@deadair/sdk 0.31.2 → 0.31.3

package/dist/messaging/messaging.client.d.ts

@@ -0,0 +1,22 @@
+import type { SdkFetch } from '../sdk-options.js';
+import type { MessagingLinkCode, MessagingLinkList } from './types/messaging.types.js';
+export declare class MessagingClient {
+    private fetch;
+    constructor(fetch: SdkFetch);
+    /**
+     * @name List messaging links
+     * @description The chat accounts linked to the signed-in account
+     */
+    listMessagingLinks(): Promise<MessagingLinkList>;
+    /**
+     * @name Create messaging link code
+     * @description A new one-time code for linking a chat account. It replaces any earlier code and stops working after ten minutes
+     */
+    createMessagingLinkCode(): Promise<MessagingLinkCode>;
+    /**
+     * @name Remove messaging link
+     * @description Unlink a chat account. Its operator commands are refused from the next one on
+     */
+    removeMessagingLink(pluginId: string, platformUserId: string): Promise<void>;
+}
+//# sourceMappingURL=messaging.client.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"messaging.client.d.ts","sourceRoot":"","sources":["../../src/messaging/messaging.client.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAC;AAElD,OAAO,KAAK,EAAE,iBAAiB,EAAE,iBAAiB,EAAE,MAAM,4BAA4B,CAAC;AAGvF,qBAAa,eAAe;IACZ,OAAO,CAAC,KAAK;gBAAL,KAAK,EAAE,QAAQ;IAEnC;;;OAGG;IACG,kBAAkB,IAAI,OAAO,CAAC,iBAAiB,CAAC;IAKtD;;;OAGG;IACG,uBAAuB,IAAI,OAAO,CAAC,iBAAiB,CAAC;IAK3D;;;OAGG;IACG,mBAAmB,CAAC,QAAQ,EAAE,MAAM,EAAE,cAAc,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;CAGrF"}

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

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

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

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

package/dist/messaging/types/messaging.types.d.ts

@@ -0,0 +1,39 @@
+import { DateTime } from 'luxon';
+/**
+ * A one-time code that links a chat account to the signed-in station account. Shown once: send it to the station's bot as `/link CODE` in a direct message
+ * generated from [MessagingLinkCode](../../../../../apps/api/data/contracts/messaging/messaging.types.ck#L7)
+ */
+export interface MessagingLinkCode {
+    /** The code itself. Case does not matter when it is sent */
+    code: string;
+    /** When the code stops working. A new code replaces any earlier one */
+    expiresAt: DateTime;
+}
+/** Rehydrates every wire-encoded scalar in a MessagingLinkCode into its runtime type. Mutates and returns `raw`. */
+export declare function reviveMessagingLinkCode(raw: MessagingLinkCode): MessagingLinkCode;
+/**
+ * A chat account linked to the signed-in station account. Operator commands sent from it run with this account's permissions
+ * generated from [MessagingLink](../../../../../apps/api/data/contracts/messaging/messaging.types.ck#L12)
+ */
+export interface MessagingLink {
+    /** Which messaging plugin the chat account is on, for example `deadair.telegram` */
+    pluginId: string;
+    /** The chat platform's own id for the person */
+    platformUserId: string;
+    /** What the chat platform called them when they linked */
+    displayName: string;
+    /** When the link was made */
+    createdAt: DateTime;
+}
+/** Rehydrates every wire-encoded scalar in a MessagingLink into its runtime type. Mutates and returns `raw`. */
+export declare function reviveMessagingLink(raw: MessagingLink): MessagingLink;
+/**
+ * Every chat account linked to the signed-in station account, newest first
+ * generated from [MessagingLinkList](../../../../../apps/api/data/contracts/messaging/messaging.types.ck#L19)
+ */
+export interface MessagingLinkList {
+    links: MessagingLink[];
+}
+/** Rehydrates every wire-encoded scalar in a MessagingLinkList into its runtime type. Mutates and returns `raw`. */
+export declare function reviveMessagingLinkList(raw: MessagingLinkList): MessagingLinkList;
+//# sourceMappingURL=messaging.types.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"messaging.types.d.ts","sourceRoot":"","sources":["../../../src/messaging/types/messaging.types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,OAAO,CAAC;AAUjC;;;GAGG;AACH,MAAM,WAAW,iBAAiB;IAC9B,4DAA4D;IAC5D,IAAI,EAAE,MAAM,CAAC;IACb,uEAAuE;IACvE,SAAS,EAAE,QAAQ,CAAC;CACvB;AAED,oHAAoH;AACpH,wBAAgB,uBAAuB,CAAC,GAAG,EAAE,iBAAiB,GAAG,iBAAiB,CAIjF;AAED;;;GAGG;AACH,MAAM,WAAW,aAAa;IAC1B,oFAAoF;IACpF,QAAQ,EAAE,MAAM,CAAC;IACjB,gDAAgD;IAChD,cAAc,EAAE,MAAM,CAAC;IACvB,0DAA0D;IAC1D,WAAW,EAAE,MAAM,CAAC;IACpB,6BAA6B;IAC7B,SAAS,EAAE,QAAQ,CAAC;CACvB;AAED,gHAAgH;AAChH,wBAAgB,mBAAmB,CAAC,GAAG,EAAE,aAAa,GAAG,aAAa,CAIrE;AAED;;;GAGG;AACH,MAAM,WAAW,iBAAiB;IAC9B,KAAK,EAAE,aAAa,EAAE,CAAC;CAC1B;AAED,oHAAoH;AACpH,wBAAgB,uBAAuB,CAAC,GAAG,EAAE,iBAAiB,GAAG,iBAAiB,CASjF"}

package/dist/requests/requests.client.d.ts

@@ -0,0 +1,42 @@
+import type { SdkFetch } from '../sdk-options.js';
+import type { ListenerRequest, ListenerRequestCreate, ListenerRequestDecline, ListenerRequestList, RequestStatus, RequestableTrackList } from './types/requests.types.js';
+export declare class RequestsClient {
+    private fetch;
+    constructor(fetch: SdkFetch);
+    /**
+     * @name Search requestable records
+     * @description Records the station could be asked to play, matching a title or an artist
+     */
+    searchRequestableRecords(query: {
+        q: string;
+        limit?: number;
+    }): Promise<RequestableTrackList>;
+    /**
+     * @name List requests
+     * @description Every recent request, for the operator deciding on them
+     */
+    listRequests(query?: {
+        status?: RequestStatus;
+    }): Promise<ListenerRequestList>;
+    /**
+     * @name Create request
+     * @description Ask the station to play a record. Answers with the request whatever became of it, so a refusal says why in `reason`
+     */
+    createRequest(body: ListenerRequestCreate): Promise<ListenerRequest>;
+    /**
+     * @name List my requests
+     * @description The signed-in account's own recent requests
+     */
+    listMyRequests(): Promise<ListenerRequestList>;
+    /**
+     * @name Grant request
+     * @description Let a waiting request through. It goes into the running order once its audio is here
+     */
+    grantRequest(id: string): Promise<ListenerRequest>;
+    /**
+     * @name Decline request
+     * @description Turn a request down. One already in the running order is left there; take it out of the order instead
+     */
+    declineRequest(id: string, body: ListenerRequestDecline): Promise<ListenerRequest>;
+}
+//# sourceMappingURL=requests.client.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"requests.client.d.ts","sourceRoot":"","sources":["../../src/requests/requests.client.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAC;AAElD,OAAO,KAAK,EACR,eAAe,EACf,qBAAqB,EACrB,sBAAsB,EACtB,mBAAmB,EACnB,aAAa,EACb,oBAAoB,EACvB,MAAM,2BAA2B,CAAC;AAGnC,qBAAa,cAAc;IACX,OAAO,CAAC,KAAK;gBAAL,KAAK,EAAE,QAAQ;IAEnC;;;OAGG;IACG,wBAAwB,CAAC,KAAK,EAAE;QAAE,CAAC,EAAE,MAAM,CAAC;QAAC,KAAK,CAAC,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,oBAAoB,CAAC;IAQnG;;;OAGG;IACG,YAAY,CAAC,KAAK,CAAC,EAAE;QAAE,MAAM,CAAC,EAAE,aAAa,CAAA;KAAE,GAAG,OAAO,CAAC,mBAAmB,CAAC;IAQpF;;;OAGG;IACG,aAAa,CAAC,IAAI,EAAE,qBAAqB,GAAG,OAAO,CAAC,eAAe,CAAC;IAS1E;;;OAGG;IACG,cAAc,IAAI,OAAO,CAAC,mBAAmB,CAAC;IAKpD;;;OAGG;IACG,YAAY,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,eAAe,CAAC;IAKxD;;;OAGG;IACG,cAAc,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,sBAAsB,GAAG,OAAO,CAAC,eAAe,CAAC;CAQ3F"}

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

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

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

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

package/dist/requests/types/requests.types.d.ts

@@ -0,0 +1,89 @@
+import { DateTime } from 'luxon';
+/**
+ * A record the station holds and could be asked for
+ * generated from [RequestableTrack](../../../../../apps/api/data/contracts/requests/requests.types.ck#L7)
+ */
+export interface RequestableTrack {
+    /** What to send as `trackId` to make the request */
+    trackId: string;
+    title: string;
+    /** The lead artist */
+    artist: string;
+    album?: string;
+    year?: number;
+}
+/**
+ * generated from [RequestStatus](../../../../../apps/api/data/contracts/requests/requests.types.ck#L19)
+ */
+export type RequestStatus = 'waiting' | 'pending' | 'queued' | 'aired' | 'declined' | 'expired';
+/**
+ * generated from [RequestSource](../../../../../apps/api/data/contracts/requests/requests.types.ck#L21)
+ */
+export type RequestSource = 'app' | 'chat';
+/**
+ * Ask the station to play a record
+ * generated from [ListenerRequestCreate](../../../../../apps/api/data/contracts/requests/requests.types.ck#L41)
+ */
+export interface ListenerRequestCreate {
+    /** A record from the request search */
+    trackId: string;
+    /** What the station should call you. Omitted, you are "a listener": your account's email address is never shown or read out */
+    name?: string;
+    /** Dedicate it to somebody. The station may say this name on air */
+    dedicateTo?: string;
+    /** A few words to go with it. The presenter may put them in their own words on air, and leaves out anything unfit to broadcast; the words themselves are never read out */
+    message?: string;
+}
+/**
+ * Turn a request down
+ * generated from [ListenerRequestDecline](../../../../../apps/api/data/contracts/requests/requests.types.ck#L48)
+ */
+export interface ListenerRequestDecline {
+    /** What to tell the listener. Omit for a plain no */
+    reason?: string;
+}
+/**
+ * Records matching a search, best matches first
+ * generated from [RequestableTrackList](../../../../../apps/api/data/contracts/requests/requests.types.ck#L15)
+ */
+export interface RequestableTrackList {
+    tracks: RequestableTrack[];
+}
+/**
+ * A record somebody asked the station to play, and what became of it
+ * generated from [ListenerRequest](../../../../../apps/api/data/contracts/requests/requests.types.ck#L23)
+ */
+export interface ListenerRequest {
+    id: string;
+    /** `waiting` for an operator to approve it, `pending` while its audio is fetched or a place is found for it, `queued` in the running order, `aired` once heard, `declined` or `expired` when it never will be */
+    status: RequestStatus;
+    /** The record, as it was called when it was asked for */
+    title: string;
+    artist: string;
+    /** Who asked, by the name their account or chat platform gave */
+    requesterName: string;
+    /** Whether it came from an app or a chat platform */
+    source: RequestSource;
+    /** When it was asked for */
+    createdAt: DateTime;
+    /** Why it was declined or expired, in the station's words or an operator's */
+    reason?: string;
+    /** When it aired */
+    airedAt?: DateTime;
+    /** Who the listener dedicated it to */
+    dedicateTo?: string;
+    /** What the listener asked to have said with it, in their own words */
+    message?: string;
+}
+/** Rehydrates every wire-encoded scalar in a ListenerRequest into its runtime type. Mutates and returns `raw`. */
+export declare function reviveListenerRequest(raw: ListenerRequest): ListenerRequest;
+/**
+ * Requests, newest first
+ * generated from [ListenerRequestList](../../../../../apps/api/data/contracts/requests/requests.types.ck#L37)
+ */
+export interface ListenerRequestList {
+    requests: ListenerRequest[];
+}
+/** Rehydrates every wire-encoded scalar in a ListenerRequestList into its runtime type. Mutates and returns `raw`. */
+export declare function reviveListenerRequestList(raw: ListenerRequestList): ListenerRequestList;
+//# sourceMappingURL=requests.types.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"requests.types.d.ts","sourceRoot":"","sources":["../../../src/requests/types/requests.types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,OAAO,CAAC;AAUjC;;;GAGG;AACH,MAAM,WAAW,gBAAgB;IAC7B,oDAAoD;IACpD,OAAO,EAAE,MAAM,CAAC;IAChB,KAAK,EAAE,MAAM,CAAC;IACd,sBAAsB;IACtB,MAAM,EAAE,MAAM,CAAC;IACf,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,IAAI,CAAC,EAAE,MAAM,CAAC;CACjB;AAED;;GAEG;AACH,MAAM,MAAM,aAAa,GAAG,SAAS,GAAG,SAAS,GAAG,QAAQ,GAAG,OAAO,GAAG,UAAU,GAAG,SAAS,CAAC;AAEhG;;GAEG;AACH,MAAM,MAAM,aAAa,GAAG,KAAK,GAAG,MAAM,CAAC;AAE3C;;;GAGG;AACH,MAAM,WAAW,qBAAqB;IAClC,uCAAuC;IACvC,OAAO,EAAE,MAAM,CAAC;IAChB,+HAA+H;IAC/H,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,oEAAoE;IACpE,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,2KAA2K;IAC3K,OAAO,CAAC,EAAE,MAAM,CAAC;CACpB;AAED;;;GAGG;AACH,MAAM,WAAW,sBAAsB;IACnC,qDAAqD;IACrD,MAAM,CAAC,EAAE,MAAM,CAAC;CACnB;AAED;;;GAGG;AACH,MAAM,WAAW,oBAAoB;IACjC,MAAM,EAAE,gBAAgB,EAAE,CAAC;CAC9B;AAED;;;GAGG;AACH,MAAM,WAAW,eAAe;IAC5B,EAAE,EAAE,MAAM,CAAC;IACX,iNAAiN;IACjN,MAAM,EAAE,aAAa,CAAC;IACtB,yDAAyD;IACzD,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;IACf,iEAAiE;IACjE,aAAa,EAAE,MAAM,CAAC;IACtB,qDAAqD;IACrD,MAAM,EAAE,aAAa,CAAC;IACtB,4BAA4B;IAC5B,SAAS,EAAE,QAAQ,CAAC;IACpB,8EAA8E;IAC9E,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,oBAAoB;IACpB,OAAO,CAAC,EAAE,QAAQ,CAAC;IACnB,uCAAuC;IACvC,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,uEAAuE;IACvE,OAAO,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,kHAAkH;AAClH,wBAAgB,qBAAqB,CAAC,GAAG,EAAE,eAAe,GAAG,eAAe,CAO3E;AAED;;;GAGG;AACH,MAAM,WAAW,mBAAmB;IAChC,QAAQ,EAAE,eAAe,EAAE,CAAC;CAC/B;AAED,sHAAsH;AACtH,wBAAgB,yBAAyB,CAAC,GAAG,EAAE,mBAAmB,GAAG,mBAAmB,CASvF"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@deadair/sdk",
-  "version": "0.31.2",
+  "version": "0.31.3",
   "description": "A typed client for the deadair station's HTTP API, generated from the same contracts the station serves.",
   "keywords": [
     "deadair",