@opra/cli 0.14.2 → 0.15.0

package/cjs/oprimp/process-types.js

@@ -1,130 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.processTypes = void 0;
-const tslib_1 = require("tslib");
-const chalk_1 = tslib_1.__importDefault(require("chalk"));
-const fs_1 = tslib_1.__importDefault(require("fs"));
-const path_1 = tslib_1.__importDefault(require("path"));
-const common_1 = require("@opra/common");
-const string_utils_js_1 = require("../utils/string-utils.js");
-const ts_file_js_1 = require("../utils/ts-file.js");
-const builtinsMap = {
-    base64Binary: 'Buffer',
-    dateString: 'string',
-    guid: 'string',
-    integer: 'number',
-    date: 'Date'
-};
-async function processTypes(ctx) {
-    const targetDir = path_1.default.join(ctx.absoluteDir, 'types');
-    ctx.logger.log(chalk_1.default.yellow('Processing types'));
-    const typesTs = new ts_file_js_1.TsFile();
-    typesTs.header = ctx.fileHeader;
-    let i = 0;
-    const builtinsTs = new ts_file_js_1.TsFile();
-    typesTs.header = ctx.fileHeader;
-    fs_1.default.mkdirSync(targetDir, { recursive: true });
-    const typeNames = Array.from(ctx.document.types.keys()).sort();
-    for (const typeName of typeNames) {
-        const dataType = ctx.document.getDataType(typeName);
-        if (dataType.isBuiltin) {
-            if (!builtinsMap[dataType.name])
-                continue;
-            typesTs.addExport('./types/builtins' + ctx.extension);
-            builtinsTs.content += `export type ${dataType.name} = ${builtinsMap[dataType.name]};\n`;
-            continue;
-        }
-        const tsFile = new ts_file_js_1.TsFile();
-        tsFile.header = ctx.fileHeader;
-        tsFile.content = `\n/**\n * ${(0, string_utils_js_1.wrapJSDocString)(dataType.description || dataType.name)}
- * @type ${dataType.name}
- * @kind ${dataType.kind}
- * @url ${(0, common_1.joinPath)(ctx.serviceUrl, '$metadata/types/' + dataType.name)}
- */\n`;
-        const filename = `./types/${dataType.name}`;
-        if (dataType instanceof common_1.ComplexType) {
-            await generateComplexType(ctx, dataType, tsFile);
-            await tsFile.writeFile(ctx, path_1.default.join(targetDir, dataType.name + '.ts'));
-            typesTs.addExport(`${filename}` + ctx.extension);
-            i++;
-        }
-    }
-    await builtinsTs.writeFile(ctx, path_1.default.join(targetDir, 'builtins.ts'));
-    if (i) {
-        await typesTs.writeFile(ctx, path_1.default.join(ctx.absoluteDir, 'types.ts'));
-    }
-}
-exports.processTypes = processTypes;
-async function generateComplexType(ctx, dataType, tsFile) {
-    tsFile.header = ctx.fileHeader;
-    tsFile.content = `
-export class ${dataType.name} {
-  constructor(init?: Partial<I${dataType.name}>) {
-    if (init)
-     Object.assign(this, init);
-  }
-}
-
-export interface ${dataType.name} extends I${dataType.name} {
-}
-
-interface I${dataType.name}`;
-    if (dataType.extends) {
-        tsFile.content += ' extends ' +
-            dataType.extends.map(ex => {
-                tsFile.addImport('./' + ex.type + ctx.extension, ex.type);
-                let s = '';
-                if (ex.omit)
-                    s += 'Omit<';
-                if (ex.pick)
-                    s += 'Pick<';
-                s += ex.type;
-                if (ex.pick)
-                    s += ex.pick.map(x => `'${x}`).join(' | ') + '>';
-                if (ex.omit)
-                    s += ex.omit.map(x => `'${x}`).join(' | ') + '>';
-                return s;
-            }).join(', ');
-    }
-    const getTypeName = (dt) => {
-        if (dt.isBuiltin) {
-            if (!builtinsMap[dt.name])
-                return dt.name;
-            tsFile.addImport('./builtins' + ctx.extension, dt.name);
-            return dt.name;
-        }
-        tsFile.addImport('./' + dt.name + ctx.extension, dt.name);
-        return dt.name;
-    };
-    tsFile.content += ' {\n\t';
-    for (const f of dataType.ownFields.values()) {
-        const fieldType = ctx.document.getDataType(f.type);
-        // Print JSDoc
-        tsFile.content += `/**\n * ${f.description || f.name}\n`;
-        if (f.default)
-            tsFile.content += ` * @default ` + f.default + '\n';
-        if (f.format)
-            tsFile.content += ` * @format ` + f.format + '\n';
-        if (f.exclusive)
-            tsFile.content += ` * @exclusive\n`;
-        if (f.deprecated)
-            tsFile.content += ` * @deprecated ` + (typeof f.deprecated === 'string' ? f.deprecated : '') + '\n';
-        tsFile.content += ` */\n`;
-        // Print field name
-        tsFile.content += `${f.name}${f.required ? '' : '?'}: `;
-        if (f.fixed)
-            tsFile.content += `${f.fixed}`;
-        else {
-            if (fieldType instanceof common_1.UnionType) {
-                const s = fieldType.types.map(t => getTypeName(t)).join(' | ');
-                tsFile.content += `(${s})`;
-            }
-            else
-                tsFile.content += `${getTypeName(fieldType)}`;
-            tsFile.content += `${f.isArray ? '[]' : ''};\n\n`;
-        }
-    }
-    if (dataType.additionalFields)
-        tsFile.content += '[key: string]: any;\n';
-    tsFile.content += '\b\b}\n';
-}

package/cjs/utils/ts-file.js

@@ -1,55 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.TsFile = void 0;
-const tslib_1 = require("tslib");
-const chalk_1 = tslib_1.__importDefault(require("chalk"));
-const path_1 = tslib_1.__importDefault(require("path"));
-const putil_flattentext_1 = tslib_1.__importDefault(require("putil-flattentext"));
-class TsFile {
-    constructor() {
-        this.imports = {};
-        this.exports = {};
-        this.header = '';
-        this.content = '';
-        this.addImport = (filename, ...imported) => {
-            this.imports[filename] = this.imports[filename] || [];
-            imported.forEach(x => {
-                if (!this.imports[filename].includes(x))
-                    this.imports[filename].push(x);
-            });
-        };
-        this.addExport = (filename, ...exported) => {
-            this.exports[filename] = this.exports[filename] || [];
-            exported.forEach(x => {
-                if (!this.exports[filename].includes(x))
-                    this.exports[filename].push(x);
-            });
-        };
-    }
-    generate() {
-        let output = '/* #!oprimp_auto_generated!# !! Do NOT remove this line */\n' +
-            (this.header ? (0, putil_flattentext_1.default)(this.header) + '\n\n' : '\n');
-        const importStr = Object.keys(this.imports)
-            .sort((a, b) => a.toLowerCase().localeCompare(b.toLowerCase()))
-            .map(i => `import { ${this.imports[i].join(', ')} } from '${i}';`)
-            .join('\n');
-        if (importStr)
-            output += (0, putil_flattentext_1.default)(importStr) + '\n';
-        output += (0, putil_flattentext_1.default)(this.content);
-        const exportStr = Object.keys(this.exports)
-            .sort((a, b) => a.toLowerCase().localeCompare(b.toLowerCase()))
-            .map(i => {
-            const a = this.exports[i];
-            return `export ${a.length ? '{' + a.join(', ') + '}' : '*'} from '${i}';`;
-        })
-            .join('\n');
-        if (exportStr)
-            output += (0, putil_flattentext_1.default)(exportStr) + '\n';
-        return output;
-    }
-    async writeFile(ctx, filename) {
-        await ctx.writer.writeFile(filename, this.generate());
-        ctx.logger.log(' - Written', chalk_1.default.whiteBright('./' + path_1.default.relative(ctx.absoluteDir, filename)));
-    }
-}
-exports.TsFile = TsFile;

package/esm/oprimp/delete-files.d.ts

@@ -1 +0,0 @@
-export declare function deleteFiles(dirname: string): void;

package/esm/oprimp/delete-files.js

@@ -1,22 +0,0 @@
-import fs from 'fs';
-import path from 'path';
-export function deleteFiles(dirname) {
-    if (!fs.existsSync(dirname))
-        return;
-    const files = fs.readdirSync(dirname);
-    for (const f of files) {
-        const filename = path.join(dirname, f);
-        if (fs.statSync(filename).isDirectory()) {
-            deleteFiles(filename);
-            if (!fs.readdirSync(filename).length)
-                fs.rmdirSync(filename);
-            continue;
-        }
-        if (path.extname(f) === '.ts') {
-            const contents = fs.readFileSync(filename, 'utf-8');
-            if (contents.includes('#!oprimp_auto_generated!#')) {
-                fs.unlinkSync(filename);
-            }
-        }
-    }
-}

package/esm/oprimp/generate-service.d.ts

@@ -1,13 +0,0 @@
-import { IFileWriter } from '../interfaces/file-writer.interface.js';
-import { ILogger } from '../interfaces/logger.interface.js';
-export interface ServiceGenerateConfig {
-    serviceUrl: string;
-    outDir: string;
-    name?: string;
-    cwd?: string;
-    logger?: ILogger;
-    writer?: IFileWriter;
-    fileHeader?: string;
-    extension?: string;
-}
-export declare function generateService(config: ServiceGenerateConfig): Promise<void>;

package/esm/oprimp/generate-service.js

@@ -1,49 +0,0 @@
-import chalk from 'chalk';
-import console from 'console';
-import * as fs from 'fs';
-import path from 'path';
-import * as process from 'process';
-import { OpraHttpClient } from '@opra/node-client';
-import { TsFile } from '../utils/ts-file.js';
-import { deleteFiles } from './delete-files.js';
-import { FileWriter } from './file-writer.js';
-import { processResources } from './process-resoruces.js';
-import { processTypes } from './process-types.js';
-export async function generateService(config) {
-    const cwd = config.cwd || process.cwd();
-    const logger = config.logger || console;
-    try {
-        console.log(chalk.yellow('Fetching service metadata from'), chalk.whiteBright(config.serviceUrl));
-        const client = await OpraHttpClient.create(config.serviceUrl);
-        const metadata = client.metadata;
-        console.log(chalk.yellow('Retrieved service info:'), chalk.whiteBright(metadata.info.title), '-', chalk.whiteBright(metadata.info.version));
-        console.log(chalk.yellow('Removing old files..'));
-        deleteFiles(config.outDir);
-        let name = (metadata.info.title || 'Service1').replace(/[^\w_$]*/g, '');
-        name = name.charAt(0).toUpperCase() + name.substring(1);
-        const ctx = {
-            serviceUrl: config.serviceUrl,
-            document: client.metadata,
-            name,
-            logger,
-            cwd,
-            relativeDir: config.outDir,
-            absoluteDir: path.resolve(cwd, config.outDir),
-            fileHeader: config.fileHeader || '',
-            extension: config.extension,
-            writer: config.writer || new FileWriter()
-        };
-        fs.mkdirSync(ctx.absoluteDir, { recursive: true });
-        await processTypes(ctx);
-        await processResources(ctx);
-        const indexTs = new TsFile();
-        indexTs.header = ctx.fileHeader;
-        indexTs.addExport('./' + ctx.name + ctx.extension);
-        indexTs.addExport('./types' + ctx.extension);
-        await indexTs.writeFile(ctx, path.join(ctx.absoluteDir, 'index.ts'));
-    }
-    catch (error) {
-        logger.error(chalk.red(error.message));
-        process.exit(1);
-    }
-}

package/esm/oprimp/index.d.ts

@@ -1 +0,0 @@
-export * from './generate-service.js';

package/esm/oprimp/index.js

@@ -1 +0,0 @@
-export * from './generate-service.js';

package/esm/oprimp/process-resoruces.d.ts

@@ -1,2 +0,0 @@
-import { ServiceGenerationContext } from '../interfaces/service-generation-context.interface.js';
-export declare function processResources(ctx: ServiceGenerationContext): Promise<void>;

package/esm/oprimp/process-resoruces.js

@@ -1,54 +0,0 @@
-import chalk from 'chalk';
-import path from 'path';
-import { CollectionResourceInfo, joinPath, SingletonResourceInfo } from '@opra/common';
-import { wrapJSDocString } from '../utils/string-utils.js';
-import { TsFile } from '../utils/ts-file.js';
-export async function processResources(ctx) {
-    const targetDir = ctx.absoluteDir;
-    ctx.logger.log(chalk.yellow('Processing resources'));
-    const serviceTs = new TsFile();
-    serviceTs.header = ctx.fileHeader;
-    serviceTs.addImport('@opra/client', 'OpraHttpClient');
-    serviceTs.content = `
-const kClient = Symbol('client');
-  
-export class ${ctx.name} {
-  static kClient = kClient;
-  [kClient]: OpraHttpClient;
-  
-  constructor(client: OpraHttpClient) {
-    this[kClient] = client;
-  }
-  `;
-    const resourceNames = Array.from(ctx.document.resources.keys()).sort();
-    for (const resourceName of resourceNames) {
-        const resource = ctx.document.getResource(resourceName);
-        serviceTs.content += `\n/**\n * ${wrapJSDocString(resource.description || resource.name)}
- * @url ${joinPath(ctx.serviceUrl, '$metadata/resources/' + resource.name)}
- */`;
-        if (resource instanceof CollectionResourceInfo) {
-            serviceTs.addImport('@opra/client', 'HttpCollectionService');
-            serviceTs.addImport('./types/' + resource.dataType.name + ctx.extension, resource.dataType.name);
-            const methods = resource.getHandlerNames()
-                .filter(x => x !== 'count')
-                .map(x => `'${x}'`).join(' | ');
-            serviceTs.content += `
-  get ${resource.name}(): Pick<HttpCollectionService<${resource.dataType.name}, never>, ${methods}> {
-    return this[kClient].collection('${resource.name}');
-  }\n`;
-        }
-        else if (resource instanceof SingletonResourceInfo) {
-            serviceTs.addImport('@opra/client', 'HttpSingletonService');
-            serviceTs.addImport('./types/' + resource.dataType.name + ctx.extension, resource.dataType.name);
-            const methods = resource.getHandlerNames()
-                .map(x => `'${x}'`).join(' | ');
-            serviceTs.content += `
-  get ${resource.name}(): Pick<HttpSingletonService<${resource.dataType.name}, never>, ${methods}> {
-    return this[kClient].singleton('${resource.name}');
-  }\n`;
-        }
-    }
-    serviceTs.content += `
-}\n`;
-    await serviceTs.writeFile(ctx, path.join(targetDir, ctx.name + '.ts'));
-}

package/esm/oprimp/process-types.d.ts

@@ -1,2 +0,0 @@
-import { ServiceGenerationContext } from '../interfaces/service-generation-context.interface.js';
-export declare function processTypes(ctx: ServiceGenerationContext): Promise<void>;

package/esm/oprimp/process-types.js

@@ -1,125 +0,0 @@
-import chalk from 'chalk';
-import fs from 'fs';
-import path from 'path';
-import { ComplexType, joinPath, UnionType } from '@opra/common';
-import { wrapJSDocString } from '../utils/string-utils.js';
-import { TsFile } from '../utils/ts-file.js';
-const builtinsMap = {
-    base64Binary: 'Buffer',
-    dateString: 'string',
-    guid: 'string',
-    integer: 'number',
-    date: 'Date'
-};
-export async function processTypes(ctx) {
-    const targetDir = path.join(ctx.absoluteDir, 'types');
-    ctx.logger.log(chalk.yellow('Processing types'));
-    const typesTs = new TsFile();
-    typesTs.header = ctx.fileHeader;
-    let i = 0;
-    const builtinsTs = new TsFile();
-    typesTs.header = ctx.fileHeader;
-    fs.mkdirSync(targetDir, { recursive: true });
-    const typeNames = Array.from(ctx.document.types.keys()).sort();
-    for (const typeName of typeNames) {
-        const dataType = ctx.document.getDataType(typeName);
-        if (dataType.isBuiltin) {
-            if (!builtinsMap[dataType.name])
-                continue;
-            typesTs.addExport('./types/builtins' + ctx.extension);
-            builtinsTs.content += `export type ${dataType.name} = ${builtinsMap[dataType.name]};\n`;
-            continue;
-        }
-        const tsFile = new TsFile();
-        tsFile.header = ctx.fileHeader;
-        tsFile.content = `\n/**\n * ${wrapJSDocString(dataType.description || dataType.name)}
- * @type ${dataType.name}
- * @kind ${dataType.kind}
- * @url ${joinPath(ctx.serviceUrl, '$metadata/types/' + dataType.name)}
- */\n`;
-        const filename = `./types/${dataType.name}`;
-        if (dataType instanceof ComplexType) {
-            await generateComplexType(ctx, dataType, tsFile);
-            await tsFile.writeFile(ctx, path.join(targetDir, dataType.name + '.ts'));
-            typesTs.addExport(`${filename}` + ctx.extension);
-            i++;
-        }
-    }
-    await builtinsTs.writeFile(ctx, path.join(targetDir, 'builtins.ts'));
-    if (i) {
-        await typesTs.writeFile(ctx, path.join(ctx.absoluteDir, 'types.ts'));
-    }
-}
-async function generateComplexType(ctx, dataType, tsFile) {
-    tsFile.header = ctx.fileHeader;
-    tsFile.content = `
-export class ${dataType.name} {
-  constructor(init?: Partial<I${dataType.name}>) {
-    if (init)
-     Object.assign(this, init);
-  }
-}
-
-export interface ${dataType.name} extends I${dataType.name} {
-}
-
-interface I${dataType.name}`;
-    if (dataType.extends) {
-        tsFile.content += ' extends ' +
-            dataType.extends.map(ex => {
-                tsFile.addImport('./' + ex.type + ctx.extension, ex.type);
-                let s = '';
-                if (ex.omit)
-                    s += 'Omit<';
-                if (ex.pick)
-                    s += 'Pick<';
-                s += ex.type;
-                if (ex.pick)
-                    s += ex.pick.map(x => `'${x}`).join(' | ') + '>';
-                if (ex.omit)
-                    s += ex.omit.map(x => `'${x}`).join(' | ') + '>';
-                return s;
-            }).join(', ');
-    }
-    const getTypeName = (dt) => {
-        if (dt.isBuiltin) {
-            if (!builtinsMap[dt.name])
-                return dt.name;
-            tsFile.addImport('./builtins' + ctx.extension, dt.name);
-            return dt.name;
-        }
-        tsFile.addImport('./' + dt.name + ctx.extension, dt.name);
-        return dt.name;
-    };
-    tsFile.content += ' {\n\t';
-    for (const f of dataType.ownFields.values()) {
-        const fieldType = ctx.document.getDataType(f.type);
-        // Print JSDoc
-        tsFile.content += `/**\n * ${f.description || f.name}\n`;
-        if (f.default)
-            tsFile.content += ` * @default ` + f.default + '\n';
-        if (f.format)
-            tsFile.content += ` * @format ` + f.format + '\n';
-        if (f.exclusive)
-            tsFile.content += ` * @exclusive\n`;
-        if (f.deprecated)
-            tsFile.content += ` * @deprecated ` + (typeof f.deprecated === 'string' ? f.deprecated : '') + '\n';
-        tsFile.content += ` */\n`;
-        // Print field name
-        tsFile.content += `${f.name}${f.required ? '' : '?'}: `;
-        if (f.fixed)
-            tsFile.content += `${f.fixed}`;
-        else {
-            if (fieldType instanceof UnionType) {
-                const s = fieldType.types.map(t => getTypeName(t)).join(' | ');
-                tsFile.content += `(${s})`;
-            }
-            else
-                tsFile.content += `${getTypeName(fieldType)}`;
-            tsFile.content += `${f.isArray ? '[]' : ''};\n\n`;
-        }
-    }
-    if (dataType.additionalFields)
-        tsFile.content += '[key: string]: any;\n';
-    tsFile.content += '\b\b}\n';
-}

package/esm/utils/ts-file.d.ts

@@ -1,11 +0,0 @@
-import type { ServiceGenerationContext } from '../interfaces/service-generation-context.interface.js';
-export declare class TsFile {
-    imports: Record<string, string[]>;
-    exports: Record<string, string[]>;
-    header: string;
-    content: string;
-    addImport: (filename: string, ...imported: string[]) => void;
-    addExport: (filename: string, ...exported: string[]) => void;
-    generate(): string;
-    writeFile(ctx: ServiceGenerationContext, filename: string): Promise<void>;
-}

package/esm/utils/ts-file.js

@@ -1,50 +0,0 @@
-import chalk from 'chalk';
-import path from 'path';
-import flattenText from 'putil-flattentext';
-export class TsFile {
-    constructor() {
-        this.imports = {};
-        this.exports = {};
-        this.header = '';
-        this.content = '';
-        this.addImport = (filename, ...imported) => {
-            this.imports[filename] = this.imports[filename] || [];
-            imported.forEach(x => {
-                if (!this.imports[filename].includes(x))
-                    this.imports[filename].push(x);
-            });
-        };
-        this.addExport = (filename, ...exported) => {
-            this.exports[filename] = this.exports[filename] || [];
-            exported.forEach(x => {
-                if (!this.exports[filename].includes(x))
-                    this.exports[filename].push(x);
-            });
-        };
-    }
-    generate() {
-        let output = '/* #!oprimp_auto_generated!# !! Do NOT remove this line */\n' +
-            (this.header ? flattenText(this.header) + '\n\n' : '\n');
-        const importStr = Object.keys(this.imports)
-            .sort((a, b) => a.toLowerCase().localeCompare(b.toLowerCase()))
-            .map(i => `import { ${this.imports[i].join(', ')} } from '${i}';`)
-            .join('\n');
-        if (importStr)
-            output += flattenText(importStr) + '\n';
-        output += flattenText(this.content);
-        const exportStr = Object.keys(this.exports)
-            .sort((a, b) => a.toLowerCase().localeCompare(b.toLowerCase()))
-            .map(i => {
-            const a = this.exports[i];
-            return `export ${a.length ? '{' + a.join(', ') + '}' : '*'} from '${i}';`;
-        })
-            .join('\n');
-        if (exportStr)
-            output += flattenText(exportStr) + '\n';
-        return output;
-    }
-    async writeFile(ctx, filename) {
-        await ctx.writer.writeFile(filename, this.generate());
-        ctx.logger.log(' - Written', chalk.whiteBright('./' + path.relative(ctx.absoluteDir, filename)));
-    }
-}