@webiny/app-headless-cms 0.0.0-mt-1

package/admin/viewsGraphql.d.ts

@@ -0,0 +1,4 @@
+export declare const LIST_MENU_CONTENT_GROUPS_MODELS: import("graphql").DocumentNode;
+export declare const LIST_CONTENT_MODELS: import("graphql").DocumentNode;
+export declare const CREATE_CONTENT_MODEL: import("graphql").DocumentNode;
+export declare const DELETE_CONTENT_MODEL: import("graphql").DocumentNode;

package/admin/viewsGraphql.js

@@ -0,0 +1,12 @@
+import _taggedTemplateLiteral from "@babel/runtime/helpers/taggedTemplateLiteral";
+
+var _templateObject, _templateObject2, _templateObject3, _templateObject4;
+
+import gql from "graphql-tag";
+var ERROR_FIELDS = "\n    code\n    message\n    data\n";
+var BASE_CONTENT_MODEL_FIELDS = "\n    description\n    modelId\n    name\n    savedOn\n    plugin\n    fields {\n        id\n    }\n    group {\n        id\n        name\n    }\n    createdBy {\n        id\n        displayName\n        type\n    }\n"; // Fetches data needed for constructing content models list in the main menu.
+
+export var LIST_MENU_CONTENT_GROUPS_MODELS = gql(_templateObject || (_templateObject = _taggedTemplateLiteral(["\n    query CmsListMenuContentGroupsModels {\n        listContentModelGroups {\n            data {\n                id\n                name\n                icon\n                plugin\n                contentModels {\n                    name\n                    modelId\n                    plugin\n                    createdBy {\n                        id\n                        displayName\n                        type\n                    }\n                }\n            }\n        }\n    }\n"])));
+export var LIST_CONTENT_MODELS = gql(_templateObject2 || (_templateObject2 = _taggedTemplateLiteral(["\n    query CmsListContentModels {\n        listContentModels {\n            data {\n                ", "\n            }\n        }\n    }\n"])), BASE_CONTENT_MODEL_FIELDS);
+export var CREATE_CONTENT_MODEL = gql(_templateObject3 || (_templateObject3 = _taggedTemplateLiteral(["\n    mutation CmsCreateContentModel($data: CmsContentModelCreateInput!) {\n        createContentModel(data: $data) {\n            data {\n                ", "\n            }\n            error {\n                message\n                data\n            }\n        }\n    }\n"])), BASE_CONTENT_MODEL_FIELDS);
+export var DELETE_CONTENT_MODEL = gql(_templateObject4 || (_templateObject4 = _taggedTemplateLiteral(["\n    mutation CmsDeleteContentModel($modelId: ID!) {\n        deleteContentModel(modelId: $modelId) {\n            data\n            error {\n                ", "\n            }\n        }\n    }\n"])), ERROR_FIELDS);

package/package.json

@@ -0,0 +1,109 @@
+{
+	"name": "@webiny/app-headless-cms",
+	"version": "0.0.0-mt-1",
+	"main": "index.js",
+	"repository": {
+		"type": "git",
+		"url": "https://github.com/webiny/webiny-js.git"
+	},
+	"contributors": [
+		"Pavel Denisjuk <pavel@webiny.com>",
+		"Sven Al Hamad <sven@webiny.com>",
+		"Adrian Smijulj <adrian@webiny.com>"
+	],
+	"license": "MIT",
+	"dependencies": {
+		"@apollo/react-hooks": "3.1.5",
+		"@babel/runtime": "7.15.4",
+		"@emotion/core": "10.1.1",
+		"@emotion/styled": "10.0.27",
+		"@fortawesome/fontawesome-svg-core": "1.2.36",
+		"@fortawesome/free-brands-svg-icons": "5.15.4",
+		"@fortawesome/free-regular-svg-icons": "5.15.4",
+		"@fortawesome/free-solid-svg-icons": "5.15.4",
+		"@fortawesome/react-fontawesome": "0.1.15",
+		"@svgr/webpack": "4.3.3",
+		"@types/react": "16.14.2",
+		"@webiny/app": "0.0.0-mt-1",
+		"@webiny/app-admin": "0.0.0-mt-1",
+		"@webiny/app-graphql-playground": "0.0.0-mt-1",
+		"@webiny/app-i18n": "0.0.0-mt-1",
+		"@webiny/app-plugin-admin-welcome-screen": "0.0.0-mt-1",
+		"@webiny/app-security": "0.0.0-mt-1",
+		"@webiny/error": "0.0.0-mt-1",
+		"@webiny/form": "0.0.0-mt-1",
+		"@webiny/plugins": "0.0.0-mt-1",
+		"@webiny/react-router": "0.0.0-mt-1",
+		"@webiny/ui": "0.0.0-mt-1",
+		"@webiny/validation": "0.0.0-mt-1",
+		"apollo-cache": "1.3.5",
+		"apollo-client": "2.6.10",
+		"apollo-link": "1.2.14",
+		"apollo-utilities": "1.3.4",
+		"classnames": "2.3.1",
+		"dot-prop-immutable": "2.1.1",
+		"emotion": "10.0.27",
+		"graphql": "14.7.0",
+		"graphql-tag": "2.12.5",
+		"lodash": "4.17.21",
+		"pluralize": "8.0.0",
+		"prop-types": "15.7.2",
+		"raw.macro": "0.4.2",
+		"react": "16.14.0",
+		"react-dnd": "9.5.1",
+		"react-dnd-html5-backend": "9.5.1",
+		"react-dom": "16.14.0",
+		"react-helmet": "5.2.1",
+		"react-hotkeyz": "1.0.4",
+		"react-virtualized": "9.22.3",
+		"shortid": "2.2.16",
+		"timeago-react": "2.0.1",
+		"use-deep-compare-effect": "1.8.0"
+	},
+	"devDependencies": {
+		"@babel/cli": "^7.5.5",
+		"@babel/core": "^7.5.5",
+		"@babel/preset-env": "^7.5.5",
+		"@babel/preset-react": "^7.0.0",
+		"@babel/preset-typescript": "^7.8.3",
+		"@webiny/cli": "^0.0.0-mt-1",
+		"@webiny/project-utils": "^0.0.0-mt-1",
+		"babel-plugin-emotion": "^9.2.8",
+		"babel-plugin-lodash": "^3.3.4",
+		"babel-plugin-module-resolver": "^4.1.0",
+		"babel-plugin-named-asset-import": "^1.0.0-next.3e165448",
+		"execa": "^5.0.0",
+		"rimraf": "^3.0.2",
+		"ttypescript": "^1.5.12",
+		"typescript": "^4.1.3"
+	},
+	"publishConfig": {
+		"access": "public",
+		"directory": "dist"
+	},
+	"scripts": {
+		"build": "yarn webiny run build",
+		"watch": "yarn webiny run watch"
+	},
+	"svgo": {
+		"plugins": {
+			"removeViewBox": false
+		}
+	},
+	"adio": {
+		"ignore": {
+			"src": [
+				"!!raw-loader!."
+			],
+			"dependencies": [
+				"@svgr/webpack",
+				"@emotion/core",
+				"raw-loader"
+			],
+			"peerDependencies": [
+				"react-dom"
+			]
+		}
+	},
+	"gitHead": "37736d8456a6ecb342a6c3645060bd9a3f2d4bb0"
+}

package/types.d.ts

@@ -0,0 +1,484 @@
+import * as React from "react";
+import { Plugin } from "@webiny/plugins/types";
+import { ReactElement, ReactNode } from "react";
+import { BindComponent, FormRenderPropParams, FormAPI } from "@webiny/form/types";
+import { ApolloClient } from "apollo-client";
+import { IconPrefix, IconName } from "@fortawesome/fontawesome-svg-core";
+import Label from "./admin/components/ContentEntryForm/Label";
+interface QueryFieldParams {
+    field: CmsEditorField;
+}
+export interface CmsEditorFieldTypePlugin 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[];
+        /**
+         * A list of available validators when a model field accepts a list (array) of values.
+         *
+         * ```ts
+         * listValidators: [
+         *     "minLength",
+         *     "maxLength"
+         * ]
+         * ```
+         */
+        listValidators?: string[];
+        /**
+         * 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: () => CmsEditorField;
+        /**
+         * A ReactNode that you can add in the section below the help text when creating/editing field.
+         *
+         * ```tsx
+         * renderSettings: (params) => {
+         *     return <FieldSettingsComponent />;
+         * }
+         * ```
+         */
+        renderSettings?: (params: {
+            form: FormRenderPropParams;
+            afterChangeLabel: (value: string) => void;
+            uniqueFieldIdValidator: (fieldId: string) => void;
+            contentModel: CmsEditorContentModel;
+        }) => 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: {
+            form: FormRenderPropParams;
+            getBind: (index?: number) => any;
+        }) => React.ReactNode;
+        /**
+         * 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;
+    };
+}
+export interface CmsEditorFieldRendererPlugin extends Plugin {
+    /**
+     * a plugin type
+     */
+    type: "cms-editor-field-renderer";
+    renderer: {
+        /**
+         * Name of the renderer to match the one from `createField()` method in `CmsEditorFieldTypePlugin`.
+         *
+         * ```ts
+         * renderName: "myFieldTypeRenderer"
+         * ```
+         */
+        rendererName: string;
+        /**
+         * A display name for the field in the UI. It is a `ReactNode` type so you can return a component if you want to.
+         *
+         * ```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: CmsEditorField;
+        }): 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: {
+            field: CmsEditorField;
+            Label: typeof Label;
+            getBind: (index?: number, key?: string) => any;
+            contentModel: CmsEditorContentModel;
+        }): React.ReactNode;
+    };
+}
+export interface CmsEditorFieldPredefinedValuesEntry {
+    label: string;
+    value: string;
+}
+export interface CmsEditorFieldPredefinedValues {
+    enabled: boolean;
+    values: CmsEditorFieldPredefinedValuesEntry[];
+}
+export declare type CmsEditorField<T = unknown> = T & {
+    id?: string;
+    type: string;
+    fieldId?: CmsEditorFieldId;
+    label?: string;
+    helpText?: string;
+    placeholderText?: string;
+    validation?: CmsEditorFieldValidator[];
+    listValidation?: CmsEditorFieldValidator[];
+    multipleValues?: boolean;
+    predefinedValues?: CmsEditorFieldPredefinedValues;
+    settings?: {
+        [key: string]: any;
+    };
+    renderer: {
+        name: string;
+    };
+};
+export declare type CmsEditorFieldId = string;
+export declare type CmsEditorFieldsLayout = CmsEditorFieldId[][];
+export interface CmsEditorContentModel {
+    id: CmsEditorFieldId;
+    group: {
+        id: string;
+        name: string;
+    };
+    description?: string;
+    version: number;
+    layout?: CmsEditorFieldsLayout;
+    fields: CmsEditorField[];
+    lockedFields: CmsEditorField[];
+    name: string;
+    modelId: string;
+    titleFieldId: string;
+    settings: any;
+    status: string;
+    savedOn: string;
+    meta: any;
+}
+export interface CmsEditorContentEntry {
+    id: string;
+    savedOn: string;
+    [key: string]: any;
+    meta: {
+        title: string;
+        publishedOn: string;
+        locked: boolean;
+        status: "draft" | "published" | "unpublished" | "changesRequested" | "reviewRequested";
+        version: number;
+    };
+}
+export interface CmsContentEntryRevision {
+    id: string;
+    savedOn: string;
+    meta: {
+        title: string;
+        publishedOn: string;
+        locked: boolean;
+        status: "draft" | "published" | "unpublished" | "changesRequested" | "reviewRequested";
+        version: number;
+    };
+}
+export interface CmsEditorFieldValidator {
+    name: string;
+    message: string;
+    settings: any;
+}
+export interface CmsEditorFieldValidatorPlugin extends Plugin {
+    type: "cms-editor-field-validator";
+    validator: {
+        name: string;
+        label: string;
+        description: string;
+        defaultMessage: string;
+        defaultSettings?: Record<string, any>;
+        renderSettings?: (props: {
+            field: CmsEditorField;
+            Bind: BindComponent;
+            setValue: (name: string, value: any) => void;
+            setMessage: (message: string) => void;
+            data: CmsEditorFieldValidator;
+        }) => React.ReactElement;
+    };
+}
+export declare type CmsEditorContentTab = React.FunctionComponent<{
+    activeTab: boolean;
+}>;
+export interface CmsEditorFieldOptionPlugin extends Plugin {
+    type: "cms-editor-field-option";
+    render(): ReactElement;
+}
+export interface CmsContentDetailsPlugin extends Plugin {
+    render: (params: any) => ReactNode;
+}
+export interface CmsContentDetailsRevisionContentPlugin extends Plugin {
+    type: "cms-content-details-revision-content";
+    render(params: any): ReactElement;
+}
+export interface CmsEditorFieldValidatorPatternPlugin extends Plugin {
+    type: "cms-editor-field-validator-pattern";
+    pattern: {
+        name: string;
+        message: string;
+        label: string;
+    };
+}
+export interface CmsFieldValidator {
+    name: string;
+    message: any;
+    settings: any;
+}
+export interface CmsModelFieldValidatorPlugin extends Plugin {
+    type: "cms-model-field-validator";
+    validator: {
+        name: string;
+        validate: (value: any, validator: CmsFieldValidator | any) => Promise<any>;
+    };
+}
+/**
+ * @category Plugin
+ * @category ContentModelField
+ * @category FieldValidation
+ */
+export interface CmsModelFieldValidatorPatternPlugin extends Plugin {
+    /**
+     * A plugin type
+     */
+    type: "cms-model-field-validator-pattern";
+    /**
+     * A pattern object for the validator.
+     */
+    pattern: {
+        /**
+         * name of the pattern.
+         */
+        name: string;
+        /**
+         * RegExp of the validator.
+         */
+        regex: string;
+        /**
+         * RegExp flags
+         */
+        flags: string;
+    };
+}
+export interface FieldLayoutPosition {
+    row: number;
+    index: number;
+}
+export interface CmsEditorFormSettingsPlugin extends Plugin {
+    type: "cms-editor-form-settings";
+    title: string;
+    description: string;
+    icon: React.ReactElement;
+    render(props: {
+        Bind: BindComponent;
+        form: FormAPI;
+        formData: any;
+    }): React.ReactNode;
+    renderHeaderActions?(props: {
+        Bind: BindComponent;
+        form: FormAPI;
+        formData: any;
+    }): React.ReactNode;
+}
+export interface CmsIcon {
+    /**
+     * [ pack, icon ], ex: ["fab", "cog"]
+     */
+    id: [IconPrefix, IconName];
+    /**
+     * Icon name
+     */
+    name: string;
+    /**
+     * SVG element
+     */
+    svg: ReactElement;
+}
+export interface CmsIconsPlugin extends Plugin {
+    type: "cms-icons";
+    getIcons(): CmsIcon[];
+}
+export interface UseContentModelEditorReducerState {
+    apolloClient: ApolloClient<any>;
+    id: string;
+}
+/**
+ * Transform field value when sending data to the API.
+ */
+export interface CmsFieldValueTransformer extends Plugin {
+    /**
+     * A plugin type.
+     */
+    type: "cms-field-value-transformer";
+    /**
+     * A field type for the value transformer. Or a list of field types.
+     */
+    fieldType: string | string[];
+    /**
+     * A transformer function that takes a value and returns a new one.
+     */
+    transform: (value: any, field: CmsEditorField) => any;
+}
+/**
+ * Define a custom form layout renderer for a specific content model.
+ */
+export interface CmsContentFormRendererPlugin extends Plugin {
+    /**
+     * A plugin type.
+     */
+    type: "cms-content-form-renderer";
+    /**
+     * Content model ID that will use this renderer.
+     */
+    modelId: string;
+    /**
+     * A function that will render a custom form layout.
+     */
+    render(props: {
+        /**
+         * Content model that is being rendered.
+         */
+        contentModel: CmsEditorContentModel;
+        /**
+         * Content entry data handled by the Form element.
+         */
+        data: Record<string, any>;
+        /**
+         * A component to bind data to the Form.
+         */
+        Bind: BindComponent;
+        /**
+         * Content model fields to render.
+         */
+        fields: Record<string, React.ReactElement>;
+    }): React.ReactNode;
+}
+export {};

package/types.js

@@ -0,0 +1 @@
+export {};