@htkimura/files-storage-backend.rest-client 0.0.33 → 0.0.35

package/dist/generated/folder/folder.d.ts

@@ -1,13 +1,13 @@
 import type { QueryKey, UseMutationOptions, UseMutationResult, UseQueryOptions, UseQueryResult } from '@tanstack/react-query';
 import type { AxiosError, AxiosRequestConfig, AxiosResponse } from 'axios';
-import type { CreateFolderDto, Folder, RenameFolderDto, UpdateParentFolderDto } from '.././model';
+import type { CreateFolderDto, Folder, ListMyFoldersParams, RenameFolderDto, UpdateParentFolderDto } from '.././model';
 /**
- * Returns every folder belonging to the authenticated user, in any parent location.
+ * Returns folders for the authenticated user. Omit parentFolderId to return all folders, pass null for root-level folders only, or pass a folder ID to return direct child folders.
  * @summary List all folders
  */
-export declare const listMyFolders: (options?: AxiosRequestConfig) => Promise<AxiosResponse<Folder[]>>;
-export declare const getListMyFoldersQueryKey: () => readonly ["/folders"];
-export declare const getListMyFoldersQueryOptions: <TData = AxiosResponse<Folder[], any>, TError = AxiosError<unknown, any>>(options?: {
+export declare const listMyFolders: (params?: ListMyFoldersParams, options?: AxiosRequestConfig) => Promise<AxiosResponse<Folder[]>>;
+export declare const getListMyFoldersQueryKey: (params?: ListMyFoldersParams) => readonly ["/folders", ...ListMyFoldersParams[]];
+export declare const getListMyFoldersQueryOptions: <TData = AxiosResponse<Folder[], any>, TError = AxiosError<unknown, any>>(params?: ListMyFoldersParams, options?: {
     query?: UseQueryOptions<Awaited<ReturnType<typeof listMyFolders>>, TError, TData>;
     axios?: AxiosRequestConfig;
 }) => UseQueryOptions<Awaited<ReturnType<typeof listMyFolders>>, TError, TData> & {
@@ -18,7 +18,7 @@ export type ListMyFoldersQueryError = AxiosError<unknown>;
 /**
  * @summary List all folders
  */
-export declare function useListMyFolders<TData = Awaited<ReturnType<typeof listMyFolders>>, TError = AxiosError<unknown>>(options?: {
+export declare function useListMyFolders<TData = Awaited<ReturnType<typeof listMyFolders>>, TError = AxiosError<unknown>>(params?: ListMyFoldersParams, options?: {
     query?: UseQueryOptions<Awaited<ReturnType<typeof listMyFolders>>, TError, TData>;
     axios?: AxiosRequestConfig;
 }): UseQueryResult<TData, TError> & {

package/dist/generated/folder/folder.js

@@ -8,26 +8,29 @@
 import { useMutation, useQuery } from '@tanstack/react-query';
 import axios from 'axios';
 /**
- * Returns every folder belonging to the authenticated user, in any parent location.
+ * Returns folders for the authenticated user. Omit parentFolderId to return all folders, pass null for root-level folders only, or pass a folder ID to return direct child folders.
  * @summary List all folders
  */
-export const listMyFolders = (options) => {
-    return axios.get(`/folders`, options);
+export const listMyFolders = (params, options) => {
+    return axios.get(`/folders`, {
+        ...options,
+        params: { ...params, ...options?.params },
+    });
 };
-export const getListMyFoldersQueryKey = () => {
-    return [`/folders`];
+export const getListMyFoldersQueryKey = (params) => {
+    return [`/folders`, ...(params ? [params] : [])];
 };
-export const getListMyFoldersQueryOptions = (options) => {
+export const getListMyFoldersQueryOptions = (params, options) => {
     const { query: queryOptions, axios: axiosOptions } = options ?? {};
-    const queryKey = queryOptions?.queryKey ?? getListMyFoldersQueryKey();
-    const queryFn = ({ signal }) => listMyFolders({ signal, ...axiosOptions });
+    const queryKey = queryOptions?.queryKey ?? getListMyFoldersQueryKey(params);
+    const queryFn = ({ signal }) => listMyFolders(params, { signal, ...axiosOptions });
     return { queryKey, queryFn, ...queryOptions };
 };
 /**
  * @summary List all folders
  */
-export function useListMyFolders(options) {
-    const queryOptions = getListMyFoldersQueryOptions(options);
+export function useListMyFolders(params, options) {
+    const queryOptions = getListMyFoldersQueryOptions(params, options);
     const query = useQuery(queryOptions);
     query.queryKey = queryOptions.queryKey;
     return query;

package/dist/generated/model/index.d.ts

@@ -25,12 +25,14 @@ export * from './initMultipartUploadOutput';
 export * from './listChildrenData';
 export * from './listChildrenOutput';
 export * from './listChildrenParams';
+export * from './listMyFoldersParams';
 export * from './loginDto';
 export * from './moveFileToFolderDto';
 export * from './multipartPartUrlOutput';
 export * from './multipartUploadedPartDto';
 export * from './myFilesParams';
 export * from './refreshTokenDto';
+export * from './renameFileDto';
 export * from './renameFolderDto';
 export * from './updateParentFolderDto';
 export * from './uploadFileOutput';

package/dist/generated/model/index.js

@@ -25,12 +25,14 @@ export * from './initMultipartUploadOutput';
 export * from './listChildrenData';
 export * from './listChildrenOutput';
 export * from './listChildrenParams';
+export * from './listMyFoldersParams';
 export * from './loginDto';
 export * from './moveFileToFolderDto';
 export * from './multipartPartUrlOutput';
 export * from './multipartUploadedPartDto';
 export * from './myFilesParams';
 export * from './refreshTokenDto';
+export * from './renameFileDto';
 export * from './renameFolderDto';
 export * from './updateParentFolderDto';
 export * from './uploadFileOutput';

package/dist/generated/model/listMyFoldersParams.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Generated by orval v7.4.1 🍺
+ * Do not edit manually.
+ * files-storage
+ * This API is for storing files for different users
+ * OpenAPI spec version: 1.0
+ */
+export type ListMyFoldersParams = {
+    /**
+     * Filter by parent folder. Omit to return all folders. Pass null for root-level folders only.
+     */
+    parentFolderId?: string | null;
+};

package/dist/generated/model/listMyFoldersParams.js

@@ -0,0 +1,8 @@
+/**
+ * Generated by orval v7.4.1 🍺
+ * Do not edit manually.
+ * files-storage
+ * This API is for storing files for different users
+ * OpenAPI spec version: 1.0
+ */
+export {};

package/dist/generated/model/myFilesParams.d.ts

@@ -10,4 +10,8 @@ export type MyFilesParams = {
     page?: number;
     size?: number;
     filterType?: FileFilterType[];
+    /**
+     * Filter by folder. Omit to return all files. Pass null for root-level files only.
+     */
+    folderId?: string | null;
 };

package/dist/generated/model/renameFileDto.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Generated by orval v7.4.1 🍺
+ * Do not edit manually.
+ * files-storage
+ * This API is for storing files for different users
+ * OpenAPI spec version: 1.0
+ */
+export interface RenameFileDto {
+    name: string;
+}

package/dist/generated/model/renameFileDto.js

@@ -0,0 +1,8 @@
+/**
+ * Generated by orval v7.4.1 🍺
+ * Do not edit manually.
+ * files-storage
+ * This API is for storing files for different users
+ * OpenAPI spec version: 1.0
+ */
+export {};

package/dist/generated/storage/storage.d.ts

@@ -1,6 +1,6 @@
 import type { QueryKey, UseMutationOptions, UseMutationResult, UseQueryOptions, UseQueryResult } from '@tanstack/react-query';
 import type { AxiosError, AxiosRequestConfig, AxiosResponse } from 'axios';
-import type { AbortMultipartUploadParams, CompleteMultipartUploadDto, DeleteBulkFilesByIdsParams, DeleteBulkFilesOutput, File, FileWithPresignedUrl, GetBulkFilesByIdsParams, GetMultipartPartUrlParams, GetPresignedUploadUrlParams, InitMultipartUploadDto, InitMultipartUploadOutput, ListChildrenOutput, ListChildrenParams, MoveFileToFolderDto, MultipartPartUrlOutput, UploadFileOutput } from '.././model';
+import type { AbortMultipartUploadParams, CompleteMultipartUploadDto, DeleteBulkFilesByIdsParams, DeleteBulkFilesOutput, File, FileWithPresignedUrl, GetBulkFilesByIdsParams, GetMultipartPartUrlParams, GetPresignedUploadUrlParams, InitMultipartUploadDto, InitMultipartUploadOutput, ListChildrenOutput, ListChildrenParams, MoveFileToFolderDto, MultipartPartUrlOutput, RenameFileDto, UploadFileOutput } from '.././model';
 /**
  * Returns presigned url to upload file
  * @summary Get presigned url to upload file
@@ -296,3 +296,34 @@ export declare const useMoveFileToFolder: <TData = AxiosResponse<File, any>, TEr
     id: string;
     data: MoveFileToFolderDto;
 }, TContext>;
+/**
+* Renames a file belonging to the authenticated user
+* @summary Rename a file
+*/
+export declare const renameFile: (id: string, renameFileDto: RenameFileDto, options?: AxiosRequestConfig) => Promise<AxiosResponse<File>>;
+export declare const getRenameFileMutationOptions: <TData = AxiosResponse<File, any>, TError = AxiosError<unknown, any>, TContext = unknown>(options?: {
+    mutation?: UseMutationOptions<TData, TError, {
+        id: string;
+        data: RenameFileDto;
+    }, TContext>;
+    axios?: AxiosRequestConfig;
+}) => UseMutationOptions<TData, TError, {
+    id: string;
+    data: RenameFileDto;
+}, TContext>;
+export type RenameFileMutationResult = NonNullable<Awaited<ReturnType<typeof renameFile>>>;
+export type RenameFileMutationBody = RenameFileDto;
+export type RenameFileMutationError = AxiosError<unknown>;
+/**
+* @summary Rename a file
+*/
+export declare const useRenameFile: <TData = AxiosResponse<File, any>, TError = AxiosError<unknown, any>, TContext = unknown>(options?: {
+    mutation?: UseMutationOptions<TData, TError, {
+        id: string;
+        data: RenameFileDto;
+    }, TContext>;
+    axios?: AxiosRequestConfig;
+}) => UseMutationResult<TData, TError, {
+    id: string;
+    data: RenameFileDto;
+}, TContext>;

package/dist/generated/storage/storage.js

@@ -337,3 +337,30 @@ export const useMoveFileToFolder = (options) => {
     const mutationOptions = getMoveFileToFolderMutationOptions(options);
     return useMutation(mutationOptions);
 };
+/**
+* Renames a file belonging to the authenticated user
+* @summary Rename a file
+*/
+export const renameFile = (id, renameFileDto, options) => {
+    return axios.patch(`/files/${id}/rename`, renameFileDto, options);
+};
+export const getRenameFileMutationOptions = (options) => {
+    const mutationKey = ['renameFile'];
+    const { mutation: mutationOptions, axios: axiosOptions } = options ?
+        options.mutation && 'mutationKey' in options.mutation && options.mutation.mutationKey ?
+            options
+            : { ...options, mutation: { ...options.mutation, mutationKey } }
+        : { mutation: { mutationKey, }, axios: undefined };
+    const mutationFn = (props) => {
+        const { id, data } = props ?? {};
+        return renameFile(id, data, axiosOptions);
+    };
+    return { mutationFn, ...mutationOptions };
+};
+/**
+* @summary Rename a file
+*/
+export const useRenameFile = (options) => {
+    const mutationOptions = getRenameFileMutationOptions(options);
+    return useMutation(mutationOptions);
+};

package/dist/generated/user/user.d.ts

@@ -106,7 +106,7 @@ export declare function useMe<TData = Awaited<ReturnType<typeof me>>, TError = A
     queryKey: QueryKey;
 };
 /**
- * Returns the authenticated user files URLs
+ * Returns the authenticated user files. Omit folderId to return all files, pass null for root-level files only, or pass a folder ID to return files from that folder.
  * @summary Get the authenticated user files URLs
  */
 export declare const myFiles: (params: MyFilesParams, options?: AxiosRequestConfig) => Promise<AxiosResponse<GetUserFilesOutput>>;

package/dist/generated/user/user.js

@@ -114,7 +114,7 @@ export function useMe(options) {
     return query;
 }
 /**
- * Returns the authenticated user files URLs
+ * Returns the authenticated user files. Omit folderId to return all files, pass null for root-level files only, or pass a folder ID to return files from that folder.
  * @summary Get the authenticated user files URLs
  */
 export const myFiles = (params, options) => {

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@htkimura/files-storage-backend.rest-client",
-	"version": "0.0.33",
+	"version": "0.0.35",
 	"description": "REST client of files-storage-backend",
 	"author": "Henry Kimura",
 	"license": "MIT",