@theaiplatform/miniapp-sdk 0.0.0 → 0.0.2

package/dist/web.d.ts

@@ -7,6 +7,8 @@ export declare const app: MiniAppPlatformApi;
 
 export declare function applyMiniAppTheme(theme: MiniAppTheme): void;
 
+export declare function applyMiniAppUiScale(scale: MiniAppUiScale): void;
+
 declare type CreateChannelOptions = {
     workspaceId?: string;
     name: string;
@@ -61,6 +63,8 @@ declare type GetChannelTimelineResult = {
 
 export declare function getMiniAppThemeFromSearch(search?: string | URLSearchParams): MiniAppTheme;
 
+export declare function getMiniAppUiScaleFromSearch(search?: string | URLSearchParams): MiniAppUiScale;
+
 /** Returns the public miniapp API proxy, which fails only when it is used. */
 export declare function getPlatform(): MiniAppPlatform;
 
@@ -73,6 +77,13 @@ declare type GetProjectResult = {
     project: MiniAppProject | null;
 };
 
+/** Synchronizes both theme and UI scale from the exact parent miniapp host. */
+export declare function installMiniAppAppearanceSync({ applyTheme, applyUiScale, search, }?: InstallMiniAppAppearanceSyncOptions): () => void;
+
+export declare type InstallMiniAppAppearanceSyncOptions = InstallMiniAppThemeSyncOptions & {
+    applyUiScale?: (scale: MiniAppUiScale) => void;
+};
+
 export declare function installMiniAppThemeSync({ applyTheme, search, }?: InstallMiniAppThemeSyncOptions): () => void;
 
 export declare type InstallMiniAppThemeSyncOptions = {
@@ -115,12 +126,18 @@ declare type ListWorkflowsResult = {
     workflows: MiniAppWorkflow[];
 };
 
+export declare const MINIAPP_UI_SCALE_DEFAULT = 16;
+
+export declare const MINIAPP_UI_SCALE_MAX = 20;
+
+export declare const MINIAPP_UI_SCALE_MIN = 12;
+
 declare type MiniAppAuthApi = {
     getUserProfile(): MiniAppMaybePromise<MiniAppUserProfile | null>;
 };
 
 /**
- * @capability integrations-and-marketplace
+ * @capability miniapp-platform
  */
 declare type MiniAppChannel = {
     roomId: string;
@@ -164,6 +181,85 @@ declare type MiniAppCreateSpecialistResult = {
     isActive: boolean;
 };
 
+/** Metadata-only access to host-managed credentials in the active workspace. */
+declare type MiniAppCredentialsApi = {
+    listHttp(): MiniAppMaybePromise<MiniAppHttpCredentialMetadata[]>;
+};
+
+/** Host-mediated bounded HTTP(S); browser fetch is not the authority. */
+declare type MiniAppHttpApi = {
+    request(input: MiniAppHttpRequestInput, options?: MiniAppHttpRequestOptions): MiniAppMaybePromise<MiniAppHttpResponse>;
+};
+
+/** Metadata-only stored HTTP credential. Secret fields never cross IPC. */
+declare type MiniAppHttpCredentialMetadata = {
+    id: string;
+    credentialType: MiniAppHttpCredentialType;
+    displayName: string;
+    metadataFields: Record<string, string>;
+};
+
+declare type MiniAppHttpCredentialType = 'http_bearer' | 'http_basic' | 'http_header_auth' | 'http_api_key';
+
+declare type MiniAppHttpHeader = {
+    name: string;
+    value: string;
+};
+
+declare type MiniAppHttpHeaderInput = {
+    name: string;
+    value: string;
+    /** Defaults to true when omitted. */
+    enabled?: boolean;
+};
+
+declare type MiniAppHttpQueryInput = {
+    name: string;
+    value: string;
+    /** Defaults to true when omitted. */
+    enabled?: boolean;
+};
+
+declare type MiniAppHttpRequestInput = {
+    method: string;
+    url: string;
+    query?: MiniAppHttpQueryInput[];
+    headers?: MiniAppHttpHeaderInput[];
+    body?: string | null;
+    /** Defaults to 30 seconds and is capped by the host at 120 seconds. */
+    timeoutMs?: number | null;
+    /** Defaults to 5 MiB and is capped by the host at 10 MiB. */
+    responseBodyLimitBytes?: number | null;
+    /**
+     * Defaults to false. The host follows at most ten same-origin redirects;
+     * cross-origin redirects require a separate request and grant.
+     */
+    followRedirects?: boolean | null;
+};
+
+declare type MiniAppHttpRequestOptions = {
+    /**
+     * Opaque host-managed credential reference. Secret material never enters
+     * miniapp JavaScript.
+     */
+    credentialRef?: string;
+};
+
+declare type MiniAppHttpResponse = {
+    finalUrl: string;
+    status: number;
+    statusText: string;
+    /** Ordered entries; duplicate response header names remain separate. */
+    headers: MiniAppHttpHeader[];
+    bodyText: string | null;
+    bodyBase64: string | null;
+    bodyKind: 'text' | 'binary';
+    bodyTruncated: boolean;
+    sizeBytes: number;
+    elapsedMs: number;
+    contentType: string | null;
+};
+
 /** JSON-compatible values accepted by public miniapp operations. */
 declare type MiniAppJsonValue = null | boolean | number | string | MiniAppJsonValue[] | {
     [key: string]: MiniAppJsonValue;
@@ -258,6 +354,12 @@ export declare type MiniAppPlatformApi = {
         open(options: OpenNavigationOptions): void | Promise<void>;
     };
     chat: MiniAppChatApi;
+    storage: MiniAppStorageApi;
+    presence: MiniAppPresenceApi;
+    /** Desktop host capability; feature-detect before use on portable targets. */
+    http?: MiniAppHttpApi;
+    /** Desktop host capability; feature-detect before use on portable targets. */
+    credentials?: MiniAppCredentialsApi;
     /** Browser capabilities appear only when the selected target supports them. */
     auth?: MiniAppAuthApi;
     vfs?: MiniAppVfsApi;
@@ -266,6 +368,41 @@ export declare type MiniAppPlatformApi = {
     hasHostHttpRequest?: boolean;
 };
 
+declare type MiniAppPresenceAddress = {
+    namespace: string;
+    room: string;
+};
+
+/**
+ * Ephemeral realtime presence scoped by the host to the active workspace and
+ * exact package. Participant identity is stamped by the host, not the app.
+ */
+declare type MiniAppPresenceApi = {
+    join(options: MiniAppPresenceUpdateOptions): MiniAppMaybePromise<MiniAppPresenceSnapshot>;
+    update(options: MiniAppPresenceUpdateOptions): MiniAppMaybePromise<MiniAppPresenceSnapshot>;
+    leave(options: MiniAppPresenceAddress): MiniAppMaybePromise<void>;
+    subscribe(options: MiniAppPresenceAddress, listener: MiniAppPresenceListener): () => void;
+};
+
+declare type MiniAppPresenceListener = (snapshot: MiniAppPresenceSnapshot) => void;
+
+declare type MiniAppPresenceParticipant = {
+    /** Host-derived, ephemeral participant identity. */
+    participantId: string;
+    displayName: string;
+    state: MiniAppJsonValue;
+    updatedAtMs: number;
+};
+
+declare type MiniAppPresenceSnapshot = MiniAppPresenceAddress & {
+    selfParticipantId: string;
+    participants: MiniAppPresenceParticipant[];
+};
+
+declare type MiniAppPresenceUpdateOptions = MiniAppPresenceAddress & {
+    state: MiniAppJsonValue;
+};
+
 declare type MiniAppProject = {
     id: string;
     name: string;
@@ -365,8 +502,47 @@ declare type MiniAppSpecialistTurnResult = {
     };
 };
 
+/** Caller-selected partition inside the host-derived workspace/package scope. */
+declare type MiniAppStorageAddress = {
+    namespace: string;
+    key: string;
+};
+
+/**
+ * Durable, non-secret JSON storage. The host derives workspace and package
+ * identity from the authenticated frame; apps control only the namespace and
+ * key inside that scope.
+ */
+declare type MiniAppStorageApi = {
+    get(options: MiniAppStorageAddress): MiniAppMaybePromise<MiniAppStorageEntry>;
+    set(options: MiniAppStorageSetOptions): MiniAppMaybePromise<MiniAppStorageMutationResult>;
+    delete(options: MiniAppStorageDeleteOptions): MiniAppMaybePromise<void>;
+};
+
+declare type MiniAppStorageDeleteOptions = MiniAppStorageAddress & {
+    expectedRevision: number;
+};
+
+declare type MiniAppStorageEntry = {
+    value: MiniAppJsonValue | null;
+    /** Null means that no value currently exists at this address. */
+    revision: number | null;
+};
+
+declare type MiniAppStorageMutationResult = {
+    revision: number;
+};
+
+declare type MiniAppStorageSetOptions = MiniAppStorageAddress & {
+    value: MiniAppJsonValue;
+    /** Optimistic concurrency token returned by `get`; null creates a missing key. */
+    expectedRevision: number | null;
+};
+
 export declare type MiniAppTheme = 'light' | 'dark';
 
+export declare type MiniAppUiScale = number;
+
 declare type MiniAppUserProfile = {
     sub: string;
     name?: string | null;

package/dist/web.js

@@ -101,10 +101,14 @@ async function openEditorProject(options) {
     if ("u" < typeof window) throw new Error('The miniapp host is unavailable.');
     await requestHostAction(OPEN_EDITOR_PROJECT_ACTION, options);
 }
+const MINIAPP_UI_SCALE_MIN = 12;
+const MINIAPP_UI_SCALE_MAX = 20;
+const MINIAPP_UI_SCALE_DEFAULT = 16;
 const MINIAPP_THEME_CHANGED_EVENTS = new Set([
     'zephyr-app-theme-changed',
     'tap-miniapp-theme-changed'
 ]);
+const MINIAPP_UI_SCALE_CHANGED_EVENT = 'zephyr-app-ui-scale-changed';
 function isMiniAppTheme(value) {
     return 'light' === value || 'dark' === value;
 }
@@ -123,6 +127,21 @@ function applyMiniAppTheme(theme) {
     document.documentElement.classList.toggle('light', 'light' === theme);
     document.documentElement.style.colorScheme = theme;
 }
+function isMiniAppUiScale(value) {
+    return 'number' == typeof value && Number.isInteger(value) && value >= MINIAPP_UI_SCALE_MIN && value <= MINIAPP_UI_SCALE_MAX;
+}
+function getMiniAppUiScaleFromSearch(search = "u" < typeof window ? '' : window.location.search) {
+    const params = 'string' == typeof search ? new URLSearchParams(search.startsWith('?') ? search.slice(1) : search) : search;
+    const rawScale = params.get('appUiScale');
+    if (null === rawScale || '' === rawScale.trim()) return MINIAPP_UI_SCALE_DEFAULT;
+    const scale = Number(rawScale);
+    return isMiniAppUiScale(scale) ? scale : MINIAPP_UI_SCALE_DEFAULT;
+}
+function applyMiniAppUiScale(scale) {
+    if ("u" < typeof document || !isMiniAppUiScale(scale)) return;
+    document.documentElement.dataset.uiScale = String(scale);
+    document.documentElement.style.setProperty('--app-font-size', `${scale}px`);
+}
 function installMiniAppThemeSync({ applyTheme = applyMiniAppTheme, search } = {}) {
     applyTheme(getMiniAppThemeFromSearch(search));
     if ("u" < typeof window) return ()=>void 0;
@@ -142,5 +161,22 @@ function installMiniAppThemeSync({ applyTheme = applyMiniAppTheme, search } = {}
         window.removeEventListener('message', handleMessage);
     };
 }
+function installMiniAppAppearanceSync({ applyTheme = applyMiniAppTheme, applyUiScale = applyMiniAppUiScale, search } = {}) {
+    applyTheme(getMiniAppThemeFromSearch(search));
+    applyUiScale(getMiniAppUiScaleFromSearch(search));
+    if ("u" < typeof window) return ()=>void 0;
+    const hostOrigin = getHostOrigin();
+    const parent = window.parent;
+    if (!hostOrigin || !parent || parent === window) return ()=>void 0;
+    const handleMessage = (event)=>{
+        if (event.source !== parent || event.origin !== hostOrigin) return;
+        if ('object' != typeof event.data || null === event.data) return;
+        const record = event.data;
+        if ('string' == typeof record.type && MINIAPP_THEME_CHANGED_EVENTS.has(record.type) && isMiniAppTheme(record.appTheme)) return void applyTheme(record.appTheme);
+        if (record.type === MINIAPP_UI_SCALE_CHANGED_EVENT && isMiniAppUiScale(record.appUiScale)) applyUiScale(record.appUiScale);
+    };
+    window.addEventListener('message', handleMessage);
+    return ()=>window.removeEventListener('message', handleMessage);
+}
 export { sdk as app } from "./sdk.js";
-export { applyMiniAppTheme, getMiniAppThemeFromSearch, getPlatform, installMiniAppThemeSync, openEditorProject, platformSatisfiesApp };
+export { MINIAPP_UI_SCALE_DEFAULT, MINIAPP_UI_SCALE_MAX, MINIAPP_UI_SCALE_MIN, applyMiniAppTheme, applyMiniAppUiScale, getMiniAppThemeFromSearch, getMiniAppUiScaleFromSearch, getPlatform, installMiniAppAppearanceSync, installMiniAppThemeSync, openEditorProject, platformSatisfiesApp };

package/examples/wasm-ui/Cargo.lock

@@ -0,0 +1,248 @@
+# This file is automatically @generated by Cargo.
+# It is not intended for manual editing.
+version = 4
+
+[[package]]
+name = "bumpalo"
+version = "3.20.3"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "72f5acc6cb2ba439de613abc23857ec3d78374d8ed5ac84e9d11336e87da8649"
+
+[[package]]
+name = "cfg-if"
+version = "1.0.4"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "9330f8b2ff13f34540b44e946ef35111825727b38d33286ef986142615121801"
+
+[[package]]
+name = "futures-core"
+version = "0.3.33"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "2cd50c473c80f6d7c3670a752354b8e569b1a7cbfdc0419ec88e5edad85e0dc7"
+
+[[package]]
+name = "futures-task"
+version = "0.3.33"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "b231ed28831efb4a61a08580c4bc233ec56bc009f4cd8f52da2c3cb97df0c109"
+
+[[package]]
+name = "futures-util"
+version = "0.3.33"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "a77a90a256fce34da66415271e30f94ee91c57b04b8a2c042d9cf3220179deaa"
+dependencies = [
+ "futures-core",
+ "futures-task",
+ "pin-project-lite",
+ "slab",
+]
+
+[[package]]
+name = "itoa"
+version = "1.0.18"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "8f42a60cbdf9a97f5d2305f08a87dc4e09308d1276d28c869c684d7777685682"
+
+[[package]]
+name = "js-sys"
+version = "0.3.103"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "53b44bfcdb3f8d5837a46dae1ca9660a837176eee74a28b229bc626816589102"
+dependencies = [
+ "cfg-if",
+ "futures-util",
+ "wasm-bindgen",
+]
+
+[[package]]
+name = "memchr"
+version = "2.8.3"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "cf8baf1c55e62ffcace7a9f06f4bd9cd3f0c4beb022d3b367256b91b87513d98"
+
+[[package]]
+name = "miniapp-sdk-wasm-ui-example"
+version = "0.1.0"
+dependencies = [
+ "js-sys",
+ "serde",
+ "serde-wasm-bindgen",
+ "serde_json",
+ "wasm-bindgen",
+ "web-sys",
+]
+
+[[package]]
+name = "once_cell"
+version = "1.21.4"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "9f7c3e4beb33f85d45ae3e3a1792185706c8e16d043238c593331cc7cd313b50"
+
+[[package]]
+name = "pin-project-lite"
+version = "0.2.17"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "a89322df9ebe1c1578d689c92318e070967d1042b512afbe49518723f4e6d5cd"
+
+[[package]]
+name = "proc-macro2"
+version = "1.0.106"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "8fd00f0bb2e90d81d1044c2b32617f68fcb9fa3bb7640c23e9c748e53fb30934"
+dependencies = [
+ "unicode-ident",
+]
+
+[[package]]
+name = "quote"
+version = "1.0.46"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "dfbc457d0c7a0759a614551b11a6409e5951f6c7537be1f1b7682b9ae9230368"
+dependencies = [
+ "proc-macro2",
+]
+
+[[package]]
+name = "rustversion"
+version = "1.0.23"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "cf54715a573b99ac80df0bc206da022bcd442c974952c7b9720069370852e21f"
+
+[[package]]
+name = "serde"
+version = "1.0.228"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "9a8e94ea7f378bd32cbbd37198a4a91436180c5bb472411e48b5ec2e2124ae9e"
+dependencies = [
+ "serde_core",
+ "serde_derive",
+]
+
+[[package]]
+name = "serde-wasm-bindgen"
+version = "0.6.5"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "8302e169f0eddcc139c70f139d19d6467353af16f9fce27e8c30158036a1e16b"
+dependencies = [
+ "js-sys",
+ "serde",
+ "wasm-bindgen",
+]
+
+[[package]]
+name = "serde_core"
+version = "1.0.228"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "41d385c7d4ca58e59fc732af25c3983b67ac852c1a25000afe1175de458b67ad"
+dependencies = [
+ "serde_derive",
+]
+
+[[package]]
+name = "serde_derive"
+version = "1.0.228"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "d540f220d3187173da220f885ab66608367b6574e925011a9353e4badda91d79"
+dependencies = [
+ "proc-macro2",
+ "quote",
+ "syn",
+]
+
+[[package]]
+name = "serde_json"
+version = "1.0.150"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "e8014e44b4736ed0538adeecded0fce2a272f22dc9578a7eb6b2d9993c74cfb9"
+dependencies = [
+ "itoa",
+ "memchr",
+ "serde",
+ "serde_core",
+ "zmij",
+]
+
+[[package]]
+name = "slab"
+version = "0.4.12"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "0c790de23124f9ab44544d7ac05d60440adc586479ce501c1d6d7da3cd8c9cf5"
+
+[[package]]
+name = "syn"
+version = "2.0.119"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "872831b642d1a07999a962a351ed35b955ea2cfc8f3862091e2a240a84f17297"
+dependencies = [
+ "proc-macro2",
+ "quote",
+ "unicode-ident",
+]
+
+[[package]]
+name = "unicode-ident"
+version = "1.0.24"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "e6e4313cd5fcd3dad5cafa179702e2b244f760991f45397d14d4ebf38247da75"
+
+[[package]]
+name = "wasm-bindgen"
+version = "0.2.126"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "4b067c0c11094aef6b7a801c1e34a26affafdf3d051dba08456b868789aaf9a4"
+dependencies = [
+ "cfg-if",
+ "once_cell",
+ "rustversion",
+ "wasm-bindgen-macro",
+ "wasm-bindgen-shared",
+]
+
+[[package]]
+name = "wasm-bindgen-macro"
+version = "0.2.126"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "167ce5e579f6bcf889c4f7175a8a5a585de84e8ff93976ce393efa5f2837aab1"
+dependencies = [
+ "quote",
+ "wasm-bindgen-macro-support",
+]
+
+[[package]]
+name = "wasm-bindgen-macro-support"
+version = "0.2.126"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "f3997c7839262f4ef12cf90b818d6340c18e80f263f1a94bf157d0ec4420380e"
+dependencies = [
+ "bumpalo",
+ "proc-macro2",
+ "quote",
+ "syn",
+ "wasm-bindgen-shared",
+]
+
+[[package]]
+name = "wasm-bindgen-shared"
+version = "0.2.126"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "dc1b4cb0cc549fcf58d7dfc081778139b3d283a081644e833e84682ad71cea24"
+dependencies = [
+ "unicode-ident",
+]
+
+[[package]]
+name = "web-sys"
+version = "0.3.103"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "8622dcb61c0bcc9fffa6938bed81210af2da9a7e4a1a834b2e37a59b6dfb6141"
+dependencies = [
+ "js-sys",
+ "wasm-bindgen",
+]
+
+[[package]]
+name = "zmij"
+version = "1.0.23"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "29666d0abbfad1e3dc4dcf6144730dd3a3ab225bbbdac83319345b1b44ccfc1b"

package/examples/wasm-ui/Cargo.toml

@@ -0,0 +1,18 @@
+[package]
+name = "miniapp-sdk-wasm-ui-example"
+version = "0.1.0"
+edition = "2024"
+publish = false
+
+[lib]
+crate-type = ["cdylib", "rlib"]
+
+[dependencies]
+js-sys = "0.3.98"
+serde = { version = "1.0.228", features = ["derive"] }
+serde-wasm-bindgen = "0.6.5"
+serde_json = "1.0.149"
+wasm-bindgen = "0.2.121"
+web-sys = { version = "0.3.98", features = ["Element"] }
+
+[workspace]

package/examples/wasm-ui/README.md

@@ -0,0 +1,19 @@
+# Rust/WASM UI example
+
+This crate is a clean wasm-bindgen consumer of
+`@theaiplatform/miniapp-sdk/ui/wasm`. It demonstrates the full lifecycle:
+mount, controlled revision updates, focus, action validation, replay/stale
+rejection, and idempotent teardown.
+
+Build it with:
+
+```bash
+cargo check --target wasm32-unknown-unknown
+```
+
+The JavaScript application that loads the generated wasm must import the SDK
+styles once:
+
+```ts
+import '@theaiplatform/miniapp-sdk/ui/styles.css';
+```