@back23/promptly-sdk 1.3.2 → 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/dist/index.d.mts

@@ -4,6 +4,8 @@
 interface PromptlyConfig {
     /** Tenant ID (subdomain) */
     tenantId: string;
+    /** API key (required) - Get from Dashboard > Settings > API Tokens */
+    apiKey: string;
     /** Base URL of Promptly API */
     baseUrl?: string;
     /** Request timeout in milliseconds */
@@ -744,6 +746,7 @@ declare class HttpClient {
     private tenantId;
     private timeout;
     private token;
+    private apiKey;
     constructor(config: PromptlyConfig);
     /**
      * Set authentication token
@@ -757,12 +760,21 @@ declare class HttpClient {
      * Check if authenticated
      */
     isAuthenticated(): boolean;
+    /**
+     * Set API key for server-to-server authentication
+     */
+    setApiKey(apiKey: string | null): void;
+    /**
+     * Get current API key
+     */
+    getApiKey(): string | null;
     /**
      * Build full URL with query params
      */
     private buildUrl;
     /**
      * Build request headers
+     * API key takes precedence over bearer token for server-to-server auth
      */
     private buildHeaders;
     /**
@@ -1354,6 +1366,7 @@ declare class ReservationResource {
  * Promptly SDK
  *
  * A TypeScript/JavaScript SDK for the Promptly AI CMS platform.
+ * API Key is required for all API requests.
  *
  * @example
  * ```typescript
@@ -1361,18 +1374,12 @@ declare class ReservationResource {
  *
  * const client = new Promptly({
  *   tenantId: 'my-site',
- *   baseUrl: 'https://promptly.webbyon.com',
+ *   apiKey: 'pky_your_api_key_here',  // Required
  * });
  *
- * // Public API
+ * // All APIs require API key
  * const posts = await client.blog.list();
  * const products = await client.shop.listProducts();
- *
- * // Authentication
- * await client.auth.login({ email: 'user@example.com', password: 'password' });
- *
- * // Protected API
- * const orders = await client.shop.listOrders();
  * ```
  */
 
@@ -1419,6 +1426,26 @@ declare class Promptly {
      * Get current authentication token
      */
     getToken(): string | null;
+    /**
+     * Set API key for server-to-server authentication
+     * Alternative to user token authentication
+     *
+     * @example
+     * ```typescript
+     * const client = new Promptly({
+     *   tenantId: 'my-site',
+     *   apiKey: 'pky_your_api_key_here',
+     * });
+     *
+     * // Or set later
+     * client.setApiKey('pky_your_api_key_here');
+     * ```
+     */
+    setApiKey(apiKey: string | null): void;
+    /**
+     * Get current API key
+     */
+    getApiKey(): string | null;
 }
 
 export { type AddToCartData, type ApiError, type ApiResponse, type ApplyCouponData, type AuthResponse, type AvailableDatesParams, type AvailableSlotsParams, type BlogListParams, type BlogPost, type Board, type BoardComment, type BoardListParams, type BoardPost, type BoardSettings, type Cart, type CartItem, type Coupon, type CouponType, type CouponValidation, type CreateCommentData, type CreateEntityRecordData, type CreateOrderData, type CreatePostData, type CreateReservationData, type CreateReservationResult, type CustomEntity, type EntityField, type EntityListParams, type EntityRecord, type EntitySchema, type ForgotPasswordData, type Form, type FormField, type FormFieldOption, type FormFieldType, type FormFieldValidation, type FormListParams, type FormSettings, type FormSubmission, type ListParams, type ListResponse, type LoginCredentials, type Media, type Member, type Order, type OrderItem, type OrderListParams, type OrderStatus, type PaginatedResponse, type PaginationMeta, type Payment, type PaymentCancelData, type PaymentConfirmData, type PaymentMethod, type PaymentReadyData, type PaymentStatus, type PostListParams, type Product, type ProductCategory, type ProductListParams, type ProductOption, type ProductOptionValue, type ProductStatus, type ProductVariant, Promptly, type PromptlyConfig, PromptlyError, type RegisterData, type Reservation, type ReservationListParams, type ReservationService, type ReservationSettings, type ReservationSlot, type ReservationStaff, type ReservationStaffSummary, type ResetPasswordData, type SocialAuthUrl, type SocialProvider, type SubmissionListParams, type SubmitFormData, type UpdateCartItemData, type UpdateCommentData, type UpdateEntityRecordData, type UpdatePostData, type UpdateProfileData, Promptly as default };

package/dist/index.d.ts

@@ -4,6 +4,8 @@
 interface PromptlyConfig {
     /** Tenant ID (subdomain) */
     tenantId: string;
+    /** API key (required) - Get from Dashboard > Settings > API Tokens */
+    apiKey: string;
     /** Base URL of Promptly API */
     baseUrl?: string;
     /** Request timeout in milliseconds */
@@ -744,6 +746,7 @@ declare class HttpClient {
     private tenantId;
     private timeout;
     private token;
+    private apiKey;
     constructor(config: PromptlyConfig);
     /**
      * Set authentication token
@@ -757,12 +760,21 @@ declare class HttpClient {
      * Check if authenticated
      */
     isAuthenticated(): boolean;
+    /**
+     * Set API key for server-to-server authentication
+     */
+    setApiKey(apiKey: string | null): void;
+    /**
+     * Get current API key
+     */
+    getApiKey(): string | null;
     /**
      * Build full URL with query params
      */
     private buildUrl;
     /**
      * Build request headers
+     * API key takes precedence over bearer token for server-to-server auth
      */
     private buildHeaders;
     /**
@@ -1354,6 +1366,7 @@ declare class ReservationResource {
  * Promptly SDK
  *
  * A TypeScript/JavaScript SDK for the Promptly AI CMS platform.
+ * API Key is required for all API requests.
  *
  * @example
  * ```typescript
@@ -1361,18 +1374,12 @@ declare class ReservationResource {
  *
  * const client = new Promptly({
  *   tenantId: 'my-site',
- *   baseUrl: 'https://promptly.webbyon.com',
+ *   apiKey: 'pky_your_api_key_here',  // Required
  * });
  *
- * // Public API
+ * // All APIs require API key
  * const posts = await client.blog.list();
  * const products = await client.shop.listProducts();
- *
- * // Authentication
- * await client.auth.login({ email: 'user@example.com', password: 'password' });
- *
- * // Protected API
- * const orders = await client.shop.listOrders();
  * ```
  */
 
@@ -1419,6 +1426,26 @@ declare class Promptly {
      * Get current authentication token
      */
     getToken(): string | null;
+    /**
+     * Set API key for server-to-server authentication
+     * Alternative to user token authentication
+     *
+     * @example
+     * ```typescript
+     * const client = new Promptly({
+     *   tenantId: 'my-site',
+     *   apiKey: 'pky_your_api_key_here',
+     * });
+     *
+     * // Or set later
+     * client.setApiKey('pky_your_api_key_here');
+     * ```
+     */
+    setApiKey(apiKey: string | null): void;
+    /**
+     * Get current API key
+     */
+    getApiKey(): string | null;
 }
 
 export { type AddToCartData, type ApiError, type ApiResponse, type ApplyCouponData, type AuthResponse, type AvailableDatesParams, type AvailableSlotsParams, type BlogListParams, type BlogPost, type Board, type BoardComment, type BoardListParams, type BoardPost, type BoardSettings, type Cart, type CartItem, type Coupon, type CouponType, type CouponValidation, type CreateCommentData, type CreateEntityRecordData, type CreateOrderData, type CreatePostData, type CreateReservationData, type CreateReservationResult, type CustomEntity, type EntityField, type EntityListParams, type EntityRecord, type EntitySchema, type ForgotPasswordData, type Form, type FormField, type FormFieldOption, type FormFieldType, type FormFieldValidation, type FormListParams, type FormSettings, type FormSubmission, type ListParams, type ListResponse, type LoginCredentials, type Media, type Member, type Order, type OrderItem, type OrderListParams, type OrderStatus, type PaginatedResponse, type PaginationMeta, type Payment, type PaymentCancelData, type PaymentConfirmData, type PaymentMethod, type PaymentReadyData, type PaymentStatus, type PostListParams, type Product, type ProductCategory, type ProductListParams, type ProductOption, type ProductOptionValue, type ProductStatus, type ProductVariant, Promptly, type PromptlyConfig, PromptlyError, type RegisterData, type Reservation, type ReservationListParams, type ReservationService, type ReservationSettings, type ReservationSlot, type ReservationStaff, type ReservationStaffSummary, type ResetPasswordData, type SocialAuthUrl, type SocialProvider, type SubmissionListParams, type SubmitFormData, type UpdateCartItemData, type UpdateCommentData, type UpdateEntityRecordData, type UpdatePostData, type UpdateProfileData, Promptly as default };

package/dist/index.js

@@ -70,9 +70,11 @@ var PromptlyError = class extends Error {
 var HttpClient = class {
   constructor(config) {
     this.token = null;
+    this.apiKey = null;
     this.tenantId = config.tenantId;
     this.baseUrl = (config.baseUrl || "https://promptly.webbyon.com").replace(/\/$/, "");
     this.timeout = config.timeout || 3e4;
+    this.apiKey = config.apiKey || null;
   }
   /**
    * Set authentication token
@@ -90,7 +92,19 @@ var HttpClient = class {
    * Check if authenticated
    */
   isAuthenticated() {
-    return this.token !== null;
+    return this.token !== null || this.apiKey !== null;
+  }
+  /**
+   * Set API key for server-to-server authentication
+   */
+  setApiKey(apiKey) {
+    this.apiKey = apiKey;
+  }
+  /**
+   * Get current API key
+   */
+  getApiKey() {
+    return this.apiKey;
   }
   /**
    * Build full URL with query params
@@ -108,6 +122,7 @@ var HttpClient = class {
   }
   /**
    * Build request headers
+   * API key takes precedence over bearer token for server-to-server auth
    */
   buildHeaders(customHeaders) {
     const headers = {
@@ -115,7 +130,9 @@ var HttpClient = class {
       "Accept": "application/json",
       ...customHeaders
     };
-    if (this.token) {
+    if (this.apiKey) {
+      headers["X-API-Key"] = this.apiKey;
+    } else if (this.token) {
       headers["Authorization"] = `Bearer ${this.token}`;
     }
     return headers;
@@ -208,7 +225,9 @@ var HttpClient = class {
     const headers = {
       "Accept": "application/json"
     };
-    if (this.token) {
+    if (this.apiKey) {
+      headers["X-API-Key"] = this.apiKey;
+    } else if (this.token) {
       headers["Authorization"] = `Bearer ${this.token}`;
     }
     const controller = new AbortController();
@@ -1065,6 +1084,9 @@ var ReservationResource = class {
 // src/index.ts
 var Promptly = class {
   constructor(config) {
+    if (!config.apiKey) {
+      throw new Error("API key is required. Get your API key from Dashboard > Settings > API Tokens");
+    }
     this.http = new HttpClient(config);
     this.auth = new AuthResource(this.http);
     this.boards = new BoardsResource(this.http);
@@ -1105,6 +1127,30 @@ var Promptly = class {
   getToken() {
     return this.auth.getToken();
   }
+  /**
+   * Set API key for server-to-server authentication
+   * Alternative to user token authentication
+   *
+   * @example
+   * ```typescript
+   * const client = new Promptly({
+   *   tenantId: 'my-site',
+   *   apiKey: 'pky_your_api_key_here',
+   * });
+   *
+   * // Or set later
+   * client.setApiKey('pky_your_api_key_here');
+   * ```
+   */
+  setApiKey(apiKey) {
+    this.http.setApiKey(apiKey);
+  }
+  /**
+   * Get current API key
+   */
+  getApiKey() {
+    return this.http.getApiKey();
+  }
 };
 var index_default = Promptly;
 // Annotate the CommonJS export names for ESM import in node:

package/dist/index.mjs

@@ -42,9 +42,11 @@ var PromptlyError = class extends Error {
 var HttpClient = class {
   constructor(config) {
     this.token = null;
+    this.apiKey = null;
     this.tenantId = config.tenantId;
     this.baseUrl = (config.baseUrl || "https://promptly.webbyon.com").replace(/\/$/, "");
     this.timeout = config.timeout || 3e4;
+    this.apiKey = config.apiKey || null;
   }
   /**
    * Set authentication token
@@ -62,7 +64,19 @@ var HttpClient = class {
    * Check if authenticated
    */
   isAuthenticated() {
-    return this.token !== null;
+    return this.token !== null || this.apiKey !== null;
+  }
+  /**
+   * Set API key for server-to-server authentication
+   */
+  setApiKey(apiKey) {
+    this.apiKey = apiKey;
+  }
+  /**
+   * Get current API key
+   */
+  getApiKey() {
+    return this.apiKey;
   }
   /**
    * Build full URL with query params
@@ -80,6 +94,7 @@ var HttpClient = class {
   }
   /**
    * Build request headers
+   * API key takes precedence over bearer token for server-to-server auth
    */
   buildHeaders(customHeaders) {
     const headers = {
@@ -87,7 +102,9 @@ var HttpClient = class {
       "Accept": "application/json",
       ...customHeaders
     };
-    if (this.token) {
+    if (this.apiKey) {
+      headers["X-API-Key"] = this.apiKey;
+    } else if (this.token) {
       headers["Authorization"] = `Bearer ${this.token}`;
     }
     return headers;
@@ -180,7 +197,9 @@ var HttpClient = class {
     const headers = {
       "Accept": "application/json"
     };
-    if (this.token) {
+    if (this.apiKey) {
+      headers["X-API-Key"] = this.apiKey;
+    } else if (this.token) {
       headers["Authorization"] = `Bearer ${this.token}`;
     }
     const controller = new AbortController();
@@ -1037,6 +1056,9 @@ var ReservationResource = class {
 // src/index.ts
 var Promptly = class {
   constructor(config) {
+    if (!config.apiKey) {
+      throw new Error("API key is required. Get your API key from Dashboard > Settings > API Tokens");
+    }
     this.http = new HttpClient(config);
     this.auth = new AuthResource(this.http);
     this.boards = new BoardsResource(this.http);
@@ -1077,6 +1099,30 @@ var Promptly = class {
   getToken() {
     return this.auth.getToken();
   }
+  /**
+   * Set API key for server-to-server authentication
+   * Alternative to user token authentication
+   *
+   * @example
+   * ```typescript
+   * const client = new Promptly({
+   *   tenantId: 'my-site',
+   *   apiKey: 'pky_your_api_key_here',
+   * });
+   *
+   * // Or set later
+   * client.setApiKey('pky_your_api_key_here');
+   * ```
+   */
+  setApiKey(apiKey) {
+    this.http.setApiKey(apiKey);
+  }
+  /**
+   * Get current API key
+   */
+  getApiKey() {
+    return this.http.getApiKey();
+  }
 };
 var index_default = Promptly;
 export {

package/package.json

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