@remkoj/optimizely-cms-api 2.0.3 → 2.1.0

package/README.md

@@ -1,44 +1,45 @@
-[![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](./LICENSE)
-![Static Badge](https://img.shields.io/badge/Optimizely-Content_Management_System-blue?cacheSeconds=7200)
-
-# Optimizely CMS - Integration API Client <!-- omit in toc -->
-A Javascript client for the Integration API provided by the Optimizely CMS. It wraps the [Optimizely CMS SaaS Core REST API](https://docs.developers.optimizely.com/content-management-system/v1.0.0-SaaS-Core/reference/introduction-to-the-cms-content-api).
-
-## Installation
-This package is provides as part of one of the mono-repo style demo sites. Install this package by using a mono-repo style structure for your project and copying this package into your mono-repo.
-
-## Requirements
-This package works across browser and modern Node.JS environments, which provide an implementation for the [Fetch API](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API). The library has been tested with the Fetch API implementation in [Node.JS v18](https://nodejs.org/dist/latest-v20.x/docs/api/globals.html#fetch) and above.
-
-## Usage
-```typescript
-// Import the Client
-import createClient, { ContentRoots } from '@remkoj/optimizely-cms-integration-api'
-
-// Create an instance of the client
-const client = createClient({
-    base: "https://example.com",
-    clientId: "apiClientID",
-    clientSecret: "apiClientSecret"
-});
-
-// Start using client
-client.content.contentListItems(ContentRoots.SystemRoot).then(response => {
-    const items = response.items
-    items?.map(item => {
-        // Do something with the item
-    })
-})
-```
-
-## Alternative configuration for Node.JS
-The configuration object for the `createClient()` method is optional, if it is omitted, the configuration will be read from the environment variables.
-
-## Configuration options
-The following configuration options are available for 
-| Environment variable | Configuration key | Required | Usage |
-| --- | --- | --- | --- |
-| OPTIMIZELY_CMS_URL | base | yes | The URL where the CMS is available |
-| OPTIMIZELY_CMS_CLIENT_ID | clientId | yes | The API Client ID, as configured within the CMS |
-| OPTIMIZELY_CMS_CLIENT_SECRET | clientSecret | yes | The API Client Secret as generated by the CMS when creating the client |
-| OPTIMIZELY_CMS_USER_ID | actAs | no | The username of the CMS user to impersonate |
+[![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](./LICENSE)
+![Static Badge](https://img.shields.io/badge/Optimizely-Content_Management_System-blue?cacheSeconds=7200)
+
+# Optimizely CMS - Integration API Client <!-- omit in toc -->
+A Javascript client for the Integration API provided by the Optimizely CMS. It wraps the [Optimizely CMS SaaS Core REST API](https://docs.developers.optimizely.com/content-management-system/v1.0.0-SaaS-Core/reference/introduction-to-the-cms-content-api).
+
+## Installation
+This package is provides as part of one of the mono-repo style demo sites. Install this package by using a mono-repo style structure for your project and copying this package into your mono-repo.
+
+## Requirements
+This package works across browser and modern Node.JS environments, which provide an implementation for the [Fetch API](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API). The library has been tested with the Fetch API implementation in [Node.JS v18](https://nodejs.org/dist/latest-v20.x/docs/api/globals.html#fetch) and above.
+
+## Usage
+```typescript
+// Import the Client
+import createClient, { ContentRoots } from '@remkoj/optimizely-cms-integration-api'
+
+// Create an instance of the client
+const client = createClient({
+    base: "https://example.com",
+    clientId: "apiClientID",
+    clientSecret: "apiClientSecret"
+});
+
+// Start using client
+client.content.contentListItems(ContentRoots.SystemRoot).then(response => {
+    const items = response.items
+    items?.map(item => {
+        // Do something with the item
+    })
+})
+```
+
+## Alternative configuration for Node.JS
+The configuration object for the `createClient()` method is optional, if it is omitted, the configuration will be read from the environment variables.
+
+## Configuration options
+The following configuration options are available for 
+| Environment variable | Configuration key | Required | Usage |
+| --- | --- | --- | --- |
+| OPTIMIZELY_CMS_URL | base | yes | The URL where the CMS is available |
+| OPTIMIZELY_CMS_CLIENT_ID | clientId | yes | The API Client ID, as configured within the CMS |
+| OPTIMIZELY_CMS_CLIENT_SECRET | clientSecret | yes | The API Client Secret as generated by the CMS when creating the client |
+| OPTIMIZELY_CMS_USER_ID | actAs | no | The username of the CMS user to impersonate |
+| OPTIMIZELY_CMS_SCHEMA | cmsVersion | no | Override the target Optimizely CMS Version:<br/><br/>`OPTI-CMS-12`: Optimizely CMS 12, With [CMS Service Preview 1](https://nuget.optimizely.com/package/?id=Optimizely.Cms.Preview1.Service) installed and working.<br/><br/>`OPTI-CMS-13`: Optimizely SaaS CMS / CMS 13<br/><br/>**Default:** SaaS CMS / CMS 13 |

package/dist/api-client.d.ts

@@ -1,6 +1,6 @@
 import { CmsIntegrationApiClient } from "./client";
 import { type CmsIntegrationApiOptions } from "./config";
-import type { InstanceApiVersionInfo } from "./types";
+import { type InstanceApiVersionInfo, OptiCmsVersion } from "./types";
 import type { CancelablePromise } from "./client";
 export declare class ApiClient extends CmsIntegrationApiClient {
     private _config;
@@ -10,6 +10,13 @@ export declare class ApiClient extends CmsIntegrationApiClient {
      * @param   config  The instance configuration
      */
     constructor(config?: CmsIntegrationApiOptions);
+    /**
+     * Get the runtime configuration of the target CMS version.
+     *
+     * If this differs from the cmsVersion the client may not work fully or not
+     * at all.
+     */
+    get runtimeCmsVersion(): OptiCmsVersion;
     /**
      * The URL of the CMS instance
      */

package/dist/api-client.js

@@ -7,6 +7,7 @@ exports.ApiClient = void 0;
 const client_1 = require("./client");
 const getaccesstoken_1 = require("./getaccesstoken");
 const config_1 = require("./config");
+const types_1 = require("./types");
 const version_json_1 = __importDefault(require("./version.json"));
 const OpenAPI_1 = require("./client/core/OpenAPI");
 class ApiClient extends client_1.CmsIntegrationApiClient {
@@ -18,6 +19,9 @@ class ApiClient extends client_1.CmsIntegrationApiClient {
     constructor(config) {
         const options = config ?? (0, config_1.getCmsIntegrationApiConfigFromEnvironment)();
         options.base = new URL(OpenAPI_1.OpenAPI.BASE, options.base);
+        if (options.cmsVersion == types_1.OptiCmsVersion.CMS12)
+            options.base.pathname = options.base.pathname.replace('preview2', 'preview1');
+        const apiVersion = options.cmsVersion == types_1.OptiCmsVersion.CMS12 ? 'preview1' : OpenAPI_1.OpenAPI.VERSION;
         let access_token = undefined;
         super({
             BASE: options.base.href,
@@ -36,10 +40,20 @@ class ApiClient extends client_1.CmsIntegrationApiClient {
                 Connection: "Close"
             },
             WITH_CREDENTIALS: true,
-            CREDENTIALS: "include"
+            CREDENTIALS: "include",
+            VERSION: apiVersion
         });
         this._config = options;
     }
+    /**
+     * Get the runtime configuration of the target CMS version.
+     *
+     * If this differs from the cmsVersion the client may not work fully or not
+     * at all.
+     */
+    get runtimeCmsVersion() {
+        return this._config.cmsVersion ?? types_1.OptiCmsVersion.CMS13;
+    }
     /**
      * The URL of the CMS instance
      */
@@ -53,7 +67,7 @@ class ApiClient extends client_1.CmsIntegrationApiClient {
         return this._config.debug ?? false;
     }
     get version() {
-        return OpenAPI_1.OpenAPI.VERSION;
+        return this._config.cmsVersion == types_1.OptiCmsVersion.CMS12 ? 'preview1' : OpenAPI_1.OpenAPI.VERSION;
     }
     /**
      * The API version for which this client was build

package/dist/client/index.d.ts

@@ -39,6 +39,7 @@ export type { DisplaySettingChoice } from './models/DisplaySettingChoice';
 export type { DisplayTemplate } from './models/DisplayTemplate';
 export type { DisplayTemplatePage } from './models/DisplayTemplatePage';
 export type { DoubleEnumerationSettings } from './models/DoubleEnumerationSettings';
+export type { DoubleEnumerationValue } from './models/DoubleEnumerationValue';
 export type { FloatListItem } from './models/FloatListItem';
 export type { FloatProperty } from './models/FloatProperty';
 export type { ImageDescriptor } from './models/ImageDescriptor';
@@ -46,6 +47,7 @@ export type { ImportPackageMessage } from './models/ImportPackageMessage';
 export type { ImportPackageResult } from './models/ImportPackageResult';
 export { IndexingType } from './models/IndexingType';
 export type { Int32EnumerationSettings } from './models/Int32EnumerationSettings';
+export type { Int32EnumerationValue } from './models/Int32EnumerationValue';
 export type { IntegerListItem } from './models/IntegerListItem';
 export type { IntegerProperty } from './models/IntegerProperty';
 export type { JsonStringProperty } from './models/JsonStringProperty';
@@ -66,6 +68,7 @@ export type { PropertyFormatPage } from './models/PropertyFormatPage';
 export type { PropertyGroup } from './models/PropertyGroup';
 export type { PropertyGroupPage } from './models/PropertyGroupPage';
 export type { StringEnumerationSettings } from './models/StringEnumerationSettings';
+export type { StringEnumerationValue } from './models/StringEnumerationValue';
 export type { StringListItem } from './models/StringListItem';
 export type { StringProperty } from './models/StringProperty';
 export type { UrlListItem } from './models/UrlListItem';

package/dist/client/models/DoubleEnumerationSettings.d.ts

@@ -1,3 +1,4 @@
+import type { DoubleEnumerationValue } from './DoubleEnumerationValue';
 /**
  * A writable implementation of an EnumerationSettings`1.
  */
@@ -5,5 +6,5 @@ export type DoubleEnumerationSettings = {
     /**
      * Enumeration values for this property or format.
      */
-    values?: Record<string, string>;
+    values?: Array<DoubleEnumerationValue>;
 };

package/dist/client/models/DoubleEnumerationValue.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Describes an enumeration value.
+ */
+export type DoubleEnumerationValue = {
+    /**
+     * The display name of the enumeration.
+     */
+    displayName?: string;
+    /**
+     * The value of the enumeration.
+     */
+    value?: number;
+};

package/dist/client/models/DoubleEnumerationValue.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/client/models/Int32EnumerationSettings.d.ts

@@ -1,3 +1,4 @@
+import type { Int32EnumerationValue } from './Int32EnumerationValue';
 /**
  * A writable implementation of an EnumerationSettings`1.
  */
@@ -5,5 +6,5 @@ export type Int32EnumerationSettings = {
     /**
      * Enumeration values for this property or format.
      */
-    values?: Record<string, string>;
+    values?: Array<Int32EnumerationValue>;
 };

package/dist/client/models/Int32EnumerationValue.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Describes an enumeration value.
+ */
+export type Int32EnumerationValue = {
+    /**
+     * The display name of the enumeration.
+     */
+    displayName?: string;
+    /**
+     * The value of the enumeration.
+     */
+    value?: number;
+};

package/dist/client/models/Int32EnumerationValue.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/client/models/StringEnumerationSettings.d.ts

@@ -1,3 +1,4 @@
+import type { StringEnumerationValue } from './StringEnumerationValue';
 /**
  * A writable implementation of an EnumerationSettings`1.
  */
@@ -5,5 +6,5 @@ export type StringEnumerationSettings = {
     /**
      * Enumeration values for this property or format.
      */
-    values?: Record<string, string>;
+    values?: Array<StringEnumerationValue>;
 };

package/dist/client/models/StringEnumerationValue.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Describes an enumeration value.
+ */
+export type StringEnumerationValue = {
+    /**
+     * The display name of the enumeration.
+     */
+    displayName?: string;
+    /**
+     * The value of the enumeration.
+     */
+    value?: string;
+};

package/dist/client/models/StringEnumerationValue.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/config.d.ts

@@ -1,8 +1,13 @@
+import { OptiCmsVersion } from './types';
 export type CmsIntegrationApiOptions = {
     base: URL;
     clientId?: string;
     clientSecret?: string;
     actAs?: string;
     debug?: boolean;
+    /**
+     * The CMS Schema version that is used
+     */
+    cmsVersion?: OptiCmsVersion;
 };
 export declare function getCmsIntegrationApiConfigFromEnvironment(): CmsIntegrationApiOptions;

package/dist/config.js

@@ -2,17 +2,21 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getCmsIntegrationApiConfigFromEnvironment = getCmsIntegrationApiConfigFromEnvironment;
 const OpenAPI_1 = require("./client/core/OpenAPI");
+const types_1 = require("./types");
 function getCmsIntegrationApiConfigFromEnvironment() {
-    const cmsUrl = getMandatory('OPTIMIZELY_CMS_URL');
+    const cmsUrl = getOptional('OPTIMIZELY_CMS_URL', 'https://example.cms.optimizely.com');
     const clientId = getMandatory('OPTIMIZELY_CMS_CLIENT_ID');
     const clientSecret = getMandatory('OPTIMIZELY_CMS_CLIENT_SECRET');
     const actAs = getOptional('OPTIMIZELY_CMS_USER_ID');
     const debug = getOptional('OPTIMIZELY_DEBUG', "0") == "1";
+    const cmsVersion = getSelection('OPTIMIZELY_CMS_SCHEMA', [types_1.OptiCmsVersion.CMS12, types_1.OptiCmsVersion.CMS13], types_1.OptiCmsVersion.CMS13);
     let baseUrl;
     try {
         baseUrl = new URL(OpenAPI_1.OpenAPI.BASE, cmsUrl);
+        if (cmsVersion == types_1.OptiCmsVersion.CMS12)
+            baseUrl.pathname = baseUrl.pathname.replace('preview2', 'preview1');
     }
-    catch {
+    catch (e) {
         throw new Error("Invalid URL provided");
     }
     if (debug)
@@ -22,7 +26,8 @@ function getCmsIntegrationApiConfigFromEnvironment() {
         clientId,
         clientSecret,
         actAs,
-        debug
+        debug,
+        cmsVersion
     };
 }
 function getOptional(variable, defaultValue) {
@@ -37,3 +42,11 @@ function getMandatory(variable) {
         throw new Error(`The environment variable ${variable} is missing or empty`);
     return envValue;
 }
+function getSelection(envVarName, allowedValues, defaultValue) {
+    const rawValue = getOptional(envVarName, defaultValue);
+    if (!rawValue)
+        return defaultValue;
+    if (allowedValues.some(av => av == rawValue))
+        return rawValue;
+    return defaultValue;
+}

package/dist/getaccesstoken.js

@@ -3,13 +3,16 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.getAccessToken = getAccessToken;
 const config_1 = require("./config");
 const OpenAPI_1 = require("./client/core/OpenAPI");
+const types_1 = require("./types");
 function isErrorResponse(response) {
     return typeof (response.error) == 'string';
 }
 async function getAccessToken(config) {
     const options = config ?? (0, config_1.getCmsIntegrationApiConfigFromEnvironment)();
-    const authUrl = new URL(`${OpenAPI_1.OpenAPI.BASE}/oauth/token`, options.base).href;
+    let authUrl = new URL(`${OpenAPI_1.OpenAPI.BASE}/oauth/token`, options.base).href;
     const headers = new Headers();
+    if (options.cmsVersion == types_1.OptiCmsVersion.CMS12)
+        authUrl = authUrl.replace('preview2', 'preview1');
     headers.append('Authorization', `Basic ${base64Encode(`${options.clientId}:${options.clientSecret}`)}`);
     headers.append('Content-Type', 'application/x-www-form-urlencoded');
     headers.append('Connection', 'close');

package/dist/index.d.ts

@@ -3,6 +3,7 @@ export * as IntegrationApi from './client';
 export { CmsIntegrationApiClient as CoreClient } from './client';
 export { ApiClient } from './api-client';
 export { ApiClient as CmsIntegrationApiClient } from './api-client';
+export { OptiCmsVersion } from "./types";
 import { type CmsIntegrationApiOptions } from './config';
 import { ApiClient as CmsIntegrationApiClient } from './api-client';
 export declare function createClient(config?: CmsIntegrationApiOptions): CmsIntegrationApiClient;

package/dist/index.js

@@ -26,7 +26,7 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ContentTypeKeys = exports.ContentRoots = exports.CmsIntegrationApiClient = exports.ApiClient = exports.CoreClient = exports.IntegrationApi = void 0;
+exports.ContentTypeKeys = exports.ContentRoots = exports.OptiCmsVersion = exports.CmsIntegrationApiClient = exports.ApiClient = exports.CoreClient = exports.IntegrationApi = void 0;
 exports.createClient = createClient;
 __exportStar(require("./config"), exports);
 exports.IntegrationApi = __importStar(require("./client"));
@@ -36,6 +36,8 @@ var api_client_1 = require("./api-client");
 Object.defineProperty(exports, "ApiClient", { enumerable: true, get: function () { return api_client_1.ApiClient; } });
 var api_client_2 = require("./api-client");
 Object.defineProperty(exports, "CmsIntegrationApiClient", { enumerable: true, get: function () { return api_client_2.ApiClient; } });
+var types_1 = require("./types");
+Object.defineProperty(exports, "OptiCmsVersion", { enumerable: true, get: function () { return types_1.OptiCmsVersion; } });
 const api_client_3 = require("./api-client");
 function createClient(config) {
     return new api_client_3.ApiClient(config);

package/dist/types.d.ts

@@ -6,3 +6,7 @@ export type InstanceApiVersionInfo = {
     cmsVersion: string;
     results: Record<string, any>;
 };
+export declare enum OptiCmsVersion {
+    CMS12 = "OPTI-CMS-12",
+    CMS13 = "OPTI-CMS-13"
+}

package/dist/types.js

@@ -1,2 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.OptiCmsVersion = void 0;
+var OptiCmsVersion;
+(function (OptiCmsVersion) {
+    OptiCmsVersion["CMS12"] = "OPTI-CMS-12";
+    OptiCmsVersion["CMS13"] = "OPTI-CMS-13";
+})(OptiCmsVersion || (exports.OptiCmsVersion = OptiCmsVersion = {}));

package/dist/version.json

@@ -1,5 +1,5 @@
 {
     "api": "preview2-1.0.0",
-    "service": "2024.08.05.0953",
-    "cms": "2024.08.05.0953"
+    "service": "2024.09.13.0710",
+    "cms": "2024.09.13.0710"
 }

package/package.json

@@ -2,7 +2,7 @@
   "name": "@remkoj/optimizely-cms-api",
   "displayName": "Optimizely CMS - Integration API Client",
   "description": "A Javascript client for the Integration API provided by the Optimizely CMS.",
-  "version": "2.0.3",
+  "version": "2.1.0",
   "packageManager": "yarn@4.3.0",
   "type": "commonjs",
   "license": "Apache-2.0",
@@ -12,12 +12,12 @@
     "./dist"
   ],
   "devDependencies": {
-    "@types/node": "^22.2.0",
+    "@types/node": "^22.7.4",
     "dotenv": "^16.4.5",
     "glob": "^11.0.0",
     "openapi-typescript-codegen": "^0.29.0",
-    "tslib": "^2.6.3",
-    "typescript": "^5.5.4"
+    "tslib": "^2.7.0",
+    "typescript": "^5.6.2"
   },
   "scripts": {
     "clean": "tsc --build --clean",