@contractspec/lib.plugins 1.48.1

package/README.md

@@ -0,0 +1,63 @@
+# @contractspec/lib.plugins
+
+Core plugin API for ContractSpec. Defines plugin interfaces, registry management, and discovery configuration.
+
+## Overview
+
+Use this package to build generator, validator, adapter, formatter, and registry resolver plugins. The core types keep plugin behavior consistent while allowing capability-specific logic.
+
+## Installation
+
+```bash
+bun add @contractspec/lib.plugins
+```
+
+## Usage
+
+```typescript
+import type { ContractSpecPlugin, PluginContext } from "@contractspec/lib.plugins";
+
+export const MarkdownGeneratorPlugin: ContractSpecPlugin = {
+  meta: {
+    id: "markdown-generator",
+    version: "1.0.0",
+    type: "generator",
+    provides: ["docs"],
+  },
+  register(context: PluginContext) {
+    context.generators.register({
+      id: "markdown",
+      description: "Generate markdown docs",
+      generate: async (specs) => {
+        // Implementation
+      },
+    });
+  },
+};
+```
+
+## Capabilities
+
+- **Generators**: Produce code, docs, schemas, or artifacts.
+- **Validators**: Enforce policies and compliance checks.
+- **Adapters**: Integrate frameworks or runtimes.
+- **Formatters**: Post-process generated output.
+- **Registry resolvers**: Resolve plugins from workspace, npm, or remote registries.
+
+## Registry configuration
+
+```json
+{
+  "plugins": [
+    {
+      "id": "markdown-generator",
+      "package": "@contractspec/plugin.markdown-generator",
+      "capabilities": ["generator"],
+      "options": {
+        "outputDir": "./docs/generated",
+        "format": "table"
+      }
+    }
+  ]
+}
+```

package/dist/index.d.mts

@@ -0,0 +1,113 @@
+import { AnySchemaModel } from "@contractspec/lib.schema";
+
+//#region src/types.d.ts
+type SpecDefinition = unknown;
+type PluginCapabilityType = 'generator' | 'validator' | 'adapter' | 'formatter' | 'registryResolver';
+interface PluginMeta {
+  id: string;
+  version: string;
+  type: PluginCapabilityType;
+  provides: string[];
+  description?: string;
+  compatibility?: string;
+}
+interface PluginContext {
+  workspaceRoot: string;
+  configPath?: string;
+  generators: GeneratorRegistry;
+  validators: ValidatorRegistry;
+  adapters: AdapterRegistry;
+  formatters: FormatterRegistry;
+  registryResolvers: RegistryResolverRegistry;
+}
+interface PluginRegistryItem {
+  id: string;
+  package: string;
+  capabilities: PluginCapabilityType[];
+  options?: Record<string, unknown>;
+}
+interface PluginRegistryConfig {
+  plugins: PluginRegistryItem[];
+  registry?: {
+    resolutionOrder: ('workspace' | 'npm' | 'remote')[];
+    allowPrerelease?: boolean;
+    sources?: Record<string, string>;
+  };
+}
+interface GeneratorCapability {
+  id: string;
+  description?: string;
+  generate: (specs: SpecDefinition[], context: PluginContext) => Promise<void>;
+}
+interface ValidatorCapability {
+  id: string;
+  description?: string;
+  validate: (specs: SpecDefinition[], context: PluginContext) => Promise<void>;
+}
+interface AdapterCapability {
+  id: string;
+  description?: string;
+  create: (context: PluginContext) => Promise<unknown>;
+}
+interface FormatterCapability {
+  id: string;
+  description?: string;
+  format: (output: string, context: PluginContext) => Promise<string>;
+}
+interface RegistryResolverCapability {
+  id: string;
+  description?: string;
+  resolve: (request: {
+    package: string;
+  }) => Promise<Record<string, unknown>>;
+}
+interface ContractSpecPlugin {
+  meta: PluginMeta;
+  register: (context: PluginContext) => void | Promise<void>;
+  configure?: (options: Record<string, unknown>, context: PluginContext) => void | Promise<void>;
+  validate?: (specs: SpecDefinition[], context: PluginContext) => void | Promise<void>;
+  generate?: (specs: SpecDefinition[], context: PluginContext) => void | Promise<void>;
+  dispose?: () => void | Promise<void>;
+}
+interface GeneratorRegistry {
+  register: (generator: GeneratorCapability) => void;
+  list: () => GeneratorCapability[];
+}
+interface ValidatorRegistry {
+  register: (validator: ValidatorCapability) => void;
+  list: () => ValidatorCapability[];
+}
+interface AdapterRegistry {
+  register: (adapter: AdapterCapability) => void;
+  list: () => AdapterCapability[];
+}
+interface FormatterRegistry {
+  register: (formatter: FormatterCapability) => void;
+  list: () => FormatterCapability[];
+}
+interface RegistryResolverRegistry {
+  register: (resolver: RegistryResolverCapability) => void;
+  list: () => RegistryResolverCapability[];
+}
+interface SpecRegistryEntry {
+  id: string;
+  spec: SpecDefinition;
+  schemas: Record<string, AnySchemaModel>;
+}
+//#endregion
+//#region src/registry.d.ts
+declare class PluginRegistries {
+  readonly generators: GeneratorRegistry;
+  readonly validators: ValidatorRegistry;
+  readonly adapters: AdapterRegistry;
+  readonly formatters: FormatterRegistry;
+  readonly registryResolvers: RegistryResolverRegistry;
+  constructor();
+}
+declare const defaultPluginRegistryConfig: PluginRegistryConfig;
+//#endregion
+//#region src/config.d.ts
+declare function mergePluginConfig(config?: Partial<PluginRegistryConfig>): PluginRegistryConfig;
+//#endregion
+export { type AdapterCapability, type AdapterRegistry, type ContractSpecPlugin, type FormatterCapability, type FormatterRegistry, type GeneratorCapability, type GeneratorRegistry, type PluginCapabilityType, type PluginContext, type PluginMeta, PluginRegistries, type PluginRegistryConfig, type PluginRegistryItem, type RegistryResolverCapability, type RegistryResolverRegistry, type SpecRegistryEntry, type ValidatorCapability, type ValidatorRegistry, defaultPluginRegistryConfig, mergePluginConfig };
+//# sourceMappingURL=index.d.mts.map

package/dist/index.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.mts","names":[],"sources":["../src/types.ts","../src/registry.ts","../src/config.ts"],"sourcesContent":[],"mappings":";;;KAEY,cAAA;KAEA,oBAAA;AAFA,UASK,UAAA,CATS;EAEd,EAAA,EAAA,MAAA;EAOK,OAAA,EAAA,MAAU;EASV,IAAA,EANT,oBAMsB;EAGhB,QAAA,EAAA,MAAA,EAAA;EACA,WAAA,CAAA,EAAA,MAAA;EACF,aAAA,CAAA,EAAA,MAAA;;AAES,UAPJ,aAAA,CAOI;EAAwB,aAAA,EAAA,MAAA;EAG5B,UAAA,CAAA,EAAA,MAAA;EAOA,UAAA,EAdH,iBAcuB;EASpB,UAAA,EAtBH,iBAsBsB;EAGhB,QAAA,EAxBR,eAwBQ;EAA2B,UAAA,EAvBjC,iBAuBiC;EAAkB,iBAAA,EAtB5C,wBAsB4C;;AAGhD,UAtBA,kBAAA,CAsBmB;EAGhB,EAAA,EAAA,MAAA;EAA2B,OAAA,EAAA,MAAA;EAAkB,YAAA,EAtBjD,oBAsBiD,EAAA;EAAO,OAAA,CAAA,EArB5D,MAqB4D,CAAA,MAAA,EAAA,OAAA,CAAA;AAGxE;AAMiB,UA3BA,oBAAA,CA8BmB;EAGnB,OAAA,EAhCN,kBAgCM,EAA0B;EAM1B,QAAA,CAAA,EAAA;IACT,eAAA,EAAA,CAAA,WAAA,GAAA,KAAA,GAAA,QAAA,CAAA,EAAA;IACc,eAAA,CAAA,EAAA,OAAA;IAAyB,OAAA,CAAA,EApCjC,MAoCiC,CAAA,MAAA,EAAA,MAAA,CAAA;EAElC,CAAA;;AAEC,UApCG,mBAAA,CAoCH;EAEH,EAAA,EAAA,MAAA;EACE,WAAA,CAAA,EAAA,MAAA;EACC,QAAA,EAAA,CAAA,KAAA,EArCM,cAqCN,EAAA,EAAA,OAAA,EArCiC,aAqCjC,EAAA,GArCmD,OAqCnD,CAAA,IAAA,CAAA;;AAGD,UArCI,mBAAA,CAqCJ;EACC,EAAA,EAAA,MAAA;EACW,WAAA,CAAA,EAAA,MAAA;EAAO,QAAA,EAAA,CAAA,KAAA,EApCZ,cAoCY,EAAA,EAAA,OAAA,EApCe,aAoCf,EAAA,GApCiC,OAoCjC,CAAA,IAAA,CAAA;AAGhC;AAKiB,UAzCA,iBAAA,CAyCiB;EAKjB,EAAA,EAAA,MAAA;EAKA,WAAA,CAAA,EAAA,MAAiB;EAKjB,MAAA,EAAA,CAAA,OAAA,EArDG,aAqDqB,EAAA,GArDH,OAsDf,CAAA,OAAA,CAAA;AAIvB;AAEQ,UAzDS,mBAAA,CAyDT;EACkB,EAAA,EAAA,MAAA;EAAf,WAAA,CAAA,EAAA,MAAA;EAAM,MAAA,EAAA,CAAA,MAAA,EAAA,MAAA,EAAA,OAAA,EAvDmB,aAuDnB,EAAA,GAvDqC,OAuDrC,CAAA,MAAA,CAAA;;UApDA,0BAAA;;EC5CJ,WAAA,CAAA,EAAA,MAAgB;EACN,OAAA,EAAA,CAAA,OAAA,EAAA;IACA,OAAA,EAAA,MAAA;EACF,CAAA,EAAA,GD4CwB,OC5CxB,CD4CgC,MC5ChC,CAAA,MAAA,EAAA,OAAA,CAAA,CAAA;;AAES,UD6Cb,kBAAA,CC7Ca;EAAwB,IAAA,ED8C9C,UC9C8C;EAWzC,QAAA,EAAA,CAAA,OAAA,EDoCS,aC7BrB,EAAA,GAAA,IAPyC,GDoCK,OCpCL,CAAA,IAAA,CAAA;wBDsC7B,kCACA,yBACC;qBAEH,2BACE,yBACC;qBAEH,2BACE,yBACC;EEvFE,OAAA,CAAA,EAAA,GAAA,GAAA,IAAiB,GFwFR,OExFQ,CAAA,IAAA,CAAA;;AACtB,UF0FM,iBAAA,CE1FN;EACR,QAAA,EAAA,CAAA,SAAA,EF0FqB,mBE1FrB,EAAA,GAAA,IAAA;EAAoB,IAAA,EAAA,GAAA,GF2FT,mBE3FS,EAAA;;UF8FN,iBAAA;wBACO;cACV;;UAGG,eAAA;sBACK;cACR;;UAGG,iBAAA;wBACO;cACV;;UAGG,wBAAA;uBACM;cACT;;UAGG,iBAAA;;QAET;WACG,eAAe;;;;cChGb,gBAAA;uBACU;EDzBX,SAAA,UAAc,EC0BH,iBD1BG;EAEd,SAAA,QAAA,ECyBS,eDzBW;EAOf,SAAA,UAAU,ECmBJ,iBDhBf;EAMS,SAAA,iBAAa,ECWA,wBDXA;EAGhB,WAAA,CAAA;;AAEF,cCiBC,2BDjBD,ECiB8B,oBDjB9B;;;iBEtBI,iBAAA,UACL,QAAQ,wBAChB"}

package/dist/index.mjs

@@ -0,0 +1,66 @@
+//#region src/registry.ts
+var SimpleRegistry = class {
+	entries = /* @__PURE__ */ new Map();
+	register(entry) {
+		this.entries.set(entry.id, entry);
+	}
+	list() {
+		return Array.from(this.entries.values());
+	}
+};
+var PluginRegistries = class {
+	generators;
+	validators;
+	adapters;
+	formatters;
+	registryResolvers;
+	constructor() {
+		this.generators = new SimpleRegistry();
+		this.validators = new SimpleRegistry();
+		this.adapters = new SimpleRegistry();
+		this.formatters = new SimpleRegistry();
+		this.registryResolvers = new SimpleRegistry();
+	}
+};
+const defaultPluginRegistryConfig = {
+	plugins: [],
+	registry: {
+		resolutionOrder: [
+			"workspace",
+			"npm",
+			"remote"
+		],
+		allowPrerelease: false,
+		sources: {}
+	}
+};
+
+//#endregion
+//#region src/config.ts
+function mergePluginConfig(config) {
+	return {
+		...defaultPluginRegistryConfig,
+		...config,
+		registry: {
+			...defaultPluginRegistryConfig.registry ?? { resolutionOrder: [
+				"workspace",
+				"npm",
+				"remote"
+			] },
+			...config?.registry,
+			resolutionOrder: config?.registry?.resolutionOrder ?? defaultPluginRegistryConfig.registry?.resolutionOrder ?? [
+				"workspace",
+				"npm",
+				"remote"
+			],
+			sources: {
+				...defaultPluginRegistryConfig.registry?.sources ?? {},
+				...config?.registry?.sources ?? {}
+			}
+		}
+	};
+}
+
+//#endregion
+export { PluginRegistries, defaultPluginRegistryConfig, mergePluginConfig };
+//# sourceMappingURL=index.mjs.map

package/dist/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.mjs","names":[],"sources":["../src/registry.ts","../src/config.ts"],"sourcesContent":["import type {\n  AdapterCapability,\n  AdapterRegistry,\n  FormatterCapability,\n  FormatterRegistry,\n  GeneratorCapability,\n  GeneratorRegistry,\n  PluginRegistryConfig,\n  RegistryResolverCapability,\n  RegistryResolverRegistry,\n  ValidatorCapability,\n  ValidatorRegistry,\n} from './types.js';\n\nclass SimpleRegistry<T extends { id: string }> {\n  private readonly entries = new Map<string, T>();\n\n  register(entry: T): void {\n    this.entries.set(entry.id, entry);\n  }\n\n  list(): T[] {\n    return Array.from(this.entries.values());\n  }\n}\n\nexport class PluginRegistries {\n  readonly generators: GeneratorRegistry;\n  readonly validators: ValidatorRegistry;\n  readonly adapters: AdapterRegistry;\n  readonly formatters: FormatterRegistry;\n  readonly registryResolvers: RegistryResolverRegistry;\n\n  constructor() {\n    this.generators = new SimpleRegistry<GeneratorCapability>();\n    this.validators = new SimpleRegistry<ValidatorCapability>();\n    this.adapters = new SimpleRegistry<AdapterCapability>();\n    this.formatters = new SimpleRegistry<FormatterCapability>();\n    this.registryResolvers = new SimpleRegistry<RegistryResolverCapability>();\n  }\n}\n\nexport const defaultPluginRegistryConfig: PluginRegistryConfig = {\n  plugins: [],\n  registry: {\n    resolutionOrder: ['workspace', 'npm', 'remote'],\n    allowPrerelease: false,\n    sources: {},\n  },\n};\n","import type { PluginRegistryConfig } from './types.js';\nimport { defaultPluginRegistryConfig } from './registry.js';\n\nexport function mergePluginConfig(\n  config?: Partial<PluginRegistryConfig>\n): PluginRegistryConfig {\n  return {\n    ...defaultPluginRegistryConfig,\n    ...config,\n    registry: {\n      ...(defaultPluginRegistryConfig.registry ?? {\n        resolutionOrder: ['workspace', 'npm', 'remote'],\n      }),\n      ...config?.registry,\n      resolutionOrder: config?.registry?.resolutionOrder ??\n        defaultPluginRegistryConfig.registry?.resolutionOrder ?? [\n          'workspace',\n          'npm',\n          'remote',\n        ],\n      sources: {\n        ...(defaultPluginRegistryConfig.registry?.sources ?? {}),\n        ...(config?.registry?.sources ?? {}),\n      },\n    },\n  };\n}\n"],"mappings":";AAcA,IAAM,iBAAN,MAA+C;CAC7C,AAAiB,0BAAU,IAAI,KAAgB;CAE/C,SAAS,OAAgB;AACvB,OAAK,QAAQ,IAAI,MAAM,IAAI,MAAM;;CAGnC,OAAY;AACV,SAAO,MAAM,KAAK,KAAK,QAAQ,QAAQ,CAAC;;;AAI5C,IAAa,mBAAb,MAA8B;CAC5B,AAAS;CACT,AAAS;CACT,AAAS;CACT,AAAS;CACT,AAAS;CAET,cAAc;AACZ,OAAK,aAAa,IAAI,gBAAqC;AAC3D,OAAK,aAAa,IAAI,gBAAqC;AAC3D,OAAK,WAAW,IAAI,gBAAmC;AACvD,OAAK,aAAa,IAAI,gBAAqC;AAC3D,OAAK,oBAAoB,IAAI,gBAA4C;;;AAI7E,MAAa,8BAAoD;CAC/D,SAAS,EAAE;CACX,UAAU;EACR,iBAAiB;GAAC;GAAa;GAAO;GAAS;EAC/C,iBAAiB;EACjB,SAAS,EAAE;EACZ;CACF;;;;AC9CD,SAAgB,kBACd,QACsB;AACtB,QAAO;EACL,GAAG;EACH,GAAG;EACH,UAAU;GACR,GAAI,4BAA4B,YAAY,EAC1C,iBAAiB;IAAC;IAAa;IAAO;IAAS,EAChD;GACD,GAAG,QAAQ;GACX,iBAAiB,QAAQ,UAAU,mBACjC,4BAA4B,UAAU,mBAAmB;IACvD;IACA;IACA;IACD;GACH,SAAS;IACP,GAAI,4BAA4B,UAAU,WAAW,EAAE;IACvD,GAAI,QAAQ,UAAU,WAAW,EAAE;IACpC;GACF;EACF"}

package/package.json

@@ -0,0 +1,62 @@
+{
+  "name": "@contractspec/lib.plugins",
+  "version": "1.48.1",
+  "description": "Plugin API and registry for ContractSpec extensions",
+  "keywords": [
+    "contractspec",
+    "plugins",
+    "extensions",
+    "generator",
+    "validator",
+    "adapter",
+    "registry",
+    "typescript"
+  ],
+  "type": "module",
+  "types": "./dist/index.d.ts",
+  "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 -p tsconfig.json",
+    "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": "1.48.1",
+    "@contractspec/lib.schema": "1.48.0",
+    "zod": "^4.3.5"
+  },
+  "devDependencies": {
+    "@contractspec/tool.tsdown": "1.48.0",
+    "@contractspec/tool.typescript": "1.48.0",
+    "typescript": "^5.9.3"
+  },
+  "exports": {
+    ".": "./dist/index.mjs",
+    "./registry": "./dist/registry.mjs",
+    "./types": "./dist/types.mjs",
+    "./config": "./dist/config.mjs",
+    "./*": "./*"
+  },
+  "files": [
+    "dist",
+    "README.md"
+  ],
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  },
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/lssm-tech/contractspec.git",
+    "directory": "packages/libs/plugins"
+  },
+  "homepage": "https://contractspec.io"
+}