@smartsuite-cms/emagazine-sdk 1.0.0

package/dist/index.d.mts

@@ -0,0 +1,129 @@
+/** Emagazine article item returned by the list endpoint */
+interface EmagazineItem {
+    id: string;
+    title: string;
+    slug: string;
+    summary: string | null;
+    thumbnail_url: string | null;
+    status: 'draft' | 'pending' | 'published' | 'archived' | 'trash';
+    editor_type: 'grapes' | 'custom';
+    seo_title: string | null;
+    seo_description: string | null;
+    views_count: number;
+    is_featured: boolean;
+    created_at: string;
+    updated_at: string;
+    published_at: string | null;
+    author: {
+        full_name: string;
+        avatar_url: string | null;
+    } | null;
+    category: {
+        name: string;
+    } | null;
+}
+/** Detailed article data including HTML/CSS content */
+interface EmagazineDetail {
+    id: string;
+    title: string;
+    slug: string;
+    summary: string | null;
+    html_content: string | null;
+    css_content: string | null;
+    thumbnail_url: string | null;
+    status: 'draft' | 'pending' | 'published' | 'archived' | 'trash';
+    editor_type: 'grapes' | 'custom';
+    seo_title: string | null;
+    seo_description: string | null;
+    views_count: number;
+    is_featured: boolean;
+    created_at: string;
+    updated_at: string;
+    published_at: string | null;
+    preview_url: string;
+    author: {
+        full_name: string;
+        avatar_url: string | null;
+    } | null;
+    category: {
+        name: string;
+    } | null;
+}
+/** Options for listing emagazines */
+interface ListEmagazinesOptions {
+    /** Filter by status. Default: 'published' */
+    status?: 'draft' | 'pending' | 'published' | 'archived' | 'all';
+    /** Filter by category ID */
+    categoryId?: string;
+    /** Only return featured articles */
+    featured?: boolean;
+    /** Search by title (case-insensitive) */
+    search?: string;
+    /** Page number (1-based). Default: 1 */
+    page?: number;
+    /** Items per page. Default: 20, max: 100 */
+    limit?: number;
+    /** Sort field. Default: 'published_at' */
+    orderBy?: 'published_at' | 'created_at' | 'title' | 'views_count';
+    /** Sort direction. Default: 'desc' */
+    orderDirection?: 'asc' | 'desc';
+}
+/** Paginated list response */
+interface PaginatedResponse<T> {
+    data: T[];
+    total: number;
+    page: number;
+    limit: number;
+    totalPages: number;
+}
+/** SDK configuration */
+interface EmagazineSDKConfig {
+    /** Supabase project URL */
+    supabaseUrl: string;
+    /** Supabase anon key */
+    supabaseAnonKey: string;
+    /** CMS base URL for generating preview links. Default: same as supabaseUrl origin */
+    cmsBaseUrl?: string;
+}
+
+declare class EmagazineSDK {
+    private supabase;
+    private cmsBaseUrl;
+    constructor(config: EmagazineSDKConfig);
+    /**
+     * Load a paginated list of e-magazine articles.
+     * By default returns only published articles sorted by published_at desc.
+     */
+    listEmagazines(options?: ListEmagazinesOptions): Promise<PaginatedResponse<EmagazineItem>>;
+    /**
+     * Get a list of all available categories.
+     */
+    listCategories(): Promise<{
+        id: string;
+        name: string;
+        slug: string;
+        description: string | null;
+    }[]>;
+    /**
+     * Get detailed article data by ID, including preview_url, html_content, css_content.
+     */
+    getEmagazineById(id: string): Promise<EmagazineDetail | null>;
+    /**
+     * Get detailed article data by slug, including preview_url, html_content, css_content.
+     */
+    getEmagazineBySlug(slug: string): Promise<EmagazineDetail | null>;
+    /**
+     * Render an emagazine article into an HTML container element.
+     * Injects css_content as <style> and html_content into the container.
+     * Returns a cleanup function to remove injected styles.
+     */
+    renderToElement(detail: EmagazineDetail, container: HTMLElement): () => void;
+    /**
+     * Generate a full standalone HTML page string for an emagazine article.
+     * Useful for iframes or server-side rendering.
+     */
+    generateFullPageHTML(detail: EmagazineDetail): string;
+    private escapeHtml;
+}
+
+export { type EmagazineDetail, type EmagazineItem, EmagazineSDK, type EmagazineSDKConfig, type ListEmagazinesOptions, type PaginatedResponse };

package/dist/index.d.ts

@@ -0,0 +1,129 @@
+/** Emagazine article item returned by the list endpoint */
+interface EmagazineItem {
+    id: string;
+    title: string;
+    slug: string;
+    summary: string | null;
+    thumbnail_url: string | null;
+    status: 'draft' | 'pending' | 'published' | 'archived' | 'trash';
+    editor_type: 'grapes' | 'custom';
+    seo_title: string | null;
+    seo_description: string | null;
+    views_count: number;
+    is_featured: boolean;
+    created_at: string;
+    updated_at: string;
+    published_at: string | null;
+    author: {
+        full_name: string;
+        avatar_url: string | null;
+    } | null;
+    category: {
+        name: string;
+    } | null;
+}
+/** Detailed article data including HTML/CSS content */
+interface EmagazineDetail {
+    id: string;
+    title: string;
+    slug: string;
+    summary: string | null;
+    html_content: string | null;
+    css_content: string | null;
+    thumbnail_url: string | null;
+    status: 'draft' | 'pending' | 'published' | 'archived' | 'trash';
+    editor_type: 'grapes' | 'custom';
+    seo_title: string | null;
+    seo_description: string | null;
+    views_count: number;
+    is_featured: boolean;
+    created_at: string;
+    updated_at: string;
+    published_at: string | null;
+    preview_url: string;
+    author: {
+        full_name: string;
+        avatar_url: string | null;
+    } | null;
+    category: {
+        name: string;
+    } | null;
+}
+/** Options for listing emagazines */
+interface ListEmagazinesOptions {
+    /** Filter by status. Default: 'published' */
+    status?: 'draft' | 'pending' | 'published' | 'archived' | 'all';
+    /** Filter by category ID */
+    categoryId?: string;
+    /** Only return featured articles */
+    featured?: boolean;
+    /** Search by title (case-insensitive) */
+    search?: string;
+    /** Page number (1-based). Default: 1 */
+    page?: number;
+    /** Items per page. Default: 20, max: 100 */
+    limit?: number;
+    /** Sort field. Default: 'published_at' */
+    orderBy?: 'published_at' | 'created_at' | 'title' | 'views_count';
+    /** Sort direction. Default: 'desc' */
+    orderDirection?: 'asc' | 'desc';
+}
+/** Paginated list response */
+interface PaginatedResponse<T> {
+    data: T[];
+    total: number;
+    page: number;
+    limit: number;
+    totalPages: number;
+}
+/** SDK configuration */
+interface EmagazineSDKConfig {
+    /** Supabase project URL */
+    supabaseUrl: string;
+    /** Supabase anon key */
+    supabaseAnonKey: string;
+    /** CMS base URL for generating preview links. Default: same as supabaseUrl origin */
+    cmsBaseUrl?: string;
+}
+
+declare class EmagazineSDK {
+    private supabase;
+    private cmsBaseUrl;
+    constructor(config: EmagazineSDKConfig);
+    /**
+     * Load a paginated list of e-magazine articles.
+     * By default returns only published articles sorted by published_at desc.
+     */
+    listEmagazines(options?: ListEmagazinesOptions): Promise<PaginatedResponse<EmagazineItem>>;
+    /**
+     * Get a list of all available categories.
+     */
+    listCategories(): Promise<{
+        id: string;
+        name: string;
+        slug: string;
+        description: string | null;
+    }[]>;
+    /**
+     * Get detailed article data by ID, including preview_url, html_content, css_content.
+     */
+    getEmagazineById(id: string): Promise<EmagazineDetail | null>;
+    /**
+     * Get detailed article data by slug, including preview_url, html_content, css_content.
+     */
+    getEmagazineBySlug(slug: string): Promise<EmagazineDetail | null>;
+    /**
+     * Render an emagazine article into an HTML container element.
+     * Injects css_content as <style> and html_content into the container.
+     * Returns a cleanup function to remove injected styles.
+     */
+    renderToElement(detail: EmagazineDetail, container: HTMLElement): () => void;
+    /**
+     * Generate a full standalone HTML page string for an emagazine article.
+     * Useful for iframes or server-side rendering.
+     */
+    generateFullPageHTML(detail: EmagazineDetail): string;
+    private escapeHtml;
+}
+
+export { type EmagazineDetail, type EmagazineItem, EmagazineSDK, type EmagazineSDKConfig, type ListEmagazinesOptions, type PaginatedResponse };

package/dist/index.js

@@ -0,0 +1,205 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.ts
+var index_exports = {};
+__export(index_exports, {
+  EmagazineSDK: () => EmagazineSDK
+});
+module.exports = __toCommonJS(index_exports);
+
+// src/client.ts
+var import_supabase_js = require("@supabase/supabase-js");
+var EmagazineSDK = class {
+  constructor(config) {
+    if (!config.supabaseUrl || !config.supabaseAnonKey) {
+      throw new Error("[EmagazineSDK] supabaseUrl and supabaseAnonKey are required.");
+    }
+    this.supabase = (0, import_supabase_js.createClient)(config.supabaseUrl, config.supabaseAnonKey);
+    this.cmsBaseUrl = config.cmsBaseUrl || config.supabaseUrl.replace(".supabase.co", "");
+  }
+  /**
+   * Load a paginated list of e-magazine articles.
+   * By default returns only published articles sorted by published_at desc.
+   */
+  async listEmagazines(options = {}) {
+    const {
+      status = "published",
+      categoryId,
+      featured,
+      search,
+      page = 1,
+      limit: rawLimit = 20,
+      orderBy = "published_at",
+      orderDirection = "desc"
+    } = options;
+    const limit = Math.min(Math.max(rawLimit, 1), 100);
+    const from = (page - 1) * limit;
+    const to = from + limit - 1;
+    let query = this.supabase.from("emagazines").select(`
+        id, title, slug, summary, thumbnail_url, status, editor_type,
+        seo_title, seo_description, views_count, is_featured,
+        created_at, updated_at, published_at,
+        author:users(full_name, avatar_url),
+        category:emagazine_categories(name)
+      `, { count: "exact" });
+    if (status !== "all") {
+      query = query.eq("status", status);
+    } else {
+      query = query.neq("status", "trash");
+    }
+    if (categoryId) {
+      query = query.eq("category_id", categoryId);
+    }
+    if (featured !== void 0) {
+      query = query.eq("is_featured", featured);
+    }
+    if (search) {
+      query = query.ilike("title", `%${search}%`);
+    }
+    query = query.order(orderBy, { ascending: orderDirection === "asc" }).range(from, to);
+    const { data, error, count } = await query;
+    if (error) {
+      throw new Error(`[EmagazineSDK] listEmagazines failed: ${error.message}`);
+    }
+    const total = count ?? 0;
+    const rows = data || [];
+    return {
+      data: rows,
+      total,
+      page,
+      limit,
+      totalPages: Math.ceil(total / limit)
+    };
+  }
+  /**
+   * Get a list of all available categories.
+   */
+  async listCategories() {
+    const { data, error } = await this.supabase.from("emagazine_categories").select("id, name, slug, description").order("name");
+    if (error) {
+      throw new Error(`[EmagazineSDK] listCategories failed: ${error.message}`);
+    }
+    return data || [];
+  }
+  /**
+   * Get detailed article data by ID, including preview_url, html_content, css_content.
+   */
+  async getEmagazineById(id) {
+    if (!id) throw new Error("[EmagazineSDK] id is required.");
+    const { data, error } = await this.supabase.from("emagazines").select(`
+        id, title, slug, summary, html_content, css_content,
+        thumbnail_url, status, editor_type,
+        seo_title, seo_description, views_count, is_featured,
+        created_at, updated_at, published_at,
+        author:users(full_name, avatar_url),
+        category:emagazine_categories(name)
+      `).eq("id", id).single();
+    if (error) {
+      if (error.code === "PGRST116") return null;
+      throw new Error(`[EmagazineSDK] getEmagazineById failed: ${error.message}`);
+    }
+    if (!data) return null;
+    const row = data;
+    return {
+      ...row,
+      preview_url: `${this.cmsBaseUrl}/corporate/e-magazine/preview/${row.id}`
+    };
+  }
+  /**
+   * Get detailed article data by slug, including preview_url, html_content, css_content.
+   */
+  async getEmagazineBySlug(slug) {
+    if (!slug) throw new Error("[EmagazineSDK] slug is required.");
+    const { data, error } = await this.supabase.from("emagazines").select(`
+        id, title, slug, summary, html_content, css_content,
+        thumbnail_url, status, editor_type,
+        seo_title, seo_description, views_count, is_featured,
+        created_at, updated_at, published_at,
+        author:users(full_name, avatar_url),
+        category:emagazine_categories(name)
+      `).eq("slug", slug).single();
+    if (error) {
+      if (error.code === "PGRST116") return null;
+      throw new Error(`[EmagazineSDK] getEmagazineBySlug failed: ${error.message}`);
+    }
+    if (!data) return null;
+    const row = data;
+    return {
+      ...row,
+      preview_url: `${this.cmsBaseUrl}/corporate/e-magazine/preview/${row.id}`
+    };
+  }
+  /**
+   * Render an emagazine article into an HTML container element.
+   * Injects css_content as <style> and html_content into the container.
+   * Returns a cleanup function to remove injected styles.
+   */
+  renderToElement(detail, container) {
+    if (!detail.html_content) {
+      container.innerHTML = '<p style="text-align:center;padding:2rem;color:#999;">No content available.</p>';
+      return () => {
+        container.innerHTML = "";
+      };
+    }
+    const styleEl = document.createElement("style");
+    styleEl.setAttribute("data-emagazine-id", detail.id);
+    styleEl.textContent = detail.css_content || "";
+    document.head.appendChild(styleEl);
+    container.innerHTML = detail.html_content;
+    return () => {
+      styleEl.remove();
+      container.innerHTML = "";
+    };
+  }
+  /**
+   * Generate a full standalone HTML page string for an emagazine article.
+   * Useful for iframes or server-side rendering.
+   */
+  generateFullPageHTML(detail) {
+    const title = detail.seo_title || detail.title;
+    const description = detail.seo_description || detail.summary || "";
+    return `<!DOCTYPE html>
+<html lang="vi">
+<head>
+  <meta charset="UTF-8">
+  <meta name="viewport" content="width=device-width, initial-scale=1.0">
+  <title>${this.escapeHtml(title)}</title>
+  <meta name="description" content="${this.escapeHtml(description)}">
+  ${detail.thumbnail_url ? `<meta property="og:image" content="${this.escapeHtml(detail.thumbnail_url)}">` : ""}
+  <style>
+    * { margin: 0; padding: 0; box-sizing: border-box; }
+    body { font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, sans-serif; }
+    img { max-width: 100%; height: auto; }
+    ${detail.css_content || ""}
+  </style>
+</head>
+<body>
+  ${detail.html_content || ""}
+</body>
+</html>`;
+  }
+  escapeHtml(str) {
+    return str.replace(/&/g, "&amp;").replace(/</g, "&lt;").replace(/>/g, "&gt;").replace(/"/g, "&quot;").replace(/'/g, "&#039;");
+  }
+};
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  EmagazineSDK
+});

package/dist/index.mjs

@@ -0,0 +1,178 @@
+// src/client.ts
+import { createClient } from "@supabase/supabase-js";
+var EmagazineSDK = class {
+  constructor(config) {
+    if (!config.supabaseUrl || !config.supabaseAnonKey) {
+      throw new Error("[EmagazineSDK] supabaseUrl and supabaseAnonKey are required.");
+    }
+    this.supabase = createClient(config.supabaseUrl, config.supabaseAnonKey);
+    this.cmsBaseUrl = config.cmsBaseUrl || config.supabaseUrl.replace(".supabase.co", "");
+  }
+  /**
+   * Load a paginated list of e-magazine articles.
+   * By default returns only published articles sorted by published_at desc.
+   */
+  async listEmagazines(options = {}) {
+    const {
+      status = "published",
+      categoryId,
+      featured,
+      search,
+      page = 1,
+      limit: rawLimit = 20,
+      orderBy = "published_at",
+      orderDirection = "desc"
+    } = options;
+    const limit = Math.min(Math.max(rawLimit, 1), 100);
+    const from = (page - 1) * limit;
+    const to = from + limit - 1;
+    let query = this.supabase.from("emagazines").select(`
+        id, title, slug, summary, thumbnail_url, status, editor_type,
+        seo_title, seo_description, views_count, is_featured,
+        created_at, updated_at, published_at,
+        author:users(full_name, avatar_url),
+        category:emagazine_categories(name)
+      `, { count: "exact" });
+    if (status !== "all") {
+      query = query.eq("status", status);
+    } else {
+      query = query.neq("status", "trash");
+    }
+    if (categoryId) {
+      query = query.eq("category_id", categoryId);
+    }
+    if (featured !== void 0) {
+      query = query.eq("is_featured", featured);
+    }
+    if (search) {
+      query = query.ilike("title", `%${search}%`);
+    }
+    query = query.order(orderBy, { ascending: orderDirection === "asc" }).range(from, to);
+    const { data, error, count } = await query;
+    if (error) {
+      throw new Error(`[EmagazineSDK] listEmagazines failed: ${error.message}`);
+    }
+    const total = count ?? 0;
+    const rows = data || [];
+    return {
+      data: rows,
+      total,
+      page,
+      limit,
+      totalPages: Math.ceil(total / limit)
+    };
+  }
+  /**
+   * Get a list of all available categories.
+   */
+  async listCategories() {
+    const { data, error } = await this.supabase.from("emagazine_categories").select("id, name, slug, description").order("name");
+    if (error) {
+      throw new Error(`[EmagazineSDK] listCategories failed: ${error.message}`);
+    }
+    return data || [];
+  }
+  /**
+   * Get detailed article data by ID, including preview_url, html_content, css_content.
+   */
+  async getEmagazineById(id) {
+    if (!id) throw new Error("[EmagazineSDK] id is required.");
+    const { data, error } = await this.supabase.from("emagazines").select(`
+        id, title, slug, summary, html_content, css_content,
+        thumbnail_url, status, editor_type,
+        seo_title, seo_description, views_count, is_featured,
+        created_at, updated_at, published_at,
+        author:users(full_name, avatar_url),
+        category:emagazine_categories(name)
+      `).eq("id", id).single();
+    if (error) {
+      if (error.code === "PGRST116") return null;
+      throw new Error(`[EmagazineSDK] getEmagazineById failed: ${error.message}`);
+    }
+    if (!data) return null;
+    const row = data;
+    return {
+      ...row,
+      preview_url: `${this.cmsBaseUrl}/corporate/e-magazine/preview/${row.id}`
+    };
+  }
+  /**
+   * Get detailed article data by slug, including preview_url, html_content, css_content.
+   */
+  async getEmagazineBySlug(slug) {
+    if (!slug) throw new Error("[EmagazineSDK] slug is required.");
+    const { data, error } = await this.supabase.from("emagazines").select(`
+        id, title, slug, summary, html_content, css_content,
+        thumbnail_url, status, editor_type,
+        seo_title, seo_description, views_count, is_featured,
+        created_at, updated_at, published_at,
+        author:users(full_name, avatar_url),
+        category:emagazine_categories(name)
+      `).eq("slug", slug).single();
+    if (error) {
+      if (error.code === "PGRST116") return null;
+      throw new Error(`[EmagazineSDK] getEmagazineBySlug failed: ${error.message}`);
+    }
+    if (!data) return null;
+    const row = data;
+    return {
+      ...row,
+      preview_url: `${this.cmsBaseUrl}/corporate/e-magazine/preview/${row.id}`
+    };
+  }
+  /**
+   * Render an emagazine article into an HTML container element.
+   * Injects css_content as <style> and html_content into the container.
+   * Returns a cleanup function to remove injected styles.
+   */
+  renderToElement(detail, container) {
+    if (!detail.html_content) {
+      container.innerHTML = '<p style="text-align:center;padding:2rem;color:#999;">No content available.</p>';
+      return () => {
+        container.innerHTML = "";
+      };
+    }
+    const styleEl = document.createElement("style");
+    styleEl.setAttribute("data-emagazine-id", detail.id);
+    styleEl.textContent = detail.css_content || "";
+    document.head.appendChild(styleEl);
+    container.innerHTML = detail.html_content;
+    return () => {
+      styleEl.remove();
+      container.innerHTML = "";
+    };
+  }
+  /**
+   * Generate a full standalone HTML page string for an emagazine article.
+   * Useful for iframes or server-side rendering.
+   */
+  generateFullPageHTML(detail) {
+    const title = detail.seo_title || detail.title;
+    const description = detail.seo_description || detail.summary || "";
+    return `<!DOCTYPE html>
+<html lang="vi">
+<head>
+  <meta charset="UTF-8">
+  <meta name="viewport" content="width=device-width, initial-scale=1.0">
+  <title>${this.escapeHtml(title)}</title>
+  <meta name="description" content="${this.escapeHtml(description)}">
+  ${detail.thumbnail_url ? `<meta property="og:image" content="${this.escapeHtml(detail.thumbnail_url)}">` : ""}
+  <style>
+    * { margin: 0; padding: 0; box-sizing: border-box; }
+    body { font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, sans-serif; }
+    img { max-width: 100%; height: auto; }
+    ${detail.css_content || ""}
+  </style>
+</head>
+<body>
+  ${detail.html_content || ""}
+</body>
+</html>`;
+  }
+  escapeHtml(str) {
+    return str.replace(/&/g, "&amp;").replace(/</g, "&lt;").replace(/>/g, "&gt;").replace(/"/g, "&quot;").replace(/'/g, "&#039;");
+  }
+};
+export {
+  EmagazineSDK
+};

package/package.json

@@ -0,0 +1,29 @@
+{
+    "name": "@smartsuite-cms/emagazine-sdk",
+    "version": "1.0.0",
+    "description": "SDK to load and display e-magazine articles from Smart Suite CMS",
+    "main": "dist/index.js",
+    "module": "dist/index.mjs",
+    "types": "dist/index.d.ts",
+    "files": [
+        "dist"
+    ],
+    "scripts": {
+        "build": "tsup src/index.ts --format cjs,esm --dts --clean",
+        "dev": "tsup src/index.ts --format cjs,esm --dts --watch"
+    },
+    "keywords": [
+        "emagazine",
+        "cms",
+        "smartsuite",
+        "sdk"
+    ],
+    "license": "MIT",
+    "dependencies": {
+        "@supabase/supabase-js": "^2.49.0"
+    },
+    "devDependencies": {
+        "tsup": "^8.0.0",
+        "typescript": "^5.5.0"
+    }
+}