@contractspec/lib.contracts-transformers 0.0.0-canary-20260113162409

package/dist/openapi/types.d.ts

@@ -0,0 +1,277 @@
+import { SpecSource, TransportHints } from "../common/types.js";
+import { OpenAPIV3, OpenAPIV3_1 } from "openapi-types";
+
+//#region src/openapi/types.d.ts
+
+/**
+ * Supported OpenAPI versions.
+ */
+type OpenApiVersion = '3.0' | '3.1';
+/**
+ * OpenAPI document (union of supported versions).
+ */
+type OpenApiDocument = OpenAPIV3.Document | OpenAPIV3_1.Document;
+/**
+ * OpenAPI operation object.
+ */
+type OpenApiOperation = OpenAPIV3.OperationObject | OpenAPIV3_1.OperationObject;
+/**
+ * OpenAPI schema object.
+ */
+type OpenApiSchema = OpenAPIV3.SchemaObject | OpenAPIV3_1.SchemaObject | OpenAPIV3.ReferenceObject | OpenAPIV3_1.ReferenceObject;
+/**
+ * OpenAPI parameter object.
+ */
+type OpenApiParameter = OpenAPIV3.ParameterObject | OpenAPIV3_1.ParameterObject | OpenAPIV3.ReferenceObject | OpenAPIV3_1.ReferenceObject;
+/**
+ * HTTP methods supported by OpenAPI.
+ */
+type HttpMethod = 'get' | 'post' | 'put' | 'delete' | 'patch' | 'head' | 'options' | 'trace';
+/**
+ * Parameter location in OpenAPI.
+ */
+type ParameterLocation = 'path' | 'query' | 'header' | 'cookie';
+/**
+ * Server configuration for OpenAPI export.
+ */
+interface OpenApiServer {
+  url: string;
+  description?: string;
+  variables?: Record<string, {
+    default: string;
+    enum?: string[];
+    description?: string;
+  }>;
+}
+/**
+ * Options for exporting to OpenAPI.
+ */
+interface OpenApiExportOptions {
+  /** API title */
+  title?: string;
+  /** API version */
+  version?: string;
+  /** API description */
+  description?: string;
+  /** Server configurations */
+  servers?: OpenApiServer[];
+  /** Additional OpenAPI extensions */
+  extensions?: Record<string, unknown>;
+}
+/**
+ * Options for parsing OpenAPI documents.
+ */
+interface OpenApiParseOptions {
+  /** Base URL for resolving relative references */
+  baseUrl?: string;
+  /** Whether to resolve $ref references */
+  resolveRefs?: boolean;
+  /** Timeout for HTTP requests (ms) */
+  timeout?: number;
+}
+/**
+ * Parsed operation with resolved metadata.
+ */
+interface ParsedOperation {
+  /** Operation ID (generated if not present) */
+  operationId: string;
+  /** HTTP method */
+  method: HttpMethod;
+  /** Path template */
+  path: string;
+  /** Operation summary */
+  summary?: string;
+  /** Operation description */
+  description?: string;
+  /** Operation tags */
+  tags: string[];
+  /** Path parameters */
+  pathParams: ParsedParameter[];
+  /** Query parameters */
+  queryParams: ParsedParameter[];
+  /** Header parameters */
+  headerParams: ParsedParameter[];
+  /** Cookie parameters */
+  cookieParams: ParsedParameter[];
+  /** Request body schema */
+  requestBody?: {
+    required: boolean;
+    schema: OpenApiSchema;
+    contentType: string;
+  };
+  /** Response schemas by status code */
+  responses: Record<string, {
+    description: string;
+    schema?: OpenApiSchema;
+    contentType?: string;
+  }>;
+  /** Whether the operation is deprecated */
+  deprecated: boolean;
+  /** Security requirements */
+  security?: Record<string, string[]>[];
+  /** ContractSpec extension data if present */
+  contractSpecMeta?: {
+    name: string;
+    version: string;
+    kind: 'command' | 'query';
+  };
+}
+/**
+ * Parsed parameter with resolved schema.
+ */
+interface ParsedParameter {
+  /** Parameter name */
+  name: string;
+  /** Parameter location */
+  in: ParameterLocation;
+  /** Whether the parameter is required */
+  required: boolean;
+  /** Parameter description */
+  description?: string;
+  /** Parameter schema */
+  schema: OpenApiSchema;
+  /** Whether the parameter is deprecated */
+  deprecated: boolean;
+}
+/**
+ * Result of parsing an OpenAPI document.
+ */
+interface ParseResult {
+  /** Original document */
+  document: OpenApiDocument;
+  /** Detected OpenAPI version */
+  version: OpenApiVersion;
+  /** API info */
+  info: {
+    title: string;
+    version: string;
+    description?: string;
+  };
+  /** Parsed operations */
+  operations: ParsedOperation[];
+  /** Component schemas (resolved) */
+  schemas: Record<string, OpenApiSchema>;
+  /** Servers */
+  servers: OpenApiServer[];
+  /** Parse warnings */
+  warnings: string[];
+  /** Parsed events (webhooks) */
+  events: ParsedEvent[];
+}
+/**
+ * Parsed event (webhook).
+ */
+interface ParsedEvent {
+  /** Event name */
+  name: string;
+  /** Event description */
+  description?: string;
+  /** Event payload schema */
+  payload: OpenApiSchema;
+}
+/**
+ * OpenAPI-specific transport hints.
+ */
+interface OpenApiTransportHints extends TransportHints {
+  rest: {
+    method: 'GET' | 'POST' | 'PUT' | 'DELETE' | 'PATCH' | 'HEAD' | 'OPTIONS';
+    path: string;
+    params?: {
+      path?: string[];
+      query?: string[];
+      header?: string[];
+      cookie?: string[];
+    };
+  };
+}
+/**
+ * OpenAPI-specific source information.
+ */
+interface OpenApiSource extends SpecSource {
+  type: 'openapi';
+  /** OpenAPI version of source document */
+  openApiVersion: OpenApiVersion;
+  /** Original operationId from OpenAPI */
+  operationId: string;
+}
+/**
+ * ContractSpec-compatible OpenAPI document structure.
+ * Used for export to maintain compatibility with existing code.
+ */
+interface ContractSpecOpenApiDocument {
+  openapi: '3.1.0';
+  info: {
+    title: string;
+    version: string;
+    description?: string;
+  };
+  servers?: OpenApiServer[];
+  paths: Record<string, Record<string, unknown>>;
+  components: {
+    schemas: Record<string, Record<string, unknown>>;
+  };
+  /** ContractSpec extensions for features */
+  'x-contractspec-features'?: unknown[];
+  /** ContractSpec extensions for events */
+  'x-contractspec-events'?: unknown[];
+  /** ContractSpec extensions for presentations */
+  'x-contractspec-presentations'?: unknown[];
+  /** ContractSpec extensions for forms */
+  'x-contractspec-forms'?: unknown[];
+  /** ContractSpec extensions for data views */
+  'x-contractspec-dataviews'?: unknown[];
+  /** ContractSpec extensions for workflows */
+  'x-contractspec-workflows'?: unknown[];
+}
+/**
+ * Unified export options for all ContractSpec surfaces.
+ */
+interface ContractSpecExportOptions extends OpenApiExportOptions {
+  /** Include operations in export (default: true) */
+  operations?: boolean;
+  /** Include events in export (default: true) */
+  events?: boolean;
+  /** Include features in export (default: true) */
+  features?: boolean;
+  /** Include presentations (V1 and V2) in export (default: true) */
+  presentations?: boolean;
+  /** Include forms in export (default: true) */
+  forms?: boolean;
+  /** Include data views in export (default: true) */
+  dataViews?: boolean;
+  /** Include workflows in export (default: true) */
+  workflows?: boolean;
+  /** Generate TypeScript registry code (default: true) */
+  generateRegistries?: boolean;
+}
+/**
+ * Generated registry code for a specific surface.
+ */
+interface GeneratedRegistryCode {
+  /** The generated TypeScript code */
+  code: string;
+  /** Suggested filename for the registry */
+  fileName: string;
+}
+/**
+ * Result of unified ContractSpec export.
+ */
+interface ContractSpecExportResult {
+  /** OpenAPI document with ContractSpec extensions */
+  openApi: ContractSpecOpenApiDocument;
+  /** Generated TypeScript code for registries */
+  registries?: {
+    operations?: GeneratedRegistryCode;
+    events?: GeneratedRegistryCode;
+    features?: GeneratedRegistryCode;
+    presentations?: GeneratedRegistryCode;
+    forms?: GeneratedRegistryCode;
+    dataViews?: GeneratedRegistryCode;
+    workflows?: GeneratedRegistryCode;
+    /** Index file that re-exports all registries */
+    index?: GeneratedRegistryCode;
+  };
+}
+//#endregion
+export { ContractSpecExportOptions, ContractSpecExportResult, ContractSpecOpenApiDocument, GeneratedRegistryCode, HttpMethod, OpenApiDocument, OpenApiExportOptions, OpenApiOperation, OpenApiParameter, OpenApiParseOptions, OpenApiSchema, OpenApiServer, OpenApiSource, OpenApiTransportHints, OpenApiVersion, ParameterLocation, ParseResult, ParsedOperation, ParsedParameter };
+//# sourceMappingURL=types.d.ts.map

package/dist/openapi/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","names":[],"sources":["../../src/openapi/types.ts"],"sourcesContent":[],"mappings":";;;;;AAcA;AAKA;AAOA;AACI,KAlBQ,cAAA,GAkBE,KAAA,GAAA,KAAA;;;;AAGiB,KAhBnB,eAAA,GAAkB,SAAA,CAAU,QAgBT,GAhBoB,WAAA,CAAY,QAgBhC;AAK/B;;;AAGI,KAnBQ,gBAAA,GACR,SAAA,CAAU,eAkBA,GAjBV,WAAA,CAAY,eAiBF;;;AAMd;AAaY,KA/BA,aAAA,GACR,SAAA,CAAU,YA8Be,GA7BzB,WAAA,CAAY,YA6Ba,GA5BzB,SAAA,CAAU,eA4Be,GA3BzB,WAAA,CAAY,eA2Ba;AAK7B;AAgBA;AAgBA;AAYiB,KAvEL,gBAAA,GACR,SAAA,CAAU,eAsEkB,GArE5B,WAAA,CAAY,eAqEgB,GApE5B,SAAA,CAAU,eAoEkB,GAnE5B,WAAA,CAAY,eAmEgB;;;;AAkBhB,KAhFJ,UAAA,GAgFI,KAAA,GAAA,MAAA,GAAA,KAAA,GAAA,QAAA,GAAA,OAAA,GAAA,MAAA,GAAA,SAAA,GAAA,OAAA;;;;AAUH,KA7ED,iBAAA,GA6EC,MAAA,GAAA,OAAA,GAAA,QAAA,GAAA,QAAA;;;AAuBb;AAkBiB,UAjHA,aAAA,CAiHW;EAEhB,GAAA,EAAA,MAAA;EAED,WAAA,CAAA,EAAA,MAAA;EAQG,SAAA,CAAA,EA1HA,MA0HA,CAAA,MAAA,EAAA;IAEY,OAAA,EAAA,MAAA;IAAf,IAAA,CAAA,EAAA,MAAA,EAAA;IAEA,WAAA,CAAA,EAAA,MAAA;EAID,CAAA,CAAA;;AAMV;AAYA;AAgBA;AAYiB,UAnKA,oBAAA,CAmK2B;EAOhC;EACY,KAAA,CAAA,EAAA,MAAA;EAAf;EAEmB,OAAA,CAAA,EAAA,MAAA;EAAf;EAAM,WAAA,CAAA,EAAA,MAAA;EAmBF;EAsBA,OAAA,CAAA,EA9ML,aA8MK,EAAqB;EAUrB;EAEN,UAAA,CAAA,EAxNI,MAwNJ,CAAA,MAAA,EAAA,OAAA,CAAA;;;;;AAOC,UAzNK,mBAAA,CAyNL;EACI;EACA,OAAA,CAAA,EAAA,MAAA;EAEJ;EAAqB,WAAA,CAAA,EAAA,OAAA;;;;;;;UAjNhB,eAAA;;;;UAIP;;;;;;;;;;cAUI;;eAEC;;gBAEC;;gBAEA;;;;YAIJ;;;;aAIC;;aAIE;;;;;;aAOF;;;;;;;;;;;UAYI,eAAA;;;;MAIX;;;;;;UAMI;;;;;;;UAQO,WAAA;;YAEL;;WAED;;;;;;;;cAQG;;WAEH,eAAe;;WAEf;;;;UAID;;;;;UAMO,WAAA;;;;;;WAMN;;;;;UAMM,qBAAA,SAA8B;;;;;;;;;;;;;;;UAgB9B,aAAA,SAAsB;;;kBAGrB;;;;;;;;UASD,2BAAA;;;;;;;YAOL;SACH,eAAe;;aAEX,eAAe;;;;;;;;;;;;;;;;;;UAmBX,yBAAA,SAAkC;;;;;;;;;;;;;;;;;;;;;UAsBlC,qBAAA;;;;;;;;;UAUA,wBAAA;;WAEN;;;iBAGM;aACJ;eACE;oBACK;YACR;gBACI;gBACA;;YAEJ"}

package/package.json

@@ -0,0 +1,69 @@
+{
+  "name": "@contractspec/lib.contracts-transformers",
+  "version": "0.0.0-canary-20260113162409",
+  "description": "Contract format transformations: import/export between ContractSpec and external formats (OpenAPI, AsyncAPI, etc.)",
+  "keywords": [
+    "contractspec",
+    "openapi",
+    "asyncapi",
+    "transformers",
+    "code-generation",
+    "typescript"
+  ],
+  "type": "module",
+  "scripts": {
+    "publish:pkg": "bun publish --tolerate-republish --ignore-scripts --verbose",
+    "publish:pkg:canary": "bun publish:pkg --tag canary",
+    "build": "bun build:types && bun build:bundle",
+    "build:bundle": "tsdown",
+    "build:types": "tsc --noEmit",
+    "dev": "bun build:bundle --watch",
+    "clean": "rimraf dist .turbo",
+    "lint": "bun lint:fix",
+    "lint:fix": "eslint src --fix",
+    "lint:check": "eslint src",
+    "test": "bun test"
+  },
+  "dependencies": {
+    "@contractspec/lib.contracts": "0.0.0-canary-20260113162409",
+    "@contractspec/lib.schema": "0.0.0-canary-20260113162409",
+    "compare-versions": "^6.1.1",
+    "openapi-types": "^12.1.3",
+    "yaml": "^2.7.1",
+    "zod": "^4.3.5"
+  },
+  "devDependencies": {
+    "@contractspec/tool.tsdown": "0.0.0-canary-20260113162409",
+    "@contractspec/tool.typescript": "0.0.0-canary-20260113162409",
+    "tsdown": "^0.19.0",
+    "typescript": "^5.9.3"
+  },
+  "types": "./dist/index.d.ts",
+  "files": [
+    "dist",
+    "README.md"
+  ],
+  "exports": {
+    ".": "./dist/index.js",
+    "./common": "./dist/common/index.js",
+    "./openapi": "./dist/openapi/index.js",
+    "./*": "./*"
+  },
+  "publishConfig": {
+    "access": "public",
+    "exports": {
+      ".": "./dist/index.js",
+      "./common": "./dist/common/index.js",
+      "./openapi": "./dist/openapi/index.js",
+      "./*": "./*"
+    },
+    "registry": "https://registry.npmjs.org/"
+  },
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/lssm-tech/contractspec.git",
+    "directory": "packages/libs/contracts-transformers"
+  },
+  "homepage": "https://contractspec.io"
+}