@nanobpm/nano-ide-ext-types 1.2.0 → 1.4.0

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-export type ExtKind = "lang" | "app" | "example" | "theme";
+export type ExtKind = "lang" | "app" | "example" | "theme" | "trigger";
 export interface FileType {
     /** File extension including the dot, e.g. ".rs". */
     ext: string;
@@ -69,6 +69,125 @@ export interface ThemeSpec {
     /** Design-token name -> CSS colour. Unknown keys are ignored by the host. */
     tokens: Partial<Record<ThemeTokenKey, string>>;
 }
+/**
+ * IntelliSense data a lang pack ships for the console's Monaco editor. The
+ * console has a real language service only for TypeScript/JavaScript (Monaco's
+ * built-in TS worker); every other language gets tokenisation only. A pack can
+ * light up completion, hover, and signature help for its `monacoLang` by
+ * shipping this curated data — no in-browser language server required. The host
+ * registers one provider per `monacoLang` and feeds it every pack's entries.
+ */
+export interface LangIntellisense {
+    /** Monaco language id these entries apply to (e.g. "csharp", "rust"). */
+    monacoLang: string;
+    /** Extra characters that reopen the completion popup (e.g. ["."]). The word
+     * character set always triggers completion; add member-access dots etc. */
+    triggerCharacters?: string[];
+    /** Completion items offered in files of this language. */
+    completions?: CompletionSpec[];
+    /** Hover cards keyed by the exact symbol under the cursor. */
+    hovers?: HoverSpec[];
+    /** Signature-help entries shown while typing a call's arguments. */
+    signatures?: SignatureSpec[];
+}
+/**
+ * Monaco `CompletionItemKind` names a pack may use. The listed names are the
+ * commonly-emitted ones and exist only as authoring hints — the real authority
+ * is the host's kind→Monaco mapping, which renders any unknown value as
+ * `Value`. The union is intentionally open (`string & {}`) because the mapping
+ * lives in a separate repo (the console), so a closed set here can't be
+ * compile-time reconciled with it and would only drift; keeping it open means a
+ * new generator-emitted kind never breaks consumers of this package.
+ */
+export type CompletionKind = "keyword" | "snippet" | "function" | "method" | "constructor" | "class" | "struct" | "interface" | "enum" | "module" | "property" | "field" | "variable" | "constant" | "value" | (string & {});
+/** One completion item. `insertText` defaults to `label`. */
+export interface CompletionSpec {
+    /** Text shown in the completion list. */
+    label: string;
+    /** Icon/category. Defaults to "value" when omitted. */
+    kind?: CompletionKind;
+    /** Text inserted on accept. Defaults to `label`. */
+    insertText?: string;
+    /** When true, `insertText` is a Monaco snippet (`${1:name}` placeholders). */
+    snippet?: boolean;
+    /** Short right-aligned signature/type (e.g. the return type). */
+    detail?: string;
+    /** Markdown documentation shown in the details flyout. */
+    documentation?: string;
+}
+/** A hover card: shown when the pointer rests on `symbol`. */
+export interface HoverSpec {
+    /** Exact identifier that triggers this hover (whole-word match). */
+    symbol: string;
+    /** Markdown rendered in the hover card. */
+    contents: string;
+}
+/** One function/method signature surfaced by signature help. */
+export interface SignatureSpec {
+    /** Identifier that, when followed by `(`, triggers this help (e.g.
+     * "CreateProcessInstanceAsync"). */
+    trigger: string;
+    /** Full signature line shown in the popup. */
+    label: string;
+    /** Markdown documentation for the call. */
+    documentation?: string;
+    /** Ordered parameters; the active one is highlighted by comma position. */
+    parameters?: SignatureParam[];
+}
+/** One parameter within a {@link SignatureSpec}. */
+export interface SignatureParam {
+    /** Parameter label as it appears in the signature (e.g. "id: string"). */
+    label: string;
+    /** Markdown documentation for this parameter. */
+    documentation?: string;
+}
+/**
+ * One config field a pack surfaces in the console (read-only in the IDE config
+ * panel; for a trigger source, the fields a trigger of this `kind` renders).
+ */
+export interface ConfigField {
+    /** Stable key within the pack (the manifest trigger's `config[key]`). */
+    key: string;
+    /** Human-facing label. */
+    label: string;
+    /** What the field controls. */
+    description?: string;
+    /** Environment variable this field reads its current value from, if any. */
+    env?: string;
+    /** Documented default when unset. */
+    default?: string;
+}
+/**
+ * How a trigger source pack's events reach the runtime (ADR 0025 §6). Only
+ * `webhook` — the universal ingress the driver POSTs to — is honoured in v1;
+ * the field is forward-declared so a pack states its contract explicitly.
+ */
+export type SourceTransport = "webhook";
+/**
+ * One trigger source **kind** a `kind: "trigger"` pack contributes (ADR 0025
+ * §6). Registering a `kind` lets a manifest trigger use it and the
+ * console/validation recognise it. The pack's out-of-process `driver` (a
+ * Node/Deno process, ADR 0038/0036) emits events over the trigger ingress; the
+ * runtime owns the inbox/dispatch/retry — the pack only produces events.
+ */
+export interface TriggerSourceSpec {
+    /** The `type` string a manifest trigger uses (e.g. "mqtt", "imap"). */
+    kind: string;
+    /** Human label for the console source picker. */
+    displayName?: string;
+    /** How the runtime receives this source's events. Defaults to "webhook". */
+    transport?: SourceTransport;
+    /** Config fields the console renders for a trigger of this kind. */
+    configFields?: ConfigField[];
+    /**
+     * Pack-relative path to the out-of-process driver entrypoint (a Node/Deno
+     * `.ts`/`.js`/`.mjs` file). When present, the runtime auto-launches and
+     * supervises the driver while an App with a trigger of this `kind` runs
+     * (ADR 0025 phase 4): one child process per such trigger, restarted with
+     * backoff on crash, killed when the App stops. Absent = declaration-only.
+     */
+    driver?: string;
+}
 export interface ExtManifest {
     id: string;
     kind: ExtKind;
@@ -93,7 +212,15 @@ export interface ExtManifest {
     summary?: string;
     /** theme packs: the console colour themes this pack contributes. */
     themes?: ThemeSpec[];
+    /** lang packs: curated IntelliSense (completion/hover/signature) for the
+     * pack's languages, since the console has no in-browser language server for
+     * anything but TypeScript. One entry per `monacoLang`. */
+    intellisense?: LangIntellisense[];
     /** Built-in packs set this; published packs omit it. */
     builtin?: boolean;
+    /** trigger packs: the trigger source kinds this pack contributes (ADR 0025
+     * §6). Each entry registers a `type` a manifest trigger can use; the pack's
+     * out-of-process driver emits events over the trigger ingress. */
+    triggerSources?: TriggerSourceSpec[];
 }
 export declare const MANIFEST_FILE = "nano-ide.ext.json";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nanobpm/nano-ide-ext-types",
-  "version": "1.2.0",
+  "version": "1.4.0",
   "description": "TypeScript types for the nano-ide.ext.json extension manifest (ADR 0007).",
   "license": "Apache-2.0",
   "type": "module",