@devultur/convex 1.0.3 → 1.2.0

package/README.md

@@ -67,6 +67,94 @@ function CoverUpload({ onSaved }) {
 }
 ```
 
+## Upload progress
+
+`upload(file, { onProgress, signal })` reports the PUT's progress and resolves to the stored reference:
+
+```tsx
+const { upload } = useDevultur();
+
+const media = await upload(file, {
+  onProgress: ({ loadedBytes, totalBytes, fraction }) => setPercent(Math.round(fraction * 100)),
+  signal: controller.signal, // aborts the PUT; upload() rejects with an AbortError
+});
+media.key; // the uploaded object's key ("private/image/<id>/<name>"; a video's raw file)
+await saveCover({ cover: media }); // a DevulturMedia: stores as-is in a dv.media() field, key included
+```
+
+The PUT goes through `XMLHttpRequest` (`fetch` reports no upload progress), in parts for large files. `key` is an
+optional field of `DevulturMedia` and of `dv.media()` (since 1.1.0), so references stored without it stay valid. It
+is informational: delivery URLs are still derived from `id`, `kind`, `visibility` and `filename`.
+
+## Media library
+
+Every upload, whatever its kind, gets a record in the component's `media` table once its bytes are stored, so
+`listMedia` lists your images, files and videos:
+
+```typescript
+// convex/library.ts
+import { Devultur, mediaFromRecord } from "@devultur/convex";
+import { query } from "./_generated/server";
+import { components } from "./_generated/api";
+
+const devultur = new Devultur(components.devultur);
+
+export const images = query({
+  args: {},
+  handler: async (ctx) => {
+    // Check who's asking first: listMedia returns every record, of every user.
+    const records = await devultur.listMedia(ctx, { type: "image" }); // or "video" | "file", or no filter
+    return records.map((record) => ({ record, media: mediaFromRecord(record) }));
+  },
+});
+```
+
+`listMedia` reads every record at once: fine for a handful, unbounded for a library. Page a library with
+`listMediaPage`, newest first, on a `by_type` index:
+
+```typescript
+import { paginationOptsValidator } from "convex/server";
+import { v } from "convex/values";
+
+export const imagesPage = query({
+  args: { paginationOpts: paginationOptsValidator },
+  handler: async (ctx, { paginationOpts }) => {
+    // Check who's asking first.
+    return devultur.listMediaPage(ctx, { type: "image", paginationOpts });
+  },
+});
+// React: usePaginatedQuery(api.library.imagesPage, {}, { initialNumItems: 24 })
+```
+
+`Devultur.exposeApi` also returns a `listMediaPage` query (`{ type?, paginationOpts }`). It lists every user's media,
+so export it only when every caller may see the whole library.
+
+A record is written only after the Worker confirms the object exists, so an abandoned upload never shows up:
+
+1. After its PUT, the client calls `confirmUpload({ key, filename, width, height })`. The component asks the Worker
+   for the object (a `HEAD`) and records its size and content type. `useDevultur().upload()` and `useMediaUpload` do
+   this for you when the `api` you pass `<DevulturProvider>` has `confirmUpload` (add it to the functions you export
+   from `Devultur.exposeApi` in `convex/devultur.ts`). From your server: `devultur.confirmUpload(ctx, { key })`.
+2. `createUploadUrl` also schedules the same check for 25 hours later, past the longest an upload can take. An upload
+   whose client never confirmed is recorded then; one that was never stored, or was deleted, isn't.
+
+A record's `key` is the media id for every kind (what `getMedia` takes), and `objectKey` is the uploaded object's key.
+`confirmUpload` only accepts upload keys (`{visibility}/{image|file}/{id}/{name}`, `{visibility}/video/{id}/raw/{name}`)
+and is idempotent: a video's transcode state stays as it is.
+
+`confirmUpload`, like every function `exposeApi` returns (and the `devultur-init` template exports), has no auth of
+its own: anyone who can call your Convex deployment can call it. Wrap it with your app's auth, as you would the other
+exposed functions: export your own action that checks `ctx.auth` and then calls `devultur.confirmUpload(ctx, { key })`.
+The caller only names the key: the record's visibility, size and content type come from the Worker's `HEAD` of the
+object, never from the arguments.
+
+`deleteMedia` removes an image's or a file's record once
+the Worker deleted the object (a delete refused by a lock keeps it). `deleteVideo` removes a video's.
+
+Records from before 1.1.0 (and a video only `processVideo` recorded) have no `visibility` or `objectKey`;
+`mediaFromRecord` returns `null` for them. Nothing needs migrating: the new fields are optional. `listMedia` doesn't
+report an object's lock: read it from an action with `devultur.getLock(ctx, record.objectKey)`.
+
 ## Using a self-hosted Worker
 
 The component talks to any Worker built with `createWorker()` from
@@ -115,6 +203,44 @@ webhooks with the `webhookCredential` your plugin sets in the request state (or
 none; see [Plugins](https://github.com/devultur/devultur/blob/main/docs/guides/plugins.md)). Set `DEVULTUR_SECRET`
 to that value, and make sure your plugin also accepts it as the bearer of the component's calls.
 
+## Errors
+
+When the media Worker refuses a request, component actions throw a `ConvexError` whose `data` is
+`{ code, message, status, details? }`. A plain `Error` would lose these fields across the component boundary. `code` is
+the Worker's stable code: for example `retention_active`, `compliance_extend_only`, `lock_conflict`,
+`lock_privilege_required`, `file_too_large`, or `worker_error` when the Worker sent none. `details` carries the rest of
+the Worker's answer, such as the `{ key, mode, until, hold }` of a `retention_active`.
+
+```ts
+import { devulturErrorOf } from "@devultur/convex";
+
+try {
+  await devultur.setLock(ctx, key, { until });
+} catch (error) {
+  const refusal = devulturErrorOf(error); // null when it isn't a Worker refusal
+  if (refusal?.code === "compliance_extend_only") {
+    // the date can only move later
+  }
+  throw error;
+}
+```
+
+`isDevulturError(error)` is the matching type guard. Errors that aren't Worker refusals, such as a network failure,
+are rethrown unchanged.
+
+## Object lock
+
+- `devultur.createUploadUrl(ctx, { filename, contentType, lock, hold })` locks a file from its first write.
+- `devultur.getLock(ctx, key)` and `devultur.setLock(ctx, key, { mode, until, period, derivatives })` read and change
+  a file's retention.
+- `devultur.setHold(ctx, keys)` and `devultur.releaseHold(ctx, keys)` set and release holds.
+
+These are server-side calls: `exposeApi` never lets a browser choose or change a lock. Its `createUploadUrl` applies
+`config.upload.lock` instead. A bulk hold by prefix runs on your server with `@devultur/core`'s
+`createWorkerClient(...).lock.holdAll({ prefix })`. The
+[Retention and holds](https://github.com/devultur/devultur/blob/main/docs/guides/object-lock.md) guide covers the model,
+what's enforced and the caveats.
+
 ## Documentation
 
 Guides and API reference: [github.com/devultur/devultur/tree/main/docs](https://github.com/devultur/devultur/tree/main/docs).

package/dist/bin/init.js

@@ -76,6 +76,7 @@ import { components } from "./_generated/api";
 export const {
 	issueViewerToken,
 	createUploadUrl,
+	confirmUpload,
 	deleteMedia,
 	deleteVideo,
 	processVideo,

package/dist/{chunk-FHWT3GD6.js → chunk-GKLFRSGI.js}

@@ -4,6 +4,8 @@ var mediaFields = {
   id: v.string(),
   visibility: v.union(v.literal("public"), v.literal("private")),
   filename: v.optional(v.string()),
+  // The uploaded object's key, as `upload()` returns it. Optional: references stored before it stay valid.
+  key: v.optional(v.string()),
   width: v.optional(v.number()),
   height: v.optional(v.number())
 };

package/dist/component/_generated/api.d.ts

@@ -7,11 +7,23 @@
  * @module
  */
 import type * as http from "../http.js";
+import type * as lock from "../lock.js";
+import type * as lockValidators from "../lockValidators.js";
+import type * as mediaClient from "../mediaClient.js";
 import type * as public_ from "../public.js";
+import type * as uploadKeys from "../uploadKeys.js";
+import type * as uploads from "../uploads.js";
+import type * as workerErrors from "../workerErrors.js";
 import type { ApiFromModules, FilterApi, FunctionReference } from "convex/server";
 declare const fullApi: ApiFromModules<{
     http: typeof http;
+    lock: typeof lock;
+    lockValidators: typeof lockValidators;
+    mediaClient: typeof mediaClient;
     public: typeof public_;
+    uploadKeys: typeof uploadKeys;
+    uploads: typeof uploads;
+    workerErrors: typeof workerErrors;
 }>;
 /**
  * A utility for referencing Convex functions in your app's public API.

package/dist/component/_generated/api.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"api.d.ts","sourceRoot":"","sources":["../../../src/component/_generated/api.ts"],"names":[],"mappings":"AACA;;;;;;;GAOG;AAEH,OAAO,KAAK,KAAK,IAAI,MAAM,YAAY,CAAC;AACxC,OAAO,KAAK,KAAK,OAAO,MAAM,cAAc,CAAC;AAE7C,OAAO,KAAK,EACV,cAAc,EACd,SAAS,EACT,iBAAiB,EAClB,MAAM,eAAe,CAAC;AAGvB,QAAA,MAAM,OAAO,EAAE,cAAc,CAAC;IAC5B,IAAI,EAAE,OAAO,IAAI,CAAC;IAClB,MAAM,EAAE,OAAO,OAAO,CAAC;CACxB,CAAiB,CAAC;AAEnB;;;;;;;GAOG;AACH,eAAO,MAAM,GAAG,EAAE,SAAS,CACzB,OAAO,OAAO,EACd,iBAAiB,CAAC,GAAG,EAAE,QAAQ,CAAC,CACjB,CAAC;AAElB;;;;;;;GAOG;AACH,eAAO,MAAM,QAAQ,EAAE,SAAS,CAC9B,OAAO,OAAO,EACd,iBAAiB,CAAC,GAAG,EAAE,UAAU,CAAC,CACnB,CAAC;AAElB,eAAO,MAAM,UAAU,EAAqC,EAAE,CAAC"}
+{"version":3,"file":"api.d.ts","sourceRoot":"","sources":["../../../src/component/_generated/api.ts"],"names":[],"mappings":"AACA;;;;;;;GAOG;AAEH,OAAO,KAAK,KAAK,IAAI,MAAM,YAAY,CAAC;AACxC,OAAO,KAAK,KAAK,IAAI,MAAM,YAAY,CAAC;AACxC,OAAO,KAAK,KAAK,cAAc,MAAM,sBAAsB,CAAC;AAC5D,OAAO,KAAK,KAAK,WAAW,MAAM,mBAAmB,CAAC;AACtD,OAAO,KAAK,KAAK,OAAO,MAAM,cAAc,CAAC;AAC7C,OAAO,KAAK,KAAK,UAAU,MAAM,kBAAkB,CAAC;AACpD,OAAO,KAAK,KAAK,OAAO,MAAM,eAAe,CAAC;AAC9C,OAAO,KAAK,KAAK,YAAY,MAAM,oBAAoB,CAAC;AAExD,OAAO,KAAK,EACV,cAAc,EACd,SAAS,EACT,iBAAiB,EAClB,MAAM,eAAe,CAAC;AAGvB,QAAA,MAAM,OAAO,EAAE,cAAc,CAAC;IAC5B,IAAI,EAAE,OAAO,IAAI,CAAC;IAClB,IAAI,EAAE,OAAO,IAAI,CAAC;IAClB,cAAc,EAAE,OAAO,cAAc,CAAC;IACtC,WAAW,EAAE,OAAO,WAAW,CAAC;IAChC,MAAM,EAAE,OAAO,OAAO,CAAC;IACvB,UAAU,EAAE,OAAO,UAAU,CAAC;IAC9B,OAAO,EAAE,OAAO,OAAO,CAAC;IACxB,YAAY,EAAE,OAAO,YAAY,CAAC;CACnC,CAAiB,CAAC;AAEnB;;;;;;;GAOG;AACH,eAAO,MAAM,GAAG,EAAE,SAAS,CACzB,OAAO,OAAO,EACd,iBAAiB,CAAC,GAAG,EAAE,QAAQ,CAAC,CACjB,CAAC;AAElB;;;;;;;GAOG;AACH,eAAO,MAAM,QAAQ,EAAE,SAAS,CAC9B,OAAO,OAAO,EACd,iBAAiB,CAAC,GAAG,EAAE,UAAU,CAAC,CACnB,CAAC;AAElB,eAAO,MAAM,UAAU,EAAqC,EAAE,CAAC"}

package/dist/component/_generated/api.js.map

@@ -1 +1 @@
-{"version":3,"file":"api.js","sourceRoot":"","sources":["../../../src/component/_generated/api.ts"],"names":[],"mappings":"AAAA,oBAAoB;AACpB;;;;;;;GAOG;AAUH,OAAO,EAAE,MAAM,EAAE,iBAAiB,EAAE,MAAM,eAAe,CAAC;AAE1D,MAAM,OAAO,GAGR,MAAa,CAAC;AAEnB;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,GAAG,GAGZ,MAAa,CAAC;AAElB;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,QAAQ,GAGjB,MAAa,CAAC;AAElB,MAAM,CAAC,MAAM,UAAU,GAAG,iBAAiB,EAAmB,CAAC"}
+{"version":3,"file":"api.js","sourceRoot":"","sources":["../../../src/component/_generated/api.ts"],"names":[],"mappings":"AAAA,oBAAoB;AACpB;;;;;;;GAOG;AAgBH,OAAO,EAAE,MAAM,EAAE,iBAAiB,EAAE,MAAM,eAAe,CAAC;AAE1D,MAAM,OAAO,GASR,MAAa,CAAC;AAEnB;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,GAAG,GAGZ,MAAa,CAAC;AAElB;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,QAAQ,GAGjB,MAAa,CAAC;AAElB,MAAM,CAAC,MAAM,UAAU,GAAG,iBAAiB,EAAmB,CAAC"}

package/dist/component/_generated/component.d.ts

@@ -19,6 +19,26 @@ import type { FunctionReference } from "convex/server";
  * ```
  */
 export type ComponentApi<Name extends string | undefined = string | undefined> = {
+    lock: {
+        getLock: FunctionReference<"action", "internal", {
+            key: string;
+        }, any, Name>;
+        releaseHold: FunctionReference<"action", "internal", {
+            keys: Array<string>;
+        }, any, Name>;
+        setHold: FunctionReference<"action", "internal", {
+            keys: Array<string>;
+        }, any, Name>;
+        setLock: FunctionReference<"action", "internal", {
+            bypassGovernance?: boolean;
+            derivatives?: "inherit" | "original-only";
+            key: string;
+            mode?: "governance" | "compliance";
+            period?: number;
+            remove?: true;
+            until?: string;
+        }, any, Name>;
+    };
     public: {
         createMedia: FunctionReference<"mutation", "internal", {
             contentType: string;
@@ -30,6 +50,16 @@ export type ComponentApi<Name extends string | undefined = string | undefined> =
         createUploadUrl: FunctionReference<"action", "internal", {
             contentType: string;
             filename: string;
+            hold?: boolean;
+            lock?: {
+                hold?: boolean;
+                retention?: {
+                    derivatives?: "inherit" | "original-only";
+                    mode: "governance" | "compliance";
+                    period?: number;
+                    until?: string;
+                };
+            };
             visibility?: "public" | "private";
         }, any, Name>;
         deleteMediaAction: FunctionReference<"action", "internal", {
@@ -55,6 +85,17 @@ export type ComponentApi<Name extends string | undefined = string | undefined> =
         listMedia: FunctionReference<"query", "internal", {
             type?: "video" | "image" | "file";
         }, any, Name>;
+        listMediaPage: FunctionReference<"query", "internal", {
+            paginationOpts: {
+                cursor: string | null;
+                endCursor?: string | null;
+                id?: number;
+                maximumBytesRead?: number;
+                maximumRowsRead?: number;
+                numItems: number;
+            };
+            type?: "video" | "image" | "file";
+        }, any, Name>;
         loadProgress: FunctionReference<"query", "internal", {
             userId: string;
             videoId: string;
@@ -101,5 +142,13 @@ export type ComponentApi<Name extends string | undefined = string | undefined> =
             vttUrl: string;
         }, any, Name>;
     };
+    uploads: {
+        confirmUpload: FunctionReference<"action", "internal", {
+            filename?: string;
+            height?: number;
+            key: string;
+            width?: number;
+        }, any, Name>;
+    };
 };
 //# sourceMappingURL=component.d.ts.map

package/dist/component/_generated/component.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"component.d.ts","sourceRoot":"","sources":["../../../src/component/_generated/component.ts"],"names":[],"mappings":"AACA;;;;;;;GAOG;AAEH,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,eAAe,CAAC;AAEvD;;;;;;;;;;GAUG;AACH,MAAM,MAAM,YAAY,CAAC,IAAI,SAAS,MAAM,GAAG,SAAS,GAAG,MAAM,GAAG,SAAS,IAC3E;IACE,MAAM,EAAE;QACN,WAAW,EAAE,iBAAiB,CAC5B,UAAU,EACV,UAAU,EACV;YACE,WAAW,EAAE,MAAM,CAAC;YACpB,QAAQ,EAAE,MAAM,CAAC;YACjB,GAAG,EAAE,MAAM,CAAC;YACZ,SAAS,EAAE,MAAM,CAAC;YAClB,IAAI,EAAE,OAAO,GAAG,OAAO,GAAG,MAAM,CAAC;SAClC,EACD,GAAG,EACH,IAAI,CACL,CAAC;QACF,eAAe,EAAE,iBAAiB,CAChC,QAAQ,EACR,UAAU,EACV;YACE,WAAW,EAAE,MAAM,CAAC;YACpB,QAAQ,EAAE,MAAM,CAAC;YACjB,UAAU,CAAC,EAAE,QAAQ,GAAG,SAAS,CAAC;SACnC,EACD,GAAG,EACH,IAAI,CACL,CAAC;QACF,iBAAiB,EAAE,iBAAiB,CAClC,QAAQ,EACR,UAAU,EACV;YAAE,GAAG,EAAE,MAAM,CAAA;SAAE,EACf,GAAG,EACH,IAAI,CACL,CAAC;QACF,WAAW,EAAE,iBAAiB,CAC5B,QAAQ,EACR,UAAU,EACV;YAAE,OAAO,EAAE,MAAM,CAAC;YAAC,UAAU,CAAC,EAAE,QAAQ,GAAG,SAAS,CAAA;SAAE,EACtD,GAAG,EACH,IAAI,CACL,CAAC;QACF,iBAAiB,EAAE,iBAAiB,CAClC,OAAO,EACP,UAAU,EACV;YAAE,MAAM,EAAE,MAAM,CAAC;YAAC,QAAQ,EAAE,KAAK,CAAC,MAAM,CAAC,CAAA;SAAE,EAC3C,GAAG,EACH,IAAI,CACL,CAAC;QACF,aAAa,EAAE,iBAAiB,CAC9B,OAAO,EACP,UAAU,EACV;YAAE,GAAG,EAAE,MAAM,CAAA;SAAE,EACf,GAAG,EACH,IAAI,CACL,CAAC;QACF,gBAAgB,EAAE,iBAAiB,CACjC,QAAQ,EACR,UAAU,EACV;YAAE,aAAa,CAAC,EAAE,MAAM,CAAA;SAAE,EAC1B,GAAG,EACH,IAAI,CACL,CAAC;QACF,mBAAmB,EAAE,iBAAiB,CACpC,OAAO,EACP,UAAU,EACV;YAAE,QAAQ,EAAE,MAAM,CAAA;SAAE,EACpB,GAAG,EACH,IAAI,CACL,CAAC;QACF,SAAS,EAAE,iBAAiB,CAC1B,OAAO,EACP,UAAU,EACV;YAAE,IAAI,CAAC,EAAE,OAAO,GAAG,OAAO,GAAG,MAAM,CAAA;SAAE,EACrC,GAAG,EACH,IAAI,CACL,CAAC;QACF,YAAY,EAAE,iBAAiB,CAC7B,OAAO,EACP,UAAU,EACV;YAAE,MAAM,EAAE,MAAM,CAAC;YAAC,OAAO,EAAE,MAAM,CAAA;SAAE,EACnC,GAAG,EACH,IAAI,CACL,CAAC;QACF,YAAY,EAAE,iBAAiB,CAC7B,UAAU,EACV,UAAU,EACV;YAAE,MAAM,EAAE,MAAM,CAAC;YAAC,OAAO,EAAE,MAAM,CAAA;SAAE,EACnC,GAAG,EACH,IAAI,CACL,CAAC;QACF,YAAY,EAAE,iBAAiB,CAC7B,QAAQ,EACR,UAAU,EACV;YACE,WAAW,CAAC,EAAE,MAAM,CAAC;YACrB,GAAG,EAAE,MAAM,CAAC;YACZ,OAAO,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;YACxB,MAAM,CAAC,EAAE,MAAM,CAAC;SACjB,EACD,GAAG,EACH,IAAI,CACL,CAAC;QACF,aAAa,EAAE,iBAAiB,CAC9B,UAAU,EACV,UAAU,EACV;YAAE,MAAM,EAAE,MAAM,CAAC;YAAC,OAAO,EAAE,MAAM,CAAA;SAAE,EACnC,GAAG,EACH,IAAI,CACL,CAAC;QACF,YAAY,EAAE,iBAAiB,CAC7B,UAAU,EACV,UAAU,EACV;YAAE,QAAQ,EAAE,MAAM,CAAC;YAAC,MAAM,EAAE,MAAM,CAAC;YAAC,OAAO,EAAE,MAAM,CAAA;SAAE,EACrD,GAAG,EACH,IAAI,CACL,CAAC;QACF,WAAW,EAAE,iBAAiB,CAC5B,UAAU,EACV,UAAU,EACV;YACE,cAAc,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;YAC/B,eAAe,CAAC,EAAE,OAAO,CAAC;YAC1B,QAAQ,CAAC,EAAE,MAAM,CAAC;YAClB,aAAa,CAAC,EACV,eAAe,GACf,mBAAmB,GACnB,SAAS,GACT,UAAU,GACV,UAAU,CAAC;YACf,GAAG,EAAE,MAAM,CAAC;YACZ,WAAW,CAAC,EAAE,MAAM,CAAC;YACrB,SAAS,CAAC,EAAE,OAAO,CAAC;YACpB,YAAY,CAAC,EAAE,MAAM,CAAC;YACtB,cAAc,CAAC,EAAE,MAAM,CAAC;YACxB,iBAAiB,CAAC,EAAE;gBAAE,OAAO,EAAE,MAAM,CAAC;gBAAC,KAAK,EAAE,MAAM,CAAA;aAAE,CAAC;YACvD,eAAe,CAAC,EACZ,QAAQ,GACR,aAAa,GACb,YAAY,GACZ,OAAO,GACP,QAAQ,CAAC;SACd,EACD,GAAG,EACH,IAAI,CACL,CAAC;QACF,aAAa,EAAE,iBAAiB,CAC9B,UAAU,EACV,UAAU,EACV;YAAE,MAAM,EAAE,MAAM,CAAC;YAAC,QAAQ,EAAE,MAAM,CAAC;YAAC,MAAM,CAAC,EAAE,MAAM,CAAC;YAAC,MAAM,EAAE,MAAM,CAAA;SAAE,EACrE,GAAG,EACH,IAAI,CACL,CAAC;KACH,CAAC;CACH,CAAC"}
+{"version":3,"file":"component.d.ts","sourceRoot":"","sources":["../../../src/component/_generated/component.ts"],"names":[],"mappings":"AACA;;;;;;;GAOG;AAEH,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,eAAe,CAAC;AAEvD;;;;;;;;;;GAUG;AACH,MAAM,MAAM,YAAY,CAAC,IAAI,SAAS,MAAM,GAAG,SAAS,GAAG,MAAM,GAAG,SAAS,IAC3E;IACE,IAAI,EAAE;QACJ,OAAO,EAAE,iBAAiB,CACxB,QAAQ,EACR,UAAU,EACV;YAAE,GAAG,EAAE,MAAM,CAAA;SAAE,EACf,GAAG,EACH,IAAI,CACL,CAAC;QACF,WAAW,EAAE,iBAAiB,CAC5B,QAAQ,EACR,UAAU,EACV;YAAE,IAAI,EAAE,KAAK,CAAC,MAAM,CAAC,CAAA;SAAE,EACvB,GAAG,EACH,IAAI,CACL,CAAC;QACF,OAAO,EAAE,iBAAiB,CACxB,QAAQ,EACR,UAAU,EACV;YAAE,IAAI,EAAE,KAAK,CAAC,MAAM,CAAC,CAAA;SAAE,EACvB,GAAG,EACH,IAAI,CACL,CAAC;QACF,OAAO,EAAE,iBAAiB,CACxB,QAAQ,EACR,UAAU,EACV;YACE,gBAAgB,CAAC,EAAE,OAAO,CAAC;YAC3B,WAAW,CAAC,EAAE,SAAS,GAAG,eAAe,CAAC;YAC1C,GAAG,EAAE,MAAM,CAAC;YACZ,IAAI,CAAC,EAAE,YAAY,GAAG,YAAY,CAAC;YACnC,MAAM,CAAC,EAAE,MAAM,CAAC;YAChB,MAAM,CAAC,EAAE,IAAI,CAAC;YACd,KAAK,CAAC,EAAE,MAAM,CAAC;SAChB,EACD,GAAG,EACH,IAAI,CACL,CAAC;KACH,CAAC;IACF,MAAM,EAAE;QACN,WAAW,EAAE,iBAAiB,CAC5B,UAAU,EACV,UAAU,EACV;YACE,WAAW,EAAE,MAAM,CAAC;YACpB,QAAQ,EAAE,MAAM,CAAC;YACjB,GAAG,EAAE,MAAM,CAAC;YACZ,SAAS,EAAE,MAAM,CAAC;YAClB,IAAI,EAAE,OAAO,GAAG,OAAO,GAAG,MAAM,CAAC;SAClC,EACD,GAAG,EACH,IAAI,CACL,CAAC;QACF,eAAe,EAAE,iBAAiB,CAChC,QAAQ,EACR,UAAU,EACV;YACE,WAAW,EAAE,MAAM,CAAC;YACpB,QAAQ,EAAE,MAAM,CAAC;YACjB,IAAI,CAAC,EAAE,OAAO,CAAC;YACf,IAAI,CAAC,EAAE;gBACL,IAAI,CAAC,EAAE,OAAO,CAAC;gBACf,SAAS,CAAC,EAAE;oBACV,WAAW,CAAC,EAAE,SAAS,GAAG,eAAe,CAAC;oBAC1C,IAAI,EAAE,YAAY,GAAG,YAAY,CAAC;oBAClC,MAAM,CAAC,EAAE,MAAM,CAAC;oBAChB,KAAK,CAAC,EAAE,MAAM,CAAC;iBAChB,CAAC;aACH,CAAC;YACF,UAAU,CAAC,EAAE,QAAQ,GAAG,SAAS,CAAC;SACnC,EACD,GAAG,EACH,IAAI,CACL,CAAC;QACF,iBAAiB,EAAE,iBAAiB,CAClC,QAAQ,EACR,UAAU,EACV;YAAE,GAAG,EAAE,MAAM,CAAA;SAAE,EACf,GAAG,EACH,IAAI,CACL,CAAC;QACF,WAAW,EAAE,iBAAiB,CAC5B,QAAQ,EACR,UAAU,EACV;YAAE,OAAO,EAAE,MAAM,CAAC;YAAC,UAAU,CAAC,EAAE,QAAQ,GAAG,SAAS,CAAA;SAAE,EACtD,GAAG,EACH,IAAI,CACL,CAAC;QACF,iBAAiB,EAAE,iBAAiB,CAClC,OAAO,EACP,UAAU,EACV;YAAE,MAAM,EAAE,MAAM,CAAC;YAAC,QAAQ,EAAE,KAAK,CAAC,MAAM,CAAC,CAAA;SAAE,EAC3C,GAAG,EACH,IAAI,CACL,CAAC;QACF,aAAa,EAAE,iBAAiB,CAC9B,OAAO,EACP,UAAU,EACV;YAAE,GAAG,EAAE,MAAM,CAAA;SAAE,EACf,GAAG,EACH,IAAI,CACL,CAAC;QACF,gBAAgB,EAAE,iBAAiB,CACjC,QAAQ,EACR,UAAU,EACV;YAAE,aAAa,CAAC,EAAE,MAAM,CAAA;SAAE,EAC1B,GAAG,EACH,IAAI,CACL,CAAC;QACF,mBAAmB,EAAE,iBAAiB,CACpC,OAAO,EACP,UAAU,EACV;YAAE,QAAQ,EAAE,MAAM,CAAA;SAAE,EACpB,GAAG,EACH,IAAI,CACL,CAAC;QACF,SAAS,EAAE,iBAAiB,CAC1B,OAAO,EACP,UAAU,EACV;YAAE,IAAI,CAAC,EAAE,OAAO,GAAG,OAAO,GAAG,MAAM,CAAA;SAAE,EACrC,GAAG,EACH,IAAI,CACL,CAAC;QACF,aAAa,EAAE,iBAAiB,CAC9B,OAAO,EACP,UAAU,EACV;YACE,cAAc,EAAE;gBACd,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;gBACtB,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;gBAC1B,EAAE,CAAC,EAAE,MAAM,CAAC;gBACZ,gBAAgB,CAAC,EAAE,MAAM,CAAC;gBAC1B,eAAe,CAAC,EAAE,MAAM,CAAC;gBACzB,QAAQ,EAAE,MAAM,CAAC;aAClB,CAAC;YACF,IAAI,CAAC,EAAE,OAAO,GAAG,OAAO,GAAG,MAAM,CAAC;SACnC,EACD,GAAG,EACH,IAAI,CACL,CAAC;QACF,YAAY,EAAE,iBAAiB,CAC7B,OAAO,EACP,UAAU,EACV;YAAE,MAAM,EAAE,MAAM,CAAC;YAAC,OAAO,EAAE,MAAM,CAAA;SAAE,EACnC,GAAG,EACH,IAAI,CACL,CAAC;QACF,YAAY,EAAE,iBAAiB,CAC7B,UAAU,EACV,UAAU,EACV;YAAE,MAAM,EAAE,MAAM,CAAC;YAAC,OAAO,EAAE,MAAM,CAAA;SAAE,EACnC,GAAG,EACH,IAAI,CACL,CAAC;QACF,YAAY,EAAE,iBAAiB,CAC7B,QAAQ,EACR,UAAU,EACV;YACE,WAAW,CAAC,EAAE,MAAM,CAAC;YACrB,GAAG,EAAE,MAAM,CAAC;YACZ,OAAO,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;YACxB,MAAM,CAAC,EAAE,MAAM,CAAC;SACjB,EACD,GAAG,EACH,IAAI,CACL,CAAC;QACF,aAAa,EAAE,iBAAiB,CAC9B,UAAU,EACV,UAAU,EACV;YAAE,MAAM,EAAE,MAAM,CAAC;YAAC,OAAO,EAAE,MAAM,CAAA;SAAE,EACnC,GAAG,EACH,IAAI,CACL,CAAC;QACF,YAAY,EAAE,iBAAiB,CAC7B,UAAU,EACV,UAAU,EACV;YAAE,QAAQ,EAAE,MAAM,CAAC;YAAC,MAAM,EAAE,MAAM,CAAC;YAAC,OAAO,EAAE,MAAM,CAAA;SAAE,EACrD,GAAG,EACH,IAAI,CACL,CAAC;QACF,WAAW,EAAE,iBAAiB,CAC5B,UAAU,EACV,UAAU,EACV;YACE,cAAc,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;YAC/B,eAAe,CAAC,EAAE,OAAO,CAAC;YAC1B,QAAQ,CAAC,EAAE,MAAM,CAAC;YAClB,aAAa,CAAC,EACV,eAAe,GACf,mBAAmB,GACnB,SAAS,GACT,UAAU,GACV,UAAU,CAAC;YACf,GAAG,EAAE,MAAM,CAAC;YACZ,WAAW,CAAC,EAAE,MAAM,CAAC;YACrB,SAAS,CAAC,EAAE,OAAO,CAAC;YACpB,YAAY,CAAC,EAAE,MAAM,CAAC;YACtB,cAAc,CAAC,EAAE,MAAM,CAAC;YACxB,iBAAiB,CAAC,EAAE;gBAAE,OAAO,EAAE,MAAM,CAAC;gBAAC,KAAK,EAAE,MAAM,CAAA;aAAE,CAAC;YACvD,eAAe,CAAC,EACZ,QAAQ,GACR,aAAa,GACb,YAAY,GACZ,OAAO,GACP,QAAQ,CAAC;SACd,EACD,GAAG,EACH,IAAI,CACL,CAAC;QACF,aAAa,EAAE,iBAAiB,CAC9B,UAAU,EACV,UAAU,EACV;YAAE,MAAM,EAAE,MAAM,CAAC;YAAC,QAAQ,EAAE,MAAM,CAAC;YAAC,MAAM,CAAC,EAAE,MAAM,CAAC;YAAC,MAAM,EAAE,MAAM,CAAA;SAAE,EACrE,GAAG,EACH,IAAI,CACL,CAAC;KACH,CAAC;IACF,OAAO,EAAE;QACP,aAAa,EAAE,iBAAiB,CAC9B,QAAQ,EACR,UAAU,EACV;YAAE,QAAQ,CAAC,EAAE,MAAM,CAAC;YAAC,MAAM,CAAC,EAAE,MAAM,CAAC;YAAC,GAAG,EAAE,MAAM,CAAC;YAAC,KAAK,CAAC,EAAE,MAAM,CAAA;SAAE,EACnE,GAAG,EACH,IAAI,CACL,CAAC;KACH,CAAC;CACH,CAAC"}

package/dist/component/lock.d.ts

@@ -0,0 +1,33 @@
+export declare const getLock: import("convex/server").RegisteredAction<"public", {
+    key: string;
+}, Promise<import("@devultur/core").LockView>>;
+export declare const setLock: import("convex/server").RegisteredAction<"public", {
+    mode?: "governance" | "compliance" | undefined;
+    until?: string | undefined;
+    period?: number | undefined;
+    derivatives?: "inherit" | "original-only" | undefined;
+    remove?: true | undefined;
+    bypassGovernance?: boolean | undefined;
+    key: string;
+}, Promise<import("@devultur/core").LockView>>;
+export declare const setHold: import("convex/server").RegisteredAction<"public", {
+    keys: string[];
+}, Promise<{
+    updated: string[];
+    skipped: {
+        key: string;
+        reason: string;
+    }[];
+    pageSize: number;
+}>>;
+export declare const releaseHold: import("convex/server").RegisteredAction<"public", {
+    keys: string[];
+}, Promise<{
+    updated: string[];
+    skipped: {
+        key: string;
+        reason: string;
+    }[];
+    pageSize: number;
+}>>;
+//# sourceMappingURL=lock.d.ts.map

package/dist/component/lock.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"lock.d.ts","sourceRoot":"","sources":["../../src/component/lock.ts"],"names":[],"mappings":"AAaA,eAAO,MAAM,OAAO;;8CAGlB,CAAC;AAEH,eAAO,MAAM,OAAO;;;;;;;;8CAWlB,CAAC;AAcH,eAAO,MAAM,OAAO;;;;;aARG,MAAM;gBAAU,MAAM;;;GAW3C,CAAC;AAEH,eAAO,MAAM,WAAW;;;;;aAbD,MAAM;gBAAU,MAAM;;;GAgB3C,CAAC"}

package/dist/component/lock.js

@@ -0,0 +1,47 @@
+// Object lock from the app's server: read and change an object's retention, and set or release holds on a list of
+// keys. These are component functions, so only the app's own functions can call them (never a browser). A bulk hold
+// by prefix stays on the app's server, with `@devultur/core`'s `createWorkerClient(...).lock.holdAll({ prefix })`.
+// A refusal throws a `ConvexError` whose `data.code` is the Worker's (`retention_active`, `compliance_extend_only`,
+// `lock_privilege_required`, `lock_conflict`, ...); see workerErrors.ts.
+import { HOLD_PAGE_SIZE } from "@devultur/core";
+import { v } from "convex/values";
+import { derivativesValidator, retentionModeValidator } from "./lockValidators";
+import { getMediaClient } from "./mediaClient";
+import { workerAction } from "./workerErrors";
+const keysValidator = v.array(v.string());
+export const getLock = workerAction({
+    args: { key: v.string() },
+    handler: async (_ctx, args) => getMediaClient().lock.get(args.key),
+});
+export const setLock = workerAction({
+    args: {
+        key: v.string(),
+        mode: v.optional(retentionModeValidator),
+        until: v.optional(v.string()),
+        period: v.optional(v.number()),
+        derivatives: v.optional(derivativesValidator),
+        remove: v.optional(v.literal(true)),
+        bypassGovernance: v.optional(v.boolean()),
+    },
+    handler: async (_ctx, { key, ...options }) => getMediaClient().lock.set(key, options),
+});
+/** Holds every key, a page of {@link HOLD_PAGE_SIZE} at a time; returns what changed and what didn't. */
+async function changeHolds(keys, hold) {
+    const lock = getMediaClient().lock;
+    const updated = [];
+    const skipped = [];
+    for await (const page of hold ? lock.holdAll(keys) : lock.releaseAll(keys)) {
+        updated.push(...page.updated);
+        skipped.push(...page.skipped);
+    }
+    return { updated, skipped, pageSize: HOLD_PAGE_SIZE };
+}
+export const setHold = workerAction({
+    args: { keys: keysValidator },
+    handler: async (_ctx, args) => changeHolds(args.keys, true),
+});
+export const releaseHold = workerAction({
+    args: { keys: keysValidator },
+    handler: async (_ctx, args) => changeHolds(args.keys, false),
+});
+//# sourceMappingURL=lock.js.map

package/dist/component/lock.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"lock.js","sourceRoot":"","sources":["../../src/component/lock.ts"],"names":[],"mappings":"AAAA,kHAAkH;AAClH,oHAAoH;AACpH,mHAAmH;AACnH,oHAAoH;AACpH,yEAAyE;AACzE,OAAO,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAChD,OAAO,EAAE,CAAC,EAAE,MAAM,eAAe,CAAC;AAClC,OAAO,EAAE,oBAAoB,EAAE,sBAAsB,EAAE,MAAM,kBAAkB,CAAC;AAChF,OAAO,EAAE,cAAc,EAAE,MAAM,eAAe,CAAC;AAC/C,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAE9C,MAAM,aAAa,GAAG,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC;AAE1C,MAAM,CAAC,MAAM,OAAO,GAAG,YAAY,CAAC;IACnC,IAAI,EAAE,EAAE,GAAG,EAAE,CAAC,CAAC,MAAM,EAAE,EAAE;IACzB,OAAO,EAAE,KAAK,EAAE,IAAI,EAAE,IAAI,EAAE,EAAE,CAAC,cAAc,EAAE,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC;CAClE,CAAC,CAAC;AAEH,MAAM,CAAC,MAAM,OAAO,GAAG,YAAY,CAAC;IACnC,IAAI,EAAE;QACL,GAAG,EAAE,CAAC,CAAC,MAAM,EAAE;QACf,IAAI,EAAE,CAAC,CAAC,QAAQ,CAAC,sBAAsB,CAAC;QACxC,KAAK,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;QAC7B,MAAM,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;QAC9B,WAAW,EAAE,CAAC,CAAC,QAAQ,CAAC,oBAAoB,CAAC;QAC7C,MAAM,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QACnC,gBAAgB,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC;KACzC;IACD,OAAO,EAAE,KAAK,EAAE,IAAI,EAAE,EAAE,GAAG,EAAE,GAAG,OAAO,EAAE,EAAE,EAAE,CAAC,cAAc,EAAE,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,EAAE,OAAO,CAAC;CACrF,CAAC,CAAC;AAEH,yGAAyG;AACzG,KAAK,UAAU,WAAW,CAAC,IAAc,EAAE,IAAa;IACvD,MAAM,IAAI,GAAG,cAAc,EAAE,CAAC,IAAI,CAAC;IACnC,MAAM,OAAO,GAAa,EAAE,CAAC;IAC7B,MAAM,OAAO,GAAsC,EAAE,CAAC;IACtD,IAAI,KAAK,EAAE,MAAM,IAAI,IAAI,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,CAAC;QAC5E,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,OAAO,CAAC,CAAC;QAC9B,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,OAAO,CAAC,CAAC;IAC/B,CAAC;IACD,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,cAAc,EAAE,CAAC;AACvD,CAAC;AAED,MAAM,CAAC,MAAM,OAAO,GAAG,YAAY,CAAC;IACnC,IAAI,EAAE,EAAE,IAAI,EAAE,aAAa,EAAE;IAC7B,OAAO,EAAE,KAAK,EAAE,IAAI,EAAE,IAAI,EAAE,EAAE,CAAC,WAAW,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC;CAC3D,CAAC,CAAC;AAEH,MAAM,CAAC,MAAM,WAAW,GAAG,YAAY,CAAC;IACvC,IAAI,EAAE,EAAE,IAAI,EAAE,aAAa,EAAE;IAC7B,OAAO,EAAE,KAAK,EAAE,IAAI,EAAE,IAAI,EAAE,EAAE,CAAC,WAAW,CAAC,IAAI,CAAC,IAAI,EAAE,KAAK,CAAC;CAC5D,CAAC,CAAC"}

package/dist/component/lockValidators.d.ts

@@ -0,0 +1,25 @@
+export declare const retentionModeValidator: import("convex/values").VUnion<"governance" | "compliance", [import("convex/values").VLiteral<"governance", "required">, import("convex/values").VLiteral<"compliance", "required">], "required", never>;
+export declare const derivativesValidator: import("convex/values").VUnion<"inherit" | "original-only", [import("convex/values").VLiteral<"inherit", "required">, import("convex/values").VLiteral<"original-only", "required">], "required", never>;
+export declare const objectLockValidator: import("convex/values").VObject<{
+    retention?: {
+        until?: string | undefined;
+        period?: number | undefined;
+        derivatives?: "inherit" | "original-only" | undefined;
+        mode: "governance" | "compliance";
+    } | undefined;
+    hold?: boolean | undefined;
+}, {
+    retention: import("convex/values").VObject<{
+        until?: string | undefined;
+        period?: number | undefined;
+        derivatives?: "inherit" | "original-only" | undefined;
+        mode: "governance" | "compliance";
+    } | undefined, {
+        mode: import("convex/values").VUnion<"governance" | "compliance", [import("convex/values").VLiteral<"governance", "required">, import("convex/values").VLiteral<"compliance", "required">], "required", never>;
+        until: import("convex/values").VString<string | undefined, "optional">;
+        period: import("convex/values").VFloat64<number | undefined, "optional">;
+        derivatives: import("convex/values").VUnion<"inherit" | "original-only" | undefined, [import("convex/values").VLiteral<"inherit", "required">, import("convex/values").VLiteral<"original-only", "required">], "optional", never>;
+    }, "optional", "mode" | "until" | "period" | "derivatives">;
+    hold: import("convex/values").VBoolean<boolean | undefined, "optional">;
+}, "required", "retention" | "hold" | "retention.mode" | "retention.until" | "retention.period" | "retention.derivatives">;
+//# sourceMappingURL=lockValidators.d.ts.map

package/dist/component/lockValidators.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"lockValidators.d.ts","sourceRoot":"","sources":["../../src/component/lockValidators.ts"],"names":[],"mappings":"AAGA,eAAO,MAAM,sBAAsB,0MAA4D,CAAC;AAChG,eAAO,MAAM,oBAAoB,0MAA4D,CAAC;AAE9F,eAAO,MAAM,mBAAmB;;;;;;;;;;;;;;;;;;;;;0HAU9B,CAAC"}

package/dist/component/lockValidators.js

@@ -0,0 +1,14 @@
+// Validators of the object lock arguments (the shapes of `@devultur/core`'s `ObjectLock` and `SetLockOptions`).
+import { v } from "convex/values";
+export const retentionModeValidator = v.union(v.literal("governance"), v.literal("compliance"));
+export const derivativesValidator = v.union(v.literal("inherit"), v.literal("original-only"));
+export const objectLockValidator = v.object({
+    retention: v.optional(v.object({
+        mode: retentionModeValidator,
+        until: v.optional(v.string()),
+        period: v.optional(v.number()),
+        derivatives: v.optional(derivativesValidator),
+    })),
+    hold: v.optional(v.boolean()),
+});
+//# sourceMappingURL=lockValidators.js.map

package/dist/component/lockValidators.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"lockValidators.js","sourceRoot":"","sources":["../../src/component/lockValidators.ts"],"names":[],"mappings":"AAAA,gHAAgH;AAChH,OAAO,EAAE,CAAC,EAAE,MAAM,eAAe,CAAC;AAElC,MAAM,CAAC,MAAM,sBAAsB,GAAG,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,OAAO,CAAC,YAAY,CAAC,EAAE,CAAC,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC,CAAC;AAChG,MAAM,CAAC,MAAM,oBAAoB,GAAG,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,OAAO,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC,OAAO,CAAC,eAAe,CAAC,CAAC,CAAC;AAE9F,MAAM,CAAC,MAAM,mBAAmB,GAAG,CAAC,CAAC,MAAM,CAAC;IAC3C,SAAS,EAAE,CAAC,CAAC,QAAQ,CACpB,CAAC,CAAC,MAAM,CAAC;QACR,IAAI,EAAE,sBAAsB;QAC5B,KAAK,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;QAC7B,MAAM,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;QAC9B,WAAW,EAAE,CAAC,CAAC,QAAQ,CAAC,oBAAoB,CAAC;KAC7C,CAAC,CACF;IACD,IAAI,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC;CAC7B,CAAC,CAAC"}

package/dist/component/mediaClient.d.ts

@@ -0,0 +1,3 @@
+import { type WorkerClient } from "@devultur/core";
+export declare function getMediaClient(): WorkerClient;
+//# sourceMappingURL=mediaClient.d.ts.map

package/dist/component/mediaClient.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"mediaClient.d.ts","sourceRoot":"","sources":["../../src/component/mediaClient.ts"],"names":[],"mappings":"AACA,OAAO,EAAsB,KAAK,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAGvE,wBAAgB,cAAc,IAAI,YAAY,CAE7C"}

package/dist/component/mediaClient.js

@@ -0,0 +1,7 @@
+// The component's client of the media Worker, from the env the app mounts the component with.
+import { createWorkerClient } from "@devultur/core";
+import { env } from "./_generated/server";
+export function getMediaClient() {
+    return createWorkerClient(env.DEVULTUR_SECRET, env.DEVULTUR_API_URL);
+}
+//# sourceMappingURL=mediaClient.js.map

package/dist/component/mediaClient.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"mediaClient.js","sourceRoot":"","sources":["../../src/component/mediaClient.ts"],"names":[],"mappings":"AAAA,8FAA8F;AAC9F,OAAO,EAAE,kBAAkB,EAAqB,MAAM,gBAAgB,CAAC;AACvE,OAAO,EAAE,GAAG,EAAE,MAAM,qBAAqB,CAAC;AAE1C,MAAM,UAAU,cAAc;IAC7B,OAAO,kBAAkB,CAAC,GAAG,CAAC,eAAe,EAAE,GAAG,CAAC,gBAAgB,CAAC,CAAC;AACtE,CAAC"}

package/dist/component/public.d.ts

@@ -5,7 +5,17 @@ export declare const issueViewerToken: import("convex/server").RegisteredAction<
     expiresIn: number;
 }>>;
 export declare const createUploadUrl: import("convex/server").RegisteredAction<"public", {
+    hold?: boolean | undefined;
     visibility?: "public" | "private" | undefined;
+    lock?: {
+        retention?: {
+            until?: string | undefined;
+            period?: number | undefined;
+            derivatives?: "inherit" | "original-only" | undefined;
+            mode: "governance" | "compliance";
+        } | undefined;
+        hold?: boolean | undefined;
+    } | undefined;
     filename: string;
     contentType: string;
 }, Promise<import("@devultur/core").WorkerUploadResult>>;
@@ -62,6 +72,10 @@ export declare const getMediaByKey: import("convex/server").RegisteredQuery<"pub
 }, Promise<{
     _id: import("convex/values").GenericId<"media">;
     _creationTime: number;
+    width?: number | undefined;
+    height?: number | undefined;
+    visibility?: "public" | "private" | undefined;
+    objectKey?: string | undefined;
     transcodeStatus?: "queued" | "transcoding" | "captioning" | "ready" | "failed" | undefined;
     transcodeProgress?: {
         phase?: "captioning" | "downloading" | "encoding" | "uploading" | undefined;
@@ -103,6 +117,10 @@ export declare const listMedia: import("convex/server").RegisteredQuery<"public"
 }, Promise<{
     _id: import("convex/values").GenericId<"media">;
     _creationTime: number;
+    width?: number | undefined;
+    height?: number | undefined;
+    visibility?: "public" | "private" | undefined;
+    objectKey?: string | undefined;
     transcodeStatus?: "queued" | "transcoding" | "captioning" | "ready" | "failed" | undefined;
     transcodeProgress?: {
         phase?: "captioning" | "downloading" | "encoding" | "uploading" | undefined;
@@ -139,6 +157,60 @@ export declare const listMedia: import("convex/server").RegisteredQuery<"public"
     sizeBytes: number;
     createdAt: number;
 }[]>>;
+/** One page of the media library, newest first, optionally of one type (`by_type` index). */
+export declare const listMediaPage: import("convex/server").RegisteredQuery<"public", {
+    type?: "video" | "image" | "file" | undefined;
+    paginationOpts: {
+        id?: number;
+        endCursor?: string | null;
+        maximumRowsRead?: number;
+        maximumBytesRead?: number;
+        numItems: number;
+        cursor: string | null;
+    };
+}, Promise<import("convex/server").PaginationResult<{
+    _id: import("convex/values").GenericId<"media">;
+    _creationTime: number;
+    width?: number | undefined;
+    height?: number | undefined;
+    visibility?: "public" | "private" | undefined;
+    objectKey?: string | undefined;
+    transcodeStatus?: "queued" | "transcoding" | "captioning" | "ready" | "failed" | undefined;
+    transcodeProgress?: {
+        phase?: "captioning" | "downloading" | "encoding" | "uploading" | undefined;
+        current: number;
+        total: number;
+    } | undefined;
+    transcodeError?: string | undefined;
+    failureReason?: "invalid_input" | "unsupported_codec" | "timeout" | "capacity" | "internal" | undefined;
+    retriable?: boolean | undefined;
+    playlistUrl?: string | undefined;
+    thumbnailKey?: string | undefined;
+    captionLocales?: string[] | undefined;
+    captionsPending?: boolean | undefined;
+    duration?: number | undefined;
+    renditions?: {
+        width?: number | undefined;
+        height?: number | undefined;
+        variant: string;
+        kind: "hls" | "mp4";
+        rung: string;
+        key: string;
+        url: string;
+    }[] | undefined;
+    posterUrls?: {
+        jpg?: string | undefined;
+        avif?: string | undefined;
+    } | undefined;
+    hasAudio?: boolean | undefined;
+    storyboardKey?: string | undefined;
+    type: "video" | "image" | "file";
+    key: string;
+    filename: string;
+    contentType: string;
+    sizeBytes: number;
+    createdAt: number;
+}>>>;
 export declare const upsertCaption: import("convex/server").RegisteredMutation<"public", {
     srtUrl?: string | undefined;
     mediaKey: string;

package/dist/component/public.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"public.d.ts","sourceRoot":"","sources":["../../src/component/public.ts"],"names":[],"mappings":"AAwCA,eAAO,MAAM,gBAAgB;;;;;GAU3B,CAAC;AAEH,eAAO,MAAM,eAAe;;;;wDAW1B,CAAC;AAEH,eAAO,MAAM,iBAAiB;;iBAM5B,CAAC;AAEH,eAAO,MAAM,WAAW;;;uDAUtB,CAAC;AAKH,eAAO,MAAM,mBAAmB;;iBAe9B,CAAC;AAEH,eAAO,MAAM,YAAY;;;;;wDAyEvB,CAAC;AAIH,eAAO,MAAM,YAAY;;iBAevB,CAAC;AAIH,eAAO,MAAM,sBAAsB;;iBAiBjC,CAAC;AAIH,eAAO,MAAM,mBAAmB;;iBAkB9B,CAAC;AAIH,eAAO,MAAM,WAAW;;;;;;uDAWtB,CAAC;AAEH,eAAO,MAAM,WAAW;;;;;;;;;;;;;;;iBAsCtB,CAAC;AAIH,eAAO,MAAM,aAAa;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;UAQxB,CAAC;AAEH,eAAO,MAAM,SAAS;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;KASpB,CAAC;AAIH,eAAO,MAAM,aAAa;;;;;0DAmBxB,CAAC;AAEH,eAAO,MAAM,mBAAmB;;;;;;;;;;KAQ9B,CAAC;AAWH,eAAO,MAAM,YAAY;;;;0DAgBvB,CAAC;AAEH,eAAO,MAAM,YAAY;;;;;;;;;;;;UAKvB,CAAC;AAEH,eAAO,MAAM,YAAY;;;0DAmBvB,CAAC;AAEH,eAAO,MAAM,aAAa;;;iBAQxB,CAAC;AAEH,eAAO,MAAM,iBAAiB;;;;;;;;;;;;aAK5B,CAAC;AAIH,eAAO,MAAM,kBAAkB;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBA6F7B,CAAC"}
+{"version":3,"file":"public.d.ts","sourceRoot":"","sources":["../../src/component/public.ts"],"names":[],"mappings":"AAmCA,eAAO,MAAM,gBAAgB;;;;;GAU3B,CAAC;AAEH,eAAO,MAAM,eAAe;;;;;;;;;;;;;;wDAoB1B,CAAC;AAEH,eAAO,MAAM,iBAAiB;;iBAQ5B,CAAC;AAEH,eAAO,MAAM,WAAW;;;uDAUtB,CAAC;AAKH,eAAO,MAAM,mBAAmB;;iBAe9B,CAAC;AAEH,eAAO,MAAM,YAAY;;;;;wDAyEvB,CAAC;AAIH,eAAO,MAAM,YAAY;;iBAevB,CAAC;AAIH,eAAO,MAAM,sBAAsB;;iBAiBjC,CAAC;AAIH,eAAO,MAAM,mBAAmB;;iBAkB9B,CAAC;AAIH,eAAO,MAAM,WAAW;;;;;;uDAiBtB,CAAC;AAEH,eAAO,MAAM,WAAW;;;;;;;;;;;;;;;iBAsCtB,CAAC;AAIH,eAAO,MAAM,aAAa;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;UAQxB,CAAC;AAGH,eAAO,MAAM,SAAS;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;KASpB,CAAC;AAEH,6FAA6F;AAC7F,eAAO,MAAM,aAAa;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IAYxB,CAAC;AAIH,eAAO,MAAM,aAAa;;;;;0DAmBxB,CAAC;AAEH,eAAO,MAAM,mBAAmB;;;;;;;;;;KAQ9B,CAAC;AAWH,eAAO,MAAM,YAAY;;;;0DAgBvB,CAAC;AAEH,eAAO,MAAM,YAAY;;;;;;;;;;;;UAKvB,CAAC;AAEH,eAAO,MAAM,YAAY;;;0DAmBvB,CAAC;AAEH,eAAO,MAAM,aAAa;;;iBAQxB,CAAC;AAEH,eAAO,MAAM,iBAAiB;;;;;;;;;;;;aAK5B,CAAC;AAIH,eAAO,MAAM,kBAAkB;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBA6F7B,CAAC"}