fimo 2.2.0-staging.8 → 2.2.0

package/dist/runtime/content/client/collection-core.js

@@ -11,11 +11,12 @@ export function createCollectionContentCore(config, runtime) {
     const meta = { uid: info.uid, pascal: info.pascal, localized: info.localized };
     const self = { wrapWithSource, meta };
     const resolve = (uid) => uid === info.uid ? self : resolveClientHandle(references[uid]);
-    function wrapWithSource(entry) {
+    function wrapWithSource(entry, context) {
         return wrapEntry(info, entry, {
             alwaysIncludeLocale: true,
             defaultLocale: requestDefaultLocale ?? 'en',
             resolve,
+            context,
         });
     }
     function readPath(url, options) {
@@ -88,7 +89,7 @@ export function createCollectionContentCore(config, runtime) {
             throw new Error(await response.text());
         }
         const body = parseCollectionResponse(await response.json());
-        const items = body.data.map(wrapWithSource);
+        const items = body.data.map((entry) => wrapWithSource(entry));
         const pageInfo = {
             limit: body.meta.limit,
             offset: body.meta.offset,

package/dist/runtime/content/client/core-types.d.ts

@@ -1,3 +1,4 @@
+import type { FimoSourceContext } from '../../primitives/lib/primitives.js';
 import type { Fields, Populate, PopulatedResult, ProjectedWithPopulate, Query } from '../../primitives/lib/query.js';
 export type ContentResult<T extends {
     id: string;
@@ -43,7 +44,7 @@ export interface ContentModuleMeta {
     readonly localized: boolean;
 }
 export interface ContentClientHandle {
-    wrapWithSource: (entry: Record<string, any>) => unknown;
+    wrapWithSource: (entry: Record<string, any>, context?: FimoSourceContext) => unknown;
     meta: ContentModuleMeta;
 }
 export type ContentModuleRef = ContentClientHandle | {
@@ -73,7 +74,7 @@ export interface CollectionContentCore<T extends {
     id: string;
 }, TInput extends object> {
     readonly meta: ContentModuleMeta;
-    wrapWithSource(entry: Record<string, any>): T;
+    wrapWithSource(entry: Record<string, any>, context?: FimoSourceContext): T;
     getById<TPopulate extends Populate<T> | undefined = undefined>(id: string, options?: ContentReadOptions<TPopulate>): Promise<ContentResult<T, undefined, TPopulate>>;
     getBySlug<TPopulate extends Populate<T> | undefined = undefined>(slug: string, options?: ContentReadOptions<TPopulate>): Promise<ContentResult<T, undefined, TPopulate> | null>;
     getByField<TPopulate extends Populate<T> | undefined = undefined>(fieldName: string, value: string, options?: ContentReadOptions<TPopulate>): Promise<ContentResult<T, undefined, TPopulate> | null>;
@@ -89,7 +90,7 @@ export interface SingletonContentCore<T extends {
     id: string;
 }, TInput extends object> {
     readonly meta: ContentModuleMeta;
-    wrapWithSource(entry: Record<string, any>): T;
+    wrapWithSource(entry: Record<string, any>, context?: FimoSourceContext): T;
     get<TPopulate extends Populate<T> | undefined = undefined>(options?: ContentReadOptions<TPopulate>): Promise<ContentResult<T, undefined, TPopulate>>;
     update(payload: Partial<TInput>): Promise<T>;
 }

package/dist/runtime/content/client/internal.d.ts

@@ -1,3 +1,4 @@
+import { type FimoSourceContext } from '../../primitives/lib/primitives.js';
 import type { ContentClientHandle, ContentModuleRef, ContentSchema, ContentSchemaField } from './core-types.js';
 export interface InterpretedSchema {
     uid: string;
@@ -37,6 +38,7 @@ export declare function wrapEntry(info: InterpretedSchema, entry: Record<string,
     alwaysIncludeLocale: boolean;
     defaultLocale: string;
     resolve: ReferenceResolver;
+    context?: FimoSourceContext;
 }): Record<string, unknown>;
 export {};
 //# sourceMappingURL=internal.d.ts.map

package/dist/runtime/content/client/internal.js

@@ -1,5 +1,5 @@
 import { pascalCase } from 'change-case';
-import { FIMO_SOURCE, FimoBoolean, FimoMedia, FimoRichText, FimoString } from '../../primitives/lib/primitives.js';
+import { FIMO_SOURCE, FIMO_SOURCE_CONTEXT, FimoBoolean, FimoMedia, FimoRichText, FimoString, } from '../../primitives/lib/primitives.js';
 export function interpretSchema(schema) {
     if (!schema || typeof schema.uid !== 'string' || schema.uid.length === 0) {
         throw new Error('Content schema is missing a "uid".');
@@ -94,6 +94,19 @@ function isPopulatedEntry(value) {
         typeof fimo === 'object' &&
         typeof fimo.contentType === 'string');
 }
+function appendSourceContext(context, item) {
+    return [...(context ?? []), item];
+}
+function tagWithSourceContext(value, context) {
+    if (context && context.length > 0) {
+        Object.defineProperty(value, FIMO_SOURCE_CONTEXT, {
+            value: Object.freeze([...context]),
+            enumerable: false,
+            configurable: true,
+        });
+    }
+    return value;
+}
 function asClientHandle(candidate) {
     if (candidate == null || typeof candidate !== 'object') {
         return undefined;
@@ -133,7 +146,7 @@ function unresolvableReference(uid) {
  * union narrows in a switch. Raw (unpopulated) values and types outside the
  * field's declared targets pass through untouched.
  */
-function wrapPolymorphic(value, targetUids, resolve) {
+function wrapPolymorphic(value, targetUids, source, resolve, context) {
     if (!isPopulatedEntry(value)) {
         return value;
     }
@@ -145,11 +158,11 @@ function wrapPolymorphic(value, targetUids, resolve) {
     if (!target) {
         throw unresolvableReference(contentType);
     }
-    const wrapped = target.wrapWithSource(value);
+    const wrapped = target.wrapWithSource(value, appendSourceContext(context, { kind: 'relation', source }));
     wrapped.$type = contentType;
-    return wrapped;
+    return tagWithSource(wrapped, source, context);
 }
-function wrapReference(value, uid, resolve) {
+function wrapReference(value, uid, source, resolve, context) {
     if (!isPopulatedEntry(value)) {
         return value;
     }
@@ -157,7 +170,7 @@ function wrapReference(value, uid, resolve) {
     if (!target) {
         throw unresolvableReference(uid);
     }
-    return target.wrapWithSource(value);
+    return tagWithSource(target.wrapWithSource(value, appendSourceContext(context, { kind: 'relation', source })), source, context);
 }
 /**
  * Blocks values have no wrapper class of their own — the array structure stays
@@ -174,7 +187,7 @@ function blockItemFields(field, item) {
     }
     return schema.fields;
 }
-function wrapBlockItem(field, item, source, resolve) {
+function wrapBlockItem(field, item, listSource, itemSource, resolve, context) {
     if (item == null || typeof item !== 'object' || Array.isArray(item)) {
         return item;
     }
@@ -183,61 +196,77 @@ function wrapBlockItem(field, item, source, resolve) {
     if (!fields) {
         return item;
     }
+    const itemContext = typeof record._key === 'string' && record._key.length > 0
+        ? appendSourceContext(context, {
+            kind: 'component',
+            source: listSource,
+            _key: record._key,
+            ...(typeof record._type === 'string' && record._type.length > 0 ? { _type: record._type } : {}),
+        })
+        : context;
     const wrapped = { ...record };
     for (const [key, childField] of Object.entries(fields)) {
-        wrapped[key] = wrapField(childField, record[key], `${source}.${key}`, resolve);
+        wrapped[key] = wrapField(childField, record[key], `${itemSource}.${key}`, resolve, itemContext);
     }
     return wrapped;
 }
 /**
  * A JSON field's declared shape is a plain object/array — tagging it in place
  * (rather than boxing it, like the scalar wrappers below) keeps that shape
- * intact so consumers that read it as ordinary JSON see no difference.
+ * intact so consumers that read it as ordinary JSON see no difference. A
+ * populated reference is tagged the same way, with the source of the field
+ * that HOLDS it (`Post.id:p1:en.author`), so the toolbar can select and
+ * repoint the reference itself; the target's own fields keep the sources the
+ * target client gave them.
  */
-function tagWithSource(value, source) {
+function tagWithSource(value, source, context) {
     Object.defineProperty(value, FIMO_SOURCE, { value: source, enumerable: false, configurable: true });
-    return value;
+    return tagWithSourceContext(value, context);
 }
-function wrapField(field, value, source, resolve) {
+function wrapField(field, value, source, resolve, context) {
     switch (field.type) {
         case 'string':
         case 'text':
         case 'date':
         case 'datetime':
-            return value != null ? new FimoString(String(value), source) : value;
+            return value != null ? new FimoString(String(value), source, context) : value;
         case 'richtext':
-            return value != null ? new FimoRichText(value, source) : value;
+            return value != null ? new FimoRichText(value, source, context) : value;
         case 'boolean':
-            return value != null ? new FimoBoolean(value, source) : value;
+            return value != null ? new FimoBoolean(value, source, context) : value;
         case 'json':
             return value != null && typeof value === 'object'
-                ? tagWithSource(Array.isArray(value) ? [...value] : { ...value }, source)
+                ? tagWithSource(Array.isArray(value) ? [...value] : { ...value }, source, context)
                 : value;
         case 'media':
             if (field.multiple) {
-                return (value?.map((m, i) => new FimoMedia(m, `${source}[${i}]`)) ?? value);
+                return (value?.map((m, i) => new FimoMedia(m, `${source}[${i}]`, context)) ?? value);
             }
-            return value != null ? new FimoMedia(value, source) : value;
+            return value != null ? new FimoMedia(value, source, context) : value;
         case 'reference': {
             const polymorphic = polymorphicTargetUids(field);
             if (polymorphic) {
                 if (field.many) {
-                    return Array.isArray(value) ? value.map((item) => wrapPolymorphic(item, polymorphic, resolve)) : value;
+                    return Array.isArray(value)
+                        ? value.map((item, i) => wrapPolymorphic(item, polymorphic, `${source}[${i}]`, resolve, context))
+                        : value;
                 }
-                return wrapPolymorphic(value, polymorphic, resolve);
+                return wrapPolymorphic(value, polymorphic, source, resolve, context);
             }
             const uid = field.target;
             if (!uid) {
                 return value;
             }
             if (field.many) {
-                return Array.isArray(value) ? value.map((item) => wrapReference(item, uid, resolve)) : value;
+                return Array.isArray(value)
+                    ? value.map((item, i) => wrapReference(item, uid, `${source}[${i}]`, resolve, context))
+                    : value;
             }
-            return wrapReference(value, uid, resolve);
+            return wrapReference(value, uid, source, resolve, context);
         }
         case 'blocks':
             return Array.isArray(value)
-                ? value.map((item, i) => wrapBlockItem(field, item, `${source}[${i}]`, resolve))
+                ? value.map((item, i) => wrapBlockItem(field, item, source, `${source}[${i}]`, resolve, context))
                 : value;
         // 'number' deliberately falls through here — this is a decision, not a
         // gap. React renders a boxed String directly (`<span>{new FimoString(...)}
@@ -267,7 +296,7 @@ export function wrapEntry(info, entry, options) {
         id,
         entryId,
         documentId,
-        slug: entry.slug != null ? new FimoString(entry.slug, `${sourcePrefix}.slug`) : entry.slug,
+        slug: entry.slug != null ? new FimoString(entry.slug, `${sourcePrefix}.slug`, options.context) : entry.slug,
         ...(options.alwaysIncludeLocale || entry.locale ? { locale } : {}),
         createdAt: entry.createdAt,
         updatedAt: entry.updatedAt,
@@ -276,7 +305,7 @@ export function wrapEntry(info, entry, options) {
         },
     };
     for (const [key, field] of info.fields) {
-        wrapped[key] = wrapField(field, entry[key], `${sourcePrefix}.${key}`, options.resolve);
+        wrapped[key] = wrapField(field, entry[key], `${sourcePrefix}.${key}`, options.resolve, options.context);
     }
     return wrapped;
 }

package/dist/runtime/content/client/singleton-core.js

@@ -28,11 +28,12 @@ export function createSingletonContentCore(config, runtime) {
         localizedReferenceFields = fields;
         return fields;
     }
-    function wrapWithSource(entry) {
+    function wrapWithSource(entry, context) {
         return wrapEntry(info, entry, {
             alwaysIncludeLocale: info.localized,
             defaultLocale: requestDefaultLocale ?? 'en',
             resolve,
+            context,
         });
     }
     function localize(options, fallbackLocale = requestDefaultLocale) {

package/dist/runtime/content/index.d.ts

@@ -16,6 +16,6 @@ export type { SingletonContentCore } from './client/singleton-core.js';
 export { serializeContent, type SerializedContent, type SerializedMedia } from './serialization.js';
 export { parseCollectionResponse, type CollectionResponse } from './parseCollectionResponse.js';
 export type { CollectionPage, CollectionPageInfo, ContentClientConfig, ContentClientHandle, ContentModuleMeta, ContentModuleRef, ContentReadOptions, ContentResult, ContentSchema, ContentSchemaField, } from './client/core-types.js';
-export { FIMO_PARTS, FIMO_SOURCE, FimoBoolean, FimoDate, FimoMedia, FimoRichText, FimoString, getFimoParts, getFimoSource, hasFimoSource, isFimoDate, isFimoString, type FimoPart, type FimoPolymorphicReference, type FimoReference, type FimoRichTextContent, type FimoSource, } from '../primitives/lib/primitives.js';
+export { FIMO_PARTS, FIMO_SOURCE, FIMO_SOURCE_CONTEXT, FimoBoolean, FimoDate, FimoMedia, FimoRichText, FimoString, getFimoParts, getFimoSource, getFimoSourceContext, hasFimoSource, isFimoDate, isFimoString, type FimoPart, type FimoPolymorphicReference, type FimoReference, type FimoRichTextContent, type FimoSourceContext, type FimoSourceContextItem, type FimoSource, } from '../primitives/lib/primitives.js';
 export type { BoolOps, DateOps, Field, Fields, FilterFor, NullOnlyOps, NumberOps, Populate, Populated, PopulatedResult, Projected, ProjectedWithPopulate, Query, ReferenceField, ReferenceMap, ScalarOps, Sort, SortField, StringOps, Where, WithReferences, } from '../primitives/lib/query.js';
 //# sourceMappingURL=index.d.ts.map

package/dist/runtime/content/index.js

@@ -13,4 +13,4 @@ export { readCollectionLocale, splitWritePayload, withMutationLocale } from './c
 export { requireContentApiUrl } from './client/runtime.js';
 export { serializeContent } from './serialization.js';
 export { parseCollectionResponse } from './parseCollectionResponse.js';
-export { FIMO_PARTS, FIMO_SOURCE, FimoBoolean, FimoDate, FimoMedia, FimoRichText, FimoString, getFimoParts, getFimoSource, hasFimoSource, isFimoDate, isFimoString, } from '../primitives/lib/primitives.js';
+export { FIMO_PARTS, FIMO_SOURCE, FIMO_SOURCE_CONTEXT, FimoBoolean, FimoDate, FimoMedia, FimoRichText, FimoString, getFimoParts, getFimoSource, getFimoSourceContext, hasFimoSource, isFimoDate, isFimoString, } from '../primitives/lib/primitives.js';

package/dist/runtime/content/serialization.d.ts

@@ -1,9 +1,10 @@
 import { FimoBoolean, FimoDate, FimoMedia, FimoRichText, FimoString, type FimoRichTextContent } from '../primitives/lib/primitives.js';
 export interface SerializedMedia {
+    id?: string;
     url: string;
-    alt: string;
-    name: string;
-    mime: string;
+    alt?: string;
+    name?: string;
+    mime?: string;
     width?: number;
     height?: number;
 }

package/dist/runtime/content/serialization.js

@@ -18,10 +18,11 @@ export function serializeContent(value) {
     }
     if (value instanceof FimoMedia) {
         const media = {
+            ...(value.id === undefined ? {} : { id: value.id }),
             url: value.url,
-            alt: value.alt,
-            name: value.name,
-            mime: value.mime,
+            ...(value.alt === undefined ? {} : { alt: value.alt }),
+            ...(value.name === undefined ? {} : { name: value.name }),
+            ...(value.mime === undefined ? {} : { mime: value.mime }),
             ...(value.width === undefined ? {} : { width: value.width }),
             ...(value.height === undefined ? {} : { height: value.height }),
         };

package/dist/runtime/primitives/lib/index.d.ts

@@ -1,4 +1,4 @@
-export { FimoString, FimoDate, FimoMedia, FimoBoolean, FimoRichText, type FimoPolymorphicReference, type FimoReference, type FimoSource, type FimoPart, type FimoRichTextContent, FIMO_SOURCE, FIMO_PARTS, isFimoString, isFimoDate, hasFimoSource, getFimoSource, getFimoParts, } from './primitives.js';
+export { FimoString, FimoDate, FimoMedia, FimoBoolean, FimoRichText, type FimoPolymorphicReference, type FimoReference, type FimoSource, type FimoPart, type FimoRichTextContent, type FimoSourceContext, type FimoSourceContextItem, FIMO_SOURCE, FIMO_SOURCE_CONTEXT, FIMO_PARTS, isFimoString, isFimoDate, hasFimoSource, getFimoSource, getFimoSourceContext, getFimoParts, } from './primitives.js';
 export { fimo } from './template.js';
 export { renderRichTextHtml, renderRichTextHtml as renderRichText } from './render-rich-text.js';
 export { parseImageHostSuffixes, resolveImagePresentation, type ImageFit, type ImageObjectFit, type ImagePresentation, type ImagePresentationOptions, } from './image-optimization.js';

package/dist/runtime/primitives/lib/index.js

@@ -1,5 +1,5 @@
 // Fimo - Source tracking for inline editing
-export { FimoString, FimoDate, FimoMedia, FimoBoolean, FimoRichText, FIMO_SOURCE, FIMO_PARTS, isFimoString, isFimoDate, hasFimoSource, getFimoSource, getFimoParts, } from './primitives.js';
+export { FimoString, FimoDate, FimoMedia, FimoBoolean, FimoRichText, FIMO_SOURCE, FIMO_SOURCE_CONTEXT, FIMO_PARTS, isFimoString, isFimoDate, hasFimoSource, getFimoSource, getFimoSourceContext, getFimoParts, } from './primitives.js';
 export { fimo } from './template.js';
 export { renderRichTextHtml, renderRichTextHtml as renderRichText } from './render-rich-text.js';
 export { parseImageHostSuffixes, resolveImagePresentation, } from './image-optimization.js';

package/dist/runtime/primitives/lib/primitives.d.ts

@@ -16,13 +16,25 @@ export interface FimoPolymorphicReference {
     id: string;
 }
 export declare const FIMO_SOURCE: unique symbol;
+export declare const FIMO_SOURCE_CONTEXT: unique symbol;
 export declare const FIMO_PARTS: unique symbol;
+export type FimoSourceContextItem = {
+    kind: 'relation';
+    source: string;
+} | {
+    kind: 'component';
+    source: string;
+    _key: string;
+    _type?: string;
+};
+export type FimoSourceContext = readonly FimoSourceContextItem[];
 /**
  * A piece of a composed FimoString — maps text to its source
  */
 export type FimoPart = {
     text: string;
     source?: string;
+    context?: FimoSourceContext;
 };
 /**
  * FimoString - A string with source tracking
@@ -32,8 +44,9 @@ export type FimoPart = {
  */
 export declare class FimoString extends String {
     readonly [FIMO_SOURCE]: string | null;
+    readonly [FIMO_SOURCE_CONTEXT]?: FimoSourceContext;
     readonly [FIMO_PARTS]?: FimoPart[];
-    constructor(value: string, source: string | null);
+    constructor(value: string, source: string | null, context?: FimoSourceContext);
     /**
      * Compose multiple tracked values into one FimoString.
      * Parts carry individual sources; the main FIMO_SOURCE is null.
@@ -50,28 +63,38 @@ export declare class FimoString extends String {
  */
 export declare class FimoDate extends Date {
     readonly [FIMO_SOURCE]: string;
-    constructor(value: Date | string | number, source: string);
+    readonly [FIMO_SOURCE_CONTEXT]?: FimoSourceContext;
+    constructor(value: Date | string | number, source: string, context?: FimoSourceContext);
     get __fimo(): FimoSource;
 }
 /**
- * FimoMedia - Media object with source tracking
+ * FimoMedia - a media value with source tracking.
+ *
+ * A stored media value is a reference: the media-library `id`, the `url` that
+ * still resolves if the asset is deleted, and the `alt` the entry owns. The
+ * facts the asset owns, such as `name`, `mime`, and intrinsic `width`/`height`,
+ * are optional because a read only carries them when it named the field in
+ * `populate`. Renderers must treat them as enrichment.
  */
 export declare class FimoMedia {
+    readonly id?: string;
     readonly url: string;
-    readonly alt: string;
-    readonly name: string;
-    readonly mime: string;
+    readonly alt?: string;
+    readonly name?: string;
+    readonly mime?: string;
     readonly width?: number;
     readonly height?: number;
     readonly [FIMO_SOURCE]: string;
+    readonly [FIMO_SOURCE_CONTEXT]?: FimoSourceContext;
     constructor(data: {
+        id?: string;
         url: string;
-        alt: string;
-        name: string;
-        mime: string;
+        alt?: string;
+        name?: string;
+        mime?: string;
         width?: number;
         height?: number;
-    }, source: string);
+    }, source: string, context?: FimoSourceContext);
     get __fimo(): FimoSource;
 }
 /**
@@ -80,7 +103,8 @@ export declare class FimoMedia {
 export declare class FimoBoolean {
     readonly value: boolean;
     readonly [FIMO_SOURCE]: string;
-    constructor(value: boolean, source: string);
+    readonly [FIMO_SOURCE_CONTEXT]?: FimoSourceContext;
+    constructor(value: boolean, source: string, context?: FimoSourceContext);
     get __fimo(): FimoSource;
     valueOf(): boolean;
 }
@@ -105,7 +129,8 @@ export interface FimoRichTextContent {
 export declare class FimoRichText {
     readonly content: FimoRichTextContent;
     readonly [FIMO_SOURCE]: string;
-    constructor(content: FimoRichTextContent, source: string);
+    readonly [FIMO_SOURCE_CONTEXT]?: FimoSourceContext;
+    constructor(content: FimoRichTextContent, source: string, context?: FimoSourceContext);
     get __fimo(): FimoSource;
 }
 /**
@@ -126,6 +151,8 @@ export declare function hasFimoSource(value: unknown): value is {
  * Get the source from a fimo value, or undefined if not tracked
  */
 export declare function getFimoSource(value: unknown): string | undefined;
+/** Get the hidden relation/component ancestry from a wrapped value. */
+export declare function getFimoSourceContext(value: unknown): FimoSourceContext | undefined;
 /**
  * Get the decomposed parts from a composed FimoString, or undefined
  */