@hostr/upload 0.2.0 → 0.4.0

package/README.md

@@ -75,6 +75,11 @@ upload.start();
 const { etag, sha256 } = await upload.done;
 ```
 
+`createUploadSession` also takes `audio` (`'asmr'` or the knobs) and, from
+0.3.0, `captions` — `{ language?: 'auto' | bcp47, translate?: string[], context?: string }`
+— which has hostr transcribe and translate the video once its audio exists
+(the account must have captions enabled; see the captions guide).
+
 `infra/scripts/test-upload.mjs` is the canonical example — it drives the SDK
 through a kill/resume cycle and a corrupted-part self-heal against a real API
 and real R2.

package/dist/api/client.d.ts

@@ -29,6 +29,12 @@ export type CreateResult = {
     expectedParts: number;
     key: string;
 };
+/** `createUploadSession`'s result: the API's response plus the `endpoint` it
+ *  was minted against, because the token is only valid there and the client
+ *  must take the endpoint from this response, not from its own config. */
+export type UploadSession = CreateResult & {
+    endpoint: string;
+};
 export type CompleteResult = {
     status: string;
     etag?: string;
@@ -63,6 +69,21 @@ export type UploadAudioOptions = 'asmr' | {
     truePeakDbtp?: number;
     kbps?: number;
 };
+/**
+ * Per-asset captions for `POST /v1/uploads`: hostr transcribes the audio as
+ * soon as it exists, attaches it as a `<Language> (auto)` subtitle track, and
+ * translates it into each `translate` language as `(auto-translated)` tracks.
+ * Needs captions enabled on the account (the request is refused with
+ * `403 captions_not_enabled` otherwise). Watch for `captions.ready` per track.
+ */
+export type UploadCaptionsOptions = {
+    /** `'auto'` (the default) to detect, or the BCP 47 tag the speech is in. */
+    language?: string;
+    /** Target BCP 47 tags, at most 10. A target in the spoken language is dropped. */
+    translate?: string[];
+    /** Up to 1000 characters of context for the transcriber: creator, title, terms. */
+    context?: string;
+};
 export declare function createUploadSession(opts: {
     endpoint: string;
     apiKey: string;
@@ -71,8 +92,11 @@ export declare function createUploadSession(opts: {
     size: number;
     partSize?: number;
     tokenTtlSec?: number;
+    /** Allow Hostr to finalize validated parts without a client callback. */
+    autoComplete?: boolean;
     audio?: UploadAudioOptions;
-}, fetchFn?: typeof fetch): Promise<CreateResult>;
+    captions?: UploadCaptionsOptions;
+}, fetchFn?: typeof fetch): Promise<UploadSession>;
 export declare function mintUploadToken(opts: {
     endpoint: string;
     apiKey: string;

package/dist/browser.js

@@ -97,7 +97,8 @@ var HostrApi = class {
 };
 async function createUploadSession(opts, fetchFn = fetch) {
   const { endpoint, apiKey, ...body } = opts;
-  return req(fetchFn, endpoint, apiKey, "/v1/uploads", { method: "POST", body });
+  const created = await req(fetchFn, endpoint, apiKey, "/v1/uploads", { method: "POST", body });
+  return { ...created, endpoint };
 }
 function mintUploadToken(opts, fetchFn = fetch) {
   const { endpoint, apiKey, assetId, tokenTtlSec } = opts;

package/dist/index.d.ts

@@ -1,6 +1,6 @@
 export type * from './core/types.js';
 export { ApiError, NetworkError, HostrApi, createUploadSession, mintUploadToken, } from './api/client.js';
-export type { RemotePart, RemoteUpload, CreateResult, CompleteResult, UploadAudioOptions } from './api/client.js';
+export type { RemotePart, RemoteUpload, CreateResult, UploadSession, CompleteResult, UploadAudioOptions, UploadCaptionsOptions } from './api/client.js';
 export { storageKey, loadSession, saveSession, clearSession, partSizeOf, memoryStore, } from './core/session.js';
 export type { SessionStatus, SessionRecord } from './core/session.js';
 export { classifyPut, classifyApi, backoffMs, RETRY_BUDGET } from './core/retry.js';

package/dist/index.js

@@ -71,7 +71,8 @@ var HostrApi = class {
 };
 async function createUploadSession(opts, fetchFn = fetch) {
   const { endpoint, apiKey, ...body } = opts;
-  return req(fetchFn, endpoint, apiKey, "/v1/uploads", { method: "POST", body });
+  const created = await req(fetchFn, endpoint, apiKey, "/v1/uploads", { method: "POST", body });
+  return { ...created, endpoint };
 }
 function mintUploadToken(opts, fetchFn = fetch) {
   const { endpoint, apiKey, assetId, tokenTtlSec } = opts;

package/dist/node.js

@@ -102,7 +102,8 @@ var HostrApi = class {
 };
 async function createUploadSession(opts, fetchFn = fetch) {
   const { endpoint, apiKey, ...body } = opts;
-  return req(fetchFn, endpoint, apiKey, "/v1/uploads", { method: "POST", body });
+  const created = await req(fetchFn, endpoint, apiKey, "/v1/uploads", { method: "POST", body });
+  return { ...created, endpoint };
 }
 function mintUploadToken(opts, fetchFn = fetch) {
   const { endpoint, apiKey, assetId, tokenTtlSec } = opts;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hostr/upload",
-  "version": "0.2.0",
+  "version": "0.4.0",
   "type": "module",
   "license": "MIT",
   "sideEffects": false,