@zenith-open/zenithcms-types 0.1.0

package/src/database.d.ts

@@ -0,0 +1,84 @@
+import { CollectionConfig } from './index';
+/**
+ * Zenith Database Adapter Contract
+ * ────────────────────────────────
+ * Hardened interface for database agnostic operations.
+ * Use generics <T> to ensure type safety in higher level services.
+ */
+export interface DatabaseAdapter {
+    name: string;
+    connect(): Promise<void>;
+    disconnect(): Promise<void>;
+    getHealth(): 'ok' | 'connecting' | 'disconnected' | 'error';
+    /** Syncs the provided collection config with the physical DB schema */
+    registerCollection(config: CollectionConfig): Promise<void>;
+    /** Lists all existing collections/tables in the database */
+    getExistingCollections(): Promise<string[]>;
+    find<T = unknown>(collection: string, query: Record<string, unknown>, options?: FindOptions): Promise<T[]>;
+    findOne<T = unknown>(collection: string, query: Record<string, unknown>, options?: BaseOptions): Promise<T | null>;
+    create<T = unknown>(collection: string, data: Partial<T>, options?: BaseOptions): Promise<T>;
+    update<T = unknown>(collection: string, id: string, data: Partial<T>, options?: BaseOptions): Promise<T | null>;
+    updateMany(collection: string, query: Record<string, unknown>, data: unknown, options?: BaseOptions): Promise<number>;
+    delete(collection: string, id: string, options?: BaseOptions): Promise<boolean>;
+    deleteMany(collection: string, query: Record<string, unknown>, options?: BaseOptions): Promise<number>;
+    count(collection: string, query: Record<string, unknown>): Promise<number>;
+    aggregate<T = unknown>(collection: string, pipeline: unknown[]): Promise<T[]>;
+    /**
+     * Executes multiple operations in a transaction.
+     * If the adapter does not support transactions (e.g. standalone Mongo),
+     * this will execute the function without a transaction context.
+     */
+    transaction<T>(fn: (session: unknown) => Promise<T>): Promise<T>;
+    createAuditLog(data: AuditLogData): Promise<void>;
+    createVersion(data: VersionData): Promise<void>;
+    getVersions(collection: string, documentId: string): Promise<VersionData[]>;
+    createWebhookDelivery(data: WebhookDeliveryData): Promise<void>;
+    /**
+     * Full-text / pattern search across specified fields in a collection.
+     * Each adapter translates this into its native search primitive
+     * (MongoDB $regex/$text, Postgres ILIKE/pg_trgm).
+     */
+    search<T = unknown>(collection: string, query: string, fields: string[], limit?: number, options?: BaseOptions): Promise<T[]>;
+}
+export interface BaseOptions {
+    session?: unknown;
+    tenantId?: string;
+    siteId?: string;
+}
+export interface FindOptions extends BaseOptions {
+    sort?: string | Record<string, unknown>;
+    skip?: number;
+    limit?: number;
+    select?: string | string[];
+    populate?: string | string[];
+}
+export interface AuditLogData {
+    userId: string;
+    userEmail: string;
+    action: string;
+    collectionName: string;
+    documentId?: string;
+    changes?: unknown;
+    ip?: string;
+    userAgent?: string;
+    timestamp?: Date;
+}
+export interface VersionData {
+    collectionName: string;
+    collectionSlug: string;
+    documentId: string;
+    snapshot: unknown;
+    delta?: unknown;
+    createdBy: string;
+    timestamp: Date;
+}
+export interface WebhookDeliveryData {
+    collectionSlug?: string;
+    event: string;
+    url: string;
+    payload?: unknown;
+    success: boolean;
+    responseStatus?: number;
+    timestamp?: Date;
+}
+

package/src/database.js

@@ -0,0 +1 @@
+// Database types module (interfaces only)

package/src/database.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"database.js","sourceRoot":"","sources":["database.ts"],"names":[],"mappings":"AACA,OAAO,IAAI,MAAM,MAAM,CAAA;AAgIvB,MAAM,OAAO,mBAAmB;IAGV;IAFZ,YAAY,CAAS;IAE7B,YAAoB,cAA+B;QAA/B,mBAAc,GAAd,cAAc,CAAiB;QACjD,IAAI,CAAC,YAAY,GAAG,OAAO,CAAC,GAAG,CAAC,QAAQ,KAAK,YAAY,CAAA;IAC3D,CAAC;IAEM,KAAK,CAAC,IAAI,CACf,UAAkB,EAClB,KAA8B,EAC9B,OAAqB;QAErB,IAAI,IAAI,CAAC,YAAY,EAAE,CAAC;YACtB,IAAI,CAAC;gBACH,MAAM,WAAW,GAAG,UAAU,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,GAAG,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC,CAAA;gBAC5E,oEAAoE;gBACpE,MAAM,eAAe,GAAG,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,iBAAiB,CAAC,CAAC,CAAA;gBAC/E,MAAM,MAAM,GAAG,eAAe,CAAC,OAAO,WAAW,UAAU,CAAC,CAAA;gBAC5D,IAAI,MAAM,EAAE,CAAC;oBACX,MAAM,cAAc,GAAG,IAAI,CAAC,cAAqB,CAAA;oBACjD,MAAM,QAAQ,GAAG,CAAC,OAAO,cAAc,CAAC,WAAW,KAAK,UAAU,CAAC;wBACjE,CAAC,CAAC,cAAc,CAAC,WAAW,CAAC,OAAO,CAAC;wBACrC,CAAC,CAAC,cAAc,CAAC,EAAE,CAAA;oBACrB,MAAM,WAAW,GAAG,cAAc,CAAC,MAAM,EAAE,CAAC,UAAU,CAAC,CAAA;oBACvD,OAAO,MAAM,MAAM,CAAC,QAAQ,EAAE,WAAW,EAAE,KAAK,EAAE,OAAO,CAAC,CAAA;gBAC5D,CAAC;YACH,CAAC;YAAC,MAAM,CAAC;gBACP,2CAA2C;YAC7C,CAAC;QACH,CAAC;QACD,OAAO,MAAM,IAAI,CAAC,cAAc,CAAC,IAAI,CAAI,UAAU,EAAE,KAAK,EAAE,OAAO,CAAC,CAAA;IACtE,CAAC;IAEM,KAAK,CAAC,MAAM,CAAc,UAAkB,EAAE,IAAgB,EAAE,OAAqB;QAC1F,IAAI,IAAI,CAAC,YAAY,EAAE,CAAC;YACtB,IAAI,CAAC;gBACH,MAAM,WAAW,GAAG,UAAU,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,GAAG,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC,CAAA;gBAC5E,oEAAoE;gBACpE,MAAM,eAAe,GAAG,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,iBAAiB,CAAC,CAAC,CAAA;gBAC/E,MAAM,OAAO,GAAG,eAAe,CAAC,SAAS,WAAW,UAAU,CAAC,CAAA;gBAC/D,IAAI,OAAO,EAAE,CAAC;oBACZ,MAAM,cAAc,GAAG,IAAI,CAAC,cAAqB,CAAA;oBACjD,MAAM,QAAQ,GAAG,CAAC,OAAO,cAAc,CAAC,WAAW,KAAK,UAAU,CAAC;wBACjE,CAAC,CAAC,cAAc,CAAC,WAAW,CAAC,OAAO,CAAC;wBACrC,CAAC,CAAC,cAAc,CAAC,EAAE,CAAA;oBACrB,MAAM,WAAW,GAAG,cAAc,CAAC,MAAM,EAAE,CAAC,UAAU,CAAC,CAAA;oBACvD,OAAO,MAAM,OAAO,CAAC,QAAQ,EAAE,WAAW,EAAE,IAAI,EAAE,OAAO,CAAC,CAAA;gBAC5D,CAAC;YACH,CAAC;YAAC,MAAM,CAAC;gBACP,2CAA2C;YAC7C,CAAC;QACH,CAAC;QACD,OAAO,MAAM,IAAI,CAAC,cAAc,CAAC,MAAM,CAAI,UAAU,EAAE,IAAI,EAAE,OAAO,CAAC,CAAA;IACvE,CAAC;CACF"}

package/src/database.ts

@@ -0,0 +1,164 @@
+import { CollectionConfig } from './index'
+
+/**
+ * Zenith Database Adapter Contract
+ * ────────────────────────────────
+ * Hardened interface for database agnostic operations.
+ * Use generics <T> to ensure type safety in higher level services.
+ */
+export interface DatabaseAdapter {
+  name: string
+
+  // ── Initialization ────────────────────────────────────────────────────────
+  connect(): Promise<void>
+  disconnect(): Promise<void>
+  getHealth(): 'ok' | 'connecting' | 'disconnected' | 'error'
+
+  // ── Schema Management ─────────────────────────────────────────────────────
+  /** Syncs the provided collection config with the physical DB schema */
+  registerCollection(config: CollectionConfig): Promise<void>
+  
+  /** Lists all existing collections/tables in the database */
+  getExistingCollections(): Promise<string[]>
+
+  // ── CRUD Operations ───────────────────────────────────────────────────────
+  find<T = unknown>(
+    collection: string,
+    query: Record<string, unknown>,
+    options?: FindOptions
+  ): Promise<T[]>
+  findOne<T = unknown>(
+    collection: string,
+    query: Record<string, unknown>,
+    options?: BaseOptions
+  ): Promise<T | null>
+  create<T = unknown>(collection: string, data: Partial<T>, options?: BaseOptions): Promise<T>
+  update<T = unknown>(
+    collection: string,
+    id: string,
+    data: Partial<T>,
+    options?: BaseOptions
+  ): Promise<T | null>
+  updateMany(
+    collection: string,
+    query: Record<string, unknown>,
+    data: unknown,
+    options?: BaseOptions
+  ): Promise<number>
+  delete(collection: string, id: string, options?: BaseOptions): Promise<boolean>
+  deleteMany(
+    collection: string,
+    query: Record<string, unknown>,
+    options?: BaseOptions
+  ): Promise<number>
+
+  // ── Advanced Operations ───────────────────────────────────────────────────
+  count(collection: string, query: Record<string, unknown>): Promise<number>
+  aggregate<T = unknown>(collection: string, pipeline: unknown[], options?: BaseOptions): Promise<T[]>
+
+  /**
+   * Atomically finds a single document and updates it, returning either
+   * the original (returnDocument: 'before') or updated (returnDocument: 'after') document.
+   * Returns null if no document matches the query.
+   */
+  findOneAndUpdate<T = unknown>(
+    collection: string,
+    query: Record<string, unknown>,
+    update: Record<string, unknown>,
+    options?: BaseOptions & { returnDocument?: 'before' | 'after' }
+  ): Promise<T | null>
+
+  /**
+   * Executes multiple operations in a transaction.
+   * If the adapter does not support transactions (e.g. standalone Mongo),
+   * this will execute the function without a transaction context.
+   */
+  transaction<T>(fn: (session: unknown) => Promise<T>): Promise<T>
+
+  // ── Zenith Engine Features ────────────────────────────────────────────────
+  createAuditLog(data: AuditLogData, options?: BaseOptions): Promise<void>
+  createVersion(data: VersionData, options?: BaseOptions): Promise<void>
+  getVersions(collection: string, documentId: string): Promise<VersionData[]>
+  createWebhookDelivery(data: WebhookDeliveryData): Promise<void>
+  getWebhookDeliveries(webhookId: string, limit?: number): Promise<WebhookDeliveryRecord[]>
+
+  /**
+   * Full-text / pattern search across specified fields in a collection.
+   * Each adapter translates this into its native search primitive
+   * (MongoDB $regex/$text, Postgres ILIKE/pg_trgm).
+   */
+  search<T = unknown>(
+    collection: string,
+    query: string,
+    fields: string[],
+    limit?: number,
+    options?: BaseOptions
+  ): Promise<T[]>
+}
+
+export interface BaseOptions {
+  session?: unknown
+  tenantId?: string
+  siteId?: string
+  expectedVersion?: number
+}
+
+export interface FindOptions extends BaseOptions {
+  sort?: string | Record<string, unknown>
+  skip?: number
+  limit?: number
+  select?: string | string[]
+  populate?: string | string[]
+}
+
+export interface AuditLogData {
+  userId: string
+  userEmail: string
+  userName?: string
+  action: string
+  collectionName: string
+  documentId?: string
+  changes?: unknown
+  ip?: string
+  userAgent?: string
+  timestamp?: Date
+  status?: 'success' | 'failed'
+  resource?: string
+  siteId?: string
+  hash?: string
+  previousHash?: string
+}
+
+export interface VersionData {
+  collectionName: string
+  collectionSlug: string
+  documentId: string
+  snapshot: unknown
+  delta?: unknown
+  createdBy: string
+  timestamp: Date
+}
+
+export interface WebhookDeliveryData {
+  webhookId?: string
+  collectionSlug?: string
+  event: string
+  url: string
+  payload?: unknown
+  success: boolean
+  responseStatus?: number
+  timestamp?: Date
+}
+
+export interface WebhookDeliveryRecord {
+  id: string
+  webhookId?: string
+  collectionSlug?: string
+  event: string
+  url: string
+  payload?: unknown
+  success: boolean
+  responseStatus?: number
+  timestamp: Date | string
+}
+

package/src/generated.d.ts

@@ -0,0 +1,274 @@
+/**
+ * Zenith Auto-Generated TypeScript Definitions
+ * This file is automatically re-compiled on database register & boot.
+ * DO NOT MODIFY MANUALLY.
+ */
+export interface ZenithDocument {
+    _id: string;
+    createdAt: string;
+    updatedAt: string;
+    status?: 'draft' | 'published';
+}
+export interface Posts extends ZenithDocument {
+    title: string;
+    slug: string;
+    content?: any;
+    coverImage?: any;
+    tags?: any;
+    publishedAt?: string | Date;
+    sections?: ({
+        blockType: 'hero';
+        headline?: string;
+        subheadline?: string;
+        callToAction?: string;
+        backgroundImage?: any;
+    } | {
+        blockType: 'features';
+        heading?: string;
+        featureList?: {
+            title?: string;
+            description?: string;
+            icon?: any;
+        }[];
+    } | {
+        blockType: 'testimonials';
+        heading?: string;
+        items?: {
+            quote?: string;
+            author?: string;
+            role?: string;
+            avatar?: any;
+        }[];
+    } | {
+        blockType: 'pricing';
+        heading?: string;
+        plans?: {
+            name?: string;
+            price?: string;
+            features?: string;
+            buttonText?: string;
+            isPopular?: boolean;
+        }[];
+    } | {
+        blockType: 'faq';
+        heading?: string;
+        questions?: {
+            question?: string;
+            answer?: string;
+        }[];
+    } | {
+        blockType: 'cta';
+        title?: string;
+        description?: string;
+        buttonText?: string;
+        link?: string;
+    } | {
+        blockType: 'stats';
+        items?: {
+            value?: string;
+            label?: string;
+        }[];
+    } | {
+        blockType: 'richTextSection';
+        content?: any;
+    })[];
+    seoTitle?: string;
+    seoDescription?: string;
+    ogImage?: any;
+}
+export interface Authors extends ZenithDocument {
+    name: string;
+    email: string;
+    bio?: string;
+    avatar?: any;
+}
+export interface Products extends ZenithDocument {
+    title: string;
+    price: number;
+    description?: any;
+    gallery?: any;
+    inStock?: boolean;
+    specs?: {
+        weight?: number;
+        color?: string;
+        sku?: string;
+    };
+    category: any;
+    layout?: ({
+        blockType: 'hero';
+        headline?: string;
+    } | {
+        blockType: 'features';
+        items?: {
+            title?: string;
+        }[];
+    } | {
+        blockType: 'stats';
+        items?: {
+            value?: string;
+        }[];
+    })[];
+    slug?: string;
+}
+export interface Pages extends ZenithDocument {
+    meta?: any;
+    title: string;
+    slug: string;
+    sections?: ({
+        blockType: 'hero';
+        headline?: string;
+        subheadline?: string;
+        callToAction?: string;
+        backgroundImage?: any;
+    } | {
+        blockType: 'features';
+        heading?: string;
+        featureList?: {
+            title?: string;
+            description?: string;
+            icon?: any;
+        }[];
+    } | {
+        blockType: 'testimonials';
+        heading?: string;
+        items?: {
+            quote?: string;
+            author?: string;
+            role?: string;
+            avatar?: any;
+        }[];
+    } | {
+        blockType: 'pricing';
+        heading?: string;
+        plans?: {
+            name?: string;
+            price?: string;
+            features?: string;
+            buttonText?: string;
+            isPopular?: boolean;
+        }[];
+    } | {
+        blockType: 'faq';
+        heading?: string;
+        questions?: {
+            question?: string;
+            answer?: string;
+        }[];
+    } | {
+        blockType: 'cta';
+        title?: string;
+        description?: string;
+        buttonText?: string;
+        link?: string;
+    } | {
+        blockType: 'stats';
+        items?: {
+            value?: string;
+            label?: string;
+        }[];
+    } | {
+        blockType: 'richTextSection';
+        content?: any;
+    })[];
+    seoTitle?: string;
+    seoDescription?: string;
+    ogImage?: any;
+}
+export interface Members extends ZenithDocument {
+    email: string;
+    name?: string;
+    subscriptionStatus?: any;
+    isSubscribed?: boolean;
+    activity?: any;
+    avatar?: any;
+    bio?: string;
+}
+export interface Media extends ZenithDocument {
+    name?: string;
+    url?: string;
+    alt?: string;
+    folder?: string;
+    mimetype?: string;
+    size?: number;
+}
+export interface LandingPage extends ZenithDocument {
+    title: string;
+    heroDescription?: any;
+    sections?: ({
+        blockType: 'hero';
+        headline?: string;
+        subheadline?: string;
+        callToAction?: string;
+        backgroundImage?: any;
+    } | {
+        blockType: 'features';
+        heading?: string;
+        featureList?: {
+            title?: string;
+            description?: string;
+            icon?: any;
+        }[];
+    } | {
+        blockType: 'testimonials';
+        heading?: string;
+        items?: {
+            quote?: string;
+            author?: string;
+            role?: string;
+            avatar?: any;
+        }[];
+    } | {
+        blockType: 'pricing';
+        heading?: string;
+        plans?: {
+            name?: string;
+            price?: string;
+            features?: string;
+            buttonText?: string;
+            isPopular?: boolean;
+        }[];
+    } | {
+        blockType: 'faq';
+        heading?: string;
+        questions?: {
+            question?: string;
+            answer?: string;
+        }[];
+    } | {
+        blockType: 'cta';
+        title?: string;
+        description?: string;
+        buttonText?: string;
+        link?: string;
+    } | {
+        blockType: 'stats';
+        items?: {
+            value?: string;
+            label?: string;
+        }[];
+    } | {
+        blockType: 'richTextSection';
+        content?: any;
+    })[];
+}
+export interface ZenithCollections {
+    posts: Posts;
+    authors: Authors;
+    products: Products;
+    pages: Pages;
+    members: Members;
+    media: Media;
+    'landing-page': LandingPage;
+}
+/**
+ * Fully Typed React SDK Data Hook Mappings
+ */
+export type ZenithQuery<T> = {
+    where?: Record<string, any>;
+    sort?: string | Record<string, any>;
+    limit?: number;
+    skip?: number;
+    select?: string[];
+    populate?: string[];
+    locale?: string;
+};

package/src/generated.js

@@ -0,0 +1,7 @@
+/**
+ * Zenith Auto-Generated TypeScript Definitions
+ * This file is automatically re-compiled on database register & boot.
+ * DO NOT MODIFY MANUALLY.
+ */
+export {};
+//# sourceMappingURL=generated.js.map

package/src/generated.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"generated.js","sourceRoot":"","sources":["generated.ts"],"names":[],"mappings":"AAAA;;;;GAIG"}

package/src/generated.ts

@@ -0,0 +1,143 @@
+/**
+ * Zenith Auto-Generated TypeScript Definitions
+ * This file is automatically re-compiled on database register & boot.
+ * DO NOT MODIFY MANUALLY.
+ */
+
+export interface ZenithDocument {
+  _id: string;
+  createdAt: string;
+  updatedAt: string;
+  status?: 'draft' | 'published' | 'archived' | string;
+}
+
+export interface Authors extends ZenithDocument {
+  name: string;
+  avatar?: { url: string; alt?: string };
+  bio?: string;
+}
+
+export interface Posts extends ZenithDocument {
+  title: string;
+  coverImage?: { url: string; alt?: string };
+  content?: string;
+  publishedAt?: string | Date;
+  author?: Record<string, unknown>;
+}
+
+export interface Categories extends ZenithDocument {
+  title: string;
+  slug: string;
+}
+
+export interface Products extends ZenithDocument {
+  name: string;
+  slug: string;
+  price: number;
+  description?: string;
+  gallery?: {
+    image?: { url: string; alt?: string };
+  }[];
+  inStock?: boolean;
+}
+
+export interface Pages extends ZenithDocument {
+  title: string;
+  slug: string;
+  layout?: ({
+    blockType: 'undefined';
+
+  } | {
+    blockType: 'undefined';
+
+  } | {
+    blockType: 'undefined';
+
+  } | {
+    blockType: 'undefined';
+
+  } | {
+    blockType: 'undefined';
+
+  } | {
+    blockType: 'undefined';
+
+  } | {
+    blockType: 'undefined';
+
+  } | {
+    blockType: 'undefined';
+
+  } | {
+    blockType: 'undefined';
+
+  } | {
+    blockType: 'undefined';
+
+  } | {
+    blockType: 'undefined';
+
+  })[];
+}
+
+export interface AuditTarget1781217670604 extends ZenithDocument {
+  title: string;
+}
+
+export interface Media extends ZenithDocument {
+  name?: string;
+  url?: string;
+  alt?: string;
+  folder?: string;
+  mimetype?: string;
+  size?: number;
+}
+
+export interface SiteSettings extends ZenithDocument {
+  siteName: string;
+  supportEmail?: string;
+  logo?: { url: string; alt?: string };
+  favicon?: { url: string; alt?: string };
+  primaryColor?: string;
+  metaTitle?: string;
+  metaDescription?: string;
+  ogImage?: { url: string; alt?: string };
+  socialLinks?: {
+    platform?: ('Twitter' | 'Instagram' | 'Facebook' | 'LinkedIn' | 'GitHub' | 'YouTube');
+    url?: string;
+  }[];
+  copyrightText?: string;
+  headerLinks?: {
+    label: string;
+    url: string;
+  }[];
+  footerLinks?: {
+    label: string;
+    url: string;
+  }[];
+}
+
+export interface ZenithCollections {
+  'authors': Authors;
+  'posts': Posts;
+  'categories': Categories;
+  'products': Products;
+  'pages': Pages;
+  'audit-target-1781217670604': AuditTarget1781217670604;
+  'media': Media;
+  'site-settings': SiteSettings;
+}
+
+/**
+ * Fully Typed React SDK Data Hook Mappings
+ */
+export type ZenithQuery<T> = {
+  where?: Record<string, any>;
+  sort?: string | Record<string, any>;
+  limit?: number;
+  skip?: number;
+  select?: string[];
+  populate?: string[];
+  locale?: string;
+};
+