@tinacms/schema-tools 0.0.0-bf22bf8-20241004045704 → 0.0.0-c19d29e-20251224001156

package/dist/schema/TinaSchema.d.ts

@@ -28,6 +28,7 @@ export declare class TinaSchema {
     } & Schema);
     getIsTitleFieldName: (collection: string) => string;
     getCollectionsByName: (collectionNames: string[]) => Collection<true>[];
+    findReferencesFromCollection(name: string): Record<string, string[]>;
     getCollection: (collectionName: string) => Collection<true>;
     getCollections: () => Collection<true>[];
     getCollectionByFullPath: (filepath: string) => Collection<true>;
@@ -59,7 +60,26 @@ export declare class TinaSchema {
      *
      */
     getTemplatesForCollectable: (collection: Collectable) => CollectionTemplateable;
-    walkFields: (cb: (args: {
+    /**
+     * Walk all fields in tina schema
+     *
+     * @param cb callback function invoked for each field
+     */
+    walkFields(cb: (args: {
+        field: any;
+        collection: any;
+        path: string;
+        isListItem?: boolean;
+    }) => void): void;
+    /**
+     * Walk all fields in Tina Schema
+     *
+     * This is a legacy version to preserve backwards compatibility for the tina generated schema. It does not
+     * traverse fields in object lists in rich-text templates.
+     *
+     * @param cb callback function invoked for each field
+     */
+    legacyWalkFields: (cb: (args: {
         field: TinaField;
         collection: Collection;
         path: string[];

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/schema/resolveForm.d.ts

@@ -13,7 +13,7 @@ export declare const resolveForm: ({ collection, basename, template, schema, }:
     fields: {
         [key: string]: unknown;
         name: string;
-        component: NonNullable<import("../types/index").TinaField<true>["ui"]>["component"];
+        component: NonNullable<import("..").TinaField<true>["ui"]>["component"];
         type: string;
     }[];
 };

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;
@@ -107,10 +125,35 @@ export type UIField<Type, List extends boolean> = {
      * @deprecated use `defaultItem` at the collection level instead
      */
     defaultValue?: List extends true ? Type[] : Type;
+    /**
+     * The color format for the color picker component.
+     * Can be 'hex' or 'rgb'.
+     */
+    colorFormat?: 'hex' | 'rgb';
+    /**
+     * The widget style for the color picker component.
+     * Can be 'sketch' or 'block'.
+     */
+    widget?: 'sketch' | 'block';
+    /**
+     * The width of the color picker component.
+     * Accepts CSS width values (e.g., '350px').
+     */
+    width?: string;
+    /**
+     * Preset colors for the color picker component.
+     * An array of color strings (e.g., ['#D0021B', '#F5A623']).
+     */
+    colors?: string[];
 };
 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;
@@ -150,14 +193,24 @@ type DateFormatProps = {
      * dateFormat: 'YYYY MM DD'
      * ```
      */
-    dateFormat?: string;
-    timeFormat?: string;
+    dateFormat?: string | boolean;
+    timeFormat?: string | boolean;
 };
 export type DateTimeField = (FieldGeneric<string, undefined, DateFormatProps> | FieldGeneric<string, true, DateFormatProps> | FieldGeneric<string, false, DateFormatProps>) & BaseField & {
     type: 'datetime';
 };
 export type ImageField = (FieldGeneric<string, undefined> | FieldGeneric<string, true> | FieldGeneric<string, false>) & BaseField & {
     type: 'image';
+    /**
+     * A function that returns the upload directory path based on the form values.
+     * This is used to organize uploaded images into specific folders.
+     *
+     * @example
+     * ```ts
+     * uploadDir: (formValues) => `uploads/${formValues.category}`
+     * ```
+     */
+    uploadDir?: (formValues: Record<string, any>) => string;
 };
 type ReferenceFieldOptions = {
     optionComponent?: OptionComponent;
@@ -185,7 +238,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';
+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 +251,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 +421,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 +444,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 +458,27 @@ 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;
+        /**
+         * Regular expression pattern that folder names must match when creating new folders.
+         * Only applies to newly created folders, not existing ones.
+         *
+         * @example "^[a-z0-9-]+$" - allows lowercase letters, numbers, and hyphens only
+         * @example "^[A-Za-z0-9_-]+$" - allows letters, numbers, underscores, and hyphens
+         */
+        regexValidation?: {
+            folderNameRegex?: string;
+        };
     };
     /**
      * Configurations for the autogenerated GraphQL HTTP client
@@ -492,7 +558,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: {
             /**
@@ -512,6 +578,54 @@ export interface Config<CMSCallback = undefined, FormifyCallback = undefined, Do
         loadCustomStore?: never;
         accept?: string | string[];
     };
+    /**
+     * Configuration for repository-related UI features.
+     *
+     * This allows you to configure how the CMS displays repository information
+     * and generates links to view file history in your Git provider (e.g., GitHub, GitLab).
+     *
+     * @example
+     *
+     * repoProvider: {
+     *   defaultBranchName: 'main',
+     *   historyUrl: ({ relativePath, branch }) => ({
+     *     url: `https://github.com/owner/repo/commits/${branch}/${relativePath}`
+     *   })
+     * }
+     *    */
+    repoProvider?: {
+        /**
+         * The default branch name to use when in local mode or when no branch is specified.
+         * When not in local mode, TinaCMS will use the branch selected in the editor.
+         *
+         * This is typically your main/master branch name (e.g., "main", "master").
+         */
+        defaultBranchName?: string;
+        /**
+         * A function that generates a URL to view the commit history for a specific file.
+         *
+         * This URL is used to link to your Git provider's history view (e.g., GitHub's commits page).
+         * The function receives the file's relative path and current branch, and should return
+         * a URL object with the full URL to the history page.
+         *
+         * @param context - Context object containing file and branch information
+         * @param context.relativePath - The relative path of the file from the repository root
+         * @param context.branch - The current branch name
+         * @returns An object with a `url` property containing the full URL to the history page
+         *
+         * @example
+         *s
+         * historyUrl: ({ relativePath, branch }) => ({
+         *   url: `https://github.com/tinacms/tinacms/commits/${branch}/examples/next-2024/${relativePath}`
+         * })
+         *      */
+        historyUrl?: (context: {
+            relativePath: string;
+            branch: string;
+        }) => {
+            url: string;
+        };
+    };
     search?: ({
         /**
          * An instance of a search client like Algolia
@@ -521,7 +635,7 @@ export interface Config<CMSCallback = undefined, FormifyCallback = undefined, Do
     } | {
         searchClient?: never;
         /**
-         * Use the Tina Cloud search index
+         * Use the TinaCloud search index
          */
         tina: {
             /**
@@ -536,6 +650,25 @@ export interface Config<CMSCallback = undefined, FormifyCallback = undefined, Do
              * regex used for splitting tokens (default: /[\p{L}\d_]+/)
              */
             tokenSplitRegex?: string;
+            /**
+             * Enable fuzzy search by default (default: true)
+             */
+            fuzzyEnabled?: boolean;
+            /**
+             * Fuzzy search options
+             */
+            fuzzyOptions?: {
+                /** Maximum edit distance for fuzzy matching (default: 2) */
+                maxDistance?: number;
+                /** Minimum similarity score 0-1 for matches (default: 0.6) */
+                minSimilarity?: number;
+                /** Maximum number of fuzzy matches to return per term (default: 10) */
+                maxResults?: number;
+                /** Use Damerau-Levenshtein (allows transpositions) (default: true) */
+                useTranspositions?: boolean;
+                /** Case sensitive matching (default: false) */
+                caseSensitive?: boolean;
+            };
         };
     }) & {
         /**
@@ -548,7 +681,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 +700,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 +714,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 +723,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 +739,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 +748,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 +763,7 @@ type Document = {
         relativePath: string;
         filename: string;
         extension: string;
+        hasReferences?: boolean;
     };
 };
 export interface UICollection<Form = any, CMS = any, TinaForm = any> {
@@ -671,6 +805,7 @@ export interface UICollection<Form = any, CMS = any, TinaForm = any> {
     allowedActions?: {
         create?: boolean;
         delete?: boolean;
+        createFolder?: boolean;
         createNestedFolder?: boolean;
     };
     /**

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>;