@tinacms/schema-tools 0.0.0-d08af95-20241024210716 → 0.0.0-d4c653b-20251027224657

package/dist/schema/addNamespaceToSchema.d.ts

@@ -1,4 +1,8 @@
-/**
-
-*/
-export declare function addNamespaceToSchema<T extends object | string>(maybeNode: T, namespace?: string[]): T;
+type Node = {
+    name?: string;
+    value?: string;
+    namespace?: string[];
+    [key: string]: any;
+};
+export declare function addNamespaceToSchema<T extends Node | string>(maybeNode: T, namespace?: string[]): T;
+export {};

package/dist/types/index.d.ts

@@ -1,5 +1,23 @@
 import type { FC } from 'react';
 import type React from 'react';
+export declare const CONTENT_FORMATS: readonly ["mdx", "md", "markdown", "json", "yaml", "yml", "toml"];
+export type ContentFormat = (typeof CONTENT_FORMATS)[number];
+export type ContentFrontmatterFormat = 'yaml' | 'toml' | 'json';
+export type Parser = {
+    type: 'mdx';
+} | {
+    type: 'markdown';
+    /**
+     * Tina will escape entities like `<` and `[` by default. You can choose to turn
+     * off all escaping, or specify HTML, so `<div>` will not be turned into `\<div>`
+     */
+    skipEscaping?: 'all' | 'html' | 'none';
+} | {
+    /**
+     * Experimental: Returns the native Slate.js document as JSON. Ideal to retain the pure editor content structure.
+     */
+    type: 'slatejson';
+};
 type Meta = {
     active?: boolean;
     dirty?: boolean;
@@ -111,6 +129,11 @@ export type UIField<Type, List extends boolean> = {
 type FieldGeneric<Type, List extends boolean | undefined, ExtraFieldUIProps = {}> = List extends true ? {
     list: true;
     ui?: UIField<Type, true> & ExtraFieldUIProps;
+    /**
+     * Defines where new items will be added in the list.
+     * If not specified, defaults to `append`.
+     */
+    addItemBehavior?: 'append' | 'prepend';
 } : List extends false ? {
     list?: false;
     ui?: UIField<Type, false> & ExtraFieldUIProps;
@@ -185,7 +208,7 @@ export type ReferenceField = (FieldGeneric<string, undefined, ReferenceFieldOpti
 export type PasswordField = (FieldGeneric<string, undefined> | FieldGeneric<string, false>) & BaseField & {
     type: 'password';
 };
-type toolbarItemName = 'heading' | 'link' | 'image' | 'quote' | 'ul' | 'ol' | 'code' | 'codeBlock' | 'bold' | 'italic' | 'raw' | 'embed' | 'mermaid';
+type ToolbarOverrideType = 'heading' | 'link' | 'image' | 'quote' | 'ul' | 'ol' | 'code' | 'codeBlock' | 'bold' | 'italic' | 'raw' | 'embed' | 'mermaid' | 'table';
 type RichTextAst = {
     type: 'root';
     children: Record<string, unknown>[];
@@ -198,24 +221,21 @@ export type RichTextField<WithNamespace extends boolean = false> = (FieldGeneric
      * will be stored as frontmatter
      */
     isBody?: boolean;
-    toolbarOverride?: toolbarItemName[];
+    /**@deprecated use overrides.toolbar */
+    toolbarOverride?: ToolbarOverrideType[];
     templates?: RichTextTemplate<WithNamespace>[];
+    overrides?: {
+        toolbar?: ToolbarOverrideType[];
+        /**Default set to true */
+        showFloatingToolbar?: boolean;
+    };
     /**
      * By default, Tina parses markdown with MDX, this is a more strict parser
      * that allows you to use structured content inside markdown (via `templates`).
      *
      * Specify `"markdown"` if you're having problems with Tina parsing your content.
      */
-    parser?: {
-        type: 'markdown';
-        /**
-         * Tina will escape entities like `<` and `[` by default. You can choose to turn
-         * off all escaping, or specify HTML, so `<div>` will not be turned into `\<div>`
-         */
-        skipEscaping?: 'all' | 'html' | 'none';
-    } | {
-        type: 'mdx';
-    };
+    parser?: Parser;
 };
 export type RichTextTemplate<WithNamespace extends boolean = false> = Template<WithNamespace> & {
     inline?: boolean;
@@ -371,7 +391,7 @@ export interface Config<CMSCallback = undefined, FormifyCallback = undefined, Do
     /**
      * The Schema is used to define the shape of the content.
      *
-     * https://tina.io/docs/reference/schema/
+     * https://tina.io/docs/r/the-config-file/
      */
     schema: Schema;
     /**
@@ -394,7 +414,7 @@ export interface Config<CMSCallback = undefined, FormifyCallback = undefined, Do
     token?: string | null;
     ui?: {
         /**
-         * When using Tina Cloud's branching feature, provide the URL for your given branch
+         * When using TinaCloud's branching feature, provide the URL for your given branch
          *
          * Eg. If you're deplying to Vercel, and your repo name is 'my-app',
          * Vercel's preview URL would be based on the branch:
@@ -408,11 +428,17 @@ export interface Config<CMSCallback = undefined, FormifyCallback = undefined, Do
          * ```
          * [more info](https://vercel.com/docs/concepts/deployments/generated-urls#url-with-git-branch)
          */
-        previewUrl: (context: {
+        previewUrl?: (context: {
             branch: string;
         }) => {
             url: string;
         };
+        /**
+         * Opt out of update checks - this will prevent the CMS for checking for new versions
+         * If true, the CMS will not check for updates.
+         * Defaults to false if not specified.
+         */
+        optOutOfUpdateCheck?: boolean;
     };
     /**
      * Configurations for the autogenerated GraphQL HTTP client
@@ -492,7 +518,7 @@ export interface Config<CMSCallback = undefined, FormifyCallback = undefined, Do
     } | {
         /**
          * Use Git-backed assets for media, these values will
-         * [Learn more](https://tina.io/docs/reference/media/repo-based/)
+         * [Learn more](https://tina.io/docs/r/repo-based-media/)
          */
         tina: {
             /**
@@ -521,7 +547,7 @@ export interface Config<CMSCallback = undefined, FormifyCallback = undefined, Do
     } | {
         searchClient?: never;
         /**
-         * Use the Tina Cloud search index
+         * Use the TinaCloud search index
          */
         tina: {
             /**
@@ -548,7 +574,7 @@ export interface Config<CMSCallback = undefined, FormifyCallback = undefined, Do
         maxSearchIndexFieldLength?: number;
     };
     /**
-     * Used to override the default Tina Cloud API URL
+     * Used to override the default TinaCloud API URL
      *
      * [mostly for internal use only]
      */
@@ -567,7 +593,7 @@ export interface Schema<WithNamespace extends boolean = false> {
     /**
      * 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/
+     * https://tina.io/docs/r/content-modelling-collections/
      */
     collections: Collection<WithNamespace>[];
     /**
@@ -581,7 +607,7 @@ interface BaseCollection {
     name: string;
     path: string;
     indexes?: IndexType[];
-    format?: 'json' | 'md' | 'markdown' | 'mdx' | 'yaml' | 'yml' | 'toml';
+    format?: ContentFormat;
     ui?: UICollection;
     /**
      * @deprecated - use `ui.defaultItem` on the each `template` instead
@@ -590,7 +616,7 @@ interface BaseCollection {
     /**
      * This format will be used to parse the markdown frontmatter
      */
-    frontmatterFormat?: 'yaml' | 'toml' | 'json';
+    frontmatterFormat?: ContentFrontmatterFormat;
     /**
      * The delimiters used to parse the frontmatter.
      */
@@ -606,7 +632,7 @@ type TemplateCollection<WithNamespace extends boolean = false> = {
     /**
      * 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/
+     * https://tina.io/docs/r/content-modelling-templates/
      */
     templates: Template<WithNamespace>[];
     fields?: undefined;
@@ -615,7 +641,7 @@ type FieldCollection<WithNamespace extends boolean = false> = {
     /**
      * Fields define the shape of the content and the user input.
      *
-     * https://tina.io/docs/reference/fields/
+     * https://tina.io/docs/r/string-fields/
      */
     fields: TinaField<WithNamespace>[];
     templates?: undefined;
@@ -630,6 +656,7 @@ type Document = {
         relativePath: string;
         filename: string;
         extension: string;
+        hasReferences?: boolean;
     };
 };
 export interface UICollection<Form = any, CMS = any, TinaForm = any> {

package/dist/util/normalizePath.d.ts

@@ -1 +1,9 @@
 export declare const normalizePath: (filepath: string) => string;
+/**
+ * Returns the given path such that:
+ * - The path separator is converted from '\' to '/' if necessary.
+ * - Duplicate '/' are removed
+ * - Leading and trailing '/' are cleared
+ * @param filepath Filepath to convert to its canonical form
+ */
+export declare const canonicalPath: (filepath: string) => string;

package/dist/validate/fields.d.ts

@@ -1,6 +1,3 @@
-/**
-
-*/
 import { z } from 'zod';
 import type { TinaField as TinaFieldType } from '../types/index';
 export declare const TinaFieldZod: z.ZodType<TinaFieldType>;

package/dist/validate/schema.d.ts

@@ -1,26 +1,23 @@
-/**
-
-*/
 import { z } from 'zod';
 export declare const CollectionBaseSchema: z.ZodObject<{
     label: z.ZodOptional<z.ZodString>;
     name: z.ZodEffects<z.ZodEffects<z.ZodString, string, string>, string, string>;
     path: z.ZodEffects<z.ZodEffects<z.ZodString, string, string>, string, string>;
-    format: z.ZodOptional<z.ZodEnum<["json", "md", "markdown", "mdx", "toml", "yaml", "yml"]>>;
+    format: z.ZodOptional<z.ZodEnum<["mdx", "md", "markdown", "json", "yaml", "yml", "toml"]>>;
     isAuthCollection: z.ZodOptional<z.ZodBoolean>;
     isDetached: z.ZodOptional<z.ZodBoolean>;
 }, "strip", z.ZodTypeAny, {
     name?: string;
     label?: string;
     path?: string;
-    format?: "markdown" | "mdx" | "json" | "md" | "yaml" | "yml" | "toml";
+    format?: "mdx" | "md" | "markdown" | "json" | "yaml" | "yml" | "toml";
     isDetached?: boolean;
     isAuthCollection?: boolean;
 }, {
     name?: string;
     label?: string;
     path?: string;
-    format?: "markdown" | "mdx" | "json" | "md" | "yaml" | "yml" | "toml";
+    format?: "mdx" | "md" | "markdown" | "json" | "yaml" | "yml" | "toml";
     isDetached?: boolean;
     isAuthCollection?: boolean;
 }>;
@@ -29,90 +26,90 @@ export declare const TinaCloudSchemaZod: z.ZodEffects<z.ZodObject<{
         label: z.ZodOptional<z.ZodString>;
         name: z.ZodEffects<z.ZodEffects<z.ZodString, string, string>, string, string>;
         path: z.ZodEffects<z.ZodEffects<z.ZodString, string, string>, string, string>;
-        format: z.ZodOptional<z.ZodEnum<["json", "md", "markdown", "mdx", "toml", "yaml", "yml"]>>;
+        format: z.ZodOptional<z.ZodEnum<["mdx", "md", "markdown", "json", "yaml", "yml", "toml"]>>;
         isAuthCollection: z.ZodOptional<z.ZodBoolean>;
         isDetached: z.ZodOptional<z.ZodBoolean>;
     }, {
-        fields: z.ZodEffects<z.ZodEffects<z.ZodEffects<z.ZodEffects<z.ZodOptional<z.ZodArray<z.ZodType<import("..").TinaField, z.ZodTypeDef, import("..").TinaField>, "many">>, import("..").TinaField[], import("..").TinaField[]>, import("..").TinaField[], import("..").TinaField[]>, import("..").TinaField[], import("..").TinaField[]>, import("..").TinaField[], import("..").TinaField[]>;
+        fields: z.ZodEffects<z.ZodEffects<z.ZodEffects<z.ZodEffects<z.ZodOptional<z.ZodArray<z.ZodType<import("../types/index").TinaField, z.ZodTypeDef, import("../types/index").TinaField>, "many">>, import("../types/index").TinaField[], import("../types/index").TinaField[]>, import("../types/index").TinaField[], import("../types/index").TinaField[]>, import("../types/index").TinaField[], import("../types/index").TinaField[]>, import("../types/index").TinaField[], import("../types/index").TinaField[]>;
         templates: z.ZodEffects<z.ZodOptional<z.ZodArray<z.ZodEffects<z.ZodObject<{
             label: z.ZodString;
             name: z.ZodEffects<z.ZodString, string, string>;
-            fields: z.ZodArray<z.ZodType<import("..").TinaField, z.ZodTypeDef, import("..").TinaField>, "many">;
+            fields: z.ZodArray<z.ZodType<import("../types/index").TinaField, z.ZodTypeDef, import("../types/index").TinaField>, "many">;
         }, "strip", z.ZodTypeAny, {
             name?: string;
-            fields?: import("..").TinaField[];
+            fields?: import("../types/index").TinaField[];
             label?: string;
         }, {
             name?: string;
-            fields?: import("..").TinaField[];
+            fields?: import("../types/index").TinaField[];
             label?: string;
         }>, {
             name?: string;
-            fields?: import("..").TinaField[];
+            fields?: import("../types/index").TinaField[];
             label?: string;
         }, {
             name?: string;
-            fields?: import("..").TinaField[];
+            fields?: import("../types/index").TinaField[];
             label?: string;
         }>, "many">>, {
             name?: string;
-            fields?: import("..").TinaField[];
+            fields?: import("../types/index").TinaField[];
             label?: string;
         }[], {
             name?: string;
-            fields?: import("..").TinaField[];
+            fields?: import("../types/index").TinaField[];
             label?: string;
         }[]>;
     }>, "strip", z.ZodTypeAny, {
         name?: string;
         templates?: {
             name?: string;
-            fields?: import("..").TinaField[];
+            fields?: import("../types/index").TinaField[];
             label?: string;
         }[];
-        fields?: import("..").TinaField[];
+        fields?: import("../types/index").TinaField[];
         label?: string;
         path?: string;
-        format?: "markdown" | "mdx" | "json" | "md" | "yaml" | "yml" | "toml";
+        format?: "mdx" | "md" | "markdown" | "json" | "yaml" | "yml" | "toml";
         isDetached?: boolean;
         isAuthCollection?: boolean;
     }, {
         name?: string;
         templates?: {
             name?: string;
-            fields?: import("..").TinaField[];
+            fields?: import("../types/index").TinaField[];
             label?: string;
         }[];
-        fields?: import("..").TinaField[];
+        fields?: import("../types/index").TinaField[];
         label?: string;
         path?: string;
-        format?: "markdown" | "mdx" | "json" | "md" | "yaml" | "yml" | "toml";
+        format?: "mdx" | "md" | "markdown" | "json" | "yaml" | "yml" | "toml";
         isDetached?: boolean;
         isAuthCollection?: boolean;
     }>, {
         name?: string;
         templates?: {
             name?: string;
-            fields?: import("..").TinaField[];
+            fields?: import("../types/index").TinaField[];
             label?: string;
         }[];
-        fields?: import("..").TinaField[];
+        fields?: import("../types/index").TinaField[];
         label?: string;
         path?: string;
-        format?: "markdown" | "mdx" | "json" | "md" | "yaml" | "yml" | "toml";
+        format?: "mdx" | "md" | "markdown" | "json" | "yaml" | "yml" | "toml";
         isDetached?: boolean;
         isAuthCollection?: boolean;
     }, {
         name?: string;
         templates?: {
             name?: string;
-            fields?: import("..").TinaField[];
+            fields?: import("../types/index").TinaField[];
             label?: string;
         }[];
-        fields?: import("..").TinaField[];
+        fields?: import("../types/index").TinaField[];
         label?: string;
         path?: string;
-        format?: "markdown" | "mdx" | "json" | "md" | "yaml" | "yml" | "toml";
+        format?: "mdx" | "md" | "markdown" | "json" | "yaml" | "yml" | "toml";
         isDetached?: boolean;
         isAuthCollection?: boolean;
     }>, "many">;
@@ -240,13 +237,13 @@ export declare const TinaCloudSchemaZod: z.ZodEffects<z.ZodObject<{
         name?: string;
         templates?: {
             name?: string;
-            fields?: import("..").TinaField[];
+            fields?: import("../types/index").TinaField[];
             label?: string;
         }[];
-        fields?: import("..").TinaField[];
+        fields?: import("../types/index").TinaField[];
         label?: string;
         path?: string;
-        format?: "markdown" | "mdx" | "json" | "md" | "yaml" | "yml" | "toml";
+        format?: "mdx" | "md" | "markdown" | "json" | "yaml" | "yml" | "toml";
         isDetached?: boolean;
         isAuthCollection?: boolean;
     }[];
@@ -278,13 +275,13 @@ export declare const TinaCloudSchemaZod: z.ZodEffects<z.ZodObject<{
         name?: string;
         templates?: {
             name?: string;
-            fields?: import("..").TinaField[];
+            fields?: import("../types/index").TinaField[];
             label?: string;
         }[];
-        fields?: import("..").TinaField[];
+        fields?: import("../types/index").TinaField[];
         label?: string;
         path?: string;
-        format?: "markdown" | "mdx" | "json" | "md" | "yaml" | "yml" | "toml";
+        format?: "mdx" | "md" | "markdown" | "json" | "yaml" | "yml" | "toml";
         isDetached?: boolean;
         isAuthCollection?: boolean;
     }[];
@@ -316,13 +313,13 @@ export declare const TinaCloudSchemaZod: z.ZodEffects<z.ZodObject<{
         name?: string;
         templates?: {
             name?: string;
-            fields?: import("..").TinaField[];
+            fields?: import("../types/index").TinaField[];
             label?: string;
         }[];
-        fields?: import("..").TinaField[];
+        fields?: import("../types/index").TinaField[];
         label?: string;
         path?: string;
-        format?: "markdown" | "mdx" | "json" | "md" | "yaml" | "yml" | "toml";
+        format?: "mdx" | "md" | "markdown" | "json" | "yaml" | "yml" | "toml";
         isDetached?: boolean;
         isAuthCollection?: boolean;
     }[];
@@ -354,13 +351,13 @@ export declare const TinaCloudSchemaZod: z.ZodEffects<z.ZodObject<{
         name?: string;
         templates?: {
             name?: string;
-            fields?: import("..").TinaField[];
+            fields?: import("../types/index").TinaField[];
             label?: string;
         }[];
-        fields?: import("..").TinaField[];
+        fields?: import("../types/index").TinaField[];
         label?: string;
         path?: string;
-        format?: "markdown" | "mdx" | "json" | "md" | "yaml" | "yml" | "toml";
+        format?: "mdx" | "md" | "markdown" | "json" | "yaml" | "yml" | "toml";
         isDetached?: boolean;
         isAuthCollection?: boolean;
     }[];

package/dist/validate/util.d.ts

@@ -0,0 +1,3 @@
+export declare const duplicateFieldErrorMessage: (fields: string) => string;
+export declare const duplicateTemplateErrorMessage: (templates: string) => string;
+export declare const duplicateCollectionErrorMessage: (collection: string) => string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tinacms/schema-tools",
-  "version": "0.0.0-d08af95-20241024210716",
+  "version": "0.0.0-d4c653b-20251027224657",
   "main": "dist/index.js",
   "module": "./dist/index.mjs",
   "exports": {
@@ -23,16 +23,16 @@
     ]
   },
   "devDependencies": {
-    "@types/jest": "^29.5.13",
+    "@types/jest": "^29.5.14",
     "@types/micromatch": "^4.0.9",
-    "@types/react": "^18.3.10",
+    "@types/react": "^18.3.18",
     "@types/yup": "^0.29.14",
     "jest": "^29.7.0",
     "react": "^18.3.1",
     "ts-jest": "^29.2.5",
-    "typescript": "^5.6.2",
+    "typescript": "^5.7.3",
     "yup": "^0.32.11",
-    "@tinacms/scripts": "1.3.0"
+    "@tinacms/scripts": "0.0.0-d4c653b-20251027224657"
   },
   "peerDependencies": {
     "react": ">=16.14.0",
@@ -48,7 +48,7 @@
   "dependencies": {
     "picomatch-browser": "2.2.6",
     "url-pattern": "^1.0.3",
-    "zod": "^3.23.8"
+    "zod": "^3.24.2"
   },
   "scripts": {
     "build": "tinacms-scripts build",