@tinacms/schema-tools 2.0.0 → 2.1.0

package/dist/types/index.d.ts

@@ -125,6 +125,26 @@ 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;
@@ -558,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

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@tinacms/schema-tools",
   "type": "module",
-  "version": "2.0.0",
+  "version": "2.1.0",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "files": [
@@ -24,7 +24,7 @@
     "ts-jest": "^29.2.5",
     "typescript": "^5.7.3",
     "yup": "^1.6.1",
-    "@tinacms/scripts": "1.4.1"
+    "@tinacms/scripts": "1.4.2"
   },
   "peerDependencies": {
     "react": ">=16.14.0",