@remkoj/optimizely-cms-api 6.0.0-rc.1 → 6.0.0-rc.3

package/dist/client-config.d.ts

@@ -1,5 +1,16 @@
 import type { ClientOptions, Config } from './client/client';
 import { type CmsIntegrationApiOptions } from "./config";
 type CreateConfig<T extends ClientOptions = ClientOptions> = (config?: Config<ClientOptions & T>, apiConfig?: CmsIntegrationApiOptions) => Config<Required<ClientOptions> & T>;
+/**
+ * Creates a fully resolved API client configuration.
+ *
+ * The function combines explicit client configuration with environment-based
+ * defaults and sets up bearer token authentication for requests.
+ *
+ * @param config - Optional core client configuration.
+ * @param apiConfig - Optional API integration configuration. When omitted,
+ * values are resolved from environment variables.
+ * @returns A normalized client configuration with authentication support.
+ */
 export declare const createClientConfig: CreateConfig;
 export {};

package/dist/client-config.js

@@ -3,21 +3,33 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.createClientConfig = void 0;
 const config_1 = require("./config");
 const getaccesstoken_1 = require("./getaccesstoken");
+/**
+ * Creates a fully resolved API client configuration.
+ *
+ * The function combines explicit client configuration with environment-based
+ * defaults and sets up bearer token authentication for requests.
+ *
+ * @param config - Optional core client configuration.
+ * @param apiConfig - Optional API integration configuration. When omitted,
+ * values are resolved from environment variables.
+ * @returns A normalized client configuration with authentication support.
+ */
 const createClientConfig = (config, apiConfig) => {
     const envConfig = apiConfig || (0, config_1.readPartialEnvConfig)();
-    const baseUrl = config?.baseUrl && !config.baseUrl.startsWith('/') ? new URL(config.baseUrl) : envConfig?.base ? new URL(config?.baseUrl ?? '/', envConfig.base) : undefined;
+    const baseUrl = envConfig.apiBaseUrl?.href ?? config?.baseUrl;
     // If we don't have a valid base URL just return the config as given
     if (!baseUrl)
         return { ...config };
-    if (!baseUrl.pathname.endsWith('/'))
-        baseUrl.pathname = baseUrl.pathname + '/';
     if (envConfig.debug)
-        console.log(`⚪ [CMS API] Creating API-Client for ${baseUrl.href} as ${envConfig.actAs ?? envConfig.clientId}\n`);
-    const authBaseUrl = baseUrl.hostname === 'api.cms.optimizely.com' ?
-        new URL("/", baseUrl) :
-        baseUrl;
+        console.log(`⚪ [CMS API] Creating API-Client for ${baseUrl} as ${envConfig.actAs ?? envConfig.clientId}\n`);
+    const authBaseUrl = ((new URL(baseUrl)).hostname.includes('cms.optimizely.com') ?
+        new URL('/', baseUrl) :
+        new URL('/_cms/v1/', baseUrl)).href;
+    if (envConfig.debug)
+        console.log(`⚪ [CMS API] Creating API-Client for ${baseUrl}\n`);
     let clientToken = undefined;
     const newClientConfig = {
+        ...config,
         security: [{
                 in: 'header',
                 name: 'Authorization',
@@ -32,7 +44,7 @@ const createClientConfig = (config, apiConfig) => {
             }
             if (typeof (clientToken) !== 'string' || clientToken.length == 0) {
                 try {
-                    const token = await (0, getaccesstoken_1.getAccessToken)(envConfig, authBaseUrl.href);
+                    const token = await (0, getaccesstoken_1.getAccessToken)(envConfig, authBaseUrl);
                     clientToken = token;
                     if (envConfig.debug)
                         console.log(`🔑 [CMS API] Using new token`);
@@ -47,8 +59,7 @@ const createClientConfig = (config, apiConfig) => {
                 console.log(`🔑 [CMS API] Using previously generated token`);
             return clientToken;
         },
-        ...config,
-        baseUrl: baseUrl.href,
+        baseUrl: baseUrl,
     };
     return newClientConfig;
 };

package/dist/config.d.ts

@@ -1,16 +1,51 @@
-import { OptiCmsVersion } from './types';
+/**
+ * Configuration options for creating and authenticating a CMS Integration API client.
+ */
 export type CmsIntegrationApiOptions = {
+    /**
+     * The domain where the CMS instance is running
+     */
     base?: URL;
+    /**
+     * The OAuth Client ID for the client credentials login
+     */
     clientId?: string;
+    /**
+     * The OAuth client secret for the client credentials login
+     */
     clientSecret?: string;
+    /**
+     * The username to impersonate, using the special "actAs"
+     * field supported by Optimizely CMS
+     */
     actAs?: string;
+    /**
+     * Flag to enable debugging output
+     */
     debug?: boolean;
     /**
-     * The CMS Schema version that is used
+     * The BaseURL where the services are running
      */
-    cmsVersion?: OptiCmsVersion;
+    apiBaseUrl?: URL;
 };
-type ClientCredentials = 'clientId' | 'clientSecret' | 'cmsVersion';
+type ClientCredentials = 'clientId' | 'clientSecret';
+/**
+ * Reads CMS Integration API configuration from environment variables.
+ *
+ * Client credentials are optional in this variant, which allows callers to
+ * bootstrap configuration and decide credential handling separately.
+ *
+ * @returns A partially populated configuration object.
+ */
 export declare function readPartialEnvConfig(): CmsIntegrationApiOptions;
+/**
+ * Reads and validates CMS Integration API configuration from environment variables.
+ *
+ * This function requires both client credentials to be present and throws when
+ * either value is missing.
+ *
+ * @returns Configuration object with required `clientId` and `clientSecret`.
+ * @throws {Error} When a required client credential is missing.
+ */
 export declare function readEnvConfig(): Omit<CmsIntegrationApiOptions, ClientCredentials> & Pick<Required<CmsIntegrationApiOptions>, ClientCredentials>;
 export {};

package/dist/config.js

@@ -2,22 +2,39 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.readPartialEnvConfig = readPartialEnvConfig;
 exports.readEnvConfig = readEnvConfig;
-const types_1 = require("./types");
+/**
+ * Reads CMS Integration API configuration from environment variables.
+ *
+ * Client credentials are optional in this variant, which allows callers to
+ * bootstrap configuration and decide credential handling separately.
+ *
+ * @returns A partially populated configuration object.
+ */
 function readPartialEnvConfig() {
+    const apiBaseUrl = getOptional('OPTIMIZELY_CMS_API_BASEURL');
     const cmsUrl = getOptional('OPTIMIZELY_CMS_URL');
     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.CMSSAAS], types_1.OptiCmsVersion.CMSSAAS);
-    // Determine the base, if set by the config
+    // Determine the CMS URL, if set by the config
     let base;
     if (cmsUrl) {
         try {
             base = new URL(cmsUrl.includes("://") ? cmsUrl : 'https://' + cmsUrl);
         }
         catch (e) {
-            throw new Error("Invalid Optimizely CMS URL provided");
+            throw new Error("Invalid Optimizely CMS URL provided", { cause: e });
+        }
+    }
+    // Determine the API Base path, if set by the config
+    let apiBase;
+    if (apiBaseUrl) {
+        try {
+            apiBase = new URL(apiBaseUrl);
+        }
+        catch (e) {
+            throw new Error("Invalid Optimizely CMS API Base URL Provided", { cause: e });
         }
     }
     if (debug)
@@ -28,9 +45,18 @@ function readPartialEnvConfig() {
         clientSecret,
         actAs,
         debug,
-        cmsVersion
+        apiBaseUrl: apiBase
     };
 }
+/**
+ * Reads and validates CMS Integration API configuration from environment variables.
+ *
+ * This function requires both client credentials to be present and throws when
+ * either value is missing.
+ *
+ * @returns Configuration object with required `clientId` and `clientSecret`.
+ * @throws {Error} When a required client credential is missing.
+ */
 function readEnvConfig() {
     const partialConfig = readPartialEnvConfig();
     if (!partialConfig.clientId)
@@ -45,17 +71,17 @@ function getOptional(variable, defaultValue) {
         return defaultValue;
     return envValue;
 }
-function getMandatory(variable) {
-    const envValue = process.env[variable];
-    if (!envValue)
-        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;
+/*function getMandatory(variable: string): string {
+  const envValue = process.env[variable]
+  if (!envValue)
+    throw new Error(`The environment variable ${variable} is missing or empty`)
+  return envValue
 }
+function getSelection<T>(envVarName: string, allowedValues: T[], defaultValue: T): T {
+  const rawValue = getOptional(envVarName, defaultValue as string)
+  if (!rawValue)
+    return defaultValue
+  if (allowedValues.some(av => av == rawValue))
+    return rawValue as T
+  return defaultValue
+}*/

package/dist/getaccesstoken.js

@@ -19,18 +19,36 @@ async function getAccessToken(config, baseUrl) {
     headers.append('Connection', 'close');
     if (options.debug) {
         console.log(`⚪ [CMS API] Using authentication endpoint: ${authUrl}`);
-        console.log(`⚪ [CMS API] Retrieving new credentials for ${options.clientId ?? '-'}${options.actAs ? ", acting as " + options.actAs : ""}`);
+        console.log(`⚪ [CMS API] Retrieving new credentials for ${options.clientId ?? '-'}`);
     }
     const body = new URLSearchParams();
     body.append("grant_type", "client_credentials");
-    if (options.actAs)
-        body.append("act_as", options.actAs);
     const httpResponse = await fetch(authUrl, {
         method: "POST",
         headers: headers,
         body: body.toString(),
         cache: "no-store"
     });
+    if (!httpResponse.ok) {
+        console.error(`❌ [CMS API] Network error while authenticating: ${httpResponse.status} ${httpResponse.statusText}`);
+        if (config?.debug) {
+            console.group("Network request");
+            console.log(`URL: ${authUrl}`);
+            console.log(`Method: POST`);
+            headers.entries().forEach(([headerKey, headerValue]) => {
+                console.log(`Header ${headerKey}: ${headerValue}`);
+            });
+            console.log(body.toString());
+            console.groupEnd();
+            console.group("Network response");
+            httpResponse.headers.entries().forEach(([headerKey, headerValue]) => {
+                console.log(`Header ${headerKey}: ${headerValue}`);
+            });
+            console.log(await httpResponse.text());
+            console.groupEnd();
+        }
+        throw new Error(`Network error ${httpResponse.status} ${httpResponse.statusText}`);
+    }
     const response = await httpResponse.json();
     if (isErrorResponse(response))
         throw new Error("Authentication error: " + response.error_description);
@@ -40,7 +58,7 @@ function base64Encode(input) {
     if (btoa && typeof (btoa) == 'function')
         return btoa(input);
     if (Buffer && typeof (Buffer) == 'object')
-        //@ts-expect-error
+        //@ts-expect-error We're running in server context, so no need for errors here
         return Buffer.from(input).toString('base64');
     throw new Error("Unable to base64Encode");
 }

package/dist/index.d.ts

@@ -1,13 +1,32 @@
 export * from './config';
+export type * from './types';
 export * as IntegrationApi from './client/types.gen';
 export { ApiClient, ApiError, ApiClient as CoreClient, type ApiClientStatic, type CmsIntegrationApiClient } from './api-client';
-export { OptiCmsVersion } from "./types";
 import { type CmsIntegrationApiOptions } from './config';
 import { type CmsIntegrationApiClient } from './api-client';
 export { readEnvConfig } from './config';
+/**
+ * Type alias describing a CMS Integration API client instance.
+ */
 export type ApiClientInstance = CmsIntegrationApiClient;
+/**
+ * Creates a new CMS Integration API client instance.
+ *
+ * @param config - Optional client configuration.
+ * @returns The configured API client.
+ */
 export declare function createClient(config?: CmsIntegrationApiOptions): CmsIntegrationApiClient;
+/**
+ * Determines whether a value is a CMS Integration API client instance.
+ *
+ * @param value - Value to inspect.
+ * @returns `true` when the value matches the client instance shape.
+ */
 export declare function isClientInstance(value?: object): value is CmsIntegrationApiClient;
+/**
+ * A list of all hard-coded content roots within Optimizely CMS (Both 12+ & SaaS),
+ * you need these to be able to start reading content from a given location.
+ */
 export declare enum ContentRoots {
     /**
      * The Global root node of the Content Tree

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.readEnvConfig = exports.OptiCmsVersion = exports.CoreClient = exports.ApiError = exports.ApiClient = exports.IntegrationApi = void 0;
+exports.ContentTypeKeys = exports.ContentRoots = exports.readEnvConfig = exports.CoreClient = exports.ApiError = exports.ApiClient = exports.IntegrationApi = void 0;
 exports.createClient = createClient;
 exports.isClientInstance = isClientInstance;
 __exportStar(require("./config"), exports);
@@ -45,19 +45,33 @@ var api_client_1 = require("./api-client");
 Object.defineProperty(exports, "ApiClient", { enumerable: true, get: function () { return api_client_1.ApiClient; } });
 Object.defineProperty(exports, "ApiError", { enumerable: true, get: function () { return api_client_1.ApiError; } });
 Object.defineProperty(exports, "CoreClient", { enumerable: true, get: function () { return api_client_1.ApiClient; } });
-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.readEnvConfig; } });
+/**
+ * Creates a new CMS Integration API client instance.
+ *
+ * @param config - Optional client configuration.
+ * @returns The configured API client.
+ */
 function createClient(config) {
     return new api_client_2.ApiClient(config);
 }
+/**
+ * Determines whether a value is a CMS Integration API client instance.
+ *
+ * @param value - Value to inspect.
+ * @returns `true` when the value matches the client instance shape.
+ */
 function isClientInstance(value) {
     if (typeof value !== 'object' || value === null)
         return false;
-    return typeof value['getInstanceInfo'] === 'function';
+    return typeof value['getSchemaItemBase'] === 'function';
 }
+/**
+ * A list of all hard-coded content roots within Optimizely CMS (Both 12+ & SaaS),
+ * you need these to be able to start reading content from a given location.
+ */
 var ContentRoots;
 (function (ContentRoots) {
     /**

package/dist/types.d.ts

@@ -1,14 +1 @@
-export type InstanceApiVersionInfo = {
-    status: "Healthy";
-    baseUrl?: string;
-    statusDuration: number;
-    apiVersion: string;
-    serviceVersion: string;
-    cmsVersion: string;
-    results: Record<string, any>;
-};
-export declare enum OptiCmsVersion {
-    CMS12 = "OPTI-CMS-12",
-    CMS13 = "OPTI-CMS-13",
-    CMSSAAS = "OPTI-CMS-SAAS"
-}
+export type { OpenAPIV3_1 as OpenAPI } from "openapi-types";

package/dist/types.js

@@ -1,9 +1,2 @@
 "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["CMSSAAS"] = "OPTI-CMS-SAAS";
-})(OptiCmsVersion || (exports.OptiCmsVersion = OptiCmsVersion = {}));

package/dist/version.json

@@ -1,5 +1,5 @@
 {
-    "api": "preview3-1.0.0",
-    "service": "2026.01.06.0826-preview2",
-    "cms": "2026.01.06.0826-preview2"
+    "api": "v1",
+    "service": "unknown",
+    "cms": "unknown"
 }

package/package.json

@@ -2,25 +2,36 @@
   "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-rc.1",
+  "version": "6.0.0-rc.3",
   "type": "commonjs",
   "license": "Apache-2.0",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/remkoj/optimizely-dxp-clients.git",
+    "directory": "packages/optimizely-cms-api"
+  },
+  "bugs": "https://github.com/remkoj/optimizely-dxp-clients/issues",
+  "homepage": "https://github.com/remkoj/optimizely-dxp-clients/blob/main/packages/optimizely-cms-api/README.md",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
   "files": [
-    "./dist"
+    "./dist",
+    "./AGENTS.md"
   ],
   "devDependencies": {
     "@hey-api/client-fetch": "^0.13.1",
-    "@hey-api/openapi-ts": "^0.94.4",
+    "@hey-api/openapi-ts": "^0.99.0",
+    "@remkoj/hey-api-wrapper": "6.0.0-rc.3",
     "rimraf": "^6.1.3"
   },
   "dependencies": {
-    "@types/node": "^22.19.15",
-    "dotenv": "^17.3.1",
-    "dotenv-expand": "^12.0.3",
+    "@remkoj/hey-api-wrapper": "6.0.0-rc.3",
+    "@types/node": "^24.13.3",
+    "dotenv": "^17.4.2",
+    "dotenv-expand": "^13.0.0",
     "glob": "^13.0.6",
-    "openapi-typescript-codegen": "^0.30.0",
+    "openapi-types": "^12.1.3",
+    "openapi-typescript-codegen": "^0.31.0",
     "tslib": "^2.8.1",
     "typescript": "^5.9.3"
   },
@@ -28,7 +39,7 @@
     "clean": "rimraf -g ./dist ./src/client ./*.tsbuildinfo",
     "prepare": "tsc --build && yarn node scripts/copy-client.mjs",
     "watch": "tsc --watch",
-    "rebuild": "yarn clean && yarn generate && tsc --build --force",
+    "recompile": "yarn clean && yarn generate && tsc --build --force",
     "generate": "yarn node scripts/create-client.mjs"
   },
   "stableVersion": "5.2.0"