@remkoj/optimizely-cms-api 2.0.0-pre2

package/dist/client/services/PackagesService.d.ts

@@ -0,0 +1,41 @@
+import type { ImportPackageResult } from '../models/ImportPackageResult';
+import type { Manifest } from '../models/Manifest';
+import type { PackageJob } from '../models/PackageJob';
+import type { CancelablePromise } from '../core/CancelablePromise';
+import type { BaseHttpRequest } from '../core/BaseHttpRequest';
+export declare class PackagesService {
+    readonly httpRequest: BaseHttpRequest;
+    constructor(httpRequest: BaseHttpRequest);
+    /**
+     * Get job status
+     * Get a package job status.
+     * @param key The key of the package job.
+     * @returns PackageJob Success
+     * @throws ApiError
+     */
+    packagesGet(key: string): CancelablePromise<PackageJob>;
+    /**
+     * Export package
+     * Export a data package.
+     * @param includeReadOnly Indicates if read-only resources should be included in the export data.
+     * @returns Manifest Success
+     * @throws ApiError
+     */
+    packagesExport(includeReadOnly?: boolean): CancelablePromise<Manifest>;
+    /**
+     * Import package
+     * Import a data package.
+     * @param container The key of the container content where new content items should be created under.
+     * @param overwriteExistingContentItems Indicates if the existing content item in CMS could be overwritten when the importing package contains
+     * content item with the same key.
+     * If set to `false`, always create new content item under the specified container regardless of the content key.
+     * @param ignoreDataLossWarnings Updates the content type even though the changes might result in data loss.
+     * @param locale Specifies the locale in which content item in that locale will be imported. If no locale is defined
+     * then content in all locales are imported.
+     * @param requestBody
+     * @returns ImportPackageResult Success
+     * @returns PackageJob Accepted
+     * @throws ApiError
+     */
+    packagesImport(container?: string, overwriteExistingContentItems?: boolean, ignoreDataLossWarnings?: boolean, locale?: string, requestBody?: Blob): CancelablePromise<ImportPackageResult | PackageJob>;
+}

package/dist/client/services/PackagesService.js

@@ -0,0 +1,80 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PackagesService = void 0;
+class PackagesService {
+    constructor(httpRequest) {
+        this.httpRequest = httpRequest;
+    }
+    /**
+     * Get job status
+     * Get a package job status.
+     * @param key The key of the package job.
+     * @returns PackageJob Success
+     * @throws ApiError
+     */
+    packagesGet(key) {
+        return this.httpRequest.request({
+            method: 'GET',
+            url: '/packages/{key}',
+            path: {
+                'key': key,
+            },
+            errors: {
+                403: `Forbidden`,
+            },
+        });
+    }
+    /**
+     * Export package
+     * Export a data package.
+     * @param includeReadOnly Indicates if read-only resources should be included in the export data.
+     * @returns Manifest Success
+     * @throws ApiError
+     */
+    packagesExport(includeReadOnly) {
+        return this.httpRequest.request({
+            method: 'GET',
+            url: '/packages',
+            query: {
+                'includeReadOnly': includeReadOnly,
+            },
+            errors: {
+                403: `Forbidden`,
+            },
+        });
+    }
+    /**
+     * Import package
+     * Import a data package.
+     * @param container The key of the container content where new content items should be created under.
+     * @param overwriteExistingContentItems Indicates if the existing content item in CMS could be overwritten when the importing package contains
+     * content item with the same key.
+     * If set to `false`, always create new content item under the specified container regardless of the content key.
+     * @param ignoreDataLossWarnings Updates the content type even though the changes might result in data loss.
+     * @param locale Specifies the locale in which content item in that locale will be imported. If no locale is defined
+     * then content in all locales are imported.
+     * @param requestBody
+     * @returns ImportPackageResult Success
+     * @returns PackageJob Accepted
+     * @throws ApiError
+     */
+    packagesImport(container, overwriteExistingContentItems = false, ignoreDataLossWarnings = false, locale, requestBody) {
+        return this.httpRequest.request({
+            method: 'POST',
+            url: '/packages',
+            query: {
+                'container': container,
+                'overwriteExistingContentItems': overwriteExistingContentItems,
+                'ignoreDataLossWarnings': ignoreDataLossWarnings,
+                'locale': locale,
+            },
+            body: requestBody,
+            mediaType: 'application/vnd.episerver.cms.data',
+            errors: {
+                400: `Bad Request`,
+                403: `Forbidden`,
+            },
+        });
+    }
+}
+exports.PackagesService = PackagesService;

package/dist/client/services/PropertyFormatsService.d.ts

@@ -0,0 +1,26 @@
+import type { PropertyFormat } from '../models/PropertyFormat';
+import type { PropertyFormatPage } from '../models/PropertyFormatPage';
+import type { CancelablePromise } from '../core/CancelablePromise';
+import type { BaseHttpRequest } from '../core/BaseHttpRequest';
+export declare class PropertyFormatsService {
+    readonly httpRequest: BaseHttpRequest;
+    constructor(httpRequest: BaseHttpRequest);
+    /**
+     * List property formats
+     * List all property formats using the provided options.
+     * @param pageIndex
+     * @param pageSize
+     * @returns PropertyFormatPage Success
+     * @throws ApiError
+     */
+    propertyFormatsList(pageIndex?: number, pageSize?: number): CancelablePromise<PropertyFormatPage>;
+    /**
+     * Get property format
+     * Get the property format with the provided key.
+     * @param key The key of the property format to retrieve.
+     * @param allowDeleted Indicates that a deleted property format may be returned.
+     * @returns PropertyFormat Success
+     * @throws ApiError
+     */
+    propertyFormatsGet(key: string, allowDeleted?: boolean): CancelablePromise<PropertyFormat>;
+}

package/dist/client/services/PropertyFormatsService.js

@@ -0,0 +1,53 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PropertyFormatsService = void 0;
+class PropertyFormatsService {
+    constructor(httpRequest) {
+        this.httpRequest = httpRequest;
+    }
+    /**
+     * List property formats
+     * List all property formats using the provided options.
+     * @param pageIndex
+     * @param pageSize
+     * @returns PropertyFormatPage Success
+     * @throws ApiError
+     */
+    propertyFormatsList(pageIndex, pageSize) {
+        return this.httpRequest.request({
+            method: 'GET',
+            url: '/propertyformats',
+            query: {
+                'pageIndex': pageIndex,
+                'pageSize': pageSize,
+            },
+            errors: {
+                403: `Forbidden`,
+            },
+        });
+    }
+    /**
+     * Get property format
+     * Get the property format with the provided key.
+     * @param key The key of the property format to retrieve.
+     * @param allowDeleted Indicates that a deleted property format may be returned.
+     * @returns PropertyFormat Success
+     * @throws ApiError
+     */
+    propertyFormatsGet(key, allowDeleted) {
+        return this.httpRequest.request({
+            method: 'GET',
+            url: '/propertyformats/{key}',
+            path: {
+                'key': key,
+            },
+            query: {
+                'allowDeleted': allowDeleted,
+            },
+            errors: {
+                403: `Forbidden`,
+            },
+        });
+    }
+}
+exports.PropertyFormatsService = PropertyFormatsService;

package/dist/client/services/PropertyGroupsService.d.ts

@@ -0,0 +1,61 @@
+import type { PropertyGroup } from '../models/PropertyGroup';
+import type { PropertyGroupPage } from '../models/PropertyGroupPage';
+import type { CancelablePromise } from '../core/CancelablePromise';
+import type { BaseHttpRequest } from '../core/BaseHttpRequest';
+export declare class PropertyGroupsService {
+    readonly httpRequest: BaseHttpRequest;
+    constructor(httpRequest: BaseHttpRequest);
+    /**
+     * 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?: Array<string>): CancelablePromise<PropertyGroupPage>;
+    /**
+     * Create property group
+     * Create a new property group.
+     * @param requestBody The property group that should be created.
+     * @returns PropertyGroup Success
+     * @throws ApiError
+     */
+    propertyGroupsCreate(requestBody: PropertyGroup): CancelablePromise<PropertyGroup>;
+    /**
+     * 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: string): CancelablePromise<PropertyGroup>;
+    /**
+     * 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: string, requestBody: PropertyGroup): CancelablePromise<PropertyGroup>;
+    /**
+     * 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: string, requestBody: PropertyGroup): CancelablePromise<PropertyGroup>;
+    /**
+     * 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: string): CancelablePromise<PropertyGroup>;
+}

package/dist/client/services/PropertyGroupsService.js

@@ -0,0 +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;

package/dist/config.d.ts

@@ -0,0 +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;

package/dist/config.js

@@ -0,0 +1,36 @@
+"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;
+}

package/dist/index.d.ts

@@ -0,0 +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;

package/dist/index.js

@@ -0,0 +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;

package/package.json

@@ -0,0 +1,27 @@
+{
+  "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",
+  "packageManager": "yarn@4.1.1",
+  "type": "commonjs",
+  "license": "Apache-2.0",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "files": [
+    "./dist"
+  ],
+  "devDependencies": {
+    "@types/node": "^20.12.7",
+    "openapi-typescript-codegen": "^0.29.0",
+    "tslib": "^2.6.2",
+    "typescript": "^5.4.5"
+  },
+  "scripts": {
+    "clean": "tsc --build --clean",
+    "prepare": "yarn generate-client && tsc --build",
+    "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"
+  }
+}