feat(v2): updated project setup and applied latest api changes

Author: reggeenr

.eslintignore

@@ -5,6 +5,8 @@ coverage/
 dist/
 node_modules/
 examples/**/node_modules/
+example/*.js
+scripts/*.js
 
 test/resources/auth.js
 # ignore emitted js

.eslintrc.js

@@ -1,191 +1,54 @@
 module.exports = {
-  parser: '@typescript-eslint/parser',
-  plugins: ['@typescript-eslint'],
-  extends: ['airbnb', 'eslint:recommended', 'plugin:@typescript-eslint/recommended'],
-  env: {
-    browser: true,
-    jasmine: true,
-    jquery: true,
-    jest: true,
-  },
-  globals: {
-    analytics: true,
-  },
-  rules: {
-    // This block has rules that we either had before, or that I (personal opinion) either didn't
-    // consider to be important, or not controversial.
-    'no-console': 'off',
-    'no-script-url': 'off',
-    'max-len': 'off',
-    'no-param-reassign': 'off',
-    'no-underscore-dangle': 'off',
-    camelcase: 'off',
-    'react/jsx-no-target-blank': 'error',
-    'react/jsx-uses-react': 'error',
-    'react/jsx-uses-vars': 'error',
-    'spaced-comment': 'off',
-    'import/extensions': 'off',
-    'import/order': 'off',
-    'import/newline-after-import': 'warn',
-    'import/prefer-default-export': 'off',
-    'import/no-extraneous-dependencies': 'off',
-    'no-restricted-syntax': 'off',
-    'no-plusplus': 'warn',
-    'jsx-quotes': 'off',
-    'react/jsx-curly-brace-presence': 'warn',
-    'react/destructuring-assignment': 'off',
-    'react/sort-comp': 'off',
-    'max-classes-per-file': 'off',
-    'react/jsx-boolean-value': 'off',
-    'react/forbid-prop-types': 'off',
-    'react/jsx-fragments': 'warn',
-    '@typescript-eslint/ban-ts-comment': 'warn',
-    'no-nested-ternary': 'warn',
-    'jsx-a11y/label-has-associated-control': 'warn',
-    'jsx-a11y/control-has-associated-label': 'warn',
-    'jsx-a11y/tabindex-no-positive': 'warn',
-    'operator-assignment': 'off',
-    'no-restricted-properties': 'warn',
-    'react/jsx-props-no-spreading': 'off',
-    'react/jsx-filename-extension': [1, { extensions: ['.tsx', '.jsx'] }],
-    'react/jsx-curly-newline': 'off',
-    '@typescript-eslint/no-inferrable-types': 'off',
-    '@typescript-eslint/no-extra-semi': 'off',
-    // the base rule is buggy and must be disabled
-    'no-use-before-define': 'off',
-    'react/function-component-definition': 'off',
-
-    // Formatting where prettier has a different opinion. These should remain off,
-    // or we'll have two pre-commit hooks that contradict each other.
-    'object-curly-newline': 'off',
-    'operator-linebreak': 'off',
-    'lines-between-class-members': 'off',
-    'function-paren-newline': 'off',
-    'implicit-arrow-linebreak': 'off',
-    'newline-per-chained-call': 'off',
-    'no-multiple-empty-lines': 'off',
-    'no-trailing-spaces': 'off',
-    'react/jsx-wrap-multilines': 'off',
-    'react/display-name': 'off',
-    indent: 'off',
-    'react/jsx-one-expression-per-line': 'off',
-    'react/jsx-indent': 'off',
-
-    // More "modern" JS styles. Some of these would be a lot of work to enabel.
-    'comma-dangle': 'off',
-    'arrow-body-style': 'off',
-    'prefer-object-spread': 'warn',
-    'prefer-rest-params': 'warn',
-    'prefer-destructuring': 'off',
-    'prefer-template': 'warn',
-    'prefer-arrow-callback': 'off',
-
-    // Not sure about this one. We can't easily enable it because we violate it all over the backend
-    'import/no-import-module-exports': 'off',
-
-    // Anything below here I think should really be errors. Turning them into warnings now
-    // because I can't fix them all at once. In no particular order.
-    'no-confusing-arrow': 'warn',
-    'no-useless-constructor': 'warn',
-    'no-extra-boolean-cast': 'warn',
-    'no-sequences': 'warn',
-    quotes: 'warn',
-    'no-shadow-restricted-names': 'warn',
-    eqeqeq: 'warn',
-    'no-prototype-builtins': 'warn',
-    'no-var': 'warn',
-    // For typescript, it is recommended to turn this off as it is checked by typescript
-    'no-undef': 'off',
-    'array-callback-return': 'warn',
-    'no-unneeded-ternary': 'warn',
-    'no-path-concat': 'warn',
-    'no-case-declarations': 'warn',
-    'no-useless-return': 'warn',
-    'no-continue': 'warn',
-    'no-lonely-if': 'warn',
-    'default-case': 'warn',
-    'no-multi-assign': 'warn',
-    'prefer-const': 'warn',
-    'no-async-promise-executor': 'warn',
-    // this gives false positives for typescript enums; enable the corresponding typescript rule instead
-    'no-shadow': 'off',
-    'no-useless-escape': 'warn',
-    'no-else-return': 'off',
-    'import/no-useless-path-segments': 'off',
-    'import/no-duplicates': 'warn',
-    'import/no-mutable-exports': 'warn',
-    'import/no-dynamic-require': 'warn',
-    'import/no-self-import': 'off',
-    'global-require': 'warn',
-    'object-shorthand': 'warn',
-    'no-unused-expressions': 'warn',
-    'dot-notation': 'warn',
-    'no-await-in-loop': 'warn',
-    'prefer-promise-reject-errors': 'warn',
-    'no-restricted-globals': 'warn',
-    'class-methods-use-this': 'off',
-    '@typescript-eslint/no-use-before-define': ['off'],
-    '@typescript-eslint/no-empty-interface': 'warn',
-    '@typescript-eslint/no-var-requires': 'off',
-    '@typescript-eslint/no-this-alias': 'warn',
-    '@typescript-eslint/no-namespace': 'off',
-    '@typescript-eslint/ban-types': 'warn',
-    '@typescript-eslint/no-shadow': 'error',
-    'react/prop-types': 'off',
-    'react/no-access-state-in-setstate': 'warn',
-    'react/require-default-props': 'off',
-    'react/no-unused-prop-types': 'warn',
-    'react/jsx-no-bind': 'warn',
-    'react/no-did-update-set-state': 'warn',
-    'react/no-unused-state': 'warn',
-    'react/static-property-placement': 'warn',
-    'react/no-unescaped-entities': 'warn',
-    'react/no-children-prop': 'warn',
-    'react/no-direct-mutation-state': 'warn',
-    'react/default-props-match-prop-types': 'warn',
-    'react/prefer-stateless-function': 'warn',
-    'react/jsx-key': 'warn',
-    'jsx-a11y/no-static-element-interactions': 'warn',
-    'jsx-a11y/click-events-have-key-events': 'warn',
-    'jsx-a11y/aria-props': 'warn',
-    'jsx-a11y/anchor-is-valid': 'warn',
-    'no-return-assign': 'warn',
-    'consistent-return': 'warn',
-    'import/first': 'warn',
-    'default-param-last': 'warn',
-    // The following rules seem sensible, but we violate them in so many places that I disable them for now
-    'import/no-named-as-default': 'warn',
-    'import/no-cycle': 'warn',
-    'import/no-named-as-default-member': 'warn',
-    'import/no-unresolved': 'off',
-    'padded-blocks': 'off',
-    'quote-props': 'off'
-  },
-  settings: {
-    'import/parsers': {
-      '@typescript-eslint/parser': ['.ts', '.tsx'],
-    },
-    'import/resolver': {
-      // "node": {
-      //   "paths": [path.resolve(__dirname, './src')]
-      // },
-      typescript: {
-        project: './tsconfig.json',
+  'root': true,
+  'overrides': [
+    {
+      'env': {
+        'node': true,
+      },
+      'files': ['**/*.js', '**/*.jsx'],
+      'plugins': ['node', 'jest', 'prettier'],
+      'extends': ['airbnb-base', 'plugin:jest/recommended', 'plugin:jest/style', 'prettier'],
+      'rules': {
+        'camelcase': 'off',
+        'import/extensions': 'off',
+        'no-template-curly-in-string': 'off',
+        'no-underscore-dangle': 'off',
+        'prefer-const': 'error',
+        'prettier/prettier': 'error',
       },
     },
-    react: {
-      createClass: 'createReactClass', // Regex for Component Factory to use,
-      // default to "createReactClass"
-      pragma: 'React', // Pragma to use, default to "React"
-      version: 'detect', // React version. "detect" automatically picks the version you have installed.
-      // You can also use `16.0`, `16.3`, etc, if you want to override the detected value.
-      // default to latest and warns if missing
-      // It will default to "detect" in the future
+    {
+      'files': ['*.test.js', '*.test.jsx'],
+      'rules': {
+        'jest/expect-expect': 'off',
+        'jest/no-conditional-expect': 'off',
+        'jest/no-done-callback': 'off',
+        'jest/no-standalone-expect': 'off',
+        'jest/no-try-expect': 'off',
+        'no-unused-vars': 'off',
+      },
     },
-  },
-  parserOptions: {
-    ecmaFeatures: {
-      jsx: true,
+    {
+      'files': ['**/*.ts', '**/*.tsx'],
+      'env': {
+        'node': true,
+      },
+      'extends': ['airbnb-typescript/base', 'prettier'],
+      'parser': '@typescript-eslint/parser',
+      'parserOptions': {
+        'project': 'tsconfig.json',
+        'sourceType': 'module',
+      },
+      'plugins': ['eslint-plugin-jsdoc', 'eslint-plugin-import', '@typescript-eslint', 'prettier'],
+      'rules': {
+        '@typescript-eslint/naming-convention': 'off',
+        '@typescript-eslint/no-unused-vars': 'off',
+        'max-len': 'off',
+        'no-param-reassign': 'off',
+        'no-underscore-dangle': 'off',
+        'prettier/prettier': 'error',
+        'spaced-comment': ['error', 'always', { 'exceptions': ['*'] }],
+      },
     },
-  },
+  ],
 };

.github/pull_request_template.md

@@ -1,7 +1,6 @@
 ## PR summary
 <!-- please include a brief summary of the changes in this PR -->
 
-**Fixes:** <! -- link to issue -->
 
 ## PR Checklist
 Please make sure that your PR fulfills the following requirements:

.prettierrc.js

@@ -1,5 +1,7 @@
 module.exports = {
+  semi: true,
+  trailingComma: 'es5',
   singleQuote: true,
-  jsxSingleQuote: true,
-  printWidth: 120,
+  printWidth: 100,
+  quoteProps: 'preserve',
 };

.travis.yml

@@ -1,10 +1,13 @@
-language: node_js
+dist: focal
 
-# After creating your SDK project from this template repository,
-# uncomment this section to enable builds on the appropriate node versions.
-# node_js:
-# - 12
-# - 14
+# Remove this if using external Travis
+group: beta
+
+language: node_js
+node_js:
+  - 14
+  - 16
+  - 18
 
 # After creating your SDK project from this template repository,
 # remove the "echo" command from the "before_install" section below.
@@ -19,32 +22,11 @@ script:
 - npm run lint
 - npm run check-packages
 
-# After creating your SDK project from this template repository,
-# remove this entire "jobs" section as this is only applicable
-# to the template repo's travis build.
-jobs:
-  include:
-    - stage: Run node template build
-      node_js: 12
-    - node_js: 14
-    - stage: Run system test with template
-      node_js: 14
-      script:
-        - >-
-          if [[ "$TRAVIS_PULL_REQUEST" == "false" ]]; then
-            echo "Running system tests"
-            git clone https://github.ibm.com/CloudEngineering/sdkgen-systest.git
-            cd sdkgen-systest
-            ./install_scripts/install_deps_ubuntu.sh
-            ./setup_and_generate.sh -l ibm-node -t $TRAVIS_BRANCH -s
-          else
-            echo "Skipping system tests for PR build..."
-          fi
 # To enable semantic-release, uncomment this section.
 # deploy:
 # - provider: script
 #   skip_cleanup: true
 #   script: npx semantic-release
 #   on:
 #     node: 14
-#     branch: main
+#     branch: main

CODE_OF_CONDUCT.md

@@ -55,7 +55,7 @@ further defined and clarified by project maintainers.
 ## Enforcement
 
 Instances of abusive, harassing, or otherwise unacceptable behavior may be
-reported by contacting the project team at phil_adams@us.ibm.com. All
+reported by contacting the project team at devxsdk@us.ibm.com. All
 complaints will be reviewed and investigated and will result in a response that
 is deemed necessary and appropriate to the circumstances. The project team is
 obligated to maintain confidentiality with regard to the reporter of an incident.

CONTRIBUTING.md

@@ -5,10 +5,10 @@ please ask a question at
 
 # Issues
 If you encounter an issue with the SDK, you are welcome to submit
-a [bug report](https://github.com/IBM/code-engine-node-sdk/issues).
+a [bug report](<github-repo-url>/issues).
 Before that, please search for similar issues. It's possible someone has
 already encountered this issue.
 
 # General Information
 For general guidance on contributing to this project, please see
-[this link](https://github.com/IBM/ibm-cloud-sdk-common/blob/master/CONTRIBUTING_nodejs.md)
+[this link](https://github.com/IBM/ibm-cloud-sdk-common/blob/main/CONTRIBUTING_nodejs.md)

README.md

@@ -7,9 +7,6 @@
 # NodeJS SDK for IBM Cloud Code Engine
 Node.js client library to interact with the [Code Engine API](https://cloud.ibm.com/apidocs/codeengine).
 
-Disclaimer: this SDK is being released initially as a **pre-release** version.
-Changes might occur which impact applications that use this SDK.
-
 ## Table of Contents
 
 <!--
@@ -43,7 +40,9 @@ The IBM Cloud Code Engine Node.js SDK allows developers to programmatically inte
 
 Service Name | Import Path
 --- | ---
-[Code Engine](https://cloud.ibm.com/apidocs/codeengine) | ibm-code-engine-sdk/ibm-cloud-code-engine/v1
+[Code Engine](https://cloud.ibm.com/apidocs/codeengine) | 
+[Code Engine](https://cloud.ibm.com/apidocs/codeengine/codeengine-v2.0.0) | @ibm-cloud/@ibm-cloud/ibm-code-engine-sdk/code-engine/v2 
+[Code Engine](https://cloud.ibm.com/apidocs/codeengine/codeengine-v1.0.0) | ibm-code-engine-sdk/ibm-cloud-code-engine/v1
 
 ## Prerequisites
 * You need an [IBM Cloud][ibm-cloud-onboarding] account.
@@ -54,7 +53,7 @@ Service Name | Import Path
 ## Installation
 
 ```sh
-npm install ibm-code-engine-sdk
+npm install @ibm-cloud/@ibm-cloud/ibm-code-engine-sdk
 ```
 
 ## Using the SDK