@deadair/sdk 0.14.0 → 0.16.0

package/dist/art/art.client.d.ts

@@ -1,7 +1,23 @@
 import type { SdkFetch } from '../sdk-options.js';
+import type { BreakArtworkList } from './types/art.types.js';
 export declare class ArtClient {
     private fetch;
     constructor(fetch: SdkFetch);
+    /**
+     * @name List break artwork
+     * @description Every kind the station holds a picture for
+     */
+    listBreakArtwork(): Promise<BreakArtworkList>;
+    /**
+     * @name Replace break artwork
+     * @description Puts an operator's own picture behind a kind of break. The id does not change, so a URL already on the wire keeps working and the ETag is what says the picture moved
+     */
+    replaceBreakArtwork(kind: string, body: FormData): Promise<BreakArtworkList>;
+    /**
+     * @name Revert break artwork
+     * @description Puts the picture this repository ships back. The shipped file is read at this moment rather than copied at install, so an upgrade that improved it is what comes back
+     */
+    revertBreakArtwork(kind: string): Promise<BreakArtworkList>;
     /**
      * @name Get art
      * @description The bytes of one cached image, addressed by its id alone

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

@@ -1 +1 @@
-{"version":3,"file":"art.client.d.ts","sourceRoot":"","sources":["../../src/art/art.client.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAC;AAGlD,qBAAa,SAAS;IACN,OAAO,CAAC,KAAK;gBAAL,KAAK,EAAE,QAAQ;IAEnC;;;OAGG;IACG,MAAM,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAC3B;QACI,MAAM,EAAE,GAAG,CAAC;QACZ,WAAW,EAAE,YAAY,GAAG,WAAW,GAAG,YAAY,GAAG,WAAW,CAAC;QACrE,IAAI,EAAE,IAAI,CAAC;QACX,OAAO,EAAE;YAAE,YAAY,CAAC,EAAE,MAAM,CAAC;YAAC,IAAI,CAAC,EAAE,MAAM,CAAA;SAAE,CAAC;KACrD,GACD;QAAE,MAAM,EAAE,GAAG,CAAA;KAAE,CACpB;IAkBD;;;OAGG;IACG,UAAU,CACZ,EAAE,EAAE,MAAM,EACV,QAAQ,EAAE,MAAM,GACjB,OAAO,CACJ;QACI,MAAM,EAAE,GAAG,CAAC;QACZ,WAAW,EAAE,YAAY,GAAG,WAAW,GAAG,YAAY,GAAG,WAAW,CAAC;QACrE,IAAI,EAAE,IAAI,CAAC;QACX,OAAO,EAAE;YAAE,YAAY,CAAC,EAAE,MAAM,CAAC;YAAC,IAAI,CAAC,EAAE,MAAM,CAAA;SAAE,CAAC;KACrD,GACD;QAAE,MAAM,EAAE,GAAG,CAAA;KAAE,CACpB;CAiBJ"}
+{"version":3,"file":"art.client.d.ts","sourceRoot":"","sources":["../../src/art/art.client.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAC;AAElD,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,sBAAsB,CAAC;AAE7D,qBAAa,SAAS;IACN,OAAO,CAAC,KAAK;gBAAL,KAAK,EAAE,QAAQ;IAEnC;;;OAGG;IACG,gBAAgB,IAAI,OAAO,CAAC,gBAAgB,CAAC;IAKnD;;;OAGG;IACG,mBAAmB,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,QAAQ,GAAG,OAAO,CAAC,gBAAgB,CAAC;IAQlF;;;OAGG;IACG,kBAAkB,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,gBAAgB,CAAC;IAKjE;;;OAGG;IACG,MAAM,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAC3B;QACI,MAAM,EAAE,GAAG,CAAC;QACZ,WAAW,EAAE,YAAY,GAAG,WAAW,GAAG,YAAY,GAAG,WAAW,CAAC;QACrE,IAAI,EAAE,IAAI,CAAC;QACX,OAAO,EAAE;YAAE,YAAY,CAAC,EAAE,MAAM,CAAC;YAAC,IAAI,CAAC,EAAE,MAAM,CAAA;SAAE,CAAC;KACrD,GACD;QAAE,MAAM,EAAE,GAAG,CAAA;KAAE,CACpB;IAkBD;;;OAGG;IACG,UAAU,CACZ,EAAE,EAAE,MAAM,EACV,QAAQ,EAAE,MAAM,GACjB,OAAO,CACJ;QACI,MAAM,EAAE,GAAG,CAAC;QACZ,WAAW,EAAE,YAAY,GAAG,WAAW,GAAG,YAAY,GAAG,WAAW,CAAC;QACrE,IAAI,EAAE,IAAI,CAAC;QACX,OAAO,EAAE;YAAE,YAAY,CAAC,EAAE,MAAM,CAAC;YAAC,IAAI,CAAC,EAAE,MAAM,CAAA;SAAE,CAAC;KACrD,GACD;QAAE,MAAM,EAAE,GAAG,CAAA;KAAE,CACpB;CAiBJ"}

package/dist/art/types/art.types.d.ts

@@ -0,0 +1,39 @@
+/**
+ * The picture one KIND of break wears -- a weather forecast, a news bulletin -- as the console draws
+ * it.
+ *
+ * Only kinds the station actually holds bytes for are listed. A kind with no picture is a break
+ * wearing the station's logo on the mount and nothing in a listener's app, which is what every break
+ * did before this existed and is not a row worth drawing
+ * generated from [BreakArtwork](../../../../../apps/api/data/contracts/art/art.types.ck#L13)
+ */
+export interface BreakArtwork {
+    /** `segments.kind`, which is what decides which break wears this: `weather`, `news`, or whatever an operator wrote on a format-clock band */
+    kind: string;
+    /** Where the station serves it, as a path under the API root. The same shape and the same route a record's cover uses */
+    url: string;
+    /** Whether these are the bytes this repository ships or ones somebody uploaded over them */
+    source: 'shipped' | 'operator';
+    /** Whether this repository ships a picture for this kind, which is whether reverting has anywhere to go */
+    hasShipped: boolean;
+}
+/**
+ * A picture arriving from the browser, as multipart form parts.
+ *
+ * Documentation rather than validation: a multipart body reaches the service as the raw parser and
+ * the generated client types the body as `FormData`, so nothing checks this shape. It says what to
+ * send
+ * generated from [BreakArtworkUpload](../../../../../apps/api/data/contracts/art/art.types.ck#L30)
+ */
+export interface BreakArtworkUpload {
+    /** The image itself. jpeg, png, webp or gif, decided by its BYTES rather than by its name or its declared type, and at most 4 MB */
+    file: Blob;
+}
+/**
+ * Every kind the station holds a picture for, kind by kind
+ * generated from [BreakArtworkList](../../../../../apps/api/data/contracts/art/art.types.ck#L21)
+ */
+export interface BreakArtworkList {
+    breaks: BreakArtwork[];
+}
+//# sourceMappingURL=art.types.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"art.types.d.ts","sourceRoot":"","sources":["../../../src/art/types/art.types.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AACH,MAAM,WAAW,YAAY;IACzB,6IAA6I;IAC7I,IAAI,EAAE,MAAM,CAAC;IACb,yHAAyH;IACzH,GAAG,EAAE,MAAM,CAAC;IACZ,4FAA4F;IAC5F,MAAM,EAAE,SAAS,GAAG,UAAU,CAAC;IAC/B,2GAA2G;IAC3G,UAAU,EAAE,OAAO,CAAC;CACvB;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,kBAAkB;IAC/B,oIAAoI;IACpI,IAAI,EAAE,IAAI,CAAC;CACd;AAED;;;GAGG;AACH,MAAM,WAAW,gBAAgB;IAC7B,MAAM,EAAE,YAAY,EAAE,CAAC;CAC1B"}

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

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

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

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

package/dist/index.d.ts

@@ -1,6 +1,7 @@
 export * from './activity/activity.client.js';
 export * from './activity/types/index.js';
 export * from './art/art.client.js';
+export * from './art/types/index.js';
 export * from './authentication/authentication.apikeys.client.js';
 export * from './authentication/authentication.client.js';
 export * from './authentication/authentication.factor.client.js';

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA,cAAc,+BAA+B,CAAC;AAC9C,cAAc,2BAA2B,CAAC;AAC1C,cAAc,qBAAqB,CAAC;AACpC,cAAc,mDAAmD,CAAC;AAClE,cAAc,2CAA2C,CAAC;AAC1D,cAAc,kDAAkD,CAAC;AACjE,cAAc,oDAAoD,CAAC;AACnE,cAAc,iCAAiC,CAAC;AAChD,cAAc,6BAA6B,CAAC;AAC5C,cAAc,0BAA0B,CAAC;AACzC,cAAc,2BAA2B,CAAC;AAC1C,cAAc,yBAAyB,CAAC;AACxC,cAAc,kBAAkB,CAAC;AACjC,cAAc,+BAA+B,CAAC;AAC9C,cAAc,2BAA2B,CAAC;AAC1C,cAAc,6BAA6B,CAAC;AAC5C,cAAc,0BAA0B,CAAC;AACzC,cAAc,mCAAmC,CAAC;AAClD,cAAc,6BAA6B,CAAC;AAC5C,cAAc,uBAAuB,CAAC;AACtC,cAAc,uBAAuB,CAAC;AACtC,cAAc,mCAAmC,CAAC;AAClD,cAAc,6BAA6B,CAAC;AAC5C,cAAc,mCAAmC,CAAC;AAClD,cAAc,6BAA6B,CAAC;AAC5C,cAAc,+BAA+B,CAAC;AAC9C,cAAc,2BAA2B,CAAC;AAC1C,cAAc,iCAAiC,CAAC;AAChD,cAAc,4BAA4B,CAAC;AAC3C,cAAc,6BAA6B,CAAC;AAC5C,cAAc,0BAA0B,CAAC;AACzC,cAAc,6BAA6B,CAAC;AAC5C,cAAc,0BAA0B,CAAC;AACzC,cAAc,+BAA+B,CAAC;AAC9C,cAAc,2BAA2B,CAAC;AAC1C,cAAc,qCAAqC,CAAC;AACpD,cAAc,8BAA8B,CAAC;AAC7C,cAAc,2BAA2B,CAAC;AAC1C,cAAc,yBAAyB,CAAC;AACxC,cAAc,+BAA+B,CAAC;AAC9C,cAAc,2BAA2B,CAAC;AAC1C,cAAc,kBAAkB,CAAC;AACjC,cAAc,+BAA+B,CAAC;AAC9C,cAAc,2BAA2B,CAAC;AAC1C,cAAc,yBAAyB,CAAC;AACxC,cAAc,6BAA6B,CAAC;AAC5C,cAAc,0BAA0B,CAAC;AACzC,cAAc,6BAA6B,CAAC;AAC5C,cAAc,0BAA0B,CAAC;AACzC,cAAc,2BAA2B,CAAC;AAC1C,cAAc,yBAAyB,CAAC;AACxC,cAAc,2BAA2B,CAAC;AAC1C,cAAc,yBAAyB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA,cAAc,+BAA+B,CAAC;AAC9C,cAAc,2BAA2B,CAAC;AAC1C,cAAc,qBAAqB,CAAC;AACpC,cAAc,sBAAsB,CAAC;AACrC,cAAc,mDAAmD,CAAC;AAClE,cAAc,2CAA2C,CAAC;AAC1D,cAAc,kDAAkD,CAAC;AACjE,cAAc,oDAAoD,CAAC;AACnE,cAAc,iCAAiC,CAAC;AAChD,cAAc,6BAA6B,CAAC;AAC5C,cAAc,0BAA0B,CAAC;AACzC,cAAc,2BAA2B,CAAC;AAC1C,cAAc,yBAAyB,CAAC;AACxC,cAAc,kBAAkB,CAAC;AACjC,cAAc,+BAA+B,CAAC;AAC9C,cAAc,2BAA2B,CAAC;AAC1C,cAAc,6BAA6B,CAAC;AAC5C,cAAc,0BAA0B,CAAC;AACzC,cAAc,mCAAmC,CAAC;AAClD,cAAc,6BAA6B,CAAC;AAC5C,cAAc,uBAAuB,CAAC;AACtC,cAAc,uBAAuB,CAAC;AACtC,cAAc,mCAAmC,CAAC;AAClD,cAAc,6BAA6B,CAAC;AAC5C,cAAc,mCAAmC,CAAC;AAClD,cAAc,6BAA6B,CAAC;AAC5C,cAAc,+BAA+B,CAAC;AAC9C,cAAc,2BAA2B,CAAC;AAC1C,cAAc,iCAAiC,CAAC;AAChD,cAAc,4BAA4B,CAAC;AAC3C,cAAc,6BAA6B,CAAC;AAC5C,cAAc,0BAA0B,CAAC;AACzC,cAAc,6BAA6B,CAAC;AAC5C,cAAc,0BAA0B,CAAC;AACzC,cAAc,+BAA+B,CAAC;AAC9C,cAAc,2BAA2B,CAAC;AAC1C,cAAc,qCAAqC,CAAC;AACpD,cAAc,8BAA8B,CAAC;AAC7C,cAAc,2BAA2B,CAAC;AAC1C,cAAc,yBAAyB,CAAC;AACxC,cAAc,+BAA+B,CAAC;AAC9C,cAAc,2BAA2B,CAAC;AAC1C,cAAc,kBAAkB,CAAC;AACjC,cAAc,+BAA+B,CAAC;AAC9C,cAAc,2BAA2B,CAAC;AAC1C,cAAc,yBAAyB,CAAC;AACxC,cAAc,6BAA6B,CAAC;AAC5C,cAAc,0BAA0B,CAAC;AACzC,cAAc,6BAA6B,CAAC;AAC5C,cAAc,0BAA0B,CAAC;AACzC,cAAc,2BAA2B,CAAC;AAC1C,cAAc,yBAAyB,CAAC;AACxC,cAAc,2BAA2B,CAAC;AAC1C,cAAc,yBAAyB,CAAC"}

package/dist/index.js

@@ -169,6 +169,37 @@ var ArtClient = class {
   constructor(fetch2) {
     this.fetch = fetch2;
   }
+  /**
+   * @name List break artwork
+   * @description Every kind the station holds a picture for
+   */
+  async listBreakArtwork() {
+    const result = await this.fetch(`/art/breaks`, {
+      method: "GET"
+    });
+    return await parseJson(result);
+  }
+  /**
+   * @name Replace break artwork
+   * @description Puts an operator's own picture behind a kind of break. The id does not change, so a URL already on the wire keeps working and the ETag is what says the picture moved
+   */
+  async replaceBreakArtwork(kind, body) {
+    const result = await this.fetch(`/art/breaks/${encodeURIComponent(kind)}`, {
+      method: "POST",
+      body
+    });
+    return await parseJson(result);
+  }
+  /**
+   * @name Revert break artwork
+   * @description Puts the picture this repository ships back. The shipped file is read at this moment rather than copied at install, so an upgrade that improved it is what comes back
+   */
+  async revertBreakArtwork(kind) {
+    const result = await this.fetch(`/art/breaks/${encodeURIComponent(kind)}`, {
+      method: "DELETE"
+    });
+    return await parseJson(result);
+  }
   /**
    * @name Get art
    * @description The bytes of one cached image, addressed by its id alone