@theaiplatform/miniapp-sdk 0.0.0 → 0.0.2

package/dist/config.d.ts

@@ -9,6 +9,9 @@ export declare type JsonSchema = {
     readonly [key: string]: unknown;
 };
 
+/** Closed discovery taxonomy accepted by `presentation.categories`. */
+export declare type MiniAppCategory = 'productivity' | 'developer-tools' | 'creativity' | 'communication' | 'data-and-analytics' | 'business' | 'education' | 'media-and-entertainment' | 'utilities' | 'other';
+
 export declare type ToolDefinition<TArguments = unknown, TResult = unknown> = {
     displayName?: string;
     description: string;
@@ -28,7 +31,7 @@ export declare type UIEntrypoint = {
 };
 
 /**
- * @capability integrations-and-marketplace
+ * @capability miniapp-platform
  */
 export declare type UIEntrypointType = 'workspace-left-sidebar' | 'workspace-left-sidebar-item' | 'chat-right-sidebar' | 'chat-right-sidebar-item';
 

package/dist/index.d.ts

@@ -28,6 +28,9 @@ export declare type CreateProjectResult = {
 
 export declare function defineApp<const TConfig extends AppConfig>(config: TConfig): TConfig;
 
+/** Preserve the inferred tool signatures for a package-runtime MCP server. */
+export declare function defineMcpServer<const TServer extends McpServerDefinition>(server: TServer): TServer;
+
 export declare type GetChannelAccessOptions = {
     workspaceId?: string;
     channelId: string;
@@ -105,12 +108,27 @@ export declare type ListWorkflowsResult = {
     workflows: MiniAppWorkflow[];
 };
 
+/** The tools exposed by one package-runtime MCP server. */
+export declare type McpServerDefinition = {
+    tools: Record<string, McpServerToolDefinition>;
+};
+
+/** One tool implemented by a package-runtime MCP server. */
+export declare type McpServerToolDefinition<TArguments extends MiniAppJsonValue = MiniAppJsonValue, TResult extends MiniAppJsonValue = MiniAppJsonValue> = {
+    description: string;
+    inputSchema: JsonSchema;
+    execute(arguments_: TArguments): MiniAppMaybePromise<TResult>;
+};
+
 export declare type MiniAppAuthApi = {
     getUserProfile(): MiniAppMaybePromise<MiniAppUserProfile | null>;
 };
 
+/** Closed discovery taxonomy accepted by `presentation.categories`. */
+export declare type MiniAppCategory = 'productivity' | 'developer-tools' | 'creativity' | 'communication' | 'data-and-analytics' | 'business' | 'education' | 'media-and-entertainment' | 'utilities' | 'other';
+
 /**
- * @capability integrations-and-marketplace
+ * @capability miniapp-platform
  */
 export declare type MiniAppChannel = {
     roomId: string;
@@ -154,6 +172,85 @@ export declare type MiniAppCreateSpecialistResult = {
     isActive: boolean;
 };
 
+/** Metadata-only access to host-managed credentials in the active workspace. */
+export declare type MiniAppCredentialsApi = {
+    listHttp(): MiniAppMaybePromise<MiniAppHttpCredentialMetadata[]>;
+};
+
+/** Host-mediated bounded HTTP(S); browser fetch is not the authority. */
+export declare type MiniAppHttpApi = {
+    request(input: MiniAppHttpRequestInput, options?: MiniAppHttpRequestOptions): MiniAppMaybePromise<MiniAppHttpResponse>;
+};
+
+/** Metadata-only stored HTTP credential. Secret fields never cross IPC. */
+export declare type MiniAppHttpCredentialMetadata = {
+    id: string;
+    credentialType: MiniAppHttpCredentialType;
+    displayName: string;
+    metadataFields: Record<string, string>;
+};
+
+export declare type MiniAppHttpCredentialType = 'http_bearer' | 'http_basic' | 'http_header_auth' | 'http_api_key';
+
+export declare type MiniAppHttpHeader = {
+    name: string;
+    value: string;
+};
+
+export declare type MiniAppHttpHeaderInput = {
+    name: string;
+    value: string;
+    /** Defaults to true when omitted. */
+    enabled?: boolean;
+};
+
+export declare type MiniAppHttpQueryInput = {
+    name: string;
+    value: string;
+    /** Defaults to true when omitted. */
+    enabled?: boolean;
+};
+
+export 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;
+};
+
+export declare type MiniAppHttpRequestOptions = {
+    /**
+     * Opaque host-managed credential reference. Secret material never enters
+     * miniapp JavaScript.
+     */
+    credentialRef?: string;
+};
+
+export 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. */
 export declare type MiniAppJsonValue = null | boolean | number | string | MiniAppJsonValue[] | {
     [key: string]: MiniAppJsonValue;
@@ -245,6 +342,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;
@@ -253,6 +356,41 @@ export declare type MiniAppPlatformApi = {
     hasHostHttpRequest?: boolean;
 };
 
+export 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.
+ */
+export declare type MiniAppPresenceApi = {
+    join(options: MiniAppPresenceUpdateOptions): MiniAppMaybePromise<MiniAppPresenceSnapshot>;
+    update(options: MiniAppPresenceUpdateOptions): MiniAppMaybePromise<MiniAppPresenceSnapshot>;
+    leave(options: MiniAppPresenceAddress): MiniAppMaybePromise<void>;
+    subscribe(options: MiniAppPresenceAddress, listener: MiniAppPresenceListener): () => void;
+};
+
+export declare type MiniAppPresenceListener = (snapshot: MiniAppPresenceSnapshot) => void;
+
+export declare type MiniAppPresenceParticipant = {
+    /** Host-derived, ephemeral participant identity. */
+    participantId: string;
+    displayName: string;
+    state: MiniAppJsonValue;
+    updatedAtMs: number;
+};
+
+export declare type MiniAppPresenceSnapshot = MiniAppPresenceAddress & {
+    selfParticipantId: string;
+    participants: MiniAppPresenceParticipant[];
+};
+
+export declare type MiniAppPresenceUpdateOptions = MiniAppPresenceAddress & {
+    state: MiniAppJsonValue;
+};
+
 export declare type MiniAppProject = {
     id: string;
     name: string;
@@ -352,6 +490,43 @@ export declare type MiniAppSpecialistTurnResult = {
     };
 };
 
+/** Caller-selected partition inside the host-derived workspace/package scope. */
+export 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.
+ */
+export declare type MiniAppStorageApi = {
+    get(options: MiniAppStorageAddress): MiniAppMaybePromise<MiniAppStorageEntry>;
+    set(options: MiniAppStorageSetOptions): MiniAppMaybePromise<MiniAppStorageMutationResult>;
+    delete(options: MiniAppStorageDeleteOptions): MiniAppMaybePromise<void>;
+};
+
+export declare type MiniAppStorageDeleteOptions = MiniAppStorageAddress & {
+    expectedRevision: number;
+};
+
+export declare type MiniAppStorageEntry = {
+    value: MiniAppJsonValue | null;
+    /** Null means that no value currently exists at this address. */
+    revision: number | null;
+};
+
+export declare type MiniAppStorageMutationResult = {
+    revision: number;
+};
+
+export declare type MiniAppStorageSetOptions = MiniAppStorageAddress & {
+    value: MiniAppJsonValue;
+    /** Optimistic concurrency token returned by `get`; null creates a missing key. */
+    expectedRevision: number | null;
+};
+
 export declare type MiniAppUserProfile = {
     sub: string;
     name?: string | null;
@@ -455,7 +630,7 @@ export declare type UIEntrypoint = {
 };
 
 /**
- * @capability integrations-and-marketplace
+ * @capability miniapp-platform
  */
 export declare type UIEntrypointType = 'workspace-left-sidebar' | 'workspace-left-sidebar-item' | 'chat-right-sidebar' | 'chat-right-sidebar-item';
 

package/dist/index.js

@@ -1,2 +1,3 @@
 export { defineApp } from "./config.js";
+export { defineMcpServer } from "./mcp.js";
 export { sdk } from "./sdk.js";

package/dist/mcp.d.ts

@@ -0,0 +1,27 @@
+/** Preserve the inferred tool signatures for a package-runtime MCP server. */
+export declare function defineMcpServer<const TServer extends McpServerDefinition>(server: TServer): TServer;
+
+declare type JsonSchema = {
+    readonly [key: string]: unknown;
+};
+
+/** The tools exposed by one package-runtime MCP server. */
+export declare type McpServerDefinition = {
+    tools: Record<string, McpServerToolDefinition>;
+};
+
+/** One tool implemented by a package-runtime MCP server. */
+export declare type McpServerToolDefinition<TArguments extends MiniAppJsonValue = MiniAppJsonValue, TResult extends MiniAppJsonValue = MiniAppJsonValue> = {
+    description: string;
+    inputSchema: JsonSchema;
+    execute(arguments_: TArguments): MiniAppMaybePromise<TResult>;
+};
+
+/** JSON-compatible values accepted by public miniapp operations. */
+declare type MiniAppJsonValue = null | boolean | number | string | MiniAppJsonValue[] | {
+    [key: string]: MiniAppJsonValue;
+};
+
+declare type MiniAppMaybePromise<T> = T | Promise<T>;
+
+export { }

package/dist/mcp.js

@@ -0,0 +1,4 @@
+function defineMcpServer(server) {
+    return server;
+}
+export { defineMcpServer };

package/dist/rspack/css-entry-loader.cjs

@@ -1,5 +1,5 @@
 /**
- * @capability integrations-and-marketplace
+ * @capability miniapp-platform
  */
 
 const getLoaderOptions = (loaderContext) => {

package/dist/rspack/html-loader.cjs

@@ -1,5 +1,5 @@
 /**
- * @capability integrations-and-marketplace
+ * @capability miniapp-platform
  */
 
 const crypto = require('node:crypto');