@ttt-productions/upload-ui 0.7.9 → 0.7.10

package/dist/react/use-clear-upload-activity.d.ts

@@ -1,8 +1,33 @@
+/**
+ * Generic mutation hook to clear a terminal pendingMedia item from the tray.
+ *
+ * Pure adapter: the consumer supplies `clearFn` (typically a wrapped Firebase
+ * callable in the consuming app, or a fetch call elsewhere). The package owns the
+ * useMutation wiring and the optional `onError` toast hook; the consumer owns
+ * the network call.
+ *
+ * The provider's Firestore listener observes the `uploadTrayClearedAt` write
+ * and removes the item from the tray selector automatically — no optimistic
+ * update is needed in this hook.
+ *
+ * The returned object is the standard `useMutation` result (`mutate`,
+ * `mutateAsync`, `isPending`, …). Pass `mutationKey` to register the clear in
+ * React Query's shared `MutationCache` under a stable key, so a consumer can
+ * read per-item pending with `useMutationState` (the pendingMediaId is the
+ * mutation variables) — pending that survives the clearing row unmounting.
+ */
+import { type MutationKey } from '@tanstack/react-query';
 export interface ClearUploadActivityOptions {
     /** Network call performing the clear. Receives the pendingMediaId. */
     clearFn: (pendingMediaId: string) => Promise<void>;
     /** Optional error callback. Receives the error and the pendingMediaId that failed. */
     onError?: (error: Error, pendingMediaId: string) => void;
+    /**
+     * Optional stable key for the underlying mutation, registering it in the
+     * shared `MutationCache` so pending can be read with `useMutationState`.
+     * Omitted ⇒ an unkeyed mutation (the prior behavior).
+     */
+    mutationKey?: MutationKey;
 }
 export declare function useClearUploadActivity(options: ClearUploadActivityOptions): import("@tanstack/react-query").UseMutationResult<void, Error, string, unknown>;
 //# sourceMappingURL=use-clear-upload-activity.d.ts.map

package/dist/react/use-clear-upload-activity.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"use-clear-upload-activity.d.ts","sourceRoot":"","sources":["../../src/react/use-clear-upload-activity.ts"],"names":[],"mappings":"AAiBA,MAAM,WAAW,0BAA0B;IACzC,sEAAsE;IACtE,OAAO,EAAE,CAAC,cAAc,EAAE,MAAM,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IACnD,sFAAsF;IACtF,OAAO,CAAC,EAAE,CAAC,KAAK,EAAE,KAAK,EAAE,cAAc,EAAE,MAAM,KAAK,IAAI,CAAC;CAC1D;AAED,wBAAgB,sBAAsB,CAAC,OAAO,EAAE,0BAA0B,mFAQzE"}
+{"version":3,"file":"use-clear-upload-activity.d.ts","sourceRoot":"","sources":["../../src/react/use-clear-upload-activity.ts"],"names":[],"mappings":"AAEA;;;;;;;;;;;;;;;;;GAiBG;AAEH,OAAO,EAAe,KAAK,WAAW,EAAE,MAAM,uBAAuB,CAAC;AAEtE,MAAM,WAAW,0BAA0B;IACzC,sEAAsE;IACtE,OAAO,EAAE,CAAC,cAAc,EAAE,MAAM,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IACnD,sFAAsF;IACtF,OAAO,CAAC,EAAE,CAAC,KAAK,EAAE,KAAK,EAAE,cAAc,EAAE,MAAM,KAAK,IAAI,CAAC;IACzD;;;;OAIG;IACH,WAAW,CAAC,EAAE,WAAW,CAAC;CAC3B;AAED,wBAAgB,sBAAsB,CAAC,OAAO,EAAE,0BAA0B,mFASzE"}

package/dist/react/use-clear-upload-activity.js

@@ -10,11 +10,18 @@
  * The provider's Firestore listener observes the `uploadTrayClearedAt` write
  * and removes the item from the tray selector automatically — no optimistic
  * update is needed in this hook.
+ *
+ * The returned object is the standard `useMutation` result (`mutate`,
+ * `mutateAsync`, `isPending`, …). Pass `mutationKey` to register the clear in
+ * React Query's shared `MutationCache` under a stable key, so a consumer can
+ * read per-item pending with `useMutationState` (the pendingMediaId is the
+ * mutation variables) — pending that survives the clearing row unmounting.
  */
 import { useMutation } from '@tanstack/react-query';
 export function useClearUploadActivity(options) {
-    const { clearFn, onError } = options;
+    const { clearFn, onError, mutationKey } = options;
     return useMutation({
+        mutationKey,
         mutationFn: clearFn,
         onError: (error, pendingMediaId) => {
             onError?.(error, pendingMediaId);

package/dist/react/use-clear-upload-activity.js.map

@@ -1 +1 @@
-{"version":3,"file":"use-clear-upload-activity.js","sourceRoot":"","sources":["../../src/react/use-clear-upload-activity.ts"],"names":[],"mappings":"AAAA,YAAY,CAAC;AAEb;;;;;;;;;;;GAWG;AAEH,OAAO,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAC;AASpD,MAAM,UAAU,sBAAsB,CAAC,OAAmC;IACxE,MAAM,EAAE,OAAO,EAAE,OAAO,EAAE,GAAG,OAAO,CAAC;IACrC,OAAO,WAAW,CAAsB;QACtC,UAAU,EAAE,OAAO;QACnB,OAAO,EAAE,CAAC,KAAK,EAAE,cAAc,EAAE,EAAE;YACjC,OAAO,EAAE,CAAC,KAAK,EAAE,cAAc,CAAC,CAAC;QACnC,CAAC;KACF,CAAC,CAAC;AACL,CAAC","sourcesContent":["'use client';\n\n/**\n * Generic mutation hook to clear a terminal pendingMedia item from the tray.\n *\n * Pure adapter: the consumer supplies `clearFn` (typically a wrapped Firebase\n * callable in the consuming app, or a fetch call elsewhere). The package owns the\n * useMutation wiring and the optional `onError` toast hook; the consumer owns\n * the network call.\n *\n * The provider's Firestore listener observes the `uploadTrayClearedAt` write\n * and removes the item from the tray selector automatically — no optimistic\n * update is needed in this hook.\n */\n\nimport { useMutation } from '@tanstack/react-query';\n\nexport interface ClearUploadActivityOptions {\n  /** Network call performing the clear. Receives the pendingMediaId. */\n  clearFn: (pendingMediaId: string) => Promise<void>;\n  /** Optional error callback. Receives the error and the pendingMediaId that failed. */\n  onError?: (error: Error, pendingMediaId: string) => void;\n}\n\nexport function useClearUploadActivity(options: ClearUploadActivityOptions) {\n  const { clearFn, onError } = options;\n  return useMutation<void, Error, string>({\n    mutationFn: clearFn,\n    onError: (error, pendingMediaId) => {\n      onError?.(error, pendingMediaId);\n    },\n  });\n}\n"]}
+{"version":3,"file":"use-clear-upload-activity.js","sourceRoot":"","sources":["../../src/react/use-clear-upload-activity.ts"],"names":[],"mappings":"AAAA,YAAY,CAAC;AAEb;;;;;;;;;;;;;;;;;GAiBG;AAEH,OAAO,EAAE,WAAW,EAAoB,MAAM,uBAAuB,CAAC;AAetE,MAAM,UAAU,sBAAsB,CAAC,OAAmC;IACxE,MAAM,EAAE,OAAO,EAAE,OAAO,EAAE,WAAW,EAAE,GAAG,OAAO,CAAC;IAClD,OAAO,WAAW,CAAsB;QACtC,WAAW;QACX,UAAU,EAAE,OAAO;QACnB,OAAO,EAAE,CAAC,KAAK,EAAE,cAAc,EAAE,EAAE;YACjC,OAAO,EAAE,CAAC,KAAK,EAAE,cAAc,CAAC,CAAC;QACnC,CAAC;KACF,CAAC,CAAC;AACL,CAAC","sourcesContent":["'use client';\n\n/**\n * Generic mutation hook to clear a terminal pendingMedia item from the tray.\n *\n * Pure adapter: the consumer supplies `clearFn` (typically a wrapped Firebase\n * callable in the consuming app, or a fetch call elsewhere). The package owns the\n * useMutation wiring and the optional `onError` toast hook; the consumer owns\n * the network call.\n *\n * The provider's Firestore listener observes the `uploadTrayClearedAt` write\n * and removes the item from the tray selector automatically — no optimistic\n * update is needed in this hook.\n *\n * The returned object is the standard `useMutation` result (`mutate`,\n * `mutateAsync`, `isPending`, …). Pass `mutationKey` to register the clear in\n * React Query's shared `MutationCache` under a stable key, so a consumer can\n * read per-item pending with `useMutationState` (the pendingMediaId is the\n * mutation variables) — pending that survives the clearing row unmounting.\n */\n\nimport { useMutation, type MutationKey } from '@tanstack/react-query';\n\nexport interface ClearUploadActivityOptions {\n  /** Network call performing the clear. Receives the pendingMediaId. */\n  clearFn: (pendingMediaId: string) => Promise<void>;\n  /** Optional error callback. Receives the error and the pendingMediaId that failed. */\n  onError?: (error: Error, pendingMediaId: string) => void;\n  /**\n   * Optional stable key for the underlying mutation, registering it in the\n   * shared `MutationCache` so pending can be read with `useMutationState`.\n   * Omitted ⇒ an unkeyed mutation (the prior behavior).\n   */\n  mutationKey?: MutationKey;\n}\n\nexport function useClearUploadActivity(options: ClearUploadActivityOptions) {\n  const { clearFn, onError, mutationKey } = options;\n  return useMutation<void, Error, string>({\n    mutationKey,\n    mutationFn: clearFn,\n    onError: (error, pendingMediaId) => {\n      onError?.(error, pendingMediaId);\n    },\n  });\n}\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ttt-productions/upload-ui",
-  "version": "0.7.9",
+  "version": "0.7.10",
   "description": "Upload UI primitives: local upload guard provider, useGuardedUpload helper, DeferredUploadFormShell for forms that defer Firebase Storage upload until form submit.",
   "repository": {
     "type": "git",