@putiikkipalvelu/storefront-sdk 0.1.0 → 0.2.0

package/README.md

@@ -13,15 +13,15 @@ npm install @putiikkipalvelu/storefront-sdk
 ## Quick Start
 
 ```typescript
-import { StorefrontClient } from '@putiikkipalvelu/storefront-sdk';
+import { createStorefrontClient } from '@putiikkipalvelu/storefront-sdk';
 
-const client = new StorefrontClient({
+const storefront = createStorefrontClient({
   apiKey: process.env.STOREFRONT_API_KEY!,
-  baseUrl: 'https://putiikkipalvelu.fi',
+  baseUrl: 'https://putiikkipalvelu.fi/api/storefront/v1',
 });
 
 // Get store configuration
-const config = await client.store.getConfig();
+const config = await storefront.store.getConfig();
 console.log(config.store.name);
 ```
 
@@ -29,9 +29,9 @@ console.log(config.store.name);
 
 ```typescript
 // lib/storefront.ts
-import { StorefrontClient } from '@putiikkipalvelu/storefront-sdk';
+import { createStorefrontClient } from '@putiikkipalvelu/storefront-sdk';
 
-export const storefront = new StorefrontClient({
+export const storefront = createStorefrontClient({
   apiKey: process.env.STOREFRONT_API_KEY!,
   baseUrl: process.env.NEXT_PUBLIC_STOREFRONT_API_URL!,
 });
@@ -41,10 +41,47 @@ export const storefront = new StorefrontClient({
 
 ```typescript
 const config = await storefront.store.getConfig({
-  next: { revalidate: 300 } // Cache for 5 minutes
+  next: { revalidate: 300, tags: ['store-config'] }
 });
 ```
 
+## Error Handling
+
+```typescript
+import {
+  createStorefrontClient,
+  AuthError,
+  NotFoundError,
+  StorefrontError
+} from '@putiikkipalvelu/storefront-sdk';
+
+try {
+  const config = await storefront.store.getConfig();
+} catch (error) {
+  if (error instanceof AuthError) {
+    // Invalid API key
+  } else if (error instanceof NotFoundError) {
+    // Resource not found
+  } else if (error instanceof StorefrontError) {
+    // Other API error
+    console.error(error.code, error.message);
+  }
+}
+```
+
+## TypeScript
+
+All types are exported for use in your application:
+
+```typescript
+import type {
+  StoreConfig,
+  StoreInfo,
+  Product,
+  Campaign
+} from '@putiikkipalvelu/storefront-sdk';
+```
+
 ## Available Resources
 
 - `store.getConfig()` - Store configuration, SEO, payments, campaigns