@cedarjs/uploads 8.0.0-canary.3418 → 8.0.0-canary.3421

package/README.md

@@ -14,6 +14,12 @@ File uploads and storage for CedarJS apps.
   uploads, and confirming them.
 - **Lifecycle utilities** (`storeFile`, `deleteFile`, `cleanupStaleUploads`) for
   server-generated files and explicit cleanup.
+- **Derived files (variants)**, experimental: thumbnails, previews, a video's
+  poster frame. `defineUploadVariants()` takes one generator function per
+  variant name and keeps the bookkeeping: variants are `Upload` rows linked
+  to their source, made once on first read even under concurrency, failures
+  remembered with a retry-after, `regenerateVariants()` to remake one name,
+  and deletion with the source.
 - **Content detection** (`detectContentType`, `acceptedContentType`) that
   checks what an uploaded file really is from its bytes, not from its name or
   the type the browser claimed: images, PDF, audio/video, and OpenDocument and

package/dist/cleanupStaleUploads.d.ts

@@ -3,9 +3,10 @@ export interface CleanupStaleUploadsOptions {
     db: UploadDatabase;
     targets: StorageTargets;
     /**
-     * Rows still `pending` after this many milliseconds are claimed as
-     * `failed`. Defaults to one hour, well past the five-minute validity of a
-     * presigned upload URL.
+     * Rows that have been `pending` and unchanged for this many milliseconds
+     * are claimed as `failed`. Measured from the row's last update, so a
+     * variant whose retry claimed an old row gets the full time. Defaults to
+     * one hour, well past the five-minute validity of a presigned upload URL.
      */
     olderThan?: number;
     /**

package/dist/cleanupStaleUploads.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"cleanupStaleUploads.d.ts","sourceRoot":"","sources":["../src/cleanupStaleUploads.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,cAAc,EAAE,cAAc,EAAE,YAAY,EAAE,MAAM,YAAY,CAAA;AAK9E,MAAM,WAAW,0BAA0B;IACzC,EAAE,EAAE,cAAc,CAAA;IAClB,OAAO,EAAE,cAAc,CAAA;IACvB;;;;OAIG;IACH,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB;;;;;;OAMG;IACH,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,kEAAkE;IAClE,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB;;;OAGG;IACH,OAAO,CAAC,EAAE,CAAC,KAAK,EAAE,OAAO,EAAE,MAAM,EAAE,YAAY,KAAK,IAAI,CAAA;CACzD;AAED,MAAM,WAAW,yBAAyB;IACxC,yDAAyD;IACzD,OAAO,EAAE,MAAM,CAAA;IACf,gDAAgD;IAChD,OAAO,EAAE,MAAM,CAAA;IACf,wEAAwE;IACxE,MAAM,EAAE,MAAM,CAAA;CACf;AAED;;;;;;;;;;;;;GAaG;AACH,wBAAsB,mBAAmB,CAAC,EACxC,EAAE,EACF,OAAO,EACP,SAAoB,EACpB,WAAqB,EACrB,SAAe,EACf,OAC0E,GAC3E,EAAE,0BAA0B,GAAG,OAAO,CAAC,yBAAyB,CAAC,CAmFjE"}
+{"version":3,"file":"cleanupStaleUploads.d.ts","sourceRoot":"","sources":["../src/cleanupStaleUploads.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,cAAc,EAAE,cAAc,EAAE,YAAY,EAAE,MAAM,YAAY,CAAA;AAK9E,MAAM,WAAW,0BAA0B;IACzC,EAAE,EAAE,cAAc,CAAA;IAClB,OAAO,EAAE,cAAc,CAAA;IACvB;;;;;OAKG;IACH,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB;;;;;;OAMG;IACH,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,kEAAkE;IAClE,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB;;;OAGG;IACH,OAAO,CAAC,EAAE,CAAC,KAAK,EAAE,OAAO,EAAE,MAAM,EAAE,YAAY,KAAK,IAAI,CAAA;CACzD;AAED,MAAM,WAAW,yBAAyB;IACxC,yDAAyD;IACzD,OAAO,EAAE,MAAM,CAAA;IACf,gDAAgD;IAChD,OAAO,EAAE,MAAM,CAAA;IACf,wEAAwE;IACxE,MAAM,EAAE,MAAM,CAAA;CACf;AAED;;;;;;;;;;;;;GAaG;AACH,wBAAsB,mBAAmB,CAAC,EACxC,EAAE,EACF,OAAO,EACP,SAAoB,EACpB,WAAqB,EACrB,SAAe,EACf,OAC0E,GAC3E,EAAE,0BAA0B,GAAG,OAAO,CAAC,yBAAyB,CAAC,CAyFjE"}

package/dist/cleanupStaleUploads.js

@@ -10,6 +10,7 @@ async function cleanupStaleUploads({
   onError = (error, upload) => console.error(`[cedar uploads] cleanup failed for ${upload.id}:`, error)
 }) {
   const now = Date.now();
+  const staleBefore = new Date(now - olderThan);
   let claimed = 0;
   let deleted = 0;
   let errors = 0;
@@ -36,14 +37,19 @@ async function cleanupStaleUploads({
     }
   };
   const stale = await db.upload.findMany({
-    where: { status: "pending", createdAt: { lt: new Date(now - olderThan) } },
+    where: { status: "pending", updatedAt: { lt: staleBefore } },
     omit: { data: true },
     orderBy: { createdAt: "asc" },
     take: batchSize
   });
   for (const upload of stale) {
     const { count } = await db.upload.updateMany({
-      where: { id: upload.id, status: "pending" },
+      // A row claimed again since it was read is not stale any more
+      where: {
+        id: upload.id,
+        status: "pending",
+        updatedAt: { lt: staleBefore }
+      },
       data: { status: "failed" }
     });
     if (count !== 1) {

package/dist/deleteFile.d.ts

@@ -1,14 +1,29 @@
-import type { StorageProvider, UploadDatabase, UploadRecord } from './types.js';
-export interface DeleteFileOptions {
+import type { StorageProvider, StorageTargets, UploadDatabase, UploadRecord, UploadVariantDatabase } from './types.js';
+export type DeleteFileOptions = {
     db: UploadDatabase;
     upload: Pick<UploadRecord, 'id' | 'storageKey'>;
-}
+    targets?: undefined;
+} | {
+    db: UploadDatabase & UploadVariantDatabase;
+    upload: Pick<UploadRecord, 'id' | 'storageKey'>;
+    /**
+     * Every configured storage target. When given, the upload's derived
+     * files (variants: thumbnails, previews) are deleted first, from
+     * whichever targets hold them. Required for an upload that has
+     * variants.
+     */
+    targets: StorageTargets;
+};
 /**
  * Deletes a stored file: bytes first, then the `Upload` row. Bytes-first
  * ordering means a crash between the two steps leaves a row whose object is
  * gone, which the app can see and fix by calling again, whereas the reverse
  * order would leave an unreachable object nothing references. A missing
  * object or row is tolerated, so the call is idempotent.
+ *
+ * Pass `targets` to delete the upload's derived files (variants) with it.
+ * Without it, deleting an upload that has variants throws an `UploadError`
+ * with code `HAS_VARIANTS`, because the variant rows reference their source.
  */
-export declare function deleteFile(target: StorageProvider, { db, upload }: DeleteFileOptions): Promise<void>;
+export declare function deleteFile(target: StorageProvider, options: DeleteFileOptions): Promise<void>;
 //# sourceMappingURL=deleteFile.d.ts.map

package/dist/deleteFile.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"deleteFile.d.ts","sourceRoot":"","sources":["../src/deleteFile.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,eAAe,EAAE,cAAc,EAAE,YAAY,EAAE,MAAM,YAAY,CAAA;AAE/E,MAAM,WAAW,iBAAiB;IAChC,EAAE,EAAE,cAAc,CAAA;IAClB,MAAM,EAAE,IAAI,CAAC,YAAY,EAAE,IAAI,GAAG,YAAY,CAAC,CAAA;CAChD;AAQD;;;;;;GAMG;AACH,wBAAsB,UAAU,CAC9B,MAAM,EAAE,eAAe,EACvB,EAAE,EAAE,EAAE,MAAM,EAAE,EAAE,iBAAiB,GAChC,OAAO,CAAC,IAAI,CAAC,CAYf"}
+{"version":3,"file":"deleteFile.d.ts","sourceRoot":"","sources":["../src/deleteFile.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EACV,eAAe,EACf,cAAc,EACd,cAAc,EACd,YAAY,EACZ,qBAAqB,EACtB,MAAM,YAAY,CAAA;AAGnB,MAAM,MAAM,iBAAiB,GACzB;IACE,EAAE,EAAE,cAAc,CAAA;IAClB,MAAM,EAAE,IAAI,CAAC,YAAY,EAAE,IAAI,GAAG,YAAY,CAAC,CAAA;IAC/C,OAAO,CAAC,EAAE,SAAS,CAAA;CACpB,GACD;IACE,EAAE,EAAE,cAAc,GAAG,qBAAqB,CAAA;IAC1C,MAAM,EAAE,IAAI,CAAC,YAAY,EAAE,IAAI,GAAG,YAAY,CAAC,CAAA;IAC/C;;;;;OAKG;IACH,OAAO,EAAE,cAAc,CAAA;CACxB,CAAA;AA6BL;;;;;;;;;;GAUG;AACH,wBAAsB,UAAU,CAC9B,MAAM,EAAE,eAAe,EACvB,OAAO,EAAE,iBAAiB,GACzB,OAAO,CAAC,IAAI,CAAC,CA+Cf"}

package/dist/deleteFile.js

@@ -1,15 +1,56 @@
-function isRecordNotFound(e) {
-  return typeof e === "object" && e !== null && "code" in e && e.code === "P2025";
+import { UploadError } from "./errors.js";
+import { deleteVariants } from "./variants.js";
+const MAX_VARIANT_ROUNDS = 3;
+function isPrismaError(e, code) {
+  return typeof e === "object" && e !== null && "code" in e && e.code === code;
 }
-async function deleteFile(target, { db, upload }) {
+function hasVariantRows(db, id) {
+  return db.upload.count({ where: { sourceId: id } }).then(
+    (count) => count > 0,
+    () => false
+  );
+}
+function hasVariantsError(id, cause) {
+  return new UploadError(
+    "HAS_VARIANTS",
+    `Upload '${id}' has derived files (variants), so its row cannot be deleted on its own. Pass \`targets\` to deleteFile() to delete the variants with it, or call deleteVariants() first.`,
+    cause
+  );
+}
+async function deleteFile(target, options) {
+  const { upload } = options;
+  if (!options.targets && await hasVariantRows(options.db, upload.id)) {
+    throw hasVariantsError(upload.id);
+  }
   if (upload.storageKey) {
     await target.delete(upload.storageKey);
   }
-  try {
-    await db.upload.delete({ where: { id: upload.id } });
-  } catch (e) {
-    if (!isRecordNotFound(e)) {
-      throw e;
+  for (let round = 1; ; round++) {
+    if (options.targets) {
+      await deleteVariants(upload, {
+        db: options.db,
+        targets: options.targets
+      });
+    }
+    try {
+      await options.db.upload.delete({ where: { id: upload.id } });
+      return;
+    } catch (e) {
+      if (isPrismaError(e, "P2025")) {
+        return;
+      }
+      if (!isPrismaError(e, "P2003")) {
+        throw e;
+      }
+      if (!options.targets) {
+        if (!await hasVariantRows(options.db, upload.id)) {
+          throw e;
+        }
+        throw hasVariantsError(upload.id, e);
+      }
+      if (round >= MAX_VARIANT_ROUNDS) {
+        throw e;
+      }
     }
   }
 }

package/dist/errors.d.ts

@@ -1,4 +1,4 @@
-export type UploadErrorCode = 'CONFIGURATION' | 'UNKNOWN_TARGET' | 'UNKNOWN_PROFILE' | 'UNAUTHENTICATED' | 'INVALID_TOKEN' | 'TOKEN_USER_MISMATCH' | 'TOKEN_ORGANIZATION_MISMATCH' | 'MIME_TYPE_NOT_ALLOWED' | 'FILE_TOO_LARGE' | 'TOO_MANY_FILES' | 'PRESIGN_NOT_SUPPORTED' | 'NOT_SUPPORTED' | 'NOT_FOUND' | 'FORBIDDEN' | 'NOT_PENDING' | 'NOT_IN_STORAGE' | 'SIZE_MISMATCH' | 'INVALID_KEY';
+export type UploadErrorCode = 'CONFIGURATION' | 'UNKNOWN_TARGET' | 'UNKNOWN_PROFILE' | 'UNAUTHENTICATED' | 'INVALID_TOKEN' | 'TOKEN_USER_MISMATCH' | 'TOKEN_ORGANIZATION_MISMATCH' | 'MIME_TYPE_NOT_ALLOWED' | 'FILE_TOO_LARGE' | 'TOO_MANY_FILES' | 'PRESIGN_NOT_SUPPORTED' | 'NOT_SUPPORTED' | 'NOT_FOUND' | 'FORBIDDEN' | 'NOT_PENDING' | 'NOT_IN_STORAGE' | 'SIZE_MISMATCH' | 'INVALID_KEY' | 'HAS_VARIANTS';
 /**
  * Thrown by every part of the uploads package when a request cannot be
  * honored. `code` is stable for programmatic handling and `statusCode` is the

package/dist/errors.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"errors.d.ts","sourceRoot":"","sources":["../src/errors.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,eAAe,GACvB,eAAe,GACf,gBAAgB,GAChB,iBAAiB,GACjB,iBAAiB,GACjB,eAAe,GACf,qBAAqB,GACrB,6BAA6B,GAC7B,uBAAuB,GACvB,gBAAgB,GAChB,gBAAgB,GAChB,uBAAuB,GACvB,eAAe,GACf,WAAW,GACX,WAAW,GACX,aAAa,GACb,gBAAgB,GAChB,eAAe,GACf,aAAa,CAAA;AAuBjB;;;;GAIG;AACH,qBAAa,WAAY,SAAQ,KAAK;IACpC,IAAI,EAAE,eAAe,CAAA;IACrB,UAAU,EAAE,MAAM,CAAA;gBAEN,IAAI,EAAE,eAAe,EAAE,OAAO,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,OAAO;CAMpE"}
+{"version":3,"file":"errors.d.ts","sourceRoot":"","sources":["../src/errors.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,eAAe,GACvB,eAAe,GACf,gBAAgB,GAChB,iBAAiB,GACjB,iBAAiB,GACjB,eAAe,GACf,qBAAqB,GACrB,6BAA6B,GAC7B,uBAAuB,GACvB,gBAAgB,GAChB,gBAAgB,GAChB,uBAAuB,GACvB,eAAe,GACf,WAAW,GACX,WAAW,GACX,aAAa,GACb,gBAAgB,GAChB,eAAe,GACf,aAAa,GACb,cAAc,CAAA;AAwBlB;;;;GAIG;AACH,qBAAa,WAAY,SAAQ,KAAK;IACpC,IAAI,EAAE,eAAe,CAAA;IACrB,UAAU,EAAE,MAAM,CAAA;gBAEN,IAAI,EAAE,eAAe,EAAE,OAAO,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,OAAO;CAMpE"}

package/dist/errors.js

@@ -16,7 +16,8 @@ const STATUS_CODES = {
   NOT_PENDING: 409,
   NOT_IN_STORAGE: 409,
   SIZE_MISMATCH: 409,
-  INVALID_KEY: 400
+  INVALID_KEY: 400,
+  HAS_VARIANTS: 409
 };
 class UploadError extends Error {
   code;

package/dist/index.d.ts

@@ -15,6 +15,8 @@ export { storeFile } from './storeFile.js';
 export type { StoreFileOptions } from './storeFile.js';
 export { deleteFile } from './deleteFile.js';
 export type { DeleteFileOptions } from './deleteFile.js';
+export { defineUploadVariants, deleteVariants } from './variants.js';
+export type { DefineUploadVariantsOptions, RegenerateVariantsResult, UploadVariantContext, UploadVariantDefinition, UploadVariantFile, UploadVariantGenerator, UploadVariants, UploadVariantSource, } from './variants.js';
 export { cleanupStaleUploads } from './cleanupStaleUploads.js';
 export type { CleanupStaleUploadsOptions, CleanupStaleUploadsResult, } from './cleanupStaleUploads.js';
 export { createUploadToken, UPLOAD_TOKEN_HEADER, UPLOAD_TOKEN_PURPOSE, verifyUploadToken, } from './uploadToken.js';

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,YAAY,CAAA;AAC1B,OAAO,EAAE,WAAW,EAAE,MAAM,aAAa,CAAA;AACzC,YAAY,EAAE,eAAe,EAAE,MAAM,aAAa,CAAA;AAClD,OAAO,EAAE,oBAAoB,EAAE,aAAa,EAAE,MAAM,cAAc,CAAA;AAClE,OAAO,EACL,gBAAgB,EAChB,+BAA+B,EAC/B,oBAAoB,EACpB,iBAAiB,EACjB,cAAc,GACf,MAAM,eAAe,CAAA;AACtB,YAAY,EACV,qBAAqB,EACrB,aAAa,EACb,cAAc,GACf,MAAM,eAAe,CAAA;AACtB,OAAO,EACL,mBAAmB,EACnB,yBAAyB,EACzB,8BAA8B,EAC9B,wBAAwB,EACxB,iBAAiB,EACjB,uBAAuB,EACvB,2BAA2B,EAC3B,uBAAuB,GACxB,MAAM,wBAAwB,CAAA;AAC/B,YAAY,EAAE,wBAAwB,EAAE,MAAM,wBAAwB,CAAA;AACtE,OAAO,EACL,oBAAoB,EACpB,oBAAoB,EACpB,yBAAyB,EACzB,uBAAuB,EACvB,mBAAmB,EACnB,wBAAwB,GACzB,MAAM,mBAAmB,CAAA;AAC1B,OAAO,EAAE,gBAAgB,EAAE,MAAM,mBAAmB,CAAA;AACpD,YAAY,EAAE,iBAAiB,EAAE,MAAM,mBAAmB,CAAA;AAC1D,OAAO,EAAE,gBAAgB,EAAE,MAAM,mBAAmB,CAAA;AACpD,OAAO,EAAE,kBAAkB,EAAE,MAAM,WAAW,CAAA;AAC9C,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAA;AAC1C,YAAY,EAAE,gBAAgB,EAAE,MAAM,gBAAgB,CAAA;AACtD,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAA;AAC5C,YAAY,EAAE,iBAAiB,EAAE,MAAM,iBAAiB,CAAA;AACxD,OAAO,EAAE,mBAAmB,EAAE,MAAM,0BAA0B,CAAA;AAC9D,YAAY,EACV,0BAA0B,EAC1B,yBAAyB,GAC1B,MAAM,0BAA0B,CAAA;AACjC,OAAO,EACL,iBAAiB,EACjB,mBAAmB,EACnB,oBAAoB,EACpB,iBAAiB,GAClB,MAAM,kBAAkB,CAAA;AACzB,YAAY,EACV,wBAAwB,EACxB,kBAAkB,GACnB,MAAM,kBAAkB,CAAA;AACzB,OAAO,EACL,gBAAgB,EAChB,mBAAmB,EACnB,gBAAgB,GACjB,MAAM,iBAAiB,CAAA;AACxB,YAAY,EAAE,iBAAiB,EAAE,MAAM,iBAAiB,CAAA;AACxD,OAAO,EAAE,eAAe,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAA;AAC3D,OAAO,EACL,aAAa,EACb,qBAAqB,EACrB,gBAAgB,GACjB,MAAM,eAAe,CAAA;AACtB,YAAY,EACV,oBAAoB,EACpB,0BAA0B,EAC1B,4BAA4B,EAC5B,uBAAuB,EACvB,uBAAuB,EACvB,WAAW,EACX,mBAAmB,GACpB,MAAM,eAAe,CAAA;AACtB,OAAO,EACL,iCAAiC,EACjC,0BAA0B,EAC1B,4BAA4B,EAC5B,qBAAqB,EACrB,wBAAwB,EACxB,wBAAwB,EACxB,iBAAiB,EACjB,mBAAmB,GACpB,MAAM,iBAAiB,CAAA;AACxB,YAAY,EACV,kCAAkC,EAClC,yBAAyB,EACzB,6BAA6B,GAC9B,MAAM,iBAAiB,CAAA;AACxB,OAAO,EAAE,yBAAyB,EAAE,MAAM,oBAAoB,CAAA;AAC9D,YAAY,EACV,gCAAgC,EAChC,mBAAmB,EACnB,iBAAiB,GAClB,MAAM,oBAAoB,CAAA;AAC3B,OAAO,EAAE,kBAAkB,EAAE,MAAM,qBAAqB,CAAA;AACxD,YAAY,EAAE,mBAAmB,EAAE,MAAM,qBAAqB,CAAA;AAC9D,OAAO,EAAE,eAAe,EAAE,oBAAoB,EAAE,MAAM,kBAAkB,CAAA;AACxE,YAAY,EACV,2BAA2B,EAC3B,OAAO,EACP,cAAc,EACd,aAAa,EACb,gBAAgB,EAChB,eAAe,GAChB,MAAM,kBAAkB,CAAA;AACzB,OAAO,EAAE,gBAAgB,EAAE,MAAM,mBAAmB,CAAA;AACpD,YAAY,EAAE,UAAU,EAAE,MAAM,mBAAmB,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,YAAY,CAAA;AAC1B,OAAO,EAAE,WAAW,EAAE,MAAM,aAAa,CAAA;AACzC,YAAY,EAAE,eAAe,EAAE,MAAM,aAAa,CAAA;AAClD,OAAO,EAAE,oBAAoB,EAAE,aAAa,EAAE,MAAM,cAAc,CAAA;AAClE,OAAO,EACL,gBAAgB,EAChB,+BAA+B,EAC/B,oBAAoB,EACpB,iBAAiB,EACjB,cAAc,GACf,MAAM,eAAe,CAAA;AACtB,YAAY,EACV,qBAAqB,EACrB,aAAa,EACb,cAAc,GACf,MAAM,eAAe,CAAA;AACtB,OAAO,EACL,mBAAmB,EACnB,yBAAyB,EACzB,8BAA8B,EAC9B,wBAAwB,EACxB,iBAAiB,EACjB,uBAAuB,EACvB,2BAA2B,EAC3B,uBAAuB,GACxB,MAAM,wBAAwB,CAAA;AAC/B,YAAY,EAAE,wBAAwB,EAAE,MAAM,wBAAwB,CAAA;AACtE,OAAO,EACL,oBAAoB,EACpB,oBAAoB,EACpB,yBAAyB,EACzB,uBAAuB,EACvB,mBAAmB,EACnB,wBAAwB,GACzB,MAAM,mBAAmB,CAAA;AAC1B,OAAO,EAAE,gBAAgB,EAAE,MAAM,mBAAmB,CAAA;AACpD,YAAY,EAAE,iBAAiB,EAAE,MAAM,mBAAmB,CAAA;AAC1D,OAAO,EAAE,gBAAgB,EAAE,MAAM,mBAAmB,CAAA;AACpD,OAAO,EAAE,kBAAkB,EAAE,MAAM,WAAW,CAAA;AAC9C,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAA;AAC1C,YAAY,EAAE,gBAAgB,EAAE,MAAM,gBAAgB,CAAA;AACtD,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAA;AAC5C,YAAY,EAAE,iBAAiB,EAAE,MAAM,iBAAiB,CAAA;AACxD,OAAO,EAAE,oBAAoB,EAAE,cAAc,EAAE,MAAM,eAAe,CAAA;AACpE,YAAY,EACV,2BAA2B,EAC3B,wBAAwB,EACxB,oBAAoB,EACpB,uBAAuB,EACvB,iBAAiB,EACjB,sBAAsB,EACtB,cAAc,EACd,mBAAmB,GACpB,MAAM,eAAe,CAAA;AACtB,OAAO,EAAE,mBAAmB,EAAE,MAAM,0BAA0B,CAAA;AAC9D,YAAY,EACV,0BAA0B,EAC1B,yBAAyB,GAC1B,MAAM,0BAA0B,CAAA;AACjC,OAAO,EACL,iBAAiB,EACjB,mBAAmB,EACnB,oBAAoB,EACpB,iBAAiB,GAClB,MAAM,kBAAkB,CAAA;AACzB,YAAY,EACV,wBAAwB,EACxB,kBAAkB,GACnB,MAAM,kBAAkB,CAAA;AACzB,OAAO,EACL,gBAAgB,EAChB,mBAAmB,EACnB,gBAAgB,GACjB,MAAM,iBAAiB,CAAA;AACxB,YAAY,EAAE,iBAAiB,EAAE,MAAM,iBAAiB,CAAA;AACxD,OAAO,EAAE,eAAe,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAA;AAC3D,OAAO,EACL,aAAa,EACb,qBAAqB,EACrB,gBAAgB,GACjB,MAAM,eAAe,CAAA;AACtB,YAAY,EACV,oBAAoB,EACpB,0BAA0B,EAC1B,4BAA4B,EAC5B,uBAAuB,EACvB,uBAAuB,EACvB,WAAW,EACX,mBAAmB,GACpB,MAAM,eAAe,CAAA;AACtB,OAAO,EACL,iCAAiC,EACjC,0BAA0B,EAC1B,4BAA4B,EAC5B,qBAAqB,EACrB,wBAAwB,EACxB,wBAAwB,EACxB,iBAAiB,EACjB,mBAAmB,GACpB,MAAM,iBAAiB,CAAA;AACxB,YAAY,EACV,kCAAkC,EAClC,yBAAyB,EACzB,6BAA6B,GAC9B,MAAM,iBAAiB,CAAA;AACxB,OAAO,EAAE,yBAAyB,EAAE,MAAM,oBAAoB,CAAA;AAC9D,YAAY,EACV,gCAAgC,EAChC,mBAAmB,EACnB,iBAAiB,GAClB,MAAM,oBAAoB,CAAA;AAC3B,OAAO,EAAE,kBAAkB,EAAE,MAAM,qBAAqB,CAAA;AACxD,YAAY,EAAE,mBAAmB,EAAE,MAAM,qBAAqB,CAAA;AAC9D,OAAO,EAAE,eAAe,EAAE,oBAAoB,EAAE,MAAM,kBAAkB,CAAA;AACxE,YAAY,EACV,2BAA2B,EAC3B,OAAO,EACP,cAAc,EACd,aAAa,EACb,gBAAgB,EAChB,eAAe,GAChB,MAAM,kBAAkB,CAAA;AACzB,OAAO,EAAE,gBAAgB,EAAE,MAAM,mBAAmB,CAAA;AACpD,YAAY,EAAE,UAAU,EAAE,MAAM,mBAAmB,CAAA"}

package/dist/index.js

@@ -31,6 +31,7 @@ import { createDbProvider } from "./providers/db.js";
 import { generateStorageKey } from "./keys.js";
 import { storeFile } from "./storeFile.js";
 import { deleteFile } from "./deleteFile.js";
+import { defineUploadVariants, deleteVariants } from "./variants.js";
 import { cleanupStaleUploads } from "./cleanupStaleUploads.js";
 import {
   createUploadToken,
@@ -94,7 +95,9 @@ export {
   createWithSignedUrlDirective,
   defineStorageTargets,
   defineUploadProfiles,
+  defineUploadVariants,
   deleteFile,
+  deleteVariants,
   detectContentType,
   findZipCentralDirectory,
   generateStorageKey,

package/dist/types.d.ts

@@ -43,6 +43,11 @@ export interface UploadWhere {
     id?: string | {
         in: string[];
     };
+    /**
+     * Only exists when the `Upload` model has the variant columns. A query
+     * that uses it must handle the error Prisma raises without them.
+     */
+    sourceId?: string;
     target?: string;
     status?: string | {
         in: string[];
@@ -219,4 +224,105 @@ export interface SerializedUpload {
     createdAt: string;
     updatedAt: string;
 }
+/**
+ * An `Upload` row in a schema that has the two variant columns, `sourceId`
+ * and `variant`. A derived file (a thumbnail, a preview, a video's poster
+ * frame) is an `Upload` row of its own whose `sourceId` points at the file
+ * it was made from and whose `variant` names what it is (`'thumb-164'`,
+ * `'preview'`). Original files have both set to `null`.
+ */
+export interface UploadVariantRecord extends UploadRecord {
+    sourceId: string | null;
+    variant: string | null;
+}
+export interface UploadVariantWhere {
+    id?: string | {
+        in?: string[];
+        notIn?: string[];
+    };
+    sourceId?: string | null | {
+        in: string[];
+    };
+    variant?: string | null;
+    status?: string;
+    tokenId?: string | null;
+    storageKey?: string | null;
+    createdAt?: {
+        lt?: Date;
+        lte?: Date;
+    };
+    updatedAt?: {
+        lt?: Date;
+    };
+}
+export interface UploadVariantCreateData extends UploadCreateData {
+    sourceId: string;
+    variant: string;
+}
+export interface UploadVariantUpdateData {
+    status?: UploadStatus;
+    target?: string;
+    size?: bigint;
+    storageKey?: string | null;
+    filename?: string;
+    mimeType?: string;
+    data?: Uint8Array<ArrayBuffer> | null;
+    tokenId?: string | null;
+}
+/**
+ * The subset of Prisma's generated `Upload` delegate that derived files
+ * (variants) need. A generated client satisfies it once the `Upload` model
+ * has the `sourceId` and `variant` columns described in the uploads docs.
+ */
+export interface UploadVariantDelegate {
+    create(args: {
+        data: UploadVariantCreateData;
+    }): Promise<UploadVariantRecord>;
+    findUnique(args: {
+        where: {
+            id: string;
+        };
+        omit?: {
+            data?: boolean;
+        };
+    }): Promise<UploadVariantRecord | null>;
+    findFirst(args: {
+        where: UploadVariantWhere;
+        omit?: {
+            data?: boolean;
+        };
+        orderBy?: {
+            createdAt: 'asc' | 'desc';
+        };
+    }): Promise<UploadVariantRecord | null>;
+    findMany(args: {
+        where: UploadVariantWhere;
+        omit?: {
+            data?: boolean;
+        };
+        orderBy?: {
+            createdAt: 'asc' | 'desc';
+        };
+        take?: number;
+    }): Promise<UploadVariantRecord[]>;
+    updateMany(args: {
+        where: UploadVariantWhere;
+        data: UploadVariantUpdateData;
+    }): Promise<{
+        count: number;
+    }>;
+    deleteMany(args: {
+        where: UploadVariantWhere;
+    }): Promise<{
+        count: number;
+    }>;
+}
+/**
+ * The subset of a Prisma client that derived files (variants) need. Any
+ * generated client whose `Upload` model has the `sourceId` and `variant`
+ * columns satisfies it.
+ */
+export interface UploadVariantDatabase {
+    upload: UploadVariantDelegate;
+}
 //# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAA;AAE3C,0CAA0C;AAC1C,MAAM,MAAM,YAAY,GAAG,SAAS,GAAG,WAAW,GAAG,QAAQ,CAAA;AAE7D;;;;GAIG;AACH,MAAM,MAAM,kBAAkB,GAAG,YAAY,GAAG,QAAQ,CAAA;AAExD;;;;GAIG;AACH,MAAM,WAAW,YAAY;IAC3B,EAAE,EAAE,MAAM,CAAA;IACV,MAAM,EAAE,MAAM,CAAA;IACd,MAAM,EAAE,MAAM,CAAA;IACd,QAAQ,EAAE,MAAM,CAAA;IAChB,QAAQ,EAAE,MAAM,CAAA;IAChB,IAAI,EAAE,MAAM,CAAA;IACZ,UAAU,EAAE,MAAM,GAAG,IAAI,CAAA;IACzB,IAAI,CAAC,EAAE,UAAU,GAAG,IAAI,CAAA;IACxB,MAAM,EAAE,MAAM,GAAG,IAAI,CAAA;IACrB,OAAO,EAAE,MAAM,GAAG,IAAI,CAAA;IACtB,cAAc,EAAE,MAAM,GAAG,IAAI,CAAA;IAC7B,SAAS,EAAE,IAAI,CAAA;IACf,SAAS,EAAE,IAAI,CAAA;CAChB;AAED,MAAM,WAAW,gBAAgB;IAC/B,MAAM,EAAE,MAAM,CAAA;IACd,MAAM,EAAE,YAAY,CAAA;IACpB,QAAQ,EAAE,MAAM,CAAA;IAChB,QAAQ,EAAE,MAAM,CAAA;IAChB,IAAI,EAAE,MAAM,CAAA;IACZ,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAG1B,IAAI,CAAC,EAAE,UAAU,CAAC,WAAW,CAAC,GAAG,IAAI,CAAA;IACrC,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACtB,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACvB,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;CAC/B;AAED,MAAM,WAAW,WAAW;IAC1B,EAAE,CAAC,EAAE,MAAM,GAAG;QAAE,EAAE,EAAE,MAAM,EAAE,CAAA;KAAE,CAAA;IAC9B,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,MAAM,CAAC,EAAE,MAAM,GAAG;QAAE,EAAE,EAAE,MAAM,EAAE,CAAA;KAAE,CAAA;IAClC,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG;QAAE,GAAG,EAAE,IAAI,CAAA;KAAE,CAAA;IAC1C,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,SAAS,CAAC,EAAE;QAAE,EAAE,CAAC,EAAE,IAAI,CAAC;QAAC,GAAG,CAAC,EAAE,IAAI,CAAA;KAAE,CAAA;IACrC,SAAS,CAAC,EAAE;QAAE,EAAE,CAAC,EAAE,IAAI,CAAC;QAAC,GAAG,CAAC,EAAE,IAAI,CAAA;KAAE,CAAA;CACtC;AAED,MAAM,WAAW,gBAAgB;IAC/B,MAAM,CAAC,EAAE,YAAY,CAAA;IACrB,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;CAC3B;AAED;;;GAGG;AACH,MAAM,WAAW,cAAc;IAC7B,MAAM,CAAC,IAAI,EAAE;QAAE,IAAI,EAAE,gBAAgB,CAAA;KAAE,GAAG,OAAO,CAAC,YAAY,CAAC,CAAA;IAC/D,UAAU,CAAC,IAAI,EAAE;QAAE,KAAK,EAAE;YAAE,EAAE,EAAE,MAAM,CAAA;SAAE,CAAA;KAAE,GAAG,OAAO,CAAC,YAAY,GAAG,IAAI,CAAC,CAAA;IACzE,iBAAiB,CAAC,IAAI,EAAE;QAAE,KAAK,EAAE;YAAE,EAAE,EAAE,MAAM,CAAA;SAAE,CAAA;KAAE,GAAG,OAAO,CAAC,YAAY,CAAC,CAAA;IACzE,SAAS,CAAC,IAAI,EAAE;QACd,KAAK,EAAE,WAAW,CAAA;QAClB,IAAI,CAAC,EAAE;YAAE,IAAI,CAAC,EAAE,OAAO,CAAA;SAAE,CAAA;KAC1B,GAAG,OAAO,CAAC,YAAY,GAAG,IAAI,CAAC,CAAA;IAChC,QAAQ,CAAC,IAAI,EAAE;QACb,KAAK,EAAE,WAAW,CAAA;QAClB,IAAI,CAAC,EAAE;YAAE,IAAI,CAAC,EAAE,OAAO,CAAA;SAAE,CAAA;QACzB,OAAO,CAAC,EAAE;YAAE,SAAS,EAAE,KAAK,GAAG,MAAM,CAAA;SAAE,CAAA;QACvC,IAAI,CAAC,EAAE,MAAM,CAAA;KACd,GAAG,OAAO,CAAC,YAAY,EAAE,CAAC,CAAA;IAC3B,UAAU,CAAC,IAAI,EAAE;QACf,KAAK,EAAE,WAAW,CAAA;QAClB,IAAI,EAAE,gBAAgB,CAAA;KACvB,GAAG,OAAO,CAAC;QAAE,KAAK,EAAE,MAAM,CAAA;KAAE,CAAC,CAAA;IAC9B,MAAM,CAAC,IAAI,EAAE;QAAE,KAAK,EAAE;YAAE,EAAE,EAAE,MAAM,CAAA;SAAE,CAAA;KAAE,GAAG,OAAO,CAAC,YAAY,CAAC,CAAA;IAC9D,KAAK,CAAC,IAAI,EAAE;QAAE,KAAK,EAAE,WAAW,CAAA;KAAE,GAAG,OAAO,CAAC,MAAM,CAAC,CAAA;CACrD;AAED,mEAAmE;AACnE,MAAM,WAAW,uBAAuB;IACtC,MAAM,EAAE,cAAc,CAAA;CACvB;AAED;;;;GAIG;AACH,MAAM,WAAW,cAAe,SAAQ,uBAAuB;IAC7D,YAAY,CAAC,CAAC,EACZ,EAAE,EAAE,CAAC,EAAE,EAAE,uBAAuB,KAAK,OAAO,CAAC,CAAC,CAAC,EAC/C,OAAO,CAAC,EAAE;QAAE,cAAc,CAAC,EAAE,cAAc,CAAA;KAAE,GAC5C,OAAO,CAAC,CAAC,CAAC,CAAA;CACd;AAED;;;GAGG;AACH,MAAM,WAAW,kBAAkB;IACjC,GAAG,EAAE,MAAM,CAAA;IACX,MAAM,EAAE,MAAM,CAAA;IACd,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;CAChC;AAED;;;;GAIG;AACH,MAAM,WAAW,eAAe;IAC9B,4EAA4E;IAC5E,IAAI,EAAE,MAAM,CAAA;IAEZ;;;;OAIG;IACH,YAAY,EAAE,IAAI,GAAG,CAAC,MAAM,GAAG,EAAE,CAAC,CAAA;IAElC,+BAA+B;IAC/B,KAAK,CACH,GAAG,EAAE,MAAM,EACX,IAAI,EAAE,UAAU,EAChB,IAAI,EAAE;QAAE,WAAW,EAAE,MAAM,CAAA;KAAE,GAC5B,OAAO,CAAC,IAAI,CAAC,CAAA;IAEhB,yCAAyC;IACzC,IAAI,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAAA;IAElC;;;;OAIG;IACH,SAAS,CAAC,CACR,GAAG,EAAE,MAAM,EACX,KAAK,EAAE;QAAE,MAAM,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAA;KAAE,GACxC,OAAO,CAAC,MAAM,CAAC,CAAA;IAElB;;;OAGG;IACH,UAAU,CAAC,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAA;IAE3C,2DAA2D;IAC3D,MAAM,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAElC,iCAAiC;IACjC,MAAM,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,CAAA;IAErC;;;OAGG;IACH,aAAa,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC,CAAA;IAElD;;;OAGG;IACH,gBAAgB,CACd,GAAG,EAAE,MAAM,EACX,IAAI,CAAC,EAAE;QAAE,SAAS,CAAC,EAAE,MAAM,CAAC;QAAC,WAAW,CAAC,EAAE,kBAAkB,CAAA;KAAE,GAC9D,OAAO,CAAC,MAAM,CAAC,CAAA;IAElB;;;OAGG;IACH,qBAAqB,CACnB,GAAG,EAAE,MAAM,EACX,IAAI,EAAE;QAAE,WAAW,EAAE,MAAM,CAAC;QAAC,IAAI,CAAC,EAAE,MAAM,CAAC;QAAC,SAAS,CAAC,EAAE,MAAM,CAAA;KAAE,GAC/D,OAAO,CAAC,kBAAkB,CAAC,CAAA;IAE9B;;;OAGG;IACH,SAAS,IAAI,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CACrC;AAED,MAAM,MAAM,cAAc,GAAG,MAAM,CAAC,MAAM,EAAE,eAAe,CAAC,CAAA;AAE5D,0EAA0E;AAC1E,MAAM,WAAW,gBAAgB;IAC/B,EAAE,EAAE,MAAM,CAAA;IACV,MAAM,EAAE,MAAM,CAAA;IACd,MAAM,EAAE,MAAM,CAAA;IACd,QAAQ,EAAE,MAAM,CAAA;IAChB,QAAQ,EAAE,MAAM,CAAA;IAChB,IAAI,EAAE,MAAM,CAAA;IACZ,UAAU,EAAE,MAAM,GAAG,IAAI,CAAA;IACzB,MAAM,EAAE,MAAM,GAAG,IAAI,CAAA;IACrB,cAAc,EAAE,MAAM,GAAG,IAAI,CAAA;IAC7B,SAAS,EAAE,MAAM,CAAA;IACjB,SAAS,EAAE,MAAM,CAAA;CAClB"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAA;AAE3C,0CAA0C;AAC1C,MAAM,MAAM,YAAY,GAAG,SAAS,GAAG,WAAW,GAAG,QAAQ,CAAA;AAE7D;;;;GAIG;AACH,MAAM,MAAM,kBAAkB,GAAG,YAAY,GAAG,QAAQ,CAAA;AAExD;;;;GAIG;AACH,MAAM,WAAW,YAAY;IAC3B,EAAE,EAAE,MAAM,CAAA;IACV,MAAM,EAAE,MAAM,CAAA;IACd,MAAM,EAAE,MAAM,CAAA;IACd,QAAQ,EAAE,MAAM,CAAA;IAChB,QAAQ,EAAE,MAAM,CAAA;IAChB,IAAI,EAAE,MAAM,CAAA;IACZ,UAAU,EAAE,MAAM,GAAG,IAAI,CAAA;IACzB,IAAI,CAAC,EAAE,UAAU,GAAG,IAAI,CAAA;IACxB,MAAM,EAAE,MAAM,GAAG,IAAI,CAAA;IACrB,OAAO,EAAE,MAAM,GAAG,IAAI,CAAA;IACtB,cAAc,EAAE,MAAM,GAAG,IAAI,CAAA;IAC7B,SAAS,EAAE,IAAI,CAAA;IACf,SAAS,EAAE,IAAI,CAAA;CAChB;AAED,MAAM,WAAW,gBAAgB;IAC/B,MAAM,EAAE,MAAM,CAAA;IACd,MAAM,EAAE,YAAY,CAAA;IACpB,QAAQ,EAAE,MAAM,CAAA;IAChB,QAAQ,EAAE,MAAM,CAAA;IAChB,IAAI,EAAE,MAAM,CAAA;IACZ,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAG1B,IAAI,CAAC,EAAE,UAAU,CAAC,WAAW,CAAC,GAAG,IAAI,CAAA;IACrC,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACtB,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACvB,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;CAC/B;AAED,MAAM,WAAW,WAAW;IAC1B,EAAE,CAAC,EAAE,MAAM,GAAG;QAAE,EAAE,EAAE,MAAM,EAAE,CAAA;KAAE,CAAA;IAC9B;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,MAAM,CAAC,EAAE,MAAM,GAAG;QAAE,EAAE,EAAE,MAAM,EAAE,CAAA;KAAE,CAAA;IAClC,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG;QAAE,GAAG,EAAE,IAAI,CAAA;KAAE,CAAA;IAC1C,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,SAAS,CAAC,EAAE;QAAE,EAAE,CAAC,EAAE,IAAI,CAAC;QAAC,GAAG,CAAC,EAAE,IAAI,CAAA;KAAE,CAAA;IACrC,SAAS,CAAC,EAAE;QAAE,EAAE,CAAC,EAAE,IAAI,CAAC;QAAC,GAAG,CAAC,EAAE,IAAI,CAAA;KAAE,CAAA;CACtC;AAED,MAAM,WAAW,gBAAgB;IAC/B,MAAM,CAAC,EAAE,YAAY,CAAA;IACrB,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;CAC3B;AAED;;;GAGG;AACH,MAAM,WAAW,cAAc;IAC7B,MAAM,CAAC,IAAI,EAAE;QAAE,IAAI,EAAE,gBAAgB,CAAA;KAAE,GAAG,OAAO,CAAC,YAAY,CAAC,CAAA;IAC/D,UAAU,CAAC,IAAI,EAAE;QAAE,KAAK,EAAE;YAAE,EAAE,EAAE,MAAM,CAAA;SAAE,CAAA;KAAE,GAAG,OAAO,CAAC,YAAY,GAAG,IAAI,CAAC,CAAA;IACzE,iBAAiB,CAAC,IAAI,EAAE;QAAE,KAAK,EAAE;YAAE,EAAE,EAAE,MAAM,CAAA;SAAE,CAAA;KAAE,GAAG,OAAO,CAAC,YAAY,CAAC,CAAA;IACzE,SAAS,CAAC,IAAI,EAAE;QACd,KAAK,EAAE,WAAW,CAAA;QAClB,IAAI,CAAC,EAAE;YAAE,IAAI,CAAC,EAAE,OAAO,CAAA;SAAE,CAAA;KAC1B,GAAG,OAAO,CAAC,YAAY,GAAG,IAAI,CAAC,CAAA;IAChC,QAAQ,CAAC,IAAI,EAAE;QACb,KAAK,EAAE,WAAW,CAAA;QAClB,IAAI,CAAC,EAAE;YAAE,IAAI,CAAC,EAAE,OAAO,CAAA;SAAE,CAAA;QACzB,OAAO,CAAC,EAAE;YAAE,SAAS,EAAE,KAAK,GAAG,MAAM,CAAA;SAAE,CAAA;QACvC,IAAI,CAAC,EAAE,MAAM,CAAA;KACd,GAAG,OAAO,CAAC,YAAY,EAAE,CAAC,CAAA;IAC3B,UAAU,CAAC,IAAI,EAAE;QACf,KAAK,EAAE,WAAW,CAAA;QAClB,IAAI,EAAE,gBAAgB,CAAA;KACvB,GAAG,OAAO,CAAC;QAAE,KAAK,EAAE,MAAM,CAAA;KAAE,CAAC,CAAA;IAC9B,MAAM,CAAC,IAAI,EAAE;QAAE,KAAK,EAAE;YAAE,EAAE,EAAE,MAAM,CAAA;SAAE,CAAA;KAAE,GAAG,OAAO,CAAC,YAAY,CAAC,CAAA;IAC9D,KAAK,CAAC,IAAI,EAAE;QAAE,KAAK,EAAE,WAAW,CAAA;KAAE,GAAG,OAAO,CAAC,MAAM,CAAC,CAAA;CACrD;AAED,mEAAmE;AACnE,MAAM,WAAW,uBAAuB;IACtC,MAAM,EAAE,cAAc,CAAA;CACvB;AAED;;;;GAIG;AACH,MAAM,WAAW,cAAe,SAAQ,uBAAuB;IAC7D,YAAY,CAAC,CAAC,EACZ,EAAE,EAAE,CAAC,EAAE,EAAE,uBAAuB,KAAK,OAAO,CAAC,CAAC,CAAC,EAC/C,OAAO,CAAC,EAAE;QAAE,cAAc,CAAC,EAAE,cAAc,CAAA;KAAE,GAC5C,OAAO,CAAC,CAAC,CAAC,CAAA;CACd;AAED;;;GAGG;AACH,MAAM,WAAW,kBAAkB;IACjC,GAAG,EAAE,MAAM,CAAA;IACX,MAAM,EAAE,MAAM,CAAA;IACd,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;CAChC;AAED;;;;GAIG;AACH,MAAM,WAAW,eAAe;IAC9B,4EAA4E;IAC5E,IAAI,EAAE,MAAM,CAAA;IAEZ;;;;OAIG;IACH,YAAY,EAAE,IAAI,GAAG,CAAC,MAAM,GAAG,EAAE,CAAC,CAAA;IAElC,+BAA+B;IAC/B,KAAK,CACH,GAAG,EAAE,MAAM,EACX,IAAI,EAAE,UAAU,EAChB,IAAI,EAAE;QAAE,WAAW,EAAE,MAAM,CAAA;KAAE,GAC5B,OAAO,CAAC,IAAI,CAAC,CAAA;IAEhB,yCAAyC;IACzC,IAAI,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAAA;IAElC;;;;OAIG;IACH,SAAS,CAAC,CACR,GAAG,EAAE,MAAM,EACX,KAAK,EAAE;QAAE,MAAM,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAA;KAAE,GACxC,OAAO,CAAC,MAAM,CAAC,CAAA;IAElB;;;OAGG;IACH,UAAU,CAAC,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAA;IAE3C,2DAA2D;IAC3D,MAAM,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAElC,iCAAiC;IACjC,MAAM,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,CAAA;IAErC;;;OAGG;IACH,aAAa,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC,CAAA;IAElD;;;OAGG;IACH,gBAAgB,CACd,GAAG,EAAE,MAAM,EACX,IAAI,CAAC,EAAE;QAAE,SAAS,CAAC,EAAE,MAAM,CAAC;QAAC,WAAW,CAAC,EAAE,kBAAkB,CAAA;KAAE,GAC9D,OAAO,CAAC,MAAM,CAAC,CAAA;IAElB;;;OAGG;IACH,qBAAqB,CACnB,GAAG,EAAE,MAAM,EACX,IAAI,EAAE;QAAE,WAAW,EAAE,MAAM,CAAC;QAAC,IAAI,CAAC,EAAE,MAAM,CAAC;QAAC,SAAS,CAAC,EAAE,MAAM,CAAA;KAAE,GAC/D,OAAO,CAAC,kBAAkB,CAAC,CAAA;IAE9B;;;OAGG;IACH,SAAS,IAAI,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CACrC;AAED,MAAM,MAAM,cAAc,GAAG,MAAM,CAAC,MAAM,EAAE,eAAe,CAAC,CAAA;AAE5D,0EAA0E;AAC1E,MAAM,WAAW,gBAAgB;IAC/B,EAAE,EAAE,MAAM,CAAA;IACV,MAAM,EAAE,MAAM,CAAA;IACd,MAAM,EAAE,MAAM,CAAA;IACd,QAAQ,EAAE,MAAM,CAAA;IAChB,QAAQ,EAAE,MAAM,CAAA;IAChB,IAAI,EAAE,MAAM,CAAA;IACZ,UAAU,EAAE,MAAM,GAAG,IAAI,CAAA;IACzB,MAAM,EAAE,MAAM,GAAG,IAAI,CAAA;IACrB,cAAc,EAAE,MAAM,GAAG,IAAI,CAAA;IAC7B,SAAS,EAAE,MAAM,CAAA;IACjB,SAAS,EAAE,MAAM,CAAA;CAClB;AAED;;;;;;GAMG;AACH,MAAM,WAAW,mBAAoB,SAAQ,YAAY;IACvD,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAA;IACvB,OAAO,EAAE,MAAM,GAAG,IAAI,CAAA;CACvB;AAED,MAAM,WAAW,kBAAkB;IACjC,EAAE,CAAC,EAAE,MAAM,GAAG;QAAE,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC;QAAC,KAAK,CAAC,EAAE,MAAM,EAAE,CAAA;KAAE,CAAA;IACjD,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG;QAAE,EAAE,EAAE,MAAM,EAAE,CAAA;KAAE,CAAA;IAC3C,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACvB,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACvB,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAC1B,SAAS,CAAC,EAAE;QAAE,EAAE,CAAC,EAAE,IAAI,CAAC;QAAC,GAAG,CAAC,EAAE,IAAI,CAAA;KAAE,CAAA;IACrC,SAAS,CAAC,EAAE;QAAE,EAAE,CAAC,EAAE,IAAI,CAAA;KAAE,CAAA;CAC1B;AAED,MAAM,WAAW,uBAAwB,SAAQ,gBAAgB;IAC/D,QAAQ,EAAE,MAAM,CAAA;IAChB,OAAO,EAAE,MAAM,CAAA;CAChB;AAED,MAAM,WAAW,uBAAuB;IACtC,MAAM,CAAC,EAAE,YAAY,CAAA;IACrB,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAC1B,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,QAAQ,CAAC,EAAE,MAAM,CAAA;IAEjB,IAAI,CAAC,EAAE,UAAU,CAAC,WAAW,CAAC,GAAG,IAAI,CAAA;IACrC,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;CACxB;AAED;;;;GAIG;AACH,MAAM,WAAW,qBAAqB;IACpC,MAAM,CAAC,IAAI,EAAE;QAAE,IAAI,EAAE,uBAAuB,CAAA;KAAE,GAAG,OAAO,CAAC,mBAAmB,CAAC,CAAA;IAC7E,UAAU,CAAC,IAAI,EAAE;QACf,KAAK,EAAE;YAAE,EAAE,EAAE,MAAM,CAAA;SAAE,CAAA;QACrB,IAAI,CAAC,EAAE;YAAE,IAAI,CAAC,EAAE,OAAO,CAAA;SAAE,CAAA;KAC1B,GAAG,OAAO,CAAC,mBAAmB,GAAG,IAAI,CAAC,CAAA;IACvC,SAAS,CAAC,IAAI,EAAE;QACd,KAAK,EAAE,kBAAkB,CAAA;QACzB,IAAI,CAAC,EAAE;YAAE,IAAI,CAAC,EAAE,OAAO,CAAA;SAAE,CAAA;QACzB,OAAO,CAAC,EAAE;YAAE,SAAS,EAAE,KAAK,GAAG,MAAM,CAAA;SAAE,CAAA;KACxC,GAAG,OAAO,CAAC,mBAAmB,GAAG,IAAI,CAAC,CAAA;IACvC,QAAQ,CAAC,IAAI,EAAE;QACb,KAAK,EAAE,kBAAkB,CAAA;QACzB,IAAI,CAAC,EAAE;YAAE,IAAI,CAAC,EAAE,OAAO,CAAA;SAAE,CAAA;QACzB,OAAO,CAAC,EAAE;YAAE,SAAS,EAAE,KAAK,GAAG,MAAM,CAAA;SAAE,CAAA;QACvC,IAAI,CAAC,EAAE,MAAM,CAAA;KACd,GAAG,OAAO,CAAC,mBAAmB,EAAE,CAAC,CAAA;IAClC,UAAU,CAAC,IAAI,EAAE;QACf,KAAK,EAAE,kBAAkB,CAAA;QACzB,IAAI,EAAE,uBAAuB,CAAA;KAC9B,GAAG,OAAO,CAAC;QAAE,KAAK,EAAE,MAAM,CAAA;KAAE,CAAC,CAAA;IAC9B,UAAU,CAAC,IAAI,EAAE;QAAE,KAAK,EAAE,kBAAkB,CAAA;KAAE,GAAG,OAAO,CAAC;QAAE,KAAK,EAAE,MAAM,CAAA;KAAE,CAAC,CAAA;CAC5E;AAED;;;;GAIG;AACH,MAAM,WAAW,qBAAqB;IACpC,MAAM,EAAE,qBAAqB,CAAA;CAC9B"}

package/dist/variants.d.ts

@@ -0,0 +1,207 @@
+import type { ContentDisposition, StorageProvider, StorageTargets, UploadVariantDatabase, UploadVariantRecord } from './types.js';
+/** The file a variant generator returns. */
+export interface UploadVariantFile {
+    /** The derived file's bytes. */
+    data: Uint8Array;
+    /** MIME type of `data`, for example `image/webp`. */
+    mimeType: string;
+    /**
+     * Filename for the derived file's `Upload` row. Defaults to the source's
+     * filename without its extension, plus the variant name and the extension
+     * of `mimeType`: `photo.jpg` becomes `photo-thumb-164.webp`.
+     */
+    filename?: string;
+}
+/** What a variant generator is called with. */
+export interface UploadVariantContext {
+    /** The source file's `Upload` row, without its inline `data`. */
+    source: UploadVariantRecord;
+    /** Name of the variant being made, for example `'thumb-164'`. */
+    variant: string;
+    /** Reads the source file's bytes from whichever target holds them. */
+    readSource(): Promise<Buffer>;
+    /**
+     * Reads another variant of the same source, making it first if it does
+     * not exist yet. Returns `null` when that variant could not be made. This
+     * is how one derived file is made from another, for example a PDF's
+     * thumbnail cut from its drawn first page (`readVariant('preview')`).
+     */
+    readVariant(name: string): Promise<Buffer | null>;
+}
+/**
+ * Makes one derived file (variant) from its source: a thumbnail from a
+ * photo, a preview image from a PDF, a poster frame from a video. This is
+ * the only part the app writes; the uploads package stores the result,
+ * links it to its source, and keeps track of it.
+ *
+ * Return `null` when this source cannot have this variant (a file type the
+ * generator does not handle). Both `null` and a thrown error are remembered
+ * as a failure and not retried until `retryFailedAfter` has passed.
+ */
+export type UploadVariantGenerator = (context: UploadVariantContext) => Promise<UploadVariantFile | null> | UploadVariantFile | null;
+/** A variant generator plus where its files are stored. */
+export interface UploadVariantDefinition {
+    generate: UploadVariantGenerator;
+    /** Storage target for this variant's files. Defaults to the `target` option. */
+    target?: StorageProvider;
+}
+export interface DefineUploadVariantsOptions<Name extends string> {
+    db: UploadVariantDatabase;
+    /**
+     * Every configured storage target. Used to read sources and to read and
+     * delete variants wherever they are stored.
+     */
+    targets: StorageTargets;
+    /** Storage target new variant files are written to, unless a variant names its own. */
+    target: StorageProvider;
+    /**
+     * The variants, by name, each with the function that makes it:
+     * `{ 'thumb-164': makeThumb, preview: makePdfPreview }`. Names may use
+     * letters, digits, `.`, `_` and `-`.
+     */
+    variants: Record<Name, UploadVariantGenerator | UploadVariantDefinition>;
+    /**
+     * How long a variant that could not be made is left alone before the
+     * next request tries again, in milliseconds. Defaults to one day.
+     */
+    retryFailedAfter?: number;
+    /**
+     * How long a claim to make a variant is honored, in milliseconds. A
+     * request that finds a claim older than this assumes its maker died and
+     * makes the variant itself. Defaults to ten minutes; set it above the
+     * slowest generator's running time.
+     */
+    claimTimeout?: number;
+    /**
+     * How often a request waiting for another process to finish making the
+     * same variant checks again, in milliseconds. Defaults to 250.
+     */
+    pollInterval?: number;
+    /**
+     * Called when a generator throws or its result cannot be stored. Defaults
+     * to `console.error`. The failure is remembered either way.
+     */
+    onError?: (error: unknown, info: {
+        sourceId: string;
+        variant: string;
+    }) => void;
+}
+/** What `regenerateVariants()` did. */
+export interface RegenerateVariantsResult {
+    /** Variant files deleted, made or failed alike. */
+    deleted: number;
+    /** Variants made again. */
+    made: number;
+    /** Variants that could not be made again (remembered as failed). */
+    failed: number;
+    /** Variants that could not be deleted; reported through `onError`. */
+    errors: number;
+}
+/** A source upload, by id or by its row. */
+export type UploadVariantSource = string | {
+    id: string;
+};
+/**
+ * Derived files (variants) of uploads: thumbnails, previews, poster frames.
+ * Returned by `defineUploadVariants()`.
+ */
+export interface UploadVariants<Name extends string> {
+    /** The configured variant names. */
+    names: readonly Name[];
+    /**
+     * The variant's `Upload` row, made now if it does not exist yet. Returns
+     * `null` when it could not be made and `retryFailedAfter` has not passed.
+     *
+     * Making a variant happens once: concurrent calls in this process share
+     * one attempt, and across processes a claim row decides who makes it
+     * while the others wait for the result.
+     */
+    getVariant(source: UploadVariantSource, name: Name): Promise<UploadVariantRecord | null>;
+    /**
+     * The variant's `Upload` row if it has been made, or `null`. Never makes
+     * anything; use it where making on demand would be too slow, such as a
+     * list page.
+     */
+    findVariant(source: UploadVariantSource, name: Name): Promise<UploadVariantRecord | null>;
+    /**
+     * The made variants of many sources in one query, keyed by source id.
+     * Sources without that variant are left out. Never makes anything.
+     */
+    findVariants(sourceIds: string[], name: Name): Promise<Map<string, UploadVariantRecord>>;
+    /**
+     * The variant's row and bytes, made now if it does not exist yet, or
+     * `null` when it could not be made.
+     */
+    readVariant(source: UploadVariantSource, name: Name): Promise<{
+        upload: UploadVariantRecord;
+        data: Buffer;
+    } | null>;
+    /**
+     * A URL a browser can load the variant from, made now if it does not
+     * exist yet: a signed URL for object storage, a `data:` URI for database
+     * targets. `null` when the variant could not be made.
+     */
+    getVariantUrl(source: UploadVariantSource, name: Name, options?: {
+        expiresIn?: number;
+        disposition?: ContentDisposition;
+    }): Promise<string | null>;
+    /**
+     * Remakes every variant called `name`, for every source that has one
+     * (made or failed), and leaves other variants alone. Use it after fixing
+     * a generator. Each old file is deleted, then the variant is made again
+     * unless `remake` is `false`, in which case it is made on its next read.
+     */
+    regenerateVariants(name: Name, options?: {
+        remake?: boolean;
+        batchSize?: number;
+    }): Promise<RegenerateVariantsResult>;
+    /**
+     * Deletes all variants of a source, bytes first, then rows. `deleteFile()`
+     * does this for you when given `targets`.
+     */
+    deleteVariants(source: UploadVariantSource): Promise<number>;
+}
+/**
+ * Deletes every derived file (variant) of `source`: bytes first, then rows,
+ * like `deleteFile()`. Returns how many were deleted. `deleteFile()` calls
+ * this when given `targets`, so a source never goes without its variants.
+ */
+export declare function deleteVariants(source: UploadVariantSource, { db, targets }: {
+    db: UploadVariantDatabase;
+    targets: StorageTargets;
+}): Promise<number>;
+/**
+ * Declares the derived files (variants) uploads can have, such as
+ * thumbnails, previews or a video's poster frame, each with the function
+ * that makes it. **Experimental.**
+ *
+ * The app supplies only the generators. The uploads package keeps the
+ * bookkeeping: each variant is an `Upload` row linked to its source by
+ * `sourceId` and named by `variant`; it is made on first read, once even
+ * when several requests or processes ask at the same moment; a variant
+ * that cannot be made is remembered and tried again after
+ * `retryFailedAfter`; `regenerateVariants()` remakes every variant of one
+ * name; and `deleteFile()` with `targets` deletes a source's variants with
+ * it.
+ *
+ * The package does not make images or read videos itself. A generator is
+ * any function from source bytes to new bytes, using sharp, pdf.js, ffmpeg
+ * or a third-party service as the app sees fit.
+ *
+ * @example
+ * export const uploadVariants = defineUploadVariants({
+ *   db,
+ *   targets,
+ *   target: targets.thumbnails,
+ *   variants: {
+ *     'thumb-164': async ({ readSource }) => ({
+ *       data: await sharp(await readSource()).resize(164, 164).webp().toBuffer(),
+ *       mimeType: 'image/webp',
+ *     }),
+ *   },
+ * })
+ *
+ * const thumb = await uploadVariants.getVariant(photo.uploadId, 'thumb-164')
+ */
+export declare function defineUploadVariants<Name extends string>(options: DefineUploadVariantsOptions<Name>): UploadVariants<Name>;
+//# sourceMappingURL=variants.d.ts.map

package/dist/variants.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"variants.d.ts","sourceRoot":"","sources":["../src/variants.ts"],"names":[],"mappings":"AAUA,OAAO,KAAK,EACV,kBAAkB,EAClB,eAAe,EACf,cAAc,EACd,qBAAqB,EACrB,mBAAmB,EACpB,MAAM,YAAY,CAAA;AAWnB,4CAA4C;AAC5C,MAAM,WAAW,iBAAiB;IAChC,gCAAgC;IAChC,IAAI,EAAE,UAAU,CAAA;IAChB,qDAAqD;IACrD,QAAQ,EAAE,MAAM,CAAA;IAChB;;;;OAIG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAA;CAClB;AAED,+CAA+C;AAC/C,MAAM,WAAW,oBAAoB;IACnC,iEAAiE;IACjE,MAAM,EAAE,mBAAmB,CAAA;IAC3B,iEAAiE;IACjE,OAAO,EAAE,MAAM,CAAA;IACf,sEAAsE;IACtE,UAAU,IAAI,OAAO,CAAC,MAAM,CAAC,CAAA;IAC7B;;;;;OAKG;IACH,WAAW,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC,CAAA;CAClD;AAED;;;;;;;;;GASG;AACH,MAAM,MAAM,sBAAsB,GAAG,CACnC,OAAO,EAAE,oBAAoB,KAC1B,OAAO,CAAC,iBAAiB,GAAG,IAAI,CAAC,GAAG,iBAAiB,GAAG,IAAI,CAAA;AAEjE,2DAA2D;AAC3D,MAAM,WAAW,uBAAuB;IACtC,QAAQ,EAAE,sBAAsB,CAAA;IAChC,gFAAgF;IAChF,MAAM,CAAC,EAAE,eAAe,CAAA;CACzB;AAED,MAAM,WAAW,2BAA2B,CAAC,IAAI,SAAS,MAAM;IAC9D,EAAE,EAAE,qBAAqB,CAAA;IACzB;;;OAGG;IACH,OAAO,EAAE,cAAc,CAAA;IACvB,uFAAuF;IACvF,MAAM,EAAE,eAAe,CAAA;IACvB;;;;OAIG;IACH,QAAQ,EAAE,MAAM,CAAC,IAAI,EAAE,sBAAsB,GAAG,uBAAuB,CAAC,CAAA;IACxE;;;OAGG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAA;IACzB;;;;;OAKG;IACH,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB;;;OAGG;IACH,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB;;;OAGG;IACH,OAAO,CAAC,EAAE,CACR,KAAK,EAAE,OAAO,EACd,IAAI,EAAE;QAAE,QAAQ,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,MAAM,CAAA;KAAE,KACxC,IAAI,CAAA;CACV;AAED,uCAAuC;AACvC,MAAM,WAAW,wBAAwB;IACvC,mDAAmD;IACnD,OAAO,EAAE,MAAM,CAAA;IACf,2BAA2B;IAC3B,IAAI,EAAE,MAAM,CAAA;IACZ,oEAAoE;IACpE,MAAM,EAAE,MAAM,CAAA;IACd,sEAAsE;IACtE,MAAM,EAAE,MAAM,CAAA;CACf;AAED,4CAA4C;AAC5C,MAAM,MAAM,mBAAmB,GAAG,MAAM,GAAG;IAAE,EAAE,EAAE,MAAM,CAAA;CAAE,CAAA;AAEzD;;;GAGG;AACH,MAAM,WAAW,cAAc,CAAC,IAAI,SAAS,MAAM;IACjD,oCAAoC;IACpC,KAAK,EAAE,SAAS,IAAI,EAAE,CAAA;IACtB;;;;;;;OAOG;IACH,UAAU,CACR,MAAM,EAAE,mBAAmB,EAC3B,IAAI,EAAE,IAAI,GACT,OAAO,CAAC,mBAAmB,GAAG,IAAI,CAAC,CAAA;IACtC;;;;OAIG;IACH,WAAW,CACT,MAAM,EAAE,mBAAmB,EAC3B,IAAI,EAAE,IAAI,GACT,OAAO,CAAC,mBAAmB,GAAG,IAAI,CAAC,CAAA;IACtC;;;OAGG;IACH,YAAY,CACV,SAAS,EAAE,MAAM,EAAE,EACnB,IAAI,EAAE,IAAI,GACT,OAAO,CAAC,GAAG,CAAC,MAAM,EAAE,mBAAmB,CAAC,CAAC,CAAA;IAC5C;;;OAGG;IACH,WAAW,CACT,MAAM,EAAE,mBAAmB,EAC3B,IAAI,EAAE,IAAI,GACT,OAAO,CAAC;QAAE,MAAM,EAAE,mBAAmB,CAAC;QAAC,IAAI,EAAE,MAAM,CAAA;KAAE,GAAG,IAAI,CAAC,CAAA;IAChE;;;;OAIG;IACH,aAAa,CACX,MAAM,EAAE,mBAAmB,EAC3B,IAAI,EAAE,IAAI,EACV,OAAO,CAAC,EAAE;QAAE,SAAS,CAAC,EAAE,MAAM,CAAC;QAAC,WAAW,CAAC,EAAE,kBAAkB,CAAA;KAAE,GACjE,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC,CAAA;IACzB;;;;;OAKG;IACH,kBAAkB,CAChB,IAAI,EAAE,IAAI,EACV,OAAO,CAAC,EAAE;QAAE,MAAM,CAAC,EAAE,OAAO,CAAC;QAAC,SAAS,CAAC,EAAE,MAAM,CAAA;KAAE,GACjD,OAAO,CAAC,wBAAwB,CAAC,CAAA;IACpC;;;OAGG;IACH,cAAc,CAAC,MAAM,EAAE,mBAAmB,GAAG,OAAO,CAAC,MAAM,CAAC,CAAA;CAC7D;AA+FD;;;;GAIG;AACH,wBAAsB,cAAc,CAClC,MAAM,EAAE,mBAAmB,EAC3B,EAAE,EAAE,EAAE,OAAO,EAAE,EAAE;IAAE,EAAE,EAAE,qBAAqB,CAAC;IAAC,OAAO,EAAE,cAAc,CAAA;CAAE,GACtE,OAAO,CAAC,MAAM,CAAC,CAWjB;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgCG;AACH,wBAAgB,oBAAoB,CAAC,IAAI,SAAS,MAAM,EACtD,OAAO,EAAE,2BAA2B,CAAC,IAAI,CAAC,GACzC,cAAc,CAAC,IAAI,CAAC,CA+lBtB"}

package/dist/variants.js

@@ -0,0 +1,498 @@
+import { randomUUID } from "node:crypto";
+import { setTimeout as sleep } from "node:timers/promises";
+import mime from "mime-types";
+import { UploadError } from "./errors.js";
+import { generateStorageKey } from "./keys.js";
+import { DB_MAX_FILE_SIZE } from "./profiles.js";
+import { toDataUri } from "./serialize.js";
+import { resolveTarget } from "./targets.js";
+const ONE_DAY = 24 * 60 * 60 * 1e3;
+const TEN_MINUTES = 10 * 60 * 1e3;
+const MIME_TYPE = /^[a-z0-9][a-z0-9!#$&^_.+-]*\/[a-z0-9][a-z0-9!#$&^_.+-]*$/i;
+const VARIANT_NAME = /^[A-Za-z0-9][A-Za-z0-9._-]*$/;
+function idOf(source) {
+  return typeof source === "string" ? source : source.id;
+}
+function isPrismaError(e, code) {
+  return typeof e === "object" && e !== null && "code" in e && e.code === code;
+}
+function defaultFilename(sourceFilename, name, mimeType) {
+  const base = sourceFilename.replace(/\.[^./\\]*$/, "") || "file";
+  const ext = mimeType ? mime.extension(mimeType.split(";")[0].trim()) : false;
+  return ext ? `${base}-${name}.${ext}` : `${base}-${name}`;
+}
+async function readBytes(db, targets, upload) {
+  const target = resolveTarget(targets, upload.target);
+  if (target.providerType === "db") {
+    const row = await db.upload.findUnique({ where: { id: upload.id } });
+    if (!row?.data) {
+      throw new UploadError(
+        "NOT_FOUND",
+        `Upload '${upload.id}' has no inline data.`
+      );
+    }
+    return Buffer.from(row.data);
+  }
+  if (!upload.storageKey) {
+    throw new UploadError(
+      "NOT_FOUND",
+      `Upload '${upload.id}' has no stored file.`
+    );
+  }
+  return Buffer.from(await target.read(upload.storageKey));
+}
+async function deleteVariantRow(db, targets, row) {
+  let current = row;
+  while (current) {
+    if (current.storageKey) {
+      await resolveTarget(targets, current.target).delete(current.storageKey);
+    }
+    const { count } = await db.upload.deleteMany({
+      where: {
+        id: current.id,
+        status: current.status,
+        tokenId: current.tokenId,
+        storageKey: current.storageKey
+      }
+    });
+    if (count === 1) {
+      return;
+    }
+    current = await db.upload.findUnique({
+      where: { id: current.id },
+      omit: { data: true }
+    });
+  }
+}
+async function deleteVariants(source, { db, targets }) {
+  const rows = await db.upload.findMany({
+    where: { sourceId: idOf(source) },
+    omit: { data: true }
+  });
+  for (const row of rows) {
+    await deleteVariantRow(db, targets, row);
+  }
+  return rows.length;
+}
+function defineUploadVariants(options) {
+  const {
+    db,
+    targets,
+    target: defaultTarget,
+    retryFailedAfter = ONE_DAY,
+    claimTimeout = TEN_MINUTES,
+    pollInterval = 250,
+    onError = (error, { sourceId, variant }) => console.error(
+      `[cedar uploads] could not make variant '${variant}' of ${sourceId}:`,
+      error
+    )
+  } = options;
+  const definitions = /* @__PURE__ */ new Map();
+  for (const [name, value] of Object.entries(options.variants)) {
+    if (!VARIANT_NAME.test(name)) {
+      throw new UploadError(
+        "CONFIGURATION",
+        `Invalid variant name '${name}'. Use letters, digits, '.', '_' and '-', starting with a letter or digit.`
+      );
+    }
+    const definition = typeof value === "function" ? { generate: value } : value;
+    const target = definition.target ?? defaultTarget;
+    if (!Object.hasOwn(targets, target.name) || targets[target.name] !== target) {
+      throw new UploadError(
+        "CONFIGURATION",
+        `Variant '${name}' uses a storage target that isn't in \`targets\`.`
+      );
+    }
+    definitions.set(name, { generate: definition.generate, target });
+  }
+  const names = [...definitions.keys()];
+  const inFlight = /* @__PURE__ */ new Map();
+  const waitingFor = /* @__PURE__ */ new Map();
+  const keyOf = (sourceId, name) => `${sourceId}\0${name}`;
+  const isWaitingFor = (from, to) => {
+    const seen = /* @__PURE__ */ new Set();
+    const stack = [from];
+    for (let key = stack.pop(); key !== void 0; key = stack.pop()) {
+      if (key === to) {
+        return true;
+      }
+      if (!seen.has(key)) {
+        seen.add(key);
+        stack.push(...waitingFor.get(key) ?? []);
+      }
+    }
+    return false;
+  };
+  const obtainFor = async (waiter, sourceId, name, chain) => {
+    const key = keyOf(sourceId, name);
+    if (!chain.includes(name) && inFlight.has(key) && isWaitingFor(key, waiter)) {
+      throw new UploadError(
+        "CONFIGURATION",
+        `Variant '${name}' and the variant reading it depend on each other.`
+      );
+    }
+    const waits = waitingFor.get(waiter) ?? [];
+    waitingFor.set(waiter, [...waits, key]);
+    try {
+      return await obtain(sourceId, name, chain);
+    } finally {
+      const rest = waitingFor.get(waiter) ?? [];
+      rest.splice(rest.indexOf(key), 1);
+      if (rest.length === 0) {
+        waitingFor.delete(waiter);
+      }
+    }
+  };
+  const definitionOf = (name) => {
+    const definition = definitions.get(name);
+    if (!definition) {
+      throw new UploadError(
+        "CONFIGURATION",
+        `Unknown upload variant '${name}'. Configured variants: ${names.join(", ") || "(none)"}.`
+      );
+    }
+    return definition;
+  };
+  const loadSource = async (sourceId) => {
+    const source = await db.upload.findUnique({
+      where: { id: sourceId },
+      omit: { data: true }
+    });
+    if (source?.status !== "completed") {
+      throw new UploadError(
+        "NOT_FOUND",
+        `Upload '${sourceId}' does not exist or is not completed, so it cannot have variants.`
+      );
+    }
+    if (source.sourceId) {
+      throw new UploadError(
+        "NOT_SUPPORTED",
+        `Upload '${sourceId}' is itself a variant. Variants are made from original uploads only; use \`readVariant()\` in a generator to make one variant from another.`
+      );
+    }
+    return source;
+  };
+  const findRow = (sourceId, name) => db.upload.findFirst({
+    where: { sourceId, variant: name },
+    omit: { data: true }
+  });
+  const make = async (source, rowId, claim, name, chain) => {
+    const definition = definitionOf(name);
+    const target = definition.target;
+    const ours = { id: rowId, status: "pending", tokenId: claim };
+    const fail = async (error) => {
+      if (error !== void 0) {
+        onError(error, { sourceId: source.id, variant: name });
+      }
+      await db.upload.updateMany({ where: ours, data: { status: "failed" } });
+      return null;
+    };
+    let file;
+    try {
+      file = await definition.generate({
+        source,
+        variant: name,
+        readSource: () => readBytes(db, targets, source),
+        readVariant: async (other) => {
+          const made = await obtainFor(
+            keyOf(source.id, name),
+            source.id,
+            other,
+            [...chain, name]
+          );
+          return made ? readBytes(db, targets, made) : null;
+        }
+      });
+    } catch (e) {
+      return fail(e);
+    }
+    if (!file) {
+      return fail();
+    }
+    if (!MIME_TYPE.test(file.mimeType)) {
+      return fail(
+        new UploadError(
+          "MIME_TYPE_NOT_ALLOWED",
+          `Variant '${name}' returned '${file.mimeType}', which is not a valid MIME type.`
+        )
+      );
+    }
+    const isDbTarget = target.providerType === "db";
+    if (isDbTarget && file.data.byteLength > DB_MAX_FILE_SIZE) {
+      return fail(
+        new UploadError(
+          "FILE_TOO_LARGE",
+          `Variant '${name}' is ${file.data.byteLength} bytes, which exceeds the ${DB_MAX_FILE_SIZE} byte limit for target '${target.name}'.`
+        )
+      );
+    }
+    const storageKey = isDbTarget ? null : generateStorageKey(file.mimeType);
+    if (storageKey) {
+      try {
+        await target.write(storageKey, file.data, {
+          contentType: file.mimeType
+        });
+      } catch (e) {
+        await target.delete(storageKey).catch(() => void 0);
+        await db.upload.deleteMany({ where: ours });
+        throw e;
+      }
+    }
+    const { count } = await db.upload.updateMany({
+      where: ours,
+      data: {
+        status: "completed",
+        // A retry or a takeover writes to the variant's current target,
+        // which is not necessarily the one the row was created for
+        target: target.name,
+        storageKey,
+        size: BigInt(file.data.byteLength),
+        mimeType: file.mimeType,
+        filename: file.filename ?? defaultFilename(source.filename, name, file.mimeType),
+        // Copying gives Prisma the plain-ArrayBuffer-backed array its
+        // `Bytes` input requires
+        data: isDbTarget ? new Uint8Array(file.data) : null,
+        tokenId: null
+      }
+    }).catch(async (e) => {
+      if (storageKey) {
+        await target.delete(storageKey).catch(() => void 0);
+      }
+      await db.upload.deleteMany({ where: ours }).catch(() => void 0);
+      throw e;
+    });
+    if (count !== 1) {
+      if (storageKey) {
+        await target.delete(storageKey).catch(() => void 0);
+      }
+      const current = await findRow(source.id, name);
+      return current?.status === "completed" ? current : null;
+    }
+    return db.upload.findUnique({ where: { id: rowId }, omit: { data: true } });
+  };
+  const obtainUncached = async (sourceId, name, chain) => {
+    const definition = definitionOf(name);
+    const source = await loadSource(sourceId);
+    for (; ; ) {
+      const row = await findRow(sourceId, name);
+      const now = Date.now();
+      const claim = randomUUID();
+      if (!row) {
+        let created;
+        try {
+          created = await db.upload.create({
+            data: {
+              sourceId,
+              variant: name,
+              target: definition.target.name,
+              status: "pending",
+              filename: defaultFilename(source.filename, name),
+              mimeType: "application/octet-stream",
+              size: 0n,
+              tokenId: claim,
+              userId: source.userId,
+              organizationId: source.organizationId
+            }
+          });
+        } catch (e) {
+          if (isPrismaError(e, "P2002")) {
+            continue;
+          }
+          if (isPrismaError(e, "P2003")) {
+            throw new UploadError(
+              "NOT_FOUND",
+              `Upload '${sourceId}' was deleted while its variant '${name}' was being made.`,
+              e
+            );
+          }
+          throw e;
+        }
+        return make(source, created.id, claim, name, chain);
+      }
+      if (row.status === "completed") {
+        return row;
+      }
+      if (row.status === "failed") {
+        const cutoff2 = new Date(now - retryFailedAfter);
+        if (row.updatedAt >= cutoff2) {
+          return null;
+        }
+        const { count } = await db.upload.updateMany({
+          where: { id: row.id, status: "failed", updatedAt: { lt: cutoff2 } },
+          data: { status: "pending", tokenId: claim }
+        });
+        if (count === 1) {
+          return make(source, row.id, claim, name, chain);
+        }
+        continue;
+      }
+      const cutoff = new Date(now - claimTimeout);
+      if (row.updatedAt < cutoff) {
+        const { count } = await db.upload.updateMany({
+          where: {
+            id: row.id,
+            status: "pending",
+            tokenId: row.tokenId,
+            updatedAt: { lt: cutoff }
+          },
+          data: { tokenId: claim }
+        });
+        if (count === 1) {
+          return make(source, row.id, claim, name, chain);
+        }
+        continue;
+      }
+      await sleep(pollInterval);
+    }
+  };
+  const obtain = (sourceId, name, chain) => {
+    if (chain.includes(name)) {
+      return Promise.reject(
+        new UploadError(
+          "CONFIGURATION",
+          `Variant '${name}' depends on itself: ${[...chain, name].join(" -> ")}.`
+        )
+      );
+    }
+    const key = keyOf(sourceId, name);
+    const running = inFlight.get(key);
+    if (running) {
+      return running;
+    }
+    const attempt = obtainUncached(sourceId, name, chain);
+    const forget = () => {
+      if (inFlight.get(key) === attempt) {
+        inFlight.delete(key);
+      }
+    };
+    inFlight.set(key, attempt);
+    attempt.then(forget, forget);
+    return attempt;
+  };
+  const getVariant = (source, name) => obtain(idOf(source), name, []);
+  const findVariant = async (source, name) => {
+    definitionOf(name);
+    return db.upload.findFirst({
+      where: { sourceId: idOf(source), variant: name, status: "completed" },
+      omit: { data: true }
+    });
+  };
+  const findVariants = async (sourceIds, name) => {
+    definitionOf(name);
+    const rows = sourceIds.length ? await db.upload.findMany({
+      where: {
+        sourceId: { in: sourceIds },
+        variant: name,
+        status: "completed"
+      },
+      omit: { data: true }
+    }) : [];
+    const bySource = /* @__PURE__ */ new Map();
+    for (const row of rows) {
+      if (row.sourceId) {
+        bySource.set(row.sourceId, row);
+      }
+    }
+    return bySource;
+  };
+  const readVariant = async (source, name) => {
+    const upload = await getVariant(source, name);
+    if (!upload) {
+      return null;
+    }
+    return { upload, data: await readBytes(db, targets, upload) };
+  };
+  const getVariantUrl = async (source, name, urlOptions = {}) => {
+    const upload = await getVariant(source, name);
+    if (!upload) {
+      return null;
+    }
+    const target = resolveTarget(targets, upload.target);
+    if (target.providerType === "db") {
+      return toDataUri(upload.mimeType, await readBytes(db, targets, upload));
+    }
+    if (!upload.storageKey) {
+      return null;
+    }
+    return target.getSignedReadUrl(upload.storageKey, urlOptions);
+  };
+  const regenerateVariants = async (name, {
+    remake = true,
+    batchSize = 100
+  } = {}) => {
+    definitionOf(name);
+    const result = {
+      deleted: 0,
+      made: 0,
+      failed: 0,
+      errors: 0
+    };
+    const newest = await db.upload.findFirst({
+      where: { variant: name },
+      omit: { data: true },
+      orderBy: { createdAt: "desc" }
+    });
+    if (!newest) {
+      return result;
+    }
+    const cutoff = newest.createdAt;
+    const exclude = [];
+    for (; ; ) {
+      const rows = await db.upload.findMany({
+        where: {
+          variant: name,
+          createdAt: { lte: cutoff },
+          ...exclude.length > 0 && { id: { notIn: exclude } }
+        },
+        omit: { data: true },
+        orderBy: { createdAt: "asc" },
+        take: batchSize
+      });
+      if (rows.length === 0) {
+        return result;
+      }
+      for (const row of rows) {
+        const sourceId = row.sourceId ?? "";
+        try {
+          await deleteVariantRow(db, targets, row);
+          result.deleted += 1;
+        } catch (e) {
+          result.errors += 1;
+          exclude.push(row.id);
+          onError(e, { sourceId, variant: name });
+          continue;
+        }
+        if (remake) {
+          await inFlight.get(keyOf(sourceId, name))?.catch(() => null);
+          const made = await getVariant(sourceId, name).catch((e) => {
+            onError(e, { sourceId, variant: name });
+            return null;
+          });
+          if (made) {
+            result.made += 1;
+          } else {
+            result.failed += 1;
+          }
+          const current = await findRow(sourceId, name);
+          if (current && current.createdAt <= cutoff) {
+            exclude.push(current.id);
+          }
+        }
+      }
+    }
+  };
+  return {
+    names,
+    getVariant,
+    findVariant,
+    findVariants,
+    readVariant,
+    getVariantUrl,
+    regenerateVariants,
+    deleteVariants: (source) => deleteVariants(source, { db, targets })
+  };
+}
+export {
+  defineUploadVariants,
+  deleteVariants
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cedarjs/uploads",
-  "version": "8.0.0-canary.3418",
+  "version": "8.0.0-canary.3421",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/cedarjs/cedar.git",
@@ -43,9 +43,9 @@
     "test:watch": "vitest watch"
   },
   "dependencies": {
-    "@cedarjs/api": "8.0.0-canary.3418",
-    "@cedarjs/context": "8.0.0-canary.3418",
-    "@cedarjs/graphql-server": "8.0.0-canary.3418",
+    "@cedarjs/api": "8.0.0-canary.3421",
+    "@cedarjs/context": "8.0.0-canary.3421",
+    "@cedarjs/graphql-server": "8.0.0-canary.3421",
     "@fastify/multipart": "9.4.0",
     "graphql": "16.14.2",
     "mime-types": "2.1.35"
@@ -55,8 +55,8 @@
     "@arethetypeswrong/cli": "0.18.5",
     "@aws-sdk/client-s3": "3.1149.0",
     "@aws-sdk/s3-request-presigner": "3.1149.0",
-    "@cedarjs/framework-tools": "8.0.0-canary.3418",
-    "@cedarjs/web": "8.0.0-canary.3418",
+    "@cedarjs/framework-tools": "8.0.0-canary.3421",
+    "@cedarjs/web": "8.0.0-canary.3421",
     "@prisma/adapter-better-sqlite3": "7.10.0",
     "@prisma/client": "7.10.0",
     "@testing-library/dom": "10.4.2",
@@ -90,7 +90,7 @@
     "@apollo/client": "4.3.3",
     "@aws-sdk/client-s3": "^3.0.0",
     "@aws-sdk/s3-request-presigner": "^3.0.0",
-    "@cedarjs/web": "8.0.0-canary.3418",
+    "@cedarjs/web": "8.0.0-canary.3421",
     "@uppy/aws-s3": "^6.0.0",
     "@uppy/core": "^6.0.0",
     "@uppy/dashboard": "^6.0.0",