@back23/promptly-sdk 2.0.0 → 2.1.0

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/dist/index.js

@@ -379,29 +379,29 @@ var BoardsResource = class {
    * @returns ListResponse with data array (always defined) and pagination meta
    */
   async list(params) {
-    return this.http.getList("/public/boards", params);
+    return this.http.getList("/boards", params);
   }
   /**
    * Get board by ID or slug
    */
   async get(idOrSlug) {
-    return this.http.get(`/public/boards/${idOrSlug}`);
+    return this.http.get(`/boards/${idOrSlug}`);
   }
   // ============================================
-  // Posts (Public)
+  // Posts
   // ============================================
   /**
    * List posts in a board
    * @returns ListResponse with data array and pagination meta
    */
   async listPosts(boardIdOrSlug, params) {
-    return this.http.getList(`/public/boards/${boardIdOrSlug}/posts`, params);
+    return this.http.getList(`/boards/${boardIdOrSlug}/posts`, params);
   }
   /**
    * Get post by ID
    */
   async getPost(postId) {
-    return this.http.get(`/public/posts/${postId}`);
+    return this.http.get(`/posts/${postId}`);
   }
   // ============================================
   // Posts (Protected - requires auth)
@@ -432,7 +432,7 @@ var BoardsResource = class {
    * @returns Array of comments (always an array, never null/undefined)
    */
   async listComments(postId) {
-    const response = await this.http.getList(`/public/posts/${postId}/comments`);
+    const response = await this.http.getList(`/posts/${postId}/comments`);
     return response.data;
   }
   /**
@@ -465,26 +465,26 @@ var BlogResource = class {
    * @returns ListResponse with data array (always defined) and pagination meta
    */
   async list(params) {
-    return this.http.getList("/public/blog", params);
+    return this.http.getList("/blog", params);
   }
   /**
    * Get blog post by slug
    */
   async get(slug) {
-    return this.http.get(`/public/blog/${slug}`);
+    return this.http.get(`/blog/${slug}`);
   }
   /**
    * Get blog post by ID
    */
   async getById(id) {
-    return this.http.get(`/public/blog/id/${id}`);
+    return this.http.get(`/blog/id/${id}`);
   }
   /**
    * Get featured blog posts
    * @returns Array of featured posts (always an array, never null/undefined)
    */
   async featured(limit = 5) {
-    const response = await this.http.getList("/public/blog", {
+    const response = await this.http.getList("/blog", {
       per_page: limit,
       featured: true
     });
@@ -495,7 +495,7 @@ var BlogResource = class {
    * @returns ListResponse with data array and pagination meta
    */
   async byCategory(category, params) {
-    return this.http.getList("/public/blog", {
+    return this.http.getList("/blog", {
       ...params,
       category
     });
@@ -505,7 +505,7 @@ var BlogResource = class {
    * @returns ListResponse with data array and pagination meta
    */
   async byTag(tag, params) {
-    return this.http.getList("/public/blog", {
+    return this.http.getList("/blog", {
       ...params,
       tag
     });
@@ -515,7 +515,7 @@ var BlogResource = class {
    * @returns ListResponse with data array and pagination meta
    */
   async search(query, params) {
-    return this.http.getList("/public/blog", {
+    return this.http.getList("/blog", {
       ...params,
       search: query
     });
@@ -525,7 +525,7 @@ var BlogResource = class {
    * @returns Array of category names (always an array)
    */
   async categories() {
-    const response = await this.http.get("/public/blog/categories");
+    const response = await this.http.get("/blog/categories");
     return Array.isArray(response) ? response : response?.data ?? [];
   }
   /**
@@ -533,7 +533,7 @@ var BlogResource = class {
    * @returns Array of tag names (always an array)
    */
   async tags() {
-    const response = await this.http.get("/public/blog/tags");
+    const response = await this.http.get("/blog/tags");
     return Array.isArray(response) ? response : response?.data ?? [];
   }
 };
@@ -548,19 +548,19 @@ var FormsResource = class {
    * @returns ListResponse with data array and pagination meta
    */
   async list(params) {
-    return this.http.getList("/public/forms", params);
+    return this.http.getList("/forms", params);
   }
   /**
    * Get form by ID or slug
    */
   async get(idOrSlug) {
-    return this.http.get(`/public/forms/${idOrSlug}`);
+    return this.http.get(`/forms/${idOrSlug}`);
   }
   /**
    * Submit form data
    */
   async submit(formIdOrSlug, data) {
-    return this.http.post(`/public/forms/${formIdOrSlug}/submit`, data);
+    return this.http.post(`/forms/${formIdOrSlug}/submit`, data);
   }
   // ============================================
   // Protected endpoints (requires auth)
@@ -593,20 +593,20 @@ var ShopResource = class {
    * @returns ListResponse with data array and pagination meta
    */
   async listProducts(params) {
-    return this.http.getList("/public/products", params);
+    return this.http.getList("/products", params);
   }
   /**
    * Get product by ID or slug
    */
   async getProduct(idOrSlug) {
-    return this.http.get(`/public/products/${idOrSlug}`);
+    return this.http.get(`/products/${idOrSlug}`);
   }
   /**
    * Get featured products
    * @returns Array of featured products (always an array)
    */
   async featuredProducts(limit = 8) {
-    const response = await this.http.getList("/public/products", {
+    const response = await this.http.getList("/products", {
       per_page: limit,
       is_featured: true
     });
@@ -617,7 +617,7 @@ var ShopResource = class {
    * @returns ListResponse with data array and pagination meta
    */
   async searchProducts(query, params) {
-    return this.http.getList("/public/products", {
+    return this.http.getList("/products", {
       ...params,
       search: query
     });
@@ -630,21 +630,21 @@ var ShopResource = class {
    * @returns Array of categories (always an array)
    */
   async listCategories() {
-    const response = await this.http.getList("/public/categories");
+    const response = await this.http.getList("/categories");
     return response.data;
   }
   /**
    * Get category by ID or slug
    */
   async getCategory(idOrSlug) {
-    return this.http.get(`/public/categories/${idOrSlug}`);
+    return this.http.get(`/categories/${idOrSlug}`);
   }
   /**
    * Get products in category
    * @returns ListResponse with data array and pagination meta
    */
   async categoryProducts(categoryIdOrSlug, params) {
-    return this.http.getList(`/public/categories/${categoryIdOrSlug}/products`, params);
+    return this.http.getList(`/categories/${categoryIdOrSlug}/products`, params);
   }
   // ============================================
   // Cart
@@ -817,7 +817,7 @@ var EntitiesResource = class {
    * ```
    */
   async list() {
-    const response = await this.http.getList("/public/entities");
+    const response = await this.http.getList("/entities");
     return response.data;
   }
   /**
@@ -830,7 +830,7 @@ var EntitiesResource = class {
    * ```
    */
   async getSchema(slug) {
-    return this.http.get(`/public/entities/${slug}/schema`);
+    return this.http.get(`/entities/${slug}/schema`);
   }
   // ============================================
   // Records (Public Read)
@@ -858,7 +858,7 @@ var EntitiesResource = class {
    * ```
    */
   async listRecords(slug, params) {
-    return this.http.getList(`/public/entities/${slug}`, params);
+    return this.http.getList(`/entities/${slug}`, params);
   }
   /**
    * Get a single record by ID
@@ -870,7 +870,7 @@ var EntitiesResource = class {
    * ```
    */
   async getRecord(slug, id) {
-    return this.http.get(`/public/entities/${slug}/${id}`);
+    return this.http.get(`/entities/${slug}/${id}`);
   }
   // ============================================
   // Records (Protected - requires auth)
@@ -990,14 +990,14 @@ var ReservationResource = class {
    * @returns Reservation settings for the tenant
    */
   async getSettings() {
-    return this.http.get("/public/reservation/settings");
+    return this.http.get("/reservation/settings");
   }
   /**
    * List available services
    * @returns Array of services (always an array)
    */
   async listServices() {
-    const response = await this.http.getList("/public/reservation/services");
+    const response = await this.http.getList("/reservation/services");
     return response.data;
   }
   /**
@@ -1007,7 +1007,7 @@ var ReservationResource = class {
    */
   async listStaff(serviceId) {
     const params = serviceId ? { service_id: serviceId } : void 0;
-    const response = await this.http.getList("/public/reservation/staffs", params);
+    const response = await this.http.getList("/reservation/staffs", params);
     return response.data;
   }
   /**
@@ -1015,7 +1015,7 @@ var ReservationResource = class {
    * @returns Array of available date strings (YYYY-MM-DD)
    */
   async getAvailableDates(params) {
-    const response = await this.http.get("/public/reservation/available-dates", params);
+    const response = await this.http.get("/reservation/available-dates", params);
     return Array.isArray(response) ? response : response?.data ?? [];
   }
   /**
@@ -1023,7 +1023,7 @@ var ReservationResource = class {
    * @returns Array of available slots (always an array)
    */
   async getAvailableSlots(params) {
-    const response = await this.http.get("/public/reservation/available-slots", params);
+    const response = await this.http.get("/reservation/available-slots", params);
     return Array.isArray(response) ? response : response?.data ?? [];
   }
   // ============================================

package/dist/index.mjs

@@ -351,29 +351,29 @@ var BoardsResource = class {
    * @returns ListResponse with data array (always defined) and pagination meta
    */
   async list(params) {
-    return this.http.getList("/public/boards", params);
+    return this.http.getList("/boards", params);
   }
   /**
    * Get board by ID or slug
    */
   async get(idOrSlug) {
-    return this.http.get(`/public/boards/${idOrSlug}`);
+    return this.http.get(`/boards/${idOrSlug}`);
   }
   // ============================================
-  // Posts (Public)
+  // Posts
   // ============================================
   /**
    * List posts in a board
    * @returns ListResponse with data array and pagination meta
    */
   async listPosts(boardIdOrSlug, params) {
-    return this.http.getList(`/public/boards/${boardIdOrSlug}/posts`, params);
+    return this.http.getList(`/boards/${boardIdOrSlug}/posts`, params);
   }
   /**
    * Get post by ID
    */
   async getPost(postId) {
-    return this.http.get(`/public/posts/${postId}`);
+    return this.http.get(`/posts/${postId}`);
   }
   // ============================================
   // Posts (Protected - requires auth)
@@ -404,7 +404,7 @@ var BoardsResource = class {
    * @returns Array of comments (always an array, never null/undefined)
    */
   async listComments(postId) {
-    const response = await this.http.getList(`/public/posts/${postId}/comments`);
+    const response = await this.http.getList(`/posts/${postId}/comments`);
     return response.data;
   }
   /**
@@ -437,26 +437,26 @@ var BlogResource = class {
    * @returns ListResponse with data array (always defined) and pagination meta
    */
   async list(params) {
-    return this.http.getList("/public/blog", params);
+    return this.http.getList("/blog", params);
   }
   /**
    * Get blog post by slug
    */
   async get(slug) {
-    return this.http.get(`/public/blog/${slug}`);
+    return this.http.get(`/blog/${slug}`);
   }
   /**
    * Get blog post by ID
    */
   async getById(id) {
-    return this.http.get(`/public/blog/id/${id}`);
+    return this.http.get(`/blog/id/${id}`);
   }
   /**
    * Get featured blog posts
    * @returns Array of featured posts (always an array, never null/undefined)
    */
   async featured(limit = 5) {
-    const response = await this.http.getList("/public/blog", {
+    const response = await this.http.getList("/blog", {
       per_page: limit,
       featured: true
     });
@@ -467,7 +467,7 @@ var BlogResource = class {
    * @returns ListResponse with data array and pagination meta
    */
   async byCategory(category, params) {
-    return this.http.getList("/public/blog", {
+    return this.http.getList("/blog", {
       ...params,
       category
     });
@@ -477,7 +477,7 @@ var BlogResource = class {
    * @returns ListResponse with data array and pagination meta
    */
   async byTag(tag, params) {
-    return this.http.getList("/public/blog", {
+    return this.http.getList("/blog", {
       ...params,
       tag
     });
@@ -487,7 +487,7 @@ var BlogResource = class {
    * @returns ListResponse with data array and pagination meta
    */
   async search(query, params) {
-    return this.http.getList("/public/blog", {
+    return this.http.getList("/blog", {
       ...params,
       search: query
     });
@@ -497,7 +497,7 @@ var BlogResource = class {
    * @returns Array of category names (always an array)
    */
   async categories() {
-    const response = await this.http.get("/public/blog/categories");
+    const response = await this.http.get("/blog/categories");
     return Array.isArray(response) ? response : response?.data ?? [];
   }
   /**
@@ -505,7 +505,7 @@ var BlogResource = class {
    * @returns Array of tag names (always an array)
    */
   async tags() {
-    const response = await this.http.get("/public/blog/tags");
+    const response = await this.http.get("/blog/tags");
     return Array.isArray(response) ? response : response?.data ?? [];
   }
 };
@@ -520,19 +520,19 @@ var FormsResource = class {
    * @returns ListResponse with data array and pagination meta
    */
   async list(params) {
-    return this.http.getList("/public/forms", params);
+    return this.http.getList("/forms", params);
   }
   /**
    * Get form by ID or slug
    */
   async get(idOrSlug) {
-    return this.http.get(`/public/forms/${idOrSlug}`);
+    return this.http.get(`/forms/${idOrSlug}`);
   }
   /**
    * Submit form data
    */
   async submit(formIdOrSlug, data) {
-    return this.http.post(`/public/forms/${formIdOrSlug}/submit`, data);
+    return this.http.post(`/forms/${formIdOrSlug}/submit`, data);
   }
   // ============================================
   // Protected endpoints (requires auth)
@@ -565,20 +565,20 @@ var ShopResource = class {
    * @returns ListResponse with data array and pagination meta
    */
   async listProducts(params) {
-    return this.http.getList("/public/products", params);
+    return this.http.getList("/products", params);
   }
   /**
    * Get product by ID or slug
    */
   async getProduct(idOrSlug) {
-    return this.http.get(`/public/products/${idOrSlug}`);
+    return this.http.get(`/products/${idOrSlug}`);
   }
   /**
    * Get featured products
    * @returns Array of featured products (always an array)
    */
   async featuredProducts(limit = 8) {
-    const response = await this.http.getList("/public/products", {
+    const response = await this.http.getList("/products", {
       per_page: limit,
       is_featured: true
     });
@@ -589,7 +589,7 @@ var ShopResource = class {
    * @returns ListResponse with data array and pagination meta
    */
   async searchProducts(query, params) {
-    return this.http.getList("/public/products", {
+    return this.http.getList("/products", {
       ...params,
       search: query
     });
@@ -602,21 +602,21 @@ var ShopResource = class {
    * @returns Array of categories (always an array)
    */
   async listCategories() {
-    const response = await this.http.getList("/public/categories");
+    const response = await this.http.getList("/categories");
     return response.data;
   }
   /**
    * Get category by ID or slug
    */
   async getCategory(idOrSlug) {
-    return this.http.get(`/public/categories/${idOrSlug}`);
+    return this.http.get(`/categories/${idOrSlug}`);
   }
   /**
    * Get products in category
    * @returns ListResponse with data array and pagination meta
    */
   async categoryProducts(categoryIdOrSlug, params) {
-    return this.http.getList(`/public/categories/${categoryIdOrSlug}/products`, params);
+    return this.http.getList(`/categories/${categoryIdOrSlug}/products`, params);
   }
   // ============================================
   // Cart
@@ -789,7 +789,7 @@ var EntitiesResource = class {
    * ```
    */
   async list() {
-    const response = await this.http.getList("/public/entities");
+    const response = await this.http.getList("/entities");
     return response.data;
   }
   /**
@@ -802,7 +802,7 @@ var EntitiesResource = class {
    * ```
    */
   async getSchema(slug) {
-    return this.http.get(`/public/entities/${slug}/schema`);
+    return this.http.get(`/entities/${slug}/schema`);
   }
   // ============================================
   // Records (Public Read)
@@ -830,7 +830,7 @@ var EntitiesResource = class {
    * ```
    */
   async listRecords(slug, params) {
-    return this.http.getList(`/public/entities/${slug}`, params);
+    return this.http.getList(`/entities/${slug}`, params);
   }
   /**
    * Get a single record by ID
@@ -842,7 +842,7 @@ var EntitiesResource = class {
    * ```
    */
   async getRecord(slug, id) {
-    return this.http.get(`/public/entities/${slug}/${id}`);
+    return this.http.get(`/entities/${slug}/${id}`);
   }
   // ============================================
   // Records (Protected - requires auth)
@@ -962,14 +962,14 @@ var ReservationResource = class {
    * @returns Reservation settings for the tenant
    */
   async getSettings() {
-    return this.http.get("/public/reservation/settings");
+    return this.http.get("/reservation/settings");
   }
   /**
    * List available services
    * @returns Array of services (always an array)
    */
   async listServices() {
-    const response = await this.http.getList("/public/reservation/services");
+    const response = await this.http.getList("/reservation/services");
     return response.data;
   }
   /**
@@ -979,7 +979,7 @@ var ReservationResource = class {
    */
   async listStaff(serviceId) {
     const params = serviceId ? { service_id: serviceId } : void 0;
-    const response = await this.http.getList("/public/reservation/staffs", params);
+    const response = await this.http.getList("/reservation/staffs", params);
     return response.data;
   }
   /**
@@ -987,7 +987,7 @@ var ReservationResource = class {
    * @returns Array of available date strings (YYYY-MM-DD)
    */
   async getAvailableDates(params) {
-    const response = await this.http.get("/public/reservation/available-dates", params);
+    const response = await this.http.get("/reservation/available-dates", params);
     return Array.isArray(response) ? response : response?.data ?? [];
   }
   /**
@@ -995,7 +995,7 @@ var ReservationResource = class {
    * @returns Array of available slots (always an array)
    */
   async getAvailableSlots(params) {
-    const response = await this.http.get("/public/reservation/available-slots", params);
+    const response = await this.http.get("/reservation/available-slots", params);
     return Array.isArray(response) ? response : response?.data ?? [];
   }
   // ============================================

package/package.json

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