contentful-management 11.60.3 → 12.0.0-beta.10

package/dist/types/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/types/common-utils.d.ts

@@ -0,0 +1,9 @@
+import type { Collection, CollectionProp, CursorPaginatedCollection, CursorPaginatedCollectionProp, MakeRequest } from './common-types.js';
+/**
+ * @private
+ */
+export declare const wrapCollection: <R, T, Rest extends any[]>(fn: (makeRequest: MakeRequest, entity: T, ...rest: Rest) => R) => (makeRequest: MakeRequest, data: CollectionProp<T>, ...rest: Rest) => Collection<R, T>;
+export declare const wrapCursorPaginatedCollection: <R, T, Rest extends any[]>(fn: (makeRequest: MakeRequest, entity: T, ...rest: Rest) => R) => (makeRequest: MakeRequest, data: CursorPaginatedCollectionProp<T>, ...rest: Rest) => CursorPaginatedCollection<R, T>;
+export declare function isSuccessful(statusCode: number): boolean;
+export declare function shouldRePoll(statusCode: number): boolean;
+export declare function waitFor(ms?: number): Promise<unknown>;

package/dist/types/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/types/constants/editor-interface-defaults/controls-defaults.d.ts

@@ -0,0 +1,244 @@
+import type { ContentFields } from '../../entities/content-type-fields.js';
+declare const INTERNAL_TO_API: {
+    readonly Symbol: {
+        readonly type: "Symbol";
+    };
+    readonly Text: {
+        readonly type: "Text";
+    };
+    readonly RichText: {
+        readonly type: "RichText";
+    };
+    readonly Integer: {
+        readonly type: "Integer";
+    };
+    readonly Number: {
+        readonly type: "Number";
+    };
+    readonly Boolean: {
+        readonly type: "Boolean";
+    };
+    readonly Date: {
+        readonly type: "Date";
+    };
+    readonly Location: {
+        readonly type: "Location";
+    };
+    readonly Object: {
+        readonly type: "Object";
+    };
+    readonly File: {
+        readonly type: "File";
+    };
+    readonly Entry: {
+        readonly type: "Link";
+        readonly linkType: "Entry";
+    };
+    readonly Asset: {
+        readonly type: "Link";
+        readonly linkType: "Asset";
+    };
+    readonly Resource: {
+        readonly type: "ResourceLink";
+    };
+    readonly Symbols: {
+        readonly type: "Array";
+        readonly items: {
+            readonly type: "Symbol";
+        };
+    };
+    readonly Entries: {
+        readonly type: "Array";
+        readonly items: {
+            readonly type: "Link";
+            readonly linkType: "Entry";
+        };
+    };
+    readonly Assets: {
+        readonly type: "Array";
+        readonly items: {
+            readonly type: "Link";
+            readonly linkType: "Asset";
+        };
+    };
+    readonly Resources: {
+        readonly type: "Array";
+        readonly items: {
+            readonly type: "ResourceLink";
+        };
+    };
+};
+export declare const FIELD_TYPES: Array<keyof typeof 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
+ */
+export declare function toInternalFieldType(api: Partial<ContentFields>): "Asset" | "Entry" | "Boolean" | "Symbol" | "Number" | "Resource" | "Text" | "RichText" | "Integer" | "Date" | "Object" | "Location" | "File" | "Symbols" | "Entries" | "Assets" | "Resources" | undefined;
+export declare const DEFAULTS_WIDGET: {
+    Text: {
+        widgetId: string;
+    };
+    Symbol: {
+        widgetId: string;
+    };
+    Integer: {
+        widgetId: string;
+    };
+    Number: {
+        widgetId: string;
+    };
+    Boolean: {
+        widgetId: string;
+    };
+    Date: {
+        widgetId: string;
+    };
+    Location: {
+        widgetId: string;
+    };
+    Object: {
+        widgetId: string;
+    };
+    RichText: {
+        widgetId: string;
+    };
+    Entry: {
+        widgetId: string;
+    };
+    Asset: {
+        widgetId: string;
+    };
+    Symbols: {
+        widgetId: string;
+    };
+    Entries: {
+        widgetId: string;
+    };
+    Assets: {
+        widgetId: string;
+    };
+    File: {
+        widgetId: string;
+    };
+    Resource: {
+        widgetId: string;
+    };
+    Resources: {
+        widgetId: string;
+    };
+};
+export declare const DEFAULTS_SETTINGS: {
+    readonly Boolean: {
+        readonly falseLabel: "No";
+        readonly helpText: null;
+        readonly trueLabel: "Yes";
+    };
+    readonly Date: {
+        readonly helpText: null;
+        readonly ampm: "24";
+        readonly format: "timeZ";
+    };
+    readonly Entry: {
+        readonly helpText: null;
+        readonly showCreateEntityAction: true;
+        readonly showLinkEntityAction: true;
+    };
+    readonly Asset: {
+        readonly helpText: null;
+        readonly showCreateEntityAction: true;
+        readonly showLinkEntityAction: true;
+    };
+    readonly Entries: {
+        readonly helpText: null;
+        readonly bulkEditing: false;
+        readonly showCreateEntityAction: true;
+        readonly showLinkEntityAction: true;
+    };
+    readonly Assets: {
+        readonly helpText: null;
+        readonly showCreateEntityAction: true;
+        readonly showLinkEntityAction: true;
+    };
+};
+interface DefaultWidget {
+    widgetId: string;
+    settings?: {
+        helpText: null | string;
+    };
+    fieldId: string;
+    widgetNamespace: 'builtin';
+}
+/**
+ * Given our internal identifier returns a minimal API field object.
+ */
+export declare function toApiFieldType(internal: keyof typeof INTERNAL_TO_API): {
+    readonly type: "Symbol";
+} | {
+    readonly type: "Text";
+} | {
+    readonly type: "RichText";
+} | {
+    readonly type: "Integer";
+} | {
+    readonly type: "Number";
+} | {
+    readonly type: "Boolean";
+} | {
+    readonly type: "Date";
+} | {
+    readonly type: "Location";
+} | {
+    readonly type: "Object";
+} | {
+    readonly type: "File";
+} | {
+    readonly type: "Link";
+    readonly linkType: "Entry";
+} | {
+    readonly type: "Link";
+    readonly linkType: "Asset";
+} | {
+    readonly type: "ResourceLink";
+} | {
+    readonly type: "Array";
+    readonly items: {
+        readonly type: "Symbol";
+    };
+} | {
+    readonly type: "Array";
+    readonly items: {
+        readonly type: "Link";
+        readonly linkType: "Entry";
+    };
+} | {
+    readonly type: "Array";
+    readonly items: {
+        readonly type: "Link";
+        readonly linkType: "Asset";
+    };
+} | {
+    readonly type: "Array";
+    readonly items: {
+        readonly type: "ResourceLink";
+    };
+};
+export default function getDefaultControlOfField(field: ContentFields): DefaultWidget;
+export {};

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

@@ -0,0 +1,161 @@
+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 = {
+        ...DEFAULTS_WIDGET[field],
+        settings: {
+            helpText: null,
+        },
+        widgetNamespace: 'builtin',
+        fieldId,
+    };
+    if (in_(field, DEFAULTS_SETTINGS)) {
+        defaultWidget.settings = {
+            ...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/types/constants/editor-interface-defaults/editors-defaults.d.ts

@@ -0,0 +1,23 @@
+import { WidgetNamespace } from './types.js';
+export declare const EntryEditorWidgetTypes: {
+    DEFAULT_EDITOR: {
+        name: string;
+        id: string;
+        icon: string;
+    };
+    REFERENCE_TREE: {
+        name: string;
+        id: string;
+        icon: string;
+    };
+    TAGS_EDITOR: {
+        name: string;
+        id: string;
+        icon: string;
+    };
+};
+export declare const EntryConfiguration: {
+    widgetId: string;
+    widgetNamespace: WidgetNamespace;
+    name: string;
+}[];

package/dist/types/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/types/constants/editor-interface-defaults/index.d.ts

@@ -0,0 +1,22 @@
+import getDefaultControlOfField from './controls-defaults.js';
+declare const _default: {
+    SidebarEntryConfiguration: {
+        widgetId: string;
+        widgetNamespace: import("./types.js").WidgetNamespace;
+        name: string;
+        description: string;
+    }[];
+    SidebarAssetConfiguration: {
+        widgetId: string;
+        widgetNamespace: import("./types.js").WidgetNamespace;
+        name: string;
+        description: string;
+    }[];
+    EntryConfiguration: {
+        widgetId: string;
+        widgetNamespace: import("./types.js").WidgetNamespace;
+        name: string;
+    }[];
+    getDefaultControlOfField: typeof getDefaultControlOfField;
+};
+export default _default;

package/dist/types/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/types/constants/editor-interface-defaults/sidebar-defaults.d.ts

@@ -0,0 +1,13 @@
+import { WidgetNamespace } from './types.js';
+export declare const SidebarEntryConfiguration: {
+    widgetId: string;
+    widgetNamespace: WidgetNamespace;
+    name: string;
+    description: string;
+}[];
+export declare const SidebarAssetConfiguration: {
+    widgetId: string;
+    widgetNamespace: WidgetNamespace;
+    name: string;
+    description: string;
+}[];

package/dist/types/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/types/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/types/create-adapter.d.ts

@@ -0,0 +1,13 @@
+/**
+ * @packageDocumentation
+ * @hidden
+ */
+import type { Adapter } from './common-types.js';
+import type { RestAdapterParams } from './adapters/REST/rest-adapter.js';
+export type AdapterParams = {
+    apiAdapter: Adapter;
+};
+/**
+ * @private
+ */
+export declare function createAdapter(params: RestAdapterParams | AdapterParams): Adapter;

package/dist/types/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 };