@01.software/sdk 0.1.0-dev.260206.8918543 → 0.1.0-dev.260211.a92d27b

package/dist/index.d.ts

@@ -510,17 +510,15 @@ interface Product {
     id: number;
     _order?: string | null;
     tenant?: (number | null) | Tenant;
-    /**
-     * 영문, 숫자, _(언더스코어), -(하이픈)만 사용가능합니다.
-     */
-    sku: string;
+    title: string;
+    subTitle?: string | null;
     /**
      * When enabled, the slug will auto-generate from the title field on save and autosave.
      */
     generateSlug?: boolean | null;
-    slug: string;
-    title: string;
-    subTitle?: string | null;
+    slug?: string | null;
+    status?: ('draft' | 'published' | 'archived') | null;
+    isSoldOut?: boolean | null;
     thumbnail?: (number | null) | ProductImage;
     images?: (number | ProductImage)[] | null;
     description?: {
@@ -553,10 +551,8 @@ interface Product {
         hasNextPage?: boolean;
         totalDocs?: number;
     };
-    isSoldOut?: boolean | null;
     updatedAt: string;
     createdAt: string;
-    _status?: ('draft' | 'published') | null;
 }
 /**
  * This interface was referenced by `Config`'s JSON-Schema
@@ -656,7 +652,7 @@ interface Brand {
      * When enabled, the slug will auto-generate from the title field on save and autosave.
      */
     generateSlug?: boolean | null;
-    slug: string;
+    slug?: string | null;
     /**
      * Primary brand logo
      */
@@ -724,6 +720,7 @@ interface Order {
     orderNumber: string;
     status: 'pending' | 'paid' | 'failed' | 'canceled' | 'preparing' | 'shipped' | 'delivered' | 'confirmed' | 'return_requested' | 'return_processing' | 'returned';
     totalAmount?: number | null;
+    name?: string | null;
     email?: string | null;
     shippingCarrier?: ('cj' | 'hanjin' | 'lotte' | 'epost' | 'logen' | 'other') | null;
     trackingNumber?: string | null;
@@ -767,7 +764,7 @@ interface OrderProduct {
     order: number | Order;
     product: number | Product;
     variant?: (number | null) | ProductVariant;
-    option: number | ProductOption;
+    option?: (number | null) | ProductOption;
     quantity: number;
     title?: string | null;
     updatedAt: string;
@@ -983,7 +980,7 @@ interface Post {
      * When enabled, the slug will auto-generate from the title field on save and autosave.
      */
     generateSlug?: boolean | null;
-    slug: string;
+    slug?: string | null;
     categories?: (number | PostCategory)[] | null;
     tags?: (number | PostTag)[] | null;
     content?: {
@@ -1772,11 +1769,12 @@ interface TenantOgImagesSelect<T extends boolean = true> {
 interface ProductsSelect<T extends boolean = true> {
     _order?: T;
     tenant?: T;
-    sku?: T;
-    generateSlug?: T;
-    slug?: T;
     title?: T;
     subTitle?: T;
+    generateSlug?: T;
+    slug?: T;
+    status?: T;
+    isSoldOut?: T;
     thumbnail?: T;
     images?: T;
     description?: T;
@@ -1787,10 +1785,8 @@ interface ProductsSelect<T extends boolean = true> {
     brand?: T;
     variants?: T;
     options?: T;
-    isSoldOut?: T;
     updatedAt?: T;
     createdAt?: T;
-    _status?: T;
 }
 /**
  * This interface was referenced by `Config`'s JSON-Schema
@@ -1955,6 +1951,7 @@ interface OrdersSelect<T extends boolean = true> {
     orderNumber?: T;
     status?: T;
     totalAmount?: T;
+    name?: T;
     email?: T;
     shippingCarrier?: T;
     trackingNumber?: T;
@@ -2643,23 +2640,36 @@ interface PaginationMeta {
     totalPages: number;
     hasNextPage: boolean;
     hasPrevPage: boolean;
+    pagingCounter: number;
+    prevPage: number | null;
+    nextPage: number | null;
 }
-interface ApiSuccessResponse<T = unknown> {
-    data: T;
-    success: true;
-    message?: string;
-    pagination?: PaginationMeta;
+/**
+ * Payload CMS Find (List) Response
+ * GET /api/{collection}
+ */
+interface PayloadFindResponse<T = unknown> {
+    docs: T[];
+    totalDocs: number;
+    limit: number;
+    totalPages: number;
+    page: number;
+    pagingCounter: number;
+    hasPrevPage: boolean;
+    hasNextPage: boolean;
+    prevPage: number | null;
+    nextPage: number | null;
 }
-interface ApiErrorResponse {
-    data: null;
-    success: false;
-    error: {
-        code: string;
-        message: string;
-        details?: unknown;
-    };
+/**
+ * Payload CMS Create/Update Response
+ * POST /api/{collection}
+ * PATCH /api/{collection}/{id}
+ */
+interface PayloadMutationResponse<T = unknown> {
+    message: string;
+    doc: T;
+    errors?: unknown[];
 }
-type ApiResponse<T = unknown> = ApiSuccessResponse<T> | ApiErrorResponse;
 interface ApiQueryOptions {
     page?: number;
     limit?: number;
@@ -2686,8 +2696,6 @@ type DeepPartial<T> = {
     [P in keyof T]?: T[P] extends object ? DeepPartial<T[P]> : T[P];
 };
 type ExtractArrayType<T> = T extends (infer U)[] ? U : never;
-declare function isSuccessResponse<T>(response: ApiResponse<T>): response is ApiSuccessResponse<T>;
-declare function isErrorResponse(response: ApiResponse<unknown>): response is ApiErrorResponse;
 
 type CollectionType<T extends Collection> = T extends keyof Config['collections'] ? Config['collections'][T] : never;
 
@@ -2788,32 +2796,130 @@ declare class BaseApiClient {
     protected baseUrl?: string;
     protected defaultOptions: FetchOptions;
     constructor(clientKey: string, secretKey?: string, baseUrl?: string);
-    protected get<T = unknown>(endpoint: string, options?: ApiQueryOptions): Promise<ApiResponse<T>>;
-    protected post<T = unknown>(endpoint: string, data?: unknown, options?: FetchOptions): Promise<ApiResponse<T>>;
-    protected patch<T = unknown>(endpoint: string, data?: unknown, options?: FetchOptions): Promise<ApiResponse<T>>;
-    protected delete<T = unknown>(endpoint: string, options?: FetchOptions): Promise<ApiResponse<T>>;
     protected buildUrl(endpoint: string, options?: ApiQueryOptions): string;
-    protected parseResponse<T>(response: Response): Promise<ApiResponse<T>>;
+    /**
+     * Parse Payload CMS find response (list query)
+     * Returns native Payload response structure
+     */
+    protected parseFindResponse<T>(response: Response): Promise<PayloadFindResponse<T>>;
+    /**
+     * Parse Payload CMS mutation response (create/update)
+     * Returns native Payload response structure
+     */
+    protected parseMutationResponse<T>(response: Response): Promise<PayloadMutationResponse<T>>;
+    /**
+     * Parse Payload CMS document response (findById/delete)
+     * Returns document directly without wrapper
+     */
+    protected parseDocumentResponse<T>(response: Response): Promise<T>;
 }
 
 declare class CollectionsApi extends BaseApiClient {
     constructor(clientKey: string, secretKey?: string, baseUrl?: string);
     from<T extends Collection>(collection: T): CollectionQueryBuilder<T>;
-    requestGet<T = unknown>(endpoint: string, options?: ApiQueryOptions): Promise<ApiResponse<T>>;
-    requestPost<T = unknown>(endpoint: string, data?: unknown): Promise<ApiResponse<T>>;
-    requestPatch<T = unknown>(endpoint: string, data?: unknown): Promise<ApiResponse<T>>;
-    requestDelete<T = unknown>(endpoint: string): Promise<ApiResponse<T>>;
+    /**
+     * Find documents (list query)
+     * GET /api/{collection}
+     */
+    requestFind<T = unknown>(endpoint: string, options?: ApiQueryOptions): Promise<PayloadFindResponse<T>>;
+    /**
+     * Find document by ID
+     * GET /api/{collection}/{id}
+     */
+    requestFindById<T = unknown>(endpoint: string, options?: ApiQueryOptions): Promise<T>;
+    /**
+     * Create document
+     * POST /api/{collection}
+     */
+    requestCreate<T = unknown>(endpoint: string, data?: unknown): Promise<PayloadMutationResponse<T>>;
+    /**
+     * Update document
+     * PATCH /api/{collection}/{id}
+     */
+    requestUpdate<T = unknown>(endpoint: string, data?: unknown): Promise<PayloadMutationResponse<T>>;
+    /**
+     * Count documents
+     * GET /api/{collection}/count
+     */
+    requestCount(endpoint: string, options?: ApiQueryOptions): Promise<{
+        totalDocs: number;
+    }>;
+    /**
+     * Update multiple documents (bulk update)
+     * PATCH /api/{collection}
+     */
+    requestUpdateMany<T = unknown>(endpoint: string, data: {
+        where?: unknown;
+        data: unknown;
+    }): Promise<PayloadFindResponse<T>>;
+    /**
+     * Delete document
+     * DELETE /api/{collection}/{id}
+     */
+    requestDelete<T = unknown>(endpoint: string): Promise<T>;
+    /**
+     * Delete multiple documents (bulk delete)
+     * DELETE /api/{collection}
+     */
+    requestDeleteMany<T = unknown>(endpoint: string, data: {
+        where?: unknown;
+    }): Promise<PayloadFindResponse<T>>;
 }
 
 declare class CollectionQueryBuilder<T extends Collection> {
     private api;
     private collection;
     constructor(api: CollectionsApi, collection: T);
-    find(options?: ApiQueryOptions): Promise<ApiResponse<CollectionType<T>[]>>;
-    findById(id: number | string, options?: ApiQueryOptions): Promise<ApiResponse<CollectionType<T>>>;
-    create(data: Partial<CollectionType<T>>): Promise<ApiResponse<CollectionType<T>>>;
-    update(id: number | string, data: Partial<CollectionType<T>>): Promise<ApiResponse<CollectionType<T>>>;
-    remove(id: number | string): Promise<ApiResponse<void>>;
+    /**
+     * Find documents (list query)
+     * GET /api/{collection}
+     * @returns Payload CMS find response with docs array and pagination
+     */
+    find(options?: ApiQueryOptions): Promise<PayloadFindResponse<CollectionType<T>>>;
+    /**
+     * Find document by ID
+     * GET /api/{collection}/{id}
+     * @returns Document object directly (no wrapper)
+     */
+    findById(id: number | string, options?: ApiQueryOptions): Promise<CollectionType<T>>;
+    /**
+     * Create a new document
+     * POST /api/{collection}
+     * @returns Payload CMS mutation response with doc and message
+     */
+    create(data: Partial<CollectionType<T>>): Promise<PayloadMutationResponse<CollectionType<T>>>;
+    /**
+     * Update a document by ID
+     * PATCH /api/{collection}/{id}
+     * @returns Payload CMS mutation response with doc and message
+     */
+    update(id: number | string, data: Partial<CollectionType<T>>): Promise<PayloadMutationResponse<CollectionType<T>>>;
+    /**
+     * Count documents
+     * GET /api/{collection}/count
+     * @returns Count response with totalDocs
+     */
+    count(options?: ApiQueryOptions): Promise<{
+        totalDocs: number;
+    }>;
+    /**
+     * Update multiple documents (bulk update)
+     * PATCH /api/{collection}
+     * @returns Payload CMS find response with updated docs
+     */
+    updateMany(where: ApiQueryOptions['where'], data: Partial<CollectionType<T>>): Promise<PayloadFindResponse<CollectionType<T>>>;
+    /**
+     * Delete a document by ID
+     * DELETE /api/{collection}/{id}
+     * @returns Deleted document object directly (no wrapper)
+     */
+    remove(id: number | string): Promise<CollectionType<T>>;
+    /**
+     * Delete multiple documents (bulk delete)
+     * DELETE /api/{collection}
+     * @returns Payload CMS find response with deleted docs
+     */
+    removeMany(where: ApiQueryOptions['where']): Promise<PayloadFindResponse<CollectionType<T>>>;
 }
 
 interface UnifiedQueryOptions {
@@ -2872,7 +2978,7 @@ declare class UnifiedQueryClient {
         refetchOnMount?: boolean;
         refetchInterval?: number | false;
         retry?: boolean | number;
-    }): _tanstack_react_query.UseQueryResult<_tanstack_react_query.NoInfer<CollectionType<T> | null>, Error>;
+    }): _tanstack_react_query.UseQueryResult<_tanstack_react_query.NoInfer<CollectionType<T>>, Error>;
     useSuspenseQueryById<T extends Collection>(params: CollectionDetailQueryParams<T>, options?: {
         staleTime?: number;
         gcTime?: number;
@@ -2880,7 +2986,7 @@ declare class UnifiedQueryClient {
         refetchOnMount?: boolean;
         refetchInterval?: number | false;
         retry?: boolean | number;
-    }): _tanstack_react_query.UseSuspenseQueryResult<CollectionType<T> | null, Error>;
+    }): _tanstack_react_query.UseSuspenseQueryResult<CollectionType<T>, Error>;
     useInfiniteQuery<T extends Collection>(params: CollectionInfiniteQueryParams<T>, options?: {
         enabled?: boolean;
         staleTime?: number;
@@ -2888,14 +2994,14 @@ declare class UnifiedQueryClient {
         refetchOnWindowFocus?: boolean;
         refetchOnMount?: boolean;
         retry?: boolean | number;
-    }): _tanstack_react_query.UseInfiniteQueryResult<_tanstack_react_query.InfiniteData<CollectionType<T>[], unknown>, Error>;
+    }): _tanstack_react_query.UseInfiniteQueryResult<_tanstack_react_query.InfiniteData<PayloadFindResponse<CollectionType<T>>, unknown>, Error>;
     useSuspenseInfiniteQuery<T extends Collection>(params: CollectionInfiniteQueryParams<T>, options?: {
         staleTime?: number;
         gcTime?: number;
         refetchOnWindowFocus?: boolean;
         refetchOnMount?: boolean;
         retry?: boolean | number;
-    }): _tanstack_react_query.UseSuspenseInfiniteQueryResult<_tanstack_react_query.InfiniteData<CollectionType<T>[], unknown>, Error>;
+    }): _tanstack_react_query.UseSuspenseInfiniteQueryResult<_tanstack_react_query.InfiniteData<PayloadFindResponse<CollectionType<T>>, unknown>, Error>;
     prefetchQuery<T extends Collection>(params: CollectionQueryParams<T>, options?: {
         staleTime?: number;
     }): Promise<void>;
@@ -3014,4 +3120,4 @@ interface RichTextContentProps {
 }
 declare function RichTextContent({ data, className, internalDocToHref, blocks, }: RichTextContentProps): React.JSX.Element;
 
-export { API_URLS, ApiClient, type ApiClientOptions, ApiError, type ApiErrorResponse, type ApiQueryOptions, type ApiQueryReactOptions, type ApiResponse, type ApiSuccessResponse, type Auth, type Brand, type BrandLogo, type BrandLogosSelect, type BrandsSelect, BrowserClient, BrowserClient as BrowserClientType, COLLECTIONS, type ClientBrowserConfig, type ClientMetadata, type ClientServerConfig, type ClientState, type Collection, type CollectionDetailQueryParams, type CollectionInfiniteQueryParams, CollectionQueryBuilder, type CollectionQueryParams, type CollectionType, CollectionsApi, type Config, ConfigError, type CreateOrderParams, type DebugConfig, type DeepPartial, type Document, type DocumentCategoriesSelect, type DocumentCategory, type DocumentImage, type DocumentImagesSelect, type DocumentsSelect, type Environment, type ErrorLogger, type ExtractArrayType, type Form, type FormSubmission, type FormSubmissionsSelect, type FormsSelect, type GalleriesSelect, type Gallery, type GalleryImage, type GalleryImagesSelect, type IframeBlock, type JwtPayload, type Media, type MediaSelect, type Music, type MusicsSelect, NetworkError, type Order, type OrderProduct, type OrderProductsSelect, type OrdersSelect, type PaginationMeta, type PayloadKv, type PayloadKvSelect, type PayloadLockedDocument, type PayloadLockedDocumentsSelect, type PayloadMigration, type PayloadMigrationsSelect, type PayloadPreference, type PayloadPreferencesSelect, type PlayerBlock, type Playlist, type PlaylistImage, type PlaylistImagesSelect, type PlaylistsSelect, type Post, type PostCategoriesSelect, type PostCategory, type PostImage, type PostImagesSelect, type PostTag, type PostTagsSelect, type PostsSelect, type Product, type ProductCategoriesSelect, type ProductCategory, type ProductImage, type ProductImagesSelect, type ProductOption, type ProductOptionsSelect, type ProductTag, type ProductTagsSelect, type ProductVariant, type ProductVariantsSelect, type ProductsSelect, type PublicCollection, type RetryConfig, type Return, type ReturnProduct, type ReturnProductsSelect, type ReturnsSelect, RichTextContent, type RichTextContentProps, type RichTextData, SDKError, ServerClient, ServerClient as ServerClientType, type SupportedTimezones, type Tenant, type TenantLogo, type TenantLogosSelect, type TenantMetadataSelect, type TenantMetadatum, type TenantOgImage, type TenantOgImagesSelect, type TenantsSelect, TimeoutError, type Transaction, type TransactionsSelect, UnifiedQueryClient, type UnifiedQueryOptions, type UpdateOrderParams, type UpdateTransactionParams, type User, type UserAuthOperations, type UsersSelect, ValidationError, type WebhookEvent, type WebhookHandler, type WebhookOperation, collectionKeys, createApiKey, createBrowserClient, createServerClient, createServerToken, createTypedWebhookHandler, decodeServerToken, formatOrderName, generateOrderNumber, getQueryClient, handleWebhook, isApiError, isConfigError, isErrorResponse, isNetworkError, isSDKError, isSuccessResponse, isTimeoutError, isValidWebhookEvent, isValidationError, objectFor, parseApiKey, resolveApiUrl, verifyServerToken };
+export { API_URLS, ApiClient, type ApiClientOptions, ApiError, type ApiQueryOptions, type ApiQueryReactOptions, type Auth, type Brand, type BrandLogo, type BrandLogosSelect, type BrandsSelect, BrowserClient, BrowserClient as BrowserClientType, COLLECTIONS, type ClientBrowserConfig, type ClientMetadata, type ClientServerConfig, type ClientState, type Collection, type CollectionDetailQueryParams, type CollectionInfiniteQueryParams, CollectionQueryBuilder, type CollectionQueryParams, type CollectionType, CollectionsApi, type Config, ConfigError, type CreateOrderParams, type DebugConfig, type DeepPartial, type Document, type DocumentCategoriesSelect, type DocumentCategory, type DocumentImage, type DocumentImagesSelect, type DocumentsSelect, type Environment, type ErrorLogger, type ExtractArrayType, type Form, type FormSubmission, type FormSubmissionsSelect, type FormsSelect, type GalleriesSelect, type Gallery, type GalleryImage, type GalleryImagesSelect, type IframeBlock, type JwtPayload, type Media, type MediaSelect, type Music, type MusicsSelect, NetworkError, type Order, type OrderProduct, type OrderProductsSelect, type OrdersSelect, type PaginationMeta, type PayloadFindResponse, type PayloadKv, type PayloadKvSelect, type PayloadLockedDocument, type PayloadLockedDocumentsSelect, type PayloadMigration, type PayloadMigrationsSelect, type PayloadMutationResponse, type PayloadPreference, type PayloadPreferencesSelect, type PlayerBlock, type Playlist, type PlaylistImage, type PlaylistImagesSelect, type PlaylistsSelect, type Post, type PostCategoriesSelect, type PostCategory, type PostImage, type PostImagesSelect, type PostTag, type PostTagsSelect, type PostsSelect, type Product, type ProductCategoriesSelect, type ProductCategory, type ProductImage, type ProductImagesSelect, type ProductOption, type ProductOptionsSelect, type ProductTag, type ProductTagsSelect, type ProductVariant, type ProductVariantsSelect, type ProductsSelect, type PublicCollection, type RetryConfig, type Return, type ReturnProduct, type ReturnProductsSelect, type ReturnsSelect, RichTextContent, type RichTextContentProps, type RichTextData, SDKError, ServerClient, ServerClient as ServerClientType, type SupportedTimezones, type Tenant, type TenantLogo, type TenantLogosSelect, type TenantMetadataSelect, type TenantMetadatum, type TenantOgImage, type TenantOgImagesSelect, type TenantsSelect, TimeoutError, type Transaction, type TransactionsSelect, UnifiedQueryClient, type UnifiedQueryOptions, type UpdateOrderParams, type UpdateTransactionParams, type User, type UserAuthOperations, type UsersSelect, ValidationError, type WebhookEvent, type WebhookHandler, type WebhookOperation, collectionKeys, createApiKey, createBrowserClient, createServerClient, createServerToken, createTypedWebhookHandler, decodeServerToken, formatOrderName, generateOrderNumber, getQueryClient, handleWebhook, isApiError, isConfigError, isNetworkError, isSDKError, isTimeoutError, isValidWebhookEvent, isValidationError, objectFor, parseApiKey, resolveApiUrl, verifyServerToken };