emdash 1.1.0 → 1.2.0

package/dist/types-Ff85fTzU.d.mts

@@ -0,0 +1,289 @@
+import { r as ContentFieldFilters } from "./content-list-query-Bxxdd9fv.mjs";
+import { l as CustomFieldValue } from "./types-BiHcpUoO.mjs";
+
+//#region src/database/repositories/types.d.ts
+interface CreateContentInput {
+  /** Explicit content ID for stable seed imports. Omit to generate a ULID. */
+  id?: string;
+  type: string;
+  slug?: string | null;
+  data: Record<string, unknown>;
+  status?: string;
+  authorId?: string;
+  primaryBylineId?: string | null;
+  locale?: string;
+  translationOf?: string;
+  /** Field columns selected atomically from `translationOf` during the insert. */
+  inheritFields?: string[];
+  publishedAt?: string | null;
+  /** Override created_at (ISO 8601). Used by importers to preserve original dates. */
+  createdAt?: string | null;
+}
+interface UpdateContentInput {
+  data?: Record<string, unknown>;
+  status?: string;
+  slug?: string | null;
+  publishedAt?: string | null;
+  scheduledAt?: string | null;
+  /** Entry owner (`ec_{collection}.author_id`). */
+  authorId?: string | null;
+  /** Revision author, separate from entry ownership. */
+  revisionAuthorId?: string | null;
+  primaryBylineId?: string | null;
+}
+/** SEO fields for content items */
+interface ContentSeo {
+  title: string | null;
+  description: string | null;
+  image: string | null;
+  canonical: string | null;
+  noIndex: boolean;
+}
+/** Input for updating SEO fields on content */
+interface ContentSeoInput {
+  title?: string | null;
+  description?: string | null;
+  image?: string | null;
+  canonical?: string | null;
+  noIndex?: boolean;
+}
+interface BylineSummary {
+  id: string;
+  slug: string;
+  displayName: string;
+  bio: string | null;
+  avatarMediaId: string | null;
+  /**
+   * The avatar media's storage key, folded in by a LEFT JOIN on the
+   * `media` table. Populated by the content-credit hydration path
+   * (`getContentBylines` / `getContentBylinesMany`, i.e. the
+   * `entry.data.bylines` populated by `getEmDashCollection` /
+   * `getEmDashEntry`) and by the single-row finders (`findById`,
+   * `findBySlug`, `findByUserId`, `findByUserIds`). `findMany` doesn't
+   * join media, so it leaves this null.
+   *
+   * Lets a page build a direct storage URL for an author avatar without a
+   * per-byline `MediaRepository.findById`, avoiding an N+1 when many distinct
+   * authors appear on one page.
+   *
+   * Optional so adding it is a non-breaking change for existing code that
+   * constructs a `BylineSummary` literal; the repositories always populate it
+   * (to `null` when there's no avatar or no media join).
+   */
+  avatarStorageKey?: string | null;
+  /** Avatar media alt text, from the same media join. Null when not joined. */
+  avatarAlt?: string | null;
+  /**
+   * Avatar media blurhash (LQIP placeholder, migration 024), folded in by the
+   * same media join as `avatarStorageKey`. Lets a renderer paint a blurred
+   * placeholder while the full avatar loads, with no extra media lookup.
+   * Null when the byline has no avatar, the media row has no blurhash, or the
+   * byline came from `findMany`, which doesn't join media.
+   */
+  avatarBlurhash?: string | null;
+  /**
+   * Avatar media dominant colour (LQIP placeholder, migration 024), from the
+   * same media join. Null under the same conditions as `avatarBlurhash`.
+   */
+  avatarDominantColor?: string | null;
+  websiteUrl: string | null;
+  userId: string | null;
+  isGuest: boolean;
+  createdAt: string;
+  updatedAt: string;
+  /**
+   * Locale this byline row is presented in. Added by migration 040.
+   * `(slug, locale)` is unique; a single slug can repeat across locales.
+   */
+  locale: string;
+  /**
+   * Shared across translations of the same byline. Added by migration 040.
+   * `_emdash_content_bylines.byline_id` and `ec_*.primary_byline_id` store
+   * this value, so a credit spans every locale variant of a byline.
+   * Nullable in storage for backwards compatibility; new rows always
+   * populate it.
+   */
+  translationGroup: string | null;
+  /**
+   * Custom field values registered via the byline-fields schema (migration
+   * 041, Discussion #1174). Optional in the TypeScript shape so existing
+   * object-literal consumers (test fixtures, plugin renderers) stay
+   * source-compatible; the runtime always returns `{}` when no fields are
+   * registered. Translatable values reflect this row's locale; non-
+   * translatable values are shared across every locale variant of the
+   * byline's `translation_group`.
+   */
+  customFields?: Record<string, CustomFieldValue>;
+}
+interface ContentBylineCredit {
+  byline: BylineSummary;
+  sortOrder: number;
+  roleLabel: string | null;
+  /** Whether this credit was explicitly assigned or inferred from authorId */
+  source?: "explicit" | "inferred";
+}
+/** A whitelisted timestamp column a content-list date range can filter on. */
+type ContentDateField = "createdAt" | "updatedAt" | "publishedAt";
+/**
+ * Inclusive date-range filter for a single whitelisted timestamp column.
+ * Bounds are compared lexicographically against the stored ISO 8601 strings,
+ * which is correct because every timestamp is written via `toISOString()`.
+ * Callers wanting an inclusive upper bound should pass an end-of-day value
+ * (e.g. `2024-12-31T23:59:59.999Z`); the repository does not widen `to`.
+ */
+interface ContentDateFilter {
+  field: ContentDateField;
+  from?: string;
+  to?: string;
+}
+/**
+ * Byline filter for a content list.
+ *
+ * `mode: "any"` matches entries credited to at least one of `bylineIds`;
+ * `mode: "none"` matches entries with no credit at all.
+ *
+ * `bylineIds` are `translation_group` values — what
+ * `_emdash_content_bylines.byline_id` stores since migration 040 — so a filter
+ * matches a byline across every locale variant.
+ *
+ * By default only explicit credits count. `includeInferred` widens the filter
+ * to the byline the list actually renders, which for an entry with no credits
+ * is the one linked to its `author_id` (see `hydrateBylinesMany`).
+ */
+interface ContentBylineFilter {
+  mode: "any" | "none";
+  /** Ignored when `mode` is `"none"`. An empty list matches nothing. */
+  bylineIds?: string[];
+  includeInferred?: boolean;
+  /**
+   * Locale a credit has to resolve at — the locale the list is scoped to.
+   * Applies to explicit credits as well as inferred ones, since a byline
+   * group credited to an entry renders only where it has a row at that
+   * locale. Defaults to each entry's own locale when the list spans locales.
+   */
+  locale?: string;
+}
+interface FindManyOptions {
+  where?: {
+    status?: string;
+    authorId?: string;
+    locale?: string; /** Case-insensitive substring to match against `searchColumns`. */
+    q?: string;
+    /**
+     * Columns the `q` substring filter is applied to (OR'd together).
+     * Resolved by the handler from the collection's display fields, slug,
+     * and any field marked searchable. Each name is validated as a SQL
+     * identifier.
+     */
+    searchColumns?: string[];
+    /**
+     * Serve `q` from the collection's FTS5 index (`_emdash_fts_<slug>`)
+     * instead of an unindexable substring LIKE. Set by the handler only
+     * when the collection has search enabled and the index exists
+     * (SQLite only). The repository combines a token-prefix MATCH with
+     * an index-served slug prefix so slug lookups keep working.
+     */
+    useFts?: boolean; /** Inclusive date range over a whitelisted timestamp column. */
+    dateFilter?: ContentDateFilter; /** Restrict to entries by their byline credits. */
+    bylineFilter?: ContentBylineFilter; /** AND-combined filters over custom fields explicitly marked as indexed. */
+    fieldFilters?: ContentFieldFilters;
+  };
+  orderBy?: {
+    field: string;
+    direction: "asc" | "desc";
+  };
+  /**
+   * Extra field slugs allowed as `orderBy` beyond the system columns — the
+   * collection's configured titleField/dateField. Resolved by the
+   * handler server-side so `orderBy` stays a closed set per request.
+   */
+  sortableExtras?: string[];
+  limit?: number;
+  cursor?: string;
+  /** Rows to skip before the page, for numbered pages. Cannot be combined with `cursor`. */
+  offset?: number;
+}
+interface FindManyResult<T> {
+  items: T[];
+  nextCursor?: string;
+  /**
+   * Total number of rows matching the where clause (ignoring pagination).
+   * Optional because not every caller needs it; repositories that compute
+   * it should set it so the UI can render a stable pagination denominator.
+   */
+  total?: number;
+}
+/**
+ * Thrown when a pagination cursor cannot be decoded.
+ *
+ * Repository callers should let this propagate; handler catch blocks
+ * map it to a structured `INVALID_CURSOR` error so client pagination
+ * bugs surface immediately rather than silently re-fetching the first
+ * page.
+ */
+declare class InvalidCursorError extends Error {
+  constructor(cursor: string);
+}
+interface ContentItem {
+  id: string;
+  type: string;
+  slug: string | null;
+  status: string;
+  data: Record<string, unknown>;
+  authorId: string | null;
+  primaryBylineId: string | null;
+  byline?: BylineSummary | null;
+  bylines?: ContentBylineCredit[];
+  createdAt: string;
+  updatedAt: string;
+  publishedAt: string | null;
+  scheduledAt: string | null;
+  liveRevisionId: string | null;
+  draftRevisionId: string | null;
+  version: number;
+  locale: string | null;
+  translationGroup: string | null;
+  /** SEO metadata — only populated for collections with `has_seo` enabled */
+  seo?: ContentSeo;
+  /**
+   * For collections that support `revisions`: when a draft revision exists,
+   * `data` reflects the unsaved draft and `liveData` carries the currently-
+   * published values. When no draft exists, `liveData` is undefined.
+   *
+   * Hydrated by `EmDashRuntime.hydrateDraftData()` — repositories themselves
+   * never set this field; it's purely a runtime-overlay concept that gives
+   * agents a clear picture of "draft vs. live" without re-fetching the
+   * revision history.
+   */
+  liveData?: Record<string, unknown>;
+  /**
+   * First page of each reference field's resolved selection, keyed by field
+   * slug. Only populated when the caller opts in via `handleContentGet`'s
+   * `referenceOptions` param (see content.ts) — hydration is never
+   * unconditional because it can leak draft ids/slugs to callers without
+   * `content:read_drafts`.
+   *
+   * Shape mirrors `EntryRef` from `api/handlers/relations.ts`, duplicated
+   * here (rather than imported) so the database layer doesn't depend on
+   * the api/handlers layer.
+   */
+  references?: Record<string, {
+    children: Array<{
+      id: string;
+      slug: string | null;
+      collection: string;
+      title: string | null;
+      locale: string | null;
+      translationGroup: string | null;
+      sortOrder?: number;
+    }>;
+    nextCursor?: string;
+  }>;
+}
+declare class EmDashValidationError extends Error {
+  details?: unknown | undefined;
+  constructor(message: string, details?: unknown | undefined);
+}
+//#endregion
+export { ContentSeo as a, EmDashValidationError as c, InvalidCursorError as d, UpdateContentInput as f, ContentItem as i, FindManyOptions as l, ContentBylineCredit as n, ContentSeoInput as o, ContentDateField as r, CreateContentInput as s, BylineSummary as t, FindManyResult as u };
+//# sourceMappingURL=types-Ff85fTzU.d.mts.map

package/dist/types-Ff85fTzU.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types-Ff85fTzU.d.mts","names":[],"sources":["../src/database/repositories/types.ts"],"mappings":";;;;UAciB,kBAAA;;EAEhB,EAAA;EACA,IAAA;EACA,IAAA;EACA,IAAA,EAAM,MAAA;EACN,MAAA;EACA,QAAA;EACA,eAAA;EACA,MAAA;EACA,aAAA;EAJA;EAMA,aAAA;EACA,WAAA;EAJA;EAMA,SAAA;AAAA;AAAA,UAGgB,kBAAA;EAChB,IAAA,GAAO,MAAA;EACP,MAAA;EACA,IAAA;EACA,WAAA;EACA,WAAA;;EAEA,QAAA;EANA;EAQA,gBAAA;EACA,eAAA;AAAA;;UAIgB,UAAA;EAChB,KAAA;EACA,WAAA;EACA,KAAA;EACA,SAAA;EACA,OAAA;AAAA;;UAIgB,eAAA;EAChB,KAAA;EACA,WAAA;EACA,KAAA;EACA,SAAA;EACA,OAAA;AAAA;AAAA,UAGgB,aAAA;EAChB,EAAA;EACA,IAAA;EACA,WAAA;EACA,GAAA;EACA,aAAA;EAZA;;;;;;;AAOD;;;;;;;;;;EAuBC,gBAAA;EAUA;EARA,SAAA;EAcA;;;;;;;EANA,cAAA;EAiCe;;;;EA5Bf,mBAAA;EACA,UAAA;EACA,MAAA;EACA,OAAA;EACA,SAAA;EACA,SAAA;EA4BA;;;;EAvBA,MAAA;EA8BW;;;;;AASZ;;EA/BC,gBAAA;EAgCuB;;;;;;;AAmBxB;;EAzCC,YAAA,GAAe,MAAA,SAAe,gBAAA;AAAA;AAAA,UAGd,mBAAA;EAChB,MAAA,EAAQ,aAAA;EACR,SAAA;EACA,SAAA;EA8CM;EA5CN,MAAA;AAAA;;KAIW,gBAAA;;;;;;;;UASK,iBAAA;EAChB,KAAA,EAAO,gBAAA;EACP,IAAA;EACA,EAAA;AAAA;;;;;;;;;;;;;;;UAiBgB,mBAAA;EAChB,IAAA;EA0D8B;EAxD9B,SAAA;EACA,eAAA;EAuD+B;;;;;;EAhD/B,MAAA;AAAA;AAAA,UAGgB,eAAA;EAChB,KAAA;IACC,MAAA;IACA,QAAA;IACA,MAAA,WA8EW;IA5EX,CAAA;IA4EyB;AAgC3B;;;;;IArGE,aAAA;IAyHK;;;;;;;IAjHL,MAAA,YAgGD;IA9FC,UAAA,GAAa,iBAAA,EAgGd;IA9FC,YAAA,GAAe,mBAAA,EA+FhB;IA7FC,YAAA,GAAe,mBAAA;EAAA;EAEhB,OAAA;IACC,KAAA;IACA,SAAA;EAAA;EA8FD;;;;;EAvFA,cAAA;EACA,KAAA;EACA,MAAA;EA8FA;EA5FA,MAAA;AAAA;AAAA,UAGgB,cAAA;EAChB,KAAA,EAAO,CAAA;EACP,UAAA;EAiHE;;;;;EA3GF,KAAA;AAAA;;;;;;;;;cA4BY,kBAAA,SAA2B,KAAA;cAC3B,MAAA;AAAA;AAAA,UAgCI,WAAA;EAChB,EAAA;EACA,IAAA;EACA,IAAA;EACA,MAAA;EACA,IAAA,EAAM,MAAA;EACN,QAAA;EACA,eAAA;EACA,MAAA,GAAS,aAAA;EACT,OAAA,GAAU,mBAAA;EACV,SAAA;EACA,SAAA;EACA,WAAA;EACA,WAAA;EACA,cAAA;EACA,eAAA;EACA,OAAA;EACA,MAAA;EACA,gBAAA;;EAEA,GAAA,GAAM,UAAA;;;;;;;;;;;EAWN,QAAA,GAAW,MAAA;;;;;;;;;;;;EAYX,UAAA,GAAa,MAAA;IAGX,QAAA,EAAU,KAAA;MACT,EAAA;MACA,IAAA;MACA,UAAA;MACA,KAAA;MACA,MAAA;MACA,gBAAA;MACA,SAAA;IAAA;IAED,UAAA;EAAA;AAAA;AAAA,cAKU,qBAAA,SAA8B,KAAA;EAGlC,OAAA;cADP,OAAA,UACO,OAAA;AAAA"}