@openwaggle/extension-sdk 0.0.0-bootstrap.0 → 0.1.0

package/dist/constants.d.ts

@@ -0,0 +1,183 @@
+export declare const OPENWAGGLE_EXTENSION_BROKER: {
+    readonly CAPABILITY: {
+        readonly HOST_CONTEXT: "openwaggle.host.context";
+        readonly STORAGE: "openwaggle.storage";
+        readonly STATE: "openwaggle.state";
+        readonly ACTIONS: "openwaggle.actions";
+        readonly SETTINGS: "openwaggle.settings";
+        readonly DOCS: "openwaggle.docs";
+        readonly RUNTIME: "openwaggle.runtime";
+    };
+    readonly CAPABILITIES: readonly ("openwaggle.host.context" | "openwaggle.storage" | "openwaggle.state" | "openwaggle.actions" | "openwaggle.settings" | "openwaggle.docs" | "openwaggle.runtime")[];
+    readonly CAPABILITY_METHODS: readonly [{
+        readonly capability: "openwaggle.host.context";
+        readonly methods: readonly ["get-scope"];
+    }, {
+        readonly capability: "openwaggle.storage";
+        readonly methods: readonly ["get", "set", "delete", "list"];
+    }, {
+        readonly capability: "openwaggle.state";
+        readonly methods: readonly ["get-state", "read-state"];
+    }, {
+        readonly capability: "openwaggle.actions";
+        readonly methods: readonly ["select-project"];
+    }, {
+        readonly capability: "openwaggle.settings";
+        readonly methods: readonly ["get-settings", "update-settings", "get-setting", "update-setting"];
+    }, {
+        readonly capability: "openwaggle.docs";
+        readonly methods: readonly ["discover-docs", "resolve-docs-topic"];
+    }, {
+        readonly capability: "openwaggle.runtime";
+        readonly methods: readonly ["register-contribution", "unregister-contribution"];
+    }];
+    readonly METHOD: {
+        readonly GET_SCOPE: "get-scope";
+        readonly GET: "get";
+        readonly SET: "set";
+        readonly DELETE: "delete";
+        readonly LIST: "list";
+        readonly GET_STATE: "get-state";
+        readonly READ_STATE: "read-state";
+        readonly SELECT_PROJECT: "select-project";
+        readonly GET_SETTINGS: "get-settings";
+        readonly UPDATE_SETTINGS: "update-settings";
+        readonly GET_SETTING: "get-setting";
+        readonly UPDATE_SETTING: "update-setting";
+        readonly DISCOVER_DOCS: "discover-docs";
+        readonly RESOLVE_DOCS_TOPIC: "resolve-docs-topic";
+        readonly REGISTER_CONTRIBUTION: "register-contribution";
+        readonly UNREGISTER_CONTRIBUTION: "unregister-contribution";
+    };
+    readonly METHODS: readonly ("get-scope" | "get" | "set" | "delete" | "list" | "get-state" | "read-state" | "select-project" | "get-settings" | "update-settings" | "get-setting" | "update-setting" | "discover-docs" | "resolve-docs-topic" | "register-contribution" | "unregister-contribution")[];
+    readonly FAILURE_CODE: {
+        readonly INVALID_INPUT: "invalid-input";
+        readonly INVALID_PAYLOAD: "invalid-payload";
+        readonly UNKNOWN_EXTENSION: "unknown-extension";
+        readonly DISABLED_EXTENSION: "disabled-extension";
+        readonly UNKNOWN_CONTRIBUTION: "unknown-contribution";
+        readonly UNDECLARED_CAPABILITY: "undeclared-capability";
+        readonly UNDECLARED_METHOD: "undeclared-method";
+        readonly UNDECLARED_SCOPE: "undeclared-scope";
+        readonly OUT_OF_SCOPE: "out-of-scope";
+        readonly UNSUPPORTED_CAPABILITY: "unsupported-capability";
+        readonly UNSUPPORTED_METHOD: "unsupported-method";
+        readonly TRANSPORT_FAILED: "transport-failed";
+    };
+    readonly FAILURE_CODES: readonly ("invalid-input" | "invalid-payload" | "unknown-extension" | "disabled-extension" | "unknown-contribution" | "undeclared-capability" | "undeclared-method" | "undeclared-scope" | "out-of-scope" | "unsupported-capability" | "unsupported-method" | "transport-failed")[];
+    readonly OUTCOME: {
+        readonly SUCCEEDED: "succeeded";
+        readonly REJECTED: "rejected";
+    };
+    readonly OUTCOMES: readonly ("succeeded" | "rejected")[];
+    readonly STATE_SELECTOR: {
+        readonly CURRENT_PROJECT: "current-project";
+        readonly CURRENT_SESSION: "current-session";
+        readonly CURRENT_BRANCH: "current-branch";
+        readonly RECENT_PROJECTS: "recent-projects";
+        readonly MODEL_PREFERENCES: "model-preferences";
+    };
+    readonly STATE_SELECTORS: readonly ("current-project" | "current-session" | "current-branch" | "recent-projects" | "model-preferences")[];
+    readonly SETTING_KEY: {
+        readonly MODEL_PREFERENCES: "model-preferences";
+        readonly PROJECT_DISPLAY_NAME: "project-display-name";
+    };
+    readonly SETTING_KEYS: readonly ("model-preferences" | "project-display-name")[];
+};
+export declare const OPENWAGGLE_EXTENSION: {
+    readonly MANIFEST_FILE: "openwaggle.extension.json";
+    readonly SDK_VERSION: "0.1.0";
+    readonly PROJECT_ROOT_SEGMENTS: readonly [".openwaggle", "extensions"];
+    readonly GLOBAL_EXTENSIONS_DIR: "extensions";
+    readonly SCOPE: {
+        readonly GLOBAL_KIND: "global";
+        readonly PROJECT_KIND: "project";
+        readonly GLOBAL_ID: "global";
+    };
+    readonly LIMITS: {
+        readonly ID_MAX_LENGTH: 96;
+        readonly CONTRIBUTION_ID_MAX_LENGTH: 128;
+        readonly NAME_MAX_LENGTH: 120;
+        readonly DESCRIPTION_MAX_LENGTH: 2000;
+        readonly RELATIVE_PATH_MAX_LENGTH: 260;
+        readonly NETWORK_ORIGIN_MAX_LENGTH: 300;
+        readonly RUNTIME_REQUIREMENT_BINARY_MAX_LENGTH: 120;
+        readonly BUILD_COMMAND_MAX_LENGTH: 500;
+        readonly BUILD_LOG_MAX_LENGTH: 4000;
+        readonly BUILD_COMMAND_TIMEOUT_MS: number;
+    };
+    readonly PATTERNS: {
+        readonly WINDOWS_ABSOLUTE_PATH: RegExp;
+        readonly ID: RegExp;
+        readonly CONTRIBUTION_ID: RegExp;
+        readonly SEMVER_VERSION: RegExp;
+    };
+    readonly PATH: {
+        readonly NUL_CHARACTER: "\0";
+        readonly POSIX_SEPARATOR: "/";
+        readonly WINDOWS_SEPARATOR: "\\";
+        readonly RELATIVE_PARENT_SEGMENT: "..";
+        readonly CURRENT_DIRECTORY_SEGMENT: ".";
+    };
+    readonly RUNTIME_MODULE_PROTOCOL: {
+        readonly MODULE_CONTEXT_SEGMENT: "__context__";
+    };
+    readonly CAPABILITY_SCOPES: readonly ["app", "project", "session", "branch"];
+    readonly CONTRIBUTION_FAMILY: {
+        readonly COMMANDS: "commands";
+        readonly SLASH_COMMANDS: "slashCommands";
+        readonly ROUTES: "routes";
+        readonly SETTINGS_SECTIONS: "settingsSections";
+        readonly SIDE_PANELS: "sidePanels";
+        readonly DIALOGS: "dialogs";
+        readonly TRANSCRIPT_RENDERERS: "transcriptRenderers";
+        readonly TOOL_RENDERERS: "toolRenderers";
+        readonly CUSTOM_MESSAGE_RENDERERS: "customMessageRenderers";
+        readonly INTERACTION_RENDERERS: "interactionRenderers";
+        readonly STATUS_WIDGETS: "statusWidgets";
+    };
+    readonly CONTRIBUTION_FAMILIES: readonly ["commands", "slashCommands", "routes", "settingsSections", "sidePanels", "dialogs", "transcriptRenderers", "toolRenderers", "customMessageRenderers", "interactionRenderers", "statusWidgets"];
+    readonly COMMAND_CONTRIBUTION_FAMILIES: readonly ["commands", "slashCommands"];
+    readonly CONTRIBUTION_RUNTIME: {
+        readonly FEDERATED_MODULE: "federated-module";
+        readonly TRUSTED_RENDERER: "trusted-renderer";
+    };
+    readonly CONTRIBUTION_RUNTIMES: readonly ("federated-module" | "trusted-renderer")[];
+    readonly EXECUTION_PLACEMENT: {
+        readonly HOST_RENDERER: "host-renderer";
+        readonly FRAME: "frame";
+    };
+    readonly EXECUTION_PLACEMENTS: readonly ("host-renderer" | "frame")[];
+    readonly STORAGE: {
+        readonly KIND: {
+            readonly STATE: "state";
+            readonly CONFIG: "config";
+        };
+        readonly KINDS: readonly ("state" | "config")[];
+        readonly SCOPE: {
+            readonly GLOBAL_KIND: "global";
+            readonly PROJECT_KIND: "project";
+            readonly GLOBAL_ID: "global";
+        };
+        readonly SCOPE_KINDS: readonly ("global" | "project")[];
+        readonly KEY_MAX_LENGTH: 160;
+    };
+    readonly ENTRY_CONTRIBUTION_FAMILIES: readonly ["routes", "settingsSections", "sidePanels", "dialogs", "transcriptRenderers", "toolRenderers", "customMessageRenderers", "interactionRenderers", "statusWidgets"];
+    readonly SLOT_CONTRIBUTION_FAMILIES: readonly ["settingsSections", "sidePanels", "dialogs", "transcriptRenderers", "toolRenderers", "customMessageRenderers", "interactionRenderers", "statusWidgets"];
+    readonly INSTALL_SOURCE: {
+        readonly PREBUILT: "prebuilt";
+        readonly LOCAL_BUILD: "local-build";
+    };
+    readonly INSTALL_SOURCES: readonly ("prebuilt" | "local-build")[];
+    readonly RUNTIME_REQUIREMENT_TYPE: {
+        readonly BINARY: "binary";
+        readonly COMMAND: "command";
+    };
+    readonly RUNTIME_REQUIREMENT_TYPES: readonly ("binary" | "command")[];
+    readonly NETWORK_ACCESS_MODE: {
+        readonly BROKERED: "brokered";
+        readonly RESTRICTED: "restricted";
+        readonly DIRECT: "direct";
+    };
+    readonly NETWORK_ACCESS_MODES: readonly ("brokered" | "restricted" | "direct")[];
+};

package/dist/constants.js

@@ -0,0 +1,245 @@
+const TEN_MINUTES_MS = 10 * 60 * 1_000;
+const EXTENSION_BROKER_FAILURE_CODE = {
+    INVALID_INPUT: 'invalid-input',
+    INVALID_PAYLOAD: 'invalid-payload',
+    UNKNOWN_EXTENSION: 'unknown-extension',
+    DISABLED_EXTENSION: 'disabled-extension',
+    UNKNOWN_CONTRIBUTION: 'unknown-contribution',
+    UNDECLARED_CAPABILITY: 'undeclared-capability',
+    UNDECLARED_METHOD: 'undeclared-method',
+    UNDECLARED_SCOPE: 'undeclared-scope',
+    OUT_OF_SCOPE: 'out-of-scope',
+    UNSUPPORTED_CAPABILITY: 'unsupported-capability',
+    UNSUPPORTED_METHOD: 'unsupported-method',
+    TRANSPORT_FAILED: 'transport-failed',
+};
+const EXTENSION_BROKER_OUTCOME = {
+    SUCCEEDED: 'succeeded',
+    REJECTED: 'rejected',
+};
+const EXTENSION_BROKER_CAPABILITY = {
+    HOST_CONTEXT: 'openwaggle.host.context',
+    STORAGE: 'openwaggle.storage',
+    STATE: 'openwaggle.state',
+    ACTIONS: 'openwaggle.actions',
+    SETTINGS: 'openwaggle.settings',
+    DOCS: 'openwaggle.docs',
+    RUNTIME: 'openwaggle.runtime',
+};
+const EXTENSION_BROKER_METHOD = {
+    GET_SCOPE: 'get-scope',
+    GET: 'get',
+    SET: 'set',
+    DELETE: 'delete',
+    LIST: 'list',
+    GET_STATE: 'get-state',
+    READ_STATE: 'read-state',
+    SELECT_PROJECT: 'select-project',
+    GET_SETTINGS: 'get-settings',
+    UPDATE_SETTINGS: 'update-settings',
+    GET_SETTING: 'get-setting',
+    UPDATE_SETTING: 'update-setting',
+    DISCOVER_DOCS: 'discover-docs',
+    RESOLVE_DOCS_TOPIC: 'resolve-docs-topic',
+    REGISTER_CONTRIBUTION: 'register-contribution',
+    UNREGISTER_CONTRIBUTION: 'unregister-contribution',
+};
+const EXTENSION_BROKER_STATE_SELECTOR = {
+    CURRENT_PROJECT: 'current-project',
+    CURRENT_SESSION: 'current-session',
+    CURRENT_BRANCH: 'current-branch',
+    RECENT_PROJECTS: 'recent-projects',
+    MODEL_PREFERENCES: 'model-preferences',
+};
+const EXTENSION_BROKER_SETTING_KEY = {
+    MODEL_PREFERENCES: 'model-preferences',
+    PROJECT_DISPLAY_NAME: 'project-display-name',
+};
+const EXTENSION_BROKER_CAPABILITY_METHODS = [
+    {
+        capability: EXTENSION_BROKER_CAPABILITY.HOST_CONTEXT,
+        methods: [EXTENSION_BROKER_METHOD.GET_SCOPE],
+    },
+    {
+        capability: EXTENSION_BROKER_CAPABILITY.STORAGE,
+        methods: [
+            EXTENSION_BROKER_METHOD.GET,
+            EXTENSION_BROKER_METHOD.SET,
+            EXTENSION_BROKER_METHOD.DELETE,
+            EXTENSION_BROKER_METHOD.LIST,
+        ],
+    },
+    {
+        capability: EXTENSION_BROKER_CAPABILITY.STATE,
+        methods: [EXTENSION_BROKER_METHOD.GET_STATE, EXTENSION_BROKER_METHOD.READ_STATE],
+    },
+    {
+        capability: EXTENSION_BROKER_CAPABILITY.ACTIONS,
+        methods: [EXTENSION_BROKER_METHOD.SELECT_PROJECT],
+    },
+    {
+        capability: EXTENSION_BROKER_CAPABILITY.SETTINGS,
+        methods: [
+            EXTENSION_BROKER_METHOD.GET_SETTINGS,
+            EXTENSION_BROKER_METHOD.UPDATE_SETTINGS,
+            EXTENSION_BROKER_METHOD.GET_SETTING,
+            EXTENSION_BROKER_METHOD.UPDATE_SETTING,
+        ],
+    },
+    {
+        capability: EXTENSION_BROKER_CAPABILITY.DOCS,
+        methods: [EXTENSION_BROKER_METHOD.DISCOVER_DOCS, EXTENSION_BROKER_METHOD.RESOLVE_DOCS_TOPIC],
+    },
+    {
+        capability: EXTENSION_BROKER_CAPABILITY.RUNTIME,
+        methods: [
+            EXTENSION_BROKER_METHOD.REGISTER_CONTRIBUTION,
+            EXTENSION_BROKER_METHOD.UNREGISTER_CONTRIBUTION,
+        ],
+    },
+];
+const EXTENSION_CONTRIBUTION_FAMILY = {
+    COMMANDS: 'commands',
+    SLASH_COMMANDS: 'slashCommands',
+    ROUTES: 'routes',
+    SETTINGS_SECTIONS: 'settingsSections',
+    SIDE_PANELS: 'sidePanels',
+    DIALOGS: 'dialogs',
+    TRANSCRIPT_RENDERERS: 'transcriptRenderers',
+    TOOL_RENDERERS: 'toolRenderers',
+    CUSTOM_MESSAGE_RENDERERS: 'customMessageRenderers',
+    INTERACTION_RENDERERS: 'interactionRenderers',
+    STATUS_WIDGETS: 'statusWidgets',
+};
+const EXTENSION_COMMAND_CONTRIBUTION_FAMILIES = Object.freeze([
+    EXTENSION_CONTRIBUTION_FAMILY.COMMANDS,
+    EXTENSION_CONTRIBUTION_FAMILY.SLASH_COMMANDS,
+]);
+const EXTENSION_SLOT_CONTRIBUTION_FAMILIES = Object.freeze([
+    EXTENSION_CONTRIBUTION_FAMILY.SETTINGS_SECTIONS,
+    EXTENSION_CONTRIBUTION_FAMILY.SIDE_PANELS,
+    EXTENSION_CONTRIBUTION_FAMILY.DIALOGS,
+    EXTENSION_CONTRIBUTION_FAMILY.TRANSCRIPT_RENDERERS,
+    EXTENSION_CONTRIBUTION_FAMILY.TOOL_RENDERERS,
+    EXTENSION_CONTRIBUTION_FAMILY.CUSTOM_MESSAGE_RENDERERS,
+    EXTENSION_CONTRIBUTION_FAMILY.INTERACTION_RENDERERS,
+    EXTENSION_CONTRIBUTION_FAMILY.STATUS_WIDGETS,
+]);
+const EXTENSION_ENTRY_CONTRIBUTION_FAMILIES = Object.freeze([
+    EXTENSION_CONTRIBUTION_FAMILY.ROUTES,
+    ...EXTENSION_SLOT_CONTRIBUTION_FAMILIES,
+]);
+const EXTENSION_CONTRIBUTION_FAMILIES = Object.freeze([
+    ...EXTENSION_COMMAND_CONTRIBUTION_FAMILIES,
+    ...EXTENSION_ENTRY_CONTRIBUTION_FAMILIES,
+]);
+const EXTENSION_CONTRIBUTION_RUNTIME = {
+    FEDERATED_MODULE: 'federated-module',
+    TRUSTED_RENDERER: 'trusted-renderer',
+};
+const EXTENSION_EXECUTION_PLACEMENT = {
+    HOST_RENDERER: 'host-renderer',
+    FRAME: 'frame',
+};
+const EXTENSION_STORAGE_KIND = {
+    STATE: 'state',
+    CONFIG: 'config',
+};
+const EXTENSION_STORAGE_SCOPE = {
+    GLOBAL_KIND: 'global',
+    PROJECT_KIND: 'project',
+    GLOBAL_ID: 'global',
+};
+const EXTENSION_INSTALL_SOURCE = {
+    PREBUILT: 'prebuilt',
+    LOCAL_BUILD: 'local-build',
+};
+const EXTENSION_RUNTIME_REQUIREMENT_TYPE = {
+    BINARY: 'binary',
+    COMMAND: 'command',
+};
+const EXTENSION_NETWORK_ACCESS_MODE = {
+    BROKERED: 'brokered',
+    RESTRICTED: 'restricted',
+    DIRECT: 'direct',
+};
+export const OPENWAGGLE_EXTENSION_BROKER = {
+    CAPABILITY: EXTENSION_BROKER_CAPABILITY,
+    CAPABILITIES: Object.freeze(Object.values(EXTENSION_BROKER_CAPABILITY)),
+    CAPABILITY_METHODS: EXTENSION_BROKER_CAPABILITY_METHODS,
+    METHOD: EXTENSION_BROKER_METHOD,
+    METHODS: Object.freeze(Object.values(EXTENSION_BROKER_METHOD)),
+    FAILURE_CODE: EXTENSION_BROKER_FAILURE_CODE,
+    FAILURE_CODES: Object.freeze(Object.values(EXTENSION_BROKER_FAILURE_CODE)),
+    OUTCOME: EXTENSION_BROKER_OUTCOME,
+    OUTCOMES: Object.freeze(Object.values(EXTENSION_BROKER_OUTCOME)),
+    STATE_SELECTOR: EXTENSION_BROKER_STATE_SELECTOR,
+    STATE_SELECTORS: Object.freeze(Object.values(EXTENSION_BROKER_STATE_SELECTOR)),
+    SETTING_KEY: EXTENSION_BROKER_SETTING_KEY,
+    SETTING_KEYS: Object.freeze(Object.values(EXTENSION_BROKER_SETTING_KEY)),
+};
+export const OPENWAGGLE_EXTENSION = {
+    MANIFEST_FILE: 'openwaggle.extension.json',
+    SDK_VERSION: '0.1.0',
+    PROJECT_ROOT_SEGMENTS: ['.openwaggle', 'extensions'],
+    GLOBAL_EXTENSIONS_DIR: 'extensions',
+    SCOPE: {
+        GLOBAL_KIND: 'global',
+        PROJECT_KIND: 'project',
+        GLOBAL_ID: 'global',
+    },
+    LIMITS: {
+        ID_MAX_LENGTH: 96,
+        CONTRIBUTION_ID_MAX_LENGTH: 128,
+        NAME_MAX_LENGTH: 120,
+        DESCRIPTION_MAX_LENGTH: 2_000,
+        RELATIVE_PATH_MAX_LENGTH: 260,
+        NETWORK_ORIGIN_MAX_LENGTH: 300,
+        RUNTIME_REQUIREMENT_BINARY_MAX_LENGTH: 120,
+        BUILD_COMMAND_MAX_LENGTH: 500,
+        BUILD_LOG_MAX_LENGTH: 4_000,
+        BUILD_COMMAND_TIMEOUT_MS: TEN_MINUTES_MS,
+    },
+    PATTERNS: {
+        WINDOWS_ABSOLUTE_PATH: /^[A-Za-z]:[\\/]/,
+        ID: /^[a-z0-9][a-z0-9._-]*$/,
+        CONTRIBUTION_ID: /^[a-z0-9][a-z0-9._/-]*$/,
+        SEMVER_VERSION: /^(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)(?:-[0-9A-Za-z.-]+)?(?:\+[0-9A-Za-z.-]+)?$/,
+    },
+    PATH: {
+        NUL_CHARACTER: '\0',
+        POSIX_SEPARATOR: '/',
+        WINDOWS_SEPARATOR: '\\',
+        RELATIVE_PARENT_SEGMENT: '..',
+        CURRENT_DIRECTORY_SEGMENT: '.',
+    },
+    RUNTIME_MODULE_PROTOCOL: {
+        MODULE_CONTEXT_SEGMENT: '__context__',
+    },
+    CAPABILITY_SCOPES: ['app', 'project', 'session', 'branch'],
+    CONTRIBUTION_FAMILY: EXTENSION_CONTRIBUTION_FAMILY,
+    CONTRIBUTION_FAMILIES: EXTENSION_CONTRIBUTION_FAMILIES,
+    COMMAND_CONTRIBUTION_FAMILIES: EXTENSION_COMMAND_CONTRIBUTION_FAMILIES,
+    CONTRIBUTION_RUNTIME: EXTENSION_CONTRIBUTION_RUNTIME,
+    CONTRIBUTION_RUNTIMES: Object.freeze(Object.values(EXTENSION_CONTRIBUTION_RUNTIME)),
+    EXECUTION_PLACEMENT: EXTENSION_EXECUTION_PLACEMENT,
+    EXECUTION_PLACEMENTS: Object.freeze(Object.values(EXTENSION_EXECUTION_PLACEMENT)),
+    STORAGE: {
+        KIND: EXTENSION_STORAGE_KIND,
+        KINDS: Object.freeze(Object.values(EXTENSION_STORAGE_KIND)),
+        SCOPE: EXTENSION_STORAGE_SCOPE,
+        SCOPE_KINDS: Object.freeze([
+            EXTENSION_STORAGE_SCOPE.GLOBAL_KIND,
+            EXTENSION_STORAGE_SCOPE.PROJECT_KIND,
+        ]),
+        KEY_MAX_LENGTH: 160,
+    },
+    ENTRY_CONTRIBUTION_FAMILIES: EXTENSION_ENTRY_CONTRIBUTION_FAMILIES,
+    SLOT_CONTRIBUTION_FAMILIES: EXTENSION_SLOT_CONTRIBUTION_FAMILIES,
+    INSTALL_SOURCE: EXTENSION_INSTALL_SOURCE,
+    INSTALL_SOURCES: Object.freeze(Object.values(EXTENSION_INSTALL_SOURCE)),
+    RUNTIME_REQUIREMENT_TYPE: EXTENSION_RUNTIME_REQUIREMENT_TYPE,
+    RUNTIME_REQUIREMENT_TYPES: Object.freeze(Object.values(EXTENSION_RUNTIME_REQUIREMENT_TYPE)),
+    NETWORK_ACCESS_MODE: EXTENSION_NETWORK_ACCESS_MODE,
+    NETWORK_ACCESS_MODES: Object.freeze(Object.values(EXTENSION_NETWORK_ACCESS_MODE)),
+};

package/dist/context.d.ts

@@ -0,0 +1,66 @@
+import type { ExtensionBrokerSdk } from './broker.js';
+import type { JsonValue } from './json.js';
+import { createOpenWaggleExtensionTheme, extensionThemeCssVariableEntries, type OpenWaggleExtensionTheme } from './theme.js';
+import type { ExtensionContributionRegistryEntry } from './types.js';
+import { createOpenWaggleExtensionUiStylesheet, OPENWAGGLE_EXTENSION_UI_ATTRIBUTES, OPENWAGGLE_EXTENSION_UI_CLASS_NAMES, openWaggleExtensionClassName } from './ui.js';
+export interface OpenWaggleExtensionSurfaceContext {
+    readonly extension: {
+        readonly id: string;
+        readonly name: string;
+        readonly version: string;
+    };
+    readonly contribution: {
+        readonly id: string;
+        readonly title: string;
+        readonly family: string;
+    };
+    readonly surface: {
+        readonly family: string;
+        readonly execution: string;
+        readonly payload?: JsonValue;
+    };
+    readonly packagePath: string;
+    readonly projectPaths: readonly string[];
+    readonly theme: OpenWaggleExtensionTheme;
+}
+export interface OpenWaggleExtensionSurfaceSdk {
+    readonly sendAction: (actionId: string, payload?: JsonValue) => Promise<void>;
+    readonly respondInteraction: (value: JsonValue | null) => Promise<void>;
+}
+export type OpenWaggleExtensionSdk = ExtensionBrokerSdk & {
+    readonly surface: OpenWaggleExtensionSurfaceSdk;
+};
+export interface OpenWaggleExtensionSharedModules {
+    readonly sdk: {
+        readonly openWaggleVersion: string;
+    };
+    readonly theme: {
+        readonly current: OpenWaggleExtensionTheme;
+        readonly createTheme: typeof createOpenWaggleExtensionTheme;
+        readonly cssVariableEntries: typeof extensionThemeCssVariableEntries;
+    };
+    readonly ui: {
+        readonly classNames: typeof OPENWAGGLE_EXTENSION_UI_CLASS_NAMES;
+        readonly attributes: typeof OPENWAGGLE_EXTENSION_UI_ATTRIBUTES;
+        readonly className: typeof openWaggleExtensionClassName;
+        readonly createStylesheet: typeof createOpenWaggleExtensionUiStylesheet;
+    };
+}
+export interface OpenWaggleExtensionMountContext extends OpenWaggleExtensionSurfaceContext {
+    readonly root: HTMLElement;
+    readonly sdk: OpenWaggleExtensionSdk;
+    readonly modules: OpenWaggleExtensionSharedModules;
+}
+export type OpenWaggleExtensionMountCleanup = () => void;
+export type OpenWaggleExtensionMountResult = undefined | OpenWaggleExtensionMountCleanup;
+export interface OpenWaggleFederatedModule {
+    readonly mount: (context: OpenWaggleExtensionMountContext) => OpenWaggleExtensionMountResult | Promise<OpenWaggleExtensionMountResult>;
+}
+export interface CreateOpenWaggleExtensionSurfaceContextInput {
+    readonly entry: ExtensionContributionRegistryEntry;
+    readonly surfacePayload?: JsonValue;
+    readonly theme?: OpenWaggleExtensionTheme;
+}
+export declare function createNoopExtensionSurfaceSdk(): OpenWaggleExtensionSurfaceSdk;
+export declare function createOpenWaggleExtensionSharedModules(theme?: OpenWaggleExtensionTheme): OpenWaggleExtensionSharedModules;
+export declare function createOpenWaggleExtensionSurfaceContext(input: CreateOpenWaggleExtensionSurfaceContextInput): OpenWaggleExtensionSurfaceContext;

package/dist/context.js

@@ -0,0 +1,49 @@
+import { OPENWAGGLE_EXTENSION } from './constants.js';
+import { createOpenWaggleExtensionTheme, extensionThemeCssVariableEntries, } from './theme.js';
+import { createOpenWaggleExtensionUiStylesheet, OPENWAGGLE_EXTENSION_UI_ATTRIBUTES, OPENWAGGLE_EXTENSION_UI_CLASS_NAMES, openWaggleExtensionClassName, } from './ui.js';
+export function createNoopExtensionSurfaceSdk() {
+    return {
+        sendAction: async () => undefined,
+        respondInteraction: async () => undefined,
+    };
+}
+export function createOpenWaggleExtensionSharedModules(theme = createOpenWaggleExtensionTheme()) {
+    return {
+        sdk: {
+            openWaggleVersion: OPENWAGGLE_EXTENSION.SDK_VERSION,
+        },
+        theme: {
+            current: theme,
+            createTheme: createOpenWaggleExtensionTheme,
+            cssVariableEntries: extensionThemeCssVariableEntries,
+        },
+        ui: {
+            classNames: OPENWAGGLE_EXTENSION_UI_CLASS_NAMES,
+            attributes: OPENWAGGLE_EXTENSION_UI_ATTRIBUTES,
+            className: openWaggleExtensionClassName,
+            createStylesheet: createOpenWaggleExtensionUiStylesheet,
+        },
+    };
+}
+export function createOpenWaggleExtensionSurfaceContext(input) {
+    return {
+        extension: {
+            id: input.entry.extensionId,
+            name: input.entry.extensionName,
+            version: input.entry.extensionVersion,
+        },
+        contribution: {
+            id: input.entry.contributionId,
+            title: input.entry.title,
+            family: input.entry.family,
+        },
+        surface: {
+            family: input.entry.family,
+            execution: input.entry.execution ?? '',
+            ...(input.surfacePayload !== undefined ? { payload: input.surfacePayload } : {}),
+        },
+        packagePath: input.entry.packagePath,
+        projectPaths: input.entry.projectPaths,
+        theme: input.theme ?? createOpenWaggleExtensionTheme(),
+    };
+}

package/dist/contribution-types.d.ts

@@ -0,0 +1,21 @@
+import type { OPENWAGGLE_EXTENSION } from './constants.js';
+import type { ExtensionContributionRegistration as ManifestContributionRegistration, ExtensionContributionUnregistration as ManifestContributionUnregistration } from './manifest.js';
+type ConstantValue<TObject> = TObject[keyof TObject];
+export type ExtensionCapabilityScope = (typeof OPENWAGGLE_EXTENSION.CAPABILITY_SCOPES)[number];
+export type ExtensionContributionFamily = ConstantValue<typeof OPENWAGGLE_EXTENSION.CONTRIBUTION_FAMILY>;
+export type ExtensionContributionRuntime = ConstantValue<typeof OPENWAGGLE_EXTENSION.CONTRIBUTION_RUNTIME>;
+export type ExtensionExecutionPlacement = ConstantValue<typeof OPENWAGGLE_EXTENSION.EXECUTION_PLACEMENT>;
+export type ExtensionInstallSource = ConstantValue<typeof OPENWAGGLE_EXTENSION.INSTALL_SOURCE>;
+export type ExtensionNetworkAccessMode = ConstantValue<typeof OPENWAGGLE_EXTENSION.NETWORK_ACCESS_MODE>;
+export interface ExtensionContributionTargetView {
+    readonly projectPaths?: readonly string[];
+    readonly sessionIds?: readonly string[];
+}
+export interface ExtensionContributionMatchView {
+    readonly toolNames?: readonly string[];
+    readonly customMessageNames?: readonly string[];
+    readonly interactionKinds?: readonly string[];
+}
+export type ExtensionRuntimeRegisterContributionPayload = ManifestContributionRegistration;
+export type ExtensionRuntimeUnregisterContributionPayload = ManifestContributionUnregistration;
+export {};

package/dist/contribution-types.js

@@ -0,0 +1 @@
+export {};

package/dist/core-types.d.ts

@@ -0,0 +1,58 @@
+import type { OPENWAGGLE_EXTENSION_BROKER } from './constants.js';
+type ConstantValue<TObject> = TObject[keyof TObject];
+export type ExtensionBrokerCapability = ConstantValue<typeof OPENWAGGLE_EXTENSION_BROKER.CAPABILITY>;
+export type ExtensionBrokerMethod = ConstantValue<typeof OPENWAGGLE_EXTENSION_BROKER.METHOD>;
+export type ExtensionInvokeFailureCode = ConstantValue<typeof OPENWAGGLE_EXTENSION_BROKER.FAILURE_CODE>;
+export type ExtensionInvokeOutcome = ConstantValue<typeof OPENWAGGLE_EXTENSION_BROKER.OUTCOME>;
+export type ExtensionStateSelector = ConstantValue<typeof OPENWAGGLE_EXTENSION_BROKER.STATE_SELECTOR>;
+export type ExtensionSettingsKey = ConstantValue<typeof OPENWAGGLE_EXTENSION_BROKER.SETTING_KEY>;
+export type ExtensionInvokeScope = {
+    readonly kind: 'app';
+} | {
+    readonly kind: 'project';
+    readonly projectPath: string;
+} | {
+    readonly kind: 'session';
+    readonly projectPath: string;
+    readonly sessionId: string;
+} | {
+    readonly kind: 'branch';
+    readonly projectPath: string;
+    readonly sessionId: string;
+    readonly branchId: string;
+};
+export interface ExtensionCapabilityAuditEntry {
+    readonly extensionId: string;
+    readonly contributionId: string;
+    readonly capability: string;
+    readonly method: string;
+    readonly scope: ExtensionInvokeScope;
+    readonly outcome: ExtensionInvokeOutcome;
+    readonly timestamp: number;
+    readonly failureCode?: ExtensionInvokeFailureCode;
+}
+export interface ExtensionInvokeInput {
+    readonly extensionId: string;
+    readonly contributionId: string;
+    readonly capability: string;
+    readonly method: string;
+    readonly scope: ExtensionInvokeScope;
+    readonly payload?: unknown;
+}
+export interface ExtensionInvokeError {
+    readonly code: ExtensionInvokeFailureCode;
+    readonly message: string;
+    readonly issues?: readonly string[];
+}
+export interface ExtensionInvokeSuccess<TValue = unknown> {
+    readonly ok: true;
+    readonly value: TValue;
+    readonly audit: ExtensionCapabilityAuditEntry;
+}
+export interface ExtensionInvokeFailure {
+    readonly ok: false;
+    readonly error: ExtensionInvokeError;
+    readonly audit?: ExtensionCapabilityAuditEntry;
+}
+export type ExtensionInvokeResult<TValue = unknown> = ExtensionInvokeSuccess<TValue> | ExtensionInvokeFailure;
+export {};

package/dist/core-types.js

@@ -0,0 +1 @@
+export {};

package/dist/docs-validation.d.ts

@@ -0,0 +1,3 @@
+import type { ExtensionDocsDiscoverResult, ExtensionDocsResolveTopicResult } from './types.js';
+export declare function isDocsDiscoverResult(value: unknown): value is ExtensionDocsDiscoverResult;
+export declare function isDocsResolveTopicResult(value: unknown): value is ExtensionDocsResolveTopicResult;