@tinacms/schema-tools 1.3.2 → 1.3.4

package/dist/types/types2.d.ts

@@ -1,445 +0,0 @@
-/**
-
-*/
-/**
- *
- */
-export interface UICollection {
-    /**
-     * Customize the way filenames are generated during content creation
-     */
-    filename?: {
-        /**
-         * A callback which receives form values as an argument. The return value
-         * here will be used as the filename (the extension is not necessary)
-         *
-         * eg:
-         * ```ts
-         * slugify: (values) => values.title.toLowerCase().split(" ").join("-")
-         * ```
-         */
-        slugify?: (values: Record<string, any>) => string;
-        /**
-         * When set to `true`, editors won't be able to modify the filename
-         */
-        readonly?: boolean;
-    };
-    /**
-     * Forms for this collection will be editable from the global sidebar rather than the form panel
-     */
-    global?: boolean | {
-        icon?: any;
-        layout: 'fullscreen' | 'popup';
-    };
-    /**
-     * Provide the path that your document is viewable on your site
-     *
-     * eg:
-     * ```ts
-     * router: ({ document }) => {
-     *   return `blog-posts/${document._sys.filename}`;
-     * }
-     * ```
-     */
-    router?: (args: {
-        document: Document;
-        collection: Collection;
-    }) => string | undefined;
-}
-export declare type Option = string | {
-    label: string;
-    value: string;
-};
-import type React from 'react';
-declare type Meta = {
-    active?: boolean;
-    dirty?: boolean;
-    error?: any;
-};
-declare type Component<Type, List> = (props: {
-    field: SchemaField & {
-        namespace: string[];
-    };
-    input: {
-        /**
-         * The full name of the field, for fields nested inside object
-         * fields, this will be the full path:
-         *
-         * `myObject.0.title`
-         */
-        name: string;
-        onBlur: (event?: React.FocusEvent<Type>) => void;
-        /**
-         * The value provided will be saved to the form so it
-         * should match the configured type:
-         *
-         * `input.onChange('some string')`
-         */
-        onChange: (event: React.ChangeEvent<Type>) => void;
-        onFocus: (event?: React.FocusEvent<Type>) => void;
-        type?: string;
-        value: List extends true ? Type[] : Type;
-    };
-    meta: Meta;
-}) => any;
-declare type UIField<Type, List extends boolean> = {
-    /**
-     * Override the label from parent object
-     */
-    label?: string;
-    /**
-     * Override the description from parent object
-     */
-    description?: string;
-    /**
-     * A React component which will be used in the Tina form. Be sure
-     * to import React into the config file.
-     *
-     * Note: Any Tailwind classes provided here will be compiled as part
-     * of the Tina stylesheet
-     *
-     * eg:
-     * ```tsx
-     *  component: (props) => {
-     *    const { input, field } = props
-     *    return (
-     *      <div className="my-4">
-     *        <label
-     *          htmlFor={input.name}
-     *          className="block text-sm font-medium"
-     *        >
-     *          {field.name}
-     *        </label>
-     *        <div className="mt-1">
-     *          <input
-     *            id={input.name}
-     *            className="py-2 px-4 block"
-     *            type="text"
-     *            {...input}
-     *          />
-     *        </div>
-     *      </div>
-     *    )
-     *  }
-     * ```
-     *
-     * Note: If the form has already been registered with the cms, you
-     * can provide it's name here (eg. `textarea`)
-     */
-    component?: Component<Type, List> | string | null;
-    /**
-     * Optional: Prepare data for use in the component. This is useful
-     * if you don't have access to the component directly
-     */
-    parse?: (value: List extends true ? Type[] : Type, name: string, field: Field) => List extends true ? Type[] : Type;
-    /**
-     * Optional: Prepare data for saving. This is useful
-     * if you don't have access to the component directly
-     */
-    format?: (value: Type, name: string, field: Field) => List extends true ? Type[] : Type;
-    /**
-     * Optional: Return undefined when valid. Return a string or an object when there are errors.
-     *
-     * ```ts
-     * validate: (value) => {
-     *   if(value.length > 40){
-     *      return 'Title cannot be more than 40 characters long'
-     *   }
-     * }
-     * ```
-     */
-    validate?(value: List extends true ? Type[] : Type, allValues: {
-        [key: string]: any;
-    }, meta: Meta, field: UIField<Type, List>): (List extends true ? Type[] : Type) | undefined | void;
-    /**
-     * @deprecated use `defaultItem` at the collection level instead
-     */
-    defaultValue?: List extends true ? Type[] : Type;
-};
-declare type FieldGeneric<Type, List extends boolean | undefined, ExtraFieldUIProps = {}> = List extends true ? {
-    list: true;
-    ui?: UIField<Type, true> & ExtraFieldUIProps;
-} : List extends false ? {
-    list: false;
-    ui?: UIField<Type, false> & ExtraFieldUIProps;
-} : {
-    list?: never;
-    ui?: UIField<Type, false> & ExtraFieldUIProps;
-};
-export interface BaseField {
-    label?: string;
-    required?: boolean;
-    name: string;
-}
-export declare type StringField = (FieldGeneric<string, undefined> | FieldGeneric<string, true> | FieldGeneric<string, false>) & BaseField & {
-    type: 'string';
-    isTitle?: boolean;
-    options?: Option[];
-};
-export declare type NumberField = (FieldGeneric<number, undefined> | FieldGeneric<number, true> | FieldGeneric<number, false>) & BaseField & {
-    type: 'number';
-};
-export declare type BooleanField = (FieldGeneric<boolean, undefined> | FieldGeneric<boolean, true> | FieldGeneric<boolean, false>) & BaseField & {
-    type: 'boolean';
-};
-export declare type DateTimeField = (FieldGeneric<string, undefined> | FieldGeneric<string, true> | FieldGeneric<string, false>) & BaseField & {
-    type: 'datetime';
-};
-export declare type ImageField = (FieldGeneric<string, undefined> | FieldGeneric<string, true> | FieldGeneric<string, false>) & BaseField & {
-    type: 'image';
-};
-export declare type ReferenceField = (FieldGeneric<string, undefined> | FieldGeneric<string, false>) & BaseField & {
-    type: 'reference';
-    /**
-     * The names of the collections this field can use as a reference
-     * ```ts
-     * {
-     *   type: 'reference',
-     *   name: 'author',
-     *   collections: ['author'],
-     * }
-     * ```
-     */
-    collections: string[];
-};
-declare type RichTextAst = {
-    type: 'root';
-    children: Record<string, unknown>[];
-};
-export declare type RichTextField = (FieldGeneric<RichTextAst, undefined> | FieldGeneric<RichTextAst, false>) & BaseField & {
-    type: 'rich-text';
-    /**
-     * When using Markdown or MDX formats, this field's value
-     * will be saved to the markdown body, while all other values
-     * will be stored as frontmatter
-     */
-    isBody?: boolean;
-    templates?: (Template & {
-        inline?: boolean;
-        /**
-         * If you have some custom shortcode logic in your markdown,
-         * you can specify it in the 'match' property and Tina will
-         * handle it as if it were a jsx element:
-         *
-         * ```
-         * # This is my markdown, it uses some custom shortcode
-         * syntax {{ myshortcode title="hello!" }}.
-         *
-         * {
-         *   match: {
-         *     start: "{{"
-         *     end: "}}"
-         *   }
-         * }
-         * ```
-         */
-        match?: {
-            start: string;
-            end: string;
-            name?: string;
-        };
-    })[];
-};
-declare type DefaultItem<ReturnType> = ReturnType | (() => ReturnType);
-declare type ExtraFieldUIProps = {
-    /**
-     * Override the properties passed to the field
-     * component. This is mostly useful for controlling
-     * the display value via callback on `itemProps.label`
-     */
-    itemProps?(item: Record<string, any>): {
-        key?: string;
-        /**
-         * Control the display value when object
-         * items are shown in a compact list, eg:
-         *
-         * ```ts
-         * itemProps: (values) => ({
-         *   label: values?.title || 'Showcase Item',
-         * }),
-         * ```
-         */
-        label?: string;
-    };
-    /**
-     * The value will be used when a new object is inserted, eg:
-     *
-     * ```ts
-     * {
-     *   title: "My Headline",
-     *   description: "Some description"
-     * }
-     * ```
-     *
-     * Note: when supplying a value for a `rich-text` field, you must supply
-     * the the value as an object.
-     * ```ts
-     * {
-     *   title: "My Headline",
-     *   description: "Some description"
-     *   // This is field a rich-text field
-     *   body: {
-     *     type: "root",
-     *     children: [{
-     *       type: "p",
-     *       children: [{
-     *         type: "text",
-     *         value: "This is some placeholder text"
-     *       }]
-     *     }]
-     *   }
-     * }
-     * ```
-     *
-     */
-    defaultItem?: DefaultItem<Record<string, any>>;
-};
-export declare type ObjectField = (FieldGeneric<string, undefined> | FieldGeneric<string, true, ExtraFieldUIProps> | FieldGeneric<string, false>) & BaseField & ({
-    type: 'object';
-    fields: Field[];
-    templates?: undefined;
-} | {
-    type: 'object';
-    fields?: undefined;
-    templates: Template[];
-});
-declare type Field = StringField | NumberField | BooleanField | DateTimeField | ImageField | ReferenceField | RichTextField | ObjectField;
-declare type SchemaField = Field;
-export type { SchemaField };
-export interface Template {
-    label?: string;
-    name: string;
-    fields: Field[];
-}
-export interface FieldCollection {
-    label?: string;
-    name: string;
-    path: string;
-    format?: 'json' | 'md' | 'markdown' | 'mdx';
-    ui?: UICollection;
-    templates?: never;
-    /**
-     * Fields define the shape of the content and the user input.
-     *
-     * https://tina.io/docs/reference/fields/
-     */
-    fields: Field[];
-}
-export interface TemplateCollection {
-    label?: string;
-    name: string;
-    path: string;
-    format?: 'json' | 'md' | 'markdown' | 'mdx';
-    ui?: UICollection;
-    /**
-     * In most cases, just using fields is enough, however templates can be used when there are multiple variants of the same collection or object. For example in a "page" collection there might be a need for a marketing page template and a content page template, both under the collection "page".
-     *
-     * https://tina.io/docs/reference/templates/
-     */
-    templates?: Template[];
-    fields?: never;
-}
-export declare type Collection = FieldCollection | TemplateCollection;
-export interface Schema {
-    /**
-     * Collections represent a type of content (EX, blog post, page, author, etc). We recommend using singular naming in a collection (Ex: use post and not posts).
-     *
-     * https://tina.io/docs/reference/collections/
-     */
-    collections: Collection[];
-}
-export interface Config<CMSCallback = undefined, FormifyCallback = undefined, DocumentCreatorCallback = undefined, Store = undefined> {
-    /**
-     * The Schema is used to define the shape of the content.
-     *
-     * https://tina.io/docs/reference/schema/
-     */
-    schema: Schema;
-    /**
-     * The base branch to pull content from. Note that this is ignored for local development
-     */
-    branch: string | null;
-    /**
-     * Your clientId from  app.tina.io
-     */
-    clientId: string | null;
-    /**
-     * Your read only token from app.tina.io
-     */
-    token: string | null;
-    /**
-     * Configurations for the autogenerated GraphQL HTTP client
-     */
-    client?: {
-        /**
-         * Autogenerated queries will traverse references to a given depth
-         * @default 2
-         */
-        referenceDepth?: number;
-    };
-    /**
-     * Tina is compiled as a single-page app and placed in the public directory
-     * of your application.
-     */
-    build: {
-        /**
-         * The folder where your application stores assets, eg. `"public"`
-         */
-        publicFolder: string;
-        /**
-         * The value specified here will determine the path when visiting the TinaCMS dashboard.
-         *
-         * Eg. `"admin"` will be viewable at `[your-development-url]/admin/index.html`
-         *
-         * Note that for most framworks you can omit the `index.html` portion, for Next.js see the [rewrites section](https://nextjs.org/docs/api-reference/next.config.js/rewrites)
-         */
-        outputFolder: string;
-    };
-    media?: {
-        /**
-         * Load a media store like Cloudinary
-         *
-         * ```ts
-         * loadCustomStore = async () => {
-         *   const pack = await import("next-tinacms-cloudinary");
-         *   return pack.TinaCloudCloudinaryMediaStore;
-         * }
-         * ```
-         */
-        loadCustomStore: () => Promise<Store>;
-        tina?: never;
-    } | {
-        /**
-         * Use Git-backed assets for media, these values will
-         * [Learn more](https://tina.io/docs/reference/media/repo-based/)
-         */
-        tina: {
-            /**
-             * The folder where your application stores assets, eg. `"public"`
-             */
-            publicFolder: string;
-            /**
-             * The root folder for media managed by Tina. For example, `"uploads"`
-             * would store content in `"<my-public-folder>/uploads"`
-             */
-            mediaRoot: string;
-        };
-        loadCustomStore?: never;
-    };
-    /**
-     * Used to override the default Tina Cloud API URL
-     *
-     * [mostly for internal use only]
-     */
-    tinaioConfig?: {
-        assetsApiUrlOverride?: string;
-        frontendUrlOverride?: string;
-        identityApiUrlOverride?: string;
-        contentApiUrlOverride?: string;
-    };
-    cmsCallback?: CMSCallback;
-    formifyCallback?: FormifyCallback;
-    documentCreatorCallback?: DocumentCreatorCallback;
-}
-export declare type TinaCMSConfig<CMSCallback = undefined, FormifyCallback = undefined, DocumentCreatorCallback = undefined, Store = undefined> = Config<CMSCallback, FormifyCallback, DocumentCreatorCallback, Store>;
-export {};