bump package version to 5.0.0

feat: openapi@2.2.4 updates OKTA-388870 <<<Jenkins Check-In of Tested SHA: 7d81339 for eng_productivity_ci_bot_okta@okta.com>>> Artifact: okta-sdk-nodejs Files changed count: 770 PR Link: "#248" feat: discontinue node 10 support * chore: upgrade to latest dependencies OKTA-405437 <<<Jenkins Check-In of Tested SHA: a716afc for eng_productivity_ci_bot_okta@okta.com>>> Artifact: okta-sdk-nodejs Files changed count: 8 PR Link: "#259" doc: mark 5.x as a stable version OKTA-410715 <<<Jenkins Check-In of Tested SHA: 3760703 for eng_productivity_ci_bot_okta@okta.com>>> Artifact: okta-sdk-nodejs Files changed count: 1 PR Link: "#263" OKTA-410726 <<<Jenkins Check-In of Tested SHA: fc55468 for eng_productivity_ci_bot_okta@okta.com>>> Artifact: okta-sdk-nodejs Files changed count: 773 PR Link: "#264"
okta · Jul 9, 2021 · 92cbd10 · 92cbd10
1 parent a7cbf84
commit 92cbd10
Show file tree

Hide file tree

Showing 773 changed files with 6,419 additions and 4,117 deletions.
diff --git a/.travis.yml b/.travis.yml
@@ -1,9 +1,9 @@
 sudo: false
 language: node_js
 node_js:
-  - 10
   - 12
   - 14
+  - 16
 
 script:
   - sh ./scripts/travis.sh

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,92 @@
 # Okta Node SDK Changelog
 
+## 5.0.0
+
+- [#259](https://github.com/okta/okta-sdk-nodejs/pull/259) Drop support for Node 10
+
+- [#248](https://github.com/okta/okta-sdk-nodejs/pull/248) Generates SDK over latest spec `@okta/openapi@2.2.4` that includes new endpoints and updated method signatures. Please see list below for detailed information:
+  - Fixes
+    - correct njwt-facing type signatures
+    - force required params in js code
+    - correct parsing of models' properties of array types
+  - Model changes
+    - `AuthorizationServer`
+      - method `listPolicies`: returns `Collection<AuthorizationServerPolicy>`
+      - method `createPolicy`: parameter type changed to `AuthorizationServerPolicyOptions`, returns `Collection<AuthorizationServerPolicy>`
+      - method `getPolicy`: returns `Promise<AuthorizationServerPolicy>`
+      - method `updatePolicy`: second parameter type changed to `AuthorizationServerPolicyOptions`, returns `Promise<AuthorizationServerPolicy>`
+    - `PolicyRule`
+      - added properties: `actions: PolicyRuleActions`, `conditions: PolicyRuleConditions`, `name: string`
+    - `SamlApplicationSettingsSignOn`
+      - added properties: `slo: SingleLogout`, `spCertificate: SpCertificate`
+    - `InlineHookChannelConfig`
+      - added properties: `method: string`
+    - `OpenIdConnectApplicationSettingsClient`
+      - added properties: `idp_initiated_login: OpenIdConnectApplicationIdpInitiatedLogin`
+    - `UserType`
+      - added method `replaceUserType`
+    - added `AuthorizationServerPolicy`
+    - added `AuthorizationServerPolicyRule`
+    - added `AuthorizationServerPolicyRuleActions`
+    - added `AuthorizationServerPolicyRuleActions`
+    - added `AuthorizationServerPolicyRuleConditions`
+    - added `NetworkZone`
+    - added `NetworkZoneAddress`
+    - added `NetworkZoneAddressType`
+    - added `NetworkZoneLocation`
+    - added `NetworkZoneStatus`
+    - added `NetworkZoneType`
+    - added `NetworkZoneUsage`
+    - added `OpenIdConnectApplicationIdpInitiatedLogin`
+    - added `PolicyRuleActions`
+    - added `PolicyRuleActionsEnroll`
+    - added `PolicyRuleActionsEnrollSelf`
+    - added `ProfileMapping`
+    - added `ProfileMappingProperty`
+    - added `ProfileMappingPropertyPushStatus`
+    - added `ProfileMappingSource`
+    - added `SingleLogout`
+    - added `SpCertificate`
+    - added `ThreatInsightConfiguration`
+    - added `TokenAuthorizationServerPolicyRuleAction`
+    - added `UserSchema`
+    - added `UserSchemaAttribute`
+    - added `UserSchemaAttributeMaster`
+    - added `UserSchemaAttributePermission`
+    - added `UserSchemaBase`
+    - added `UserSchemaBaseProperties`
+    - added `UserSchemaDefinitions`
+    - added `UserSchemaPublic`
+  - Client changes
+    - method `createAuthorizationServerPolicy`: added `authorizationServerPolicy: AuthorizationServerPolicyOptions` parameter
+    - method `listAuthorizationServerPolicies`: returns `Collection<AuthorizationServerPolicy>`
+    - method `getAuthorizationServerPolicy`: returns `Promise<AuthorizationServerPolicy>`
+    - method `updateAuthorizationServerPolicy`: second parameter type changed to `AuthorizationServerPolicyOptions`, returns `Promise<AuthorizationServerPolicy>`
+    - method `listPolicies` returns `Promise<AuthorizationServerPolicy>`
+    - added method `activateAuthorizationServerPolicy`
+    - added method `deactivateAuthorizationServerPolicy`
+    - added method `listAuthorizationServerPolicyRules`
+    - added method `createAuthorizationServerPolicyRule`
+    - added method `deleteAuthorizationServerPolicyRule`
+    - added method `getAuthorizationServerPolicyRule`
+    - added method `updateAuthorizationServerPolicyRule`
+    - added method `activateAuthorizationServerPolicyRule`
+    - added method `deactivateAuthorizationServerPolicyRule`
+    - added method `listProfileMappings`
+    - added method `getProfileMapping`
+    - added method `updateProfileMapping`
+    - added method `getApplicationUserSchema`
+    - added method `updateApplicationUserProfile`
+    - added method `getUserSchema`
+    - added method `updateUserProfile`
+    - added method `getCurrentConfiguration`
+    - added method `updateConfiguration`
+    - added method `createNetworkZone`
+    - added method `deleteNetworkZone`
+    - added method `getNetworkZone`
+    - added method `updateNetworkZone`
+    - added method `activateNetworkZone`
+    - added method `deactivateNetworkZone`
 ## 4.6.0
 
 ### Features

diff --git a/README.md b/README.md
@@ -27,6 +27,7 @@ This library uses semantic versioning and follows Okta's [library version policy
 | 2.x | :x: Retired |
 | 3.x | :x: Retired |
 | 4.x | :heavy_check_mark: Stable ([migration guide](#from-3x-to-40)) |
+| 5.x | :heavy_check_mark: Stable ([migration guide](#from-4x-to-50)) |
 
 The latest release can always be found on the [releases page][github-releases].
 
@@ -38,10 +39,7 @@ If you run into problems using the SDK, you can
 * Post [issues][github-issues] here on GitHub (for code errors)
 Node.js API Client for the [Okta Platform API].
 
-
-## Getting started
-
-Requires Node.js version 10.0.0 or higher.
+Requires Node.js version 12.0.0 or higher.
 
 
 ```sh
@@ -196,7 +194,7 @@ orgUsersCollection.each(user => {
 .then(() => console.log('All users have been listed'));
 ```
 
-If you're using a version of Node 10 or greater, you can use async iterators.
+You can also use async iterators.
 
 ```javascript
 for await (let user of client.listUsers()) {
@@ -854,6 +852,26 @@ import { Client, LogEvent } from '@okta/okta-sdk-nodejs';
 
 ## Migrating between versions
 
+### From 4.x to 5.0
+
+The version 5.0 of this SDK dropped support for Node 10, which is EOL (End-of-Life) since 2021-04-30. Current supported minimum Node version is 12.0.0.
+
+#### Breaking changes
+
+Following Client methods signatures have changed:
+ - `createAuthorizationServerPolicy`: added `authorizationServerPolicy: AuthorizationServerPolicyOptions` parameter
+ - `listAuthorizationServerPolicies`: returns `Collection<AuthorizationServerPolicy>`
+ - `getAuthorizationServerPolicy`: returns `Promise<AuthorizationServerPolicy>`
+ - `updateAuthorizationServerPolicy`: second parameter type changed to `AuthorizationServerPolicyOptions`, returns `Promise<AuthorizationServerPolicy>`
+ - `listPolicies` returns `Promise<AuthorizationServerPolicy>`
+
+Following models' method signatures have changed:
+- `AuthorizationServer`
+
+ Change details are listed in [CHANGELOG.md](CHANGELOG.md#500)
+
+All required method parameters in Client are now checked at runtime in JS code.
+
 ### From 3.x to 4.0
 
 The version 4.0 of this SDK dropped support for Node 8, which is EOL (End-of-Life) since 2019-12-31. Current supported minimum Node version is 10.0.0.

diff --git a/package.json b/package.json
@@ -1,9 +1,9 @@
 {
   "name": "@okta/okta-sdk-nodejs",
-  "version": "4.7.0",
+  "version": "5.0.0",
   "description": "Okta API wrapper for Node.js",
   "engines": {
-    "node": ">=10.0"
+    "node": ">=12.0"
   },
   "files": [
     "src/",
@@ -32,17 +32,18 @@
   "repository": "https://github.com/okta/okta-sdk-nodejs",
   "dependencies": {
     "@types/node-fetch": "^2.5.8",
+    "@types/rasha": "^1.2.2",
     "deep-copy": "^1.4.2",
     "isomorphic-fetch": "^3.0.0",
-    "js-yaml": "^3.14.1",
+    "js-yaml": "^4.1.0",
     "lodash": "^4.17.20",
     "njwt": "^1.0.0",
     "parse-link-header": "^1.0.1",
     "rasha": "^1.2.5",
     "safe-flat": "^2.0.2"
   },
   "devDependencies": {
-    "@okta/openapi": "^2.1.6",
+    "@okta/openapi": "^2.2.4",
     "@types/chai": "^4.2.17",
     "@types/mocha": "^8.2.2",
     "@typescript-eslint/eslint-plugin": "^4.15.2",
@@ -54,19 +55,19 @@
     "faker": "^5.1.0",
     "globby": "^11.0.1",
     "ink-docstrap": "^1.3.2",
-    "jest": "^26.6.3",
+    "jest": "^27.0.4",
     "jest-date-mock": "^1.0.8",
     "jest-junit": "^12.0.0",
     "jsdoc": "^3.6.6",
-    "mocha": "^8.2.1",
+    "mocha": "^9.0.1",
     "mocha-junit-reporter": "^2.0.0",
     "nyc": "^15.1.0",
     "rimraf": "^3.0.2",
-    "sinon": "^9.2.1",
+    "sinon": "^11.1.1",
     "speakeasy": "^2.0.0",
-    "ts-node": "^9.1.1",
+    "ts-node": "^10.0.0",
     "tsconfig-paths": "^3.9.0",
-    "tsd": "^0.14.0",
+    "tsd": "^0.17.0",
     "typescript": "^4.2.2"
   },
   "jest": {

diff --git a/src/api-error.js b/src/api-error.js
@@ -1,5 +1,5 @@
 /*!
- * Copyright (c) 2017-2020, Okta, Inc. and/or its affiliates. All rights reserved.
+ * Copyright (c) 2017-present, Okta, Inc. and/or its affiliates. All rights reserved.
  * The Okta software accompanied by this notice is provided pursuant to the Apache License, Version 2.0 (the "License.")
  *
  * You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0.

diff --git a/src/client.js b/src/client.js
@@ -1,5 +1,5 @@
 /*!
- * Copyright (c) 2017-2020, Okta, Inc. and/or its affiliates. All rights reserved.
+ * Copyright (c) 2017-present, Okta, Inc. and/or its affiliates. All rights reserved.
  * The Okta software accompanied by this notice is provided pursuant to the Apache License, Version 2.0 (the "License.")
  *
  * You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0.

diff --git a/src/collection.js b/src/collection.js
@@ -1,5 +1,5 @@
 /*!
- * Copyright (c) 2017-2020, Okta, Inc. and/or its affiliates. All rights reserved.
+ * Copyright (c) 2017-present, Okta, Inc. and/or its affiliates. All rights reserved.
  * The Okta software accompanied by this notice is provided pursuant to the Apache License, Version 2.0 (the "License.")
  *
  * You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0.

diff --git a/src/config-loader.js b/src/config-loader.js
@@ -1,5 +1,5 @@
 /*!
- * Copyright (c) 2017-2020, Okta, Inc. and/or its affiliates. All rights reserved.
+ * Copyright (c) 2017-present, Okta, Inc. and/or its affiliates. All rights reserved.
  * The Okta software accompanied by this notice is provided pursuant to the Apache License, Version 2.0 (the "License.")
  *
  * You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0.
@@ -75,7 +75,7 @@ class ConfigLoader {
   }
 
   applyYamlFile(path) {
-    this.apply(yaml.safeLoad(fs.readFileSync(path)).okta);
+    this.apply(yaml.load(fs.readFileSync(path)).okta);
   }
 
   apply(config) {

diff --git a/src/default-cache-middleware.js b/src/default-cache-middleware.js
@@ -1,5 +1,5 @@
 /*!
- * Copyright (c) 2017-2020, Okta, Inc. and/or its affiliates. All rights reserved.
+ * Copyright (c) 2017-present, Okta, Inc. and/or its affiliates. All rights reserved.
  * The Okta software accompanied by this notice is provided pursuant to the Apache License, Version 2.0 (the "License.")
  *
  * You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0.

diff --git a/src/default-request-executor.js b/src/default-request-executor.js
@@ -1,5 +1,5 @@
 /*!
- * Copyright (c) 2018-2020, Okta, Inc. and/or its affiliates. All rights reserved.
+ * Copyright (c) 2018-present, Okta, Inc. and/or its affiliates. All rights reserved.
  * The Okta software accompanied by this notice is provided pursuant to the Apache License, Version 2.0 (the "License.")
  *
  * You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0.

diff --git a/src/factories/ApplicationFactory.js b/src/factories/ApplicationFactory.js
diff --git a/src/factories/BrowserPluginApplicationFactory.js b/src/factories/BrowserPluginApplicationFactory.js
diff --git a/src/factories/PolicyFactory.js b/src/factories/PolicyFactory.js
diff --git a/src/factories/PolicyRuleFactory.js b/src/factories/PolicyRuleFactory.js
diff --git a/src/factories/UserFactorFactory.js b/src/factories/UserFactorFactory.js
diff --git a/src/factories/index.js b/src/factories/index.js