fastapi-rtk 2.8.0 → 2.9.0

package/dist/core/esm/Wrappers/Provider/utils/authFetch.mjs

@@ -1,99 +0,0 @@
-import { urlJoin, createFetchParams } from "fastapi-rtk/utils";
-async function authSignin(baseUrl, { username, password }) {
-  const formData = new FormData();
-  formData.append("username", username);
-  formData.append("password", password);
-  const { fetchPath, options } = createFetchParams({
-    path: urlJoin(baseUrl, "auth/login"),
-    method: "POST"
-  });
-  const res = await fetch(fetchPath, {
-    ...options,
-    headers: {
-      "Content-Type": "application/x-www-form-urlencoded"
-    },
-    // #MUSTASSERT #MUSTANY URLSearchParams accepts FormData at runtime, but the DOM lib types omit that constructor overload
-    body: new URLSearchParams(formData)
-  });
-  if (!res.ok) {
-    if (res.status === 400) {
-      throw new Error("Username or password wrong.");
-    } else {
-      throw new Error("Failed to sign in.");
-    }
-  }
-}
-async function authSignout(baseUrl) {
-  const { fetchPath, options } = createFetchParams({
-    path: urlJoin(baseUrl, "auth/logout"),
-    method: "POST"
-  });
-  const res = await fetch(fetchPath, options);
-  if (!res.ok) {
-    throw new Error("Failed to sign out.");
-  }
-}
-async function authResetPassword(baseUrl, newPassword, { email }) {
-  const { fetchPath, options } = createFetchParams({
-    path: urlJoin(baseUrl, "auth/forgot-password"),
-    method: "POST",
-    body: { email }
-  });
-  const forgotPasswordRes = await fetch(fetchPath, options);
-  if (!forgotPasswordRes.ok) {
-    throw new Error("Could not request token to reset password");
-  }
-  const jsonResponse = await forgotPasswordRes.json();
-  const { token } = jsonResponse;
-  const { fetchPath: fetchPath2, options: options2 } = createFetchParams({
-    path: urlJoin(baseUrl, "auth/reset-password"),
-    method: "POST",
-    body: { token, password: newPassword }
-  });
-  const resetPasswordRes = await fetch(fetchPath2, options2);
-  if (!resetPasswordRes.ok) {
-    throw new Error("Could not reset password");
-  }
-}
-function authOAuthSignin(baseUrl, provider, popup, afterSigninPopup) {
-  const url = urlJoin(baseUrl, "auth/login", provider);
-  if (!popup) {
-    window.location.href = urlJoin(baseUrl, "auth/login", provider);
-    return;
-  }
-  const width = 500;
-  const height = 500;
-  const left = window.screenLeft + window.outerWidth / 2 - width / 2;
-  const top = window.screenTop + window.outerHeight / 2 - height / 2;
-  const authWindow = window.open(
-    url + "?popup=true",
-    "auth",
-    `toolbar=no, location=no, directories=no, status=no, menubar=no, scrollbars=no, resizable=no, copyhistory=no, width=${width}, height=${height}, top=${top}, left=${left}`
-  );
-  const pollTimer = window.setInterval(function() {
-    if (authWindow.closed !== false) {
-      window.clearInterval(pollTimer);
-      afterSigninPopup == null ? void 0 : afterSigninPopup();
-    }
-  }, 200);
-}
-async function authInfo(baseUrl, signal) {
-  const { fetchPath, options } = createFetchParams({
-    path: urlJoin(baseUrl, "info/"),
-    method: "GET"
-  });
-  const res = await fetch(fetchPath, { signal, ...options });
-  const data = await res.json();
-  if (!res.ok) {
-    const errorMessage = typeof data.detail === "string" ? data.detail : JSON.stringify(data.detail, null, 2);
-    throw new Error(errorMessage);
-  }
-  return data;
-}
-export {
-  authInfo,
-  authOAuthSignin,
-  authResetPassword,
-  authSignin,
-  authSignout
-};

package/dist/core/esm/Wrappers/Provider/utils/userCRUD.mjs

@@ -1,32 +0,0 @@
-import { createFetchParams, urlJoin } from "fastapi-rtk/utils";
-async function getUser(baseUrl, signal) {
-  const { fetchPath, options } = createFetchParams({
-    path: urlJoin(baseUrl, "auth/user"),
-    method: "GET"
-  });
-  const res = await fetch(fetchPath, { signal, ...options });
-  const data = await res.json();
-  if (!res.ok) {
-    const errorMessage = typeof data.detail === "string" ? data.detail : JSON.stringify(data.detail, null, 2);
-    throw new Error(errorMessage);
-  }
-  return data;
-}
-async function updateUser(baseUrl, userData) {
-  const { fetchPath, options } = createFetchParams({
-    path: urlJoin(baseUrl, "auth/user"),
-    method: "PUT",
-    body: userData
-  });
-  const res = await fetch(fetchPath, options);
-  const data = await res.json();
-  if (!res.ok) {
-    const errorMessage = typeof data.detail === "string" ? data.detail : JSON.stringify(data.detail, null, 2);
-    throw new Error(errorMessage);
-  }
-  return data;
-}
-export {
-  getUser,
-  updateUser
-};

package/dist/core/lib/Wrappers/ApiProvider/Contexts/FormContext.d.ts

@@ -1,5 +0,0 @@
-import { FormsContextValue } from '../../../hooks/api/types';
-export declare const FormContextViewProvider: import('react').Provider<FormsContextValue<import('../../../../../.external/lib/mantine-react-table').MRT_RowData> | null>, useFormViewProvider: (options?: import('fastapi-rtk/utils').SafeContextOptions<FormsContextValue<import('../../../../../.external/lib/mantine-react-table').MRT_RowData>>) => FormsContextValue<import('../../../../../.external/lib/mantine-react-table').MRT_RowData>;
-export declare const FormContextAddProvider: import('react').Provider<FormsContextValue<import('../../../../../.external/lib/mantine-react-table').MRT_RowData> | null>, useFormAddProvider: (options?: import('fastapi-rtk/utils').SafeContextOptions<FormsContextValue<import('../../../../../.external/lib/mantine-react-table').MRT_RowData>>) => FormsContextValue<import('../../../../../.external/lib/mantine-react-table').MRT_RowData>;
-export declare const FormContextEditProvider: import('react').Provider<FormsContextValue<import('../../../../../.external/lib/mantine-react-table').MRT_RowData> | null>, useFormEditProvider: (options?: import('fastapi-rtk/utils').SafeContextOptions<FormsContextValue<import('../../../../../.external/lib/mantine-react-table').MRT_RowData>>) => FormsContextValue<import('../../../../../.external/lib/mantine-react-table').MRT_RowData>;
-export declare const FormContextDeleteProvider: import('react').Provider<FormsContextValue<import('../../../../../.external/lib/mantine-react-table').MRT_RowData> | null>, useFormDeleteProvider: (options?: import('fastapi-rtk/utils').SafeContextOptions<FormsContextValue<import('../../../../../.external/lib/mantine-react-table').MRT_RowData>>) => FormsContextValue<import('../../../../../.external/lib/mantine-react-table').MRT_RowData>;

package/dist/core/lib/Wrappers/ApiProvider/hooks/types.d.ts

@@ -1,90 +0,0 @@
-import { convertId } from 'fastapi-rtk/utils';
-import { InfiniteData, QueryKey, UseInfiniteQueryOptions, UseInfiniteQueryResult, UseQueryOptions, UseQueryResult } from '../../../../../.external/lib/@tanstack/react-query';
-import { RefObject } from 'react';
-import { createItem } from '../utils/api/createItem';
-import { deleteItem } from '../utils/api/deleteItem';
-import { downloadItems } from '../utils/api/downloadItems';
-import { formCreateItem } from '../utils/api/formCreateItem';
-import { formUpdateItem } from '../utils/api/formUpdateItem';
-import { getInfo } from '../utils/api/getInfo';
-import { getItem } from '../utils/api/getItem';
-import { getItems } from '../utils/api/getItems';
-import { updateItem } from '../utils/api/updateItem';
-import { uploadItems } from '../utils/api/uploadItems';
-import { postBulk } from '../utils/bulkActions/postBulkAction';
-import { DataPage, PrimaryKey, StreamingPage } from 'fastapi-rtk/api-types';
-import { CoreConvertedInfo, QueryParams } from '../utils/types';
-export type { DataPage, StreamingPage };
-/** An entry identifier as accepted by the action functions before conversion. */
-export type EntryId = Parameters<typeof convertId>[0];
-/** The converted `/_info` data as held by the info query, tagged with the resource path. */
-export type InfoQueryData = CoreConvertedInfo & {
-    path: string;
-};
-/** The set of API functions the provider hooks dispatch through. */
-export interface ApiFunctions {
-    getItem: typeof getItem;
-    getItems: typeof getItems;
-    createItem: typeof createItem;
-    updateItem: typeof updateItem;
-    deleteItem: typeof deleteItem;
-    downloadItems: typeof downloadItems;
-    uploadItems: typeof uploadItems;
-    getInfo: typeof getInfo;
-    formCreateItem: typeof formCreateItem;
-    formUpdateItem: typeof formUpdateItem;
-}
-/** The set of bulk-action functions the bulk provider dispatches through. */
-export interface BulkFunctions {
-    postBulk: typeof postBulk;
-}
-/** A relation reference seeded into the query filters by the provider. */
-export interface RelationParam {
-    foreign_key?: string;
-    type?: string;
-    id?: PrimaryKey | null;
-    id_?: PrimaryKey | null;
-}
-/** The arguments accepted by `useApiActions`. */
-export interface UseApiActionsParams {
-    api: ApiFunctions;
-    path: string;
-    pathRef: RefObject<string>;
-    infoRef: RefObject<InfoQueryData | undefined>;
-    queryParamsRef: RefObject<QueryParams | null>;
-    currentLanguage: string;
-}
-/** The options accepted by the provider's download action. */
-export interface DownloadActionOptions {
-    export_mode?: string;
-    delimiter?: string;
-    quotechar?: string;
-}
-/** The options accepted by the provider's upload action. */
-export interface UploadActionOptions {
-    delimiter?: string;
-    quotechar?: string;
-}
-/** The arguments accepted by `useStreamingData`. */
-export interface UseStreamingDataParams {
-    streamingMode: boolean;
-    dataQuery: UseQueryResult<DataPage | null>;
-    streamingQuery: UseInfiniteQueryResult<InfiniteData<StreamingPage | null>>;
-    streamingQueryKey: QueryKey;
-}
-/** The configuration object accepted by `useProvideApi`. */
-export interface UseProvideApiParams {
-    path: string;
-    initialQueryParams?: QueryParams;
-    relation?: RelationParam;
-    fetchInfo?: boolean;
-    clearInfoOnRefetch?: boolean;
-    clearDataOnRefetch?: boolean;
-    refetchInfoBasedOnLang?: boolean;
-    refetchDataBasedOnLang?: boolean;
-    resetQueryParamsOnPathChange?: boolean;
-    infoQueryProps?: Partial<UseQueryOptions<InfoQueryData>>;
-    dataQueryProps?: Partial<UseQueryOptions<DataPage | null>>;
-    streamingQueryProps?: Partial<UseInfiniteQueryOptions<StreamingPage | null, Error, InfiniteData<StreamingPage | null>, QueryKey, number>>;
-    streaming?: boolean;
-}

package/dist/core/lib/Wrappers/ApiProvider/hooks/useProvideBulk.d.ts

@@ -1,8 +0,0 @@
-import { BulkActionsContextValue } from '../../../hooks/api/types';
-import { BulkFunctions } from './types';
-export declare const defaultBulk: {
-    postBulk: (path: string, handler: string, data: import('../utils/bulkActions/types').BulkActionPayload, options?: import('../utils/api/types').FetchOptions) => Promise<import('../utils/bulkActions/types').BulkActionResponse>;
-};
-export declare const useProvideBulk: (params: {
-    path: string;
-}, bulk?: BulkFunctions) => BulkActionsContextValue;

package/dist/core/lib/Wrappers/ApiProvider/hooks/useProvideForm.d.ts

@@ -1,2 +0,0 @@
-import { FormsContextValue } from '../../../hooks/api/types';
-export declare const useProvideForm: () => import('../../../../../.external/lib/zustand').UseBoundStore<import('../../../../../.external/lib/zustand').StoreApi<FormsContextValue<import('../../../../../.external/lib/mantine-react-table').MRT_RowData>>>;

package/dist/core/lib/Wrappers/ApiProvider/hooks/utils/useApiActions.d.ts

@@ -1,11 +0,0 @@
-import { MRT_RowData } from '../../../../../../.external/lib/mantine-react-table';
-import { DownloadActionOptions, EntryId, UploadActionOptions, UseApiActionsParams } from '../types';
-export declare const useApiActions: (params: UseApiActionsParams) => {
-    getEntry: (id: EntryId) => Promise<MRT_RowData>;
-    addEntry: (item: MRT_RowData) => Promise<MRT_RowData>;
-    updateEntry: (id: EntryId, item: MRT_RowData) => Promise<MRT_RowData>;
-    deleteEntry: (id: EntryId) => Promise<MRT_RowData | null>;
-    download: (label?: string, { export_mode, delimiter, quotechar }?: DownloadActionOptions) => Promise<void>;
-    upload: (file: File, { delimiter, quotechar }?: UploadActionOptions) => Promise<import('../../utils/api/types').UploadResponse>;
-    getItemURL: (type: string, item: string | File) => string;
-};

package/dist/core/lib/Wrappers/ApiProvider/utils/api/createItem.d.ts

@@ -1,3 +0,0 @@
-import { MRT_RowData } from '../../../../../../.external/lib/mantine-react-table';
-import { FetchOptions } from './types';
-export declare const createItem: (path: string, data: MRT_RowData, options?: FetchOptions) => Promise<MRT_RowData>;

package/dist/core/lib/Wrappers/ApiProvider/utils/api/deleteItem.d.ts

@@ -1,3 +0,0 @@
-import { MRT_RowData } from '../../../../../../.external/lib/mantine-react-table';
-import { FetchOptions, ItemId } from './types';
-export declare const deleteItem: (path: string, id: ItemId, options?: FetchOptions) => Promise<MRT_RowData | null>;

package/dist/core/lib/Wrappers/ApiProvider/utils/api/downloadItems.d.ts

@@ -1,3 +0,0 @@
-import { QueryParams } from 'fastapi-rtk/api-types';
-import { DownloadOptions } from './types';
-export declare const downloadItems: (path: string, queryParams?: QueryParams, { label, export_mode, delimiter, quotechar }?: DownloadOptions) => Promise<void>;

package/dist/core/lib/Wrappers/ApiProvider/utils/api/formCreateItem.d.ts

@@ -1,3 +0,0 @@
-import { MRT_RowData } from '../../../../../../.external/lib/mantine-react-table';
-import { FetchOptions } from './types';
-export declare const formCreateItem: (path: string, data: MRT_RowData, options?: FetchOptions) => Promise<MRT_RowData>;

package/dist/core/lib/Wrappers/ApiProvider/utils/api/formUpdateItem.d.ts

@@ -1,3 +0,0 @@
-import { MRT_RowData } from '../../../../../../.external/lib/mantine-react-table';
-import { FetchOptions, ItemId } from './types';
-export declare const formUpdateItem: (path: string, id: ItemId, data: MRT_RowData, options?: FetchOptions) => Promise<MRT_RowData>;

package/dist/core/lib/Wrappers/ApiProvider/utils/api/getItem.d.ts

@@ -1,3 +0,0 @@
-import { MRT_RowData } from '../../../../../../.external/lib/mantine-react-table';
-import { FetchOptions, ItemId } from './types';
-export declare const getItem: (path: string, id: ItemId, options?: FetchOptions) => Promise<MRT_RowData>;

package/dist/core/lib/Wrappers/ApiProvider/utils/api/updateItem.d.ts

@@ -1,3 +0,0 @@
-import { MRT_RowData } from '../../../../../../.external/lib/mantine-react-table';
-import { FetchOptions, ItemId } from './types';
-export declare const updateItem: (path: string, id: ItemId, data: MRT_RowData, options?: FetchOptions) => Promise<MRT_RowData>;

package/dist/core/lib/Wrappers/ApiProvider/utils/api/uploadItems.d.ts

@@ -1,2 +0,0 @@
-import { UploadOptions, UploadResponse } from './types';
-export declare const uploadItems: (path: string, file: File, { delimiter, quotechar }?: UploadOptions) => Promise<UploadResponse>;

package/dist/core/lib/Wrappers/ApiProvider/utils/bulkActions/postBulkAction.d.ts

@@ -1,3 +0,0 @@
-import { FetchOptions } from '../api/types';
-import { BulkActionPayload, BulkActionResponse } from './types';
-export declare const postBulk: (path: string, handler: string, data: BulkActionPayload, options?: FetchOptions) => Promise<BulkActionResponse>;

package/dist/core/lib/Wrappers/Provider/hooks/types.d.ts

@@ -1,24 +0,0 @@
-import { AppApiInfo } from 'fastapi-rtk/api-types';
-import { AuthUser } from '../../../hooks/auth/types';
-export interface SigninCredentials {
-    username: string;
-    password: string;
-}
-export interface AuthDependencies {
-    getUser: (baseUrl: string, signal?: AbortSignal) => Promise<AuthUser>;
-    update: (baseUrl: string, userData: Partial<AuthUser>) => Promise<AuthUser>;
-    signin: (baseUrl: string, credentials: SigninCredentials) => Promise<void>;
-    signout: (baseUrl: string) => Promise<void>;
-    resetPassword: (baseUrl: string, newPassword: string, user: {
-        email: string;
-    }) => Promise<void>;
-    oauthSignin: (baseUrl: string, provider: string, popup: boolean, afterSigninPopup?: () => void) => void;
-}
-export interface InfoDependencies {
-    getInfo: (baseUrl: string, signal?: AbortSignal) => Promise<AppApiInfo[]>;
-    fab?: boolean;
-}
-export interface ProvideAuthError {
-    message: string;
-    originalError: Error;
-}

package/dist/core/lib/Wrappers/Provider/hooks/useProvideAuth.d.ts

@@ -1,17 +0,0 @@
-import { UseQueryOptions } from '../../../../../.external/lib/@tanstack/react-query';
-import { AuthUser } from '../../../hooks/auth/types';
-import { AuthDependencies, SigninCredentials } from './types';
-export declare function useProvideAuth(baseURL: string, authQueryProps?: Partial<UseQueryOptions<AuthUser>>, auth?: AuthDependencies): {
-    user: AuthUser | null | undefined;
-    loading: boolean;
-    error: string | null;
-    query: import('../../../../../.external/lib/@tanstack/react-query').UseQueryResult<AuthUser, Error>;
-    signin: ({ username, password }: SigninCredentials) => Promise<void>;
-    signout: () => Promise<void>;
-    update: (data: Partial<AuthUser>) => Promise<void>;
-    resetPassword: (password: string) => Promise<void>;
-    oauthSignin: (provider: string, popup: boolean) => void;
-    refetch: (options?: import('../../../../../.external/lib/@tanstack/react-query').RefetchOptions) => Promise<import('../../../../../.external/lib/@tanstack/react-query').QueryObserverResult<AuthUser, Error>>;
-    resetError: () => void;
-    oauth_signin: (provider: string, popup: boolean) => void;
-};

package/dist/core/lib/Wrappers/Provider/utils/userCRUD.d.ts

@@ -1,19 +0,0 @@
-import { AuthUser } from '../../../hooks/auth/types';
-/**
- * Fetches the current user's information.
- *
- * @param baseUrl - The base URL of the user endpoint.
- * @param signal - The signal to use for the fetch request.
- * @returns The user's information as a JSON object.
- * @throws {Error} Throws an error if fetching the user information fails.
- */
-export declare function getUser(baseUrl: string, signal?: AbortSignal): Promise<AuthUser>;
-/**
- * Updates the current user's information.
- *
- * @param baseUrl - The base URL of the user endpoint.
- * @param userData - The new user data to update.
- * @returns The updated user's information as a JSON object.
- * @throws {Error} Throws an error if updating the user information fails.
- */
-export declare function updateUser(baseUrl: string, userData: Partial<AuthUser>): Promise<AuthUser>;

package/dist/utils/lib/convertToFormData/convertToFormData.d.ts

@@ -1,15 +0,0 @@
-/**
- * Converts a plain object to a FormData instance.
- *
- * - If the value is an array:
- *   - An empty array appends a null.
- *   - Otherwise the array is split into Files and non-Files.
- *     - Each File is appended separately under the same key.
- *     - Non-File values are appended as a JSON string.
- * - An object (excluding File) is appended as a JSON string.
- * - Otherwise the value is appended as-is.
- *
- * @param data - The object containing key-value pairs to be converted.
- * @returns A FormData instance populated with the processed data.
- */
-export declare const convertToFormData: <T extends object>(data: T) => FormData;