react-query-lightbase-codegen 0.5.0 → 1.0.2

package/lib/esm/generateSchemas.js

@@ -1,96 +0,0 @@
-import pasCase from 'case';
-import lodash from 'lodash';
-const { isEmpty } = lodash;
-const { pascal } = pasCase;
-import { formatDescription, getScalar, isReference, resolveValue } from './utils.js';
-import { getDocs, getResReqTypes } from './utils.js';
-/**
- * Generate the interface string
- */
-const generateInterface = (name, schema) => {
-    const scalar = getScalar(schema);
-    return `${formatDescription(schema.description)}
-       export type ${pascal(name)} = ${scalar}
-     `;
-};
-/**
- * Extract all types from #/components/schemas
- */
-const generateSchemasDefinition = (schemas = {}) => {
-    if (isEmpty(schemas)) {
-        return '';
-    }
-    return ('\n // SCEHMAS \n' +
-        Object.entries(schemas)
-            .map(([name, schema]) => !isReference(schema) &&
-            (!schema.type || schema.type === 'object') &&
-            !schema.allOf &&
-            !schema.oneOf &&
-            !isReference(schema) &&
-            !schema.nullable
-            ? generateInterface(name, schema)
-            : `${formatDescription(isReference(schema) ? undefined : schema.description)} export type ${pascal(name)} = ${resolveValue(schema)};`)
-            .join('\n\n') +
-        '\n');
-};
-/**
- * Extract all types from #/components/requestBodies
- */
-const generateRequestBodiesDefinition = (requestBodies = {}) => {
-    if (isEmpty(requestBodies)) {
-        return '';
-    }
-    return ('\n // REQUEST BODIES \n' +
-        Object.entries(requestBodies)
-            .map(([name, requestBody]) => {
-            const doc = getDocs(requestBody);
-            const type = getResReqTypes([['', requestBody]]);
-            const isEmptyInterface = type === '{}';
-            if (isEmptyInterface) {
-                return `${doc}\nexport type ${pascal(name)}RequestBody = ${type}`;
-            }
-            else if (type.includes('{') && !type.includes('|') && !type.includes('&')) {
-                return `${doc}\nexport type ${pascal(name)}RequestBody = ${type}`;
-            }
-            else {
-                return `${doc}\nexport type ${pascal(name)}RequestBody = ${type};`;
-            }
-        })
-            .join('\n\n') +
-        '\n');
-};
-/**
- * Extract all types from #/components/responses
- */
-const generateResponsesDefinition = (responses = {}) => {
-    if (isEmpty(responses)) {
-        return '';
-    }
-    return ('\n // RESPONSES \n' +
-        Object.entries(responses)
-            .map(([name, response]) => {
-            const doc = getDocs(response);
-            const type = getResReqTypes([['', response]]);
-            const isEmptyInterface = type === '{}';
-            if (isEmptyInterface) {
-                return `export type RQ${pascal(name)}Response = ${type}`;
-            }
-            else if (type.includes('{') && !type.includes('|') && !type.includes('&')) {
-                return `${doc}export type RQ${pascal(name)}Response = ${type}`;
-            }
-            else {
-                return `${doc}export type RQ${pascal(name)}Response = ${type};`;
-            }
-        })
-            .join('\n\n') +
-        '\n');
-};
-/**
- * Extract all types from #/components/schemas
- */
-export const generateSchemas = ({ spec }) => {
-    const schemaOutput = generateRequestBodiesDefinition(spec.components?.requestBodies) +
-        generateResponsesDefinition(spec.components?.responses) +
-        generateSchemasDefinition(spec.components?.schemas);
-    return schemaOutput;
-};

package/lib/esm/generateSchemasDefinition.js

@@ -1,33 +0,0 @@
-import { pascal } from 'case';
-import isEmpty from 'lodash/isEmpty';
-import { formatDescription, getScalar, isReference, resolveValue } from './getResReqTypes';
-/**
- * Generate the interface string
- */
-const generateInterface = (name, schema) => {
-    const scalar = getScalar(schema);
-    return `
-       ${formatDescription(schema.description)}
-       export type ${pascal(name)} = ${scalar}
-     `;
-};
-/**
- * Extract all types from #/components/schemas
- */
-export const generateSchemasDefinition = (schemas = {}) => {
-    if (isEmpty(schemas)) {
-        return '';
-    }
-    return ('\n // SCEHMAS' +
-        Object.entries(schemas)
-            .map(([name, schema]) => !isReference(schema) &&
-            (!schema.type || schema.type === 'object') &&
-            !schema.allOf &&
-            !schema.oneOf &&
-            !isReference(schema) &&
-            !schema.nullable
-            ? generateInterface(name, schema)
-            : `${formatDescription(isReference(schema) ? undefined : schema.description)} type ${pascal(name)} = ${resolveValue(schema)};`)
-            .join('\n\n') +
-        '\n');
-};

package/lib/esm/getResReqTypes.js

@@ -1,150 +0,0 @@
-import { pascal } from 'case';
-import { uniq } from 'lodash';
-import isEmpty from 'lodash/isEmpty';
-export const getDocs = (data) => isReference(data) ? '' : formatDescription(data.description);
-/**
- * Discriminator helper for `ReferenceObject`
- */
-export const isReference = (property) => {
-    return Boolean(property.$ref);
-};
-/**
- * Return the typescript equivalent of open-api data type
- */
-export const getScalar = (item) => {
-    const nullable = item.nullable ? ' | null' : '';
-    switch (item.type) {
-        case 'number':
-        case 'integer':
-            return 'number' + nullable;
-        case 'boolean':
-            return 'boolean' + nullable;
-        case 'array':
-            return getArray(item) + nullable;
-        case 'string':
-            return (item.enum ? `"${item.enum.join(`" | "`)}"` : 'string') + nullable;
-        case 'object':
-        default:
-            return getObject(item) + nullable;
-    }
-};
-/**
- * Return the output type from the $ref
- */
-const getRef = ($ref) => {
-    if ($ref.startsWith('#/components/schemas')) {
-        return pascal($ref.replace('#/components/schemas/', ''));
-    }
-    else if ($ref.startsWith('#/components/responses')) {
-        return pascal($ref.replace('#/components/responses/', '')) + 'Response';
-    }
-    else if ($ref.startsWith('#/components/parameters')) {
-        return pascal($ref.replace('#/components/parameters/', '')) + 'Parameter';
-    }
-    else if ($ref.startsWith('#/components/requestBodies')) {
-        return pascal($ref.replace('#/components/requestBodies/', '')) + 'RequestBody';
-    }
-    else {
-        throw new Error('This library only resolve $ref that are include into `#/components/*` for now');
-    }
-};
-/**
- * Return the output type from an array
- */
-const getArray = (item) => {
-    if (item.items) {
-        if (!isReference(item.items) && (item.items.oneOf || item.items.allOf || item.items.enum)) {
-            return `(${resolveValue(item.items)})[]`;
-        }
-        else {
-            return `${resolveValue(item.items)}[]`;
-        }
-    }
-    else {
-        throw new Error('All arrays must have an `items` key define');
-    }
-};
-/**
- * Return the output type from an object
- */
-const getObject = (item) => {
-    if (isReference(item)) {
-        return getRef(item.$ref);
-    }
-    if (item.allOf) {
-        return item.allOf.map(resolveValue).join(' & ');
-    }
-    if (item.oneOf) {
-        return item.oneOf.map(resolveValue).join(' | ');
-    }
-    if (!item.type && !item.properties && !item.additionalProperties) {
-        return '{}';
-    }
-    // Free form object (https://swagger.io/docs/specification/data-models/data-types/#free-form)
-    if (item.type === 'object' &&
-        !item.properties &&
-        (!item.additionalProperties || item.additionalProperties === true || isEmpty(item.additionalProperties))) {
-        return '{[key: string]: any}';
-    }
-    const IdentifierRegexp = /^[a-zA-Z_$][a-zA-Z0-9_$]*$/;
-    // Consolidation of item.properties & item.additionalProperties
-    let output = '{\n';
-    if (item.properties) {
-        output += Object.entries(item.properties)
-            .map(([key, prop]) => {
-            const doc = getDocs(prop);
-            const isRequired = (item.required || []).includes(key);
-            const processedKey = IdentifierRegexp.test(key) ? key : `"${key}"`;
-            return `${doc}\n${processedKey}${isRequired ? '' : '?'}: ${resolveValue(prop)};`;
-        })
-            .join('\n');
-    }
-    if (item.additionalProperties) {
-        if (item.properties) {
-            output += '\n';
-        }
-        output += `} & { [key: string]: ${item.additionalProperties === true ? 'any' : resolveValue(item.additionalProperties)}`;
-    }
-    if (item.properties || item.additionalProperties) {
-        if (output === '{\n') {
-            return '{}';
-        }
-        return output + '\n}';
-    }
-    return item.type === 'object' ? '{[key: string]: any}' : 'any';
-};
-/**
- * Resolve the value of a schema object to a proper type definition.
- */
-export const resolveValue = (schema) => isReference(schema) ? getRef(schema.$ref) : getScalar(schema);
-/**
- * Format a description to code documentation.
- */
-export const formatDescription = (description, tabSize = 0) => description
-    ? `/**\n${description
-        .split('\n')
-        .map((i) => `${' '.repeat(tabSize)} *  ${i}`)
-        .join('\n')}\n${' '.repeat(tabSize)} */${' '.repeat(tabSize)}`
-    : '';
-/**
- * Extract responses / request types from open-api specs
- */
-export const getResReqTypes = (responsesOrRequests) => uniq(responsesOrRequests.map(([_, res]) => {
-    if (!res) {
-        return 'void';
-    }
-    if (isReference(res)) {
-        return getRef(res.$ref);
-    }
-    if (res.content) {
-        for (let contentType of Object.keys(res.content)) {
-            if (contentType.startsWith('application/json') ||
-                contentType.startsWith('application/octet-stream')) {
-                const schema = res.content[contentType].schema;
-                return resolveValue(schema);
-            }
-        }
-        return 'void';
-    }
-    return 'void';
-})).join(' | ');

package/lib/esm/import-open-api.js

@@ -1,32 +0,0 @@
-import set from 'lodash/set';
-import { generateQueryHooks } from './generateHooks';
-import { generateImports } from './generateImports';
-import { isReference } from './getResReqTypes';
-/**
- * Propagate every `discriminator.propertyName` mapping to the original ref
- *
- * Note: This method directly mutate the `specs` object.
- */
-const resolveDiscriminator = (specs) => {
-    if (specs.components && specs.components.schemas) {
-        Object.values(specs.components.schemas).forEach((schema) => {
-            if (isReference(schema) || !schema.discriminator || !schema.discriminator.mapping) {
-                return;
-            }
-            const { mapping, propertyName } = schema.discriminator;
-            Object.entries(mapping).forEach(([name, ref]) => {
-                if (!ref.startsWith('#/components/schemas/')) {
-                    throw new Error('Discriminator mapping outside of `#/components/schemas` is not supported');
-                }
-                set(specs, `components.schemas.${ref.slice('#/components/schemas/'.length)}.properties.${propertyName}.enum`, [name]);
-            });
-        });
-    }
-};
-export const importOpenApi = async ({ specs, apiDirectory, queryClientDir, headerFilters = [], }) => {
-    const operationIds = [];
-    resolveDiscriminator(specs);
-    const imports = generateImports({ apiDirectory, queryClientDir });
-    const hooks = generateQueryHooks(specs, operationIds, headerFilters);
-    return imports + hooks;
-};

package/lib/esm/importSpecs.js

@@ -1,80 +0,0 @@
-import chalk from 'chalk';
-import { readFileSync, writeFileSync, readdir, mkdirSync } from 'fs';
-import { join, parse } from 'path';
-import { convertSwaggerFile } from './convertSwaggerFile.js';
-import { createHook } from './generateHooks.js';
-import { generateImports } from './generateImports.js';
-import { generateSchemas } from './generateSchemas.js';
-export function importSpecs({ sourceDirectory, exportDirectory, apiDirectory, queryClientDir, headerFilters, overrides, }) {
-    readdir(sourceDirectory, function (err, filenames) {
-        if (err) {
-            console.log(err);
-            throw err;
-        }
-        filenames.map(async (filename) => {
-            try {
-                const data = readFileSync(join(process.cwd(), sourceDirectory + '/' + filename), 'utf-8');
-                const { ext } = parse(sourceDirectory + '/' + filename);
-                const format = ['.yaml', '.yml'].includes(ext.toLowerCase()) ? 'yaml' : 'json';
-                let spec = await convertSwaggerFile(data, format);
-                const schemaName = `useQueries${filename.split('.')[0]}.schema`;
-                const hooksName = `useQueries${filename.split('.')[0]}`;
-                const name = filename.split('.')[0];
-                mkdirSync(join(process.cwd(), `${exportDirectory}/${name}`), { recursive: true });
-                const operationIds = [];
-                let hooks = '';
-                let schemaImportsArray = [];
-                let collectedQueryImports = [];
-                Object.entries(spec.paths).forEach(([route, verbs]) => {
-                    Object.entries(verbs).forEach(([verb, operation]) => {
-                        if (['get', 'post', 'patch', 'put', 'delete'].includes(verb) && !operation.deprecated) {
-                            const { implementation, imports, queryImports } = createHook({
-                                operation,
-                                verb,
-                                route: (spec.basePath || '') + route,
-                                operationIds,
-                                parameters: verbs.parameters,
-                                schemasComponents: spec.components,
-                                headerFilters,
-                                overrides,
-                            });
-                            hooks += implementation;
-                            imports.forEach((element) => {
-                                const formattedImport = element.replace('[]', '');
-                                if (!schemaImportsArray.includes(formattedImport) &&
-                                    element !== 'void' &&
-                                    element !== 'string' &&
-                                    !element.includes('{')) {
-                                    schemaImportsArray.push(formattedImport);
-                                }
-                            });
-                            queryImports.forEach((element) => {
-                                if (!schemaImportsArray.includes(element)) {
-                                    collectedQueryImports.push(element);
-                                }
-                            });
-                        }
-                    });
-                });
-                const imports = generateImports({
-                    apiDirectory,
-                    queryClientDir,
-                    schemaName,
-                    schemaImports: schemaImportsArray,
-                    queryImports: collectedQueryImports,
-                });
-                writeFileSync(join(process.cwd(), `${exportDirectory}/${name}/${hooksName}.tsx`), imports + hooks);
-                const schemas = generateSchemas({ spec });
-                writeFileSync(join(process.cwd(), `${exportDirectory}/${name}/${schemaName}.tsx`), schemas);
-                console.log(chalk.green(`🎉 [${filename}] Your OpenAPI spec has been converted into react query hooks`));
-            }
-            catch (error) {
-                if (error.code === 'EISDIR') {
-                    console.log(chalk.red('nested folder structure not supported'));
-                    return;
-                }
-                console.log(chalk.red(`[${filename}]:`), chalk.red(error));
-            }
-        });
-    });
-}

package/lib/esm/index.js

@@ -1,3 +0,0 @@
-import { convertSwaggerFile } from './convertSwaggerFile.js';
-import { importSpecs } from './importSpecs.js';
-export { importSpecs, convertSwaggerFile };

package/lib/esm/react-query-codegen-import.js

@@ -1,42 +0,0 @@
-import chalk from 'chalk';
-import { readFileSync, writeFileSync, readdir, mkdirSync } from 'fs';
-import { join, parse } from 'path';
-import { convertSwaggerFile } from './convertSwaggerFile';
-import { generateQueryHooks } from './generateHooks';
-import { generateSchemas } from './generateSchemas';
-export function importSpecs({ sourceDirectory, exportDirectory, apiDirectory, queryClientDir, headerFilters, }) {
-    readdir(sourceDirectory, function (err, filenames) {
-        if (err) {
-            console.log(err);
-            throw err;
-        }
-        filenames.map(async (filename) => {
-            const data = readFileSync(join(process.cwd(), sourceDirectory + '/' + filename), 'utf-8');
-            const { ext } = parse(sourceDirectory + '/' + filename);
-            const format = ['.yaml', '.yml'].includes(ext.toLowerCase()) ? 'yaml' : 'json';
-            try {
-                const name = filename.split('.')[0];
-                const hooksName = `useQueries${filename.split('.')[0]}`;
-                const schemaName = `useQueries${filename.split('.')[0]}.schema`;
-                let spec = await convertSwaggerFile(data, format);
-                const operationIds = [];
-                mkdirSync(join(process.cwd(), `${exportDirectory}/${name}`), { recursive: true });
-                const hooks = generateQueryHooks({
-                    spec,
-                    schemaName,
-                    operationIds,
-                    headerFilters,
-                    apiDirectory,
-                    queryClientDir,
-                });
-                writeFileSync(join(process.cwd(), `${exportDirectory}/${name}/${hooksName}.tsx`), hooks);
-                const schemas = generateSchemas(spec);
-                writeFileSync(join(process.cwd(), `${exportDirectory}/${name}/${schemaName}.tsx`), schemas);
-                console.log(chalk.green(`🎉 [${filename}] Your OpenAPI spec has been converted into react query hooks`));
-            }
-            catch (error) {
-                console.log(chalk.red(`[${filename}]:`), chalk.red(error));
-            }
-        });
-    });
-}

package/lib/esm/resolveDiscriminator.js

@@ -1,24 +0,0 @@
-import set from 'lodash/set';
-import { isReference } from './getResReqTypes';
-/**
- * Propagate every `discriminator.propertyName` mapping to the original ref
- *
- * Note: This method directly mutate the `specs` object.
- */
-export const resolveDiscriminator = (specs) => {
-    if (specs.components && specs.components.schemas) {
-        Object.values(specs.components.schemas).forEach((schema) => {
-            if (isReference(schema) || !schema.discriminator || !schema.discriminator.mapping) {
-                return;
-            }
-            const { mapping, propertyName } = schema.discriminator;
-            Object.entries(mapping).forEach(([name, ref]) => {
-                if (!ref.startsWith('#/components/schemas/')) {
-                    throw new Error('Discriminator mapping outside of `#/components/schemas` is not supported');
-                }
-                console.log('HELLO');
-                set(specs, `components.schemas.${ref.slice('#/components/schemas/'.length)}.properties.${propertyName}.enum`, [name]);
-            });
-        });
-    }
-};

package/lib/esm/types.js

@@ -1 +0,0 @@
-export {};

package/lib/esm/utils.js

@@ -1,156 +0,0 @@
-import lodash from 'lodash';
-const { uniq, isEmpty } = lodash;
-import pasCase from 'case';
-const { pascal } = pasCase;
-export const getDocs = (data) => isReference(data) ? '' : formatDescription(data.description);
-/**
- * Discriminator helper for `ReferenceObject`
- */
-export const isReference = (property) => {
-    return Boolean(property.$ref);
-};
-/**
- * Return the typescript equivalent of open-api data type
- */
-export const getScalar = (item) => {
-    const nullable = item.nullable ? ' | null' : '';
-    switch (item.type) {
-        case 'number':
-        case 'integer':
-            return 'number' + nullable;
-        case 'boolean':
-            return 'boolean' + nullable;
-        case 'array':
-            return getArray(item) + nullable;
-        case 'string':
-            return (item.enum ? `"${item.enum.join(`" | "`)}"` : 'string') + nullable;
-        case 'object':
-        default:
-            return getObject(item) + nullable;
-    }
-};
-/**
- * Return the output type from the $ref
- */
-const getRef = ($ref) => {
-    if ($ref.startsWith('#/components/schemas')) {
-        return pascal($ref.replace('#/components/schemas/', ''));
-    }
-    else if ($ref.startsWith('#/components/responses')) {
-        return pascal($ref.replace('#/components/responses/', '')) + 'Response';
-    }
-    else if ($ref.startsWith('#/components/parameters')) {
-        return pascal($ref.replace('#/components/parameters/', '')) + 'Parameter';
-    }
-    else if ($ref.startsWith('#/components/requestBodies')) {
-        return pascal($ref.replace('#/components/requestBodies/', '')) + 'RequestBody';
-    }
-    else {
-        throw new Error('This library only resolve $ref that are include into `#/components/*` for now');
-    }
-};
-/**
- * Return the output type from an array
- */
-const getArray = (item) => {
-    if (item.items) {
-        if (!isReference(item.items) && (item.items.oneOf || item.items.allOf || item.items.enum)) {
-            return `(${resolveValue(item.items)})[]`;
-        }
-        else {
-            return `${resolveValue(item.items)}[]`;
-        }
-    }
-    else {
-        throw new Error('All arrays must have an `items` key define');
-    }
-};
-/**
- * Return the output type from an object
- */
-const getObject = (item) => {
-    if (isReference(item)) {
-        return getRef(item.$ref);
-    }
-    if (item.allOf) {
-        return item.allOf.map(resolveValue).join(' & ');
-    }
-    if (item.oneOf) {
-        return item.oneOf.map(resolveValue).join(' | ');
-    }
-    if (!item.type && !item.properties && !item.additionalProperties) {
-        return '{}';
-    }
-    // Free form object (https://swagger.io/docs/specification/data-models/data-types/#free-form)
-    if (item.type === 'object' &&
-        !item.properties &&
-        (!item.additionalProperties || item.additionalProperties === true || isEmpty(item.additionalProperties))) {
-        return '{[key: string]: any}';
-    }
-    const IdentifierRegexp = /^[a-zA-Z_$][a-zA-Z0-9_$]*$/;
-    // Consolidation of item.properties & item.additionalProperties
-    let output = '{\n';
-    if (item.properties) {
-        output += Object.entries(item.properties)
-            .map(([key, prop]) => {
-            const doc = getDocs(prop);
-            const isRequired = (item.required || []).includes(key);
-            const processedKey = IdentifierRegexp.test(key) ? key : `"${key}"`;
-            return `${doc}\n${processedKey}${isRequired ? '' : '?'}: ${resolveValue(prop)};`;
-        })
-            .join('');
-    }
-    if (item.additionalProperties) {
-        if (item.properties) {
-            output += '\n';
-        }
-        output += `} & { [key: string]: ${item.additionalProperties === true ? 'any' : resolveValue(item.additionalProperties)}`;
-    }
-    if (item.properties || item.additionalProperties) {
-        if (output === '{\n') {
-            return '{}';
-        }
-        return output + '\n}';
-    }
-    return item.type === 'object' ? '{[key: string]: any}' : 'any';
-};
-/**
- * Resolve the value of a schema object to a proper type definition.
- */
-export const resolveValue = (schema) => isReference(schema) ? getRef(schema.$ref) : getScalar(schema);
-/**
- * Format a description to code documentation.
- */
-export const formatDescription = (description) => {
-    if (!description) {
-        return '';
-    }
-    return `\n/**\n${description
-        .split('\n')
-        .map((i) => `*  ${i}`)
-        .join('\n')}\n */`;
-};
-/**
- * Extract responses / request types from open-api specs
- */
-export const getResReqTypes = (responsesOrRequests) => {
-    return uniq(responsesOrRequests.map(([_, res]) => {
-        if (!res) {
-            return;
-        }
-        if (isReference(res)) {
-            return getRef(res.$ref);
-        }
-        if (res.content) {
-            for (let contentType of Object.keys(res.content)) {
-                if (contentType.startsWith('application/json') ||
-                    contentType.startsWith('application/octet-stream')) {
-                    const schema = res.content[contentType].schema;
-                    return resolveValue(schema);
-                }
-            }
-            return;
-        }
-        return;
-    })).join(' | ');
-};