busa-sdk 0.17.2 → 0.18.0

package/dist/airapp-node.d.ts

@@ -1,66 +1,111 @@
-import { BusabaseAirAppCredentialStoreOptions } from './oauth-node.js';
-import './oauth.js';
-
+import { t as BusabaseAirAppCredentialStoreOptions } from "./oauth-node-DGiWkh_l.js";
+//#region src/airapp-node.d.ts
+/**
+ * The env var Busabase injects into every AirApp process it spawns. Nobody else
+ * sets it, which is what makes its **absence** the positive fact "standalone".
+ */
+declare const BUSABASE_AIRAPP_RUNTIME_ENV = "BUSABASE_AIRAPP_RUNTIME";
+/**
+ * Every runtime Busabase hosts an AirApp in, as known to *this* SDK version.
+ *
+ * **Informational. Not what decides whether an app is hosted.** That separation
+ * is the whole point of this constant existing here rather than being pasted
+ * into each app, and getting it backwards is a bug we have already shipped once:
+ * every generated AirApp used to carry its own hardcoded copy of this list and
+ * answer `hosted` from membership in it. When the `local-node` engine was
+ * renamed to `local`, all of them started answering "standalone" *inside a
+ * hosted preview* — showing their own connection gate, calling `/api/v1` with no
+ * credential, and leaving the operator with nothing to act on.
+ *
+ * Moving the list into the SDK does not by itself fix that. An app pins an SDK
+ * version, so a list that gates behaviour would simply rot on a slower clock:
+ * add an engine, and every app on an older SDK is wrong again until it upgrades.
+ *
+ * So the list names runtimes; {@link isBusabaseAirAppHosted} decides hosting,
+ * from presence alone, and needs no upgrade to stay correct.
+ */
+declare const BUSABASE_AIRAPP_RUNTIMES: readonly ["nodepod", "local", "srt", "sandock", "embed"];
+type BusabaseAirAppRuntime = (typeof BUSABASE_AIRAPP_RUNTIMES)[number];
+/** Read the injected runtime, normalised. `""` means nobody hosted this process. */
+declare const readBusabaseAirAppRuntime: (env?: Record<string, string | undefined>) => string;
+/**
+ * Whether Busabase is hosting this process.
+ *
+ * Presence, never membership — see {@link BUSABASE_AIRAPP_RUNTIMES}. An engine
+ * this SDK has never heard of still means "Busabase spawned me", because only
+ * Busabase sets the variable at all.
+ */
+declare const isBusabaseAirAppHosted: (runtime?: string) => boolean;
+/**
+ * Narrow a runtime string to one this SDK knows, or `null`.
+ *
+ * For code that wants to *branch* on a specific engine — an app that renders
+ * differently under a public embed, say. Deliberately returns `null` rather than
+ * throwing on an unknown value: a newer Busabase naming an engine this SDK
+ * predates is normal, not an error, and the caller should fall back to generic
+ * behaviour rather than break.
+ */
+declare const asKnownBusabaseAirAppRuntime: (runtime: string) => BusabaseAirAppRuntime | null;
 declare const BUSABASE_AIRAPP_GATEWAY_REASONS: {
-    readonly authRequired: "AUTH_REQUIRED";
-    readonly authUnavailable: "AUTH_UNAVAILABLE";
-    readonly connectionRequired: "CONNECTION_REQUIRED";
-    readonly oauthCallbackInvalid: "OAUTH_CALLBACK_INVALID";
-    readonly spaceNotAllowed: "SPACE_NOT_ALLOWED";
-    readonly spaceSelectionRequired: "SPACE_SELECTION_REQUIRED";
+  readonly authRequired: "AUTH_REQUIRED";
+  readonly authUnavailable: "AUTH_UNAVAILABLE";
+  readonly connectionRequired: "CONNECTION_REQUIRED";
+  readonly oauthCallbackInvalid: "OAUTH_CALLBACK_INVALID";
+  readonly spaceNotAllowed: "SPACE_NOT_ALLOWED";
+  readonly spaceSelectionRequired: "SPACE_SELECTION_REQUIRED";
 };
 type GatewayReason = (typeof BUSABASE_AIRAPP_GATEWAY_REASONS)[keyof typeof BUSABASE_AIRAPP_GATEWAY_REASONS];
 interface AuthSpace {
-    id: string;
-    name: string;
-    slug?: string | null;
-    plan?: string | null;
+  id: string;
+  name: string;
+  slug?: string | null;
+  plan?: string | null;
 }
 interface GatewayTarget {
-    baseUrl: string;
-    accessToken: string;
-    selectedSpace?: AuthSpace;
-    source: "airapp-oauth-local" | "environment" | "open-server";
+  baseUrl: string;
+  accessToken: string;
+  selectedSpace?: AuthSpace;
+  source: "airapp-oauth-local" | "environment" | "open-server";
 }
 interface BusabaseAirAppLocalGatewayOptions {
-    appId: string;
-    cloudBaseUrl?: string;
-    clientId?: string;
-    environment?: Record<string, string | undefined>;
-    fetch?: typeof fetch;
-    now?: () => number;
-    oauthPendingTtlMs?: number;
-    requestTimeoutMs?: number;
-    credentialStore?: BusabaseAirAppCredentialStoreOptions;
-    successPath?: string;
-    errorPath?: string;
+  appId: string;
+  cloudBaseUrl?: string;
+  clientId?: string;
+  environment?: Record<string, string | undefined>;
+  fetch?: typeof fetch;
+  now?: () => number;
+  oauthPendingTtlMs?: number;
+  requestTimeoutMs?: number;
+  credentialStore?: BusabaseAirAppCredentialStoreOptions;
+  successPath?: string;
+  errorPath?: string;
 }
 interface BusabaseAirAppAuthStatus {
-    connected: boolean;
-    cloudBaseUrl: string;
-    baseUrl?: string;
-    source?: GatewayTarget["source"];
-    readiness: "needs_connection" | "needs_auth" | "needs_space" | "ready" | "retry";
-    action: "connect" | "reconnect" | "select_space" | "continue" | "retry";
-    requiresSpace?: boolean;
-    selectedSpace?: AuthSpace | null;
-    space?: AuthSpace | null;
-    spaces?: AuthSpace[];
-    reason?: GatewayReason;
-    message?: string;
+  connected: boolean;
+  cloudBaseUrl: string;
+  baseUrl?: string;
+  source?: GatewayTarget["source"];
+  readiness: "needs_connection" | "needs_auth" | "needs_space" | "ready" | "retry";
+  action: "connect" | "reconnect" | "select_space" | "continue" | "retry";
+  requiresSpace?: boolean;
+  selectedSpace?: AuthSpace | null;
+  space?: AuthSpace | null;
+  spaces?: AuthSpace[];
+  reason?: GatewayReason;
+  message?: string;
 }
 declare class BusabaseAirAppLocalGateway {
-    #private;
-    constructor(options: BusabaseAirAppLocalGatewayOptions);
-    get cloudBaseUrl(): string;
-    status(): Promise<BusabaseAirAppAuthStatus>;
-    statusResponse: () => Promise<Response>;
-    start: (request: Request) => Promise<Response>;
-    callback: (request: Request) => Promise<Response>;
-    selectSpace: (request: Request) => Promise<Response>;
-    logout: (request: Request) => Promise<Response>;
-    proxy: (request: Request) => Promise<Response>;
+  #private;
+  constructor(options: BusabaseAirAppLocalGatewayOptions);
+  get cloudBaseUrl(): string;
+  status(): Promise<BusabaseAirAppAuthStatus>;
+  statusResponse: () => Promise<Response>;
+  start: (request: Request) => Promise<Response>;
+  callback: (request: Request) => Promise<Response>;
+  selectSpace: (request: Request) => Promise<Response>;
+  logout: (request: Request) => Promise<Response>;
+  proxy: (request: Request) => Promise<Response>;
 }
 declare const createBusabaseAirAppLocalGateway: (options: BusabaseAirAppLocalGatewayOptions) => BusabaseAirAppLocalGateway;
-
-export { BUSABASE_AIRAPP_GATEWAY_REASONS, type BusabaseAirAppAuthStatus, BusabaseAirAppLocalGateway, type BusabaseAirAppLocalGatewayOptions, createBusabaseAirAppLocalGateway };
+//#endregion
+export { BUSABASE_AIRAPP_GATEWAY_REASONS, BUSABASE_AIRAPP_RUNTIMES, BUSABASE_AIRAPP_RUNTIME_ENV, BusabaseAirAppAuthStatus, BusabaseAirAppLocalGateway, BusabaseAirAppLocalGatewayOptions, BusabaseAirAppRuntime, asKnownBusabaseAirAppRuntime, createBusabaseAirAppLocalGateway, isBusabaseAirAppHosted, readBusabaseAirAppRuntime };