@forgecart/sdk 1.2.5 → 1.2.6
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 +2 -87
- package/dist/admin-types.generated.d.ts +9884 -0
- package/dist/admin.d.ts +55 -8
- package/dist/admin.generated.d.ts +790 -0
- package/dist/admin.generated.js +1801 -0
- package/dist/admin.js +112 -23
- package/dist/client.generated.d.ts +251 -0
- package/dist/client.generated.js +757 -0
- package/dist/documents.generated.d.ts +465 -0
- package/dist/documents.generated.js +24283 -0
- package/dist/error-utils.d.ts +25 -0
- package/dist/error-utils.js +59 -0
- package/dist/hook-event-map.generated.d.ts +243 -0
- package/dist/hook-event-map.generated.js +9 -0
- package/dist/index.d.ts +23 -59
- package/dist/index.js +35 -83
- package/dist/sdk-hook-subscription.generated.d.ts +29 -0
- package/dist/sdk-hook-subscription.generated.js +73 -0
- package/dist/sdk-plugin.generated.d.ts +38 -0
- package/dist/sdk-plugin.generated.js +31 -0
- package/dist/sdk-types.generated.d.ts +56 -0
- package/dist/sdk-types.generated.js +28 -0
- package/dist/shop-types.generated.d.ts +4776 -0
- package/dist/shop.d.ts +18 -8
- package/dist/shop.generated.d.ts +213 -0
- package/dist/shop.generated.js +465 -0
- package/dist/shop.js +37 -23
- package/dist/upload.d.ts +14 -0
- package/dist/upload.js +163 -0
- package/package.json +10 -25
- package/src/admin-types.generated.ts +28377 -0
- package/src/admin.generated.ts +1771 -0
- package/src/admin.ts +55 -9
- package/src/client.generated.ts +845 -0
- package/src/documents.generated.ts +24730 -0
- package/src/error-utils.ts +74 -0
- package/src/hook-event-map.generated.ts +252 -0
- package/src/index.ts +23 -115
- package/src/sdk-hook-subscription.generated.ts +93 -0
- package/src/sdk-plugin.generated.ts +59 -0
- package/src/sdk-types.generated.ts +79 -0
- package/src/shop-types.generated.ts +10400 -0
- package/src/shop.generated.ts +452 -0
- package/src/shop.ts +18 -9
- package/src/upload.ts +211 -0
- package/LICENSE +0 -21
- package/dist/admin-namespace.d.ts +0 -2688
- package/dist/admin-namespace.js +0 -9691
- package/dist/admin-types.d.ts +0 -16195
- package/dist/shop-namespace.d.ts +0 -718
- package/dist/shop-namespace.js +0 -3124
- package/dist/shop-types.d.ts +0 -6310
- package/src/admin-namespace.ts +0 -11428
- package/src/admin-types.ts +0 -10809
- package/src/shop-namespace.ts +0 -3547
- package/src/shop-types.ts +0 -4684
- /package/dist/{admin-types.js → admin-types.generated.js} +0 -0
- /package/dist/{shop-types.js → shop-types.generated.js} +0 -0
|
@@ -0,0 +1,79 @@
|
|
|
1
|
+
/* eslint-disable */
|
|
2
|
+
/**
|
|
3
|
+
* AUTO-GENERATED FILE — DO NOT EDIT
|
|
4
|
+
*
|
|
5
|
+
* This file was generated by @forgecart/client-sdk-generators.
|
|
6
|
+
* Any manual changes will be overwritten on the next generation run.
|
|
7
|
+
*/
|
|
8
|
+
|
|
9
|
+
export type ID = string & { readonly __brand?: 'ID' };
|
|
10
|
+
|
|
11
|
+
// eslint-disable-next-line @typescript-eslint/no-explicit-any -- constructor signature requires any[]
|
|
12
|
+
export type Type<T = unknown> = new (...args: any[]) => T;
|
|
13
|
+
|
|
14
|
+
export interface ApiExtension {
|
|
15
|
+
schema?: unknown;
|
|
16
|
+
resolvers?: Type[];
|
|
17
|
+
}
|
|
18
|
+
|
|
19
|
+
/** Minimal RequestContext interface for SDK consumers */
|
|
20
|
+
export interface IRequestContext {
|
|
21
|
+
readonly channelId: string;
|
|
22
|
+
readonly channelToken: string;
|
|
23
|
+
readonly apiType: 'admin' | 'shop';
|
|
24
|
+
readonly languageCode: string;
|
|
25
|
+
readonly hookDepth: number;
|
|
26
|
+
/** Cross-process correlation token set by the platform during hook dispatch */
|
|
27
|
+
readonly transactionToken?: string;
|
|
28
|
+
}
|
|
29
|
+
|
|
30
|
+
export type HookHandler = (...args: unknown[]) => Promise<void>;
|
|
31
|
+
|
|
32
|
+
export interface FulfillmentHandlerCapabilities {
|
|
33
|
+
supportsTracking: boolean;
|
|
34
|
+
requiresShippingAddress: boolean;
|
|
35
|
+
autoFulfillOnPayment: boolean;
|
|
36
|
+
autoDeliver: boolean;
|
|
37
|
+
autoCreateLabel: boolean;
|
|
38
|
+
supportsReturn: boolean;
|
|
39
|
+
}
|
|
40
|
+
|
|
41
|
+
export interface OrderLineInput {
|
|
42
|
+
orderLineId: ID;
|
|
43
|
+
variantId: ID;
|
|
44
|
+
quantity: number;
|
|
45
|
+
}
|
|
46
|
+
|
|
47
|
+
export interface IFulfillmentHandler {
|
|
48
|
+
readonly code: string;
|
|
49
|
+
readonly name: string;
|
|
50
|
+
getCapabilities(): FulfillmentHandlerCapabilities;
|
|
51
|
+
groupLines(
|
|
52
|
+
ctx: IRequestContext,
|
|
53
|
+
lines: OrderLineInput[],
|
|
54
|
+
): Promise<OrderLineInput[][]>;
|
|
55
|
+
onCreated(ctx: IRequestContext, fulfillment: unknown): Promise<unknown>;
|
|
56
|
+
onStateTransition(
|
|
57
|
+
ctx: IRequestContext,
|
|
58
|
+
fulfillment: unknown,
|
|
59
|
+
fromState: string,
|
|
60
|
+
toState: string,
|
|
61
|
+
): Promise<unknown>;
|
|
62
|
+
}
|
|
63
|
+
|
|
64
|
+
export enum SdkErrorCode {
|
|
65
|
+
SERVICE_NOT_FOUND = 'SERVICE_NOT_FOUND',
|
|
66
|
+
METHOD_NOT_FOUND = 'METHOD_NOT_FOUND',
|
|
67
|
+
WEBSOCKET_TIMEOUT = 'WEBSOCKET_TIMEOUT',
|
|
68
|
+
}
|
|
69
|
+
|
|
70
|
+
export class SdkError extends Error {
|
|
71
|
+
constructor(
|
|
72
|
+
public readonly code: SdkErrorCode,
|
|
73
|
+
public readonly variables: Record<string, string> = {},
|
|
74
|
+
) {
|
|
75
|
+
super(code);
|
|
76
|
+
this.name = 'SdkError';
|
|
77
|
+
Object.setPrototypeOf(this, new.target.prototype);
|
|
78
|
+
}
|
|
79
|
+
}
|