@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.
- package/README.md +26 -6
- package/dist/copy/types.d.ts +29 -2
- package/dist/index.js +1 -1
- package/dist/index.mjs +1 -1
- package/dist/player.js +1 -1
- package/dist/player.mjs +1 -1
- package/dist/server/media/client.d.ts +34 -1
- package/dist/server/media/protocol.d.ts +242 -4
- package/dist/server/r2/client.d.ts +18 -4
- package/dist/server/storage/chunked.d.ts +6 -2
- package/dist/server/storage/s3.d.ts +51 -0
- package/dist/server/testing/fake-r2.d.ts +22 -2
- package/dist/server/transfer/handler.d.ts +50 -0
- package/dist/server/transfer/protocol.d.ts +53 -4
- package/dist/server-media.js +1 -1
- package/dist/server-media.mjs +1 -1
- package/dist/server-testing.js +1 -1
- package/dist/server-testing.mjs +1 -1
- package/dist/server.js +1 -1
- package/dist/server.mjs +1 -1
- package/dist/transfer/client.d.ts +13 -2
- package/dist/transfer/engine.d.ts +22 -2
- 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 +1 -0
- package/dist/transfer/protocol.d.ts +5 -0
- package/dist/transfer/storage.d.ts +28 -3
- 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/package.json +51 -3
|
@@ -0,0 +1,86 @@
|
|
|
1
|
+
import { type ZipWorkerConfig } from "./config.mjs";
|
|
2
|
+
export type { ZipWorkerConfig } from "./config.mjs";
|
|
3
|
+
/** The part of R2's binding this uses (R2Bucket satisfies it). */
|
|
4
|
+
export interface ObjLike {
|
|
5
|
+
etag: string;
|
|
6
|
+
size: number;
|
|
7
|
+
/** Absent when an onlyIf condition failed (R2 returns the object's metadata only). */
|
|
8
|
+
body?: ReadableStream<Uint8Array>;
|
|
9
|
+
arrayBuffer?(): Promise<ArrayBuffer>;
|
|
10
|
+
}
|
|
11
|
+
export interface BucketLike {
|
|
12
|
+
get(key: string, opts?: {
|
|
13
|
+
range?: {
|
|
14
|
+
offset: number;
|
|
15
|
+
length: number;
|
|
16
|
+
};
|
|
17
|
+
onlyIf?: {
|
|
18
|
+
etagMatches: string;
|
|
19
|
+
};
|
|
20
|
+
}): Promise<ObjLike | null>;
|
|
21
|
+
head(key: string): Promise<{
|
|
22
|
+
etag: string;
|
|
23
|
+
size: number;
|
|
24
|
+
} | null>;
|
|
25
|
+
}
|
|
26
|
+
export interface Env {
|
|
27
|
+
BUCKET: BucketLike;
|
|
28
|
+
/** Shared with the product's site (≥ 32 characters). */
|
|
29
|
+
ZIP_SIGNING_KEY: string;
|
|
30
|
+
/** Prepended to every key read (a shared test bucket); "" or unset in production. */
|
|
31
|
+
KEY_PREFIX?: string;
|
|
32
|
+
}
|
|
33
|
+
export interface Options {
|
|
34
|
+
now?: () => number;
|
|
35
|
+
/** Make a fixed-length body stream (workerd: FixedLengthStream). Default: a TransformStream. */
|
|
36
|
+
fixedLength?: (n: number) => {
|
|
37
|
+
readable: ReadableStream<Uint8Array>;
|
|
38
|
+
writable: WritableStream<Uint8Array>;
|
|
39
|
+
};
|
|
40
|
+
/** Small-file read-ahead: at most this many reads in flight and bytes buffered. */
|
|
41
|
+
aheadReads?: number;
|
|
42
|
+
aheadBytes?: number;
|
|
43
|
+
/** A file piece up to this size is read whole into memory (read-ahead); bigger ones stream. */
|
|
44
|
+
smallPiece?: number;
|
|
45
|
+
/** For tests: how many times each R2 read is retried before the response is aborted. */
|
|
46
|
+
getRetries?: number;
|
|
47
|
+
/** How often a streaming response re-checks that its plan is still valid (default 30 s). */
|
|
48
|
+
planCheckMs?: number;
|
|
49
|
+
/**
|
|
50
|
+
* A file piece bigger than this is only started after the plan was re-checked: a big file of a deleted share never
|
|
51
|
+
* starts streaming on an older answer (DELETE-PLAN: before each file larger than 64 MB). Default 64 MiB.
|
|
52
|
+
*/
|
|
53
|
+
bigPiece?: number;
|
|
54
|
+
/**
|
|
55
|
+
* Another piece of the SAME big file within this long of its check doesn't check again (default 1 s). A different
|
|
56
|
+
* file is always checked (B1, round-1 review: a withdrawal in that second let the next big file start).
|
|
57
|
+
*/
|
|
58
|
+
freshMs?: number;
|
|
59
|
+
/** Hard limit on any one storage read (marker, plan, object headers); a timeout is a storage error (default 5 s). */
|
|
60
|
+
readTimeoutMs?: number;
|
|
61
|
+
}
|
|
62
|
+
/** A pinned object changed (412) or vanished (410) after the plan was made. */
|
|
63
|
+
export declare class PinError extends Error {
|
|
64
|
+
readonly status: 410 | 412;
|
|
65
|
+
readonly key: string;
|
|
66
|
+
constructor(status: 410 | 412, key: string);
|
|
67
|
+
}
|
|
68
|
+
/** What the cache may hold; with one cold load of a MAX_PLAN_BYTES plan on top it stays well inside 128 MB. */
|
|
69
|
+
export declare const CACHE_BYTES: number;
|
|
70
|
+
/** Content-Disposition for any name (RFC 6266 / 8187), with an ASCII fallback. */
|
|
71
|
+
export declare function disposition(name: string): string;
|
|
72
|
+
/**
|
|
73
|
+
* One `Range` header against a `length`-byte resource → [start, end) or "unsatisfiable", or null when the
|
|
74
|
+
* header should be ignored (absent, malformed, several ranges, not bytes): the whole thing as 200.
|
|
75
|
+
*/
|
|
76
|
+
export declare function parseRange(h: string | null, length: number): [number, number] | "unsatisfiable" | null;
|
|
77
|
+
/** A request handler with its own plan cache. */
|
|
78
|
+
export interface ZipHandler {
|
|
79
|
+
handle(req: Request, env: Env, opts?: Options): Promise<Response>;
|
|
80
|
+
/** Forget every cached plan (tests). */
|
|
81
|
+
clearPlanCache(): void;
|
|
82
|
+
/** Estimated bytes the plan cache holds. */
|
|
83
|
+
planCacheBytes(): number;
|
|
84
|
+
}
|
|
85
|
+
/** The Worker's request handling for one product (config). Keep one per isolate: it holds the plan cache. */
|
|
86
|
+
export declare function createZipHandler(cfg: ZipWorkerConfig): ZipHandler;
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* The workerd entry for a product's zip Worker: the R2 binding and FixedLengthStream (so responses carry
|
|
3
|
+
* Content-Length, and a browser shows real progress and can resume).
|
|
4
|
+
*
|
|
5
|
+
* export default createZipWorker(MY_CONFIG);
|
|
6
|
+
*/
|
|
7
|
+
import { type Env, type Options, type ZipHandler } from "./serve.mjs";
|
|
8
|
+
import type { ZipWorkerConfig } from "./config.mjs";
|
|
9
|
+
/** From a config, or from a handler made with createZipHandler (to share its plan cache with other callers). */
|
|
10
|
+
export declare function createZipWorker(cfg: ZipWorkerConfig | ZipHandler, opts?: Omit<Options, "fixedLength">): {
|
|
11
|
+
fetch(req: Request, env: Env): Promise<Response>;
|
|
12
|
+
};
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@uploadfilm/sdk",
|
|
3
|
-
"version": "0.
|
|
4
|
-
"description": "UploadFilm SDK: resumable verified transfers, a headless video player and embeds, React hooks,
|
|
3
|
+
"version": "0.2.0",
|
|
4
|
+
"description": "UploadFilm SDK: resumable verified transfers, a headless video player and embeds, React hooks, server helpers for R2 (presign, auth kit, media-worker jobs), and the media and zip Cloudflare Workers.",
|
|
5
5
|
"license": "UNLICENSED",
|
|
6
6
|
"author": "UploadFilm",
|
|
7
7
|
"main": "dist/index.js",
|
|
@@ -68,6 +68,31 @@
|
|
|
68
68
|
"import": "./dist/sync.mjs",
|
|
69
69
|
"require": "./dist/sync.js"
|
|
70
70
|
},
|
|
71
|
+
"./workers/media": {
|
|
72
|
+
"types": "./dist/workers/media/types/build/entry/index.d.mts",
|
|
73
|
+
"workerd": "./dist/workers/media/index.mjs",
|
|
74
|
+
"import": "./dist/workers/media/index.mjs",
|
|
75
|
+
"default": "./dist/workers/media/index.mjs"
|
|
76
|
+
},
|
|
77
|
+
"./workers/media/config": {
|
|
78
|
+
"types": "./dist/workers/media/types/build/entry/config.d.mts",
|
|
79
|
+
"import": "./dist/workers/media/config.mjs",
|
|
80
|
+
"default": "./dist/workers/media/config.mjs"
|
|
81
|
+
},
|
|
82
|
+
"./workers/media/runner": {
|
|
83
|
+
"types": "./dist/workers/media/types/build/entry/runner.d.mts",
|
|
84
|
+
"node": "./dist/workers/media/runner.mjs",
|
|
85
|
+
"import": "./dist/workers/media/runner.mjs",
|
|
86
|
+
"default": "./dist/workers/media/runner.mjs"
|
|
87
|
+
},
|
|
88
|
+
"./workers/media/container/Dockerfile": "./dist/workers/media/container/Dockerfile",
|
|
89
|
+
"./workers/media/container/runner.mjs": "./dist/workers/media/container/runner.mjs",
|
|
90
|
+
"./workers/zip": {
|
|
91
|
+
"types": "./dist/workers/zip/types/build/entry/index.d.mts",
|
|
92
|
+
"workerd": "./dist/workers/zip/index.mjs",
|
|
93
|
+
"import": "./dist/workers/zip/index.mjs",
|
|
94
|
+
"default": "./dist/workers/zip/index.mjs"
|
|
95
|
+
},
|
|
71
96
|
"./package.json": "./package.json"
|
|
72
97
|
},
|
|
73
98
|
"typesVersions": {
|
|
@@ -105,11 +130,26 @@
|
|
|
105
130
|
"sync": [
|
|
106
131
|
"./dist/sync/index.d.ts"
|
|
107
132
|
],
|
|
133
|
+
"workers/media": [
|
|
134
|
+
"./dist/workers/media/types/build/entry/index.d.mts"
|
|
135
|
+
],
|
|
136
|
+
"workers/media/config": [
|
|
137
|
+
"./dist/workers/media/types/build/entry/config.d.mts"
|
|
138
|
+
],
|
|
139
|
+
"workers/media/runner": [
|
|
140
|
+
"./dist/workers/media/types/build/entry/runner.d.mts"
|
|
141
|
+
],
|
|
142
|
+
"workers/zip": [
|
|
143
|
+
"./dist/workers/zip/types/build/entry/index.d.mts"
|
|
144
|
+
],
|
|
108
145
|
"*": [
|
|
109
146
|
"./dist/index.d.ts"
|
|
110
147
|
]
|
|
111
148
|
}
|
|
112
149
|
},
|
|
150
|
+
"bin": {
|
|
151
|
+
"uploadfilm-sdk": "dist/workers/cli.mjs"
|
|
152
|
+
},
|
|
113
153
|
"sideEffects": false,
|
|
114
154
|
"files": [
|
|
115
155
|
"dist",
|
|
@@ -122,6 +162,7 @@
|
|
|
122
162
|
"scripts": {
|
|
123
163
|
"build": "npm run clean && npm run build:bundle",
|
|
124
164
|
"build:bundle": "rollup -c rollup.config.mjs",
|
|
165
|
+
"build:workers": "node ../workers/build.mjs",
|
|
125
166
|
"build:embed": "node scripts/build-embed-script.mjs",
|
|
126
167
|
"build:watch": "rollup -c rollup.config.mjs --watch",
|
|
127
168
|
"clean": "rm -rf dist",
|
|
@@ -149,7 +190,10 @@
|
|
|
149
190
|
"hls",
|
|
150
191
|
"embed",
|
|
151
192
|
"sdk",
|
|
152
|
-
"typescript"
|
|
193
|
+
"typescript",
|
|
194
|
+
"cloudflare-workers",
|
|
195
|
+
"ffmpeg",
|
|
196
|
+
"zip"
|
|
153
197
|
],
|
|
154
198
|
"publishConfig": {
|
|
155
199
|
"access": "public"
|
|
@@ -195,6 +239,7 @@
|
|
|
195
239
|
"fast-xml-parser": "5.11.2"
|
|
196
240
|
},
|
|
197
241
|
"peerDependencies": {
|
|
242
|
+
"@cloudflare/containers": "^0.3.7",
|
|
198
243
|
"@cloudflare/workers-types": ">=4.0.0",
|
|
199
244
|
"@upstash/redis": ">=1.34.0",
|
|
200
245
|
"@videojs/react": ">=10.0.0",
|
|
@@ -205,6 +250,9 @@
|
|
|
205
250
|
"undici": ">=6.0.0"
|
|
206
251
|
},
|
|
207
252
|
"peerDependenciesMeta": {
|
|
253
|
+
"@cloudflare/containers": {
|
|
254
|
+
"optional": true
|
|
255
|
+
},
|
|
208
256
|
"@cloudflare/workers-types": {
|
|
209
257
|
"optional": true
|
|
210
258
|
},
|