@deadair/sdk 0.7.0

package/dist/render/render.client.d.ts

@@ -0,0 +1,210 @@
+import type { SdkFetch } from '../sdk-options.js';
+import type { PadFetch, PadList, PadScanResult, PadSetMembership, PadSetWrite, PadState, PronunciationList, PronunciationQuery, PronunciationStateWrite, PronunciationWrite, ScriptAttempt, ScriptHistoryPage, ScriptHistoryQuery, ScriptHistorySummary, ScriptHistorySummaryQuery, ScriptRatingInput, Segment, SegmentCreate, SegmentList, SegmentScanResult, SpeechPreviewRequest, VoiceList } from './types/render.types.js';
+export declare class RenderClient {
+    private fetch;
+    constructor(fetch: SdkFetch);
+    /**
+     * @name List segments
+     * @description Everything the station can play that is not a record
+     */
+    listSegments(): Promise<SegmentList>;
+    /**
+     * @name Create segment
+     * @description Plans something for the station to say, and starts rendering it
+     */
+    createSegment(body: SegmentCreate): Promise<Segment>;
+    /**
+     * @name Upload segment
+     * @description Takes a recording in from the browser and puts it in the library, ready to air
+     */
+    uploadSegment(body: FormData): Promise<Segment>;
+    /**
+     * @name Scan the segment inbox
+     * @description Takes whatever audio is sitting in the inbox directory into the library. Safe to repeat: a segment is identified by its audio, so the same recording arriving twice is one segment
+     */
+    scanTheSegmentInbox(): Promise<SegmentScanResult>;
+    /**
+     * @name Read script history
+     * @description What the station has written lately, newest first, one page at a time
+     */
+    readScriptHistory(query?: ScriptHistoryQuery): Promise<ScriptHistoryPage>;
+    /**
+     * @name Rate script
+     * @description What the operator thought of this attempt. Nothing acts on it automatically
+     */
+    rateScript(id: string, body: ScriptRatingInput): Promise<ScriptAttempt>;
+    /**
+     * @name Read script summary
+     * @description Write attempts by outcome, per presenter, over a recent window
+     */
+    readScriptSummary(query?: ScriptHistorySummaryQuery): Promise<ScriptHistorySummary>;
+    /**
+     * @name List voices
+     * @description The voices the station can be asked to speak in
+     */
+    listVoices(): Promise<VoiceList>;
+    /**
+     * @name Get default voice sample
+     * @description A short line spoken in whichever voice the plugin falls back to
+     */
+    getDefaultVoiceSample(): Promise<{
+        status: 200;
+        contentType: 'audio/mpeg' | 'audio/wav' | 'audio/ogg' | 'audio/flac' | 'audio/mp4';
+        data: Blob;
+        headers: {
+            cacheControl?: string;
+            etag?: string;
+        };
+    } | {
+        status: 304;
+    }>;
+    /**
+     * @name Get voice sample
+     * @description A short line spoken in one voice, so an operator can hear it before choosing it
+     */
+    getVoiceSample(voiceId: string): Promise<{
+        status: 200;
+        contentType: 'audio/mpeg' | 'audio/wav' | 'audio/ogg' | 'audio/flac' | 'audio/mp4';
+        data: Blob;
+        headers: {
+            cacheControl?: string;
+            etag?: string;
+        };
+    } | {
+        status: 304;
+    }>;
+    /**
+     * @name Preview speech
+     * @description Speaks the caller's words in one voice, so a break can be heard before it is written for air
+     */
+    previewSpeech(body: SpeechPreviewRequest): Promise<{
+        contentType: 'audio/mpeg' | 'audio/wav' | 'audio/ogg' | 'audio/flac' | 'audio/mp4';
+        data: Blob;
+    }>;
+    /**
+     * @name Delete segment
+     * @description Removes a recording and the inbox file behind it, so the next scan does not read it back in
+     */
+    deleteSegment(id: string): Promise<SegmentList>;
+    /**
+     * @name Get segment audio
+     * @description The audio of one segment
+     */
+    getSegmentAudio(id: string): Promise<{
+        status: 200;
+        contentType: 'audio/mpeg' | 'audio/wav' | 'audio/ogg' | 'audio/flac' | 'audio/mp4';
+        data: Blob;
+        headers: {
+            cacheControl?: string;
+            etag?: string;
+        };
+    } | {
+        status: 304;
+    }>;
+    /**
+     * @name Get stored audio
+     * @description Audio out of the segment store, addressed by content rather than by row
+     */
+    getStoredAudio(checksum: string, ext: string): Promise<{
+        status: 200;
+        contentType: 'audio/mpeg' | 'audio/wav' | 'audio/ogg' | 'audio/flac' | 'audio/mp4';
+        data: Blob;
+        headers: {
+            cacheControl?: string;
+            etag?: string;
+        };
+    } | {
+        status: 304;
+    }>;
+    /**
+     * @name List pronunciations
+     * @description The station's lexicon: what it says, what has been proposed to it, and what it has turned down
+     */
+    listPronunciations(query?: PronunciationQuery): Promise<PronunciationList>;
+    /**
+     * @name Create pronunciation
+     * @description Adds one the operator typed. It is said from the next render on
+     */
+    createPronunciation(body: PronunciationWrite): Promise<PronunciationList>;
+    /**
+     * @name Update pronunciation
+     * @description Rewrites one entry's words, whoever proposed it
+     */
+    updatePronunciation(id: string, body: PronunciationWrite): Promise<PronunciationList>;
+    /**
+     * @name Delete pronunciation
+     * @description Removes an entry outright. Turning a PROPOSAL down is a state rather than a deletion, because a deleted one comes back on the next pass
+     */
+    deletePronunciation(id: string): Promise<PronunciationList>;
+    /**
+     * @name Set pronunciation state
+     * @description Accepts a proposal, turns one down, or takes an entry out of use without losing what it said
+     */
+    setPronunciationState(id: string, body: PronunciationStateWrite): Promise<PronunciationList>;
+    /**
+     * @name List pads
+     * @description Every sound the station holds, board by board
+     */
+    listPads(): Promise<PadList>;
+    /**
+     * @name Upload pad
+     * @description Takes a sound in from the browser and puts it on a board. The file lands in the pad library on disk, so it survives a rebuild and an archive carries it
+     */
+    uploadPad(body: FormData): Promise<PadList>;
+    /**
+     * @name Scan the pad library
+     * @description Takes whatever audio is sitting in the pad library directory onto its board. Safe to repeat: a file nobody has touched is seen and left alone
+     */
+    scanThePadLibrary(): Promise<PadScanResult>;
+    /**
+     * @name Fetch pad
+     * @description Fetches a sound from an address and puts it on a board. The operator names the address, so this is them choosing a file exactly as dropping one in the library is
+     */
+    fetchPad(body: PadFetch): Promise<PadList>;
+    /**
+     * @name Delete pad
+     * @description Removes a sound the console put there, and the file it wrote for it
+     */
+    deletePad(id: string): Promise<PadList>;
+    /**
+     * @name Set pad state
+     * @description Turns a sound down, or puts one back. Answers the whole rack, since one pad changing state is one row moving between two sections of the same page
+     */
+    setPadState(id: string, body: PadState): Promise<PadList>;
+    /**
+     * @name Get pad audio
+     * @description The sound itself, so an operator can hear what they dropped in
+     */
+    getPadAudio(id: string): Promise<{
+        status: 200;
+        contentType: 'audio/mpeg' | 'audio/wav' | 'audio/ogg' | 'audio/flac' | 'audio/mp4';
+        data: Blob;
+        headers: {
+            cacheControl?: string;
+            etag?: string;
+        };
+    } | {
+        status: 304;
+    }>;
+    /**
+     * @name Create pad set
+     * @description Names a new set, or answers the one already under that key
+     */
+    createPadSet(body: PadSetWrite): Promise<PadList>;
+    /**
+     * @name Update pad set
+     * @description Renames a set. The KEY moves with it, so every persona naming the old one stops finding it
+     */
+    updatePadSet(id: string, body: PadSetWrite): Promise<PadList>;
+    /**
+     * @name Delete pad set
+     * @description Removes a set and its memberships, and no pads at all
+     */
+    deletePadSet(id: string): Promise<PadList>;
+    /**
+     * @name Set pad membership
+     * @description Puts a pad on a set or takes it off. Refused where the set already answers to that name, because a script writes a name
+     */
+    setPadMembership(id: string, body: PadSetMembership): Promise<PadList>;
+}
+//# sourceMappingURL=render.client.d.ts.map

package/dist/render/render.client.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"render.client.d.ts","sourceRoot":"","sources":["../../src/render/render.client.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAC;AAElD,OAAO,KAAK,EACR,QAAQ,EACR,OAAO,EACP,aAAa,EACb,gBAAgB,EAChB,WAAW,EACX,QAAQ,EACR,iBAAiB,EACjB,kBAAkB,EAClB,uBAAuB,EACvB,kBAAkB,EAClB,aAAa,EACb,iBAAiB,EACjB,kBAAkB,EAClB,oBAAoB,EACpB,yBAAyB,EACzB,iBAAiB,EACjB,OAAO,EACP,aAAa,EACb,WAAW,EACX,iBAAiB,EACjB,oBAAoB,EACpB,SAAS,EACZ,MAAM,yBAAyB,CAAC;AAGjC,qBAAa,YAAY;IACT,OAAO,CAAC,KAAK;gBAAL,KAAK,EAAE,QAAQ;IAEnC;;;OAGG;IACG,YAAY,IAAI,OAAO,CAAC,WAAW,CAAC;IAK1C;;;OAGG;IACG,aAAa,CAAC,IAAI,EAAE,aAAa,GAAG,OAAO,CAAC,OAAO,CAAC;IAS1D;;;OAGG;IACG,aAAa,CAAC,IAAI,EAAE,QAAQ,GAAG,OAAO,CAAC,OAAO,CAAC;IAQrD;;;OAGG;IACG,mBAAmB,IAAI,OAAO,CAAC,iBAAiB,CAAC;IAKvD;;;OAGG;IACG,iBAAiB,CAAC,KAAK,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,iBAAiB,CAAC;IAQ/E;;;OAGG;IACG,UAAU,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,iBAAiB,GAAG,OAAO,CAAC,aAAa,CAAC;IAS7E;;;OAGG;IACG,iBAAiB,CAAC,KAAK,CAAC,EAAE,yBAAyB,GAAG,OAAO,CAAC,oBAAoB,CAAC;IAQzF;;;OAGG;IACG,UAAU,IAAI,OAAO,CAAC,SAAS,CAAC;IAKtC;;;OAGG;IACG,qBAAqB,IAAI,OAAO,CAChC;QACI,MAAM,EAAE,GAAG,CAAC;QACZ,WAAW,EAAE,YAAY,GAAG,WAAW,GAAG,WAAW,GAAG,YAAY,GAAG,WAAW,CAAC;QACnF,IAAI,EAAE,IAAI,CAAC;QACX,OAAO,EAAE;YAAE,YAAY,CAAC,EAAE,MAAM,CAAC;YAAC,IAAI,CAAC,EAAE,MAAM,CAAA;SAAE,CAAC;KACrD,GACD;QAAE,MAAM,EAAE,GAAG,CAAA;KAAE,CACpB;IAkBD;;;OAGG;IACG,cAAc,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CACxC;QACI,MAAM,EAAE,GAAG,CAAC;QACZ,WAAW,EAAE,YAAY,GAAG,WAAW,GAAG,WAAW,GAAG,YAAY,GAAG,WAAW,CAAC;QACnF,IAAI,EAAE,IAAI,CAAC;QACX,OAAO,EAAE;YAAE,YAAY,CAAC,EAAE,MAAM,CAAC;YAAC,IAAI,CAAC,EAAE,MAAM,CAAA;SAAE,CAAC;KACrD,GACD;QAAE,MAAM,EAAE,GAAG,CAAA;KAAE,CACpB;IAkBD;;;OAGG;IACG,aAAa,CACf,IAAI,EAAE,oBAAoB,GAC3B,OAAO,CAAC;QAAE,WAAW,EAAE,YAAY,GAAG,WAAW,GAAG,WAAW,GAAG,YAAY,GAAG,WAAW,CAAC;QAAC,IAAI,EAAE,IAAI,CAAA;KAAE,CAAC;IAY9G;;;OAGG;IACG,aAAa,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,CAAC;IAKrD;;;OAGG;IACG,eAAe,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CACpC;QACI,MAAM,EAAE,GAAG,CAAC;QACZ,WAAW,EAAE,YAAY,GAAG,WAAW,GAAG,WAAW,GAAG,YAAY,GAAG,WAAW,CAAC;QACnF,IAAI,EAAE,IAAI,CAAC;QACX,OAAO,EAAE;YAAE,YAAY,CAAC,EAAE,MAAM,CAAC;YAAC,IAAI,CAAC,EAAE,MAAM,CAAA;SAAE,CAAC;KACrD,GACD;QAAE,MAAM,EAAE,GAAG,CAAA;KAAE,CACpB;IAkBD;;;OAGG;IACG,cAAc,CAChB,QAAQ,EAAE,MAAM,EAChB,GAAG,EAAE,MAAM,GACZ,OAAO,CACJ;QACI,MAAM,EAAE,GAAG,CAAC;QACZ,WAAW,EAAE,YAAY,GAAG,WAAW,GAAG,WAAW,GAAG,YAAY,GAAG,WAAW,CAAC;QACnF,IAAI,EAAE,IAAI,CAAC;QACX,OAAO,EAAE;YAAE,YAAY,CAAC,EAAE,MAAM,CAAC;YAAC,IAAI,CAAC,EAAE,MAAM,CAAA;SAAE,CAAC;KACrD,GACD;QAAE,MAAM,EAAE,GAAG,CAAA;KAAE,CACpB;IAkBD;;;OAGG;IACG,kBAAkB,CAAC,KAAK,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,iBAAiB,CAAC;IAQhF;;;OAGG;IACG,mBAAmB,CAAC,IAAI,EAAE,kBAAkB,GAAG,OAAO,CAAC,iBAAiB,CAAC;IAS/E;;;OAGG;IACG,mBAAmB,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,kBAAkB,GAAG,OAAO,CAAC,iBAAiB,CAAC;IAS3F;;;OAGG;IACG,mBAAmB,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,iBAAiB,CAAC;IAKjE;;;OAGG;IACG,qBAAqB,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,uBAAuB,GAAG,OAAO,CAAC,iBAAiB,CAAC;IASlG;;;OAGG;IACG,QAAQ,IAAI,OAAO,CAAC,OAAO,CAAC;IAKlC;;;OAGG;IACG,SAAS,CAAC,IAAI,EAAE,QAAQ,GAAG,OAAO,CAAC,OAAO,CAAC;IAQjD;;;OAGG;IACG,iBAAiB,IAAI,OAAO,CAAC,aAAa,CAAC;IAKjD;;;OAGG;IACG,QAAQ,CAAC,IAAI,EAAE,QAAQ,GAAG,OAAO,CAAC,OAAO,CAAC;IAShD;;;OAGG;IACG,SAAS,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAK7C;;;OAGG;IACG,WAAW,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,QAAQ,GAAG,OAAO,CAAC,OAAO,CAAC;IAS/D;;;OAGG;IACG,WAAW,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAChC;QACI,MAAM,EAAE,GAAG,CAAC;QACZ,WAAW,EAAE,YAAY,GAAG,WAAW,GAAG,WAAW,GAAG,YAAY,GAAG,WAAW,CAAC;QACnF,IAAI,EAAE,IAAI,CAAC;QACX,OAAO,EAAE;YAAE,YAAY,CAAC,EAAE,MAAM,CAAC;YAAC,IAAI,CAAC,EAAE,MAAM,CAAA;SAAE,CAAC;KACrD,GACD;QAAE,MAAM,EAAE,GAAG,CAAA;KAAE,CACpB;IAkBD;;;OAGG;IACG,YAAY,CAAC,IAAI,EAAE,WAAW,GAAG,OAAO,CAAC,OAAO,CAAC;IASvD;;;OAGG;IACG,YAAY,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,WAAW,GAAG,OAAO,CAAC,OAAO,CAAC;IASnE;;;OAGG;IACG,YAAY,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAKhD;;;OAGG;IACG,gBAAgB,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,gBAAgB,GAAG,OAAO,CAAC,OAAO,CAAC;CAQ/E"}

package/dist/render/types/index.d.ts

@@ -0,0 +1,2 @@
+export * from './render.types.js';
+//# sourceMappingURL=index.d.ts.map

package/dist/render/types/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/render/types/index.ts"],"names":[],"mappings":"AACA,cAAc,mBAAmB,CAAC"}