@omelhorsite/sdk 0.4.1 → 0.4.2

package/dist/index.js

@@ -12560,11 +12560,9 @@ function songImportProgress(record) {
 
 class MusicImportsNamespace extends Resource {
   spotify;
-  srMachine;
   constructor(http) {
     super(http);
     this.spotify = new SpotifySyncNamespace(http);
-    this.srMachine = new SRMachineNamespace(http);
   }
   async list(params = {}, options = {}) {
     const base = {
@@ -12658,48 +12656,6 @@ class SpotifySyncNamespace extends Resource {
     };
   }
 }
-
-class SRMachineNamespace extends Resource {
-  async metadata(url, options = {}) {
-    return this.http.get("/s_r_machine/metadata", {
-      timeoutMs: 120000,
-      ...options,
-      query: { url },
-      retry: options.retry ?? false
-    });
-  }
-  async artwork(url, options = {}) {
-    return this.http.download("/s_r_machine/artwork", {
-      timeoutMs: 120000,
-      ...options,
-      query: { url },
-      retry: options.retry ?? false
-    });
-  }
-  async audio(url, options = {}) {
-    return this.http.download("/s_r_machine/audio", {
-      timeoutMs: 600000,
-      ...options,
-      query: { url },
-      retry: options.retry ?? false
-    });
-  }
-  async convertToOpus(file2, options = {}) {
-    const form = await buildFormData({ file: file2 });
-    const response = await this.http.raw("POST", "/s_r_machine/convert-opus", {
-      timeoutMs: 600000,
-      ...options,
-      body: form
-    });
-    const data = await response.blob();
-    return {
-      data,
-      filename: filenameFromDisposition(response.headers.get("content-disposition")),
-      contentType: response.headers.get("content-type") ?? undefined,
-      size: data.size
-    };
-  }
-}
 function spotifySyncProgress(status) {
   const playlists = status.sync_progress?.playlists ?? [];
   let loaded = 0;
@@ -14818,23 +14774,29 @@ class CaptionsNamespace extends Resource {
     return this.http.get(`/caption_jobs/${encodeURIComponent(id)}`, options);
   }
   async transcribe(id, input, options = {}) {
-    const started = await this.http.post(`/caption_jobs/${encodeURIComponent(id)}/transcribe`, {
+    const started = await this.startTranscribe(id, input, options);
+    return this.settle(id, started, options, "the transcription");
+  }
+  async startTranscribe(id, input, options = {}) {
+    return this.http.post(`/caption_jobs/${encodeURIComponent(id)}/transcribe`, {
       start: input.start,
       end: input.end,
       ...input.language === undefined ? {} : { language: input.language }
     }, { ...options, retry: options.retry ?? false });
-    return this.settle(id, started, options, "the transcription");
   }
   async render(id, input = {}, options = {}) {
+    const started = await this.startRender(id, input, options);
+    return this.settle(id, started, options, "the render");
+  }
+  async startRender(id, input = {}, options = {}) {
     const words = input.words ?? (await this.get(id, options)).words ?? [];
     if (words.length === 0) {
       throw new OmsError(`Caption job ${id} has no words to render. Transcribe a window first with transcribe(), ` + `or pass an edited list as \`words\`.`, "conflict");
     }
-    const started = await this.http.post(`/caption_jobs/${encodeURIComponent(id)}/render`, {
+    return this.http.post(`/caption_jobs/${encodeURIComponent(id)}/render`, {
       words,
       ...input.style === undefined ? {} : { style: input.style }
     }, { ...options, retry: options.retry ?? false });
-    return this.settle(id, started, options, "the render");
   }
   async delete(id, options = {}) {
     await this.http.delete(`/caption_jobs/${encodeURIComponent(id)}`, options);
@@ -15136,6 +15098,49 @@ class UpscaleNamespace extends Resource {
   }
 }
 
+// src/resources/tools/srMachine.ts
+class SRMachineNamespace extends Resource {
+  async metadata(url, options = {}) {
+    return this.http.get("/s_r_machine/metadata", {
+      timeoutMs: 120000,
+      ...options,
+      query: { url },
+      retry: options.retry ?? false
+    });
+  }
+  async artwork(url, options = {}) {
+    return this.http.download("/s_r_machine/artwork", {
+      timeoutMs: 120000,
+      ...options,
+      query: { url },
+      retry: options.retry ?? false
+    });
+  }
+  async audio(url, options = {}) {
+    return this.http.download("/s_r_machine/audio", {
+      timeoutMs: 600000,
+      ...options,
+      query: { url },
+      retry: options.retry ?? false
+    });
+  }
+  async convertToOpus(file2, options = {}) {
+    const form = await buildFormData({ file: file2 });
+    const response = await this.http.raw("POST", "/s_r_machine/convert-opus", {
+      timeoutMs: 600000,
+      ...options,
+      body: form
+    });
+    const data = await response.blob();
+    return {
+      data,
+      filename: filenameFromDisposition(response.headers.get("content-disposition")),
+      contentType: response.headers.get("content-type") ?? undefined,
+      size: data.size
+    };
+  }
+}
+
 // src/resources/tools/vocalSeparation.ts
 function vocalSeparationProgress(record) {
   const base = toolProgress(record);
@@ -15267,6 +15272,7 @@ class ToolsNamespace extends Resource {
   captions;
   jumpstyle;
   downloader;
+  srMachine;
   constructor(http) {
     super(http);
     this.backgroundRemoval = new BackgroundRemovalNamespace(http);
@@ -15276,6 +15282,7 @@ class ToolsNamespace extends Resource {
     this.captions = new CaptionsNamespace(http);
     this.jumpstyle = new JumpstyleNamespace(http);
     this.downloader = new DownloaderNamespace(http);
+    this.srMachine = new SRMachineNamespace(http);
   }
 }
 

package/dist/types/resources/music/imports.d.ts

@@ -10,7 +10,6 @@
  * | `/song_imports` | one track, downloaded from a URL or found by search | any signed-in user |
  * | `/playlist_imports/preview` | read a playlist URL without importing it | any signed-in user |
  * | `/spotify_syncs/*` | mirror a Spotify account into playlists | Spotify-enabled accounts only |
- * | `/s_r_machine/*` | raw fetch + transcode helpers | **admins only** |
  *
  * ## An import is not a `Job`
  *
@@ -48,7 +47,7 @@
  */
 import { type ApiClient, Resource } from "../../http";
 import type { ListParams } from "../../listing";
-import type { BaseRecord, FileInput, FileOutput, Id, NativeFile, Paginated, Progress, RequestOptions, Timestamp, WaitOptions } from "../../types";
+import type { BaseRecord, Id, Paginated, Progress, RequestOptions, Timestamp, WaitOptions } from "../../types";
 import type { DownloaderPreview } from "../tools/downloader";
 /**
  * Primary key of a song import. An **integer**, like `songs` and `playlists`
@@ -314,8 +313,6 @@ export declare function songImportProgress(record: SongImport): Progress;
 export declare class MusicImportsNamespace extends Resource {
     /** Spotify account mirroring. Spotify-enabled accounts only - see the class. */
     readonly spotify: SpotifySyncNamespace;
-    /** Admin-only fetch and transcode helpers. */
-    readonly srMachine: SRMachineNamespace;
     constructor(http: ApiClient);
     /**
      * `GET /song_imports` - your import history, newest first only if you ask.
@@ -788,117 +785,6 @@ export declare class SpotifySyncNamespace extends Resource {
     /** The one description of "watching a sync", shared by the two watchers. */
     private syncPollPlan;
 }
-/** What `GET /s_r_machine/metadata` answers. Two keys, both nullable. */
-export interface SRMachineMetadata {
-    readonly title: string | null;
-    readonly artist: string | null;
-}
-/**
- * The SR Machine helpers, reachable as `oms.music.imports.srMachine`.
- *
- * ## Admin only, and the check is blunt
- *
- * Every route answers `403 "You SHALL NOT use this resource"` to anyone who is
- * not an administrator. There is no allowlist, no scope and no per-user
- * quota.
- *
- * ## What it is
- *
- * Four unrelated primitives left over from the "slowed + reverb" video tool:
- * fetch the artwork behind a URL, fetch its audio, read its title and artist,
- * and transcode an arbitrary audio blob to Opus. Nothing here touches the
- * library - no song is created, nothing is stored, and the bytes come back in
- * the response body. If you want a track IN the library, use
- * {@link MusicImportsNamespace.create} instead; this is the raw pipe.
- *
- * Three of the four fetch a caller-supplied URL and hold a server thread while
- * they do it, exactly like {@link MusicImportsNamespace.previewPlaylist} - but
- * they have no budget of their own, so the only ceiling is the general
- * 600/min. The admin gate is what stands in for a budget here. Do not build a
- * batch loop on top of these.
- *
- * A YouTube URL carrying `?list=` is truncated at the `?list=` before the fetch,
- * so a link copied from inside a playlist resolves to the single video rather
- * than the playlist. That happens server-side, in all three fetchers.
- *
- * All three fetchers respond with `Content-Disposition: attachment` and a
- * fixed filename (`artwork.jpg`, `audio.opus`), so `FileOutput.filename` is
- * that constant rather than anything derived from the source.
- */
-export declare class SRMachineNamespace extends Resource {
-    /**
-     * `GET /s_r_machine/metadata` - the title and artist read off a URL.
-     *
-     * Both keys can be `null` for a source that carries no tags; it is a
-     * best-effort read, not a lookup.
-     *
-     * Not retried by default: it parks a server thread for up to 60 seconds,
-     * and a failure means the source refused.
-     *
-     * @throws {OmsAuthError} 403 `"You SHALL NOT use this resource"` for a
-     *   non-admin.
-     * @throws {OmsApiError} 400 `"url is not allowed"` for a URL that is not
-     *   public http(s); 500 when the fetch itself fails - an upstream failure
-     *   surfaces as a server error here, not as a 502.
-     */
-    metadata(url: string, options?: RequestOptions): Promise<SRMachineMetadata>;
-    /**
-     * `GET /s_r_machine/artwork` - the cover behind a URL, as `image/jpeg`.
-     *
-     * Buffered fully into memory in every runtime, React Native included. It is a
-     * cover, so that is fine; {@link SRMachineNamespace.audio} is where it is not.
-     *
-     * @throws {OmsAuthError} 403 for a non-admin.
-     * @throws {OmsApiError} 400 `"url is not allowed"`; 500 on a fetch failure.
-     */
-    artwork(url: string, options?: RequestOptions): Promise<FileOutput>;
-    /**
-     * `GET /s_r_machine/audio` - the audio behind a URL, as `audio/opus`.
-     *
-     * The whole track is downloaded server-side, held in memory there, and sent
-     * back in one body which this then buffers into memory again on the client.
-     * Nothing streams. On a phone that is a whole track in the JavaScript heap,
-     * and there is no signed-URL alternative here the way there is for library
-     * media - this endpoint has no storage node behind it. Reach for it on
-     * desktop, think twice on React Native, and never for a batch.
-     *
-     * Generous `timeoutMs` by default because a long track legitimately takes
-     * minutes.
-     *
-     * @throws {OmsAuthError} 403 for a non-admin.
-     * @throws {OmsApiError} 400 `"url is not allowed"`; 500 on a fetch failure.
-     */
-    audio(url: string, options?: RequestOptions): Promise<FileOutput>;
-    /**
-     * `POST /s_r_machine/convert-opus` - transcode an audio file to Opus.
-     *
-     * Multipart, field name `file`, and the only method in this namespace that
-     * uploads. The response is `audio/opus` bytes, not JSON.
-     *
-     * Works on all three runtimes: a React Native `{ uri, name, type }` descriptor
-     * goes into the `FormData` verbatim and is streamed off disk by the native
-     * layer, while a browser or Bun caller passes a `FileInput` carrying a Blob
-     * or a `Uint8Array`. A `ReadableStream` is buffered first, because
-     * `FormData` has no streaming entry.
-     *
-     * The upload has no client-side size cap here because the server declares
-     * none - but the CDN in front of the API rejects a request body over roughly
-     * 100 MB with a 413 that never reaches it. There is no chunked path for this
-     * route, so a file above that simply cannot go through it.
-     *
-     * The server reads the whole part into memory before transcoding, so a large
-     * input is a large allocation on both sides.
-     *
-     * @throws {OmsAuthError} 403 `"You SHALL NOT use this resource"` for a
-     *   non-admin.
-     * @throws {OmsApiError} 500 when no `file` part was sent or when the input
-     *   cannot be transcoded. Neither is a graceful 400.
-     * @throws {TypeError} when a React Native descriptor is passed on a runtime
-     *   whose `FormData` is the web one, which would otherwise upload the literal
-     *   text `"[object Object]"` and answer 500.
-     */
-    convertToOpus(file: FileInput | NativeFile, options?: RequestOptions): Promise<FileOutput>;
-}
 /**
  * Renders a sync run as the SDK's shared {@link Progress}.
  *

package/dist/types/resources/tools/captions.d.ts

@@ -506,6 +506,13 @@ export declare class CaptionsNamespace extends Resource {
      *   quota is spent either way and the words still land on the row.
      */
     transcribe(id: Id, input: TranscribeCaptionInput, options?: ToolRunOptions): Promise<CaptionJob>;
+    /**
+     * `POST /caption_jobs/:id/transcribe` without waiting: answers the row as
+     * soon as it is `"transcribing"`. For a screen that polls {@link get} itself
+     * and shows progress meanwhile. Same errors as {@link transcribe}, minus the
+     * timeouts.
+     */
+    startTranscribe(id: Id, input: TranscribeCaptionInput, options?: RequestOptions): Promise<CaptionJob>;
     /**
      * `POST /caption_jobs/:id/render` - step 3.
      *
@@ -532,6 +539,12 @@ export declare class CaptionsNamespace extends Resource {
      *   `code: "aborted"` when the signal fires. Neither cancels the render.
      */
     render(id: Id, input?: RenderCaptionInput, options?: ToolRunOptions): Promise<CaptionJob>;
+    /**
+     * `POST /caption_jobs/:id/render` without waiting: answers the row as soon
+     * as it is `"rendering"`. Same word handling and errors as {@link render},
+     * minus the timeouts.
+     */
+    startRender(id: Id, input?: RenderCaptionInput, options?: RequestOptions): Promise<CaptionJob>;
     /**
      * `DELETE /caption_jobs/:id` - drops the job and its uploaded video.
      *

package/dist/types/resources/tools/index.d.ts

@@ -40,6 +40,7 @@ import { DownloaderNamespace } from "./downloader";
 import { JumpstyleNamespace } from "./jumpstyle";
 import { TranscriptionNamespace } from "./transcription";
 import { UpscaleNamespace } from "./upscale";
+import { SRMachineNamespace } from "./srMachine";
 import { VocalSeparationNamespace } from "./vocalSeparation";
 export * from "./backgroundRemoval";
 export * from "./captions";
@@ -47,6 +48,7 @@ export * from "./downloader";
 export * from "./jumpstyle";
 export * from "./transcription";
 export * from "./upscale";
+export * from "./srMachine";
 export * from "./vocalSeparation";
 /**
  * Lifecycle of a tool row.
@@ -255,5 +257,7 @@ export declare class ToolsNamespace extends Resource {
     readonly jumpstyle: JumpstyleNamespace;
     /** Fetches media from a public URL. */
     readonly downloader: DownloaderNamespace;
+    /** Fetch, convert and package a track. Administrators only. */
+    readonly srMachine: SRMachineNamespace;
     constructor(http: ApiClient);
 }

package/dist/types/resources/tools/srMachine.d.ts

@@ -0,0 +1,114 @@
+/** The `tools.srMachine` namespace: fetch a track's audio, artwork and metadata by URL, and transcode audio to Opus. Administrators only. */
+import { Resource } from "../../http";
+import type { FileInput, FileOutput, NativeFile, RequestOptions } from "../../types";
+/** What `GET /s_r_machine/metadata` answers. Two keys, both nullable. */
+export interface SRMachineMetadata {
+    readonly title: string | null;
+    readonly artist: string | null;
+}
+/**
+ * The SR Machine helpers, reachable as `oms.tools.srMachine`.
+ *
+ * ## Admin only, and the check is blunt
+ *
+ * Every route answers `403 "You SHALL NOT use this resource"` to anyone who is
+ * not an administrator. There is no allowlist, no scope and no per-user
+ * quota.
+ *
+ * ## What it is
+ *
+ * Four unrelated primitives left over from the "slowed + reverb" video tool:
+ * fetch the artwork behind a URL, fetch its audio, read its title and artist,
+ * and transcode an arbitrary audio blob to Opus. Nothing here touches the
+ * library - no song is created, nothing is stored, and the bytes come back in
+ * the response body. If you want a track IN the library, use
+ * `oms.music.imports.create()` instead; this is the raw pipe.
+ *
+ * Three of the four fetch a caller-supplied URL and hold a server thread while
+ * they do it, exactly like `oms.music.imports.previewPlaylist()` - but
+ * they have no budget of their own, so the only ceiling is the general
+ * 600/min. The admin gate is what stands in for a budget here. Do not build a
+ * batch loop on top of these.
+ *
+ * A YouTube URL carrying `?list=` is truncated at the `?list=` before the fetch,
+ * so a link copied from inside a playlist resolves to the single video rather
+ * than the playlist. That happens server-side, in all three fetchers.
+ *
+ * All three fetchers respond with `Content-Disposition: attachment` and a
+ * fixed filename (`artwork.jpg`, `audio.opus`), so `FileOutput.filename` is
+ * that constant rather than anything derived from the source.
+ */
+export declare class SRMachineNamespace extends Resource {
+    /**
+     * `GET /s_r_machine/metadata` - the title and artist read off a URL.
+     *
+     * Both keys can be `null` for a source that carries no tags; it is a
+     * best-effort read, not a lookup.
+     *
+     * Not retried by default: it parks a server thread for up to 60 seconds,
+     * and a failure means the source refused.
+     *
+     * @throws {OmsAuthError} 403 `"You SHALL NOT use this resource"` for a
+     *   non-admin.
+     * @throws {OmsApiError} 400 `"url is not allowed"` for a URL that is not
+     *   public http(s); 500 when the fetch itself fails - an upstream failure
+     *   surfaces as a server error here, not as a 502.
+     */
+    metadata(url: string, options?: RequestOptions): Promise<SRMachineMetadata>;
+    /**
+     * `GET /s_r_machine/artwork` - the cover behind a URL, as `image/jpeg`.
+     *
+     * Buffered fully into memory in every runtime, React Native included. It is a
+     * cover, so that is fine; {@link SRMachineNamespace.audio} is where it is not.
+     *
+     * @throws {OmsAuthError} 403 for a non-admin.
+     * @throws {OmsApiError} 400 `"url is not allowed"`; 500 on a fetch failure.
+     */
+    artwork(url: string, options?: RequestOptions): Promise<FileOutput>;
+    /**
+     * `GET /s_r_machine/audio` - the audio behind a URL, as `audio/opus`.
+     *
+     * The whole track is downloaded server-side, held in memory there, and sent
+     * back in one body which this then buffers into memory again on the client.
+     * Nothing streams. On a phone that is a whole track in the JavaScript heap,
+     * and there is no signed-URL alternative here the way there is for library
+     * media - this endpoint has no storage node behind it. Reach for it on
+     * desktop, think twice on React Native, and never for a batch.
+     *
+     * Generous `timeoutMs` by default because a long track legitimately takes
+     * minutes.
+     *
+     * @throws {OmsAuthError} 403 for a non-admin.
+     * @throws {OmsApiError} 400 `"url is not allowed"`; 500 on a fetch failure.
+     */
+    audio(url: string, options?: RequestOptions): Promise<FileOutput>;
+    /**
+     * `POST /s_r_machine/convert-opus` - transcode an audio file to Opus.
+     *
+     * Multipart, field name `file`, and the only method in this namespace that
+     * uploads. The response is `audio/opus` bytes, not JSON.
+     *
+     * Works on all three runtimes: a React Native `{ uri, name, type }` descriptor
+     * goes into the `FormData` verbatim and is streamed off disk by the native
+     * layer, while a browser or Bun caller passes a `FileInput` carrying a Blob
+     * or a `Uint8Array`. A `ReadableStream` is buffered first, because
+     * `FormData` has no streaming entry.
+     *
+     * The upload has no client-side size cap here because the server declares
+     * none - but the CDN in front of the API rejects a request body over roughly
+     * 100 MB with a 413 that never reaches it. There is no chunked path for this
+     * route, so a file above that simply cannot go through it.
+     *
+     * The server reads the whole part into memory before transcoding, so a large
+     * input is a large allocation on both sides.
+     *
+     * @throws {OmsAuthError} 403 `"You SHALL NOT use this resource"` for a
+     *   non-admin.
+     * @throws {OmsApiError} 500 when no `file` part was sent or when the input
+     *   cannot be transcoded. Neither is a graceful 400.
+     * @throws {TypeError} when a React Native descriptor is passed on a runtime
+     *   whose `FormData` is the web one, which would otherwise upload the literal
+     *   text `"[object Object]"` and answer 500.
+     */
+    convertToOpus(file: FileInput | NativeFile, options?: RequestOptions): Promise<FileOutput>;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@omelhorsite/sdk",
-  "version": "0.4.1",
+  "version": "0.4.2",
   "description": "TypeScript SDK for the omelhorsite API. Isolate-safe: no node builtins, no environment access, no stdout.",
   "type": "module",
   "license": "UNLICENSED",