@webiny/app-headless-cms-common 0.0.0-unstable.085ff6572f → 0.0.0-unstable.0d717d18dd

package/README.md

@@ -1,18 +1,11 @@
 # @webiny/app-headless-cms-common
 
-[![](https://img.shields.io/npm/dw/@webiny/app-headless-cms-common.svg)](https://www.npmjs.com/package/@webiny/app-headless-cms-common)
-[![](https://img.shields.io/npm/v/@webiny/app-headless-cms-common.svg)](https://www.npmjs.com/package/@webiny/app-headless-cms-common)
-[![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square)](https://github.com/prettier/prettier)
-[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](http://makeapullrequest.com)
+> [!NOTE]
+> This package is part of the [Webiny](https://www.webiny.com) monorepo.
+> It’s **included in every Webiny project by default** and is not meant to be used as a standalone package.
 
-## Install
+📘 **Documentation:** [https://www.webiny.com/docs](https://www.webiny.com/docs)
 
-```
-npm install --save @webiny/app-headless-cms-common
-```
+---
 
-Or if you prefer yarn:
-
-```
-yarn add @webiny/app-headless-cms-common
-```
+_This README file is automatically generated during the publish process._

package/constants.d.ts

@@ -0,0 +1 @@
+export declare const CMS_MODEL_SINGLETON_TAG = "singleEntry";

package/constants.js

@@ -0,0 +1,4 @@
+const CMS_MODEL_SINGLETON_TAG = "singleEntry";
+export { CMS_MODEL_SINGLETON_TAG };
+
+//# sourceMappingURL=constants.js.map

package/constants.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.js","sources":["../src/constants.ts"],"sourcesContent":["export const CMS_MODEL_SINGLETON_TAG = \"singleEntry\";\n"],"names":["CMS_MODEL_SINGLETON_TAG"],"mappings":"AAAO,MAAMA,0BAA0B"}

package/exports/admin/cms.d.ts

@@ -0,0 +1 @@
+export type { CmsContentEntry, CmsModel, CmsModelField, CmsModelLayoutField, CmsIdentity } from "../../types/index.js";

package/index.d.ts

@@ -1,3 +1 @@
-export * from "./entries.graphql";
-export * from "./getModelTitleFieldId";
-export * from "./createFieldsList";
+export { CMS_MODEL_SINGLETON_TAG } from "./constants.js";

package/index.js

@@ -1,38 +1 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-var _entries = require("./entries.graphql");
-Object.keys(_entries).forEach(function (key) {
-  if (key === "default" || key === "__esModule") return;
-  if (key in exports && exports[key] === _entries[key]) return;
-  Object.defineProperty(exports, key, {
-    enumerable: true,
-    get: function get() {
-      return _entries[key];
-    }
-  });
-});
-var _getModelTitleFieldId = require("./getModelTitleFieldId");
-Object.keys(_getModelTitleFieldId).forEach(function (key) {
-  if (key === "default" || key === "__esModule") return;
-  if (key in exports && exports[key] === _getModelTitleFieldId[key]) return;
-  Object.defineProperty(exports, key, {
-    enumerable: true,
-    get: function get() {
-      return _getModelTitleFieldId[key];
-    }
-  });
-});
-var _createFieldsList = require("./createFieldsList");
-Object.keys(_createFieldsList).forEach(function (key) {
-  if (key === "default" || key === "__esModule") return;
-  if (key in exports && exports[key] === _createFieldsList[key]) return;
-  Object.defineProperty(exports, key, {
-    enumerable: true,
-    get: function get() {
-      return _createFieldsList[key];
-    }
-  });
-});
+export { CMS_MODEL_SINGLETON_TAG } from "./constants.js";

package/package.json

@@ -1,7 +1,11 @@
 {
 	"name": "@webiny/app-headless-cms-common",
-	"version": "0.0.0-unstable.085ff6572f",
-	"main": "index.js",
+	"version": "0.0.0-unstable.0d717d18dd",
+	"type": "module",
+	"exports": {
+		".": "./index.js",
+		"./*": "./*"
+	},
 	"repository": {
 		"type": "git",
 		"url": "https://github.com/webiny/webiny-js.git"
@@ -13,40 +17,27 @@
 	],
 	"license": "MIT",
 	"dependencies": {
-		"@babel/runtime": "7.20.13",
-		"@fortawesome/fontawesome-svg-core": "1.3.0",
-		"@types/react": "17.0.39",
-		"@webiny/app-security": "0.0.0-unstable.085ff6572f",
-		"@webiny/form": "0.0.0-unstable.085ff6572f",
-		"@webiny/plugins": "0.0.0-unstable.085ff6572f",
-		"graphql": "15.8.0",
-		"graphql-tag": "2.12.6",
-		"prop-types": "15.8.1",
-		"react": "17.0.2",
-		"react-dnd": "11.1.3"
+		"@fortawesome/fontawesome-svg-core": "7.3.1",
+		"@webiny/admin-ui": "0.0.0-unstable.0d717d18dd",
+		"@webiny/app": "0.0.0-unstable.0d717d18dd",
+		"@webiny/app-admin": "0.0.0-unstable.0d717d18dd",
+		"@webiny/form": "0.0.0-unstable.0d717d18dd",
+		"@webiny/plugins": "0.0.0-unstable.0d717d18dd",
+		"@webiny/validation": "0.0.0-unstable.0d717d18dd",
+		"dnd-core": "16.0.1",
+		"react": "18.3.1"
 	},
 	"devDependencies": {
-		"@babel/cli": "7.20.7",
-		"@babel/core": "7.20.12",
-		"@babel/preset-env": "7.20.2",
-		"@babel/preset-react": "7.18.6",
-		"@babel/preset-typescript": "7.18.6",
-		"@webiny/cli": "0.0.0-unstable.085ff6572f",
-		"@webiny/project-utils": "0.0.0-unstable.085ff6572f",
-		"babel-plugin-emotion": "9.2.11",
-		"babel-plugin-lodash": "3.3.4",
-		"babel-plugin-module-resolver": "4.1.0",
-		"rimraf": "3.0.2",
-		"ttypescript": "1.5.15",
-		"typescript": "4.7.4"
+		"@types/react": "18.3.31",
+		"@webiny/build-tools": "0.0.0-unstable.0d717d18dd",
+		"rimraf": "6.1.3",
+		"typescript": "7.0.2"
 	},
 	"publishConfig": {
-		"access": "public",
-		"directory": "dist"
-	},
-	"scripts": {
-		"build": "yarn webiny run build",
-		"watch": "yarn webiny run watch"
+		"access": "public"
 	},
-	"gitHead": "085ff6572f6bb6a76d218088b06d9f4ef92bbea7"
+	"gitHead": "8476da73b653c89cc1474d968baf55c1b0ae0e5f",
+	"webiny": {
+		"publishFrom": "dist"
+	}
 }

package/types/index.d.ts

@@ -1,293 +1,37 @@
-import * as React from "react";
-import { ReactElement, ReactNode } from "react";
-import { Plugin } from "@webiny/plugins/types";
-import { BindComponent as BaseBindComponent, BindComponentProps as BaseBindComponentProps, BindComponentRenderProp as BaseBindComponentRenderProp, FormAPI } from "@webiny/form";
-import { IconName, IconPrefix } from "@fortawesome/fontawesome-svg-core";
-import { SecurityPermission } from "@webiny/app-security/types";
-import { CmsModelFieldValidator, CmsModelFieldValidatorsFactory, CmsModelFieldValidatorsGroup } from "./validation";
-import { CmsModel, CmsModelField } from "./model";
-import { CmsIdentity } from "./shared";
-import { DragObjectWithType } from "react-dnd";
-export * from "./validation";
-export * from "./model";
-export * from "./shared";
-interface QueryFieldParams {
-    model: CmsModel;
-    field: CmsModelField;
-}
+import type * as React from "react";
+import type { ReactElement, ReactNode } from "react";
+import type { Plugin } from "@webiny/plugins/types.js";
+import type { BindComponent as BaseBindComponent, BindComponentProps as BaseBindComponentProps, BindComponentRenderProp as BaseBindComponentRenderProp, FormAPI } from "@webiny/form";
+import type { IconName, IconPrefix } from "@fortawesome/fontawesome-svg-core";
+import type { CmsEditorFieldsLayout, CmsLayoutField, CmsModel, CmsModelField } from "./model.js";
+import type { CmsIdentity } from "../types/shared.js";
+import type { SourceType } from "dnd-core";
+import type { IconPickerIconDto } from "@webiny/admin-ui";
+import type { GenericRecord } from "@webiny/app/types.js";
+import type { Identity } from "@webiny/app-admin/domain/Identity.js";
+import type { CmsModelFieldValidator } from "./model.js";
+export type DragObjectWithType = {
+    type: SourceType;
+};
+export type * from "./model.js";
+export { isLayoutField } from "./model.js";
+export type * from "./shared.js";
 interface Position {
     row: number;
     index: number;
 }
+interface Location {
+    folderId: string;
+}
 export interface DragSource extends DragObjectWithType {
     parent?: string;
     pos?: Partial<Position>;
-    type: "row" | "field" | "newField";
+    type: "row" | "field" | "newField" | "newLayoutField" | "layoutField";
     fieldType?: string;
+    layoutFieldType?: string;
     field?: CmsModelField | null;
     fields?: CmsModelField[];
-}
-/**
- * @deprecated Use `CmsModelFieldTypePlugin`.
- */
-export declare type CmsEditorFieldTypePlugin = CmsModelFieldTypePlugin;
-export interface CmsModelFieldTypePlugin extends Plugin {
-    /**
-     * a plugin type
-     */
-    type: "cms-editor-field-type";
-    field: {
-        /**
-         * A unique identifier of the field type (text, number, json, myField, ...).
-         *
-         * ```ts
-         * type: "myField"
-         * ```
-         */
-        type: string;
-        /**
-         * A display name for the field.
-         *
-         * ```ts
-         * label: "Field name"
-         * ```
-         */
-        label: string;
-        /**
-         * A list of available validators for the model field.
-         *
-         * ```ts
-         * validators: [
-         *     "required",
-         *     "gte",
-         *     "lte"
-         * ]
-         * ```
-         */
-        validators?: string[] | CmsModelFieldValidatorsGroup | CmsModelFieldValidatorsFactory;
-        /**
-         * A list of available validators when a model field accepts a list (array) of values.
-         *
-         * ```ts
-         * listValidators: [
-         *     "minLength",
-         *     "maxLength"
-         * ]
-         * ```
-         */
-        listValidators?: string[] | CmsModelFieldValidatorsGroup | CmsModelFieldValidatorsFactory;
-        /**
-         * An explanation of the field displayed beneath the label.
-         *
-         * ```ts
-         * description: "A short description of the field"
-         * ```
-         */
-        description: string;
-        /**
-         * A ReactNode to display the icon for the field.
-         *
-         * ```tsx
-         * icon: <MyIconComponent />
-         * ```
-         */
-        icon: React.ReactNode;
-        /**
-         * Is it allowed to have multiple values in this field?
-         *
-         * ```ts
-         * allowMultipleValues: true
-         * ```
-         */
-        allowMultipleValues?: boolean;
-        /**
-         * Does this field type have a fixed list of values that can be selected?
-         *
-         * ```ts
-         * allowPredefinedValues: false
-         * ```
-         */
-        allowPredefinedValues?: boolean;
-        /**
-         * A ReactNode label when multiple values are enabled.
-         */
-        multipleValuesLabel?: React.ReactNode;
-        /**
-         * These are default values when the field is first created. This is a representation of the field that is stored in the database.
-         *
-         * ```ts
-         * createField: () => ({
-         *     type: "fieldType",
-         *     validation: [],
-         *     renderer: {
-         *         name: "fieldTypeRenderer"
-         *     }
-         * })
-         * ```
-         */
-        createField: () => Pick<CmsModelField, "type" | "validation" | "renderer" | "settings">;
-        /**
-         * If `true` (default), this field will be configurable via a settings dialog.
-         * If `false`, a user will not be able to open the settings dialog, not will the dialog be opened on field drop.
-         */
-        canEditSettings?: boolean;
-        /**
-         * Determine if a `draggable` can be dropped into this field.
-         * NOTE: This is only applicable to nested field types.
-         */
-        canAccept?(field: CmsModelField, draggable: DragSource): boolean;
-        /**
-         * If `true` (default), will allow fields to be laid out into columns (next to each other).
-         * If `false`, horizontal layout will not be allowed.
-         * NOTE: This is only applicable to nested field types.
-         */
-        allowLayout?: boolean;
-        /**
-         * A ReactNode that you can add in the section below the help text when creating/editing field.
-         *
-         * ```tsx
-         * renderSettings: (params) => {
-         *     return <FieldSettingsComponent />;
-         * }
-         * ```
-         */
-        renderSettings?: (params: {
-            afterChangeLabel: (value: string) => void;
-            uniqueFieldIdValidator: (fieldId: string) => void;
-            contentModel: CmsModel;
-        }) => React.ReactNode;
-        /**
-         * A ReactNode that renders in the Predefined values tab.
-         *
-         * ```tsx
-         * renderPredefinedValues: (params) => {
-         *     const {form: {Bind}} = params;
-         *     return (
-         *         <Bind name="fieldProperty">
-         *             <InputComponent />
-         *         </Bind>
-         *     );
-         * }
-         * ```
-         */
-        renderPredefinedValues?: (params: {
-            getBind: (index?: number) => any;
-        }) => React.ReactElement;
-        /**
-         * Object wrapper for GraphQL stuff
-         */
-        graphql?: {
-            /**
-             * Define field selection.
-             *
-             * ```ts
-             * graphql: {
-             *     queryField: `
-             *         {
-             *             id
-             *             title
-             *             createdOn
-             *         }
-             *     `,
-             * }
-             * ```
-             */
-            queryField?: string | ((params: QueryFieldParams) => string);
-        };
-        render?(params: any): React.ReactElement;
-        tags?: string[];
-        /**
-         * Render additional information in the Admin UI Model edit view
-         */
-        renderInfo?: (params: {
-            field: CmsModelField;
-            model: CmsModel;
-        }) => React.ReactElement;
-    };
-}
-export interface CmsModelFieldRendererProps {
-    field: CmsModelField;
-    Label: React.FC;
-    getBind: (index?: number, key?: string) => BindComponent;
-    contentModel: CmsModel;
-}
-/**
- * @deprecated Use `CmsModelFieldRendererProps`.
- */
-export declare type CmsEditorFieldRendererProps = CmsModelFieldRendererProps;
-/**
- * @deprecated Use `CmsModelFieldRendererPlugin`.
- */
-export declare type CmsEditorFieldRendererPlugin = CmsModelFieldRendererPlugin;
-export interface CmsModelFieldRendererPlugin extends Plugin {
-    /**
-     * a plugin type
-     */
-    type: "cms-editor-field-renderer";
-    renderer: {
-        /**
-         * Name of the renderer to match the one from `createField()` method in `CmsModelFieldTypePlugin`.
-         *
-         * ```ts
-         * renderName: "myFieldTypeRenderer"
-         * ```
-         */
-        rendererName: string;
-        /**
-         * A display name for the field in the UI. It is a `ReactNode` type, so you can use a JSX element.
-         *
-         * ```tsx
-         * name: <MyFieldNameComponent />
-         * ```
-         */
-        name: React.ReactNode;
-        /**
-         * A description for the field in the UI. Works exactly like the `name` property.
-         *
-         * ```tsx
-         * name: <MyFieldDescriptionComponent />
-         * ```
-         */
-        description: React.ReactNode;
-        /**
-         * A method that determines if the field can be rendered by this plugin.
-         *
-         * ```ts
-         * canUse({ field }) {
-         *     return (
-         *         field.type === "myType" && !field.multipleValues
-         *     );
-         * }
-         * ```
-         */
-        canUse(props: {
-            field: CmsModelField;
-            fieldPlugin: CmsModelFieldTypePlugin;
-        }): boolean;
-        /**
-         * Renders a field in the UI.
-         *
-         * ```tsx
-         * render({ field, getBind }) {
-         *     const Bind = getBind();
-         *
-         *     return (
-         *         <Bind>
-         *             {bind => {
-         *                 return (
-         *                     <Input
-         *                         value={bind.value}
-         *                         onChange={bind.onChange}
-         *                     />
-         *                 )
-         *             }}
-         *         </Bind>
-         *     );
-         * }
-         * ```
-         */
-        render(props: CmsModelFieldRendererProps): React.ReactNode;
-    };
+    layoutField?: CmsLayoutField;
 }
 export interface CmsEditorFieldPredefinedValuesEntry {
     label: string;
@@ -305,46 +49,89 @@ export interface CmsDynamicZoneTemplate {
     description: string;
     icon: string;
     fields: CmsModelField[];
-    layout: string[][];
+    layout: CmsEditorFieldsLayout;
     validation: CmsModelFieldValidator[];
+    tags?: string[];
+    componentName?: string;
 }
-export declare type CmsContentEntryStatusType = "draft" | "published" | "unpublished";
-/**
- * @deprecated Use `CmsContentEntry`.
- */
-export declare type CmsEditorContentEntry = CmsContentEntry;
-export interface CmsContentEntry {
+export type CmsContentEntryStatusType = "draft" | "published" | "unpublished";
+export interface CmsContentEntryLive {
+    version: number;
+}
+export interface CmsContentEntrySystem {
+}
+export interface CmsContentEntry<TValues extends GenericRecord = GenericRecord> {
     id: string;
-    savedOn: string;
+    entryId: string;
     modelId: string;
+    createdOn: string;
     createdBy: CmsIdentity;
+    savedOn: string;
+    savedBy: CmsIdentity;
+    modifiedOn: string | null;
+    modifiedBy: CmsIdentity | null;
+    deletedOn: string | null;
+    deletedBy: CmsIdentity | null;
+    firstPublishedOn: string | null;
+    firstPublishedBy: CmsIdentity | null;
+    lastPublishedOn: string | null;
+    lastPublishedBy: CmsIdentity | null;
+    revisionCreatedOn: string;
+    revisionCreatedBy: CmsIdentity;
+    revisionSavedOn: string;
+    revisionSavedBy: CmsIdentity;
+    revisionModifiedOn: string | null;
+    revisionModifiedBy: CmsIdentity | null;
+    revisionDeletedOn: string | null;
+    revisionDeletedBy: CmsIdentity | null;
+    revisionFirstPublishedOn: string | null;
+    revisionFirstPublishedBy: CmsIdentity | null;
+    revisionLastPublishedOn: string | null;
+    revisionLastPublishedBy: CmsIdentity | null;
+    wbyAco_location: Location;
+    live: CmsContentEntryLive | null;
+    system: CmsContentEntrySystem | null;
     meta: {
         title: string;
         description?: string;
         image?: string;
-        publishedOn: string;
         locked: boolean;
         status: CmsContentEntryStatusType;
         version: number;
     };
-    [key: string]: any;
+    revisionDescription?: string;
+    values: TValues;
 }
 export interface CmsContentEntryRevision {
     id: string;
-    savedOn: string;
     modelId: string;
+    savedOn: string;
+    deletedOn: string | null;
+    firstPublishedOn: string | null;
+    lastPublishedOn: string | null;
     createdBy: CmsIdentity;
+    deletedBy: CmsIdentity | null;
+    revisionCreatedOn: string;
+    revisionSavedOn: string;
+    revisionModifiedOn: string | null;
+    revisionDeletedOn: string | null;
+    revisionFirstPublishedOn: string | null;
+    revisionLastPublishedOn: string | null;
+    revisionCreatedBy: CmsIdentity;
+    revisionSavedBy: CmsIdentity;
+    revisionModifiedBy: CmsIdentity | null;
+    revisionDeletedBy: CmsIdentity | null;
+    revisionFirstPublishedBy: CmsIdentity | null;
+    revisionLastPublishedBy: CmsIdentity | null;
+    wbyAco_location: Location;
+    revisionDescription?: string;
     meta: {
         title: string;
-        publishedOn: string;
         locked: boolean;
         status: CmsContentEntryStatusType;
         version: number;
     };
 }
-export declare type CmsEditorContentTab = React.FC<{
-    activeTab: boolean;
-}>;
 export interface CmsEditorFieldOptionPlugin extends Plugin {
     type: "cms-editor-field-option";
     render(): ReactElement;
@@ -352,24 +139,21 @@ export interface CmsEditorFieldOptionPlugin extends Plugin {
 export interface CmsContentDetailsPlugin extends Plugin {
     render: (params: any) => ReactNode;
 }
-export interface FieldLayoutPosition {
-    row: number;
-    index: number | null;
-}
-export interface CmsEditorFormSettingsPlugin extends Plugin {
+export interface CmsEditorFormSettingsPlugin<T = GenericRecord> extends Plugin {
     type: "cms-editor-form-settings";
     title: string;
     description: string;
     icon: React.ReactElement;
+    showSave?: boolean;
     render(props: {
         Bind: BaseBindComponent;
-        form: FormAPI;
-        formData: any;
+        form: FormAPI<T>;
+        formData: T;
     }): React.ReactNode;
     renderHeaderActions?(props: {
         Bind: BaseBindComponent;
-        form: FormAPI;
-        formData: any;
+        form: FormAPI<T>;
+        formData: T;
     }): React.ReactNode;
 }
 export interface CmsIcon {
@@ -388,7 +172,7 @@ export interface CmsIcon {
 }
 export interface CmsIconsPlugin extends Plugin {
     type: "cms-icons";
-    getIcons(): CmsIcon[];
+    getIcons(): IconPickerIconDto[];
 }
 /**
  * Transform field value when sending data to the API.
@@ -446,15 +230,15 @@ export interface CmsContentFormRendererPlugin extends Plugin {
  * Data types
  * #########################
  */
-export interface CmsSecurityPermission extends SecurityPermission {
+export interface CmsSecurityPermission extends Identity.Permission {
     accessLevel?: "full" | "no" | "custom";
-    models?: Record<string, string>;
-    groups?: Record<string, string>;
+    models?: string[];
+    groups?: string[];
     endpoints?: string[];
-    locales?: string[];
     rwd?: string;
     own?: boolean;
     pw?: string;
+    _src?: string;
 }
 /**
  * @category GraphQL
@@ -463,7 +247,7 @@ export interface CmsSecurityPermission extends SecurityPermission {
 export interface CmsErrorResponse {
     message: string;
     code: string;
-    data: Record<string, any> | Record<string, any>[];
+    data?: Record<string, any> | null;
 }
 /**
  * @category GraphQL
@@ -477,7 +261,7 @@ export interface CmsMetaResponse {
 /***
  * ###### FORM ########
  */
-export interface BindComponentRenderProp<T = any, F = Record<string, any>> extends BaseBindComponentRenderProp<T, F> {
+export interface BindComponentRenderProp<T = any> extends BaseBindComponentRenderProp<T> {
     parentName: string;
     appendValue: (value: any, index?: number) => void;
     prependValue: (value: any) => void;
@@ -486,12 +270,15 @@ export interface BindComponentRenderProp<T = any, F = Record<string, any>> exten
     moveValueUp: (index: number) => void;
     moveValueDown: (index: number) => void;
 }
-interface BindComponentProps extends Omit<BaseBindComponentProps, "children" | "name"> {
+interface BindComponentProps<T = any> extends Omit<BaseBindComponentProps, "children" | "name"> {
     name?: string;
-    children?: ((props: BindComponentRenderProp) => React.ReactElement) | React.ReactElement;
+    children?: ((props: BindComponentRenderProp<T>) => React.ReactElement) | React.ReactElement;
 }
-export declare type BindComponent = React.FC<BindComponentProps> & {
-    parentName?: string;
+export type BindComponent<T = any> = React.ComponentType<BindComponentProps<T>> & {
+    parentName: string;
+    ValidationContainer: React.ComponentType<{
+        children: React.ReactNode;
+    }>;
 };
 /**
  * After RequestReview and RequestChanges was removed, we need an option to add new status filters