@opra/cli 1.0.0-alpha.9 → 1.0.0-beta.1

package/cjs/file-writer.js

@@ -2,10 +2,10 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.FileWriter = void 0;
 const tslib_1 = require("tslib");
-const fs_1 = tslib_1.__importDefault(require("fs"));
+const node_fs_1 = tslib_1.__importDefault(require("node:fs"));
 class FileWriter {
     writeFile(filename, contents) {
-        fs_1.default.writeFileSync(filename, contents, 'utf-8');
+        node_fs_1.default.writeFileSync(filename, contents, 'utf-8');
     }
 }
 exports.FileWriter = FileWriter;

package/cjs/oprimp-cli.js

@@ -1,35 +1,37 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 const tslib_1 = require("tslib");
+const console = tslib_1.__importStar(require("node:console"));
+const fs = tslib_1.__importStar(require("node:fs"));
+const node_path_1 = tslib_1.__importDefault(require("node:path"));
+const process = tslib_1.__importStar(require("node:process"));
 const common_1 = require("@opra/common");
-const chalk_1 = tslib_1.__importDefault(require("chalk"));
+const ansi_colors_1 = tslib_1.__importDefault(require("ansi-colors"));
 const commander_1 = require("commander");
-const console = tslib_1.__importStar(require("console"));
-const fs = tslib_1.__importStar(require("fs"));
-const path_1 = tslib_1.__importDefault(require("path"));
-const process = tslib_1.__importStar(require("process"));
 const ts_generator_js_1 = require("./ts-generator/ts-generator.js");
-const dirname = path_1.default.dirname((0, common_1.getStackFileName)());
-const pkgJson = JSON.parse(fs.readFileSync(path_1.default.resolve(dirname, '../package.json'), 'utf-8'));
+const dirname = node_path_1.default.dirname((0, common_1.getStackFileName)());
+const pkgJson = JSON.parse(fs.readFileSync(node_path_1.default.resolve(dirname, '../package.json'), 'utf-8'));
 commander_1.program
     .version(pkgJson.version)
     .argument('<serviceUrl>', 'OPRA service url')
     .argument('<outDir>', 'Output directory')
     .option('--ext', 'Adds js extension to imports')
+    .option('--refns', 'Exports references with namespaces')
     .option('--no-color', 'Disables colors in logs messages')
     .action(async (serviceUrl, outDir, options) => {
     if (!options.color)
-        chalk_1.default.level = 0;
+        ansi_colors_1.default.enabled = false;
     const generator = new ts_generator_js_1.TsGenerator({
         serviceUrl,
         logger: console,
         outDir,
         importExt: options.ext,
+        referenceNamespaces: options.refns,
         fileHeader: `/* Generated by OPRA Code Generator, Version ${pkgJson.version} */`,
     });
     await generator
         .generate()
-        .then(() => console.log(chalk_1.default.greenBright('Completed')))
+        .then(() => console.log(ansi_colors_1.default.greenBright('Completed')))
         .catch(e => console.error(e.message));
 });
 if (process.argv.length < 3)

package/cjs/ts-generator/{processors → generators}/clean-directory.js

@@ -1,10 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.cleanDirectory = void 0;
+exports.cleanDirectory = cleanDirectory;
 const tslib_1 = require("tslib");
 const node_fs_1 = tslib_1.__importDefault(require("node:fs"));
 const node_path_1 = tslib_1.__importDefault(require("node:path"));
-const chalk_1 = tslib_1.__importDefault(require("chalk"));
+const ansi_colors_1 = tslib_1.__importDefault(require("ansi-colors"));
 function cleanDirectory(dirname) {
     const rootDir = dirname;
     const _cleanDirectory = (targetDir) => {
@@ -16,7 +16,7 @@ function cleanDirectory(dirname) {
             if (node_fs_1.default.statSync(absolutePath).isDirectory()) {
                 _cleanDirectory(absolutePath);
                 if (!node_fs_1.default.readdirSync(absolutePath).length) {
-                    this.emit('verbose', chalk_1.default.cyan(`Removing directory ${node_path_1.default.relative(absolutePath, rootDir)}`));
+                    this.emit('verbose', ansi_colors_1.default.cyan(`Removing directory ${node_path_1.default.relative(absolutePath, rootDir)}`));
                     node_fs_1.default.rmdirSync(absolutePath);
                 }
                 continue;
@@ -24,7 +24,7 @@ function cleanDirectory(dirname) {
             if (node_path_1.default.extname(f) === '.ts') {
                 const contents = node_fs_1.default.readFileSync(absolutePath, 'utf-8');
                 if (contents.includes('#!oprimp_auto_generated!#')) {
-                    this.emit('verbose', chalk_1.default.cyan(`Removing file ${node_path_1.default.relative(absolutePath, rootDir)}`));
+                    this.emit('verbose', ansi_colors_1.default.cyan(`Removing file ${node_path_1.default.relative(absolutePath, rootDir)}`));
                     node_fs_1.default.unlinkSync(absolutePath);
                 }
             }
@@ -32,4 +32,3 @@ function cleanDirectory(dirname) {
     };
     _cleanDirectory(dirname);
 }
-exports.cleanDirectory = cleanDirectory;

package/cjs/ts-generator/generators/generate-data-type.js

@@ -0,0 +1,258 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.generateDataType = generateDataType;
+exports._generateTypeCode = _generateTypeCode;
+exports._generateEnumTypeCode = _generateEnumTypeCode;
+exports._generateComplexTypeCode = _generateComplexTypeCode;
+exports._generateSimpleTypeCode = _generateSimpleTypeCode;
+exports._generateMixinTypeCode = _generateMixinTypeCode;
+exports._generateMappedTypeCode = _generateMappedTypeCode;
+const tslib_1 = require("tslib");
+const node_path_1 = tslib_1.__importDefault(require("node:path"));
+const common_1 = require("@opra/common");
+const code_block_js_1 = require("../../code-block.js");
+const string_utils_js_1 = require("../utils/string-utils.js");
+const internalTypeNames = ['any', 'boolean', 'bigint', 'number', 'null', 'string', 'object'];
+async function generateDataType(dataType, intent, currentFile) {
+    const doc = dataType.node.getDocument();
+    if (doc.id !== this._document?.id) {
+        const { generator } = await this.generateDocument(doc);
+        return await generator.generateDataType(dataType, intent, currentFile);
+    }
+    const typeName = dataType.name;
+    if (typeName) {
+        if (internalTypeNames.includes(typeName))
+            return { kind: 'internal', typeName: dataType.name };
+        let file = this._filesMap.get(dataType);
+        if (file) {
+            if (currentFile)
+                currentFile.addImport(file.filename, [typeName]);
+            return { kind: 'named', file, typeName: dataType.name };
+        }
+        if (dataType instanceof common_1.SimpleType)
+            file = this.addFile(node_path_1.default.join(this._documentRoot, '/simple-types.ts'), true);
+        else if (dataType instanceof common_1.EnumType) {
+            file = this.addFile(node_path_1.default.join(this._typesRoot, 'enums', typeName + '.ts'), true);
+        }
+        else
+            file = this.addFile(node_path_1.default.join(this._typesRoot, 'types', typeName + '.ts'), true);
+        this._filesMap.set(dataType, file);
+        if (file.exportTypes.includes(typeName)) {
+            if (currentFile)
+                currentFile.addImport(file.filename, [typeName]);
+            return { kind: 'named', file, typeName: dataType.name };
+        }
+        file.exportTypes.push(typeName);
+        const typesIndexTs = this.addFile(node_path_1.default.join(this._typesRoot, 'index.ts'), true);
+        const indexTs = this.addFile('/index.ts', true);
+        indexTs.addExport(typesIndexTs.filename, undefined, this._typesNamespace);
+        const codeBlock = (file.code['type_' + typeName] = new code_block_js_1.CodeBlock());
+        codeBlock.head = `/**\n * ${(0, string_utils_js_1.wrapJSDocString)(dataType.description || '')}\n *`;
+        codeBlock.head += `
+ * @url ${node_path_1.default.posix.join(doc.url || this.serviceUrl, '$schema', '#types/' + typeName)}
+ */
+export `;
+        codeBlock.typeDef = (await this._generateTypeCode(file, dataType, 'root')) + '\n\n';
+        typesIndexTs.addExport(file.filename);
+        if (currentFile)
+            currentFile.addImport(file.filename, [typeName]);
+        return { kind: 'named', file, typeName };
+    }
+    if (!currentFile)
+        throw new TypeError(`You must provide currentFile to generate data type`);
+    const code = await this._generateTypeCode(currentFile, dataType, intent);
+    return { kind: 'embedded', code };
+}
+/**
+ *
+ */
+async function _generateTypeCode(currentFile, dataType, intent) {
+    if (intent === 'root' && !dataType.name) {
+        throw new TypeError(`Name required to generate data type code to root intent`);
+    }
+    if (dataType instanceof common_1.EnumType) {
+        return await this._generateEnumTypeCode(currentFile, dataType, intent);
+    }
+    if (dataType instanceof common_1.ComplexType) {
+        return await this._generateComplexTypeCode(currentFile, dataType, intent);
+    }
+    if (dataType instanceof common_1.SimpleType) {
+        return await this._generateSimpleTypeCode(currentFile, dataType, intent);
+    }
+    if (dataType instanceof common_1.MappedType) {
+        return await this._generateMappedTypeCode(currentFile, dataType, intent);
+    }
+    if (dataType instanceof common_1.MixinType) {
+        return await this._generateMixinTypeCode(currentFile, dataType, intent);
+    }
+    /* istanbul ignore next */
+    throw new TypeError(`${dataType.kind} data types can not be directly exported`);
+}
+/**
+ *
+ */
+async function _generateEnumTypeCode(currentFile, dataType, intent) {
+    if (intent === 'root') {
+        let out = `enum ${dataType.name} {\n\t`;
+        for (const [value, info] of Object.entries(dataType.attributes)) {
+            // Print JSDoc
+            let jsDoc = '';
+            if (dataType.attributes[value].description)
+                jsDoc += ` * ${dataType.attributes[value].description}\n`;
+            if (jsDoc)
+                out += `/**\n${jsDoc} */\n`;
+            out +=
+                `${info.alias || value} = ` +
+                    (typeof value === 'number' ? value : "'" + String(value).replace("'", "\\'") + "'");
+            out += ',\n\n';
+        }
+        return out + '\b}';
+    }
+    return ('(' +
+        Object.keys(dataType.attributes)
+            .map(t => `'${t}'`)
+            .join(' | ') +
+        ')');
+}
+/**
+ *
+ */
+async function _generateComplexTypeCode(currentFile, dataType, intent) {
+    let out = intent === 'root' ? `interface ${dataType.name} ` : '';
+    const ownFields = [...dataType.fields.values()].filter(f => f.origin === dataType);
+    if (dataType.base) {
+        const base = await this.generateDataType(dataType.base, 'extends', currentFile);
+        let baseDef = base.kind === 'embedded' ? base.code : base.typeName;
+        const omitBaseFields = ownFields.filter(f => dataType.base.fields.has(f.name));
+        if (omitBaseFields.length)
+            baseDef = `Omit<${baseDef}, ${omitBaseFields.map(x => "'" + x.name + "'").join(' | ')}>`;
+        if (intent === 'root')
+            out += `extends ${baseDef} `;
+        else {
+            out += baseDef;
+            if (!ownFields.length)
+                return out;
+            out += ' & ';
+        }
+    }
+    out += '{\n\t';
+    let i = 0;
+    for (const field of ownFields) {
+        if (i++)
+            out += '\n';
+        // Print JSDoc
+        out += `/**\n * ${field.description || ''}\n`;
+        if (field.default)
+            out += ` * @default ` + field.default + '\n';
+        // if (field.format)
+        //   jsDoc += ` * @format ` + field.format + '\n';
+        if (field.exclusive)
+            out += ` * @exclusive\n`;
+        if (field.readonly)
+            out += ` * @readonly\n`;
+        if (field.writeonly)
+            out += ` * @writeonly\n`;
+        if (field.deprecated) {
+            out += ` * @deprecated ` + (typeof field.deprecated === 'string' ? field.deprecated : '') + '\n';
+        }
+        out += ' */\n';
+        // Print field name
+        if (field.readonly)
+            out += 'readonly ';
+        out += `${field.name}${field.required ? '' : '?'}: `;
+        if (field.fixed) {
+            const t = typeof field.fixed;
+            out += `${t === 'number' || t === 'boolean' || t === 'bigint' ? field.fixed : "'" + field.fixed + "'"}\n`;
+        }
+        else {
+            const x = await this.generateDataType(field.type, 'typeDef', currentFile);
+            out += (x.kind === 'embedded' ? x.code : x.typeName) + `${field.isArray ? '[]' : ''};\n`;
+        }
+    }
+    if (dataType.additionalFields)
+        out += '[key: string]: any;\n';
+    return out + '\b}';
+}
+/**
+ *
+ */
+async function _generateSimpleTypeCode(currentFile, dataType, intent) {
+    let out = intent === 'root' ? `type ${dataType.name} = ` : '';
+    out += dataType.nameMappings.js || 'any';
+    return intent === 'root' ? out + ';' : out;
+}
+/**
+ *
+ */
+async function _generateMixinTypeCode(currentFile, dataType, intent) {
+    const outArray = [];
+    for (const t of dataType.types) {
+        const x = await this.generateDataType(t, 'typeDef', currentFile);
+        if (x.kind === 'embedded') {
+            outArray.push(x.code.includes('|') ? '(' + x.code + ')' : x.code);
+        }
+        else
+            outArray.push(x.typeName);
+    }
+    if (intent === 'root')
+        return `type ${dataType.name} = ${outArray.join(' & ')}`;
+    if (intent === 'extends')
+        return outArray.join(', ');
+    return outArray.join(' & ');
+}
+/**
+ *
+ */
+async function _generateMappedTypeCode(currentFile, dataType, intent) {
+    let out = intent === 'root' ? `type ${dataType.name} = ` : '';
+    const base = await this.generateDataType(dataType.base, 'typeDef', currentFile);
+    const typeDef = base.kind === 'embedded' ? base.code : base.typeName;
+    const pick = dataType.pick?.length ? dataType.pick : undefined;
+    const omit = !pick && dataType.omit?.length ? dataType.omit : undefined;
+    const partial = dataType.partial === true || (Array.isArray(dataType.partial) && dataType.partial.length > 0)
+        ? dataType.partial
+        : undefined;
+    const required = dataType.required === true || (Array.isArray(dataType.required) && dataType.required.length > 0)
+        ? dataType.required
+        : undefined;
+    if (!(pick || omit || partial || required))
+        return typeDef;
+    if (partial === true)
+        out += 'Partial<';
+    else if (partial) {
+        out += 'PartialSome<';
+        currentFile.addExport('ts-gems', ['PartialSome']);
+    }
+    if (required === true)
+        out += 'Partial<';
+    else if (required) {
+        out += 'RequiredSome<';
+        currentFile.addExport('ts-gems', ['RequiredSome']);
+    }
+    if (pick)
+        out += 'Pick<';
+    else if (omit)
+        out += 'Omit<';
+    out += typeDef;
+    if (omit || pick) {
+        out +=
+            ', ' +
+                (omit || pick)
+                    .filter(x => !!x)
+                    .map(x => `'${x}'`)
+                    .join(' | ') +
+                '>';
+    }
+    if (partial) {
+        if (Array.isArray(partial)) {
+            out +=
+                ', ' +
+                    partial
+                        .filter(x => !!x)
+                        .map(x => `'${x}'`)
+                        .join(' | ');
+        }
+        out += '>';
+    }
+    return out;
+}

package/cjs/ts-generator/generators/generate-document.js

@@ -0,0 +1,64 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.generateDocument = generateDocument;
+const tslib_1 = require("tslib");
+const node_path_1 = tslib_1.__importDefault(require("node:path"));
+const client_1 = require("@opra/client");
+const common_1 = require("@opra/common");
+const ansi_colors_1 = tslib_1.__importDefault(require("ansi-colors"));
+const putil_varhelpers_1 = require("putil-varhelpers");
+async function generateDocument(document, options) {
+    if (!document || typeof document === 'string') {
+        if (document) {
+            const out = this._documentsMap.get(document);
+            if (out)
+                return out;
+        }
+        this.emit('log', ansi_colors_1.default.cyan('Fetching document schema from ') + ansi_colors_1.default.blueBright(this.serviceUrl));
+        const client = new client_1.OpraHttpClient(this.serviceUrl);
+        document = await client.fetchDocument({ documentId: document });
+    }
+    this._document = document;
+    let out = this._documentsMap.get(document.id);
+    if (out)
+        return out;
+    out = {
+        document,
+        generator: this,
+    };
+    this._documentsMap.set(document.id, out);
+    this.emit('log', ansi_colors_1.default.white('[' + document.id + '] ') +
+        ansi_colors_1.default.cyan('Processing document ') +
+        ansi_colors_1.default.magenta(document.info.title || ''));
+    if (document.references.size) {
+        let refIdGenerator = options?.refIdGenerator || 1;
+        this.emit('log', ansi_colors_1.default.white('[' + document.id + '] ') + ansi_colors_1.default.cyan(`Processing references`));
+        for (const ref of document.references.values()) {
+            const generator = this.extend();
+            generator._document = ref;
+            const typesNamespace = ref.api?.name || (ref.info.title ? (0, putil_varhelpers_1.pascalCase)(ref.info.title) : `Reference${refIdGenerator++}`);
+            generator._documentRoot = '/references/' + typesNamespace;
+            generator._typesRoot = node_path_1.default.join(generator._documentRoot, 'models');
+            generator._typesNamespace = !this.options.referenceNamespaces || ref[common_1.BUILTIN] ? '' : typesNamespace;
+            await generator.generateDocument(ref, { typesOnly: true, refIdGenerator });
+        }
+    }
+    this._fileHeaderDocInfo = `/*
+ * ${document.info.title}
+ * Id: ${document.id}
+ * Version: ${document.info.version}
+ * ${this.serviceUrl}
+ */`;
+    if (document.types.size) {
+        this.emit('log', ansi_colors_1.default.white('[' + document.id + ']'), ansi_colors_1.default.cyan(`Processing data types`));
+        for (const t of document.types.values()) {
+            await this.generateDataType(t, 'root');
+        }
+    }
+    if (options?.typesOnly)
+        return out;
+    if (document.api instanceof common_1.HttpApi) {
+        await this.generateHttpApi(document.api);
+    }
+    return out;
+}

package/cjs/ts-generator/{processors/process-http-api.js → generators/generate-http-api.js}

@@ -1,13 +1,13 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.processHttpApi = void 0;
+exports.generateHttpApi = generateHttpApi;
 const tslib_1 = require("tslib");
 const node_path_1 = tslib_1.__importDefault(require("node:path"));
 const putil_varhelpers_1 = require("putil-varhelpers");
 const code_block_js_1 = require("../../code-block.js");
 const http_controller_node_js_1 = require("../http-controller-node.js");
 const string_utils_js_1 = require("../utils/string-utils.js");
-async function processHttpApi(api) {
+async function generateHttpApi(api) {
     let file = this._filesMap.get(api);
     if (file)
         return file;
@@ -32,7 +32,7 @@ async function processHttpApi(api) {
     classConstBlock.tail = `\b\n}\n`;
     for (const controller of api.controllers.values()) {
         const generator = this.extend();
-        const f = await generator.processHttpController(controller);
+        const f = await generator.generateHttpController(controller);
         const childClassName = (0, putil_varhelpers_1.pascalCase)(controller.name) + 'Controller';
         file.addImport('.' + f.filename, [childClassName]);
         const property = '$' + controller.name.charAt(0).toLowerCase() + (0, putil_varhelpers_1.camelCase)(controller.name.substring(1));
@@ -42,4 +42,3 @@ async function processHttpApi(api) {
     classBlock.tail = `\b}`;
     return file;
 }
-exports.processHttpApi = processHttpApi;