scoutline 0.1.0 → 0.2.0

package/dist/providers/types.js

@@ -0,0 +1,127 @@
+/**
+ * Provider Types (DESIGN.md §5, PRD FR-001, FR-004, NFR-004, NFR-010).
+ *
+ * This module defines the static shape of a Provider: a stable ID, the
+ * set of Capabilities it advertises, and a factory that produces an
+ * Adapter bound to a Provider context. No transport, no I/O, no
+ * credential reads occur outside Capability invocation.
+ *
+ * Phase 2 (P2-01) declares only the Search Capability; Phase 3 (P3-01)
+ * adds the `vision?: VisionCapability` slot on `ProviderAdapter` and
+ * declares the matching descriptor metadata. Quota and diagnostics
+ * attach to the `ProviderAdapter` interface in later phases. The
+ * `ProviderCapability` union already enumerates them so descriptor
+ * metadata stays forward-compatible.
+ *
+ * `BUILT_IN_PROVIDER_DESCRIPTORS` is intentionally empty in this stub
+ * file; the production registry waits for P2-05, after both real
+ * Search Adapters exist. Selection functions and tests operate on
+ * explicit descriptor lists through `getProviderDescriptor` and
+ * `getConfiguredProviderDescriptors`.
+ */
+// ---------------------------------------------------------------------------
+// Provider identity
+// ---------------------------------------------------------------------------
+/**
+ * Built-in Provider IDs. Adding a new Provider is a Phase 2+ decision;
+ * new entries must come with a real Adapter and conformance coverage.
+ */
+export const PROVIDER_IDS = ["zai", "minimax"];
+/**
+ * Built-in Provider registry. Phase 2 leaves this empty; P2-05 wires
+ * the real Z.AI and MiniMax descriptors once both Adapters exist. Tests
+ * inject descriptor lists explicitly through `getProviderDescriptor` and
+ * `getConfiguredProviderDescriptors`; the production registry is static
+ * and never accepts package names, file paths, or dynamic imports.
+ */
+export const BUILT_IN_PROVIDER_DESCRIPTORS = [];
+/**
+ * Look up a descriptor by ID. Throws when the ID is unknown. The
+ * optional `descriptors` parameter lets tests inject doubles; production
+ * uses the static built-in list.
+ */
+export function getProviderDescriptor(id, descriptors) {
+    const list = descriptors ?? BUILT_IN_PROVIDER_DESCRIPTORS;
+    const descriptor = list.find((d) => d.id === id);
+    if (!descriptor) {
+        throw new Error(`Unknown provider "${id}". Built-in providers: ${PROVIDER_IDS.join(", ")}.`);
+    }
+    return descriptor;
+}
+/**
+ * Return the descriptors that are configured for the given environment.
+ * Configuration is purely metadata-driven and never constructs an
+ * Adapter.
+ */
+export function getConfiguredProviderDescriptors(env, descriptors) {
+    const list = descriptors ?? BUILT_IN_PROVIDER_DESCRIPTORS;
+    return list.filter((d) => d.isConfigured(env));
+}
+// ---------------------------------------------------------------------------
+// Descriptor factories
+// ---------------------------------------------------------------------------
+/**
+ * Build the Z.AI Provider Descriptor. Phase 2 returns a stub that
+ * advertises the search Capability; P2-03 supplies the real Adapter.
+ * P3-01 extends the capability set with every current Vision operation
+ * so descriptor metadata advertises the Capability before any Adapter
+ * is constructed; the real `vision` slot arrives in P3-03.
+ *
+ * The stub keeps the Provider registerable from day one while the
+ * Search Adapter is implemented in P2-03. Throwing inside `create()`
+ * surfaces the unfinished Adapter during testing rather than silently
+ * failing later.
+ */
+export function createZaiDescriptor(
+// eslint-disable-next-line @typescript-eslint/no-unused-vars
+dependencies) {
+    return {
+        id: "zai",
+        isConfigured(env) {
+            const key = env.Z_AI_API_KEY;
+            return typeof key === "string" && /\S/.test(key);
+        },
+        capabilities() {
+            return new Set([
+                "search",
+                "vision.interpret-image",
+                "vision.ui-artifact",
+                "vision.extract-text",
+                "vision.diagnose-error",
+                "vision.diagram",
+                "vision.chart",
+                "vision.diff",
+                "vision.video",
+                "diagnostics",
+            ]);
+        },
+        create() {
+            throw new Error("Z.AI Search Adapter is not yet implemented; arrives in P2-03.");
+        },
+    };
+}
+/**
+ * Build the MiniMax Provider Descriptor. Phase 2 returns a stub that
+ * advertises the search Capability; P2-04 supplies the real Adapter.
+ * P3-01 advertises the general `vision.interpret-image` Capability
+ * while leaving every specialized operation out until Phase 5
+ * attests individual specialized mappings.
+ */
+export function createMiniMaxDescriptor(
+// eslint-disable-next-line @typescript-eslint/no-unused-vars
+dependencies) {
+    return {
+        id: "minimax",
+        isConfigured(env) {
+            const key = env.MINIMAX_API_KEY;
+            return typeof key === "string" && /\S/.test(key);
+        },
+        capabilities() {
+            return new Set(["search", "vision.interpret-image", "diagnostics"]);
+        },
+        create() {
+            throw new Error("MiniMax Search Adapter is not yet implemented; arrives in P2-04.");
+        },
+    };
+}
+//# sourceMappingURL=types.js.map

package/dist/providers/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/providers/types.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;AAOH,8EAA8E;AAC9E,oBAAoB;AACpB,8EAA8E;AAE9E;;;GAGG;AACH,MAAM,CAAC,MAAM,YAAY,GAAG,CAAC,KAAK,EAAE,SAAS,CAAU,CAAC;AAmExD;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,6BAA6B,GAAkC,EAAE,CAAC;AAE/E;;;;GAIG;AACH,MAAM,UAAU,qBAAqB,CACnC,EAAc,EACd,WAA2C;IAE3C,MAAM,IAAI,GAAG,WAAW,IAAI,6BAA6B,CAAC;IAC1D,MAAM,UAAU,GAAG,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC;IACjD,IAAI,CAAC,UAAU,EAAE,CAAC;QAChB,MAAM,IAAI,KAAK,CAAC,qBAAqB,EAAE,0BAA0B,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAC/F,CAAC;IACD,OAAO,UAAU,CAAC;AACpB,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,gCAAgC,CAC9C,GAAsB,EACtB,WAA2C;IAE3C,MAAM,IAAI,GAAG,WAAW,IAAI,6BAA6B,CAAC;IAC1D,OAAO,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC,CAAC;AACjD,CAAC;AAsJD,8EAA8E;AAC9E,uBAAuB;AACvB,8EAA8E;AAE9E;;;;;;;;;;;GAWG;AACH,MAAM,UAAU,mBAAmB;AACjC,6DAA6D;AAC7D,YAAqC;IAErC,OAAO;QACL,EAAE,EAAE,KAAK;QACT,YAAY,CAAC,GAAG;YACd,MAAM,GAAG,GAAG,GAAG,CAAC,YAAY,CAAC;YAC7B,OAAO,OAAO,GAAG,KAAK,QAAQ,IAAI,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACnD,CAAC;QACD,YAAY;YACV,OAAO,IAAI,GAAG,CAAqB;gBACjC,QAAQ;gBACR,wBAAwB;gBACxB,oBAAoB;gBACpB,qBAAqB;gBACrB,uBAAuB;gBACvB,gBAAgB;gBAChB,cAAc;gBACd,aAAa;gBACb,cAAc;gBACd,aAAa;aACd,CAAC,CAAC;QACL,CAAC;QACD,MAAM;YACJ,MAAM,IAAI,KAAK,CAAC,+DAA+D,CAAC,CAAC;QACnF,CAAC;KACF,CAAC;AACJ,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,uBAAuB;AACrC,6DAA6D;AAC7D,YAAyC;IAEzC,OAAO;QACL,EAAE,EAAE,SAAS;QACb,YAAY,CAAC,GAAG;YACd,MAAM,GAAG,GAAG,GAAG,CAAC,eAAe,CAAC;YAChC,OAAO,OAAO,GAAG,KAAK,QAAQ,IAAI,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACnD,CAAC;QACD,YAAY;YACV,OAAO,IAAI,GAAG,CAAqB,CAAC,QAAQ,EAAE,wBAAwB,EAAE,aAAa,CAAC,CAAC,CAAC;QAC1F,CAAC;QACD,MAAM;YACJ,MAAM,IAAI,KAAK,CAAC,kEAAkE,CAAC,CAAC;QACtF,CAAC;KACF,CAAC;AACJ,CAAC"}

package/dist/providers/zai/adapter.d.ts

@@ -0,0 +1,35 @@
+/**
+ * Z.AI Search Adapter (DESIGN.md §5, §7, §11 — P2-03).
+ *
+ * Implements the real Z.AI Provider Descriptor with Search support.
+ * The Adapter owns credentials, transport lifecycle, Provider field
+ * mapping, and failure normalization. Shared execution owns cache and
+ * retry policy, so Adapter invocations disable client-owned cache and
+ * retries (`noCache: true, disableRetry: true`).
+ *
+ * Boundary rules (ARCHITECTURE.md §2):
+ *   - May import capability types, normalized errors, Provider-specific
+ *     transport (ZaiMcpClient), and Provider identity types.
+ *   - Must NOT import command presentation, output mode, or another
+ *     Provider's Adapter.
+ *
+ * Field mapping (DESIGN.md §7):
+ *   title        -> title
+ *   link         -> url
+ *   content      -> summary
+ *   media        -> source
+ *   publish_date -> date
+ *
+ * The Adapter sends only `search_query`, domain, recency, content size,
+ * and location to the Provider. It NEVER sends count.
+ */
+import type { ProviderDescriptor, ZaiAdapterDependencies } from "../types.js";
+/**
+ * Build the Z.AI Provider Descriptor. The descriptor advertises the
+ * Search Capability and constructs an Adapter whose `search` Capability
+ * owns credentials, transport lifecycle, Provider field mapping, and
+ * failure normalization. Construction is side-effect-free; transport is
+ * built and torn down per invocation.
+ */
+export declare function createZaiDescriptor(dependencies?: ZaiAdapterDependencies): ProviderDescriptor;
+//# sourceMappingURL=adapter.d.ts.map

package/dist/providers/zai/adapter.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"adapter.d.ts","sourceRoot":"","sources":["../../../src/providers/zai/adapter.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AAIH,OAAO,KAAK,EAIV,kBAAkB,EAElB,sBAAsB,EAGvB,MAAM,aAAa,CAAC;AAunBrB;;;;;;GAMG;AACH,wBAAgB,mBAAmB,CAAC,YAAY,CAAC,EAAE,sBAAsB,GAAG,kBAAkB,CA2D7F"}