palbase 0.10.1 → 0.11.0

package/types/internal/src/modules/events.d.ts

@@ -13,11 +13,11 @@ export interface PlatformEvents extends AiEvents, AnalyticsEvents, AuthEvents, F
 /** A platform event's type: one a module's contract declares. */
 export type EventType = keyof PlatformEvents;
 /** Every platform event's type, as the contracts declare them. */
-export declare const EVENT_TYPES: readonly ["ai.goal.updated", "ai.response.completed", "ai.response.failed", "ai.response.started", "ai.voice.closed", "ai.voice.delegated", "ai.voice.started", "ai.workspace.published", "ai.workspace.pushed", "audience.entered", "audience.exited", "consent.changed", "device.revoked", "file.deleted", "file.moved", "file.uploaded", "flag.changed", "flag.override_changed", "notification.action", "notification.bounced", "notification.complained", "notification.delivered", "notification.dismissed", "notification.expired", "notification.failed", "notification.not_shown", "notification.opened", "notification.read", "notification.received", "notification.rejected", "notification.sent", "notification.unconfirmed", "notification.undelivered", "notification.uninstalled", "purchases.catalog.applied", "purchases.catalog.changed", "purchases.coupon.redeemed", "purchases.credits.depleted", "purchases.credits.low", "purchases.customer.changed", "purchases.customer.erased", "purchases.customer.merged", "purchases.entitlement.changed", "purchases.offer.redeemed", "purchases.ownership.transferred", "purchases.paywall.published", "purchases.purchase.completed", "purchases.quota.exhausted", "purchases.quota.threshold", "purchases.refund.changed", "purchases.store.changed", "purchases.subscription.changed", "session.ended", "stores.action.changed", "stores.app.changed", "stores.apple.changed", "stores.delivery.changed", "stores.delivery.requested", "stores.google.changed", "stores.group.changed", "stores.package.changed", "user.converted", "user.deleted", "user.locale_changed", "user.permissions_changed"];
+export declare const EVENT_TYPES: readonly ["ai.goal.updated", "ai.response.completed", "ai.response.failed", "ai.response.started", "ai.voice.closed", "ai.voice.delegated", "ai.voice.started", "ai.workspace.published", "ai.workspace.pushed", "audience.entered", "audience.exited", "consent.changed", "device.revoked", "file.deleted", "file.moved", "file.uploaded", "flag.changed", "flag.override_changed", "notification.action", "notification.bounced", "notification.complained", "notification.delivered", "notification.dismissed", "notification.expired", "notification.failed", "notification.not_shown", "notification.opened", "notification.read", "notification.received", "notification.rejected", "notification.sent", "notification.unconfirmed", "notification.undelivered", "notification.uninstalled", "purchases.catalog.applied", "purchases.catalog.changed", "purchases.coupon.redeemed", "purchases.credits.depleted", "purchases.credits.low", "purchases.customer.changed", "purchases.customer.erased", "purchases.customer.merged", "purchases.entitlement.changed", "purchases.offer.redeemed", "purchases.ownership.transferred", "purchases.paywall.published", "purchases.purchase.completed", "purchases.quota.exhausted", "purchases.quota.threshold", "purchases.refund.changed", "purchases.store.changed", "purchases.subscription.changed", "session.ended", "stores.action.changed", "stores.app.changed", "stores.apple.changed", "stores.delivery.changed", "stores.delivery.requested", "stores.google.changed", "stores.group.changed", "stores.package.changed", "stores.version.changed", "stores.version.reviewed", "user.converted", "user.deleted", "user.locale_changed", "user.permissions_changed"];
 /**
  * A platform event as delivered: one member per type the contracts declare,
  * its data that type's payload, so a switch on its type narrows it. An
  * event of a type none of them declares (one a newer platform sends) is no
  * member: at run time it reaches the switch's default, which takes it.
  */
-export type PalbaseEvent = WebhookEvent<PlatformEvents["ai.goal.updated"], "ai.goal.updated"> | WebhookEvent<PlatformEvents["ai.response.completed"], "ai.response.completed"> | WebhookEvent<PlatformEvents["ai.response.failed"], "ai.response.failed"> | WebhookEvent<PlatformEvents["ai.response.started"], "ai.response.started"> | WebhookEvent<PlatformEvents["ai.voice.closed"], "ai.voice.closed"> | WebhookEvent<PlatformEvents["ai.voice.delegated"], "ai.voice.delegated"> | WebhookEvent<PlatformEvents["ai.voice.started"], "ai.voice.started"> | WebhookEvent<PlatformEvents["ai.workspace.published"], "ai.workspace.published"> | WebhookEvent<PlatformEvents["ai.workspace.pushed"], "ai.workspace.pushed"> | WebhookEvent<PlatformEvents["audience.entered"], "audience.entered"> | WebhookEvent<PlatformEvents["audience.exited"], "audience.exited"> | WebhookEvent<PlatformEvents["consent.changed"], "consent.changed"> | WebhookEvent<PlatformEvents["device.revoked"], "device.revoked"> | WebhookEvent<PlatformEvents["file.deleted"], "file.deleted"> | WebhookEvent<PlatformEvents["file.moved"], "file.moved"> | WebhookEvent<PlatformEvents["file.uploaded"], "file.uploaded"> | WebhookEvent<PlatformEvents["flag.changed"], "flag.changed"> | WebhookEvent<PlatformEvents["flag.override_changed"], "flag.override_changed"> | WebhookEvent<PlatformEvents["notification.action"], "notification.action"> | WebhookEvent<PlatformEvents["notification.bounced"], "notification.bounced"> | WebhookEvent<PlatformEvents["notification.complained"], "notification.complained"> | WebhookEvent<PlatformEvents["notification.delivered"], "notification.delivered"> | WebhookEvent<PlatformEvents["notification.dismissed"], "notification.dismissed"> | WebhookEvent<PlatformEvents["notification.expired"], "notification.expired"> | WebhookEvent<PlatformEvents["notification.failed"], "notification.failed"> | WebhookEvent<PlatformEvents["notification.not_shown"], "notification.not_shown"> | WebhookEvent<PlatformEvents["notification.opened"], "notification.opened"> | WebhookEvent<PlatformEvents["notification.read"], "notification.read"> | WebhookEvent<PlatformEvents["notification.received"], "notification.received"> | WebhookEvent<PlatformEvents["notification.rejected"], "notification.rejected"> | WebhookEvent<PlatformEvents["notification.sent"], "notification.sent"> | WebhookEvent<PlatformEvents["notification.unconfirmed"], "notification.unconfirmed"> | WebhookEvent<PlatformEvents["notification.undelivered"], "notification.undelivered"> | WebhookEvent<PlatformEvents["notification.uninstalled"], "notification.uninstalled"> | WebhookEvent<PlatformEvents["purchases.catalog.applied"], "purchases.catalog.applied"> | WebhookEvent<PlatformEvents["purchases.catalog.changed"], "purchases.catalog.changed"> | WebhookEvent<PlatformEvents["purchases.coupon.redeemed"], "purchases.coupon.redeemed"> | WebhookEvent<PlatformEvents["purchases.credits.depleted"], "purchases.credits.depleted"> | WebhookEvent<PlatformEvents["purchases.credits.low"], "purchases.credits.low"> | WebhookEvent<PlatformEvents["purchases.customer.changed"], "purchases.customer.changed"> | WebhookEvent<PlatformEvents["purchases.customer.erased"], "purchases.customer.erased"> | WebhookEvent<PlatformEvents["purchases.customer.merged"], "purchases.customer.merged"> | WebhookEvent<PlatformEvents["purchases.entitlement.changed"], "purchases.entitlement.changed"> | WebhookEvent<PlatformEvents["purchases.offer.redeemed"], "purchases.offer.redeemed"> | WebhookEvent<PlatformEvents["purchases.ownership.transferred"], "purchases.ownership.transferred"> | WebhookEvent<PlatformEvents["purchases.paywall.published"], "purchases.paywall.published"> | WebhookEvent<PlatformEvents["purchases.purchase.completed"], "purchases.purchase.completed"> | WebhookEvent<PlatformEvents["purchases.quota.exhausted"], "purchases.quota.exhausted"> | WebhookEvent<PlatformEvents["purchases.quota.threshold"], "purchases.quota.threshold"> | WebhookEvent<PlatformEvents["purchases.refund.changed"], "purchases.refund.changed"> | WebhookEvent<PlatformEvents["purchases.store.changed"], "purchases.store.changed"> | WebhookEvent<PlatformEvents["purchases.subscription.changed"], "purchases.subscription.changed"> | WebhookEvent<PlatformEvents["session.ended"], "session.ended"> | WebhookEvent<PlatformEvents["stores.action.changed"], "stores.action.changed"> | WebhookEvent<PlatformEvents["stores.app.changed"], "stores.app.changed"> | WebhookEvent<PlatformEvents["stores.apple.changed"], "stores.apple.changed"> | WebhookEvent<PlatformEvents["stores.delivery.changed"], "stores.delivery.changed"> | WebhookEvent<PlatformEvents["stores.delivery.requested"], "stores.delivery.requested"> | WebhookEvent<PlatformEvents["stores.google.changed"], "stores.google.changed"> | WebhookEvent<PlatformEvents["stores.group.changed"], "stores.group.changed"> | WebhookEvent<PlatformEvents["stores.package.changed"], "stores.package.changed"> | WebhookEvent<PlatformEvents["user.converted"], "user.converted"> | WebhookEvent<PlatformEvents["user.deleted"], "user.deleted"> | WebhookEvent<PlatformEvents["user.locale_changed"], "user.locale_changed"> | WebhookEvent<PlatformEvents["user.permissions_changed"], "user.permissions_changed">;
+export type PalbaseEvent = WebhookEvent<PlatformEvents["ai.goal.updated"], "ai.goal.updated"> | WebhookEvent<PlatformEvents["ai.response.completed"], "ai.response.completed"> | WebhookEvent<PlatformEvents["ai.response.failed"], "ai.response.failed"> | WebhookEvent<PlatformEvents["ai.response.started"], "ai.response.started"> | WebhookEvent<PlatformEvents["ai.voice.closed"], "ai.voice.closed"> | WebhookEvent<PlatformEvents["ai.voice.delegated"], "ai.voice.delegated"> | WebhookEvent<PlatformEvents["ai.voice.started"], "ai.voice.started"> | WebhookEvent<PlatformEvents["ai.workspace.published"], "ai.workspace.published"> | WebhookEvent<PlatformEvents["ai.workspace.pushed"], "ai.workspace.pushed"> | WebhookEvent<PlatformEvents["audience.entered"], "audience.entered"> | WebhookEvent<PlatformEvents["audience.exited"], "audience.exited"> | WebhookEvent<PlatformEvents["consent.changed"], "consent.changed"> | WebhookEvent<PlatformEvents["device.revoked"], "device.revoked"> | WebhookEvent<PlatformEvents["file.deleted"], "file.deleted"> | WebhookEvent<PlatformEvents["file.moved"], "file.moved"> | WebhookEvent<PlatformEvents["file.uploaded"], "file.uploaded"> | WebhookEvent<PlatformEvents["flag.changed"], "flag.changed"> | WebhookEvent<PlatformEvents["flag.override_changed"], "flag.override_changed"> | WebhookEvent<PlatformEvents["notification.action"], "notification.action"> | WebhookEvent<PlatformEvents["notification.bounced"], "notification.bounced"> | WebhookEvent<PlatformEvents["notification.complained"], "notification.complained"> | WebhookEvent<PlatformEvents["notification.delivered"], "notification.delivered"> | WebhookEvent<PlatformEvents["notification.dismissed"], "notification.dismissed"> | WebhookEvent<PlatformEvents["notification.expired"], "notification.expired"> | WebhookEvent<PlatformEvents["notification.failed"], "notification.failed"> | WebhookEvent<PlatformEvents["notification.not_shown"], "notification.not_shown"> | WebhookEvent<PlatformEvents["notification.opened"], "notification.opened"> | WebhookEvent<PlatformEvents["notification.read"], "notification.read"> | WebhookEvent<PlatformEvents["notification.received"], "notification.received"> | WebhookEvent<PlatformEvents["notification.rejected"], "notification.rejected"> | WebhookEvent<PlatformEvents["notification.sent"], "notification.sent"> | WebhookEvent<PlatformEvents["notification.unconfirmed"], "notification.unconfirmed"> | WebhookEvent<PlatformEvents["notification.undelivered"], "notification.undelivered"> | WebhookEvent<PlatformEvents["notification.uninstalled"], "notification.uninstalled"> | WebhookEvent<PlatformEvents["purchases.catalog.applied"], "purchases.catalog.applied"> | WebhookEvent<PlatformEvents["purchases.catalog.changed"], "purchases.catalog.changed"> | WebhookEvent<PlatformEvents["purchases.coupon.redeemed"], "purchases.coupon.redeemed"> | WebhookEvent<PlatformEvents["purchases.credits.depleted"], "purchases.credits.depleted"> | WebhookEvent<PlatformEvents["purchases.credits.low"], "purchases.credits.low"> | WebhookEvent<PlatformEvents["purchases.customer.changed"], "purchases.customer.changed"> | WebhookEvent<PlatformEvents["purchases.customer.erased"], "purchases.customer.erased"> | WebhookEvent<PlatformEvents["purchases.customer.merged"], "purchases.customer.merged"> | WebhookEvent<PlatformEvents["purchases.entitlement.changed"], "purchases.entitlement.changed"> | WebhookEvent<PlatformEvents["purchases.offer.redeemed"], "purchases.offer.redeemed"> | WebhookEvent<PlatformEvents["purchases.ownership.transferred"], "purchases.ownership.transferred"> | WebhookEvent<PlatformEvents["purchases.paywall.published"], "purchases.paywall.published"> | WebhookEvent<PlatformEvents["purchases.purchase.completed"], "purchases.purchase.completed"> | WebhookEvent<PlatformEvents["purchases.quota.exhausted"], "purchases.quota.exhausted"> | WebhookEvent<PlatformEvents["purchases.quota.threshold"], "purchases.quota.threshold"> | WebhookEvent<PlatformEvents["purchases.refund.changed"], "purchases.refund.changed"> | WebhookEvent<PlatformEvents["purchases.store.changed"], "purchases.store.changed"> | WebhookEvent<PlatformEvents["purchases.subscription.changed"], "purchases.subscription.changed"> | WebhookEvent<PlatformEvents["session.ended"], "session.ended"> | WebhookEvent<PlatformEvents["stores.action.changed"], "stores.action.changed"> | WebhookEvent<PlatformEvents["stores.app.changed"], "stores.app.changed"> | WebhookEvent<PlatformEvents["stores.apple.changed"], "stores.apple.changed"> | WebhookEvent<PlatformEvents["stores.delivery.changed"], "stores.delivery.changed"> | WebhookEvent<PlatformEvents["stores.delivery.requested"], "stores.delivery.requested"> | WebhookEvent<PlatformEvents["stores.google.changed"], "stores.google.changed"> | WebhookEvent<PlatformEvents["stores.group.changed"], "stores.group.changed"> | WebhookEvent<PlatformEvents["stores.package.changed"], "stores.package.changed"> | WebhookEvent<PlatformEvents["stores.version.changed"], "stores.version.changed"> | WebhookEvent<PlatformEvents["stores.version.reviewed"], "stores.version.reviewed"> | WebhookEvent<PlatformEvents["user.converted"], "user.converted"> | WebhookEvent<PlatformEvents["user.deleted"], "user.deleted"> | WebhookEvent<PlatformEvents["user.locale_changed"], "user.locale_changed"> | WebhookEvent<PlatformEvents["user.permissions_changed"], "user.permissions_changed">;

package/types/internal/src/modules/machines.d.ts

@@ -123,7 +123,7 @@ export type InstallationLink = {
     user_token: string;
 };
 /**
- * Connects an installation another project of the same organization connected, on Studio's word that both are one organization's (the X-Palbase-Studio-Share header, which Studio's backend alone signs; Studio's call that connects an organization's installation asks it) — no GitHub user's token. The project reaches what that project's GitHub user can push to, as it does.
+ * Connects an installation another project of the same organization connected, on the registry's word that both are one organization's (the X-Palbase-Studio-Share header, which the registry alone signs, for an admin of both; Studio's call that connects an organization's installation asks it) — no GitHub user's token. The project reaches what that project's GitHub user can push to, as it does.
  */
 export type InstallationShare = {
     installation_id: number;
@@ -1345,6 +1345,41 @@ export type TaskType = {
 export type TaskTypeList = {
     types: TaskType[];
 };
+/**
+ * A template written for a test user — its rows by table, as the machine's program said — or why it was not (error: no_template, not_a_test_user, template_failed, template_timeout, machine_unavailable, then a colon and why). again: answered from what was kept when it was written before; the machine was not asked again.
+ */
+export type TemplateOutcome = {
+    name: string;
+    rows?: {
+        [key: string]: number;
+    };
+    error?: string;
+    again?: boolean;
+};
+/**
+ * A test user made with a template: its sign-in, shown this once, and what became of the template. The user is made whatever came of the template.
+ */
+export type TemplatedUser = {
+    user_id: string;
+    email: string;
+    /**
+     * Its password, shown this once (a test fixture).
+     */
+    password: string;
+    /**
+     * With with_tokens: an access token for it (a test fixture).
+     */
+    access_token?: string;
+    template: TemplateOutcome;
+};
+export type TemplatedUserList = {
+    users: TemplatedUser[];
+};
+export type TemplatedUsersAsked = {
+    count?: number;
+    template: string;
+    with_tokens?: boolean;
+};
 /** Palbase Machines */
 export declare function client(t: Transport): {
     /**
@@ -1412,7 +1447,7 @@ export declare function client(t: Transport): {
     /**
      * Share an installation of the organization
      *
-     * Connects an installation of Palbase Cloud that another project of the same organization connected, on Studio's word (X-Palbase-Studio-Share): a program that opens a project for each product connects its own installation to each, with no person's GitHub token. The project reaches the repositories of it the GitHub user who connected it there can push to — and, as with every connection, one created or added to the installation later once that user can push to it (asked when a machine is built from it, and when GitHub says repositories were added). Refused without Studio's word, or when that project has not connected the installation; and when this project connected it otherwise — for other repositories, for all of them where this names some (or some where this names none), or by another GitHub user: linking again never widens, narrows or hands over a connection, so it is disconnected and connected anew. The same share again is as it was.
+     * Connects an installation of Palbase Cloud that another project of the same organization connected, on the registry's word (X-Palbase-Studio-Share), which Studio asks the registry for an admin of both projects: a program that opens a project for each product connects its own installation to each, with no person's GitHub token. The project reaches the repositories of it the GitHub user who connected it there can push to — and, as with every connection, one created or added to the installation later once that user can push to it (asked when a machine is built from it, and when GitHub says repositories were added). Refused without the registry's word, or when that project has not connected the installation; and when this project connected it otherwise — for other repositories, for all of them where this names some (or some where this names none), or by another GitHub user: linking again never widens, narrows or hands over a connection, so it is disconnected and connected anew. The same share again is as it was.
      */
     shareInstallation(input: {
         body: InstallationShare; /** Stops the call: the request in flight, a wait before a retry, a proof-of-work being solved. */
@@ -1877,5 +1912,42 @@ export declare function client(t: Transport): {
         }; /** Stops the call: the request in flight, a wait before a retry, a proof-of-work being solved. */
         signal?: AbortSignal;
     }): Promise<Reply<200, TaskTypeList>>;
+    /**
+     * Make test users with a template's data
+     *
+     * Makes 1 to 10 test users (auth's: their tokens say test: true) and has the machine's own program write a template's data for each — the backend's seed for one account (palbase/backend's @TestUserTemplate), for a person or an agent to sign in and see a screen with its data. The platform calls the program for each user — POST /_palbase/test-user-templates/<template> on the machine's own port, with {"user": {"id", "email"}, "template"}, signed as a cron's call is, waking the machine for it; the program writes the template in one transaction and answers {"rows": {table: count}}, or refuses a user auth does not say is a test user (403). A user is made whatever came of its template: its template answers its error by name. The same user and template asked again (POST …/test-users/{user}/templates/{template}) answers what was kept, the machine not asked again. The users' passwords (and with with_tokens their access tokens) are test fixtures, shown this once, as auth's test users' are. 409 when auth makes no more test users for the project; 429 quota_exceeded, and no user made, when the project's machines are not run now (its machine time for the period used up, or the project deleted).
+     */
+    makeTemplatedTestUsers(input: {
+        path: {
+            name: string;
+        };
+        body: TemplatedUsersAsked; /** Stops the call: the request in flight, a wait before a retry, a proof-of-work being solved. */
+        signal?: AbortSignal;
+    }): Promise<Reply<201, TemplatedUserList>>;
+    /**
+     * Write a template for a test user
+     *
+     * Has the machine's program write a template for a test user this machine made with one (POST /machines/{name}/test-users) — answered from what was kept when it wrote that template for that user before, the machine not asked again (again: true). 429 quota_exceeded when the project's machines are not run now and the template was not written before. 404 when the user is no test user this machine made with a template: a test user is the machine's that made it, another machine of the project neither writes for it nor deletes it.
+     */
+    templateTestUser(input: {
+        path: {
+            name: string; /** The test user's id, as the users made with a template were answered. */
+            user: string; /** The template's name, as the machine's program names it (@TestUserTemplate): lowercase letters, digits, _ and -, starting with a letter, 64 at most. */
+            template: string;
+        }; /** Stops the call: the request in flight, a wait before a retry, a proof-of-work being solved. */
+        signal?: AbortSignal;
+    }): Promise<Reply<200, TemplateOutcome>>;
+    /**
+     * Delete a test user made with a template
+     *
+     * Has the machine's program undo each template the user was written with — POST /_palbase/test-user-templates/<template>/undo, signed as the template's call; a program with no undo (404) leaves it to its user.deleted — then deletes the user. 502 undo_failed when the program did not undo one: the user is kept, for the delete to be asked again. 429 quota_exceeded, the user kept, when the project's machines are not run now. 404 when the user is no test user this machine made with a template: a test user is the machine's that made it, another machine of the project neither writes for it nor deletes it.
+     */
+    deleteTemplatedTestUser(input: {
+        path: {
+            name: string; /** The test user's id, as the users made with a template were answered. */
+            user: string;
+        }; /** Stops the call: the request in flight, a wait before a retry, a proof-of-work being solved. */
+        signal?: AbortSignal;
+    }): Promise<Reply<204, undefined>>;
 };
 export type Client = ReturnType<typeof client>;

package/types/internal/src/modules/purchases.d.ts

@@ -8,7 +8,7 @@ export type AppReview = {
      */
     note?: string;
     /**
-     * The id of an image the project uploaded: the product in the app.
+     * The screenshot App Review is shown of the product in the app: the sha256 (sha256:<hex> or the hex alone) of an image uploaded to the stores module for review (palbase stores:review-screenshot, PUT /stores/apps/{app_id}/screenshots?for=review). A plan gives it to App Store Connect, and Apple then has what it needs of the product.
      */
     screenshot?: string;
 };
@@ -232,6 +232,10 @@ export type ApplePrice = {
      * The storefront (USA).
      */
     territory: string;
+    /**
+     * A coming price's first day (UTC); none for one in effect.
+     */
+    from?: string;
 };
 /**
  * Whether the environment sells in the App Store, check by check.
@@ -271,6 +275,7 @@ export type AppleStepResult = {
      * The App Store's product id (or the subscription group's reference name).
      */
     store_id: string;
+    next_price?: ApplePrice;
 };
 /**
  * What the stores module answered of a plan's Google Play part, once it wrote it (pending until then): Play's state, step by step.
@@ -645,6 +650,12 @@ export type Channel = {
      * Stripe's tax code for the product (the web's alone).
      */
     tax_code?: string;
+    /**
+     * Ids the store already sells the product's plans by — made in App Store Connect or the Play Console by hand, or by another tool — by plan key: the plan is that product at the store, found by its id and never made there (a plan's link step), and its purchases, recorded before, are the catalog's from then on. On the App Store each plan is a product of its own; on Google Play a subscription's plans are base plans of one product (every plan mapped, to the same product). Not for web.
+     */
+    store_ids?: {
+        [key: string]: StoreID;
+    };
 };
 /**
  * A chart, period by period.
@@ -3966,6 +3977,10 @@ export type Plan = {
      */
     period?: string;
     price: Price;
+    /**
+     * The plan off sale, its product sold by its other plans; a plan someone bought is retired, not left out (plan_has_buyers).
+     */
+    retired?: boolean;
 };
 /**
  * A confirmation, with the hash of the plan shown.
@@ -3995,7 +4010,7 @@ export type PlanStep = {
      */
     note?: string;
     /**
-     * What it does: create_product, update_product, create_price (Stripe); create_subscription_group, create_subscription, create_in_app_purchase (the App Store); create_subscription, create_onetime_product (Google Play).
+     * What it does: create_product, update_product, create_price (Stripe); create_subscription_group, create_subscription, create_in_app_purchase, update_subscription, update_in_app_purchase (what the catalog changed of a product App Store Connect has: its text, its price from tomorrow on — subscribers keep theirs —, its review screenshot and note), link_subscription, link_in_app_purchase (a product App Store Connect already sells, found by its id, nothing made or changed) (the App Store); create_subscription, create_onetime_product, update_subscription, update_onetime_product, link_subscription, link_onetime_product (Google Play).
      */
     op: string;
     /**
@@ -4154,6 +4169,10 @@ export type Product = {
      * How much of each limit it gives.
      */
     quota?: QuotaAllowance[];
+    /**
+     * Off sale: no store is asked to sell it and no one new buys it, while whoever bought it keeps what it gives. A product someone bought never leaves the catalog — a save that leaves it out, or gives it another key, is refused (product_has_buyers).
+     */
+    retired?: boolean;
     /**
      * A subscription's level in its group, 1 or more: higher is more.
      */
@@ -5490,7 +5509,7 @@ export type AppleOfferRequest = {
     environment?: string;
 };
 /**
- * What StoreKit buys the promotional offer with, for this customer's purchases: Apple's subscription offer signature.
+ * What StoreKit buys the promotional offer with, for this customer's purchases and their Apple account: Apple's subscription offer signature.
  */
 export type AppleOfferSignature = {
     /**
@@ -5521,6 +5540,10 @@ export type AppleOfferSignature = {
      * ES256, base64.
      */
     signature: string;
+    /**
+     * The same offer as a compact JWS (ES256 under key_id), naming one of the customer's App Store transactions (transactionId): Apple buys it for the Apple account holding that transaction alone. StoreKit buys with it since iOS 26 (Product.PurchaseOption.promotionalOffer(_:compactJWS:), back-deployed to iOS 15), and Xcode's StoreKit testing takes it alone for a key Xcode generated.
+     */
+    compact_jws: string;
 };
 /**
  * What came of an offer.
@@ -5817,6 +5840,19 @@ export type CouponRedeemedEvent = {
      */
     one_time: boolean;
 };
+/**
+ * A plan's product at a store.
+ */
+export type StoreID = {
+    /**
+     * A Google Play subscription's base plan id.
+     */
+    base_plan?: string;
+    /**
+     * The store's product id.
+     */
+    product: string;
+};
 /** The events this module sends the project's webhooks (x-palbase-events), by type: each one's payload, the event's data. */
 export interface Events {
     /**

package/types/internal/src/modules/secrets.d.ts

@@ -39,6 +39,93 @@ export type ErrorResponse = {
      */
     status: number;
 };
+/**
+ * A field key with the key.
+ */
+export type FieldKey = {
+    /**
+     * When new values are sealed with it from.
+     */
+    activates_at: string;
+    id: string;
+    /**
+     * The 32-byte AES-256-GCM key, base64url without padding.
+     */
+    key: string;
+};
+/**
+ * One of the project's field keys, without the key.
+ */
+export type FieldKeyInfo = {
+    /**
+     * When new values are sealed with it from.
+     */
+    activates_at: string;
+    created_at: string;
+    /**
+     * Who made it: a key's id, a developer's, or the first read's.
+     */
+    created_by: string;
+    /**
+     * The key's id (k1, k2, …): what a value it sealed names.
+     */
+    id: string;
+};
+/**
+ * The project's field keys, oldest first.
+ */
+export type FieldKeyList = {
+    /**
+     * The key new values are sealed with now.
+     */
+    current: string;
+    keys: FieldKeyInfo[];
+};
+/**
+ * Every field key of the project, oldest first, and its lookup key.
+ */
+export type FieldKeys = {
+    keys: FieldKey[];
+    /**
+     * The 32-byte HMAC-SHA256 key a field's lookup is made with, base64url without padding; no rotation changes it.
+     */
+    lookup: string;
+};
+export type FieldOpen = {
+    /**
+     * The column: table.column, or schema.table.column outside public.
+     */
+    address: string;
+    /**
+     * The column's encrypted values (pbe1.…).
+     */
+    values: string[];
+};
+export type FieldPlaceholder = {
+    /**
+     * The column: table.column, or schema.table.column outside public.
+     */
+    address: string;
+};
+export type FieldSealed = {
+    /**
+     * The placeholder sealed (pbe1.…) with the key in force.
+     */
+    value: string;
+};
+export type FieldsOpened = {
+    values: OpenedField[];
+};
+export type OpenedField = {
+    /**
+     * Why it did not open.
+     */
+    error?: "unopenable";
+    /**
+     * The field's value; null when it did not open.
+     */
+    value: string | null;
+};
 /**
  * A secret, without its value.
  */
@@ -59,19 +146,22 @@ export type Secret = {
  * One read or write of the project's secrets.
  */
 export type SecretAuditEntry = {
-    action: "list" | "read" | "read_all" | "write" | "rollback" | "delete" | "versions";
+    action: "list" | "read" | "read_all" | "write" | "rollback" | "delete" | "versions" | "field_keys_list" | "field_keys_read" | "field_keys_rotate" | "field_open" | "field_placeholder";
     /**
      * When it happened.
      */
     at: string;
-    environment: "development" | "production";
+    /**
+     * The environment, for a secret's action; absent for the field keys'.
+     */
+    environment?: "development" | "production";
     id: string;
     /**
      * The id of the key that made the request.
      */
     key_id: string;
     /**
-     * The secret, when the action names one.
+     * The secret, when the action names one; the field key made, for a rotation; the column, for a field opened or a placeholder sealed.
      */
     name?: string;
     request_id: string;
@@ -170,6 +260,51 @@ export declare function client(t: Transport): {
         }; /** Stops the call: the request in flight, a wait before a retry, a proof-of-work being solved. */
         signal?: AbortSignal;
     }): Promise<Reply<200, SecretAuditPage>>;
+    /**
+     * List the field keys
+     *
+     * The project's field keys without the keys: their ids, when each came (or comes) into force, who made it, and the one new values are sealed with now. The project's first key is made on first use. Recorded in the audit trail.
+     */
+    listFieldKeys(input?: {
+        signal?: AbortSignal;
+    }): Promise<Reply<200, FieldKeyList>>;
+    /**
+     * Read the field keys
+     *
+     * Every field key of the project with the key, and its lookup key: what its backend reads at startup and every minute after (palbase/server's `fields`). A developer reads them only as the project's owner — to open a dump of the database elsewhere. The read is recorded in the audit trail.
+     */
+    getFieldKeys(input?: {
+        signal?: AbortSignal;
+    }): Promise<Reply<200, FieldKeys>>;
+    /**
+     * Open encrypted fields
+     *
+     * Opens encrypted fields of one column for a developer looking at them in Studio, as the project's owner or an admin; the keys stay in the module. A value that does not open there — tampered, from another column, not encrypted — is answered `unopenable`. Every opening is recorded in the audit trail, with the column.
+     */
+    openFields(input: {
+        body: FieldOpen; /** Stops the call: the request in flight, a wait before a retry, a proof-of-work being solved. */
+        signal?: AbortSignal;
+    }): Promise<Reply<200, FieldsOpened>>;
+    /**
+     * Seal the placeholder
+     *
+     * Seals the placeholder (`•••`) at a column's address with the key in force: what a copy of another environment's data (`palbase db:copy`) fills its encrypted columns with — never that environment's values, whose keys are not this project's. The value is fixed: no caller has a value of its choice sealed here, which the project's backend would take as its own. Recorded in the audit trail, with the column.
+     */
+    sealPlaceholder(input: {
+        body: FieldPlaceholder; /** Stops the call: the request in flight, a wait before a retry, a proof-of-work being solved. */
+        signal?: AbortSignal;
+    }): Promise<Reply<200, FieldSealed>>;
+    /**
+     * Rotate the field keys
+     *
+     * Makes a new field key, in force five minutes from now: by then every running backend has fetched it, so none meets a value it cannot open. New values are sealed with it from then on; the older keys go on opening what they sealed until a deploy seals their fields again. A developer rotates as the project's owner or an admin. One rotation at a time: a second before the first is in force is refused (409). Recorded in the audit trail.
+     */
+    rotateFieldKeys(input?: {
+        headers?: {
+            "Idempotency-Key"?: string;
+        }; /** Stops the call: the request in flight, a wait before a retry, a proof-of-work being solved. */
+        signal?: AbortSignal;
+    }): Promise<Reply<200, FieldKeyList>>;
     /**
      * List an environment's secrets
      *