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

package/dist/index.d.ts

@@ -48,7 +48,20 @@ export interface RunConfig {
 }
 export interface TemplateSpec {
     id: string;
+    /** Short human-facing title rendered on the New Project template card. */
     label: string;
+    /** One-line description rendered on the template card. Older packs instead
+     * cram "Title — description" into `label`; the console's template menu
+     * splits that on the em-dash as a fallback, but new packs should set this.
+     * Hosts that don't understand `description` render `label` alone, so if you
+     * must support such a host, keep the combined "Title — description" `label`
+     * (the em-dash split then keeps modern cards correct too). */
+    description?: string;
+    /** Language pack id this template's project uses, when it differs from what
+     * the pack implies (lang packs → the pack id; app/example packs →
+     * `requires[0]`, else "deno"). Drives the card's language icon AND the
+     * scaffolded project's `lang`. */
+    lang?: string;
 }
 /**
  * The console's design-token vocabulary (nanobpmn
@@ -188,6 +201,47 @@ export interface TriggerSourceSpec {
      */
     driver?: string;
 }
+/**
+ * One worker a connector pack contributes — the **outbound/compute** edge of the
+ * I/O surface (ADR 0050, amending ADR 0033 §4). "Connector" is the *planned* pack
+ * kind for two-edge I/O packs; it is not yet a member of {@link ExtKind}, so today
+ * these packs ship as `kind: "trigger"` and carry `workers[]` alongside their
+ * `triggerSources[]`. Where {@link TriggerSourceSpec} is the *inbound* edge
+ * (external event → engine), a worker is the *outbound* edge (engine job →
+ * external effect, e.g. "post a Slack message").
+ *
+ * The `type` is the design→runtime **seam**: it must equal the
+ * `zeebe:taskDefinition:type` of the element template (a {@link ExtManifest.components}
+ * entry) that this worker backs, so a task dragged from the palette resolves to
+ * a running worker (ADR 0033 §1). The worker is **long-lived**: it subscribes by
+ * `type` (Zeebe-style, via `@nanobpm/worker`'s `defineWorker`), is started when
+ * the connector is enabled and the App runs, and is supervised — restarted with
+ * backoff on crash, killed on stop — reusing the trigger-driver supervisor
+ * (ADR 0025 §4 / 0036 / 0038). At-least-once outbound delivery is inherited from
+ * the engine's durable job queue (the job *is* the outbox), so no new durable
+ * subsystem is needed — the symmetric dual of the inbound inbox (ADR 0025 §2).
+ */
+export interface WorkerSpec {
+    /** The BPMN job type this worker serves. MUST equal the backing element
+     * template's `zeebe:taskDefinition:type` (the design→runtime seam). */
+    type: string;
+    /** Pack-relative entrypoint (a Node/Deno `.ts`/`.js`/`.mjs`) that calls
+     * `@nanobpm/worker`'s `defineWorker`. Runs on Node >=22.6
+     * (`--experimental-strip-types`) or Deno, like a trigger driver. */
+    entry: string;
+    /** Human label for the console. */
+    displayName?: string;
+    /** Max concurrent jobs (maps to `defineWorker`'s `maxParallelJobs`). */
+    maxParallelJobs?: number;
+    /**
+     * Config fields surfaced **per-connector** in the project config surface when
+     * the connector is enabled — e.g. the shared connection/API token. Defaults
+     * are env-pointers (`env`), never inline secrets, so the committed manifest
+     * carries no credentials (ADR 0027 §5). Distinct from the element template's
+     * per-instance `zeebe:input` fields (channel, message text).
+     */
+    configFields?: ConfigField[];
+}
 export interface ExtManifest {
     id: string;
     kind: ExtKind;
@@ -222,5 +276,22 @@ export interface ExtManifest {
      * §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[];
+    /**
+     * Pack-relative paths to Camunda **element-template** JSON files (each a
+     * single template or an array of them) — the design-time **components** this
+     * pack contributes to the modeler palette (ADR 0033 §4). The host resolves +
+     * parses them (`extensions::pack_component_templates`, path-escape-guarded)
+     * and layers them into the palette / template chooser. Mirrors the host's
+     * `ExtManifest.components: Vec<String>`.
+     */
+    components?: string[];
+    /**
+     * connector packs: the **workers** this pack contributes — the outbound edge
+     * bound to its `components` element templates by matching job `type` (ADR
+     * 0050, amending ADR 0033 §4). Host consumption (launch + supervision +
+     * project-enablement gating) is the ADR 0050 host increment; the field is the
+     * canonical contract packs author against.
+     */
+    workers?: WorkerSpec[];
 }
 export declare const MANIFEST_FILE = "nano-ide.ext.json";

package/package.json

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