@deadair/sdk 0.41.0 → 0.43.0

package/dist/director/types/rules.types.d.ts

@@ -0,0 +1,97 @@
+import { DateTime } from 'luxon';
+/**
+ * A never-play rule: a KIND of record the station must not play. Absolute, like a dislike, and
+ * exclude-only: there is no "only these" rule, because one could leave the station nothing to play.
+ * Every scope is optional and an absent one means "always"
+ * generated from [BlockRule](../../../../../apps/api/data/contracts/director/rules.types.ck#L10)
+ */
+export interface BlockRule {
+    id: string;
+    /** `genre` refuses any record tagged with this genre or a kind of it (`Punk Rock` under `Punk`, never `Pop` under `Pop Punk`, never `Trap` under `Rap`). `tag` refuses a record carrying exactly this tag */
+    field: 'genre' | 'tag';
+    /** The genre or tag, as you would write it */
+    value: string;
+    /** First day it holds, as `MM-DD`. With `seasonTo`; a season starting after it ends wraps the year end */
+    seasonFrom?: string;
+    /** Last day it holds, as `MM-DD` */
+    seasonTo?: string;
+    /** First hour of the station's day it holds. With `untilHour`; a window starting after it ends wraps midnight */
+    fromHour?: number;
+    /** The hour it stops holding, exclusive */
+    untilHour?: number;
+    /** Only while the station is in one of these modes. Absent or empty means every mode */
+    modes?: ('rotation' | 'setlist' | 'feature')[];
+    /** Only during these schedule blocks. Absent or empty means whatever is on */
+    slotIds?: string[];
+    /** When it stops holding. Absent means until it is removed */
+    endsAt?: DateTime;
+    /** Whether it holds right now, on the station's clock, for what is on air */
+    inForce: boolean;
+}
+export interface BlockRuleInput {
+    /** `genre` refuses any record tagged with this genre or a kind of it (`Punk Rock` under `Punk`, never `Pop` under `Pop Punk`, never `Trap` under `Rap`). `tag` refuses a record carrying exactly this tag */
+    field: 'genre' | 'tag';
+    /** The genre or tag, as you would write it */
+    value: string;
+    /** First day it holds, as `MM-DD`. With `seasonTo`; a season starting after it ends wraps the year end */
+    seasonFrom?: string;
+    /** Last day it holds, as `MM-DD` */
+    seasonTo?: string;
+    /** First hour of the station's day it holds. With `untilHour`; a window starting after it ends wraps midnight */
+    fromHour?: number;
+    /** The hour it stops holding, exclusive */
+    untilHour?: number;
+    /** Only while the station is in one of these modes. Absent or empty means every mode */
+    modes?: ('rotation' | 'setlist' | 'feature')[];
+    /** Only during these schedule blocks. Absent or empty means whatever is on */
+    slotIds?: string[];
+    /** When it stops holding. Absent means until it is removed */
+    endsAt?: DateTime;
+}
+/** Rehydrates every wire-encoded scalar in a BlockRule into its runtime type. Mutates and returns `raw`. */
+export declare function reviveBlockRule(raw: BlockRule): BlockRule;
+/**
+ * A lean toward some genres for a while. The opposite of a rule: the station favours them when it
+ * chooses records, and still plays anything else rather than run dry
+ * generated from [GenreSteer](../../../../../apps/api/data/contracts/director/rules.types.ck#L31)
+ */
+export interface GenreSteer {
+    /** What to favour, as genres. A record tagged with any of them, or a kind of one, is preferred */
+    genres: string[];
+    /** When the station goes back to choosing as it ordinarily does */
+    endsAt: DateTime;
+}
+/** Rehydrates every wire-encoded scalar in a GenreSteer into its runtime type. Mutates and returns `raw`. */
+export declare function reviveGenreSteer(raw: GenreSteer): GenreSteer;
+/**
+ * Lean the station toward some genres for a number of hours
+ * generated from [GenreSteerInput](../../../../../apps/api/data/contracts/director/rules.types.ck#L42)
+ */
+export interface GenreSteerInput {
+    genres: string[];
+    /** How long it lasts, from now */
+    hours: number;
+}
+/**
+ * Every rule on the station, newest first
+ * generated from [BlockRuleList](../../../../../apps/api/data/contracts/director/rules.types.ck#L25)
+ */
+export interface BlockRuleList {
+    rules: BlockRule[];
+}
+export interface BlockRuleListInput {
+    rules: BlockRuleInput[];
+}
+/** Rehydrates every wire-encoded scalar in a BlockRuleList into its runtime type. Mutates and returns `raw`. */
+export declare function reviveBlockRuleList(raw: BlockRuleList): BlockRuleList;
+/**
+ * The lean in force, or none
+ * generated from [GenreSteerReading](../../../../../apps/api/data/contracts/director/rules.types.ck#L37)
+ */
+export interface GenreSteerReading {
+    /** Absent when nothing is leaning the station, including once one has run out */
+    steer?: GenreSteer;
+}
+/** Rehydrates every wire-encoded scalar in a GenreSteerReading into its runtime type. Mutates and returns `raw`. */
+export declare function reviveGenreSteerReading(raw: GenreSteerReading): GenreSteerReading;
+//# sourceMappingURL=rules.types.d.ts.map

package/dist/director/types/rules.types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"rules.types.d.ts","sourceRoot":"","sources":["../../../src/director/types/rules.types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,OAAO,CAAC;AAUjC;;;;;GAKG;AACH,MAAM,WAAW,SAAS;IACtB,EAAE,EAAE,MAAM,CAAC;IACX,6MAA6M;IAC7M,KAAK,EAAE,OAAO,GAAG,KAAK,CAAC;IACvB,8CAA8C;IAC9C,KAAK,EAAE,MAAM,CAAC;IACd,0GAA0G;IAC1G,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,oCAAoC;IACpC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,iHAAiH;IACjH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,2CAA2C;IAC3C,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,wFAAwF;IACxF,KAAK,CAAC,EAAE,CAAC,UAAU,GAAG,SAAS,GAAG,SAAS,CAAC,EAAE,CAAC;IAC/C,8EAA8E;IAC9E,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;IACnB,8DAA8D;IAC9D,MAAM,CAAC,EAAE,QAAQ,CAAC;IAClB,6EAA6E;IAC7E,OAAO,EAAE,OAAO,CAAC;CACpB;AAED,MAAM,WAAW,cAAc;IAC3B,6MAA6M;IAC7M,KAAK,EAAE,OAAO,GAAG,KAAK,CAAC;IACvB,8CAA8C;IAC9C,KAAK,EAAE,MAAM,CAAC;IACd,0GAA0G;IAC1G,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,oCAAoC;IACpC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,iHAAiH;IACjH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,2CAA2C;IAC3C,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,wFAAwF;IACxF,KAAK,CAAC,EAAE,CAAC,UAAU,GAAG,SAAS,GAAG,SAAS,CAAC,EAAE,CAAC;IAC/C,8EAA8E;IAC9E,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;IACnB,8DAA8D;IAC9D,MAAM,CAAC,EAAE,QAAQ,CAAC;CACrB;AAED,4GAA4G;AAC5G,wBAAgB,eAAe,CAAC,GAAG,EAAE,SAAS,GAAG,SAAS,CAMzD;AAED;;;;GAIG;AACH,MAAM,WAAW,UAAU;IACvB,kGAAkG;IAClG,MAAM,EAAE,MAAM,EAAE,CAAC;IACjB,mEAAmE;IACnE,MAAM,EAAE,QAAQ,CAAC;CACpB;AAED,6GAA6G;AAC7G,wBAAgB,gBAAgB,CAAC,GAAG,EAAE,UAAU,GAAG,UAAU,CAI5D;AAED;;;GAGG;AACH,MAAM,WAAW,eAAe;IAC5B,MAAM,EAAE,MAAM,EAAE,CAAC;IACjB,kCAAkC;IAClC,KAAK,EAAE,MAAM,CAAC;CACjB;AAED;;;GAGG;AACH,MAAM,WAAW,aAAa;IAC1B,KAAK,EAAE,SAAS,EAAE,CAAC;CACtB;AAED,MAAM,WAAW,kBAAkB;IAC/B,KAAK,EAAE,cAAc,EAAE,CAAC;CAC3B;AAED,gHAAgH;AAChH,wBAAgB,mBAAmB,CAAC,GAAG,EAAE,aAAa,GAAG,aAAa,CASrE;AAED;;;GAGG;AACH,MAAM,WAAW,iBAAiB;IAC9B,iFAAiF;IACjF,KAAK,CAAC,EAAE,UAAU,CAAC;CACtB;AAED,oHAAoH;AACpH,wBAAgB,uBAAuB,CAAC,GAAG,EAAE,iBAAiB,GAAG,iBAAiB,CAMjF"}