@01.software/sdk 0.3.0 → 0.4.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +5 -2
- package/dist/auth.d.cts +1 -1
- package/dist/auth.d.ts +1 -1
- package/dist/const-BpirbGBD.d.cts +19 -0
- package/dist/const-qZSQiSSC.d.ts +19 -0
- package/dist/index.cjs +228 -78
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +114 -196
- package/dist/index.d.ts +114 -196
- package/dist/index.js +228 -78
- package/dist/index.js.map +1 -1
- package/dist/{payload-types-ggU6BNuH.d.cts → payload-types-CZiaL4Wr.d.cts} +6 -5
- package/dist/{payload-types-ggU6BNuH.d.ts → payload-types-CZiaL4Wr.d.ts} +6 -5
- package/dist/realtime-DupPIYx-.d.cts +33 -0
- package/dist/realtime-DupPIYx-.d.ts +33 -0
- package/dist/realtime.cjs +261 -0
- package/dist/realtime.cjs.map +1 -0
- package/dist/realtime.d.cts +38 -0
- package/dist/realtime.d.ts +38 -0
- package/dist/realtime.js +239 -0
- package/dist/realtime.js.map +1 -0
- package/dist/ui/code-block.cjs +3 -1
- package/dist/ui/code-block.cjs.map +1 -1
- package/dist/ui/code-block.js +4 -2
- package/dist/ui/code-block.js.map +1 -1
- package/dist/ui/flow.cjs +18 -3
- package/dist/ui/flow.cjs.map +1 -1
- package/dist/ui/flow.js +18 -3
- package/dist/ui/flow.js.map +1 -1
- package/dist/ui/form.d.cts +1 -1
- package/dist/ui/form.d.ts +1 -1
- package/dist/ui/video.cjs +219 -0
- package/dist/ui/video.cjs.map +1 -0
- package/dist/ui/video.d.cts +96 -0
- package/dist/ui/video.d.ts +96 -0
- package/dist/ui/video.js +191 -0
- package/dist/ui/video.js.map +1 -0
- package/dist/video-DbLL8yuc.d.cts +85 -0
- package/dist/video-DbLL8yuc.d.ts +85 -0
- package/dist/webhook-3iL9OEyq.d.cts +20 -0
- package/dist/webhook-DuTqrH9x.d.ts +20 -0
- package/dist/webhook.cjs +8 -8
- package/dist/webhook.cjs.map +1 -1
- package/dist/webhook.d.cts +3 -2
- package/dist/webhook.d.ts +3 -2
- package/dist/webhook.js +8 -8
- package/dist/webhook.js.map +1 -1
- package/package.json +29 -4
- package/dist/webhook-B54a-HGd.d.ts +0 -35
- package/dist/webhook-DInps2xX.d.cts +0 -35
package/dist/index.d.cts
CHANGED
|
@@ -1,90 +1,18 @@
|
|
|
1
|
-
import { O as Order, a as OrderProduct, T as Transaction, b as Fulfillment, R as Return, E as Exchange,
|
|
2
|
-
export { o as ApiUsage, as as ApiUsageSelect, A as Audience, ao as AudiencesSelect, bo as Auth, q as BillingHistory, au as BillingHistorySelect, y as Brand, B as BrandLogo, aD as BrandLogosSelect, aC as BrandsSelect, aT as CartItemsSelect, aS as CartsSelect, g as CodeBlock, bn as CollectionsWidget,
|
|
1
|
+
import { O as Order, a as OrderProduct, T as Transaction, b as Fulfillment, R as Return, E as Exchange, c as Cart, d as CartItem, P as Product } from './payload-types-CZiaL4Wr.cjs';
|
|
2
|
+
export { o as ApiUsage, as as ApiUsageSelect, A as Audience, ao as AudiencesSelect, bo as Auth, q as BillingHistory, au as BillingHistorySelect, y as Brand, B as BrandLogo, aD as BrandLogosSelect, aC as BrandsSelect, aT as CartItemsSelect, aS as CartsSelect, g as CodeBlock, bn as CollectionsWidget, C as Config, G as Customer, J as CustomerAddress, aQ as CustomerAddressesSelect, e as CustomerAuthOperations, H as CustomerGroup, aR as CustomerGroupsSelect, aP as CustomersSelect, W as Discount, aU as DiscountsSelect, $ as Document, a_ as DocumentCategoriesSelect, a1 as DocumentCategory, a0 as DocumentType, a$ as DocumentTypesSelect, aZ as DocumentsSelect, m as EmailLog, ap as EmailLogsSelect, N as ExchangeProduct, aN as ExchangeProductsSelect, aM as ExchangesSelect, j as FieldConfig, al as FieldConfigsSelect, aa as Flow, bb as FlowCategoriesSelect, ab as FlowCategory, ae as FlowEdgeType, ba as FlowEdgeTypesSelect, ad as FlowNodeType, b9 as FlowNodeTypesSelect, ac as FlowTag, bc as FlowTagsSelect, b8 as FlowsSelect, F as Form, af as FormSubmission, bi as FormSubmissionsSelect, bh as FormsSelect, K as FulfillmentItem, aJ as FulfillmentItemsSelect, aI as FulfillmentsSelect, b4 as GalleriesSelect, a6 as Gallery, b5 as GalleryCategoriesSelect, a7 as GalleryCategory, a9 as GalleryItem, b7 as GalleryItemsSelect, a8 as GalleryTag, b6 as GalleryTagsSelect, I as IframeBlock, k as Image, am as ImagesSelect, L as LiveStream, bg as LiveStreamsSelect, a5 as Music, b3 as MusicsSelect, aF as OrderProductsSelect, Q as OrderStatusLog, aH as OrderStatusLogsSelect, aE as OrdersSelect, ag as PayloadKv, bj as PayloadKvSelect, ah as PayloadLockedDocument, bk as PayloadLockedDocumentsSelect, aj as PayloadMigration, bm as PayloadMigrationsSelect, ai as PayloadPreference, bl as PayloadPreferencesSelect, f as PlayerBlock, a2 as Playlist, b1 as PlaylistCategoriesSelect, a3 as PlaylistCategory, a4 as PlaylistTag, b2 as PlaylistTagsSelect, b0 as PlaylistsSelect, X as Post, Y as PostAuthor, aW as PostAuthorsSelect, aX as PostCategoriesSelect, Z as PostCategory, _ as PostTag, aY as PostTagsSelect, aV as PostsSelect, az as ProductCategoriesSelect, w as ProductCategory, D as ProductCollection, aB as ProductCollectionsSelect, v as ProductOption, ay as ProductOptionsSelect, x as ProductTag, aA as ProductTagsSelect, u as ProductVariant, ax as ProductVariantsSelect, aw as ProductsSelect, M as ReturnProduct, aL as ReturnProductsSelect, aK as ReturnsSelect, aO as ShippingPoliciesSelect, z as ShippingPolicy, p as Subscription, at as SubscriptionsSelect, S as SupportedTimezones, l as SystemMedia, an as SystemMediaSelect, i as Tenant, r as TenantLogo, av as TenantLogosSelect, ar as TenantMetadataSelect, n as TenantMetadatum, aq as TenantsSelect, aG as TransactionsSelect, h as User, U as UserAuthOperations, ak as UsersSelect, V as Video, be as VideoCategoriesSelect, s as VideoCategory, t as VideoTag, bf as VideoTagsSelect, bd as VideosSelect } from './payload-types-CZiaL4Wr.cjs';
|
|
3
3
|
import { Sort, Where } from 'payload';
|
|
4
4
|
import * as _tanstack_react_query from '@tanstack/react-query';
|
|
5
5
|
import { QueryClient } from '@tanstack/react-query';
|
|
6
|
-
import { P as PublicCollection
|
|
7
|
-
export {
|
|
6
|
+
import { P as PublicCollection } from './const-BpirbGBD.cjs';
|
|
7
|
+
export { a as COLLECTIONS, C as Collection } from './const-BpirbGBD.cjs';
|
|
8
8
|
import { Metadata } from 'next';
|
|
9
|
+
import { C as CollectionType } from './webhook-3iL9OEyq.cjs';
|
|
10
|
+
export { a as WebhookEvent, b as WebhookHandler, W as WebhookOperation, c as WebhookOptions, d as createTypedWebhookHandler, h as handleWebhook, i as isValidWebhookEvent } from './webhook-3iL9OEyq.cjs';
|
|
11
|
+
export { a as RealtimeConnection, R as RealtimeEvent, b as RealtimeListener } from './realtime-DupPIYx-.cjs';
|
|
9
12
|
export { b as IMAGE_SIZES, I as ImageData, a as ImagePalette, f as ImagePlaceholderOptions, d as getImageLqip, e as getImagePalette, h as getImagePlaceholderStyle, c as getImageSrcSet, g as getImageUrl } from './image-TT8lTsk5.cjs';
|
|
13
|
+
export { e as VideoGifOptions, V as VideoThumbnailOptions, a as getVideoGif, c as getVideoMp4Url, d as getVideoStoryboard, b as getVideoStreamUrl, g as getVideoThumbnail } from './video-DbLL8yuc.cjs';
|
|
10
14
|
export { JwtPayload, createApiKey, createServerToken, decodeServerToken, parseApiKey, verifyServerToken } from './auth.cjs';
|
|
11
15
|
|
|
12
|
-
declare class SDKError extends Error {
|
|
13
|
-
readonly code: string;
|
|
14
|
-
readonly status?: number;
|
|
15
|
-
readonly details?: unknown;
|
|
16
|
-
readonly userMessage?: string;
|
|
17
|
-
readonly suggestion?: string;
|
|
18
|
-
constructor(code: string, message: string, status?: number, details?: unknown, userMessage?: string, suggestion?: string);
|
|
19
|
-
getUserMessage(): string;
|
|
20
|
-
toJSON(): {
|
|
21
|
-
name: string;
|
|
22
|
-
code: string;
|
|
23
|
-
message: string;
|
|
24
|
-
status: number | undefined;
|
|
25
|
-
details: unknown;
|
|
26
|
-
userMessage: string | undefined;
|
|
27
|
-
suggestion: string | undefined;
|
|
28
|
-
};
|
|
29
|
-
}
|
|
30
|
-
declare class NetworkError extends SDKError {
|
|
31
|
-
constructor(message: string, status?: number, details?: unknown, userMessage?: string, suggestion?: string);
|
|
32
|
-
}
|
|
33
|
-
declare class ValidationError extends SDKError {
|
|
34
|
-
constructor(message: string, details?: unknown, userMessage?: string, suggestion?: string);
|
|
35
|
-
}
|
|
36
|
-
declare class ApiError extends SDKError {
|
|
37
|
-
constructor(message: string, status: number, details?: unknown, userMessage?: string, suggestion?: string);
|
|
38
|
-
}
|
|
39
|
-
declare class ConfigError extends SDKError {
|
|
40
|
-
constructor(message: string, details?: unknown, userMessage?: string, suggestion?: string);
|
|
41
|
-
}
|
|
42
|
-
declare class TimeoutError extends SDKError {
|
|
43
|
-
constructor(message?: string, details?: unknown, userMessage?: string, suggestion?: string);
|
|
44
|
-
}
|
|
45
|
-
declare class GoneError extends SDKError {
|
|
46
|
-
constructor(message?: string, details?: unknown, userMessage?: string, suggestion?: string);
|
|
47
|
-
}
|
|
48
|
-
declare class ServiceUnavailableError extends SDKError {
|
|
49
|
-
readonly retryAfter?: number;
|
|
50
|
-
constructor(message?: string, retryAfter?: number, details?: unknown, userMessage?: string, suggestion?: string);
|
|
51
|
-
}
|
|
52
|
-
declare class UsageLimitError extends SDKError {
|
|
53
|
-
readonly usage: {
|
|
54
|
-
limit: number;
|
|
55
|
-
current: number;
|
|
56
|
-
remaining: number;
|
|
57
|
-
};
|
|
58
|
-
constructor(message: string, usage: {
|
|
59
|
-
limit: number;
|
|
60
|
-
current: number;
|
|
61
|
-
remaining: number;
|
|
62
|
-
}, details?: unknown, userMessage?: string, suggestion?: string);
|
|
63
|
-
toJSON(): {
|
|
64
|
-
usage: {
|
|
65
|
-
limit: number;
|
|
66
|
-
current: number;
|
|
67
|
-
remaining: number;
|
|
68
|
-
};
|
|
69
|
-
name: string;
|
|
70
|
-
code: string;
|
|
71
|
-
message: string;
|
|
72
|
-
status: number | undefined;
|
|
73
|
-
details: unknown;
|
|
74
|
-
userMessage: string | undefined;
|
|
75
|
-
suggestion: string | undefined;
|
|
76
|
-
};
|
|
77
|
-
}
|
|
78
|
-
declare function isSDKError(error: unknown): error is SDKError;
|
|
79
|
-
declare function isNetworkError(error: unknown): error is NetworkError;
|
|
80
|
-
declare function isValidationError(error: unknown): error is ValidationError;
|
|
81
|
-
declare function isApiError(error: unknown): error is ApiError;
|
|
82
|
-
declare function isConfigError(error: unknown): error is ConfigError;
|
|
83
|
-
declare function isTimeoutError(error: unknown): error is TimeoutError;
|
|
84
|
-
declare function isGoneError(error: unknown): error is GoneError;
|
|
85
|
-
declare function isServiceUnavailableError(error: unknown): error is ServiceUnavailableError;
|
|
86
|
-
declare function isUsageLimitError(error: unknown): error is UsageLimitError;
|
|
87
|
-
|
|
88
16
|
/**
|
|
89
17
|
* API URL을 반환합니다.
|
|
90
18
|
* 환경변수 SOFTWARE_API_URL 또는 NEXT_PUBLIC_SOFTWARE_API_URL로 오버라이드 가능.
|
|
@@ -182,9 +110,6 @@ interface RetryConfig {
|
|
|
182
110
|
retryableStatuses?: number[];
|
|
183
111
|
retryDelay?: (attempt: number) => number;
|
|
184
112
|
}
|
|
185
|
-
interface ErrorLogger {
|
|
186
|
-
log(error: SDKError | Error, context?: Record<string, unknown>): void;
|
|
187
|
-
}
|
|
188
113
|
type DeepPartial<T> = {
|
|
189
114
|
[P in keyof T]?: T[P] extends object ? DeepPartial<T[P]> : T[P];
|
|
190
115
|
};
|
|
@@ -195,25 +120,35 @@ interface ServerApiOptions {
|
|
|
195
120
|
secretKey: string;
|
|
196
121
|
baseUrl?: string;
|
|
197
122
|
}
|
|
123
|
+
interface RequestOptions {
|
|
124
|
+
method?: 'GET' | 'POST' | 'PATCH' | 'DELETE';
|
|
125
|
+
headers?: Record<string, string>;
|
|
126
|
+
}
|
|
198
127
|
declare abstract class BaseApi {
|
|
199
128
|
protected readonly clientKey: string;
|
|
200
129
|
protected readonly secretKey: string;
|
|
201
130
|
protected readonly baseUrl?: string;
|
|
202
131
|
constructor(apiName: string, options: ServerApiOptions);
|
|
203
|
-
protected request<T>(endpoint: string, body: unknown): Promise<T>;
|
|
132
|
+
protected request<T>(endpoint: string, body: unknown, options?: RequestOptions): Promise<T>;
|
|
204
133
|
}
|
|
205
134
|
|
|
206
135
|
type OrderApiOptions = ServerApiOptions;
|
|
136
|
+
type CustomerSnapshot = {
|
|
137
|
+
name?: string;
|
|
138
|
+
email: string;
|
|
139
|
+
phone?: string;
|
|
140
|
+
};
|
|
141
|
+
type ReturnReason = 'change_of_mind' | 'defective' | 'wrong_delivery' | 'damaged' | 'other';
|
|
142
|
+
type ReturnProductItem = {
|
|
143
|
+
orderProduct: string;
|
|
144
|
+
quantity: number;
|
|
145
|
+
};
|
|
207
146
|
type CreateOrderParams = {
|
|
208
147
|
orderNumber: string;
|
|
209
148
|
customer?: string;
|
|
210
|
-
customerSnapshot:
|
|
211
|
-
name?: string;
|
|
212
|
-
email: string;
|
|
213
|
-
phone?: string;
|
|
214
|
-
};
|
|
149
|
+
customerSnapshot: CustomerSnapshot;
|
|
215
150
|
shippingAddress: Order['shippingAddress'];
|
|
216
|
-
orderProducts:
|
|
151
|
+
orderProducts: Pick<OrderProduct, 'product' | 'variant' | 'option' | 'quantity' | 'unitPrice' | 'totalPrice'>[];
|
|
217
152
|
totalAmount: number;
|
|
218
153
|
shippingFee?: number;
|
|
219
154
|
paymentId?: string;
|
|
@@ -232,11 +167,7 @@ type UpdateTransactionParams = {
|
|
|
232
167
|
type CheckoutParams = {
|
|
233
168
|
cartId: string;
|
|
234
169
|
orderNumber: string;
|
|
235
|
-
customerSnapshot:
|
|
236
|
-
name?: string;
|
|
237
|
-
email: string;
|
|
238
|
-
phone?: string;
|
|
239
|
-
};
|
|
170
|
+
customerSnapshot: CustomerSnapshot;
|
|
240
171
|
paymentId?: string;
|
|
241
172
|
discountCode?: string;
|
|
242
173
|
};
|
|
@@ -286,12 +217,9 @@ type GetOrderParams = {
|
|
|
286
217
|
};
|
|
287
218
|
type CreateReturnParams = {
|
|
288
219
|
orderNumber: string;
|
|
289
|
-
reason?:
|
|
220
|
+
reason?: ReturnReason;
|
|
290
221
|
reasonDetail?: string;
|
|
291
|
-
returnProducts:
|
|
292
|
-
orderProduct: string;
|
|
293
|
-
quantity: number;
|
|
294
|
-
}>;
|
|
222
|
+
returnProducts: ReturnProductItem[];
|
|
295
223
|
refundAmount: number;
|
|
296
224
|
};
|
|
297
225
|
type UpdateReturnParams = {
|
|
@@ -300,12 +228,9 @@ type UpdateReturnParams = {
|
|
|
300
228
|
};
|
|
301
229
|
type ReturnWithRefundParams = {
|
|
302
230
|
orderNumber: string;
|
|
303
|
-
reason?:
|
|
231
|
+
reason?: ReturnReason;
|
|
304
232
|
reasonDetail?: string;
|
|
305
|
-
returnProducts:
|
|
306
|
-
orderProduct: string;
|
|
307
|
-
quantity: number;
|
|
308
|
-
}>;
|
|
233
|
+
returnProducts: ReturnProductItem[];
|
|
309
234
|
refundAmount: number;
|
|
310
235
|
paymentId: string;
|
|
311
236
|
refundReceiptUrl?: string;
|
|
@@ -625,6 +550,11 @@ interface CustomerRegisterData {
|
|
|
625
550
|
password: string;
|
|
626
551
|
phone?: string;
|
|
627
552
|
}
|
|
553
|
+
interface CustomerRegisterResponse {
|
|
554
|
+
customer: CustomerProfile;
|
|
555
|
+
/** True when tenant requires email verification. Token delivered via webhook. */
|
|
556
|
+
verificationRequired?: boolean;
|
|
557
|
+
}
|
|
628
558
|
interface CustomerLoginData {
|
|
629
559
|
email: string;
|
|
630
560
|
password: string;
|
|
@@ -670,9 +600,7 @@ declare class CustomerAuth {
|
|
|
670
600
|
/**
|
|
671
601
|
* Register a new customer account
|
|
672
602
|
*/
|
|
673
|
-
register(data: CustomerRegisterData): Promise<
|
|
674
|
-
customer: CustomerProfile;
|
|
675
|
-
}>;
|
|
603
|
+
register(data: CustomerRegisterData): Promise<CustomerRegisterResponse>;
|
|
676
604
|
/**
|
|
677
605
|
* Login with email and password. Stores the token internally.
|
|
678
606
|
*/
|
|
@@ -737,6 +665,82 @@ declare class CustomerAuth {
|
|
|
737
665
|
private requestJson;
|
|
738
666
|
}
|
|
739
667
|
|
|
668
|
+
declare class SDKError extends Error {
|
|
669
|
+
readonly code: string;
|
|
670
|
+
readonly status?: number;
|
|
671
|
+
readonly details?: unknown;
|
|
672
|
+
readonly userMessage?: string;
|
|
673
|
+
readonly suggestion?: string;
|
|
674
|
+
constructor(code: string, message: string, status?: number, details?: unknown, userMessage?: string, suggestion?: string);
|
|
675
|
+
getUserMessage(): string;
|
|
676
|
+
toJSON(): {
|
|
677
|
+
name: string;
|
|
678
|
+
code: string;
|
|
679
|
+
message: string;
|
|
680
|
+
status: number | undefined;
|
|
681
|
+
details: unknown;
|
|
682
|
+
userMessage: string | undefined;
|
|
683
|
+
suggestion: string | undefined;
|
|
684
|
+
};
|
|
685
|
+
}
|
|
686
|
+
declare class NetworkError extends SDKError {
|
|
687
|
+
constructor(message: string, status?: number, details?: unknown, userMessage?: string, suggestion?: string);
|
|
688
|
+
}
|
|
689
|
+
declare class ValidationError extends SDKError {
|
|
690
|
+
constructor(message: string, details?: unknown, userMessage?: string, suggestion?: string);
|
|
691
|
+
}
|
|
692
|
+
declare class ApiError extends SDKError {
|
|
693
|
+
constructor(message: string, status: number, details?: unknown, userMessage?: string, suggestion?: string);
|
|
694
|
+
}
|
|
695
|
+
declare class ConfigError extends SDKError {
|
|
696
|
+
constructor(message: string, details?: unknown, userMessage?: string, suggestion?: string);
|
|
697
|
+
}
|
|
698
|
+
declare class TimeoutError extends SDKError {
|
|
699
|
+
constructor(message?: string, details?: unknown, userMessage?: string, suggestion?: string);
|
|
700
|
+
}
|
|
701
|
+
declare class GoneError extends SDKError {
|
|
702
|
+
constructor(message?: string, details?: unknown, userMessage?: string, suggestion?: string);
|
|
703
|
+
}
|
|
704
|
+
declare class ServiceUnavailableError extends SDKError {
|
|
705
|
+
readonly retryAfter?: number;
|
|
706
|
+
constructor(message?: string, retryAfter?: number, details?: unknown, userMessage?: string, suggestion?: string);
|
|
707
|
+
}
|
|
708
|
+
declare class UsageLimitError extends SDKError {
|
|
709
|
+
readonly usage: {
|
|
710
|
+
limit: number;
|
|
711
|
+
current: number;
|
|
712
|
+
remaining: number;
|
|
713
|
+
};
|
|
714
|
+
constructor(message: string, usage: {
|
|
715
|
+
limit: number;
|
|
716
|
+
current: number;
|
|
717
|
+
remaining: number;
|
|
718
|
+
}, details?: unknown, userMessage?: string, suggestion?: string);
|
|
719
|
+
toJSON(): {
|
|
720
|
+
usage: {
|
|
721
|
+
limit: number;
|
|
722
|
+
current: number;
|
|
723
|
+
remaining: number;
|
|
724
|
+
};
|
|
725
|
+
name: string;
|
|
726
|
+
code: string;
|
|
727
|
+
message: string;
|
|
728
|
+
status: number | undefined;
|
|
729
|
+
details: unknown;
|
|
730
|
+
userMessage: string | undefined;
|
|
731
|
+
suggestion: string | undefined;
|
|
732
|
+
};
|
|
733
|
+
}
|
|
734
|
+
declare function isSDKError(error: unknown): error is SDKError;
|
|
735
|
+
declare function isNetworkError(error: unknown): error is NetworkError;
|
|
736
|
+
declare function isValidationError(error: unknown): error is ValidationError;
|
|
737
|
+
declare function isApiError(error: unknown): error is ApiError;
|
|
738
|
+
declare function isConfigError(error: unknown): error is ConfigError;
|
|
739
|
+
declare function isTimeoutError(error: unknown): error is TimeoutError;
|
|
740
|
+
declare function isGoneError(error: unknown): error is GoneError;
|
|
741
|
+
declare function isServiceUnavailableError(error: unknown): error is ServiceUnavailableError;
|
|
742
|
+
declare function isUsageLimitError(error: unknown): error is UsageLimitError;
|
|
743
|
+
|
|
740
744
|
interface CollectionQueryParams<T extends PublicCollection> {
|
|
741
745
|
collection: T;
|
|
742
746
|
options?: ApiQueryOptions;
|
|
@@ -834,9 +838,7 @@ declare class CustomerHooks {
|
|
|
834
838
|
useCustomerLogin(options?: MutationCallbacks<CustomerAuthResponse>): _tanstack_react_query.UseMutationResult<CustomerAuthResponse, SDKError, CustomerLoginData, unknown>;
|
|
835
839
|
useCustomerRegister(options?: MutationCallbacks<{
|
|
836
840
|
customer: CustomerProfile;
|
|
837
|
-
}>): _tanstack_react_query.UseMutationResult<
|
|
838
|
-
customer: CustomerProfile;
|
|
839
|
-
}, SDKError, CustomerRegisterData, unknown>;
|
|
841
|
+
}>): _tanstack_react_query.UseMutationResult<CustomerRegisterResponse, SDKError, CustomerRegisterData, unknown>;
|
|
840
842
|
useCustomerLogout(options?: MutationCallbacks<void>): _tanstack_react_query.UseMutationResult<void, SDKError, void, unknown>;
|
|
841
843
|
useCustomerForgotPassword(options?: MutationCallbacks<void>): _tanstack_react_query.UseMutationResult<void, SDKError, string, unknown>;
|
|
842
844
|
useCustomerResetPassword(options?: MutationCallbacks<void>): _tanstack_react_query.UseMutationResult<void, SDKError, {
|
|
@@ -945,88 +947,4 @@ declare const formatOrderName: (items: OrderItem[]) => string;
|
|
|
945
947
|
*/
|
|
946
948
|
declare const resolveRelation: <T>(ref: T | string | number | null | undefined) => T | null;
|
|
947
949
|
|
|
948
|
-
|
|
949
|
-
/** Width in pixels (default: 640) */
|
|
950
|
-
width?: number;
|
|
951
|
-
/** Height in pixels (auto if omitted) */
|
|
952
|
-
height?: number;
|
|
953
|
-
/** Time offset in seconds (default: 0) */
|
|
954
|
-
time?: number;
|
|
955
|
-
/** Fit mode (default: 'smartcrop') */
|
|
956
|
-
fitMode?: 'preserve' | 'stretch' | 'crop' | 'smartcrop' | 'pad';
|
|
957
|
-
/** Flip horizontally */
|
|
958
|
-
flipH?: boolean;
|
|
959
|
-
/** Flip vertically */
|
|
960
|
-
flipV?: boolean;
|
|
961
|
-
/** Rotation in degrees (90, 180, 270) */
|
|
962
|
-
rotate?: 90 | 180 | 270;
|
|
963
|
-
}
|
|
964
|
-
/**
|
|
965
|
-
* Returns a Mux thumbnail URL for a video.
|
|
966
|
-
*
|
|
967
|
-
* @example
|
|
968
|
-
* ```ts
|
|
969
|
-
* getVideoThumbnail('abc123')
|
|
970
|
-
* // => 'https://image.mux.com/abc123/thumbnail.jpg?width=640'
|
|
971
|
-
*
|
|
972
|
-
* getVideoThumbnail('abc123', { width: 320, time: 5 })
|
|
973
|
-
* // => 'https://image.mux.com/abc123/thumbnail.jpg?width=320&time=5'
|
|
974
|
-
* ```
|
|
975
|
-
*/
|
|
976
|
-
declare function getVideoThumbnail(playbackId: string, options?: VideoThumbnailOptions): string;
|
|
977
|
-
interface VideoGifOptions {
|
|
978
|
-
/** Width in pixels (default: 320) */
|
|
979
|
-
width?: number;
|
|
980
|
-
/** Start time in seconds (default: 0) */
|
|
981
|
-
start?: number;
|
|
982
|
-
/** End time in seconds (default: start + 5) */
|
|
983
|
-
end?: number;
|
|
984
|
-
/** Frames per second (default: 15) */
|
|
985
|
-
fps?: number;
|
|
986
|
-
}
|
|
987
|
-
/**
|
|
988
|
-
* Returns a Mux animated GIF URL for a video.
|
|
989
|
-
*
|
|
990
|
-
* @example
|
|
991
|
-
* ```ts
|
|
992
|
-
* getVideoGif('abc123')
|
|
993
|
-
* // => 'https://image.mux.com/abc123/animated.gif?width=320'
|
|
994
|
-
*
|
|
995
|
-
* getVideoGif('abc123', { width: 240, start: 2, end: 6 })
|
|
996
|
-
* // => 'https://image.mux.com/abc123/animated.gif?width=240&start=2&end=6'
|
|
997
|
-
* ```
|
|
998
|
-
*/
|
|
999
|
-
declare function getVideoGif(playbackId: string, options?: VideoGifOptions): string;
|
|
1000
|
-
/**
|
|
1001
|
-
* Returns a Mux storyboard VTT URL for timeline hover previews.
|
|
1002
|
-
*
|
|
1003
|
-
* @example
|
|
1004
|
-
* ```ts
|
|
1005
|
-
* getVideoStoryboard('abc123')
|
|
1006
|
-
* // => 'https://image.mux.com/abc123/storyboard.vtt'
|
|
1007
|
-
* ```
|
|
1008
|
-
*/
|
|
1009
|
-
declare function getVideoStoryboard(playbackId: string): string;
|
|
1010
|
-
/**
|
|
1011
|
-
* Returns the HLS stream URL for a video.
|
|
1012
|
-
*
|
|
1013
|
-
* @example
|
|
1014
|
-
* ```ts
|
|
1015
|
-
* getVideoStreamUrl('abc123')
|
|
1016
|
-
* // => 'https://stream.mux.com/abc123.m3u8'
|
|
1017
|
-
* ```
|
|
1018
|
-
*/
|
|
1019
|
-
declare function getVideoStreamUrl(playbackId: string): string;
|
|
1020
|
-
/**
|
|
1021
|
-
* Returns a Mux MP4 download URL for a video.
|
|
1022
|
-
* Only available if the asset was created with `mp4_support` enabled.
|
|
1023
|
-
*
|
|
1024
|
-
* @example
|
|
1025
|
-
* ```ts
|
|
1026
|
-
* getVideoMp4Url('abc123', 'high')
|
|
1027
|
-
* // => 'https://stream.mux.com/abc123/high.mp4'
|
|
1028
|
-
* ```
|
|
1029
|
-
*/
|
|
1030
|
-
declare function getVideoMp4Url(playbackId: string, resolution?: 'high' | 'medium' | 'low'): string;
|
|
1031
|
-
|
|
1032
|
-
export { type AddItemParams, ApiError, type ApiQueryOptions, type ApiQueryReactOptions, type ApplyDiscountParams, BaseApi, BrowserClient, BrowserClient as BrowserClientType, type CalculateShippingParams, type CalculateShippingResult, Cart, CartApi, type CartApiOptions, CartItem, type CheckoutParams, type ClearCartParams, type ClientBrowserConfig, type ClientMetadata, type ClientServerConfig, type ClientState, CollectionClient, type CollectionDetailQueryParams, CollectionHooks, type CollectionInfiniteQueryParams, CollectionQueryBuilder, type CollectionQueryParams, CollectionType, ConfigError, type CreateExchangeParams, type CreateFulfillmentParams, type CreateOrderParams, type CreateReturnParams, CustomerAuth, type CustomerAuthOptions, type CustomerAuthResponse, CustomerHooks, type CustomerLoginData, type CustomerProfile, type CustomerRefreshResponse, type CustomerRegisterData, type DebugConfig, type DeepPartial, type ErrorLogger, Exchange, type ExtractArrayType, Fulfillment, type GenerateMetadataOptions, type GetOrderParams, GoneError, NetworkError, Order, OrderApi, type OrderApiOptions, OrderProduct, type PaginationMeta, type PayloadFindResponse, type PayloadMutationResponse, Product, ProductApi, type ProductApiOptions, PublicCollection, QueryHooks, type ReadOnlyQueryBuilder, type ReadOnlyQueryHooks, type RemoveDiscountParams, type RemoveItemParams, type RetryConfig, Return, type ReturnWithRefundParams, SDKError, type ServerApiOptions, ServerClient, ServerClient as ServerClientType, ServiceUnavailableError, type StockCheckParams, type StockCheckResponse, type StockCheckResult, TimeoutError, Transaction, type UpdateExchangeParams, type UpdateFulfillmentParams, type UpdateItemParams, type UpdateOrderParams, type UpdateProfileData, type UpdateReturnParams, type UpdateTransactionParams, UsageLimitError, type ValidateDiscountParams, type ValidateDiscountResult, ValidationError, type VideoGifOptions, type VideoThumbnailOptions, collectionKeys, createBrowserClient, createServerClient, customerKeys, formatOrderName, generateOrderNumber, getQueryClient, getVideoGif, getVideoMp4Url, getVideoStoryboard, getVideoStreamUrl, getVideoThumbnail, isApiError, isConfigError, isGoneError, isNetworkError, isSDKError, isServiceUnavailableError, isTimeoutError, isUsageLimitError, isValidationError, resolveApiUrl, resolveRelation };
|
|
950
|
+
export { type AddItemParams, ApiError, type ApiQueryOptions, type ApiQueryReactOptions, type ApplyDiscountParams, BaseApi, BrowserClient, BrowserClient as BrowserClientType, type CalculateShippingParams, type CalculateShippingResult, Cart, CartApi, type CartApiOptions, CartItem, type CheckoutParams, type ClearCartParams, type ClientBrowserConfig, type ClientMetadata, type ClientServerConfig, type ClientState, CollectionClient, type CollectionDetailQueryParams, CollectionHooks, type CollectionInfiniteQueryParams, CollectionQueryBuilder, type CollectionQueryParams, CollectionType, ConfigError, type CreateExchangeParams, type CreateFulfillmentParams, type CreateOrderParams, type CreateReturnParams, CustomerAuth, type CustomerAuthOptions, type CustomerAuthResponse, CustomerHooks, type CustomerLoginData, type CustomerProfile, type CustomerRefreshResponse, type CustomerRegisterData, type CustomerRegisterResponse, type CustomerSnapshot, type DebugConfig, type DeepPartial, Exchange, type ExtractArrayType, Fulfillment, type GenerateMetadataOptions, type GetOrderParams, GoneError, NetworkError, Order, OrderApi, type OrderApiOptions, OrderProduct, type PaginationMeta, type PayloadFindResponse, type PayloadMutationResponse, Product, ProductApi, type ProductApiOptions, PublicCollection, QueryHooks, type ReadOnlyQueryBuilder, type ReadOnlyQueryHooks, type RemoveDiscountParams, type RemoveItemParams, type RequestOptions, type RetryConfig, Return, type ReturnProductItem, type ReturnReason, type ReturnWithRefundParams, SDKError, type ServerApiOptions, ServerClient, ServerClient as ServerClientType, ServiceUnavailableError, type StockCheckParams, type StockCheckResponse, type StockCheckResult, TimeoutError, Transaction, type UpdateExchangeParams, type UpdateFulfillmentParams, type UpdateItemParams, type UpdateOrderParams, type UpdateProfileData, type UpdateReturnParams, type UpdateTransactionParams, UsageLimitError, type ValidateDiscountParams, type ValidateDiscountResult, ValidationError, collectionKeys, createBrowserClient, createServerClient, customerKeys, formatOrderName, generateOrderNumber, getQueryClient, isApiError, isConfigError, isGoneError, isNetworkError, isSDKError, isServiceUnavailableError, isTimeoutError, isUsageLimitError, isValidationError, resolveApiUrl, resolveRelation };
|