@htkimura/files-storage-backend.rest-client 0.0.21 → 0.0.23

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

@@ -0,0 +1,17 @@
+/**
+ * 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 File {
+    id: string;
+    createdAt: string;
+    updatedAt: string;
+    name: string;
+    type: string;
+    size: number;
+    path: string;
+    userId: string;
+}

package/dist/generated/model/file.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/fileWithPresignedUrl.d.ts

@@ -0,0 +1,18 @@
+/**
+ * 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 FileWithPresignedUrl {
+    id: string;
+    createdAt: string;
+    updatedAt: string;
+    name: string;
+    type: string;
+    size: number;
+    path: string;
+    userId: string;
+    presignedUrl: string;
+}

package/dist/generated/model/fileWithPresignedUrl.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/getBulkFilesByIdsParams.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 type GetBulkFilesByIdsParams = {
+    ids: string[];
+};

package/dist/generated/model/getBulkFilesByIdsParams.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/getPresignedUrlParams.d.ts

@@ -0,0 +1,12 @@
+/**
+ * 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 GetPresignedUrlParams = {
+    fileName: string;
+    fileType: string;
+    fileSize: number;
+};

package/dist/generated/model/getPresignedUrlParams.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/index.d.ts

@@ -6,8 +6,11 @@
  * OpenAPI spec version: 1.0
  */
 export * from './createUserDto';
+export * from './file';
+export * from './fileWithPresignedUrl';
+export * from './getBulkFilesByIdsParams';
+export * from './getPresignedUrlParams';
 export * from './loginDto';
 export * from './refreshTokenDto';
-export * from './storageControllerGetPresignedUrlParams';
 export * from './user';
 export * from './userLogin';

package/dist/generated/model/index.js

@@ -6,8 +6,11 @@
  * OpenAPI spec version: 1.0
  */
 export * from './createUserDto';
+export * from './file';
+export * from './fileWithPresignedUrl';
+export * from './getBulkFilesByIdsParams';
+export * from './getPresignedUrlParams';
 export * from './loginDto';
 export * from './refreshTokenDto';
-export * from './storageControllerGetPresignedUrlParams';
 export * from './user';
 export * from './userLogin';

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

@@ -1,18 +1,71 @@
 import type { QueryKey, UseQueryOptions, UseQueryResult } from '@tanstack/react-query';
 import type { AxiosError, AxiosRequestConfig, AxiosResponse } from 'axios';
-import type { StorageControllerGetPresignedUrlParams } from '.././model';
-export declare const storageControllerGetPresignedUrl: (params: StorageControllerGetPresignedUrlParams, options?: AxiosRequestConfig) => Promise<AxiosResponse<void>>;
-export declare const getStorageControllerGetPresignedUrlQueryKey: (params: StorageControllerGetPresignedUrlParams) => readonly ["/uploads/presigned-url", ...StorageControllerGetPresignedUrlParams[]];
-export declare const getStorageControllerGetPresignedUrlQueryOptions: <TData = AxiosResponse<void, any>, TError = AxiosError<unknown, any>>(params: StorageControllerGetPresignedUrlParams, options?: {
-    query?: UseQueryOptions<Awaited<ReturnType<typeof storageControllerGetPresignedUrl>>, TError, TData>;
+import type { FileWithPresignedUrl, GetBulkFilesByIdsParams, GetPresignedUrlParams } from '.././model';
+/**
+ * Returns presigned url to upload file
+ * @summary Get presigned url to upload file
+ */
+export declare const getPresignedUrl: (params: GetPresignedUrlParams, options?: AxiosRequestConfig) => Promise<AxiosResponse<string>>;
+export declare const getGetPresignedUrlQueryKey: (params: GetPresignedUrlParams) => readonly ["/uploads/presigned-url", ...GetPresignedUrlParams[]];
+export declare const getGetPresignedUrlQueryOptions: <TData = AxiosResponse<string, any>, TError = AxiosError<unknown, any>>(params: GetPresignedUrlParams, options?: {
+    query?: UseQueryOptions<Awaited<ReturnType<typeof getPresignedUrl>>, TError, TData>;
     axios?: AxiosRequestConfig;
-}) => UseQueryOptions<Awaited<ReturnType<typeof storageControllerGetPresignedUrl>>, TError, TData> & {
+}) => UseQueryOptions<Awaited<ReturnType<typeof getPresignedUrl>>, TError, TData> & {
     queryKey: QueryKey;
 };
-export type StorageControllerGetPresignedUrlQueryResult = NonNullable<Awaited<ReturnType<typeof storageControllerGetPresignedUrl>>>;
-export type StorageControllerGetPresignedUrlQueryError = AxiosError<unknown>;
-export declare function useStorageControllerGetPresignedUrl<TData = Awaited<ReturnType<typeof storageControllerGetPresignedUrl>>, TError = AxiosError<unknown>>(params: StorageControllerGetPresignedUrlParams, options?: {
-    query?: UseQueryOptions<Awaited<ReturnType<typeof storageControllerGetPresignedUrl>>, TError, TData>;
+export type GetPresignedUrlQueryResult = NonNullable<Awaited<ReturnType<typeof getPresignedUrl>>>;
+export type GetPresignedUrlQueryError = AxiosError<unknown>;
+/**
+ * @summary Get presigned url to upload file
+ */
+export declare function useGetPresignedUrl<TData = Awaited<ReturnType<typeof getPresignedUrl>>, TError = AxiosError<unknown>>(params: GetPresignedUrlParams, options?: {
+    query?: UseQueryOptions<Awaited<ReturnType<typeof getPresignedUrl>>, TError, TData>;
+    axios?: AxiosRequestConfig;
+}): UseQueryResult<TData, TError> & {
+    queryKey: QueryKey;
+};
+/**
+ * Returns the authenticated user files by ids with presigned urls
+ * @summary Get the authenticated user files by ids with presigned urls
+ */
+export declare const getBulkFilesByIds: (params: GetBulkFilesByIdsParams, options?: AxiosRequestConfig) => Promise<AxiosResponse<FileWithPresignedUrl[]>>;
+export declare const getGetBulkFilesByIdsQueryKey: (params: GetBulkFilesByIdsParams) => readonly ["/files/bulk", ...GetBulkFilesByIdsParams[]];
+export declare const getGetBulkFilesByIdsQueryOptions: <TData = AxiosResponse<FileWithPresignedUrl[], any>, TError = AxiosError<unknown, any>>(params: GetBulkFilesByIdsParams, options?: {
+    query?: UseQueryOptions<Awaited<ReturnType<typeof getBulkFilesByIds>>, TError, TData>;
+    axios?: AxiosRequestConfig;
+}) => UseQueryOptions<Awaited<ReturnType<typeof getBulkFilesByIds>>, TError, TData> & {
+    queryKey: QueryKey;
+};
+export type GetBulkFilesByIdsQueryResult = NonNullable<Awaited<ReturnType<typeof getBulkFilesByIds>>>;
+export type GetBulkFilesByIdsQueryError = AxiosError<unknown>;
+/**
+ * @summary Get the authenticated user files by ids with presigned urls
+ */
+export declare function useGetBulkFilesByIds<TData = Awaited<ReturnType<typeof getBulkFilesByIds>>, TError = AxiosError<unknown>>(params: GetBulkFilesByIdsParams, options?: {
+    query?: UseQueryOptions<Awaited<ReturnType<typeof getBulkFilesByIds>>, TError, TData>;
+    axios?: AxiosRequestConfig;
+}): UseQueryResult<TData, TError> & {
+    queryKey: QueryKey;
+};
+/**
+ * Returns file by id with presigned url
+ * @summary Get file by id with presigned url
+ */
+export declare const getFileById: (id: string, options?: AxiosRequestConfig) => Promise<AxiosResponse<FileWithPresignedUrl>>;
+export declare const getGetFileByIdQueryKey: (id: string) => readonly [`/files/${string}`];
+export declare const getGetFileByIdQueryOptions: <TData = AxiosResponse<FileWithPresignedUrl, any>, TError = AxiosError<unknown, any>>(id: string, options?: {
+    query?: UseQueryOptions<Awaited<ReturnType<typeof getFileById>>, TError, TData>;
+    axios?: AxiosRequestConfig;
+}) => UseQueryOptions<Awaited<ReturnType<typeof getFileById>>, TError, TData> & {
+    queryKey: QueryKey;
+};
+export type GetFileByIdQueryResult = NonNullable<Awaited<ReturnType<typeof getFileById>>>;
+export type GetFileByIdQueryError = AxiosError<unknown>;
+/**
+ * @summary Get file by id with presigned url
+ */
+export declare function useGetFileById<TData = Awaited<ReturnType<typeof getFileById>>, TError = AxiosError<unknown>>(id: string, options?: {
+    query?: UseQueryOptions<Awaited<ReturnType<typeof getFileById>>, TError, TData>;
     axios?: AxiosRequestConfig;
 }): UseQueryResult<TData, TError> & {
     queryKey: QueryKey;

package/dist/generated/storage/storage.js

@@ -7,23 +7,83 @@
  */
 import { useQuery } from '@tanstack/react-query';
 import axios from 'axios';
-export const storageControllerGetPresignedUrl = (params, options) => {
+/**
+ * Returns presigned url to upload file
+ * @summary Get presigned url to upload file
+ */
+export const getPresignedUrl = (params, options) => {
     return axios.get(`/uploads/presigned-url`, {
         ...options,
         params: { ...params, ...options?.params },
     });
 };
-export const getStorageControllerGetPresignedUrlQueryKey = (params) => {
+export const getGetPresignedUrlQueryKey = (params) => {
     return [`/uploads/presigned-url`, ...(params ? [params] : [])];
 };
-export const getStorageControllerGetPresignedUrlQueryOptions = (params, options) => {
+export const getGetPresignedUrlQueryOptions = (params, options) => {
+    const { query: queryOptions, axios: axiosOptions } = options ?? {};
+    const queryKey = queryOptions?.queryKey ?? getGetPresignedUrlQueryKey(params);
+    const queryFn = ({ signal }) => getPresignedUrl(params, { signal, ...axiosOptions });
+    return { queryKey, queryFn, ...queryOptions };
+};
+/**
+ * @summary Get presigned url to upload file
+ */
+export function useGetPresignedUrl(params, options) {
+    const queryOptions = getGetPresignedUrlQueryOptions(params, options);
+    const query = useQuery(queryOptions);
+    query.queryKey = queryOptions.queryKey;
+    return query;
+}
+/**
+ * Returns the authenticated user files by ids with presigned urls
+ * @summary Get the authenticated user files by ids with presigned urls
+ */
+export const getBulkFilesByIds = (params, options) => {
+    return axios.get(`/files/bulk`, {
+        ...options,
+        params: { ...params, ...options?.params },
+    });
+};
+export const getGetBulkFilesByIdsQueryKey = (params) => {
+    return [`/files/bulk`, ...(params ? [params] : [])];
+};
+export const getGetBulkFilesByIdsQueryOptions = (params, options) => {
     const { query: queryOptions, axios: axiosOptions } = options ?? {};
-    const queryKey = queryOptions?.queryKey ?? getStorageControllerGetPresignedUrlQueryKey(params);
-    const queryFn = ({ signal }) => storageControllerGetPresignedUrl(params, { signal, ...axiosOptions });
+    const queryKey = queryOptions?.queryKey ?? getGetBulkFilesByIdsQueryKey(params);
+    const queryFn = ({ signal }) => getBulkFilesByIds(params, { signal, ...axiosOptions });
     return { queryKey, queryFn, ...queryOptions };
 };
-export function useStorageControllerGetPresignedUrl(params, options) {
-    const queryOptions = getStorageControllerGetPresignedUrlQueryOptions(params, options);
+/**
+ * @summary Get the authenticated user files by ids with presigned urls
+ */
+export function useGetBulkFilesByIds(params, options) {
+    const queryOptions = getGetBulkFilesByIdsQueryOptions(params, options);
+    const query = useQuery(queryOptions);
+    query.queryKey = queryOptions.queryKey;
+    return query;
+}
+/**
+ * Returns file by id with presigned url
+ * @summary Get file by id with presigned url
+ */
+export const getFileById = (id, options) => {
+    return axios.get(`/files/${id}`, options);
+};
+export const getGetFileByIdQueryKey = (id) => {
+    return [`/files/${id}`];
+};
+export const getGetFileByIdQueryOptions = (id, options) => {
+    const { query: queryOptions, axios: axiosOptions } = options ?? {};
+    const queryKey = queryOptions?.queryKey ?? getGetFileByIdQueryKey(id);
+    const queryFn = ({ signal }) => getFileById(id, { signal, ...axiosOptions });
+    return { queryKey, queryFn, enabled: !!(id), ...queryOptions };
+};
+/**
+ * @summary Get file by id with presigned url
+ */
+export function useGetFileById(id, options) {
+    const queryOptions = getGetFileByIdQueryOptions(id, options);
     const query = useQuery(queryOptions);
     query.queryKey = queryOptions.queryKey;
     return query;

package/dist/generated/user/user.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 { CreateUserDto, LoginDto, RefreshTokenDto, User, UserLogin } from '.././model';
+import type { CreateUserDto, File, LoginDto, RefreshTokenDto, User, UserLogin } from '.././model';
 /**
  * Creates a new user and returns the created user. We don't have plans for now to implement this on frontend, but it's here for testing purposes
  * @summary Sign up route where a user is created
@@ -109,9 +109,9 @@ export declare function useMe<TData = Awaited<ReturnType<typeof me>>, TError = A
  * Returns the authenticated user files URLs
  * @summary Get the authenticated user files URLs
  */
-export declare const myFiles: (options?: AxiosRequestConfig) => Promise<AxiosResponse<string[]>>;
+export declare const myFiles: (options?: AxiosRequestConfig) => Promise<AxiosResponse<File[]>>;
 export declare const getMyFilesQueryKey: () => readonly ["/users/me/files"];
-export declare const getMyFilesQueryOptions: <TData = AxiosResponse<string[], any>, TError = AxiosError<unknown, any>>(options?: {
+export declare const getMyFilesQueryOptions: <TData = AxiosResponse<File[], any>, TError = AxiosError<unknown, any>>(options?: {
     query?: UseQueryOptions<Awaited<ReturnType<typeof myFiles>>, TError, TData>;
     axios?: AxiosRequestConfig;
 }) => UseQueryOptions<Awaited<ReturnType<typeof myFiles>>, TError, TData> & {

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@htkimura/files-storage-backend.rest-client",
-	"version": "0.0.21",
+	"version": "0.0.23",
 	"description": "REST client of files-storage-backend",
 	"author": "Henry Kimura",
 	"license": "MIT",
@@ -17,7 +17,7 @@
 	],
 	"scripts": {
 		"buildPackage": "tsc -p tsconfig.build.json",
-		"publish": "buildPackage && npm publish --access public"
+		"publishPackage": "yarn buildPackage && npm publish --access public"
 	},
 	"peerDependencies": {
 		"@tanstack/react-query": "^5.66.0",