@deadair/sdk 0.52.1 → 0.53.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/catalog/types/catalog.types.d.ts +67 -52
- package/dist/catalog/types/catalog.types.d.ts.map +1 -1
- package/dist/index.d.ts +1 -0
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +99 -14
- package/dist/index.js.map +1 -1
- package/dist/requests/requests.client.d.ts +2 -0
- package/dist/requests/requests.client.d.ts.map +1 -1
- package/dist/requests/requests.party.client.d.ts +30 -0
- package/dist/requests/requests.party.client.d.ts.map +1 -0
- package/dist/requests/types/requests.types.d.ts +56 -0
- package/dist/requests/types/requests.types.d.ts.map +1 -1
- package/package.json +1 -1
|
@@ -1,7 +1,9 @@
|
|
|
1
1
|
import type { SdkFetch } from '../sdk-options.js';
|
|
2
2
|
import type { ListenerRequest, ListenerRequestCreate, ListenerRequestDecline, ListenerRequestList, RequestStatus, RequestableTrackList } from './types/requests.types.js';
|
|
3
|
+
import { RequestsPartyClient } from './requests.party.client.js';
|
|
3
4
|
export declare class RequestsClient {
|
|
4
5
|
private fetch;
|
|
6
|
+
readonly party: RequestsPartyClient;
|
|
5
7
|
constructor(fetch: SdkFetch);
|
|
6
8
|
/**
|
|
7
9
|
* @name Search requestable records
|
|
@@ -1 +1 @@
|
|
|
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;
|
|
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;AAEnC,OAAO,EAAE,mBAAmB,EAAE,MAAM,4BAA4B,CAAC;AAEjE,qBAAa,cAAc;IAGX,OAAO,CAAC,KAAK;IAFzB,QAAQ,CAAC,KAAK,EAAE,mBAAmB,CAAC;gBAEhB,KAAK,EAAE,QAAQ;IAInC;;;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"}
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
import type { PartyGuestSession, PartyJoin, PartyPass, PartyStart, PartyState } from './types/requests.types.js';
|
|
2
|
+
import type { SdkFetch } from '../sdk-options.js';
|
|
3
|
+
/**
|
|
4
|
+
* generated from [requests.party.ck](../../../../apps/api/data/contracts/requests/requests.party.ck)
|
|
5
|
+
*/
|
|
6
|
+
export declare class RequestsPartyClient {
|
|
7
|
+
private fetch;
|
|
8
|
+
constructor(fetch: SdkFetch);
|
|
9
|
+
/**
|
|
10
|
+
* @name Get party
|
|
11
|
+
* @description The party that is on, with its pass, so the console can show the QR code again
|
|
12
|
+
*/
|
|
13
|
+
getParty(): Promise<PartyState>;
|
|
14
|
+
/**
|
|
15
|
+
* @name Start party
|
|
16
|
+
* @description Start a party. A party already on is ended first, which turns its guests away, so there is only ever one pass to scan
|
|
17
|
+
*/
|
|
18
|
+
startParty(body: PartyStart): Promise<PartyPass>;
|
|
19
|
+
/**
|
|
20
|
+
* @name End party
|
|
21
|
+
* @description End the party. Its pass stops working and every guest who joined with it is turned away on their next request
|
|
22
|
+
*/
|
|
23
|
+
endParty(): Promise<void>;
|
|
24
|
+
/**
|
|
25
|
+
* @name Join party
|
|
26
|
+
* @description Join the party as a guest. Answers 404 for a pass that is unknown, ended or run out, without saying which
|
|
27
|
+
*/
|
|
28
|
+
joinParty(body: PartyJoin): Promise<PartyGuestSession>;
|
|
29
|
+
}
|
|
30
|
+
//# sourceMappingURL=requests.party.client.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"requests.party.client.d.ts","sourceRoot":"","sources":["../../src/requests/requests.party.client.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,iBAAiB,EAAE,SAAS,EAAE,SAAS,EAAE,UAAU,EAAE,UAAU,EAAE,MAAM,2BAA2B,CAAC;AAEjH,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAC;AAGlD;;GAEG;AACH,qBAAa,mBAAmB;IAChB,OAAO,CAAC,KAAK;gBAAL,KAAK,EAAE,QAAQ;IAEnC;;;OAGG;IACG,QAAQ,IAAI,OAAO,CAAC,UAAU,CAAC;IAKrC;;;OAGG;IACG,UAAU,CAAC,IAAI,EAAE,UAAU,GAAG,OAAO,CAAC,SAAS,CAAC;IAStD;;;OAGG;IACG,QAAQ,IAAI,OAAO,CAAC,IAAI,CAAC;IAI/B;;;OAGG;IACG,SAAS,CAAC,IAAI,EAAE,SAAS,GAAG,OAAO,CAAC,iBAAiB,CAAC;CAQ/D"}
|
|
@@ -25,6 +25,50 @@ export interface ListenerRequestDecline {
|
|
|
25
25
|
/** What to tell the listener. Omit for a plain no */
|
|
26
26
|
reason?: string;
|
|
27
27
|
}
|
|
28
|
+
/**
|
|
29
|
+
* A party: the pass guests join with by scanning its QR code, for as long as it lasts
|
|
30
|
+
* generated from [PartyPass](../../../../../apps/api/data/contracts/requests/requests.types.ck)
|
|
31
|
+
*/
|
|
32
|
+
export interface PartyPass {
|
|
33
|
+
/** The pass itself. Put it after `#` on the station's `/party` page, as `/party#<token>`, and that address is what the QR code holds. Anyone holding it can join until the party ends, so show it only to the room */
|
|
34
|
+
token: string;
|
|
35
|
+
/** When the party started */
|
|
36
|
+
createdAt: DateTime;
|
|
37
|
+
/** When the pass stops letting guests in, and turns away every guest who joined with it */
|
|
38
|
+
expiresAt: DateTime;
|
|
39
|
+
/** How many guests have joined with it */
|
|
40
|
+
guests: number;
|
|
41
|
+
}
|
|
42
|
+
/** Rehydrates every wire-encoded scalar in a PartyPass into its runtime type. Mutates and returns `raw`. */
|
|
43
|
+
export declare function revivePartyPass(raw: PartyPass): PartyPass;
|
|
44
|
+
/**
|
|
45
|
+
* Start a party
|
|
46
|
+
* generated from [PartyStart](../../../../../apps/api/data/contracts/requests/requests.types.ck)
|
|
47
|
+
*/
|
|
48
|
+
export interface PartyStart {
|
|
49
|
+
/** How long the pass lasts. Six when omitted */
|
|
50
|
+
hours?: number;
|
|
51
|
+
}
|
|
52
|
+
/**
|
|
53
|
+
* Join a party as a guest, with the pass from its QR code
|
|
54
|
+
* generated from [PartyJoin](../../../../../apps/api/data/contracts/requests/requests.types.ck)
|
|
55
|
+
*/
|
|
56
|
+
export interface PartyJoin {
|
|
57
|
+
/** The pass, as it appears after `#` in the party page's address */
|
|
58
|
+
token: string;
|
|
59
|
+
}
|
|
60
|
+
/**
|
|
61
|
+
* A guest's way in: send it as a bearer token on the request routes
|
|
62
|
+
* generated from [PartyGuestSession](../../../../../apps/api/data/contracts/requests/requests.types.ck)
|
|
63
|
+
*/
|
|
64
|
+
export interface PartyGuestSession {
|
|
65
|
+
/** The bearer token. It lets a guest search for records, ask for one and see their own requests, and nothing else */
|
|
66
|
+
accessToken: string;
|
|
67
|
+
/** When it stops working, which is when the party's pass does */
|
|
68
|
+
expiresAt: DateTime;
|
|
69
|
+
}
|
|
70
|
+
/** Rehydrates every wire-encoded scalar in a PartyGuestSession into its runtime type. Mutates and returns `raw`. */
|
|
71
|
+
export declare function revivePartyGuestSession(raw: PartyGuestSession): PartyGuestSession;
|
|
28
72
|
/**
|
|
29
73
|
* A record the station could be asked for: one it holds, or one a music provider carries
|
|
30
74
|
* generated from [RequestableTrack](../../../../../apps/api/data/contracts/requests/requests.types.ck)
|
|
@@ -83,9 +127,21 @@ export interface ListenerRequest {
|
|
|
83
127
|
dedicateTo?: string;
|
|
84
128
|
/** What the listener asked to have said with it, in their own words */
|
|
85
129
|
message?: string;
|
|
130
|
+
/** True when a guest at a party asked for it, through the party pass. Absent otherwise */
|
|
131
|
+
fromParty?: boolean;
|
|
86
132
|
}
|
|
87
133
|
/** Rehydrates every wire-encoded scalar in a ListenerRequest into its runtime type. Mutates and returns `raw`. */
|
|
88
134
|
export declare function reviveListenerRequest(raw: ListenerRequest): ListenerRequest;
|
|
135
|
+
/**
|
|
136
|
+
* The party, if one is on
|
|
137
|
+
* generated from [PartyState](../../../../../apps/api/data/contracts/requests/requests.types.ck)
|
|
138
|
+
*/
|
|
139
|
+
export interface PartyState {
|
|
140
|
+
/** Absent when no party is on */
|
|
141
|
+
party?: PartyPass;
|
|
142
|
+
}
|
|
143
|
+
/** Rehydrates every wire-encoded scalar in a PartyState into its runtime type. Mutates and returns `raw`. */
|
|
144
|
+
export declare function revivePartyState(raw: PartyState): PartyState;
|
|
89
145
|
/**
|
|
90
146
|
* Records matching a search, best matches first, the station's own before any a provider carries
|
|
91
147
|
* generated from [RequestableTrackList](../../../../../apps/api/data/contracts/requests/requests.types.ck)
|
|
@@ -1 +1 @@
|
|
|
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,iBAAiB;IAC9B,iCAAiC;IACjC,QAAQ,EAAE,MAAM,CAAC;IACjB,0CAA0C;IAC1C,UAAU,EAAE,MAAM,CAAC;CACtB;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,sBAAsB;IACnC,qDAAqD;IACrD,MAAM,CAAC,EAAE,MAAM,CAAC;CACnB;AAED;;;GAGG;AACH,MAAM,WAAW,gBAAgB;IAC7B,iIAAiI;IACjI,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,iGAAiG;IACjG,MAAM,CAAC,EAAE,iBAAiB,CAAC;IAC3B,mEAAmE;IACnE,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,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;;;GAGG;AACH,MAAM,WAAW,qBAAqB;IAClC,iGAAiG;IACjG,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,8HAA8H;IAC9H,MAAM,CAAC,EAAE,iBAAiB,CAAC;IAC3B,+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,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;
|
|
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,iBAAiB;IAC9B,iCAAiC;IACjC,QAAQ,EAAE,MAAM,CAAC;IACjB,0CAA0C;IAC1C,UAAU,EAAE,MAAM,CAAC;CACtB;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,sBAAsB;IACnC,qDAAqD;IACrD,MAAM,CAAC,EAAE,MAAM,CAAC;CACnB;AAED;;;GAGG;AACH,MAAM,WAAW,SAAS;IACtB,sNAAsN;IACtN,KAAK,EAAE,MAAM,CAAC;IACd,6BAA6B;IAC7B,SAAS,EAAE,QAAQ,CAAC;IACpB,2FAA2F;IAC3F,SAAS,EAAE,QAAQ,CAAC;IACpB,0CAA0C;IAC1C,MAAM,EAAE,MAAM,CAAC;CAClB;AAED,4GAA4G;AAC5G,wBAAgB,eAAe,CAAC,GAAG,EAAE,SAAS,GAAG,SAAS,CAKzD;AAED;;;GAGG;AACH,MAAM,WAAW,UAAU;IACvB,gDAAgD;IAChD,KAAK,CAAC,EAAE,MAAM,CAAC;CAClB;AAED;;;GAGG;AACH,MAAM,WAAW,SAAS;IACtB,oEAAoE;IACpE,KAAK,EAAE,MAAM,CAAC;CACjB;AAED;;;GAGG;AACH,MAAM,WAAW,iBAAiB;IAC9B,qHAAqH;IACrH,WAAW,EAAE,MAAM,CAAC;IACpB,iEAAiE;IACjE,SAAS,EAAE,QAAQ,CAAC;CACvB;AAED,oHAAoH;AACpH,wBAAgB,uBAAuB,CAAC,GAAG,EAAE,iBAAiB,GAAG,iBAAiB,CAIjF;AAED;;;GAGG;AACH,MAAM,WAAW,gBAAgB;IAC7B,iIAAiI;IACjI,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,iGAAiG;IACjG,MAAM,CAAC,EAAE,iBAAiB,CAAC;IAC3B,mEAAmE;IACnE,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,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;;;GAGG;AACH,MAAM,WAAW,qBAAqB;IAClC,iGAAiG;IACjG,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,8HAA8H;IAC9H,MAAM,CAAC,EAAE,iBAAiB,CAAC;IAC3B,+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,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;IACjB,0FAA0F;IAC1F,SAAS,CAAC,EAAE,OAAO,CAAC;CACvB;AAED,kHAAkH;AAClH,wBAAgB,qBAAqB,CAAC,GAAG,EAAE,eAAe,GAAG,eAAe,CAO3E;AAED;;;GAGG;AACH,MAAM,WAAW,UAAU;IACvB,iCAAiC;IACjC,KAAK,CAAC,EAAE,SAAS,CAAC;CACrB;AAED,6GAA6G;AAC7G,wBAAgB,gBAAgB,CAAC,GAAG,EAAE,UAAU,GAAG,UAAU,CAM5D;AAED;;;GAGG;AACH,MAAM,WAAW,oBAAoB;IACjC,MAAM,EAAE,gBAAgB,EAAE,CAAC;CAC9B;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"}
|