typedapi-client-helpers 0.1.5 → 0.1.7

package/dist/index.js

@@ -73,7 +73,7 @@ function isCallback(value) {
 function isRequestParams(value) {
   return typeof value === "object" && value !== null && !Array.isArray(value);
 }
-function extractArgsCallbacksAndParams(argsWithCallbacks) {
+function extractArgsToastsAndParams(argsWithCallbacks) {
   const values = [...argsWithCallbacks];
   let onSuccess;
   let onError;
@@ -101,6 +101,41 @@ function extractArgsCallbacksAndParams(argsWithCallbacks) {
   };
 }
 
+// src/utils/extractArgsCallbacksAndParams.ts
+function isCallback2(value) {
+  return typeof value === "function";
+}
+function isRequestParams2(value) {
+  return typeof value === "object" && value !== null && !Array.isArray(value);
+}
+function extractArgsCallbacksAndParams(argsWithCallbacks) {
+  const values = [...argsWithCallbacks];
+  let onSuccess;
+  let onError;
+  let params;
+  let lastArgument = values[values.length - 1];
+  if (isRequestParams2(lastArgument)) {
+    params = lastArgument;
+    values.pop();
+  }
+  lastArgument = values[values.length - 1];
+  if (isCallback2(lastArgument)) {
+    onError = lastArgument;
+    values.pop();
+  }
+  lastArgument = values[values.length - 1];
+  if (isCallback2(lastArgument)) {
+    onSuccess = lastArgument;
+    values.pop();
+  }
+  return {
+    args: values,
+    onSuccess,
+    onError,
+    params
+  };
+}
+
 // src/utils/handleApiResponse.ts
 async function readResponseBody(response) {
   if (response.status === 204) {
@@ -122,29 +157,32 @@ async function handleApiResponse(call, options) {
     response = await call();
     const data = await readResponseBody(response);
     if (response.ok) {
-      await options?.onSuccess?.(data);
-      return {
+      const result2 = {
         ok: true,
         status: response.status,
         response: data
       };
+      await options?.onSuccess?.(result2);
+      return result2;
     }
     const errorData = data;
-    await options?.onError?.(errorData);
-    return {
+    const result = {
       ok: false,
       status: response.status,
       response: data,
       error: errorData
     };
+    await options?.onError?.(result);
+    return result;
   } catch (error) {
-    await options?.onError?.(error);
-    return {
+    const result = {
       ok: false,
       status: error instanceof Response ? error.status : response?.status ?? 0,
       response: void 0,
       error
     };
+    await options?.onError?.(result);
+    return result;
   }
 }
 
@@ -179,514 +217,6 @@ function getSortDirectionFromSortType(sortType) {
   }
 }
 
-// src/api/generated/http-client.ts
-var HttpClient = class {
-  constructor(apiConfig = {}) {
-    this.baseUrl = "https://localhost:7000";
-    this.securityData = null;
-    this.abortControllers = /* @__PURE__ */ new Map();
-    this.customFetch = (...fetchParams) => fetch(...fetchParams);
-    this.baseApiParams = {
-      credentials: "same-origin",
-      headers: {},
-      redirect: "follow",
-      referrerPolicy: "no-referrer"
-    };
-    this.setSecurityData = (data) => {
-      this.securityData = data;
-    };
-    this.contentFormatters = {
-      ["application/json" /* Json */]: (input) => input !== null && (typeof input === "object" || typeof input === "string") ? JSON.stringify(input) : input,
-      ["application/vnd.api+json" /* JsonApi */]: (input) => input !== null && (typeof input === "object" || typeof input === "string") ? JSON.stringify(input) : input,
-      ["text/plain" /* Text */]: (input) => input !== null && typeof input !== "string" ? JSON.stringify(input) : input,
-      ["multipart/form-data" /* FormData */]: (input) => {
-        if (input instanceof FormData) {
-          return input;
-        }
-        return Object.keys(input || {}).reduce((formData, key) => {
-          const property = input[key];
-          formData.append(
-            key,
-            property instanceof Blob ? property : typeof property === "object" && property !== null ? JSON.stringify(property) : `${property}`
-          );
-          return formData;
-        }, new FormData());
-      },
-      ["application/x-www-form-urlencoded" /* UrlEncoded */]: (input) => this.toQueryString(input)
-    };
-    this.createAbortSignal = (cancelToken) => {
-      if (this.abortControllers.has(cancelToken)) {
-        const abortController2 = this.abortControllers.get(cancelToken);
-        if (abortController2) {
-          return abortController2.signal;
-        }
-        return void 0;
-      }
-      const abortController = new AbortController();
-      this.abortControllers.set(cancelToken, abortController);
-      return abortController.signal;
-    };
-    this.abortRequest = (cancelToken) => {
-      const abortController = this.abortControllers.get(cancelToken);
-      if (abortController) {
-        abortController.abort();
-        this.abortControllers.delete(cancelToken);
-      }
-    };
-    this.request = async ({
-      body,
-      secure,
-      path,
-      type,
-      query,
-      format,
-      baseUrl,
-      cancelToken,
-      ...params
-    }) => {
-      const secureParams = (typeof secure === "boolean" ? secure : this.baseApiParams.secure) && this.securityWorker && await this.securityWorker(this.securityData) || {};
-      const requestParams = this.mergeRequestParams(params, secureParams);
-      const queryString = query && this.toQueryString(query);
-      const payloadFormatter = this.contentFormatters[type || "application/json" /* Json */];
-      const responseFormat = format || requestParams.format;
-      return this.customFetch(
-        `${baseUrl || this.baseUrl || ""}${path}${queryString ? `?${queryString}` : ""}`,
-        {
-          ...requestParams,
-          headers: {
-            ...requestParams.headers || {},
-            ...type && type !== "multipart/form-data" /* FormData */ ? { "Content-Type": type } : {}
-          },
-          signal: (cancelToken ? this.createAbortSignal(cancelToken) : requestParams.signal) || null,
-          body: typeof body === "undefined" || body === null ? null : payloadFormatter(body)
-        }
-      ).then(async (response) => {
-        const r = response;
-        r.data = null;
-        r.error = null;
-        const responseToParse = responseFormat ? response.clone() : response;
-        const data = !responseFormat ? r : await responseToParse[responseFormat]().then((data2) => {
-          if (r.ok) {
-            r.data = data2;
-          } else {
-            r.error = data2;
-          }
-          return r;
-        }).catch((e) => {
-          r.error = e;
-          return r;
-        });
-        if (cancelToken) {
-          this.abortControllers.delete(cancelToken);
-        }
-        if (!response.ok) throw data;
-        return data;
-      });
-    };
-    Object.assign(this, apiConfig);
-  }
-  encodeQueryParam(key, value) {
-    const encodedKey = encodeURIComponent(key);
-    return `${encodedKey}=${encodeURIComponent(typeof value === "number" ? value : `${value}`)}`;
-  }
-  addQueryParam(query, key) {
-    return this.encodeQueryParam(key, query[key]);
-  }
-  addArrayQueryParam(query, key) {
-    const value = query[key];
-    return value.map((v) => this.encodeQueryParam(key, v)).join("&");
-  }
-  toQueryString(rawQuery) {
-    const query = rawQuery || {};
-    const keys = Object.keys(query).filter(
-      (key) => "undefined" !== typeof query[key]
-    );
-    return keys.map(
-      (key) => Array.isArray(query[key]) ? this.addArrayQueryParam(query, key) : this.addQueryParam(query, key)
-    ).join("&");
-  }
-  addQueryParams(rawQuery) {
-    const queryString = this.toQueryString(rawQuery);
-    return queryString ? `?${queryString}` : "";
-  }
-  mergeRequestParams(params1, params2) {
-    return {
-      ...this.baseApiParams,
-      ...params1,
-      ...params2 || {},
-      headers: {
-        ...this.baseApiParams.headers || {},
-        ...params1.headers || {},
-        ...params2 && params2.headers || {}
-      }
-    };
-  }
-};
-
-// src/api/generated/Import.ts
-var Import = class extends HttpClient {
-  constructor() {
-    super(...arguments);
-    /**
-     * No description
-     *
-     * @tags Import
-     * @name UploadProductFile
-     * @request POST:/api/import/products
-     */
-    this.uploadProductFile = (data, params = {}) => this.request({
-      path: `/api/import/products`,
-      method: "POST",
-      body: data,
-      type: "multipart/form-data" /* FormData */,
-      format: "json",
-      ...params
-    });
-    /**
-     * No description
-     *
-     * @tags Import
-     * @name UploadSupplierFile
-     * @request POST:/api/import/suppliers
-     */
-    this.uploadSupplierFile = (data, params = {}) => this.request({
-      path: `/api/import/suppliers`,
-      method: "POST",
-      body: data,
-      type: "multipart/form-data" /* FormData */,
-      format: "json",
-      ...params
-    });
-  }
-};
-
-// src/api/methods/Import.api.ts
-var importApi = new Import();
-
-// src/api/generated/Order.ts
-var Order = class extends HttpClient {
-  constructor() {
-    super(...arguments);
-    /**
-     * No description
-     *
-     * @tags Order
-     * @name GetOrders
-     * @request GET:/api/orders
-     */
-    this.getOrders = (query = {}, params = {}) => this.request({
-      path: `/api/orders`,
-      method: "GET",
-      query,
-      format: "json",
-      ...params
-    });
-    /**
-     * No description
-     *
-     * @tags Order
-     * @name CreateOrder
-     * @request POST:/api/orders
-     */
-    this.createOrder = (data, params = {}) => this.request({
-      path: `/api/orders`,
-      method: "POST",
-      body: data,
-      type: "application/json" /* Json */,
-      format: "json",
-      ...params
-    });
-    /**
-     * No description
-     *
-     * @tags Order
-     * @name GetOrderById
-     * @request GET:/api/orders/{id}
-     */
-    this.getOrderById = ({ id }, params = {}) => this.request({
-      path: `/api/orders/${id}`,
-      method: "GET",
-      format: "json",
-      ...params
-    });
-    /**
-     * No description
-     *
-     * @tags Order
-     * @name ApproveOrder
-     * @request PUT:/api/orders/{id}/approve
-     */
-    this.approveOrder = ({ id }, data, params = {}) => this.request({
-      path: `/api/orders/${id}/approve`,
-      method: "PUT",
-      body: data,
-      type: "application/json" /* Json */,
-      format: "json",
-      ...params
-    });
-  }
-};
-
-// src/api/methods/Order.api.ts
-var orderApi = new Order();
-async function getOrders(query, onSuccess, onError, params) {
-  return handleApiResponse(
-    () => orderApi.getOrders(query, params ?? {}),
-    { onSuccess, onError }
-  );
-}
-
-// src/api/generated/Product.ts
-var Product = class extends HttpClient {
-  constructor() {
-    super(...arguments);
-    /**
-     * No description
-     *
-     * @tags Product
-     * @name GetProducts
-     * @request GET:/api/products
-     */
-    this.getProducts = (query = {}, params = {}) => this.request({
-      path: `/api/products`,
-      method: "GET",
-      query,
-      format: "json",
-      ...params
-    });
-    /**
-     * No description
-     *
-     * @tags Product
-     * @name CreateProduct
-     * @request POST:/api/products
-     */
-    this.createProduct = (data, params = {}) => this.request({
-      path: `/api/products`,
-      method: "POST",
-      body: data,
-      type: "application/json" /* Json */,
-      format: "json",
-      ...params
-    });
-    /**
-     * No description
-     *
-     * @tags Product
-     * @name GetProductById
-     * @request GET:/api/products/{id}
-     */
-    this.getProductById = ({ id }, params = {}) => this.request({
-      path: `/api/products/${id}`,
-      method: "GET",
-      format: "json",
-      ...params
-    });
-    /**
-     * No description
-     *
-     * @tags Product
-     * @name UpdateProduct
-     * @request PUT:/api/products/{id}
-     */
-    this.updateProduct = ({ id }, data, params = {}) => this.request({
-      path: `/api/products/${id}`,
-      method: "PUT",
-      body: data,
-      type: "application/json" /* Json */,
-      format: "json",
-      ...params
-    });
-    /**
-     * No description
-     *
-     * @tags Product
-     * @name DeleteProduct
-     * @request DELETE:/api/products/{id}
-     */
-    this.deleteProduct = ({ id }, params = {}) => this.request({
-      path: `/api/products/${id}`,
-      method: "DELETE",
-      ...params
-    });
-    /**
-     * No description
-     *
-     * @tags Product
-     * @name SearchProducts
-     * @request GET:/api/products/search
-     */
-    this.searchProducts = (query = {}, params = {}) => this.request({
-      path: `/api/products/search`,
-      method: "GET",
-      query,
-      format: "json",
-      ...params
-    });
-    /**
-     * No description
-     *
-     * @tags Product
-     * @name ExportProducts
-     * @request GET:/api/products/export
-     */
-    this.exportProducts = (query = {}, params = {}) => this.request({
-      path: `/api/products/export`,
-      method: "GET",
-      query,
-      ...params
-    });
-  }
-};
-
-// src/api/methods/Product.api.ts
-var productApi = new Product();
-
-// src/api/generated/Report.ts
-var Report = class extends HttpClient {
-  constructor() {
-    super(...arguments);
-    /**
-     * No description
-     *
-     * @tags Report
-     * @name GetInventorySummary
-     * @request GET:/api/reports/summary
-     */
-    this.getInventorySummary = (query = {}, params = {}) => this.request({
-      path: `/api/reports/summary`,
-      method: "GET",
-      query,
-      format: "json",
-      ...params
-    });
-  }
-};
-
-// src/api/methods/Report.api.ts
-var reportApi = new Report();
-
-// src/api/generated/Supplier.ts
-var Supplier = class extends HttpClient {
-  constructor() {
-    super(...arguments);
-    /**
-     * No description
-     *
-     * @tags Supplier
-     * @name GetSuppliers
-     * @request GET:/api/suppliers
-     */
-    this.getSuppliers = (query = {}, params = {}) => this.request({
-      path: `/api/suppliers`,
-      method: "GET",
-      query,
-      format: "json",
-      ...params
-    });
-    /**
-     * No description
-     *
-     * @tags Supplier
-     * @name CreateSupplier
-     * @request POST:/api/suppliers
-     */
-    this.createSupplier = (data, params = {}) => this.request({
-      path: `/api/suppliers`,
-      method: "POST",
-      body: data,
-      type: "application/json" /* Json */,
-      format: "json",
-      ...params
-    });
-    /**
-     * No description
-     *
-     * @tags Supplier
-     * @name GetSupplierById
-     * @request GET:/api/suppliers/{id}
-     */
-    this.getSupplierById = ({ id }, params = {}) => this.request({
-      path: `/api/suppliers/${id}`,
-      method: "GET",
-      format: "json",
-      ...params
-    });
-    /**
-     * No description
-     *
-     * @tags Supplier
-     * @name UpdateSupplier
-     * @request PUT:/api/suppliers/{id}
-     */
-    this.updateSupplier = ({ id }, data, params = {}) => this.request({
-      path: `/api/suppliers/${id}`,
-      method: "PUT",
-      body: data,
-      type: "application/json" /* Json */,
-      format: "json",
-      ...params
-    });
-    /**
-     * No description
-     *
-     * @tags Supplier
-     * @name DeleteSupplier
-     * @request DELETE:/api/suppliers/{id}
-     */
-    this.deleteSupplier = ({ id }, params = {}) => this.request({
-      path: `/api/suppliers/${id}`,
-      method: "DELETE",
-      ...params
-    });
-  }
-};
-
-// src/api/methods/Supplier.api.ts
-var supplierApi = new Supplier();
-async function createSupplier(...argsWithCallbacks) {
-  const {
-    args,
-    onSuccess,
-    onError,
-    params
-  } = extractArgsCallbacksAndParams(argsWithCallbacks);
-  const requestArgs = [
-    ...args,
-    params ?? {}
-  ];
-  return handleApiResponse(
-    () => supplierApi.createSupplier(
-      ...requestArgs
-    ),
-    {
-      onSuccess,
-      onError
-    }
-  );
-}
-async function getSupplierById(...argsWithCallbacks) {
-  const {
-    args,
-    onSuccess,
-    onError,
-    params
-  } = extractArgsCallbacksAndParams(argsWithCallbacks);
-  const requestArgs = [
-    ...args,
-    params ?? {}
-  ];
-  return handleApiResponse(
-    () => supplierApi.getSupplierById(
-      ...requestArgs
-    ),
-    {
-      onSuccess,
-      onError
-    }
-  );
-}
-
 // src/utils/toFormData.ts
 function toFormData(payload) {
   const formData = new FormData();
@@ -719,45 +249,10 @@ function appendFormDataValue(formData, key, value) {
   }
   formData.append(key, JSON.stringify(value));
 }
-var x = createSupplier(
-  { id: "", name: "Test Supplier", active: true, countryCode: "US", email: "test.supplier@example.com", rating: 4.5 },
-  () => {
-    console.info("Created");
-  },
-  (error) => {
-    console.error("Error", error);
-  }
-);
-var y = getOrders(
-  {},
-  (response) => {
-    console.info("Created", response);
-  },
-  (error) => {
-    console.error("Error", error);
-  }
-);
-var x2 = getSupplierById(
-  { id: "1" },
-  () => {
-    console.info("Created");
-  },
-  (error) => {
-    console.error("Error", error);
-  }
-);
-var y2 = getSupplierById(
-  { id: "1" },
-  (response) => {
-    console.info("Created", response);
-  },
-  (error) => {
-    console.error("Error", error);
-  }
-);
 export {
   buildQuery,
   extractArgsCallbacksAndParams,
+  extractArgsToastsAndParams,
   getSortDirectionFromSortType,
   getSortTypeFromSortDirection,
   handleApiResponse,

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,wBAAwB,CAAC;AACvC,cAAc,qBAAqB,CAAC;AACpC,cAAc,uBAAuB,CAAC;AAEtC,cAAc,wBAAwB,CAAC;AACvC,cAAc,sBAAsB,CAAC;AACrC,cAAc,wBAAwB,CAAC;AAEvC,cAAc,oBAAoB,CAAC;AACnC,cAAc,oCAAoC,CAAC;AACnD,cAAc,2BAA2B,CAAC;AAC1C,cAAc,mCAAmC,CAAC;AAClD,cAAc,oBAAoB,CAAC"}

package/dist/interfaces/ApiResult.d.ts

@@ -0,0 +1,17 @@
+/**
+ * Standard result wrapper for API calls.
+ *
+ * When `ok` is true, the request succeeded and `response` contains the expected data.
+ * When `ok` is false, the request failed and `error` contains the thrown or returned error value.
+ */
+export type ApiResult<T> = {
+    ok: true;
+    status: number;
+    response: T;
+} | {
+    ok: false;
+    status: number;
+    response?: T;
+    error: unknown;
+};
+//# sourceMappingURL=ApiResult.d.ts.map

package/dist/interfaces/ApiResult.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ApiResult.d.ts","sourceRoot":"","sources":["../../src/interfaces/ApiResult.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,MAAM,MAAM,SAAS,CAAC,CAAC,IACnB;IACE,EAAE,EAAE,IAAI,CAAC;IACT,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,CAAC,CAAC;CACb,GACD;IACE,EAAE,EAAE,KAAK,CAAC;IACV,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,CAAC,EAAE,CAAC,CAAC;IACb,KAAK,EAAE,OAAO,CAAC;CAChB,CAAC"}

package/dist/interfaces/ApiResult.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=ApiResult.js.map

package/dist/interfaces/ApiResult.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ApiResult.js","sourceRoot":"","sources":["../../src/interfaces/ApiResult.ts"],"names":[],"mappings":""}

package/dist/interfaces/Filter.d.ts

@@ -0,0 +1,31 @@
+/**
+ * Supported filter input types used by typed filter forms.
+ *
+ * These values decide which UI input should be rendered for a filter.
+ */
+export type FilterType = "number" | "date" | "string" | "timespan" | "boolean" | "boolean-button" | "OptionValue";
+/**
+ * Selectable option value used by option-based filters.
+ *
+ * `name` is shown in the UI and `value` is sent as the actual filter value.
+ */
+export interface OptionValue {
+    name: string;
+    value: number | string | Date;
+}
+/**
+ * Configuration for one filter field in a typed filter form.
+ *
+ * `filterName` maps the form value to a query property.
+ * `filterNameMax` can be used for range filters such as dates or numbers.
+ */
+export interface FilterFormValues<TQuery> {
+    name: string;
+    filterName: keyof TQuery;
+    filterNameMax?: keyof TQuery;
+    type: FilterType;
+    value: number | string | Date | boolean | null | OptionValue[] | string[];
+    maxValue?: number | string | Date | null;
+    isAList: boolean;
+}
+//# sourceMappingURL=Filter.d.ts.map