@bpmnkit/connector-gen 0.0.2 → 0.0.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/LICENSE +21 -0
  2. package/README.md +92 -0
  3. package/package.json +50 -30
package/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2026 urbanisierung
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
package/README.md ADDED
@@ -0,0 +1,92 @@
1
+ <div align="center">
2
+ <img src="https://raw.githubusercontent.com/bpmnkit/monorepo/main/doc/logos/logo-2-gateway.svg" width="72" height="72" alt="BPMN Kit logo">
3
+ <h1>@bpmnkit/connector-gen</h1>
4
+ <p>Generate Camunda REST connector element templates from OpenAPI/Swagger specs</p>
5
+
6
+ [![npm](https://img.shields.io/npm/v/@bpmnkit/connector-gen?style=flat-square&color=6244d7)](https://www.npmjs.com/package/@bpmnkit/connector-gen)
7
+ [![license](https://img.shields.io/npm/l/@bpmnkit/connector-gen?style=flat-square)](https://github.com/bpmnkit/monorepo/blob/main/LICENSE)
8
+ [![typescript](https://img.shields.io/badge/TypeScript-strict-6244d7?style=flat-square&logo=typescript&logoColor=white)](https://github.com/bpmnkit/monorepo)
9
+
10
+ [Website](https://bpmnkit.com) · [Documentation](https://docs.bpmnkit.com) · [GitHub](https://github.com/bpmnkit/monorepo) · [Changelog](https://github.com/bpmnkit/monorepo/blob/main/packages/connector-gen/CHANGELOG.md)
11
+ </div>
12
+
13
+ ---
14
+
15
+ ## Overview
16
+
17
+ `@bpmnkit/connector-gen` parses OpenAPI 3.x and Swagger 2.x specifications and generates Camunda REST connector element templates. Drop in your API spec and get a ready-to-import `.json` template that wires up request/response mappings automatically.
18
+
19
+ ## Features
20
+
21
+ - **OpenAPI 3.x and Swagger 2.x** support
22
+ - **Generates Camunda element templates** — REST connector format with input/output mappings
23
+ - **Endpoint selection** — generate all endpoints or filter by path/method
24
+ - **FEEL expressions** — pre-fills input bindings with `=variable` expressions
25
+ - **Zero dependencies** beyond `yaml` for YAML parsing
26
+
27
+ ## Installation
28
+
29
+ ```sh
30
+ npm install @bpmnkit/connector-gen
31
+ ```
32
+
33
+ ## Quick Start
34
+
35
+ ```typescript
36
+ import { generateConnectorTemplates } from "@bpmnkit/connector-gen"
37
+ import { readFileSync, writeFileSync } from "node:fs"
38
+
39
+ const spec = readFileSync("openapi.yaml", "utf8")
40
+ const templates = generateConnectorTemplates(spec)
41
+
42
+ for (const template of templates) {
43
+ writeFileSync(`${template.id}.json`, JSON.stringify(template, null, 2))
44
+ console.log(`Generated: ${template.name}`)
45
+ }
46
+ ```
47
+
48
+ ## CLI usage (via `@bpmnkit/cli`)
49
+
50
+ ```sh
51
+ casen connector generate openapi.yaml --out ./templates/
52
+ ```
53
+
54
+ ## API Reference
55
+
56
+ ```typescript
57
+ function generateConnectorTemplates(
58
+ spec: string, // YAML or JSON OpenAPI/Swagger spec
59
+ options?: GenerateOptions
60
+ ): ConnectorTemplate[]
61
+
62
+ interface GenerateOptions {
63
+ filter?: {
64
+ paths?: string[] // include only these path prefixes
65
+ methods?: string[] // e.g. ["get", "post"]
66
+ }
67
+ }
68
+ ```
69
+
70
+ ---
71
+
72
+ ## Related Packages
73
+
74
+ | Package | Description |
75
+ |---------|-------------|
76
+ | [`@bpmnkit/core`](https://www.npmjs.com/package/@bpmnkit/core) | BPMN/DMN/Form parser, builder, layout engine |
77
+ | [`@bpmnkit/canvas`](https://www.npmjs.com/package/@bpmnkit/canvas) | Zero-dependency SVG BPMN viewer |
78
+ | [`@bpmnkit/editor`](https://www.npmjs.com/package/@bpmnkit/editor) | Full-featured interactive BPMN editor |
79
+ | [`@bpmnkit/engine`](https://www.npmjs.com/package/@bpmnkit/engine) | Lightweight BPMN process execution engine |
80
+ | [`@bpmnkit/feel`](https://www.npmjs.com/package/@bpmnkit/feel) | FEEL expression language parser & evaluator |
81
+ | [`@bpmnkit/plugins`](https://www.npmjs.com/package/@bpmnkit/plugins) | 22 composable canvas plugins |
82
+ | [`@bpmnkit/api`](https://www.npmjs.com/package/@bpmnkit/api) | Camunda 8 REST API TypeScript client |
83
+ | [`@bpmnkit/ascii`](https://www.npmjs.com/package/@bpmnkit/ascii) | Render BPMN diagrams as Unicode ASCII art |
84
+ | [`@bpmnkit/ui`](https://www.npmjs.com/package/@bpmnkit/ui) | Shared design tokens and UI components |
85
+ | [`@bpmnkit/profiles`](https://www.npmjs.com/package/@bpmnkit/profiles) | Shared auth, profile storage, and client factories for CLI & proxy |
86
+ | [`@bpmnkit/operate`](https://www.npmjs.com/package/@bpmnkit/operate) | Monitoring & operations frontend for Camunda clusters |
87
+ | [`@bpmnkit/cli`](https://www.npmjs.com/package/@bpmnkit/cli) | Camunda 8 command-line interface (casen) |
88
+ | [`@bpmnkit/proxy`](https://www.npmjs.com/package/@bpmnkit/proxy) | Local AI bridge and Camunda API proxy server |
89
+
90
+ ## License
91
+
92
+ [MIT](https://github.com/bpmnkit/monorepo/blob/main/LICENSE) © BPMN Kit — made by [u11g](https://u11g.com)
package/package.json CHANGED
@@ -1,31 +1,51 @@
1
1
  {
2
- "name": "@bpmnkit/connector-gen",
3
- "version": "0.0.2",
4
- "private": false,
5
- "type": "module",
6
- "exports": {
7
- ".": {
8
- "import": "./dist/index.js",
9
- "types": "./dist/index.d.ts"
10
- }
11
- },
12
- "main": "./dist/index.js",
13
- "types": "./dist/index.d.ts",
14
- "files": ["dist/**/*.js", "dist/**/*.d.ts"],
15
- "scripts": {
16
- "build": "tsc",
17
- "typecheck": "tsc --noEmit",
18
- "check": "biome check .",
19
- "test": "vitest run"
20
- },
21
- "dependencies": {
22
- "yaml": "^2.7.0"
23
- },
24
- "description": "Generate Camunda REST connector element templates from OpenAPI/Swagger specs",
25
- "keywords": ["camunda", "connector", "openapi", "swagger", "bpmn", "element-template"],
26
- "license": "MIT",
27
- "repository": {
28
- "type": "git",
29
- "url": "https://github.com/bpmnkit/monorepo"
30
- }
31
- }
2
+ "name": "@bpmnkit/connector-gen",
3
+ "version": "0.0.4",
4
+ "private": false,
5
+ "type": "module",
6
+ "exports": {
7
+ ".": {
8
+ "import": "./dist/index.js",
9
+ "types": "./dist/index.d.ts"
10
+ }
11
+ },
12
+ "main": "./dist/index.js",
13
+ "types": "./dist/index.d.ts",
14
+ "files": [
15
+ "LICENSE",
16
+ "README.md",
17
+ "dist/**/*.js",
18
+ "dist/**/*.d.ts"
19
+ ],
20
+ "dependencies": {
21
+ "yaml": "^2.7.0"
22
+ },
23
+ "description": "Generate Camunda REST connector element templates from OpenAPI/Swagger specs",
24
+ "keywords": [
25
+ "camunda",
26
+ "connector",
27
+ "openapi",
28
+ "swagger",
29
+ "bpmn",
30
+ "element-template",
31
+ "typescript"
32
+ ],
33
+ "license": "MIT",
34
+ "repository": {
35
+ "type": "git",
36
+ "url": "https://github.com/bpmnkit/monorepo"
37
+ },
38
+ "homepage": "https://bpmnkit.com",
39
+ "bugs": {
40
+ "url": "https://github.com/bpmnkit/monorepo/issues"
41
+ },
42
+ "publishConfig": {
43
+ "access": "public"
44
+ },
45
+ "scripts": {
46
+ "build": "tsc",
47
+ "typecheck": "tsc --noEmit",
48
+ "check": "biome check .",
49
+ "test": "vitest run"
50
+ }
51
+ }