@forgecart/sdk 1.2.5 → 1.2.7

package/README.md

@@ -1,90 +1,88 @@
 # @forgecart/sdk
 
-Auto-generated TypeScript SDK for ForgeCart API.
+ForgeCart Client SDK
 
 ## Installation
 
 ```bash
-pnpm add @forgecart/sdk
-# or
 npm install @forgecart/sdk
-# or
-yarn add @forgecart/sdk
 ```
 
 ## Usage
 
-### Unified SDK (Recommended)
+### Standalone Admin Client
 
 ```typescript
-import { ForgeCartSDK } from '@forgecart/sdk'
+import { ForgeCartAdminClient } from '@forgecart/sdk';
 
-const sdk = new ForgeCartSDK({
-  adminEndpoint: 'https://api.forgecart.com/admin-api',
-  shopEndpoint: 'https://api.forgecart.com/shop-api',
-})
-
-// Admin API
-const products = await sdk.admin.products.products({ take: 10 })
-const customer = await sdk.admin.customer.customer({ id: '1' })
-
-// Shop API
-const shopProducts = await sdk.shop.products.products({ take: 10 })
-await sdk.shop.order.addItemToOrder({
-  productVariantId: '1',
-  quantity: 1,
-})
+const admin = new ForgeCartAdminClient({
+  endpoint: 'https://api.mystore.com/admin-api',
+  channelToken: 'my-channel-token',
+  adminSecret: 'my-admin-secret',
+});
 
-// Authentication
-sdk.setAdminAuthToken('your-admin-token')
-sdk.setShopAuthToken('your-shop-token')
-
-// Clean up
-sdk.dispose()
+admin.setAuthToken(token);
+const result = await admin.products.products({ take: 10 });
 ```
 
-### Individual Namespaces
+### Standalone Shop Client
 
 ```typescript
-// Admin API only
-import { AdminNamespace } from '@forgecart/sdk/admin'
-
-const admin = new AdminNamespace({
-  endpoint: 'https://api.forgecart.com/admin-api',
-})
+import { ForgeCartShopClient } from '@forgecart/sdk';
 
-// Shop API only
-import { ShopNamespace } from '@forgecart/sdk/shop'
+const shop = new ForgeCartShopClient({
+  endpoint: 'https://api.mystore.com/shop-api',
+  channelToken: 'my-channel-token',
+});
 
-const shop = new ShopNamespace({
-  endpoint: 'https://api.forgecart.com/shop-api',
-})
+const order = await shop.cart.addItemToOrder({ variantId, quantity: 1 });
 ```
 
-## Features
+### Union Client (Admin + Shop)
 
-- ✅ Full TypeScript support with auto-generated types
-- ✅ GraphQL query, mutation, and subscription support
-- ✅ WebSocket subscriptions with auto-reconnect
-- ✅ Built-in authentication helpers
-- ✅ Error handling
-- ✅ Categorized operations for better organization
-- ✅ Tree-shakeable - import only what you need
+```typescript
+import { ForgeCartClient } from '@forgecart/sdk';
+
+const client = new ForgeCartClient({
+  endpoint: 'https://api.mystore.com',
+  channelToken: 'my-channel-token',
+  adminSecret: 'my-admin-secret',
+});
 
-## API Structure
+client.setAuthToken(token);
+const products = await client.admin.products.products({ take: 10 });
+const order = await client.shop.cart.addItemToOrder({ variantId, quantity: 1 });
+```
 
-The SDK is organized into namespaces and categories:
+## Namespaces
 
-- **Admin Namespace**: Administrative operations
-  - products, customer, orders, etc.
-- **Shop Namespace**: Storefront operations
-  - products, cart, checkout, etc.
+- `client.admin` — entry, fieldDefinition, publish, acfSchema, acf, administrator, analyticsGateway, asset, audienceMembership, audienceSegment, auth, settings, channel, chat, collection, country, address, group, customerGroup, customer, deployment, facet, fulfillmentRequest, fulfillment, hookDispatch, hook, marketingAttribution, marketingEvent, marketingIdentity, onboarding, coupon, draft, modification, note, orderModification, order, payment, manageable, plugin, optionGroup, option, productOption, productVariant, product, promotion, role, scheduledJob, search, seller, shipping, stock, subscription, tax, transaction, zone
+- `client.shop` — acf, auth, cart, checkout, collection, customer, facet, hookDispatch, hook, marketingEvent, marketingIdentity, order, payment, product, search, shipping, subscription
 
-## License
+## NestJS Integration
 
-MIT
+```typescript
+import { ForgeCartGraphQLModule } from '@forgecart/sdk';
+
+// Admin only
+@Module({
+  imports: [ForgeCartGraphQLModule.forAdmin({
+    endpoint: 'https://api.mystore.com/admin-api',
+    channelToken: 'my-channel-token',
+  })],
+})
+export class AppModule {}
+
+// Full union (admin + shop)
+@Module({
+  imports: [ForgeCartGraphQLModule.forRoot({
+    endpoint: 'https://api.mystore.com',
+    channelToken: 'my-channel-token',
+  })],
+})
+export class AppModule {}
+```
 
-## Generated
+---
 
-This SDK was automatically generated by ForgeCart SDK Generator.
-Do not modify manually - changes will be overwritten on next generation.
+*Auto-generated by @forgecart/client-sdk-generators.*