opacacms 0.1.21 → 0.2.0

package/dist/schema/collection.d.ts

@@ -3,11 +3,11 @@ import type { AccessRules, InferFields } from "./infer";
 /**
  * The Fluent API Collection Builder.
  */
-export declare class CollectionBuilder<TFields extends Record<string, any> = {}> {
-    readonly slug: string;
+export declare class CollectionBuilder<TSlug extends string, TFields extends Record<string, any> = {}> {
+    readonly slug: TSlug;
     private config;
     private fieldBuilders;
-    constructor(slug: string);
+    constructor(slug: TSlug);
     /**
      * Sets the user-friendly label for the Collection.
      */
@@ -24,7 +24,7 @@ export declare class CollectionBuilder<TFields extends Record<string, any> = {}>
      * 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<InferFields<T>>;
+    fields<T extends readonly any[]>(fields: [...T]): CollectionBuilder<TSlug, InferFields<T>>;
     /**
      * Type-safe access control rules.
      */
@@ -42,23 +42,7 @@ export declare class CollectionBuilder<TFields extends Record<string, any> = {}>
             apiKey?: any;
         }) => TReturn | Promise<TReturn>;
         returnType?: "string" | "number" | "boolean" | "json";
-    }): CollectionBuilder<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";
-    }): CollectionBuilder<TFields & {
+    }): CollectionBuilder<TSlug, TFields & {
         [K in TName]: TReturn;
     }>;
     /**
@@ -86,11 +70,10 @@ export declare class CollectionBuilder<TFields extends Record<string, any> = {}>
      */
     extend(preset: any): this;
     protected _ensureAdmin(): void;
-    /**
-     * Compiles the collection builder down into the raw Object structure expected by OpacaCMS.
-     */
-    build(): BaseCollection;
+    build(): BaseCollection & {
+        slug: TSlug;
+    };
 }
 export declare const Collection: {
-    create: (slug: string) => CollectionBuilder<{}>;
+    create: <T extends string>(slug: T) => CollectionBuilder<T, {}>;
 };

package/dist/schema/fields/base.d.ts

@@ -1,3 +1,4 @@
+import type { z } from "zod";
 import type { BaseField, FieldAccessConfig } from "../../types";
 /**
  * The base class for all Fluent API Field Builders.
@@ -41,9 +42,9 @@ export declare abstract class FieldBuilder<TType extends string, TName extends s
      */
     defaultValue(val: TValue): this;
     /**
-     * A custom validation callback function.
+     * A custom validation callback function or a Zod schema.
      */
-    validate(fn: (value: unknown) => boolean | string): this;
+    validate(val: ((value: unknown) => boolean | string) | z.ZodTypeAny): this;
     /**
      * Configure granular access control for this specific field.
      */

package/dist/schema/fields/index.d.ts

@@ -23,6 +23,9 @@ export declare class RichTextFieldBuilder<TName extends string> extends FieldBui
     constructor(name: TName);
     mode(mode: "simple" | "notion"): this;
 }
+export declare class UIFieldBuilder<TName extends string> extends FieldBuilder<"ui", TName, any> {
+    constructor(name: TName);
+}
 export declare class RelationshipFieldBuilder<TName extends string> extends FieldBuilder<"relationship", TName, string | string[]> {
     constructor(name: TName);
     to(collection: string | {
@@ -38,6 +41,9 @@ export declare class FileFieldBuilder<TName extends string> extends FieldBuilder
     allowedmime_types(types: string[]): this;
     maxSize(bytes: number): this;
 }
+export declare class JSONFieldBuilder<TName extends string> extends FieldBuilder<"json", TName, any> {
+    constructor(name: TName);
+}
 export declare class DateFieldBuilder<TName extends string> extends FieldBuilder<"date", TName, string | Date> {
     constructor(name: TName);
 }
@@ -131,5 +137,11 @@ export declare const Field: {
     row: <S extends readonly FieldBuilder<any, any, any, any>[]>(fields?: S) => RowFieldBuilder<S>;
     blocks: <N extends string, TSub extends readonly BlockBuilder<any, any, any>[]>(name: N, ...blocks: TSub) => BlocksFieldBuilder<N, TSub>;
     block: <N extends string>(slug: N) => BlockBuilder<N, string, any[]>;
+    /**
+     * Inject a pure Custom UI Element (Web Component) directly into the Admin Form.
+     * This field is ignored by the database schema generator and backend validation.
+     */
+    ui: <N extends string>(name: N) => UIFieldBuilder<N>;
+    json: <N extends string>(name: N) => JSONFieldBuilder<N>;
 };
 export * from "./base";

package/dist/schema/fields/validation.test.d.ts

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

package/dist/schema/global.d.ts

@@ -5,10 +5,11 @@ export type Global = GlobalType;
 /**
  * A Fluent API Builder for defining OpacaCMS Globals.
  */
-export declare class GlobalBuilder<TFields extends Record<string, any> = {}> {
+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: string);
+    constructor(slug: TSlug);
     /**
      * Sets the label for this global in the Admin UI.
      */
@@ -20,7 +21,7 @@ export declare class GlobalBuilder<TFields extends Record<string, any> = {}> {
     /**
      * Defines the fields for this global schema.
      */
-    fields<T extends readonly any[]>(fields: [...T]): GlobalBuilder<InferFields<T>>;
+    fields<T extends readonly any[]>(fields: [...T]): GlobalBuilder<TSlug, InferFields<T>>;
     /**
      * Configuration for who can read and update this global.
      */
@@ -38,7 +39,7 @@ export declare class GlobalBuilder<TFields extends Record<string, any> = {}> {
             apiKey?: any;
         }) => TReturn | Promise<TReturn>;
         returnType?: "string" | "number" | "boolean" | "json";
-    }): GlobalBuilder<TFields & {
+    }): GlobalBuilder<TSlug, TFields & {
         [K in TName]: TReturn;
     }>;
     /**
@@ -54,7 +55,7 @@ export declare class GlobalBuilder<TFields extends Record<string, any> = {}> {
             apiKey?: any;
         }) => TReturn | Promise<TReturn>;
         returnType?: "string" | "number" | "boolean" | "json";
-    }): GlobalBuilder<TFields & {
+    }): GlobalBuilder<TSlug, TFields & {
         [K in TName]: TReturn;
     }>;
     /**
@@ -64,11 +65,13 @@ export declare class GlobalBuilder<TFields extends Record<string, any> = {}> {
     /**
      * Compiles the builder down into the raw Global object expected by OpacaCMS.
      */
-    build(): Global;
+    build(): Global & {
+        slug: TSlug;
+    };
 }
 /**
  * Singleton factory for creating Globals.
  */
 export declare const Global: {
-    create: (slug: string) => GlobalBuilder<{}>;
+    create: <T extends string>(slug: T) => GlobalBuilder<T, {}>;
 };

package/dist/schema/index.js

@@ -34,8 +34,8 @@ class FieldBuilder {
     this.config.defaultValue = val;
     return this;
   }
-  validate(fn) {
-    this.config.validate = fn;
+  validate(val) {
+    this.config.validate = val;
     return this;
   }
   access(config) {
@@ -146,6 +146,12 @@ class RichTextFieldBuilder extends FieldBuilder {
   }
 }
 
+class UIFieldBuilder extends FieldBuilder {
+  constructor(name) {
+    super("ui", name);
+  }
+}
+
 class RelationshipFieldBuilder extends FieldBuilder {
   constructor(name) {
     super("relationship", name);
@@ -188,6 +194,12 @@ class FileFieldBuilder extends FieldBuilder {
   }
 }
 
+class JSONFieldBuilder extends FieldBuilder {
+  constructor(name) {
+    super("json", name);
+  }
+}
+
 class DateFieldBuilder extends FieldBuilder {
   constructor(name) {
     super("date", name);
@@ -375,7 +387,9 @@ var Field = {
     builder.blocks(...blocks);
     return builder;
   },
-  block: (slug) => new BlockBuilder(slug)
+  block: (slug) => new BlockBuilder(slug),
+  ui: (name) => new UIFieldBuilder(name),
+  json: (name) => new JSONFieldBuilder(name)
 };
 
 // src/schema/collection.ts
@@ -407,6 +421,7 @@ class CollectionBuilder {
     const nextBuilder = new CollectionBuilder(this.config.slug);
     nextBuilder.config = { ...this.config };
     nextBuilder.fieldBuilders = [...fields];
+    nextBuilder.config.fields = nextBuilder.fieldBuilders.map((f) => f.build());
     return nextBuilder;
   }
   access(rules) {
@@ -424,11 +439,9 @@ class CollectionBuilder {
     const nextBuilder = new CollectionBuilder(this.config.slug);
     nextBuilder.config = { ...this.config };
     nextBuilder.fieldBuilders = [...this.fieldBuilders, builder];
+    nextBuilder.config.fields = nextBuilder.fieldBuilders.map((f) => f.build());
     return nextBuilder;
   }
-  computed(name, options) {
-    return this.virtual(name, options);
-  }
   admin(opts) {
     if (typeof opts === "boolean") {
       this.config.admin = opts;
@@ -457,6 +470,7 @@ class CollectionBuilder {
     const compiledFields = this.fieldBuilders.map((builder) => builder.build());
     return {
       ...this.config,
+      slug: this.slug,
       fields: compiledFields
     };
   }
@@ -466,9 +480,11 @@ var Collection = {
 };
 // src/schema/global.ts
 class GlobalBuilder {
+  slug;
   config = {};
   _fields = [];
   constructor(slug) {
+    this.slug = slug;
     this.config.slug = slug;
     this.config.fields = [];
     this.config.timestamps = true;

package/dist/server/admin-router.d.ts

@@ -1,8 +1,8 @@
 import { Hono } from "hono";
 import type { Auth } from "../auth";
 import type { OpacaConfig } from "../types";
-import type { ApiContextVariables } from "./router";
-export declare function createAdminRouter(config: OpacaConfig, state: {
+import type { ApiContextVariables } from "../server/router";
+export declare function createAdminRouter(config: OpacaConfig, settings: Record<string, any>, state: {
     auth: Auth | undefined;
 }): Hono<{
     Variables: ApiContextVariables;

package/dist/server/admin.d.ts

@@ -7,6 +7,7 @@ type AdminHandlers = {
     getConfig: (c: Context) => Promise<Response>;
     getSetupStatus: (c: Context) => Promise<Response>;
     createApiKey: (c: Context) => Promise<Response>;
+    getPluginSettings: (c: Context) => Promise<Response>;
 };
 /**
  * Creates the admin handlers for the OpacaCMS.
@@ -14,5 +15,5 @@ type AdminHandlers = {
  * @param getAuth A function that returns the authentication instance.
  * @returns An object containing the admin handlers for hono integration.
  */
-export declare function createAdminHandlers(config: OpacaConfig, getAuth: () => Auth | undefined): AdminHandlers;
+export declare function createAdminHandlers(config: OpacaConfig, settings: Record<string, any>, getAuth: () => Auth | undefined): AdminHandlers;
 export {};

package/dist/server/collection-router.d.ts

@@ -1,7 +1,7 @@
 import type { Hono } from "hono";
 import type { Auth } from "../auth";
 import type { OpacaConfig } from "../types";
-import type { ApiContextVariables } from "./router";
+import type { ApiContextVariables } from "../server/router";
 export declare function mountCollectionRoutes(router: Hono<{
     Variables: ApiContextVariables;
 }>, config: OpacaConfig, state: {

package/dist/server/handlers.d.ts

@@ -8,6 +8,16 @@ import type { Collection, Global, OpacaConfig } from "../types";
  * @returns hydrated document
  */
 export declare const hydrateDoc: (doc: any, fields: any[], c: Context, config: OpacaConfig) => Promise<any>;
+/**
+ * Parses the populate query parameter into a nested map.
+ * Supports comma-separated dot notation (e.g. "author,comments.user")
+ * or a JSON string.
+ */
+export declare function parsePopulate(populate: string | any): Record<string, any>;
+/**
+ * Populates a document with related documents recursively.
+ */
+export declare const populateDoc: (db: any, fields: any[], doc: any, populate: Record<string, any>, config: OpacaConfig) => Promise<any>;
 /**
  * Creates handlers for a collection
  * @param config opaca config

package/dist/server/middlewares/admin.d.ts

@@ -1,6 +1,6 @@
 import type { Context, Next } from "hono";
 export declare const adminMiddleware: (c: Context, next: Next) => Promise<(Response & import("hono").TypedResponse<{
     message: string;
-}, 401, "json">) | (Response & import("hono").TypedResponse<{
+}, 403, "json">) | (Response & import("hono").TypedResponse<{
     message: string;
-}, 403, "json">) | undefined>;
+}, 401, "json">) | undefined>;

package/dist/server/middlewares/auth.d.ts

@@ -1,4 +1,4 @@
-import type { Session, User } from "better-auth";
+import type { Session, User } from "../../types";
 import type { MiddlewareHandler } from "hono";
 import type { Auth } from "../../auth";
 export type AuthContextVariables = {

package/dist/server/middlewares/context.d.ts

@@ -1,8 +1,10 @@
 import type { MiddlewareHandler } from "hono";
 import type { OpacaConfig } from "../../types";
+import { OpacaLogger } from "../../utils/logger";
 export type OpacaContextVariables = {
     config: OpacaConfig;
     db: OpacaConfig["db"];
+    logger: OpacaLogger;
 };
 export declare function createContextMiddleware(config: OpacaConfig): MiddlewareHandler<{
     Variables: OpacaContextVariables;

package/dist/server/middlewares/rate-limit.d.ts

@@ -1,3 +1,3 @@
 import type { MiddlewareHandler } from "hono";
-import type { OpacaConfig } from "@/types";
+import type { OpacaConfig } from "../../types";
 export declare function createRateLimitMiddleware(config: OpacaConfig): MiddlewareHandler;

package/dist/server/openapi.d.ts

@@ -0,0 +1,2 @@
+import type { OpacaConfig } from "../types";
+export declare function generateOpenAPISchema(config: OpacaConfig): any;

package/dist/server/plugins-loader.d.ts

@@ -0,0 +1,6 @@
+import type { OpacaConfig } from "@/types";
+/**
+ * Loads all plugin settings from the `_opaca_plugin_settings` collection.
+ * Returns a Record where keys are plugin names and values are their configurations.
+ */
+export declare function loadPluginSettings(config: OpacaConfig): Promise<Record<string, any>>;

package/dist/server/router.d.ts

@@ -1,7 +1,7 @@
 import { Hono } from "hono";
 import type { OpacaConfig } from "../types";
-import { type ApiContextVariables } from "./setup-middlewares";
-export type { ApiContextVariables } from "./setup-middlewares";
-export declare function createAPIRouter(config: OpacaConfig): Hono<{
+import { type ApiContextVariables } from "../server/setup-middlewares";
+export type { ApiContextVariables } from "../server/setup-middlewares";
+export declare function createAPIRouter(config: OpacaConfig, settings?: Record<string, any>): Hono<{
     Variables: ApiContextVariables;
 }>;

package/dist/server/routers/admin.d.ts

@@ -1,8 +1,8 @@
 import { Hono } from "hono";
 import type { Auth } from "../../auth";
 import type { OpacaConfig } from "../../types";
-import type { ApiContextVariables } from "../router";
-export declare function createAdminRouter(config: OpacaConfig, state: {
+import type { ApiContextVariables } from "../../server/router";
+export declare function createAdminRouter(config: OpacaConfig, settings: Record<string, any>, state: {
     auth: Auth | undefined;
 }): Hono<{
     Variables: ApiContextVariables;

package/dist/server/routers/auth.d.ts

@@ -1,7 +1,7 @@
 import { Hono } from "hono";
 import type { Auth } from "../../auth";
 import type { OpacaConfig } from "../../types";
-import type { ApiContextVariables } from "../router";
+import type { ApiContextVariables } from "../../server/router";
 export declare function createAuthRouter(config: OpacaConfig, state: {
     auth: Auth | undefined;
 }): Hono<{

package/dist/server/routers/collections.d.ts

@@ -1,7 +1,7 @@
 import { Hono } from "hono";
 import type { Auth } from "../../auth";
 import type { OpacaConfig } from "../../types";
-import type { ApiContextVariables } from "../router";
+import type { ApiContextVariables } from "../../server/router";
 export declare function mountCollectionRoutes(router: Hono<{
     Variables: ApiContextVariables;
 }>, config: OpacaConfig, state: {

package/dist/server/routers/plugins.d.ts

@@ -0,0 +1,18 @@
+import type { Hono } from "hono";
+import type { OpacaConfig } from "../../types";
+import type { ApiContextVariables } from "../setup-middlewares";
+/**
+ * Mounts all plugin-specific routes and middlewares.
+ *
+ * @param config - The OpacaCMS configuration.
+ * @param settings - The loaded plugin settings.
+ * @param logger - The system logger.
+ * @param router - The Hono router instance.
+ */
+export declare function mountPluginRoutes(config: OpacaConfig, settings: Record<string, any>, logger: typeof import("../../utils/logger").logger, router: Hono<{
+    Variables: ApiContextVariables;
+}>): void;
+/**
+ * Fires the onInitComplete hook for all plugins.
+ */
+export declare function firePluginInitComplete(config: OpacaConfig, settings: Record<string, any>, logger: typeof import("../../utils/logger").logger): void;

package/dist/server/setup-middlewares.d.ts

@@ -1,8 +1,8 @@
 import type { Hono } from "hono";
 import type { Auth } from "../auth";
 import type { OpacaConfig } from "../types";
-import { type AuthContextVariables } from "./middlewares/auth";
-import { type OpacaContextVariables } from "./middlewares/context";
+import { type AuthContextVariables } from "../server/middlewares/auth";
+import { type OpacaContextVariables } from "../server/middlewares/context";
 export type ApiContextVariables = OpacaContextVariables & AuthContextVariables;
 export declare function setupMiddlewares(router: Hono<{
     Variables: ApiContextVariables;

package/dist/server/system-router.d.ts

@@ -1,6 +1,6 @@
 import { Hono } from "hono";
 import type { OpacaConfig } from "../types";
-import type { ApiContextVariables } from "./router";
+import type { ApiContextVariables } from "../server/router";
 export declare function createSystemRouter(config: OpacaConfig): Hono<{
     Variables: ApiContextVariables;
 }, import("hono/types").BlankSchema, "/">;

package/dist/server.js

@@ -3,20 +3,24 @@ import {
   createAdminHandlers,
   createGlobalHandlers,
   createHandlers,
-  hydrateDoc
-} from "./chunk-xrfhhz85.js";
+  hydrateDoc,
+  parsePopulate,
+  populateDoc
+} from "./chunk-kc4jfnv7.js";
 import {
   defineConfig
-} from "./chunk-t9v845m2.js";
-import"./chunk-mycmsjd9.js";
+} from "./chunk-7y1nbmw6.js";
+import"./chunk-b3kr8w41.js";
 import {
   BaseDatabaseAdapter
 } from "./chunk-s8mqwnm1.js";
-import"./chunk-62ev8gnc.js";
-import"./chunk-2kyhqvhc.js";
-import"./chunk-ybbbqj63.js";
+import"./chunk-qxt9vge8.js";
+import"./chunk-v9z61v3g.js";
+import"./chunk-t0zg026p.js";
 import"./chunk-8sqjbsgt.js";
 export {
+  populateDoc,
+  parsePopulate,
   hydrateDoc,
   defineConfig,
   createHandlers,

package/dist/storage/adapters/local.d.ts

@@ -1,4 +1,4 @@
-import type { StorageAdapter, StorageAdapterConfig } from "../types";
+import type { StorageAdapter, StorageAdapterConfig } from "../../storage/types";
 export interface LocalAdapterConfig extends StorageAdapterConfig {
     uploadDir: string;
     publicUrl: string;

package/dist/storage/adapters/s3.d.ts

@@ -1,4 +1,4 @@
-import type { StorageAdapter, StorageAdapterConfig } from "../types";
+import type { StorageAdapter, StorageAdapterConfig } from "../../storage/types";
 export interface S3AdapterConfig extends StorageAdapterConfig {
     region: string;
     bucket: string;