contentful-management 11.52.1 → 12.0.0-beta.1

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

@@ -0,0 +1,42 @@
+import { __rest } from 'tslib';
+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) => {
+    var _a;
+    const data = copy(rawData);
+    delete data.sys;
+    return put(http, getWorkflowUrl(params), data, {
+        headers: Object.assign({ 'X-Contentful-Version': (_a = rawData.sys.version) !== null && _a !== void 0 ? _a : 0 }, headers),
+    });
+};
+const del = (http, _a, headers) => {
+    var { version } = _a, params = __rest(_a, ["version"]);
+    return del$1(http, getWorkflowUrl(params), {
+        headers: Object.assign({ 'X-Contentful-Version': version }, headers),
+    });
+};
+const complete = (http, _a, headers) => {
+    var { version } = _a, params = __rest(_a, ["version"]);
+    return put(http, completeWorkflowUrl(params), null, {
+        headers: Object.assign({ 'X-Contentful-Version': version }, headers),
+    });
+};
+
+export { complete, create, del, get, getMany, update };

package/dist/esm/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/esm/adapters/REST/make-request.js

@@ -0,0 +1,17 @@
+import endpoints from './endpoints/index.js';
+
+const makeRequest = async ({ axiosInstance, entityType, action: actionInput, params, payload, headers, userAgent, }) => {
+    var _a;
+    // `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
+    (_a = endpoints[entityType]) === null || _a === void 0 ? void 0 : _a[action];
+    if (endpoint === undefined) {
+        throw new Error('Unknown endpoint');
+    }
+    return await endpoint(axiosInstance, params, payload, Object.assign(Object.assign({}, headers), (userAgent ? { 'X-Contentful-User-Agent': userAgent } : {})));
+};
+
+export { makeRequest };

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

@@ -0,0 +1,30 @@
+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 = Object.assign(Object.assign({}, defaultHostParameters), copiedParams);
+        this.axiosInstance = createHttpClient(axios, Object.assign(Object.assign({}, this.params), { headers: Object.assign(Object.assign({ 'Content-Type': 'application/vnd.contentful.management.v1+json' }, (params.userAgent ? { 'X-Contentful-User-Agent': params.userAgent } : {})), this.params.headers) }));
+    }
+    async makeRequest(opts) {
+        return makeRequest(Object.assign(Object.assign({}, opts), { axiosInstance: this.axiosInstance }));
+    }
+}
+
+export { RestAdapter };

package/dist/esm/common-types.js

@@ -0,0 +1,6 @@
+var ScheduledActionReferenceFilters;
+(function (ScheduledActionReferenceFilters) {
+    ScheduledActionReferenceFilters["contentTypeAnnotationNotIn"] = "sys.contentType.metadata.annotations.ContentType[nin]";
+})(ScheduledActionReferenceFilters || (ScheduledActionReferenceFilters = {}));
+
+export { ScheduledActionReferenceFilters };

package/dist/esm/common-utils.js

@@ -0,0 +1,32 @@
+import { toPlainObject } from 'contentful-sdk-core';
+import copy from 'fast-copy';
+
+/* eslint-disable @typescript-eslint/ban-ts-comment */
+/**
+ * @private
+ */
+const wrapCollection = (fn) => (makeRequest, data, ...rest) => {
+    const collectionData = toPlainObject(copy(data));
+    // @ts-expect-error
+    collectionData.items = collectionData.items.map((entity) => fn(makeRequest, entity, ...rest));
+    // @ts-expect-error
+    return collectionData;
+};
+const wrapCursorPaginatedCollection = (fn) => (makeRequest, data, ...rest) => {
+    const collectionData = toPlainObject(copy(data));
+    // @ts-expect-error
+    collectionData.items = collectionData.items.map((entity) => fn(makeRequest, entity, ...rest));
+    // @ts-expect-error
+    return collectionData;
+};
+function isSuccessful(statusCode) {
+    return statusCode < 300;
+}
+function shouldRePoll(statusCode) {
+    return [404, 422, 429, 400].includes(statusCode);
+}
+async function waitFor(ms = 1000) {
+    return new Promise((resolve) => setTimeout(resolve, ms));
+}
+
+export { isSuccessful, shouldRePoll, waitFor, wrapCollection, wrapCursorPaginatedCollection };

package/dist/esm/constants/editor-interface-defaults/controls-defaults.js

@@ -0,0 +1,153 @@
+import { in_ } from './types.js';
+
+const DROPDOWN_TYPES = ['Text', 'Symbol', 'Integer', 'Number', 'Boolean'];
+const INTERNAL_TO_API = {
+    Symbol: { type: 'Symbol' },
+    Text: { type: 'Text' },
+    RichText: { type: 'RichText' },
+    Integer: { type: 'Integer' },
+    Number: { type: 'Number' },
+    Boolean: { type: 'Boolean' },
+    Date: { type: 'Date' },
+    Location: { type: 'Location' },
+    Object: { type: 'Object' },
+    File: { type: 'File' },
+    Entry: { type: 'Link', linkType: 'Entry' },
+    Asset: { type: 'Link', linkType: 'Asset' },
+    Resource: { type: 'ResourceLink' },
+    Symbols: { type: 'Array', items: { type: 'Symbol' } },
+    Entries: { type: 'Array', items: { type: 'Link', linkType: 'Entry' } },
+    Assets: { type: 'Array', items: { type: 'Link', linkType: 'Asset' } },
+    Resources: { type: 'Array', items: { type: 'ResourceLink' } },
+};
+const FIELD_TYPES = Object.keys(INTERNAL_TO_API);
+/**
+ * Returns an internal string identifier for an API field object.
+ *
+ * We use this string as a simplified reference to field types.
+ * Possible values are:
+ *
+ * - Symbol
+ * - Symbols
+ * - Text
+ * - RichText
+ * - Integer
+ * - Number
+ * - Boolean
+ * - Date
+ * - Location
+ * - Object
+ * - Entry
+ * - Entries
+ * - Asset
+ * - Assets
+ * - File
+ */
+function toInternalFieldType(api) {
+    return FIELD_TYPES.find((key) => {
+        const internalApi = INTERNAL_TO_API[key];
+        const stripped = {
+            type: api.type,
+            linkType: api.linkType,
+            items: api.items,
+        };
+        if (stripped.items) {
+            stripped.items = { type: stripped.items.type, linkType: stripped.items.linkType };
+        }
+        if (internalApi.type === 'Link') {
+            return internalApi.linkType === stripped.linkType;
+        }
+        if (internalApi.type === 'Array' && internalApi.items && stripped.items) {
+            if (internalApi.items.type === 'Link') {
+                return internalApi.items.linkType === stripped.items.linkType;
+            }
+            return internalApi.items.type === stripped.items.type;
+        }
+        return internalApi.type === stripped.type;
+    });
+}
+const DEFAULTS_WIDGET = {
+    Text: { widgetId: 'markdown' },
+    Symbol: { widgetId: 'singleLine' },
+    Integer: { widgetId: 'numberEditor' },
+    Number: { widgetId: 'numberEditor' },
+    Boolean: { widgetId: 'boolean' },
+    Date: { widgetId: 'datePicker' },
+    Location: { widgetId: 'locationEditor' },
+    Object: { widgetId: 'objectEditor' },
+    RichText: { widgetId: 'richTextEditor' },
+    Entry: { widgetId: 'entryLinkEditor' },
+    Asset: { widgetId: 'assetLinkEditor' },
+    Symbols: { widgetId: 'tagEditor' },
+    Entries: { widgetId: 'entryLinksEditor' },
+    Assets: { widgetId: 'assetLinksEditor' },
+    File: { widgetId: 'fileEditor' },
+    Resource: { widgetId: 'resourceLinkEditor' },
+    Resources: { widgetId: 'resourceLinksEditor' },
+};
+const DEFAULTS_SETTINGS = {
+    Boolean: {
+        falseLabel: 'No',
+        helpText: null,
+        trueLabel: 'Yes',
+    },
+    Date: {
+        helpText: null,
+        ampm: '24',
+        format: 'timeZ',
+    },
+    Entry: {
+        helpText: null,
+        showCreateEntityAction: true,
+        showLinkEntityAction: true,
+    },
+    Asset: {
+        helpText: null,
+        showCreateEntityAction: true,
+        showLinkEntityAction: true,
+    },
+    Entries: {
+        helpText: null,
+        bulkEditing: false,
+        showCreateEntityAction: true,
+        showLinkEntityAction: true,
+    },
+    Assets: {
+        helpText: null,
+        showCreateEntityAction: true,
+        showLinkEntityAction: true,
+    },
+};
+function getDefaultWidget(field, fieldId) {
+    const defaultWidget = Object.assign(Object.assign({}, DEFAULTS_WIDGET[field]), { settings: {
+            helpText: null,
+        }, widgetNamespace: 'builtin', fieldId });
+    if (in_(field, DEFAULTS_SETTINGS)) {
+        defaultWidget.settings = Object.assign(Object.assign({}, defaultWidget.settings), DEFAULTS_SETTINGS[field]);
+    }
+    return defaultWidget;
+}
+/*
+ * Gets the default widget ID for a field:
+ * - If a field allows predefined values then `dropdown` widget is used
+ *   in the presence of the `in` validation.
+ * - If a Text field is a title then the `singleLine` widget is used.
+ * - Otherwise a simple type-to-editor mapping is used.
+ */
+function getDefaultControlOfField(field) {
+    const fieldType = toInternalFieldType(field);
+    if (!fieldType) {
+        throw new Error('Invalid field type');
+    }
+    const hasInValidation = (field.validations || []).find((v) => 'in' in v);
+    if (hasInValidation && DROPDOWN_TYPES.includes(fieldType)) {
+        return {
+            widgetId: 'dropdown',
+            fieldId: field.id,
+            widgetNamespace: 'builtin',
+        };
+    }
+    return getDefaultWidget(fieldType, field.id);
+}
+
+export { DEFAULTS_SETTINGS, DEFAULTS_WIDGET, FIELD_TYPES, getDefaultControlOfField as default, toInternalFieldType };

package/dist/esm/constants/editor-interface-defaults/editors-defaults.js

@@ -0,0 +1,37 @@
+import { WidgetNamespace, DEFAULT_EDITOR_ID } from './types.js';
+
+const EntryEditorWidgetTypes = {
+    DEFAULT_EDITOR: {
+        name: 'Editor',
+        id: DEFAULT_EDITOR_ID,
+        icon: 'Entry',
+    },
+    REFERENCE_TREE: {
+        name: 'References',
+        id: 'reference-tree',
+        icon: 'References',
+    },
+    TAGS_EDITOR: {
+        name: 'Tags',
+        id: 'tags-editor',
+        icon: 'Tags',
+    },
+};
+const DefaultEntryEditor = {
+    widgetId: EntryEditorWidgetTypes.DEFAULT_EDITOR.id,
+    widgetNamespace: WidgetNamespace.EDITOR_BUILTIN,
+    name: EntryEditorWidgetTypes.DEFAULT_EDITOR.name,
+};
+const ReferencesEntryEditor = {
+    widgetId: EntryEditorWidgetTypes.REFERENCE_TREE.id,
+    widgetNamespace: WidgetNamespace.EDITOR_BUILTIN,
+    name: EntryEditorWidgetTypes.REFERENCE_TREE.name,
+};
+const TagsEditor = {
+    widgetId: EntryEditorWidgetTypes.TAGS_EDITOR.id,
+    widgetNamespace: WidgetNamespace.EDITOR_BUILTIN,
+    name: EntryEditorWidgetTypes.TAGS_EDITOR.name,
+};
+const EntryConfiguration = [DefaultEntryEditor, ReferencesEntryEditor, TagsEditor];
+
+export { EntryConfiguration, EntryEditorWidgetTypes };

package/dist/esm/constants/editor-interface-defaults/index.js

@@ -0,0 +1,12 @@
+import { SidebarEntryConfiguration, SidebarAssetConfiguration } from './sidebar-defaults.js';
+import { EntryConfiguration } from './editors-defaults.js';
+import getDefaultControlOfField from './controls-defaults.js';
+
+var index = {
+    SidebarEntryConfiguration,
+    SidebarAssetConfiguration,
+    EntryConfiguration,
+    getDefaultControlOfField,
+};
+
+export { index as default };

package/dist/esm/constants/editor-interface-defaults/sidebar-defaults.js

@@ -0,0 +1,68 @@
+import { WidgetNamespace } from './types.js';
+
+const SidebarWidgetTypes = {
+    USERS: 'users-widget',
+    CONTENT_PREVIEW: 'content-preview-widget',
+    TRANSLATION: 'translation-widget',
+    INCOMING_LINKS: 'incoming-links-widget',
+    PUBLICATION: 'publication-widget',
+    RELEASES: 'releases-widget',
+    VERSIONS: 'versions-widget',
+    INFO_PANEL: 'info-panel',
+    JOBS: 'jobs-widget',
+    COMMENTS_PANEL: 'comments-panel',
+};
+const Publication = {
+    widgetId: SidebarWidgetTypes.PUBLICATION,
+    widgetNamespace: WidgetNamespace.SIDEBAR_BUILTIN,
+    name: 'Publish & Status',
+    description: 'Built-in - View entry status, publish, etc.',
+};
+const Releases = {
+    widgetId: SidebarWidgetTypes.RELEASES,
+    widgetNamespace: WidgetNamespace.SIDEBAR_BUILTIN,
+    name: 'Release',
+    description: 'Built-in - View release, add to it, etc.',
+};
+const ContentPreview = {
+    widgetId: SidebarWidgetTypes.CONTENT_PREVIEW,
+    widgetNamespace: WidgetNamespace.SIDEBAR_BUILTIN,
+    name: 'Preview',
+    description: 'Built-in - Displays preview functionality.',
+};
+const Links = {
+    widgetId: SidebarWidgetTypes.INCOMING_LINKS,
+    widgetNamespace: WidgetNamespace.SIDEBAR_BUILTIN,
+    name: 'Links',
+    description: 'Built-in - Shows where an entry is linked.',
+};
+const Translation = {
+    widgetId: SidebarWidgetTypes.TRANSLATION,
+    widgetNamespace: WidgetNamespace.SIDEBAR_BUILTIN,
+    name: 'Translation',
+    description: 'Built-in - Manage which translations are visible.',
+};
+const Versions = {
+    widgetId: SidebarWidgetTypes.VERSIONS,
+    widgetNamespace: WidgetNamespace.SIDEBAR_BUILTIN,
+    name: 'Versions',
+    description: 'Built-in - View previously published versions. Available only for master environment.',
+};
+const Users = {
+    widgetId: SidebarWidgetTypes.USERS,
+    widgetNamespace: WidgetNamespace.SIDEBAR_BUILTIN,
+    name: 'Users',
+    description: 'Built-in - Displays users on the same entry.',
+};
+const SidebarEntryConfiguration = [
+    Publication,
+    Releases,
+    ContentPreview,
+    Links,
+    Translation,
+    Versions,
+    Users,
+];
+const SidebarAssetConfiguration = [Publication, Releases, Links, Translation, Users];
+
+export { SidebarAssetConfiguration, SidebarEntryConfiguration };

package/dist/esm/constants/editor-interface-defaults/types.js

@@ -0,0 +1,15 @@
+var WidgetNamespace;
+(function (WidgetNamespace) {
+    WidgetNamespace["BUILTIN"] = "builtin";
+    WidgetNamespace["EXTENSION"] = "extension";
+    WidgetNamespace["SIDEBAR_BUILTIN"] = "sidebar-builtin";
+    WidgetNamespace["APP"] = "app";
+    WidgetNamespace["EDITOR_BUILTIN"] = "editor-builtin";
+})(WidgetNamespace || (WidgetNamespace = {}));
+const DEFAULT_EDITOR_ID = 'default-editor';
+/**
+ * @private
+ */
+const in_ = (key, object) => key in object;
+
+export { DEFAULT_EDITOR_ID, WidgetNamespace, in_ };

package/dist/esm/create-adapter.js

@@ -0,0 +1,19 @@
+import { RestAdapter } from './adapters/REST/rest-adapter.js';
+
+/**
+ * @packageDocumentation
+ * @hidden
+ */
+/**
+ * @private
+ */
+function createAdapter(params) {
+    if ('apiAdapter' in params) {
+        return params.apiAdapter;
+    }
+    else {
+        return new RestAdapter(params);
+    }
+}
+
+export { createAdapter };