@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
package/README.md
CHANGED
|
@@ -1,90 +1,5 @@
|
|
|
1
1
|
# @forgecart/sdk
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
ForgeCart Client SDK
|
|
4
4
|
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
```bash
|
|
8
|
-
pnpm add @forgecart/sdk
|
|
9
|
-
# or
|
|
10
|
-
npm install @forgecart/sdk
|
|
11
|
-
# or
|
|
12
|
-
yarn add @forgecart/sdk
|
|
13
|
-
```
|
|
14
|
-
|
|
15
|
-
## Usage
|
|
16
|
-
|
|
17
|
-
### Unified SDK (Recommended)
|
|
18
|
-
|
|
19
|
-
```typescript
|
|
20
|
-
import { ForgeCartSDK } from '@forgecart/sdk'
|
|
21
|
-
|
|
22
|
-
const sdk = new ForgeCartSDK({
|
|
23
|
-
adminEndpoint: 'https://api.forgecart.com/admin-api',
|
|
24
|
-
shopEndpoint: 'https://api.forgecart.com/shop-api',
|
|
25
|
-
})
|
|
26
|
-
|
|
27
|
-
// Admin API
|
|
28
|
-
const products = await sdk.admin.products.products({ take: 10 })
|
|
29
|
-
const customer = await sdk.admin.customer.customer({ id: '1' })
|
|
30
|
-
|
|
31
|
-
// Shop API
|
|
32
|
-
const shopProducts = await sdk.shop.products.products({ take: 10 })
|
|
33
|
-
await sdk.shop.order.addItemToOrder({
|
|
34
|
-
productVariantId: '1',
|
|
35
|
-
quantity: 1,
|
|
36
|
-
})
|
|
37
|
-
|
|
38
|
-
// Authentication
|
|
39
|
-
sdk.setAdminAuthToken('your-admin-token')
|
|
40
|
-
sdk.setShopAuthToken('your-shop-token')
|
|
41
|
-
|
|
42
|
-
// Clean up
|
|
43
|
-
sdk.dispose()
|
|
44
|
-
```
|
|
45
|
-
|
|
46
|
-
### Individual Namespaces
|
|
47
|
-
|
|
48
|
-
```typescript
|
|
49
|
-
// Admin API only
|
|
50
|
-
import { AdminNamespace } from '@forgecart/sdk/admin'
|
|
51
|
-
|
|
52
|
-
const admin = new AdminNamespace({
|
|
53
|
-
endpoint: 'https://api.forgecart.com/admin-api',
|
|
54
|
-
})
|
|
55
|
-
|
|
56
|
-
// Shop API only
|
|
57
|
-
import { ShopNamespace } from '@forgecart/sdk/shop'
|
|
58
|
-
|
|
59
|
-
const shop = new ShopNamespace({
|
|
60
|
-
endpoint: 'https://api.forgecart.com/shop-api',
|
|
61
|
-
})
|
|
62
|
-
```
|
|
63
|
-
|
|
64
|
-
## Features
|
|
65
|
-
|
|
66
|
-
- ✅ Full TypeScript support with auto-generated types
|
|
67
|
-
- ✅ GraphQL query, mutation, and subscription support
|
|
68
|
-
- ✅ WebSocket subscriptions with auto-reconnect
|
|
69
|
-
- ✅ Built-in authentication helpers
|
|
70
|
-
- ✅ Error handling
|
|
71
|
-
- ✅ Categorized operations for better organization
|
|
72
|
-
- ✅ Tree-shakeable - import only what you need
|
|
73
|
-
|
|
74
|
-
## API Structure
|
|
75
|
-
|
|
76
|
-
The SDK is organized into namespaces and categories:
|
|
77
|
-
|
|
78
|
-
- **Admin Namespace**: Administrative operations
|
|
79
|
-
- products, customer, orders, etc.
|
|
80
|
-
- **Shop Namespace**: Storefront operations
|
|
81
|
-
- products, cart, checkout, etc.
|
|
82
|
-
|
|
83
|
-
## License
|
|
84
|
-
|
|
85
|
-
MIT
|
|
86
|
-
|
|
87
|
-
## Generated
|
|
88
|
-
|
|
89
|
-
This SDK was automatically generated by ForgeCart SDK Generator.
|
|
90
|
-
Do not modify manually - changes will be overwritten on next generation.
|
|
5
|
+
Full documentation, guides, and API reference: https://docs.forgecart.com
|