react-query-lightbase-codegen 1.1.0 → 1.1.1

package/lib/esm/importSpecs.js

@@ -0,0 +1,39 @@
+import chalk from 'chalk';
+import { readFileSync, writeFileSync, readdir, mkdirSync } from 'fs';
+import { join, parse } from 'path';
+import { convertSwaggerFile } from './convertSwaggerFile.js';
+import { generateImports, generateQueryHooks } from './generateHooks.js';
+import { generateSchemas } from './generateSchemas.js';
+export function importSpecs({ sourceDirectory, exportDirectory, apiDirectory, queryClientDir, headerFilters, }) {
+    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';
+                const name = filename.split('.')[0];
+                let spec = await convertSwaggerFile(data, format);
+                const operationIds = [];
+                mkdirSync(join(process.cwd(), `${exportDirectory}/${name}`), { recursive: true });
+                const { implementation, schemaImports } = generateQueryHooks({ spec, operationIds, headerFilters });
+                const schemaName = `useQueries${filename.split('.')[0]}.schema`;
+                const imports = generateImports({ apiDirectory, queryClientDir, schemaName, schemaImports });
+                const hooksName = `useQueries${filename.split('.')[0]}`;
+                writeFileSync(join(process.cwd(), `${exportDirectory}/${name}/${hooksName}.tsx`), imports + implementation);
+                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') {
+                    return;
+                }
+                console.log(chalk.red(`[${filename}]:`), chalk.red(error));
+            }
+        });
+    });
+}

package/lib/esm/index.js

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

package/lib/esm/utils.js

@@ -0,0 +1,153 @@
+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${description
+        .split('\n')
+        .map((i) => `*  ${i}`)
+        .join('\n')}\n */`;
+};
+/**
+ * Extract responses / request types from open-api specs
+ */
+export const getResReqTypes = (responsesOrRequests) => 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(' | ');

package/package.json

@@ -1,13 +1,13 @@
 {
   "name": "react-query-lightbase-codegen",
   "description": "Fully typed react query code generation tool based on openApi specifications",
-  "version": "1.1.0",
+  "version": "1.1.1",
   "license": "MIT",
   "type": "module",
-  "exports": "./dist/index.js",
+  "exports": "./lib/index.js",
   "files": [
     "src",
-    "dist"
+    "lib"
   ],
   "keywords": [
     "rest",
@@ -29,7 +29,7 @@
   },
   "repository": {
     "type": "git",
-    "url": "https://github.com/owinter86/react-query-codegen"
+    "url": "https://github.com/lightbasenl/react-query-codegen"
   },
   "engines": {
     "node": ">=14.16"