@schnebel-crm/integration-sdk 0.1.0

package/dist/config-BB4KcLpw.d.mts

@@ -0,0 +1,12 @@
+//#region src/config.d.ts
+interface IntegrationProjectConfig {
+  /** Entry point for the integration (default: "./src/index.ts") */
+  entry?: string;
+  /** Output directory for the build (default: "./dist") */
+  outDir?: string;
+  /** GitHub repository URL (required for public App Store integrations) */
+  github?: string;
+}
+declare function defineConfig(config: IntegrationProjectConfig): IntegrationProjectConfig;
+//#endregion
+export { defineConfig as n, IntegrationProjectConfig as t };

package/dist/config-kHZazM_E.mjs

@@ -0,0 +1,7 @@
+//#region src/config.ts
+function defineConfig(config) {
+	return config;
+}
+
+//#endregion
+export { defineConfig as t };

package/dist/config.d.mts

@@ -0,0 +1,2 @@
+import { n as defineConfig, t as IntegrationProjectConfig } from "./config-BB4KcLpw.mjs";
+export { IntegrationProjectConfig, defineConfig };

package/dist/config.mjs

@@ -0,0 +1,3 @@
+import { t as defineConfig } from "./config-kHZazM_E.mjs";
+
+export { defineConfig };

package/dist/index.d.mts

@@ -0,0 +1,93 @@
+import { n as defineConfig, t as IntegrationProjectConfig } from "./config-BB4KcLpw.mjs";
+
+//#region src/types.d.ts
+declare const INTEGRATION_CATEGORIES: readonly ["email", "calendar", "communication", "analytics", "storage", "payment", "marketing", "automation", "other"];
+type IntegrationCategory = (typeof INTEGRATION_CATEGORIES)[number];
+declare const AUTH_TYPES: readonly ["none", "api_key", "oauth2", "basic", "custom"];
+type AuthType = (typeof AUTH_TYPES)[number];
+declare const CONFIG_FIELD_TYPES: readonly ["text", "number", "boolean", "select", "secret", "email", "url"];
+type ConfigFieldType = (typeof CONFIG_FIELD_TYPES)[number];
+type ConfigField = {
+  key: string;
+  label: string;
+  type: ConfigFieldType;
+  required: boolean;
+  description?: string;
+  placeholder?: string;
+  defaultValue?: string | number | boolean;
+  options?: Array<{
+    value: string;
+    label: string;
+  }>;
+  group?: string;
+};
+type CredentialField = {
+  key: string;
+  label: string;
+  type: "text" | "secret" | "oauth_token";
+  required: boolean;
+  description?: string;
+  placeholder?: string;
+};
+declare const CAPABILITIES: readonly ["send_email", "receive_email", "sync_contacts", "sync_calendar", "sync_tasks", "webhooks", "import_data", "export_data", "notifications", "file_storage", "analytics", "lead_tracking"];
+type IntegrationCapability = (typeof CAPABILITIES)[number];
+interface IntegrationDefinition<TConfig extends string = string, TCredential extends string = string> {
+  id: string;
+  name: string;
+  description: string;
+  icon: string;
+  category: IntegrationCategory;
+  authType: AuthType;
+  version: string;
+  capabilities: IntegrationCapability[];
+  configFields: (ConfigField & {
+    key: TConfig;
+  })[];
+  credentialFields: (CredentialField & {
+    key: TCredential;
+  })[];
+  webhookSupport: boolean;
+  multiInstance?: boolean;
+  documentationUrl?: string;
+  tags?: string[];
+}
+type InferConfigKeys<T extends IntegrationDefinition> = T["configFields"][number]["key"];
+type InferCredentialKeys<T extends IntegrationDefinition> = T["credentialFields"][number]["key"];
+interface IntegrationContext<TConfig extends Record<string, unknown> = Record<string, unknown>, TCredentials extends Record<string, unknown> = Record<string, unknown>> {
+  config: TConfig;
+  credentials: TCredentials;
+  organizationId: string;
+  installationId: string;
+}
+type ConnectionTestResult = {
+  success: true;
+} | {
+  success: false;
+  error: string;
+};
+interface IntegrationAction<TInput = unknown, TOutput = unknown> {
+  id: string;
+  name: string;
+  description: string;
+  execute(ctx: IntegrationContext, input: TInput): Promise<TOutput>;
+}
+interface IntegrationHandler {
+  testConnection(ctx: IntegrationContext): Promise<ConnectionTestResult>;
+  onInstall?(ctx: IntegrationContext): Promise<void>;
+  onUninstall?(ctx: IntegrationContext): Promise<void>;
+  actions: IntegrationAction[];
+}
+//#endregion
+//#region src/handler.d.ts
+declare function defineHandler<TConfig extends Record<string, unknown>, TCredentials extends Record<string, unknown>>(handler: {
+  testConnection(ctx: IntegrationContext<TConfig, TCredentials>): Promise<ConnectionTestResult>;
+  onInstall?(ctx: IntegrationContext<TConfig, TCredentials>): Promise<void>;
+  onUninstall?(ctx: IntegrationContext<TConfig, TCredentials>): Promise<void>;
+  actions: IntegrationAction[];
+}): IntegrationHandler;
+declare function createAction<TInput = unknown, TOutput = unknown>(action: IntegrationAction<TInput, TOutput>): IntegrationAction;
+//#endregion
+//#region src/helpers.d.ts
+declare function defineIntegration<TConfig extends string, TCredential extends string>(definition: IntegrationDefinition<TConfig, TCredential>): IntegrationDefinition<TConfig, TCredential>;
+//#endregion
+export { AUTH_TYPES, type AuthType, CAPABILITIES, CONFIG_FIELD_TYPES, type ConfigField, type ConfigFieldType, type ConnectionTestResult, type CredentialField, INTEGRATION_CATEGORIES, type InferConfigKeys, type InferCredentialKeys, type IntegrationAction, type IntegrationCapability, type IntegrationCategory, type IntegrationContext, type IntegrationDefinition, type IntegrationHandler, type IntegrationProjectConfig, createAction, defineConfig, defineHandler, defineIntegration };

package/dist/index.mjs

@@ -0,0 +1,62 @@
+import { t as defineConfig } from "./config-kHZazM_E.mjs";
+
+//#region src/types.ts
+const INTEGRATION_CATEGORIES = [
+	"email",
+	"calendar",
+	"communication",
+	"analytics",
+	"storage",
+	"payment",
+	"marketing",
+	"automation",
+	"other"
+];
+const AUTH_TYPES = [
+	"none",
+	"api_key",
+	"oauth2",
+	"basic",
+	"custom"
+];
+const CONFIG_FIELD_TYPES = [
+	"text",
+	"number",
+	"boolean",
+	"select",
+	"secret",
+	"email",
+	"url"
+];
+const CAPABILITIES = [
+	"send_email",
+	"receive_email",
+	"sync_contacts",
+	"sync_calendar",
+	"sync_tasks",
+	"webhooks",
+	"import_data",
+	"export_data",
+	"notifications",
+	"file_storage",
+	"analytics",
+	"lead_tracking"
+];
+
+//#endregion
+//#region src/handler.ts
+function defineHandler(handler) {
+	return handler;
+}
+function createAction(action) {
+	return action;
+}
+
+//#endregion
+//#region src/helpers.ts
+function defineIntegration(definition) {
+	return Object.freeze(definition);
+}
+
+//#endregion
+export { AUTH_TYPES, CAPABILITIES, CONFIG_FIELD_TYPES, INTEGRATION_CATEGORIES, createAction, defineConfig, defineHandler, defineIntegration };

package/package.json

@@ -0,0 +1,34 @@
+{
+  "name": "@schnebel-crm/integration-sdk",
+  "version": "0.1.0",
+  "type": "module",
+  "description": "SDK for building custom integrations for Schnebel CRM",
+  "main": "./dist/index.mjs",
+  "types": "./dist/index.d.mts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.mts",
+      "import": "./dist/index.mjs"
+    },
+    "./config": {
+      "types": "./dist/config.d.mts",
+      "import": "./dist/config.mjs"
+    }
+  },
+  "files": ["dist"],
+  "scripts": {
+    "build": "tsdown src/index.ts src/config.ts --format esm --dts --clean",
+    "check-types": "tsc --noEmit",
+    "prepublishOnly": "pnpm run build"
+  },
+  "keywords": ["schnebel", "crm", "integration", "sdk", "plugin"],
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/schnebel-it/schnebel-crm"
+  },
+  "devDependencies": {
+    "tsdown": "^0.16.5",
+    "typescript": "^5"
+  }
+}