palbase 0.7.0 → 0.8.0

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

@@ -744,7 +744,7 @@ export type AnonymousConvertRequest = {
      */
     password: string;
     /**
-     * Where the verification link lands; must be on the project's redirect allow-list.
+     * Where the verification link lands: an address the auth settings' redirect_urls allow, or one of the project's web apps' redirects (apps:env:set --redirect); any other is refused (invalid_redirect).
      */
     redirect_to?: string;
 };
@@ -1454,6 +1454,10 @@ export type ErrorResponse = {
      * On a refused configuration (invalid_auth_config): each field refused, by its JSON Pointer in the request body, and why.
      */
     field_errors?: FieldError[];
+    /**
+     * Why a session ended, on a refused refresh: user_deleted (the account was deleted), user_banned (the account was suspended). The refusal's code stays the one a client ends a session on (invalid_token, session_revoked).
+     */
+    reason?: "user_deleted" | "user_banned";
     /**
      * Correlation ID for log/audit lookup
      */
@@ -1956,6 +1960,10 @@ export type MFAVerifyEnrollmentRequest = {
 };
 export type MagicLinkRequest = {
     email: string;
+    /**
+     * Where the sign-in link lands instead of the project's site URL: an address the auth settings' redirect_urls allow, or one of the project's web apps' redirects (apps:env:set --redirect); any other is refused (invalid_redirect).
+     */
+    redirect_to?: string;
 };
 export type MagicLinkVerifyRequest = {
     token: string;
@@ -2185,6 +2193,10 @@ export type PasswordResetConfirmRequest = {
 };
 export type PasswordResetRequest = {
     email: string;
+    /**
+     * Where the reset link lands instead of the project's site URL: an address the auth settings' redirect_urls allow, or one of the project's web apps' redirects (apps:env:set --redirect); any other is refused (invalid_redirect).
+     */
+    redirect_to?: string;
 };
 export type PasswordSetRequest = {
     /**
@@ -2599,7 +2611,7 @@ export type SignupRequest = {
      */
     password: string;
     /**
-     * Where the verification link lands; must be on the project's redirect allow-list.
+     * Where the verification link lands: an address the auth settings' redirect_urls allow, or one of the project's web apps' redirects (apps:env:set --redirect); any other is refused (invalid_redirect).
      */
     redirect_to?: string;
 };

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

@@ -9,11 +9,11 @@ export interface PlatformEvents extends AiEvents, PurchasesEvents, StorageEvents
 /** 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.response.completed", "ai.response.failed", "file.deleted", "file.moved", "file.uploaded", "purchases.catalog.applied", "purchases.catalog.changed", "purchases.credits.depleted", "purchases.credits.low", "purchases.customer.changed", "purchases.customer.erased", "purchases.customer.merged", "purchases.entitlement.changed", "purchases.ownership.transferred", "purchases.paywall.published", "purchases.purchase.completed", "purchases.quota.exhausted", "purchases.quota.threshold", "purchases.refund.changed", "purchases.store.changed", "purchases.subscription.changed", "stores.action.changed", "stores.app.changed", "stores.apple.changed", "stores.delivery.changed", "stores.delivery.requested", "stores.group.changed", "stores.package.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", "file.deleted", "file.moved", "file.uploaded", "purchases.catalog.applied", "purchases.catalog.changed", "purchases.credits.depleted", "purchases.credits.low", "purchases.customer.changed", "purchases.customer.erased", "purchases.customer.merged", "purchases.entitlement.changed", "purchases.ownership.transferred", "purchases.paywall.published", "purchases.purchase.completed", "purchases.quota.exhausted", "purchases.quota.threshold", "purchases.refund.changed", "purchases.store.changed", "purchases.subscription.changed", "stores.action.changed", "stores.app.changed", "stores.apple.changed", "stores.delivery.changed", "stores.delivery.requested", "stores.google.changed", "stores.group.changed", "stores.package.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.response.completed"], "ai.response.completed"> | WebhookEvent<PlatformEvents["ai.response.failed"], "ai.response.failed"> | WebhookEvent<PlatformEvents["file.deleted"], "file.deleted"> | WebhookEvent<PlatformEvents["file.moved"], "file.moved"> | WebhookEvent<PlatformEvents["file.uploaded"], "file.uploaded"> | WebhookEvent<PlatformEvents["purchases.catalog.applied"], "purchases.catalog.applied"> | WebhookEvent<PlatformEvents["purchases.catalog.changed"], "purchases.catalog.changed"> | 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.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["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.group.changed"], "stores.group.changed"> | WebhookEvent<PlatformEvents["stores.package.changed"], "stores.package.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["file.deleted"], "file.deleted"> | WebhookEvent<PlatformEvents["file.moved"], "file.moved"> | WebhookEvent<PlatformEvents["file.uploaded"], "file.uploaded"> | WebhookEvent<PlatformEvents["purchases.catalog.applied"], "purchases.catalog.applied"> | WebhookEvent<PlatformEvents["purchases.catalog.changed"], "purchases.catalog.changed"> | 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.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["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">;

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

@@ -26,6 +26,14 @@ export type Build = {
      * The machine may return to this build (POST /machines/{name}/rollback): it succeeded and its image is kept — a machine keeps the images of ten of its builds that succeeded, the one it runs among them.
      */
     returnable: boolean;
+    /**
+     * What became of the build's contract: captured; none (an app that says of none); refused — a palbase/backend build whose contract is refused takes no traffic, and fails saying why (contract_error). Absent while it is being read.
+     */
+    contract_state?: "captured" | "none" | "refused";
+    /**
+     * Why the build's contract was refused, in its app's words where it said.
+     */
+    contract_error?: string;
     created_at: string;
     started_at?: string;
     finished_at?: string;
@@ -47,6 +55,18 @@ export type BuildRef = {
     id: string;
     commit: string;
 };
+/**
+ * A machine's newest build, which failed or was skipped while the machine runs another: the push it was of did not roll out.
+ */
+export type FailedBuild = {
+    id: string;
+    commit: string;
+    state: "failed" | "skipped";
+    /**
+     * Why it did not roll out: its build failed, its tests failed, its contract was refused, it did not come up, its commit's checks did not pass.
+     */
+    reason: string;
+};
 /**
  * Where the project's owner goes to connect GitHub. GitHub asks who they are and comes back to the platform, which shows them the accounts Palbase Cloud is installed on that they can push to — and where to install it on another — and connects the one they choose once they write the project's ref.
  */
@@ -102,6 +122,20 @@ export type InstallationLink = {
     installation_id: number;
     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.
+ */
+export type InstallationShare = {
+    installation_id: number;
+    /**
+     * The project that connected it.
+     */
+    from_project: string;
+    /**
+     * The repositories (owner/name) the project reaches of it, and no other: each one the installation reaches and the GitHub user who connected it can push to (refused otherwise, `repository_not_shared`). Shared for them, the project never reaches a repository the installation reaches later. Left out: what that project reaches.
+     */
+    repositories?: string[];
+};
 /**
  * The project's installations.
  */
@@ -137,6 +171,10 @@ export type Machine = {
      * Why the machine has failed, or why a new version is not up — its image could not be pulled, it could not be started, its process keeps exiting or ran out of its memory, it does not answer 2xx at its health path (it is started again each time it has not in the 90 s it has), nothing answers on its port (past 90 s) — or that a version did not come up and the one before runs; absent otherwise.
      */
     state_reason?: string;
+    /**
+     * What kind of thing `state_reason` says: waiting — the version asked for waits before it takes traffic (on its commit's checks, its configuration, its tests, its contract, its database or its migration) and rolls out once that is done; not_up — it does not start or answer, or a copy of the one before it stays; given_up — it did not come up, and the one before it serves until the machine's next change; migration — its database migration failed (to start, and the version does not roll out; or to close); stopped — it was put to sleep for a reason; failed — it cannot run. Absent with no `state_reason`.
+     */
+    state_reason_kind?: "failed" | "given_up" | "migration" | "not_up" | "stopped" | "waiting";
     updated_at: string;
     /**
      * Where the machine answers: the project's own address for `backend`, <name>-<ref> under the app domain for any other.
@@ -158,6 +196,7 @@ export type Machine = {
     secrets?: "production" | "development";
     source: Source;
     build?: BuildRef;
+    failed_build?: FailedBuild;
     /**
      * A build of the branch's head is asked for — opened, pushed to, deployed, its source changed — and not queued yet: the platform asks GitHub for the head first. Once false, the machine's newest build is the one asked for, or, when the branch was not found, `state` and `state_reason` say so.
      */
@@ -199,6 +238,14 @@ export type Machine = {
      * The SHA-256 (hex) of the contract the build the machine serves from says it answers (GET /machines/{name}/openapi): a client generated from it is current while the two are the same. Absent while the contract has not been read, or when the app serves none.
      */
     contract_digest?: string;
+    /**
+     * What became of the contract of the build the machine serves from: captured; none (an app that says of none); refused (contract_error says why: the events, webhooks and crons of a palbase/backend app are registered from its contract, and none were). Absent while it is being read.
+     */
+    contract_state?: "captured" | "none" | "refused";
+    /**
+     * Why the contract of the build the machine serves from was refused, in its app's words where it said.
+     */
+    contract_error?: string;
 };
 /**
  * A machine to open.
@@ -1356,12 +1403,21 @@ export declare function client(t: Transport): {
     /**
      * Connect an installation
      *
-     * Connects an installation of Palbase Cloud the user reaches, with the user's own GitHub token for the App (a CLI's device flow): the project reaches the repositories of it that user can push to — connected again, what they can push to now. Refused when GitHub says the user cannot reach it, or push to any repository of it. The user taking their authorization of the App back on GitHub disconnects what they connected.
+     * Connects an installation of Palbase Cloud the user reaches, with the user's own GitHub token for the App (a CLI's device flow): the project reaches the repositories of it that user can push to — connected again by that user, what they can push to now. Refused when GitHub says the user cannot reach it, or push to any repository of it; and when the project connected it otherwise — by another GitHub user, or for some repositories alone (a share): linking again never widens, narrows or hands over a connection, so it is disconnected and connected anew. The user taking their authorization of the App back on GitHub disconnects what they connected.
      */
     linkInstallation(input: {
         body: InstallationLink; /** Stops the call: the request in flight, a wait before a retry, a proof-of-work being solved. */
         signal?: AbortSignal;
     }): Promise<Reply<201, Installation>>;
+    /**
+     * 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.
+     */
+    shareInstallation(input: {
+        body: InstallationShare; /** Stops the call: the request in flight, a wait before a retry, a proof-of-work being solved. */
+        signal?: AbortSignal;
+    }): Promise<Reply<201, Installation>>;
     /**
      * Disconnect an installation
      *

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

@@ -1047,7 +1047,7 @@ export declare function client(t: Transport): {
     /**
      * Override an email template
      *
-     * Overrides the template in this locale. It is Handlebars ({{name}}, {{#if}} {{#unless}} {{#each}} {{#with}}, lookup, equal): {{name}} in an HTML body is escaped, {{{name}}} is not; a subject, a text body and an SMS are text; an override of a platform template uses only the variables its sender passes. On the platform's shared sender, auth's templates (auth.*) go out in Palbase's words; the project's edits of them are used with its own email provider.
+     * Overrides the template in this locale. It is Handlebars ({{name}}, {{#if}} {{#unless}} {{#each}} {{#with}}, lookup, equal): {{name}} in an HTML body is escaped, {{{name}}} is not; a subject, a text body and an SMS are text; an override of a platform template uses only the variables its sender passes. On the platform's shared sender, auth's templates (auth.*) go out in Palbase's words; the project's edits of them are used with its own email provider. An environment's token is refused (403 token_out_of_scope) at a template that carries a user's own sign-in or reset credential, a link or a one-time code (the list is catalog.CarriesCredential): closed per slug in the handler, not by an x-palbase-credential mark, which would close the app's own notification templates too. Those stay open.
      */
     putEmailTemplate(input: {
         path: {
@@ -1063,7 +1063,7 @@ export declare function client(t: Transport): {
     /**
      * Remove an override
      *
-     * Removes the project's override; the platform's default renders again.
+     * Removes the project's override; the platform's default renders again. An environment's token is refused (403 token_out_of_scope) at a template that carries a user's own sign-in or reset credential, a link or a one-time code (the list is catalog.CarriesCredential): closed per slug in the handler, not by an x-palbase-credential mark, which would close the app's own notification templates too. Those stay open.
      */
     deleteEmailTemplate(input: {
         path: {
@@ -1098,7 +1098,7 @@ export declare function client(t: Transport): {
     /**
      * Override an SMS template
      *
-     * Overrides the SMS template in this locale. It is Handlebars ({{name}}, {{#if}} {{#unless}} {{#each}} {{#with}}, lookup, equal): {{name}} in an HTML body is escaped, {{{name}}} is not; a subject, a text body and an SMS are text; an override of a platform template uses only the variables its sender passes.
+     * Overrides the SMS template in this locale. It is Handlebars ({{name}}, {{#if}} {{#unless}} {{#each}} {{#with}}, lookup, equal): {{name}} in an HTML body is escaped, {{{name}}} is not; a subject, a text body and an SMS are text; an override of a platform template uses only the variables its sender passes. An environment's token is refused (403 token_out_of_scope) at a template that carries a user's own sign-in or reset credential, a link or a one-time code (the list is catalog.CarriesCredential): closed per slug in the handler, not by an x-palbase-credential mark, which would close the app's own notification templates too. Those stay open.
      */
     putSmsTemplate(input: {
         path: {
@@ -1114,7 +1114,7 @@ export declare function client(t: Transport): {
     /**
      * Remove an SMS override
      *
-     * Removes the project's override; the platform's default renders again.
+     * Removes the project's override; the platform's default renders again. An environment's token is refused (403 token_out_of_scope) at a template that carries a user's own sign-in or reset credential, a link or a one-time code (the list is catalog.CarriesCredential): closed per slug in the handler, not by an x-palbase-credential mark, which would close the app's own notification templates too. Those stay open.
      */
     deleteSmsTemplate(input: {
         path: {
@@ -1149,7 +1149,7 @@ export declare function client(t: Transport): {
     /**
      * Map a slug to a WhatsApp template
      *
-     * Maps the slug in this locale to a template approved on the project's Meta account.
+     * Maps the slug in this locale to a template approved on the project's Meta account. An environment's token is refused (403 token_out_of_scope) at a template that carries a user's own sign-in or reset credential, a link or a one-time code (the list is catalog.CarriesCredential): closed per slug in the handler, not by an x-palbase-credential mark, which would close the app's own notification templates too. Those stay open.
      */
     putWhatsAppTemplate(input: {
         path: {
@@ -1165,7 +1165,7 @@ export declare function client(t: Transport): {
     /**
      * Remove a WhatsApp template mapping
      *
-     * Removes the mapping.
+     * Removes the mapping. An environment's token is refused (403 token_out_of_scope) at a template that carries a user's own sign-in or reset credential, a link or a one-time code (the list is catalog.CarriesCredential): closed per slug in the handler, not by an x-palbase-credential mark, which would close the app's own notification templates too. Those stay open.
      */
     deleteWhatsAppTemplate(input: {
         path: {