contentful-management 11.60.3 → 12.0.0-beta.10

package/dist/types/adapters/REST/endpoints/webhook.js

@@ -0,0 +1,84 @@
+import copy from 'fast-copy';
+import { get as get$1, post, put, del as del$1 } from './raw.js';
+import { normalizeSelect } from './utils.js';
+
+const getBaseUrl = (params) => `/spaces/${params.spaceId}/webhook_definitions`;
+const getWebhookCallBaseUrl = (params) => `/spaces/${params.spaceId}/webhooks`;
+const getWebhookUrl = (params) => `${getBaseUrl(params)}/${params.webhookDefinitionId}`;
+const getWebhookCallUrl = (params) => `${getWebhookCallBaseUrl(params)}/${params.webhookDefinitionId}/calls`;
+const getWebhookCallDetailsUrl = (params) => `${getWebhookCallBaseUrl(params)}/${params.webhookDefinitionId}/calls/${params.callId}`;
+const getWebhookHealthUrl = (params) => `${getWebhookCallBaseUrl(params)}/${params.webhookDefinitionId}/health`;
+const getWebhookSettingsUrl = (params) => `/spaces/${params.spaceId}/webhook_settings`;
+const getWebhookSigningSecretUrl = (params) => `${getWebhookSettingsUrl(params)}/signing_secret`;
+const getWebhookRetryPolicyUrl = (params) => `${getWebhookSettingsUrl(params)}/retry_policy`;
+const get = (http, params) => {
+    return get$1(http, getWebhookUrl(params));
+};
+const getManyCallDetails = (http, params) => {
+    return get$1(http, getWebhookCallUrl(params), {
+        params: normalizeSelect(params.query),
+    });
+};
+const getCallDetails = (http, params) => {
+    return get$1(http, getWebhookCallDetailsUrl(params));
+};
+const getHealthStatus = (http, params) => {
+    return get$1(http, getWebhookHealthUrl(params));
+};
+const getMany = (http, params) => {
+    return get$1(http, getBaseUrl(params), {
+        params: normalizeSelect(params.query),
+    });
+};
+const getSigningSecret = (http, params) => {
+    return get$1(http, getWebhookSigningSecretUrl(params));
+};
+/**
+ * @deprecated The EAP for this feature has ended. This method will be removed in the next major version.
+ */
+const getRetryPolicy = (http, params) => {
+    return get$1(http, getWebhookRetryPolicyUrl(params));
+};
+const create = (http, params, rawData, headers) => {
+    const data = copy(rawData);
+    return post(http, getBaseUrl(params), data, { headers });
+};
+const createWithId = (http, params, rawData, headers) => {
+    const data = copy(rawData);
+    return put(http, getWebhookUrl(params), data, { headers });
+};
+const update = async (http, params, rawData, headers) => {
+    const data = copy(rawData);
+    delete data.sys;
+    return put(http, getWebhookUrl(params), data, {
+        headers: {
+            'X-Contentful-Version': rawData.sys.version ?? 0,
+            ...headers,
+        },
+    });
+};
+const upsertSigningSecret = async (http, params, rawData) => {
+    const data = copy(rawData);
+    return put(http, getWebhookSigningSecretUrl(params), data);
+};
+/**
+ * @deprecated The EAP for this feature has ended. This method will be removed in the next major version.
+ */
+const upsertRetryPolicy = async (http, params, rawData) => {
+    const data = copy(rawData);
+    return put(http, getWebhookRetryPolicyUrl(params), data);
+};
+const del = (http, params) => {
+    return del$1(http, getWebhookUrl(params));
+};
+const deleteSigningSecret = async (http, params) => {
+    return del$1(http, getWebhookSigningSecretUrl(params));
+};
+/**
+ * @deprecated The EAP for this feature has ended. This method will be removed in the next major version.
+ */
+const deleteRetryPolicy = async (http, params) => {
+    return del$1(http, getWebhookRetryPolicyUrl(params));
+};
+
+export { create, createWithId, del, deleteRetryPolicy, deleteSigningSecret, get, getCallDetails, getHealthStatus, getMany, getManyCallDetails, getRetryPolicy, getSigningSecret, update, upsertRetryPolicy, upsertSigningSecret };

package/dist/types/adapters/REST/endpoints/workflow-definition.d.ts

@@ -0,0 +1,6 @@
+import type { RestEndpoint } from '../types.js';
+export declare const get: RestEndpoint<'WorkflowDefinition', 'get'>;
+export declare const getMany: RestEndpoint<'WorkflowDefinition', 'getMany'>;
+export declare const create: RestEndpoint<'WorkflowDefinition', 'create'>;
+export declare const update: RestEndpoint<'WorkflowDefinition', 'update'>;
+export declare const del: RestEndpoint<'WorkflowDefinition', 'delete'>;

package/dist/types/adapters/REST/endpoints/workflow-definition.js

@@ -0,0 +1,35 @@
+import copy from 'fast-copy';
+import { get as get$1, post, put, del as del$1 } from './raw.js';
+
+const getBaseUrl = (params) => `/spaces/${params.spaceId}/environments/${params.environmentId}/workflow_definitions`;
+const getWorkflowDefinitionUrl = (params) => `${getBaseUrl(params)}/${params.workflowDefinitionId}`;
+const get = (http, params, headers) => get$1(http, getWorkflowDefinitionUrl(params), {
+    headers,
+});
+const getMany = (http, params, headers) => get$1(http, getBaseUrl(params), {
+    headers,
+    params: params.query,
+});
+const create = (http, params, rawData, headers) => {
+    const data = copy(rawData);
+    return post(http, getBaseUrl(params), data, {
+        headers,
+    });
+};
+const update = (http, params, rawData, headers) => {
+    const data = copy(rawData);
+    delete data.sys;
+    return put(http, getWorkflowDefinitionUrl(params), data, {
+        headers: {
+            'X-Contentful-Version': rawData.sys.version ?? 0,
+            ...headers,
+        },
+    });
+};
+const del = (http, { version, ...params }, headers) => {
+    return del$1(http, getWorkflowDefinitionUrl(params), {
+        headers: { 'X-Contentful-Version': version, ...headers },
+    });
+};
+
+export { create, del, get, getMany, update };

package/dist/types/adapters/REST/endpoints/workflow.d.ts

@@ -0,0 +1,7 @@
+import type { RestEndpoint } from '../types.js';
+export declare const getMany: RestEndpoint<'Workflow', 'getMany'>;
+export declare const get: RestEndpoint<'Workflow', 'get'>;
+export declare const create: RestEndpoint<'Workflow', 'create'>;
+export declare const update: RestEndpoint<'Workflow', 'update'>;
+export declare const del: RestEndpoint<'Workflow', 'delete'>;
+export declare const complete: RestEndpoint<'Workflow', 'complete'>;

package/dist/types/adapters/REST/endpoints/workflow.js

@@ -0,0 +1,41 @@
+import copy from 'fast-copy';
+import { get as get$1, post, put, del as del$1 } from './raw.js';
+
+const getBaseUrl = (params) => `/spaces/${params.spaceId}/environments/${params.environmentId}/workflows`;
+const getWorkflowUrl = (params) => `${getBaseUrl(params)}/${params.workflowId}`;
+const completeWorkflowUrl = (params) => `${getWorkflowUrl(params)}/complete`;
+const getMany = (http, params, headers) => get$1(http, getBaseUrl(params), {
+    headers,
+    params: params.query,
+});
+const get = (http, params, headers) => get$1(http, getWorkflowUrl(params), {
+    headers,
+});
+const create = (http, params, rawData, headers) => {
+    const data = copy(rawData);
+    return post(http, getBaseUrl(params), data, {
+        headers,
+    });
+};
+const update = (http, params, rawData, headers) => {
+    const data = copy(rawData);
+    delete data.sys;
+    return put(http, getWorkflowUrl(params), data, {
+        headers: {
+            'X-Contentful-Version': rawData.sys.version ?? 0,
+            ...headers,
+        },
+    });
+};
+const del = (http, { version, ...params }, headers) => {
+    return del$1(http, getWorkflowUrl(params), {
+        headers: { 'X-Contentful-Version': version, ...headers },
+    });
+};
+const complete = (http, { version, ...params }, headers) => {
+    return put(http, completeWorkflowUrl(params), null, {
+        headers: { 'X-Contentful-Version': version, ...headers },
+    });
+};
+
+export { complete, create, del, get, getMany, update };

package/dist/types/adapters/REST/endpoints/workflows-changelog.d.ts

@@ -0,0 +1,2 @@
+import type { RestEndpoint } from '../types.js';
+export declare const getMany: RestEndpoint<'WorkflowsChangelog', 'getMany'>;

package/dist/types/adapters/REST/endpoints/workflows-changelog.js

@@ -0,0 +1,9 @@
+import { get } from './raw.js';
+
+const getBaseUrl = (params) => `/spaces/${params.spaceId}/environments/${params.environmentId}/workflows_changelog`;
+const getMany = (http, params, headers) => get(http, getBaseUrl(params), {
+    headers,
+    params: params.query,
+});
+
+export { getMany };

package/dist/types/adapters/REST/make-request.d.ts

@@ -0,0 +1,7 @@
+import type { AxiosInstance } from 'contentful-sdk-core';
+import type { MakeRequestOptions } from '../../common-types.js';
+type makeAxiosRequest = MakeRequestOptions & {
+    axiosInstance: AxiosInstance;
+};
+export declare const makeRequest: <R>({ axiosInstance, entityType, action: actionInput, params, payload, headers, userAgent, }: makeAxiosRequest) => Promise<R>;
+export {};

package/dist/types/adapters/REST/make-request.js

@@ -0,0 +1,20 @@
+import endpoints from './endpoints/index.js';
+
+const makeRequest = async ({ axiosInstance, entityType, action: actionInput, params, payload, headers, userAgent, }) => {
+    // `delete` is a reserved keyword. Therefore, the methods are called `del`.
+    const action = actionInput === 'delete' ? 'del' : actionInput;
+    const endpoint = 
+    // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+    // @ts-ignore
+    endpoints[entityType]?.[action];
+    if (endpoint === undefined) {
+        throw new Error('Unknown endpoint');
+    }
+    return await endpoint(axiosInstance, params, payload, {
+        ...headers,
+        // overwrite the userAgent with the one passed in the request
+        ...(userAgent ? { 'X-Contentful-User-Agent': userAgent } : {}),
+    });
+};
+
+export { makeRequest };

package/dist/types/adapters/REST/rest-adapter.d.ts

@@ -0,0 +1,25 @@
+import type { CreateHttpClientParams } from 'contentful-sdk-core';
+import type { Adapter, MakeRequestOptions } from '../../common-types.js';
+export type RestAdapterParams = CreateHttpClientParams & {
+    /**
+     * Contentful CMA Access Token
+     */
+    accessToken: CreateHttpClientParams['accessToken'];
+    /**
+     * API host
+     * @default api.contentful.com
+     */
+    host?: string;
+    /**
+     * direct file upload host
+     * @default upload.contentful.com
+     */
+    hostUpload?: string;
+    userAgent?: string | undefined;
+};
+export declare class RestAdapter implements Adapter {
+    private readonly params;
+    private readonly axiosInstance;
+    constructor(params: RestAdapterParams);
+    makeRequest<R>(opts: MakeRequestOptions): Promise<R>;
+}

package/dist/types/adapters/REST/rest-adapter.js

@@ -0,0 +1,41 @@
+import axios from 'axios';
+import { createHttpClient } from 'contentful-sdk-core';
+import copy from 'fast-copy';
+import { makeRequest } from './make-request.js';
+
+/**
+ * @private
+ */
+const defaultHostParameters = {
+    defaultHostname: 'api.contentful.com',
+    defaultHostnameUpload: 'upload.contentful.com',
+};
+class RestAdapter {
+    constructor(params) {
+        if (!params.accessToken) {
+            throw new TypeError('Expected parameter accessToken');
+        }
+        const copiedParams = copy(params);
+        // httpAgent and httpsAgent cannot be copied because they can contain private fields
+        copiedParams.httpAgent = params.httpAgent;
+        copiedParams.httpsAgent = params.httpsAgent;
+        this.params = {
+            ...defaultHostParameters,
+            ...copiedParams,
+        };
+        this.axiosInstance = createHttpClient(axios, {
+            ...this.params,
+            headers: {
+                'Content-Type': 'application/vnd.contentful.management.v1+json',
+                // possibly define a default user agent?
+                ...(params.userAgent ? { 'X-Contentful-User-Agent': params.userAgent } : {}),
+                ...this.params.headers,
+            },
+        });
+    }
+    async makeRequest(opts) {
+        return makeRequest({ ...opts, axiosInstance: this.axiosInstance });
+    }
+}
+
+export { RestAdapter };

package/dist/types/adapters/REST/types.d.ts

@@ -0,0 +1,6 @@
+import type { AxiosInstance } from 'contentful-sdk-core';
+import type { MRActions, MROpts, MRReturn } from '../../common-types.js';
+/**
+ * @private
+ */
+export type RestEndpoint<ET extends keyof MRActions, Action extends keyof MRActions[ET], Params = 'params' extends keyof MROpts<ET, Action, false> ? MROpts<ET, Action, false>['params'] : undefined, Payload = 'payload' extends keyof MROpts<ET, Action, false> ? MROpts<ET, Action, false>['payload'] : undefined, Headers = 'headers' extends keyof MROpts<ET, Action, false> ? MROpts<ET, Action, false>['headers'] : undefined, Return = MRReturn<ET, Action>> = Params extends undefined ? (http: AxiosInstance) => Return : Payload extends undefined ? (http: AxiosInstance, params: Params) => Return : Headers extends undefined ? (http: AxiosInstance, params: Params, payload: Payload) => Return : (http: AxiosInstance, params: Params, payload: Payload, headers: Headers) => Return;