@dyrected/core 0.0.1 → 1.0.1

package/LICENSE.md

@@ -0,0 +1,50 @@
+Business Source License 1.1
+
+Parameters
+
+Licensor:             Ajola Technologies Ltd
+Licensed Work:        Dyrected
+Additional Use Grant: Commercial use is permitted as long as it is not used to provide a hosted or managed service that competes with Dyrected.
+Change Date:          2030-05-11
+Change License:       Apache License 2.0
+
+---
+
+Business Source License 1.1
+
+License text copyright © 2024 MariaDB plc, All Rights Reserved. 
+“Business Source License” is a trademark of MariaDB plc.
+
+### Terms
+
+The Licensor hereby grants you the right to copy, modify, create derivative works, redistribute, and make non-production use of the Licensed Work. The Licensor may make an Additional Use Grant, above, permitting limited production use.
+
+Effective on the Change Date, or the fourth anniversary of the first publicly available distribution of a specific version of the Licensed Work under this License, whichever comes first, the Licensor hereby grants you rights under the terms of the Change License, and the rights granted in the paragraph above terminate.
+
+If your use of the Licensed Work does not comply with the requirements currently in effect as described in this License, you must purchase a commercial license from the Licensor, its affiliated entities, or authorized resellers, or you must refrain from using the Licensed Work.
+
+All copies of the original and modified Licensed Work, and derivative works of the Licensed Work, are subject to this License. This License applies separately for each version of the Licensed Work and the Change Date may vary for each version of the Licensed Work released by Licensor.
+
+You must conspicuously display this License on each original or modified copy of the Licensed Work. If you receive the Licensed Work in original or modified form from a third party, the terms and conditions set forth in this License apply to your use of that work.
+
+Any use of the Licensed Work in violation of this License will automatically terminate your rights under this License for the current and all other versions of the Licensed Work.
+
+This License does not grant you any right in any trademark or logo of Licensor or its affiliates (provided that you may use a trademark or logo of Licensor as expressly required by this License).
+
+TO THE EXTENT PERMITTED BY APPLICABLE LAW, THE LICENSED WORK IS PROVIDED ON AN “AS IS” BASIS. LICENSOR HEREBY DISCLAIMS ALL WARRANTIES AND CONDITIONS, EXPRESS OR IMPLIED, INCLUDING (WITHOUT LIMITATION) WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT, AND TITLE. 
+
+MariaDB hereby grants you permission to use this License’s text to license your works, and to refer to it using the trademark “Business Source License”, as long as you comply with the Covenants of Licensor below.
+
+### Covenants of Licensor
+
+In consideration of the right to use this License’s text and the “Business Source License” name and trademark, Licensor covenants to MariaDB, and to all other recipients of the licensed work to be provided by Licensor:
+
+1. To specify as the Change License the GPL Version 2.0 or any later version, or a license that is compatible with GPL Version 2.0 or a later version, where “compatible” means that software provided under the Change License can be included in a program with software provided under GPL Version 2.0 or a later version. Licensor may specify additional Change Licenses without limitation. 
+
+2. To either: (a) specify an additional grant of rights to use that does not impose any additional restriction on the right granted in this License, as the Additional Use Grant; or (b) insert the text “None”.
+
+3. Not to modify this License in any other way.
+
+---
+
+The Business Source License (this document, or the “License”) is not an Open Source license. However, the Licensed Work will eventually be made available under an Open Source License, as stated in this License.

package/README.md

@@ -1,3 +1,37 @@
 # @dyrected/core
 
-This is the core package/app for the Dyrected ecosystem.
+The heart of the Dyrected ecosystem. `@dyrected/core` is a lightweight, Hono-based headless CMS engine designed for high performance and developer flexibility.
+
+## Features
+
+- **Code-First Schema**: Define your content structure in TypeScript.
+- **Framework Agnostic**: Pluggable adapters for database, storage, and auth.
+- **REST & OpenAPI**: Automatically generates a fully-typed API and Swagger documentation.
+- **Embedded or Standalone**: Use it directly inside your Next.js/Nuxt app or as a separate service.
+
+## Installation
+
+```bash
+pnpm add @dyrected/core
+```
+
+## Basic Usage
+
+```ts
+import { defineConfig } from '@dyrected/core';
+
+export default defineConfig({
+  collections: [
+    {
+      slug: 'posts',
+      fields: [
+        { name: 'title', type: 'text', required: true },
+        { name: 'content', type: 'richText' }
+      ]
+    }
+  ],
+  // Add database and storage adapters
+});
+```
+
+For full documentation, visit [docs.dyrected.com](https://docs.dyrected.com).

package/dist/chunk-FURYJ254.mjs

@@ -0,0 +1,33 @@
+// src/auth/token.ts
+import { SignJWT, jwtVerify, decodeJwt } from "jose";
+import { TextEncoder } from "util";
+function getSecret() {
+  const secret = process.env.DYRECTED_JWT_SECRET || process.env.JWT_SECRET;
+  if (!secret) {
+    throw new Error(
+      "[dyrected/core] DYRECTED_JWT_SECRET is not set. Add it to your environment variables to enable auth collections."
+    );
+  }
+  return new TextEncoder().encode(secret);
+}
+var DEFAULT_EXPIRY = "7d";
+async function signCollectionToken(payload, expiresIn = DEFAULT_EXPIRY) {
+  return new SignJWT({ ...payload }).setProtectedHeader({ alg: "HS256" }).setIssuedAt().setExpirationTime(expiresIn).sign(getSecret());
+}
+async function verifyCollectionToken(token) {
+  const { payload } = await jwtVerify(token, getSecret());
+  return payload;
+}
+function decodeCollectionToken(token) {
+  try {
+    return decodeJwt(token);
+  } catch {
+    return null;
+  }
+}
+
+export {
+  signCollectionToken,
+  verifyCollectionToken,
+  decodeCollectionToken
+};

package/dist/chunk-GM4WW6IE.js

@@ -0,0 +1,66 @@
+// src/utils/config.ts
+var AUDIT_COLLECTION_SLUG = "__audit";
+var SYSTEM_FIELDS = [
+  {
+    name: "createdAt",
+    type: "date",
+    label: "Created At",
+    admin: { readOnly: true, hidden: true }
+  },
+  {
+    name: "updatedAt",
+    type: "date",
+    label: "Updated At",
+    admin: { readOnly: true, hidden: true }
+  },
+  {
+    name: "createdBy",
+    type: "text",
+    label: "Created By",
+    admin: { readOnly: true, hidden: true }
+  },
+  {
+    name: "updatedBy",
+    type: "text",
+    label: "Updated By",
+    admin: { readOnly: true, hidden: true }
+  }
+];
+var AUDIT_COLLECTION = {
+  slug: AUDIT_COLLECTION_SLUG,
+  labels: { singular: "Audit Log", plural: "Audit Logs" },
+  fields: [
+    { name: "collection", type: "text", label: "Collection", required: true },
+    { name: "documentId", type: "text", label: "Document ID" },
+    { name: "operation", type: "select", label: "Operation", options: ["create", "update", "delete"], required: true },
+    { name: "user", type: "text", label: "User ID" },
+    { name: "timestamp", type: "date", label: "Timestamp", required: true },
+    { name: "changes", type: "json", label: "Changes" }
+  ],
+  admin: { hidden: true }
+};
+function normalizeConfig(config) {
+  const needsAudit = config.collections.some((col) => col.audit);
+  const normalizedCollections = config.collections.map((col) => {
+    const existingFieldNames = new Set(col.fields.map((f) => f.name));
+    const fieldsToInject = SYSTEM_FIELDS.filter((f) => !existingFieldNames.has(f.name));
+    return {
+      ...col,
+      fields: [...col.fields, ...fieldsToInject]
+    };
+  });
+  const hasAuditCollection = normalizedCollections.some(
+    (col) => col.slug === AUDIT_COLLECTION_SLUG
+  );
+  return {
+    ...config,
+    collections: [
+      ...normalizedCollections,
+      ...needsAudit && !hasAuditCollection ? [AUDIT_COLLECTION] : []
+    ]
+  };
+}
+
+export {
+  normalizeConfig
+};

package/dist/index-D38_E0gf.d.cts

@@ -0,0 +1,336 @@
+type FieldType = "text" | "textarea" | "richText" | "number" | "boolean" | "date" | "select" | "multiSelect" | "relationship" | "array" | "object" | "json" | "blocks" | "image" | "email" | "url";
+interface Block {
+    slug: string;
+    labels?: {
+        singular: string;
+        plural: string;
+    };
+    fields: Field[];
+}
+interface Field {
+    name: string;
+    type: FieldType;
+    label?: string;
+    required?: boolean;
+    unique?: boolean;
+    defaultValue?: any;
+    options?: string[] | {
+        label: string;
+        value: string;
+    }[];
+    relationTo?: string;
+    hasMany?: boolean;
+    fields?: Field[];
+    blocks?: Block[];
+    access?: {
+        read?: AccessFunction;
+        update?: AccessFunction;
+    };
+    hooks?: {
+        beforeChange?: FieldHook[];
+        afterRead?: FieldHook[];
+    };
+    admin?: {
+        placeholder?: string;
+        description?: string;
+        hidden?: boolean;
+        readOnly?: boolean;
+        condition?: ((data: any, siblingData: any) => boolean) | string;
+        layout?: "radio" | "select" | string;
+        direction?: "horizontal" | "vertical";
+    };
+}
+type AccessFunction = (args: {
+    user: any;
+    doc?: any;
+    data?: any;
+    req: any;
+}) => boolean | object | Promise<boolean | object>;
+type HookFunction = (args: {
+    data?: any;
+    doc?: any;
+    user?: any;
+    req?: any;
+    /** The operation that triggered this hook. */
+    operation?: 'create' | 'update' | 'delete';
+}) => any | Promise<any>;
+type FieldHook = (args: {
+    value: any;
+    originalDoc?: any;
+    data?: any;
+    user?: any;
+}) => any | Promise<any>;
+interface CollectionConfig {
+    slug: string;
+    siteId?: string;
+    shared?: boolean;
+    labels?: {
+        singular: string;
+        plural: string;
+    };
+    auth?: boolean;
+    upload?: boolean | UploadConfig;
+    fields: Field[];
+    timestamps?: boolean;
+    /** Enable full activity logging to the __audit collection for this collection. */
+    audit?: boolean;
+    access?: {
+        read?: AccessFunction;
+        create?: AccessFunction;
+        update?: AccessFunction;
+        delete?: AccessFunction;
+    };
+    hooks?: {
+        beforeRead?: HookFunction[];
+        afterRead?: HookFunction[];
+        beforeChange?: HookFunction[];
+        afterChange?: HookFunction[];
+        beforeDelete?: HookFunction[];
+        afterDelete?: HookFunction[];
+    };
+    admin?: {
+        useAsTitle?: string;
+        defaultColumns?: string[];
+        group?: string;
+        hidden?: boolean;
+        /**
+         * URL to open in the Live Preview pane.
+         * Accepts a static string or a function that receives the document and returns a URL.
+         */
+        previewUrl?: string | ((doc: any, opts: {
+            locale?: string;
+        }) => string | null);
+        /** Which mode to use for live preview. Defaults to 'postMessage'. */
+        previewMode?: 'postMessage' | 'token';
+    };
+}
+interface UploadConfig {
+    allowedMimeTypes?: string[];
+    maxFileSize?: number;
+    /** Local disk path where files are stored. Only used by LocalStorage adapter. */
+    staticDir?: string;
+    /** Public URL prefix for locally stored files. Only used by LocalStorage adapter. */
+    staticURL?: string;
+    /** Which imageSizes entry to use as the thumbnail in the Admin media grid. */
+    adminThumbnail?: string;
+    imageSizes?: {
+        name: string;
+        width?: number;
+        height?: number;
+        crop?: string;
+        /** sharp fit strategy: 'cover' | 'contain' | 'fill' | 'inside' | 'outside' */
+        fit?: string;
+        /** Never upscale images smaller than the target size. Default: true. */
+        withoutEnlargement?: boolean;
+        /** Additional sharp format options. */
+        formatOptions?: Record<string, any>;
+    }[];
+}
+interface GlobalConfig {
+    slug: string;
+    siteId?: string;
+    shared?: boolean;
+    label?: string;
+    fields: Field[];
+    access?: {
+        read?: AccessFunction;
+        update?: AccessFunction;
+    };
+    hooks?: {
+        beforeRead?: HookFunction[];
+        afterRead?: HookFunction[];
+        beforeChange?: HookFunction[];
+        afterChange?: HookFunction[];
+    };
+    admin?: {
+        group?: string;
+        hidden?: boolean;
+    };
+}
+interface PaginatedResult<T = any> {
+    docs: T[];
+    total: number;
+    limit: number;
+    page: number;
+    /** Total number of pages given the current limit. */
+    totalPages: number;
+    hasNextPage: boolean;
+    hasPrevPage: boolean;
+}
+interface DatabaseAdapter {
+    find(args: {
+        collection: string;
+        where?: any;
+        limit?: number;
+        page?: number;
+        sort?: string;
+    }): Promise<PaginatedResult>;
+    findOne(args: {
+        collection: string;
+        id: string;
+    }): Promise<any>;
+    create(args: {
+        collection: string;
+        data: any;
+    }): Promise<any>;
+    update(args: {
+        collection: string;
+        id: string;
+        data: any;
+    }): Promise<any>;
+    delete(args: {
+        collection: string;
+        id: string;
+    }): Promise<any>;
+    getGlobal(args: {
+        slug: string;
+    }): Promise<any>;
+    updateGlobal(args: {
+        slug: string;
+        data: any;
+    }): Promise<any>;
+    /**
+     * Sync the database schema with the provided collections and globals.
+     * Useful for creating tables on startup.
+     */
+    sync?(collections: CollectionConfig[], globals: GlobalConfig[]): Promise<void>;
+    /**
+     * Low-level raw query execution.
+     * Optional as not all adapters may support raw SQL/commands.
+     */
+    execute?(query: string, params?: any[]): Promise<any>;
+}
+interface FileData {
+    filename: string;
+    filesize?: number;
+    mimeType: string;
+    url: string;
+    width?: number;
+    height?: number;
+    focalPoint?: {
+        x: number;
+        y: number;
+    };
+    blurhash?: string;
+    type?: "upload" | "external";
+    provider?: string;
+    provider_metadata?: any;
+    [key: string]: any;
+}
+interface StorageAdapter {
+    upload(args: {
+        filename: string;
+        buffer: Uint8Array;
+        mimeType: string;
+        prefix?: string;
+    }): Promise<FileData>;
+    delete(args: {
+        filename: string;
+    }): Promise<void>;
+    getURL(args: {
+        filename: string;
+    }): string;
+    /** Retrieve file content for serving via API */
+    resolve?(args: {
+        filename: string;
+    }): Promise<{
+        buffer: Uint8Array;
+        mimeType: string;
+    } | null>;
+}
+/** Branding and metadata configuration for the Admin UI. */
+interface AdminConfig {
+    branding?: {
+        /** URL or imported image for the full logo shown in the sidebar. */
+        logo?: string;
+        /** URL or imported image for the compact logo mark used in collapsed sidebar. */
+        logoMark?: string;
+        /** Primary accent colour as a CSS value (e.g. '#6366f1' or 'hsl(240 50% 60%)') */
+        primaryColor?: string;
+        /** URL for the browser tab favicon. */
+        favicon?: string;
+    };
+    meta?: {
+        /** Appended to every Admin page title. Default: '- Dyrected' */
+        titleSuffix?: string;
+    };
+}
+interface ImageService {
+    process(args: {
+        buffer: Uint8Array;
+        mimeType: string;
+        config?: CollectionConfig['upload'];
+        focalPoint?: {
+            x: number;
+            y: number;
+        };
+    }): Promise<{
+        metadata: {
+            width?: number;
+            height?: number;
+            blurhash?: string;
+        };
+        sizes?: Record<string, {
+            buffer: Uint8Array;
+            width: number;
+            height: number;
+            filename: string;
+        }>;
+    }>;
+}
+interface DyrectedConfig {
+    collections: CollectionConfig[];
+    globals: GlobalConfig[];
+    db?: DatabaseAdapter;
+    storage?: StorageAdapter;
+    image?: ImageService;
+    /** Admin UI branding and meta configuration. */
+    admin?: AdminConfig;
+    email?: {
+        from: string;
+        send: (args: {
+            to: string;
+            subject: string;
+            html: string;
+        }) => Promise<void>;
+        templates?: {
+            welcome?: (args: {
+                email: string;
+            }) => {
+                subject?: string;
+                html: string;
+            };
+            invite?: (args: {
+                token: string;
+                invitedByEmail?: string;
+            }) => {
+                subject?: string;
+                html: string;
+            };
+            resetPassword?: (args: {
+                token: string;
+            }) => {
+                subject?: string;
+                html: string;
+            };
+            passwordChanged?: (args: {
+                email: string;
+            }) => {
+                subject?: string;
+                html: string;
+            };
+        };
+    };
+    redis?: {
+        url: string;
+    };
+    cors?: {
+        origins: string[];
+    };
+    onSchemaFetch?: (siteId: string) => Promise<{
+        collections?: CollectionConfig[];
+        globals?: GlobalConfig[];
+    }>;
+}
+
+export type { AccessFunction as A, Block as B, CollectionConfig as C, DyrectedConfig as D, Field as F, GlobalConfig as G, HookFunction as H, ImageService as I, PaginatedResult as P, StorageAdapter as S, UploadConfig as U, AdminConfig as a, DatabaseAdapter as b, FieldHook as c, FieldType as d, FileData as e };