@deadair/sdk 0.7.0

package/dist/playlists/types/playlists.types.d.ts

@@ -0,0 +1,71 @@
+/**
+ * An action a source will permit on one playlist's items. Item-scoped: neither value covers the playlist's own name or description
+ * generated from [PlaylistPermission](../../../../../apps/api/data/contracts/playlists/playlists.types.ck#L8)
+ */
+export type PlaylistPermission = 'read' | 'edit';
+/**
+ * One record as its PROVIDER describes it, plus what the catalog can say about the same copy.
+ *
+ * The first half mirrors the plugin SDK's `ProviderTrack` and stays the provider's answer: this is a
+ * listing of what a playlist holds, not of what the station has ingested. The three ids below are the
+ * station's own and are absent for anything it has never seen, which on most playlists is plenty of
+ * rows — a playlist is a provider's list and the library is what a sync has walked
+ * generated from [CatalogTrack](../../../../../apps/api/data/contracts/playlists/playlists.types.ck#L28)
+ */
+export interface CatalogTrack {
+    /** The PROVIDER's id for this copy, which is what an import names it by. Never a `deadair.tracks` id */
+    id: string;
+    title: string;
+    /** Ordered, primary artist first. Empty array if the provider genuinely has none */
+    artists: string[];
+    album?: string;
+    durationMs?: number;
+    isrc?: string;
+    artworkUrl?: string;
+    /** The canonical `deadair.tracks` row this copy is bound to, when the catalog holds one */
+    trackId?: string;
+    /** The canonical artist behind that row */
+    artistId?: string;
+    /** The release that row was ingested inside. Absent for a single ingested outside any */
+    albumId?: string;
+}
+/**
+ * One catalog-capable plugin that could not be listed
+ * generated from [CatalogSourceError](../../../../../apps/api/data/contracts/playlists/playlists.types.ck#L42)
+ */
+export interface CatalogSourceError {
+    pluginId: string;
+    pluginName: string;
+    message: string;
+}
+/**
+ * A playlist a catalog-capable plugin offers, tagged with the plugin it came from so an aggregated list is addressable
+ * generated from [CatalogPlaylist](../../../../../apps/api/data/contracts/playlists/playlists.types.ck#L11)
+ */
+export interface CatalogPlaylist {
+    pluginId: string;
+    pluginName: string;
+    id: string;
+    name: string;
+    description?: string;
+    trackCount?: number;
+    artworkUrl?: string;
+    /** What the SOURCE permits on this playlist's items, not what this actor may do. Empty means the source permits nothing; absent means it did not say */
+    permissions?: PlaylistPermission[];
+}
+/**
+ * generated from [CatalogPlaylistTracks](../../../../../apps/api/data/contracts/playlists/playlists.types.ck#L53)
+ */
+export interface CatalogPlaylistTracks {
+    pluginId: string;
+    playlistId: string;
+    tracks: CatalogTrack[];
+}
+/**
+ * generated from [CatalogPlaylistPage](../../../../../apps/api/data/contracts/playlists/playlists.types.ck#L48)
+ */
+export interface CatalogPlaylistPage {
+    playlists: CatalogPlaylist[];
+    errors: CatalogSourceError[];
+}
+//# sourceMappingURL=playlists.types.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"playlists.types.d.ts","sourceRoot":"","sources":["../../../src/playlists/types/playlists.types.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,MAAM,MAAM,kBAAkB,GAAG,MAAM,GAAG,MAAM,CAAC;AAEjD;;;;;;;;GAQG;AACH,MAAM,WAAW,YAAY;IACzB,wGAAwG;IACxG,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,EAAE,MAAM,CAAC;IACd,oFAAoF;IACpF,OAAO,EAAE,MAAM,EAAE,CAAC;IAClB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,2FAA2F;IAC3F,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,2CAA2C;IAC3C,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,yFAAyF;IACzF,OAAO,CAAC,EAAE,MAAM,CAAC;CACpB;AAED;;;GAGG;AACH,MAAM,WAAW,kBAAkB;IAC/B,QAAQ,EAAE,MAAM,CAAC;IACjB,UAAU,EAAE,MAAM,CAAC;IACnB,OAAO,EAAE,MAAM,CAAC;CACnB;AAED;;;GAGG;AACH,MAAM,WAAW,eAAe;IAC5B,QAAQ,EAAE,MAAM,CAAC;IACjB,UAAU,EAAE,MAAM,CAAC;IACnB,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,wJAAwJ;IACxJ,WAAW,CAAC,EAAE,kBAAkB,EAAE,CAAC;CACtC;AAED;;GAEG;AACH,MAAM,WAAW,qBAAqB;IAClC,QAAQ,EAAE,MAAM,CAAC;IACjB,UAAU,EAAE,MAAM,CAAC;IACnB,MAAM,EAAE,YAAY,EAAE,CAAC;CAC1B;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAChC,SAAS,EAAE,eAAe,EAAE,CAAC;IAC7B,MAAM,EAAE,kBAAkB,EAAE,CAAC;CAChC"}

package/dist/playout/playout.client.d.ts

@@ -0,0 +1,37 @@
+import type { SdkFetch } from '../sdk-options.js';
+import type { PlayoutChartInput, PlayoutPlaylistInput, PlayoutStatus } from './types/playout.types.js';
+export declare class PlayoutClient {
+    private fetch;
+    constructor(fetch: SdkFetch);
+    /**
+     * @name Get playout status
+     * @description What the station is playing and what is queued behind it. The console polls this
+     */
+    getPlayoutStatus(): Promise<PlayoutStatus>;
+    /**
+     * @name Play a playlist
+     * @description Loads a plugin playlist into the running order and starts handing it to the player. Replaces whatever was queued; what is on air finishes rather than being cut off
+     */
+    playAPlaylist(body: PlayoutPlaylistInput): Promise<PlayoutStatus>;
+    /**
+     * @name Play a chart
+     * @description Builds the running order from a published chart and starts handing it to the player. The same replacement a playlist makes, from a document somebody else ranked
+     */
+    playAChart(body: PlayoutChartInput): Promise<PlayoutStatus>;
+    /**
+     * @name Skip the current item
+     * @description Ends the item on air so the next one starts immediately. The station owns the decoder, so this lands at once rather than waiting out audio already committed to a player
+     */
+    skipTheCurrentItem(): Promise<PlayoutStatus>;
+    /**
+     * @name Start playout
+     * @description Puts the station back on air with the running order it already has, picking it up where Stop left it. Distinct from putting a playlist on air, which builds a new broadcast and throws away what was there. Refused when there is nothing left to resume
+     */
+    startPlayout(): Promise<PlayoutStatus>;
+    /**
+     * @name Stop playout
+     * @description Stands the station down: stops what is on air at once and hands the mount back. The running order is LEFT as it is, so `/playout/start` can pick it up where this stopped it. deadair holds the mount on a lease it renews while it has something to play, so stopping goes quiet rather than falling through to a bed nobody programmed
+     */
+    stopPlayout(): Promise<PlayoutStatus>;
+}
+//# sourceMappingURL=playout.client.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"playout.client.d.ts","sourceRoot":"","sources":["../../src/playout/playout.client.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAC;AAElD,OAAO,KAAK,EAAE,iBAAiB,EAAE,oBAAoB,EAAE,aAAa,EAAE,MAAM,0BAA0B,CAAC;AAEvG,qBAAa,aAAa;IACV,OAAO,CAAC,KAAK;gBAAL,KAAK,EAAE,QAAQ;IAEnC;;;OAGG;IACG,gBAAgB,IAAI,OAAO,CAAC,aAAa,CAAC;IAKhD;;;OAGG;IACG,aAAa,CAAC,IAAI,EAAE,oBAAoB,GAAG,OAAO,CAAC,aAAa,CAAC;IASvE;;;OAGG;IACG,UAAU,CAAC,IAAI,EAAE,iBAAiB,GAAG,OAAO,CAAC,aAAa,CAAC;IASjE;;;OAGG;IACG,kBAAkB,IAAI,OAAO,CAAC,aAAa,CAAC;IAKlD;;;OAGG;IACG,YAAY,IAAI,OAAO,CAAC,aAAa,CAAC;IAK5C;;;OAGG;IACG,WAAW,IAAI,OAAO,CAAC,aAAa,CAAC;CAI9C"}

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

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

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

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

package/dist/playout/types/playout.types.d.ts

@@ -0,0 +1,163 @@
+/**
+ * The plugin playlist to load into the running order
+ * generated from [PlayoutPlaylistInput](../../../../../apps/api/data/contracts/playout/playout.types.ck#L7)
+ */
+export interface PlayoutPlaylistInput {
+    pluginId: string;
+    playlistId: string;
+}
+/**
+ * The published chart to build the running order from
+ * generated from [PlayoutChartInput](../../../../../apps/api/data/contracts/playout/playout.types.ck#L12)
+ */
+export interface PlayoutChartInput {
+    /** As `pluginId:chartId`, which is how `GET /charts` lists them */
+    chartId: string;
+    /** Which way round to play it. Absent is `countdown`, which opens on the lowest rank and ends on number one */
+    chartOrder?: 'countdown' | 'ranked' | 'unordered';
+}
+/**
+ * One item in the running order, as the console sees it
+ * generated from [PlayoutItem](../../../../../apps/api/data/contracts/playout/playout.types.ck#L17)
+ */
+export interface PlayoutItem {
+    /** deadair's own id for this item, not the provider's: a playlist may hold the same track twice */
+    id: string;
+    pluginId: string;
+    /** The track's id in its plugin's id space */
+    externalId: string;
+    title: string;
+    artists: string[];
+    /** Integer milliseconds. Deliberately not the `duration` scalar, which is a Luxon `Duration` over an ISO-8601 string */
+    durationMs?: number;
+    album?: string;
+    /** The locally cached cover where there is one, the provider's URL otherwise */
+    artworkUrl?: string;
+    /** First release year, when the catalog knows one */
+    year?: number;
+    /** The canonical `deadair.tracks` id, when this item is a track the catalog holds. Absent for anything the catalog has never seen */
+    trackId?: string;
+}
+/**
+ * A stream container still running config the app has replaced. Icecast and Liquidsoap read
+ * their rendered config ONCE, at startup, and nothing restarts or signals them when it is
+ * re-rendered — so a reseeded secret leaves a process holding credentials that match nothing,
+ * and the symptom names something else entirely (every listener refused, or no mount at all).
+ * The app cannot restart a sibling container and should not be able to, so it reports.
+ * generated from [StreamConfigWarning](../../../../../apps/api/data/contracts/playout/playout.types.ck#L41)
+ */
+export interface StreamConfigWarning {
+    /** Which one is behind */
+    container: 'icecast' | 'liquidsoap';
+    /** What is wrong and how it is known, in a sentence */
+    detail: string;
+    /** The exact command that adopts the new config, which is the only thing that does */
+    restart: string;
+}
+/**
+ * Which gate is keeping the station quiet, or `airing` when none of them is. Ordered by cause: a
+ * stalled transport loop makes every reading under it stale, so it is ruled out first
+ * generated from [SilenceCause](../../../../../apps/api/data/contracts/playout/playout.types.ck#L49)
+ */
+export type SilenceCause = 'airing' | 'transportStalled' | 'controlDenied' | 'streamUnreachable' | 'configNotAdopted' | 'stoodDown' | 'noProgramme' | 'noAudience' | 'warmingUp' | 'waitingOnAudio' | 'notDriving' | 'starved';
+/**
+ * How one gate is doing. `waiting` is its own state rather than a mild fault, because a station
+ * idling for want of a listener and a station that cannot reach its stream are both silent and only
+ * one of them is something to go and fix
+ * generated from [SilenceState](../../../../../apps/api/data/contracts/playout/playout.types.ck#L67)
+ */
+export type SilenceState = 'ok' | 'waiting' | 'fault';
+/**
+ * One mount the station is publishing right now
+ * generated from [PlayoutMount](../../../../../apps/api/data/contracts/playout/playout.types.ck#L84)
+ */
+export interface PlayoutMount {
+    format: 'mp3' | 'opus' | 'aac' | 'flac';
+    /** Same-origin path, on the same terms as `PlayoutStatus.mountPath` */
+    path: string;
+    /** Absent for FLAC, which is lossless and has no rate to set */
+    bitrateKbps?: number;
+}
+/**
+ * Which rundown item Liquidsoap has just started playing
+ * generated from [PlayoutAiredQuery](../../../../../apps/api/data/contracts/playout/playout.types.ck#L104)
+ */
+export interface PlayoutAiredQuery {
+    /** The id the app put on the pushed uri's `annotate:` metadata */
+    item: string;
+}
+/**
+ * Which way the running order went, and how long it had been that way
+ * generated from [PlayoutStarveQuery](../../../../../apps/api/data/contracts/playout/playout.types.ck#L108)
+ */
+export interface PlayoutStarveQuery {
+    /** `starved`: the queue stopped producing while deadair was driving, so the mount fell through to the local bed. `recovered`: it is producing again */
+    state: 'starved' | 'recovered';
+    /** How long the PREVIOUS state lasted, in milliseconds. On a recovery this is the length of the gap, which is the number worth reading */
+    forMs: number;
+}
+/**
+ * What the PLAYER says is airing, which is not the same as what was last handed to it
+ * generated from [PlayoutNowPlaying](../../../../../apps/api/data/contracts/playout/playout.types.ck#L30)
+ */
+export interface PlayoutNowPlaying {
+    item: PlayoutItem;
+    /** Unix epoch millis, as observed when the player reported it */
+    startedAt: number;
+    /** The decoder's own countdown, absent when it cannot say. It leads the listener by the encoder and client buffers */
+    remainingMs?: number;
+}
+/**
+ * One gate's answer about itself
+ * generated from [SilenceCheck](../../../../../apps/api/data/contracts/playout/playout.types.ck#L69)
+ */
+export interface SilenceCheck {
+    /** Never `airing`, which is the absence of a blocking gate rather than a gate */
+    code: SilenceCause;
+    state: SilenceState;
+    /** What this gate is doing right now, whether or not it is the one blocking */
+    detail: string;
+    /** What would clear it, where there is something an operator can actually do */
+    remedy?: string;
+}
+/**
+ * Why the station cannot be heard, as one answer
+ * generated from [StationSilence](../../../../../apps/api/data/contracts/playout/playout.types.ck#L76)
+ */
+export interface StationSilence {
+    /** Whether the station believes its programme is reaching the mount. NOT whether anybody is hearing it: a station can be audible with no listeners in `always` mode, and can have listeners while airing the local bed */
+    audible: boolean;
+    cause: SilenceCause;
+    detail: string;
+    remedy?: string;
+    /** Every gate, in the order they are judged, so a console can say what it ruled out. A `configNotAdopted` fault appears here and is never the cause, because a station can air perfectly well while it is true */
+    checks: SilenceCheck[];
+}
+/**
+ * The station's transport, as one reading
+ * generated from [PlayoutStatus](../../../../../apps/api/data/contracts/playout/playout.types.ck#L90)
+ */
+export interface PlayoutStatus {
+    /** Whether Liquidsoap's control API is answering at all. False means nothing can air, whatever the running order holds */
+    streamUp: boolean;
+    /** Whether the station is actually broadcasting. deadair holds the mount on a lease it renews only while it has a programme, so a reachable stream with nothing to play is up and NOT on air: it is connected, and airing silence */
+    onAir: boolean;
+    /** Same-origin path of the Icecast MP3 mount, which is always published and is the one a console names when it can only name one. A path rather than a URL: the browser reaches Icecast through whatever edge served the SPA, never at the address the app itself uses */
+    mountPath: string;
+    /** Every mount being published, MP3 first, so a console can offer the others rather than implying the station is only on one. Never empty: MP3 has no switch. A format the operator has not switched on is absent rather than present and disabled, because every consumer of this wants the mounts that are actually there */
+    mounts: PlayoutMount[];
+    nowPlaying?: PlayoutNowPlaying;
+    /** Waiting here, in order. Excludes what the player already holds */
+    upNext: PlayoutItem[];
+    /** How many items are waiting in total, of which `upNext` is the head */
+    queuedCount: number;
+    /** How many clients Icecast has attached to the mount. Zero both for "nobody is listening" and for an Icecast that is not answering, which `audience` is where to tell apart */
+    listeners: number;
+    /** Whether the station counts as having an audience, which lingers for a minute past the last listener so a reconnecting player does not cut the broadcast */
+    audience: boolean;
+    /** Containers running config the app has since replaced. Empty is the ordinary state, and so is empty for anything the app has no evidence about: a warning here has never been a guess */
+    staleStreamConfig: StreamConfigWarning[];
+    /** Which gate is keeping the station quiet, composed from every one of them rather than inferred from the fields above. `streamUp`, `onAir`, `audience` and `queuedCount` each answer for one gate and a console reading them alone has to guess at the rest */
+    silence: StationSilence;
+}
+//# sourceMappingURL=playout.types.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"playout.types.d.ts","sourceRoot":"","sources":["../../../src/playout/types/playout.types.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,MAAM,WAAW,oBAAoB;IACjC,QAAQ,EAAE,MAAM,CAAC;IACjB,UAAU,EAAE,MAAM,CAAC;CACtB;AAED;;;GAGG;AACH,MAAM,WAAW,iBAAiB;IAC9B,mEAAmE;IACnE,OAAO,EAAE,MAAM,CAAC;IAChB,+GAA+G;IAC/G,UAAU,CAAC,EAAE,WAAW,GAAG,QAAQ,GAAG,WAAW,CAAC;CACrD;AAED;;;GAGG;AACH,MAAM,WAAW,WAAW;IACxB,mGAAmG;IACnG,EAAE,EAAE,MAAM,CAAC;IACX,QAAQ,EAAE,MAAM,CAAC;IACjB,8CAA8C;IAC9C,UAAU,EAAE,MAAM,CAAC;IACnB,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,EAAE,MAAM,EAAE,CAAC;IAClB,wHAAwH;IACxH,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,gFAAgF;IAChF,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,qDAAqD;IACrD,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,qIAAqI;IACrI,OAAO,CAAC,EAAE,MAAM,CAAC;CACpB;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,mBAAmB;IAChC,0BAA0B;IAC1B,SAAS,EAAE,SAAS,GAAG,YAAY,CAAC;IACpC,uDAAuD;IACvD,MAAM,EAAE,MAAM,CAAC;IACf,sFAAsF;IACtF,OAAO,EAAE,MAAM,CAAC;CACnB;AAED;;;;GAIG;AACH,MAAM,MAAM,YAAY,GAClB,QAAQ,GACR,kBAAkB,GAClB,eAAe,GACf,mBAAmB,GACnB,kBAAkB,GAClB,WAAW,GACX,aAAa,GACb,YAAY,GACZ,WAAW,GACX,gBAAgB,GAChB,YAAY,GACZ,SAAS,CAAC;AAEhB;;;;;GAKG;AACH,MAAM,MAAM,YAAY,GAAG,IAAI,GAAG,SAAS,GAAG,OAAO,CAAC;AAEtD;;;GAGG;AACH,MAAM,WAAW,YAAY;IACzB,MAAM,EAAE,KAAK,GAAG,MAAM,GAAG,KAAK,GAAG,MAAM,CAAC;IACxC,uEAAuE;IACvE,IAAI,EAAE,MAAM,CAAC;IACb,gEAAgE;IAChE,WAAW,CAAC,EAAE,MAAM,CAAC;CACxB;AAED;;;GAGG;AACH,MAAM,WAAW,iBAAiB;IAC9B,kEAAkE;IAClE,IAAI,EAAE,MAAM,CAAC;CAChB;AAED;;;GAGG;AACH,MAAM,WAAW,kBAAkB;IAC/B,uJAAuJ;IACvJ,KAAK,EAAE,SAAS,GAAG,WAAW,CAAC;IAC/B,0IAA0I;IAC1I,KAAK,EAAE,MAAM,CAAC;CACjB;AAED;;;GAGG;AACH,MAAM,WAAW,iBAAiB;IAC9B,IAAI,EAAE,WAAW,CAAC;IAClB,iEAAiE;IACjE,SAAS,EAAE,MAAM,CAAC;IAClB,sHAAsH;IACtH,WAAW,CAAC,EAAE,MAAM,CAAC;CACxB;AAED;;;GAGG;AACH,MAAM,WAAW,YAAY;IACzB,iFAAiF;IACjF,IAAI,EAAE,YAAY,CAAC;IACnB,KAAK,EAAE,YAAY,CAAC;IACpB,+EAA+E;IAC/E,MAAM,EAAE,MAAM,CAAC;IACf,gFAAgF;IAChF,MAAM,CAAC,EAAE,MAAM,CAAC;CACnB;AAED;;;GAGG;AACH,MAAM,WAAW,cAAc;IAC3B,0NAA0N;IAC1N,OAAO,EAAE,OAAO,CAAC;IACjB,KAAK,EAAE,YAAY,CAAC;IACpB,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,kNAAkN;IAClN,MAAM,EAAE,YAAY,EAAE,CAAC;CAC1B;AAED;;;GAGG;AACH,MAAM,WAAW,aAAa;IAC1B,0HAA0H;IAC1H,QAAQ,EAAE,OAAO,CAAC;IAClB,qOAAqO;IACrO,KAAK,EAAE,OAAO,CAAC;IACf,0QAA0Q;IAC1Q,SAAS,EAAE,MAAM,CAAC;IAClB,+TAA+T;IAC/T,MAAM,EAAE,YAAY,EAAE,CAAC;IACvB,UAAU,CAAC,EAAE,iBAAiB,CAAC;IAC/B,qEAAqE;IACrE,MAAM,EAAE,WAAW,EAAE,CAAC;IACtB,yEAAyE;IACzE,WAAW,EAAE,MAAM,CAAC;IACpB,gLAAgL;IAChL,SAAS,EAAE,MAAM,CAAC;IAClB,8JAA8J;IAC9J,QAAQ,EAAE,OAAO,CAAC;IAClB,2LAA2L;IAC3L,iBAAiB,EAAE,mBAAmB,EAAE,CAAC;IACzC,gQAAgQ;IAChQ,OAAO,EAAE,cAAc,CAAC;CAC3B"}

package/dist/plugins/plugins.client.d.ts

@@ -0,0 +1,107 @@
+import type { SdkFetch } from '../sdk-options.js';
+import type { PluginConfigInput, PluginDetail, PluginFieldSuggestions, PluginGrantInput, PluginGrantList, PluginImportResult, PluginLogLevelInput, PluginLogPage, PluginLogQuery, PluginOAuthCallbackQuery, PluginOAuthResult, PluginOAuthStart, PluginSummary, PluginTestResult } from './types/plugins.types.js';
+export declare class PluginsClient {
+    private fetch;
+    constructor(fetch: SdkFetch);
+    /**
+     * @name List plugins
+     * @description Lists every plugin the host knows about
+     */
+    listPlugins(): Promise<PluginSummary[]>;
+    /**
+     * @name List plugin grants
+     * @description Every capability an installed plugin is asking the operator for, with the answer so far
+     */
+    listPluginGrants(): Promise<PluginGrantList>;
+    /**
+     * @name Rescan plugins
+     * @description Rescans the mounted plugin directory: registers new plugins, unloads removed ones
+     */
+    rescanPlugins(): Promise<PluginSummary[]>;
+    /**
+     * @name Import plugin
+     * @description Takes a plugin in from the browser as the tarball npm pack writes and puts it in the plugins directory. It lands disabled, and a newer version of an installed plugin replaces the older one
+     */
+    importPlugin(body: FormData): Promise<PluginImportResult>;
+    /**
+     * @name Get plugin
+     * @description One plugin, including its stored non-secret configuration and last error
+     */
+    getPlugin(id: string): Promise<PluginDetail>;
+    /**
+     * @name Remove plugin
+     * @description Removes a plugin the operator installed: stops it and deletes its folder. Its settings are kept, so importing it again brings them back. A bundled plugin is refused
+     */
+    removePlugin(id: string): Promise<PluginSummary[]>;
+    /**
+     * @name Update plugin configuration
+     * @description Validates against the plugin's own config schema, encrypts secrets, persists, and reinitializes
+     */
+    updatePluginConfiguration(id: string, body: PluginConfigInput): Promise<PluginDetail>;
+    /**
+     * @name Enable plugin
+     * @description Enables a plugin without resubmitting its configuration
+     */
+    enablePlugin(id: string): Promise<PluginDetail>;
+    /**
+     * @name Disable plugin
+     * @description Disables a plugin and tears its instance down, keeping its configuration
+     */
+    disablePlugin(id: string): Promise<PluginDetail>;
+    /**
+     * @name Decide plugin grant
+     * @description Answers one capability this plugin asked for. Takes effect on the next fetch, with no reload
+     */
+    decidePluginGrant(id: string, body: PluginGrantInput): Promise<PluginGrantList>;
+    /**
+     * @name Reload plugin
+     * @description Reapplies the plugin's stored configuration: disposes the running instance and initializes it again
+     */
+    reloadPlugin(id: string): Promise<PluginDetail>;
+    /**
+     * @name Test plugin connection
+     * @description Runs the plugin's own `testConnection()` through the invoker
+     */
+    testPluginConnection(id: string): Promise<PluginTestResult>;
+    /**
+     * @name Suggest plugin config options
+     * @description Asks the plugin what to offer for its config fields right now, through the invoker
+     */
+    suggestPluginConfigOptions(id: string): Promise<PluginFieldSuggestions>;
+    /**
+     * @name Get plugin logs
+     * @description Returns the plugin's buffered log lines at or above the current log level
+     */
+    getPluginLogs(id: string, query?: PluginLogQuery): Promise<PluginLogPage>;
+    /**
+     * @name Download plugin logs
+     * @description Streams the plugin's full retained log as a plain-text attachment
+     */
+    downloadPluginLogs(id: string): Promise<{
+        data: string;
+        headers: {
+            contentDisposition?: string;
+        };
+    }>;
+    /**
+     * @name Set plugin log level
+     * @description Sets the minimum severity the plugin's log store retains going forward
+     */
+    setPluginLogLevel(id: string, body: PluginLogLevelInput): Promise<PluginDetail>;
+    /**
+     * @name Start plugin OAuth authorization
+     * @description Reports where to send the operator for the provider's consent screen
+     */
+    startPluginOAuthAuthorization(id: string): Promise<PluginOAuthStart>;
+    /**
+     * @name Disconnect plugin OAuth
+     * @description Forgets the plugin's stored OAuth tokens and reinitializes it
+     */
+    disconnectPluginOAuth(id: string): Promise<PluginDetail>;
+    /**
+     * @name Complete plugin OAuth authorization
+     * @description Completes the flow. Anonymous: the provider redirects the browser here with no session of ours
+     */
+    completePluginOAuthAuthorization(id: string, query?: PluginOAuthCallbackQuery): Promise<PluginOAuthResult>;
+}
+//# sourceMappingURL=plugins.client.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"plugins.client.d.ts","sourceRoot":"","sources":["../../src/plugins/plugins.client.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAC;AAElD,OAAO,KAAK,EACR,iBAAiB,EACjB,YAAY,EACZ,sBAAsB,EACtB,gBAAgB,EAChB,eAAe,EACf,kBAAkB,EAClB,mBAAmB,EACnB,aAAa,EACb,cAAc,EACd,wBAAwB,EACxB,iBAAiB,EACjB,gBAAgB,EAChB,aAAa,EACb,gBAAgB,EACnB,MAAM,0BAA0B,CAAC;AAGlC,qBAAa,aAAa;IACV,OAAO,CAAC,KAAK;gBAAL,KAAK,EAAE,QAAQ;IAEnC;;;OAGG;IACG,WAAW,IAAI,OAAO,CAAC,aAAa,EAAE,CAAC;IAK7C;;;OAGG;IACG,gBAAgB,IAAI,OAAO,CAAC,eAAe,CAAC;IAKlD;;;OAGG;IACG,aAAa,IAAI,OAAO,CAAC,aAAa,EAAE,CAAC;IAK/C;;;OAGG;IACG,YAAY,CAAC,IAAI,EAAE,QAAQ,GAAG,OAAO,CAAC,kBAAkB,CAAC;IAQ/D;;;OAGG;IACG,SAAS,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,YAAY,CAAC;IAKlD;;;OAGG;IACG,YAAY,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,aAAa,EAAE,CAAC;IAKxD;;;OAGG;IACG,yBAAyB,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,iBAAiB,GAAG,OAAO,CAAC,YAAY,CAAC;IAS3F;;;OAGG;IACG,YAAY,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,YAAY,CAAC;IAKrD;;;OAGG;IACG,aAAa,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,YAAY,CAAC;IAKtD;;;OAGG;IACG,iBAAiB,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,gBAAgB,GAAG,OAAO,CAAC,eAAe,CAAC;IASrF;;;OAGG;IACG,YAAY,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,YAAY,CAAC;IAKrD;;;OAGG;IACG,oBAAoB,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,gBAAgB,CAAC;IAKjE;;;OAGG;IACG,0BAA0B,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,sBAAsB,CAAC;IAK7E;;;OAGG;IACG,aAAa,CAAC,EAAE,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,aAAa,CAAC;IAQ/E;;;OAGG;IACG,kBAAkB,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE;YAAE,kBAAkB,CAAC,EAAE,MAAM,CAAA;SAAE,CAAA;KAAE,CAAC;IAMzG;;;OAGG;IACG,iBAAiB,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,mBAAmB,GAAG,OAAO,CAAC,YAAY,CAAC;IASrF;;;OAGG;IACG,6BAA6B,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,gBAAgB,CAAC;IAK1E;;;OAGG;IACG,qBAAqB,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,YAAY,CAAC;IAK9D;;;OAGG;IACG,gCAAgC,CAAC,EAAE,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,wBAAwB,GAAG,OAAO,CAAC,iBAAiB,CAAC;CAOnH"}

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

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

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

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