@easy-cms/core 0.13.1 → 0.14.0

package/dist/index.d.ts

@@ -169,8 +169,29 @@ interface Database {
      * do that itself (SQLite). Others (Postgres) leave it out; use their own tools.
      */
     readonly backup?: ((file: string) => Promise<void>) | undefined;
+    /** Raw table access for copying a whole database to another (`easy-cms copy`). */
+    readonly transfer?: DatabaseTransfer | undefined;
     destroy(): Promise<void>;
 }
+/**
+ * Reads and writes stored rows as they are, ids and hidden fields included, bypassing validation
+ * and hooks. Only for moving a database: `copyDatabase()`.
+ */
+interface DatabaseTransfer {
+    /**
+     * Identifies the tables and columns the config produces, the same for every database kind.
+     * Two databases can be copied into each other when their hashes match.
+     */
+    readonly schemaHash: string;
+    /** Every table, in an order that is safe to write. */
+    tables(): string[];
+    count(table: string): Promise<number>;
+    /** Rows in a stable order (by primary key), `offset` and `limit` for batches. */
+    read(table: string, offset: number, limit: number): Promise<Record<string, unknown>[]>;
+    write(table: string, rows: readonly Record<string, unknown>[]): Promise<void>;
+    /** After all writes, e.g. moves id sequences past the copied ids so new documents fit. */
+    finish(): Promise<void>;
+}
 /** What `sqlite()` / `postgres()` return and what `config.db` holds. */
 interface DatabaseAdapter {
     readonly name: string;
@@ -1278,6 +1299,24 @@ declare const MEDIA = "media";
 /** Collections Easy CMS uses internally. Not exposed over REST or in the admin UI. */
 declare const INTERNAL_COLLECTIONS: ReadonlySet<string>;
 
+interface CopyProgress {
+    readonly table: string;
+    readonly rows: number;
+}
+interface CopyResult {
+    readonly tables: number;
+    readonly rows: number;
+}
+/**
+ * Copies every stored row from `source` into `target` (another kind of database is fine, e.g.
+ * SQLite to Postgres), keeping ids, so relationships, versions and users stay as they are.
+ * Both must come from the same collections and fields, and the target must be empty.
+ * Uploaded files are not copied: they stay in the storage they are in.
+ */
+declare function copyDatabase(source: Database, target: Database, options?: {
+    onTable?: (progress: CopyProgress) => void;
+}): Promise<CopyResult>;
+
 interface ConfigIssue {
     /** Where the problem is, e.g. `collections.posts.fields.slug.from`. */
     readonly path: string;
@@ -1577,4 +1616,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 { ADMIN_ICONS, type Access, type AccessArgs, type AccessOptions, type AdminBrand, type AdminCollection, type AdminComponent, type AdminComponentRef, 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 ContainerAdmin, 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, type Endpoint, type EndpointRequest, FIELD_TYPES, type Field, type FieldAccess, type FieldAccessFn, type FieldAdmin, 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, applyPlugins, consoleLogger, createEasyCMS, createRestHandler, defineConfig, fillMissing, findConfigFile, generateSlugs, generateTypes, hasRows, hashPassword, imageDimensions, importConfig, isAdmin, isLoggedIn, loadConfig, localStorage, mergeForUpdate, mimeAllowed, parseId, populate, readCookie, resolveAdminModule, resolveConfig, rowFields, silentLogger, singularize, slugify, sniffMimeType, validateConfig, validateFields, verifyPassword };
+export { ADMIN_ICONS, type Access, type AccessArgs, type AccessOptions, type AdminBrand, type AdminCollection, type AdminComponent, type AdminComponentRef, 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 ContainerAdmin, type CopyProgress, type CopyResult, 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 DatabaseTransfer, type DateField, type DepthOptions, EXTENSIONS, EasyCMS, EasyCMSError, type EmailField, type Endpoint, type EndpointRequest, FIELD_TYPES, type Field, type FieldAccess, type FieldAccessFn, type FieldAdmin, 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, applyPlugins, consoleLogger, copyDatabase, createEasyCMS, createRestHandler, defineConfig, fillMissing, findConfigFile, generateSlugs, generateTypes, hasRows, hashPassword, imageDimensions, importConfig, isAdmin, isLoggedIn, loadConfig, localStorage, mergeForUpdate, mimeAllowed, parseId, populate, readCookie, resolveAdminModule, resolveConfig, rowFields, silentLogger, singularize, slugify, sniffMimeType, validateConfig, validateFields, verifyPassword };

package/dist/index.js

@@ -750,6 +750,44 @@ function defineConfig(config) {
   return config;
 }
 
+// src/copy.ts
+var BATCH = 200;
+async function copyDatabase(source, target, options = {}) {
+  const from = source.transfer;
+  const to = target.transfer;
+  if (!from || !to) throw new EasyCMSError("This database adapter cannot copy databases", 400);
+  if (from.schemaHash !== to.schemaHash) {
+    throw new EasyCMSError(
+      "The two configs describe different collections or fields. Copy between configs with the same collections (import one config into the other and change only `db`).",
+      400
+    );
+  }
+  const tables = from.tables();
+  for (const table of tables) {
+    if (await to.count(table) > 0) {
+      throw new EasyCMSError(
+        `The target database is not empty ("${table}" has rows). Copy into a new, empty database.`,
+        400
+      );
+    }
+  }
+  let total = 0;
+  for (const table of tables) {
+    let copied = 0;
+    for (; ; ) {
+      const rows = await from.read(table, copied, BATCH);
+      if (rows.length === 0) break;
+      await to.write(table, rows);
+      copied += rows.length;
+      if (rows.length < BATCH) break;
+    }
+    total += copied;
+    options.onTable?.({ table, rows: copied });
+  }
+  await to.finish();
+  return { tables: tables.length, rows: total };
+}
+
 // src/document.ts
 import { randomUUID } from "crypto";
 var EMAIL_PATTERN = /^[^\s@]+@[^\s@]+\.[^\s@]+$/;
@@ -4814,6 +4852,7 @@ export {
   applyDefaults,
   applyPlugins,
   consoleLogger,
+  copyDatabase,
   createEasyCMS,
   createRestHandler,
   defineConfig,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@easy-cms/core",
-  "version": "0.13.1",
+  "version": "0.14.0",
   "description": "Embedded, code-first headless CMS for Nuxt and Next.js",
   "license": "MIT",
   "type": "module",