@opensip-cli/config 0.1.0

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/NOTICE

@@ -0,0 +1,8 @@
+OpenSIP CLI
+Copyright 2026 opensip-ai
+
+Licensed under the Apache License, Version 2.0 (the "License"); you may not use
+this software except in compliance with the License. A copy of the License is
+included in the LICENSE file and is also available at:
+
+    http://www.apache.org/licenses/LICENSE-2.0

package/README.md

@@ -0,0 +1,31 @@
+<!-- Generated by scripts/build-package-readmes.mjs — do not edit by hand.
+     Change the package's "description" (or the generator template) and run
+     `pnpm docs:readmes`. CI enforces sync via `pnpm docs:readmes:check`. -->
+
+# @opensip-cli/config
+
+> Configuration layer for OpenSIP CLI — the capability-configuration composer and schema registry
+
+This is an **internal library** of the opensip-cli toolkit. It is published so the CLI and tools can depend on it; most users will not install it directly.
+
+Part of [**opensip-cli**](https://github.com/opensip-ai/opensip-cli) — an open-source codebase-analysis toolkit: fitness checks (`fit`), static call-graph analysis (`graph`), and simulation (`sim`).
+
+## Install
+
+Most users install the CLI, which bundles the first-party tools:
+
+```bash
+curl -fsSL https://opensip.ai/cli/install.sh | bash
+```
+
+This package is published for the CLI and advanced plugin authors; most users should not install `@opensip-cli/config` directly.
+
+## Documentation
+
+- 📚 Project docs: https://opensip.ai/docs/opensip-cli/
+- 🧭 Package catalog (what every package does): https://github.com/opensip-ai/opensip-cli/blob/v0.1.0/docs/public/70-reference/02-package-catalog.md
+- 📦 Source: https://github.com/opensip-ai/opensip-cli/tree/v0.1.0/packages/config
+
+## License
+
+Apache-2.0 © opensip-ai

package/dist/capability-preferences.d.ts

@@ -0,0 +1,39 @@
+/**
+ * @fileoverview One descriptor-driven capability-preference resolver (§5.3,
+ * Phase 3).
+ *
+ * Three bespoke readers parse three key-sets today — fitness's
+ * `readCheckPackagePreferences` (`plugins.checkPackages`), simulation's
+ * `readScenarioPackagePreferences` (`plugins.scenarioPackages` /
+ * `autoDiscoverScenarios` / `packageScopes`), and graph's
+ * `readGraphAdapterPackagePreferences` (`plugins.graphAdapters` /
+ * `autoDiscoverGraphAdapters`). Each domain's discovery descriptor maps domain →
+ * config keys (`descriptor.configKeys`), so this one resolver replaces all three
+ * WITHOUT renaming a single key — the documented `opensip-cli.config.yml`
+ * surface is byte-identical, no migration.
+ *
+ * Reads from the raw `plugins` block of the project config (the same block the
+ * three readers read). Lives in `@opensip-cli/config` because reading config is
+ * a config-layer concern; the generic substrate (core) receives the RESOLVED
+ * preferences, staying config-pure.
+ */
+import type { CapabilityDiscoveryDescriptor } from '@opensip-cli/core';
+/** Resolved discovery preferences for one domain — the shape the substrate consumes. */
+export interface CapabilityPreferences {
+    /** Explicit package-name list (present → the substrate skips/augments auto per its mode). */
+    readonly packages?: readonly string[];
+    /** Auto-discovery enabled. Documented default: ON unless explicitly `false`. */
+    readonly autoDiscover: boolean;
+    /** name-pattern mode: the resolved+validated scopes to scan (default ∪ customer). */
+    readonly scopes?: readonly string[];
+}
+/**
+ * Resolve a domain's discovery preferences from the project config's `plugins`
+ * block through the keys its descriptor declares.
+ *
+ * @param descriptor   The domain's discovery descriptor (supplies `configKeys` + mode).
+ * @param pluginsConfig The raw `plugins` block from `opensip-cli.config.yml`
+ *   (or anything — a non-object is treated as "no preferences declared").
+ */
+export declare function resolveCapabilityPreferences(descriptor: CapabilityDiscoveryDescriptor, pluginsConfig: unknown): CapabilityPreferences;
+//# sourceMappingURL=capability-preferences.d.ts.map

package/dist/capability-preferences.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"capability-preferences.d.ts","sourceRoot":"","sources":["../src/capability-preferences.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;GAkBG;AAIH,OAAO,KAAK,EAAE,6BAA6B,EAAE,MAAM,mBAAmB,CAAC;AAEvE,wFAAwF;AACxF,MAAM,WAAW,qBAAqB;IACpC,6FAA6F;IAC7F,QAAQ,CAAC,QAAQ,CAAC,EAAE,SAAS,MAAM,EAAE,CAAC;IACtC,gFAAgF;IAChF,QAAQ,CAAC,YAAY,EAAE,OAAO,CAAC;IAC/B,qFAAqF;IACrF,QAAQ,CAAC,MAAM,CAAC,EAAE,SAAS,MAAM,EAAE,CAAC;CACrC;AAYD;;;;;;;GAOG;AACH,wBAAgB,4BAA4B,CAC1C,UAAU,EAAE,6BAA6B,EACzC,aAAa,EAAE,OAAO,GACrB,qBAAqB,CAqBvB"}

package/dist/capability-preferences.js

@@ -0,0 +1,61 @@
+/**
+ * @fileoverview One descriptor-driven capability-preference resolver (§5.3,
+ * Phase 3).
+ *
+ * Three bespoke readers parse three key-sets today — fitness's
+ * `readCheckPackagePreferences` (`plugins.checkPackages`), simulation's
+ * `readScenarioPackagePreferences` (`plugins.scenarioPackages` /
+ * `autoDiscoverScenarios` / `packageScopes`), and graph's
+ * `readGraphAdapterPackagePreferences` (`plugins.graphAdapters` /
+ * `autoDiscoverGraphAdapters`). Each domain's discovery descriptor maps domain →
+ * config keys (`descriptor.configKeys`), so this one resolver replaces all three
+ * WITHOUT renaming a single key — the documented `opensip-cli.config.yml`
+ * surface is byte-identical, no migration.
+ *
+ * Reads from the raw `plugins` block of the project config (the same block the
+ * three readers read). Lives in `@opensip-cli/config` because reading config is
+ * a config-layer concern; the generic substrate (core) receives the RESOLVED
+ * preferences, staying config-pure.
+ */
+import { isRecord, resolveScopes } from '@opensip-cli/core';
+/** Read a key as a `string[]`, filtering non-strings; `undefined` when the key is not an array. */
+function stringArrayAt(record, key) {
+    if (key === undefined)
+        return undefined;
+    const value = record[key];
+    return Array.isArray(value) ? value.filter((v) => typeof v === 'string') : undefined;
+}
+/**
+ * Resolve a domain's discovery preferences from the project config's `plugins`
+ * block through the keys its descriptor declares.
+ *
+ * @param descriptor   The domain's discovery descriptor (supplies `configKeys` + mode).
+ * @param pluginsConfig The raw `plugins` block from `opensip-cli.config.yml`
+ *   (or anything — a non-object is treated as "no preferences declared").
+ */
+export function resolveCapabilityPreferences(descriptor, pluginsConfig) {
+    const plugins = isRecord(pluginsConfig) ? pluginsConfig : {};
+    const keys = descriptor.configKeys;
+    // Explicit list: present (even empty) → the substrate honors it; absent → undefined.
+    const packages = stringArrayAt(plugins, keys.packages);
+    // Auto-discover: documented default ON; only an explicit boolean `false` disables it.
+    const autoRaw = keys.autoDiscover === undefined ? undefined : plugins[keys.autoDiscover];
+    const autoDiscover = typeof autoRaw === 'boolean' ? autoRaw : true;
+    // Scopes (name-pattern only): merge the descriptor's default scopes with any
+    // customer-configured additions, validated + deduped — exactly the
+    // `resolveScopes(DEFAULT_SCOPE, packageScopes)` the sim reader did.
+    const scopes = resolveNamePatternScopes(descriptor, stringArrayAt(plugins, keys.scopes) ?? []);
+    return {
+        ...(packages === undefined ? {} : { packages }),
+        autoDiscover,
+        ...(scopes === undefined ? {} : { scopes }),
+    };
+}
+/** Merge default + customer scopes for name-pattern mode; `undefined` for marker mode. */
+function resolveNamePatternScopes(descriptor, customerScopes) {
+    if (descriptor.discovery.mode !== 'name-pattern')
+        return undefined;
+    const [primary = '@opensip-cli', ...restDefaults] = descriptor.discovery.defaultScopes;
+    return resolveScopes(primary, [...restDefaults, ...customerScopes], 'plugin.capability.invalid_scope');
+}
+//# sourceMappingURL=capability-preferences.js.map

package/dist/capability-preferences.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"capability-preferences.js","sourceRoot":"","sources":["../src/capability-preferences.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;GAkBG;AAEH,OAAO,EAAE,QAAQ,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAC;AAc5D,mGAAmG;AACnG,SAAS,aAAa,CACpB,MAA+B,EAC/B,GAAuB;IAEvB,IAAI,GAAG,KAAK,SAAS;QAAE,OAAO,SAAS,CAAC;IACxC,MAAM,KAAK,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC;IAC1B,OAAO,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,EAAe,EAAE,CAAC,OAAO,CAAC,KAAK,QAAQ,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;AACpG,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,4BAA4B,CAC1C,UAAyC,EACzC,aAAsB;IAEtB,MAAM,OAAO,GAAG,QAAQ,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,EAAE,CAAC;IAC7D,MAAM,IAAI,GAAG,UAAU,CAAC,UAAU,CAAC;IAEnC,qFAAqF;IACrF,MAAM,QAAQ,GAAG,aAAa,CAAC,OAAO,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC;IAEvD,sFAAsF;IACtF,MAAM,OAAO,GAAG,IAAI,CAAC,YAAY,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;IACzF,MAAM,YAAY,GAAG,OAAO,OAAO,KAAK,SAAS,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC;IAEnE,6EAA6E;IAC7E,mEAAmE;IACnE,oEAAoE;IACpE,MAAM,MAAM,GAAG,wBAAwB,CAAC,UAAU,EAAE,aAAa,CAAC,OAAO,EAAE,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC,CAAC;IAE/F,OAAO;QACL,GAAG,CAAC,QAAQ,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,QAAQ,EAAE,CAAC;QAC/C,YAAY;QACZ,GAAG,CAAC,MAAM,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC;KAC5C,CAAC;AACJ,CAAC;AAED,0FAA0F;AAC1F,SAAS,wBAAwB,CAC/B,UAAyC,EACzC,cAAiC;IAEjC,IAAI,UAAU,CAAC,SAAS,CAAC,IAAI,KAAK,cAAc;QAAE,OAAO,SAAS,CAAC;IACnE,MAAM,CAAC,OAAO,GAAG,cAAc,EAAE,GAAG,YAAY,CAAC,GAAG,UAAU,CAAC,SAAS,CAAC,aAAa,CAAC;IACvF,OAAO,aAAa,CAClB,OAAO,EACP,CAAC,GAAG,YAAY,EAAE,GAAG,cAAc,CAAC,EACpC,iCAAiC,CAClC,CAAC;AACJ,CAAC"}

package/dist/composer.d.ts

@@ -0,0 +1,58 @@
+/**
+ * composer — merges the registered namespaced schemas into one strict
+ * whole-document schema, and validates a raw config document against it.
+ *
+ * ADR-0023. Each tool contributes a {@link ToolConfigDeclaration}; the host
+ * composes them into a single Zod object keyed by namespace. Two rules govern
+ * unknown keys:
+ *
+ *   1. STRICT within a namespace — an unknown key inside a *known* namespace
+ *      (e.g. `fitness.faliOnErrors`, a typo) is rejected. Achieved by making
+ *      each namespace's object schema `.strict()`.
+ *
+ *   2. TOLERANT at the document level — a top-level key claimed by NO
+ *      registered declaration is passed through, not rejected. This is a
+ *      deliberate, permanent forward-compatibility contract, NOT migration
+ *      debt: a config document may carry a namespace block for a tool that is
+ *      not installed in this run (a third-party plugin missing from
+ *      `plugins.<domain>`, or one config shared across projects with
+ *      different tool sets). Rejecting it would make installing/uninstalling
+ *      a tool break the shared document. Achieved by a
+ *      `.catchall(z.unknown())` at the document level. The moment a namespace
+ *      IS claimed — by a tool declaration or a host declaration
+ *      (`document/host-declarations.ts` claims `cli`, `targets`,
+ *      `globalExcludes`, `checkOverrides`, `dashboard`, `plugins`,
+ *      `schemaVersion`) — it gains the strict treatment of rule 1.
+ *      (Historical note: this catchall once also covered then-unclaimed host
+ *      blocks; that migration use ended when host-declarations claimed them.)
+ *
+ * A validation failure in ANY namespace throws the same typed
+ * {@link ConfigurationError} (→ `CONFIGURATION_ERROR` exit), so a typo in
+ * `fitness` and a typo in `graph` fail identically.
+ */
+import { type ZodType } from 'zod';
+import type { ToolConfigDeclaration } from './declaration.js';
+/**
+ * Compose the registered tool declarations into one strict whole-document
+ * schema.
+ *
+ * The result is a Zod object whose keys are the registered namespaces (each a
+ * strict version of the tool's schema, made optional so a config omitting a
+ * tool's block is valid) plus a catchall that tolerates unclaimed top-level
+ * keys (the uninstalled-tool forward-compat contract — see the module
+ * docstring, rule 2).
+ *
+ * @param declarations The tool declarations to compose. Duplicate namespaces
+ *   are rejected — two tools may not own the same top-level key.
+ */
+export declare function composeConfigSchema(declarations: readonly ToolConfigDeclaration[]): ZodType;
+/**
+ * Validate a raw config document against the composed schema.
+ *
+ * @returns The parsed, type-narrowed document on success.
+ * @throws {ConfigurationError} On any validation failure, with the formatted
+ *   Zod issues attached as `issues` for diagnosis. The same error shape is
+ *   thrown regardless of which namespace failed.
+ */
+export declare function validateConfigDocument(schema: ZodType, raw: unknown): unknown;
+//# sourceMappingURL=composer.d.ts.map

package/dist/composer.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"composer.d.ts","sourceRoot":"","sources":["../src/composer.ts"],"names":[],"mappings":"AACA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+BG;AAGH,OAAO,EAAK,KAAK,OAAO,EAAE,MAAM,KAAK,CAAC;AAEtC,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,kBAAkB,CAAC;AAgB9D;;;;;;;;;;;;GAYG;AACH,wBAAgB,mBAAmB,CAAC,YAAY,EAAE,SAAS,qBAAqB,EAAE,GAAG,OAAO,CAkB3F;AAED;;;;;;;GAOG;AACH,wBAAgB,sBAAsB,CAAC,MAAM,EAAE,OAAO,EAAE,GAAG,EAAE,OAAO,GAAG,OAAO,CAwB7E"}

package/dist/composer.js

@@ -0,0 +1,111 @@
+// @fitness-ignore-file null-safety -- Zod schema builder chains (.strict()/.optional()/.catchall()) always return valid schema objects; there is no nullable access
+/**
+ * composer — merges the registered namespaced schemas into one strict
+ * whole-document schema, and validates a raw config document against it.
+ *
+ * ADR-0023. Each tool contributes a {@link ToolConfigDeclaration}; the host
+ * composes them into a single Zod object keyed by namespace. Two rules govern
+ * unknown keys:
+ *
+ *   1. STRICT within a namespace — an unknown key inside a *known* namespace
+ *      (e.g. `fitness.faliOnErrors`, a typo) is rejected. Achieved by making
+ *      each namespace's object schema `.strict()`.
+ *
+ *   2. TOLERANT at the document level — a top-level key claimed by NO
+ *      registered declaration is passed through, not rejected. This is a
+ *      deliberate, permanent forward-compatibility contract, NOT migration
+ *      debt: a config document may carry a namespace block for a tool that is
+ *      not installed in this run (a third-party plugin missing from
+ *      `plugins.<domain>`, or one config shared across projects with
+ *      different tool sets). Rejecting it would make installing/uninstalling
+ *      a tool break the shared document. Achieved by a
+ *      `.catchall(z.unknown())` at the document level. The moment a namespace
+ *      IS claimed — by a tool declaration or a host declaration
+ *      (`document/host-declarations.ts` claims `cli`, `targets`,
+ *      `globalExcludes`, `checkOverrides`, `dashboard`, `plugins`,
+ *      `schemaVersion`) — it gains the strict treatment of rule 1.
+ *      (Historical note: this catchall once also covered then-unclaimed host
+ *      blocks; that migration use ended when host-declarations claimed them.)
+ *
+ * A validation failure in ANY namespace throws the same typed
+ * {@link ConfigurationError} (→ `CONFIGURATION_ERROR` exit), so a typo in
+ * `fitness` and a typo in `graph` fail identically.
+ */
+import { ConfigurationError } from '@opensip-cli/core';
+import { z } from 'zod';
+/**
+ * Make a namespace schema reject unknown keys.
+ *
+ * Object schemas gain `.strict()`. A non-object schema (a tool could contribute
+ * a `z.record(...)` or a union) has no "unknown key" concept, so it is returned
+ * unchanged — strictness is meaningful only for object shapes.
+ */
+function strictenNamespace(schema) {
+    if (schema instanceof z.ZodObject) {
+        return schema.strict();
+    }
+    return schema;
+}
+/**
+ * Compose the registered tool declarations into one strict whole-document
+ * schema.
+ *
+ * The result is a Zod object whose keys are the registered namespaces (each a
+ * strict version of the tool's schema, made optional so a config omitting a
+ * tool's block is valid) plus a catchall that tolerates unclaimed top-level
+ * keys (the uninstalled-tool forward-compat contract — see the module
+ * docstring, rule 2).
+ *
+ * @param declarations The tool declarations to compose. Duplicate namespaces
+ *   are rejected — two tools may not own the same top-level key.
+ */
+export function composeConfigSchema(declarations) {
+    const shape = {};
+    for (const decl of declarations) {
+        if (Object.prototype.hasOwnProperty.call(shape, decl.namespace)) {
+            throw new ConfigurationError(`Duplicate config namespace '${decl.namespace}': two tools cannot own the same top-level key.`, { code: 'CONFIGURATION_ERROR', namespace: decl.namespace });
+        }
+        // Optional so a document that omits a tool's block stays valid; strict so a
+        // typo *inside* the block is rejected.
+        shape[decl.namespace] = strictenNamespace(decl.schema).optional();
+    }
+    // `.catchall(z.unknown())` tolerates unclaimed top-level keys — the
+    // namespace block of a tool not installed in this run must pass through
+    // (forward compat; module docstring rule 2). Strictness lives inside each
+    // claimed namespace, not at the document root.
+    return z.object(shape).catchall(z.unknown());
+}
+/**
+ * Validate a raw config document against the composed schema.
+ *
+ * @returns The parsed, type-narrowed document on success.
+ * @throws {ConfigurationError} On any validation failure, with the formatted
+ *   Zod issues attached as `issues` for diagnosis. The same error shape is
+ *   thrown regardless of which namespace failed.
+ */
+export function validateConfigDocument(schema, raw) {
+    const result = schema.safeParse(raw);
+    if (result.success) {
+        return result.data;
+    }
+    const issues = result.error.issues;
+    const summary = issues
+        .map((issue) => {
+        const path = issue.path.length > 0 ? issue.path.join('.') : '(document root)';
+        return `${path}: ${issue.message}`;
+    })
+        .join('; ');
+    const error = new ConfigurationError(`Invalid configuration: ${summary}`, {
+        code: 'CONFIGURATION_ERROR',
+    });
+    // Attach the formatted Zod issues for downstream diagnosis. The base
+    // ToolError constructor only copies `code` off the options bag, so the
+    // structured issues must be set on the instance directly.
+    Object.defineProperty(error, 'issues', {
+        value: issues,
+        enumerable: true,
+        writable: false,
+    });
+    throw error;
+}
+//# sourceMappingURL=composer.js.map

package/dist/composer.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"composer.js","sourceRoot":"","sources":["../src/composer.ts"],"names":[],"mappings":"AAAA,oKAAoK;AACpK;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+BG;AAEH,OAAO,EAAE,kBAAkB,EAAE,MAAM,mBAAmB,CAAC;AACvD,OAAO,EAAE,CAAC,EAAgB,MAAM,KAAK,CAAC;AAItC;;;;;;GAMG;AACH,SAAS,iBAAiB,CAAC,MAAe;IACxC,IAAI,MAAM,YAAY,CAAC,CAAC,SAAS,EAAE,CAAC;QAClC,OAAO,MAAM,CAAC,MAAM,EAAE,CAAC;IACzB,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC;AAED;;;;;;;;;;;;GAYG;AACH,MAAM,UAAU,mBAAmB,CAAC,YAA8C;IAChF,MAAM,KAAK,GAA4B,EAAE,CAAC;IAC1C,KAAK,MAAM,IAAI,IAAI,YAAY,EAAE,CAAC;QAChC,IAAI,MAAM,CAAC,SAAS,CAAC,cAAc,CAAC,IAAI,CAAC,KAAK,EAAE,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC;YAChE,MAAM,IAAI,kBAAkB,CAC1B,+BAA+B,IAAI,CAAC,SAAS,iDAAiD,EAC9F,EAAE,IAAI,EAAE,qBAAqB,EAAE,SAAS,EAAE,IAAI,CAAC,SAAS,EAAE,CAC3D,CAAC;QACJ,CAAC;QACD,4EAA4E;QAC5E,uCAAuC;QACvC,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,iBAAiB,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,QAAQ,EAAE,CAAC;IACpE,CAAC;IACD,oEAAoE;IACpE,wEAAwE;IACxE,0EAA0E;IAC1E,+CAA+C;IAC/C,OAAO,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC;AAC/C,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,sBAAsB,CAAC,MAAe,EAAE,GAAY;IAClE,MAAM,MAAM,GAAG,MAAM,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC;IACrC,IAAI,MAAM,CAAC,OAAO,EAAE,CAAC;QACnB,OAAO,MAAM,CAAC,IAAI,CAAC;IACrB,CAAC;IACD,MAAM,MAAM,GAAG,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC;IACnC,MAAM,OAAO,GAAG,MAAM;SACnB,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE;QACb,MAAM,IAAI,GAAG,KAAK,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,iBAAiB,CAAC;QAC9E,OAAO,GAAG,IAAI,KAAK,KAAK,CAAC,OAAO,EAAE,CAAC;IACrC,CAAC,CAAC;SACD,IAAI,CAAC,IAAI,CAAC,CAAC;IACd,MAAM,KAAK,GAAG,IAAI,kBAAkB,CAAC,0BAA0B,OAAO,EAAE,EAAE;QACxE,IAAI,EAAE,qBAAqB;KAC5B,CAAC,CAAC;IACH,qEAAqE;IACrE,uEAAuE;IACvE,0DAA0D;IAC1D,MAAM,CAAC,cAAc,CAAC,KAAK,EAAE,QAAQ,EAAE;QACrC,KAAK,EAAE,MAAM;QACb,UAAU,EAAE,IAAI;QAChB,QAAQ,EAAE,KAAK;KAChB,CAAC,CAAC;IACH,MAAM,KAAK,CAAC;AACd,CAAC"}

package/dist/declaration.d.ts

@@ -0,0 +1,59 @@
+/**
+ * declaration — the contract a tool offers to the configuration layer.
+ *
+ * Each tool contributes a {@link ToolConfigDeclaration}: a namespace (its
+ * top-level key in `opensip-cli.config.yml`), a Zod schema describing that
+ * namespace's block, optional defaults, and optional environment-variable
+ * bindings. The host composes the registered declarations into one strict
+ * whole-document schema (see {@link ./composer}) and resolves precedence across
+ * flags / env / file / defaults (see {@link ./precedence}).
+ *
+ * Nothing here imports a tool; the declaration is a pure data contract the
+ * tools hand to the composition root (wired in Phase 4).
+ */
+import type { ZodType } from 'zod';
+/**
+ * Coercion applied to a raw environment-variable string before it is merged
+ * into the resolved config.
+ *
+ *   - `string`  — passed through verbatim (the default).
+ *   - `number`  — parsed with `Number(...)`; a non-finite result is dropped.
+ *   - `boolean` — `'true'`/`'1'` → true, `'false'`/`'0'` → false (case-insensitive);
+ *                 anything else is dropped.
+ */
+export type EnvBindingType = 'string' | 'number' | 'boolean';
+/**
+ * Binds one environment variable to one config key within a namespace.
+ *
+ * The precedence resolver reads `process.env[envVar]` (supplied as the `env`
+ * map), coerces it per `type`, and writes it onto the namespace's resolved
+ * object under `key` — but only if no higher-precedence source (a flag) already
+ * set it.
+ */
+export interface EnvBindingDeclaration {
+    /** The environment variable name, e.g. `OPENSIP_FIT_FAIL_ON_ERRORS`. */
+    readonly envVar: string;
+    /** The config key within the owning namespace this variable populates. */
+    readonly key: string;
+    /** How the raw string is coerced before merge. Defaults to `'string'`. */
+    readonly type?: EnvBindingType;
+}
+/**
+ * A tool's contribution to the composed configuration document.
+ *
+ * `namespace` is the tool's top-level key (e.g. `fitness`, `graph`,
+ * `simulation`); `schema` validates that namespace's block. The composer makes
+ * each namespace schema `.strict()` so a typo inside a known namespace is
+ * rejected, while tolerating unclaimed top-level keys for forward compatibility.
+ */
+export interface ToolConfigDeclaration {
+    /** Top-level config key owned by this tool. */
+    readonly namespace: string;
+    /** Zod schema validating the namespace's block. */
+    readonly schema: ZodType;
+    /** Optional defaults for the namespace, used as the lowest-precedence source. */
+    readonly defaults?: unknown;
+    /** Optional environment-variable bindings for keys in this namespace. */
+    readonly env?: readonly EnvBindingDeclaration[];
+}
+//# sourceMappingURL=declaration.d.ts.map

package/dist/declaration.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"declaration.d.ts","sourceRoot":"","sources":["../src/declaration.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;GAYG;AAEH,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,KAAK,CAAC;AAEnC;;;;;;;;GAQG;AACH,MAAM,MAAM,cAAc,GAAG,QAAQ,GAAG,QAAQ,GAAG,SAAS,CAAC;AAE7D;;;;;;;GAOG;AACH,MAAM,WAAW,qBAAqB;IACpC,wEAAwE;IACxE,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,0EAA0E;IAC1E,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC;IACrB,0EAA0E;IAC1E,QAAQ,CAAC,IAAI,CAAC,EAAE,cAAc,CAAC;CAChC;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,qBAAqB;IACpC,+CAA+C;IAC/C,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;IAC3B,mDAAmD;IACnD,QAAQ,CAAC,MAAM,EAAE,OAAO,CAAC;IACzB,iFAAiF;IACjF,QAAQ,CAAC,QAAQ,CAAC,EAAE,OAAO,CAAC;IAC5B,yEAAyE;IACzE,QAAQ,CAAC,GAAG,CAAC,EAAE,SAAS,qBAAqB,EAAE,CAAC;CACjD"}

package/dist/declaration.js

@@ -0,0 +1,15 @@
+/**
+ * declaration — the contract a tool offers to the configuration layer.
+ *
+ * Each tool contributes a {@link ToolConfigDeclaration}: a namespace (its
+ * top-level key in `opensip-cli.config.yml`), a Zod schema describing that
+ * namespace's block, optional defaults, and optional environment-variable
+ * bindings. The host composes the registered declarations into one strict
+ * whole-document schema (see {@link ./composer}) and resolves precedence across
+ * flags / env / file / defaults (see {@link ./precedence}).
+ *
+ * Nothing here imports a tool; the declaration is a pure data contract the
+ * tools hand to the composition root (wired in Phase 4).
+ */
+export {};
+//# sourceMappingURL=declaration.js.map

package/dist/declaration.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"declaration.js","sourceRoot":"","sources":["../src/declaration.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;GAYG"}