tinacms 3.8.4 → 3.9.0

package/dist/internalClient/index.d.ts

@@ -2,16 +2,20 @@ import { BranchData, EventBus } from '@tinacms/toolkit';
 import { DocumentNode, GraphQLSchema } from 'graphql';
 import { TokenObject } from '../auth/authenticate';
 import { AuthProvider, Schema, TinaSchema } from '@tinacms/schema-tools';
-import { SearchClient, SearchOptions, SearchQueryResponse, IndexableDocument, FuzzySearchOptions } from '@tinacms/search/index-client';
+import { FuzzySearchOptions, IndexableDocument, SearchClient, SearchOptions, SearchQueryResponse } from '@tinacms/search/index-client';
+import gql from 'graphql-tag';
+import { EditorialWorkflowResult } from '../toolkit/form-builder/editorial-workflow-constants';
+import { TinaCloudProject } from './types';
+export * from './authProvider';
 interface TinaSearchConfig {
     stopwordLanguages?: string[];
     fuzzyEnabled?: boolean;
     fuzzyOptions?: FuzzySearchOptions;
 }
-import gql from 'graphql-tag';
-import { EditorialWorkflowResult } from '../toolkit/form-builder/editorial-workflow-constants';
-import { TinaCloudProject } from './types';
-export * from './authProvider';
+type EditorialWorkflowStatusUpdate = {
+    status: string;
+    message?: string;
+};
 export type OnLoginFunc = (args: {
     token?: TokenObject;
 }) => Promise<void>;
@@ -124,11 +128,12 @@ export declare class Client {
     getIndexStatus({ ref }: {
         ref: string;
     }): Promise<{
-        status?: "unknown" | "complete" | "failed" | "inprogress";
+        status?: "complete" | "unknown" | "failed" | "inprogress";
         timestamp?: number;
     }>;
     listBranches(args?: {
         includeIndexStatus?: boolean;
+        signal?: AbortSignal;
     }): Promise<[{
         name?: string;
         protected?: boolean;
@@ -139,7 +144,7 @@ export declare class Client {
         githubPullRequestUrl?: string;
     }[]] | {
         indexStatus: {
-            status?: "unknown" | "complete" | "failed" | "inprogress";
+            status?: "complete" | "unknown" | "failed" | "inprogress";
             timestamp?: number;
         };
         name?: string;
@@ -147,9 +152,14 @@ export declare class Client {
         githubPullRequestUrl?: string;
     }[]>;
     usingProtectedBranch(): boolean;
-    branchExists(branchName: string): Promise<boolean>;
+    branchExists(branchName: string, args?: {
+        signal?: AbortSignal;
+    }): Promise<boolean>;
     createBranch({ baseBranch, branchName }: BranchData): Promise<string>;
     getLatestVersion(): Promise<LatestVersionResponse>;
+    private pollEditorialWorkflowStatus;
+    private toEditorialWorkflowError;
+    private postEditorialWorkflow;
     /**
      * Initiate and poll for the results of an editorial workflow operation
      *
@@ -169,6 +179,18 @@ export declare class Client {
             message?: string;
         }) => void;
     }): Promise<EditorialWorkflowResult>;
+    startMediaEditorialWorkflow(options: {
+        branchName: string;
+        baseBranch: string;
+        prTitle?: string;
+        operation: 'upload' | 'delete';
+        repoPath: string;
+    }): Promise<{
+        branchName: string;
+        requestId: string;
+        status?: string;
+    }>;
+    waitForEditorialWorkflowStatus(requestId: string, onStatusUpdate?: (status: EditorialWorkflowStatusUpdate) => void): Promise<EditorialWorkflowResult>;
 }
 export declare const DEFAULT_LOCAL_TINA_GQL_SERVER_URL = "http://localhost:4001/graphql";
 export declare class LocalClient extends Client {

package/dist/toolkit/components/media/media-workflow-overlay.d.ts

@@ -0,0 +1,2 @@
+import * as React from 'react';
+export declare const MediaWorkflowOverlay: () => React.JSX.Element;

package/dist/toolkit/core/event.d.ts

@@ -6,12 +6,26 @@ export interface CMSEvent {
 export declare class EventBus {
     private listeners;
     subscribe<E extends CMSEvent = CMSEvent>(event: E['type'] | E['type'][], callback: Callback<E>): () => void;
-    dispatch<E extends CMSEvent = CMSEvent>(event: E): void;
+    dispatch<E extends CMSEvent = CMSEvent>(event: E): boolean;
+    /**
+     * Whether any listener *explicitly* targets `eventType`. The catch-all `'*'`
+     * pattern does not count — callers use this to detect a purpose-built
+     * subscriber (e.g. a mounted UI overlay) without being misled by ambient
+     * `'*'` listeners such as the alerts bridge, which would otherwise make
+     * {@link dispatch} report every event as "handled".
+     */
+    hasExplicitListenerFor<E extends CMSEvent = CMSEvent>(eventType: E['type']): boolean;
 }
 export declare class Listener<E extends CMSEvent = CMSEvent> {
     private eventPattern;
     private callback;
     constructor(eventPattern: E['type'], callback: Callback<E>);
     handleEvent(event: E): boolean;
+    /**
+     * Whether this listener explicitly targets `eventType`. Unlike
+     * {@link watchesEvent}, the catch-all `'*'` pattern does NOT match, so this
+     * reflects a purpose-built subscription rather than an ambient one.
+     */
+    isExplicitListenerFor(eventType: E['type']): boolean;
     watchesEvent(currentEvent: E): boolean;
 }

package/dist/toolkit/core/media-store.default.d.ts

@@ -1,4 +1,4 @@
-import { CMS } from './cms';
+import type { TinaCMS } from '../tina-cms';
 import { Media, MediaList, MediaListOptions, MediaStore, MediaUploadOptions } from './media';
 export declare class DummyMediaStore implements MediaStore {
     accept: string;
@@ -30,14 +30,16 @@ export declare class TinaMediaStore implements MediaStore {
     private url;
     private staticMedia;
     isStatic?: boolean;
-    constructor(cms: CMS, staticMedia?: StaticMedia);
+    private workflowBranchOverride;
+    private mediaWorkflowInProgress;
+    constructor(cms: TinaCMS, staticMedia?: StaticMedia);
     setup(): void;
     isAuthenticated(): Promise<boolean>;
     accept: string;
     maxSize: number;
     /**
-     * Returns the current branch as a single-encoded query-param value, or
-     * an empty string when no branch is set.
+     * Returns the workflow branch override or current branch as a single-encoded
+     * query-param value, or an empty string when no branch is set.
      *
      * `this.api.branch` is already URL-encoded by `Client.setBranch()`, so we
      * decode then re-encode here to defend against double-encoding when this
@@ -50,7 +52,32 @@ export declare class TinaMediaStore implements MediaStore {
      * assets-api (which would route the call to a non-existent staging path).
      */
     private encodedBranchParam;
+    private shortStableHash;
+    private trimEdges;
+    private branchSlugForMediaPath;
+    /** Joins a directory and filename into a normalized `dir/file` repo path. */
+    private joinMediaPath;
+    private branchQueryParam;
+    private requestMediaBranchChoice;
+    private prepareMediaBranch;
+    private resetWorkflowState;
+    private finalizeMediaWorkflow;
+    private dispatchMediaWorkflowError;
+    private runMediaOpWithWorkflow;
+    private prepareProtectedMediaBranch;
+    private waitForRequestStatus;
     private persist_cloud;
+    /**
+     * Uploads assets through the editorial workflow. The asset is staged, the
+     * server-side workflow catalogues it in the new branch's media index, and
+     * only then do we list it — while the branch override still routes list
+     * calls to the workflow branch, so the freshly uploaded item is returned to
+     * the caller (and added to the media manager) without needing a manual
+     * refresh.
+     */
+    private persistCloudViaWorkflow;
+    private uploadCloudMediaItem;
+    private groupMediaByDirectory;
     /**
      * Resolves the just-uploaded items to canonical `Media` entries by hitting
      * the assets-api `list` endpoint, which is the source of truth for the

package/dist/toolkit/fields/plugins/mdx-field-plugin/plate/components/plate-ui/command.d.ts

@@ -6,7 +6,7 @@ export declare const Command: React.ForwardRefExoticComponent<Omit<Omit<{
     ref?: React.Ref<HTMLDivElement>;
 } & {
     asChild?: boolean;
-}, "key" | keyof React.HTMLAttributes<HTMLDivElement> | "asChild"> & {
+}, "key" | "asChild" | keyof React.HTMLAttributes<HTMLDivElement>> & {
     label?: string;
     shouldFilter?: boolean;
     filter?: (value: string, search: string, keywords?: string[]) => number;
@@ -22,7 +22,7 @@ export declare const Command: React.ForwardRefExoticComponent<Omit<Omit<{
     ref?: React.Ref<HTMLDivElement>;
 } & {
     asChild?: boolean;
-}, "key" | keyof React.HTMLAttributes<HTMLDivElement> | "asChild"> & {
+}, "key" | "asChild" | keyof React.HTMLAttributes<HTMLDivElement>> & {
     label?: string;
     shouldFilter?: boolean;
     filter?: (value: string, search: string, keywords?: string[]) => number;
@@ -58,7 +58,7 @@ export declare const InputCommand: React.ForwardRefExoticComponent<Omit<Omit<Omi
 }, "key" | keyof React.InputHTMLAttributes<HTMLInputElement> | "asChild">, "value" | "type" | "onChange"> & {
     value?: string;
     onValueChange?: (search: string) => void;
-} & React.RefAttributes<HTMLInputElement>, "h" | "variant"> & import("class-variance-authority").VariantProps<(props?: {
+} & React.RefAttributes<HTMLInputElement>, "variant" | "h"> & import("class-variance-authority").VariantProps<(props?: {
     h?: "sm" | "md";
     variant?: "default" | "ghost";
 } & import("class-variance-authority/types").ClassProp) => string>, "ref"> & React.RefAttributes<HTMLInputElement>>;
@@ -68,7 +68,7 @@ export declare const CommandList: React.ForwardRefExoticComponent<Omit<{
     ref?: React.Ref<HTMLDivElement>;
 } & {
     asChild?: boolean;
-}, "key" | keyof React.HTMLAttributes<HTMLDivElement> | "asChild"> & {
+}, "key" | "asChild" | keyof React.HTMLAttributes<HTMLDivElement>> & {
     label?: string;
 } & React.RefAttributes<HTMLDivElement>, "ref"> & React.RefAttributes<HTMLDivElement>>;
 export declare const CommandEmpty: React.ForwardRefExoticComponent<Omit<{
@@ -77,14 +77,14 @@ export declare const CommandEmpty: React.ForwardRefExoticComponent<Omit<{
     ref?: React.Ref<HTMLDivElement>;
 } & {
     asChild?: boolean;
-}, "key" | keyof React.HTMLAttributes<HTMLDivElement> | "asChild"> & React.RefAttributes<HTMLDivElement>, "ref"> & React.RefAttributes<HTMLDivElement>>;
+}, "key" | "asChild" | keyof React.HTMLAttributes<HTMLDivElement>> & React.RefAttributes<HTMLDivElement>, "ref"> & React.RefAttributes<HTMLDivElement>>;
 export declare const CommandGroup: React.ForwardRefExoticComponent<Omit<{
     children?: React.ReactNode;
 } & Omit<Pick<Pick<React.DetailedHTMLProps<React.HTMLAttributes<HTMLDivElement>, HTMLDivElement>, "key" | keyof React.HTMLAttributes<HTMLDivElement>> & {
     ref?: React.Ref<HTMLDivElement>;
 } & {
     asChild?: boolean;
-}, "key" | keyof React.HTMLAttributes<HTMLDivElement> | "asChild">, "value" | "heading"> & {
+}, "key" | "asChild" | keyof React.HTMLAttributes<HTMLDivElement>>, "value" | "heading"> & {
     heading?: React.ReactNode;
     value?: string;
     forceMount?: boolean;
@@ -93,7 +93,7 @@ export declare const CommandSeparator: React.ForwardRefExoticComponent<Omit<Pick
     ref?: React.Ref<HTMLDivElement>;
 } & {
     asChild?: boolean;
-}, "key" | keyof React.HTMLAttributes<HTMLDivElement> | "asChild"> & {
+}, "key" | "asChild" | keyof React.HTMLAttributes<HTMLDivElement>> & {
     alwaysRender?: boolean;
 } & React.RefAttributes<HTMLDivElement>, "ref"> & React.RefAttributes<HTMLDivElement>>;
 export declare const CommandItem: React.ForwardRefExoticComponent<Omit<{
@@ -102,7 +102,7 @@ export declare const CommandItem: React.ForwardRefExoticComponent<Omit<{
     ref?: React.Ref<HTMLDivElement>;
 } & {
     asChild?: boolean;
-}, "key" | keyof React.HTMLAttributes<HTMLDivElement> | "asChild">, "value" | "disabled" | "onSelect"> & {
+}, "key" | "asChild" | keyof React.HTMLAttributes<HTMLDivElement>>, "value" | "disabled" | "onSelect"> & {
     disabled?: boolean;
     onSelect?: (value: string) => void;
     value?: string;

package/dist/toolkit/fields/plugins/mdx-field-plugin/plate/components/plate-ui/input.d.ts

@@ -2,7 +2,7 @@ export declare const inputVariants: (props?: {
     h?: "sm" | "md";
     variant?: "default" | "ghost";
 } & import("class-variance-authority/types").ClassProp) => string;
-export declare const Input: import("react").ForwardRefExoticComponent<Omit<Omit<import("react").DetailedHTMLProps<import("react").InputHTMLAttributes<HTMLInputElement>, HTMLInputElement>, "ref"> & Omit<import("react").DetailedHTMLProps<import("react").InputHTMLAttributes<HTMLInputElement>, HTMLInputElement>, "h" | "variant"> & import("class-variance-authority").VariantProps<(props?: {
+export declare const Input: import("react").ForwardRefExoticComponent<Omit<Omit<import("react").DetailedHTMLProps<import("react").InputHTMLAttributes<HTMLInputElement>, HTMLInputElement>, "ref"> & Omit<import("react").DetailedHTMLProps<import("react").InputHTMLAttributes<HTMLInputElement>, HTMLInputElement>, "variant" | "h"> & import("class-variance-authority").VariantProps<(props?: {
     h?: "sm" | "md";
     variant?: "default" | "ghost";
 } & import("class-variance-authority/types").ClassProp) => string>, "ref"> & import("react").RefAttributes<HTMLInputElement>>;

package/dist/toolkit/form-builder/create-branch-modal.d.ts

@@ -9,6 +9,15 @@ export declare const CreateBranchModal: ({ close, safeSubmit, path, values, crud
     tinaForm?: Form;
     onBaseBranchDeleted?: () => void;
 }) => React.JSX.Element;
+export declare const CreateBranchPromptModal: ({ branchName, close, disabled, errorMessage, onBranchNameChange, onCreateBranch, onSaveToProtectedBranch, }: {
+    branchName: string;
+    close: () => void;
+    disabled?: boolean;
+    errorMessage?: string;
+    onBranchNameChange: (value: string) => void;
+    onCreateBranch: () => void;
+    onSaveToProtectedBranch: () => void;
+}) => React.JSX.Element;
 export declare const PrefixedTextField: ({ label, prefix, ...props }: {
     [x: string]: any;
     label?: any;

package/dist/toolkit/form-builder/editorial-workflow-progress-modal.d.ts

@@ -0,0 +1,15 @@
+import * as React from 'react';
+interface EditorialWorkflowProgressModalProps {
+    title: string;
+    currentStep: number;
+    elapsedTime: number;
+}
+/**
+ * Shared modal shell for any "we're creating a branch + PR right now"
+ * state. Both the content-save flow (`CreateBranchModal`) and the
+ * media-store flow (`MediaWorkflowOverlay`) render this while the
+ * workflow is in flight so the editor sees the same indicator regardless
+ * of what triggered it.
+ */
+export declare const EditorialWorkflowProgressModal: ({ title, currentStep, elapsedTime, }: EditorialWorkflowProgressModalProps) => React.JSX.Element;
+export {};

package/dist/toolkit/form-builder/editorial-workflow-utils.d.ts

@@ -0,0 +1,20 @@
+export interface MediaWorkflowConfirmBranchEvent {
+    type: 'media:workflow:confirm-branch';
+    branchName: string;
+    baseBranch: string;
+    onConfirm: (branchName: string) => Promise<void>;
+    onCancel: () => void;
+    onSaveToProtectedBranch: () => void;
+}
+export declare const getEditorialWorkflowPrTitle: (branchName: string) => string;
+export declare const TARGET_BRANCH_EXISTS_ERROR = "A branch with this name already exists";
+export declare const checkBaseBranchExists: (tinaApi: {
+    branchExists: (branchName: string, args?: {
+        signal?: AbortSignal;
+    }) => Promise<boolean>;
+}, baseBranch: string, debugLabel: string, signal?: AbortSignal) => Promise<boolean>;
+export declare const checkTargetBranchExists: (tinaApi: {
+    branchExists: (branchName: string, args?: {
+        signal?: AbortSignal;
+    }) => Promise<boolean>;
+}, targetBranch: string, debugLabel: string, signal?: AbortSignal) => Promise<boolean>;

package/dist/toolkit/form-builder/use-editorial-workflow.d.ts

@@ -12,6 +12,7 @@ export interface ExecuteWorkflowOptions {
     values: Record<string, unknown>;
     crudType: string;
     tinaForm?: Form;
+    signal?: AbortSignal;
 }
 export interface UseEditorialWorkflowResult {
     isExecuting: boolean;
@@ -23,4 +24,5 @@ export interface UseEditorialWorkflowResult {
     /** Reset error/executing state so the form can be retried */
     reset: () => void;
 }
+export declare const getEditorialWorkflowErrorMessage: (e: unknown) => string;
 export declare function useEditorialWorkflow(): UseEditorialWorkflowResult;

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

@@ -5,12 +5,6 @@
 export declare class GitClient {
     private baseUrl;
     constructor(baseUrl: string);
-    /**
-     * An alias to `commit`
-     *
-     * @deprecated
-     */
-    onSubmit(data: any): Promise<any>;
     /**
      * An alias to `writeToDisk`
      *

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

@@ -18,7 +18,7 @@ export declare class GitFile {
     /**
      * @deprecated
      */
-    commit: () => Promise<void>;
+    commit: () => Promise<boolean>;
     /**
      * @deprecated
      */

package/dist/toolkit/index.d.ts

@@ -38,3 +38,4 @@ export type { TinaUIProps } from './components/tina-ui';
 export { useLocalStorage } from './hooks/use-local-storage';
 export { CursorPaginator } from './components/media/pagination';
 export { DEFAULT_MEDIA_UPLOAD_TYPES, sanitizeFilename, } from './components/media';
+export { MediaWorkflowOverlay } from './components/media/media-workflow-overlay';

package/dist/toolkit/plugin-branch-switcher/branch-switcher.d.ts

@@ -1,7 +1,8 @@
 import * as React from 'react';
 import { Branch, BranchSwitcherProps } from './types';
 export declare const tableHeadingStyle = "px-3 py-3 text-left text-xs font-bold text-gray-700 tracking-wider sticky top-0 bg-gray-100 z-20 border-b-2 border-gray-200 ";
-export declare function formatBranchName(str: string): string;
+import { formatBranchName } from './format-branch-name';
+export { formatBranchName };
 export declare const BranchSwitcher: (props: BranchSwitcherProps) => React.JSX.Element;
 export declare const EditoralBranchSwitcher: ({ listBranches, createBranch, chooseBranch, setModalTitle, }: BranchSwitcherProps) => React.JSX.Element;
 export declare const getFilteredBranchList: (branchList: Branch[], search: string, currentBranchName: string, filter?: "content" | "all") => Branch[];

package/dist/toolkit/plugin-branch-switcher/format-branch-name.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Normalizes user-supplied strings into git-ref-safe branch segments.
+ * Kept in its own file (no React or workspace-internal imports) so
+ * non-React callers like `core/media-store.default.ts` can import it
+ * without dragging in the rest of `plugin-branch-switcher` and creating
+ * a cycle through `@toolkit/core`.
+ */
+export declare function formatBranchName(str: string): string;

package/dist/toolkit/react-core/use-cms-event.d.ts

@@ -3,6 +3,6 @@ import { Callback, CMSEvent } from '../core';
 export declare function useCMSEvent<E extends CMSEvent = CMSEvent>(event: E['type'] | E['type'][], callback: Callback<E>, deps: React.DependencyList): void;
 export declare const useEventSubscription: typeof useCMSEvent;
 export declare function useEvent<E extends CMSEvent = CMSEvent>(eventType: E['type']): {
-    dispatch: (event: Omit<E, "type">) => void;
+    dispatch: (event: Omit<E, "type">) => boolean;
     subscribe: (callback: (event: E) => any) => () => void;
 };

package/package.json

@@ -2,7 +2,7 @@
   "name": "tinacms",
   "type": "module",
   "typings": "dist/index.d.ts",
-  "version": "3.8.4",
+  "version": "3.9.0",
   "main": "dist/index.js",
   "module": "./dist/index.js",
   "exports": {
@@ -117,9 +117,9 @@
     "webfontloader": "1.6.28",
     "yup": "^1.6.1",
     "zod": "^3.24.2",
+    "@tinacms/schema-tools": "2.8.1",
     "@tinacms/bridge": "0.3.0",
     "@tinacms/mdx": "2.1.6",
-    "@tinacms/schema-tools": "2.8.1",
     "@tinacms/search": "1.2.17"
   },
   "devDependencies": {