rastack 0.0.16 → 0.0.19

package/hooks/query/api.ts

@@ -1,42 +1,42 @@
-import axios, { AxiosAdapter, AxiosInstance } from "axios";
-
-// @ts-ignore
-const defaultBaseURL = process.env.NEXT_PUBLIC_BASE_URL || "http://127.0.0.1:8000";
-
-/**
- * The shared axios client every generated hook talks through. It is a stable
- * singleton — imported directly all over the codegen — so `<RAStackProvider>`
- * reconfigures it *in place* (base URL for `remote` mode, or a WASM adapter for
- * `local`/`s3` mode) rather than swapping the instance. That is what lets the
- * same hooks hit a Lambda over HTTP or an in-browser WASM engine with no
- * codegen changes.
- */
-export const API: AxiosInstance = axios.create({
-  baseURL: defaultBaseURL,
-});
-
-export interface ApiConfig {
-  /** Base URL for HTTP (`remote`) mode. */
-  baseURL?: string;
-  /**
-   * Axios adapter override. Pass the WASM adapter to route requests into the
-   * in-browser engine; pass `null` to restore axios's default HTTP transport.
-   */
-  adapter?: AxiosAdapter | null;
-}
-
-/** Reconfigure the shared client. Called by `<RAStackProvider>` on mode changes. */
-export function configureApi(config: ApiConfig): void {
-  if (config.baseURL !== undefined) {
-    API.defaults.baseURL = config.baseURL;
-  }
-  if ("adapter" in config) {
-    API.defaults.adapter = config.adapter ?? undefined;
-  }
-}
-
-/** Restore the client to its default HTTP transport and base URL. */
-export function resetApi(): void {
-  API.defaults.baseURL = defaultBaseURL;
-  API.defaults.adapter = undefined;
-}
+import axios, { AxiosAdapter, AxiosInstance } from "axios";
+
+// @ts-ignore
+const defaultBaseURL = process.env.NEXT_PUBLIC_BASE_URL || "http://127.0.0.1:8000";
+
+/**
+ * The shared axios client every generated hook talks through. It is a stable
+ * singleton — imported directly all over the codegen — so `<RAStackProvider>`
+ * reconfigures it *in place* (base URL for `remote` mode, or a WASM adapter for
+ * `local`/`s3` mode) rather than swapping the instance. That is what lets the
+ * same hooks hit a Lambda over HTTP or an in-browser WASM engine with no
+ * codegen changes.
+ */
+export const API: AxiosInstance = axios.create({
+  baseURL: defaultBaseURL,
+});
+
+export interface ApiConfig {
+  /** Base URL for HTTP (`remote`) mode. */
+  baseURL?: string;
+  /**
+   * Axios adapter override. Pass the WASM adapter to route requests into the
+   * in-browser engine; pass `null` to restore axios's default HTTP transport.
+   */
+  adapter?: AxiosAdapter | null;
+}
+
+/** Reconfigure the shared client. Called by `<RAStackProvider>` on mode changes. */
+export function configureApi(config: ApiConfig): void {
+  if (config.baseURL !== undefined) {
+    API.defaults.baseURL = config.baseURL;
+  }
+  if ("adapter" in config) {
+    API.defaults.adapter = config.adapter ?? undefined;
+  }
+}
+
+/** Restore the client to its default HTTP transport and base URL. */
+export function resetApi(): void {
+  API.defaults.baseURL = defaultBaseURL;
+  API.defaults.adapter = undefined;
+}

package/hooks/query/delete.ts

@@ -1,45 +1,45 @@
-import { AxiosResponse } from "axios";
-import { UseMutationResult } from "react-query/types/react/types";
-import { useMutation, useQueryClient } from "react-query";
-import { IDeleteQueryResult } from "./interfaces";
-import { API } from "./api";
-
-interface DeleteQueryProps {
-  deleteUrl?: ((id: string) => string) | string;
-  listQueryCacheKey?: string | undefined;
-}
-
-export function useDeleteQuery<TResult>({
-  deleteUrl,
-  listQueryCacheKey,
-}: DeleteQueryProps): IDeleteQueryResult<TResult> {
-  const queryClient = useQueryClient();
-
-  return useMutation(
-    async (params: { id?: string }) => {
-      if (params.id === undefined) {
-        throw new Error("ID is required for delete operation");
-      }
-      let url: string = "";
-      if (typeof deleteUrl === "function") {
-        if (params.id) {
-          url = deleteUrl(params.id);
-        }
-      } else {
-        if (deleteUrl) {
-          url = deleteUrl;
-        }
-      }
-
-      const response: AxiosResponse = await API.delete(url);
-      return response.data.results;
-    },
-    {
-      onSuccess: () => {
-        if (listQueryCacheKey) {
-          queryClient.invalidateQueries(listQueryCacheKey);
-        }
-      },
-    },
-  ) as UseMutationResult<TResult>;
-}
+import { AxiosResponse } from "axios";
+import { UseMutationResult } from "react-query/types/react/types";
+import { useMutation, useQueryClient } from "react-query";
+import { IDeleteQueryResult } from "./interfaces";
+import { API } from "./api";
+
+interface DeleteQueryProps {
+  deleteUrl?: ((id: string) => string) | string;
+  listQueryCacheKey?: string | undefined;
+}
+
+export function useDeleteQuery<TResult>({
+  deleteUrl,
+  listQueryCacheKey,
+}: DeleteQueryProps): IDeleteQueryResult<TResult> {
+  const queryClient = useQueryClient();
+
+  return useMutation(
+    async (params: { id?: string }) => {
+      if (params.id === undefined) {
+        throw new Error("ID is required for delete operation");
+      }
+      let url: string = "";
+      if (typeof deleteUrl === "function") {
+        if (params.id) {
+          url = deleteUrl(params.id);
+        }
+      } else {
+        if (deleteUrl) {
+          url = deleteUrl;
+        }
+      }
+
+      const response: AxiosResponse = await API.delete(url);
+      return response.data.results;
+    },
+    {
+      onSuccess: () => {
+        if (listQueryCacheKey) {
+          queryClient.invalidateQueries(listQueryCacheKey);
+        }
+      },
+    },
+  ) as UseMutationResult<TResult>;
+}

package/hooks/query/fetch.ts

@@ -1,48 +1,48 @@
-import { AxiosResponse } from "axios";
-import { useQuery } from "react-query";
-import { API } from "./api";
-import { stringifyQueryParams } from "./url";
-import { GetQueryOptions, IGetQueryResult } from "./interfaces";
-
-export interface GetQueryProps<TParam> {
-  getUrl: string;
-  queryKey: string;
-  pathParameters: (keyof TParam)[];
-  requiredParams: (keyof TParam)[];
-  isAuthenticated: boolean;
-  options?: GetQueryOptions<TParam>;
-}
-
-export function useGetQuery<TParam, TResult>({
-  getUrl,
-  queryKey,
-  pathParameters,
-  requiredParams,
-  isAuthenticated,
-  options,
-}: GetQueryProps<TParam>): IGetQueryResult<TResult> {
-  const isRequiredParamsPresent = requiredParams?.every((param) => {
-    if (!options?.params) {
-      return false;
-    } else {
-      return options?.params[param as keyof TParam] !== undefined;
-    }
-  });
-
-  const params = options?.params;
-
-  return useQuery(
-    [queryKey, getUrl, params],
-    async () => {
-      const urlParams = stringifyQueryParams(pathParameters, params);
-      const serverURL = `${getUrl}${urlParams ? `?${urlParams}` : ""}`;
-
-      const response: AxiosResponse<TResult> = await API.get(serverURL);
-
-      return response.data;
-    },
-    {
-      enabled: isAuthenticated && isRequiredParamsPresent,
-    },
-  );
-}
+import { AxiosResponse } from "axios";
+import { useQuery } from "react-query";
+import { API } from "./api";
+import { stringifyQueryParams } from "./url";
+import { GetQueryOptions, IGetQueryResult } from "./interfaces";
+
+export interface GetQueryProps<TParam> {
+  getUrl: string;
+  queryKey: string;
+  pathParameters: (keyof TParam)[];
+  requiredParams: (keyof TParam)[];
+  isAuthenticated: boolean;
+  options?: GetQueryOptions<TParam>;
+}
+
+export function useGetQuery<TParam, TResult>({
+  getUrl,
+  queryKey,
+  pathParameters,
+  requiredParams,
+  isAuthenticated,
+  options,
+}: GetQueryProps<TParam>): IGetQueryResult<TResult> {
+  const isRequiredParamsPresent = requiredParams?.every((param) => {
+    if (!options?.params) {
+      return false;
+    } else {
+      return options?.params[param as keyof TParam] !== undefined;
+    }
+  });
+
+  const params = options?.params;
+
+  return useQuery(
+    [queryKey, getUrl, params],
+    async () => {
+      const urlParams = stringifyQueryParams(pathParameters, params);
+      const serverURL = `${getUrl}${urlParams ? `?${urlParams}` : ""}`;
+
+      const response: AxiosResponse<TResult> = await API.get(serverURL);
+
+      return response.data;
+    },
+    {
+      enabled: isAuthenticated && isRequiredParamsPresent,
+    },
+  );
+}

package/hooks/query/index.ts

@@ -1,21 +1,21 @@
-export { useGetQuery } from "./fetch";
-export type {
-  IGetQueryResult,
-  IUpdateQueryResult,
-  IDeleteQueryResult,
-  IListQuery,
-  ListQueryOptions,
-  GetQueryOptions,
-} from "./interfaces";
-export { useGetPaginatedQueryList } from "./list";
-export { useUpdateQuery } from "./update";
-export { useDeleteQuery } from "./delete";
-export type {
-  IPaginationActions,
-  ISearchingActions,
-  IFilterActions,
-  ISortingActions,
-  ReturnedHeader,
-} from "./interfaces";
-export { API, configureApi, resetApi } from "./api";
-export type { ApiConfig } from "./api";
+export { useGetQuery } from "./fetch";
+export type {
+  IGetQueryResult,
+  IUpdateQueryResult,
+  IDeleteQueryResult,
+  IListQuery,
+  ListQueryOptions,
+  GetQueryOptions,
+} from "./interfaces";
+export { useGetPaginatedQueryList } from "./list";
+export { useUpdateQuery } from "./update";
+export { useDeleteQuery } from "./delete";
+export type {
+  IPaginationActions,
+  ISearchingActions,
+  IFilterActions,
+  ISortingActions,
+  ReturnedHeader,
+} from "./interfaces";
+export { API, configureApi, resetApi } from "./api";
+export type { ApiConfig } from "./api";

package/hooks/query/interfaces.ts

@@ -1,111 +1,111 @@
-import {
-  UseMutationResult,
-  UseQueryResult,
-} from "react-query/types/react/types";
-import { ExtractKey } from "../../types";
-
-export interface IPaginationActions {
-  currentPage: number;
-  pageSize: number;
-  itemCount: number;
-  pageCount: number;
-  nextPage: () => void;
-  previousPage: () => void;
-  setPageSize: (pageSize: number) => void;
-}
-
-export interface ISearchingActions<TParam> {
-  searchText: string | undefined;
-  setSearchText: (value: string | undefined) => void;
-}
-
-export interface IPagination {
-  next: number | null;
-  previous: number | null;
-  current: number;
-  last: number;
-  page_size: number;
-  count: number;
-}
-
-export interface ISortingActions<TParam> {
-  sortField: (key: NormalizedField<ExtractKey<TParam, "order_by">>) => void;
-  getSortingDirection: (
-    key: NormalizedField<ExtractKey<TParam, "order_by">>,
-  ) => "asc" | "desc" | undefined;
-}
-
-export interface IFilterActions<TParam> {
-  getFilterFieldValue: (key: keyof TParam) => TParam[keyof TParam];
-  setFilterFieldValue: (
-    key: keyof TParam,
-  ) => (value: TParam[keyof TParam]) => void;
-}
-
-export interface IFilter {
-  [key: string]: unknown;
-}
-
-export type UseQueryResultWithoutData<TResult> = Omit<
-  UseQueryResult<IPaginatedResponse<TResult>>,
-  "data"
->;
-
-export type NormalizedField<T> = T extends `-${infer U}` ? U : T;
-
-export interface ReturnedHeader {
-  key: string;
-  name: string;
-}
-
-export type IPaginatedResponse<TResult> = {
-  [key in keyof TResult]: TResult[key];
-} & {
-  headers?: ReturnedHeader[];
-  pagination: IPagination;
-};
-
-export interface IListQuery<TParam, TQuery>
-  extends UseQueryResultWithoutData<TQuery> {
-  pagination: IPaginationActions;
-  searching: ISearchingActions<TParam>;
-  sorting: ISortingActions<TParam>;
-  filtering: IFilterActions<TParam>;
-  header: ReturnedHeader[] | undefined;
-  data: TQuery[] | undefined;
-  raw: IPaginatedResponse<TQuery> | undefined;
-}
-
-export type IGetQueryResult<TResult> = UseQueryResult<TResult>;
-
-export interface WriteQueryVariables<TParams, TPayload> {
-  params: TParams;
-  payload: TPayload;
-}
-
-export type IUpdateQueryResult<TParams, TPayload, TResult> = UseMutationResult<
-  TResult,
-  unknown,
-  WriteQueryVariables<TParams, TPayload>,
-  unknown
->;
-
-export type IDeleteQueryResult<TResult> = UseMutationResult<TResult>;
-
-export interface ListQueryOptions<TParam, TResult> {
-  params?: Partial<TParam>;
-  requiredParams?: (keyof TParam)[];
-  searchKey?: keyof TParam;
-  defaultSortFields?: (string & ExtractKey<TParam, "order_by">)[];
-  onSuccess?: (result: IPaginatedResponse<TResult>) => void;
-  localCache?: boolean;
-  pageSize?: number;
-  localSearchFunction?: (
-    searchValue: string | undefined,
-    searchData: TResult,
-  ) => boolean;
-}
-
-export interface GetQueryOptions<TParam> {
-  params?: Partial<TParam>;
-}
+import {
+  UseMutationResult,
+  UseQueryResult,
+} from "react-query/types/react/types";
+import { ExtractKey } from "../../types";
+
+export interface IPaginationActions {
+  currentPage: number;
+  pageSize: number;
+  itemCount: number;
+  pageCount: number;
+  nextPage: () => void;
+  previousPage: () => void;
+  setPageSize: (pageSize: number) => void;
+}
+
+export interface ISearchingActions<TParam> {
+  searchText: string | undefined;
+  setSearchText: (value: string | undefined) => void;
+}
+
+export interface IPagination {
+  next: number | null;
+  previous: number | null;
+  current: number;
+  last: number;
+  page_size: number;
+  count: number;
+}
+
+export interface ISortingActions<TParam> {
+  sortField: (key: NormalizedField<ExtractKey<TParam, "order_by">>) => void;
+  getSortingDirection: (
+    key: NormalizedField<ExtractKey<TParam, "order_by">>,
+  ) => "asc" | "desc" | undefined;
+}
+
+export interface IFilterActions<TParam> {
+  getFilterFieldValue: (key: keyof TParam) => TParam[keyof TParam];
+  setFilterFieldValue: (
+    key: keyof TParam,
+  ) => (value: TParam[keyof TParam]) => void;
+}
+
+export interface IFilter {
+  [key: string]: unknown;
+}
+
+export type UseQueryResultWithoutData<TResult> = Omit<
+  UseQueryResult<IPaginatedResponse<TResult>>,
+  "data"
+>;
+
+export type NormalizedField<T> = T extends `-${infer U}` ? U : T;
+
+export interface ReturnedHeader {
+  key: string;
+  name: string;
+}
+
+export type IPaginatedResponse<TResult> = {
+  [key in keyof TResult]: TResult[key];
+} & {
+  headers?: ReturnedHeader[];
+  pagination: IPagination;
+};
+
+export interface IListQuery<TParam, TQuery>
+  extends UseQueryResultWithoutData<TQuery> {
+  pagination: IPaginationActions;
+  searching: ISearchingActions<TParam>;
+  sorting: ISortingActions<TParam>;
+  filtering: IFilterActions<TParam>;
+  header: ReturnedHeader[] | undefined;
+  data: TQuery[] | undefined;
+  raw: IPaginatedResponse<TQuery> | undefined;
+}
+
+export type IGetQueryResult<TResult> = UseQueryResult<TResult>;
+
+export interface WriteQueryVariables<TParams, TPayload> {
+  params: TParams;
+  payload: TPayload;
+}
+
+export type IUpdateQueryResult<TParams, TPayload, TResult> = UseMutationResult<
+  TResult,
+  unknown,
+  WriteQueryVariables<TParams, TPayload>,
+  unknown
+>;
+
+export type IDeleteQueryResult<TResult> = UseMutationResult<TResult>;
+
+export interface ListQueryOptions<TParam, TResult> {
+  params?: Partial<TParam>;
+  requiredParams?: (keyof TParam)[];
+  searchKey?: keyof TParam;
+  defaultSortFields?: (string & ExtractKey<TParam, "order_by">)[];
+  onSuccess?: (result: IPaginatedResponse<TResult>) => void;
+  localCache?: boolean;
+  pageSize?: number;
+  localSearchFunction?: (
+    searchValue: string | undefined,
+    searchData: TResult,
+  ) => boolean;
+}
+
+export interface GetQueryOptions<TParam> {
+  params?: Partial<TParam>;
+}