@back23/promptly-sdk 2.0.0 → 2.0.1

package/README.md

@@ -15,10 +15,40 @@ import { Promptly } from '@back23/promptly-sdk';
 
 const client = new Promptly({
   tenantId: 'demo',
-  baseUrl: 'https://promptly.webbyon.com',
+  apiKey: 'pky_your_api_key_here',  // Required - Get from Dashboard > Settings > API Tokens
+  baseUrl: 'https://promptly.webbyon.com', // Optional
+});
+
+// All API calls require API key
+const { data: posts } = await client.blog.list();
+const products = await client.shop.listProducts();
+```
+
+## v2.0.0 Breaking Changes
+
+### API Key Required
+
+**All API requests now require an API key.** There are no public APIs - this ensures security and proper tenant isolation.
+
+```typescript
+// ❌ v1.x - apiKey was optional
+const client = new Promptly({
+  tenantId: 'demo',
+});
+
+// ✅ v2.0 - apiKey is REQUIRED
+const client = new Promptly({
+  tenantId: 'demo',
+  apiKey: 'pky_xxxxxxxxxxxxxxxxxxxxxxxx',
 });
 ```
 
+Get your API key from: **Dashboard > Settings > API Tokens**
+
+The SDK automatically includes the `X-API-Key` header in all requests.
+
+---
+
 ## v1.3.0 Changes
 
 ### Unified Response Structure
@@ -53,10 +83,11 @@ data.map(post => ...);  // data is always an array
 
 ## API Overview
 
-| Resource | Public (No Auth) | Protected (Auth Required) |
-|----------|------------------|---------------------------|
-| **Boards** | list, get | - |
-| **Posts** | listPosts, getPost | createPost, updatePost, deletePost |
+> **Note:** All APIs require API key (v2.0+). "Auth Required" means additional member login token is needed.
+
+| Resource | Read Operations | Write Operations (Auth Required) |
+|----------|-----------------|----------------------------------|
+| **Boards** | list, get, listPosts, getPost, listComments | createPost, updatePost, deletePost |
 | **Comments** | listComments | createComment, updateComment, deleteComment |
 | **Blog** | list, get, featured, byCategory, byTag | - |
 | **Shop** | listProducts, getProduct, listCategories | getCart, addToCart, listOrders, createOrder |
@@ -68,7 +99,7 @@ data.map(post => ...);  // data is always an array
 
 ## API Reference
 
-### Boards (게시판) - Public
+### Boards (게시판)
 
 ```typescript
 // 게시판 목록
@@ -134,7 +165,7 @@ await client.boards.updateComment(commentId, {
 await client.boards.deleteComment(commentId);
 ```
 
-### Blog (블로그) - Public
+### Blog (블로그)
 
 ```typescript
 // 블로그 글 목록
@@ -400,7 +431,7 @@ const response = await client.auth.socialCallback('google', code);
 // Returns: { member: Member, token: string }
 ```
 
-### Forms (폼) - Public
+### Forms (폼)
 
 ```typescript
 // 폼 목록
@@ -529,7 +560,7 @@ await customers.create({
 });
 ```
 
-### Site Settings - Public
+### Site Settings
 
 ```typescript
 // 테마 설정
@@ -543,6 +574,21 @@ const settings = await client.getSettings();
 
 ## Types
 
+### Configuration
+
+```typescript
+interface PromptlyConfig {
+  /** Tenant ID (subdomain) */
+  tenantId: string;
+  /** API key (required) - Get from Dashboard > Settings > API Tokens */
+  apiKey: string;
+  /** Base URL of Promptly API (optional) */
+  baseUrl?: string;
+  /** Request timeout in milliseconds (optional) */
+  timeout?: number;
+}
+```
+
 ### Common Types
 
 ```typescript
@@ -720,6 +766,7 @@ import { Promptly } from '@back23/promptly-sdk';
 
 const client = new Promptly({
   tenantId: 'demo',
+  apiKey: process.env.NEXT_PUBLIC_PROMPTLY_API_KEY!, // Required
   baseUrl: 'https://promptly.webbyon.com',
 });
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@back23/promptly-sdk",
-  "version": "2.0.0",
+  "version": "2.0.1",
   "description": "Promptly AI CMS SDK for JavaScript/TypeScript",
   "main": "dist/index.js",
   "module": "dist/index.mjs",