react-query-lightbase-codegen 1.0.0 → 1.0.1

package/lib/{cjs → src}/utils.js

@@ -1,27 +1,26 @@
 "use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
+exports.__esModule = true;
 exports.getResReqTypes = exports.formatDescription = exports.resolveValue = exports.getScalar = exports.isReference = exports.getDocs = void 0;
-const lodash_1 = __importDefault(require("lodash"));
-const { uniq, isEmpty } = lodash_1.default;
-const case_1 = __importDefault(require("case"));
-const { pascal } = case_1.default;
-const getDocs = (data) => (0, exports.isReference)(data) ? '' : (0, exports.formatDescription)(data.description);
+var lodash_1 = require("lodash");
+var uniq = lodash_1["default"].uniq, isEmpty = lodash_1["default"].isEmpty;
+var case_1 = require("case");
+var pascal = case_1["default"].pascal;
+var getDocs = function (data) {
+    return (0, exports.isReference)(data) ? '' : (0, exports.formatDescription)(data.description);
+};
 exports.getDocs = getDocs;
 /**
  * Discriminator helper for `ReferenceObject`
  */
-const isReference = (property) => {
+var isReference = function (property) {
     return Boolean(property.$ref);
 };
 exports.isReference = isReference;
 /**
  * Return the typescript equivalent of open-api data type
  */
-const getScalar = (item) => {
-    const nullable = item.nullable ? ' | null' : '';
+var getScalar = function (item) {
+    var nullable = item.nullable ? ' | null' : '';
     switch (item.type) {
         case 'number':
         case 'integer':
@@ -31,7 +30,7 @@ const getScalar = (item) => {
         case 'array':
             return getArray(item) + nullable;
         case 'string':
-            return (item.enum ? `"${item.enum.join(`" | "`)}"` : 'string') + nullable;
+            return (item["enum"] ? "\"".concat(item["enum"].join("\" | \""), "\"") : 'string') + nullable;
         case 'object':
         default:
             return getObject(item) + nullable;
@@ -41,7 +40,7 @@ exports.getScalar = getScalar;
 /**
  * Return the output type from the $ref
  */
-const getRef = ($ref) => {
+var getRef = function ($ref) {
     if ($ref.startsWith('#/components/schemas')) {
         return pascal($ref.replace('#/components/schemas/', ''));
     }
@@ -61,13 +60,13 @@ const getRef = ($ref) => {
 /**
  * Return the output type from an array
  */
-const getArray = (item) => {
+var getArray = function (item) {
     if (item.items) {
-        if (!(0, exports.isReference)(item.items) && (item.items.oneOf || item.items.allOf || item.items.enum)) {
-            return `(${(0, exports.resolveValue)(item.items)})[]`;
+        if (!(0, exports.isReference)(item.items) && (item.items.oneOf || item.items.allOf || item.items["enum"])) {
+            return "(".concat((0, exports.resolveValue)(item.items), ")[]");
         }
         else {
-            return `${(0, exports.resolveValue)(item.items)}[]`;
+            return "".concat((0, exports.resolveValue)(item.items), "[]");
         }
     }
     else {
@@ -77,7 +76,7 @@ const getArray = (item) => {
 /**
  * Return the output type from an object
  */
-const getObject = (item) => {
+var getObject = function (item) {
     if ((0, exports.isReference)(item)) {
         return getRef(item.$ref);
     }
@@ -96,16 +95,17 @@ const getObject = (item) => {
         (!item.additionalProperties || item.additionalProperties === true || isEmpty(item.additionalProperties))) {
         return '{[key: string]: any}';
     }
-    const IdentifierRegexp = /^[a-zA-Z_$][a-zA-Z0-9_$]*$/;
+    var IdentifierRegexp = /^[a-zA-Z_$][a-zA-Z0-9_$]*$/;
     // Consolidation of item.properties & item.additionalProperties
-    let output = '{\n';
+    var output = '{\n';
     if (item.properties) {
         output += Object.entries(item.properties)
-            .map(([key, prop]) => {
-            const doc = (0, exports.getDocs)(prop);
-            const isRequired = (item.required || []).includes(key);
-            const processedKey = IdentifierRegexp.test(key) ? key : `"${key}"`;
-            return `${doc}\n${processedKey}${isRequired ? '' : '?'}: ${(0, exports.resolveValue)(prop)};`;
+            .map(function (_a) {
+            var key = _a[0], prop = _a[1];
+            var doc = (0, exports.getDocs)(prop);
+            var isRequired = (item.required || []).includes(key);
+            var processedKey = IdentifierRegexp.test(key) ? key : "\"".concat(key, "\"");
+            return "".concat(doc, "\n").concat(processedKey).concat(isRequired ? '' : '?', ": ").concat((0, exports.resolveValue)(prop), ";");
         })
             .join('');
     }
@@ -113,7 +113,7 @@ const getObject = (item) => {
         if (item.properties) {
             output += '\n';
         }
-        output += `} & { [key: string]: ${item.additionalProperties === true ? 'any' : (0, exports.resolveValue)(item.additionalProperties)}`;
+        output += "} & { [key: string]: ".concat(item.additionalProperties === true ? 'any' : (0, exports.resolveValue)(item.additionalProperties));
     }
     if (item.properties || item.additionalProperties) {
         if (output === '{\n') {
@@ -126,26 +126,29 @@ const getObject = (item) => {
 /**
  * Resolve the value of a schema object to a proper type definition.
  */
-const resolveValue = (schema) => (0, exports.isReference)(schema) ? getRef(schema.$ref) : (0, exports.getScalar)(schema);
+var resolveValue = function (schema) {
+    return (0, exports.isReference)(schema) ? getRef(schema.$ref) : (0, exports.getScalar)(schema);
+};
 exports.resolveValue = resolveValue;
 /**
  * Format a description to code documentation.
  */
-const formatDescription = (description) => {
+var formatDescription = function (description) {
     if (!description) {
         return '';
     }
-    return `\n/**\n${description
+    return "\n/**\n".concat(description
         .split('\n')
-        .map((i) => `*  ${i}`)
-        .join('\n')}\n */`;
+        .map(function (i) { return "*  ".concat(i); })
+        .join('\n'), "\n */");
 };
 exports.formatDescription = formatDescription;
 /**
  * Extract responses / request types from open-api specs
  */
-const getResReqTypes = (responsesOrRequests) => {
-    return uniq(responsesOrRequests.map(([_, res]) => {
+var getResReqTypes = function (responsesOrRequests) {
+    return uniq(responsesOrRequests.map(function (_a) {
+        var _ = _a[0], res = _a[1];
         if (!res) {
             return;
         }
@@ -153,10 +156,11 @@ const getResReqTypes = (responsesOrRequests) => {
             return getRef(res.$ref);
         }
         if (res.content) {
-            for (let contentType of Object.keys(res.content)) {
+            for (var _i = 0, _b = Object.keys(res.content); _i < _b.length; _i++) {
+                var contentType = _b[_i];
                 if (contentType.startsWith('application/json') ||
                     contentType.startsWith('application/octet-stream')) {
-                    const schema = res.content[contentType].schema;
+                    var schema = res.content[contentType].schema;
                     return (0, exports.resolveValue)(schema);
                 }
             }

package/lib/typescript/convertSwaggerFile.d.ts

@@ -0,0 +1,5 @@
+import { OpenAPIObject } from 'openapi3-ts';
+/**
+ * Import and parse the openapi spec from a yaml/json
+ */
+export declare const convertSwaggerFile: (data: string, extension: 'yaml' | 'json') => Promise<OpenAPIObject>;

package/lib/typescript/generateHooks.d.ts

@@ -0,0 +1,25 @@
+import { ComponentsObject, OperationObject, ParameterObject, ReferenceObject } from 'openapi3-ts';
+/**
+ * Generate a react-query component from openapi operation specs
+ */
+export declare const createHook: ({ operation, verb, route, operationIds, parameters, schemasComponents, headerFilters, overrides, }: {
+    operation: OperationObject;
+    verb: string;
+    route: string;
+    operationIds: string[];
+    parameters: (ReferenceObject | ParameterObject)[] | undefined;
+    schemasComponents?: ComponentsObject | undefined;
+    headerFilters?: string[] | undefined;
+    overrides?: Record<string, {
+        type: 'query';
+    } | {
+        type: 'mutation';
+    } | {
+        type: 'infiniteQuery';
+        infiniteQueryParm: string;
+    }> | undefined;
+}) => {
+    implementation: string;
+    imports: string[];
+    queryImports: ("query" | "mutation" | "infiniteQuery")[];
+};

package/lib/typescript/generateImports.d.ts

@@ -0,0 +1,7 @@
+export declare const generateImports: ({ schemaName, apiDirectory, queryClientDir, schemaImports, queryImports, }: {
+    apiDirectory: string;
+    queryClientDir: string;
+    schemaName: string;
+    schemaImports: string[];
+    queryImports: ('query' | 'mutation' | 'infiniteQuery')[];
+}) => string;

package/lib/typescript/generateSchemas.d.ts

@@ -0,0 +1,7 @@
+import { OpenAPIObject } from 'openapi3-ts';
+/**
+ * Extract all types from #/components/schemas
+ */
+export declare const generateSchemas: ({ spec }: {
+    spec: OpenAPIObject;
+}) => string;

package/lib/typescript/importSpecs.d.ts

@@ -0,0 +1,15 @@
+export declare function importSpecs({ sourceDirectory, exportDirectory, apiDirectory, queryClientDir, headerFilters, overrides, }: {
+    sourceDirectory: string;
+    exportDirectory: string;
+    apiDirectory: string;
+    queryClientDir: string;
+    headerFilters?: string[];
+    overrides?: Record<string, {
+        type: 'query';
+    } | {
+        type: 'mutation';
+    } | {
+        type: 'infiniteQuery';
+        infiniteQueryParm: string;
+    }>;
+}): void;

package/lib/typescript/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/package.json

@@ -1,12 +1,16 @@
 {
   "name": "react-query-lightbase-codegen",
   "description": "Fully typed react query code generation tool based on openApi specifications",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "license": "MIT",
   "type": "module",
   "exports": "./src/index.js",
   "files": [
-    "lib/"
+    "src",
+    "lib",
+    "!**/__tests__",
+    "!**/__fixtures__",
+    "!**/__mocks__"
   ],
   "keywords": [
     "rest",
@@ -36,13 +40,13 @@
   "scripts": {
     "lint": "eslint . --ext .js,.jsx,.ts,.tsx",
     "tsc": "tsc -p tsconfig.json && tsc -p tsconfig-cjs.json",
-    "test": "yarn tsc && node test/script.mjs && prettier --check ./test/generated/**/*.tsx --write && eslint ./test/generated/**/*.tsx --fix",
-    "prepare": "husky install"
+    "test": "node test/script.mjs && prettier --check ./test/generated/**/*.tsx --write && eslint ./test/generated/**/*.tsx --fix",
+    "prepare": "bob build"
   },
   "dependencies": {
     "axios": "0.27.2",
     "case": "1.6.3",
-    "chalk": "5.0.1",
+    "chalk": "4.1.2",
     "js-yaml": "4.1.0",
     "lodash": "4.17.21",
     "openapi3-ts": "2.0.2",
@@ -71,7 +75,23 @@
     "husky": "^8.0.1",
     "prettier": "2.7.1",
     "react": "17.0.2",
+    "react-native-builder-bob": "^0.18.3",
     "semantic-release": "^19.0.3",
     "typescript": "4.7.4"
-  }
+  },
+  "main": "lib/commonjs/index.js",
+  "react-native": "src/index.ts",
+  "types": "lib/typescript/src/index.d.ts",
+  "react-native-builder-bob": {
+    "source": "src",
+    "output": "lib",
+    "targets": [
+      "commonjs",
+      "typescript"
+    ]
+  },
+  "eslintIgnore": [
+    "node_modules/",
+    "lib/"
+  ]
 }

package/src/convertSwaggerFile.ts

@@ -0,0 +1,25 @@
+import { OpenAPIObject } from 'openapi3-ts';
+import swagger2openapi from 'swagger2openapi';
+import yaml from 'js-yaml';
+
+/**
+ * Import and parse the openapi spec from a yaml/json
+ */
+export const convertSwaggerFile = (data: string, extension: 'yaml' | 'json'): Promise<OpenAPIObject> => {
+  const schema = extension === 'yaml' ? yaml.load(data) : JSON.parse(data);
+  return new Promise((resolve, reject) => {
+    if (!schema.openapi || !schema.openapi.startsWith('3.')) {
+      swagger2openapi.convertObj(schema, {}, (err, convertedObj) => {
+        if (err) {
+          reject(err);
+        } else {
+          // @ts-ignore
+          convertedObj.openapi.basePath = convertedObj.original.basePath;
+          resolve(convertedObj.openapi);
+        }
+      });
+    } else {
+      resolve(schema);
+    }
+  });
+};