@easy-cms/core 0.9.1 → 0.11.0

package/README.md

@@ -1,6 +1,6 @@
 # @easy-cms/core
 
-Core of [Easy CMS](https://github.com/maritonx/easy-crm) — an embedded, code-first headless CMS for Nuxt and Next.js.
+Core of [Easy CMS](https://github.com/maritonx/easy-cms) — an embedded, code-first headless CMS for Nuxt and Next.js.
 
 > ⚠️ Pre-release. Not ready for production.
 

package/dist/index.d.ts

@@ -164,6 +164,11 @@ interface Database {
     /** Applies pending migrations in order. Returns the names applied. */
     migrate(): Promise<string[]>;
     migrationStatus(): Promise<MigrationInfo[]>;
+    /**
+     * Copies the database to `file` (an absolute path) while it is in use, when the database can
+     * do that itself (SQLite). Others (Postgres) leave it out; use their own tools.
+     */
+    readonly backup?: ((file: string) => Promise<void>) | undefined;
     destroy(): Promise<void>;
 }
 /** What `sqlite()` / `postgres()` return and what `config.db` holds. */
@@ -429,6 +434,8 @@ interface CollectionConfig {
         readonly singular?: Label;
         readonly plural?: Label;
     };
+    /** Icon in the admin menu. Default `file-text`. */
+    readonly icon?: AdminIcon;
     readonly fields: readonly Field[];
     /** Top-level field shown as the document title in the admin UI. */
     readonly useAsTitle?: string;
@@ -450,6 +457,8 @@ interface CollectionConfig {
 interface GlobalConfig {
     readonly slug: string;
     readonly label?: Label;
+    /** Icon in the admin menu. Default `settings`. */
+    readonly icon?: AdminIcon;
     readonly fields: readonly Field[];
     readonly drafts?: boolean;
     /** Keep a snapshot of every save. See `CollectionConfig.versions`. */
@@ -462,11 +471,25 @@ interface GlobalConfig {
     readonly hooks?: GlobalHooks;
 }
 type AdminLocale = 'en' | 'th';
+/** Icons a collection or global can show in the admin menu ([Lucide](https://lucide.dev) names). */
+declare const ADMIN_ICONS: readonly ["file-text", "newspaper", "book-open", "notebook", "folder", "tag", "tags", "image", "images", "video", "music", "file", "users", "user", "building", "store", "shopping-bag", "shopping-cart", "package", "box", "calendar", "calendar-days", "map-pin", "globe", "house", "layout-grid", "layers", "star", "heart", "message-square", "mail", "phone", "briefcase", "graduation-cap", "utensils", "car", "settings", "sliders-horizontal", "palette", "megaphone", "bell", "link", "quote", "circle-help", "award", "ticket", "camera"];
+type AdminIcon = (typeof ADMIN_ICONS)[number];
+/** Your or your client's brand in the admin UI. */
+interface AdminBrand {
+    /** Shown in the menu, on the login page and in the browser tab. Default "Easy CMS". */
+    readonly name?: string;
+    /** Logo URL: a path on your site (`/logo.svg`) or an `https://` address. */
+    readonly logo?: string;
+    /** Main color as `#rrggbb`; lighter and darker shades are derived from it. */
+    readonly color?: string;
+}
 interface AdminConfig {
     /** Where the admin UI is served. Default `/admin`. */
     readonly path?: string;
     /** Default admin UI language. Default `en`. */
     readonly locale?: AdminLocale;
+    /** Name, logo and color of the admin UI. */
+    readonly brand?: AdminBrand;
 }
 interface ImageSize {
     /** Key in `media.sizes`, e.g. `thumbnail`. */
@@ -1042,6 +1065,17 @@ declare class EasyCMS<C extends Config = Config> {
     private scheduleTarget;
     private globalScheduleTarget;
     private addJob;
+    /**
+     * The next pending jobs across all collections and globals, soonest first; with access
+     * enforced, only those the user may update.
+     */
+    upcomingJobs(options?: AccessOptions & {
+        limit?: number;
+    }): Promise<(ScheduledJob & {
+        collection?: string;
+        global?: string;
+        doc: ID;
+    })[]>;
     private pendingJobs;
     private removeJob;
     /** @internal */
@@ -1351,6 +1385,7 @@ interface AdminCollection {
         singular?: Label;
         plural?: Label;
     };
+    icon?: string;
     useAsTitle?: string;
     drafts: boolean;
     versions: boolean;
@@ -1369,6 +1404,7 @@ interface AdminCollection {
 interface AdminGlobal {
     slug: string;
     label?: Label;
+    icon?: string;
     drafts: boolean;
     versions: boolean;
     /** Has live preview (`preview` in the config). */
@@ -1420,4 +1456,4 @@ declare const BUILTIN_COLLECTIONS: readonly ["users", "media"];
 /** Checks a config and returns every problem found. An empty array means it is valid. */
 declare function validateConfig(config: Config): ConfigIssue[];
 
-export { type Access, type AccessArgs, type AccessOptions, type AdminCollection, type AdminConfig, type AdminField, type AdminGlobal, type AdminLocale, type AdminSchema, type AfterChangeHook, type AfterDeleteHook, type AfterReadHook, type ArrayField, Auth, type AuthConfig, type AuthUser, BUILTIN_COLLECTIONS, type BeforeChangeHook, type BeforeDeleteHook, type BeforeValidateHook, type Block, type BlocksField, type BooleanField, type BuiltinMediaCollection, type BuiltinUsersCollection, type BundleHints, CONFIG_FILE_NAMES, CSRF_COOKIE, CSRF_HEADER, type CollectionAccess, type CollectionConfig, type CollectionDocument, type CollectionHooks, type CollectionSlug, type Config, ConfigError, type ConfigIssue, type CreateEasyCMSOptions, type CreateInput, type CreateMigrationResult, DEFAULT_ADMIN_PATH, DEFAULT_API_PATH, DEFAULT_DEPTH, DEFAULT_MAX_FILE_SIZE, DEFAULT_MAX_VERSIONS, DEFAULT_TOKEN_EXPIRATION, type Database, type DatabaseAdapter, type DatabaseInitArgs, type DateField, type DepthOptions, EXTENSIONS, EasyCMS, EasyCMSError, type EmailField, FIELD_TYPES, type Field, type FieldAccess, type FieldAccessFn, type FieldError, type FieldType, type FieldValidate, type FieldValidateContext, type FieldValue, type FieldsInput, type FieldsValue, type FindArgs, type FindOptions, ForbiddenError, type GlobalAccess, type GlobalConfig, type GlobalDocument, type GlobalHooks, type GlobalInput, type GlobalSlug, type GroupField, type ID, INTERNAL_COLLECTIONS, type ImageSize, type InferCollection, type InferGlobal, type JsonField, type Label, type LivePreview, type LoadConfigOptions, type LocalStorageOptions, type LocalizationConfig, type Logger, type LoginArgs, MAX_DEPTH, MEDIA, MIN_PASSWORD_LENGTH, MIN_SECRET_LENGTH, type MediaDocument, type MediaSize, type MigrationInfo, NotFoundError, type NumberField, type Operation, type PaginatedDocs, PayloadTooLargeError, type Plugin, type PreviewTarget, type PreviewURL, QueryError, type RawDocument, type ReadOptions, type RelationshipField, type ResolvedConfig, type RestHandler, type RestHandlerOptions, type RichTextDocument, type RichTextField, type Role, type RoutesConfig, SESSION_COOKIE, type ScheduledJob, SchemaError, type SchemaMode, type SelectField, type SelectOption, type Session, type SlugField, type StorageAdapter, type StoredFile, type TextField, type TextareaField, TooManyRequestsError, UnauthorizedError, type UpdateInput, type UploadConfig, type UploadField, ValidationError, type Version, type VersionSummary, type VersionsConfig, WEBHOOK_EVENTS, type WebhookConfig, type WebhookEvent, type WebhookPayload, type Where, type WhereOperators, anyone, applyDefaults, consoleLogger, createEasyCMS, createRestHandler, defineConfig, fillMissing, findConfigFile, generateSlugs, generateTypes, hasRows, hashPassword, imageDimensions, importConfig, isAdmin, isLoggedIn, loadConfig, localStorage, mergeForUpdate, mimeAllowed, parseId, populate, readCookie, resolveConfig, rowFields, silentLogger, singularize, slugify, sniffMimeType, validateConfig, validateFields, verifyPassword };
+export { ADMIN_ICONS, type Access, type AccessArgs, type AccessOptions, type AdminBrand, type AdminCollection, type AdminConfig, type AdminField, type AdminGlobal, type AdminIcon, type AdminLocale, type AdminSchema, type AfterChangeHook, type AfterDeleteHook, type AfterReadHook, type ArrayField, Auth, type AuthConfig, type AuthUser, BUILTIN_COLLECTIONS, type BeforeChangeHook, type BeforeDeleteHook, type BeforeValidateHook, type Block, type BlocksField, type BooleanField, type BuiltinMediaCollection, type BuiltinUsersCollection, type BundleHints, CONFIG_FILE_NAMES, CSRF_COOKIE, CSRF_HEADER, type CollectionAccess, type CollectionConfig, type CollectionDocument, type CollectionHooks, type CollectionSlug, type Config, ConfigError, type ConfigIssue, type CreateEasyCMSOptions, type CreateInput, type CreateMigrationResult, DEFAULT_ADMIN_PATH, DEFAULT_API_PATH, DEFAULT_DEPTH, DEFAULT_MAX_FILE_SIZE, DEFAULT_MAX_VERSIONS, DEFAULT_TOKEN_EXPIRATION, type Database, type DatabaseAdapter, type DatabaseInitArgs, type DateField, type DepthOptions, EXTENSIONS, EasyCMS, EasyCMSError, type EmailField, FIELD_TYPES, type Field, type FieldAccess, type FieldAccessFn, type FieldError, type FieldType, type FieldValidate, type FieldValidateContext, type FieldValue, type FieldsInput, type FieldsValue, type FindArgs, type FindOptions, ForbiddenError, type GlobalAccess, type GlobalConfig, type GlobalDocument, type GlobalHooks, type GlobalInput, type GlobalSlug, type GroupField, type ID, INTERNAL_COLLECTIONS, type ImageSize, type InferCollection, type InferGlobal, type JsonField, type Label, type LivePreview, type LoadConfigOptions, type LocalStorageOptions, type LocalizationConfig, type Logger, type LoginArgs, MAX_DEPTH, MEDIA, MIN_PASSWORD_LENGTH, MIN_SECRET_LENGTH, type MediaDocument, type MediaSize, type MigrationInfo, NotFoundError, type NumberField, type Operation, type PaginatedDocs, PayloadTooLargeError, type Plugin, type PreviewTarget, type PreviewURL, QueryError, type RawDocument, type ReadOptions, type RelationshipField, type ResolvedConfig, type RestHandler, type RestHandlerOptions, type RichTextDocument, type RichTextField, type Role, type RoutesConfig, SESSION_COOKIE, type ScheduledJob, SchemaError, type SchemaMode, type SelectField, type SelectOption, type Session, type SlugField, type StorageAdapter, type StoredFile, type TextField, type TextareaField, TooManyRequestsError, UnauthorizedError, type UpdateInput, type UploadConfig, type UploadField, ValidationError, type Version, type VersionSummary, type VersionsConfig, WEBHOOK_EVENTS, type WebhookConfig, type WebhookEvent, type WebhookPayload, type Where, type WhereOperators, anyone, applyDefaults, consoleLogger, createEasyCMS, createRestHandler, defineConfig, fillMissing, findConfigFile, generateSlugs, generateTypes, hasRows, hashPassword, imageDimensions, importConfig, isAdmin, isLoggedIn, loadConfig, localStorage, mergeForUpdate, mimeAllowed, parseId, populate, readCookie, resolveConfig, rowFields, silentLogger, singularize, slugify, sniffMimeType, validateConfig, validateFields, verifyPassword };

package/dist/index.js

@@ -242,6 +242,7 @@ function withUsers(config) {
     slug: USERS,
     labels: { singular: { en: "User", th: "\u0E1C\u0E39\u0E49\u0E43\u0E0A\u0E49" }, plural: { en: "Users", th: "\u0E1C\u0E39\u0E49\u0E43\u0E0A\u0E49" } },
     useAsTitle: "email",
+    icon: "users",
     ...custom,
     fields: [...userFields(roles), ...custom?.fields ?? []],
     access: {
@@ -302,6 +303,7 @@ function withMedia(config) {
   const media = {
     slug: MEDIA,
     labels: { singular: { en: "Media", th: "\u0E2A\u0E37\u0E48\u0E2D" }, plural: { en: "Media", th: "\u0E04\u0E25\u0E31\u0E07\u0E2A\u0E37\u0E48\u0E2D" } },
+    icon: "image",
     useAsTitle: "filename",
     ...custom,
     fields: [...mediaFields(), ...custom?.fields ?? []],
@@ -695,6 +697,55 @@ var Auth = class {
 };
 
 // src/config.ts
+var ADMIN_ICONS = [
+  "file-text",
+  "newspaper",
+  "book-open",
+  "notebook",
+  "folder",
+  "tag",
+  "tags",
+  "image",
+  "images",
+  "video",
+  "music",
+  "file",
+  "users",
+  "user",
+  "building",
+  "store",
+  "shopping-bag",
+  "shopping-cart",
+  "package",
+  "box",
+  "calendar",
+  "calendar-days",
+  "map-pin",
+  "globe",
+  "house",
+  "layout-grid",
+  "layers",
+  "star",
+  "heart",
+  "message-square",
+  "mail",
+  "phone",
+  "briefcase",
+  "graduation-cap",
+  "utensils",
+  "car",
+  "settings",
+  "sliders-horizontal",
+  "palette",
+  "megaphone",
+  "bell",
+  "link",
+  "quote",
+  "circle-help",
+  "award",
+  "ticket",
+  "camera"
+];
 function defineConfig(config) {
   return config;
 }
@@ -1236,9 +1287,12 @@ function validateConfig(config) {
     const path = `collections.${collection2.slug ?? `[${i}]`}`;
     validateContainer(collection2, path, collectionSlugs, add);
     validateUseAsTitle(collection2, path, add);
+    validateIcon(collection2, path, add);
   });
   globals.forEach((global2, i) => {
-    validateContainer(global2, `globals.${global2.slug ?? `[${i}]`}`, collectionSlugs, add);
+    const path = `globals.${global2.slug ?? `[${i}]`}`;
+    validateContainer(global2, path, collectionSlugs, add);
+    validateIcon(global2, path, add);
   });
   const plugins = config.plugins;
   if (plugins !== void 0 && (!Array.isArray(plugins) || plugins.some((p) => typeof p !== "function"))) {
@@ -1267,6 +1321,31 @@ function validateAdmin(config, add) {
   if (admin.locale !== void 0 && admin.locale !== "en" && admin.locale !== "th") {
     add("admin.locale", `must be "en" or "th" (got ${JSON.stringify(admin.locale)})`);
   }
+  const brand = admin.brand;
+  if (brand === void 0) return;
+  if (typeof brand !== "object" || brand === null) {
+    add("admin.brand", "must be an object", "e.g. brand: { name: 'Acme', color: '#0f766e' }");
+    return;
+  }
+  const { name, logo, color } = brand;
+  if (name !== void 0 && (typeof name !== "string" || name.trim() === "")) {
+    add("admin.brand.name", "must be a non-empty string");
+  }
+  if (logo !== void 0 && (typeof logo !== "string" || !/^(\/|https?:\/\/|data:image\/)/.test(logo))) {
+    add(
+      "admin.brand.logo",
+      'must be a path starting with "/" or an http(s) URL',
+      "e.g. logo: '/logo.svg'"
+    );
+  }
+  if (color !== void 0 && (typeof color !== "string" || !/^#[0-9a-f]{6}$/i.test(color))) {
+    add("admin.brand.color", `must be a hex color like "#0f766e" (got ${JSON.stringify(color)})`);
+  }
+}
+function validateIcon(container, path, add) {
+  const icon = container.icon;
+  if (icon === void 0 || ADMIN_ICONS.includes(icon)) return;
+  add(`${path}.icon`, `unknown icon ${JSON.stringify(icon)}`, `one of: ${ADMIN_ICONS.join(", ")}`);
 }
 function validateAuth(config, add) {
   const auth = config.auth;
@@ -1665,7 +1744,8 @@ async function resolveConfig(input) {
     routes: { api: `/${(config.routes?.api ?? DEFAULT_API_PATH).replace(/^\/+|\/+$/g, "")}` },
     admin: {
       path: config.admin?.path ?? DEFAULT_ADMIN_PATH,
-      locale: config.admin?.locale ?? "en"
+      locale: config.admin?.locale ?? "en",
+      brand: config.admin?.brand ?? {}
     },
     upload: {
       dir: config.upload?.dir ?? "uploads",
@@ -3040,6 +3120,42 @@ var EasyCMS = class {
     });
     return toJob(row);
   }
+  /**
+   * The next pending jobs across all collections and globals, soonest first; with access
+   * enforced, only those the user may update.
+   */
+  async upcomingJobs(options = {}) {
+    if (!this.config.collections.some((c) => c.slug === SCHEDULED_JOBS)) return [];
+    const guard = guardOf(options);
+    const limit = options.limit ?? 10;
+    const rows = await this.db.find({
+      collection: SCHEDULED_JOBS,
+      where: { state: { equals: "pending" } },
+      sort: ["runAt"],
+      limit: limit * 5,
+      page: 1
+    });
+    const allowed2 = /* @__PURE__ */ new Map();
+    const may = async (parent) => {
+      if (!guard.enforce) return true;
+      const cached = allowed2.get(parent);
+      if (cached !== void 0) return cached;
+      const config = parent.startsWith("global:") ? this.config.globals.find((g) => g.slug === parent.slice("global:".length)) : this.config.collections.find((c) => c.slug === parent);
+      const access = config ? await evaluateAccess(config.access?.update, { user: guard.user }) : false;
+      const result = access !== false;
+      allowed2.set(parent, result);
+      return result;
+    };
+    const jobs = [];
+    for (const row of rows.docs) {
+      const parent = String(row.parent);
+      if (!await may(parent)) continue;
+      const target = parent.startsWith("global:") ? { global: parent.slice("global:".length) } : { collection: parent };
+      jobs.push({ ...toJob(row), ...target, doc: row.doc });
+      if (jobs.length === limit) break;
+    }
+    return jobs;
+  }
   async pendingJobs(parent, doc) {
     const rows = await this.db.find({
       collection: SCHEDULED_JOBS,
@@ -3601,6 +3717,7 @@ async function collection(config, user, localized) {
   };
   if (config.labels) result.labels = config.labels;
   if (config.useAsTitle) result.useAsTitle = config.useAsTitle;
+  if (config.icon) result.icon = config.icon;
   return result;
 }
 async function global(config, user, localized) {
@@ -3621,6 +3738,7 @@ async function global(config, user, localized) {
     }
   };
   if (config.label !== void 0) result.label = config.label;
+  if (config.icon) result.icon = config.icon;
   return result;
 }
 async function adminSchema(cms, user) {
@@ -3863,6 +3981,8 @@ async function route(cms, ctx, method, segments, options) {
     if (!ctx.user) throw new UnauthorizedError();
     if (second === "schema" && third === void 0)
       return { body: await adminSchema(cms, ctx.user) };
+    if (second === "scheduled" && third === void 0)
+      return { body: await cms.upcomingJobs({ user: ctx.user, overrideAccess: false }) };
     const [, , collection3, id2, extra] = segments;
     if (second === "access" && collection3 && id2 && extra === void 0) {
       if (INTERNAL_COLLECTIONS.has(collection3) || !cms.config.collections.some((c) => c.slug === collection3)) {
@@ -4392,6 +4512,7 @@ ${map(n.globals)}
   return parts.join("\n");
 }
 export {
+  ADMIN_ICONS,
   Auth,
   BUILTIN_COLLECTIONS,
   CONFIG_FILE_NAMES,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@easy-cms/core",
-  "version": "0.9.1",
+  "version": "0.11.0",
   "description": "Embedded, code-first headless CMS for Nuxt and Next.js",
   "license": "MIT",
   "type": "module",
@@ -30,7 +30,7 @@
   },
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/maritonx/easy-crm.git",
+    "url": "git+https://github.com/maritonx/easy-cms.git",
     "directory": "packages/core"
   },
   "keywords": [