apps 0.0.1-beta.87 → 0.0.1-beta.88

package/types/apps/src/contracts/app.d.ts

@@ -59,6 +59,8 @@ export interface App<Slots extends AccountSlots, Def extends AppDefinition<never
     readonly accounts: Slots;
     /** Declared beside the accounts, so a host lists them without evaluating the app. */
     readonly events?: Readonly<Record<string, import("./events.js").AppEvent>>;
+    /** Declared beside the accounts and checked when the module loads. */
+    readonly icons?: import("./icons.js").AppIcons;
     readonly evaluate: (context: BoundContext<Slots>) => Effect.Effect<Def, unknown>;
 }
 declare const NotImplemented_base: Schema.Class<NotImplemented, Schema.TaggedStruct<"NotImplemented", {

package/types/apps/src/contracts/context.d.ts

@@ -3,11 +3,17 @@ import type { WorkflowControls } from "./workflows.js";
 import type { AccountSlots, BoundContext } from "./app.js";
 import type { Sql, SqlReader } from "./sql.js";
 import type { AnyEventDeclaration, EventEmitter } from "../implementation/events.js";
+import type { AppIcon } from "./icons.js";
 /** Requirements are pure values; selected accounts and SQL access belong to invocations. */
 export interface AppRequirements {
     readonly accounts: AccountSlots;
     /** Events this app emits, by name, such as `issue.opened`. */
     readonly events?: Readonly<Record<string, AnyEventDeclaration>>;
+    /**
+     * Images a dashboard shows for the app, such as its logo in light and dark variants. Each `src`
+     * is base64 `data:image/...` or an `https:` URL; at most 8 icons and 32 KiB in total.
+     */
+    readonly icons?: ReadonlyArray<AppIcon>;
 }
 /** The emitter for an app's declared events. */
 type EventsContext<Requirements extends AppRequirements> = {

package/types/apps/src/contracts/host.d.ts

@@ -20,6 +20,7 @@ export { ElicitationLimits, defaultElicitationLimits, FormElicitation, Elicitati
 export { McpClientLimits, defaultMcpClientLimits } from "./mcp.js";
 export * from "./webhook-protocol.js";
 export * from "./events.js";
+export { AppIcon, AppIcons, appIconLimits } from "./icons.js";
 export * from "./placement.js";
 export { AccountId, HttpUrl } from "./schema.js";
 export { OAuthAuthorizationParams, OAuthClientAuth, OAuthSecretClientAuth, OAuthTokenRequestFormat, OAuthTokenResponse, } from "./provider.js";

package/types/apps/src/contracts/icons.d.ts

@@ -0,0 +1,28 @@
+/** The icons an app declares beside its accounts, so a host shows them without evaluating it. */
+import { Schema } from "effect";
+/** At most this many icons, together at most this many characters of JSON (32 KiB). */
+export declare const appIconLimits: {
+    readonly icons: 8;
+    readonly characters: number;
+};
+/**
+ * One image an app shows for itself, the same shape as a router's icon. `theme` names the color
+ * scheme it is drawn for; an icon without one suits both.
+ */
+export declare const AppIcon: Schema.Struct<{
+    readonly src: Schema.String;
+    readonly mimeType: Schema.optionalKey<Schema.String>;
+    readonly sizes: Schema.optionalKey<Schema.$Array<Schema.String>>;
+    readonly theme: Schema.optionalKey<Schema.Literals<readonly ["light", "dark"]>>;
+}>;
+export type AppIcon = typeof AppIcon.Type;
+/** An app's icons, bounded in number and total size. */
+export declare const AppIcons: Schema.$Array<Schema.Struct<{
+    readonly src: Schema.String;
+    readonly mimeType: Schema.optionalKey<Schema.String>;
+    readonly sizes: Schema.optionalKey<Schema.$Array<Schema.String>>;
+    readonly theme: Schema.optionalKey<Schema.Literals<readonly ["light", "dark"]>>;
+}>>;
+export type AppIcons = typeof AppIcons.Type;
+/** Why declared icons are refused, in the author's terms, or undefined when they are valid. */
+export declare const appIconsProblem: (icons: unknown) => string | undefined;

package/types/apps/src/contracts/protocols/current.d.ts

@@ -663,6 +663,13 @@ export declare const DeclaredRequirements: Schema.Struct<{
         readonly filters: Schema.$Record<Schema.String, Schema.Codec<Schema.Json, Schema.Json, never, never>>;
         readonly payload: Schema.$Record<Schema.String, Schema.Codec<Schema.Json, Schema.Json, never, never>>;
     }>>>;
+    /** The icons the app declares, so a host shows them without evaluating the app. */
+    readonly icons: Schema.optionalKey<Schema.$Array<Schema.Struct<{
+        readonly src: Schema.String;
+        readonly mimeType: Schema.optionalKey<Schema.String>;
+        readonly sizes: Schema.optionalKey<Schema.$Array<Schema.String>>;
+        readonly theme: Schema.optionalKey<Schema.Literals<readonly ["light", "dark"]>>;
+    }>>>;
 }>;
 /** Parsed declared account requirements. */
 export type DeclaredRequirements = typeof DeclaredRequirements.Type;
@@ -3175,6 +3182,13 @@ export declare const current: {
                 readonly filters: Schema.$Record<Schema.String, Schema.Codec<Schema.Json, Schema.Json, never, never>>;
                 readonly payload: Schema.$Record<Schema.String, Schema.Codec<Schema.Json, Schema.Json, never, never>>;
             }>>>;
+            /** The icons the app declares, so a host shows them without evaluating the app. */
+            readonly icons: Schema.optionalKey<Schema.$Array<Schema.Struct<{
+                readonly src: Schema.String;
+                readonly mimeType: Schema.optionalKey<Schema.String>;
+                readonly sizes: Schema.optionalKey<Schema.$Array<Schema.String>>;
+                readonly theme: Schema.optionalKey<Schema.Literals<readonly ["light", "dark"]>>;
+            }>>>;
         }>;
         readonly catalog: Schema.Struct<{
             readonly tools: Schema.$Array<Schema.Struct<{

package/types/apps/src/implementation/router-catalog.d.ts

@@ -190,15 +190,15 @@ export declare const readCatalog: (root: AppRouter | DynamicRouter | undefined,
         readonly description?: string;
         readonly error?: import("../index.js").ProviderError | import("../contracts/host.js").McpError | import("../contracts/host.js").SkillLoadFailed | HostDeclarationInvalid | HostEvaluationFailed;
         readonly title?: string;
-        readonly tags?: {
-            readonly [x: string]: string;
-        };
         readonly icons?: readonly {
             readonly src: string;
             readonly mimeType?: string;
             readonly sizes?: readonly string[];
             readonly theme?: "light" | "dark";
         }[];
+        readonly tags?: {
+            readonly [x: string]: string;
+        };
         readonly skill?: string;
     }[];
 }, import("../index.js").ProviderError | import("../contracts/host.js").McpError | import("../contracts/host.js").SkillLoadFailed | HostDeclarationInvalid | HostEvaluationFailed, never>;

package/types/apps/src/index.d.ts

@@ -27,6 +27,7 @@ export type { AccountRequest } from "./contracts/provider.js";
 export { accountRouter } from "./implementation/account-router.js";
 export { router, dynamicRouter, withApprovals, renameTools, type OperationChild, type OperationDeclaration, type RouterDeclaration, type RouterChild, type RouterOptions, } from "./implementation/router.js";
 export type { RouterIcon } from "./contracts/router.js";
+export type { AppIcon } from "./contracts/icons.js";
 export { dynamicSkills } from "./implementation/dynamic-skills.js";
 export type { HostedTool as OperationDescription } from "./contracts/host.js";
 /** Account fields as app code receives them from a method declared with this schema. */