@abitechdev/openchasqui-spec 0.0.0-stage → 0.1.1

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,4 @@
+OpenChasqui
+Copyright 2026 The OpenChasqui Authors
+
+This product is licensed under the Apache License, Version 2.0.

package/README.md

@@ -1,3 +1,56 @@
-# Temporary Holding Version
+<p align="center">
+  <a href="https://github.com/abitech-dev/abitech-openchasqui-cli#readme"><img alt="OpenChasqui" src="https://raw.githubusercontent.com/abitech-dev/abitech-openchasqui-cli/main/.github/assets/logo-light.svg" width="320"></a>
+</p>
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+# @abitechdev/openchasqui-spec
+
+[![npm](https://img.shields.io/npm/v/@abitechdev/openchasqui-spec?color=c2410c&label=npm)](https://www.npmjs.com/package/@abitechdev/openchasqui-spec)
+[![CI](https://github.com/abitech-dev/abitech-openchasqui-cli/actions/workflows/ci.yml/badge.svg)](https://github.com/abitech-dev/abitech-openchasqui-cli/actions/workflows/ci.yml)
+[![Apache-2.0](https://img.shields.io/badge/license-Apache--2.0-blue)](https://github.com/abitech-dev/abitech-openchasqui-cli/blob/main/LICENSE)
+
+Contrato de OpenChasqui: el modelo canónico de la API, los tipos de la configuración y la interfaz de cada tipo de plugin. Es la única dependencia que necesitas para escribir un plugin propio.
+
+> **¿Solo quieres generar colecciones?** Instala el CLI,
+> [`@abitechdev/openchasqui`](https://www.npmjs.com/package/@abitechdev/openchasqui), que ya incluye este paquete.
+
+## Instalación
+
+```bash
+npm i @abitechdev/openchasqui-spec
+pnpm add @abitechdev/openchasqui-spec
+yarn add @abitechdev/openchasqui-spec
+```
+
+Requiere Node.js 22 o superior.
+
+## Uso
+
+Un emisor que lista las rutas del contrato:
+
+```ts
+import type { Emitter } from "@abitechdev/openchasqui-spec";
+
+export const routesEmitter: Emitter = {
+  name: "routes-emitter",
+  kind: "emitter",
+  apiVersion: 1,
+  target: "routes",
+  emit: async ({ model }) => [
+    {
+      path: "routes.txt",
+      contents: model.operations.map((op) => `${op.method} ${op.path}`).join("\n"),
+    },
+  ],
+};
+```
+
+Los tipos de plugin son `document-transformer`, `loader`, `transformer`,
+`generator`, `validator` y `emitter`.
+
+## Documentación
+
+[Español](https://github.com/abitech-dev/abitech-openchasqui-cli#readme) · [English](https://github.com/abitech-dev/abitech-openchasqui-cli/blob/main/README.en.md)
+
+## Licencia
+
+[Apache-2.0](https://github.com/abitech-dev/abitech-openchasqui-cli/blob/main/LICENSE). Parte de [OpenChasqui](https://github.com/abitech-dev/abitech-openchasqui-cli).

package/dist/config.d.ts

@@ -0,0 +1,37 @@
+/** Configuration file version. `openchasqui migrate` moves it forward. */
+export declare const CONFIG_VERSION: 1;
+export interface OpenChasquiConfig {
+    readonly version: typeof CONFIG_VERSION;
+    /** Path to the OpenAPI document, relative to the configuration file. */
+    readonly source: string;
+    /** Overlay 1.0 documents, applied in order. */
+    readonly overlays?: readonly string[];
+    readonly environments?: Readonly<Record<string, EnvironmentConfig>>;
+    readonly variables?: VariableNames;
+    /** Data set for synthetic examples, `generic` by default or `es-pe`. */
+    readonly data?: "generic" | "es-pe";
+    readonly tests?: TestOptions;
+    readonly targets: readonly string[];
+    /** Folder for the emitted collections, one subfolder per target. */
+    readonly output: string;
+}
+export interface TestOptions {
+    /** Slowest acceptable response. Defaults to 5000. */
+    readonly responseTimeMs?: number;
+}
+/** Names of the variables the collections use. */
+export interface VariableNames {
+    /** Defaults to `baseUrl`. */
+    readonly baseUrl?: string;
+    /** Defaults to `token`. */
+    readonly token?: string;
+    /** Defaults to `apiKey`. */
+    readonly apiKey?: string;
+}
+export declare const DEFAULT_VARIABLES: Required<VariableNames>;
+export interface EnvironmentConfig {
+    readonly variables: Readonly<Record<string, string>>;
+    /** Variable names whose values never leave the user's machine. */
+    readonly secrets?: readonly string[];
+}
+//# sourceMappingURL=config.d.ts.map

package/dist/config.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"config.d.ts","sourceRoot":"","sources":["../src/config.ts"],"names":[],"mappings":"AAAA,0EAA0E;AAC1E,eAAO,MAAM,cAAc,EAAG,CAAU,CAAC;AAEzC,MAAM,WAAW,iBAAiB;IAChC,QAAQ,CAAC,OAAO,EAAE,OAAO,cAAc,CAAC;IACxC,wEAAwE;IACxE,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,+CAA+C;IAC/C,QAAQ,CAAC,QAAQ,CAAC,EAAE,SAAS,MAAM,EAAE,CAAC;IACtC,QAAQ,CAAC,YAAY,CAAC,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,iBAAiB,CAAC,CAAC,CAAC;IACpE,QAAQ,CAAC,SAAS,CAAC,EAAE,aAAa,CAAC;IACnC,wEAAwE;IACxE,QAAQ,CAAC,IAAI,CAAC,EAAE,SAAS,GAAG,OAAO,CAAC;IACpC,QAAQ,CAAC,KAAK,CAAC,EAAE,WAAW,CAAC;IAC7B,QAAQ,CAAC,OAAO,EAAE,SAAS,MAAM,EAAE,CAAC;IACpC,oEAAoE;IACpE,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;CACzB;AAED,MAAM,WAAW,WAAW;IAC1B,qDAAqD;IACrD,QAAQ,CAAC,cAAc,CAAC,EAAE,MAAM,CAAC;CAClC;AAED,kDAAkD;AAClD,MAAM,WAAW,aAAa;IAC5B,6BAA6B;IAC7B,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,CAAC;IAC1B,2BAA2B;IAC3B,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,CAAC;IACxB,4BAA4B;IAC5B,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC;CAC1B;AAED,eAAO,MAAM,iBAAiB,EAAE,QAAQ,CAAC,aAAa,CAIrD,CAAC;AAEF,MAAM,WAAW,iBAAiB;IAChC,QAAQ,CAAC,SAAS,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC;IACrD,kEAAkE;IAClE,QAAQ,CAAC,OAAO,CAAC,EAAE,SAAS,MAAM,EAAE,CAAC;CACtC"}

package/dist/config.js

@@ -0,0 +1,8 @@
+/** Configuration file version. `openchasqui migrate` moves it forward. */
+export const CONFIG_VERSION = 1;
+export const DEFAULT_VARIABLES = {
+    baseUrl: "baseUrl",
+    token: "token",
+    apiKey: "apiKey",
+};
+//# sourceMappingURL=config.js.map

package/dist/config.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"config.js","sourceRoot":"","sources":["../src/config.ts"],"names":[],"mappings":"AAAA,0EAA0E;AAC1E,MAAM,CAAC,MAAM,cAAc,GAAG,CAAU,CAAC;AAiCzC,MAAM,CAAC,MAAM,iBAAiB,GAA4B;IACxD,OAAO,EAAE,SAAS;IAClB,KAAK,EAAE,OAAO;IACd,MAAM,EAAE,QAAQ;CACjB,CAAC"}

package/dist/index.d.ts

@@ -0,0 +1,4 @@
+export * from "./config.js";
+export * from "./model.js";
+export * from "./plugin.js";
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,aAAa,CAAC;AAC5B,cAAc,YAAY,CAAC;AAC3B,cAAc,aAAa,CAAC"}

package/dist/index.js

@@ -0,0 +1,4 @@
+export * from "./config.js";
+export * from "./model.js";
+export * from "./plugin.js";
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,aAAa,CAAC;AAC5B,cAAc,YAAY,CAAC;AAC3B,cAAc,aAAa,CAAC"}

package/dist/model.d.ts

@@ -0,0 +1,97 @@
+/** Version of the canonical model. A breaking change ships with a migration. */
+export declare const MODEL_VERSION: 1;
+export type HttpMethod = "GET" | "POST" | "PUT" | "PATCH" | "DELETE" | "HEAD" | "OPTIONS";
+/** JSON Schema 2020-12, as found in an OpenAPI 3.1 document. */
+export type JsonSchema = {
+    readonly [keyword: string]: unknown;
+};
+export interface ApiModel {
+    readonly modelVersion: typeof MODEL_VERSION;
+    readonly info: ApiInfo;
+    readonly servers: readonly Server[];
+    readonly securitySchemes: Readonly<Record<string, SecurityScheme>>;
+    readonly operations: readonly Operation[];
+    readonly schemas: Readonly<Record<string, JsonSchema>>;
+}
+export interface ApiInfo {
+    readonly title: string;
+    readonly version: string;
+    readonly description?: string;
+}
+export interface Server {
+    readonly url: string;
+    readonly description?: string;
+}
+export type SecurityScheme = {
+    readonly type: "http";
+    readonly scheme: "bearer" | "basic";
+    readonly bearerFormat?: string;
+} | {
+    readonly type: "apiKey";
+    readonly in: "header" | "query" | "cookie";
+    readonly name: string;
+} | {
+    readonly type: "oauth2" | "openIdConnect";
+};
+export interface Operation {
+    /** The operationId, or the method plus the path when it is missing. */
+    readonly id: string;
+    readonly method: HttpMethod;
+    /** Path template with OpenAPI braces, e.g. `/banks/{id}`. */
+    readonly path: string;
+    /** Display name in the collection. */
+    readonly name: string;
+    /** Folder path from the root of the collection. */
+    readonly folder: readonly string[];
+    /** Position inside its folder, starting at 1. */
+    readonly order: number;
+    readonly summary?: string;
+    readonly description?: string;
+    readonly deprecated: boolean;
+    readonly parameters: readonly Parameter[];
+    readonly requestBody?: RequestBody;
+    readonly responses: readonly Response[];
+    /** Names of the security schemes that apply. Empty means public. */
+    readonly security: readonly string[];
+    readonly tests: readonly TestCase[];
+    /** `x-` extensions of the source operation, untouched. */
+    readonly extensions: Readonly<Record<string, unknown>>;
+}
+export type ParameterLocation = "path" | "query" | "header" | "cookie";
+export interface Parameter {
+    readonly name: string;
+    readonly in: ParameterLocation;
+    readonly required: boolean;
+    readonly description?: string;
+    readonly schema?: JsonSchema;
+    readonly example?: unknown;
+}
+export interface RequestBody {
+    readonly required: boolean;
+    readonly content: readonly MediaContent[];
+}
+export interface MediaContent {
+    readonly mediaType: string;
+    readonly schema?: JsonSchema;
+    readonly example?: unknown;
+}
+export interface Response {
+    /** Status code (`200`), range (`2XX`) or `default`, as in OpenAPI. */
+    readonly status: string;
+    readonly description?: string;
+    readonly content: readonly MediaContent[];
+}
+export type TestCase = {
+    readonly kind: "status";
+    readonly expected: readonly number[];
+} | {
+    readonly kind: "contentType";
+    readonly mediaType: string;
+} | {
+    readonly kind: "jsonSchema";
+    readonly schema: JsonSchema;
+} | {
+    readonly kind: "responseTime";
+    readonly maxMilliseconds: number;
+};
+//# sourceMappingURL=model.d.ts.map

package/dist/model.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"model.d.ts","sourceRoot":"","sources":["../src/model.ts"],"names":[],"mappings":"AAAA,gFAAgF;AAChF,eAAO,MAAM,aAAa,EAAG,CAAU,CAAC;AAExC,MAAM,MAAM,UAAU,GAAG,KAAK,GAAG,MAAM,GAAG,KAAK,GAAG,OAAO,GAAG,QAAQ,GAAG,MAAM,GAAG,SAAS,CAAC;AAE1F,gEAAgE;AAChE,MAAM,MAAM,UAAU,GAAG;IAAE,QAAQ,EAAE,OAAO,EAAE,MAAM,GAAG,OAAO,CAAA;CAAE,CAAC;AAEjE,MAAM,WAAW,QAAQ;IACvB,QAAQ,CAAC,YAAY,EAAE,OAAO,aAAa,CAAC;IAC5C,QAAQ,CAAC,IAAI,EAAE,OAAO,CAAC;IACvB,QAAQ,CAAC,OAAO,EAAE,SAAS,MAAM,EAAE,CAAC;IACpC,QAAQ,CAAC,eAAe,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,cAAc,CAAC,CAAC,CAAC;IACnE,QAAQ,CAAC,UAAU,EAAE,SAAS,SAAS,EAAE,CAAC;IAC1C,QAAQ,CAAC,OAAO,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,UAAU,CAAC,CAAC,CAAC;CACxD;AAED,MAAM,WAAW,OAAO;IACtB,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAC;CAC/B;AAED,MAAM,WAAW,MAAM;IACrB,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC;IACrB,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAC;CAC/B;AAED,MAAM,MAAM,cAAc,GACtB;IAAE,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IAAC,QAAQ,CAAC,MAAM,EAAE,QAAQ,GAAG,OAAO,CAAC;IAAC,QAAQ,CAAC,YAAY,CAAC,EAAE,MAAM,CAAA;CAAE,GAC9F;IAAE,QAAQ,CAAC,IAAI,EAAE,QAAQ,CAAC;IAAC,QAAQ,CAAC,EAAE,EAAE,QAAQ,GAAG,OAAO,GAAG,QAAQ,CAAC;IAAC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;CAAE,GAC9F;IAAE,QAAQ,CAAC,IAAI,EAAE,QAAQ,GAAG,eAAe,CAAA;CAAE,CAAC;AAElD,MAAM,WAAW,SAAS;IACxB,uEAAuE;IACvE,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IACpB,QAAQ,CAAC,MAAM,EAAE,UAAU,CAAC;IAC5B,6DAA6D;IAC7D,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,sCAAsC;IACtC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,mDAAmD;IACnD,QAAQ,CAAC,MAAM,EAAE,SAAS,MAAM,EAAE,CAAC;IACnC,iDAAiD;IACjD,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,CAAC;IAC1B,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAC;IAC9B,QAAQ,CAAC,UAAU,EAAE,OAAO,CAAC;IAC7B,QAAQ,CAAC,UAAU,EAAE,SAAS,SAAS,EAAE,CAAC;IAC1C,QAAQ,CAAC,WAAW,CAAC,EAAE,WAAW,CAAC;IACnC,QAAQ,CAAC,SAAS,EAAE,SAAS,QAAQ,EAAE,CAAC;IACxC,oEAAoE;IACpE,QAAQ,CAAC,QAAQ,EAAE,SAAS,MAAM,EAAE,CAAC;IACrC,QAAQ,CAAC,KAAK,EAAE,SAAS,QAAQ,EAAE,CAAC;IACpC,0DAA0D;IAC1D,QAAQ,CAAC,UAAU,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC;CACxD;AAED,MAAM,MAAM,iBAAiB,GAAG,MAAM,GAAG,OAAO,GAAG,QAAQ,GAAG,QAAQ,CAAC;AAEvE,MAAM,WAAW,SAAS;IACxB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,EAAE,EAAE,iBAAiB,CAAC;IAC/B,QAAQ,CAAC,QAAQ,EAAE,OAAO,CAAC;IAC3B,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAC;IAC9B,QAAQ,CAAC,MAAM,CAAC,EAAE,UAAU,CAAC;IAC7B,QAAQ,CAAC,OAAO,CAAC,EAAE,OAAO,CAAC;CAC5B;AAED,MAAM,WAAW,WAAW;IAC1B,QAAQ,CAAC,QAAQ,EAAE,OAAO,CAAC;IAC3B,QAAQ,CAAC,OAAO,EAAE,SAAS,YAAY,EAAE,CAAC;CAC3C;AAED,MAAM,WAAW,YAAY;IAC3B,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;IAC3B,QAAQ,CAAC,MAAM,CAAC,EAAE,UAAU,CAAC;IAC7B,QAAQ,CAAC,OAAO,CAAC,EAAE,OAAO,CAAC;CAC5B;AAED,MAAM,WAAW,QAAQ;IACvB,sEAAsE;IACtE,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAC;IAC9B,QAAQ,CAAC,OAAO,EAAE,SAAS,YAAY,EAAE,CAAC;CAC3C;AAED,MAAM,MAAM,QAAQ,GAChB;IAAE,QAAQ,CAAC,IAAI,EAAE,QAAQ,CAAC;IAAC,QAAQ,CAAC,QAAQ,EAAE,SAAS,MAAM,EAAE,CAAA;CAAE,GACjE;IAAE,QAAQ,CAAC,IAAI,EAAE,aAAa,CAAC;IAAC,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAA;CAAE,GAC5D;IAAE,QAAQ,CAAC,IAAI,EAAE,YAAY,CAAC;IAAC,QAAQ,CAAC,MAAM,EAAE,UAAU,CAAA;CAAE,GAC5D;IAAE,QAAQ,CAAC,IAAI,EAAE,cAAc,CAAC;IAAC,QAAQ,CAAC,eAAe,EAAE,MAAM,CAAA;CAAE,CAAC"}

package/dist/model.js

@@ -0,0 +1,3 @@
+/** Version of the canonical model. A breaking change ships with a migration. */
+export const MODEL_VERSION = 1;
+//# sourceMappingURL=model.js.map

package/dist/model.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"model.js","sourceRoot":"","sources":["../src/model.ts"],"names":[],"mappings":"AAAA,gFAAgF;AAChF,MAAM,CAAC,MAAM,aAAa,GAAG,CAAU,CAAC"}

package/dist/plugin.d.ts

@@ -0,0 +1,75 @@
+import type { VariableNames } from "./config.js";
+import type { ApiModel } from "./model.js";
+/** Plugin contract version. The core also accepts the previous one. */
+export declare const PLUGIN_API_VERSION: 1;
+export type PluginKind = "document-transformer" | "loader" | "transformer" | "generator" | "validator" | "emitter" | "runner" | "reporter";
+export interface PluginBase {
+    readonly name: string;
+    readonly kind: PluginKind;
+    readonly apiVersion: typeof PLUGIN_API_VERSION;
+}
+/** Reads files for a plugin. Plugins never touch the disk themselves. */
+export interface SourceReader {
+    readText(path: string): Promise<string>;
+}
+export interface PluginContext {
+    readonly reader: SourceReader;
+    readonly options: Readonly<Record<string, unknown>>;
+}
+export interface DocumentTransformResult {
+    readonly document: unknown;
+    readonly findings: readonly Finding[];
+}
+/** Changes the source document before a loader reads it, as Overlay does. */
+export interface DocumentTransformer extends PluginBase {
+    readonly kind: "document-transformer";
+    transformDocument(document: unknown, context: PluginContext): Promise<DocumentTransformResult>;
+}
+export interface Loader extends PluginBase {
+    readonly kind: "loader";
+    canLoad(document: unknown): boolean;
+    load(document: unknown, context: PluginContext): Promise<ApiModel>;
+}
+export interface Transformer extends PluginBase {
+    readonly kind: "transformer";
+    transform(model: ApiModel, context: PluginContext): Promise<ApiModel>;
+}
+export interface Generator extends PluginBase {
+    readonly kind: "generator";
+    generate(model: ApiModel, context: PluginContext): Promise<ApiModel>;
+}
+export type Severity = "error" | "warning" | "info";
+export interface Finding {
+    readonly rule: string;
+    readonly severity: Severity;
+    readonly message: string;
+    readonly operationId?: string;
+    readonly file?: string;
+}
+export interface Validator extends PluginBase {
+    readonly kind: "validator";
+    validate(model: ApiModel, context: PluginContext): Promise<readonly Finding[]>;
+}
+export interface EmittedFile {
+    /** Relative to the target folder, with forward slashes. */
+    readonly path: string;
+    readonly contents: string;
+}
+export interface EnvironmentDefinition {
+    readonly name: string;
+    readonly variables: Readonly<Record<string, string>>;
+    readonly secrets: readonly string[];
+}
+export interface EmitInput {
+    readonly model: ApiModel;
+    readonly environments: readonly EnvironmentDefinition[];
+    readonly variables: Required<VariableNames>;
+}
+export interface Emitter extends PluginBase {
+    readonly kind: "emitter";
+    /** Name used in the configuration, e.g. `postman`. */
+    readonly target: string;
+    emit(input: EmitInput, context: PluginContext): Promise<readonly EmittedFile[]>;
+}
+export type Plugin = DocumentTransformer | Loader | Transformer | Generator | Validator | Emitter;
+//# sourceMappingURL=plugin.d.ts.map

package/dist/plugin.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"plugin.d.ts","sourceRoot":"","sources":["../src/plugin.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AACjD,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAE3C,uEAAuE;AACvE,eAAO,MAAM,kBAAkB,EAAG,CAAU,CAAC;AAE7C,MAAM,MAAM,UAAU,GAClB,sBAAsB,GACtB,QAAQ,GACR,aAAa,GACb,WAAW,GACX,WAAW,GACX,SAAS,GACT,QAAQ,GACR,UAAU,CAAC;AAEf,MAAM,WAAW,UAAU;IACzB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,IAAI,EAAE,UAAU,CAAC;IAC1B,QAAQ,CAAC,UAAU,EAAE,OAAO,kBAAkB,CAAC;CAChD;AAED,yEAAyE;AACzE,MAAM,WAAW,YAAY;IAC3B,QAAQ,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;CACzC;AAED,MAAM,WAAW,aAAa;IAC5B,QAAQ,CAAC,MAAM,EAAE,YAAY,CAAC;IAC9B,QAAQ,CAAC,OAAO,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC;CACrD;AAED,MAAM,WAAW,uBAAuB;IACtC,QAAQ,CAAC,QAAQ,EAAE,OAAO,CAAC;IAC3B,QAAQ,CAAC,QAAQ,EAAE,SAAS,OAAO,EAAE,CAAC;CACvC;AAED,6EAA6E;AAC7E,MAAM,WAAW,mBAAoB,SAAQ,UAAU;IACrD,QAAQ,CAAC,IAAI,EAAE,sBAAsB,CAAC;IACtC,iBAAiB,CAAC,QAAQ,EAAE,OAAO,EAAE,OAAO,EAAE,aAAa,GAAG,OAAO,CAAC,uBAAuB,CAAC,CAAC;CAChG;AAED,MAAM,WAAW,MAAO,SAAQ,UAAU;IACxC,QAAQ,CAAC,IAAI,EAAE,QAAQ,CAAC;IACxB,OAAO,CAAC,QAAQ,EAAE,OAAO,GAAG,OAAO,CAAC;IACpC,IAAI,CAAC,QAAQ,EAAE,OAAO,EAAE,OAAO,EAAE,aAAa,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAC;CACpE;AAED,MAAM,WAAW,WAAY,SAAQ,UAAU;IAC7C,QAAQ,CAAC,IAAI,EAAE,aAAa,CAAC;IAC7B,SAAS,CAAC,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,aAAa,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAC;CACvE;AAED,MAAM,WAAW,SAAU,SAAQ,UAAU;IAC3C,QAAQ,CAAC,IAAI,EAAE,WAAW,CAAC;IAC3B,QAAQ,CAAC,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,aAAa,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAC;CACtE;AAED,MAAM,MAAM,QAAQ,GAAG,OAAO,GAAG,SAAS,GAAG,MAAM,CAAC;AAEpD,MAAM,WAAW,OAAO;IACtB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAC;IAC5B,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAC;IAC9B,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,CAAC;CACxB;AAED,MAAM,WAAW,SAAU,SAAQ,UAAU;IAC3C,QAAQ,CAAC,IAAI,EAAE,WAAW,CAAC;IAC3B,QAAQ,CAAC,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,aAAa,GAAG,OAAO,CAAC,SAAS,OAAO,EAAE,CAAC,CAAC;CAChF;AAED,MAAM,WAAW,WAAW;IAC1B,2DAA2D;IAC3D,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;CAC3B;AAED,MAAM,WAAW,qBAAqB;IACpC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,SAAS,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC;IACrD,QAAQ,CAAC,OAAO,EAAE,SAAS,MAAM,EAAE,CAAC;CACrC;AAED,MAAM,WAAW,SAAS;IACxB,QAAQ,CAAC,KAAK,EAAE,QAAQ,CAAC;IACzB,QAAQ,CAAC,YAAY,EAAE,SAAS,qBAAqB,EAAE,CAAC;IACxD,QAAQ,CAAC,SAAS,EAAE,QAAQ,CAAC,aAAa,CAAC,CAAC;CAC7C;AAED,MAAM,WAAW,OAAQ,SAAQ,UAAU;IACzC,QAAQ,CAAC,IAAI,EAAE,SAAS,CAAC;IACzB,sDAAsD;IACtD,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,IAAI,CAAC,KAAK,EAAE,SAAS,EAAE,OAAO,EAAE,aAAa,GAAG,OAAO,CAAC,SAAS,WAAW,EAAE,CAAC,CAAC;CACjF;AAED,MAAM,MAAM,MAAM,GAAG,mBAAmB,GAAG,MAAM,GAAG,WAAW,GAAG,SAAS,GAAG,SAAS,GAAG,OAAO,CAAC"}

package/dist/plugin.js

@@ -0,0 +1,3 @@
+/** Plugin contract version. The core also accepts the previous one. */
+export const PLUGIN_API_VERSION = 1;
+//# sourceMappingURL=plugin.js.map

package/dist/plugin.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"plugin.js","sourceRoot":"","sources":["../src/plugin.ts"],"names":[],"mappings":"AAGA,uEAAuE;AACvE,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAAU,CAAC"}

package/package.json

@@ -1,6 +1,33 @@
 {
   "name": "@abitechdev/openchasqui-spec",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
+  "version": "0.1.1",
+  "description": "Canonical API model, plugin contract and configuration types for OpenChasqui.",
+  "keywords": [
+    "openapi",
+    "api-model",
+    "plugin-contract",
+    "typescript",
+    "openchasqui"
+  ],
+  "license": "Apache-2.0",
+  "type": "module",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist",
+    "src",
+    "NOTICE"
+  ],
+  "engines": {
+    "node": ">=22"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/abitech-dev/abitech-openchasqui-cli.git",
+    "directory": "packages/spec"
+  }
 }

package/src/config.ts

@@ -0,0 +1,45 @@
+/** Configuration file version. `openchasqui migrate` moves it forward. */
+export const CONFIG_VERSION = 1 as const;
+
+export interface OpenChasquiConfig {
+  readonly version: typeof CONFIG_VERSION;
+  /** Path to the OpenAPI document, relative to the configuration file. */
+  readonly source: string;
+  /** Overlay 1.0 documents, applied in order. */
+  readonly overlays?: readonly string[];
+  readonly environments?: Readonly<Record<string, EnvironmentConfig>>;
+  readonly variables?: VariableNames;
+  /** Data set for synthetic examples, `generic` by default or `es-pe`. */
+  readonly data?: "generic" | "es-pe";
+  readonly tests?: TestOptions;
+  readonly targets: readonly string[];
+  /** Folder for the emitted collections, one subfolder per target. */
+  readonly output: string;
+}
+
+export interface TestOptions {
+  /** Slowest acceptable response. Defaults to 5000. */
+  readonly responseTimeMs?: number;
+}
+
+/** Names of the variables the collections use. */
+export interface VariableNames {
+  /** Defaults to `baseUrl`. */
+  readonly baseUrl?: string;
+  /** Defaults to `token`. */
+  readonly token?: string;
+  /** Defaults to `apiKey`. */
+  readonly apiKey?: string;
+}
+
+export const DEFAULT_VARIABLES: Required<VariableNames> = {
+  baseUrl: "baseUrl",
+  token: "token",
+  apiKey: "apiKey",
+};
+
+export interface EnvironmentConfig {
+  readonly variables: Readonly<Record<string, string>>;
+  /** Variable names whose values never leave the user's machine. */
+  readonly secrets?: readonly string[];
+}

package/src/index.ts

@@ -0,0 +1,3 @@
+export * from "./config.js";
+export * from "./model.js";
+export * from "./plugin.js";

package/src/model.ts

@@ -0,0 +1,92 @@
+/** Version of the canonical model. A breaking change ships with a migration. */
+export const MODEL_VERSION = 1 as const;
+
+export type HttpMethod = "GET" | "POST" | "PUT" | "PATCH" | "DELETE" | "HEAD" | "OPTIONS";
+
+/** JSON Schema 2020-12, as found in an OpenAPI 3.1 document. */
+export type JsonSchema = { readonly [keyword: string]: unknown };
+
+export interface ApiModel {
+  readonly modelVersion: typeof MODEL_VERSION;
+  readonly info: ApiInfo;
+  readonly servers: readonly Server[];
+  readonly securitySchemes: Readonly<Record<string, SecurityScheme>>;
+  readonly operations: readonly Operation[];
+  readonly schemas: Readonly<Record<string, JsonSchema>>;
+}
+
+export interface ApiInfo {
+  readonly title: string;
+  readonly version: string;
+  readonly description?: string;
+}
+
+export interface Server {
+  readonly url: string;
+  readonly description?: string;
+}
+
+export type SecurityScheme =
+  | { readonly type: "http"; readonly scheme: "bearer" | "basic"; readonly bearerFormat?: string }
+  | { readonly type: "apiKey"; readonly in: "header" | "query" | "cookie"; readonly name: string }
+  | { readonly type: "oauth2" | "openIdConnect" };
+
+export interface Operation {
+  /** The operationId, or the method plus the path when it is missing. */
+  readonly id: string;
+  readonly method: HttpMethod;
+  /** Path template with OpenAPI braces, e.g. `/banks/{id}`. */
+  readonly path: string;
+  /** Display name in the collection. */
+  readonly name: string;
+  /** Folder path from the root of the collection. */
+  readonly folder: readonly string[];
+  /** Position inside its folder, starting at 1. */
+  readonly order: number;
+  readonly summary?: string;
+  readonly description?: string;
+  readonly deprecated: boolean;
+  readonly parameters: readonly Parameter[];
+  readonly requestBody?: RequestBody;
+  readonly responses: readonly Response[];
+  /** Names of the security schemes that apply. Empty means public. */
+  readonly security: readonly string[];
+  readonly tests: readonly TestCase[];
+  /** `x-` extensions of the source operation, untouched. */
+  readonly extensions: Readonly<Record<string, unknown>>;
+}
+
+export type ParameterLocation = "path" | "query" | "header" | "cookie";
+
+export interface Parameter {
+  readonly name: string;
+  readonly in: ParameterLocation;
+  readonly required: boolean;
+  readonly description?: string;
+  readonly schema?: JsonSchema;
+  readonly example?: unknown;
+}
+
+export interface RequestBody {
+  readonly required: boolean;
+  readonly content: readonly MediaContent[];
+}
+
+export interface MediaContent {
+  readonly mediaType: string;
+  readonly schema?: JsonSchema;
+  readonly example?: unknown;
+}
+
+export interface Response {
+  /** Status code (`200`), range (`2XX`) or `default`, as in OpenAPI. */
+  readonly status: string;
+  readonly description?: string;
+  readonly content: readonly MediaContent[];
+}
+
+export type TestCase =
+  | { readonly kind: "status"; readonly expected: readonly number[] }
+  | { readonly kind: "contentType"; readonly mediaType: string }
+  | { readonly kind: "jsonSchema"; readonly schema: JsonSchema }
+  | { readonly kind: "responseTime"; readonly maxMilliseconds: number };

package/src/plugin.ts

@@ -0,0 +1,100 @@
+import type { VariableNames } from "./config.js";
+import type { ApiModel } from "./model.js";
+
+/** Plugin contract version. The core also accepts the previous one. */
+export const PLUGIN_API_VERSION = 1 as const;
+
+export type PluginKind =
+  | "document-transformer"
+  | "loader"
+  | "transformer"
+  | "generator"
+  | "validator"
+  | "emitter"
+  | "runner"
+  | "reporter";
+
+export interface PluginBase {
+  readonly name: string;
+  readonly kind: PluginKind;
+  readonly apiVersion: typeof PLUGIN_API_VERSION;
+}
+
+/** Reads files for a plugin. Plugins never touch the disk themselves. */
+export interface SourceReader {
+  readText(path: string): Promise<string>;
+}
+
+export interface PluginContext {
+  readonly reader: SourceReader;
+  readonly options: Readonly<Record<string, unknown>>;
+}
+
+export interface DocumentTransformResult {
+  readonly document: unknown;
+  readonly findings: readonly Finding[];
+}
+
+/** Changes the source document before a loader reads it, as Overlay does. */
+export interface DocumentTransformer extends PluginBase {
+  readonly kind: "document-transformer";
+  transformDocument(document: unknown, context: PluginContext): Promise<DocumentTransformResult>;
+}
+
+export interface Loader extends PluginBase {
+  readonly kind: "loader";
+  canLoad(document: unknown): boolean;
+  load(document: unknown, context: PluginContext): Promise<ApiModel>;
+}
+
+export interface Transformer extends PluginBase {
+  readonly kind: "transformer";
+  transform(model: ApiModel, context: PluginContext): Promise<ApiModel>;
+}
+
+export interface Generator extends PluginBase {
+  readonly kind: "generator";
+  generate(model: ApiModel, context: PluginContext): Promise<ApiModel>;
+}
+
+export type Severity = "error" | "warning" | "info";
+
+export interface Finding {
+  readonly rule: string;
+  readonly severity: Severity;
+  readonly message: string;
+  readonly operationId?: string;
+  readonly file?: string;
+}
+
+export interface Validator extends PluginBase {
+  readonly kind: "validator";
+  validate(model: ApiModel, context: PluginContext): Promise<readonly Finding[]>;
+}
+
+export interface EmittedFile {
+  /** Relative to the target folder, with forward slashes. */
+  readonly path: string;
+  readonly contents: string;
+}
+
+export interface EnvironmentDefinition {
+  readonly name: string;
+  readonly variables: Readonly<Record<string, string>>;
+  readonly secrets: readonly string[];
+}
+
+export interface EmitInput {
+  readonly model: ApiModel;
+  readonly environments: readonly EnvironmentDefinition[];
+  readonly variables: Required<VariableNames>;
+}
+
+export interface Emitter extends PluginBase {
+  readonly kind: "emitter";
+  /** Name used in the configuration, e.g. `postman`. */
+  readonly target: string;
+  emit(input: EmitInput, context: PluginContext): Promise<readonly EmittedFile[]>;
+}
+
+export type Plugin = DocumentTransformer | Loader | Transformer | Generator | Validator | Emitter;