react-query-lightbase-codegen 1.1.1 → 1.1.4

package/dist/importSpecs.js

@@ -0,0 +1,90 @@
+import Case from 'case';
+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';
+import execa from 'execa';
+export function importSpecs({ sourceDirectory, exportDirectory, apiDirectory, queryClientDir, headerFilters, overrides, }) {
+    readdir(sourceDirectory, async (err, filenames) => {
+        if (err) {
+            console.log(err);
+            throw err;
+        }
+        filenames.forEach(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 formattedFileName = Case.camel(`useQueries, ${filename.split('.')[0]}`);
+                const schemaName = `${formattedFileName}.schema`;
+                const hooksName = `${formattedFileName}`;
+                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);
+                writeFileSync(join(process.cwd(), `${exportDirectory}/${name}/${schemaName}.tsx`), generateSchemas({ spec }));
+                console.log(chalk.green(`🎉 [${filename}] Your OpenAPI spec has been converted into react query hooks`));
+                try {
+                    execa.sync('prettier', ['--write', `./${exportDirectory}/${name}/*.tsx`]);
+                    console.log(chalk.blue(`⚙️  Running prettier`));
+                }
+                catch (e) {
+                    console.log(chalk.yellow(`⚠️  Prettier not found`));
+                }
+            }
+            catch (error) {
+                if (error.code === 'EISDIR') {
+                    console.log(chalk.red('nested folder structure not supported'));
+                    return;
+                }
+                console.log(chalk.red(`[${filename}]:`), chalk.red(error));
+            }
+        });
+    });
+}
+//# sourceMappingURL=importSpecs.js.map

package/dist/importSpecs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"importSpecs.js","sourceRoot":"","sources":["../src/importSpecs.ts"],"names":[],"mappings":"AAAA,OAAO,IAAI,MAAM,MAAM,CAAC;AACxB,OAAO,KAAK,MAAM,OAAO,CAAC;AAC1B,OAAO,EAAE,YAAY,EAAE,aAAa,EAAE,OAAO,EAAE,SAAS,EAAE,MAAM,IAAI,CAAC;AAErE,OAAO,EAAE,IAAI,EAAE,KAAK,EAAE,MAAM,MAAM,CAAC;AACnC,OAAO,EAAE,kBAAkB,EAAE,MAAM,yBAAyB,CAAC;AAC7D,OAAO,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAC;AAChD,OAAO,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AACvD,OAAO,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AACvD,OAAO,KAAK,MAAM,OAAO,CAAC;AAE1B,MAAM,UAAU,WAAW,CAAC,EAC1B,eAAe,EACf,eAAe,EACf,YAAY,EACZ,cAAc,EACd,aAAa,EACb,SAAS,GAWV;IACC,OAAO,CAAC,eAAe,EAAE,KAAK,EAAE,GAAG,EAAE,SAAS,EAAE,EAAE;QAChD,IAAI,GAAG,EAAE;YACP,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;YACjB,MAAM,GAAG,CAAC;SACX;QACD,SAAS,CAAC,OAAO,CAAC,KAAK,EAAE,QAAQ,EAAE,EAAE;YACnC,IAAI;gBACF,MAAM,IAAI,GAAG,YAAY,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,eAAe,GAAG,GAAG,GAAG,QAAQ,CAAC,EAAE,OAAO,CAAC,CAAC;gBAC1F,MAAM,EAAE,GAAG,EAAE,GAAG,KAAK,CAAC,eAAe,GAAG,GAAG,GAAG,QAAQ,CAAC,CAAC;gBACxD,MAAM,MAAM,GAAG,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC,QAAQ,CAAC,GAAG,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC;gBAC/E,IAAI,IAAI,GAAG,MAAM,kBAAkB,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;gBAElD,MAAM,iBAAiB,GAAG,IAAI,CAAC,KAAK,CAAC,eAAe,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;gBAC9E,MAAM,UAAU,GAAG,GAAG,iBAAiB,SAAS,CAAC;gBACjD,MAAM,SAAS,GAAG,GAAG,iBAAiB,EAAE,CAAC;gBACzC,MAAM,IAAI,GAAG,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;gBACpC,SAAS,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,GAAG,eAAe,IAAI,IAAI,EAAE,CAAC,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;gBAElF,MAAM,YAAY,GAAa,EAAE,CAAC;gBAElC,IAAI,KAAK,GAAG,EAAE,CAAC;gBACf,IAAI,kBAAkB,GAAG,EAAc,CAAC;gBACxC,IAAI,qBAAqB,GAAG,EAAgD,CAAC;gBAC7E,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,KAAK,EAAE,KAAK,CAA2B,EAAE,EAAE;oBAC9E,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,EAAE,SAAS,CAA4B,EAAE,EAAE;wBAC7E,IAAI,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,KAAK,EAAE,QAAQ,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,UAAU,EAAE;4BACrF,MAAM,EAAE,cAAc,EAAE,OAAO,EAAE,YAAY,EAAE,GAAG,UAAU,CAAC;gCAC3D,SAAS;gCACT,IAAI;gCACJ,KAAK,EAAE,CAAC,IAAI,CAAC,QAAQ,IAAI,EAAE,CAAC,GAAG,KAAK;gCACpC,YAAY;gCACZ,UAAU,EAAE,KAAK,CAAC,UAAU;gCAC5B,iBAAiB,EAAE,IAAI,CAAC,UAAU;gCAClC,aAAa;gCACb,SAAS;6BACV,CAAC,CAAC;4BAEH,KAAK,IAAI,cAAc,CAAC;4BACxB,OAAO,CAAC,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE;gCAC1B,MAAM,eAAe,GAAG,OAAO,CAAC,OAAO,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;gCAClD,IACE,CAAC,kBAAkB,CAAC,QAAQ,CAAC,eAAe,CAAC;oCAC7C,OAAO,KAAK,MAAM;oCAClB,OAAO,KAAK,QAAQ;oCACpB,CAAC,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAC,EACtB;oCACA,kBAAkB,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;iCAC1C;4BACH,CAAC,CAAC,CAAC;4BACH,YAAY,CAAC,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE;gCAC/B,IAAI,CAAC,kBAAkB,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE;oCACzC,qBAAqB,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;iCACrC;4BACH,CAAC,CAAC,CAAC;yBACJ;oBACH,CAAC,CAAC,CAAC;gBACL,CAAC,CAAC,CAAC;gBAEH,MAAM,OAAO,GAAG,eAAe,CAAC;oBAC9B,YAAY;oBACZ,cAAc;oBACd,UAAU;oBACV,aAAa,EAAE,kBAAkB;oBACjC,YAAY,EAAE,qBAAqB;iBACpC,CAAC,CAAC;gBAEH,aAAa,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,GAAG,eAAe,IAAI,IAAI,IAAI,SAAS,MAAM,CAAC,EAAE,OAAO,GAAG,KAAK,CAAC,CAAC;gBAEnG,aAAa,CACX,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,GAAG,eAAe,IAAI,IAAI,IAAI,UAAU,MAAM,CAAC,EACnE,eAAe,CAAC,EAAE,IAAI,EAAE,CAAC,CAC1B,CAAC;gBACF,OAAO,CAAC,GAAG,CACT,KAAK,CAAC,KAAK,CAAC,OAAO,QAAQ,+DAA+D,CAAC,CAC5F,CAAC;gBACF,IAAI;oBACF,KAAK,CAAC,IAAI,CAAC,UAAU,EAAE,CAAC,SAAS,EAAE,KAAK,eAAe,IAAI,IAAI,QAAQ,CAAC,CAAC,CAAC;oBAC1E,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,sBAAsB,CAAC,CAAC,CAAC;iBACjD;gBAAC,OAAO,CAAC,EAAE;oBACV,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,MAAM,CAAC,wBAAwB,CAAC,CAAC,CAAC;iBACrD;aACF;YAAC,OAAO,KAAK,EAAE;gBACd,IAAK,KAAa,CAAC,IAAI,KAAK,QAAQ,EAAE;oBACpC,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,uCAAuC,CAAC,CAAC,CAAC;oBAChE,OAAO;iBACR;gBACD,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,QAAQ,IAAI,CAAC,EAAE,KAAK,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC;aAC5D;QACH,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC"}

package/dist/index.js

@@ -0,0 +1,4 @@
+import { convertSwaggerFile } from './convertSwaggerFile.js';
+import { importSpecs } from './importSpecs.js';
+export { importSpecs, convertSwaggerFile };
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,MAAM,yBAAyB,CAAC;AAC7D,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAC/C,OAAO,EAAE,WAAW,EAAE,kBAAkB,EAAE,CAAC"}

package/dist/utils.d.ts

@@ -0,0 +1,24 @@
+import { ReferenceObject, RequestBodyObject, ResponseObject, SchemaObject } from 'openapi3-ts';
+export declare const getDocs: (data: ReferenceObject | {
+    description?: string;
+}) => string;
+/**
+ * Discriminator helper for `ReferenceObject`
+ */
+export declare const isReference: (property: any) => property is ReferenceObject;
+/**
+ * Return the typescript equivalent of open-api data type
+ */
+export declare const getScalar: (item: SchemaObject) => string;
+/**
+ * Resolve the value of a schema object to a proper type definition.
+ */
+export declare const resolveValue: (schema: SchemaObject) => string;
+/**
+ * Format a description to code documentation.
+ */
+export declare const formatDescription: (description?: string) => string;
+/**
+ * Extract responses / request types from open-api specs
+ */
+export declare const getResReqTypes: (responsesOrRequests: Array<[string, ResponseObject | ReferenceObject | RequestBodyObject]>) => string;

package/{lib/esm → dist}/utils.js

@@ -122,9 +122,10 @@ export const resolveValue = (schema) => isReference(schema) ? getRef(schema.$ref
  * Format a description to code documentation.
  */
 export const formatDescription = (description) => {
-    if (!description)
+    if (!description) {
         return '';
-    return `/**\n${description
+    }
+    return `\n/**\n${description
         .split('\n')
         .map((i) => `*  ${i}`)
         .join('\n')}\n */`;
@@ -132,22 +133,25 @@ export const formatDescription = (description) => {
 /**
  * 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);
+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;
-    }
-    return;
-})).join(' | ');
+    })).join(' | ');
+};
+//# sourceMappingURL=utils.js.map

package/dist/utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.js","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":"AAAA,OAAO,MAAM,MAAM,QAAQ,CAAC;AAC5B,MAAM,EAAE,IAAI,EAAE,OAAO,EAAE,GAAG,MAAM,CAAC;AACjC,OAAO,OAAO,MAAM,MAAM,CAAC;AAE3B,MAAM,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC;AAI3B,MAAM,CAAC,MAAM,OAAO,GAAG,CAAC,IAAgD,EAAE,EAAE,CAC1E,WAAW,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,iBAAiB,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;AAC/D;;GAEG;AACH,MAAM,CAAC,MAAM,WAAW,GAAG,CAAC,QAAa,EAA+B,EAAE;IACxE,OAAO,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;AAChC,CAAC,CAAC;AAEF;;GAEG;AACH,MAAM,CAAC,MAAM,SAAS,GAAG,CAAC,IAAkB,EAAE,EAAE;IAC9C,MAAM,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC;IAEhD,QAAQ,IAAI,CAAC,IAAI,EAAE;QACjB,KAAK,QAAQ,CAAC;QACd,KAAK,SAAS;YACZ,OAAO,QAAQ,GAAG,QAAQ,CAAC;QAE7B,KAAK,SAAS;YACZ,OAAO,SAAS,GAAG,QAAQ,CAAC;QAE9B,KAAK,OAAO;YACV,OAAO,QAAQ,CAAC,IAAI,CAAC,GAAG,QAAQ,CAAC;QAEnC,KAAK,QAAQ;YACX,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,QAAQ,CAAC,GAAG,QAAQ,CAAC;QAE5E,KAAK,QAAQ,CAAC;QACd;YACE,OAAO,SAAS,CAAC,IAAI,CAAC,GAAG,QAAQ,CAAC;KACrC;AACH,CAAC,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,GAAG,CAAC,IAA6B,EAAE,EAAE;IAC/C,IAAI,IAAI,CAAC,UAAU,CAAC,sBAAsB,CAAC,EAAE;QAC3C,OAAO,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,uBAAuB,EAAE,EAAE,CAAC,CAAC,CAAC;KAC1D;SAAM,IAAI,IAAI,CAAC,UAAU,CAAC,wBAAwB,CAAC,EAAE;QACpD,OAAO,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,yBAAyB,EAAE,EAAE,CAAC,CAAC,GAAG,UAAU,CAAC;KACzE;SAAM,IAAI,IAAI,CAAC,UAAU,CAAC,yBAAyB,CAAC,EAAE;QACrD,OAAO,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,0BAA0B,EAAE,EAAE,CAAC,CAAC,GAAG,WAAW,CAAC;KAC3E;SAAM,IAAI,IAAI,CAAC,UAAU,CAAC,4BAA4B,CAAC,EAAE;QACxD,OAAO,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,6BAA6B,EAAE,EAAE,CAAC,CAAC,GAAG,aAAa,CAAC;KAChF;SAAM;QACL,MAAM,IAAI,KAAK,CAAC,+EAA+E,CAAC,CAAC;KAClG;AACH,CAAC,CAAC;AAEF;;GAEG;AACH,MAAM,QAAQ,GAAG,CAAC,IAAkB,EAAU,EAAE;IAC9C,IAAI,IAAI,CAAC,KAAK,EAAE;QACd,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,IAAI,IAAI,CAAC,KAAK,CAAC,KAAK,IAAI,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE;YACzF,OAAO,IAAI,YAAY,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC;SAC1C;aAAM;YACL,OAAO,GAAG,YAAY,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC;SACxC;KACF;SAAM;QACL,MAAM,IAAI,KAAK,CAAC,4CAA4C,CAAC,CAAC;KAC/D;AACH,CAAC,CAAC;AAEF;;GAEG;AACH,MAAM,SAAS,GAAG,CAAC,IAAkB,EAAU,EAAE;IAC/C,IAAI,WAAW,CAAC,IAAI,CAAC,EAAE;QACrB,OAAO,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;KAC1B;IAED,IAAI,IAAI,CAAC,KAAK,EAAE;QACd,OAAO,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;KACjD;IAED,IAAI,IAAI,CAAC,KAAK,EAAE;QACd,OAAO,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;KACjD;IAED,IAAI,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,IAAI,CAAC,UAAU,IAAI,CAAC,IAAI,CAAC,oBAAoB,EAAE;QAChE,OAAO,IAAI,CAAC;KACb;IAED,6FAA6F;IAC7F,IACE,IAAI,CAAC,IAAI,KAAK,QAAQ;QACtB,CAAC,IAAI,CAAC,UAAU;QAChB,CAAC,CAAC,IAAI,CAAC,oBAAoB,IAAI,IAAI,CAAC,oBAAoB,KAAK,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC,oBAAoB,CAAC,CAAC,EACxG;QACA,OAAO,sBAAsB,CAAC;KAC/B;IAED,MAAM,gBAAgB,GAAG,4BAA4B,CAAC;IACtD,+DAA+D;IAC/D,IAAI,MAAM,GAAG,KAAK,CAAC;IACnB,IAAI,IAAI,CAAC,UAAU,EAAE;QACnB,MAAM,IAAI,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,UAAU,CAAC;aACtC,GAAG,CAAC,CAAC,CAAC,GAAG,EAAE,IAAI,CAA2C,EAAE,EAAE;YAC7D,MAAM,GAAG,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;YAC1B,MAAM,UAAU,GAAG,CAAC,IAAI,CAAC,QAAQ,IAAI,EAAE,CAAC,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;YACvD,MAAM,YAAY,GAAG,gBAAgB,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,GAAG,GAAG,CAAC;YACnE,OAAO,GAAG,GAAG,KAAK,YAAY,GAAG,UAAU,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,KAAK,YAAY,CAAC,IAAI,CAAC,GAAG,CAAC;QACnF,CAAC,CAAC;aACD,IAAI,CAAC,EAAE,CAAC,CAAC;KACb;IAED,IAAI,IAAI,CAAC,oBAAoB,EAAE;QAC7B,IAAI,IAAI,CAAC,UAAU,EAAE;YACnB,MAAM,IAAI,IAAI,CAAC;SAChB;QACD,MAAM,IAAI,wBACR,IAAI,CAAC,oBAAoB,KAAK,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,YAAY,CAAC,IAAI,CAAC,oBAAoB,CACrF,EAAE,CAAC;KACJ;IAED,IAAI,IAAI,CAAC,UAAU,IAAI,IAAI,CAAC,oBAAoB,EAAE;QAChD,IAAI,MAAM,KAAK,KAAK,EAAE;YACpB,OAAO,IAAI,CAAC;SACb;QACD,OAAO,MAAM,GAAG,KAAK,CAAC;KACvB;IAED,OAAO,IAAI,CAAC,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,sBAAsB,CAAC,CAAC,CAAC,KAAK,CAAC;AACjE,CAAC,CAAC;AAEF;;GAEG;AACH,MAAM,CAAC,MAAM,YAAY,GAAG,CAAC,MAAoB,EAAE,EAAE,CACnD,WAAW,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;AAEhE;;GAEG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAG,CAAC,WAAoB,EAAE,EAAE;IACxD,IAAI,CAAC,WAAW,EAAE;QAChB,OAAO,EAAE,CAAC;KACX;IACD,OAAO,UAAU,WAAW;SACzB,KAAK,CAAC,IAAI,CAAC;SACX,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,MAAM,CAAC,EAAE,CAAC;SACrB,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC;AACvB,CAAC,CAAC;AAEF;;GAEG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG,CAC5B,mBAA0F,EAC1F,EAAE;IACF,OAAO,IAAI,CACT,mBAAmB,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,GAAG,CAAC,EAAE,EAAE;QACnC,IAAI,CAAC,GAAG,EAAE;YACR,OAAO;SACR;QAED,IAAI,WAAW,CAAC,GAAG,CAAC,EAAE;YACpB,OAAO,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;SACzB;QAED,IAAI,GAAG,CAAC,OAAO,EAAE;YACf,KAAK,IAAI,WAAW,IAAI,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE;gBAChD,IACE,WAAW,CAAC,UAAU,CAAC,kBAAkB,CAAC;oBAC1C,WAAW,CAAC,UAAU,CAAC,0BAA0B,CAAC,EAClD;oBACA,MAAM,MAAM,GAAG,GAAG,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC,MAAO,CAAC;oBAEhD,OAAO,YAAY,CAAC,MAAM,CAAC,CAAC;iBAC7B;aACF;YACD,OAAO;SACR;QAED,OAAO;IACT,CAAC,CAAC,CACH,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;AAChB,CAAC,CAAC"}

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.1",
+  "version": "1.1.4",
   "license": "MIT",
   "type": "module",
-  "exports": "./lib/index.js",
+  "exports": "./dist/index.js",
   "files": [
     "src",
-    "lib"
+    "dist"
   ],
   "keywords": [
     "rest",

package/src/generateHooks.ts

@@ -200,12 +200,15 @@ export const createHook = ({
       ? `use${componentName}Query.baseKey()`
       : `[...use${componentName}Query.baseKey(), params]`;
 
+    const props = emptyParams ? `props?` : `{ options = {}, ...params }`;
+    const options = emptyParams ? `...props?.options:` : `...options`;
+
     const createQuery = () => `
     type ${componentName}QueryProps<T = ${responseTypes}> = ${queryParamType} {
       options?: UseQueryOptions<${responseTypes}, AxiosError, T, any> 
     }
-    export function use${componentName}Query<T = ${responseTypes}>({ options = {}, ...params }: ${componentName}QueryProps<T>) { 
-      return useQuery(use${componentName}Query.queryKey(${key}), async () => ${fetchName}(${key}), { enabled: ${enabledParam}, ...options });
+    export function use${componentName}Query<T = ${responseTypes}>(${props}: ${componentName}QueryProps<T>) { 
+      return useQuery(use${componentName}Query.queryKey(${key}), async () => ${fetchName}(${key}), { enabled: ${enabledParam}, ${options} });
     }
 
     use${componentName}Query.baseKey = (): QueryKey => ["${componentName.toLowerCase()}"];

package/lib/cjs/convertSwaggerFile.js

@@ -1,32 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.convertSwaggerFile = void 0;
-const swagger2openapi_1 = __importDefault(require("swagger2openapi"));
-const js_yaml_1 = __importDefault(require("js-yaml"));
-/**
- * Import and parse the openapi spec from a yaml/json
- */
-const convertSwaggerFile = (data, extension) => {
-    const schema = extension === 'yaml' ? js_yaml_1.default.load(data) : JSON.parse(data);
-    return new Promise((resolve, reject) => {
-        if (!schema.openapi || !schema.openapi.startsWith('3.')) {
-            swagger2openapi_1.default.convertObj(schema, {}, (err, convertedObj) => {
-                if (err) {
-                    reject(err);
-                }
-                else {
-                    // @ts-ignore
-                    convertedObj.openapi.basePath = convertedObj.original.basePath;
-                    resolve(convertedObj.openapi);
-                }
-            });
-        }
-        else {
-            resolve(schema);
-        }
-    });
-};
-exports.convertSwaggerFile = convertSwaggerFile;

package/lib/cjs/generateHooks.js

@@ -1,368 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.generateQueryHooks = exports.generateImports = void 0;
-const lodash_1 = __importDefault(require("lodash"));
-const { get, groupBy, uniq } = lodash_1.default;
-const utils_js_1 = require("./utils.js");
-const case_1 = __importDefault(require("case"));
-const { pascal } = case_1.default;
-const IdentifierRegexp = /^[a-zA-Z_$][a-zA-Z0-9_$]*$/;
-/**
- * Return every params in a path
- */
-const getParamsInPath = (path) => {
-    let n;
-    const output = [];
-    const templatePathRegex = /\{(\w+)}/g;
-    while ((n = templatePathRegex.exec(path)) !== null) {
-        output.push(n[1]);
-    }
-    return output;
-};
-const createQueryHooks = ({ componentName, responseTypes, enabledParam, emptyParams, }) => {
-    const params = emptyParams ? '' : `params: ${componentName}Params,`;
-    const key = emptyParams ? '' : `params`;
-    const mutationParams = emptyParams ? 'void' : `${componentName}Params`;
-    const queryParams = emptyParams ? '' : `${componentName}Params &`;
-    const filterParams = emptyParams
-        ? '{ filters }: { filters?: QueryFilters }'
-        : `{ params, filters }: { params: ${componentName}Params, filters }`;
-    const cacheParams = emptyParams
-        ? `{updater, options}: {updater: Updater<${responseTypes} | undefined, ${responseTypes} | undefined>, options?: SetDataOptions | undefined}`
-        : `{params, updater, options}: {params: ${componentName}Params, updater: Updater<${responseTypes} | undefined, ${responseTypes} | undefined>, options?: SetDataOptions | undefined}`;
-    const queryKey = emptyParams
-        ? `use${componentName}Query.baseKey()`
-        : `[...use${componentName}Query.baseKey(), params]`;
-    const query = `
-  use${componentName}Query.baseKey = (): QueryKey => ["${componentName.toLowerCase()}"];
-
-  use${componentName}Query.queryKey = (${params}): QueryKey => ${queryKey};
-
-  use${componentName}Query.updateCache = (${cacheParams}) => queryClient.setQueryData<${responseTypes}>(use${componentName}Query.queryKey(${key}), updater, options);
-  
-  use${componentName}Query.getQueryState = (${filterParams})=> queryClient.getQueryState<${responseTypes}>(use${componentName}Query.queryKey(${key}), filters);
-  
-  use${componentName}Query.getQueryData = (${filterParams})=> queryClient.getQueryData<${responseTypes}>(use${componentName}Query.queryKey(${key}), filters);
-  
-  use${componentName}Query.prefetch = (${params}) => queryClient.prefetchQuery<${responseTypes}>(use${componentName}Query.queryKey(${key}), ()=> use${componentName}Query.fetch(${key}));
-
-  use${componentName}Query.cancelQueries = (${params}) => queryClient.cancelQueries(use${componentName}Query.queryKey(${key}))
-
-  use${componentName}Query.invalidate = (${params}) => queryClient.invalidateQueries<${responseTypes}>(use${componentName}Query.queryKey(${key}));
-
-  use${componentName}Query.refetchStale = (${params}) => queryClient.refetchQueries<${responseTypes}>(use${componentName}Query.queryKey(${key}), { stale: true });
-
-  type ${componentName}QueryProps<T = ${responseTypes}> = ${queryParams} {
-    options?: UseQueryOptions<${responseTypes}, AxiosError, T, any> 
-  }
-  export function use${componentName}Query<T = ${responseTypes}>({ options = {}, ...params }: ${componentName}QueryProps<T>) { 
-    return useQuery(use${componentName}Query.queryKey(${key}), async () => use${componentName}Query.fetch(${key}), { enabled: ${enabledParam}, ...options });
-  }`;
-    const mutation = `
-  type ${componentName}MutationProps<T> = {
-    options?: UseMutationOptions<${responseTypes}, AxiosError, ${mutationParams}, T> 
-  }
-  export function use${componentName}Mutation<T = ${responseTypes}>(props?: ${componentName}MutationProps<T>) { 
-    return useMutation(async (${key}) => use${componentName}Query.fetch(${key}), props?.options)
-  };`;
-    return query + mutation;
-};
-/**
- * Generate a react-query component from openapi operation specs
- */
-const createHook = ({ operation, verb, route, operationIds, parameters, schemasComponents, headerFilters, }) => {
-    const { operationId = route.replace('/', '') } = operation;
-    if (operationId === '*') {
-        throw new Error(`Invalid operationId/Route set for ${verb} ${route}`);
-    }
-    if (operationIds.includes(operationId)) {
-        throw new Error(`"${operationId}" is duplicated in your schema definition!`);
-    }
-    operationIds.push(operationId);
-    route = route.replace(/\{/g, '${').replace('//', '/'); // `/pet/{id}` => `/pet/${id}`
-    // Remove the last param of the route if we are in the DELETE case
-    let lastParamInTheRoute = null;
-    const componentName = pascal(operationId);
-    const isOk = ([statusCode]) => statusCode.toString().startsWith('2');
-    const responseTypes = (0, utils_js_1.getResReqTypes)(Object.entries(operation.responses).filter(isOk)) || 'void';
-    const requestBodyTypes = (0, utils_js_1.getResReqTypes)([['body', operation.requestBody]]);
-    let imports = [responseTypes];
-    const paramsInPath = getParamsInPath(route).filter((param) => !(verb === 'delete' && param === lastParamInTheRoute));
-    const { query: queryParams = [], path: pathParams = [], header = [], } = groupBy([...(parameters || []), ...(operation.parameters || [])].map((p) => {
-        if ((0, utils_js_1.isReference)(p)) {
-            return get(schemasComponents, p.$ref.replace('#/components/', '').replace('/', '.'));
-        }
-        else {
-            return p;
-        }
-    }), 'in');
-    const headerParams = header.filter((p) => !headerFilters?.includes(p.name));
-    let enabled = [];
-    // TODO: extract all requestBody or remove useQuery variants
-    let enabledParam = '!!params';
-    [...queryParams, ...pathParams, ...headerParams].forEach((item) => {
-        if (item.required) {
-            enabled.push(`["${item.name}"]`);
-            if (enabledParam && enabledParam !== '!!params') {
-                enabledParam += `&& params['${item.name}'] != null`;
-            }
-            else {
-                enabledParam = `params['${item.name}'] != null`;
-            }
-        }
-    });
-    // `!props${enabled.join('== null && !props')}`;
-    const paramsTypes = paramsInPath
-        .map((p) => {
-        try {
-            const { name, required, schema } = pathParams.find((i) => i.name === p);
-            return `${name}${required ? '' : '?'}: ${(0, utils_js_1.resolveValue)(schema)}`;
-        }
-        catch (err) {
-            throw new Error(`The path params ${p} can't be found in parameters (${operationId})`);
-        }
-    })
-        .join('; ');
-    const queryParamsType = queryParams
-        .map((p) => {
-        const processedName = IdentifierRegexp.test(p.name) ? p.name : `"${p.name}"`;
-        return `${(0, utils_js_1.formatDescription)(p.description)}${processedName}${p.required ? '' : '?'}: ${(0, utils_js_1.resolveValue)(p.schema)}`;
-    })
-        .join(';\n  ');
-    const headerType = headerParams
-        .map((p) => {
-        try {
-            const { name, required, schema } = headerParams.find((i) => i.name === p.name);
-            return `"${name}"${required ? '' : '?'}: ${(0, utils_js_1.resolveValue)(schema)}`;
-        }
-        catch (err) {
-            throw new Error(`The path params ${p} can't be found in parameters (${operationId})`);
-        }
-    })
-        .join('; ');
-    // Retrieve the type of the param for delete verb
-    const lastParamInTheRouteDefinition = operation.parameters && lastParamInTheRoute
-        ? operation.parameters.find((p) => {
-            if ((0, utils_js_1.isReference)(p)) {
-                return false;
-            }
-            return p.name === lastParamInTheRoute;
-        }) // Reference is not possible
-        : { schema: { type: 'string' } };
-    if (!lastParamInTheRouteDefinition) {
-        throw new Error(`The path params ${lastParamInTheRoute} can't be found in parameters (${operationId})`);
-    }
-    const description = (0, utils_js_1.formatDescription)(operation.summary && operation.description
-        ? `${operation.summary}\n\n${operation.description}`
-        : `${operation.summary || ''}${operation.description || ''}`);
-    let output = `\n\n${description}`;
-    const headerParam = headerType && headerType !== 'void' ? `${headerType};` : '';
-    const queryParam = queryParamsType && queryParamsType !== 'void' ? `${queryParamsType}` : '';
-    const requestBodyComponent = requestBodyTypes && requestBodyTypes !== 'void' ? `${requestBodyTypes}` : '';
-    if (requestBodyComponent) {
-        imports.push(requestBodyComponent);
-    }
-    // QUERIES
-    if (!requestBodyComponent && !paramsInPath.length && !queryParam && !headerParam) {
-        output += `
-    // SECTION-A
-    use${componentName}Query.fetch = async () => {
-      const result = await api.${verb}<${responseTypes}>(\`${route}\`);
-      return result.data;
-    }
-    `;
-        output += createQueryHooks({ componentName, responseTypes, enabledParam, emptyParams: true });
-    }
-    if (!requestBodyComponent && paramsInPath.length && queryParam && !headerParam) {
-        output += `
-    // SECTION-B
-    type ${componentName}Params = {
-      ${paramsTypes}
-      ${queryParamsType}; 
-    }
-
-    use${componentName}Query.fetch = async (props:${componentName}Params) => {
-      const {${paramsInPath.join(', ')}, ...params} = props
-      const result = await api.${verb}<${responseTypes}>(\`${route}\`, {params})
-      return result.data;
-    }`;
-        output += createQueryHooks({ componentName, responseTypes, enabledParam });
-    }
-    if (!requestBodyComponent && paramsInPath.length && !queryParam && !headerParam) {
-        output += `
-    // SECTION-C
-    type ${componentName}Params = {
-      ${paramsTypes}
-    }
-
-    use${componentName}Query.fetch = async (props: ${componentName}Params ) => {
-      const result = await api.${verb}<${responseTypes}>(\`${route.replace(/\{/g, '{props.')}\`);
-      return result.data;
-    }
-    `;
-        output += createQueryHooks({ componentName, responseTypes, enabledParam });
-    }
-    if (!requestBodyComponent && !paramsInPath.length && queryParam && !headerParam) {
-        output += `
-    // SECTION-D
-    type ${componentName}Params = { 
-      ${queryParamsType} 
-    }
-
-    use${componentName}Query.fetch = async (props: ${componentName}Params) => {
-      const result = await api.${verb}<${responseTypes}>(\`${route}\`, {params: props})
-      return result.data;
-    }
-    `;
-        output += createQueryHooks({ componentName, responseTypes, enabledParam });
-    }
-    if (requestBodyComponent && !paramsInPath.length && !queryParam && !headerParam) {
-        output += `
-    // SECTION-E
-    type ${componentName}Params = ${requestBodyComponent}
-
-    use${componentName}Query.fetch = async (body: ${componentName}Params) => {
-      const result = await api.${verb}<${responseTypes}>(\`${route}\`, body)
-        return result.data
-      }
-      
-      `;
-        output += createQueryHooks({ componentName, responseTypes, enabledParam });
-    }
-    if (requestBodyComponent && !paramsInPath.length && queryParam && !headerParam) {
-        output += `
-    // SECTION-G
-    // TODO: LOOKS BROKEN
-    type ${componentName}Params = {
-      body: ${requestBodyComponent} 
-      queryParams: ${queryParamsType} 
-    }
-
-    type ${componentName}QueryProps<T = ${responseTypes}> = ${componentName}Params & {
-      options?: UseQueryOptions<${responseTypes}, AxiosError, T, any> 
-    }
-
-    use${componentName}Query.fetch = async ({body, queryParams}: ${componentName}Params) => {   
-      const result = await api.${verb}<${responseTypes}>(\`${route}\`, body, {params: queryParams})
-      return result.data
-    }
-    `;
-        output += createQueryHooks({ componentName, responseTypes, enabledParam });
-    }
-    if (!requestBodyComponent && !paramsInPath.length && !queryParam && headerParam) {
-        output += `
-    // SECTION-H
-    type ${componentName}Params = {
-      ${headerParam}
-    };
-
-    use${componentName}Query.fetch = async (headers: ${componentName}Params) => {
-      const result = await api.${verb}<${responseTypes}>(\`${route}\`, {headers});
-      return result.data;
-    }
-    `;
-        output += createQueryHooks({ componentName, responseTypes, enabledParam });
-    }
-    if (requestBodyComponent && !paramsInPath.length && !queryParam && headerParam) {
-        output += `
-    // SECTION-J
-    type ${componentName}Params = {
-      body: ${requestBodyComponent}
-      headers: {${headerParam}}
-    };
-
-    use${componentName}Query.fetch = async ({headers, body}: ${componentName}Params) => {
-      const result = await api.${verb}<${responseTypes}>(\`${route}\`, body, {headers})
-        return result.data
-      }`;
-        output += createQueryHooks({ componentName, responseTypes, enabledParam });
-    }
-    if (!requestBodyComponent && !paramsInPath.length && queryParam && headerParam) {
-        output += `
-    // SECTION-K
-    type ${componentName}Params = {
-      headers: {${headerParam}}
-      queryParams: {${queryParamsType} }
-    }
-    use${componentName}Query.fetch = async ({headers, queryParams}: ${componentName}Params) => {
-      const result = await api.${verb}<${responseTypes}>(\`${route}\`, body, {headers, params: queryParams})
-        return result.data
-      }`;
-        output += createQueryHooks({ componentName, responseTypes, enabledParam });
-    }
-    if (requestBodyComponent && paramsInPath.length && !queryParam && !headerParam) {
-        output += `// TODO: NOT SUPPORTED requestBodyComponent && paramsInPath)`;
-    }
-    if (requestBodyComponent && paramsInPath.length && queryParam && !headerParam) {
-        output += `// TODO: NOT SUPPORTED requestBodyComponent && paramsInPath && queryParam)`;
-    }
-    if (requestBodyComponent && !paramsInPath.length && queryParam && headerParam) {
-        output += `// TODO: NOT SUPPORTED requestBodyComponent && queryParam && headerParam)`;
-    }
-    if (requestBodyComponent && paramsInPath.length && queryParam && headerParam) {
-        output += `// TODO: NOT SUPPORTED requestBodyComponent && paramsInPath && queryParam && headerParam)`;
-    }
-    if (!requestBodyComponent && paramsInPath.length && !queryParam && headerParam) {
-        output += `// TODO: NOT SUPPORTED (paramsInPath && headerParam)`;
-    }
-    if (!requestBodyComponent && paramsInPath.length && queryParam && headerParam) {
-        output += `// TODO: NOT SUPPORTED (paramsInPath && queryParam && headerParam)`;
-    }
-    if (requestBodyComponent && paramsInPath.length && !queryParam && headerParam) {
-        output += `// TODO: NOT SUPPORTED (requestBodyComponent && paramsInPath && headerParam)`;
-    }
-    return { implementation: output, imports };
-};
-const generateImports = ({ schemaName, apiDirectory, queryClientDir, schemaImports, }) => {
-    const importTypes = schemaImports.join(',');
-    return `
-  import {
-    useQuery,
-    useMutation,
-    UseQueryOptions,
-    UseMutationOptions,
-    QueryKey,
-    SetDataOptions,
-    QueryFilters
-  } from '@tanstack/react-query';
-  
-  import { AxiosError } from 'axios';
-  import { api } from '${apiDirectory}';
-  import { queryClient } from '${queryClientDir}';
-
-  import {${importTypes}} from './${schemaName}'
-
-  type Updater<TInput, TOutput> = TOutput | ((input: TInput) => TOutput);  
-  `;
-};
-exports.generateImports = generateImports;
-const generateQueryHooks = ({ spec, operationIds, headerFilters, }) => {
-    const { paths, components } = spec;
-    let hooks = '';
-    let schemaImports = [];
-    Object.entries(paths).forEach(([route, verbs]) => {
-        Object.entries(verbs).forEach(([verb, operation]) => {
-            if (['get', 'post', 'patch', 'put', 'delete'].includes(verb) && !operation.deprecated) {
-                const { implementation, imports } = createHook({
-                    operation,
-                    verb,
-                    route: spec.basePath + route,
-                    operationIds,
-                    parameters: verbs.parameters,
-                    schemasComponents: components,
-                    headerFilters,
-                });
-                hooks += implementation;
-                imports.forEach((element) => {
-                    schemaImports.push(element.replace('[]', ''));
-                });
-            }
-        });
-    });
-    const schemaImportsFiltered = schemaImports.filter((item) => !!item && item !== 'void' && item !== 'boolean' && item !== 'undefined' && item !== 'string');
-    return { implementation: hooks, schemaImports: uniq(schemaImportsFiltered) };
-};
-exports.generateQueryHooks = generateQueryHooks;