@codenotch/codenotch.cli 1.0.36 → 1.0.37

package/dist/utils/I18nTsUtils.js

@@ -0,0 +1,221 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const fs_1 = require("fs");
+const path_1 = require("path");
+/**
+ * Generate an importable TypeScript class from the entries of a *.i18n.csv file.
+ *
+ * The generated class exposes one static method per translation key, e.g. for:
+ *   key,en,de
+ *   ,,
+ *   userWelcome,hello,hallo
+ *   hiMr,hello mister {0},hallo herr {0}
+ * we get `hello.userWelcome()` and `hello.hiMr(arg1)`.
+ *
+ * The file is fully regenerated on each run, it must not be edited by hand.
+ */
+class I18nTsUtils {
+    static RESERVED_MEMBERS = ['values', 'lang', 'setLanguage', 'getValue'];
+    static PLACEHOLDER_REGEX = /\{(\d+)\}/g;
+    static INDENT = '    ';
+    /**
+     * Converts a *.i18n.csv file name (or path) into a valid class name, e.g. 'src/hello.i18n.csv' => 'hello'
+     */
+    static getClassName(fileNameOrPath) {
+        const fileName = fileNameOrPath.replaceAll('\\', '/').split('/').pop() ?? '';
+        const name = fileName.replace(/\.i18n\.csv$/i, '').replace(/\.csv$/i, '');
+        return this.toIdentifier(name) || 'I18n';
+    }
+    /**
+     * Keeps only the real translation entries of a parsed csv: the rows without key are ignored
+     * (the csv may still contain a leading empty row, kept for readability).
+     */
+    static getEntries(lines) {
+        const entries = [];
+        for (const line of lines) {
+            const key = (line.key ?? '').trim();
+            if (key === '') {
+                continue;
+            }
+            entries.push({ ...line, key });
+        }
+        return entries;
+    }
+    /**
+     * Generates the TypeScript class.
+     * @param className name of the generated class
+     * @param sourceFileName name of the *.i18n.csv the class is generated from (mentioned in the file header)
+     * @param entries translation entries (see getEntries)
+     */
+    static generate(className, sourceFileName, entries) {
+        const warnings = [];
+        const languages = this.getLanguages(entries);
+        const valuesBlock = this.generateValuesBlock(entries, languages);
+        const methodsBlock = this.generateMethodsBlock(entries, languages, warnings);
+        return { content: this.generateTemplate(className, sourceFileName, languages[0] ?? 'en', valuesBlock, methodsBlock), warnings };
+    }
+    /**
+     * Languages in csv column order (every column except 'key', papaparse internals are ignored)
+     */
+    static getLanguages(entries) {
+        const languages = [];
+        for (const entry of entries) {
+            for (const column of Object.keys(entry)) {
+                if (column === 'key' || column.startsWith('__') || languages.includes(column)) {
+                    continue;
+                }
+                languages.push(column);
+            }
+        }
+        return languages;
+    }
+    static generateValuesBlock(entries, languages) {
+        const i = this.INDENT;
+        const lines = [];
+        lines.push(`${i}static values: { [key: string]: { [lang: string]: string } } = {`);
+        for (const entry of entries) {
+            const values = languages
+                .filter(lang => (entry[lang] ?? '').trim() !== '')
+                .map(lang => `${i}${i}${i}${JSON.stringify(lang)}: ${JSON.stringify(entry[lang])}`);
+            lines.push(`${i}${i}${JSON.stringify(entry.key)}: {`);
+            if (values.length > 0) {
+                lines.push(values.join(',\n'));
+            }
+            lines.push(`${i}${i}},`);
+        }
+        lines.push(`${i}};`);
+        return lines.join('\n');
+    }
+    static generateMethodsBlock(entries, languages, warnings) {
+        const i = this.INDENT;
+        const lines = [];
+        const usedNames = new Set();
+        for (const entry of entries) {
+            let methodName = this.toIdentifier(entry.key);
+            if (methodName !== entry.key) {
+                warnings.push(`Key '${entry.key}' is not a valid identifier, method '${methodName}' generated instead.`);
+            }
+            if (this.RESERVED_MEMBERS.includes(methodName)) {
+                warnings.push(`Key '${entry.key}' conflicts with a reserved member, method '${methodName}_' generated instead.`);
+                methodName = `${methodName}_`;
+            }
+            if (usedNames.has(methodName)) {
+                warnings.push(`Key '${entry.key}' produces the duplicated method '${methodName}', skipped.`);
+                continue;
+            }
+            usedNames.add(methodName);
+            const argCount = this.getArgCount(languages.map(lang => entry[lang] ?? ''));
+            const argNames = Array.from({ length: argCount }, (_, index) => `arg${index + 1}`);
+            const signature = argNames.map(name => `${name}: string`).join(', ');
+            const callArgs = [JSON.stringify(entry.key), ...argNames].join(', ');
+            lines.push(`${i}/**`);
+            for (const lang of languages) {
+                const value = (entry[lang] ?? '').trim();
+                if (value !== '') {
+                    lines.push(`${i} * ${lang.toUpperCase()}: ${this.toCommentText(value)}`);
+                }
+            }
+            lines.push(`${i} */`);
+            lines.push(`${i}static ${methodName}(${signature}) { return this.getValue(${callArgs}); }`);
+        }
+        return lines.join('\n');
+    }
+    /**
+     * Number of arguments needed by a translation: highest {n} placeholder + 1 over all languages
+     */
+    static getArgCount(values) {
+        let maxIndex = -1;
+        for (const value of values) {
+            for (const match of value.matchAll(this.PLACEHOLDER_REGEX)) {
+                maxIndex = Math.max(maxIndex, parseInt(match[1], 10));
+            }
+        }
+        return maxIndex + 1;
+    }
+    /**
+     * Makes a translation value safe inside a JSDoc comment: single line, no comment terminator
+     */
+    static toCommentText(value) {
+        return value.replace(/\r?\n/g, ' ').replaceAll('*/', '* /');
+    }
+    static toIdentifier(name) {
+        let identifier = name.trim().replace(/[^\w$]/g, '_');
+        if (/^\d/.test(identifier)) {
+            identifier = `_${identifier}`;
+        }
+        return identifier;
+    }
+    /**
+     * Header written at the top of the generated file
+     */
+    static generateHeader(className, sourceFileName) {
+        const version = this.getCliVersion();
+        const generator = version ? `codenotch-cli v${version}` : 'codenotch-cli';
+        const line = '-'.repeat(75);
+        return [
+            `/* ${line}`,
+            ` *  ${className}.i18n.ts`,
+            ` *`,
+            ` *  Generated by ${generator} from '${this.toCommentText(sourceFileName)}'.`,
+            ` *`,
+            ` *  THIS FILE IS GENERATED, DO NOT EDIT IT MANUALLY: it is entirely overwritten`,
+            ` *  each time it is regenerated, edit the csv instead and run:`,
+            ` *`,
+            ` *      cn generate i18n -f ${this.toCommentText(sourceFileName)}`,
+            ` * ${line} */`
+        ].join('\n');
+    }
+    static getCliVersion() {
+        try {
+            // works from both src/utils (tsx) and dist/utils (build)
+            const packageJson = JSON.parse((0, fs_1.readFileSync)((0, path_1.join)(__dirname, '../../package.json'), 'utf8'));
+            return typeof packageJson.version === 'string' ? packageJson.version : undefined;
+        }
+        catch {
+            return undefined;
+        }
+    }
+    static generateTemplate(className, sourceFileName, defaultLang, valuesBlock, methodsBlock) {
+        const i = this.INDENT;
+        return [
+            this.generateHeader(className, sourceFileName),
+            ``,
+            `export default abstract class ${className} {`,
+            ``,
+            valuesBlock,
+            ``,
+            `${i}static lang: string = ${JSON.stringify(defaultLang)};`,
+            `${i}static setLanguage(lang: string) {`,
+            `${i}${i}this.lang = lang.toLowerCase();`,
+            `${i}}`,
+            ``,
+            `${i}private static getValue(key: string, ...args: any[]) {`,
+            `${i}${i}try {`,
+            `${i}${i}${i}const values = this.values[key];`,
+            `${i}${i}${i}if (values === undefined) {`,
+            `${i}${i}${i}${i}return \`KEY '\${key}' NOT EXISTS\`;`,
+            `${i}${i}${i}}`,
+            ``,
+            `${i}${i}${i}let langValue = values[this.lang] ?? values[Object.keys(values)[0]];`,
+            `${i}${i}${i}let argIndex = 0;`,
+            `${i}${i}${i}for (const arg of args) {`,
+            `${i}${i}${i}${i}langValue = langValue.replaceAll(\`{\${argIndex}}\`, \`\${(arg ?? '')}\`.trim());`,
+            `${i}${i}${i}${i}argIndex++;`,
+            `${i}${i}${i}}`,
+            ``,
+            `${i}${i}${i}return langValue;`,
+            `${i}${i}}`,
+            `${i}${i}catch (e) {`,
+            `${i}${i}${i}console.error('I18N', e);`,
+            `${i}${i}${i}return 'ERROR';`,
+            `${i}${i}}`,
+            `${i}}`,
+            ``,
+            methodsBlock,
+            `}`,
+            ``
+        ].join('\n');
+    }
+}
+exports.default = I18nTsUtils;
+//# sourceMappingURL=I18nTsUtils.js.map

package/dist/utils/I18nTsUtils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"I18nTsUtils.js","sourceRoot":"","sources":["../../src/utils/I18nTsUtils.ts"],"names":[],"mappings":";;AAAA,2BAAkC;AAClC,+BAA4B;AAiB5B;;;;;;;;;;;GAWG;AACH,MAA8B,WAAW;IAE7B,MAAM,CAAU,gBAAgB,GAAG,CAAC,QAAQ,EAAE,MAAM,EAAE,aAAa,EAAE,UAAU,CAAC,CAAC;IACjF,MAAM,CAAU,iBAAiB,GAAG,YAAY,CAAC;IACjD,MAAM,CAAU,MAAM,GAAG,MAAM,CAAC;IAExC;;OAEG;IACH,MAAM,CAAC,YAAY,CAAC,cAAsB;QACtC,MAAM,QAAQ,GAAG,cAAc,CAAC,UAAU,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,IAAI,EAAE,CAAC;QAC7E,MAAM,IAAI,GAAG,QAAQ,CAAC,OAAO,CAAC,eAAe,EAAE,EAAE,CAAC,CAAC,OAAO,CAAC,SAAS,EAAE,EAAE,CAAC,CAAC;QAC1E,OAAO,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,IAAI,MAAM,CAAC;IAC7C,CAAC;IAED;;;OAGG;IACH,MAAM,CAAC,UAAU,CAAC,KAA2B;QACzC,MAAM,OAAO,GAAyB,EAAE,CAAC;QAEzC,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;YACvB,MAAM,GAAG,GAAG,CAAC,IAAI,CAAC,GAAG,IAAI,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC;YACpC,IAAI,GAAG,KAAK,EAAE,EAAE,CAAC;gBACb,SAAS;YACb,CAAC;YACD,OAAO,CAAC,IAAI,CAAC,EAAE,GAAG,IAAI,EAAE,GAAG,EAAE,CAAC,CAAC;QACnC,CAAC;QAED,OAAO,OAAO,CAAC;IACnB,CAAC;IAED;;;;;OAKG;IACH,MAAM,CAAC,QAAQ,CAAC,SAAiB,EAAE,cAAsB,EAAE,OAA6B;QACpF,MAAM,QAAQ,GAAa,EAAE,CAAC;QAC9B,MAAM,SAAS,GAAG,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC;QAC7C,MAAM,WAAW,GAAG,IAAI,CAAC,mBAAmB,CAAC,OAAO,EAAE,SAAS,CAAC,CAAC;QACjE,MAAM,YAAY,GAAG,IAAI,CAAC,oBAAoB,CAAC,OAAO,EAAE,SAAS,EAAE,QAAQ,CAAC,CAAC;QAE7E,OAAO,EAAE,OAAO,EAAE,IAAI,CAAC,gBAAgB,CAAC,SAAS,EAAE,cAAc,EAAE,SAAS,CAAC,CAAC,CAAC,IAAI,IAAI,EAAE,WAAW,EAAE,YAAY,CAAC,EAAE,QAAQ,EAAE,CAAC;IACpI,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,YAAY,CAAC,OAA6B;QAC7C,MAAM,SAAS,GAAa,EAAE,CAAC;QAC/B,KAAK,MAAM,KAAK,IAAI,OAAO,EAAE,CAAC;YAC1B,KAAK,MAAM,MAAM,IAAI,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC;gBACtC,IAAI,MAAM,KAAK,KAAK,IAAI,MAAM,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,SAAS,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,CAAC;oBAC5E,SAAS;gBACb,CAAC;gBACD,SAAS,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;YAC3B,CAAC;QACL,CAAC;QACD,OAAO,SAAS,CAAC;IACrB,CAAC;IAEO,MAAM,CAAC,mBAAmB,CAAC,OAA6B,EAAE,SAAmB;QACjF,MAAM,CAAC,GAAG,IAAI,CAAC,MAAM,CAAC;QACtB,MAAM,KAAK,GAAa,EAAE,CAAC;QAC3B,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,kEAAkE,CAAC,CAAC;QAEnF,KAAK,MAAM,KAAK,IAAI,OAAO,EAAE,CAAC;YAC1B,MAAM,MAAM,GAAG,SAAS;iBACnB,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,CAAC;iBACjD,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,KAAK,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC;YAExF,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;YACtD,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;gBACpB,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC;YACnC,CAAC;YACD,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QAC7B,CAAC;QAED,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QACrB,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC5B,CAAC;IAEO,MAAM,CAAC,oBAAoB,CAAC,OAA6B,EAAE,SAAmB,EAAE,QAAkB;QACtG,MAAM,CAAC,GAAG,IAAI,CAAC,MAAM,CAAC;QACtB,MAAM,KAAK,GAAa,EAAE,CAAC;QAC3B,MAAM,SAAS,GAAG,IAAI,GAAG,EAAU,CAAC;QAEpC,KAAK,MAAM,KAAK,IAAI,OAAO,EAAE,CAAC;YAC1B,IAAI,UAAU,GAAG,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;YAC9C,IAAI,UAAU,KAAK,KAAK,CAAC,GAAG,EAAE,CAAC;gBAC3B,QAAQ,CAAC,IAAI,CAAC,QAAQ,KAAK,CAAC,GAAG,wCAAwC,UAAU,sBAAsB,CAAC,CAAC;YAC7G,CAAC;YACD,IAAI,IAAI,CAAC,gBAAgB,CAAC,QAAQ,CAAC,UAAU,CAAC,EAAE,CAAC;gBAC7C,QAAQ,CAAC,IAAI,CAAC,QAAQ,KAAK,CAAC,GAAG,+CAA+C,UAAU,uBAAuB,CAAC,CAAC;gBACjH,UAAU,GAAG,GAAG,UAAU,GAAG,CAAC;YAClC,CAAC;YACD,IAAI,SAAS,CAAC,GAAG,CAAC,UAAU,CAAC,EAAE,CAAC;gBAC5B,QAAQ,CAAC,IAAI,CAAC,QAAQ,KAAK,CAAC,GAAG,qCAAqC,UAAU,aAAa,CAAC,CAAC;gBAC7F,SAAS;YACb,CAAC;YACD,SAAS,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;YAE1B,MAAM,QAAQ,GAAG,IAAI,CAAC,WAAW,CAAC,SAAS,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC;YAC5E,MAAM,QAAQ,GAAG,KAAK,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,QAAQ,EAAE,EAAE,CAAC,CAAC,EAAE,KAAK,EAAE,EAAE,CAAC,MAAM,KAAK,GAAG,CAAC,EAAE,CAAC,CAAC;YACnF,MAAM,SAAS,GAAG,QAAQ,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,GAAG,IAAI,UAAU,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YACrE,MAAM,QAAQ,GAAG,CAAC,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE,GAAG,QAAQ,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YAErE,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;YACtB,KAAK,MAAM,IAAI,IAAI,SAAS,EAAE,CAAC;gBAC3B,MAAM,KAAK,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC;gBACzC,IAAI,KAAK,KAAK,EAAE,EAAE,CAAC;oBACf,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,MAAM,IAAI,CAAC,WAAW,EAAE,KAAK,IAAI,CAAC,aAAa,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;gBAC7E,CAAC;YACL,CAAC;YACD,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;YACtB,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,UAAU,UAAU,IAAI,SAAS,4BAA4B,QAAQ,MAAM,CAAC,CAAC;QAChG,CAAC;QAED,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC5B,CAAC;IAED;;OAEG;IACK,MAAM,CAAC,WAAW,CAAC,MAAgB;QACvC,IAAI,QAAQ,GAAG,CAAC,CAAC,CAAC;QAClB,KAAK,MAAM,KAAK,IAAI,MAAM,EAAE,CAAC;YACzB,KAAK,MAAM,KAAK,IAAI,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC,iBAAiB,CAAC,EAAE,CAAC;gBACzD,QAAQ,GAAG,IAAI,CAAC,GAAG,CAAC,QAAQ,EAAE,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC;YAC1D,CAAC;QACL,CAAC;QACD,OAAO,QAAQ,GAAG,CAAC,CAAC;IACxB,CAAC;IAED;;OAEG;IACK,MAAM,CAAC,aAAa,CAAC,KAAa;QACtC,OAAO,KAAK,CAAC,OAAO,CAAC,QAAQ,EAAE,GAAG,CAAC,CAAC,UAAU,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;IAChE,CAAC;IAEO,MAAM,CAAC,YAAY,CAAC,IAAY;QACpC,IAAI,UAAU,GAAG,IAAI,CAAC,IAAI,EAAE,CAAC,OAAO,CAAC,SAAS,EAAE,GAAG,CAAC,CAAC;QACrD,IAAI,KAAK,CAAC,IAAI,CAAC,UAAU,CAAC,EAAE,CAAC;YACzB,UAAU,GAAG,IAAI,UAAU,EAAE,CAAC;QAClC,CAAC;QACD,OAAO,UAAU,CAAC;IACtB,CAAC;IAED;;OAEG;IACK,MAAM,CAAC,cAAc,CAAC,SAAiB,EAAE,cAAsB;QACnE,MAAM,OAAO,GAAG,IAAI,CAAC,aAAa,EAAE,CAAC;QACrC,MAAM,SAAS,GAAG,OAAO,CAAC,CAAC,CAAC,kBAAkB,OAAO,EAAE,CAAC,CAAC,CAAC,eAAe,CAAC;QAC1E,MAAM,IAAI,GAAG,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;QAC5B,OAAO;YACH,MAAM,IAAI,EAAE;YACZ,OAAO,SAAS,UAAU;YAC1B,IAAI;YACJ,oBAAoB,SAAS,UAAU,IAAI,CAAC,aAAa,CAAC,cAAc,CAAC,IAAI;YAC7E,IAAI;YACJ,iFAAiF;YACjF,gEAAgE;YAChE,IAAI;YACJ,+BAA+B,IAAI,CAAC,aAAa,CAAC,cAAc,CAAC,EAAE;YACnE,MAAM,IAAI,KAAK;SAClB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACjB,CAAC;IAEO,MAAM,CAAC,aAAa;QACxB,IAAI,CAAC;YACD,yDAAyD;YACzD,MAAM,WAAW,GAAG,IAAI,CAAC,KAAK,CAAC,IAAA,iBAAY,EAAC,IAAA,WAAI,EAAC,SAAS,EAAE,oBAAoB,CAAC,EAAE,MAAM,CAAC,CAAC,CAAC;YAC5F,OAAO,OAAO,WAAW,CAAC,OAAO,KAAK,QAAQ,CAAC,CAAC,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC,CAAC,SAAS,CAAC;QACrF,CAAC;QACD,MAAM,CAAC;YACH,OAAO,SAAS,CAAC;QACrB,CAAC;IACL,CAAC;IAEO,MAAM,CAAC,gBAAgB,CAAC,SAAiB,EAAE,cAAsB,EAAE,WAAmB,EAAE,WAAmB,EAAE,YAAoB;QACrI,MAAM,CAAC,GAAG,IAAI,CAAC,MAAM,CAAC;QACtB,OAAO;YACH,IAAI,CAAC,cAAc,CAAC,SAAS,EAAE,cAAc,CAAC;YAC9C,EAAE;YACF,iCAAiC,SAAS,IAAI;YAC9C,EAAE;YACF,WAAW;YACX,EAAE;YACF,GAAG,CAAC,yBAAyB,IAAI,CAAC,SAAS,CAAC,WAAW,CAAC,GAAG;YAC3D,GAAG,CAAC,oCAAoC;YACxC,GAAG,CAAC,GAAG,CAAC,iCAAiC;YACzC,GAAG,CAAC,GAAG;YACP,EAAE;YACF,GAAG,CAAC,wDAAwD;YAC5D,GAAG,CAAC,GAAG,CAAC,OAAO;YACf,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,kCAAkC;YAC9C,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,6BAA6B;YACzC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,sCAAsC;YACtD,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG;YACf,EAAE;YACF,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,sEAAsE;YAClF,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,mBAAmB;YAC/B,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,2BAA2B;YACvC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,mFAAmF;YACnG,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,aAAa;YAC7B,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG;YACf,EAAE;YACF,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,mBAAmB;YAC/B,GAAG,CAAC,GAAG,CAAC,GAAG;YACX,GAAG,CAAC,GAAG,CAAC,aAAa;YACrB,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,2BAA2B;YACvC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,iBAAiB;YAC7B,GAAG,CAAC,GAAG,CAAC,GAAG;YACX,GAAG,CAAC,GAAG;YACP,EAAE;YACF,YAAY;YACZ,GAAG;YACH,EAAE;SACL,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACjB,CAAC;;AAhOL,8BAiOC"}

package/dist/utils/OpenApiUtils.d.ts

@@ -0,0 +1,81 @@
+import { IDiscoveredProcess } from './ProjectUtils';
+import { IJsonSchema } from './TypeSchemaUtils';
+export interface IOpenApiOptions {
+    /** Title of the API, usually the project name */
+    title: string;
+    /** Version of the API, usually the project version */
+    version: string;
+    /** Description shown at the top of the document */
+    description?: string;
+}
+export interface IOpenApiGenerationResult {
+    document: IOpenApiDocument;
+    warnings: string[];
+    /** Number of endpoints written */
+    endpointCount: number;
+}
+export interface IOpenApiParameter {
+    name: string;
+    in: 'path' | 'query';
+    required: boolean;
+    schema: IJsonSchema;
+    description?: string;
+}
+export interface IOpenApiOperation {
+    operationId: string;
+    summary?: string;
+    description?: string;
+    tags?: string[];
+    parameters?: IOpenApiParameter[];
+    requestBody?: {
+        required: boolean;
+        content: {
+            'application/json': {
+                schema: IJsonSchema;
+            };
+        };
+    };
+    responses: Record<string, {
+        description: string;
+        content?: {
+            'application/json': {
+                schema: IJsonSchema;
+            };
+        };
+    }>;
+    /** Value of 'auth.scope' of the process, a Codenotch specific extension */
+    'x-codenotch-scope'?: string;
+    /** Id of the process behind the endpoint */
+    'x-codenotch-process': string;
+}
+export interface IOpenApiDocument {
+    openapi: '3.0.3';
+    info: {
+        title: string;
+        version: string;
+        description?: string;
+    };
+    paths: Record<string, Record<string, IOpenApiOperation>>;
+}
+/**
+ * Builds the OpenAPI document of a project out of its processes triggered by `api.*(...)`.
+ *
+ * The input type of `run` is split between the path (its properties named like a route segment),
+ * the query string (GET and DELETE) or the request body (other methods). The declared return
+ * type becomes the 200 response. What the sources do not state is left open rather than invented:
+ * an input without annotation gives no parameter, a return type that is a reference stays named.
+ */
+export default abstract class OpenApiUtils {
+    static generate(processes: IDiscoveredProcess[], options: IOpenApiOptions): IOpenApiGenerationResult;
+    /** Express style ':bookId' becomes OpenAPI style '{bookId}' */
+    static toOpenApiPath(route: string): string;
+    /** Names of the '{param}' segments of a path, in order */
+    static getPathParameterNames(route: string): string[];
+    private static sortKey;
+    private static toOperation;
+    /**
+     * Dispatches the properties of the input between the path, the query string and the body.
+     * A path parameter is always documented, typed from the input when it says so.
+     */
+    private static splitInput;
+}

package/dist/utils/OpenApiUtils.js

@@ -0,0 +1,123 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const FileUtils_1 = __importDefault(require("./FileUtils"));
+/** Methods whose input travels in the query string rather than in a body */
+const QUERY_METHODS = ['get', 'delete', 'head', 'options'];
+/**
+ * Builds the OpenAPI document of a project out of its processes triggered by `api.*(...)`.
+ *
+ * The input type of `run` is split between the path (its properties named like a route segment),
+ * the query string (GET and DELETE) or the request body (other methods). The declared return
+ * type becomes the 200 response. What the sources do not state is left open rather than invented:
+ * an input without annotation gives no parameter, a return type that is a reference stays named.
+ */
+class OpenApiUtils {
+    static generate(processes, options) {
+        const warnings = [];
+        const paths = {};
+        let endpointCount = 0;
+        const endpoints = processes
+            .filter(process => process.trigger?.kind === 'api')
+            // Sorted so that regenerating an unchanged project produces an unchanged file
+            .sort((left, right) => this.sortKey(left).localeCompare(this.sortKey(right)));
+        for (const process of endpoints) {
+            const trigger = process.trigger;
+            const where = `${FileUtils_1.default.getNameFromPath(process.filePath)}:${process.line}`;
+            if (process.id === undefined) {
+                warnings.push(`The endpoint ${trigger.method} ${trigger.route} (${where}) has a computed id, it cannot be given an operationId and is left out.`);
+                continue;
+            }
+            const route = this.toOpenApiPath(trigger.route);
+            const method = trigger.method.toLowerCase();
+            if (paths[route]?.[method] !== undefined) {
+                warnings.push(`${trigger.method} ${route} is declared twice, by '${paths[route][method].operationId}' and '${process.id}' (${where}); only the first one is kept.`);
+                continue;
+            }
+            // A process that takes no input has nothing to document, one that takes an untyped input does
+            if (process.takesInput && process.input === undefined) {
+                warnings.push(`'${process.id}' (${where}) declares no type for its input, its parameters are not documented.`);
+            }
+            paths[route] = paths[route] ?? {};
+            paths[route][method] = this.toOperation(process, method, route);
+            endpointCount++;
+        }
+        return {
+            document: {
+                openapi: '3.0.3',
+                info: { title: options.title, version: options.version, ...(options.description ? { description: options.description } : {}) },
+                paths
+            },
+            warnings,
+            endpointCount
+        };
+    }
+    /** Express style ':bookId' becomes OpenAPI style '{bookId}' */
+    static toOpenApiPath(route) {
+        return route.replace(/:([A-Za-z_$][\w$]*)/g, '{$1}');
+    }
+    /** Names of the '{param}' segments of a path, in order */
+    static getPathParameterNames(route) {
+        return [...route.matchAll(/\{([^}]+)\}/g)].map(match => match[1]);
+    }
+    static sortKey(process) {
+        const trigger = process.trigger;
+        return `${this.toOpenApiPath(trigger.route)} ${trigger.method}`;
+    }
+    static toOperation(process, method, route) {
+        const { parameters, body } = this.splitInput(process.input, route, method);
+        // Built in the order a reader expects: what it is, what it takes, what it gives back
+        return {
+            operationId: process.id,
+            ...(process.description === undefined ? {} : { summary: process.description }),
+            tags: [FileUtils_1.default.getNameFromPath(process.filePath, true)],
+            ...(parameters.length === 0 ? {} : { parameters }),
+            ...(body === undefined ? {} : {
+                requestBody: { required: (body.required ?? []).length > 0, content: { 'application/json': { schema: body } } }
+            }),
+            responses: {
+                '200': {
+                    description: 'Successful response',
+                    ...(process.output === undefined ? {} : { content: { 'application/json': { schema: process.output } } })
+                }
+            },
+            'x-codenotch-process': process.id,
+            ...(process.scope === undefined ? {} : { 'x-codenotch-scope': process.scope })
+        };
+    }
+    /**
+     * Dispatches the properties of the input between the path, the query string and the body.
+     * A path parameter is always documented, typed from the input when it says so.
+     */
+    static splitInput(input, route, method) {
+        const pathNames = this.getPathParameterNames(route);
+        const properties = input?.properties ?? {};
+        const required = new Set(input?.required ?? []);
+        const parameters = pathNames.map(name => ({
+            name,
+            in: 'path',
+            required: true,
+            schema: properties[name] ?? { type: 'string' }
+        }));
+        const remaining = Object.entries(properties).filter(([name]) => !pathNames.includes(name));
+        if (remaining.length === 0) {
+            return { parameters };
+        }
+        if (QUERY_METHODS.includes(method)) {
+            for (const [name, schema] of remaining) {
+                parameters.push({ name, in: 'query', required: required.has(name), schema });
+            }
+            return { parameters };
+        }
+        const body = { type: 'object', properties: Object.fromEntries(remaining) };
+        const bodyRequired = remaining.map(([name]) => name).filter(name => required.has(name));
+        if (bodyRequired.length > 0) {
+            body.required = bodyRequired;
+        }
+        return { parameters, body };
+    }
+}
+exports.default = OpenApiUtils;
+//# sourceMappingURL=OpenApiUtils.js.map

package/dist/utils/OpenApiUtils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"OpenApiUtils.js","sourceRoot":"","sources":["../../src/utils/OpenApiUtils.ts"],"names":[],"mappings":";;;;;AAEA,4DAAoC;AA8CpC,4EAA4E;AAC5E,MAAM,aAAa,GAAG,CAAC,KAAK,EAAE,QAAQ,EAAE,MAAM,EAAE,SAAS,CAAC,CAAC;AAE3D;;;;;;;GAOG;AACH,MAA8B,YAAY;IAEtC,MAAM,CAAC,QAAQ,CAAC,SAA+B,EAAE,OAAwB;QAErE,MAAM,QAAQ,GAAa,EAAE,CAAC;QAC9B,MAAM,KAAK,GAAsD,EAAE,CAAC;QACpE,IAAI,aAAa,GAAG,CAAC,CAAC;QAEtB,MAAM,SAAS,GAAG,SAAS;aACtB,MAAM,CAAC,OAAO,CAAC,EAAE,CAAC,OAAO,CAAC,OAAO,EAAE,IAAI,KAAK,KAAK,CAAC;YACnD,8EAA8E;aAC7E,IAAI,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,aAAa,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;QAElF,KAAK,MAAM,OAAO,IAAI,SAAS,EAAE,CAAC;YAE9B,MAAM,OAAO,GAAG,OAAO,CAAC,OAAyD,CAAC;YAClF,MAAM,KAAK,GAAG,GAAG,mBAAS,CAAC,eAAe,CAAC,OAAO,CAAC,QAAQ,CAAC,IAAI,OAAO,CAAC,IAAI,EAAE,CAAC;YAE/E,IAAI,OAAO,CAAC,EAAE,KAAK,SAAS,EAAE,CAAC;gBAC3B,QAAQ,CAAC,IAAI,CAAC,gBAAgB,OAAO,CAAC,MAAM,IAAI,OAAO,CAAC,KAAK,KAAK,KAAK,yEAAyE,CAAC,CAAC;gBAClJ,SAAS;YACb,CAAC;YAED,MAAM,KAAK,GAAG,IAAI,CAAC,aAAa,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;YAChD,MAAM,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,WAAW,EAAE,CAAC;YAE5C,IAAI,KAAK,CAAC,KAAK,CAAC,EAAE,CAAC,MAAM,CAAC,KAAK,SAAS,EAAE,CAAC;gBACvC,QAAQ,CAAC,IAAI,CAAC,GAAG,OAAO,CAAC,MAAM,IAAI,KAAK,2BAA2B,KAAK,CAAC,KAAK,CAAC,CAAC,MAAM,CAAC,CAAC,WAAW,UAAU,OAAO,CAAC,EAAE,MAAM,KAAK,gCAAgC,CAAC,CAAC;gBACpK,SAAS;YACb,CAAC;YAED,8FAA8F;YAC9F,IAAI,OAAO,CAAC,UAAU,IAAI,OAAO,CAAC,KAAK,KAAK,SAAS,EAAE,CAAC;gBACpD,QAAQ,CAAC,IAAI,CAAC,IAAI,OAAO,CAAC,EAAE,MAAM,KAAK,sEAAsE,CAAC,CAAC;YACnH,CAAC;YAED,KAAK,CAAC,KAAK,CAAC,GAAG,KAAK,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC;YAClC,KAAK,CAAC,KAAK,CAAC,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC,WAAW,CAAC,OAAO,EAAE,MAAM,EAAE,KAAK,CAAC,CAAC;YAChE,aAAa,EAAE,CAAC;QACpB,CAAC;QAED,OAAO;YACH,QAAQ,EAAE;gBACN,OAAO,EAAE,OAAO;gBAChB,IAAI,EAAE,EAAE,KAAK,EAAE,OAAO,CAAC,KAAK,EAAE,OAAO,EAAE,OAAO,CAAC,OAAO,EAAE,GAAG,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC,CAAC,EAAE,WAAW,EAAE,OAAO,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE;gBAC9H,KAAK;aACR;YACD,QAAQ;YACR,aAAa;SAChB,CAAC;IACN,CAAC;IAED,+DAA+D;IAC/D,MAAM,CAAC,aAAa,CAAC,KAAa;QAC9B,OAAO,KAAK,CAAC,OAAO,CAAC,sBAAsB,EAAE,MAAM,CAAC,CAAC;IACzD,CAAC;IAED,0DAA0D;IAC1D,MAAM,CAAC,qBAAqB,CAAC,KAAa;QACtC,OAAO,CAAC,GAAG,KAAK,CAAC,QAAQ,CAAC,cAAc,CAAC,CAAC,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;IACtE,CAAC;IAEO,MAAM,CAAC,OAAO,CAAC,OAA2B;QAC9C,MAAM,OAAO,GAAG,OAAO,CAAC,OAA4C,CAAC;QACrE,OAAO,GAAG,IAAI,CAAC,aAAa,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,OAAO,CAAC,MAAM,EAAE,CAAC;IACpE,CAAC;IAEO,MAAM,CAAC,WAAW,CAAC,OAA2B,EAAE,MAAc,EAAE,KAAa;QAEjF,MAAM,EAAE,UAAU,EAAE,IAAI,EAAE,GAAG,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,KAAK,EAAE,KAAK,EAAE,MAAM,CAAC,CAAC;QAE3E,qFAAqF;QACrF,OAAO;YACH,WAAW,EAAE,OAAO,CAAC,EAAG;YACxB,GAAG,CAAC,OAAO,CAAC,WAAW,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,OAAO,CAAC,WAAW,EAAE,CAAC;YAC9E,IAAI,EAAE,CAAC,mBAAS,CAAC,eAAe,CAAC,OAAO,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;YACzD,GAAG,CAAC,UAAU,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,UAAU,EAAE,CAAC;YAClD,GAAG,CAAC,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;gBAC1B,WAAW,EAAE,EAAE,QAAQ,EAAE,CAAC,IAAI,CAAC,QAAQ,IAAI,EAAE,CAAC,CAAC,MAAM,GAAG,CAAC,EAAE,OAAO,EAAE,EAAE,kBAAkB,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,EAAE,EAAE;aACjH,CAAC;YACF,SAAS,EAAE;gBACP,KAAK,EAAE;oBACH,WAAW,EAAE,qBAAqB;oBAClC,GAAG,CAAC,OAAO,CAAC,MAAM,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,EAAE,kBAAkB,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,MAAM,EAAE,EAAE,EAAE,CAAC;iBAC3G;aACJ;YACD,qBAAqB,EAAE,OAAO,CAAC,EAAG;YAClC,GAAG,CAAC,OAAO,CAAC,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,mBAAmB,EAAE,OAAO,CAAC,KAAK,EAAE,CAAC;SACjF,CAAC;IACN,CAAC;IAED;;;OAGG;IACK,MAAM,CAAC,UAAU,CAAC,KAA8B,EAAE,KAAa,EAAE,MAAc;QAEnF,MAAM,SAAS,GAAG,IAAI,CAAC,qBAAqB,CAAC,KAAK,CAAC,CAAC;QACpD,MAAM,UAAU,GAAG,KAAK,EAAE,UAAU,IAAI,EAAE,CAAC;QAC3C,MAAM,QAAQ,GAAG,IAAI,GAAG,CAAC,KAAK,EAAE,QAAQ,IAAI,EAAE,CAAC,CAAC;QAEhD,MAAM,UAAU,GAAwB,SAAS,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;YAC3D,IAAI;YACJ,EAAE,EAAE,MAAM;YACV,QAAQ,EAAE,IAAI;YACd,MAAM,EAAE,UAAU,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,EAAE,QAAQ,EAAE;SACjD,CAAC,CAAC,CAAC;QAEJ,MAAM,SAAS,GAAG,MAAM,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,EAAE,CAAC,CAAC,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC;QAE3F,IAAI,SAAS,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACzB,OAAO,EAAE,UAAU,EAAE,CAAC;QAC1B,CAAC;QAED,IAAI,aAAa,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,CAAC;YACjC,KAAK,MAAM,CAAC,IAAI,EAAE,MAAM,CAAC,IAAI,SAAS,EAAE,CAAC;gBACrC,UAAU,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,EAAE,EAAE,OAAO,EAAE,QAAQ,EAAE,QAAQ,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC,CAAC;YACjF,CAAC;YACD,OAAO,EAAE,UAAU,EAAE,CAAC;QAC1B,CAAC;QAED,MAAM,IAAI,GAAgB,EAAE,IAAI,EAAE,QAAQ,EAAE,UAAU,EAAE,MAAM,CAAC,WAAW,CAAC,SAAS,CAAC,EAAE,CAAC;QACxF,MAAM,YAAY,GAAG,SAAS,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC,QAAQ,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC;QACxF,IAAI,YAAY,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAC1B,IAAI,CAAC,QAAQ,GAAG,YAAY,CAAC;QACjC,CAAC;QAED,OAAO,EAAE,UAAU,EAAE,IAAI,EAAE,CAAC;IAChC,CAAC;CACJ;AAjID,+BAiIC"}

package/dist/utils/ProjectCompilationUtils.d.ts

@@ -28,7 +28,6 @@ export default abstract class ProjectCompilationUtils {
      */
     static compileTestProject(targetPath: string): Promise<CompilationResult>;
     static generateDbSchema(context: CompilationContext): Promise<string>;
-    static getManifestFileType(file: string): "" | "table" | "document" | "script" | "jsxtsx" | "i18n";
     /**
      * Generate the full project manifest
      * Uses the manifest cache if available, otherwise read the project files to generate the full manifest

package/dist/utils/ProjectCompilationUtils.js

@@ -24,7 +24,9 @@ class ProjectCompilationUtils {
         // TODO: Generate ts files for i18n (one per *.i18n.csv)
         const context = {
             targetPath: targetPath,
-            files: FileUtils_1.default.getAllFilesFromPath(targetPath, ['node_modules', '.codenotch', '.git', 'dist', 'build', 'out', '.github']),
+            files: FileUtils_1.default.listFilesRecursively(targetPath, {
+                ignoredFolderNames: ['node_modules', '.codenotch', '.git', 'dist', 'build', 'out', '.github']
+            }),
             errors: [],
             warnings: []
         };
@@ -35,7 +37,7 @@ class ProjectCompilationUtils {
         // Overwrite manifest
         FileUtils_1.default.writeFileSync(path_1.default.join(targetPath, MANIFEST_FILE_NAME), JSON.stringify(context.manifest, null, 4));
         // Remove .npmrc if exists, we don't want to expose it
-        FileUtils_1.default.delete(path_1.default.join(targetPath, '.npmrc'));
+        FileUtils_1.default.deleteRecursively(path_1.default.join(targetPath, '.npmrc'));
         if (context.errors.length > 0) {
             console.log(chalk_1.default.red(`Compilation finished with ${context.errors.length} error(s)`));
         }
@@ -72,16 +74,6 @@ class ProjectCompilationUtils {
         // TODO: Generate DB schema (read all .ts/.js files that declare a table)
         throw new Error('Not implemented.');
     }
-    static getManifestFileType(file) {
-        file = file.toLowerCase();
-        let fileType = file.endsWith('.table') ? 'table' :
-            file.endsWith('.jschema') ? 'document' :
-                file.endsWith('.tsx') ? 'jsxtsx' :
-                    file.endsWith('.jsx') ? 'jsxtsx' :
-                        file.endsWith('.i18n.csv') ? 'i18n' :
-                            file.endsWith('.js') ? 'script' : '';
-        return fileType;
-    }
     /**
      * Generate the full project manifest
      * Uses the manifest cache if available, otherwise read the project files to generate the full manifest
@@ -121,44 +113,4 @@ class ProjectCompilationUtils {
     }
 }
 exports.default = ProjectCompilationUtils;
-class TypescriptUtils {
-    /**
-     * Read TS table definition file like:
-     * ```ts
-        import { defineEntity, type InferEntity, p } from '@codenotch/orm';
-
-        export const User = defineEntity({
-            name: 'User',
-            properties: {
-                id: p.integer().primary(),
-                fullName: p.string(),
-                email: p.string()
-            },
-        });
-
-        export type IUser = InferEntity<typeof User>;
-     * ```
-     *
-     * And returns the table structure(s) (can have multiple table in one file)
-     */
-    static async parseTablesFromScript(ts) {
-        // TODO
-        return [];
-    }
-    /**
-     * Find all file (recursivly) in a given folder (workspacePath) that contains a table declaration ('defineEntity').
-     */
-    static async discoverTableFiles(workspacePath) {
-    }
-    /**
-     * Find all file (recursivly) in a given folder (workspacePath) that contains a table declaration ('defineDocument').
-     */
-    static async discoverDocumentFiles(workspacePath) {
-    }
-    /**
-     * Find all file (recursivly) in a given folder (workspacePath) that contains a table declaration ('process').
-     */
-    static async discoverProcessFiles(workspacePath) {
-    }
-}
 //# sourceMappingURL=ProjectCompilationUtils.js.map

package/dist/utils/ProjectCompilationUtils.js.map

@@ -1 +1 @@
-{"version":3,"file":"ProjectCompilationUtils.js","sourceRoot":"","sources":["../../src/utils/ProjectCompilationUtils.ts"],"names":[],"mappings":";;;;;AAAA,gDAAwB;AAExB,4DAAoC;AACpC,kEAA0C;AAE1C,kDAA0B;AAmB1B,MAAM,kBAAkB,GAAG,eAAe,CAAC;AAC3C,MAAM,mBAAmB,GAAG,eAAe,CAAC;AAC5C,MAA8B,uBAAuB;IAEjD;;;;;;;OAOG;IACI,MAAM,CAAC,KAAK,CAAC,cAAc,CAAC,UAAkB;QAEjD,+EAA+E;QAC/E,8EAA8E;QAC9E,wDAAwD;QAExD,MAAM,OAAO,GAAuB;YAChC,UAAU,EAAE,UAAU;YACtB,KAAK,EAAE,mBAAS,CAAC,mBAAmB,CAAC,UAAU,EAAE,CAAC,cAAc,EAAE,YAAY,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,KAAK,EAAE,SAAS,CAAC,CAAC;YAC3H,MAAM,EAAE,EAAE;YACV,QAAQ,EAAE,EAAE;SACf,CAAC;QAGF,qFAAqF;QACrF,OAAO,CAAC,GAAG,CAAC,eAAK,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,yBAAyB,CAAC,CAAC;QACzD,OAAO,CAAC,QAAQ,GAAG,MAAM,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;QAExD,sBAAY,CAAC,KAAK,CAAC,oBAAoB,CAAC,CAAC;QAEzC,qBAAqB;QACrB,mBAAS,CAAC,aAAa,CAAC,cAAI,CAAC,IAAI,CAAC,UAAU,EAAE,kBAAkB,CAAC,EAAE,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,QAAQ,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC;QAE9G,sDAAsD;QACtD,mBAAS,CAAC,MAAM,CAAC,cAAI,CAAC,IAAI,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAC,CAAC;QAElD,IAAI,OAAO,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAC5B,OAAO,CAAC,GAAG,CAAC,eAAK,CAAC,GAAG,CAAC,6BAA6B,OAAO,CAAC,MAAM,CAAC,MAAM,WAAW,CAAC,CAAC,CAAC;QAC1F,CAAC;aACI,CAAC;YACF,sBAAY,CAAC,KAAK,CAAC,sBAAsB,CAAC,CAAC;QAC/C,CAAC;QAED,OAAO;YACH,MAAM,EAAE,OAAO,CAAC,MAAM;YACtB,QAAQ,EAAE,OAAO,CAAC,QAAQ;SAC7B,CAAC;IACN,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,KAAK,CAAC,kBAAkB,CAAC,UAAkB;QAErD,MAAM,OAAO,GAAuB,EAAE,UAAU,EAAE,UAAU,EAAE,KAAK,EAAE,EAAE,EAAE,MAAM,EAAE,EAAE,EAAE,QAAQ,EAAE,EAAE,EAAE,CAAC;QAEpG,qFAAqF;QACrF,OAAO,CAAC,QAAQ,GAAG,MAAM,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;QAGxD,0BAA0B;QAC1B,mBAAS,CAAC,aAAa,CAAC,cAAI,CAAC,IAAI,CAAC,UAAU,EAAE,kBAAkB,CAAC,EAAE,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,QAAQ,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC;QAE9G,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;QACtD,IAAG,QAAQ,EAAC,CAAC;YACT,mBAAS,CAAC,aAAa,CAAC,cAAI,CAAC,IAAI,CAAC,UAAU,EAAE,mBAAmB,CAAC,EAAE,QAAQ,CAAC,CAAC;QAClF,CAAC;QAED,OAAO;YACH,MAAM,EAAE,OAAO,CAAC,MAAM;YACtB,QAAQ,EAAE,OAAO,CAAC,QAAQ;SAC7B,CAAC;IACN,CAAC;IAED,MAAM,CAAC,KAAK,CAAC,gBAAgB,CAAC,OAA2B;QACrD,yEAAyE;QAEzE,MAAM,IAAI,KAAK,CAAC,kBAAkB,CAAC,CAAC;IACxC,CAAC;IAIM,MAAM,CAAC,mBAAmB,CAAC,IAAY;QAC1C,IAAI,GAAG,IAAI,CAAC,WAAW,EAAE,CAAC;QAC1B,IAAI,QAAQ,GACR,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC;YAC/B,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC;gBACpC,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC;oBAC9B,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC;wBAC9B,IAAI,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC;4BACjC,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,CAAC;QAC7D,OAAO,QAAQ,CAAC;IACpB,CAAC;IAED;;;OAGG;IACI,MAAM,CAAC,KAAK,CAAC,gBAAgB,CAAC,OAA2B;QAE5D,MAAM,WAAW,GAAG,OAAO,CAAC,UAAU,CAAC;QAEvC,sIAAsI;QACtI,MAAM,QAAQ,GAAG,MAAM,mBAAS,CAAC,iBAAiB,CAA4B,cAAI,CAAC,IAAI,CAAC,WAAW,EAAE,kBAAkB,CAAC,CAAC,CAAC;QAC1H,IAAI,CAAC,QAAQ,EAAE,CAAC;YACZ,MAAM,IAAI,KAAK,CAAC,sCAAsC,CAAC,CAAC;QAC5D,CAAC;QAED,4BAA4B;QAC5B,QAAQ,CAAC,SAAS,GAAG,QAAQ,CAAC,SAAS,IAAI,EAAE,CAAC;QAC9C,QAAQ,CAAC,KAAK,GAAG,QAAQ,CAAC,KAAK,IAAI,EAAE,CAAC;QAGtC,4BAA4B;QAC5B,IAAI,CAAC,QAAQ,CAAC,OAAO,IAAI,EAAE,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC;YACzC,QAAQ,CAAC,OAAO,GAAG,OAAO,CAAC;QAC/B,CAAC;QAED,qCAAqC;QACrC,IAAI,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAM,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,WAAW,EAAE,KAAK,KAAK,CAAC,KAAK,SAAS,EAAE,CAAC;YAChF,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC;gBAChB,IAAI,EAAE,KAAK;gBACX,WAAW,EAAE,4BAA4B;aAC5C,CAAC,CAAC;QACP,CAAC;QACD,IAAI,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAM,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,WAAW,EAAE,KAAK,OAAO,CAAC,KAAK,SAAS,EAAE,CAAC;YAClF,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC;gBAChB,IAAI,EAAE,OAAO;gBACb,WAAW,EAAE,+BAA+B;aAC/C,CAAC,CAAC;QACP,CAAC;QAED,qDAAqD;QACrD,IAAI,QAAQ,CAAC,SAAS,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAClC,QAAQ,CAAC,SAAS,GAAG,CAAC,IAAI,CAAC,CAAA;QAC/B,CAAC;QAGD,OAAO,QAAQ,CAAC;IACpB,CAAC;CAKJ;AAnJD,0CAmJC;AAED,MAAe,eAAe;IAE1B;;;;;;;;;;;;;;;;;;OAkBG;IACH,MAAM,CAAC,KAAK,CAAC,qBAAqB,CAAC,EAAU;QAEzC,OAAO;QAEP,OAAO,EAAE,CAAC;IACd,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,KAAK,CAAC,kBAAkB,CAAC,aAAqB;IAErD,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,KAAK,CAAC,qBAAqB,CAAC,aAAqB;IAExD,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,KAAK,CAAC,oBAAoB,CAAC,aAAqB;IAEvD,CAAC;CACJ"}
+{"version":3,"file":"ProjectCompilationUtils.js","sourceRoot":"","sources":["../../src/utils/ProjectCompilationUtils.ts"],"names":[],"mappings":";;;;;AAAA,gDAAwB;AAExB,4DAAoC;AACpC,kEAA0C;AAE1C,kDAA0B;AAmB1B,MAAM,kBAAkB,GAAG,eAAe,CAAC;AAC3C,MAAM,mBAAmB,GAAG,eAAe,CAAC;AAC5C,MAA8B,uBAAuB;IAEjD;;;;;;;OAOG;IACI,MAAM,CAAC,KAAK,CAAC,cAAc,CAAC,UAAkB;QAEjD,+EAA+E;QAC/E,8EAA8E;QAC9E,wDAAwD;QAExD,MAAM,OAAO,GAAuB;YAChC,UAAU,EAAE,UAAU;YACtB,KAAK,EAAE,mBAAS,CAAC,oBAAoB,CAAC,UAAU,EAAE;gBAC9C,kBAAkB,EAAE,CAAC,cAAc,EAAE,YAAY,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,KAAK,EAAE,SAAS,CAAC;aAChG,CACA;YACD,MAAM,EAAE,EAAE;YACV,QAAQ,EAAE,EAAE;SACf,CAAC;QAGF,qFAAqF;QACrF,OAAO,CAAC,GAAG,CAAC,eAAK,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,yBAAyB,CAAC,CAAC;QACzD,OAAO,CAAC,QAAQ,GAAG,MAAM,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;QAExD,sBAAY,CAAC,KAAK,CAAC,oBAAoB,CAAC,CAAC;QAEzC,qBAAqB;QACrB,mBAAS,CAAC,aAAa,CAAC,cAAI,CAAC,IAAI,CAAC,UAAU,EAAE,kBAAkB,CAAC,EAAE,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,QAAQ,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC;QAE9G,sDAAsD;QACtD,mBAAS,CAAC,iBAAiB,CAAC,cAAI,CAAC,IAAI,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAC,CAAC;QAE7D,IAAI,OAAO,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAC5B,OAAO,CAAC,GAAG,CAAC,eAAK,CAAC,GAAG,CAAC,6BAA6B,OAAO,CAAC,MAAM,CAAC,MAAM,WAAW,CAAC,CAAC,CAAC;QAC1F,CAAC;aACI,CAAC;YACF,sBAAY,CAAC,KAAK,CAAC,sBAAsB,CAAC,CAAC;QAC/C,CAAC;QAED,OAAO;YACH,MAAM,EAAE,OAAO,CAAC,MAAM;YACtB,QAAQ,EAAE,OAAO,CAAC,QAAQ;SAC7B,CAAC;IACN,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,KAAK,CAAC,kBAAkB,CAAC,UAAkB;QAErD,MAAM,OAAO,GAAuB,EAAE,UAAU,EAAE,UAAU,EAAE,KAAK,EAAE,EAAE,EAAE,MAAM,EAAE,EAAE,EAAE,QAAQ,EAAE,EAAE,EAAE,CAAC;QAEpG,qFAAqF;QACrF,OAAO,CAAC,QAAQ,GAAG,MAAM,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;QAGxD,0BAA0B;QAC1B,mBAAS,CAAC,aAAa,CAAC,cAAI,CAAC,IAAI,CAAC,UAAU,EAAE,kBAAkB,CAAC,EAAE,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,QAAQ,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC;QAE9G,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;QACtD,IAAG,QAAQ,EAAC,CAAC;YACT,mBAAS,CAAC,aAAa,CAAC,cAAI,CAAC,IAAI,CAAC,UAAU,EAAE,mBAAmB,CAAC,EAAE,QAAQ,CAAC,CAAC;QAClF,CAAC;QAED,OAAO;YACH,MAAM,EAAE,OAAO,CAAC,MAAM;YACtB,QAAQ,EAAE,OAAO,CAAC,QAAQ;SAC7B,CAAC;IACN,CAAC;IAED,MAAM,CAAC,KAAK,CAAC,gBAAgB,CAAC,OAA2B;QACrD,yEAAyE;QAEzE,MAAM,IAAI,KAAK,CAAC,kBAAkB,CAAC,CAAC;IACxC,CAAC;IAED;;;OAGG;IACI,MAAM,CAAC,KAAK,CAAC,gBAAgB,CAAC,OAA2B;QAE5D,MAAM,WAAW,GAAG,OAAO,CAAC,UAAU,CAAC;QAEvC,sIAAsI;QACtI,MAAM,QAAQ,GAAG,MAAM,mBAAS,CAAC,iBAAiB,CAA4B,cAAI,CAAC,IAAI,CAAC,WAAW,EAAE,kBAAkB,CAAC,CAAC,CAAC;QAC1H,IAAI,CAAC,QAAQ,EAAE,CAAC;YACZ,MAAM,IAAI,KAAK,CAAC,sCAAsC,CAAC,CAAC;QAC5D,CAAC;QAED,4BAA4B;QAC5B,QAAQ,CAAC,SAAS,GAAG,QAAQ,CAAC,SAAS,IAAI,EAAE,CAAC;QAC9C,QAAQ,CAAC,KAAK,GAAG,QAAQ,CAAC,KAAK,IAAI,EAAE,CAAC;QAGtC,4BAA4B;QAC5B,IAAI,CAAC,QAAQ,CAAC,OAAO,IAAI,EAAE,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC;YACzC,QAAQ,CAAC,OAAO,GAAG,OAAO,CAAC;QAC/B,CAAC;QAED,qCAAqC;QACrC,IAAI,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAM,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,WAAW,EAAE,KAAK,KAAK,CAAC,KAAK,SAAS,EAAE,CAAC;YAChF,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC;gBAChB,IAAI,EAAE,KAAK;gBACX,WAAW,EAAE,4BAA4B;aAC5C,CAAC,CAAC;QACP,CAAC;QACD,IAAI,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAM,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,WAAW,EAAE,KAAK,OAAO,CAAC,KAAK,SAAS,EAAE,CAAC;YAClF,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC;gBAChB,IAAI,EAAE,OAAO;gBACb,WAAW,EAAE,+BAA+B;aAC/C,CAAC,CAAC;QACP,CAAC;QAED,qDAAqD;QACrD,IAAI,QAAQ,CAAC,SAAS,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAClC,QAAQ,CAAC,SAAS,GAAG,CAAC,IAAI,CAAC,CAAA;QAC/B,CAAC;QAGD,OAAO,QAAQ,CAAC;IACpB,CAAC;CAKJ;AAxID,0CAwIC"}

package/dist/utils/ProjectGeneratorUtils.d.ts

@@ -0,0 +1,35 @@
+export interface IGenerationResult {
+    /** Absolute paths of the files written */
+    written: string[];
+    warnings: string[];
+    /** Why nothing was written, when the project simply has nothing to generate from */
+    skipped?: string;
+    /** Why the generation failed, when it did */
+    error?: string;
+}
+/**
+ * The generators of the derived files of a project, shared by 'cn generate ...' (one at a time)
+ * and 'cn project new' (all of them, once the template is written).
+ *
+ * Every generator reports rather than prints: the command decides how to show the outcome.
+ */
+export default abstract class ProjectGeneratorUtils {
+    /** 'db-schema.xml' and 'db-schema.ts' from the 'defineEntity' declarations of the project */
+    static generateDbContext(projectPath: string): Promise<IGenerationResult & {
+        tableCount: number;
+    }>;
+    /** 'openapi.json' from the processes triggered by an api call */
+    static generateOpenApi(projectPath: string): Promise<IGenerationResult & {
+        endpointCount: number;
+    }>;
+    /** The '*.i18n.ts' class of one '*.i18n.csv', written next to it */
+    static generateI18n(csvPath: string): Promise<IGenerationResult & {
+        keyCount: number;
+    }>;
+    /**
+     * Every derived file of a project: the database schema when it declares tables, the class of
+     * each translation file, the openapi document when it exposes endpoints. Skipped generators
+     * are silent, since a project without tables is not an error.
+     */
+    static generateAll(projectPath: string): Promise<IGenerationResult>;
+}