@deadair/sdk 0.83.1 → 0.84.1
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/index.js +11 -1
- package/dist/index.js.map +1 -1
- package/dist/schedule/schedule.client.d.ts +7 -2
- package/dist/schedule/schedule.client.d.ts.map +1 -1
- package/dist/schedule/types/schedule.types.d.ts +17 -0
- package/dist/schedule/types/schedule.types.d.ts.map +1 -1
- package/package.json +1 -1
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import type { SdkFetch } from '../sdk-options.js';
|
|
2
|
-
import type { ScheduleNow, ScheduleSlotInput, ScheduleSlotList, ScheduleTimetable, ScheduleTimetableQuery, SlotPlaylistPosition } from './types/schedule.types.js';
|
|
2
|
+
import type { ScheduleNow, ScheduleSlotApplied, ScheduleSlotInput, ScheduleSlotList, ScheduleTimetable, ScheduleTimetableQuery, SlotPlaylistPosition } from './types/schedule.types.js';
|
|
3
3
|
export declare class ScheduleClient {
|
|
4
4
|
private fetch;
|
|
5
5
|
constructor(fetch: SdkFetch);
|
|
@@ -25,7 +25,7 @@ export declare class ScheduleClient {
|
|
|
25
25
|
readTimetable(query?: ScheduleTimetableQuery): Promise<ScheduleTimetable>;
|
|
26
26
|
/**
|
|
27
27
|
* @name Update schedule slot
|
|
28
|
-
* @description Rewrites a slot. Takes effect at its next boundary rather than immediately
|
|
28
|
+
* @description Rewrites a slot. Takes effect at its next boundary rather than immediately; to change the show on air too, when it is this slot's, apply the slot afterwards with `POST /schedule/{id}/apply`
|
|
29
29
|
*/
|
|
30
30
|
updateScheduleSlot(id: string, body: ScheduleSlotInput): Promise<ScheduleSlotList>;
|
|
31
31
|
/**
|
|
@@ -33,6 +33,11 @@ export declare class ScheduleClient {
|
|
|
33
33
|
* @description Removes a slot. Whatever is on air stays on until the next slot begins
|
|
34
34
|
*/
|
|
35
35
|
deleteScheduleSlot(id: string): Promise<ScheduleSlotList>;
|
|
36
|
+
/**
|
|
37
|
+
* @name Apply schedule slot to air
|
|
38
|
+
* @description Applies a slot, as it is saved now, to the show on air, which must be that slot's. Its name, brief, period, moods, rules and host change in place and the broadcast carries on; the records still planned are chosen again against the new programme, and the ones already planned keep playing until the new set is ready. A change to its source, mode, end or co-hosts cannot be made mid-show and waits for the slot's next occurrence
|
|
39
|
+
*/
|
|
40
|
+
applyScheduleSlotToAir(id: string): Promise<ScheduleSlotApplied>;
|
|
36
41
|
/**
|
|
37
42
|
* @name Read slot playlist position
|
|
38
43
|
* @description The record a slot that resumes its playlist will open on next time, or nothing when it would start from the top
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"schedule.client.d.ts","sourceRoot":"","sources":["../../src/schedule/schedule.client.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAC;AAElD,OAAO,KAAK,EACR,WAAW,EACX,iBAAiB,EACjB,gBAAgB,EAChB,iBAAiB,EACjB,sBAAsB,EACtB,oBAAoB,EACvB,MAAM,2BAA2B,CAAC;AAEnC,qBAAa,cAAc;IACX,OAAO,CAAC,KAAK;gBAAL,KAAK,EAAE,QAAQ;IAEnC;;;OAGG;IACG,YAAY,IAAI,OAAO,CAAC,gBAAgB,CAAC;IAK/C;;;OAGG;IACG,kBAAkB,CAAC,IAAI,EAAE,iBAAiB,GAAG,OAAO,CAAC,gBAAgB,CAAC;IAS5E;;;OAGG;IACG,eAAe,IAAI,OAAO,CAAC,WAAW,CAAC;IAK7C;;;OAGG;IACG,aAAa,CAAC,KAAK,CAAC,EAAE,sBAAsB,GAAG,OAAO,CAAC,iBAAiB,CAAC;IAQ/E;;;OAGG;IACG,kBAAkB,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,iBAAiB,GAAG,OAAO,CAAC,gBAAgB,CAAC;IASxF;;;OAGG;IACG,kBAAkB,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,gBAAgB,CAAC;IAK/D;;;OAGG;IACG,wBAAwB,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,oBAAoB,CAAC;IAKzE;;;OAGG;IACG,mBAAmB,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;CAGvD"}
|
|
1
|
+
{"version":3,"file":"schedule.client.d.ts","sourceRoot":"","sources":["../../src/schedule/schedule.client.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAC;AAElD,OAAO,KAAK,EACR,WAAW,EACX,mBAAmB,EACnB,iBAAiB,EACjB,gBAAgB,EAChB,iBAAiB,EACjB,sBAAsB,EACtB,oBAAoB,EACvB,MAAM,2BAA2B,CAAC;AAEnC,qBAAa,cAAc;IACX,OAAO,CAAC,KAAK;gBAAL,KAAK,EAAE,QAAQ;IAEnC;;;OAGG;IACG,YAAY,IAAI,OAAO,CAAC,gBAAgB,CAAC;IAK/C;;;OAGG;IACG,kBAAkB,CAAC,IAAI,EAAE,iBAAiB,GAAG,OAAO,CAAC,gBAAgB,CAAC;IAS5E;;;OAGG;IACG,eAAe,IAAI,OAAO,CAAC,WAAW,CAAC;IAK7C;;;OAGG;IACG,aAAa,CAAC,KAAK,CAAC,EAAE,sBAAsB,GAAG,OAAO,CAAC,iBAAiB,CAAC;IAQ/E;;;OAGG;IACG,kBAAkB,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,iBAAiB,GAAG,OAAO,CAAC,gBAAgB,CAAC;IASxF;;;OAGG;IACG,kBAAkB,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,gBAAgB,CAAC;IAK/D;;;OAGG;IACG,sBAAsB,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,mBAAmB,CAAC;IAKtE;;;OAGG;IACG,wBAAwB,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,oBAAoB,CAAC;IAKzE;;;OAGG;IACG,mBAAmB,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;CAGvD"}
|
|
@@ -50,6 +50,11 @@ export interface ScheduleOccurrence {
|
|
|
50
50
|
}
|
|
51
51
|
/**
|
|
52
52
|
* Where a slot that resumes its playlist will pick it up. Empty when it would start from the top: the slot does not resume, has no playlist, has aired nothing from it yet, or the last record it aired is no longer on it
|
|
53
|
+
* A part of a slot that applying it to the show on air can change, or has to leave for its next occurrence
|
|
54
|
+
* generated from [ScheduleSlotPart](../../../../../apps/api/data/contracts/schedule/schedule.types.ck)
|
|
55
|
+
*/
|
|
56
|
+
export type ScheduleSlotPart = 'name' | 'brief' | 'era' | 'moods' | 'avoidMoods' | 'rules' | 'host' | 'coHosts' | 'source' | 'mode' | 'onEnd';
|
|
57
|
+
/**
|
|
53
58
|
* generated from [SlotPlaylistPosition](../../../../../apps/api/data/contracts/schedule/schedule.types.ck)
|
|
54
59
|
*/
|
|
55
60
|
export interface SlotPlaylistPosition {
|
|
@@ -225,6 +230,18 @@ export interface ScheduleNow {
|
|
|
225
230
|
/** The block on now, if there is one, and the few that follow it, earliest first. Empty for a station with nothing scheduled from here on. A gap is simply absent, exactly as it is on the timetable: what plays there is the sustaining source rather than a block */
|
|
226
231
|
upcoming: ScheduleOccurrence[];
|
|
227
232
|
}
|
|
233
|
+
/**
|
|
234
|
+
* What applying a slot to the show on air changed now, and what waits for the slot's next occurrence
|
|
235
|
+
* generated from [ScheduleSlotApplied](../../../../../apps/api/data/contracts/schedule/schedule.types.ck)
|
|
236
|
+
*/
|
|
237
|
+
export interface ScheduleSlotApplied {
|
|
238
|
+
/** The parts the show on air follows from now on. Empty when it already matched the slot */
|
|
239
|
+
applied: ScheduleSlotPart[];
|
|
240
|
+
/** The parts that differ from the show on air and cannot change mid-show: its source, mode and end make a different programme, and its co-hosts are settled for the night. They apply the next time the slot comes round */
|
|
241
|
+
waiting: ScheduleSlotPart[];
|
|
242
|
+
/** Whether the records still planned are being chosen again against the new programme. The ones already planned keep playing until the new set is ready, so nothing goes quiet while it is chosen */
|
|
243
|
+
replanning: boolean;
|
|
244
|
+
}
|
|
228
245
|
/**
|
|
229
246
|
* generated from [ScheduleSlotList](../../../../../apps/api/data/contracts/schedule/schedule.types.ck)
|
|
230
247
|
*/
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"schedule.types.d.ts","sourceRoot":"","sources":["../../../src/schedule/types/schedule.types.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,MAAM,WAAW,aAAa;IAC1B,qFAAqF;IACrF,SAAS,EAAE,MAAM,CAAC;IAClB,6GAA6G;IAC7G,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;IAChB,wHAAwH;IACxH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,kJAAkJ;IAClJ,YAAY,CAAC,EAAE,MAAM,CAAC;CACzB;AAED;;;GAGG;AACH,MAAM,WAAW,UAAU;IACvB,yFAAyF;IACzF,SAAS,EAAE,MAAM,CAAC;IAClB,wJAAwJ;IACxJ,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;IAChB,kGAAkG;IAClG,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,6FAA6F;IAC7F,YAAY,CAAC,EAAE,MAAM,CAAC;CACzB;AAED;;;GAGG;AACH,MAAM,WAAW,sBAAsB;IACnC,kMAAkM;IAClM,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,oDAAoD;IACpD,IAAI,CAAC,EAAE,MAAM,CAAC;CACjB;AAED;;;GAGG;AACH,MAAM,WAAW,kBAAkB;IAC/B,MAAM,EAAE,MAAM,CAAC;IACf,KAAK,EAAE,MAAM,CAAC;IACd,+LAA+L;IAC/L,KAAK,EAAE,MAAM,CAAC;IACd,4GAA4G;IAC5G,GAAG,EAAE,MAAM,CAAC;CACf;AAED
|
|
1
|
+
{"version":3,"file":"schedule.types.d.ts","sourceRoot":"","sources":["../../../src/schedule/types/schedule.types.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,MAAM,WAAW,aAAa;IAC1B,qFAAqF;IACrF,SAAS,EAAE,MAAM,CAAC;IAClB,6GAA6G;IAC7G,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;IAChB,wHAAwH;IACxH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,kJAAkJ;IAClJ,YAAY,CAAC,EAAE,MAAM,CAAC;CACzB;AAED;;;GAGG;AACH,MAAM,WAAW,UAAU;IACvB,yFAAyF;IACzF,SAAS,EAAE,MAAM,CAAC;IAClB,wJAAwJ;IACxJ,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;IAChB,kGAAkG;IAClG,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,6FAA6F;IAC7F,YAAY,CAAC,EAAE,MAAM,CAAC;CACzB;AAED;;;GAGG;AACH,MAAM,WAAW,sBAAsB;IACnC,kMAAkM;IAClM,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,oDAAoD;IACpD,IAAI,CAAC,EAAE,MAAM,CAAC;CACjB;AAED;;;GAGG;AACH,MAAM,WAAW,kBAAkB;IAC/B,MAAM,EAAE,MAAM,CAAC;IACf,KAAK,EAAE,MAAM,CAAC;IACd,+LAA+L;IAC/L,KAAK,EAAE,MAAM,CAAC;IACd,4GAA4G;IAC5G,GAAG,EAAE,MAAM,CAAC;CACf;AAED;;;;GAIG;AACH,MAAM,MAAM,gBAAgB,GAAG,MAAM,GAAG,OAAO,GAAG,KAAK,GAAG,OAAO,GAAG,YAAY,GAAG,OAAO,GAAG,MAAM,GAAG,SAAS,GAAG,QAAQ,GAAG,MAAM,GAAG,OAAO,CAAC;AAE9I;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACjC,sKAAsK;IACtK,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,sBAAsB;IACtB,MAAM,CAAC,EAAE,MAAM,CAAC;CACnB;AAED;;;GAGG;AACH,MAAM,WAAW,YAAY;IACzB,EAAE,EAAE,MAAM,CAAC;IACX,oFAAoF;IACpF,KAAK,EAAE,MAAM,CAAC;IACd,sEAAsE;IACtE,eAAe,EAAE,MAAM,CAAC;IACxB,2KAA2K;IAC3K,aAAa,EAAE,MAAM,CAAC;IACtB,yEAAyE;IACzE,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;IAChB,qGAAqG;IACrG,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,6PAA6P;IAC7P,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,6HAA6H;IAC7H,gBAAgB,CAAC,EAAE,WAAW,GAAG,QAAQ,GAAG,WAAW,CAAC;IACxD,8OAA8O;IAC9O,uBAAuB,CAAC,EAAE,MAAM,CAAC;IACjC,uFAAuF;IACvF,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,oOAAoO;IACpO,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,4KAA4K;IAC5K,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,0GAA0G;IAC1G,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,2WAA2W;IAC3W,KAAK,CAAC,EAAE,CAAC,MAAM,GAAG,WAAW,GAAG,SAAS,GAAG,SAAS,GAAG,YAAY,GAAG,OAAO,GAAG,MAAM,CAAC,EAAE,CAAC;IAC3F,0SAA0S;IAC1S,UAAU,CAAC,EAAE,CAAC,MAAM,GAAG,WAAW,GAAG,SAAS,GAAG,SAAS,GAAG,YAAY,GAAG,OAAO,GAAG,MAAM,CAAC,EAAE,CAAC;IAChG,0WAA0W;IAC1W,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,qNAAqN;IACrN,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,0UAA0U;IAC1U,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,2PAA2P;IAC3P,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB,yRAAyR;IACzR,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,gHAAgH;IAChH,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,iUAAiU;IACjU,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,+QAA+Q;IAC/Q,qBAAqB,CAAC,EAAE,MAAM,CAAC;IAC/B,wOAAwO;IACxO,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,yVAAyV;IACzV,WAAW,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IAClC,kQAAkQ;IAClQ,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,8HAA8H;IAC9H,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,2NAA2N;IAC3N,OAAO,CAAC,EAAE,UAAU,EAAE,CAAC;IACvB,uOAAuO;IACvO,UAAU,CAAC,EAAE,aAAa,EAAE,CAAC;IAC7B,qLAAqL;IACrL,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,sWAAsW;IACtW,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB,IAAI,EAAE,UAAU,GAAG,SAAS,GAAG,SAAS,CAAC;IACzC,KAAK,EAAE,QAAQ,GAAG,QAAQ,GAAG,MAAM,CAAC;CACvC;AAED,MAAM,WAAW,iBAAiB;IAC9B,oFAAoF;IACpF,KAAK,EAAE,MAAM,CAAC;IACd,sEAAsE;IACtE,eAAe,EAAE,MAAM,CAAC;IACxB,2KAA2K;IAC3K,aAAa,EAAE,MAAM,CAAC;IACtB,yEAAyE;IACzE,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;IAChB,qGAAqG;IACrG,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,6PAA6P;IAC7P,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,6HAA6H;IAC7H,gBAAgB,CAAC,EAAE,WAAW,GAAG,QAAQ,GAAG,WAAW,CAAC;IACxD,8OAA8O;IAC9O,uBAAuB,CAAC,EAAE,MAAM,CAAC;IACjC,uFAAuF;IACvF,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,oOAAoO;IACpO,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,4KAA4K;IAC5K,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,0GAA0G;IAC1G,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,2WAA2W;IAC3W,KAAK,CAAC,EAAE,CAAC,MAAM,GAAG,WAAW,GAAG,SAAS,GAAG,SAAS,GAAG,YAAY,GAAG,OAAO,GAAG,MAAM,CAAC,EAAE,CAAC;IAC3F,0SAA0S;IAC1S,UAAU,CAAC,EAAE,CAAC,MAAM,GAAG,WAAW,GAAG,SAAS,GAAG,SAAS,GAAG,YAAY,GAAG,OAAO,GAAG,MAAM,CAAC,EAAE,CAAC;IAChG,0WAA0W;IAC1W,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,qNAAqN;IACrN,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,0UAA0U;IAC1U,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,2PAA2P;IAC3P,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB,yRAAyR;IACzR,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,gHAAgH;IAChH,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,iUAAiU;IACjU,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,+QAA+Q;IAC/Q,qBAAqB,CAAC,EAAE,MAAM,CAAC;IAC/B,wOAAwO;IACxO,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,yVAAyV;IACzV,WAAW,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IAClC,kQAAkQ;IAClQ,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,8HAA8H;IAC9H,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,2NAA2N;IAC3N,OAAO,CAAC,EAAE,UAAU,EAAE,CAAC;IACvB,uOAAuO;IACvO,UAAU,CAAC,EAAE,aAAa,EAAE,CAAC;IAC7B,qLAAqL;IACrL,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,sWAAsW;IACtW,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB,IAAI,EAAE,UAAU,GAAG,SAAS,GAAG,SAAS,CAAC;IACzC,KAAK,EAAE,QAAQ,GAAG,QAAQ,GAAG,MAAM,CAAC;CACvC;AAED;;;GAGG;AACH,MAAM,WAAW,iBAAiB;IAC9B,mJAAmJ;IACnJ,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,EAAE,kBAAkB,EAAE,CAAC;CACrC;AAED;;;GAGG;AACH,MAAM,WAAW,WAAW;IACxB,4SAA4S;IAC5S,GAAG,EAAE,MAAM,CAAC;IACZ,sTAAsT;IACtT,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,kFAAkF;IAClF,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,mRAAmR;IACnR,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,uKAAuK;IACvK,gBAAgB,CAAC,EAAE,MAAM,EAAE,CAAC;IAC5B,mKAAmK;IACnK,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,kKAAkK;IAClK,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,uQAAuQ;IACvQ,QAAQ,EAAE,kBAAkB,EAAE,CAAC;CAClC;AAED;;;GAGG;AACH,MAAM,WAAW,mBAAmB;IAChC,4FAA4F;IAC5F,OAAO,EAAE,gBAAgB,EAAE,CAAC;IAC5B,4NAA4N;IAC5N,OAAO,EAAE,gBAAgB,EAAE,CAAC;IAC5B,qMAAqM;IACrM,UAAU,EAAE,OAAO,CAAC;CACvB;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC7B,KAAK,EAAE,YAAY,EAAE,CAAC;CACzB;AAED,MAAM,WAAW,qBAAqB;IAClC,KAAK,EAAE,iBAAiB,EAAE,CAAC;CAC9B"}
|