@mintplayer/ng-spark 22.13.0 → 22.15.0

package/types/mintplayer-ng-spark-models.d.ts

@@ -237,6 +237,19 @@ interface EntityType {
     attributes: EntityAttributeDefinition[];
     /** Query aliases or IDs to display as related query tables on the detail page. */
     queries?: string[];
+    /**
+     * The definitions of this type's AsDetail row types, sent alongside it so a detail table can draw
+     * its columns.
+     *
+     * Needed because a row type usually has no rights of its own — a row is edited through its parent
+     * — and the entity-type catalogue is gated on `Query`. Resolving a row type from the catalogue
+     * therefore failed silently, and the table rendered with **no columns at all**.
+     *
+     * Per-caller and gated on the *parent's* right, which is the same gate that already ships each
+     * row's attribute schema inside `attr.objects`. Pruned server-side: no `queryType`, `indexName`,
+     * `queries` or `alias`.
+     */
+    detailTypes?: EntityType[];
 }
 
 type SparkQueryRenderMode = 'Pagination' | 'VirtualScrolling';
@@ -552,6 +565,26 @@ declare function nestedPoToDict(po: PersistentObject | null | undefined): Record
  * can never contain it.
  */
 declare const AS_DETAIL_SELF_BREADCRUMB_KEY = "__sparkBreadcrumb";
+/**
+ * Reserved key under which a flattened nested object keeps its own row key — the value of whatever
+ * property the server registered as that type's `[ValueKey]`.
+ *
+ * A value object's key is not a model attribute (nothing declares `Id` in its model file), so it
+ * travels as the nested `PersistentObject`'s `id` and has to be carried across the flat-dict form
+ * state by hand. Before this existed, flattening dropped it and `dictToNestedPo` rebuilt `id` from
+ * `dict['Id']`, which is never present — so **every** embedded row reached the server with an empty
+ * id, and the fresh instance the mapper builds kept the guid its own field initializer had just
+ * minted.
+ *
+ * That is not cosmetic. Stored keys and incoming keys were then both plausible and never equal, so
+ * a save could not match rows: an edit was indistinguishable from a delete plus a create. Every
+ * per-row rule — preserving read-only fields, and the `New`/`Edit`/`Delete` rights of the row type —
+ * rests on this key surviving the round trip.
+ *
+ * Safe to carry, for the same reason the breadcrumb is: `dictToNestedPo` walks the entity type's
+ * attributes and never the dict's keys, so a reserved key is never sent back as an attribute.
+ */
+declare const AS_DETAIL_ROW_KEY = "__sparkRowKey";
 /**
  * The breadcrumb the server resolved for a flattened object, or null when it resolved to nothing.
  *
@@ -561,6 +594,17 @@ declare const AS_DETAIL_SELF_BREADCRUMB_KEY = "__sparkBreadcrumb";
  * rendering nothing — it reads as a real value. `typeName` lets a caller filter it back out.
  */
 declare function selfBreadcrumb(row: Record<string, any> | null | undefined, typeName?: string): string | null;
+/**
+ * The same filter as {@link selfBreadcrumb}, for a caller holding the server's breadcrumb string
+ * directly rather than a flattened row dict — `attr.object.breadcrumb` on a detail page, or a query
+ * cell's `breadcrumb`.
+ *
+ * Split out so there is exactly one answer to "is this the type-name placeholder?". The first
+ * implementation lived inside `selfBreadcrumb` and so covered only the two pipes that flatten a row
+ * first; the two that read the string straight off the wire kept printing `BuildFeedback` and
+ * `GateSettings` at users (#384). A second copy of the comparison is how that happens again.
+ */
+declare function resolvedBreadcrumb(value: unknown, typeName?: string): string | null;
 /**
  * Reserved key under which {@link nestedPoToDisplayRow} stashes the server-resolved breadcrumb of
  * each reference attribute (keyed by attribute name). Lets an AsDetail reference cell render the
@@ -568,6 +612,16 @@ declare function selfBreadcrumb(row: Record<string, any> | null | undefined, typ
  * reference-query options page. Prefixed to avoid colliding with a real attribute name.
  */
 declare const AS_DETAIL_BREADCRUMBS_KEY = "__sparkBreadcrumbs";
+/**
+ * Whether a flattened-row key is one this module reserved rather than a model attribute.
+ *
+ * `nestedPoToDict` and `nestedPoToDisplayRow` stash the row key and the resolved breadcrumbs
+ * alongside the real values, which is safe on the way back — `dictToNestedPo` walks the entity
+ * type's attributes and never the dict's keys. It is *not* safe for anything that enumerates the
+ * dict to build display text: a caller joining `Object.values(dict)` prints the row's guid and its
+ * own breadcrumb as though they were fields.
+ */
+declare function isReservedAsDetailKey(key: string): boolean;
 /**
  * Like {@link nestedPoToDict}, but for the read-only detail display path. In addition to each
  * attribute's value it preserves the server-resolved per-reference `breadcrumb` under
@@ -720,5 +774,5 @@ interface EvaluableAttribute {
  */
 declare function evaluateRules(attr: EvaluableAttribute, value: any): RuleFailure[];
 
-export { AS_DETAIL_BREADCRUMBS_KEY, AS_DETAIL_SELF_BREADCRUMB_KEY, ELookupDisplayType, EReferenceDisplayType, ShowedOn, applyOverlay, currentLanguage, dictToNestedPo, evaluateRules, filterQueryActions, hasShowedOnFlag, isPersistentObject, isQueryRow, mergeRefreshValues, nestedPoToDict, nestedPoToDisplayRow, overlayFromResponse, parseSelectionRule, resolveTranslation, selectionModeFor, selfBreadcrumb, valueFor };
+export { AS_DETAIL_BREADCRUMBS_KEY, AS_DETAIL_ROW_KEY, AS_DETAIL_SELF_BREADCRUMB_KEY, ELookupDisplayType, EReferenceDisplayType, ShowedOn, applyOverlay, currentLanguage, dictToNestedPo, evaluateRules, filterQueryActions, hasShowedOnFlag, isPersistentObject, isQueryRow, isReservedAsDetailKey, mergeRefreshValues, nestedPoToDict, nestedPoToDisplayRow, overlayFromResponse, parseSelectionRule, resolveTranslation, resolvedBreadcrumb, selectionModeFor, selfBreadcrumb, valueFor };
 export type { AttributeGroup, AttributeOverlay, AttributeTab, CustomActionDefinition, EntityAttributeDefinition, EntityPermissions, EntityType, EntityTypeResolver, EvaluableAttribute, LookupReference, LookupReferenceListItem, LookupReferenceValue, PersistentObject, PersistentObjectAttribute, PersistentObjectPermissions, ProgramUnit, ProgramUnitGroup, ProgramUnitsConfiguration, QueryColumn, QueryResult, QueryResultItem, QueryResultItemValue, RefreshOverlay, RefreshedOption, RetryActionPayload, RetryActionResult, RuleFailure, SparkCellColumn, SparkQuery, SparkQueryRenderMode, SparkQuerySortColumn, SparkRow, SparkSelectionMode, StreamingErrorMessage, StreamingMessage, StreamingPatchItem, StreamingPatchMessage, StreamingSnapshotMessage, TranslatedString, ValidationError, ValidationErrorResponse, ValidationRule };

package/types/mintplayer-ng-spark-pipes.d.ts

@@ -1,6 +1,6 @@
 import * as i0 from '@angular/core';
 import { PipeTransform } from '@angular/core';
-import { TranslatedString, PersistentObject, EntityType, LookupReference, EntityAttributeDefinition, QueryResultItem, ProgramUnit, EntityPermissions, ELookupDisplayType, LookupReferenceValue, ValidationError, QueryColumn } from '@mintplayer/ng-spark/models';
+import { TranslatedString, PersistentObject, EntityType, LookupReference, EntityAttributeDefinition, QueryResultItem, SparkRow, ProgramUnit, EntityPermissions, ELookupDisplayType, LookupReferenceValue, ValidationError, QueryColumn } from '@mintplayer/ng-spark/models';
 
 declare class TranslateKeyPipe implements PipeTransform {
     private readonly lang;
@@ -41,8 +41,21 @@ declare class ReferenceDisplayValuePipe implements PipeTransform {
     static ɵpipe: i0.ɵɵPipeDeclaration<ReferenceDisplayValuePipe, "referenceDisplayValue", true>;
 }
 
+/**
+ * The text a reference picker's result grid shows in one column.
+ *
+ * ⚠️ **Reads the row through {@link valueFor}, not through a shape it assumes.** This used to do
+ * `item.attributes.find(...)`, which is the `PersistentObject` shape — but a picker's rows are
+ * `QueryResultItem`s, which carry `values` (`[{ key, value, breadcrumb }]`) and have no `attributes`
+ * at all. Every cell therefore threw `can't access property "find", item.attributes is undefined`,
+ * and the picker rendered nothing selectable.
+ *
+ * There are three row shapes in this codebase and `valueFor` exists precisely so a consumer does not
+ * have to know which one it was handed. Using it is also what keeps this working if a picker is ever
+ * pointed at an AsDetail sub-table, whose rows are the flat record shape.
+ */
 declare class ReferenceAttrValuePipe implements PipeTransform {
-    transform(item: PersistentObject, attrName: string): any;
+    transform(item: SparkRow, attrName: string): any;
     static ɵfac: i0.ɵɵFactoryDeclaration<ReferenceAttrValuePipe, never>;
     static ɵpipe: i0.ɵɵPipeDeclaration<ReferenceAttrValuePipe, "referenceAttrValue", true>;
 }
@@ -157,6 +170,23 @@ declare class CanDeleteDetailRowPipe implements PipeTransform {
     static ɵpipe: i0.ɵɵPipeDeclaration<CanDeleteDetailRowPipe, "canDeleteDetailRow", true>;
 }
 
+/**
+ * Whether the caller may edit rows of an AsDetail attribute's row type.
+ *
+ * The third of the `can*DetailRow` family, and the one the server was already answering. `canEdit`
+ * has been computed, shipped and fetched per AsDetail attribute since row rights landed — it was
+ * simply never read for the row path, so the form offered an edit the save would undo.
+ *
+ * ⚠️ Apply this **read-only, never hidden**. A row the caller may not edit must stay fully
+ * readable; hiding the inputs would hide the data, which is a worse answer than showing it
+ * uneditable.
+ */
+declare class CanEditDetailRowPipe implements PipeTransform {
+    transform(attr: EntityAttributeDefinition, permissions: Record<string, EntityPermissions>): boolean;
+    static ɵfac: i0.ɵɵFactoryDeclaration<CanEditDetailRowPipe, never>;
+    static ɵpipe: i0.ɵɵPipeDeclaration<CanEditDetailRowPipe, "canEditDetailRow", true>;
+}
+
 declare class LookupDisplayTypePipe implements PipeTransform {
     transform(attr: EntityAttributeDefinition, lookupRefOptions: Record<string, LookupReference>): ELookupDisplayType;
     static ɵfac: i0.ɵɵFactoryDeclaration<LookupDisplayTypePipe, never>;
@@ -235,5 +265,5 @@ declare class QueryReferenceChipsPipe implements PipeTransform {
     static ɵpipe: i0.ɵɵPipeDeclaration<QueryReferenceChipsPipe, "queryReferenceChips", true>;
 }
 
-export { ArrayValuePipe, AsDetailCellValuePipe, AsDetailColumnsPipe, AsDetailDisplayValuePipe, AsDetailTypePipe, AttributeValuePipe, CanCreateDetailRowPipe, CanDeleteDetailRowPipe, ErrorForAttributePipe, IconNamePipe, InlineRefOptionsPipe, InputTypePipe, LookupDisplayTypePipe, LookupDisplayValuePipe, LookupOptionsPipe, QueryCellValuePipe, QueryReferenceChipsPipe, RawAttributeValuePipe, ReferenceAttrValuePipe, ReferenceChipsPipe, ReferenceDisplayValuePipe, ReferenceLinkRoutePipe, ResolveTranslationPipe, RouterLinkPipe, TranslateKeyPipe };
+export { ArrayValuePipe, AsDetailCellValuePipe, AsDetailColumnsPipe, AsDetailDisplayValuePipe, AsDetailTypePipe, AttributeValuePipe, CanCreateDetailRowPipe, CanDeleteDetailRowPipe, CanEditDetailRowPipe, ErrorForAttributePipe, IconNamePipe, InlineRefOptionsPipe, InputTypePipe, LookupDisplayTypePipe, LookupDisplayValuePipe, LookupOptionsPipe, QueryCellValuePipe, QueryReferenceChipsPipe, RawAttributeValuePipe, ReferenceAttrValuePipe, ReferenceChipsPipe, ReferenceDisplayValuePipe, ReferenceLinkRoutePipe, ResolveTranslationPipe, RouterLinkPipe, TranslateKeyPipe };
 export type { AsDetailCellValue, ReferenceChip };