@opra/cli 0.33.11 → 1.0.0-alpha.7

package/esm/api-exporter/process-types.js

@@ -1,249 +0,0 @@
-import path from 'node:path';
-import { ComplexType, EnumType, MappedType, MixinType, SimpleType } from '@opra/common';
-import { wrapJSDocString } from '../utils/string-utils.js';
-const internalTypeNames = ['any', 'boolean', 'bigint', 'number', 'null', 'string', 'object'];
-/**
- *
- */
-export async function processTypes() {
-    const { document } = this;
-    for (const dataType of document.types.values()) {
-        await this.generateTypeFile(dataType);
-    }
-}
-/**
- *
- * @param dataType
- */
-export async function generateTypeFile(dataType) {
-    const typeName = dataType.name;
-    if (typeName === 'any')
-        return;
-    if (!typeName)
-        throw new TypeError(`DataType has no name`);
-    const typesTs = this.addFile('/types.ts', true);
-    let filePath = '';
-    if (dataType instanceof SimpleType)
-        filePath = '/simple-types.ts';
-    else {
-        if (dataType instanceof EnumType)
-            filePath = path.join('/enums', typeName + '.ts');
-        else
-            filePath = path.join('/types', typeName + '.ts');
-    }
-    const file = this.addFile(filePath, true);
-    if (file.exportTypes.includes(typeName))
-        return file;
-    file.exportTypes.push(typeName);
-    const indexTs = this.addFile('/index.ts', true);
-    indexTs.addExport(file.filename);
-    file.content += `
-/**
- * ${typeName}`;
-    if (dataType.description)
-        file.content += `
- * ${wrapJSDocString(dataType.description || '')}`;
-    file.content += `
- * @url ${path.posix.join(this.client.serviceUrl, '#types/' + typeName)}
- */
-export `;
-    if (dataType instanceof EnumType)
-        file.content += await this.generateEnumTypeDefinition({ file, dataType, intent: 'scope' });
-    else if (dataType instanceof ComplexType)
-        file.content += await this.generateComplexTypeDefinition({ file, dataType, intent: 'scope' });
-    else if (dataType instanceof SimpleType)
-        file.content += await this.generateSimpleTypeDefinition({ file, dataType, intent: 'scope' });
-    else
-        throw new TypeError(`${dataType.kind} data type (${typeName}) can not be directly exported`);
-    file.content += '\n';
-    typesTs.addExport(file.filename);
-    return file;
-}
-/**
- *
- */
-export async function resolveTypeNameOrDef(args) {
-    const { dataType } = args;
-    if (dataType.name && !dataType.isEmbedded) {
-        if (internalTypeNames.includes(dataType.name))
-            return dataType.name;
-        const f = await this.generateTypeFile(dataType);
-        if (!f)
-            return '';
-        args.file.addImport(f.filename, [dataType.name], true);
-        return dataType.name;
-    }
-    if (dataType instanceof SimpleType)
-        return this.generateSimpleTypeDefinition({ ...args, dataType });
-    if (dataType instanceof EnumType)
-        return this.generateEnumTypeDefinition({ ...args, dataType });
-    if (dataType instanceof MixinType)
-        return this.generateMixinTypeDefinition({ ...args, dataType });
-    if (dataType instanceof MappedType)
-        return this.generateMappedTypeDefinition({ ...args, dataType });
-    if (dataType instanceof ComplexType)
-        return this.generateComplexTypeDefinition({ ...args, dataType });
-    return '';
-}
-/**
- *
- */
-export async function generateEnumTypeDefinition(args) {
-    const { dataType } = args;
-    if (args.intent === 'field')
-        return '(' +
-            Object.keys(dataType.values)
-                .map(t => `'${t}'`)
-                .join(' | ') +
-            ')';
-    if (args.intent !== 'scope')
-        throw new TypeError(`Can't generate EnumType for "${args.intent}" intent`);
-    if (!dataType.name)
-        throw new TypeError(`Name required to generate EnumType for "${args.intent}" intent`);
-    let out = `enum ${dataType.name} {\n\t`;
-    for (const [value, info] of Object.entries(dataType.values)) {
-        // Print JSDoc
-        let jsDoc = '';
-        if (dataType.values[value].description)
-            jsDoc += ` * ${dataType.values[value].description}\n`;
-        if (jsDoc)
-            out += `/**\n${jsDoc} */\n`;
-        out += `${info.key || value} = ` +
-            (typeof value === 'number' ? value : ('\'' + (String(value)).replace('\'', '\\\'')) + '\'');
-        out += ',\n\n';
-    }
-    return out + '\b}';
-}
-/**
- *
- */
-export async function generateComplexTypeDefinition(args) {
-    const { intent, dataType } = args;
-    if (intent === 'scope' && !dataType.name)
-        throw new TypeError(`Name required to generate ComplexType for "${args.intent}" intent`);
-    let out = intent === 'scope' ? `interface ${dataType.name} ` : '';
-    if (dataType.base) {
-        const base = await this.resolveTypeNameOrDef({ file: args.file, dataType: dataType.base, intent: 'extends' });
-        const omitFields = [...dataType.own.fields.keys()]
-            .filter(k => dataType.base?.fields.has(k));
-        const baseDef = omitFields.length
-            ? `Omit<${base}, ${omitFields.map(x => "'" + x + "'").join(' | ')}>`
-            : `${base}`;
-        if (intent === 'scope')
-            out += `extends ${baseDef} `;
-        else {
-            out += baseDef;
-            if (!dataType.own.fields.size)
-                return out;
-            out += ' & ';
-        }
-    }
-    out += '{\n\t';
-    let i = 0;
-    for (const field of dataType.own.fields.values()) {
-        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 {
-            out += await this.resolveTypeNameOrDef({ file: args.file, dataType: field.type, intent: 'field' }) +
-                `${field.isArray ? '[]' : ''};\n`;
-        }
-    }
-    if (dataType.additionalFields)
-        out += '[key: string]: any;\n';
-    return out + '\b}';
-}
-/**
- *
- */
-export async function generateSimpleTypeDefinition(args) {
-    const { intent, dataType } = args;
-    if (intent === 'scope' && !dataType.name)
-        throw new TypeError(`Name required to generate SimpleType for "${args.intent}" intent`);
-    let out = intent === 'scope' ? `type ${dataType.name} = ` : '';
-    if (dataType.extendsFrom('boolean'))
-        out += 'boolean';
-    else if (dataType.extendsFrom('string'))
-        out += 'string';
-    else if (dataType.extendsFrom('number') || dataType.extendsFrom('integer'))
-        out += 'number';
-    else if (dataType.extendsFrom('date') || dataType.extendsFrom('datetime'))
-        out += 'Date';
-    else if (dataType.extendsFrom('approxdate') || dataType.extendsFrom('approxdatetime'))
-        out += 'string';
-    else if (dataType.extendsFrom('bigint'))
-        out += 'bigint';
-    else if (dataType.extendsFrom('object'))
-        out += 'object';
-    else
-        out += 'any';
-    return intent === 'scope' ? out + ';' : out;
-}
-/**
- *
- */
-export async function generateMixinTypeDefinition(args) {
-    const { file, dataType, intent } = args;
-    return (await Promise.all(dataType.types
-        .map(t => this.resolveTypeNameOrDef({ file, dataType: t, intent })))).map(t => t.includes('|') ? '(' + t + ')' : t)
-        .join(intent === 'extends' ? ', ' : ' & ');
-}
-/**
- *
- */
-export async function generateMappedTypeDefinition(args) {
-    const { dataType } = args;
-    const typeDef = await this.resolveTypeNameOrDef({ ...args, dataType: dataType.base });
-    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;
-    if (!(pick || omit || partial))
-        return typeDef;
-    let out = '';
-    if (partial)
-        out += 'Partial<';
-    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/esm/api-exporter/ts-file.js

@@ -1,99 +0,0 @@
-import path from 'path';
-import flattenText from 'putil-flattentext';
-export class TsFile {
-    constructor(filename) {
-        this.filename = filename;
-        this.imports = {};
-        this.exportFiles = {};
-        this.exportTypes = [];
-        this.header = '';
-        this.content = '';
-        this.addImport = (filename, items, typeImport) => {
-            if (isLocalFile(filename)) {
-                filename = path.relative(this.dirname, path.resolve(this.dirname, filename));
-                if (!filename.startsWith('.'))
-                    filename = './' + filename;
-            }
-            if (filename.endsWith('.d.ts'))
-                filename = filename.substring(0, filename.length - 5);
-            if (filename.endsWith('.ts') || filename.endsWith('.js'))
-                filename = filename.substring(0, filename.length - 3);
-            const imp = (this.imports[filename] = this.imports[filename] || { items: [], typeImport });
-            if (!typeImport)
-                imp.typeImport = false;
-            items?.forEach(x => {
-                if (!imp.items.includes(x))
-                    imp.items.push(x);
-            });
-        };
-        this.addExport = (filename, types) => {
-            if (isLocalFile(filename)) {
-                filename = path.relative(this.dirname, path.resolve(this.dirname, filename));
-                if (!filename.startsWith('.'))
-                    filename = './' + filename;
-            }
-            if (filename.endsWith('.d.ts'))
-                filename = filename.substring(0, filename.length - 5);
-            if (filename.endsWith('.ts') || filename.endsWith('.js'))
-                filename = filename.substring(0, filename.length - 3);
-            this.exportFiles[filename] = this.exportFiles[filename] || [];
-            types?.forEach(x => {
-                if (!this.exportFiles[filename].includes(x))
-                    this.exportFiles[filename].push(x);
-            });
-        };
-        this.dirname = path.dirname(filename);
-    }
-    generate(options) {
-        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) => {
-            if (a.startsWith('@'))
-                return -1;
-            if (b.startsWith('@'))
-                return 1;
-            if (!a.startsWith('.'))
-                return -1;
-            if (!b.startsWith('.'))
-                return 1;
-            return a.toLowerCase().localeCompare(b.toLowerCase());
-        })
-            .map(filename => {
-            const imp = this.imports[filename];
-            let relFile = filename;
-            if (!isPackageName(filename)) {
-                if (options?.importExt)
-                    relFile += '.js';
-            }
-            return `import${imp.typeImport ? ' type' : ''} ${imp.items.length ? '{ ' + imp.items.join(', ') + ' } from ' : ''}'${relFile}';`;
-        })
-            .join('\n');
-        if (importStr)
-            output += flattenText(importStr) + '\n';
-        output += flattenText(this.content);
-        const exportStr = Object.keys(this.exportFiles)
-            .sort((a, b) => a.toLowerCase().localeCompare(b.toLowerCase()))
-            .map(filename => {
-            const types = this.exportFiles[filename];
-            let relFile = filename;
-            if (!isPackageName(filename)) {
-                if (options?.importExt)
-                    relFile += '.js';
-            }
-            return `export ${types.length ? '{ ' + types.join(', ') + ' }' : '*'} from '${relFile}';`;
-        })
-            .join('\n');
-        if (exportStr)
-            output += flattenText(exportStr) + '\n';
-        return output;
-    }
-}
-function isLocalFile(s) {
-    return typeof s === 'string' &&
-        (s.startsWith('.') || s.startsWith('/'));
-}
-const PACKAGENAME_PATTERN = /^(@[a-z0-9-~][a-z0-9-._~]*\/)?[a-z0-9-~][a-z0-9-._~]*$/;
-function isPackageName(s) {
-    return PACKAGENAME_PATTERN.test(s);
-}

package/esm/utils/get-caller-file.util.js

@@ -1,20 +0,0 @@
-const PATH_PATTERN = /^(?:file:\/\/)?(.+)$/;
-export function getCallerFile(position = 1) {
-    if (position >= Error.stackTraceLimit) {
-        throw new TypeError('getCallerFile(position) requires position be less then Error.stackTraceLimit but position was: `' +
-            position + '` and Error.stackTraceLimit was: `' + Error.stackTraceLimit + '`');
-    }
-    const oldPrepareStackTrace = Error.prepareStackTrace;
-    Error.prepareStackTrace = (_, stack) => stack;
-    const stack = new Error().stack;
-    Error.prepareStackTrace = oldPrepareStackTrace;
-    if (stack !== null && typeof stack === 'object') {
-        // stack[0] holds this file
-        // stack[1] holds where this function was called
-        const s = stack[position] ?
-            stack[position].getFileName() : undefined;
-        const m = s ? PATH_PATTERN.exec(s) : undefined;
-        return m ? m[1] : '';
-    }
-    return '';
-}

package/types/api-exporter/api-exporter.d.ts

@@ -1,46 +0,0 @@
-import { OpraHttpClient } from '@opra/client';
-import { ApiDocument } from '@opra/common';
-import { IFileWriter } from '../interfaces/file-writer.interface.js';
-import { ILogger } from '../interfaces/logger.interface.js';
-import { processResource } from './process-resources.js';
-import { generateComplexTypeDefinition, generateEnumTypeDefinition, generateMappedTypeDefinition, generateMixinTypeDefinition, generateSimpleTypeDefinition, generateTypeFile, processTypes, resolveTypeNameOrDef } from './process-types.js';
-import { TsFile } from './ts-file.js';
-export declare namespace ApiExporter {
-    interface Config {
-        serviceUrl: string;
-        outDir: string;
-        name?: string;
-        cwd?: string;
-        logger?: ILogger;
-        writer?: IFileWriter;
-        fileHeader?: string;
-        importExt?: boolean;
-    }
-}
-export declare class ApiExporter {
-    protected client: OpraHttpClient;
-    protected document: ApiDocument;
-    protected logger: ILogger;
-    protected outDir: string;
-    protected cwd: string;
-    protected serviceClassName?: string;
-    protected fileHeader: string;
-    protected writer: IFileWriter;
-    protected files: Record<string, TsFile>;
-    protected importExt?: boolean;
-    protected processResource: typeof processResource;
-    protected processTypes: typeof processTypes;
-    protected generateTypeFile: typeof generateTypeFile;
-    protected generateComplexTypeDefinition: typeof generateComplexTypeDefinition;
-    protected generateSimpleTypeDefinition: typeof generateSimpleTypeDefinition;
-    protected resolveTypeNameOrDef: typeof resolveTypeNameOrDef;
-    protected generateEnumTypeDefinition: typeof generateEnumTypeDefinition;
-    protected generateMixinTypeDefinition: typeof generateMixinTypeDefinition;
-    protected generateMappedTypeDefinition: typeof generateMappedTypeDefinition;
-    protected constructor(config: ApiExporter.Config);
-    protected execute(): Promise<void>;
-    protected getFile(filePath: string): TsFile;
-    protected addFile(filePath: string, returnExists?: boolean): TsFile;
-    protected cleanDirectory(dirname: string): void;
-    static execute(config: ApiExporter.Config): Promise<void>;
-}

package/types/api-exporter/index.d.ts

@@ -1 +0,0 @@
-export * from './api-exporter.js';

package/types/api-exporter/process-resources.d.ts

@@ -1,4 +0,0 @@
-import { Resource } from '@opra/common';
-import type { ApiExporter } from './api-exporter.js';
-import { TsFile } from './ts-file.js';
-export declare function processResource(this: ApiExporter, resource: Resource, className: string, tsFile: TsFile): Promise<string>;

package/types/api-exporter/process-types.d.ts

@@ -1,62 +0,0 @@
-import { ComplexType, DataType, EnumType, MappedType, MixinType, SimpleType } from '@opra/common';
-import type { ApiExporter } from './api-exporter.js';
-import { TsFile } from './ts-file.js';
-type Intent = 'scope' | 'extends' | 'field';
-/**
- *
- */
-export declare function processTypes(this: ApiExporter): Promise<void>;
-/**
- *
- * @param dataType
- */
-export declare function generateTypeFile(this: ApiExporter, dataType: DataType): Promise<TsFile | undefined>;
-/**
- *
- */
-export declare function resolveTypeNameOrDef(this: ApiExporter, args: {
-    file: TsFile;
-    dataType: DataType;
-    intent: Intent;
-}): Promise<string>;
-/**
- *
- */
-export declare function generateEnumTypeDefinition(this: ApiExporter, args: {
-    file: TsFile;
-    dataType: EnumType;
-    intent: Intent;
-}): Promise<string>;
-/**
- *
- */
-export declare function generateComplexTypeDefinition(this: ApiExporter, args: {
-    file: TsFile;
-    dataType: ComplexType;
-    intent: Intent;
-}): Promise<string>;
-/**
- *
- */
-export declare function generateSimpleTypeDefinition(this: ApiExporter, args: {
-    file: TsFile;
-    dataType: SimpleType;
-    intent: Intent;
-}): Promise<string>;
-/**
- *
- */
-export declare function generateMixinTypeDefinition(this: ApiExporter, args: {
-    file: TsFile;
-    dataType: MixinType;
-    intent: Intent;
-}): Promise<string>;
-/**
- *
- */
-export declare function generateMappedTypeDefinition(this: ApiExporter, args: {
-    file: TsFile;
-    dataType: MappedType;
-    intent: Intent;
-}): Promise<string>;
-export {};

package/types/utils/get-caller-file.util.d.ts

@@ -1 +0,0 @@
-export declare function getCallerFile(position?: number): string;