@forgecart/sdk 1.2.3 → 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.
Files changed (58) hide show
  1. package/README.md +2 -87
  2. package/dist/admin-types.generated.d.ts +9884 -0
  3. package/dist/admin.d.ts +55 -8
  4. package/dist/admin.generated.d.ts +790 -0
  5. package/dist/admin.generated.js +1801 -0
  6. package/dist/admin.js +112 -23
  7. package/dist/client.generated.d.ts +251 -0
  8. package/dist/client.generated.js +757 -0
  9. package/dist/documents.generated.d.ts +465 -0
  10. package/dist/documents.generated.js +24283 -0
  11. package/dist/error-utils.d.ts +25 -0
  12. package/dist/error-utils.js +59 -0
  13. package/dist/hook-event-map.generated.d.ts +243 -0
  14. package/dist/hook-event-map.generated.js +9 -0
  15. package/dist/index.d.ts +23 -59
  16. package/dist/index.js +35 -83
  17. package/dist/sdk-hook-subscription.generated.d.ts +29 -0
  18. package/dist/sdk-hook-subscription.generated.js +73 -0
  19. package/dist/sdk-plugin.generated.d.ts +38 -0
  20. package/dist/sdk-plugin.generated.js +31 -0
  21. package/dist/sdk-types.generated.d.ts +56 -0
  22. package/dist/sdk-types.generated.js +28 -0
  23. package/dist/shop-types.generated.d.ts +4776 -0
  24. package/dist/shop.d.ts +18 -8
  25. package/dist/shop.generated.d.ts +213 -0
  26. package/dist/shop.generated.js +465 -0
  27. package/dist/shop.js +37 -23
  28. package/dist/upload.d.ts +14 -0
  29. package/dist/upload.js +163 -0
  30. package/package.json +10 -25
  31. package/src/admin-types.generated.ts +28377 -0
  32. package/src/admin.generated.ts +1771 -0
  33. package/src/admin.ts +55 -9
  34. package/src/client.generated.ts +845 -0
  35. package/src/documents.generated.ts +24730 -0
  36. package/src/error-utils.ts +74 -0
  37. package/src/hook-event-map.generated.ts +252 -0
  38. package/src/index.ts +23 -115
  39. package/src/sdk-hook-subscription.generated.ts +93 -0
  40. package/src/sdk-plugin.generated.ts +59 -0
  41. package/src/sdk-types.generated.ts +79 -0
  42. package/src/shop-types.generated.ts +10400 -0
  43. package/src/shop.generated.ts +452 -0
  44. package/src/shop.ts +18 -9
  45. package/src/upload.ts +211 -0
  46. package/LICENSE +0 -21
  47. package/dist/admin-namespace.d.ts +0 -2664
  48. package/dist/admin-namespace.js +0 -9638
  49. package/dist/admin-types.d.ts +0 -16191
  50. package/dist/shop-namespace.d.ts +0 -694
  51. package/dist/shop-namespace.js +0 -3071
  52. package/dist/shop-types.d.ts +0 -6310
  53. package/src/admin-namespace.ts +0 -11372
  54. package/src/admin-types.ts +0 -10804
  55. package/src/shop-namespace.ts +0 -3491
  56. package/src/shop-types.ts +0 -4684
  57. /package/dist/{admin-types.js → admin-types.generated.js} +0 -0
  58. /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
- Auto-generated TypeScript SDK for ForgeCart API.
3
+ ForgeCart Client SDK
4
4
 
5
- ## Installation
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