@uploadfilm/sdk 0.1.0 → 0.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (75) hide show
  1. package/README.md +26 -6
  2. package/dist/copy/types.d.ts +29 -2
  3. package/dist/index.js +1 -1
  4. package/dist/index.mjs +1 -1
  5. package/dist/player.js +1 -1
  6. package/dist/player.mjs +1 -1
  7. package/dist/server/media/client.d.ts +34 -1
  8. package/dist/server/media/protocol.d.ts +242 -4
  9. package/dist/server/r2/client.d.ts +18 -4
  10. package/dist/server/storage/chunked.d.ts +6 -2
  11. package/dist/server/storage/s3.d.ts +51 -0
  12. package/dist/server/testing/fake-r2.d.ts +22 -2
  13. package/dist/server/transfer/handler.d.ts +50 -0
  14. package/dist/server/transfer/protocol.d.ts +53 -4
  15. package/dist/server-media.js +1 -1
  16. package/dist/server-media.mjs +1 -1
  17. package/dist/server-testing.js +1 -1
  18. package/dist/server-testing.mjs +1 -1
  19. package/dist/server.js +1 -1
  20. package/dist/server.mjs +1 -1
  21. package/dist/transfer/client.d.ts +13 -2
  22. package/dist/transfer/engine.d.ts +22 -2
  23. package/dist/transfer/growing/bytes.d.ts +17 -0
  24. package/dist/transfer/growing/index.d.ts +12 -0
  25. package/dist/transfer/growing/parts.d.ts +157 -0
  26. package/dist/transfer/growing/retry.d.ts +38 -0
  27. package/dist/transfer/growing/store.d.ts +66 -0
  28. package/dist/transfer/growing/upload.d.ts +126 -0
  29. package/dist/transfer/index.d.ts +1 -0
  30. package/dist/transfer/protocol.d.ts +5 -0
  31. package/dist/transfer/storage.d.ts +28 -3
  32. package/dist/workers/cli.mjs +115 -0
  33. package/dist/workers/media/config.mjs +53 -0
  34. package/dist/workers/media/container/Dockerfile +19 -0
  35. package/dist/workers/media/container/FFMPEG.md +129 -0
  36. package/dist/workers/media/container/runner.mjs +2690 -0
  37. package/dist/workers/media/index.mjs +1011 -0
  38. package/dist/workers/media/init/config.ts +52 -0
  39. package/dist/workers/media/init/worker.ts +8 -0
  40. package/dist/workers/media/init/wrangler.toml +44 -0
  41. package/dist/workers/media/runner.mjs +2656 -0
  42. package/dist/workers/media/types/build/entry/config.d.mts +6 -0
  43. package/dist/workers/media/types/build/entry/index.d.mts +43 -0
  44. package/dist/workers/media/types/build/entry/program.d.mts +13 -0
  45. package/dist/workers/media/types/build/entry/runner.d.mts +12 -0
  46. package/dist/workers/media/types/build/entry/settings.d.mts +40 -0
  47. package/dist/workers/media/types/src/config.d.mts +135 -0
  48. package/dist/workers/media/types/src/jobs.d.mts +73 -0
  49. package/dist/workers/media/types/src/runner/container.d.mts +32 -0
  50. package/dist/workers/media/types/src/runner/ffmpeg.d.mts +227 -0
  51. package/dist/workers/media/types/src/runner/job.d.mts +107 -0
  52. package/dist/workers/media/types/src/runner/node.d.mts +71 -0
  53. package/dist/workers/media/types/src/runner/plugins.d.mts +45 -0
  54. package/dist/workers/media/types/src/serve.d.mts +107 -0
  55. package/dist/workers/media/types/src/steps/audio.d.mts +33 -0
  56. package/dist/workers/media/types/src/steps/edit.d.mts +62 -0
  57. package/dist/workers/media/types/src/steps/frameCheck.d.mts +44 -0
  58. package/dist/workers/media/types/src/steps/gate.d.mts +18 -0
  59. package/dist/workers/media/types/src/steps/paths.d.mts +1 -0
  60. package/dist/workers/media/types/src/steps/prep.d.mts +60 -0
  61. package/dist/workers/media/types/src/steps/render.d.mts +40 -0
  62. package/dist/workers/media/types/src/steps/runner.d.mts +30 -0
  63. package/dist/workers/media/types/src/steps/transcribe.d.mts +89 -0
  64. package/dist/workers/media/types/src/storyboard/index.d.mts +61 -0
  65. package/dist/workers/media/types/src/transcoder.d.mts +30 -0
  66. package/dist/workers/media/types/src/worker.d.mts +30 -0
  67. package/dist/workers/zip/index.mjs +589 -0
  68. package/dist/workers/zip/init/config.ts +22 -0
  69. package/dist/workers/zip/init/worker.ts +5 -0
  70. package/dist/workers/zip/init/wrangler.toml +25 -0
  71. package/dist/workers/zip/types/build/entry/index.d.mts +5 -0
  72. package/dist/workers/zip/types/src/config.d.mts +35 -0
  73. package/dist/workers/zip/types/src/serve.d.mts +86 -0
  74. package/dist/workers/zip/types/src/worker.d.mts +12 -0
  75. package/package.json +51 -3
@@ -0,0 +1,52 @@
1
+ /**
2
+ * YOUR media worker's configuration (written by `npx @uploadfilm/sdk init media-worker`). Edit what's marked EDIT.
3
+ * Nothing here is shared with another product at run time: your bucket, your secret, your callback, your policy.
4
+ */
5
+ import { grantSealer } from "@uploadfilm/sdk/server";
6
+ import { STEPS, ladderSettings, sourceHash, stepSettings } from "@uploadfilm/sdk/server/media";
7
+ import { DEFAULT_BINDINGS, DEFAULT_TIMING, type MediaWorkerConfig } from "@uploadfilm/sdk/workers/media/config";
8
+
9
+ /**
10
+ * The settings version: stamped on every output, and part of every output's name (so new settings make new outputs and
11
+ * never overwrite what viewers have cached). EDIT whenever the ladder below changes. The self-hosted runner's default
12
+ * (RUNNER_DEFAULT_VERSION in @uploadfilm/sdk/workers/media/runner) is this same value.
13
+ */
14
+ // 2: the format lab's runner fixes (F1–F11: HDR tone-mapped, interlaced deinterlaced, …).
15
+ export const VERSION = "360-720-1080/2";
16
+
17
+ /** Source keys a job may read: printable, no "..", no leading "/". EDIT to your own key layout. */
18
+ const SOURCE = /^(?!.*(?:^|\/)\.\.(?:\/|$))[A-Za-z0-9!_.*'()\/-]{1,1024}$/;
19
+
20
+ export const config = {
21
+ ladder: ladderSettings(VERSION),
22
+ steps: { default: ["ladder", "poster"], allowed: [...STEPS] },
23
+ // The optional steps (audio, transcript, frame-check) a job may ask for; jobs naming one are stamped
24
+ // "<VERSION>+<this version>". EDIT the version whenever these settings change. `transcript` needs the AI binding
25
+ // (wrangler.toml [ai]); without it a transcript job fails.
26
+ stepSettings: stepSettings("audio-vad-whisper/1"),
27
+ // The editor's steps (prep, render) are off: STEPS doesn't name them. To allow them, add
28
+ // "prep" / "render" to steps.allowed (or use ALL_STEPS), give their settings here (stepSettings(v, { prep, render }))
29
+ // and, for renders, where they go:
30
+ // render: { prefixFor: async (job) => `renders/${(await renderHash(job)).slice(0, 32)}/` },
31
+ maxSourceBytes: 6 * 1024 ** 3,
32
+ // A capped job (a preview of a camera original): 360/720/1080 at most, from a source up to 14 GB.
33
+ caps: { 1080: { variant: "cap1080", maxSourceBytes: 14 * 1024 ** 3 } },
34
+ layout: {
35
+ prefixFor: async (src, etag, variant) =>
36
+ SOURCE.test(src) && !src.startsWith("/") ? `media/${(await sourceHash(src, etag, [VERSION, variant].filter(Boolean).join("#"))).slice(0, 32)}/` : null,
37
+ idOf: (prefix) => prefix.split("/")[1],
38
+ },
39
+ etag: /^[0-9a-f]{32}(-\d{1,5})?$/,
40
+ // EDIT: your site's report endpoint. https only (http://localhost only with ALLOW_LOCAL_CALLBACK=1, for dev).
41
+ callbacks: /^https:\/\/example\.com\/api\/media\/done$|^http:\/\/(?:localhost|127\.0\.0\.1):\d{2,5}\/api\/media\/done$/,
42
+ hmac: { header: "x-media-sig", jobDomain: "media-job-1", doneDomain: "media-done-1" },
43
+ // EDIT the salt to name your product: grants never open across products even with the same secret.
44
+ grants: grantSealer({ salt: "media-worker-template", isValid: (g) => /^media\/[0-9a-f]{32}\/$/.test(g.prefix) && g.copy === undefined }),
45
+ bindings: DEFAULT_BINDINGS,
46
+ timing: DEFAULT_TIMING,
47
+ serve: { liveTtlMs: 30_000, maxAgeS: 6 * 3600, cacheHost: "media-cache.internal", steps: ["ladder", "poster", "storyboard"] },
48
+ maxPutBytes: 64 * 1024 * 1024,
49
+ // Optional: another speech-to-text model for the transcript step (default: Workers AI through the AI binding), built
50
+ // from the Worker's env so the key stays a Worker secret.
51
+ // transcriber: (env) => openAiCompatibleTranscriber({ baseUrl: "https://api.groq.com/openai/v1", model: "whisper-large-v3-turbo", apiKey: env.GROQ_API_KEY as string }),
52
+ } satisfies MediaWorkerConfig;
@@ -0,0 +1,8 @@
1
+ /** Your media Worker: viewers (GET /h/<grant>/<file>) and your site's jobs (POST /jobs). Settings: ./config.ts. */
2
+ import { createMediaWorker } from "@uploadfilm/sdk/workers/media";
3
+ import { config } from "./config";
4
+
5
+ export default createMediaWorker(config);
6
+ // The Durable Object (one container per job), configured by the call above, and the containers package's outbound
7
+ // proxy (the container reaches storage only through it). wrangler.toml names both classes' bindings.
8
+ export { Transcoder, ContainerProxy } from "@uploadfilm/sdk/workers/media";
@@ -0,0 +1,44 @@
1
+ # Your media Worker (written by `npx @uploadfilm/sdk init media-worker`). EDIT the name, the bucket and max_instances.
2
+ #
3
+ # npx wrangler secret put MEDIA_SECRET # the same value as your site's; ≥ 32 characters
4
+ # npx wrangler deploy # builds the container image from node_modules (Docker needed)
5
+ #
6
+ # 💸 Containers bill per running second, memory included. Keep max_instances low until you've watched real traffic, and
7
+ # set a Cloudflare budget alert before the first deploy (README: "Cost").
8
+ name = "my-media-worker"
9
+ main = "worker.ts"
10
+ compatibility_date = "2026-11-01"
11
+ compatibility_flags = ["nodejs_compat"]
12
+ workers_dev = true
13
+
14
+ [[containers]]
15
+ class_name = "Transcoder"
16
+ # The package's image: Node + pinned FFmpeg + the runner. Built from its own folder (no build context needed).
17
+ # A prebuilt image works too (README: "Prebuilt image").
18
+ image = "./node_modules/@uploadfilm/sdk/dist/workers/media/container/Dockerfile"
19
+ # 4 vCPU, 12 GiB, 20 GB disk: a 6 GB source and its ladder fit.
20
+ instance_type = "standard-4"
21
+ # A ceiling, not a reservation: containers start per job and are destroyed when it ends.
22
+ max_instances = 2
23
+
24
+ [[durable_objects.bindings]]
25
+ name = "TRANSCODER"
26
+ class_name = "Transcoder"
27
+
28
+ [[migrations]]
29
+ tag = "v1"
30
+ new_sqlite_classes = ["Transcoder"]
31
+
32
+ [[r2_buckets]]
33
+ binding = "BUCKET"
34
+ bucket_name = "my-media-bucket"
35
+
36
+ # Workers AI, only for the optional `transcript` step. Uncomment to allow transcript jobs.
37
+ # [ai]
38
+ # binding = "AI"
39
+
40
+ [vars]
41
+ KEY_PREFIX = ""
42
+ ALLOW_LOCAL_CALLBACK = "0"
43
+ # Kill switch: "1" answers 404 to every viewer request (players fall back to your MP4). Jobs keep running.
44
+ STREAM_PAUSED = "0"