@remkoj/optimizely-cms-api 6.0.0-pre3 → 6.0.0-pre5

package/dist/api-client.d.ts

@@ -2,7 +2,7 @@ import * as Operations from './client/sdk.gen';
 import { type CmsIntegrationApiOptions } from "./config";
 import { type InstanceApiVersionInfo, OptiCmsVersion } from "./types";
 import { createClient, type RequestResult, type ResponseStyle } from './client/client';
-import { type CreateClientConfig } from './client/client.gen';
+import type { CreateClientConfig } from './client/client.gen';
 type OperationsType = {
     -readonly [KT in keyof typeof Operations]: (typeof Operations)[KT];
 };
@@ -57,6 +57,7 @@ declare class BaseApiClient {
      * @returns The version information from the running instance
      */
     getInstanceInfo(): Promise<InstanceApiVersionInfo>;
+    getOpenApiSpec(): Promise<any>;
     protected createClientConfig: CreateClientConfig;
 }
 export declare class ApiError extends Error {

package/dist/api-client.js

@@ -156,6 +156,14 @@ class BaseApiClient {
             return result.data;
         throw new ApiError(result);
     }
+    async getOpenApiSpec() {
+        const result = await this._client.get({
+            url: '/docs/content-openapi.json'
+        });
+        if (result.data)
+            return result.data;
+        throw new ApiError(result);
+    }
     createClientConfig = (override) => {
         return {
             ...override,

package/dist/client-config.js

@@ -4,7 +4,7 @@ exports.createClientConfig = void 0;
 const config_1 = require("./config");
 const getaccesstoken_1 = require("./getaccesstoken");
 const createClientConfig = (config) => {
-    const envConfig = (0, config_1.getCmsIntegrationApiConfigFromEnvironment)();
+    const envConfig = (0, config_1.readPartialEnvConfig)();
     const baseUrl = envConfig.base.href;
     const newClientConfig = {
         baseUrl,

package/dist/config.d.ts

@@ -10,4 +10,8 @@ export type CmsIntegrationApiOptions = {
      */
     cmsVersion?: OptiCmsVersion;
 };
+type ClientCredentials = 'clientId' | 'clientSecret';
+export declare function readPartialEnvConfig(): CmsIntegrationApiOptions;
+export declare function readEnvConfig(): Omit<CmsIntegrationApiOptions, ClientCredentials> & Pick<Required<CmsIntegrationApiOptions>, ClientCredentials>;
 export declare function getCmsIntegrationApiConfigFromEnvironment(): CmsIntegrationApiOptions;
+export {};

package/dist/config.js

@@ -1,9 +1,47 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.readPartialEnvConfig = readPartialEnvConfig;
+exports.readEnvConfig = readEnvConfig;
 exports.getCmsIntegrationApiConfigFromEnvironment = getCmsIntegrationApiConfigFromEnvironment;
 const types_1 = require("./types");
+function readPartialEnvConfig() {
+    const cmsUrl = getOptional('OPTIMIZELY_CMS_URL', 'https://api.cms.optimizely.com');
+    const clientId = getOptional('OPTIMIZELY_CMS_CLIENT_ID');
+    const clientSecret = getOptional('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 {
+        const cmsUrlAdjusted = cmsUrl.includes("://") ? cmsUrl : 'https://' + cmsUrl;
+        baseUrl = new URL('/_cms/preview2', cmsUrlAdjusted);
+        if (cmsVersion == types_1.OptiCmsVersion.CMS12)
+            baseUrl.pathname = baseUrl.pathname.replace('preview2', 'preview1');
+    }
+    catch (e) {
+        throw new Error("Invalid Optimizely CMS URL provided");
+    }
+    if (debug)
+        console.log(`[Optimizely CMS API] Connecting to ${baseUrl} as ${clientId ?? 'Anonymous'}`);
+    return {
+        base: baseUrl,
+        clientId,
+        clientSecret,
+        actAs,
+        debug,
+        cmsVersion
+    };
+}
+function readEnvConfig() {
+    const partialConfig = readPartialEnvConfig();
+    if (!partialConfig.clientId)
+        throw new Error("The Client ID (OPTIMIZELY_CMS_CLIENT_ID) is a required environment variable");
+    if (!partialConfig.clientSecret)
+        throw new Error("The Client Secret (OPTIMIZELY_CMS_CLIENT_SECRET) is a required environment variable");
+    return partialConfig;
+}
 function getCmsIntegrationApiConfigFromEnvironment() {
-    const cmsUrl = getOptional('OPTIMIZELY_CMS_URL', 'https://example.cms.optimizely.com');
+    const cmsUrl = getOptional('OPTIMIZELY_CMS_URL', 'https://api.cms.optimizely.com');
     const clientId = getMandatory('OPTIMIZELY_CMS_CLIENT_ID');
     const clientSecret = getMandatory('OPTIMIZELY_CMS_CLIENT_SECRET');
     const actAs = getOptional('OPTIMIZELY_CMS_USER_ID');

package/dist/getaccesstoken.js

@@ -12,7 +12,7 @@ async function getAccessToken(config) {
     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('Authorization', `Basic ${base64Encode(`${options.clientId ?? ''}:${options.clientSecret ?? ''}`)}`);
     headers.append('Content-Type', 'application/x-www-form-urlencoded');
     headers.append('Connection', 'close');
     if (options.debug) {

package/dist/index.d.ts

@@ -4,6 +4,7 @@ export { ApiClient, ApiError, ApiClient as CoreClient, type ApiClientStatic, typ
 export { OptiCmsVersion } from "./types";
 import { type CmsIntegrationApiOptions } from './config';
 import { type CmsIntegrationApiClient } from './api-client';
+export { getCmsIntegrationApiConfigFromEnvironment as readEnvConfig } from './config';
 export declare function createClient(config?: CmsIntegrationApiOptions): CmsIntegrationApiClient;
 export declare enum ContentRoots {
     /**

package/dist/index.js

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

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": "6.0.0-pre3",
+  "version": "6.0.0-pre5",
   "type": "commonjs",
   "license": "Apache-2.0",
   "main": "./dist/index.js",