@fonderie/client 0.29.2 → 0.31.0

package/brain/signatures.md

@@ -285,6 +285,8 @@ new AdminClient(opts: IAdminClientOptions): AdminClient
   .adminLog(query?: IAdminLogQuery): Promise<IApiResponse<IAdminLogPage>>
   .issueToken(input: IAdminIssueTokenInput): Promise<IApiResponse<IAdminIssuedToken>>
   .revokeToken(id: string): Promise<IApiResponse<undefined>>
+  .migrations(): Promise<IApiResponse<IAdminMigrationsReport>>
+  .applyMigrations(module: string, expect: readonly string[]): Promise<IApiResponse<IAdminMigrationModule>>
 
 interface IAuthAdminClientOptions {
     baseUrl: string;
@@ -298,7 +300,13 @@ interface IAdminLoginHistoryQuery {
     cursor?: string;
 }
 
+interface IAdminUsersQuery {
+    limit?: number;
+    cursor?: string;
+}
+
 new AuthAdminClient(opts: IAuthAdminClientOptions): AuthAdminClient
+  .listUsers(query?: IAdminUsersQuery): Promise<IApiResponse<IAdminUserPageResult>>
   .findUser(email: string): Promise<IApiResponse<IAdminUserDTO>>
   .getUser(id: string): Promise<IApiResponse<IAdminUserDTO>>
   .listUserSessions(id: string): Promise<IApiResponse<ISessionDTO[]>>
@@ -320,11 +328,17 @@ interface IAdminLedgerQuery {
     cursor?: string;
 }
 
+interface IAdminSubscriptionsQuery {
+    limit?: number;
+    cursor?: string;
+}
+
 new BillingAdminClient(opts: IBillingAdminClientOptions): BillingAdminClient
   .catalog(): Promise<IApiResponse<IAdminCatalog>>
   .createPlan(input: IAdminPlanInput & { name: string; }): Promise<IApiResponse<IPlanDTO>>
   .updatePlan(planId: string, input: IAdminPlanInput): Promise<IApiResponse<IPlanDTO>>
   .deletePlan(planId: string): Promise<IApiResponse<undefined>>
+  .listSubscriptions(query?: IAdminSubscriptionsQuery): Promise<IApiResponse<IAdminSubscriptionPage>>
   .subscription(type: SubscriberType, id: string): Promise<IApiResponse<IAdminSubscriptionDTO>>
   .wallet(type: SubscriberType, id: string, currency?: string | undefined): Promise<IApiResponse<IAdminWalletDTO>>
   .walletLedger(type: SubscriberType, id: string, query?: IAdminLedgerQuery): Promise<IApiResponse<IAdminWalletLedgerPage>>
@@ -357,6 +371,20 @@ interface ICourierAdminClientOptions {
     actor?: string;
 }
 
+interface IPreviewTemplateInput {
+    text: string;
+    subject?: string;
+    html?: string;
+    data?: Record<string, unknown>;
+}
+
+interface IRenderedTemplateResult {
+    subject?: string;
+    html?: string;
+    text: string;
+    variables: string[];
+}
+
 interface IRollbackTemplateInput {
     toVersion: number;
 }
@@ -376,6 +404,7 @@ new CourierAdminClient(opts: ICourierAdminClientOptions): CourierAdminClient
   .deleteTemplate(type: string, locale?: string | null | undefined): Promise<IApiResponse<undefined>>
   .listRevisions(type: string, locale?: string | null | undefined): Promise<IApiResponse<ITemplateRevision[]>>
   .rollback(type: string, input: IRollbackTemplateInput, locale?: string | null | undefined): Promise<IApiResponse<ITemplateEntry>>
+  .previewTemplate(type: string, input: IPreviewTemplateInput, locale?: string | null | undefined): Promise<IApiResponse<IRenderedTemplateResult>>
 
 interface IAddAddressInput {
     countryIso: string;
@@ -662,6 +691,11 @@ interface ILoginEventDTO {
     createdAt: string;
 }
 
+interface IAdminUserPageResult {
+    users: IAdminUserDTO[];
+    nextCursor: string | null;
+}
+
 interface ILoginHistoryPageResult {
     events: ILoginEventDTO[];
     nextCursor: string | null;
@@ -829,6 +863,26 @@ interface IAdminIssuedToken extends IAdminTokenRecord {
     token: string;
 }
 
+type MigrationImpact = 'additive' | 'destructive';
+
+interface IAdminPendingMigration {
+    file: string;
+    impact: MigrationImpact;
+    destructive: string[];
+}
+
+interface IAdminMigrationModule {
+    name: string;
+    pending: IAdminPendingMigration[];
+    blockedBy: string | null;
+    appliable: boolean;
+}
+
+interface IAdminMigrationsReport {
+    everApplied: boolean;
+    modules: IAdminMigrationModule[];
+}
+
 interface IAdminUserDTO extends IUserDTO {
     deletedAt: string | null;
 }
@@ -859,6 +913,11 @@ interface IAdminWalletDTO extends IWalletDTO {
     updatedAt: string | null;
 }
 
+interface IAdminSubscriptionPage {
+    subscriptions: IAdminSubscriptionDTO[];
+    nextCursor: string | null;
+}
+
 interface IAdminWalletLedgerPage {
     currency: string;
     entries: IWalletTransactionDTO[];

package/dist/index.cjs

@@ -1828,6 +1828,26 @@ var AdminClient = class {
   revokeToken(id) {
     return this.call("DELETE", `/access/tokens/${encodeURIComponent(id)}`);
   }
+  // What each module is waiting on, with every pending file's impact. Empty
+  // when the deployment did not hand its migration sequence to the surface.
+  migrations() {
+    return this.get("/migrations");
+  }
+  /**
+   * Apply one module's pending migrations — all of them, or none.
+   *
+   * `expect` is the pending list you were shown, in order. If it no longer
+   * matches, the server refuses with 409 MIGRATIONS_CHANGED rather than
+   * applying something nobody reviewed. Also refuses 409 when an earlier
+   * module is behind, and 422 when any pending file deletes data.
+   */
+  applyMigrations(module2, expect) {
+    return this.call(
+      "POST",
+      `/migrations/${encodeURIComponent(module2)}/apply`,
+      { expect }
+    );
+  }
 };
 
 // src/modules/auth-admin.ts
@@ -1850,6 +1870,15 @@ var AuthAdminClient = class {
       headers: this.actorHeaders
     });
   }
+  // A page of users, newest first. The same route as findUser — with an email
+  // it looks one up, without one it lists.
+  listUsers(query = {}) {
+    const q = new URLSearchParams();
+    if (query.limit) q.set("limit", String(query.limit));
+    if (query.cursor) q.set("cursor", query.cursor);
+    const qs = q.toString();
+    return this.call("GET", qs ? `?${qs}` : "");
+  }
   findUser(email) {
     return this.call("GET", `?email=${encodeURIComponent(email)}`);
   }
@@ -1917,6 +1946,15 @@ var BillingAdminClient = class {
   deletePlan(planId) {
     return this.call("DELETE", `/plans/${encodeURIComponent(planId)}`);
   }
+  // A page of subscribers, newest first. The lookup below still answers for a
+  // known subscriber; this is for finding one you cannot name.
+  listSubscriptions(query = {}) {
+    const q = new URLSearchParams();
+    if (query.limit) q.set("limit", String(query.limit));
+    if (query.cursor) q.set("cursor", query.cursor);
+    const qs = q.toString();
+    return this.call("GET", `/subscriptions${qs ? `?${qs}` : ""}`);
+  }
   subscription(type, id) {
     return this.call("GET", `/subscriptions${this.sub(type, id)}`);
   }
@@ -2055,6 +2093,22 @@ var CourierAdminClient = class {
       })
     );
   }
+  // Renders content you are HOLDING, not what is stored — so an editor can
+  // show the change before it is saved. Server-side on purpose: the shell and
+  // the variable substitution are the resolver's, and a preview rendered any
+  // other way would not be the mail that sends.
+  previewTemplate(type, input, locale) {
+    const q = locale ? `?locale=${encodeURIComponent(locale)}` : "";
+    return this.http.request(
+      this.rebase({
+        method: "POST",
+        path: `/admin/templates/${encodeURIComponent(type)}/preview${q}`,
+        body: input,
+        token: this.adminToken,
+        headers: this.actorHeaders
+      })
+    );
+  }
 };
 
 // src/types.ts