@remkoj/optimizely-cms-api 2.0.0-pre2 → 2.0.0-pre4

package/dist/client/services/PropertyGroupsService.js

@@ -1,135 +1,135 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.PropertyGroupsService = void 0;
-class PropertyGroupsService {
-    constructor(httpRequest) {
-        this.httpRequest = httpRequest;
-    }
-    /**
-     * List property groups
-     * List property groups using the provided options.
-     * @param sources Indicates which property groups sources that should be listed.
-     * Use All to include groups from all sources or
-     * Default to include groups without a specific sources.
-     * @returns PropertyGroupPage Success
-     * @throws ApiError
-     */
-    propertyGroupsList(sources) {
-        return this.httpRequest.request({
-            method: 'GET',
-            url: '/propertygroups',
-            query: {
-                'sources': sources,
-            },
-            errors: {
-                403: `Forbidden`,
-            },
-        });
-    }
-    /**
-     * Create property group
-     * Create a new property group.
-     * @param requestBody The property group that should be created.
-     * @returns PropertyGroup Success
-     * @throws ApiError
-     */
-    propertyGroupsCreate(requestBody) {
-        return this.httpRequest.request({
-            method: 'POST',
-            url: '/propertygroups',
-            body: requestBody,
-            mediaType: 'application/json',
-            errors: {
-                400: `Bad Request`,
-                403: `Forbidden`,
-            },
-        });
-    }
-    /**
-     * Get property group
-     * Get the property group with the provided key.
-     * @param key The key of the property group to retrieve.
-     * @returns PropertyGroup Success
-     * @throws ApiError
-     */
-    propertyGroupsGet(key) {
-        return this.httpRequest.request({
-            method: 'GET',
-            url: '/propertygroups/{key}',
-            path: {
-                'key': key,
-            },
-            errors: {
-                403: `Forbidden`,
-            },
-        });
-    }
-    /**
-     * Create or replace property group
-     * Create or replace a property group. If a property group with the provided key exist it is replaced.
-     * Otherwise a new property group is created.
-     * @param key The key of the property group to update or create.
-     * @param requestBody The values of the created or replaced property group.
-     * @returns PropertyGroup Success
-     * @throws ApiError
-     */
-    propertyGroupsPut(key, requestBody) {
-        return this.httpRequest.request({
-            method: 'PUT',
-            url: '/propertygroups/{key}',
-            path: {
-                'key': key,
-            },
-            body: requestBody,
-            mediaType: 'application/json',
-            errors: {
-                400: `Bad Request`,
-                403: `Forbidden`,
-            },
-        });
-    }
-    /**
-     * Update property group
-     * Update an existing property group.
-     * @param key The key of the property group to patch.
-     * @param requestBody The values of the property group that should be updated.
-     * @returns PropertyGroup Success
-     * @throws ApiError
-     */
-    propertyGroupsPatch(key, requestBody) {
-        return this.httpRequest.request({
-            method: 'PATCH',
-            url: '/propertygroups/{key}',
-            path: {
-                'key': key,
-            },
-            body: requestBody,
-            mediaType: 'application/merge-patch+json',
-            errors: {
-                400: `Bad Request`,
-                403: `Forbidden`,
-            },
-        });
-    }
-    /**
-     * Delete property group
-     * Deletes the property group with the provided key.
-     * @param key The key of the property group to delete.
-     * @returns PropertyGroup Success
-     * @throws ApiError
-     */
-    propertyGroupsDelete(key) {
-        return this.httpRequest.request({
-            method: 'DELETE',
-            url: '/propertygroups/{key}',
-            path: {
-                'key': key,
-            },
-            errors: {
-                400: `Bad Request`,
-                403: `Forbidden`,
-            },
-        });
-    }
-}
-exports.PropertyGroupsService = PropertyGroupsService;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PropertyGroupsService = void 0;
+class PropertyGroupsService {
+    constructor(httpRequest) {
+        this.httpRequest = httpRequest;
+    }
+    /**
+     * List property groups
+     * List property groups using the provided options.
+     * @param sources Indicates which property groups sources that should be listed.
+     * Use All to include groups from all sources or
+     * Default to include groups without a specific sources.
+     * @returns PropertyGroupPage Success
+     * @throws ApiError
+     */
+    propertyGroupsList(sources) {
+        return this.httpRequest.request({
+            method: 'GET',
+            url: '/propertygroups',
+            query: {
+                'sources': sources,
+            },
+            errors: {
+                403: `Forbidden`,
+            },
+        });
+    }
+    /**
+     * Create property group
+     * Create a new property group.
+     * @param requestBody The property group that should be created.
+     * @returns PropertyGroup Success
+     * @throws ApiError
+     */
+    propertyGroupsCreate(requestBody) {
+        return this.httpRequest.request({
+            method: 'POST',
+            url: '/propertygroups',
+            body: requestBody,
+            mediaType: 'application/json',
+            errors: {
+                400: `Bad Request`,
+                403: `Forbidden`,
+            },
+        });
+    }
+    /**
+     * Get property group
+     * Get the property group with the provided key.
+     * @param key The key of the property group to retrieve.
+     * @returns PropertyGroup Success
+     * @throws ApiError
+     */
+    propertyGroupsGet(key) {
+        return this.httpRequest.request({
+            method: 'GET',
+            url: '/propertygroups/{key}',
+            path: {
+                'key': key,
+            },
+            errors: {
+                403: `Forbidden`,
+            },
+        });
+    }
+    /**
+     * Create or replace property group
+     * Create or replace a property group. If a property group with the provided key exist it is replaced.
+     * Otherwise a new property group is created.
+     * @param key The key of the property group to update or create.
+     * @param requestBody The values of the created or replaced property group.
+     * @returns PropertyGroup Success
+     * @throws ApiError
+     */
+    propertyGroupsPut(key, requestBody) {
+        return this.httpRequest.request({
+            method: 'PUT',
+            url: '/propertygroups/{key}',
+            path: {
+                'key': key,
+            },
+            body: requestBody,
+            mediaType: 'application/json',
+            errors: {
+                400: `Bad Request`,
+                403: `Forbidden`,
+            },
+        });
+    }
+    /**
+     * Update property group
+     * Update an existing property group.
+     * @param key The key of the property group to patch.
+     * @param requestBody The values of the property group that should be updated.
+     * @returns PropertyGroup Success
+     * @throws ApiError
+     */
+    propertyGroupsPatch(key, requestBody) {
+        return this.httpRequest.request({
+            method: 'PATCH',
+            url: '/propertygroups/{key}',
+            path: {
+                'key': key,
+            },
+            body: requestBody,
+            mediaType: 'application/merge-patch+json',
+            errors: {
+                400: `Bad Request`,
+                403: `Forbidden`,
+            },
+        });
+    }
+    /**
+     * Delete property group
+     * Deletes the property group with the provided key.
+     * @param key The key of the property group to delete.
+     * @returns PropertyGroup Success
+     * @throws ApiError
+     */
+    propertyGroupsDelete(key) {
+        return this.httpRequest.request({
+            method: 'DELETE',
+            url: '/propertygroups/{key}',
+            path: {
+                'key': key,
+            },
+            errors: {
+                400: `Bad Request`,
+                403: `Forbidden`,
+            },
+        });
+    }
+}
+exports.PropertyGroupsService = PropertyGroupsService;

package/dist/config.d.ts

@@ -1,8 +1,8 @@
-export type CmsIntegrationApiOptions = {
-    base: URL;
-    clientId?: string;
-    clientSecret?: string;
-    actAs?: string;
-};
-export declare const API_VERSION = "v0.5";
-export declare function getCmsIntegrationApiConfigFromEnvironment(): CmsIntegrationApiOptions;
+export type CmsIntegrationApiOptions = {
+    base: URL;
+    clientId?: string;
+    clientSecret?: string;
+    actAs?: string;
+    debug?: boolean;
+};
+export declare function getCmsIntegrationApiConfigFromEnvironment(): CmsIntegrationApiOptions;

package/dist/config.js

@@ -1,36 +1,40 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getCmsIntegrationApiConfigFromEnvironment = exports.API_VERSION = void 0;
-exports.API_VERSION = 'v0.5';
-function getCmsIntegrationApiConfigFromEnvironment() {
-    const cmsUrl = getMandatory('OPTIMIZELY_CMS_URL');
-    const clientId = getMandatory('OPTIMIZELY_CMS_CLIENT_ID');
-    const clientSecret = getMandatory('OPTIMIZELY_CMS_CLIENT_SECRET');
-    const actAs = getOptional('OPTIMIZELY_CMS_USER_ID');
-    let baseUrl;
-    try {
-        baseUrl = new URL('/_cms/' + exports.API_VERSION, cmsUrl);
-    }
-    catch {
-        throw new Error("Invalid URL provided");
-    }
-    return {
-        base: baseUrl,
-        clientId,
-        clientSecret,
-        actAs
-    };
-}
-exports.getCmsIntegrationApiConfigFromEnvironment = getCmsIntegrationApiConfigFromEnvironment;
-function getOptional(variable, defaultValue) {
-    const envValue = process.env[variable];
-    if (!envValue || envValue == "")
-        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;
-}
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getCmsIntegrationApiConfigFromEnvironment = void 0;
+const OpenAPI_1 = require("./client/core/OpenAPI");
+function getCmsIntegrationApiConfigFromEnvironment() {
+    const cmsUrl = getMandatory('OPTIMIZELY_CMS_URL');
+    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";
+    let baseUrl;
+    try {
+        baseUrl = new URL(OpenAPI_1.OpenAPI.BASE, cmsUrl);
+    }
+    catch {
+        throw new Error("Invalid URL provided");
+    }
+    if (debug)
+        console.log(`[Optimizely CMS API] Connecting to ${baseUrl} as ${clientId}`);
+    return {
+        base: baseUrl,
+        clientId,
+        clientSecret,
+        actAs,
+        debug
+    };
+}
+exports.getCmsIntegrationApiConfigFromEnvironment = getCmsIntegrationApiConfigFromEnvironment;
+function getOptional(variable, defaultValue) {
+    const envValue = process.env[variable];
+    if (!envValue || envValue == "")
+        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;
+}

package/dist/index.d.ts

@@ -1,15 +1,15 @@
-export * from './config';
-export * as IntegrationApi from './client';
-export { CmsIntegrationApiClient } from './client';
-import { type CmsIntegrationApiOptions } from './config';
-import { CmsIntegrationApiClient } from './client';
-export declare function getAccessToken(config?: CmsIntegrationApiOptions): Promise<string>;
-export declare function createClient(config?: CmsIntegrationApiOptions): CmsIntegrationApiClient;
-export declare enum ContentRoots {
-    SystemRoot = "43f936c99b234ea397b261c538ad07c9",
-    MultiChannelContent = "41118A415C8C4BE08E73520FF3DE8244"
-}
-export declare enum ContentTypeKeys {
-    Folder = "SysContentFolder"
-}
-export default createClient;
+export * from './config';
+export * as IntegrationApi from './client';
+export { CmsIntegrationApiClient } from './client';
+import { type CmsIntegrationApiOptions } from './config';
+import { CmsIntegrationApiClient } from './client';
+export declare function getAccessToken(config?: CmsIntegrationApiOptions): Promise<string>;
+export declare function createClient(config?: CmsIntegrationApiOptions): CmsIntegrationApiClient;
+export declare enum ContentRoots {
+    SystemRoot = "43f936c99b234ea397b261c538ad07c9",
+    MultiChannelContent = "41118A415C8C4BE08E73520FF3DE8244"
+}
+export declare enum ContentTypeKeys {
+    Folder = "SysContentFolder"
+}
+export default createClient;

package/dist/index.js

@@ -1,95 +1,95 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ContentTypeKeys = exports.ContentRoots = exports.createClient = exports.getAccessToken = exports.CmsIntegrationApiClient = exports.IntegrationApi = void 0;
-__exportStar(require("./config"), exports);
-exports.IntegrationApi = __importStar(require("./client"));
-var client_1 = require("./client");
-Object.defineProperty(exports, "CmsIntegrationApiClient", { enumerable: true, get: function () { return client_1.CmsIntegrationApiClient; } });
-const config_1 = require("./config");
-const client_2 = require("./client");
-function isErrorResponse(response) {
-    return typeof (response.error) == 'string';
-}
-let _access_token = undefined;
-async function getAccessToken(config) {
-    if (!_access_token) {
-        _access_token = (async (config) => {
-            const options = config ?? (0, config_1.getCmsIntegrationApiConfigFromEnvironment)();
-            const authUrl = `${options.base.href}/oauth/token`;
-            const headers = new Headers();
-            headers.append('Authorization', `Basic ${base64Encode(`${options.clientId}:${options.clientSecret}`)}`);
-            headers.append('Content-Type', 'application/x-www-form-urlencoded');
-            headers.append('Connection', 'close');
-            const body = new URLSearchParams();
-            body.append("grant_type", "client_credentials");
-            if (options.actAs)
-                body.append("act_as", options.actAs);
-            const response = await (await fetch(authUrl, {
-                method: "POST",
-                headers: headers,
-                body: body.toString()
-            })).json();
-            if (isErrorResponse(response))
-                throw new Error("Authentication error: " + response.error_description);
-            return response.access_token;
-        })(config);
-    }
-    return _access_token;
-}
-exports.getAccessToken = getAccessToken;
-function createClient(config) {
-    const options = config ?? (0, config_1.getCmsIntegrationApiConfigFromEnvironment)();
-    const client = new client_2.CmsIntegrationApiClient({
-        BASE: options.base.href,
-        TOKEN: () => getAccessToken(options),
-        HEADERS: {
-            Connection: "Close"
-        }
-    });
-    return client;
-}
-exports.createClient = createClient;
-var ContentRoots;
-(function (ContentRoots) {
-    ContentRoots["SystemRoot"] = "43f936c99b234ea397b261c538ad07c9";
-    ContentRoots["MultiChannelContent"] = "41118A415C8C4BE08E73520FF3DE8244";
-})(ContentRoots || (exports.ContentRoots = ContentRoots = {}));
-var ContentTypeKeys;
-(function (ContentTypeKeys) {
-    ContentTypeKeys["Folder"] = "SysContentFolder";
-})(ContentTypeKeys || (exports.ContentTypeKeys = ContentTypeKeys = {}));
-function base64Encode(input) {
-    if (btoa && typeof (btoa) == 'function')
-        return btoa(input);
-    if (Buffer && typeof (Buffer) == 'object')
-        //@ts-expect-error
-        return Buffer.from(input).toString('base64');
-    throw new Error("Unable to base64Encode");
-}
-exports.default = createClient;
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ContentTypeKeys = exports.ContentRoots = exports.createClient = exports.getAccessToken = exports.CmsIntegrationApiClient = exports.IntegrationApi = void 0;
+__exportStar(require("./config"), exports);
+exports.IntegrationApi = __importStar(require("./client"));
+var client_1 = require("./client");
+Object.defineProperty(exports, "CmsIntegrationApiClient", { enumerable: true, get: function () { return client_1.CmsIntegrationApiClient; } });
+const config_1 = require("./config");
+const client_2 = require("./client");
+function isErrorResponse(response) {
+    return typeof (response.error) == 'string';
+}
+let _access_token = undefined;
+async function getAccessToken(config) {
+    if (!_access_token) {
+        _access_token = (async (config) => {
+            const options = config ?? (0, config_1.getCmsIntegrationApiConfigFromEnvironment)();
+            const authUrl = `${options.base.href}/oauth/token`;
+            const headers = new Headers();
+            headers.append('Authorization', `Basic ${base64Encode(`${options.clientId}:${options.clientSecret}`)}`);
+            headers.append('Content-Type', 'application/x-www-form-urlencoded');
+            headers.append('Connection', 'close');
+            const body = new URLSearchParams();
+            body.append("grant_type", "client_credentials");
+            if (options.actAs)
+                body.append("act_as", options.actAs);
+            const response = await (await fetch(authUrl, {
+                method: "POST",
+                headers: headers,
+                body: body.toString()
+            })).json();
+            if (isErrorResponse(response))
+                throw new Error("Authentication error: " + response.error_description);
+            return response.access_token;
+        })(config);
+    }
+    return _access_token;
+}
+exports.getAccessToken = getAccessToken;
+function createClient(config) {
+    const options = config ?? (0, config_1.getCmsIntegrationApiConfigFromEnvironment)();
+    const client = new client_2.CmsIntegrationApiClient({
+        BASE: options.base.href,
+        TOKEN: () => getAccessToken(options),
+        HEADERS: {
+            Connection: "Close"
+        }
+    });
+    return client;
+}
+exports.createClient = createClient;
+var ContentRoots;
+(function (ContentRoots) {
+    ContentRoots["SystemRoot"] = "43f936c99b234ea397b261c538ad07c9";
+    ContentRoots["MultiChannelContent"] = "41118A415C8C4BE08E73520FF3DE8244";
+})(ContentRoots || (exports.ContentRoots = ContentRoots = {}));
+var ContentTypeKeys;
+(function (ContentTypeKeys) {
+    ContentTypeKeys["Folder"] = "SysContentFolder";
+})(ContentTypeKeys || (exports.ContentTypeKeys = ContentTypeKeys = {}));
+function base64Encode(input) {
+    if (btoa && typeof (btoa) == 'function')
+        return btoa(input);
+    if (Buffer && typeof (Buffer) == 'object')
+        //@ts-expect-error
+        return Buffer.from(input).toString('base64');
+    throw new Error("Unable to base64Encode");
+}
+exports.default = createClient;

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.0-pre2",
+  "version": "2.0.0-pre4",
   "packageManager": "yarn@4.1.1",
   "type": "commonjs",
   "license": "Apache-2.0",
@@ -12,7 +12,7 @@
     "./dist"
   ],
   "devDependencies": {
-    "@types/node": "^20.12.7",
+    "@types/node": "^20.12.12",
     "openapi-typescript-codegen": "^0.29.0",
     "tslib": "^2.6.2",
     "typescript": "^5.4.5"
@@ -23,5 +23,6 @@
     "watch": "tsc --watch",
     "rebuild": "tsc --build --clean && yarn generate-client && tsc --build --force",
     "generate-client": "yarn openapi --input ./integrationapi.spec.json --output ./src/client --name CmsIntegrationApiClient"
-  }
+  },
+  "stableVersion": "2.0.0-pre2"
 }