@theaiplatform/miniapp-sdk 0.3.2 → 0.4.0

package/dist/ui.js.LICENSE.txt

@@ -0,0 +1,12 @@
+/*! Bundled license information:
+
+prismjs/prism.js:
+  (**
+   * Prism: Lightweight, robust, elegant syntax highlighting
+   *
+   * @license MIT <https://opensource.org/licenses/MIT>
+   * @author Lea Verou <https://lea.verou.me>
+   * @namespace
+   * @public
+   *)
+*/

package/dist/vscode-webview.d.ts

@@ -0,0 +1,147 @@
+/** JSON-compatible values accepted by public miniapp operations. */
+declare type MiniAppJsonValue = null | boolean | number | string | MiniAppJsonValue[] | {
+    [key: string]: MiniAppJsonValue;
+};
+
+/**
+ * Mount a converted VS Code webview while retaining all TAP authority in the
+ * outer federated surface. The imported page receives only the explicitly
+ * configured compatibility operations.
+ */
+export declare function mountVsCodeWebview(container: HTMLElement, context: TapFederatedSurfaceMountContext, options: TapVsCodeWebviewBridgeOptions): TapVsCodeWebviewMount;
+
+/**
+ * Host-owned entropy for release-scoped identifiers.
+ *
+ * Ordinary TAP surfaces use the browser's cryptographically strong UUID
+ * source. Test Lab mounts derive a deterministic stream from the selected
+ * profile seed and exact frame identity, then reset it before each mount so
+ * app-owned state is reproducible without weakening production identifiers,
+ * colliding across retained remounts, or relying on ambient test globals.
+ */
+declare interface TapFederatedSurfaceEntropy {
+    randomUUID(): string;
+}
+
+/**
+ * Read-only authority projected by TAP for the exact package release/frame.
+ * A candidate frame starts without authority and may only perform host-backed
+ * work after the host confirms that release. Subscribers are notified only
+ * when the boolean snapshot changes.
+ */
+declare interface TapFederatedSurfaceHostAuthority {
+    getSnapshot(): boolean;
+    subscribe(listener: () => void): () => void;
+}
+
+/** Cleanup handle returned by a federated surface mount. */
+declare interface TapFederatedSurfaceMount {
+    unmount(): void | Promise<void>;
+}
+
+/** Context supplied by TAP's isolated webview surface runtime. */
+declare interface TapFederatedSurfaceMountContext {
+    readonly packageId: string;
+    readonly packageNamespace: string;
+    readonly releaseId: string;
+    readonly installationId: string;
+    readonly contributionId: string;
+    readonly instanceId: string;
+    readonly hostOrigin: string;
+    readonly packageAssetBaseUrl: string;
+    readonly workspaceId?: string;
+    readonly channelId?: string;
+    readonly conversationId?: string;
+    readonly events: TapPackageEventPublisher;
+    readonly entropy: TapFederatedSurfaceEntropy;
+    readonly hostAuthority: TapFederatedSurfaceHostAuthority;
+}
+
+/**
+ * @capability miniapp-platform
+ */
+/** Declared package-event channel supplied to an isolated UI contribution. */
+declare interface TapPackageEventPublisher {
+    publish(name: string, payload: Readonly<Record<string, unknown>>): void | Promise<void>;
+    subscribe(name: string, listener: (payload: unknown, envelope: Readonly<Record<string, unknown>>) => void | Promise<void>): () => void;
+}
+
+export declare interface TapVsCodeWebviewBootstrapBinding {
+    /** Path to read in the stored JSON value. */
+    statePath: readonly string[];
+    /** Path to update in the bootstrap JSON value. */
+    bootstrapPath: readonly string[];
+    transform?: Exclude<TapVsCodeWebviewValueTransform, 'byte-array-to-base64'>;
+}
+
+export declare interface TapVsCodeWebviewBootstrapOptions {
+    selector: string;
+    attribute: string;
+    encoding: 'base64-json';
+    value: MiniAppJsonValue;
+}
+
+export declare interface TapVsCodeWebviewBridgeOptions {
+    title: string;
+    entryPath: string;
+    /** Browser runtime emitted from `tapVsCodeWebviewRuntimeSource`. */
+    runtimePath: string;
+    bootstrap?: TapVsCodeWebviewBootstrapOptions;
+    storage?: TapVsCodeWebviewStorageOptions;
+    session?: TapVsCodeWebviewSessionOptions;
+    network?: TapVsCodeWebviewNetworkOptions;
+    onMessage?: (message: unknown) => void | Promise<void>;
+    onError?: (error: Error) => void;
+}
+
+export declare interface TapVsCodeWebviewMessageBinding {
+    /** Exact value of the message discriminator (normally `message.type`). */
+    messageType: string;
+    /** Path to the value in the webview message. */
+    messageValuePath: readonly string[];
+    /** Path to update in the JSON value stored by `sdk.storage`. */
+    statePath: readonly string[];
+    transform?: Exclude<TapVsCodeWebviewValueTransform, 'base64-to-byte-array'>;
+}
+
+export declare interface TapVsCodeWebviewMount extends TapFederatedSurfaceMount {
+    postMessage(message: unknown): void;
+}
+
+export declare interface TapVsCodeWebviewNetworkOptions {
+    /** Exact HTTPS origins approved by the conversion recipe. */
+    allowedOrigins: readonly string[];
+}
+
+/**
+ * Self-contained browser runtime written next to a converted webview by the
+ * conversion CLI. Keeping this byte string in the SDK prevents generated
+ * adapters from growing a second, incompatible bridge implementation.
+ */
+export declare const tapVsCodeWebviewRuntimeSource: string;
+
+export declare interface TapVsCodeWebviewSessionOptions {
+    /**
+     * Field inside the installation-scoped `sdk.session` object. The iframe gets
+     * a synchronous in-memory localStorage facade backed by this field.
+     */
+    namespace: string;
+}
+
+export declare interface TapVsCodeWebviewStorageOptions {
+    namespace: string;
+    key: string;
+    initialValue: MiniAppJsonValue;
+    messageTypePath?: readonly string[];
+    messageBindings?: readonly TapVsCodeWebviewMessageBinding[];
+    bootstrapBindings?: readonly TapVsCodeWebviewBootstrapBinding[];
+    /**
+     * Optional path used for the synchronous `acquireVsCodeApi().getState()` and
+     * `setState()` compatibility value.
+     */
+    vscodeStatePath?: readonly string[];
+}
+
+export declare type TapVsCodeWebviewValueTransform = 'identity' | 'byte-array-to-base64' | 'base64-to-byte-array';
+
+export { }