tinacms 1.5.16 → 1.5.18

package/dist/toolkit/forms/form.d.ts

@@ -0,0 +1,138 @@
+import { FormApi, Config, FormState } from 'final-form';
+import type { FormSubscription } from 'final-form';
+import type { Plugin } from '../core';
+import { Field, AnyField } from './field';
+export type { FormApi };
+declare type GlobalOptions = {
+    global: true;
+    icon?: any;
+    layout?: 'fullscreen' | 'popup';
+};
+export interface FormOptions<S, F extends Field = AnyField> extends Config<S> {
+    id: any;
+    label: string;
+    fields?: F[];
+    __type?: string;
+    reset?(): void;
+    actions?: any[];
+    global?: GlobalOptions;
+    buttons?: {
+        save: string;
+        reset: string;
+    };
+    loadInitialValues?: () => Promise<S>;
+    onChange?(values: FormState<S>): void;
+    extraSubscribeValues?: FormSubscription;
+    queries?: string[];
+    crudType?: 'create' | 'update';
+    relativePath?: string;
+}
+export declare class Form<S = any, F extends Field = AnyField> implements Plugin {
+    private _reset;
+    __type: string;
+    id: any;
+    label: string;
+    fields: F[];
+    finalForm: FormApi<S>;
+    actions: any[];
+    buttons: {
+        save: string;
+        reset: string;
+    };
+    queries: string[];
+    global: GlobalOptions | null;
+    loading: boolean;
+    relativePath: string;
+    crudType?: 'create' | 'update';
+    constructor({ id, label, fields, actions, buttons, global, reset, loadInitialValues, onChange, queries, ...options }: FormOptions<S, F>);
+    /**
+     * A unique identifier for Forms.
+     *
+     * @deprecated use id instead
+     */
+    get name(): any;
+    /**
+     * Returns the current values of the form.
+     *
+     * if the form is still loading it returns `undefined`.
+     */
+    get values(): S | undefined;
+    /**
+     * The values the form was initialized with.
+     */
+    get initialValues(): Partial<S>;
+    get pristine(): boolean;
+    get dirty(): boolean;
+    get submitting(): boolean;
+    get valid(): boolean;
+    /**
+     * Resets the values back to the initial values the form was initialized with.
+     * Or empties all the values if the form was not initialized.
+     */
+    reset(): Promise<void>;
+    /**
+     * @deprecated Unnecessary indirection
+     */
+    updateFields(fields: F[]): void;
+    /**
+     * Subscribes to changes to the form. The subscriber will only be called when
+     * values specified in subscription change. A form can have many subscribers.
+     */
+    subscribe: FormApi<S>['subscribe'];
+    onSubmit: Config<S>['onSubmit'];
+    private handleSubmit;
+    /**
+     * Submits the form if there are currently no validation errors. It may
+     * return undefined or a Promise depending on the nature of the onSubmit
+     * configuration value given to the form when it was created.
+     */
+    submit: FormApi<S>['submit'];
+    /**
+     * Changes the value of the given field.
+     *
+     * @param name
+     * @param value
+     */
+    change(name: keyof S, value?: any): void;
+    get mutators(): Record<string, (...args: any[]) => any>;
+    addQuery(queryId: string): void;
+    removeQuery(queryId: string): void;
+    /**
+     * Updates multiple fields in the form.
+     *
+     * The updates are batched so that it only triggers one `onChange` event.
+     *
+     * In order to prevent disruptions to the user's editing experience this
+     * function will _not_ update the value of any field that is currently
+     * being edited.
+     *
+     * @param values
+     */
+    updateValues(values: S): void;
+    /**
+     * Replaces the initialValues of the form without deleting the current values.
+     *
+     * This function is helpful when the initialValues are loaded asynchronously.
+     *
+     * @param initialValues
+     */
+    updateInitialValues(initialValues: S): void;
+    /**
+     * Based on field's name this function will
+     * return an array of fields for the give form along
+     * with the path that it was found at top nearest
+     * object-like group
+     *
+     * So if you have a field named blocks.3.title
+     * It will return the fields from the 3rd "block"
+     * along with the path it was found at
+     * fields: [{type: 'string', name: 'title'}, ... other fields]
+     * activePath: ['blocks', '3']
+     */
+    getActiveField(fieldName: string | null): {
+        label?: string;
+        name?: string;
+        fields: Field[];
+    };
+    private getFieldGroup;
+}

package/dist/toolkit/forms/index.d.ts

@@ -0,0 +1,4 @@
+export * from './form';
+export * from './field';
+export type { ContentCreatorPlugin } from './content-creator-plugin';
+export type { FormApi } from 'final-form';

package/dist/toolkit/git-client/git-client.d.ts

@@ -0,0 +1,92 @@
+export declare class GitClient {
+    private baseUrl;
+    constructor(baseUrl: string);
+    /**
+     * An alias to `commit`
+     *
+     * @deprecated
+     */
+    onSubmit(data: any): Promise<any>;
+    /**
+     * An alias to `writeToDisk`
+     *
+     * @deprecated
+     */
+    onChange(data: any): Promise<any>;
+    /**
+     * An alias to `writeMediaToDisk`
+     *
+     * @deprecated
+     */
+    onUploadMedia(data: any): Promise<any>;
+    /**
+     * An alias to `deleteFromDisk`
+     *
+     * @deprecated
+     */
+    onDelete(data: any): Promise<any>;
+    /**
+     * @deprecated
+     */
+    isAuthenticated(): boolean;
+    commit(data: {
+        files: string[];
+        message?: string;
+        name?: string;
+        email?: string;
+    }): Promise<Response>;
+    /**
+     *
+     * TODO: Add return type.
+     * TODO: Remove `catch`
+     */
+    push(): Promise<any>;
+    /**
+     *
+     * TODO: Add return type.
+     * TODO: Remove `catch`
+     */
+    writeToDisk(data: {
+        fileRelativePath: string;
+        content: string;
+    }): Promise<any>;
+    /**
+     * Uploads a File to disk
+     * TODO: Remove `catch`
+     */
+    writeMediaToDisk(data: {
+        directory: string;
+        content: File;
+    }): Promise<any>;
+    /**
+     * TODO: rename `data.relPath` to `data.fileRelativePath`
+     * TODO: Add return type.
+     * TODO: Remove `catch`
+     */
+    deleteFromDisk(data: {
+        relPath: string;
+    }): Promise<any>;
+    /**
+     * Resets the given files.
+     */
+    reset(data: {
+        files: string[];
+    }): Promise<Response>;
+    /**
+     * Get the contents of a file or directory on disk.
+     */
+    getFile(fileRelativePath: string): Promise<any>;
+    /**
+     * Get the contents of a file for the most recent commit.
+     */
+    show(fileRelativePath: string): Promise<any>;
+    /**
+     * Get information about a local branch by name, or the current branch if no
+     * name is specified.
+     */
+    branch(name?: string): Promise<any>;
+    /**
+     * Get a list of the names of all local branches.
+     */
+    branches(): Promise<any>;
+}

package/dist/toolkit/git-client/git-file.d.ts

@@ -0,0 +1,16 @@
+import { CMS } from '../core';
+export declare class GitFile {
+    private cms;
+    relativePath: string;
+    format: (file: any) => string;
+    parse: (content: string) => any;
+    constructor(cms: CMS, relativePath: string, format: (file: any) => string, parse: (content: string) => any);
+    /**
+     * Load the contents of this file at HEAD
+     */
+    show: () => Promise<any>;
+    commit: () => Promise<void>;
+    reset: () => void;
+    write: (values: any) => void;
+    private get git();
+}

package/dist/toolkit/git-client/git-media-store.d.ts

@@ -0,0 +1,11 @@
+import { MediaStore, MediaUploadOptions, Media, MediaListOptions, MediaList } from '../core';
+import { GitClient } from './git-client';
+export declare class GitMediaStore implements MediaStore {
+    private client;
+    accept: string;
+    constructor(client: GitClient);
+    persist(files: MediaUploadOptions[]): Promise<Media[]>;
+    list(options?: MediaListOptions): Promise<MediaList>;
+    delete(media: Media): Promise<void>;
+}
+export declare const nextOffset: (offset: number, limit: number, count: number) => number;

package/dist/toolkit/git-client/index.d.ts

@@ -0,0 +1,4 @@
+export * from './git-client';
+export * from './git-file';
+export * from './use-git-file';
+export * from './git-media-store';

package/dist/toolkit/git-client/use-git-file.d.ts

@@ -0,0 +1,2 @@
+import { GitFile } from './git-file';
+export declare function useGitFile(relativePath: string, format: (file: any) => string, parse: (content: string) => any): GitFile;

package/dist/toolkit/hooks/use-field-reference.d.ts

@@ -0,0 +1,12 @@
+/**
+ * If the DOM wrapped by Tina contains an element with a
+ * `data-tinafield` attribute matching `fieldName`,
+ * `useFieldReference` will find it by querying the dom and return
+ * the matched DOM element.
+ *
+ * `useFieldReference` is connected to a MutationObserver higher in the DOM,
+ * and will cause components that use it to rerender any time content in the DOM
+ * changes. This ensures reliable tracking of the referenced DOM element, but
+ * may cause problems if `useFieldReference` is called in expensive renders.
+ */
+export declare const useFieldReference: (fieldName: string | null) => HTMLElement;

package/dist/toolkit/hooks/use-local-storage.d.ts

@@ -0,0 +1 @@
+export declare function useLocalStorage(key: any, initialValue: any): any[];

package/dist/toolkit/icons/Add.d.ts

@@ -0,0 +1,9 @@
+/**
+
+
+
+*/
+/// <reference types="react" />
+export declare const AddIcon: ({ ...props }: {
+    [x: string]: any;
+}) => JSX.Element;

package/dist/toolkit/icons/Alert.d.ts

@@ -0,0 +1,9 @@
+/**
+
+
+
+*/
+/// <reference types="react" />
+export declare const AlertIcon: ({ ...props }: {
+    [x: string]: any;
+}) => JSX.Element;

package/dist/toolkit/icons/AlignCenter.d.ts

@@ -0,0 +1,9 @@
+/**
+
+
+
+*/
+/// <reference types="react" />
+export declare const AlignCenter: ({ ...props }: {
+    [x: string]: any;
+}) => JSX.Element;

package/dist/toolkit/icons/AlignLeft.d.ts

@@ -0,0 +1,9 @@
+/**
+
+
+
+*/
+/// <reference types="react" />
+export declare const AlignLeft: ({ ...props }: {
+    [x: string]: any;
+}) => JSX.Element;

package/dist/toolkit/icons/AlignRight.d.ts

@@ -0,0 +1,9 @@
+/**
+
+
+
+*/
+/// <reference types="react" />
+export declare const AlignRight: ({ ...props }: {
+    [x: string]: any;
+}) => JSX.Element;

package/dist/toolkit/icons/Bold.d.ts

@@ -0,0 +1,9 @@
+/**
+
+
+
+*/
+/// <reference types="react" />
+export declare const BoldIcon: ({ ...props }: {
+    [x: string]: any;
+}) => JSX.Element;

package/dist/toolkit/icons/ChevronDown.d.ts

@@ -0,0 +1,9 @@
+/**
+
+
+
+*/
+/// <reference types="react" />
+export declare const ChevronDownIcon: ({ ...props }: {
+    [x: string]: any;
+}) => JSX.Element;

package/dist/toolkit/icons/ChevronLeft.d.ts

@@ -0,0 +1,9 @@
+/**
+
+
+
+*/
+/// <reference types="react" />
+export declare const ChevronLeftIcon: ({ ...props }: {
+    [x: string]: any;
+}) => JSX.Element;

package/dist/toolkit/icons/ChevronRight.d.ts

@@ -0,0 +1,9 @@
+/**
+
+
+
+*/
+/// <reference types="react" />
+export declare const ChevronRightIcon: ({ ...props }: {
+    [x: string]: any;
+}) => JSX.Element;

package/dist/toolkit/icons/ChevronUp.d.ts

@@ -0,0 +1,9 @@
+/**
+
+
+
+*/
+/// <reference types="react" />
+export declare const ChevronUpIcon: ({ ...props }: {
+    [x: string]: any;
+}) => JSX.Element;

package/dist/toolkit/icons/Circle.d.ts

@@ -0,0 +1,9 @@
+/**
+
+
+
+*/
+/// <reference types="react" />
+export declare const Circle: ({ ...props }: {
+    [x: string]: any;
+}) => JSX.Element;

package/dist/toolkit/icons/CircleCheck.d.ts

@@ -0,0 +1,9 @@
+/**
+
+
+
+*/
+/// <reference types="react" />
+export declare const CircleCheck: ({ ...props }: {
+    [x: string]: any;
+}) => JSX.Element;

package/dist/toolkit/icons/Close.d.ts

@@ -0,0 +1,9 @@
+/**
+
+
+
+*/
+/// <reference types="react" />
+export declare const CloseIcon: ({ ...props }: {
+    [x: string]: any;
+}) => JSX.Element;

package/dist/toolkit/icons/Code.d.ts

@@ -0,0 +1,9 @@
+/**
+
+
+
+*/
+/// <reference types="react" />
+export declare const CodeIcon: ({ ...props }: {
+    [x: string]: any;
+}) => JSX.Element;

package/dist/toolkit/icons/Drag.d.ts

@@ -0,0 +1,9 @@
+/**
+
+
+
+*/
+/// <reference types="react" />
+export declare const DragIcon: ({ ...props }: {
+    [x: string]: any;
+}) => JSX.Element;

package/dist/toolkit/icons/Duplicate.d.ts

@@ -0,0 +1,9 @@
+/**
+
+
+
+*/
+/// <reference types="react" />
+export declare const DuplicateIcon: ({ ...props }: {
+    [x: string]: any;
+}) => JSX.Element;

package/dist/toolkit/icons/Edit.d.ts

@@ -0,0 +1,9 @@
+/**
+
+
+
+*/
+/// <reference types="react" />
+export declare const EditIcon: ({ ...props }: {
+    [x: string]: any;
+}) => JSX.Element;

package/dist/toolkit/icons/EllipsisVertical.d.ts

@@ -0,0 +1,9 @@
+/**
+
+
+
+*/
+/// <reference types="react" />
+export declare const EllipsisVerticalIcon: ({ ...props }: {
+    [x: string]: any;
+}) => JSX.Element;

package/dist/toolkit/icons/Error.d.ts

@@ -0,0 +1,9 @@
+/**
+
+
+
+*/
+/// <reference types="react" />
+export declare const ErrorIcon: ({ ...props }: {
+    [x: string]: any;
+}) => JSX.Element;

package/dist/toolkit/icons/Exit.d.ts

@@ -0,0 +1,9 @@
+/**
+
+
+
+*/
+/// <reference types="react" />
+export declare const ExitIcon: ({ ...props }: {
+    [x: string]: any;
+}) => JSX.Element;

package/dist/toolkit/icons/File.d.ts

@@ -0,0 +1,9 @@
+/**
+
+
+
+*/
+/// <reference types="react" />
+export declare const File: ({ ...props }: {
+    [x: string]: any;
+}) => JSX.Element;

package/dist/toolkit/icons/Folder.d.ts

@@ -0,0 +1,9 @@
+/**
+
+
+
+*/
+/// <reference types="react" />
+export declare const Folder: ({ ...props }: {
+    [x: string]: any;
+}) => JSX.Element;

package/dist/toolkit/icons/Hamburger.d.ts

@@ -0,0 +1,9 @@
+/**
+
+
+
+*/
+/// <reference types="react" />
+export declare const HamburgerIcon: ({ ...props }: {
+    [x: string]: any;
+}) => JSX.Element;

package/dist/toolkit/icons/Heading.d.ts

@@ -0,0 +1,9 @@
+/**
+
+
+
+*/
+/// <reference types="react" />
+export declare const HeadingIcon: ({ ...props }: {
+    [x: string]: any;
+}) => JSX.Element;

package/dist/toolkit/icons/Info.d.ts

@@ -0,0 +1,9 @@
+/**
+
+
+
+*/
+/// <reference types="react" />
+export declare const InfoIcon: ({ ...props }: {
+    [x: string]: any;
+}) => JSX.Element;

package/dist/toolkit/icons/Italic.d.ts

@@ -0,0 +1,9 @@
+/**
+
+
+
+*/
+/// <reference types="react" />
+export declare const ItalicIcon: ({ ...props }: {
+    [x: string]: any;
+}) => JSX.Element;

package/dist/toolkit/icons/LeftArrow.d.ts

@@ -0,0 +1,9 @@
+/**
+
+
+
+*/
+/// <reference types="react" />
+export declare const LeftArrowIcon: ({ ...props }: {
+    [x: string]: any;
+}) => JSX.Element;

package/dist/toolkit/icons/Link.d.ts

@@ -0,0 +1,9 @@
+/**
+
+
+
+*/
+/// <reference types="react" />
+export declare const LinkIcon: ({ ...props }: {
+    [x: string]: any;
+}) => JSX.Element;

package/dist/toolkit/icons/Lock.d.ts

@@ -0,0 +1,9 @@
+/**
+
+
+
+*/
+/// <reference types="react" />
+export declare const LockIcon: ({ ...props }: {
+    [x: string]: any;
+}) => JSX.Element;

package/dist/toolkit/icons/Markdown.d.ts

@@ -0,0 +1,9 @@
+/**
+
+
+
+*/
+/// <reference types="react" />
+export declare const MarkdownIcon: ({ ...props }: {
+    [x: string]: any;
+}) => JSX.Element;

package/dist/toolkit/icons/Media.d.ts

@@ -0,0 +1,9 @@
+/**
+
+
+
+*/
+/// <reference types="react" />
+export declare const MediaIcon: ({ ...props }: {
+    [x: string]: any;
+}) => JSX.Element;

package/dist/toolkit/icons/OrderedList.d.ts

@@ -0,0 +1,9 @@
+/**
+
+
+
+*/
+/// <reference types="react" />
+export declare const OrderedListIcon: ({ ...props }: {
+    [x: string]: any;
+}) => JSX.Element;

package/dist/toolkit/icons/PullRequest.d.ts

@@ -0,0 +1,9 @@
+/**
+
+
+
+*/
+/// <reference types="react" />
+export declare const PullRequestIcon: ({ ...props }: {
+    [x: string]: any;
+}) => JSX.Element;

package/dist/toolkit/icons/Quote.d.ts

@@ -0,0 +1,9 @@
+/**
+
+
+
+*/
+/// <reference types="react" />
+export declare const QuoteIcon: ({ ...props }: {
+    [x: string]: any;
+}) => JSX.Element;

package/dist/toolkit/icons/Redo.d.ts

@@ -0,0 +1,9 @@
+/**
+
+
+
+*/
+/// <reference types="react" />
+export declare const RedoIcon: ({ ...props }: {
+    [x: string]: any;
+}) => JSX.Element;