@deadair/sdk 0.7.0

package/dist/plugins/types/plugins.types.d.ts

@@ -0,0 +1,330 @@
+import { DateTime } from 'luxon';
+/**
+ * Lifecycle state of a plugin the host knows about
+ * generated from [PluginStatus](../../../../../apps/api/data/contracts/plugins/plugins.types.ck#L7)
+ */
+export type PluginStatus = 'discovered' | 'disabled' | 'misconfigured' | 'active' | 'failed';
+/**
+ * Where the station found a plugin: shipped inside the image, or installed by the operator into the plugins
+ * directory on the data volume. Says nothing about trust; both kinds run inside the station with its privileges
+ * generated from [PluginOrigin](../../../../../apps/api/data/contracts/plugins/plugins.types.ck#L11)
+ */
+export type PluginOrigin = 'bundled' | 'installed';
+/**
+ * generated from [ConfigFieldType](../../../../../apps/api/data/contracts/plugins/plugins.types.ck#L13)
+ */
+export type ConfigFieldType = 'string' | 'text' | 'url' | 'secret' | 'number' | 'boolean' | 'select' | 'multiselect' | 'list' | 'note';
+/**
+ * What a `number` field's value is measured in. The stored value is always in this unit; only the
+ * control the operator touches changes, so a byte count stays a byte count everywhere it is read and
+ * a `fraction` stays the share between 0 and 1 that the code multiplying by it wants
+ * generated from [ConfigFieldUnit](../../../../../apps/api/data/contracts/plugins/plugins.types.ck#L18)
+ */
+export type ConfigFieldUnit = 'bytes' | 'fraction';
+/**
+ * The control a field asks to be drawn with, where the ordinary one for its type reads badly. Opt-in
+ * per field rather than inferred, because a slider is right for a value you feel for and wrong for
+ * one you have to hit exactly, and `tags` is right for a comma-separated line that is really a SET
+ * and wrong for one that is prose. Nothing about the stored value changes either way
+ * generated from [ConfigFieldControl](../../../../../apps/api/data/contracts/plugins/plugins.types.ck#L24)
+ */
+export type ConfigFieldControl = 'slider' | 'tags';
+/**
+ * One choice of a `select` config field
+ * generated from [ConfigFieldOption](../../../../../apps/api/data/contracts/plugins/plugins.types.ck#L27)
+ */
+export interface ConfigFieldOption {
+    value: string;
+    label: string;
+}
+/**
+ * Where a field's or a column's choices come from when only the console can enumerate them: the
+ * station's own tables, the platform's zone list, the enabled plugins that can do one of four jobs,
+ * or the models the selected model plugin currently offers. Resolved by the console either way
+ * generated from [ConfigFieldOptionSource](../../../../../apps/api/data/contracts/plugins/plugins.types.ck#L35)
+ */
+export type ConfigFieldOptionSource = 'station.newsCategories' | 'station.newsFeeds' | 'intl.timeZones' | 'plugins.speech' | 'plugins.llm' | 'plugins.mixer' | 'plugins.analysis' | 'llm.models';
+/**
+ * A plugin handed over from the browser. The generated client types the body as `FormData`, so
+ * nothing checks this shape. It says what to send
+ * generated from [PluginImport](../../../../../apps/api/data/contracts/plugins/plugins.types.ck#L93)
+ */
+export interface PluginImport {
+    /** The gzip tarball npm pack writes: every entry under package/, holding package.json and the built code, at most 64 MB */
+    file: Blob;
+}
+/**
+ * generated from [PluginLogLevel](../../../../../apps/api/data/contracts/plugins/plugins.types.ck#L104)
+ */
+export type PluginLogLevel = 'debug' | 'info' | 'warn' | 'error';
+/**
+ * A submitted settings form. Secret values arrive in here and are never echoed back
+ * generated from [PluginConfigInput](../../../../../apps/api/data/contracts/plugins/plugins.types.ck#L136)
+ */
+export interface PluginConfigInput {
+    config: Record<string, unknown>;
+}
+/**
+ * What a plugin may do with a capability it asked for. Denied is the default and needs no row: a
+ * capability is refused until somebody allows it, so "never answered" and "refused" are one state
+ * generated from [GrantDecision](../../../../../apps/api/data/contracts/plugins/plugins.types.ck#L142)
+ */
+export type GrantDecision = 'allowed' | 'denied';
+/**
+ * Outcome of the plugin's own `testConnection()`
+ * generated from [PluginTestResult](../../../../../apps/api/data/contracts/plugins/plugins.types.ck#L166)
+ */
+export interface PluginTestResult {
+    ok: boolean;
+    message?: string;
+}
+/**
+ * Where the console should send the browser to obtain the operator's consent. Reported rather than
+ * redirected to: the route is behind the Bearer floor, so a browser cannot follow a redirect from it
+ * generated from [PluginOAuthStart](../../../../../apps/api/data/contracts/plugins/plugins.types.ck#L184)
+ */
+export interface PluginOAuthStart {
+    url: string;
+}
+/**
+ * Outcome of an OAuth callback
+ * generated from [PluginOAuthResult](../../../../../apps/api/data/contracts/plugins/plugins.types.ck#L189)
+ */
+export interface PluginOAuthResult {
+    pluginId: string;
+    ok: boolean;
+    message?: string;
+}
+/**
+ * generated from [PluginOAuthCallbackQuery](../../../../../apps/api/data/contracts/plugins/plugins.types.ck#L195)
+ */
+export interface PluginOAuthCallbackQuery {
+    code?: string;
+    state?: string;
+    error?: string;
+    ubi?: string;
+    /**
+     * What a desktop-style flow returns instead of `code`: the provider mints a token before the
+     * consent screen and hands the same one back, which the plugin exchanges for a session. Last.fm's
+     * auth works this way. Listed here because the route parses this query strictly, so an
+     * undeclared parameter is a 400 before any plugin code runs
+     */
+    token?: string;
+}
+/**
+ * Live choices for a plugin's config fields, keyed by field key, out of the plugin's own
+ * `suggestConfigOptions()`. What `ConfigFieldDescriptor.options` cannot be: fixed when the manifest
+ * was written, where these are whatever the operator's own server currently says
+ * generated from [PluginFieldSuggestions](../../../../../apps/api/data/contracts/plugins/plugins.types.ck#L174)
+ */
+export interface PluginFieldSuggestions {
+    /** Keys the plugin had nothing to say about are simply absent, rather than present and empty */
+    fields: Record<string, ConfigFieldOption[]>;
+    /**
+     * False when the plugin does not implement suggestions at all, so a console can tell "nothing to
+     * suggest" from "asked and got nothing", and draw a refresh control only where one would do something
+     */
+    supported: boolean;
+}
+/**
+ * One column of a `list` field. Every ordinary cell is stored as a string in the row, so this describes the
+ * control rather than the value; a `secret` cell is encrypted on its own and is never in the row at all
+ * generated from [ConfigFieldColumn](../../../../../apps/api/data/contracts/plugins/plugins.types.ck#L39)
+ */
+export interface ConfigFieldColumn {
+    key: string;
+    label: string;
+    type: 'string' | 'url' | 'select' | 'secret';
+    required?: boolean;
+    placeholder?: string;
+    options?: ConfigFieldOption[];
+    optionsFrom?: ConfigFieldOptionSource;
+    /** Key of another column in the same list. This cell applies only to a row whose cell there holds one of `dependsOnValues`. Stronger than a field's `dependsOn`, which only hides a control: a cell that does not apply is neither sent by the console nor read by the host, so a `url` column that does not apply to a row contributes no hostname to the plugin's allowlist. A target this list does not declare, or a target cell still empty, shows the cell */
+    dependsOn?: string;
+    /** The values of the `dependsOn` cell this one applies to. Omitted means any non-empty value; ignored without a target */
+    dependsOnValues?: string[];
+}
+/**
+ * generated from [PluginLogEntry](../../../../../apps/api/data/contracts/plugins/plugins.types.ck#L106)
+ */
+export interface PluginLogEntry {
+    ts: string;
+    level: PluginLogLevel;
+    /** Must match MAX_LINE_BYTES_CEILING in apps/api/src/logging/rotating.log.store.ts. Change both together */
+    text: string;
+}
+/**
+ * generated from [PluginLogQuery](../../../../../apps/api/data/contracts/plugins/plugins.types.ck#L118)
+ */
+export interface PluginLogQuery {
+    limit?: number;
+    level?: PluginLogLevel;
+}
+/**
+ * generated from [PluginLogLevelInput](../../../../../apps/api/data/contracts/plugins/plugins.types.ck#L123)
+ */
+export interface PluginLogLevelInput {
+    level: PluginLogLevel;
+}
+/**
+ * One capability a plugin asked for, with the station's answer. The ask is the plugin's manifest and
+ * the answer is a row, so a plugin that stops asking stops appearing here whatever was stored
+ * generated from [PluginGrant](../../../../../apps/api/data/contracts/plugins/plugins.types.ck#L146)
+ */
+export interface PluginGrant {
+    pluginId: string;
+    pluginName: string;
+    /** The host's own id for it, e.g. `network.open` */
+    capability: string;
+    /** What the host calls the capability */
+    label: string;
+    /** What allowing it opens up, in the station's words */
+    describes: string;
+    /** Why this plugin says it needs it, in the plugin's words */
+    reason: string;
+    decision: GrantDecision;
+}
+/**
+ * generated from [PluginGrantInput](../../../../../apps/api/data/contracts/plugins/plugins.types.ck#L160)
+ */
+export interface PluginGrantInput {
+    capability: string;
+    decision: GrantDecision;
+}
+/**
+ * Mirrors the plugin SDK's `ConfigField`: enough for a console to render the settings form with no per-plugin code
+ * generated from [ConfigFieldDescriptor](../../../../../apps/api/data/contracts/plugins/plugins.types.ck#L52)
+ */
+export interface ConfigFieldDescriptor {
+    key: string;
+    label: string;
+    type: ConfigFieldType;
+    required?: boolean;
+    default?: string | number | boolean;
+    /** `number` only, and ignored elsewhere */
+    unit?: ConfigFieldUnit;
+    /** `slider` for a `number` with both `min` and `max`, `tags` for a `string` holding a comma-separated set */
+    control?: ConfigFieldControl;
+    /** How coarsely a `control` moves, in the field's own unit. Ignored without one, and defaults to 1 */
+    step?: number;
+    /** `number` only: the smallest value that will be accepted, inclusive */
+    min?: number;
+    /** `number` only: the largest value that will be accepted, inclusive */
+    max?: number;
+    placeholder?: string;
+    help?: string;
+    options?: ConfigFieldOption[];
+    /** Choices only the console can enumerate. Merged where a plugin's own suggestions are, and outranked by them */
+    optionsFrom?: ConfigFieldOptionSource;
+    /** `list` only, and ignored elsewhere */
+    columns?: ConfigFieldColumn[];
+    /** Key of the field this one is only relevant to */
+    dependsOn?: string;
+    /** Key of the `number` field that is the upper end of the range this one opens, declared on the lower end only. Still two settings, each validated by name; the console draws them as one control whose handles cannot cross */
+    rangeWith?: string;
+}
+/**
+ * generated from [PluginLogPage](../../../../../apps/api/data/contracts/plugins/plugins.types.ck#L112)
+ */
+export interface PluginLogPage {
+    pluginId: string;
+    level: PluginLogLevel;
+    /** Newest first, as the activity feed and the script history send. The download is the file as written, oldest first */
+    entries: PluginLogEntry[];
+}
+/**
+ * generated from [PluginGrantList](../../../../../apps/api/data/contracts/plugins/plugins.types.ck#L156)
+ */
+export interface PluginGrantList {
+    /** Every capability every installed plugin is asking for, refused ones included */
+    grants: PluginGrant[];
+}
+/**
+ * A plugin as the settings list sees it. Carries no configured VALUES, only which secrets are set
+ * generated from [PluginSummary](../../../../../apps/api/data/contracts/plugins/plugins.types.ck#L73)
+ */
+export interface PluginSummary {
+    id: string;
+    name: string;
+    version: string;
+    capabilities: string[];
+    /** Whether the manifest declares the `trackFetcher` permission, so its records reach air through the station's own track fetcher and that fetcher needs its own authorization. Not the same as the `stream` capability, which a plugin that mints its own stream URLs declares too. Absent means it does not */
+    usesTrackFetcher?: boolean;
+    status: PluginStatus;
+    origin: PluginOrigin;
+    enabled: boolean;
+    description?: string;
+    icon?: string;
+    configFields: ConfigFieldDescriptor[];
+    /** Whether a value is currently stored, per `secret` field under its own key and per `secret` cell under `field/rowId/column`. Never the value itself */
+    secretsConfigured: Record<string, boolean>;
+    /** When this plugin was first ever enabled. Absent means it never has been, so the console asks before it is */
+    firstEnabledAt?: DateTime;
+    /** The last recorded failure. Absent means it is not currently unhappy */
+    lastError?: string;
+    /** When the breaker will probe this plugin again on its own. Absent means no probe is pending */
+    nextProbeAt?: DateTime;
+}
+export interface PluginSummaryInput {
+    id: string;
+    name: string;
+    version: string;
+    capabilities: string[];
+    /** Whether the manifest declares the `trackFetcher` permission, so its records reach air through the station's own track fetcher and that fetcher needs its own authorization. Not the same as the `stream` capability, which a plugin that mints its own stream URLs declares too. Absent means it does not */
+    usesTrackFetcher?: boolean;
+    status: PluginStatus;
+    origin: PluginOrigin;
+    enabled: boolean;
+    description?: string;
+    icon?: string;
+    configFields: ConfigFieldDescriptor[];
+    /** Whether a value is currently stored, per `secret` field under its own key and per `secret` cell under `field/rowId/column`. Never the value itself */
+    secretsConfigured: Record<string, boolean>;
+    /** The last recorded failure. Absent means it is not currently unhappy */
+    lastError?: string;
+}
+/** Rehydrates every wire-encoded scalar in a PluginSummary into its runtime type. Mutates and returns `raw`. */
+export declare function revivePluginSummary(raw: PluginSummary): PluginSummary;
+/**
+ * What an import did
+ * generated from [PluginImportResult](../../../../../apps/api/data/contracts/plugins/plugins.types.ck#L98)
+ */
+export interface PluginImportResult {
+    /** The id the imported plugin claimed */
+    pluginId: string;
+    /** The same version was already loaded, so the station runs the build it had until it restarts. False for a new plugin and for a new version */
+    restartRequired: boolean;
+    /** Every plugin, as the catalogue now stands. An import can take an older version away as well as add one */
+    plugins: PluginSummary[];
+}
+export interface PluginImportResultInput {
+    /** The id the imported plugin claimed */
+    pluginId: string;
+    /** The same version was already loaded, so the station runs the build it had until it restarts. False for a new plugin and for a new version */
+    restartRequired: boolean;
+    /** Every plugin, as the catalogue now stands. An import can take an older version away as well as add one */
+    plugins: PluginSummaryInput[];
+}
+/** Rehydrates every wire-encoded scalar in a PluginImportResult into its runtime type. Mutates and returns `raw`. */
+export declare function revivePluginImportResult(raw: PluginImportResult): PluginImportResult;
+/**
+ * A summary plus the stored NON-SECRET configuration
+ * generated from [PluginDetail](../../../../../apps/api/data/contracts/plugins/plugins.types.ck#L128)
+ */
+export interface PluginDetail extends PluginSummary {
+    /** Absolute path of the plugin's directory on the station */
+    dir: string;
+    config: Record<string, unknown>;
+    oauthConnected?: boolean;
+    logLevel: PluginLogLevel;
+}
+export interface PluginDetailInput extends PluginSummaryInput {
+    /** Absolute path of the plugin's directory on the station */
+    dir: string;
+    config: Record<string, unknown>;
+    oauthConnected?: boolean;
+    logLevel: PluginLogLevel;
+}
+/** Rehydrates every wire-encoded scalar in a PluginDetail into its runtime type. Mutates and returns `raw`. */
+export declare function revivePluginDetail(raw: PluginDetail): PluginDetail;
+//# sourceMappingURL=plugins.types.d.ts.map

package/dist/plugins/types/plugins.types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"plugins.types.d.ts","sourceRoot":"","sources":["../../../src/plugins/types/plugins.types.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,QAAQ,EAAE,MAAM,OAAO,CAAC;AAYjC;;;GAGG;AACH,MAAM,MAAM,YAAY,GAAG,YAAY,GAAG,UAAU,GAAG,eAAe,GAAG,QAAQ,GAAG,QAAQ,CAAC;AAE7F;;;;GAIG;AACH,MAAM,MAAM,YAAY,GAAG,SAAS,GAAG,WAAW,CAAC;AAEnD;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG,QAAQ,GAAG,MAAM,GAAG,KAAK,GAAG,QAAQ,GAAG,QAAQ,GAAG,SAAS,GAAG,QAAQ,GAAG,aAAa,GAAG,MAAM,GAAG,MAAM,CAAC;AAEvI;;;;;GAKG;AACH,MAAM,MAAM,eAAe,GAAG,OAAO,GAAG,UAAU,CAAC;AAEnD;;;;;;GAMG;AACH,MAAM,MAAM,kBAAkB,GAAG,QAAQ,GAAG,MAAM,CAAC;AAEnD;;;GAGG;AACH,MAAM,WAAW,iBAAiB;IAC9B,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,MAAM,CAAC;CACjB;AAED;;;;;GAKG;AACH,MAAM,MAAM,uBAAuB,GAC7B,wBAAwB,GACxB,mBAAmB,GACnB,gBAAgB,GAChB,gBAAgB,GAChB,aAAa,GACb,eAAe,GACf,kBAAkB,GAClB,YAAY,CAAC;AAEnB;;;;GAIG;AACH,MAAM,WAAW,YAAY;IACzB,2HAA2H;IAC3H,IAAI,EAAE,IAAI,CAAC;CACd;AAED;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG,OAAO,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC;AAEjE;;;GAGG;AACH,MAAM,WAAW,iBAAiB;IAC9B,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACnC;AAED;;;;GAIG;AACH,MAAM,MAAM,aAAa,GAAG,SAAS,GAAG,QAAQ,CAAC;AAEjD;;;GAGG;AACH,MAAM,WAAW,gBAAgB;IAC7B,EAAE,EAAE,OAAO,CAAC;IACZ,OAAO,CAAC,EAAE,MAAM,CAAC;CACpB;AAED;;;;GAIG;AACH,MAAM,WAAW,gBAAgB;IAC7B,GAAG,EAAE,MAAM,CAAC;CACf;AAED;;;GAGG;AACH,MAAM,WAAW,iBAAiB;IAC9B,QAAQ,EAAE,MAAM,CAAC;IACjB,EAAE,EAAE,OAAO,CAAC;IACZ,OAAO,CAAC,EAAE,MAAM,CAAC;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,wBAAwB;IACrC,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,GAAG,CAAC,EAAE,MAAM,CAAC;IACb;;;;;OAKG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;CAClB;AAED;;;;;GAKG;AACH,MAAM,WAAW,sBAAsB;IACnC,gGAAgG;IAChG,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,iBAAiB,EAAE,CAAC,CAAC;IAC5C;;;OAGG;IACH,SAAS,EAAE,OAAO,CAAC;CACtB;AAED;;;;GAIG;AACH,MAAM,WAAW,iBAAiB;IAC9B,GAAG,EAAE,MAAM,CAAC;IACZ,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,QAAQ,GAAG,KAAK,GAAG,QAAQ,GAAG,QAAQ,CAAC;IAC7C,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,OAAO,CAAC,EAAE,iBAAiB,EAAE,CAAC;IAC9B,WAAW,CAAC,EAAE,uBAAuB,CAAC;IACtC,ocAAoc;IACpc,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,0HAA0H;IAC1H,eAAe,CAAC,EAAE,MAAM,EAAE,CAAC;CAC9B;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC3B,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,EAAE,cAAc,CAAC;IACtB,4GAA4G;IAC5G,IAAI,EAAE,MAAM,CAAC;CAChB;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC3B,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,KAAK,CAAC,EAAE,cAAc,CAAC;CAC1B;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAChC,KAAK,EAAE,cAAc,CAAC;CACzB;AAED;;;;GAIG;AACH,MAAM,WAAW,WAAW;IACxB,QAAQ,EAAE,MAAM,CAAC;IACjB,UAAU,EAAE,MAAM,CAAC;IACnB,oDAAoD;IACpD,UAAU,EAAE,MAAM,CAAC;IACnB,yCAAyC;IACzC,KAAK,EAAE,MAAM,CAAC;IACd,wDAAwD;IACxD,SAAS,EAAE,MAAM,CAAC;IAClB,8DAA8D;IAC9D,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,aAAa,CAAC;CAC3B;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC7B,UAAU,EAAE,MAAM,CAAC;IACnB,QAAQ,EAAE,aAAa,CAAC;CAC3B;AAED;;;GAGG;AACH,MAAM,WAAW,qBAAqB;IAClC,GAAG,EAAE,MAAM,CAAC;IACZ,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,eAAe,CAAC;IACtB,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,OAAO,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC;IACpC,2CAA2C;IAC3C,IAAI,CAAC,EAAE,eAAe,CAAC;IACvB,6GAA6G;IAC7G,OAAO,CAAC,EAAE,kBAAkB,CAAC;IAC7B,sGAAsG;IACtG,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,yEAAyE;IACzE,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,wEAAwE;IACxE,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,OAAO,CAAC,EAAE,iBAAiB,EAAE,CAAC;IAC9B,iHAAiH;IACjH,WAAW,CAAC,EAAE,uBAAuB,CAAC;IACtC,yCAAyC;IACzC,OAAO,CAAC,EAAE,iBAAiB,EAAE,CAAC;IAC9B,oDAAoD;IACpD,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,gOAAgO;IAChO,SAAS,CAAC,EAAE,MAAM,CAAC;CACtB;AAED;;GAEG;AACH,MAAM,WAAW,aAAa;IAC1B,QAAQ,EAAE,MAAM,CAAC;IACjB,KAAK,EAAE,cAAc,CAAC;IACtB,wHAAwH;IACxH,OAAO,EAAE,cAAc,EAAE,CAAC;CAC7B;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC5B,mFAAmF;IACnF,MAAM,EAAE,WAAW,EAAE,CAAC;CACzB;AAED;;;GAGG;AACH,MAAM,WAAW,aAAa;IAC1B,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;IAChB,YAAY,EAAE,MAAM,EAAE,CAAC;IACvB,gTAAgT;IAChT,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAC3B,MAAM,EAAE,YAAY,CAAC;IACrB,MAAM,EAAE,YAAY,CAAC;IACrB,OAAO,EAAE,OAAO,CAAC;IACjB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,YAAY,EAAE,qBAAqB,EAAE,CAAC;IACtC,yJAAyJ;IACzJ,iBAAiB,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAC3C,gHAAgH;IAChH,cAAc,CAAC,EAAE,QAAQ,CAAC;IAC1B,0EAA0E;IAC1E,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,iGAAiG;IACjG,WAAW,CAAC,EAAE,QAAQ,CAAC;CAC1B;AAED,MAAM,WAAW,kBAAkB;IAC/B,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;IAChB,YAAY,EAAE,MAAM,EAAE,CAAC;IACvB,gTAAgT;IAChT,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAC3B,MAAM,EAAE,YAAY,CAAC;IACrB,MAAM,EAAE,YAAY,CAAC;IACrB,OAAO,EAAE,OAAO,CAAC;IACjB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,YAAY,EAAE,qBAAqB,EAAE,CAAC;IACtC,yJAAyJ;IACzJ,iBAAiB,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAC3C,0EAA0E;IAC1E,SAAS,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,gHAAgH;AAChH,wBAAgB,mBAAmB,CAAC,GAAG,EAAE,aAAa,GAAG,aAAa,CASrE;AAED;;;GAGG;AACH,MAAM,WAAW,kBAAkB;IAC/B,yCAAyC;IACzC,QAAQ,EAAE,MAAM,CAAC;IACjB,gJAAgJ;IAChJ,eAAe,EAAE,OAAO,CAAC;IACzB,6GAA6G;IAC7G,OAAO,EAAE,aAAa,EAAE,CAAC;CAC5B;AAED,MAAM,WAAW,uBAAuB;IACpC,yCAAyC;IACzC,QAAQ,EAAE,MAAM,CAAC;IACjB,gJAAgJ;IAChJ,eAAe,EAAE,OAAO,CAAC;IACzB,6GAA6G;IAC7G,OAAO,EAAE,kBAAkB,EAAE,CAAC;CACjC;AAED,qHAAqH;AACrH,wBAAgB,wBAAwB,CAAC,GAAG,EAAE,kBAAkB,GAAG,kBAAkB,CASpF;AAED;;;GAGG;AACH,MAAM,WAAW,YAAa,SAAQ,aAAa;IAC/C,6DAA6D;IAC7D,GAAG,EAAE,MAAM,CAAC;IACZ,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAChC,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB,QAAQ,EAAE,cAAc,CAAC;CAC5B;AAED,MAAM,WAAW,iBAAkB,SAAQ,kBAAkB;IACzD,6DAA6D;IAC7D,GAAG,EAAE,MAAM,CAAC;IACZ,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAChC,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB,QAAQ,EAAE,cAAc,CAAC;CAC5B;AAED,+GAA+G;AAC/G,wBAAgB,kBAAkB,CAAC,GAAG,EAAE,YAAY,GAAG,YAAY,CAGlE"}

package/dist/productions/productions.client.d.ts

@@ -0,0 +1,22 @@
+import type { SdkFetch } from '../sdk-options.js';
+import type { Production, ProductionList, ProductionRequest } from './types/productions.types.js';
+export declare class ProductionsClient {
+    private fetch;
+    constructor(fetch: SdkFetch);
+    /**
+     * @name List productions
+     * @description Everything the station has made or is making, newest first
+     */
+    listProductions(): Promise<ProductionList>;
+    /**
+     * @name Request production
+     * @description Asks the station to make one. It is queued, not started
+     */
+    requestProduction(body: ProductionRequest): Promise<Production>;
+    /**
+     * @name Cancel production
+     * @description Stops a production being made, for good
+     */
+    cancelProduction(id: string): Promise<Production>;
+}
+//# sourceMappingURL=productions.client.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"productions.client.d.ts","sourceRoot":"","sources":["../../src/productions/productions.client.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAC;AAElD,OAAO,KAAK,EAAE,UAAU,EAAE,cAAc,EAAE,iBAAiB,EAAE,MAAM,8BAA8B,CAAC;AAGlG,qBAAa,iBAAiB;IACd,OAAO,CAAC,KAAK;gBAAL,KAAK,EAAE,QAAQ;IAEnC;;;OAGG;IACG,eAAe,IAAI,OAAO,CAAC,cAAc,CAAC;IAKhD;;;OAGG;IACG,iBAAiB,CAAC,IAAI,EAAE,iBAAiB,GAAG,OAAO,CAAC,UAAU,CAAC;IASrE;;;OAGG;IACG,gBAAgB,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,UAAU,CAAC;CAI1D"}

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

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

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

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

package/dist/productions/types/productions.types.d.ts

@@ -0,0 +1,90 @@
+import { DateTime } from 'luxon';
+/**
+ * One person in a production: the presenter, or somebody cast to phone in. A snapshot rather than a
+ * reference, because the persona it names may be edited or deleted while the programme is still being
+ * made and what the turns were written as has to be what an operator reads back
+ * generated from [ProductionCastMember](../../../../../apps/api/data/contracts/productions/productions.types.ck#L10)
+ */
+export interface ProductionCastMember {
+    role: 'host' | 'caller';
+    /** What they are called on air */
+    name?: string;
+    /** The persona key, for a link back to the character */
+    persona?: string;
+}
+/**
+ * What an operator asks for. Everything else about a production is decided by the passes that make it
+ * generated from [ProductionRequest](../../../../../apps/api/data/contracts/productions/productions.types.ck#L39)
+ */
+export interface ProductionRequest {
+    kind?: string;
+    /** Absent is named after its kind and the moment it was asked for, which is what somebody taking a call now wants rather than a box to fill in */
+    title?: string;
+    brief?: string;
+    personaId?: string;
+    /** Absent takes the station's `render.productionWritingMode` */
+    writingMode?: 'quick' | 'outlined' | 'polished';
+    targetMs?: number;
+    scheduledFor?: DateTime;
+}
+/** Rehydrates every wire-encoded scalar in a ProductionRequest into its runtime type. Mutates and returns `raw`. */
+export declare function reviveProductionRequest(raw: ProductionRequest): ProductionRequest;
+/**
+ * Something the station makes rather than something it says: several beats of speech, written in several passes, that airs as one block
+ * generated from [Production](../../../../../apps/api/data/contracts/productions/productions.types.ck#L17)
+ */
+export interface Production {
+    id: string;
+    /** What sort of production: podcast, bulletin, feature. Free text, so a station that wants a documentary strand needs no migration */
+    kind: string;
+    title: string;
+    /** What was asked for, in the operator's own words. Distinct from the title, which is only a label */
+    brief?: string;
+    /** Who presents it. Absent falls back to the station's active persona when a pass runs */
+    personaId?: string;
+    /** How many passes to spend on it */
+    writingMode: 'quick' | 'outlined' | 'polished';
+    /** How long it should run. What the beat count and the per-beat word budgets are computed from */
+    targetMs: number;
+    /** `stitching` is the beats being joined into one piece of audio, and it leads to `ready` whether that worked or not */
+    state: 'planned' | 'outlining' | 'drafting' | 'checking' | 'rendering' | 'stitching' | 'ready' | 'aired' | 'failed' | 'cancelled';
+    /** Why making it did not work */
+    error?: string;
+    /** When it should air. Absent means as soon as it is made */
+    scheduledFor?: DateTime;
+    cancelledAt?: DateTime;
+    /** How many beats exist so far, which is how far along the drafting is */
+    beats: number;
+    /** Who is on it, decided by the first pass that ran. Empty for one nobody has started, and for a programme the presenter reads alone */
+    cast: ProductionCastMember[];
+    createdAt: DateTime;
+}
+export interface ProductionInput {
+    /** What sort of production: podcast, bulletin, feature. Free text, so a station that wants a documentary strand needs no migration */
+    kind: string;
+    title: string;
+    /** What was asked for, in the operator's own words. Distinct from the title, which is only a label */
+    brief?: string;
+    /** Who presents it. Absent falls back to the station's active persona when a pass runs */
+    personaId?: string;
+    /** How many passes to spend on it */
+    writingMode: 'quick' | 'outlined' | 'polished';
+    /** How long it should run. What the beat count and the per-beat word budgets are computed from */
+    targetMs: number;
+    /** When it should air. Absent means as soon as it is made */
+    scheduledFor?: DateTime;
+}
+/** Rehydrates every wire-encoded scalar in a Production into its runtime type. Mutates and returns `raw`. */
+export declare function reviveProduction(raw: Production): Production;
+/**
+ * generated from [ProductionList](../../../../../apps/api/data/contracts/productions/productions.types.ck#L34)
+ */
+export interface ProductionList {
+    productions: Production[];
+}
+export interface ProductionListInput {
+    productions: ProductionInput[];
+}
+/** Rehydrates every wire-encoded scalar in a ProductionList into its runtime type. Mutates and returns `raw`. */
+export declare function reviveProductionList(raw: ProductionList): ProductionList;
+//# sourceMappingURL=productions.types.d.ts.map

package/dist/productions/types/productions.types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"productions.types.d.ts","sourceRoot":"","sources":["../../../src/productions/types/productions.types.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,QAAQ,EAAE,MAAM,OAAO,CAAC;AAYjC;;;;;GAKG;AACH,MAAM,WAAW,oBAAoB;IACjC,IAAI,EAAE,MAAM,GAAG,QAAQ,CAAC;IACxB,kCAAkC;IAClC,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,wDAAwD;IACxD,OAAO,CAAC,EAAE,MAAM,CAAC;CACpB;AAED;;;GAGG;AACH,MAAM,WAAW,iBAAiB;IAC9B,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,kJAAkJ;IAClJ,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,gEAAgE;IAChE,WAAW,CAAC,EAAE,OAAO,GAAG,UAAU,GAAG,UAAU,CAAC;IAChD,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,YAAY,CAAC,EAAE,QAAQ,CAAC;CAC3B;AAED,oHAAoH;AACpH,wBAAgB,uBAAuB,CAAC,GAAG,EAAE,iBAAiB,GAAG,iBAAiB,CAMjF;AAED;;;GAGG;AACH,MAAM,WAAW,UAAU;IACvB,EAAE,EAAE,MAAM,CAAC;IACX,sIAAsI;IACtI,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,sGAAsG;IACtG,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,0FAA0F;IAC1F,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,qCAAqC;IACrC,WAAW,EAAE,OAAO,GAAG,UAAU,GAAG,UAAU,CAAC;IAC/C,kGAAkG;IAClG,QAAQ,EAAE,MAAM,CAAC;IACjB,wHAAwH;IACxH,KAAK,EAAE,SAAS,GAAG,WAAW,GAAG,UAAU,GAAG,UAAU,GAAG,WAAW,GAAG,WAAW,GAAG,OAAO,GAAG,OAAO,GAAG,QAAQ,GAAG,WAAW,CAAC;IAClI,iCAAiC;IACjC,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,6DAA6D;IAC7D,YAAY,CAAC,EAAE,QAAQ,CAAC;IACxB,WAAW,CAAC,EAAE,QAAQ,CAAC;IACvB,0EAA0E;IAC1E,KAAK,EAAE,MAAM,CAAC;IACd,wIAAwI;IACxI,IAAI,EAAE,oBAAoB,EAAE,CAAC;IAC7B,SAAS,EAAE,QAAQ,CAAC;CACvB;AAED,MAAM,WAAW,eAAe;IAC5B,sIAAsI;IACtI,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,sGAAsG;IACtG,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,0FAA0F;IAC1F,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,qCAAqC;IACrC,WAAW,EAAE,OAAO,GAAG,UAAU,GAAG,UAAU,CAAC;IAC/C,kGAAkG;IAClG,QAAQ,EAAE,MAAM,CAAC;IACjB,6DAA6D;IAC7D,YAAY,CAAC,EAAE,QAAQ,CAAC;CAC3B;AAED,6GAA6G;AAC7G,wBAAgB,gBAAgB,CAAC,GAAG,EAAE,UAAU,GAAG,UAAU,CAU5D;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC3B,WAAW,EAAE,UAAU,EAAE,CAAC;CAC7B;AAED,MAAM,WAAW,mBAAmB;IAChC,WAAW,EAAE,eAAe,EAAE,CAAC;CAClC;AAED,iHAAiH;AACjH,wBAAgB,oBAAoB,CAAC,GAAG,EAAE,cAAc,GAAG,cAAc,CASxE"}