@schnebel-crm/cli 0.1.0

package/dist/cli.mjs

@@ -0,0 +1,614 @@
+#!/usr/bin/env node
+import { Command } from "commander";
+import prompts from "prompts";
+import { access, mkdir, readFile, writeFile } from "node:fs/promises";
+import { join, resolve } from "node:path";
+import pc from "picocolors";
+import { build, context } from "esbuild";
+import { pathToFileURL } from "node:url";
+import { homedir } from "node:os";
+
+//#region src/utils/log.ts
+const log = {
+	success(msg) {
+		console.log(`${pc.green("✓")} ${msg}`);
+	},
+	error(msg) {
+		console.error(`${pc.red("✗")} ${msg}`);
+	},
+	info(msg) {
+		console.log(`${pc.blue("ℹ")} ${msg}`);
+	},
+	warn(msg) {
+		console.log(`${pc.yellow("⚠")} ${msg}`);
+	},
+	step(msg) {
+		console.log(`${pc.cyan("→")} ${msg}`);
+	}
+};
+
+//#endregion
+//#region src/commands/init.ts
+const initCommand = new Command("init").description("Create a new Schnebel CRM integration").argument("[name]", "Integration name").action(async (name) => {
+	const answers = await prompts([
+		{
+			type: name ? null : "text",
+			name: "name",
+			message: "Integration name:",
+			initial: name
+		},
+		{
+			type: "text",
+			name: "slug",
+			message: "Integration slug (kebab-case):",
+			initial: (prev) => (name ?? prev).toLowerCase().replace(/\s+/g, "-")
+		},
+		{
+			type: "text",
+			name: "description",
+			message: "Description:"
+		},
+		{
+			type: "select",
+			name: "category",
+			message: "Category:",
+			choices: [
+				{
+					title: "Email",
+					value: "email"
+				},
+				{
+					title: "Calendar",
+					value: "calendar"
+				},
+				{
+					title: "Communication",
+					value: "communication"
+				},
+				{
+					title: "Analytics",
+					value: "analytics"
+				},
+				{
+					title: "Storage",
+					value: "storage"
+				},
+				{
+					title: "Payment",
+					value: "payment"
+				},
+				{
+					title: "Marketing",
+					value: "marketing"
+				},
+				{
+					title: "Automation",
+					value: "automation"
+				},
+				{
+					title: "Other",
+					value: "other"
+				}
+			]
+		},
+		{
+			type: "select",
+			name: "authType",
+			message: "Authentication type:",
+			choices: [
+				{
+					title: "API Key",
+					value: "api_key"
+				},
+				{
+					title: "OAuth 2.0",
+					value: "oauth2"
+				},
+				{
+					title: "Basic Auth",
+					value: "basic"
+				},
+				{
+					title: "None",
+					value: "none"
+				},
+				{
+					title: "Custom",
+					value: "custom"
+				}
+			]
+		}
+	]);
+	if (!answers.slug) {
+		log.error("Aborted.");
+		return;
+	}
+	const integrationName = name ?? answers.name ?? answers.slug;
+	const dir = resolve(answers.slug);
+	await mkdir(join(dir, "src"), { recursive: true });
+	await writeFile(join(dir, "package.json"), JSON.stringify({
+		name: answers.slug,
+		version: "1.0.0",
+		type: "module",
+		private: true,
+		scripts: {
+			build: "schnebel build",
+			dev: "schnebel dev",
+			deploy: "schnebel deploy"
+		},
+		dependencies: { "@schnebel-crm/integration-sdk": "^0.1.0" },
+		devDependencies: {
+			"@schnebel-crm/cli": "^0.1.0",
+			typescript: "^5"
+		}
+	}, null, 2));
+	await writeFile(join(dir, "tsconfig.json"), JSON.stringify({
+		compilerOptions: {
+			target: "ESNext",
+			module: "ESNext",
+			moduleResolution: "bundler",
+			strict: true,
+			skipLibCheck: true,
+			esModuleInterop: true,
+			verbatimModuleSyntax: true,
+			outDir: "./dist",
+			declaration: true
+		},
+		include: ["src"]
+	}, null, 2));
+	await writeFile(join(dir, "schnebel.config.ts"), `import { defineConfig } from "@schnebel-crm/integration-sdk/config";
+
+export default defineConfig({
+  entry: "./src/index.ts",
+  // github: "https://github.com/your-org/${answers.slug}",
+});
+`);
+	await writeFile(join(dir, "src", "definition.ts"), `import { defineIntegration } from "@schnebel-crm/integration-sdk";
+
+export const definition = defineIntegration({
+  id: "${answers.slug}",
+  name: "${integrationName}",
+  description: "${answers.description ?? ""}",
+  icon: "IconPlug",
+  category: "${answers.category}",
+  authType: "${answers.authType}",
+  version: "1.0.0",
+  webhookSupport: false,
+  capabilities: [],
+
+  configFields: [
+    // {
+    //   key: "example",
+    //   label: "Example Field",
+    //   type: "text",
+    //   required: true,
+    // },
+  ],
+
+  credentialFields: [${answers.authType === "api_key" ? `
+    {
+      key: "api_key",
+      label: "API Key",
+      type: "secret",
+      required: true,
+      placeholder: "Your API key",
+    },` : ""}
+  ],
+});
+`);
+	await writeFile(join(dir, "src", "handler.ts"), `import { defineHandler, createAction } from "@schnebel-crm/integration-sdk";
+
+export const handler = defineHandler({
+  async testConnection(ctx) {
+    // TODO: Validate credentials and return connection status
+    try {
+      // Example: await fetch("https://api.example.com/health", {
+      //   headers: { Authorization: \`Bearer \${ctx.credentials.api_key}\` },
+      // });
+      return { success: true };
+    } catch (err) {
+      return {
+        success: false,
+        error: err instanceof Error ? err.message : "Connection failed",
+      };
+    }
+  },
+
+  actions: [
+    // createAction({
+    //   id: "example_action",
+    //   name: "Example Action",
+    //   description: "An example action.",
+    //   async execute(ctx, input) {
+    //     return { result: "done" };
+    //   },
+    // }),
+  ],
+});
+`);
+	await writeFile(join(dir, "src", "index.ts"), `export { definition } from "./definition.js";
+export { handler } from "./handler.js";
+`);
+	await writeFile(join(dir, ".gitignore"), `node_modules/
+dist/
+.schnebel/
+`);
+	console.log("");
+	log.success(`Created ${pc.bold(answers.slug)} integration`);
+	console.log("");
+	console.log(`  ${pc.dim("$")} cd ${answers.slug}`);
+	console.log(`  ${pc.dim("$")} npm install`);
+	console.log(`  ${pc.dim("$")} npm run build`);
+	console.log("");
+});
+
+//#endregion
+//#region src/utils/config.ts
+const DEFAULTS = {
+	entry: "./src/index.ts",
+	outDir: "./dist",
+	github: ""
+};
+async function loadConfig(cwd) {
+	const configPath = resolve(cwd, "schnebel.config.ts");
+	try {
+		const mod = await import(pathToFileURL(configPath).href);
+		const userConfig = mod.default ?? mod;
+		return {
+			...DEFAULTS,
+			...userConfig
+		};
+	} catch {
+		return DEFAULTS;
+	}
+}
+
+//#endregion
+//#region src/commands/build.ts
+const buildCommand = new Command("build").description("Build the integration into a deployable bundle").action(async () => {
+	const cwd = process.cwd();
+	const config = await loadConfig(cwd);
+	const entryPoint = resolve(cwd, config.entry);
+	const outDir = resolve(cwd, config.outDir);
+	const outFile = join(outDir, "index.mjs");
+	log.step("Building integration...");
+	try {
+		await build({
+			entryPoints: [entryPoint],
+			bundle: true,
+			format: "esm",
+			platform: "node",
+			target: "node20",
+			outfile: outFile,
+			external: ["@schnebel-crm/integration-sdk"],
+			minify: false,
+			sourcemap: false
+		});
+		log.step("Generating manifest...");
+		const mod = await import(pathToFileURL(outFile).href);
+		if (!mod.definition) {
+			log.error("Bundle must export a 'definition' named export.");
+			process.exit(1);
+		}
+		if (!mod.handler) {
+			log.error("Bundle must export a 'handler' named export.");
+			process.exit(1);
+		}
+		const def = mod.definition;
+		const manifest = {
+			id: def.id,
+			name: def.name,
+			version: def.version,
+			description: def.description,
+			icon: def.icon,
+			category: def.category,
+			authType: def.authType,
+			capabilities: def.capabilities,
+			webhookSupport: def.webhookSupport,
+			multiInstance: def.multiInstance ?? false,
+			configFields: def.configFields,
+			credentialFields: def.credentialFields,
+			documentationUrl: def.documentationUrl,
+			tags: def.tags,
+			sdkVersion: "0.1.0"
+		};
+		await writeFile(join(outDir, "manifest.json"), JSON.stringify(manifest, null, 2));
+		log.success(`Built ${def.name}@${def.version}`);
+		log.info(`  Bundle: ${outFile}`);
+		log.info(`  Manifest: ${join(outDir, "manifest.json")}`);
+	} catch (err) {
+		log.error(`Build failed: ${err instanceof Error ? err.message : String(err)}`);
+		process.exit(1);
+	}
+});
+
+//#endregion
+//#region src/commands/validate.ts
+const validateCommand = new Command("validate").description("Validate the built integration bundle").action(async () => {
+	const cwd = process.cwd();
+	const outDir = resolve(cwd, (await loadConfig(cwd)).outDir);
+	const bundlePath = join(outDir, "index.mjs");
+	const manifestPath = join(outDir, "manifest.json");
+	let hasErrors = false;
+	try {
+		await access(bundlePath);
+	} catch {
+		log.error("Bundle not found. Run 'schnebel build' first.");
+		process.exit(1);
+	}
+	try {
+		await access(manifestPath);
+	} catch {
+		log.error("Manifest not found. Run 'schnebel build' first.");
+		process.exit(1);
+	}
+	log.step("Validating bundle exports...");
+	try {
+		const mod = await import(pathToFileURL(bundlePath).href);
+		if (!mod.definition) {
+			log.error("Missing 'definition' export.");
+			hasErrors = true;
+		} else {
+			const def = mod.definition;
+			if (!def.id) {
+				log.error("definition.id is required");
+				hasErrors = true;
+			}
+			if (!def.name) {
+				log.error("definition.name is required");
+				hasErrors = true;
+			}
+			if (!def.version) {
+				log.error("definition.version is required");
+				hasErrors = true;
+			}
+			if (!def.category) {
+				log.error("definition.category is required");
+				hasErrors = true;
+			}
+			if (!/^[a-z0-9-]+$/.test(def.id)) {
+				log.error("definition.id must be lowercase alphanumeric with hyphens only");
+				hasErrors = true;
+			}
+			if (!hasErrors) log.success(`Definition: ${def.name} (${def.id}@${def.version})`);
+		}
+		if (!mod.handler) {
+			log.error("Missing 'handler' export.");
+			hasErrors = true;
+		} else {
+			if (typeof mod.handler.testConnection !== "function") {
+				log.error("handler.testConnection must be a function");
+				hasErrors = true;
+			}
+			if (!Array.isArray(mod.handler.actions)) {
+				log.error("handler.actions must be an array");
+				hasErrors = true;
+			}
+			if (!hasErrors) log.success(`Handler: testConnection + ${mod.handler.actions.length} action(s)`);
+		}
+	} catch (err) {
+		log.error(`Failed to load bundle: ${err instanceof Error ? err.message : String(err)}`);
+		hasErrors = true;
+	}
+	if (hasErrors) {
+		log.error("Validation failed.");
+		process.exit(1);
+	}
+	log.success("Validation passed.");
+});
+
+//#endregion
+//#region src/utils/auth.ts
+const CONFIG_DIR = join(homedir(), ".schnebel");
+const CONFIG_FILE = join(CONFIG_DIR, "config.json");
+async function saveAuth(config) {
+	await mkdir(CONFIG_DIR, { recursive: true });
+	await writeFile(CONFIG_FILE, JSON.stringify(config, null, 2));
+}
+async function loadAuth() {
+	try {
+		const data = await readFile(CONFIG_FILE, "utf-8");
+		return JSON.parse(data);
+	} catch {
+		return null;
+	}
+}
+
+//#endregion
+//#region src/commands/deploy.ts
+const deployCommand = new Command("deploy").description("Deploy the integration to your Schnebel CRM workspace").action(async () => {
+	const auth = await loadAuth();
+	if (!auth) {
+		log.error("Not authenticated. Run 'schnebel login' first.");
+		process.exit(1);
+	}
+	const cwd = process.cwd();
+	const outDir = resolve(cwd, (await loadConfig(cwd)).outDir);
+	log.step("Reading build artifacts...");
+	let bundle;
+	let manifest;
+	try {
+		bundle = await readFile(join(outDir, "index.mjs"));
+		manifest = await readFile(join(outDir, "manifest.json"), "utf-8");
+	} catch {
+		log.error("Build artifacts not found. Run 'schnebel build' first.");
+		process.exit(1);
+	}
+	const manifestData = JSON.parse(manifest);
+	log.step(`Deploying ${manifestData.name}@${manifestData.version}...`);
+	try {
+		const formData = new FormData();
+		formData.append("bundle", new Blob([bundle]), "index.mjs");
+		formData.append("manifest", manifest);
+		const res = await fetch(`${auth.url}/api/integrations/custom/upload`, {
+			method: "POST",
+			headers: { "x-api-key": auth.apiKey },
+			body: formData
+		});
+		if (!res.ok) {
+			const body = await res.text();
+			log.error(`Deploy failed (${res.status}): ${body}`);
+			process.exit(1);
+		}
+		const result = await res.json();
+		log.success(`Deployed ${manifestData.name}@${manifestData.version} to your workspace`);
+		log.info(`Slug: ${result.slug}`);
+	} catch (err) {
+		log.error(`Deploy failed: ${err instanceof Error ? err.message : String(err)}`);
+		process.exit(1);
+	}
+});
+
+//#endregion
+//#region src/commands/publish.ts
+const publishCommand = new Command("publish").description("Submit the integration for App Store review").action(async () => {
+	const auth = await loadAuth();
+	if (!auth) {
+		log.error("Not authenticated. Run 'schnebel login' first.");
+		process.exit(1);
+	}
+	const cwd = process.cwd();
+	const config = await loadConfig(cwd);
+	if (!config.github) {
+		log.error("A GitHub repository URL is required for public integrations.");
+		log.info("Add 'github' to your schnebel.config.ts:");
+		log.info("  github: \"https://github.com/your-org/your-integration\"");
+		process.exit(1);
+	}
+	try {
+		const repoUrl = config.github.replace("https://github.com/", "https://api.github.com/repos/");
+		const res = await fetch(repoUrl);
+		if (!res.ok) {
+			log.error("GitHub repository not found or not accessible.");
+			process.exit(1);
+		}
+		if ((await res.json()).private) {
+			log.error("GitHub repository must be public for App Store integrations.");
+			process.exit(1);
+		}
+	} catch {
+		log.warn("Could not verify GitHub repository. Proceeding anyway.");
+	}
+	const outDir = resolve(cwd, config.outDir);
+	let manifest;
+	try {
+		manifest = await readFile(join(outDir, "manifest.json"), "utf-8");
+	} catch {
+		log.error("Manifest not found. Run 'schnebel build' first.");
+		process.exit(1);
+	}
+	const manifestData = JSON.parse(manifest);
+	log.step(`Submitting ${manifestData.name}@${manifestData.version} for review...`);
+	try {
+		const res = await fetch(`${auth.url}/api/integrations/custom/${manifestData.id}/submit`, {
+			method: "POST",
+			headers: {
+				"Content-Type": "application/json",
+				"x-api-key": auth.apiKey
+			},
+			body: JSON.stringify({ githubUrl: config.github })
+		});
+		if (!res.ok) {
+			const body = await res.text();
+			log.error(`Submit failed (${res.status}): ${body}`);
+			process.exit(1);
+		}
+		log.success("Submitted for review.");
+		log.info("We'll notify you when the review is complete.");
+	} catch (err) {
+		log.error(`Submit failed: ${err instanceof Error ? err.message : String(err)}`);
+		process.exit(1);
+	}
+});
+
+//#endregion
+//#region src/commands/login.ts
+const loginCommand = new Command("login").description("Authenticate with your Schnebel CRM instance").action(async () => {
+	const answers = await prompts([{
+		type: "text",
+		name: "url",
+		message: "Schnebel CRM URL:",
+		initial: "https://api.schnebel-crm.de"
+	}, {
+		type: "password",
+		name: "apiKey",
+		message: "API Key:"
+	}]);
+	if (!answers.url || !answers.apiKey) {
+		log.error("Aborted.");
+		return;
+	}
+	log.step("Verifying connection...");
+	try {
+		const res = await fetch(`${answers.url}/v1/health`, { headers: { "x-api-key": answers.apiKey } });
+		if (!res.ok) {
+			log.error(`Connection failed (${res.status}). Check your URL and API key.`);
+			return;
+		}
+	} catch (err) {
+		log.error(`Connection failed: ${err instanceof Error ? err.message : String(err)}`);
+		return;
+	}
+	await saveAuth({
+		url: answers.url,
+		apiKey: answers.apiKey
+	});
+	log.success("Authenticated successfully.");
+	log.info(`Config saved to ~/.schnebel/config.json`);
+});
+
+//#endregion
+//#region src/commands/whoami.ts
+const whoamiCommand = new Command("whoami").description("Show current authentication status").action(async () => {
+	const auth = await loadAuth();
+	if (!auth) {
+		log.error("Not authenticated. Run 'schnebel login' first.");
+		return;
+	}
+	log.success("Authenticated");
+	log.info(`URL: ${auth.url}`);
+	log.info(`API Key: ${auth.apiKey.slice(0, 8)}...`);
+});
+
+//#endregion
+//#region src/commands/dev.ts
+const devCommand = new Command("dev").description("Watch and validate the integration in development mode").action(async () => {
+	const cwd = process.cwd();
+	const config = await loadConfig(cwd);
+	const entryPoint = resolve(cwd, config.entry);
+	const outDir = resolve(cwd, config.outDir);
+	log.info("Starting dev mode... (press Ctrl+C to stop)");
+	try {
+		await (await context({
+			entryPoints: [entryPoint],
+			bundle: true,
+			format: "esm",
+			platform: "node",
+			target: "node20",
+			outfile: `${outDir}/index.mjs`,
+			external: ["@schnebel-crm/integration-sdk"],
+			logLevel: "info"
+		})).watch();
+		log.success("Watching for changes...");
+	} catch (err) {
+		log.error(`Dev mode failed: ${err instanceof Error ? err.message : String(err)}`);
+		process.exit(1);
+	}
+});
+
+//#endregion
+//#region src/cli.ts
+const program = new Command();
+program.name("schnebel").description("CLI for building and deploying Schnebel CRM integrations").version("0.1.0");
+program.addCommand(initCommand);
+program.addCommand(devCommand);
+program.addCommand(buildCommand);
+program.addCommand(validateCommand);
+program.addCommand(deployCommand);
+program.addCommand(publishCommand);
+program.addCommand(loginCommand);
+program.addCommand(whoamiCommand);
+program.parse();
+
+//#endregion
+export {  };

package/package.json

@@ -0,0 +1,34 @@
+{
+  "name": "@schnebel-crm/cli",
+  "version": "0.1.0",
+  "type": "module",
+  "description": "CLI for building and deploying Schnebel CRM integrations",
+  "main": "./dist/cli.mjs",
+  "bin": {
+    "schnebel": "./dist/cli.mjs"
+  },
+  "files": ["dist"],
+  "scripts": {
+    "build": "tsdown src/cli.ts --format esm --clean",
+    "check-types": "tsc --noEmit",
+    "prepublishOnly": "pnpm run build"
+  },
+  "keywords": ["schnebel", "crm", "integration", "cli"],
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/schnebel-it/schnebel-crm"
+  },
+  "dependencies": {
+    "@schnebel-crm/integration-sdk": "workspace:^",
+    "commander": "^13.0.0",
+    "esbuild": "^0.25.0",
+    "picocolors": "^1.1.0",
+    "prompts": "^2.4.2"
+  },
+  "devDependencies": {
+    "@types/prompts": "^2.4.9",
+    "tsdown": "^0.16.5",
+    "typescript": "^5"
+  }
+}