@astralbeam/sdk 0.6.0 → 0.9.0

package/dist/react.d.ts

@@ -1,6 +1,6 @@
-import { C as AstralBeamChatState, S as AstralBeamChatCoreOptions, x as AstralBeamChatCore } from "./index-TbZxlv54.js";
+import { C as AstralBeamChatState, S as AstralBeamChatCoreOptions, x as AstralBeamChatCore } from "./index-BQBdZKyB.js";
 import { ReactNode } from "react";
-import { AstralBeamChatAttachmentOptions, AstralBeamChatAuthTokenRequest, AstralBeamChatAuthTokenSource, AstralBeamChatColorScheme, AstralBeamChatTheme, InferParameters, JsonSchemaObject, ParametersSchema, ToolDefinition, WidgetDefinition as WidgetDefinition$1, defineTool } from "@astralbeam/sdk/client";
+import { AstralBeamChatAttachmentOptions, AstralBeamChatColorScheme, AstralBeamChatTheme, AstralBeamTokenRequest, AstralBeamTokenSource, InferParameters, JsonSchemaObject, MountAstralBeamChatOptions, ParametersSchema, ToolDefinition, WidgetDefinition as WidgetDefinition$1, defineTool } from "@astralbeam/sdk/client";
 
 //#region src/react/index.d.ts
 interface WidgetDefinition extends Omit<WidgetDefinition$1, "render"> {
@@ -38,60 +38,21 @@ interface AstralBeamChatRef {
   /** Stops the in-flight generation, if any; the transcript keeps what already streamed. */
   stop: () => void;
 }
-interface AstralBeamChatProps {
-  /**
-   * Public ID of the organization-owned agent. Omit it to use the organization's default agent,
-   * which the dashboard's agents page selects. A change answers the next run with the new agent
-   * and keeps the transcript, which that agent then sees as history.
-   */
-  agentId?: string;
-  /** Name shown in the widget's header. Default `"AstralBeam"`. */
-  title?: string;
-  /**
-   * Shows the widget's header with the title and the reset button; `false` hides both and gives
-   * the transcript the full height. Default `true`.
-   */
-  showHeader?: boolean;
+/**
+ * Every mount option as a prop, with the DOM-rendering fields replaced by React ones: a widget
+ * renders JSX, and the chrome slots take nodes instead of renderers. The shared options are
+ * documented once, on `MountAstralBeamChatOptions`.
+ */
+interface AstralBeamChatProps extends Omit<MountAstralBeamChatOptions, "widgets" | "slots"> {
+  /** Host-defined widgets the agent can render inline in the conversation, keyed by identifier. */
+  widgets?: Record<string, WidgetDefinition> | undefined;
   /** Replaces the header's content with the host's own React content; `showHeader` still applies. */
   header?: ReactNode;
   /** Replaces the empty-transcript state with the host's own React content. */
   empty?: ReactNode;
   /** Extra host controls at the end of the composer's button row, next to send. */
   composerActions?: ReactNode;
-  /** Headline shown on the empty transcript. Default `"Ask the assistant"`. */
-  emptyTitle?: string;
-  /** Subtitle under the empty transcript's headline. */
-  emptyDescription?: string;
-  /**
-   * Base URL of the AstralBeam API; the widget calls `/chat` under it. Read per request, so a
-   * change moves the next one. Default the hosted cloud.
-   */
-  apiUrl?: string;
-  /**
-   * Where the short-lived chat JWT comes from: `{ url, ...RequestInit }` for a token endpoint, or
-   * a function minting `{ token }`, optionally a promise, in the host app. Read per token, and
-   * the function form runs in the host's React tree, so an inline closure over current auth state
-   * is fine and needs no memoization. Default `{ url: "/api/astralbeam/token" }`.
-   */
-  fetchChatAuthToken?: AstralBeamChatAuthTokenSource;
-  /** Host-defined tools the agent can call, executed in the host's React app, keyed by name. */
-  tools?: Record<string, ToolDefinition>;
-  /** Host-defined widgets the agent can render inline in the conversation, keyed by identifier. */
-  widgets?: Record<string, WidgetDefinition>;
-  /** Color scheme of the chat widget. Default `"system"`. */
-  colorScheme?: AstralBeamChatColorScheme;
-  /** Custom values for the widget's theming CSS variables, per color scheme. */
-  theme?: AstralBeamChatTheme | undefined;
-  /** File attachments in the composer, on by default; `false` turns them off. */
-  attachments?: boolean | AstralBeamChatAttachmentOptions;
-  /** Shows the collected sandbox panel (files with downloads, command log) above the composer. Default `false`. */
-  sandboxPanel?: boolean;
-  /**
-   * Logs every SDK action to the browser console with UTC timestamps and full payloads,
-   * and asks the endpoint to log its side of the run too.
-   */
-  debug?: boolean;
 }
 declare const AstralBeamChat: import("react").ForwardRefExoticComponent<AstralBeamChatProps & import("react").RefAttributes<AstralBeamChatRef>>;
 //#endregion
-export { AstralBeamChat, type AstralBeamChatAttachmentOptions, type AstralBeamChatAuthTokenRequest, type AstralBeamChatAuthTokenSource, type AstralBeamChatColorScheme, type AstralBeamChatCore, type AstralBeamChatCoreOptions, AstralBeamChatProps, AstralBeamChatRef, type AstralBeamChatState, type AstralBeamChatTheme, type InferParameters, type ParametersSchema, type ToolDefinition, TypedReactWidgetDefinition, UseAstralBeamChatResult, WidgetDefinition, defineTool, defineWidget, useAstralBeamChat };
+export { AstralBeamChat, type AstralBeamChatAttachmentOptions, type AstralBeamChatColorScheme, type AstralBeamChatCore, type AstralBeamChatCoreOptions, AstralBeamChatProps, AstralBeamChatRef, type AstralBeamChatState, type AstralBeamChatTheme, type AstralBeamTokenRequest, type AstralBeamTokenSource, type InferParameters, type ParametersSchema, type ToolDefinition, TypedReactWidgetDefinition, UseAstralBeamChatResult, WidgetDefinition, defineTool, defineWidget, useAstralBeamChat };

package/dist/react.js

@@ -1,4 +1,4 @@
-import { C as DEFAULT_COLOR_SCHEME, r as createAstralBeamChat } from "./core-DYXxodYg.js";
+import { C as DEFAULT_COLOR_SCHEME, n as CORE_OPTION_KEYS, r as createAstralBeamChat } from "./core-Eh2vyhUP.js";
 import { forwardRef, useEffect, useImperativeHandle, useMemo, useRef, useState, useSyncExternalStore } from "react";
 import { createPortal } from "react-dom";
 import { defineTool, mountAstralBeamChat } from "@astralbeam/sdk/client";
@@ -15,19 +15,12 @@ function defineWidget(widget) {
 * state stay live and nothing needs a remount.
 */
 function useAstralBeamChat(options) {
-	const [core] = useState(() => createAstralBeamChat(options));
+	const coreRef = useRef(null);
+	coreRef.current ??= createAstralBeamChat(options);
+	const core = coreRef.current;
 	useEffect(() => {
 		core.updateOptions(options);
-	}, [
-		core,
-		options.agentId,
-		options.apiUrl,
-		options.fetchChatAuthToken,
-		options.tools,
-		options.widgets,
-		options.onRenderWidget,
-		options.debug
-	]);
+	}, [core, ...CORE_OPTION_KEYS.map((key) => options[key])]);
 	useEffect(() => () => core.dispose(), [core]);
 	return {
 		...useSyncExternalStore(core.subscribe, core.getState, core.getState),
@@ -39,7 +32,7 @@ function useAstralBeamChat(options) {
 		core
 	};
 }
-const AstralBeamChat = forwardRef(function AstralBeamChat({ agentId, title, showHeader, header, empty, composerActions, emptyTitle, emptyDescription, apiUrl, fetchChatAuthToken, tools, widgets = {}, colorScheme = DEFAULT_COLOR_SCHEME, theme, attachments, sandboxPanel, debug }, ref) {
+const AstralBeamChat = forwardRef(function AstralBeamChat({ agentId, title, showHeader, header, empty, composerActions, emptyTitle, emptyDescription, apiUrl, fetchAstralBeamToken, tools, widgets = {}, colorScheme = DEFAULT_COLOR_SCHEME, theme, attachments, sandboxPanel, debug }, ref) {
 	const targetRef = useRef(null);
 	const handleRef = useRef(null);
 	const [activeRenders, setActiveRenders] = useState(/* @__PURE__ */ new Map());
@@ -106,7 +99,7 @@ const AstralBeamChat = forwardRef(function AstralBeamChat({ agentId, title, show
 	const live = useMemo(() => ({
 		agentId,
 		apiUrl,
-		fetchChatAuthToken,
+		fetchAstralBeamToken,
 		title,
 		showHeader,
 		emptyTitle,
@@ -122,7 +115,7 @@ const AstralBeamChat = forwardRef(function AstralBeamChat({ agentId, title, show
 	}), [
 		agentId,
 		apiUrl,
-		fetchChatAuthToken,
+		fetchAstralBeamToken,
 		title,
 		showHeader,
 		emptyTitle,

package/dist/server.d.ts

@@ -1,38 +1,42 @@
-import * as Schema from "effect/Schema";
-
 //#region src/server/index.d.ts
 declare const CHAT_AUTH_TOKEN_AUDIENCE = "astralbeam";
 declare const CHAT_AUTH_TOKEN_TYPE = "astralbeam+jwt";
 declare const CHAT_AUTH_TOKEN_VERSION = 4;
 declare const CHAT_AUTH_TOKEN_LIFETIME_SECONDS = 300;
 declare const CHAT_AUTH_TOKEN_MAX_LIFETIME_SECONDS = 600;
-declare const TenantSchema: Schema.Struct<{
-  readonly id: Schema.String;
-  readonly name: Schema.optional<Schema.String>;
-  readonly metadata: Schema.optional<Schema.$Record<Schema.String, Schema.Codec<Schema.Json, Schema.Json, never, never>>>;
-}>;
-declare const TenantUserSchema: Schema.Struct<{
-  readonly id: Schema.String;
-  readonly name: Schema.optional<Schema.String>;
-  readonly admin: Schema.optional<Schema.Boolean>;
-  readonly metadata: Schema.optional<Schema.$Record<Schema.String, Schema.Codec<Schema.Json, Schema.Json, never, never>>>;
-}>;
+/** A JSON value, which is all a `metadata` object may hold: the token carries it verbatim. */
+type JsonValue = string | number | boolean | null | readonly JsonValue[] | {
+  readonly [key: string]: JsonValue;
+};
+/** A `metadata` object: caller-owned keys, preserved verbatim in the token's claims. */
+type JsonMetadata = {
+  readonly [key: string]: JsonValue;
+};
 /** Tenant identity from the Organization's application, including JSON metadata. */
-type Tenant = typeof TenantSchema.Type;
+interface Tenant {
+  readonly id: string;
+  readonly name?: string | undefined;
+  readonly metadata?: JsonMetadata | undefined;
+}
 /** User of an Organization's Tenant who interacts with AstralBeam. */
-type TenantUser = typeof TenantUserSchema.Type;
-interface CreateChatAuthTokenOptions<TTenantUser extends TenantUser = TenantUser, TTenant extends Tenant = Tenant> {
+interface TenantUser {
+  readonly id: string;
+  readonly name?: string | undefined;
+  readonly admin?: boolean | undefined;
+  readonly metadata?: JsonMetadata | undefined;
+}
+interface CreateAstralBeamTokenOptions<TTenantUser extends TenantUser = TenantUser, TTenant extends Tenant = Tenant> {
   readonly apiKey: string;
   readonly user: TTenantUser;
   readonly tenant: TTenant;
   readonly expiresInSeconds?: number | undefined;
 }
 /** Creates the short-lived bearer token returned by an application's server auth endpoint. */
-declare function createChatAuthToken<TTenantUser extends TenantUser = TenantUser, TTenant extends Tenant = Tenant>({
+declare function createAstralBeamToken<TTenantUser extends TenantUser = TenantUser, TTenant extends Tenant = Tenant>({
   apiKey,
   user,
   tenant,
   expiresInSeconds
-}: CreateChatAuthTokenOptions<TTenantUser, TTenant>): Promise<string>;
+}: CreateAstralBeamTokenOptions<TTenantUser, TTenant>): Promise<string>;
 //#endregion
-export { CHAT_AUTH_TOKEN_AUDIENCE, CHAT_AUTH_TOKEN_LIFETIME_SECONDS, CHAT_AUTH_TOKEN_MAX_LIFETIME_SECONDS, CHAT_AUTH_TOKEN_TYPE, CHAT_AUTH_TOKEN_VERSION, CreateChatAuthTokenOptions, Tenant, TenantSchema, TenantUser, TenantUserSchema, createChatAuthToken };
+export { CHAT_AUTH_TOKEN_AUDIENCE, CHAT_AUTH_TOKEN_LIFETIME_SECONDS, CHAT_AUTH_TOKEN_MAX_LIFETIME_SECONDS, CHAT_AUTH_TOKEN_TYPE, CHAT_AUTH_TOKEN_VERSION, CreateAstralBeamTokenOptions, JsonMetadata, JsonValue, Tenant, TenantUser, createAstralBeamToken };

package/dist/server.js

@@ -1,4 +1,3 @@
-import * as Schema from "effect/Schema";
 //#region node_modules/.deno/jose@6.2.9/node_modules/jose/dist/webapi/lib/buffer_utils.js
 const encoder = new TextEncoder();
 const decoder = new TextDecoder();
@@ -645,43 +644,22 @@ const CHAT_AUTH_TOKEN_LIFETIME_SECONDS = 300;
 const CHAT_AUTH_TOKEN_MAX_LIFETIME_SECONDS = 600;
 const CHAT_AUTH_TOKEN_MAX_BYTES = 16384;
 const IDENTITY_MAX_BYTES = 8192;
+const EXTERNAL_ID_MAX_LENGTH = 255;
+const API_KEY_PATTERN = /^key_[0-9a-z-]{1,63}_[0-9a-z-]{1,63}_abo_[A-Za-z]{64}$/;
+const TENANT_FIELDS = [
+	"id",
+	"name",
+	"metadata"
+];
+const TENANT_USER_FIELDS = [
+	"id",
+	"name",
+	"admin",
+	"metadata"
+];
 const textEncoder = new TextEncoder();
-const SlugSchema = Schema.String.pipe(Schema.check(Schema.isPattern(/^[0-9a-z-]{1,63}$/)));
-const ApiKeySecretSchema = Schema.String.pipe(Schema.check(Schema.isPattern(/^abo_[A-Za-z]{64}$/)));
-const ApiKeySchema = Schema.TemplateLiteral([
-	"key_",
-	SlugSchema,
-	"_",
-	SlugSchema,
-	"_",
-	ApiKeySecretSchema
-]);
-const isApiKey = Schema.is(ApiKeySchema);
-const MetadataSchema = Schema.JsonObject.annotate({ message: "metadata must be a JSON object" });
-const TenantExternalIdSchema = Schema.String.pipe(Schema.check(Schema.makeFilter((value) => value.length >= 1 && value.length <= 255, { message: "tenant.id must be a 1-255 character string" })));
-const TenantUserExternalIdSchema = Schema.String.pipe(Schema.check(Schema.makeFilter((value) => value.length >= 1 && value.length <= 255, { message: "user.id must be a 1-255 character string" })));
-const TenantSchema = Schema.Struct({
-	id: TenantExternalIdSchema,
-	name: Schema.optional(Schema.String),
-	metadata: Schema.optional(MetadataSchema)
-});
-const TenantUserSchema = Schema.Struct({
-	id: TenantUserExternalIdSchema,
-	name: Schema.optional(Schema.String),
-	admin: Schema.optional(Schema.Boolean),
-	metadata: Schema.optional(MetadataSchema)
-});
-const IdentitySchema = Schema.Struct({
-	user: TenantUserSchema,
-	tenant: TenantSchema
-}).pipe(Schema.check(Schema.makeFilter((value) => textEncoder.encode(JSON.stringify(value)).byteLength <= IDENTITY_MAX_BYTES, { message: `user and tenant must not exceed ${IDENTITY_MAX_BYTES} bytes` })));
-const decodeIdentity = Schema.decodeUnknownSync(IdentitySchema, {
-	errors: "all",
-	onExcessProperty: "error",
-	reportInput: false
-});
 function parseApiKey(apiKey) {
-	if (!isApiKey(apiKey)) throw new Error("apiKey must match key_<organization>_<key>_abo_<secret>");
+	if (!API_KEY_PATTERN.test(apiKey)) throw new Error("apiKey must match key_<organization>_<key>_abo_<secret>");
 	const separator = apiKey.lastIndexOf("_abo_");
 	const keyId = apiKey.slice(0, separator);
 	const keySecret = apiKey.slice(separator + 1);
@@ -691,18 +669,43 @@ function parseApiKey(apiKey) {
 		keySecret
 	};
 }
+function isPlainObject(value) {
+	if (typeof value !== "object" || value === null) return false;
+	const prototype = Object.getPrototypeOf(value);
+	return prototype === Object.prototype || prototype === null;
+}
+function isJsonValue(value) {
+	if (value === null || typeof value === "string" || typeof value === "boolean") return true;
+	if (typeof value === "number") return Number.isFinite(value);
+	if (Array.isArray(value)) return value.every(isJsonValue);
+	return isPlainObject(value) && Object.values(value).every(isJsonValue);
+}
+function validateIdentity(label, value, isUser) {
+	if (!isPlainObject(value)) throw new Error(`${label} must be an object`);
+	const fields = isUser ? TENANT_USER_FIELDS : TENANT_FIELDS;
+	for (const key of Object.keys(value)) if (!fields.includes(key)) throw new Error(`${label} has an unknown field "${key}"`);
+	const { id, name, admin, metadata } = value;
+	if (typeof id !== "string" || id.length < 1 || id.length > EXTERNAL_ID_MAX_LENGTH) throw new Error(`${label}.id must be a 1-${EXTERNAL_ID_MAX_LENGTH} character string`);
+	if (name !== void 0 && typeof name !== "string") throw new Error(`${label}.name must be a string`);
+	if (isUser && admin !== void 0 && typeof admin !== "boolean") throw new Error(`${label}.admin must be a boolean`);
+	if (metadata !== void 0 && !(isPlainObject(metadata) && isJsonValue(metadata))) throw new Error(`${label}.metadata must be a JSON object`);
+}
 function validatedIdentity(user, tenant) {
-	return JSON.parse(JSON.stringify(decodeIdentity({
+	validateIdentity("user", user, true);
+	validateIdentity("tenant", tenant, false);
+	const json = JSON.stringify({
 		user,
 		tenant
-	})));
+	});
+	if (textEncoder.encode(json).byteLength > IDENTITY_MAX_BYTES) throw new Error(`user and tenant must not exceed ${IDENTITY_MAX_BYTES} bytes`);
+	return JSON.parse(json);
 }
 async function signingKey(secret) {
 	const digest = await crypto.subtle.digest("SHA-256", textEncoder.encode(secret));
 	return textEncoder.encode(encode(new Uint8Array(digest)));
 }
 /** Creates the short-lived bearer token returned by an application's server auth endpoint. */
-async function createChatAuthToken({ apiKey, user, tenant, expiresInSeconds = 300 }) {
+async function createAstralBeamToken({ apiKey, user, tenant, expiresInSeconds = 300 }) {
 	if (!Number.isInteger(expiresInSeconds) || expiresInSeconds < 60 || expiresInSeconds > 600) throw new Error("chat auth tokens must live for 60-600 seconds");
 	const { keyId, organizationSlug, keySecret } = parseApiKey(apiKey);
 	const identity = validatedIdentity(user, tenant);
@@ -720,4 +723,4 @@ async function createChatAuthToken({ apiKey, user, tenant, expiresInSeconds = 30
 	return token;
 }
 //#endregion
-export { CHAT_AUTH_TOKEN_AUDIENCE, CHAT_AUTH_TOKEN_LIFETIME_SECONDS, CHAT_AUTH_TOKEN_MAX_LIFETIME_SECONDS, CHAT_AUTH_TOKEN_TYPE, CHAT_AUTH_TOKEN_VERSION, TenantSchema, TenantUserSchema, createChatAuthToken };
+export { CHAT_AUTH_TOKEN_AUDIENCE, CHAT_AUTH_TOKEN_LIFETIME_SECONDS, CHAT_AUTH_TOKEN_MAX_LIFETIME_SECONDS, CHAT_AUTH_TOKEN_TYPE, CHAT_AUTH_TOKEN_VERSION, createAstralBeamToken };