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

package/dist/api-client.d.ts

@@ -0,0 +1,35 @@
+import { CmsIntegrationApiClient } from "./client";
+import { type CmsIntegrationApiOptions } from "./config";
+import type { InstanceApiVersionInfo } from "./types";
+import type { CancelablePromise } from "./client";
+export declare class ApiClient extends CmsIntegrationApiClient {
+    private _config;
+    /**
+     * Create a new instance of the API Client
+     *
+     * @param   config  The instance configuration
+     */
+    constructor(config?: CmsIntegrationApiOptions);
+    /**
+     * The URL of the CMS instance
+     */
+    get cmsUrl(): URL;
+    /**
+     * Marker to indicate if the client has debugging enabled
+     */
+    get debug(): boolean;
+    /**
+     * The API version for which this client was build
+     */
+    get apiVersion(): string;
+    /**
+     * The CMS version for which this client was build
+     */
+    get cmsVersion(): string;
+    /**
+     * Retrieve the version information
+     *
+     * @returns The version information from the running instance
+     */
+    getInstanceInfo(): CancelablePromise<InstanceApiVersionInfo>;
+}

package/dist/api-client.js

@@ -0,0 +1,67 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ApiClient = void 0;
+const client_1 = require("./client");
+const getaccesstoken_1 = require("./getaccesstoken");
+const config_1 = require("./config");
+const version_json_1 = __importDefault(require("./version.json"));
+class ApiClient extends client_1.CmsIntegrationApiClient {
+    /**
+     * Create a new instance of the API Client
+     *
+     * @param   config  The instance configuration
+     */
+    constructor(config) {
+        const options = config ?? (0, config_1.getCmsIntegrationApiConfigFromEnvironment)();
+        super({
+            BASE: options.base.href,
+            TOKEN: () => (0, getaccesstoken_1.getAccessToken)(options),
+            HEADERS: {
+                Connection: "Close"
+            }
+        });
+        this._config = options;
+    }
+    /**
+     * The URL of the CMS instance
+     */
+    get cmsUrl() {
+        return this._config.base;
+    }
+    /**
+     * Marker to indicate if the client has debugging enabled
+     */
+    get debug() {
+        return this._config.debug ?? false;
+    }
+    /**
+     * The API version for which this client was build
+     */
+    get apiVersion() {
+        return version_json_1.default.api;
+    }
+    /**
+     * The CMS version for which this client was build
+     */
+    get cmsVersion() {
+        return version_json_1.default.cms;
+    }
+    /**
+     * Retrieve the version information
+     *
+     * @returns The version information from the running instance
+     */
+    getInstanceInfo() {
+        return this.request.request({
+            method: 'GET',
+            url: '/info',
+            errors: {
+                403: `Forbidden`,
+            },
+        });
+    }
+}
+exports.ApiClient = ApiClient;

package/dist/client/CmsIntegrationApiClient.d.ts

@@ -1,24 +1,24 @@
-import type { BaseHttpRequest } from './core/BaseHttpRequest';
-import type { OpenAPIConfig } from './core/OpenAPI';
-import { ChangesetsService } from './services/ChangesetsService';
-import { ContentService } from './services/ContentService';
-import { ContentTypesService } from './services/ContentTypesService';
-import { DisplayTemplatesService } from './services/DisplayTemplatesService';
-import { OauthService } from './services/OauthService';
-import { PackagesService } from './services/PackagesService';
-import { PropertyFormatsService } from './services/PropertyFormatsService';
-import { PropertyGroupsService } from './services/PropertyGroupsService';
-type HttpRequestConstructor = new (config: OpenAPIConfig) => BaseHttpRequest;
-export declare class CmsIntegrationApiClient {
-    readonly changesets: ChangesetsService;
-    readonly content: ContentService;
-    readonly contentTypes: ContentTypesService;
-    readonly displayTemplates: DisplayTemplatesService;
-    readonly oauth: OauthService;
-    readonly packages: PackagesService;
-    readonly propertyFormats: PropertyFormatsService;
-    readonly propertyGroups: PropertyGroupsService;
-    readonly request: BaseHttpRequest;
-    constructor(config?: Partial<OpenAPIConfig>, HttpRequest?: HttpRequestConstructor);
-}
-export {};
+import type { BaseHttpRequest } from './core/BaseHttpRequest';
+import type { OpenAPIConfig } from './core/OpenAPI';
+import { ChangesetsService } from './services/ChangesetsService';
+import { ContentService } from './services/ContentService';
+import { ContentTypesService } from './services/ContentTypesService';
+import { DisplayTemplatesService } from './services/DisplayTemplatesService';
+import { OauthService } from './services/OauthService';
+import { PackagesService } from './services/PackagesService';
+import { PropertyFormatsService } from './services/PropertyFormatsService';
+import { PropertyGroupsService } from './services/PropertyGroupsService';
+type HttpRequestConstructor = new (config: OpenAPIConfig) => BaseHttpRequest;
+export declare class CmsIntegrationApiClient {
+    readonly changesets: ChangesetsService;
+    readonly content: ContentService;
+    readonly contentTypes: ContentTypesService;
+    readonly displayTemplates: DisplayTemplatesService;
+    readonly oauth: OauthService;
+    readonly packages: PackagesService;
+    readonly propertyFormats: PropertyFormatsService;
+    readonly propertyGroups: PropertyGroupsService;
+    readonly request: BaseHttpRequest;
+    constructor(config?: Partial<OpenAPIConfig>, HttpRequest?: HttpRequestConstructor);
+}
+export {};

package/dist/client/CmsIntegrationApiClient.js

@@ -1,36 +1,36 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.CmsIntegrationApiClient = void 0;
-const FetchHttpRequest_1 = require("./core/FetchHttpRequest");
-const ChangesetsService_1 = require("./services/ChangesetsService");
-const ContentService_1 = require("./services/ContentService");
-const ContentTypesService_1 = require("./services/ContentTypesService");
-const DisplayTemplatesService_1 = require("./services/DisplayTemplatesService");
-const OauthService_1 = require("./services/OauthService");
-const PackagesService_1 = require("./services/PackagesService");
-const PropertyFormatsService_1 = require("./services/PropertyFormatsService");
-const PropertyGroupsService_1 = require("./services/PropertyGroupsService");
-class CmsIntegrationApiClient {
-    constructor(config, HttpRequest = FetchHttpRequest_1.FetchHttpRequest) {
-        this.request = new HttpRequest({
-            BASE: config?.BASE ?? '/_cms/preview2',
-            VERSION: config?.VERSION ?? 'preview2',
-            WITH_CREDENTIALS: config?.WITH_CREDENTIALS ?? false,
-            CREDENTIALS: config?.CREDENTIALS ?? 'include',
-            TOKEN: config?.TOKEN,
-            USERNAME: config?.USERNAME,
-            PASSWORD: config?.PASSWORD,
-            HEADERS: config?.HEADERS,
-            ENCODE_PATH: config?.ENCODE_PATH,
-        });
-        this.changesets = new ChangesetsService_1.ChangesetsService(this.request);
-        this.content = new ContentService_1.ContentService(this.request);
-        this.contentTypes = new ContentTypesService_1.ContentTypesService(this.request);
-        this.displayTemplates = new DisplayTemplatesService_1.DisplayTemplatesService(this.request);
-        this.oauth = new OauthService_1.OauthService(this.request);
-        this.packages = new PackagesService_1.PackagesService(this.request);
-        this.propertyFormats = new PropertyFormatsService_1.PropertyFormatsService(this.request);
-        this.propertyGroups = new PropertyGroupsService_1.PropertyGroupsService(this.request);
-    }
-}
-exports.CmsIntegrationApiClient = CmsIntegrationApiClient;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CmsIntegrationApiClient = void 0;
+const FetchHttpRequest_1 = require("./core/FetchHttpRequest");
+const ChangesetsService_1 = require("./services/ChangesetsService");
+const ContentService_1 = require("./services/ContentService");
+const ContentTypesService_1 = require("./services/ContentTypesService");
+const DisplayTemplatesService_1 = require("./services/DisplayTemplatesService");
+const OauthService_1 = require("./services/OauthService");
+const PackagesService_1 = require("./services/PackagesService");
+const PropertyFormatsService_1 = require("./services/PropertyFormatsService");
+const PropertyGroupsService_1 = require("./services/PropertyGroupsService");
+class CmsIntegrationApiClient {
+    constructor(config, HttpRequest = FetchHttpRequest_1.FetchHttpRequest) {
+        this.request = new HttpRequest({
+            BASE: config?.BASE ?? '/_cms/preview2',
+            VERSION: config?.VERSION ?? 'preview2',
+            WITH_CREDENTIALS: config?.WITH_CREDENTIALS ?? false,
+            CREDENTIALS: config?.CREDENTIALS ?? 'include',
+            TOKEN: config?.TOKEN,
+            USERNAME: config?.USERNAME,
+            PASSWORD: config?.PASSWORD,
+            HEADERS: config?.HEADERS,
+            ENCODE_PATH: config?.ENCODE_PATH,
+        });
+        this.changesets = new ChangesetsService_1.ChangesetsService(this.request);
+        this.content = new ContentService_1.ContentService(this.request);
+        this.contentTypes = new ContentTypesService_1.ContentTypesService(this.request);
+        this.displayTemplates = new DisplayTemplatesService_1.DisplayTemplatesService(this.request);
+        this.oauth = new OauthService_1.OauthService(this.request);
+        this.packages = new PackagesService_1.PackagesService(this.request);
+        this.propertyFormats = new PropertyFormatsService_1.PropertyFormatsService(this.request);
+        this.propertyGroups = new PropertyGroupsService_1.PropertyGroupsService(this.request);
+    }
+}
+exports.CmsIntegrationApiClient = CmsIntegrationApiClient;

package/dist/client/core/ApiError.d.ts

@@ -1,10 +1,10 @@
-import type { ApiRequestOptions } from './ApiRequestOptions';
-import type { ApiResult } from './ApiResult';
-export declare class ApiError extends Error {
-    readonly url: string;
-    readonly status: number;
-    readonly statusText: string;
-    readonly body: any;
-    readonly request: ApiRequestOptions;
-    constructor(request: ApiRequestOptions, response: ApiResult, message: string);
-}
+import type { ApiRequestOptions } from './ApiRequestOptions';
+import type { ApiResult } from './ApiResult';
+export declare class ApiError extends Error {
+    readonly url: string;
+    readonly status: number;
+    readonly statusText: string;
+    readonly body: any;
+    readonly request: ApiRequestOptions;
+    constructor(request: ApiRequestOptions, response: ApiResult, message: string);
+}

package/dist/client/core/ApiError.js

@@ -1,15 +1,15 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ApiError = void 0;
-class ApiError extends Error {
-    constructor(request, response, message) {
-        super(message);
-        this.name = 'ApiError';
-        this.url = response.url;
-        this.status = response.status;
-        this.statusText = response.statusText;
-        this.body = response.body;
-        this.request = request;
-    }
-}
-exports.ApiError = ApiError;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ApiError = void 0;
+class ApiError extends Error {
+    constructor(request, response, message) {
+        super(message);
+        this.name = 'ApiError';
+        this.url = response.url;
+        this.status = response.status;
+        this.statusText = response.statusText;
+        this.body = response.body;
+        this.request = request;
+    }
+}
+exports.ApiError = ApiError;

package/dist/client/core/ApiRequestOptions.d.ts

@@ -1,13 +1,13 @@
-export type ApiRequestOptions = {
-    readonly method: 'GET' | 'PUT' | 'POST' | 'DELETE' | 'OPTIONS' | 'HEAD' | 'PATCH';
-    readonly url: string;
-    readonly path?: Record<string, any>;
-    readonly cookies?: Record<string, any>;
-    readonly headers?: Record<string, any>;
-    readonly query?: Record<string, any>;
-    readonly formData?: Record<string, any>;
-    readonly body?: any;
-    readonly mediaType?: string;
-    readonly responseHeader?: string;
-    readonly errors?: Record<number, string>;
-};
+export type ApiRequestOptions = {
+    readonly method: 'GET' | 'PUT' | 'POST' | 'DELETE' | 'OPTIONS' | 'HEAD' | 'PATCH';
+    readonly url: string;
+    readonly path?: Record<string, any>;
+    readonly cookies?: Record<string, any>;
+    readonly headers?: Record<string, any>;
+    readonly query?: Record<string, any>;
+    readonly formData?: Record<string, any>;
+    readonly body?: any;
+    readonly mediaType?: string;
+    readonly responseHeader?: string;
+    readonly errors?: Record<number, string>;
+};

package/dist/client/core/ApiRequestOptions.js

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

package/dist/client/core/ApiResult.d.ts

@@ -1,7 +1,7 @@
-export type ApiResult = {
-    readonly url: string;
-    readonly ok: boolean;
-    readonly status: number;
-    readonly statusText: string;
-    readonly body: any;
-};
+export type ApiResult = {
+    readonly url: string;
+    readonly ok: boolean;
+    readonly status: number;
+    readonly statusText: string;
+    readonly body: any;
+};

package/dist/client/core/ApiResult.js

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

package/dist/client/core/BaseHttpRequest.d.ts

@@ -1,8 +1,8 @@
-import type { ApiRequestOptions } from './ApiRequestOptions';
-import type { CancelablePromise } from './CancelablePromise';
-import type { OpenAPIConfig } from './OpenAPI';
-export declare abstract class BaseHttpRequest {
-    readonly config: OpenAPIConfig;
-    constructor(config: OpenAPIConfig);
-    abstract request<T>(options: ApiRequestOptions): CancelablePromise<T>;
-}
+import type { ApiRequestOptions } from './ApiRequestOptions';
+import type { CancelablePromise } from './CancelablePromise';
+import type { OpenAPIConfig } from './OpenAPI';
+export declare abstract class BaseHttpRequest {
+    readonly config: OpenAPIConfig;
+    constructor(config: OpenAPIConfig);
+    abstract request<T>(options: ApiRequestOptions): CancelablePromise<T>;
+}

package/dist/client/core/BaseHttpRequest.js

@@ -1,9 +1,9 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.BaseHttpRequest = void 0;
-class BaseHttpRequest {
-    constructor(config) {
-        this.config = config;
-    }
-}
-exports.BaseHttpRequest = BaseHttpRequest;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BaseHttpRequest = void 0;
+class BaseHttpRequest {
+    constructor(config) {
+        this.config = config;
+    }
+}
+exports.BaseHttpRequest = BaseHttpRequest;

package/dist/client/core/CancelablePromise.d.ts

@@ -1,20 +1,20 @@
-export declare class CancelError extends Error {
-    constructor(message: string);
-    get isCancelled(): boolean;
-}
-export interface OnCancel {
-    readonly isResolved: boolean;
-    readonly isRejected: boolean;
-    readonly isCancelled: boolean;
-    (cancelHandler: () => void): void;
-}
-export declare class CancelablePromise<T> implements Promise<T> {
-    #private;
-    constructor(executor: (resolve: (value: T | PromiseLike<T>) => void, reject: (reason?: any) => void, onCancel: OnCancel) => void);
-    get [Symbol.toStringTag](): string;
-    then<TResult1 = T, TResult2 = never>(onFulfilled?: ((value: T) => TResult1 | PromiseLike<TResult1>) | null, onRejected?: ((reason: any) => TResult2 | PromiseLike<TResult2>) | null): Promise<TResult1 | TResult2>;
-    catch<TResult = never>(onRejected?: ((reason: any) => TResult | PromiseLike<TResult>) | null): Promise<T | TResult>;
-    finally(onFinally?: (() => void) | null): Promise<T>;
-    cancel(): void;
-    get isCancelled(): boolean;
-}
+export declare class CancelError extends Error {
+    constructor(message: string);
+    get isCancelled(): boolean;
+}
+export interface OnCancel {
+    readonly isResolved: boolean;
+    readonly isRejected: boolean;
+    readonly isCancelled: boolean;
+    (cancelHandler: () => void): void;
+}
+export declare class CancelablePromise<T> implements Promise<T> {
+    #private;
+    constructor(executor: (resolve: (value: T | PromiseLike<T>) => void, reject: (reason?: any) => void, onCancel: OnCancel) => void);
+    get [Symbol.toStringTag](): string;
+    then<TResult1 = T, TResult2 = never>(onFulfilled?: ((value: T) => TResult1 | PromiseLike<TResult1>) | null, onRejected?: ((reason: any) => TResult2 | PromiseLike<TResult2>) | null): Promise<TResult1 | TResult2>;
+    catch<TResult = never>(onRejected?: ((reason: any) => TResult | PromiseLike<TResult>) | null): Promise<T | TResult>;
+    finally(onFinally?: (() => void) | null): Promise<T>;
+    cancel(): void;
+    get isCancelled(): boolean;
+}