@tinacms/schema-tools 0.1.5 → 0.1.7

package/dist/schema/TinaSchema.d.ts

@@ -49,9 +49,7 @@ export declare class TinaSchema {
     getGlobalTemplate: (templateName: string) => {
         label: string;
         name: string;
-        ui?: object | (import("../types").UIField<any, any> & {
-            previewSrc: string;
-        });
+        ui?: import("../types").UICollection;
         fields: import("../types").TinaFieldInner<true>[];
         namespace: string[];
     };

package/dist/types/SchemaTypes.d.ts

@@ -65,49 +65,52 @@ export declare type TinaIndex = {
         name: string;
     }[];
 };
+export interface UICollection {
+    filename?: {
+        slugify?: (values: Record<string, any>) => string;
+        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: TinaCloudCollection<true>;
+    }) => string | undefined;
+}
+declare type DefaultItem<ReturnType> = () => ReturnType | ReturnType;
 interface BaseCollection {
     label?: string;
     name: string;
     path: string;
-    defaultItem?: () => unknown | unknown;
+    defaultItem?: DefaultItem<Record<string, any>>;
     indexes?: TinaIndex[];
     format?: FormatType;
-    ui?: {
-        filename?: {
-            slugify?: (values: unknown) => string;
-            disabled?: 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: TinaCloudCollection<true>;
-        }) => string | undefined;
-    };
+    ui?: UICollection;
     match?: string;
 }
-declare type CollectionTemplates<WithNamespace extends boolean> = WithNamespace extends true ? CollectionTemplatesWithNamespace<WithNamespace> : CollectionTemplatesInner<WithNamespace>;
+export declare type CollectionTemplates<WithNamespace extends boolean> = WithNamespace extends true ? CollectionTemplatesWithNamespace<WithNamespace> : CollectionTemplatesInner<WithNamespace>;
+export declare type TinaTemplate = Template<false>;
 interface CollectionTemplatesInner<WithNamespace extends boolean> extends BaseCollection {
-    templates: (string | Template<WithNamespace>)[];
+    templates: (string | GlobalTemplate<WithNamespace>)[];
     fields?: undefined;
 }
 export interface CollectionTemplatesWithNamespace<WithNamespace extends boolean> extends BaseCollection {
-    templates: (string | Template<WithNamespace>)[];
+    templates: (string | GlobalTemplate<WithNamespace>)[];
     fields?: undefined;
     references?: ReferenceType<WithNamespace>[];
     namespace: WithNamespace extends true ? string[] : undefined;
@@ -169,7 +172,9 @@ declare type StringField = {
     isBody?: boolean;
     list: true;
     isTitle?: never;
-    ui?: UIField<any, string[]>;
+    ui?: UIField<any, string[]> & {
+        defaultItem?: DefaultItem<string>;
+    };
 };
 declare type BooleanField = {
     type: 'boolean';
@@ -287,6 +292,9 @@ interface ObjectTemplatesWithNamespace<WithNamespace extends boolean> extends Ti
     type: 'object';
     visualSelector?: boolean;
     required?: false;
+    ui?: UIField<any, Record<string, any>> & {
+        defaultItem?: DefaultItem<Record<string, any>>;
+    };
     list?: boolean;
     /**
      * templates can either be an array of Tina templates or a reference to
@@ -305,6 +313,9 @@ interface InnerObjectFields<WithNamespace extends boolean> extends TinaField {
     type: 'object';
     visualSelector?: boolean;
     required?: false;
+    ui?: UIField<any, Record<string, any>> & {
+        defaultItem?: DefaultItem<Record<string, any>>;
+    };
     /**
      * fields can either be an array of Tina fields, or a reference to the fields
      * of a global template definition.
@@ -319,6 +330,9 @@ interface InnerObjectFieldsWithNamespace<WithNamespace extends boolean> extends
     type: 'object';
     visualSelector?: boolean;
     required?: false;
+    ui?: UIField<any, Record<string, any>> & {
+        defaultItem?: DefaultItem<Record<string, any>>;
+    };
     /**
      * fields can either be an array of Tina fields, or a reference to the fields
      * of a global template definition.
@@ -338,17 +352,13 @@ interface InnerObjectFieldsWithNamespace<WithNamespace extends boolean> extends
 export declare type GlobalTemplate<WithNamespace extends boolean> = WithNamespace extends true ? {
     label: string;
     name: string;
-    ui?: object | (UIField<any, any> & {
-        previewSrc: string;
-    });
+    ui?: UICollection;
     fields: TinaFieldInner<WithNamespace>[];
     namespace: WithNamespace extends true ? string[] : undefined;
 } : {
     label: string;
     name: string;
-    ui?: object | (UIField<any, any> & {
-        previewSrc: string;
-    });
+    ui?: UICollection;
     fields: TinaFieldInner<WithNamespace>[];
 };
 export declare type TinaCloudTemplateBase = GlobalTemplate<false>;
@@ -389,6 +399,9 @@ export declare type CollectionTemplateableObject = {
     namespace: string[];
     type: 'object';
     visualSelector?: boolean;
+    ui?: UIField<any, Record<string, any>> & {
+        defaultItem?: DefaultItem<Record<string, any>>;
+    };
     required?: false;
     template: Templateable;
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tinacms/schema-tools",
-  "version": "0.1.5",
+  "version": "0.1.7",
   "main": "dist/index.js",
   "module": "./dist/index.es.js",
   "exports": {