@dyrected/core 0.0.1 → 1.0.1

package/dist/index.cjs

@@ -0,0 +1,413 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.ts
+var index_exports = {};
+__export(index_exports, {
+  defineCollection: () => defineCollection,
+  defineConfig: () => defineConfig,
+  defineGlobal: () => defineGlobal,
+  generateAIPrompt: () => generateAIPrompt,
+  normalizeConfig: () => normalizeConfig
+});
+module.exports = __toCommonJS(index_exports);
+
+// src/utils/setup-prompt.ts
+function generateAIPrompt(activeTab, config) {
+  const frameworkLabel = activeTab === "next" ? "Next.js" : activeTab === "nuxt" ? "Nuxt" : activeTab.charAt(0).toUpperCase() + activeTab.slice(1);
+  const backendPkg = activeTab === "nuxt" ? "@dyrected/nuxt" : "@dyrected/next";
+  const isSelfHosted = config.isSelfHosted ?? (config.baseUrl?.includes("localhost") || !config.apiKey);
+  const baseIntro = isSelfHosted ? `You are a Senior Content Architect. Your mission is to integrate Dyrected CMS into a ${config.siteName || "new"} project using ${frameworkLabel}. This is a SELF-HOSTED installation.
+The backend is already configured via ${backendPkg}.
+Your priority is DATA PRESERVATION and creating a CMS that empowers marketing teams.` : `You are a Senior Content Architect. Your mission is to integrate Dyrected CMS into a ${config.siteName || "new"} project using ${frameworkLabel}. Complete the entire setup automatically, including embedding the Admin UI and syncing the schema. Your priority is DATA PRESERVATION and marketing independence.`;
+  const credentials = `
+\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501
+SITE CREDENTIALS
+\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501
+${config.siteName ? `Site Name : ${config.siteName}
+` : ""}${isSelfHosted ? "" : `Site ID   : ${config.siteId}
+API Key   : ${config.apiKey}
+`}API URL   : ${config.baseUrl || "https://api.dyrected.cloud"}
+`;
+  const importantNotes = `
+\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501
+IMPORTANT NOTES \u2014 READ BEFORE ACTING
+\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501
+- \`client.collection(slug)\` is the primary API entrypoint. Do NOT use \`client.collections\`.
+- Blocks are stored as \`[{ blockType: '<slug>', ...fields }]\` \u2014 always switch on \`blockType\` when rendering.
+- MARKETING INDEPENDENCE: Always use a dynamic \`pages\` collection with a catch-all route. Marketing should create pages without a developer. (Exceptions: Special pages like Contact or those with complex forms may use static routes).
+- AUTO-SEEDING: Use \`initialData\` in all data fetches to ensure the site is never empty on first load.
+- Globals use \`client.global(slug).get()\` and \`client.global(slug).update(data)\`.
+- Relationship fields are populated to the specified \`depth\` (default: 1). Set \`depth: 0\` for IDs only.
+- SYNC SCHEMA: After creating the content model, you MUST execute \`npx @dyrected/cli sync:schema\` immediately. This is non-negotiable for a working setup.
+- EMBED ADMIN: You MUST create a route (e.g. \`/admin\`) and mount the Admin UI components described below.
+- ALL-IN-ONE: Your goal is to give the user a project that is READY TO SHIP. Do the setup, do the embedding, and do the sync in one go.
+`;
+  const strategy = `
+\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501
+PHASE 0 \u2014 DATA PRESERVATION & STRATEGY
+\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501
+1. BACKUP: If an existing site is provided, you MUST extract all current content (text, assets, structure) and save it into a \`migration/\` folder as structured .md files BEFORE modifying any code. Never lose data.
+2. DISCOVERY: If NO existing site is provided, STOP and ask the user:
+   - "What are your core content types (e.g. Services, Team, Blog)?"
+   - "How do you want your marketing team to manage the page layouts?"
+3. ARCHITECTURAL CREATIVITY: Design the CMS for longevity. Use \`blocks\` for flexible page builders, \`globals\` for site settings, and \`collections\` for repeated content.
+
+STEP 1 \u2014 CONTENT MODEL (dyrected.config.ts)
+\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501
+Use \`defineCollection\`, \`defineGlobal\`, and \`defineConfig\` from '@dyrected/core'.
+
+SUPPORTED FIELD TYPES:
+  Primitive  : text | textarea | richText | number | boolean | date | email | url | json
+  Choice     : select | multiSelect           (requires \`options: [{ label, value }]\`)
+  Structural : array | object                 (requires nested \`fields: [...]\`)
+  Relation   : relationship                   (requires \`collection: '<slug>'\`)
+  Media      : image                          (use a relationship to an upload collection)
+  Blocks     : blocks                         (requires \`blocks: [{ slug, labels, fields }]\`)
+
+COLLECTION OPTIONS:
+  \`upload: true\`   \u2014 turns this collection into a media library (file uploads)
+  \`auth: true\`     \u2014 adds login/register/me endpoints; password field is auto-added
+  \`admin.group\`    \u2014 groups this collection under a sidebar heading
+  \`admin.useAsTitle\` \u2014 field to use as the display title in the admin list view
+  \`admin.hidden\`   \u2014 hide from sidebar (useful for internal/system collections)
+
+FIELD OPTIONS:
+  \`required\`        \u2014 validation
+  \`unique\`          \u2014 database-level uniqueness
+  \`defaultValue\`    \u2014 fallback value
+  \`admin.condition\` \u2014 "expression" \u2014 Jexl string expression to show/hide field (e.g. "status == \\"published\\"")
+  \`admin.layout\`    \u2014 "radio" | "dropdown" \u2014 Visual layout for select/multiSelect
+  \`admin.direction\` \u2014 "vertical" | "horizontal" \u2014 Layout direction for radio groups
+  \`admin.readOnly\`  \u2014 display-only in the form
+  \`admin.hidden\`    \u2014 completely hidden from editor UI
+  \`access.read\`     \u2014 ({ user }) => boolean \u2014 field-level read access
+  \`access.update\`   \u2014 ({ user }) => boolean \u2014 field-level write access
+  \`hooks.beforeChange\` \u2014 [async (value) => newValue] \u2014 transform value before save
+  \`hooks.afterRead\`    \u2014 [async (value) => newValue] \u2014 transform value after read
+
+BLOCKS EXPLAINED:
+  A \`blocks\` field stores an ordered array of typed content blocks.
+  Each block has a \`blockType\` discriminator and its own set of fields.
+  The admin UI renders a drag-and-drop block editor automatically.
+  On the frontend, iterate the array and switch on \`block.blockType\`.
+
+COMPLETE EXAMPLE:
+\`\`\`typescript
+import { defineCollection, defineGlobal, defineConfig } from '@dyrected/core'
+
+// \u2500\u2500 Media \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500
+const media = defineCollection({
+  slug: 'media',
+  labels: { singular: 'Media Item', plural: 'Media' },
+  upload: true,
+  fields: [
+    { name: 'alt', type: 'text', label: 'Alt Text' },
+    { name: 'caption', type: 'textarea', label: 'Caption' },
+  ],
+})
+
+// \u2500\u2500 Authentication collection \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500
+const customers = defineCollection({
+  slug: 'customers',
+  labels: { singular: 'Customer', plural: 'Customers' },
+  auth: true,                  // adds /customers/login, /customers/me, etc.
+  admin: { group: 'Membership' },
+  fields: [
+    { name: 'name', type: 'text', required: true },
+    { name: 'email', type: 'email', required: true, unique: true },
+    // 'password' is auto-added when auth: true
+    { name: 'avatar', type: 'relationship', relationTo: 'media' },
+    { name: 'role', type: 'select', admin: { layout: 'radio' }, options: [
+        { label: 'Member', value: 'member' },
+        { label: 'VIP', value: 'vip' },
+    ]},
+  ],
+})
+
+// \u2500\u2500 Pages with blocks \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500
+const pages = defineCollection({
+  slug: 'pages',
+  labels: { singular: 'Page', plural: 'Pages' },
+  admin: { useAsTitle: 'title', group: 'Content' },
+  fields: [
+    { name: 'title', type: 'text', required: true },
+    { name: 'slug',  type: 'text', required: true, unique: true },
+    { name: 'seo', type: 'object', fields: [
+        { name: 'metaTitle',       type: 'text' },
+        { name: 'metaDescription', type: 'textarea' },
+        { name: 'ogImage',         type: 'relationship', relationTo: 'media' },
+    ]},
+    {
+      name: 'layout',
+      type: 'blocks',
+      label: 'Page Layout',
+      blocks: [
+        {
+          slug: 'hero',
+          labels: { singular: 'Hero', plural: 'Heroes' },
+          fields: [
+            { name: 'heading',    type: 'text',         required: true },
+            { name: 'subheading', type: 'textarea' },
+            { name: 'image',      type: 'relationship', relationTo: 'media' },
+            { name: 'ctaLabel',   type: 'text' },
+            { name: 'ctaLink',    type: 'url' },
+          ],
+        },
+        {
+          slug: 'richContent',
+          labels: { singular: 'Rich Content', plural: 'Rich Content Blocks' },
+          fields: [
+            { name: 'content', type: 'richText', required: true },
+          ],
+        },
+      ],
+    },
+  ],
+})
+
+export default defineConfig({
+  collections: [media, customers, pages],
+  admin: {
+    branding: {
+      primaryColor: '#4f46e5',
+      logo: '/logo.png',
+    }
+  }
+})
+\`\`\`
+
+${isSelfHosted ? "" : `
+\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501
+STEP 2 \u2014 CHOOSE YOUR MODE
+\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501
+The developer can choose between two modes:
+
+1. CLOUD MODE (Managed)
+   - Use the SITE CREDENTIALS above.
+   - Point baseUrl to ${config.baseUrl}.
+   - Content is stored in Dyrected Cloud.
+
+2. SELF-HOSTED MODE (Core)
+   - Do NOT use apiKey/siteId (unless for proxying).
+   - Use a database adapter like \`SqliteAdapter\` from '@dyrected/db-sqlite'.
+   - Content is stored locally in the developer's project.
+`}
+
+\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501
+STEP ${isSelfHosted ? "2" : "3"} \u2014 MOUNTING THE ADMIN UI
+\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501
+The Admin UI can be mounted on any path (e.g. /cms-admin).
+Pass the \`basename\` prop to the \`<AdminUI />\` component to match your route.
+
+\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501
+STEP ${isSelfHosted ? "3" : "4"} \u2014 FRONTEND IMPLEMENTATION
+\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501
+`;
+  const frameworks = {
+    next: `Install \`@dyrected/sdk\` (or \`@dyrected/next\` if you want Next.js server helpers).
+
+SDK CLIENT SETUP (\`lib/dyrected.ts\`):
+\`\`\`ts
+import { createClient } from '@dyrected/sdk'
+
+export const dyrected = createClient({
+  baseUrl: '${config.baseUrl || "http://localhost:3000"}',${isSelfHosted ? "" : `
+  apiKey:  '${config.apiKey}',
+  siteId:  '${config.siteId}',`}
+})
+\`\`\``,
+    nuxt: `Install \`@dyrected/nuxt\` and add it to \`nuxt.config.ts\`:
+\`\`\`ts
+export default defineNuxtConfig({
+  modules: ['@dyrected/nuxt'],
+  dyrected: {
+    baseUrl: '${config.baseUrl || "http://localhost:3000"}',${isSelfHosted ? "" : `
+    apiKey:  '${config.apiKey}',
+    siteId:  '${config.siteId}',`}
+  },
+})
+\`\`\`
+
+MOUNTING THE ADMIN DASHBOARD (\`pages/cms-admin.vue\`):
+\`\`\`vue
+<script setup lang="ts">
+definePageMeta({ layout: false })
+</script>
+
+<template>
+  <ClientOnly>
+    <DyrectedAdmin basename="/cms-admin" />
+  </ClientOnly>
+</template>
+\`\`\`
+`,
+    react: `Install \`@dyrected/sdk\`:
+
+CLIENT SETUP (\`lib/dyrected.ts\`):
+\`\`\`ts
+import { createClient } from '@dyrected/sdk'
+
+export const dyrected = createClient({
+  baseUrl: '${config.baseUrl || "https://api.dyrected.cloud"}',${isSelfHosted ? "" : `
+  apiKey:  '${config.apiKey}',
+  siteId:  '${config.siteId}',`}
+})
+\`\`\`
+
+MOUNTING THE ADMIN DASHBOARD (\`pages/admin.tsx\`):
+\`\`\`tsx
+import { AdminUI } from '@dyrected/admin'
+import '@dyrected/admin/styles'
+
+export default function AdminPage() {
+  return (
+    <div style={{ height: '100vh' }}>
+      <AdminUI 
+        apiKey='${config.apiKey}'
+        siteId='${config.siteId}'
+        baseUrl='${config.baseUrl || "https://api.dyrected.cloud"}'
+      />
+    </div>
+  )
+}
+\`\`\`
+`,
+    vue: `Install \`@dyrected/sdk\`:
+
+CLIENT SETUP (\`lib/dyrected.ts\`):
+\`\`\`ts
+import { createClient } from '@dyrected/sdk'
+
+export const dyrected = createClient({
+  baseUrl: '${config.baseUrl || "https://api.dyrected.cloud"}',${isSelfHosted ? "" : `
+  apiKey:  '${config.apiKey}',
+  siteId:  '${config.siteId}',`}
+})
+\`\`\`
+
+MOUNTING THE ADMIN DASHBOARD (\`pages/admin.vue\`):
+\`\`\`vue
+<template>
+  <div ref="container" style="height: 100vh" />
+</template>
+
+<script setup>
+import { ref, onMounted } from 'vue'
+import { renderAdminUI } from '@dyrected/admin'
+import '@dyrected/admin/styles'
+
+const container = ref(null)
+onMounted(() => {
+  renderAdminUI(container.value, {
+    apiKey: '${config.apiKey}',
+    siteId: '${config.siteId}',
+    baseUrl: '${config.baseUrl || "https://api.dyrected.cloud"}'
+  })
+})
+</script>
+\`\`\`
+`
+  };
+  return baseIntro + credentials + importantNotes + strategy + (frameworks[activeTab] || frameworks.next) + `
+
+  API Reference: ${config.baseUrl || "http://localhost:3000"}/api/docs`;
+}
+
+// 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] : []
+    ]
+  };
+}
+
+// src/index.ts
+function defineCollection(config) {
+  return config;
+}
+function defineGlobal(config) {
+  return config;
+}
+function defineConfig(config) {
+  return config;
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  defineCollection,
+  defineConfig,
+  defineGlobal,
+  generateAIPrompt,
+  normalizeConfig
+});

package/dist/index.d.cts

@@ -0,0 +1,33 @@
+import { D as DyrectedConfig, C as CollectionConfig, G as GlobalConfig } from './index-RylhgOwj.cjs';
+export { A as AccessFunction, a as AdminConfig, B as Block, b as DatabaseAdapter, F as Field, c as FieldHook, d as FieldType, e as FileData, H as HookFunction, I as ImageService, P as PaginatedResult, S as StorageAdapter, U as UploadConfig } from './index-RylhgOwj.cjs';
+
+interface SetupPromptConfig {
+    siteName?: string;
+    siteId?: string;
+    apiKey?: string;
+    baseUrl?: string;
+    isSelfHosted?: boolean;
+}
+declare function generateAIPrompt(activeTab: "next" | "nuxt" | "react" | "vue", config: SetupPromptConfig): string;
+
+/**
+ * Normalizes the Dyrected configuration by injecting system fields
+ * (createdAt, updatedAt, createdBy, updatedBy) into every collection and
+ * registering the __audit collection if any collection has audit: true.
+ */
+declare function normalizeConfig(config: DyrectedConfig): DyrectedConfig;
+
+/**
+ * Define a collection configuration with full type safety.
+ */
+declare function defineCollection(config: CollectionConfig): CollectionConfig;
+/**
+ * Define a global configuration with full type safety.
+ */
+declare function defineGlobal(config: GlobalConfig): GlobalConfig;
+/**
+ * Define the main Dyrected configuration.
+ */
+declare function defineConfig(config: DyrectedConfig): DyrectedConfig;
+
+export { CollectionConfig, DyrectedConfig, GlobalConfig, type SetupPromptConfig, defineCollection, defineConfig, defineGlobal, generateAIPrompt, normalizeConfig };