emdash 1.0.1 → 1.1.0

package/dist/validate-CfQ9_YlD.d.mts

@@ -0,0 +1,468 @@
+import { f as FieldType, n as CollectionAdminConfig, x as BlockFieldDefinition } from "./types-CLTQ9b_r.mjs";
+import { t as Database } from "./types-ifgOkcBa.mjs";
+import { d as Storage } from "./types-CQLvuXoZ.mjs";
+import { a as SiteSettings } from "./types-CPkQw2T2.mjs";
+import { Kysely } from "kysely";
+
+//#region src/seed/types.d.ts
+/**
+ * Root seed file structure
+ */
+interface SeedFile {
+  /** JSON schema reference (optional) */
+  $schema?: string;
+  /** Seed format version */
+  version: "1";
+  /**
+   * Default locale for locale-bearing rows (menus, taxonomies, content) that
+   * omit an explicit `locale`. Lets a non-`en` single-locale project survive an
+   * `export-seed` → `seed` round-trip: `apply` runs outside the Astro runtime
+   * (no i18n config), so without this it would backfill the omitted locale as
+   * `en`. See #1421.
+   */
+  defaultLocale?: string;
+  /** Metadata about the seed */
+  meta?: {
+    name?: string;
+    description?: string;
+    author?: string;
+  };
+  /** Site settings */
+  settings?: Partial<SiteSettings>;
+  /** Collection definitions */
+  collections?: SeedCollection[];
+  /** Database-owned block types, applied before collections that reference them. */
+  blockTypes?: SeedBlockType[];
+  /** Relations joining two collections, which reference fields bind to */
+  relations?: SeedRelation[];
+  /** Taxonomy definitions */
+  taxonomies?: SeedTaxonomy[];
+  /** Navigation menus */
+  menus?: SeedMenu[];
+  /** Redirect rules */
+  redirects?: SeedRedirect[];
+  /** Widget areas */
+  widgetAreas?: SeedWidgetArea[];
+  /** Sections (reusable content blocks, like WP patterns/reusable blocks) */
+  sections?: SeedSection[];
+  /** Bylines used for presentation credits */
+  bylines?: SeedByline[];
+  /** Sample content (organized by collection) */
+  content?: Record<string, SeedContentEntry[]>;
+}
+interface SeedBlockType {
+  slug: string;
+  label: string;
+  description?: string;
+  icon?: string;
+  category?: string;
+  currentVersion: number;
+  versions: Array<{
+    version: number;
+    fields: BlockFieldDefinition[];
+  }>;
+}
+/**
+ * Collection definition in seed
+ */
+interface SeedCollection {
+  slug: string;
+  label: string;
+  labelSingular?: string;
+  description?: string;
+  icon?: string;
+  admin?: CollectionAdminConfig;
+  supports?: ("drafts" | "revisions" | "preview" | "scheduling" | "search" | "seo")[];
+  urlPattern?: string;
+  /** Require a slug before an entry can be published. Defaults to true. */
+  routable?: boolean;
+  /**
+   * Omit this collection from the admin sidebar and the dashboard quick
+   * actions. It stays reachable through the API, MCP, plugin hooks, and
+   * direct `/content/:collection` URLs.
+   */
+  hidden?: boolean;
+  /**
+   * Explicit position in the admin sidebar (ascending). Collections without
+   * a `sortOrder` keep the alphabetical order and follow the ordered ones.
+   */
+  sortOrder?: number;
+  /** Admin sidebar folder shared with other collections of the same group. */
+  group?: string;
+  /** Enable comments on this collection */
+  commentsEnabled?: boolean;
+  /** Take an edit lock when an entry is opened (defaults to true) */
+  editLocking?: boolean;
+  /** Field slug powering the admin list Title column (defaults to title display) */
+  titleField?: string;
+  /** Field slug (a datetime field) powering the admin list Date column (defaults to last-updated) */
+  dateField?: string;
+  fields: SeedField[];
+}
+/**
+ * Relation definition in seed.
+ *
+ * A relation joins two collections and owns the link set a reference field
+ * views. Declaring it here names it — the slug is how a field addresses it — and
+ * lets a field on either collection bind to it. A reference field that names
+ * only a `targetCollection` gets a relation created for it instead, which stays
+ * the shorter path for a one-sided link.
+ *
+ * Labels are single-valued: a relation is schema, like a collection or a field,
+ * and carries no locale.
+ */
+interface SeedRelation {
+  slug: string;
+  parentCollection: string;
+  childCollection: string;
+  /** Names the parent's role, as seen from the child. */
+  parentLabel: string;
+  parentLabelSingular?: string;
+  /** Names the child's role, as seen from the parent. */
+  childLabel: string;
+  childLabelSingular?: string;
+  /** How many children one parent may link. Omitted or `null` is unlimited. */
+  maxChildrenPerParent?: number | null;
+  /** How many parents one child may link. Omitted or `null` is unlimited. */
+  maxParentsPerChild?: number | null;
+}
+/**
+ * Field definition in seed
+ */
+interface SeedField {
+  slug: string;
+  label: string;
+  type: FieldType;
+  required?: boolean;
+  unique?: boolean;
+  searchable?: boolean;
+  indexed?: boolean;
+  /** Whether the value is stored per locale (default true). `false` shares one value across translations. */
+  translatable?: boolean;
+  defaultValue?: unknown;
+  validation?: Record<string, unknown>;
+  widget?: string;
+  options?: Record<string, unknown>;
+}
+/**
+ * Taxonomy definition in seed. For multi-locale exports each locale variant
+ * is its own entry, linked via `translationOf` (referencing another entry's `id`).
+ */
+interface SeedTaxonomy {
+  /** Optional seed-local id, e.g. "tax:category:en". Target of `translationOf`. */
+  id?: string;
+  name: string;
+  label: string;
+  labelSingular?: string;
+  /** Required unless `translationOf` points at an entry with the same `name`, in which case it comes from the last entry of that same-name `translationOf` chain. Shared by every locale. */
+  hierarchical?: boolean;
+  /** Required unless `translationOf` points at an entry with the same `name`, in which case it comes from the last entry of that same-name `translationOf` chain. Shared by every locale. */
+  collections?: string[];
+  locale?: string;
+  translationOf?: string;
+  terms?: SeedTaxonomyTerm[];
+}
+/**
+ * Taxonomy term in seed
+ */
+interface SeedTaxonomyTerm {
+  /** Optional seed-local id, e.g. "term:category:news:en". */
+  id?: string;
+  slug: string;
+  label: string;
+  description?: string;
+  parent?: string;
+  locale?: string;
+  translationOf?: string;
+}
+/**
+ * Menu definition in seed
+ */
+interface SeedMenu {
+  /** Optional seed-local id, e.g. "menu:primary:en". */
+  id?: string;
+  name: string;
+  label: string;
+  locale?: string;
+  translationOf?: string;
+  items: SeedMenuItem[];
+}
+/**
+ * Menu item in seed
+ */
+interface SeedMenuItem {
+  /** Optional seed-local id, e.g. "item:primary:home:en". */
+  id?: string;
+  type: string;
+  label?: string;
+  url?: string;
+  ref?: string;
+  collection?: string;
+  target?: "_blank" | "_self";
+  titleAttr?: string;
+  cssClasses?: string;
+  locale?: string;
+  translationOf?: string;
+  children?: SeedMenuItem[];
+}
+/**
+ * Redirect definition in seed
+ */
+interface SeedRedirect {
+  source: string;
+  destination: string;
+  type?: 301 | 302 | 307 | 308;
+  enabled?: boolean;
+  groupName?: string | null;
+}
+/**
+ * Widget area definition in seed
+ */
+interface SeedWidgetArea {
+  name: string;
+  label: string;
+  description?: string;
+  widgets: SeedWidget[];
+}
+/**
+ * Widget in seed
+ */
+interface SeedWidget {
+  type: "content" | "menu" | "component";
+  title?: string;
+  content?: Array<{
+    _type: string;
+    _key?: string;
+    [key: string]: unknown;
+  }>;
+  menuName?: string;
+  componentId?: string;
+  props?: Record<string, unknown>;
+}
+/**
+ * Section (reusable content block) in seed
+ */
+interface SeedSection {
+  slug: string;
+  title: string;
+  description?: string;
+  /** Search keywords */
+  keywords?: string[];
+  /** Portable Text content */
+  content: Array<{
+    _type: string;
+    _key?: string;
+    [key: string]: unknown;
+  }>;
+  /** Source: "theme" for seed-provided (the default), "user" for editor-created, "import" for WP imports */
+  source?: "theme" | "user" | "import";
+}
+/**
+ * Byline profile in seed
+ */
+interface SeedByline {
+  /** Seed-local ID for byline references in content entries */
+  id: string;
+  slug: string;
+  displayName: string;
+  bio?: string;
+  websiteUrl?: string;
+  isGuest?: boolean;
+  /**
+   * Avatar for the byline, seeded as an already-stored media item. Unlike a
+   * content `$media` reference, nothing is downloaded: the caller supplies the
+   * `storageKey` of a file that already exists in the configured storage (the
+   * common case when seeding alongside a media migration). A `media` row is
+   * created and linked via `avatarMediaId`.
+   */
+  avatar?: SeedBylineAvatar;
+}
+interface SeedBylineAvatar {
+  /** Storage key of an avatar file that already exists in the configured storage. */
+  storageKey: string;
+  /** Alt text for the avatar image. */
+  alt?: string;
+  /** Filename for the media record. Defaults to the storage key's basename. */
+  filename?: string;
+  /** MIME type for the media record. Defaults to `image/jpeg`. */
+  mimeType?: string;
+  width?: number;
+  height?: number;
+}
+/**
+ * Content entry in seed
+ */
+interface SeedContentEntry {
+  /** Seed-local ID for $ref resolution */
+  id: string;
+  /** URL slug. May be omitted for entries in non-routable collections. */
+  slug?: string | null;
+  /** Publication status */
+  status?: "published" | "draft";
+  /** Content data (field slug -> value) */
+  data: Record<string, unknown>;
+  /** Taxonomy term assignments (taxonomy name -> term slugs) */
+  taxonomies?: Record<string, string[]>;
+  /** Ordered byline credits for this entry */
+  bylines?: SeedBylineCredit[];
+  /** BCP 47 locale code. When omitted, defaults to defaultLocale. */
+  locale?: string;
+  /**
+   * Seed-local ID of the source content entry this translates.
+   * Must reference another entry's `id` in the same collection.
+   */
+  translationOf?: string;
+}
+interface SeedBylineCredit {
+  /** Seed byline ID from root `bylines[]` */
+  byline: string;
+  roleLabel?: string;
+}
+/**
+ * Options for applying a seed
+ */
+interface SeedApplyOptions {
+  /**
+   * Include sample data: content entries, bylines, and taxonomy terms
+   * (default: false). Schema and structure (collections, fields, taxonomy
+   * definitions, menus, settings, redirects, widget areas, sections) are
+   * always applied.
+   */
+  includeContent?: boolean;
+  /**
+   * How to handle conflicts (default: "skip"). Site settings are processed
+   * per key: "skip" creates only missing keys, "update" overwrites supplied
+   * keys, and "error" stops at the first existing key without rolling back
+   * keys created earlier in the seed.
+   */
+  onConflict?: "skip" | "update" | "error";
+  /** Base path for local media files (for $media.file resolution) */
+  mediaBasePath?: string;
+  /**
+   * Storage adapter for media uploads.
+   * Required if seed contains $media references with URLs.
+   */
+  storage?: Storage;
+  /**
+   * Skip downloading and storing media for $media references.
+   *
+   * When true, $media references are resolved to a MediaValue
+   * that uses the original external URL directly as the `src`,
+   * with provider set to "external". No storage adapter is needed.
+   *
+   * Useful for playground/demo environments where media storage
+   * is unavailable or undesirable.
+   */
+  skipMediaDownload?: boolean;
+}
+/**
+ * Result of applying a seed
+ */
+interface SeedApplyResult {
+  blockTypes: {
+    created: number;
+    skipped: number;
+    updated: number;
+  };
+  collections: {
+    created: number;
+    skipped: number;
+    updated: number;
+  };
+  fields: {
+    created: number;
+    skipped: number;
+    updated: number;
+  };
+  relations: {
+    created: number;
+    skipped: number;
+    updated: number;
+  };
+  taxonomies: {
+    created: number;
+    skipped: number;
+    terms: number;
+  };
+  bylines: {
+    created: number;
+    skipped: number;
+    updated: number;
+  };
+  menus: {
+    created: number;
+    items: number;
+  };
+  redirects: {
+    created: number;
+    skipped: number;
+    updated: number;
+  };
+  widgetAreas: {
+    created: number;
+    widgets: number;
+  };
+  sections: {
+    created: number;
+    skipped: number;
+    updated: number;
+  };
+  settings: {
+    applied: number;
+  };
+  content: {
+    created: number;
+    skipped: number;
+    updated: number;
+  };
+  media: {
+    created: number;
+    skipped: number;
+  };
+}
+/**
+ * Validation result
+ */
+interface ValidationResult {
+  valid: boolean;
+  errors: string[];
+  warnings: string[];
+}
+//#endregion
+//#region src/seed/apply.d.ts
+/**
+ * Apply a seed file to the database
+ *
+ * This function is idempotent - safe to run multiple times.
+ *
+ * @param db - Kysely database instance
+ * @param seed - Seed file to apply
+ * @param options - Application options
+ * @returns Result summary
+ */
+declare function applySeed(db: Kysely<Database>, seed: SeedFile, options?: SeedApplyOptions): Promise<SeedApplyResult>;
+//#endregion
+//#region src/seed/default.d.ts
+declare const defaultSeed: SeedFile;
+//#endregion
+//#region src/seed/load.d.ts
+/**
+ * Load the seed file (user seed or default).
+ */
+declare function loadSeed(): Promise<SeedFile>;
+/**
+ * Load the user's seed file, or null if none exists.
+ */
+declare function loadUserSeed(): Promise<SeedFile | null>;
+//#endregion
+//#region src/seed/validate.d.ts
+/**
+ * Validate a seed file
+ *
+ * @param data - Unknown data to validate as a seed file
+ * @returns Validation result with errors and warnings
+ */
+declare function validateSeed(data: unknown): ValidationResult;
+//#endregion
+export { SeedTaxonomyTerm as _, applySeed as a, ValidationResult as b, SeedCollection as c, SeedFile as d, SeedMenu as f, SeedTaxonomy as g, SeedSection as h, defaultSeed as i, SeedContentEntry as l, SeedRedirect as m, loadSeed as n, SeedApplyOptions as o, SeedMenuItem as p, loadUserSeed as r, SeedApplyResult as s, validateSeed as t, SeedField as u, SeedWidget as v, SeedWidgetArea as y };
+//# sourceMappingURL=validate-CfQ9_YlD.d.mts.map

package/dist/validate-CfQ9_YlD.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"validate-CfQ9_YlD.d.mts","names":[],"sources":["../src/seed/types.ts","../src/seed/apply.ts","../src/seed/default.ts","../src/seed/load.ts","../src/seed/validate.ts"],"mappings":";;;;;;;;;;UAeiB,QAAA;EAiCJ;EA/BZ,OAAA;EAqCQ;EAlCR,OAAA;EAwCc;;;;;;;EA/Bd,aAAA;EATA;EAYA,IAAA;IACC,IAAA;IACA,WAAA;IACA,MAAA;EAAA;EAID;EAAA,QAAA,GAAW,OAAA,CAAQ,YAAA;EAAA;EAGnB,WAAA,GAAc,cAAA;EAAA;EAGd,UAAA,GAAa,aAAA;EAAA;EAGb,SAAA,GAAY,YAAA;EAAA;EAGZ,UAAA,GAAa,YAAA;EAAA;EAGb,KAAA,GAAQ,QAAA;EAAA;EAGR,SAAA,GAAY,YAAA;EAAA;EAGZ,WAAA,GAAc,cAAA;EAAA;EAGd,QAAA,GAAW,WAAA;EAAA;EAGX,OAAA,GAAU,UAAA;EAAA;EAGV,OAAA,GAAU,MAAA,SAAe,gBAAA;AAAA;AAAA,UAGT,aAAA;EAChB,IAAA;EACA,KAAA;EACA,WAAA;EACA,IAAA;EACA,QAAA;EACA,cAAA;EACA,QAAA,EAAU,KAAA;IACT,OAAA;IACA,MAAA,EAAQ,oBAAA;EAAA;AAAA;;;;UAOO,cAAA;EAChB,IAAA;EACA,KAAA;EACA,aAAA;EACA,WAAA;EACA,IAAA;EACA,KAAA,GAAQ,qBAAA;EACR,QAAA;EACA,UAAA;EAPA;EASA,QAAA;EAPA;;;;;EAaA,MAAA;EARA;;;;EAaA,SAAA;EAIA;EAFA,KAAA;EAMA;EAJA,eAAA;EAOA;EALA,WAAA;EAKiB;EAHjB,UAAA;EAkBgB;EAhBhB,SAAA;EACA,MAAA,EAAQ,SAAA;AAAA;;;;;;;;;;;;AAkCT;UAnBiB,YAAA;EAChB,IAAA;EACA,gBAAA;EACA,eAAA;EA6BU;EA3BV,WAAA;EACA,mBAAA;EAcA;EAZA,UAAA;EACA,kBAAA;EAaM;EAXN,oBAAA;EAaA;EAXA,kBAAA;AAAA;;;;UAMgB,SAAA;EAChB,IAAA;EACA,KAAA;EACA,IAAA,EAAM,SAAA;EACN,QAAA;EACA,MAAA;EACA,UAAA;EACA,OAAA;;EAEA,YAAA;EACA,YAAA;EACA,UAAA,GAAa,MAAA;EACb,MAAA;EACA,OAAA,GAAU,MAAA;AAAA;;;;;UAOM,YAAA;EAYQ;EAVxB,EAAA;EACA,IAAA;EACA,KAAA;EACA,aAAA;EAagC;EAXhC,YAAA;EAcA;EAZA,WAAA;EACA,MAAA;EACA,aAAA;EACA,KAAA,GAAQ,gBAAA;AAAA;;;AAoBT;UAdiB,gBAAA;;EAEhB,EAAA;EACA,IAAA;EACA,KAAA;EACA,WAAA;EACA,MAAA;EACA,MAAA;EACA,aAAA;AAAA;;;AAmBD;UAbiB,QAAA;;EAEhB,EAAA;EACA,IAAA;EACA,KAAA;EACA,MAAA;EACA,aAAA;EACA,KAAA,EAAO,YAAA;AAAA;;;;UAMS,YAAA;EAYhB;EAVA,EAAA;EACA,IAAA;EACA,KAAA;EACA,GAAA;EACA,GAAA;EACA,UAAA;EACA,MAAA;EACA,SAAA;EACA,UAAA;EACA,MAAA;EACA,aAAA;EACA,QAAA,GAAW,YAAA;AAAA;;;AAiBZ;UAXiB,YAAA;EAChB,MAAA;EACA,WAAA;EACA,IAAA;EACA,OAAA;EACA,SAAA;AAAA;;;;UAMgB,cAAA;EAChB,IAAA;EACA,KAAA;EACA,WAAA;EACA,OAAA,EAAS,UAAA;AAAA;;;;UAMO,UAAA;EAChB,IAAA;EACA,KAAA;EAGA,OAAA,GAAU,KAAA;IAAQ,KAAA;IAAe,IAAA;IAAA,CAAgB,GAAA;EAAA;EAGjD,QAAA;EAGA,WAAA;EACA,KAAA,GAAQ,MAAA;AAAA;;;;UAMQ,WAAA;EAChB,IAAA;EACA,KAAA;EACA,WAAA;EAIgC;EAFhC,QAAA;EAIA;EAFA,OAAA,EAAS,KAAA;IAAQ,KAAA;IAAe,IAAA;IAAA,CAAgB,GAAA;EAAA;EAuBvB;EArBzB,MAAA;AAAA;;;;UAMgB,UAAA;EAehB;EAbA,EAAA;EACA,IAAA;EACA,WAAA;EACA,GAAA;EACA,UAAA;EACA,OAAA;EAWgC;;;;;;;EAHhC,MAAA,GAAS,gBAAA;AAAA;AAAA,UAGO,gBAAA;EAgBgB;EAdhC,UAAA;EAyBM;EAvBN,GAAA;EA6BU;EA3BV,QAAA;EA2B0B;EAzB1B,QAAA;EACA,KAAA;EACA,MAAA;AAAA;;;;UAMgB,gBAAA;EAiBN;EAfV,EAAA;EAwBA;EArBA,IAAA;EAqBa;EAlBb,MAAA;EAqBgC;EAlBhC,IAAA,EAAM,MAAA;EAoBN;EAjBA,UAAA,GAAa,MAAA;EAwBG;EArBhB,OAAA,GAAU,gBAAA;;EAGV,MAAA;EAyBA;;;;EAnBA,aAAA;AAAA;AAAA,UAGgB,gBAAA;EA6CC;EA3CjB,MAAA;EACA,SAAA;AAAA;;;;UAMgB,gBAAA;EA2CgC;;;;;;EApChD,cAAA;EAsC2B;;;;;;EA9B3B,UAAA;EAgCc;EA7Bd,aAAA;EA6BgD;;;;EAvBhD,OAAA,GAAU,OAAA;EAyBV;;;;;;;;;;EAbA,iBAAA;AAAA;;;;UAMgB,eAAA;EAChB,UAAA;IAAc,OAAA;IAAiB,OAAA;IAAiB,OAAA;EAAA;EAChD,WAAA;IAAe,OAAA;IAAiB,OAAA;IAAiB,OAAA;EAAA;EACjD,MAAA;IAAU,OAAA;IAAiB,OAAA;IAAiB,OAAA;EAAA;EAC5C,SAAA;IAAa,OAAA;IAAiB,OAAA;IAAiB,OAAA;EAAA;EAC/C,UAAA;IAAc,OAAA;IAAiB,OAAA;IAAiB,KAAA;EAAA;EAChD,OAAA;IAAW,OAAA;IAAiB,OAAA;IAAiB,OAAA;EAAA;EAC7C,KAAA;IAAS,OAAA;IAAiB,KAAA;EAAA;EAC1B,SAAA;IAAa,OAAA;IAAiB,OAAA;IAAiB,OAAA;EAAA;EAC/C,WAAA;IAAe,OAAA;IAAiB,OAAA;EAAA;EAChC,QAAA;IAAY,OAAA;IAAiB,OAAA;IAAiB,OAAA;EAAA;EAC9C,QAAA;IAAY,OAAA;EAAA;EACZ,OAAA;IAAW,OAAA;IAAiB,OAAA;IAAiB,OAAA;EAAA;EAC7C,KAAA;IAAS,OAAA;IAAiB,OAAA;EAAA;AAAA;;;;UAMV,gBAAA;EAChB,KAAA;EACA,MAAA;EACA,QAAA;AAAA;;;;;;;;;;;;;iBC/PqB,SAAA,CACrB,EAAA,EAAI,MAAA,CAAO,QAAA,GACX,IAAA,EAAM,QAAA,EACN,OAAA,GAAS,gBAAA,GACP,OAAA,CAAQ,eAAA;;;cCxKE,WAAA,EAAa,QAAA;;;;;;iBCcJ,QAAA,CAAA,GAAY,OAAA,CAAQ,QAAA;;;;iBAQpB,YAAA,CAAA,GAAgB,OAAA,CAAQ,QAAA;;;;;;;;;iBCsD9B,YAAA,CAAa,IAAA,YAAgB,gBAAA"}