opacacms 0.2.1 → 0.3.1

package/dist/schema/collection.d.ts

@@ -1,79 +1,125 @@
-import type { Collection as BaseCollection, IconName } from "../types";
-import type { AccessRules, InferFields } from "./infer";
-/**
- * The Fluent API Collection Builder.
- */
-export declare class CollectionBuilder<TSlug extends string, TFields extends Record<string, any> = {}> {
-    readonly slug: TSlug;
-    private config;
-    private fieldBuilders;
-    constructor(slug: TSlug);
-    /**
-     * Sets the user-friendly label for the Collection.
-     */
-    label(label: string): this;
-    /**
-     * Sets the Lucide icon for this collection.
-     */
-    icon(iconName: IconName): this;
-    /**
-     * Defines which field should be used as the title in the Admin UI.
-     */
-    useAsTitle(fieldName: keyof TFields | (string & {})): this;
-    /**
-     * Defines the fields for this Collection.
-     * Re-instantiates the builder to capture the strong types of the fields.
-     */
-    fields<T extends readonly any[]>(fields: [...T]): CollectionBuilder<TSlug, InferFields<T>>;
-    /**
-     * Type-safe access control rules.
-     */
-    access(rules: AccessRules<TFields>): this;
-    /**
-     * Defines a virtual/computed field with full type inference of the current collection data.
-     */
-    virtual<TName extends string, TReturn = any>(name: TName, options: {
-        label?: string;
-        resolve: (args: {
-            data: TFields;
-            req: any;
-            user: any;
-            session: any;
-            apiKey?: any;
-        }) => TReturn | Promise<TReturn>;
-        returnType?: "string" | "number" | "boolean" | "json";
-    }): CollectionBuilder<TSlug, TFields & {
-        [K in TName]: TReturn;
-    }>;
-    /**
-     * Advanced Admin UI configuration.
-     */
-    admin(opts: BaseCollection["admin"]): this;
-    /**
-     * Adds automated versioning and drafts.
-     */
-    versions(opts: {
+import type { Faker } from "@faker-js/faker";
+import type { AccessConfig, CollectionHooks, LucideIcons } from "@/types";
+import { type ZodObject, type ZodRawShape, type infer as zInfer } from "./zod";
+export interface CollectionConfig<T = any> {
+    slug: string;
+    label?: string;
+    admin?: {
+        useAsTitle?: string;
+        hidden?: boolean;
+        group?: string;
+        icon?: LucideIcons;
+        defaultColumns?: string[];
+        disableAdmin?: boolean;
+        views?: Array<{
+            name: string;
+            filter: Record<string, any>;
+        }>;
+    };
+    timestamps?: boolean | {
+        createdAt?: string;
+        updatedAt?: string;
+    };
+    access?: AccessConfig;
+    hooks?: CollectionHooks<T>;
+    versions?: {
         drafts?: boolean;
         maxRevisions?: number;
         autosave?: boolean;
-    }): this;
-    /**
-     * Adds webhooks to be triggered on document lifecycle events.
-     */
-    webhooks(webhooks: {
-        events: string[];
+    };
+    webhooks?: Array<{
+        type: "outgoing";
+        events: Array<"after:create" | "after:update" | "after:delete">;
         url: string;
         headers?: Record<string, string>;
-    }[]): this;
+        retries?: number;
+        timeoutMs?: number;
+        transform?: (data: T) => any;
+    } | {
+        type: "incoming";
+        /** The public URL path where OpacaCMS will listen for requests. */
+        path: string;
+        /** Secret or function used to verify the request signature (HMAC-SHA256). */
+        verifySignature?: string | ((req: Request) => boolean | Promise<boolean>);
+        /** The HTTP header that contains the signature (defaults to 'x-opaca-signature'). */
+        signatureHeader?: string;
+        /** Function to map the third-party payload to your CMS collection fields. */
+        mapPayload?: (payload: any) => Partial<T> | Promise<Partial<T>>;
+        onSuccess?: (args: {
+            data: T;
+            payload: any;
+            operation: "create" | "update";
+        }) => void | Promise<void>;
+    }>;
     /**
-     * Spreads configuration from presets (Proposed Feature stub)
+     * Seed function for the collection.
+     * @param faker faker instance
+     * @returns Partial<T> or Promise<Partial<T>>
      */
-    extend(preset: any): this;
-    protected _ensureAdmin(): void;
-    build(): BaseCollection & {
-        slug: TSlug;
-    };
+    seed?: (faker: Faker) => Partial<T> | Promise<Partial<T>>;
 }
-export declare const Collection: {
-    create: <T extends string>(slug: T) => CollectionBuilder<T, {}>;
+export interface DefineCollectionArgs<T extends ZodRawShape> extends CollectionConfig<zInfer<ZodObject<T>>> {
+    schema: ZodObject<T>;
+}
+/**
+ * Replaces the legacy Collection.create() Builder API.
+ * Wraps a Zod Schema and attaches collection-level metadata to it.
+ */
+export declare function defineCollection<T extends ZodRawShape>(config: DefineCollectionArgs<T>): {
+    schema: ZodObject<T, import("better-auth").$strip>;
+    fields: any[];
+    seed: ((faker: Faker) => Partial<import("better-auth").$InferObjectOutput<T, {}>> | Promise<Partial<import("better-auth").$InferObjectOutput<T, {}>>>) | undefined;
+    __type: zInfer<ZodObject<T, import("better-auth").$strip>>;
+    slug: string;
+    label?: string;
+    admin?: {
+        useAsTitle?: string;
+        hidden?: boolean;
+        group?: string;
+        icon?: LucideIcons;
+        defaultColumns?: string[];
+        disableAdmin?: boolean;
+        views?: Array<{
+            name: string;
+            filter: Record<string, any>;
+        }>;
+    };
+    timestamps?: boolean | {
+        createdAt?: string;
+        updatedAt?: string;
+    };
+    access?: AccessConfig;
+    hooks?: CollectionHooks<import("better-auth").$InferObjectOutput<T, {}>> | undefined;
+    versions?: {
+        drafts?: boolean;
+        maxRevisions?: number;
+        autosave?: boolean;
+    };
+    webhooks?: ({
+        type: "outgoing";
+        events: Array<"after:create" | "after:update" | "after:delete">;
+        url: string;
+        headers?: Record<string, string>;
+        retries?: number;
+        timeoutMs?: number;
+        transform?: ((data: import("better-auth").$InferObjectOutput<T, {}>) => any) | undefined;
+    } | {
+        type: "incoming";
+        /** The public URL path where OpacaCMS will listen for requests. */
+        path: string;
+        /** Secret or function used to verify the request signature (HMAC-SHA256). */
+        verifySignature?: string | ((req: Request) => boolean | Promise<boolean>);
+        /** The HTTP header that contains the signature (defaults to 'x-opaca-signature'). */
+        signatureHeader?: string;
+        /** Function to map the third-party payload to your CMS collection fields. */
+        mapPayload?: ((payload: any) => Partial<import("better-auth").$InferObjectOutput<T, {}>> | Promise<Partial<import("better-auth").$InferObjectOutput<T, {}>>>) | undefined;
+        onSuccess?: ((args: {
+            data: import("better-auth").$InferObjectOutput<T, {}>;
+            payload: any;
+            operation: "create" | "update";
+        }) => void | Promise<void>) | undefined;
+    })[] | undefined;
 };
+export type InferCollection<T extends {
+    __type: any;
+}> = T["__type"];

package/dist/schema/compiler.d.ts

@@ -0,0 +1,6 @@
+import { type ZodTypeAny } from "./zod";
+/**
+ * Translates a Zod schema tree into OpacaCMS legacy JSON field configuration.
+ * This is used to bridge the new Zod-based definitions with the Admin UI and legacy core.
+ */
+export declare function zodToOpacaFields(schema: ZodTypeAny, currentPath?: string): any[];

package/dist/schema/global.d.ts

@@ -1,77 +1,44 @@
-import type { AccessConfig, Global as GlobalType, IconName } from "../types";
-import { type FieldBuilder } from "./fields";
-import type { InferFields } from "./infer";
-export type Global = GlobalType;
-/**
- * A Fluent API Builder for defining OpacaCMS Globals.
- */
-export declare class GlobalBuilder<TSlug extends string, TFields extends Record<string, any> = {}> {
-    readonly slug: TSlug;
-    protected config: Partial<Global>;
-    protected _fields: FieldBuilder<any, any>[];
-    constructor(slug: TSlug);
-    /**
-     * Sets the label for this global in the Admin UI.
-     */
-    label(label: string): this;
-    /**
-     * Sets the Lucide icon for this global.
-     */
-    icon(iconName: IconName): this;
-    /**
-     * Defines the fields for this global schema.
-     */
-    fields<T extends readonly any[]>(fields: [...T]): GlobalBuilder<TSlug, InferFields<T>>;
-    /**
-     * Configuration for who can read and update this global.
-     */
-    access(rules: AccessConfig): this;
-    /**
-     * Defines a virtual/computed field with full type inference of the current global data.
-     */
-    virtual<TName extends string, TReturn = any>(name: TName, options: {
-        label?: string;
-        resolve: (args: {
-            data: TFields;
-            req: any;
-            user: any;
-            session: any;
-            apiKey?: any;
-        }) => TReturn | Promise<TReturn>;
-        returnType?: "string" | "number" | "boolean" | "json";
-    }): GlobalBuilder<TSlug, TFields & {
-        [K in TName]: TReturn;
-    }>;
-    /**
-     * Alias for .virtual()
-     */
-    computed<TName extends string, TReturn = any>(name: TName, options: {
-        label?: string;
-        resolve: (args: {
-            data: TFields;
-            req: any;
-            user: any;
-            session: any;
-            apiKey?: any;
-        }) => TReturn | Promise<TReturn>;
-        returnType?: "string" | "number" | "boolean" | "json";
-    }): GlobalBuilder<TSlug, TFields & {
-        [K in TName]: TReturn;
-    }>;
-    /**
-     * Extends the global with arbitrary configuration.
-     */
-    extend(opts: Record<string, any>): this;
+import type { Faker } from "@faker-js/faker";
+import { type ZodObject, type ZodRawShape, type infer as zInfer } from "./zod";
+export interface GlobalConfig {
+    slug: string;
+    label?: string;
+    admin?: {
+        hidden?: boolean;
+        group?: string;
+        icon?: string;
+    };
+    access?: {
+        read?: (context: any) => boolean | Promise<boolean>;
+        update?: (context: any) => boolean | Promise<boolean>;
+    };
     /**
-     * Compiles the builder down into the raw Global object expected by OpacaCMS.
+     * Seed function for the global.
+     * @param faker faker instance
+     * @returns Partial<T> or Promise<Partial<T>>
      */
-    build(): Global & {
-        slug: TSlug;
-    };
+    seed?: (faker: Faker) => any | Promise<any>;
+}
+export interface DefineGlobalArgs<T extends ZodRawShape> extends GlobalConfig {
+    schema: ZodObject<T>;
 }
 /**
- * Singleton factory for creating Globals.
+ * Zod-based replacement for the legacy GlobalBuilder.
  */
-export declare const Global: {
-    create: <T extends string>(slug: T) => GlobalBuilder<T, {}>;
+export declare function defineGlobal<T extends ZodRawShape>(config: DefineGlobalArgs<T>): {
+    schema: ZodObject<T, import("better-auth").$strip>;
+    fields: any[];
+    seed: ((faker: Faker) => any | Promise<any>) | undefined;
+    __type: zInfer<ZodObject<T, import("better-auth").$strip>>;
+    slug: string;
+    label?: string;
+    admin?: {
+        hidden?: boolean;
+        group?: string;
+        icon?: string;
+    };
+    access?: {
+        read?: (context: any) => boolean | Promise<boolean>;
+        update?: (context: any) => boolean | Promise<boolean>;
+    };
 };

package/dist/schema/index.d.ts

@@ -1,4 +1,5 @@
-export { Collection, CollectionBuilder } from "./collection";
-export { Field, FieldBuilder } from "./fields/index";
-export { Global, GlobalBuilder } from "./global";
-export type { AccessRules, InferFields } from "./infer";
+export type { Collection, Field } from "../types";
+export * from "./collection";
+export * from "./compiler";
+export * from "./global";
+export * from "./zod";