@sanity/ailf 6.1.1 → 6.1.2

package/dist/_vendor/ailf-shared/editorial-reference.d.ts

@@ -0,0 +1,48 @@
+/**
+ * Cross Dataset Reference (CDR) write shape (D0043).
+ *
+ * The shape AILF documents use to reference editorial content (article,
+ * docPage, …) across the dataset boundary (`ailf-prod-private` →
+ * editorial). Sanity's Mutation API requires `_projectId` even when both
+ * datasets live in the same project (W0154 spike Finding 13). `_weak: true`
+ * keeps the AILF document publishable when the editorial target is retired
+ * (Finding 16) and matches the W0155 schema declaration.
+ *
+ * Canonical builder for this shape. Used by:
+ *
+ *   - `packages/eval/src/sanity/client.ts:buildEditorialReference()` — the
+ *     env-aware runtime wrapper that supplies projectId + dataset from
+ *     env, used by the eval pipeline's mirror step (W0156).
+ *   - `packages/studio/scripts/migrate-to-private-dataset.ts` — the
+ *     one-shot corpus migration script (W0159).
+ *
+ * Adding a field here is a single edit; both consumers pick it up without
+ * drift. That is the load-bearing property — the migration script and the
+ * runtime write path must emit byte-identical CDR shapes.
+ */
+export interface EditorialReference {
+    _type: "crossDatasetReference";
+    _projectId: string;
+    _dataset: string;
+    _ref: string;
+    _weak?: boolean;
+}
+export interface MakeEditorialReferenceArgs {
+    /** Sanity project ID hosting both source and dest datasets. */
+    projectId: string;
+    /** The editorial dataset name (e.g. "next"). */
+    dataset: string;
+    /** The document ID being referenced. */
+    refId: string;
+    /** Whether the reference is weak. Defaults to true for AILF→editorial. */
+    weak?: boolean;
+}
+/**
+ * Construct an editorial Cross Dataset Reference. Pure — no env reads, no
+ * side effects. Callers that need env-aware defaults (the eval pipeline)
+ * wrap this; callers with explicit config (the migration script) call it
+ * directly.
+ *
+ * @throws if `refId` is empty.
+ */
+export declare function makeEditorialReference(args: MakeEditorialReferenceArgs): EditorialReference;

package/dist/_vendor/ailf-shared/editorial-reference.js

@@ -0,0 +1,43 @@
+/**
+ * Cross Dataset Reference (CDR) write shape (D0043).
+ *
+ * The shape AILF documents use to reference editorial content (article,
+ * docPage, …) across the dataset boundary (`ailf-prod-private` →
+ * editorial). Sanity's Mutation API requires `_projectId` even when both
+ * datasets live in the same project (W0154 spike Finding 13). `_weak: true`
+ * keeps the AILF document publishable when the editorial target is retired
+ * (Finding 16) and matches the W0155 schema declaration.
+ *
+ * Canonical builder for this shape. Used by:
+ *
+ *   - `packages/eval/src/sanity/client.ts:buildEditorialReference()` — the
+ *     env-aware runtime wrapper that supplies projectId + dataset from
+ *     env, used by the eval pipeline's mirror step (W0156).
+ *   - `packages/studio/scripts/migrate-to-private-dataset.ts` — the
+ *     one-shot corpus migration script (W0159).
+ *
+ * Adding a field here is a single edit; both consumers pick it up without
+ * drift. That is the load-bearing property — the migration script and the
+ * runtime write path must emit byte-identical CDR shapes.
+ */
+/**
+ * Construct an editorial Cross Dataset Reference. Pure — no env reads, no
+ * side effects. Callers that need env-aware defaults (the eval pipeline)
+ * wrap this; callers with explicit config (the migration script) call it
+ * directly.
+ *
+ * @throws if `refId` is empty.
+ */
+export function makeEditorialReference(args) {
+    if (!args.refId) {
+        throw new Error("makeEditorialReference: refId is required");
+    }
+    const weak = args.weak ?? true;
+    return {
+        _type: "crossDatasetReference",
+        _projectId: args.projectId,
+        _dataset: args.dataset,
+        _ref: args.refId,
+        ...(weak ? { _weak: true } : {}),
+    };
+}

package/dist/_vendor/ailf-shared/index.d.ts

@@ -19,6 +19,7 @@
  */
 export { computeCanaryDrift, type CanaryDriftReport, type CanaryReportSlim, type DriftEntry, type DriftThresholds, type DriftVerdict, } from "./canary-drift.js";
 export { type DocumentRef } from "./document-ref.js";
+export { makeEditorialReference, type EditorialReference, type MakeEditorialReferenceArgs, } from "./editorial-reference.js";
 export { FEATURE_FLAGS, type FeatureFlag, type FeatureFlagKey, } from "./feature-flags.js";
 export { GRADE_BOUNDARIES, scoreGrade, type ScoreGrade, } from "./score-grades.js";
 export { NOISE_THRESHOLD } from "./noise-threshold.js";

package/dist/_vendor/ailf-shared/index.js

@@ -18,6 +18,7 @@
  * surface against future regressions.
  */
 export { computeCanaryDrift, } from "./canary-drift.js";
+export { makeEditorialReference, } from "./editorial-reference.js";
 export { FEATURE_FLAGS, } from "./feature-flags.js";
 export { GRADE_BOUNDARIES, scoreGrade, } from "./score-grades.js";
 export { NOISE_THRESHOLD } from "./noise-threshold.js";

package/dist/pipeline/mirror-repo-tasks.d.ts

@@ -135,7 +135,7 @@ export declare function buildMirrorDocument(task: LiteracyTaskDefinition, opts:
         _key: string;
         reason: string;
     } | {
-        doc?: import("../sanity/client.js").EditorialReference | undefined;
+        doc?: import("@sanity/ailf-shared").EditorialReference | undefined;
         docId?: string | undefined;
         refType: string;
         _key: string;

package/dist/sanity/client.d.ts

@@ -1,5 +1,7 @@
 import { type SanityClient } from "@sanity/client";
+import { type EditorialReference } from "../_vendor/ailf-shared/index.d.ts";
 import type { ResolvedSourceConfig } from "../sources.js";
+export type { EditorialReference };
 export interface SanityConfig {
     apiVersion: string;
     dataset: string;
@@ -50,25 +52,6 @@ export declare function getAilfSanityClient(overrides?: Partial<SanityConfig>):
  * mutating env vars between tests so the cached client doesn't leak.
  */
 export declare function resetAilfSanityClientCache(): void;
-/**
- * The write shape for a Cross Dataset Reference. Sanity's Mutation API
- * requires `_projectId` even when the target dataset lives in the same
- * project (spike Finding 13). `_weak: true` keeps the AILF source doc
- * publishable when the editorial target is retired (Finding 16).
- *
- * The literal `_type: "crossDatasetReference"` matches the receiving
- * Studio schema field type and the validated migration script
- * (`packages/studio/scripts/poc-migrate-to-private.ts`).
- *
- * @see docs/decisions/D0043-private-dataset-with-cdrs.md
- */
-export interface EditorialReference {
-    _type: "crossDatasetReference";
-    _projectId: string;
-    _dataset: string;
-    _ref: string;
-    _weak?: boolean;
-}
 export interface BuildEditorialReferenceOptions {
     /** Override the editorial-side project ID. Defaults to AILF project. */
     projectId?: string;
@@ -82,7 +65,9 @@ export interface BuildEditorialReferenceOptions {
     weak?: boolean;
 }
 /**
- * Build a Cross Dataset Reference from an AILF document into editorial content.
+ * Build a Cross Dataset Reference from an AILF document into editorial content,
+ * with env-aware defaults for `projectId` / `dataset` so call sites can pass
+ * just the `refId` in the common case.
  *
  * Use this for any reference field on an `ailf.*` document that points at an
  * editorial type (`article`, `docPage`, …). The schema-side counterpart is a
@@ -90,7 +75,7 @@ export interface BuildEditorialReferenceOptions {
  *
  * @example
  *   const docRef = buildEditorialReference(articleId)
- *   // → { _type: "reference", _projectId: "3do82whm",
+ *   // → { _type: "crossDatasetReference", _projectId: "3do82whm",
  *   //     _dataset: "next", _ref: articleId, _weak: true }
  */
 export declare function buildEditorialReference(refId: string, options?: BuildEditorialReferenceOptions): EditorialReference;

package/dist/sanity/client.js

@@ -1,11 +1,14 @@
 import { createClient } from "@sanity/client";
-// Transitional default for AILF operational documents while D0043 rollout
-// is in progress. Code paths route through `getAilfSanityClient()` so the
-// default flip to `ailf-prod-private` is a single-line change after the
-// migration script (D0043 rollout step 5) ships and runs. Until then the
-// default mirrors the editorial dataset to avoid silent dual-write across
-// the cutover boundary.
-const AILF_DATASET_DEFAULT = "next";
+import { makeEditorialReference, } from "../_vendor/ailf-shared/index.js";
+// Belt-and-suspenders default for AILF operational documents per D0043.
+// In practice this constant is never the load-bearing value in any
+// production-shaped env: the cascade in `getAilfDefaultConfig()` is
+// `AILF_REPORT_DATASET ?? SANITY_DATASET ?? AILF_DATASET_DEFAULT`, and
+// every deployed env sets at least `SANITY_DATASET` for editorial reads.
+// The constant matters only for ad-hoc runs with no env at all — where
+// landing in `ailf-prod-private` is safer than polluting the editorial
+// dataset with stray writes.
+const AILF_DATASET_DEFAULT = "ailf-prod-private";
 // Default editorial dataset that AILF cross-dataset references point at.
 // Used by `buildEditorialReference()` and by Studio's CDR field config.
 const EDITORIAL_DATASET_DEFAULT = "next";
@@ -157,7 +160,9 @@ export function resetAilfSanityClientCache() {
     _ailfClient = null;
 }
 /**
- * Build a Cross Dataset Reference from an AILF document into editorial content.
+ * Build a Cross Dataset Reference from an AILF document into editorial content,
+ * with env-aware defaults for `projectId` / `dataset` so call sites can pass
+ * just the `refId` in the common case.
  *
  * Use this for any reference field on an `ailf.*` document that points at an
  * editorial type (`article`, `docPage`, …). The schema-side counterpart is a
@@ -165,13 +170,10 @@ export function resetAilfSanityClientCache() {
  *
  * @example
  *   const docRef = buildEditorialReference(articleId)
- *   // → { _type: "reference", _projectId: "3do82whm",
+ *   // → { _type: "crossDatasetReference", _projectId: "3do82whm",
  *   //     _dataset: "next", _ref: articleId, _weak: true }
  */
 export function buildEditorialReference(refId, options = {}) {
-    if (!refId) {
-        throw new Error("buildEditorialReference: refId is required");
-    }
     // oxlint-disable-next-line @typescript-eslint/prefer-nullish-coalescing -- empty string env var should fall back
     const envProjectId = process.env.AILF_REPORT_PROJECT_ID || process.env.SANITY_PROJECT_ID;
     // Editorial dataset precedence: explicit AILF_EDITORIAL_DATASET overrides;
@@ -179,14 +181,10 @@ export function buildEditorialReference(refId, options = {}) {
     // correct editorial dataset); fall back to "next" only when nothing is set.
     // oxlint-disable-next-line @typescript-eslint/prefer-nullish-coalescing -- empty string env var should fall back
     const envDataset = process.env.AILF_EDITORIAL_DATASET || process.env.SANITY_DATASET;
-    const projectId = options.projectId ?? envProjectId ?? "3do82whm";
-    const dataset = options.dataset ?? envDataset ?? EDITORIAL_DATASET_DEFAULT;
-    const weak = options.weak ?? true;
-    return {
-        _type: "crossDatasetReference",
-        _projectId: projectId,
-        _dataset: dataset,
-        _ref: refId,
-        ...(weak ? { _weak: true } : {}),
-    };
+    return makeEditorialReference({
+        projectId: options.projectId ?? envProjectId ?? "3do82whm",
+        dataset: options.dataset ?? envDataset ?? EDITORIAL_DATASET_DEFAULT,
+        refId,
+        weak: options.weak,
+    });
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sanity/ailf",
-  "version": "6.1.1",
+  "version": "6.1.2",
   "private": false,
   "publishConfig": {
     "access": "public"