@deadair/sdk 0.67.1 → 0.68.0

package/dist/settings/settings.client.d.ts

@@ -1,5 +1,5 @@
 import type { SdkFetch } from '../sdk-options.js';
-import type { SigninProvidersCheck, StationSettings, StationSettingsInput } from './types/settings.types.js';
+import type { InvitationPreview, InvitationPreviewQuery, SigninProvidersCheck, StationSettings, StationSettingsInput } from './types/settings.types.js';
 export declare class SettingsClient {
     private fetch;
     constructor(fetch: SdkFetch);
@@ -18,5 +18,10 @@ export declare class SettingsClient {
      * @description Asks each identity provider in the sign-in settings for its discovery document, the way a sign-in would, and says which answered
      */
     checkSignInProviders(): Promise<SigninProvidersCheck>;
+    /**
+     * @name Preview invitation
+     * @description Renders the invitation email as it would be sent now, in the station's saved wording, with sample values in place of a real link, inviter and date
+     */
+    previewInvitation(query?: InvitationPreviewQuery): Promise<InvitationPreview>;
 }
 //# sourceMappingURL=settings.client.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"settings.client.d.ts","sourceRoot":"","sources":["../../src/settings/settings.client.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAC;AAElD,OAAO,KAAK,EAAE,oBAAoB,EAAE,eAAe,EAAE,oBAAoB,EAAE,MAAM,2BAA2B,CAAC;AAE7G,qBAAa,cAAc;IACX,OAAO,CAAC,KAAK;gBAAL,KAAK,EAAE,QAAQ;IAEnC;;;OAGG;IACG,WAAW,IAAI,OAAO,CAAC,eAAe,CAAC;IAK7C;;;OAGG;IACG,cAAc,CAAC,IAAI,EAAE,oBAAoB,GAAG,OAAO,CAAC,eAAe,CAAC;IAS1E;;;OAGG;IACG,oBAAoB,IAAI,OAAO,CAAC,oBAAoB,CAAC;CAI9D"}
+{"version":3,"file":"settings.client.d.ts","sourceRoot":"","sources":["../../src/settings/settings.client.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAC;AAElD,OAAO,KAAK,EACR,iBAAiB,EACjB,sBAAsB,EACtB,oBAAoB,EACpB,eAAe,EACf,oBAAoB,EACvB,MAAM,2BAA2B,CAAC;AAEnC,qBAAa,cAAc;IACX,OAAO,CAAC,KAAK;gBAAL,KAAK,EAAE,QAAQ;IAEnC;;;OAGG;IACG,WAAW,IAAI,OAAO,CAAC,eAAe,CAAC;IAK7C;;;OAGG;IACG,cAAc,CAAC,IAAI,EAAE,oBAAoB,GAAG,OAAO,CAAC,eAAe,CAAC;IAS1E;;;OAGG;IACG,oBAAoB,IAAI,OAAO,CAAC,oBAAoB,CAAC;IAK3D;;;OAGG;IACG,iBAAiB,CAAC,KAAK,CAAC,EAAE,sBAAsB,GAAG,OAAO,CAAC,iBAAiB,CAAC;CAOtF"}

package/dist/settings/types/settings.types.d.ts

@@ -28,6 +28,30 @@ export interface SigninProviderCheck {
     /** Why not, in a sentence. Absent when it answered */
     problem?: string;
 }
+/**
+ * Which invitation to preview
+ * generated from [InvitationPreviewQuery](../../../../../apps/api/data/contracts/settings/settings.types.ck)
+ */
+export interface InvitationPreviewQuery {
+    /** The role the invitation would be for. Its subject, its guide link and the station's own wording differ between the two */
+    role: 'listener' | 'admin';
+}
+/**
+ * An invitation as it would be emailed now, with a sample link, inviter and date in place of a real one
+ * generated from [InvitationPreview](../../../../../apps/api/data/contracts/settings/settings.types.ck)
+ */
+export interface InvitationPreview {
+    /** The subject line */
+    subject: string;
+    /** The whole HTML part, as a document */
+    html: string;
+    /** The plain-text part */
+    text: string;
+    /** Whether the station's saved subject or message was used. False when neither is set, or when what is saved cannot be used and the station's own wording is shown instead */
+    ownWording: boolean;
+    /** Why the saved wording cannot be used, in a sentence. Absent when it can, or when nothing is saved */
+    problem?: string;
+}
 /**
  * A station setting as the console needs to render it. `ConfigFieldDescriptor` is the plugins area's,
  * and shared deliberately: a plugin's settings form and the station's are the same problem, and the

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

@@ -1 +1 @@
-{"version":3,"file":"settings.types.d.ts","sourceRoot":"","sources":["../../../src/settings/types/settings.types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,sCAAsC,CAAC;AAElF;;;GAGG;AACH,MAAM,MAAM,YAAY,GAClB,SAAS,GACT,QAAQ,GACR,cAAc,GACd,MAAM,GACN,QAAQ,GACR,UAAU,GACV,QAAQ,GACR,WAAW,GACX,SAAS,GACT,QAAQ,GACR,KAAK,GACL,UAAU,GACV,UAAU,GACV,UAAU,GACV,WAAW,GACX,WAAW,CAAC;AAElB;;;;GAIG;AACH,MAAM,WAAW,oBAAoB;IACjC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACnC;AAED;;;GAGG;AACH,MAAM,WAAW,mBAAmB;IAChC,qBAAqB;IACrB,IAAI,EAAE,MAAM,CAAC;IACb,2BAA2B;IAC3B,KAAK,EAAE,MAAM,CAAC;IACd,gCAAgC;IAChC,MAAM,EAAE,MAAM,CAAC;IACf,0EAA0E;IAC1E,EAAE,EAAE,OAAO,CAAC;IACZ,sDAAsD;IACtD,OAAO,CAAC,EAAE,MAAM,CAAC;CACpB;AAED;;;;;GAKG;AACH,MAAM,WAAW,wBAAyB,SAAQ,qBAAqB;IACnE,KAAK,EAAE,YAAY,CAAC;CACvB;AAED;;;GAGG;AACH,MAAM,WAAW,oBAAoB;IACjC,uCAAuC;IACvC,SAAS,EAAE,mBAAmB,EAAE,CAAC;IACjC,gJAAgJ;IAChJ,QAAQ,EAAE,MAAM,EAAE,CAAC;CACtB;AAED;;;GAGG;AACH,MAAM,WAAW,eAAe;IAC5B,WAAW,EAAE,wBAAwB,EAAE,CAAC;IACxC,mFAAmF;IACnF,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAChC,kGAAkG;IAClG,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACpC,6wBAA6wB;IAC7wB,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CACnC"}
+{"version":3,"file":"settings.types.d.ts","sourceRoot":"","sources":["../../../src/settings/types/settings.types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,sCAAsC,CAAC;AAElF;;;GAGG;AACH,MAAM,MAAM,YAAY,GAClB,SAAS,GACT,QAAQ,GACR,cAAc,GACd,MAAM,GACN,QAAQ,GACR,UAAU,GACV,QAAQ,GACR,WAAW,GACX,SAAS,GACT,QAAQ,GACR,KAAK,GACL,UAAU,GACV,UAAU,GACV,UAAU,GACV,WAAW,GACX,WAAW,CAAC;AAElB;;;;GAIG;AACH,MAAM,WAAW,oBAAoB;IACjC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACnC;AAED;;;GAGG;AACH,MAAM,WAAW,mBAAmB;IAChC,qBAAqB;IACrB,IAAI,EAAE,MAAM,CAAC;IACb,2BAA2B;IAC3B,KAAK,EAAE,MAAM,CAAC;IACd,gCAAgC;IAChC,MAAM,EAAE,MAAM,CAAC;IACf,0EAA0E;IAC1E,EAAE,EAAE,OAAO,CAAC;IACZ,sDAAsD;IACtD,OAAO,CAAC,EAAE,MAAM,CAAC;CACpB;AAED;;;GAGG;AACH,MAAM,WAAW,sBAAsB;IACnC,6HAA6H;IAC7H,IAAI,EAAE,UAAU,GAAG,OAAO,CAAC;CAC9B;AAED;;;GAGG;AACH,MAAM,WAAW,iBAAiB;IAC9B,uBAAuB;IACvB,OAAO,EAAE,MAAM,CAAC;IAChB,yCAAyC;IACzC,IAAI,EAAE,MAAM,CAAC;IACb,0BAA0B;IAC1B,IAAI,EAAE,MAAM,CAAC;IACb,8KAA8K;IAC9K,UAAU,EAAE,OAAO,CAAC;IACpB,wGAAwG;IACxG,OAAO,CAAC,EAAE,MAAM,CAAC;CACpB;AAED;;;;;GAKG;AACH,MAAM,WAAW,wBAAyB,SAAQ,qBAAqB;IACnE,KAAK,EAAE,YAAY,CAAC;CACvB;AAED;;;GAGG;AACH,MAAM,WAAW,oBAAoB;IACjC,uCAAuC;IACvC,SAAS,EAAE,mBAAmB,EAAE,CAAC;IACjC,gJAAgJ;IAChJ,QAAQ,EAAE,MAAM,EAAE,CAAC;CACtB;AAED;;;GAGG;AACH,MAAM,WAAW,eAAe;IAC5B,WAAW,EAAE,wBAAwB,EAAE,CAAC;IACxC,mFAAmF;IACnF,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAChC,kGAAkG;IAClG,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACpC,6wBAA6wB;IAC7wB,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CACnC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@deadair/sdk",
-  "version": "0.67.1",
+  "version": "0.68.0",
   "description": "A typed client for the deadair station's HTTP API, generated from the same contracts the station serves.",
   "keywords": [
     "deadair",