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

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

@@ -1,26 +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>;
-}
+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 OK
+     * @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 OK
+     * @throws ApiError
+     */
+    propertyFormatsGet(key: string, allowDeleted?: boolean): CancelablePromise<PropertyFormat>;
+}

package/dist/client/services/PropertyFormatsService.js

@@ -10,7 +10,7 @@ class PropertyFormatsService {
      * List all property formats using the provided options.
      * @param pageIndex
      * @param pageSize
-     * @returns PropertyFormatPage Success
+     * @returns PropertyFormatPage OK
      * @throws ApiError
      */
     propertyFormatsList(pageIndex, pageSize) {
@@ -31,7 +31,7 @@ class PropertyFormatsService {
      * 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
+     * @returns PropertyFormat OK
      * @throws ApiError
      */
     propertyFormatsGet(key, allowDeleted) {

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

@@ -1,61 +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>;
-}
+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 OK
+     * @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 OK
+     * @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 OK
+     * @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 OK
+     * @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 OK
+     * @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 OK
+     * @throws ApiError
+     */
+    propertyGroupsDelete(key: string): CancelablePromise<PropertyGroup>;
+}

package/dist/client/services/PropertyGroupsService.js

@@ -11,7 +11,7 @@ class PropertyGroupsService {
      * @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
+     * @returns PropertyGroupPage OK
      * @throws ApiError
      */
     propertyGroupsList(sources) {
@@ -30,7 +30,7 @@ class PropertyGroupsService {
      * Create property group
      * Create a new property group.
      * @param requestBody The property group that should be created.
-     * @returns PropertyGroup Success
+     * @returns PropertyGroup OK
      * @throws ApiError
      */
     propertyGroupsCreate(requestBody) {
@@ -49,7 +49,7 @@ class PropertyGroupsService {
      * Get property group
      * Get the property group with the provided key.
      * @param key The key of the property group to retrieve.
-     * @returns PropertyGroup Success
+     * @returns PropertyGroup OK
      * @throws ApiError
      */
     propertyGroupsGet(key) {
@@ -70,7 +70,7 @@ class PropertyGroupsService {
      * 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
+     * @returns PropertyGroup OK
      * @throws ApiError
      */
     propertyGroupsPut(key, requestBody) {
@@ -93,7 +93,7 @@ class PropertyGroupsService {
      * 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
+     * @returns PropertyGroup OK
      * @throws ApiError
      */
     propertyGroupsPatch(key, requestBody) {
@@ -115,7 +115,7 @@ class PropertyGroupsService {
      * Delete property group
      * Deletes the property group with the provided key.
      * @param key The key of the property group to delete.
-     * @returns PropertyGroup Success
+     * @returns PropertyGroup OK
      * @throws ApiError
      */
     propertyGroupsDelete(key) {

package/dist/config.d.ts

@@ -1,7 +1,8 @@
-export type CmsIntegrationApiOptions = {
-    base: URL;
-    clientId?: string;
-    clientSecret?: string;
-    actAs?: string;
-};
-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

@@ -21,7 +21,8 @@ function getCmsIntegrationApiConfigFromEnvironment() {
         base: baseUrl,
         clientId,
         clientSecret,
-        actAs
+        actAs,
+        debug
     };
 }
 exports.getCmsIntegrationApiConfigFromEnvironment = getCmsIntegrationApiConfigFromEnvironment;

package/dist/getaccesstoken.d.ts

@@ -0,0 +1,3 @@
+import { type CmsIntegrationApiOptions } from "./config";
+export declare function getAccessToken(config?: CmsIntegrationApiOptions): Promise<string>;
+export default getAccessToken;

package/dist/getaccesstoken.js

@@ -0,0 +1,43 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getAccessToken = void 0;
+const config_1 = require("./config");
+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 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 = getAccessToken;

package/dist/index.d.ts

@@ -1,15 +1,16 @@
-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 as CoreClient } from './client';
+export { ApiClient } from './api-client';
+export { ApiClient as CmsIntegrationApiClient } from './api-client';
+import { type CmsIntegrationApiOptions } from './config';
+import { ApiClient as CmsIntegrationApiClient } from './api-client';
+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

@@ -26,53 +26,18 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ContentTypeKeys = exports.ContentRoots = exports.createClient = exports.getAccessToken = exports.CmsIntegrationApiClient = exports.IntegrationApi = void 0;
+exports.ContentTypeKeys = exports.ContentRoots = exports.createClient = exports.CmsIntegrationApiClient = exports.ApiClient = exports.CoreClient = 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;
+Object.defineProperty(exports, "CoreClient", { enumerable: true, get: function () { return client_1.CmsIntegrationApiClient; } });
+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; } });
+const api_client_3 = require("./api-client");
 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;
+    return new api_client_3.ApiClient(config);
 }
 exports.createClient = createClient;
 var ContentRoots;
@@ -84,12 +49,4 @@ 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/dist/types.d.ts

@@ -0,0 +1,8 @@
+export type InstanceApiVersionInfo = {
+    status: "Healthy";
+    statusDuration: number;
+    apiVersion: string;
+    serviceVersion: string;
+    cmsVersion: string;
+    results: Record<string, any>;
+};

package/dist/types.js

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

package/dist/version.json

@@ -0,0 +1,5 @@
+{
+    "api": "preview2-1.0.0",
+    "service": "2024.06.11.0833",
+    "cms": "2024.06.11.0833"
+}

package/package.json

@@ -2,8 +2,8 @@
   "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-pre3",
-  "packageManager": "yarn@4.1.1",
+  "version": "2.0.0-pre5",
+  "packageManager": "yarn@4.3.0",
   "type": "commonjs",
   "license": "Apache-2.0",
   "main": "./dist/index.js",
@@ -12,17 +12,21 @@
     "./dist"
   ],
   "devDependencies": {
-    "@types/node": "^20.12.12",
+    "@types/node": "^20.14.2",
+    "dotenv": "^16.4.5",
+    "glob": "^10.4.1",
     "openapi-typescript-codegen": "^0.29.0",
-    "tslib": "^2.6.2",
+    "tslib": "^2.6.3",
     "typescript": "^5.4.5"
   },
   "scripts": {
     "clean": "tsc --build --clean",
-    "prepare": "yarn generate-client && tsc --build",
+    "prepare": "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"
+    "rebuild": "yarn clean && yarn update-client && tsc --build --force",
+    "update-client": "yarn generate-spec && yarn generate-client",
+    "generate-client": "yarn openapi --input ./integrationapi.spec.json --output ./src/client --name CmsIntegrationApiClient",
+    "generate-spec": "yarn node scripts/update-spec.js"
   },
   "stableVersion": "2.0.0-pre2"
 }