@bpmnkit/connector-gen 0.0.5 → 0.0.7

package/README.md

@@ -1,5 +1,5 @@
 <div align="center">
-  <img src="https://raw.githubusercontent.com/bpmnkit/monorepo/main/doc/logos/logo-2-gateway.svg" width="72" height="72" alt="BPMN Kit logo">
+  <a href="https://bpmnkit.com"><img src="https://bpmnkit.com/favicon.svg" width="72" height="72" alt="BPMN Kit logo"></a>
   <h1>@bpmnkit/connector-gen</h1>
   <p>Generate Camunda REST connector element templates from OpenAPI/Swagger specs</p>
 
@@ -90,3 +90,7 @@ interface GenerateOptions {
 ## License
 
 [MIT](https://github.com/bpmnkit/monorepo/blob/main/LICENSE) © BPMN Kit — made by [u11g](https://u11g.com)
+
+<div align="center">
+  <a href="https://bpmnkit.com"><img src="https://bpmnkit.com/favicon.svg" width="32" height="32" alt="BPMN Kit"></a>
+</div>

package/dist/browser.d.ts

@@ -0,0 +1,40 @@
+/**
+ * Browser-safe entry point for `@bpmnkit/connector-gen`.
+ *
+ * Identical to the main entry except `writeTemplates` is excluded — that
+ * function depends on `node:fs/promises` and `node:path` which are not
+ * available in browser environments. Use this entry point when bundling for
+ * the browser (e.g. with Vite or webpack).
+ *
+ * @packageDocumentation
+ */
+export { buildTemplate, buildTemplates } from "./build-template.js";
+export { CATALOG, getCatalogEntry } from "./catalog.js";
+export type { CatalogEntry } from "./catalog.js";
+export { detectDefaultAuth, getBaseUrl, getOperations, getServers, isRef, parseOpenApi, resolve, resolveRef, } from "./parse-openapi.js";
+export type { DetectedAuth } from "./parse-openapi.js";
+export type { ApiResponse, AuthHint, Binding, Components, ConnectorGroup, ConnectorTemplate, Constraints, GeneratorOptions, HttpMethod, MediaType, OpenApiDoc, OpenApiInfo, OpenApiServer, Operation, OperationWithMeta, OAuthFlows, Parameter, PathItem, PropertyDef, Ref, RequestBody, Schema, SecurityRequirement, WriteOptions, } from "./types.js";
+export { CONNECTOR_SCHEMA } from "./types.js";
+import type { CatalogEntry } from "./catalog.js";
+import type { ConnectorTemplate, GeneratorOptions } from "./types.js";
+export interface GenerateOptions extends GeneratorOptions {
+    filter?: GeneratorOptions["filter"];
+}
+/**
+ * Parse an OpenAPI spec (string or object) and generate connector templates.
+ */
+export declare function generate(specText: string, opts: GeneratorOptions): ConnectorTemplate[];
+/**
+ * Download an OpenAPI spec from a URL and generate connector templates.
+ */
+export declare function generateFromUrl(url: string, opts: GeneratorOptions): Promise<{
+    templates: ConnectorTemplate[];
+}>;
+/**
+ * Generate connector templates from a catalog entry by ID.
+ */
+export declare function generateFromCatalog(id: string, overrides?: Partial<GenerateOptions>): Promise<{
+    templates: ConnectorTemplate[];
+    entry: CatalogEntry;
+}>;
+//# sourceMappingURL=browser.d.ts.map

package/dist/browser.js

@@ -0,0 +1,55 @@
+/**
+ * Browser-safe entry point for `@bpmnkit/connector-gen`.
+ *
+ * Identical to the main entry except `writeTemplates` is excluded — that
+ * function depends on `node:fs/promises` and `node:path` which are not
+ * available in browser environments. Use this entry point when bundling for
+ * the browser (e.g. with Vite or webpack).
+ *
+ * @packageDocumentation
+ */
+export { buildTemplate, buildTemplates } from "./build-template.js";
+export { CATALOG, getCatalogEntry } from "./catalog.js";
+export { detectDefaultAuth, getBaseUrl, getOperations, getServers, isRef, parseOpenApi, resolve, resolveRef, } from "./parse-openapi.js";
+export { CONNECTOR_SCHEMA } from "./types.js";
+import { buildTemplates } from "./build-template.js";
+import { CATALOG, getCatalogEntry } from "./catalog.js";
+import { detectDefaultAuth, getOperations, parseOpenApi } from "./parse-openapi.js";
+/**
+ * Parse an OpenAPI spec (string or object) and generate connector templates.
+ */
+export function generate(specText, opts) {
+    const doc = parseOpenApi(specText);
+    const defaultAuth = opts.defaultAuthType ?? detectDefaultAuth(doc);
+    const ops = getOperations(doc, opts.filter);
+    return buildTemplates(ops, { ...opts, defaultAuthType: defaultAuth });
+}
+/**
+ * Download an OpenAPI spec from a URL and generate connector templates.
+ */
+export async function generateFromUrl(url, opts) {
+    const res = await fetch(url);
+    if (!res.ok)
+        throw new Error(`Failed to fetch spec from ${url}: ${res.status} ${res.statusText}`);
+    const text = await res.text();
+    const templates = generate(text, opts);
+    return { templates };
+}
+/**
+ * Generate connector templates from a catalog entry by ID.
+ */
+export async function generateFromCatalog(id, overrides = {}) {
+    const entry = getCatalogEntry(id);
+    if (!entry) {
+        const ids = CATALOG.map((e) => e.id).join(", ");
+        throw new Error(`Unknown catalog entry "${id}". Available: ${ids}`);
+    }
+    const opts = {
+        idPrefix: overrides.idPrefix ?? entry.idPrefix,
+        defaultAuthType: overrides.defaultAuthType ?? entry.defaultAuth,
+        ...overrides,
+    };
+    const { templates } = await generateFromUrl(entry.url, opts);
+    return { templates, entry };
+}
+//# sourceMappingURL=browser.js.map

package/dist/catalog.js

@@ -159,6 +159,86 @@ export const CATALOG = [
         idPrefix: "com.vercel",
         defaultAuth: "bearer",
     },
+    {
+        id: "anthropic",
+        name: "Anthropic API",
+        description: "Access Claude models for text generation, vision, and tool use via the Anthropic API",
+        url: "https://raw.githubusercontent.com/anthropics/anthropic-openapi/main/openapi.yaml",
+        idPrefix: "com.anthropic",
+        defaultAuth: "apiKey",
+    },
+    {
+        id: "shopify",
+        name: "Shopify Admin API",
+        description: "Manage Shopify store products, orders, customers, inventory, and fulfillments",
+        url: "https://raw.githubusercontent.com/APIs-guru/openapi-directory/main/APIs/shopify.dev/admin/2023-04/openapi.yaml",
+        idPrefix: "dev.shopify",
+        defaultAuth: "bearer",
+    },
+    {
+        id: "datadog",
+        name: "Datadog API",
+        description: "Submit metrics, manage monitors, dashboards, logs, and alerts in Datadog",
+        url: "https://raw.githubusercontent.com/DataDog/datadog-api-client-python/master/openapi.yaml",
+        idPrefix: "com.datadoghq",
+        defaultAuth: "apiKey",
+    },
+    {
+        id: "sentry",
+        name: "Sentry API",
+        description: "Manage Sentry projects, issues, events, releases, and team members",
+        url: "https://raw.githubusercontent.com/getsentry/sentry-api-schema/main/openapi-derefed.json",
+        idPrefix: "io.sentry",
+        defaultAuth: "bearer",
+    },
+    {
+        id: "intercom",
+        name: "Intercom API",
+        description: "Manage contacts, conversations, messages, and support workflows in Intercom",
+        url: "https://raw.githubusercontent.com/intercom/Intercom-OpenAPI/main/descriptions/2.10/api.intercom.io.yaml",
+        idPrefix: "io.intercom",
+        defaultAuth: "bearer",
+    },
+    {
+        id: "contentful",
+        name: "Contentful Management API",
+        description: "Create and manage content types, entries, assets, and spaces in Contentful CMS",
+        url: "https://raw.githubusercontent.com/APIs-guru/openapi-directory/main/APIs/contentful.com/management.2/openapi.yaml",
+        idPrefix: "com.contentful",
+        defaultAuth: "bearer",
+    },
+    {
+        id: "airtable",
+        name: "Airtable API",
+        description: "Read and write records, tables, fields, and views in Airtable bases",
+        url: "https://raw.githubusercontent.com/APIs-guru/openapi-directory/main/APIs/airtable.com/0.1.0/openapi.yaml",
+        idPrefix: "com.airtable",
+        defaultAuth: "bearer",
+    },
+    {
+        id: "twitch",
+        name: "Twitch Helix API",
+        description: "Manage Twitch streams, channels, clips, users, subscriptions, and EventSub webhooks",
+        url: "https://raw.githubusercontent.com/APIs-guru/openapi-directory/main/APIs/twitch.tv/helix/latest/openapi.yaml",
+        idPrefix: "tv.twitch",
+        defaultAuth: "oauth-client-credentials-flow",
+    },
+    {
+        id: "klaviyo",
+        name: "Klaviyo API",
+        description: "Manage email/SMS campaigns, lists, profiles, flows, and events in Klaviyo",
+        url: "https://raw.githubusercontent.com/klaviyo/klaviyo-api-node/main/openapi/openapi.yaml",
+        idPrefix: "com.klaviyo",
+        defaultAuth: "apiKey",
+    },
+    {
+        id: "brex",
+        name: "Brex API",
+        description: "Manage Brex business accounts, cards, transactions, and expense reimbursements",
+        url: "https://raw.githubusercontent.com/APIs-guru/openapi-directory/main/APIs/brex.com/payments/0.1/openapi.yaml",
+        idPrefix: "com.brex",
+        defaultAuth: "oauth-client-credentials-flow",
+    },
 ];
 export function getCatalogEntry(id) {
     return CATALOG.find((e) => e.id === id);

package/package.json

@@ -1,12 +1,16 @@
 {
   "name": "@bpmnkit/connector-gen",
-  "version": "0.0.5",
+  "version": "0.0.7",
   "private": false,
   "type": "module",
   "exports": {
     ".": {
       "import": "./dist/index.js",
       "types": "./dist/index.d.ts"
+    },
+    "./browser": {
+      "import": "./dist/browser.js",
+      "types": "./dist/browser.d.ts"
     }
   },
   "main": "./dist/index.js",