@tracktor/shared-module 0.9.5 → 0.10.0

package/CHANGELOG.md

@@ -1,4 +1,5 @@
 # [Versions](https://github.com/Tracktor/shared-module/releases)
 
-## v0.9.5
-- **[improvement]** : `MaskTextField` component
+## v0.10.0
+- **[feat]** : Add new function `getOrvalConfig` to get orval config 
+- **[chore]** : Upgrade dev dependencies

package/dist/config/orval/index.d.ts

@@ -0,0 +1,2 @@
+import Orval from "./orval";
+export default Orval;

package/dist/config/orval/mutator/axiosCustomInstance.d.ts

@@ -0,0 +1,5 @@
+import { AxiosError } from "axios";
+export declare const axiosCustomInstance: <T>(config: AxiosRequestConfig) => Promise<T>;
+export default axiosCustomInstance;
+export interface ErrorType<Error> extends AxiosError<Error> {
+}

package/dist/config/orval/mutator/axiosCustomInstance.ts

@@ -0,0 +1,21 @@
+// @ts-ignore
+import axios, { AxiosError, AxiosRequestConfig } from "axios";
+
+axios.create();
+
+export const axiosCustomInstance = <T>(config: AxiosRequestConfig): Promise<T> => {
+  const source = axios.CancelToken.source();
+  // @ts-ignore
+  const promise = axios({ ...config, cancelToken: source.token }).then(({ data }) => data);
+
+  // @ts-ignore
+  promise.cancel = () => {
+    source.cancel("Query was cancelled.");
+  };
+
+  return promise;
+};
+
+export default axiosCustomInstance;
+
+export interface ErrorType<Error> extends AxiosError<Error> {}

package/dist/config/orval/orval.d.ts

@@ -0,0 +1,44 @@
+/**
+ * Convert a string to capitalize
+ * @param method
+ */
+export declare const convertToCapitalize: (method: string) => string;
+/**
+ * Convert a route to camelCase
+ * @param route
+ */
+export declare const convertRouteToCamelCase: (route: string) => string;
+/**
+ * Generate the operation name for orval output
+ * @param _
+ * @param route
+ * @param method
+ */
+export declare const getOrvalOperationName: (_: any, route: string, method: string) => string;
+/**
+ * Get the orval config required for the generation
+ * @param operationsToUseInfiniteQuery
+ */
+export declare const getOrvalConfig: (operationsToUseInfiniteQuery?: string[]) => {
+    readonly api: {
+        readonly input: "./openapi.json";
+        readonly output: {
+            readonly client: "react-query";
+            readonly mode: "tags-split";
+            readonly override: {
+                readonly query: {
+                    readonly useQuery: true;
+                };
+                readonly operations?: Record<string, {}> | undefined;
+                readonly mutator: {
+                    readonly name: "axiosCustomInstance";
+                    readonly path: `${string}/config/orval/mutator/axiosCustomInstance.ts`;
+                };
+                readonly operationName: (_: any, route: string, method: string) => string;
+            };
+            readonly schemas: "src/api/model";
+            readonly target: "src/api/services/api.ts";
+        };
+    };
+};
+export default getOrvalConfig;

package/dist/main.d.ts

@@ -20,5 +20,5 @@ export { default as useResponseError } from './hooks/useResponseError';
 export * from './hooks/useResponseError';
 export { default as useInfiniteDataGrid } from './hooks/useInfiniteDataGrid';
 export * from './hooks/useInfiniteDataGrid';
-export { default as getOrvalOperationName } from './config/orval';
+export { default as getOrvalConfig } from './config/orval';
 export * from './config/orval';