@dp-bohrium/widget-contracts 0.0.1

package/dist/generated-host-runtime-config.d.ts

@@ -0,0 +1,246 @@
+/** GENERATED FILE. Do not edit directly. */
+export type Identifier = string;
+export type Mode = ("preview" | "published");
+export type Timestamp = string;
+export type RuntimeOrigin = string;
+export type PositiveInteger = number;
+export type Digest = string;
+export type WidgetSdkVersion = string;
+export type EntryPath = string;
+export type WidgetSlotConfig = ({
+    type: "tool-result";
+    toolName: string;
+} | {
+    type: "file-preview";
+    /**
+     * @minItems 1
+     */
+    extensions: [string, ...(string)[]];
+} | {
+    type: "panel";
+    panelType: string;
+});
+/**
+ * @minItems 1
+ */
+export type Samples = [
+    {
+        id: string;
+        title: string;
+        request: string;
+    },
+    ...({
+        id: string;
+        title: string;
+        request: string;
+    })[]
+];
+export type GrantedCapability = ({
+    name: "files.list";
+    limits: {
+        pageSize: number;
+        callsPerMinute: number;
+    };
+} | {
+    name: "files.metadata";
+    limits: {
+        callsPerMinute: number;
+    };
+} | {
+    name: "files.read";
+    limits: {
+        bytesPerRequest: number;
+        bytesPerRun: number;
+        callsPerMinute: number;
+    };
+} | {
+    name: "events.read";
+    /**
+     * @minItems 1
+     * @maxItems 32
+     */
+    topics: [string, ...(string)[]];
+    limits: {
+        callsPerMinute: number;
+        pageSize: number;
+        minPollMs: number;
+    };
+} | {
+    name: "actions.invoke";
+    /**
+     * @minItems 1
+     * @maxItems 32
+     */
+    actions: [string, ...(string)[]];
+    limits: {
+        callsPerMinute: number;
+    };
+} | {
+    name: "network.fetch";
+    limits: WidgetNetworkLimits;
+} | GrantedPresentationCapability);
+export type GrantedCapabilities = GrantedCapability[];
+export type FallbackReason = ("not-authorized" | "not-approved" | "delisted-for-new-use" | "revoked" | "host-api-unsupported" | "preview-not-allowed");
+export interface WidgetHostRuntimeConfig {
+    schemaVersion: 1;
+    hostApiVersion: 1;
+    configId: Identifier;
+    runId: Identifier;
+    mode: Mode;
+    issuedAt: Timestamp;
+    expiresAt: Timestamp;
+    recheckAt: Timestamp;
+    securityProfile: "runtime-security-profile-v1";
+    resourceBudget: ResourceBudget;
+    runtime: RuntimeAuthority;
+    network: NetworkAuthority;
+    bindings: (LoadableBinding | FallbackBinding)[];
+}
+export interface ResourceBudget {
+    version: 1;
+    bundle: {
+        compressedBytes: number;
+        expandedBytes: number;
+        fileCount: number;
+        singleFileBytes: number;
+    };
+    bridge: {
+        messageBytes: number;
+        messagesPerSecond: number;
+        pendingRequests: number;
+    };
+    files: {
+        readBytesPerRequest: number;
+        readBytesPerRun: number;
+        callsPerMinute: number;
+        listPageSize: number;
+    };
+    timeouts: {
+        bundleLoadMs: number;
+        handshakeMs: number;
+        firstRenderMs: number;
+        updateMs: number;
+        capabilityMs: number;
+        disposeGraceMs: number;
+    };
+    concurrency: {
+        activeIframesPerPage: number;
+        activeIframesPerRun: number;
+        hiddenRecycleMs: number;
+    };
+    retry: {
+        maxAttempts: number;
+        initialDelayMs: number;
+        maxDelayMs: number;
+        totalMs: number;
+    };
+    failure: {
+        consecutiveFailures: number;
+        windowMs: number;
+    };
+}
+export interface RuntimeAuthority {
+    origin: RuntimeOrigin;
+    catalogRevision: string;
+}
+export interface NetworkAuthority {
+    mode: ("runtime-consent" | "unavailable");
+    policyVersion: string;
+    limits: WidgetNetworkLimits;
+}
+export interface WidgetNetworkLimits {
+    timeoutMs: PositiveInteger;
+    maxRedirects: PositiveInteger;
+    maxConcurrentRequests: PositiveInteger;
+    callsPerMinute: PositiveInteger;
+    requestHeaderBytes: PositiveInteger;
+    responseHeaderBytes: PositiveInteger;
+    requestBodyBytes: PositiveInteger;
+    responseBodyBytes: PositiveInteger;
+}
+export interface LoadableBinding {
+    status: "loadable";
+    bindingId: Identifier;
+    widgetId: Identifier;
+    widgetVersionId: Identifier;
+    digest: Digest;
+    manifest: WidgetManifest;
+    launch: Launch;
+    grantedCapabilities: GrantedCapabilities;
+}
+export interface WidgetManifest {
+    name: string;
+    description?: string;
+    widgetConfig: WidgetConfig;
+}
+export interface WidgetConfig {
+    schemaVersion: 1;
+    hostApiVersion: 1;
+    widgetSdkVersion: WidgetSdkVersion;
+    entry: EntryPath;
+    slot: WidgetSlotConfig;
+    requestedCapabilities?: RequestedCapabilities;
+    runtime?: RuntimeOptions;
+    samples: Samples;
+}
+export interface RequestedCapabilities {
+    files?: FilesCapabilityRequest;
+    events?: EventsCapabilityRequest;
+    actions?: ActionsCapabilityRequest;
+    network?: NetworkCapabilityRequest;
+    presentation?: RequestedPresentationCapability;
+}
+export interface FilesCapabilityRequest {
+    list?: boolean;
+    metadata?: boolean;
+    read?: boolean;
+}
+export interface EventsCapabilityRequest {
+    /**
+     * @minItems 1
+     * @maxItems 32
+     */
+    topics: [string, ...(string)[]];
+}
+export interface ActionsCapabilityRequest {
+    /**
+     * @minItems 1
+     * @maxItems 32
+     */
+    names: [string, ...(string)[]];
+}
+export interface NetworkCapabilityRequest {
+    fetch: true;
+}
+export interface RequestedPresentationCapability {
+    /**
+     * @minItems 1
+     * @maxItems 2
+     */
+    surfaces: [("floating" | "overlay")] | [("floating" | "overlay"), ("floating" | "overlay")];
+}
+export interface RuntimeOptions {
+    worker?: boolean;
+    webAssembly?: boolean;
+}
+export interface Launch {
+    url: string;
+    expiresAt: Timestamp;
+}
+export interface GrantedPresentationCapability {
+    name: "ui.presentation";
+    /**
+     * @minItems 1
+     * @maxItems 2
+     */
+    surfaces: [("floating" | "overlay")] | [("floating" | "overlay"), ("floating" | "overlay")];
+    requiresHostConfirmation: true;
+}
+export interface FallbackBinding {
+    status: "fallback";
+    bindingId: Identifier;
+    widgetId: Identifier;
+    widgetVersionId: Identifier;
+    slot: WidgetSlotConfig;
+    reason: FallbackReason;
+}

package/dist/generated-host-runtime-config.js

@@ -0,0 +1,3 @@
+/* eslint-disable */
+/** GENERATED FILE. Do not edit directly. */
+export {};

package/dist/generated-manifest.d.ts

@@ -0,0 +1,86 @@
+/** GENERATED FILE. Do not edit directly. */
+export type WidgetSdkVersion = string;
+export type EntryPath = string;
+export type WidgetSlotConfig = ({
+    type: "tool-result";
+    toolName: string;
+} | {
+    type: "file-preview";
+    /**
+     * @minItems 1
+     */
+    extensions: [string, ...(string)[]];
+} | {
+    type: "panel";
+    panelType: string;
+});
+/**
+ * @minItems 1
+ */
+export type Samples = [
+    {
+        id: string;
+        title: string;
+        request: string;
+    },
+    ...({
+        id: string;
+        title: string;
+        request: string;
+    })[]
+];
+export interface WidgetManifest {
+    name: string;
+    description?: string;
+    widgetConfig: WidgetConfig;
+}
+export interface WidgetConfig {
+    schemaVersion: 1;
+    hostApiVersion: 1;
+    widgetSdkVersion: WidgetSdkVersion;
+    entry: EntryPath;
+    slot: WidgetSlotConfig;
+    requestedCapabilities?: RequestedCapabilities;
+    runtime?: RuntimeOptions;
+    samples: Samples;
+}
+export interface RequestedCapabilities {
+    files?: FilesCapabilityRequest;
+    events?: EventsCapabilityRequest;
+    actions?: ActionsCapabilityRequest;
+    network?: NetworkCapabilityRequest;
+    presentation?: RequestedPresentationCapability;
+}
+export interface FilesCapabilityRequest {
+    list?: boolean;
+    metadata?: boolean;
+    read?: boolean;
+}
+export interface EventsCapabilityRequest {
+    /**
+     * @minItems 1
+     * @maxItems 32
+     */
+    topics: [string, ...(string)[]];
+}
+export interface ActionsCapabilityRequest {
+    /**
+     * @minItems 1
+     * @maxItems 32
+     */
+    names: [string, ...(string)[]];
+}
+export interface NetworkCapabilityRequest {
+    fetch: true;
+}
+export interface RequestedPresentationCapability {
+    /**
+     * @minItems 1
+     * @maxItems 2
+     */
+    surfaces: [("floating" | "overlay")] | [("floating" | "overlay"), ("floating" | "overlay")];
+}
+export interface RuntimeOptions {
+    worker?: boolean;
+    webAssembly?: boolean;
+}

package/dist/generated-manifest.js

@@ -0,0 +1,3 @@
+/* eslint-disable */
+/** GENERATED FILE. Do not edit directly. */
+export {};