@deadair/sdk 0.31.2 → 0.32.0

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.32.0",
   "description": "A typed client for the deadair station's HTTP API, generated from the same contracts the station serves.",
   "keywords": [
     "deadair",