@n8n-as-code/sync 0.12.0 → 0.13.0

package/dist/services/workspace-setup-service.js

@@ -0,0 +1,107 @@
+/**
+ * WorkspaceSetupService
+ *
+ * Ensures a workflow directory has the files needed for a smooth TypeScript
+ * editing experience — no npm install required in the user's workspace:
+ *
+ *  1. `n8n-workflows.d.ts`  — ambient declarations for @n8n-as-code/transformer.
+ *     Eliminates red-squiggle "Cannot find module" errors in .workflow.ts files.
+ *
+ *  2. `tsconfig.json` (only if absent) — minimal config that enables decorators
+ *     and includes the generated declaration file.
+ *
+ * Both files are written to the workflow sync directory.
+ * The .d.ts is always overwritten so it stays up-to-date with new extension/CLI releases.
+ * The tsconfig.json is only written once and never overwritten (respects user edits).
+ *
+ * Responsibility: @n8n-as-code/sync — called by both the VS Code extension
+ * and the CLI so the experience is identical regardless of how the workspace
+ * was initialised.
+ */
+import fs from 'fs';
+import path from 'path';
+import { fileURLToPath } from 'url';
+// ─── Resolve bundled assets path ─────────────────────────────────────────────
+// Works in both ESM (import.meta.url) and CJS (__dirname)
+const _filename = typeof __filename !== 'undefined'
+    ? __filename
+    : fileURLToPath(import.meta.url);
+const _dirname = path.dirname(_filename);
+// In the built package the assets live next to this file (dist/services/../assets/)
+// At source level they live in src/assets/
+function resolveAssetPath(filename) {
+    // Try sibling assets/ dir (built layout: dist/services/workspace-setup-service.js)
+    const candidates = [
+        path.join(_dirname, '..', 'assets', filename), // packages/sync/dist/assets/
+        path.join(_dirname, 'assets', filename), // packages/sync/dist/services/assets/ (fallback)
+    ];
+    for (const candidate of candidates) {
+        if (fs.existsSync(candidate))
+            return candidate;
+    }
+    throw new Error(`[n8n-as-code] Could not find bundled asset "${filename}". Tried:\n` +
+        candidates.map(c => `  ${c}`).join('\n'));
+}
+// ─── Minimal tsconfig.json ────────────────────────────────────────────────────
+const TSCONFIG_CONTENT = JSON.stringify({
+    compilerOptions: {
+        target: 'ES2022',
+        module: 'ESNext',
+        moduleResolution: 'node',
+        baseUrl: '.',
+        paths: {
+            '@n8n-as-code/transformer': ['./n8n-workflows.d.ts'],
+        },
+        experimentalDecorators: true,
+        emitDecoratorMetadata: false,
+        strict: false,
+        noEmit: true,
+        skipLibCheck: true,
+    },
+    include: ['**/*.workflow.ts', '**/*.d.ts'],
+    exclude: ['node_modules'],
+}, null, 4);
+// ─── Service ──────────────────────────────────────────────────────────────────
+export class WorkspaceSetupService {
+    /**
+     * Ensure TypeScript support files are present in the given workflow directory.
+     * Safe to call multiple times — only writes when content has actually changed.
+     *
+     * @param workflowDir  Absolute path to the directory that contains .workflow.ts files
+     */
+    static ensureWorkspaceFiles(workflowDir) {
+        fs.mkdirSync(workflowDir, { recursive: true });
+        WorkspaceSetupService.writeDeclarationFile(workflowDir);
+        WorkspaceSetupService.writeTsConfig(workflowDir);
+    }
+    // ── Private helpers ───────────────────────────────────────────────────────
+    /** Copy / overwrite the bundled .d.ts stub so it stays current */
+    static writeDeclarationFile(dir) {
+        let stubContent;
+        try {
+            const src = resolveAssetPath('n8n-workflows.d.ts');
+            stubContent = fs.readFileSync(src, 'utf-8');
+        }
+        catch (err) {
+            console.warn('[n8n-as-code] WorkspaceSetupService:', err.message);
+            return;
+        }
+        const dest = path.join(dir, 'n8n-workflows.d.ts');
+        WorkspaceSetupService.writeIfChanged(dest, stubContent);
+    }
+    /** Write tsconfig.json, overwriting if content has changed (keeps existing workspaces up to date) */
+    static writeTsConfig(dir) {
+        const dest = path.join(dir, 'tsconfig.json');
+        WorkspaceSetupService.writeIfChanged(dest, TSCONFIG_CONTENT);
+    }
+    /** Write only when content differs (avoids unnecessary git dirty state) */
+    static writeIfChanged(filePath, content) {
+        const existing = fs.existsSync(filePath)
+            ? fs.readFileSync(filePath, 'utf-8')
+            : null;
+        if (existing !== content) {
+            fs.writeFileSync(filePath, content, 'utf-8');
+        }
+    }
+}
+//# sourceMappingURL=workspace-setup-service.js.map

package/dist/services/workspace-setup-service.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"workspace-setup-service.js","sourceRoot":"","sources":["../../src/services/workspace-setup-service.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;GAmBG;AAEH,OAAO,EAAE,MAAM,IAAI,CAAC;AACpB,OAAO,IAAI,MAAM,MAAM,CAAC;AACxB,OAAO,EAAE,aAAa,EAAE,MAAM,KAAK,CAAC;AAEpC,gFAAgF;AAEhF,0DAA0D;AAC1D,MAAM,SAAS,GACX,OAAO,UAAU,KAAK,WAAW;IAC7B,CAAC,CAAC,UAAU;IACZ,CAAC,CAAC,aAAa,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AACzC,MAAM,QAAQ,GAAG,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;AAEzC,oFAAoF;AACpF,2CAA2C;AAC3C,SAAS,gBAAgB,CAAC,QAAgB;IACtC,mFAAmF;IACnF,MAAM,UAAU,GAAG;QACf,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,IAAI,EAAE,QAAQ,EAAE,QAAQ,CAAC,EAAI,6BAA6B;QAC9E,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,QAAQ,EAAE,QAAQ,CAAC,EAAW,iDAAiD;KACtG,CAAC;IACF,KAAK,MAAM,SAAS,IAAI,UAAU,EAAE,CAAC;QACjC,IAAI,EAAE,CAAC,UAAU,CAAC,SAAS,CAAC;YAAE,OAAO,SAAS,CAAC;IACnD,CAAC;IACD,MAAM,IAAI,KAAK,CACX,+CAA+C,QAAQ,aAAa;QACpE,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAC3C,CAAC;AACN,CAAC;AAED,iFAAiF;AAEjF,MAAM,gBAAgB,GAAG,IAAI,CAAC,SAAS,CACnC;IACI,eAAe,EAAE;QACb,MAAM,EAAE,QAAQ;QAChB,MAAM,EAAE,QAAQ;QAChB,gBAAgB,EAAE,MAAM;QACxB,OAAO,EAAE,GAAG;QACZ,KAAK,EAAE;YACH,0BAA0B,EAAE,CAAC,sBAAsB,CAAC;SACvD;QACD,sBAAsB,EAAE,IAAI;QAC5B,qBAAqB,EAAE,KAAK;QAC5B,MAAM,EAAE,KAAK;QACb,MAAM,EAAE,IAAI;QACZ,YAAY,EAAE,IAAI;KACrB;IACD,OAAO,EAAE,CAAC,kBAAkB,EAAE,WAAW,CAAC;IAC1C,OAAO,EAAE,CAAC,cAAc,CAAC;CAC5B,EACD,IAAI,EACJ,CAAC,CACJ,CAAC;AAEF,iFAAiF;AAEjF,MAAM,OAAO,qBAAqB;IAC9B;;;;;OAKG;IACH,MAAM,CAAC,oBAAoB,CAAC,WAAmB;QAC3C,EAAE,CAAC,SAAS,CAAC,WAAW,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;QAE/C,qBAAqB,CAAC,oBAAoB,CAAC,WAAW,CAAC,CAAC;QACxD,qBAAqB,CAAC,aAAa,CAAC,WAAW,CAAC,CAAC;IACrD,CAAC;IAED,6EAA6E;IAE7E,kEAAkE;IAC1D,MAAM,CAAC,oBAAoB,CAAC,GAAW;QAC3C,IAAI,WAAmB,CAAC;QACxB,IAAI,CAAC;YACD,MAAM,GAAG,GAAG,gBAAgB,CAAC,oBAAoB,CAAC,CAAC;YACnD,WAAW,GAAG,EAAE,CAAC,YAAY,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC;QAChD,CAAC;QAAC,OAAO,GAAQ,EAAE,CAAC;YAChB,OAAO,CAAC,IAAI,CAAC,sCAAsC,EAAE,GAAG,CAAC,OAAO,CAAC,CAAC;YAClE,OAAO;QACX,CAAC;QAED,MAAM,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,oBAAoB,CAAC,CAAC;QAClD,qBAAqB,CAAC,cAAc,CAAC,IAAI,EAAE,WAAW,CAAC,CAAC;IAC5D,CAAC;IAED,qGAAqG;IAC7F,MAAM,CAAC,aAAa,CAAC,GAAW;QACpC,MAAM,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,eAAe,CAAC,CAAC;QAC7C,qBAAqB,CAAC,cAAc,CAAC,IAAI,EAAE,gBAAgB,CAAC,CAAC;IACjE,CAAC;IAED,2EAA2E;IACnE,MAAM,CAAC,cAAc,CAAC,QAAgB,EAAE,OAAe;QAC3D,MAAM,QAAQ,GAAG,EAAE,CAAC,UAAU,CAAC,QAAQ,CAAC;YACpC,CAAC,CAAC,EAAE,CAAC,YAAY,CAAC,QAAQ,EAAE,OAAO,CAAC;YACpC,CAAC,CAAC,IAAI,CAAC;QACX,IAAI,QAAQ,KAAK,OAAO,EAAE,CAAC;YACvB,EAAE,CAAC,aAAa,CAAC,QAAQ,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;QACjD,CAAC;IACL,CAAC;CACJ"}

package/package.json

@@ -1,13 +1,14 @@
 {
     "name": "@n8n-as-code/sync",
-    "version": "0.12.0",
+    "version": "0.13.0",
     "description": "Sync library for n8n-as-code ecosystem",
     "main": "dist/index.js",
     "types": "dist/index.d.ts",
     "type": "module",
     "scripts": {
         "prebuild": "node ../../scripts/compare-extraction.mjs || echo 'Warning: Report generation skipped/failed'",
-        "build": "tsc -b",
+        "copy-assets": "mkdir -p dist/assets && cp src/assets/n8n-workflows.d.ts dist/assets/",
+        "build": "tsc -b && npm run copy-assets",
         "watch": "tsc -b -w",
         "clean": "rm -rf dist tsconfig.tsbuildinfo",
         "test": "npm run test:unit && npm run test:integration",
@@ -16,6 +17,7 @@
         "validate-schema": "node ../../scripts/validate-schema.js --schema ./src/assets/n8n-nodes-index.json"
     },
     "dependencies": {
+        "@n8n-as-code/transformer": "0.2.0",
         "chokidar": "^3.5.3",
         "@types/json-stable-stringify": "^1.1.0",
         "axios": "^1.6.0",