@uploadfilm/sdk 0.0.0-stage → 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.
- package/LICENSE +4 -0
- package/README.md +529 -2
- package/dist/ai/embed.d.ts +58 -0
- package/dist/ai/fake.d.ts +41 -0
- package/dist/ai/http.d.ts +17 -0
- package/dist/ai/index.d.ts +27 -0
- package/dist/ai/languages.d.ts +2 -0
- package/dist/ai/ollama.d.ts +23 -0
- package/dist/ai/openaiCompatible.d.ts +54 -0
- package/dist/ai/passages.d.ts +28 -0
- package/dist/ai/transcribe.d.ts +84 -0
- package/dist/ai/types.d.ts +141 -0
- package/dist/ai/usage.d.ts +66 -0
- package/dist/ai/whisperJson.d.ts +15 -0
- package/dist/ai/workersAi.d.ts +56 -0
- package/dist/ai.js +1 -0
- package/dist/ai.mjs +1 -0
- package/dist/cards/files.d.ts +91 -0
- package/dist/cards/index.d.ts +15 -0
- package/dist/cards/layouts.d.ts +121 -0
- package/dist/cards/probe.d.ts +69 -0
- package/dist/cards/proxies.d.ts +70 -0
- package/dist/cards/select.d.ts +68 -0
- package/dist/cards/volumes.d.ts +170 -0
- package/dist/cards/xml.d.ts +80 -0
- package/dist/cards.js +1 -0
- package/dist/cards.mjs +1 -0
- package/dist/copy/checksums.d.ts +66 -0
- package/dist/copy/engine.d.ts +24 -0
- package/dist/copy/errors.d.ts +109 -0
- package/dist/copy/index.d.ts +15 -0
- package/dist/copy/steps.d.ts +28 -0
- package/dist/copy/sweep.d.ts +24 -0
- package/dist/copy/types.d.ts +363 -0
- package/dist/embed/player.js +2 -0
- package/dist/host/adapters.d.ts +107 -0
- package/dist/host/detect.d.ts +68 -0
- package/dist/host/encoders.d.ts +34 -0
- package/dist/host/environment.d.ts +53 -0
- package/dist/host/index.d.ts +20 -0
- package/dist/host/linux.d.ts +94 -0
- package/dist/host/mac.d.ts +47 -0
- package/dist/host/network.d.ts +54 -0
- package/dist/host/node.d.ts +13 -0
- package/dist/host/policy.d.ts +101 -0
- package/dist/host/tuner.d.ts +48 -0
- package/dist/host/types.d.ts +118 -0
- package/dist/host-node.js +1 -0
- package/dist/host-node.mjs +1 -0
- package/dist/host.js +1 -0
- package/dist/host.mjs +1 -0
- package/dist/images/index.d.ts +11 -0
- package/dist/images/settings.d.ts +43 -0
- package/dist/images/types.d.ts +83 -0
- package/dist/images/url.d.ts +65 -0
- package/dist/index.d.ts +16 -0
- package/dist/index.js +1 -0
- package/dist/index.mjs +1 -0
- package/dist/player/adapters/hlsjs.d.ts +28 -0
- package/dist/player/bandwidthMemory.d.ts +28 -0
- package/dist/player/captions/index.d.ts +55 -0
- package/dist/player/embed/code.d.ts +195 -0
- package/dist/player/embed/constants.d.ts +4 -0
- package/dist/player/embed/controller.d.ts +62 -0
- package/dist/player/embed/element.d.ts +32 -0
- package/dist/player/embed/frame.d.ts +65 -0
- package/dist/player/embed/global.d.ts +14 -0
- package/dist/player/embed/index.d.ts +15 -0
- package/dist/player/embed/loader.d.ts +1 -0
- package/dist/player/embed/oembed.d.ts +74 -0
- package/dist/player/embed/protocol.d.ts +64 -0
- package/dist/player/engine.d.ts +215 -0
- package/dist/player/index.d.ts +18 -0
- package/dist/player/start.d.ts +62 -0
- package/dist/player/store.d.ts +10 -0
- package/dist/player/storyboard/index.d.ts +161 -0
- package/dist/player/stream.d.ts +206 -0
- package/dist/player/tracks.d.ts +41 -0
- package/dist/player.js +1 -0
- package/dist/player.mjs +1 -0
- package/dist/proxies/args.d.ts +19 -0
- package/dist/proxies/budget.d.ts +57 -0
- package/dist/proxies/camera.d.ts +104 -0
- package/dist/proxies/formats.d.ts +36 -0
- package/dist/proxies/index.d.ts +18 -0
- package/dist/proxies/jobs.d.ts +98 -0
- package/dist/proxies/node.d.ts +32 -0
- package/dist/proxies/plan.d.ts +89 -0
- package/dist/proxies/probe.d.ts +39 -0
- package/dist/proxies/render.d.ts +104 -0
- package/dist/proxies/safety.d.ts +45 -0
- package/dist/proxies/types.d.ts +83 -0
- package/dist/proxies/upload.d.ts +14 -0
- package/dist/react/BigPlay.d.ts +26 -0
- package/dist/react/Player.d.ts +58 -0
- package/dist/react/embed/index.d.ts +45 -0
- package/dist/react/examples/CustomControls.d.ts +8 -0
- package/dist/react/images/Image.d.ts +16 -0
- package/dist/react/images/index.d.ts +4 -0
- package/dist/react/images/useImage.d.ts +47 -0
- package/dist/react/index.d.ts +17 -0
- package/dist/react/storyboard/index.d.ts +58 -0
- package/dist/react/theme.d.ts +37 -0
- package/dist/react/useAdapterErrors.d.ts +8 -0
- package/dist/react/usePlaybackStart.d.ts +18 -0
- package/dist/react/usePlayer.d.ts +28 -0
- package/dist/react/useReducedMotion.d.ts +2 -0
- package/dist/react/useTimedTrack.d.ts +22 -0
- package/dist/react.js +1 -0
- package/dist/react.mjs +1 -0
- package/dist/server/auth/apiKeys.d.ts +30 -0
- package/dist/server/auth/cache.d.ts +21 -0
- package/dist/server/auth/deviceTokens.d.ts +38 -0
- package/dist/server/auth/envelope.d.ts +15 -0
- package/dist/server/auth/grants.d.ts +76 -0
- package/dist/server/auth/index.d.ts +19 -0
- package/dist/server/auth/jwt.d.ts +65 -0
- package/dist/server/auth/keyring.d.ts +31 -0
- package/dist/server/auth/kv.d.ts +12 -0
- package/dist/server/auth/repository.d.ts +45 -0
- package/dist/server/auth/revocations.d.ts +21 -0
- package/dist/server/auth/scope.d.ts +4 -0
- package/dist/server/auth/serviceAuth.d.ts +24 -0
- package/dist/server/auth/signedUrls.d.ts +28 -0
- package/dist/server/embed/index.d.ts +36 -0
- package/dist/server/embed/lifecycle.d.ts +53 -0
- package/dist/server/embed/playerScript.d.ts +4 -0
- package/dist/server/images/index.d.ts +15 -0
- package/dist/server/images/job.d.ts +80 -0
- package/dist/server/images/layout.d.ts +24 -0
- package/dist/server/images/params.d.ts +90 -0
- package/dist/server/images/route.d.ts +101 -0
- package/dist/server/images/sign.d.ts +55 -0
- package/dist/server/index.d.ts +42 -0
- package/dist/server/media/client.d.ts +99 -0
- package/dist/server/media/frameCheck.d.ts +62 -0
- package/dist/server/media/index.d.ts +10 -0
- package/dist/server/media/protocol.d.ts +556 -0
- package/dist/server/media/storyboard.d.ts +144 -0
- package/dist/server/media/transcript.d.ts +143 -0
- package/dist/server/pipeline/index.d.ts +12 -0
- package/dist/server/pipeline/match.d.ts +10 -0
- package/dist/server/pipeline/pipeline.d.ts +182 -0
- package/dist/server/pipeline/queues.d.ts +108 -0
- package/dist/server/pipeline/sources.d.ts +54 -0
- package/dist/server/r2/client.d.ts +164 -0
- package/dist/server/r2/crc32.d.ts +24 -0
- package/dist/server/r2/encoding.d.ts +35 -0
- package/dist/server/r2/errors.d.ts +9 -0
- package/dist/server/r2/integrity.d.ts +25 -0
- package/dist/server/r2/parts.d.ts +46 -0
- package/dist/server/r2/sign.d.ts +47 -0
- package/dist/server/redis/index.d.ts +39 -0
- package/dist/server/state/memory.d.ts +18 -0
- package/dist/server/state/r2.d.ts +73 -0
- package/dist/server/state/types.d.ts +57 -0
- package/dist/server/storage/chunked.d.ts +25 -0
- package/dist/server/storage/index.d.ts +12 -0
- package/dist/server/storage/r2.d.ts +96 -0
- package/dist/server/storage/s3.d.ts +144 -0
- package/dist/server/testing/fake-r2.d.ts +410 -0
- package/dist/server/testing/index.d.ts +10 -0
- package/dist/server/testing/kv-contract.d.ts +14 -0
- package/dist/server/transfer/handler.d.ts +217 -0
- package/dist/server/transfer/keys.d.ts +45 -0
- package/dist/server/transfer/protocol.d.ts +190 -0
- package/dist/server/zip/client.d.ts +32 -0
- package/dist/server/zip/generations.d.ts +83 -0
- package/dist/server/zip/index.d.ts +12 -0
- package/dist/server/zip/planner.d.ts +94 -0
- package/dist/server/zip/sign.d.ts +22 -0
- package/dist/server-media.js +1 -0
- package/dist/server-media.mjs +1 -0
- package/dist/server-redis.js +1 -0
- package/dist/server-redis.mjs +1 -0
- package/dist/server-testing.js +1 -0
- package/dist/server-testing.mjs +1 -0
- package/dist/server.js +1 -0
- package/dist/server.mjs +1 -0
- package/dist/storage/browserFile.d.ts +19 -0
- package/dist/storage/index.d.ts +12 -0
- package/dist/storage/local.d.ts +9 -0
- package/dist/storage/presigned.d.ts +22 -0
- package/dist/sync/ffmpeg.d.ts +44 -0
- package/dist/sync/index.d.ts +17 -0
- package/dist/sync/match.d.ts +28 -0
- package/dist/sync/probe.d.ts +30 -0
- package/dist/sync/timecode.d.ts +50 -0
- package/dist/sync/transcript.d.ts +35 -0
- package/dist/sync/types.d.ts +172 -0
- package/dist/sync/waveform.d.ts +89 -0
- package/dist/sync.js +1 -0
- package/dist/sync.mjs +1 -0
- package/dist/transfer/claims.d.ts +41 -0
- package/dist/transfer/client.d.ts +267 -0
- package/dist/transfer/download.d.ts +192 -0
- package/dist/transfer/engine.d.ts +402 -0
- package/dist/transfer/errors.d.ts +50 -0
- package/dist/transfer/growing/bytes.d.ts +17 -0
- package/dist/transfer/growing/index.d.ts +12 -0
- package/dist/transfer/growing/parts.d.ts +157 -0
- package/dist/transfer/growing/retry.d.ts +38 -0
- package/dist/transfer/growing/store.d.ts +66 -0
- package/dist/transfer/growing/upload.d.ts +126 -0
- package/dist/transfer/index.d.ts +40 -0
- package/dist/transfer/integrity.d.ts +93 -0
- package/dist/transfer/limits.d.ts +34 -0
- package/dist/transfer/node.d.ts +63 -0
- package/dist/transfer/pool.d.ts +83 -0
- package/dist/transfer/protocol.d.ts +172 -0
- package/dist/transfer/signer.d.ts +29 -0
- package/dist/transfer/storage.d.ts +135 -0
- package/dist/transfer/timing.d.ts +132 -0
- package/dist/transfer/transports/electronNet.d.ts +62 -0
- package/dist/transfer/transports/fetch.d.ts +15 -0
- package/dist/transfer/transports/retryAfter.d.ts +12 -0
- package/dist/transfer/transports/undici.d.ts +72 -0
- package/dist/transfer/tuner.d.ts +56 -0
- package/dist/workers/cli.mjs +115 -0
- package/dist/workers/media/config.mjs +53 -0
- package/dist/workers/media/container/Dockerfile +19 -0
- package/dist/workers/media/container/FFMPEG.md +129 -0
- package/dist/workers/media/container/runner.mjs +2690 -0
- package/dist/workers/media/index.mjs +1011 -0
- package/dist/workers/media/init/config.ts +52 -0
- package/dist/workers/media/init/worker.ts +8 -0
- package/dist/workers/media/init/wrangler.toml +44 -0
- package/dist/workers/media/runner.mjs +2656 -0
- package/dist/workers/media/types/build/entry/config.d.mts +6 -0
- package/dist/workers/media/types/build/entry/index.d.mts +43 -0
- package/dist/workers/media/types/build/entry/program.d.mts +13 -0
- package/dist/workers/media/types/build/entry/runner.d.mts +12 -0
- package/dist/workers/media/types/build/entry/settings.d.mts +40 -0
- package/dist/workers/media/types/src/config.d.mts +135 -0
- package/dist/workers/media/types/src/jobs.d.mts +73 -0
- package/dist/workers/media/types/src/runner/container.d.mts +32 -0
- package/dist/workers/media/types/src/runner/ffmpeg.d.mts +227 -0
- package/dist/workers/media/types/src/runner/job.d.mts +107 -0
- package/dist/workers/media/types/src/runner/node.d.mts +71 -0
- package/dist/workers/media/types/src/runner/plugins.d.mts +45 -0
- package/dist/workers/media/types/src/serve.d.mts +107 -0
- package/dist/workers/media/types/src/steps/audio.d.mts +33 -0
- package/dist/workers/media/types/src/steps/edit.d.mts +62 -0
- package/dist/workers/media/types/src/steps/frameCheck.d.mts +44 -0
- package/dist/workers/media/types/src/steps/gate.d.mts +18 -0
- package/dist/workers/media/types/src/steps/paths.d.mts +1 -0
- package/dist/workers/media/types/src/steps/prep.d.mts +60 -0
- package/dist/workers/media/types/src/steps/render.d.mts +40 -0
- package/dist/workers/media/types/src/steps/runner.d.mts +30 -0
- package/dist/workers/media/types/src/steps/transcribe.d.mts +89 -0
- package/dist/workers/media/types/src/storyboard/index.d.mts +61 -0
- package/dist/workers/media/types/src/transcoder.d.mts +30 -0
- package/dist/workers/media/types/src/worker.d.mts +30 -0
- package/dist/workers/zip/index.mjs +589 -0
- package/dist/workers/zip/init/config.ts +22 -0
- package/dist/workers/zip/init/worker.ts +5 -0
- package/dist/workers/zip/init/wrangler.toml +25 -0
- package/dist/workers/zip/types/build/entry/index.d.mts +5 -0
- package/dist/workers/zip/types/src/config.d.mts +35 -0
- package/dist/workers/zip/types/src/serve.d.mts +86 -0
- package/dist/workers/zip/types/src/worker.d.mts +12 -0
- package/dist/zip/index.d.ts +13 -0
- package/dist/zip/layout.d.ts +129 -0
- package/dist/zip/names.d.ts +34 -0
- package/dist/zip/plan.d.ts +115 -0
- package/dist/zip/sw.d.ts +7 -0
- package/package.json +313 -4
|
@@ -0,0 +1,55 @@
|
|
|
1
|
+
import { type Keyring } from "../auth/keyring";
|
|
2
|
+
import type { ImageSource } from "../../images/types";
|
|
3
|
+
import { outputBox, type PolicyProblem, type ResolvedPolicy, type TransformParams, type TransformPolicy } from "./params";
|
|
4
|
+
export interface ImageSignerOptions {
|
|
5
|
+
keys: Keyring;
|
|
6
|
+
/** Where the route is mounted: an absolute URL ("https://img.example.com/img") or a path ("/img"). */
|
|
7
|
+
base: string;
|
|
8
|
+
/** Product domain tag, mixed into every MAC (two products sharing a secret still can't mint each other's URLs). */
|
|
9
|
+
domain: string;
|
|
10
|
+
policy?: TransformPolicy;
|
|
11
|
+
/** Which object keys may be transformed at all (checked when signing and when verifying). Default: any. */
|
|
12
|
+
keyAllowed?: (key: string) => boolean;
|
|
13
|
+
}
|
|
14
|
+
export type ImageUrlVerdict = {
|
|
15
|
+
ok: true;
|
|
16
|
+
key: string;
|
|
17
|
+
params: TransformParams;
|
|
18
|
+
canonical: string;
|
|
19
|
+
kid: string;
|
|
20
|
+
} | {
|
|
21
|
+
ok: false;
|
|
22
|
+
reason: "malformed" | "key" | "kid" | "signature" | "expired" | "policy";
|
|
23
|
+
problem?: PolicyProblem;
|
|
24
|
+
};
|
|
25
|
+
/** A preset name, or explicit params (format defaults to "auto"). */
|
|
26
|
+
export type ImagePresetArg = string | (Omit<TransformParams, "format"> & {
|
|
27
|
+
format?: TransformParams["format"];
|
|
28
|
+
});
|
|
29
|
+
export interface ImageSigner {
|
|
30
|
+
readonly policy: ResolvedPolicy;
|
|
31
|
+
/** Signed URL for one transform. Throws when the params are outside the policy or the key isn't allowed. */
|
|
32
|
+
url(key: string, preset: ImagePresetArg): Promise<string>;
|
|
33
|
+
/**
|
|
34
|
+
* An ImageSource for `<Image>` / `imageUrl`: signed URLs for each allowed width up to the image's own width, in
|
|
35
|
+
* each format (explicit formats, so `<picture>` can switch on type without relying on Vary: Accept).
|
|
36
|
+
*/
|
|
37
|
+
source(key: string, size: {
|
|
38
|
+
width: number;
|
|
39
|
+
height: number;
|
|
40
|
+
}, o?: {
|
|
41
|
+
widths?: readonly number[];
|
|
42
|
+
formats?: readonly ("avif" | "webp" | "jpeg" | "png")[];
|
|
43
|
+
colourHex?: string;
|
|
44
|
+
/** The image version (manifest.version): versioned URLs are cached immutably. */
|
|
45
|
+
version?: string;
|
|
46
|
+
}): Promise<ImageSource>;
|
|
47
|
+
/** Checks a request URL (absolute, or a path with optional query). */
|
|
48
|
+
verify(url: string | URL, o?: {
|
|
49
|
+
now?: number;
|
|
50
|
+
}): Promise<ImageUrlVerdict>;
|
|
51
|
+
}
|
|
52
|
+
/** Whether a key is safe to carry in a path: no empty, "." or ".." segments, no control characters or backslashes. */
|
|
53
|
+
export declare function isSafeImageKey(key: string): boolean;
|
|
54
|
+
export declare function imageSigner(o: ImageSignerOptions): ImageSigner;
|
|
55
|
+
export { outputBox };
|
|
@@ -0,0 +1,42 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* `@uploadfilm/sdk/server`: Node or Cloudflare Workers. R2 presign/multipart/integrity, the key-layout guard, the
|
|
3
|
+
* sign-batch handler (with authorize/quota/grant/dedupe hooks), and the state adapters (memory here; Redis in
|
|
4
|
+
* `@uploadfilm/sdk/server/redis`; both also fit the auth kit's KeyValueStore), and the media-worker protocol and job
|
|
5
|
+
* client (also on their own as `@uploadfilm/sdk/server/media`). RFC §2.4. Still to come: servePlayerScript(), the
|
|
6
|
+
* upload-completed pipeline.
|
|
7
|
+
*/
|
|
8
|
+
export declare const SDK_ENTRY: "server";
|
|
9
|
+
export { createR2Client, contentDisposition, COPY_PART, COPY_SINGLE_MAX, PRESIGN_MAX_SECONDS } from "./r2/client";
|
|
10
|
+
export type { R2Client, R2Config, PresignGetOptions, PresignPutOptions, SignedFetchOptions } from "./r2/client";
|
|
11
|
+
export { amzDate, assertHeaderValue, presignUrl, sha256Hex, signRequest, UnsignableHeaderError } from "./r2/sign";
|
|
12
|
+
export type { SignedRequest, SigningCredentials } from "./r2/sign";
|
|
13
|
+
export { assertSignableKey, bareEtag, canonicalQueryString, isWellFormed, objectPath, UnsignableKeyError, uriEncode, xmlEscape, xmlUnescape, } from "./r2/encoding";
|
|
14
|
+
export type { Query } from "./r2/encoding";
|
|
15
|
+
export { R2Error, expectOk } from "./r2/errors";
|
|
16
|
+
export { checkCompletion, MIB, partCount, partRange, partSizeFor, S3_MAX_OBJECT, S3_MAX_PART, S3_MAX_PARTS, S3_MIN_PART, } from "./r2/parts";
|
|
17
|
+
export type { CompletionProblem, PartPlanOptions } from "./r2/parts";
|
|
18
|
+
export { etagOfContentMd5, md5, multipartEtag, toBase64, toHex, verifyStored } from "./r2/integrity";
|
|
19
|
+
export type { Verdict } from "./r2/integrity";
|
|
20
|
+
export { crc32Combine, crc32CombineAll, crcHex, parseCrcHex } from "./r2/crc32";
|
|
21
|
+
export { createKeyGuard, keySegments } from "./transfer/keys";
|
|
22
|
+
export type { KeyGuardOptions, KeyLayout } from "./transfer/keys";
|
|
23
|
+
export { WRITE_OP_NAMES } from "./transfer/protocol";
|
|
24
|
+
export type { TransferOp, TransferOpName, TransferRequest, TransferResponse, TransferResult, } from "./transfer/protocol";
|
|
25
|
+
export { createSignHandler, MD5_B64 } from "./transfer/handler";
|
|
26
|
+
export type { CustomOp, GrantEntry, GuardOutcome, HandlerAnswer, ReserveOutcome, SignHandlerOptions, } from "./transfer/handler";
|
|
27
|
+
export { checkBy, checkTtl, checkValue, namespaced, StateError, ttlMsOf } from "./state/types";
|
|
28
|
+
export type { AtomicKeyValueStore, KeyValueStore, SetOptions, Ttl } from "./state/types";
|
|
29
|
+
export { createMemoryStore } from "./state/memory";
|
|
30
|
+
export type { MemoryStoreOptions } from "./state/memory";
|
|
31
|
+
export { createR2Store, r2BindingBackend, r2ClientBackend, r2KeyOf } from "./state/r2";
|
|
32
|
+
export type { R2BindingLike, R2KvBackend, R2StoreOptions } from "./state/r2";
|
|
33
|
+
export * from "./auth";
|
|
34
|
+
export { ifNoneMatchHits, PLAYER_SCRIPT, PLAYER_SCRIPT_CACHE_CONTROL, PLAYER_SCRIPT_CONTENT_TYPE, PLAYER_SCRIPT_PATH, PLAYER_SCRIPT_SHA256, playerScriptEtag, servePlayerScript, } from "./embed";
|
|
35
|
+
export type { ServePlayerScriptOptions } from "./embed";
|
|
36
|
+
export { EMBED_EDGE_REDIRECT_S, EMBED_ORPHAN_AFTER_MS, EMBED_RETIRE_SLACK_S, EMBED_SIGNED_URL_TTL_S, copiesToDelete, embedRedirect, retireGraceMs } from "./embed";
|
|
37
|
+
export type { EmbedCopy, RetireTiming } from "./embed";
|
|
38
|
+
export * from "./zip";
|
|
39
|
+
export * from "./media";
|
|
40
|
+
export * from "./images";
|
|
41
|
+
export * from "./storage";
|
|
42
|
+
export * from "./pipeline";
|
|
@@ -0,0 +1,99 @@
|
|
|
1
|
+
import { type DoneReport, type JobRequest, type StepSettings } from "./protocol";
|
|
2
|
+
export interface MediaJobClientOptions {
|
|
3
|
+
/** The media Worker's origin, e.g. https://media.example.com. */
|
|
4
|
+
url: string;
|
|
5
|
+
/** Shared with the Worker (≥ 32 characters). A function: read when used (env set after import). */
|
|
6
|
+
secret: string | (() => string);
|
|
7
|
+
/** HMAC domain of job requests, and of reports: one kind of signed message never passes as the other. */
|
|
8
|
+
jobDomain: string;
|
|
9
|
+
doneDomain: string;
|
|
10
|
+
/** Header the signature travels in. */
|
|
11
|
+
signatureHeader: string;
|
|
12
|
+
/** Per request. Default 30 s. */
|
|
13
|
+
timeoutMs?: number;
|
|
14
|
+
fetch?: typeof fetch;
|
|
15
|
+
/**
|
|
16
|
+
* Stamp every request with `issuedAt` (now, unix seconds) so the Worker can refuse a replay outside its window (O-3 in
|
|
17
|
+
* docs/platform/SECURITY.md). Off by default: the body stays byte for byte what it was. A Worker from before the stamp
|
|
18
|
+
* ignores it. A job that sets `issuedAt` itself is sent as given.
|
|
19
|
+
*/
|
|
20
|
+
issuedAt?: boolean;
|
|
21
|
+
/** Milliseconds clock for the stamp (tests). */
|
|
22
|
+
now?: () => number;
|
|
23
|
+
/**
|
|
24
|
+
* Cloudflare's "no container instance available" and "too many containers per second" (a burst of job starts, a
|
|
25
|
+
* container application still rolling out) are a busy moment, not a failure: the request is sent again after an
|
|
26
|
+
* exponential backoff with full jitter, within `timeoutMs` overall. Busy: a 429, a 503 with `Retry-After`, or a body
|
|
27
|
+
* naming Cloudflare's container capacity. `Retry-After` (seconds) is the floor of the next wait. Safe: the Worker
|
|
28
|
+
* runs one job per id and attempt, a repeat joins it. `false`: one try, as before. Default `{ tries: 5, baseMs: 500,
|
|
29
|
+
* maxMs: 8000 }`. Still busy after the last try: a MediaJobError with `busy: true` (the product's queue retries it later).
|
|
30
|
+
*/
|
|
31
|
+
busy?: false | {
|
|
32
|
+
tries?: number;
|
|
33
|
+
baseMs?: number;
|
|
34
|
+
maxMs?: number;
|
|
35
|
+
};
|
|
36
|
+
/**
|
|
37
|
+
* Space this client's requests at most this many per second (busy retries included), for a product with no queue in
|
|
38
|
+
* front of its job starts. Per client instance: make one client and reuse it. Off by default; with a queue, pace there
|
|
39
|
+
* (GUIDE.md: pace your job starts).
|
|
40
|
+
*/
|
|
41
|
+
maxStartsPerSecond?: number;
|
|
42
|
+
/**
|
|
43
|
+
* The Worker's step settings (its config's stepSettings), when it does renders: an edit list is checked against
|
|
44
|
+
* their render limits before it is sent. Default DEFAULT_RENDER's.
|
|
45
|
+
*/
|
|
46
|
+
stepSettings?: Pick<StepSettings, "render">;
|
|
47
|
+
/** Waits (tests). */
|
|
48
|
+
sleep?: (ms: number) => Promise<void>;
|
|
49
|
+
/** 0 ≤ x < 1, for the jitter (tests). */
|
|
50
|
+
random?: () => number;
|
|
51
|
+
}
|
|
52
|
+
export type ReportCheck = {
|
|
53
|
+
ok: true;
|
|
54
|
+
report: Partial<DoneReport> & Record<string, unknown>;
|
|
55
|
+
} | {
|
|
56
|
+
ok: false;
|
|
57
|
+
status: number;
|
|
58
|
+
body: string;
|
|
59
|
+
};
|
|
60
|
+
export interface MediaJobClient {
|
|
61
|
+
/** Ask the Worker for a job. Throws on anything but a 2xx (the caller records the failure and retries later). */
|
|
62
|
+
request(job: JobRequest): Promise<void>;
|
|
63
|
+
/**
|
|
64
|
+
* A report from the Worker: size, signature (constant time) and JSON checked. On failure, the status and body to
|
|
65
|
+
* answer with. The fields are the Worker's: check `id`, `attempt` and `prefix` against your own record.
|
|
66
|
+
*/
|
|
67
|
+
readReport(body: string, signature: string): Promise<ReportCheck>;
|
|
68
|
+
/** Sign a body as the Worker would (tests, and products running their own runner host). */
|
|
69
|
+
sign(domain: "job" | "done", body: string): Promise<string>;
|
|
70
|
+
}
|
|
71
|
+
/**
|
|
72
|
+
* A job request that failed. `reached`: the Worker answered (with `status`); false: it was never reached or didn't
|
|
73
|
+
* answer in time (network down, a deploy, DNS, the timeout), so the product shouldn't count it as a try (UploadFilm
|
|
74
|
+
* d5186f8: an unreachable Worker is re-queued in 5 min without using one up). The message is what it always was.
|
|
75
|
+
*/
|
|
76
|
+
export declare class MediaJobError extends Error {
|
|
77
|
+
readonly reached: boolean;
|
|
78
|
+
readonly status?: number;
|
|
79
|
+
readonly timedOut: boolean;
|
|
80
|
+
/** The Worker had no container to give (Cloudflare's capacity or start rate) through every try: retry later, not a try. */
|
|
81
|
+
readonly busy: boolean;
|
|
82
|
+
constructor(message: string, o: {
|
|
83
|
+
reached: boolean;
|
|
84
|
+
status?: number;
|
|
85
|
+
timedOut?: boolean;
|
|
86
|
+
busy?: boolean;
|
|
87
|
+
cause?: unknown;
|
|
88
|
+
});
|
|
89
|
+
}
|
|
90
|
+
/** Is this answer a busy moment (retry soon), not a refusal? (Exported for tests.) */
|
|
91
|
+
export declare function containerBusy(status: number, body: string, retryAfter: string | null): boolean;
|
|
92
|
+
export declare function mediaJobClient(o: MediaJobClientOptions): MediaJobClient;
|
|
93
|
+
/**
|
|
94
|
+
* A finished job's outputs, made with other settings than the site's (a container still on an older image during a
|
|
95
|
+
* rollout): refuse them (delete, ask again once the rollout is through), never serve them. `version`: the version the
|
|
96
|
+
* job is stamped with, jobVersion(ladder version, the job's steps, step settings version) (the ladder's own for a job
|
|
97
|
+
* without optional steps).
|
|
98
|
+
*/
|
|
99
|
+
export declare function refuseStale(report: Pick<DoneReport, "state" | "ladder">, version: string): boolean;
|
|
@@ -0,0 +1,62 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* The `frame-check` step: are the source's frames evenly spaced, with nothing missing, nothing repeated and nothing the
|
|
3
|
+
* decoder had to conceal? The container decodes the source once (the same decode as every other step), writes each
|
|
4
|
+
* decoded frame's timestamp (FFmpeg's framecrc of a 16×16 thumbnail, so nearly free) and collects the decoder's errors;
|
|
5
|
+
* its analysis (sdks/media-worker/src/runner/steps/frameCheck.ts) makes the small report stored as frame-check.json. A
|
|
6
|
+
* site reads it with readFrameCheck().
|
|
7
|
+
*
|
|
8
|
+
* What it can and cannot tell: a camera that drops a frame leaves a hole in the timestamps (a gap); a muxer or editor
|
|
9
|
+
* that writes two frames for one moment leaves a repeated timestamp (a duplicate); a frame earlier than the one before
|
|
10
|
+
* it is out of order; damage the decoder had to conceal shows up as decoder errors. Variable frame rate (phones) is
|
|
11
|
+
* reported as such: uneven spacing is then expected, so it isn't flagged frame by frame, only real gaps are.
|
|
12
|
+
*
|
|
13
|
+
* SELF-CONTAINED ON PURPOSE (like ./protocol.ts): no imports, erasable TypeScript only.
|
|
14
|
+
*/
|
|
15
|
+
export interface FrameCheckSettings {
|
|
16
|
+
/** A step this many times the usual frame interval (or more) is a gap: frames missing. */
|
|
17
|
+
gapFactor: number;
|
|
18
|
+
/** A frame is "evenly spaced" within this fraction of the usual interval. */
|
|
19
|
+
jitter: number;
|
|
20
|
+
/** Lines of decoder errors kept in the report. */
|
|
21
|
+
maxErrorLines: number;
|
|
22
|
+
}
|
|
23
|
+
export interface FrameGap {
|
|
24
|
+
/** Seconds: the last frame before the hole. */
|
|
25
|
+
at: number;
|
|
26
|
+
/** Seconds the hole lasts beyond one usual interval. */
|
|
27
|
+
seconds: number;
|
|
28
|
+
/** Frames that would have fit in it (rounded). */
|
|
29
|
+
missing: number;
|
|
30
|
+
}
|
|
31
|
+
export interface FrameCheckReport {
|
|
32
|
+
/** Report format. */
|
|
33
|
+
format: 1;
|
|
34
|
+
/** True when nothing below is wrong: no gaps, duplicates, out-of-order frames or decoder errors (and some frames). */
|
|
35
|
+
ok: boolean;
|
|
36
|
+
frames: number;
|
|
37
|
+
/** Seconds from the first frame to the end of the last. */
|
|
38
|
+
seconds: number;
|
|
39
|
+
/** The usual interval (median), seconds; 0 with fewer than two frames. */
|
|
40
|
+
interval: number;
|
|
41
|
+
/** 1 / interval, rounded to 3 decimals. */
|
|
42
|
+
fps: number;
|
|
43
|
+
/** Share of intervals within `jitter` of the usual one (1 = perfectly even). */
|
|
44
|
+
even: number;
|
|
45
|
+
/** Uneven by design (phones): less than 90 % of intervals are the usual one, and no gap explains it. */
|
|
46
|
+
variable: boolean;
|
|
47
|
+
gaps: FrameGap[];
|
|
48
|
+
/** How many gaps there are, and how many frames they miss (gaps lists the first 100). */
|
|
49
|
+
gapCount: number;
|
|
50
|
+
missingFrames: number;
|
|
51
|
+
/** Frames with the same timestamp as the one before (seconds of the first 100). */
|
|
52
|
+
duplicates: number[];
|
|
53
|
+
duplicateCount: number;
|
|
54
|
+
/** Frames earlier than the one before (seconds of the first 100). */
|
|
55
|
+
outOfOrder: number[];
|
|
56
|
+
outOfOrderCount: number;
|
|
57
|
+
/** Lines the decoder logged as errors (the first maxErrorLines) and how many there were. */
|
|
58
|
+
decodeErrors: string[];
|
|
59
|
+
decodeErrorCount: number;
|
|
60
|
+
}
|
|
61
|
+
/** A stored frame-check.json, checked: null when it isn't a report this version knows. */
|
|
62
|
+
export declare function readFrameCheck(json: string): FrameCheckReport | null;
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* `@uploadfilm/sdk/server/media`: the media worker's protocol (jobs, ladder settings, output names, reports) and the
|
|
3
|
+
* site's job client. The Worker itself is the deploy template in sdks/media-worker.
|
|
4
|
+
*/
|
|
5
|
+
export declare const SDK_ENTRY: "server/media";
|
|
6
|
+
export * from "./protocol";
|
|
7
|
+
export * from "./transcript";
|
|
8
|
+
export * from "./frameCheck";
|
|
9
|
+
export { MediaJobError, mediaJobClient, refuseStale, type MediaJobClient, type MediaJobClientOptions, type ReportCheck } from "./client";
|
|
10
|
+
export { DEFAULT_STORYBOARD_SETTINGS, STORYBOARD_DIR, STORYBOARD_INDEX, STORYBOARD_VTT, checkSettings as checkStoryboardSettings, isStoryboardIndex, planStoryboard, sheetCount as storyboardSheetCount, storyboardCues, storyboardDescriptor, storyboardFile, storyboardIndex, storyboardSettings, storyboardSheetName, storyboardVtt, type StoryboardCue, type StoryboardDescriptor, type StoryboardIndex, type StoryboardPlan, type StoryboardSettings, } from "./storyboard";
|