@zenith-open/zenithcms-sdk 1.0.0-beta.8 → 1.0.0-beta.9

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zenith-open/zenithcms-sdk",
-  "version": "1.0.0-beta.8",
+  "version": "1.0.0-beta.9",
   "publishConfig": {
     "access": "public"
   },
@@ -19,7 +19,7 @@
   "license": "MIT",
   "devDependencies": {
     "vitest": "^1.6.0",
-    "@zenith-open/zenithcms-types": "1.0.0-beta.8"
+    "@zenith-open/zenithcms-types": "1.0.0-beta.9"
   },
   "files": [
     "dist",

package/dist/cache.d.ts

@@ -1,21 +0,0 @@
-/**
- * Zenith Advanced Cache Service
- * ─────────────────────────────
- * Features:
- * 1. Tag-based invalidation (e.g., invalidate all 'posts')
- * 2. TTL support
- * 3. Atomic clears
- */
-export declare class CacheService {
-    private static cache;
-    private static tags;
-    static initialize(): void;
-    static get<T>(key: string): T | undefined;
-    static set(key: string, value: unknown, ttl?: number, tags?: string[]): void;
-    static del(keys: string | string[]): void;
-    /**
-     * Invalidate all keys associated with a tag
-     */
-    static invalidateTag(tag: string): void;
-    static flush(): void;
-}

package/dist/cache.js

@@ -1,55 +0,0 @@
-import NodeCache from 'node-cache';
-import { logger } from './logger';
-/**
- * Zenith Advanced Cache Service
- * ─────────────────────────────
- * Features:
- * 1. Tag-based invalidation (e.g., invalidate all 'posts')
- * 2. TTL support
- * 3. Atomic clears
- */
-export class CacheService {
-    static cache = new NodeCache({ stdTTL: 600 }); // 10 min default
-    static tags = {};
-    // Handle key expiration to prevent memory leaks in the tags array
-    static initialize() {
-        this.cache.on('expired', (key) => {
-            Object.keys(this.tags).forEach((tag) => {
-                this.tags[tag] = this.tags[tag].filter((k) => k !== key);
-            });
-        });
-    }
-    static get(key) {
-        return this.cache.get(key);
-    }
-    static set(key, value, ttl, tags = []) {
-        this.cache.set(key, value, ttl || 600);
-        // Track tags
-        tags.forEach((tag) => {
-            if (!this.tags[tag])
-                this.tags[tag] = [];
-            if (!this.tags[tag].includes(key)) {
-                this.tags[tag].push(key);
-            }
-        });
-    }
-    static del(keys) {
-        this.cache.del(keys);
-    }
-    /**
-     * Invalidate all keys associated with a tag
-     */
-    static invalidateTag(tag) {
-        const keys = this.tags[tag];
-        if (keys && keys.length > 0) {
-            logger.info({ tag, count: keys.length }, 'Invalidating cache tag');
-            this.cache.del(keys);
-            this.tags[tag] = [];
-        }
-    }
-    static flush() {
-        this.cache.flushAll();
-        this.tags = {};
-    }
-}
-CacheService.initialize();

package/dist/client.d.ts

@@ -1,65 +0,0 @@
-export interface ZenithClientOptions {
-    url: string;
-    apiKey?: string;
-    siteId?: string;
-}
-export interface FetchOptions extends RequestInit {
-    locale?: string;
-    depth?: number;
-    drafts?: boolean;
-}
-// eslint-disable-next-line @typescript-eslint/no-explicit-any
-export interface FindOptions extends FetchOptions {
-    where?: Record<string, any>; // eslint-disable-line @typescript-eslint/no-explicit-any
-    sort?: string;
-    limit?: number;
-    page?: number;
-}
-/**
- * Lightweight JavaScript client for Zenith CMS, optimized for Edge environments.
- */
-export declare class ZenithClient {
-    private url;
-    private apiKey?;
-    private siteId?;
-    constructor(options: ZenithClientOptions);
-    private buildQueryString;
-    private flattenWhereParams;
-    private fetchAPI;
-    /**
-     * Find multiple documents in a collection.
-     */
-    // eslint-disable-next-line @typescript-eslint/no-explicit-any
-find<T = any>(collection: string, options?: FindOptions): Promise<{ // eslint-disable-line @typescript-eslint/no-explicit-any
-        docs: T[];
-        totalDocs: number;
-        totalPages: number;
-        page: number;
-    }>;
-    /**
-     * Find a single document by its ID.
-     */
-    // eslint-disable-next-line @typescript-eslint/no-explicit-any
-findById<T = any>(collection: string, id: string, options?: FetchOptions): Promise<T>; // eslint-disable-line @typescript-eslint/no-explicit-any
-    /**
-     * Fetch a singleton configuration.
-     */
-    // eslint-disable-next-line @typescript-eslint/no-explicit-any
-findGlobal<T = any>(slug: string, options?: FetchOptions): Promise<T>; // eslint-disable-line @typescript-eslint/no-explicit-any
-    /**
-     * Create a new document in a collection.
-     */
-    // eslint-disable-next-line @typescript-eslint/no-explicit-any
-create<T = any>(collection: string, payload: any, options?: FetchOptions): Promise<T>; // eslint-disable-line @typescript-eslint/no-explicit-any
-    /**
-     * Update an existing document.
-     */
-    // eslint-disable-next-line @typescript-eslint/no-explicit-any
-update<T = any>(collection: string, id: string, payload: any, options?: FetchOptions): Promise<T>; // eslint-disable-line @typescript-eslint/no-explicit-any
-    /**
-     * Delete a document.
-     */
-    // eslint-disable-next-line @typescript-eslint/no-explicit-any
-delete<T = any>(collection: string, id: string, options?: FetchOptions): Promise<T>; // eslint-disable-line @typescript-eslint/no-explicit-any
-}
-export declare function createClient(options: ZenithClientOptions): ZenithClient;

package/dist/client.js

@@ -1,129 +0,0 @@
-/**
- * Lightweight JavaScript client for Zenith CMS, optimized for Edge environments.
- */
-export class ZenithClient {
-    url;
-    apiKey;
-    siteId;
-    constructor(options) {
-        this.url = options.url.replace(/\/$/, '');
-        this.apiKey = options.apiKey;
-        this.siteId = options.siteId;
-    }
-    buildQueryString(options) {
-        const params = new URLSearchParams();
-        if (options.locale)
-            params.append('locale', options.locale);
-        if (options.depth !== undefined)
-            params.append('depth', String(options.depth));
-        if (options.drafts)
-            params.append('drafts', 'true');
-        if (options.sort)
-            params.append('sort', options.sort);
-        if (options.limit !== undefined)
-            params.append('limit', String(options.limit));
-        if (options.page !== undefined)
-            params.append('page', String(options.page));
-        if (options.where) {
-            this.flattenWhereParams(options.where, 'where').forEach((value, key) => {
-                params.append(key, value);
-            });
-        }
-        const str = params.toString();
-        return str ? `?${str}` : '';
-    }
-    flattenWhereParams(obj, prefix) {
-        const map = new Map();
-        for (const [key, value] of Object.entries(obj)) {
-            if (typeof value === 'object' && value !== null && !Array.isArray(value)) {
-                const nested = this.flattenWhereParams(value, `${prefix}[${key}]`);
-                nested.forEach((v, k) => map.set(k, v));
-            }
-            else {
-                map.set(`${prefix}[${key}]`, String(value));
-            }
-        }
-        return map;
-    }
-    async fetchAPI(path, options = {}) {
-        const headers = new Headers(options.headers);
-        headers.set('Content-Type', 'application/json');
-        if (this.apiKey) {
-            headers.set('Authorization', `Bearer ${this.apiKey}`);
-        }
-        if (this.siteId) {
-            headers.set('X-Zenith-Site-Id', this.siteId);
-        }
-        const response = await fetch(`${this.url}${path}`, {
-            ...options,
-            headers,
-        });
-        const data = await response.json().catch(() => null);
-        if (!response.ok) {
-            throw new Error(data?.message || `Zenith API error: ${response.status} ${response.statusText}`);
-        }
-        return data;
-    }
-    /**
-     * Find multiple documents in a collection.
-     */
-    async find(collection, options = {}) {
-        const qs = this.buildQueryString(options);
-        const data = await this.fetchAPI(`/api/v1/${collection}${qs}`, { method: 'GET', ...options });
-        return data.data || data; // Handles different API response envelopes
-    }
-    /**
-     * Find a single document by its ID.
-     */
-    async findById(collection, id, options = {}) {
-        const qs = this.buildQueryString(options);
-        const data = await this.fetchAPI(`/api/v1/${collection}/${id}${qs}`, { method: 'GET', ...options });
-        return data.data?.document || data.data || data;
-    }
-    /**
-     * Fetch a singleton configuration.
-     */
-    async findGlobal(slug, options = {}) {
-        const qs = this.buildQueryString(options);
-        const data = await this.fetchAPI(`/api/v1/globals/${slug}${qs}`, { method: 'GET', ...options });
-        return data.data?.document || data.data || data;
-    }
-    /**
-     * Create a new document in a collection.
-     */
-    async create(collection, payload, options = {}) {
-        const qs = this.buildQueryString(options);
-        const data = await this.fetchAPI(`/api/v1/${collection}${qs}`, {
-            method: 'POST',
-            body: JSON.stringify(payload),
-            ...options,
-        });
-        return data.data || data;
-    }
-    /**
-     * Update an existing document.
-     */
-    async update(collection, id, payload, options = {}) {
-        const qs = this.buildQueryString(options);
-        const data = await this.fetchAPI(`/api/v1/${collection}/${id}${qs}`, {
-            method: 'PATCH',
-            body: JSON.stringify(payload),
-            ...options,
-        });
-        return data.data?.document || data.data || data;
-    }
-    /**
-     * Delete a document.
-     */
-    async delete(collection, id, options = {}) {
-        const qs = this.buildQueryString(options);
-        const data = await this.fetchAPI(`/api/v1/${collection}/${id}${qs}`, {
-            method: 'DELETE',
-            ...options,
-        });
-        return data.data?.document || data.data || data;
-    }
-}
-export function createClient(options) {
-    return new ZenithClient(options);
-}

package/dist/index.test.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/index.test.js

@@ -1,95 +0,0 @@
-import { describe, it, expect, vi, beforeEach } from 'vitest';
-import { ZenithClient } from './index';
-// Minimal fetch mock — intercepts calls and returns JSON
-function makeClient() {
-    return new ZenithClient({ url: 'http://localhost:3000' });
-}
-beforeEach(() => {
-    global.fetch = vi.fn();
-});
-describe('ZenithClient — SWR cache', () => {
-    it('serves stale data immediately and revalidates in background', async () => {
-        const client = makeClient();
-        const mockData = { data: { docs: [{ _id: '1', title: 'Cached Post' }] } };
-        fetch.mockResolvedValueOnce({
-            ok: true,
-            json: () => Promise.resolve(mockData),
-        });
-        const result1 = await client.find('posts', { limit: 5, cacheTtl: 30_000 });
-        expect(result1.docs[0].title).toBe('Cached Post');
-        // Second request should return cached data immediately without waiting
-        const start = Date.now();
-        const result2 = await client.find('posts', { limit: 5 });
-        const elapsed = Date.now() - start;
-        // With cache hit and SWR revalidation, this should be near-instant
-        expect(elapsed).toBeLessThan(50);
-        expect(result2.docs[0].title).toBe('Cached Post');
-    });
-    it('bypasses cache when cacheTtl is 0', async () => {
-        const client = makeClient();
-        fetch.mockResolvedValue({
-            ok: true,
-            json: () => Promise.resolve({ data: { docs: [] } }),
-        });
-        // Should call fetch both times
-        await client.find('posts', { cacheTtl: 0 });
-        await client.find('posts', { cacheTtl: 0 });
-        expect(fetch.mock.calls.length).toBeGreaterThanOrEqual(2);
-    });
-});
-describe('ZenithClient — batch', () => {
-    it('executes multiple requests in parallel', async () => {
-        const client = makeClient();
-        fetch.mockResolvedValue({
-            ok: true,
-            json: () => Promise.resolve({ data: { posts: [] } }),
-        });
-        await client.batch([
-            { method: 'GET', path: '/api/beta/posts' },
-            { method: 'GET', path: '/api/beta/authors' },
-        ]);
-        expect(fetch.mock.calls.length).toBe(2);
-    });
-});
-describe('ZenithClient — upload', () => {
-    it('sends FormData for file uploads and omits Content-Type header', async () => {
-        const client = makeClient();
-        fetch.mockResolvedValue({
-            ok: true,
-            json: () => Promise.resolve({ data: { _id: '123', url: 'http://cdn/img.jpg' } }),
-        });
-        const file = new File(['hello'], 'test.jpg', { type: 'image/jpeg' });
-        await client.upload(file, { alt: 'Test alt', focalPoint: { x: 50, y: 50 } });
-        const [url, options] = fetch.mock.calls[0];
-        expect(url).toContain('/api/beta/upload');
-        expect(options.headers.get('Content-Type')).toBeNull(); // fetch auto-sets multipart
-        expect(options.method).toBe('POST');
-    });
-});
-describe('ZenithClient — site switching', () => {
-    it('updates siteId and flushes cache when setSiteId is called', async () => {
-        const client = makeClient();
-        const mockData1 = { data: { docs: [{ _id: '1', title: 'Post Site A' }] } };
-        const mockData2 = { data: { docs: [{ _id: '2', title: 'Post Site B' }] } };
-        fetch
-            .mockResolvedValueOnce({
-            ok: true,
-            json: () => Promise.resolve(mockData1),
-        })
-            .mockResolvedValueOnce({
-            ok: true,
-            json: () => Promise.resolve(mockData2),
-        });
-        // Fetch on default site ID (empty)
-        const res1 = await client.find('posts', { limit: 5 });
-        expect(res1.docs[0].title).toBe('Post Site A');
-        // Change site ID using setSiteId
-        client.setSiteId('site-b');
-        // Fetch again — cache should be flushed, performing a new fetch with headers
-        const res2 = await client.find('posts', { limit: 5 });
-        expect(res2.docs[0].title).toBe('Post Site B');
-        // Verify correct header was sent in the second request
-        const lastCall = fetch.mock.calls[1];
-        expect(lastCall[1].headers.get('X-Zenith-Site-Id')).toBe('site-b');
-    });
-});

package/dist/src/index.d.ts

@@ -1,43 +0,0 @@
-interface ZenithConfig {
-    baseURL: string;
-    token?: string;
-    cacheTTL?: number;
-}
-/**
- * Zenith SDK — Universal Client
- * ─────────────────────────────
- * A high-performance, type-safe client for consuming Zenith CMS content.
- * Features built-in caching and automated error handling.
- */
-export declare class ZenithClient {
-    private api;
-    private cache;
-    private ttl;
-    constructor(config: ZenithConfig);
-    /**
-     * Fetch a list of entries from a collection
-     */
-    // eslint-disable-next-line @typescript-eslint/no-explicit-any
-find<T = any>(slug: string, params?: Record<string, any>): Promise<{
 // eslint-disable-line @typescript-eslint/no-explicit-any
-        data: T[];
-        meta: any;
 // eslint-disable-line @typescript-eslint/no-explicit-any
-    }>;
-    /**
-     * Fetch a single entry by ID
-     */
-    // eslint-disable-next-line @typescript-eslint/no-explicit-any
-findOne<T = any>(slug: string, id: string): Promise<{
 // eslint-disable-line @typescript-eslint/no-explicit-any
-        data: T;
-    }>;
-    /**
-     * Fetch a singleton collection
-     */
-    // eslint-disable-next-line @typescript-eslint/no-explicit-any
-getSingleton<T = any>(slug: string): Promise<{
 // eslint-disable-line @typescript-eslint/no-explicit-any
-        data: T;
-    }>;
-    private getCache;
-    private setCache;
-    private handleError;
-}
-export {};

package/dist/src/index.js

@@ -1,86 +0,0 @@
-import axios from 'axios';
-/**
- * Zenith SDK — Universal Client
- * ─────────────────────────────
- * A high-performance, type-safe client for consuming Zenith CMS content.
- * Features built-in caching and automated error handling.
- */
-export class ZenithClient {
-    api;
-    cache = new Map();
-    ttl;
-    constructor(config) {
-        this.ttl = config.cacheTTL || 60000; // Default 1 min
-        this.api = axios.create({
-            baseURL: config.baseURL.endsWith('/api/beta') ? config.baseURL : `${config.baseURL}/api/beta`,
-            headers: config.token ? { Authorization: `Bearer ${config.token}` } : {},
-        });
-    }
-    /**
-     * Fetch a list of entries from a collection
-     */
-    async find(slug, params = {}) {
-        const cacheKey = `${slug}:list:${JSON.stringify(params)}`;
-        const cached = this.getCache(cacheKey);
-        if (cached)
-            return cached;
-        try {
-            const res = await this.api.get(`/${slug}`, { params });
-            this.setCache(cacheKey, res.data);
-            return res.data;
-        }
-        catch (err) {
-            this.handleError(err);
-        }
-    }
-    /**
-     * Fetch a single entry by ID
-     */
-    async findOne(slug, id) {
-        const cacheKey = `${slug}:${id}`;
-        const cached = this.getCache(cacheKey);
-        if (cached)
-            return cached;
-        try {
-            const res = await this.api.get(`/${slug}/${id}`);
-            this.setCache(cacheKey, res.data);
-            return res.data;
-        }
-        catch (err) {
-            this.handleError(err);
-        }
-    }
-    /**
-     * Fetch a singleton collection
-     */
-    async getSingleton(slug) {
-        const cacheKey = `singleton:${slug}`;
-        const cached = this.getCache(cacheKey);
-        if (cached)
-            return cached;
-        try {
-            const res = await this.api.get(`/${slug}`);
-            this.setCache(cacheKey, res.data);
-            return res.data;
-        }
-        catch (err) {
-            this.handleError(err);
-        }
-    }
-    // --- Cache Helpers ---
-    getCache(key) {
-        const cached = this.cache.get(key);
-        if (cached && cached.expiry > Date.now())
-            return cached.data;
-        if (cached)
-            this.cache.delete(key);
-        return null;
-    }
-    setCache(key, data) {
-        this.cache.set(key, { data, expiry: Date.now() + this.ttl });
-    }
-    handleError(err) {
-        const message = err.response?.data?.error?.message || err.message || 'Unknown Zenith SDK Error';
-        throw new Error(`[Zenith SDK] ${message}`);
-    }
-}

package/dist/types.d.ts

@@ -1,54 +0,0 @@
-import type { paths } from './schema';
-/**
- * Resolve a collection name string to its document type via OpenAPI schema paths.
- * Falls back to unknown for unknown collections.
- */
-type GetPath<C extends string> = `/${C}`;
-type ExtractArrayItem<T> = T extends (infer U)[] ? U : unknown;
-type OpenAPIResponse<P extends string> = P extends keyof paths ? 'get' extends keyof paths[P] ? 'responses' extends keyof paths[P]['get'] ? 200 extends keyof paths[P]['get']['responses'] ? 'content' extends keyof paths[P]['get']['responses'][200] ? 'application/json' extends keyof paths[P]['get']['responses'][200]['content'] ? 'schema' extends keyof paths[P]['get']['responses'][200]['content']['application/json'] ? paths[P]['get']['responses'][200]['content']['application/json']['schema'] : unknown : unknown : unknown : unknown : unknown : unknown : unknown;
-export type DocType<C extends string> = OpenAPIResponse<GetPath<C>> extends never ? unknown : ExtractArrayItem<OpenAPIResponse<GetPath<C>>>;
-export interface ZenithClientOptions {
-    url: string;
-    apiKey?: string;
-    siteId?: string;
-    /** SWR cache TTL in ms. default 30_000 (30s). set 0 to disable. */
-    cacheTtl?: number;
-}
-export interface FetchOptions extends RequestInit {
-    locale?: string;
-    depth?: number;
-    drafts?: boolean;
-    populate?: string[] | string;
-    select?: string[] | string;
-    /** Override the global cache TTL for this request. 0 = bypass cache. */
-    cacheTtl?: number;
-    /** Tag-based cache invalidation key for this request */
-    cacheTag?: string;
-}
-export interface FindOptions extends FetchOptions {
-    where?: Record<string, unknown>;
-    sort?: string;
-    limit?: number;
-    page?: number;
-}
-export interface BatchRequest {
-    method?: 'GET' | 'POST' | 'PATCH' | 'DELETE';
-    path: string;
-    body?: unknown;
-    headers?: Record<string, string>;
-}
-/** Structured error thrown by all ZenithClient methods. */
-export declare class ZenithAPIError extends Error {
-    readonly status: number;
-    readonly code?: string;
-    readonly isNetworkError: boolean;
-    readonly isParseError: boolean;
-    constructor(opts: {
-        message: string;
-        status: number;
-        code?: string;
-        isNetworkError?: boolean;
-        isParseError?: boolean;
-    });
-}
-export {};

package/dist/types.js

@@ -1,16 +0,0 @@
-// ── Error Handling ────────────────────────────────────────────────────────────
-/** Structured error thrown by all ZenithClient methods. */
-export class ZenithAPIError extends Error {
-    status;
-    code;
-    isNetworkError;
-    isParseError;
-    constructor(opts) {
-        super(opts.message);
-        this.name = 'ZenithAPIError';
-        this.status = opts.status;
-        this.code = opts.code;
-        this.isNetworkError = opts.isNetworkError ?? false;
-        this.isParseError = opts.isParseError ?? false;
-    }
-}