@devultur/convex 1.0.1 → 1.0.2

package/README.md

@@ -49,6 +49,52 @@ function CoverUpload({ onSaved }) {
 }
 ```
 
+## Using a self-hosted Worker
+
+The component talks to any Worker built with `createWorker()` from
+[`@devultur/self-host`](https://github.com/devultur/devultur/tree/main/packages/self-host) (see the
+[self-host guide](https://github.com/devultur/devultur/blob/main/docs/guides/self-host.md)). It needs two values:
+
+| Convex env var | Value |
+| --- | --- |
+| `DEVULTUR_API_URL` | The Worker's origin, without a trailing slash, for example `https://media.example.com` |
+| `DEVULTUR_SECRET` | The Worker's `WORKER_AUTH_SECRET`, the same string you set with `wrangler secret put` |
+
+Declare both in your app and bind them to the component. Convex rejects `app.env.<NAME>` for a name that
+`defineApp()` doesn't declare:
+
+```typescript
+// convex/convex.config.ts
+import devultur from "@devultur/convex/convex.config";
+import { defineApp } from "convex/server";
+import { v } from "convex/values";
+
+const app = defineApp({ env: { DEVULTUR_SECRET: v.string(), DEVULTUR_API_URL: v.string() } });
+app.use(devultur, {
+  httpPrefix: "/devultur/",
+  env: { DEVULTUR_SECRET: app.env.DEVULTUR_SECRET, DEVULTUR_API_URL: app.env.DEVULTUR_API_URL },
+});
+
+export default app;
+```
+
+```bash
+npx convex env set DEVULTUR_API_URL https://media.example.com
+npx convex env set DEVULTUR_SECRET <the Worker's WORKER_AUTH_SECRET>
+```
+
+**Webhooks.** You don't configure anything else. `processVideo` sends the Worker a `callbackUrl` that points at
+the component's route, `<CONVEX_SITE_URL>/devultur/webhook`. The transcode runner reports to the Worker with
+`TRANSCODE_WEBHOOK_SECRET`. The Worker then forwards each event to the `callbackUrl` with
+`Authorization: Bearer <WORKER_AUTH_SECRET>`. The component accepts an event only when that bearer equals
+`DEVULTUR_SECRET`. If `DEVULTUR_SECRET` is wrong or missing, the component answers `401` to every event. Keep
+`TRANSCODE_WEBHOOK_SECRET` on the Worker only: the component never needs it.
+
+If you replace the Worker's `workerSecretAuth()` plugin with an auth plugin of your own, the Worker forwards
+webhooks with the `webhookCredential` your plugin sets in the request state (or `runnerCredential` when it sets
+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.
+
 ## 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

@@ -22,9 +22,10 @@ function patchConvexConfig() {
   const useLine = 'app.use(devultur, { httpPrefix: "/devultur/", env: { DEVULTUR_SECRET: app.env.DEVULTUR_SECRET, DEVULTUR_API_URL: app.env.DEVULTUR_API_URL } });';
   if (!existsSync(configPath)) {
     const content2 = `import { defineApp } from "convex/server";
+import { v } from "convex/values";
 ${importLine}
 
-const app = defineApp();
+const app = defineApp({ env: { DEVULTUR_SECRET: v.string(), DEVULTUR_API_URL: v.string() } });
 ${useLine}
 
 export default app;
@@ -54,6 +55,10 @@ ${content.slice(exportIndex)}`;
   }
   writeFileSync(configPath, content);
   log("\u2705 Patched convex/convex.config.ts with devultur component");
+  if (!/DEVULTUR_SECRET:\s*v\./.test(content)) {
+    log("\u26A0\uFE0F  Declare the env vars it binds in defineApp(), or Convex rejects the config:");
+    log("   defineApp({ env: { DEVULTUR_SECRET: v.string(), DEVULTUR_API_URL: v.string() } })");
+  }
 }
 function createDevulturModule() {
   const modulePath = join(CONVEX_DIR, "devultur.ts");

package/dist/validators.d.ts

@@ -19,13 +19,13 @@ declare const dv: {
         kind: DevulturKind;
         visibility: "public" | "private";
     }, {
-        kind: convex_values.VLiteral<DevulturKind, "required"> | convex_values.VUnion<"image" | "video" | "file", [convex_values.VLiteral<"image", "required">, convex_values.VLiteral<"video", "required">, convex_values.VLiteral<"file", "required">], "required", never>;
+        kind: convex_values.VLiteral<DevulturKind, "required"> | convex_values.VUnion<"video" | "image" | "file", [convex_values.VLiteral<"image", "required">, convex_values.VLiteral<"video", "required">, convex_values.VLiteral<"file", "required">], "required", never>;
         id: convex_values.VString<string, "required">;
         visibility: convex_values.VUnion<"public" | "private", [convex_values.VLiteral<"public", "required">, convex_values.VLiteral<"private", "required">], "required", never>;
         filename: convex_values.VString<string | undefined, "optional">;
         width: convex_values.VFloat64<number | undefined, "optional">;
         height: convex_values.VFloat64<number | undefined, "optional">;
-    }, "required", "id" | "kind" | "visibility" | "filename" | "width" | "height">;
+    }, "required", "filename" | "id" | "kind" | "visibility" | "width" | "height">;
 };
 
 export { dv };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@devultur/convex",
-  "version": "1.0.1",
+  "version": "1.0.2",
   "description": "Convex component for Devultur media: media records, uploads, transcodes, watch progress and React bindings",
   "keywords": [
     "convex",
@@ -51,8 +51,8 @@
     "dist"
   ],
   "dependencies": {
-    "@devultur/react": "1.0.1",
-    "@devultur/core": "1.0.1"
+    "@devultur/core": "1.0.2",
+    "@devultur/react": "1.0.2"
   },
   "peerDependencies": {
     "convex": ">=1.25.0",