opacacms 0.1.21 → 0.2.1

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-2es275xs.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;

package/dist/storage/index.js

@@ -219,21 +219,25 @@ function createLocalAdapter(config) {
   };
 }
 // src/storage/adapters/s3.ts
-import {
-  DeleteObjectCommand,
-  GetObjectCommand,
-  HeadObjectCommand,
-  PutObjectCommand,
-  S3Client
-} from "@aws-sdk/client-s3";
-import { getSignedUrl } from "@aws-sdk/s3-request-presigner";
 function createS3Adapter(config) {
-  const s3Client = new S3Client({
-    region: config.region,
-    endpoint: config.endpoint,
-    credentials: config.credentials,
-    forcePathStyle: config.forcePathStyle
-  });
+  let _s3Client = null;
+  let _sdk = null;
+  const getSdk = async () => {
+    if (_sdk)
+      return _sdk;
+    const [clientS3, presigner] = await Promise.all([
+      import("@aws-sdk/client-s3"),
+      import("@aws-sdk/s3-request-presigner")
+    ]);
+    _sdk = { ...clientS3, ...presigner };
+    _s3Client = new _sdk.S3Client({
+      region: config.region,
+      endpoint: config.endpoint,
+      credentials: config.credentials,
+      forcePathStyle: config.forcePathStyle
+    });
+    return _sdk;
+  };
   const getFullKey = (filename) => {
     if (config.prefix) {
       const p = config.prefix.replace(/\/$/, "");
@@ -252,6 +256,7 @@ function createS3Adapter(config) {
     name: "s3",
     async upload(file, options) {
       try {
+        const sdk = await getSdk();
         if (options?.allowedmime_types && !options.allowedmime_types.includes(file.mime_type)) {
           throw new Invalidmime_typeError("s3", options.allowedmime_types, file.mime_type);
         }
@@ -267,7 +272,7 @@ function createS3Adapter(config) {
         }
         const key = getFullKey(finalFilename);
         const body = file.buffer || file.stream;
-        const command = new PutObjectCommand({
+        const command = new sdk.PutObjectCommand({
           Bucket: config.bucket,
           Key: key,
           Body: body,
@@ -275,7 +280,7 @@ function createS3Adapter(config) {
           ContentLength: file.filesize,
           ACL: config.acl || "private"
         });
-        await s3Client.send(command);
+        await _s3Client.send(command);
         return {
           filename: finalFilename,
           mime_type: file.mime_type,
@@ -290,22 +295,24 @@ function createS3Adapter(config) {
     },
     async delete(filename) {
       try {
-        const command = new DeleteObjectCommand({
+        const sdk = await getSdk();
+        const command = new sdk.DeleteObjectCommand({
           Bucket: config.bucket,
           Key: getFullKey(filename)
         });
-        await s3Client.send(command);
+        await _s3Client.send(command);
       } catch (error) {
         throw new StorageError("s3", "delete", `Failed to delete ${filename} from S3 bucket ${config.bucket}`, error);
       }
     },
     async exists(filename) {
       try {
-        const command = new HeadObjectCommand({
+        const sdk = await getSdk();
+        const command = new sdk.HeadObjectCommand({
           Bucket: config.bucket,
           Key: getFullKey(filename)
         });
-        await s3Client.send(command);
+        await _s3Client.send(command);
         return true;
       } catch (error) {
         if (error.name === "NotFound" || error.$metadata?.httpStatusCode === 404)
@@ -315,24 +322,26 @@ function createS3Adapter(config) {
     },
     async generatePresignedUrl(filename, operation, expiresInSeconds = 3600) {
       try {
+        const sdk = await getSdk();
         let command;
         if (operation === "write") {
-          command = new PutObjectCommand({ Bucket: config.bucket, Key: getFullKey(filename) });
+          command = new sdk.PutObjectCommand({ Bucket: config.bucket, Key: getFullKey(filename) });
         } else {
-          command = new GetObjectCommand({ Bucket: config.bucket, Key: getFullKey(filename) });
+          command = new sdk.GetObjectCommand({ Bucket: config.bucket, Key: getFullKey(filename) });
         }
-        return await getSignedUrl(s3Client, command, { expiresIn: expiresInSeconds });
+        return await sdk.getSignedUrl(_s3Client, command, { expiresIn: expiresInSeconds });
       } catch (error) {
         throw new StorageError("s3", "presign", `Failed to generate presigned URL for ${filename}`, error);
       }
     },
     async download(filename) {
       try {
-        const command = new GetObjectCommand({
+        const sdk = await getSdk();
+        const command = new sdk.GetObjectCommand({
           Bucket: config.bucket,
           Key: getFullKey(filename)
         });
-        const response = await s3Client.send(command);
+        const response = await _s3Client.send(command);
         if (!response.Body) {
           throw new StorageError("s3", "download", `File not found: ${filename}`);
         }

package/dist/types.d.ts

@@ -1,8 +1,16 @@
-import type { Session, User } from "better-auth";
+import type { z } from "zod";
+import type { Session as BetterAuthSession, User as BetterAuthUser, Prettify } from "better-auth";
 import type { Context } from "hono";
 import type { icons } from "lucide-react";
-import type { AdminConfig, CollectionHooks, FieldType, AccessConfig as ValidationAccessConfig, Collection as ValidationCollection, Global as ValidationGlobal, OpacaConfig as ValidationOpacaConfig } from "./validation";
+import type { AdminConfig, CollectionHooks, FieldType, AccessConfig as ValidationAccessConfig } from "./validation";
 export type { FieldType };
+export type Session = BetterAuthSession;
+export type User = Prettify<BetterAuthUser & {
+    role?: string;
+    banned?: boolean;
+    banReason?: string | null;
+    bannedUntil?: Date | null;
+}>;
 export type IconName = keyof typeof icons;
 export interface BaseField {
     name: string;
@@ -12,7 +20,7 @@ export interface BaseField {
     unique?: boolean;
     localized?: boolean;
     defaultValue?: unknown;
-    validate?: (value: unknown) => boolean | string;
+    validate?: ((value: unknown) => boolean | string) | z.ZodTypeAny;
     access?: FieldAccessConfig;
     admin?: {
         description?: string;
@@ -26,6 +34,7 @@ export interface BaseField {
             Field?: string;
             Cell?: string;
         };
+        customProps?: Record<string, unknown>;
     };
     references?: {
         table: string;
@@ -167,7 +176,10 @@ export interface VirtualField extends BaseField {
     }) => any | Promise<any>;
     returnType?: "string" | "number" | "boolean" | "json";
 }
-export type Field = TextField | SlugField | TextAreaField | NumberField | RichTextField | RelationshipField | SelectField | VirtualField | RadioField | DateField | BooleanField | JSONField | FileField | BlocksField | GroupField | RowField | CollapsibleField | TabsField | JoinField | ArrayField;
+export interface UIField extends BaseField {
+    type: "ui";
+}
+export type Field = TextField | SlugField | TextAreaField | NumberField | RichTextField | RelationshipField | SelectField | VirtualField | RadioField | DateField | BooleanField | JSONField | FileField | BlocksField | GroupField | RowField | CollapsibleField | TabsField | JoinField | ArrayField | UIField;
 export interface ApiKey {
     id: string;
     name: string | null;
@@ -197,18 +209,20 @@ export interface AccessConfig extends Omit<ValidationAccessConfig, "read" | "cre
     delete?: boolean | ((args: AccessArgs) => boolean | Promise<boolean>);
 }
 export type { CollectionHooks };
-export interface Collection extends Omit<ValidationCollection, "fields" | "hooks" | "access" | "admin" | "apiPath" | "versions" | "webhooks" | "timestamps"> {
-    fields: Field[];
+export interface Collection {
+    slug: string;
+    label?: string;
+    icon?: IconName;
     apiPath?: string;
+    fields: Field[];
     hooks?: CollectionHooks;
     access?: AccessConfig;
-    icon?: IconName;
     versions?: {
         drafts?: boolean;
         maxRevisions?: number;
         autosave?: boolean;
     };
-    timestamps: boolean | {
+    timestamps?: boolean | {
         createdAt?: string;
         updatedAt?: string;
     };
@@ -217,11 +231,23 @@ export interface Collection extends Omit<ValidationCollection, "fields" | "hooks
         url: string;
         headers?: Record<string, string>;
     }[];
+    auth?: boolean;
     admin?: {
-        defaultColumns?: string[];
+        /**
+         * If true, the collection's title will be used as a breadcrumb.
+         */
         useAsTitle?: string;
+        /**
+         * If true, the collection will be hidden from the Admin UI sidebar but still accessible via direct URL.
+         */
         hidden?: boolean;
+        /**
+         * If true, the collection will be completely disabled from the Admin UI (hidden from sidebar and blocked via direct URL).
+         */
         disableAdmin?: boolean;
+        /**
+         * Predefined filtered views for the collection list.
+         */
         views?: {
             name: string;
             filter: Record<string, any>;
@@ -235,21 +261,121 @@ export interface Collection extends Omit<ValidationCollection, "fields" | "hooks
             }) => Promise<unknown>;
         }[];
     } | boolean;
+    hidden?: boolean;
 }
-export interface Global extends Omit<ValidationGlobal, "fields" | "access" | "timestamps"> {
+export interface Global {
+    slug: string;
     fields: Field[];
     access?: AccessConfig;
     label?: string;
     icon?: IconName;
-    timestamps: boolean | {
+    timestamps?: boolean | {
         createdAt?: string;
         updatedAt?: string;
     };
 }
-export interface OpacaConfig<Resource extends string = string> extends Omit<ValidationOpacaConfig, "collections" | "globals" | "admin" | "api" | "access" | "trustedOrigins" | "auth" | "i18n"> {
+export interface OpacaPluginContext {
+    config: OpacaConfig;
+    logger: typeof import("./utils/logger").logger;
+    settings?: Record<string, any>;
+}
+export interface OpacaPlugin {
+    /**
+     * Unique name/slug for the plugin (e.g. 'stripe')
+     */
+    name: string;
+    /**
+     * User-friendly label for the plugin
+     */
+    label?: string;
+    /**
+     * Short description of what the plugin does
+     */
+    description?: string;
+    /**
+     * Plugin version (e.g. '1.0.0')
+     */
+    version?: string;
+    /**
+     * Plugin author
+     */
+    author?: string;
+    /**
+     * Link to plugin documentation or homepage
+     */
+    homepage?: string;
+    /**
+     * Lucide icon name for the plugin
+     */
+    icon?: IconName;
+    /**
+     * Callback fired during OpacaCMS initialization.
+     * Use this to extend the schema (collections, globals).
+     */
+    onInit?: (context: OpacaPluginContext) => OpacaConfig | void;
+    /**
+     * Callback fired when the Hono router is initialized.
+     * Use this to add custom API routes.
+     */
+    onRouterInit?: (app: import("hono").Hono<any, any, any>, context: OpacaPluginContext) => void;
+    /**
+     * Callback fired after all plugins have been initialized.
+     */
+    onInitComplete?: (context: OpacaPluginContext) => void | Promise<void>;
+    /**
+     * Hook called on every CMS API request.
+     * Return false to block the request.
+     */
+    onRequest?: (c: import("hono").Context) => void | false | Promise<void | false>;
+    /**
+     * Hook for static site generation (SSG) output.
+     */
+    onExport?: (args: {
+        pages: any[];
+        outputDir: string;
+    }) => void | Promise<void | {
+        path: string;
+        content: string;
+    }[]>;
+    /**
+     * Callback fired when the CMS is shutting down.
+     */
+    onDestroy?: () => void | Promise<void>;
+    /**
+     * Defines UI assets (scripts, styles) to be loaded by the Admin UI.
+     */
+    adminAssets?: () => {
+        styles?: string[];
+        scripts?: string[];
+    };
+    /**
+     * Defines a configuration schema for the plugin.
+     * This will be used to generate a settings form in the Admin UI.
+     */
+    configSchema?: Field[];
+    /**
+     * Defines the administrative UI for the plugin.
+     * This can point to local files during development or contain inlined source for production.
+     */
+    adminUI?: {
+        /** The name of the custom element/component to render */
+        component?: string;
+        /** Absolute path to the source file (.tsx) - Used in dev/Node/Bun */
+        filePath?: string;
+        /** The inlined transpiled source code - Used in Workers/Production */
+        source?: string;
+    };
+    /** Runtime settings for the plugin */
+    settings?: Record<string, any>;
+}
+export interface OpacaConfig<Resource extends string = string> {
+    appName?: string;
+    serverURL?: string;
+    secret?: string;
+    db: DatabaseAdapter;
+    logger?: OpacaLoggerConfig;
     collections: Collection[];
     globals?: Global[];
-    db: DatabaseAdapter;
     admin?: AdminConfig;
     api?: ApiConfig;
     access?: OpacaAccessConfig<Resource>;
@@ -259,6 +385,14 @@ export interface OpacaConfig<Resource extends string = string> extends Omit<Vali
         locales: string[];
         defaultLocale: string;
     };
+    storages?: Record<string, any>;
+    runMigrationsOnStartup?: boolean;
+    plugins?: OpacaPlugin[];
+}
+export interface OpacaLoggerConfig {
+    disabled?: boolean;
+    disableColors?: boolean;
+    level?: "debug" | "info" | "warn" | "error";
 }
 export interface OpacaAuthConfig {
     /**
@@ -327,6 +461,15 @@ export interface ApiConfig {
         provider?: (c: Context) => any;
         keyGenerator?: (c: Context) => string | Promise<string>;
     };
+    openAPI?: {
+        enabled?: boolean;
+        path?: string;
+        theme?: "alternate" | "default" | "moon" | "purple" | "solarized" | "bluePlanet" | "saturn" | "kepler" | "mars" | "deepSpace" | "none" | string;
+        layout?: "modern" | "classic" | string;
+        hideModels?: boolean;
+        hideDownloadButton?: boolean;
+        customCss?: string;
+    };
 }
 export type { AdminConfig };
 export interface FindOptions {
@@ -354,8 +497,8 @@ export interface DatabaseAdapter {
     /**
      * Internal ORM instance (e.g. Drizzle instance)
      */
-    readonly db?: unknown;
-    readonly raw?: unknown;
+    readonly db?: any;
+    readonly raw?: any;
     unsafe(sql: string, params?: unknown[]): Promise<unknown>;
     count(collection: string, query?: Record<string, unknown>): Promise<number>;
     create<T extends object>(collection: string, data: Partial<T>): Promise<T>;
@@ -431,16 +574,28 @@ export interface SerializableCollection {
             fields: SerializableCollection["fields"];
         }[];
     }[];
-    timestamps: boolean | {
+    timestamps?: boolean | {
         createdAt?: string;
         updatedAt?: string;
     };
     auth?: boolean;
     admin?: {
         defaultColumns?: string[];
+        /**
+         * If true, the collection's title will be used as a breadcrumb.
+         */
         useAsTitle?: string;
+        /**
+         * If true, the collection will be hidden from the Admin UI sidebar but still accessible via direct URL.
+         */
         hidden?: boolean;
+        /**
+         * If true, the collection will be completely disabled from the Admin UI (hidden from sidebar and blocked via direct URL).
+         */
         disableAdmin?: boolean;
+        /**
+         * Predefined filtered views for the collection list.
+         */
         views?: {
             name: string;
             filter: Record<string, any>;
@@ -488,5 +643,57 @@ export interface SerializableConfig {
         }[];
     }[];
     needsInit?: boolean;
-    storages?: Record<string, unknown>;
+    storages: Record<string, unknown>;
+    plugins?: {
+        /**
+         * Name of the plugin.
+         */
+        name: string;
+        /**
+         * Label to be used in the admin UI.
+         */
+        label?: string;
+        /**
+         * Description of the plugin.
+         */
+        description?: string;
+        /**
+         * Version of the plugin.
+         */
+        version?: string;
+        /**
+         * Author of the plugin.
+         */
+        author?: string;
+        /**
+         * Homepage of the plugin.
+         */
+        homepage?: string;
+        /**
+         * Icon to be used in the admin UI.
+         */
+        icon?: IconName;
+        /**
+         * Assets to be loaded in the admin UI.
+         */
+        adminAssets?: {
+            styles?: string[];
+            scripts?: string[];
+        };
+        /**
+         * Admin UI configuration.
+         */
+        adminUI?: {
+            /**
+             * The name of the custom element to register.
+             */
+            component?: string;
+            /**
+             * The inlined transpiled source code - Used in Workers/Production
+             */
+            source?: string;
+        };
+        settings?: Record<string, any>;
+        configSchema?: SerializableCollection["fields"];
+    }[];
 }

package/dist/utils/logger.d.ts

@@ -1,35 +1,13 @@
-/**
- * Core Logger Utility for OpacaCMS.
- * Standardizes console output across the package with ANSI colors and standard prefixes.
- */
-export declare const logger: {
-    /**
-     * General information logging.
-     * Useful for successful operations, initialization steps, etc.
-     */
-    info: (message: string, ...args: any[]) => void;
-    /**
-     * Action logging. Usually highlighted in green.
-     * e.g., "Created table users", "Connected to DB"
-     */
-    success: (message: string, ...args: any[]) => void;
-    /**
-     * Dim/Debug logging.
-     * e.g., "Starting schema push...", "Syncing database..."
-     */
-    debug: (message: string, ...args: any[]) => void;
-    /**
-     * Warning logging.
-     * For non-fatal errors or deprecated warnings.
-     */
-    warn: (message: string, ...args: any[]) => void;
-    /**
-     * Error logging.
-     * For fatal errors, exceptions, and validation failures.
-     */
-    error: (message: string, ...args: any[]) => void;
-    /**
-     * Raw formatting function if manual concatenation is needed.
-     */
-    format: (color: "green" | "red" | "yellow" | "gray", msg: string) => string;
-};
+import type { OpacaLoggerConfig } from "../types";
+export declare class OpacaLogger {
+    private config;
+    constructor(config?: OpacaLoggerConfig);
+    private shouldLog;
+    info(message: string, ...args: any[]): void;
+    success(message: string, ...args: any[]): void;
+    debug(message: string, ...args: any[]): void;
+    warn(message: string, ...args: any[]): void;
+    error(message: string, ...args: any[]): void;
+    format(color: "green" | "red" | "yellow" | "gray", msg: string): string;
+}
+export declare const logger: OpacaLogger;