@mintplayer/ng-spark 22.8.0 → 22.9.0

package/fesm2022/mintplayer-ng-spark-renderers.mjs

@@ -28,10 +28,12 @@ function rendererValue(attr) {
 /**
  * The renderer-facing value of a query-result cell.
  *
- * A grid row carries no nested objects to fall back to — a projection is flat by construction —
- * so this is deliberately not the same function as {@link rendererValue}. Keeping them separate
- * is what stops a renderer silently receiving `undefined` because it was written against the
- * attribute shape.
+ * A cell is a single channel: whatever a renderer needs is already on `value` — for a single-child
+ * AsDetail column that is the nested PersistentObject itself, put there by the server so this
+ * matches what {@link rendererValue} falls through to on a detail page. There is nothing to fall
+ * back to, which is why this is deliberately not the same function: keeping them separate is what
+ * stops a renderer silently receiving `undefined` because it was written against the attribute
+ * shape's `object` / `objects` fields, which a row does not carry.
  */
 function cellValue(value) {
     return value?.value;

package/fesm2022/mintplayer-ng-spark-renderers.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"mintplayer-ng-spark-renderers.mjs","sources":["../../renderers/src/renderer-inputs.ts","../../renderers/src/spark-attribute-renderer-registry.ts","../../renderers/mintplayer-ng-spark-renderers.ts"],"sourcesContent":["import { reflectComponentType, Type } from '@angular/core';\nimport { PersistentObjectAttribute, QueryResultItemValue } from '@mintplayer/ng-spark/models';\n\n// Reflection result cached per component type: the input builders are template\n// expressions re-evaluated every CD pass (and query-list virtual-scrolls).\nconst declaredInputs = new Map<Type<any>, Set<string>>();\n\n/**\n * Drops entries the component doesn't declare, so every contract member is\n * genuinely optional — NgComponentOutlet throws on an undeclared input.\n */\nexport function withDeclaredInputs(component: Type<any>, inputs: Record<string, any>): Record<string, any> {\n  let declared = declaredInputs.get(component);\n  if (!declared) {\n    declared = new Set(reflectComponentType(component)?.inputs.map(i => i.templateName) ?? []);\n    declaredInputs.set(component, declared);\n  }\n  return Object.fromEntries(Object.entries(inputs).filter(([k]) => declared!.has(k)));\n}\n\n/**\n * The renderer-facing value of an attribute: the flat value, or for AsDetail\n * attributes (whose flat value the server nulls on purpose) the nested\n * PersistentObject (single) / PersistentObject[] (array).\n *\n * Used by the detail and edit paths, which still work in attributes.\n */\nexport function rendererValue(attr: PersistentObjectAttribute | undefined): any {\n  return attr?.value ?? attr?.object ?? attr?.objects;\n}\n\n/**\n * The renderer-facing value of a query-result cell.\n *\n * A grid row carries no nested objects to fall back to — a projection is flat by construction —\n * so this is deliberately not the same function as {@link rendererValue}. Keeping them separate\n * is what stops a renderer silently receiving `undefined` because it was written against the\n * attribute shape.\n */\nexport function cellValue(value: QueryResultItemValue | undefined): any {\n  return value?.value;\n}\n","import { InjectionToken, Provider, Type } from '@angular/core';\n\nexport interface SparkAttributeRendererRegistration {\n  /** The renderer name (must match attr.renderer in model JSON) */\n  name: string;\n  /** Component for the PO detail page. Must implement SparkAttributeDetailRenderer. Omit for a column/edit-only renderer. */\n  detailComponent?: Type<any> | null;\n  /** Component for query-list column cells. Must implement SparkAttributeColumnRenderer. Omit for a detail/edit-only renderer. */\n  columnComponent?: Type<any> | null;\n  /** Optional component for create/edit forms. Must implement SparkAttributeEditRenderer. When omitted, the default input is used. */\n  editComponent?: Type<any>;\n}\n\nexport const SPARK_ATTRIBUTE_RENDERERS = new InjectionToken<SparkAttributeRendererRegistration[]>(\n  'SparkAttributeRenderers',\n  { factory: () => [] }\n);\n\n/**\n * Register custom attribute renderers globally.\n *\n * @example\n * provideSparkAttributeRenderers([\n *   { name: 'video-player', detailComponent: VideoDetailComponent, columnComponent: VideoColumnComponent },\n *   { name: 'color-swatch', detailComponent: ColorDetailComponent, columnComponent: ColorColumnComponent },\n * ])\n */\nexport function provideSparkAttributeRenderers(\n  renderers: SparkAttributeRendererRegistration[]\n): Provider {\n  return {\n    provide: SPARK_ATTRIBUTE_RENDERERS,\n    useValue: renderers,\n  };\n}\n","/**\n * Generated bundle index. Do not edit.\n */\n\nexport * from './index';\n"],"names":[],"mappings":";;AAGA;AACA;AACA,MAAM,cAAc,GAAG,IAAI,GAAG,EAA0B;AAExD;;;AAGG;AACG,SAAU,kBAAkB,CAAC,SAAoB,EAAE,MAA2B,EAAA;IAClF,IAAI,QAAQ,GAAG,cAAc,CAAC,GAAG,CAAC,SAAS,CAAC;IAC5C,IAAI,CAAC,QAAQ,EAAE;QACb,QAAQ,GAAG,IAAI,GAAG,CAAC,oBAAoB,CAAC,SAAS,CAAC,EAAE,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,CAAC,YAAY,CAAC,IAAI,EAAE,CAAC;AAC1F,QAAA,cAAc,CAAC,GAAG,CAAC,SAAS,EAAE,QAAQ,CAAC;IACzC;AACA,IAAA,OAAO,MAAM,CAAC,WAAW,CAAC,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,QAAS,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;AACrF;AAEA;;;;;;AAMG;AACG,SAAU,aAAa,CAAC,IAA2C,EAAA;IACvE,OAAO,IAAI,EAAE,KAAK,IAAI,IAAI,EAAE,MAAM,IAAI,IAAI,EAAE,OAAO;AACrD;AAEA;;;;;;;AAOG;AACG,SAAU,SAAS,CAAC,KAAuC,EAAA;IAC/D,OAAO,KAAK,EAAE,KAAK;AACrB;;AC5BO,MAAM,yBAAyB,GAAG,IAAI,cAAc,CACzD,yBAAyB,EACzB,EAAE,OAAO,EAAE,MAAM,EAAE,EAAE;AAGvB;;;;;;;;AAQG;AACG,SAAU,8BAA8B,CAC5C,SAA+C,EAAA;IAE/C,OAAO;AACL,QAAA,OAAO,EAAE,yBAAyB;AAClC,QAAA,QAAQ,EAAE,SAAS;KACpB;AACH;;AClCA;;AAEG;;;;"}
+{"version":3,"file":"mintplayer-ng-spark-renderers.mjs","sources":["../../renderers/src/renderer-inputs.ts","../../renderers/src/spark-attribute-renderer-registry.ts","../../renderers/mintplayer-ng-spark-renderers.ts"],"sourcesContent":["import { reflectComponentType, Type } from '@angular/core';\nimport { PersistentObjectAttribute, QueryResultItemValue } from '@mintplayer/ng-spark/models';\n\n// Reflection result cached per component type: the input builders are template\n// expressions re-evaluated every CD pass (and query-list virtual-scrolls).\nconst declaredInputs = new Map<Type<any>, Set<string>>();\n\n/**\n * Drops entries the component doesn't declare, so every contract member is\n * genuinely optional — NgComponentOutlet throws on an undeclared input.\n */\nexport function withDeclaredInputs(component: Type<any>, inputs: Record<string, any>): Record<string, any> {\n  let declared = declaredInputs.get(component);\n  if (!declared) {\n    declared = new Set(reflectComponentType(component)?.inputs.map(i => i.templateName) ?? []);\n    declaredInputs.set(component, declared);\n  }\n  return Object.fromEntries(Object.entries(inputs).filter(([k]) => declared!.has(k)));\n}\n\n/**\n * The renderer-facing value of an attribute: the flat value, or for AsDetail\n * attributes (whose flat value the server nulls on purpose) the nested\n * PersistentObject (single) / PersistentObject[] (array).\n *\n * Used by the detail and edit paths, which still work in attributes.\n */\nexport function rendererValue(attr: PersistentObjectAttribute | undefined): any {\n  return attr?.value ?? attr?.object ?? attr?.objects;\n}\n\n/**\n * The renderer-facing value of a query-result cell.\n *\n * A cell is a single channel: whatever a renderer needs is already on `value` — for a single-child\n * AsDetail column that is the nested PersistentObject itself, put there by the server so this\n * matches what {@link rendererValue} falls through to on a detail page. There is nothing to fall\n * back to, which is why this is deliberately not the same function: keeping them separate is what\n * stops a renderer silently receiving `undefined` because it was written against the attribute\n * shape's `object` / `objects` fields, which a row does not carry.\n */\nexport function cellValue(value: QueryResultItemValue | undefined): any {\n  return value?.value;\n}\n","import { InjectionToken, Provider, Type } from '@angular/core';\n\nexport interface SparkAttributeRendererRegistration {\n  /** The renderer name (must match attr.renderer in model JSON) */\n  name: string;\n  /** Component for the PO detail page. Must implement SparkAttributeDetailRenderer. Omit for a column/edit-only renderer. */\n  detailComponent?: Type<any> | null;\n  /** Component for query-list column cells. Must implement SparkAttributeColumnRenderer. Omit for a detail/edit-only renderer. */\n  columnComponent?: Type<any> | null;\n  /** Optional component for create/edit forms. Must implement SparkAttributeEditRenderer. When omitted, the default input is used. */\n  editComponent?: Type<any>;\n}\n\nexport const SPARK_ATTRIBUTE_RENDERERS = new InjectionToken<SparkAttributeRendererRegistration[]>(\n  'SparkAttributeRenderers',\n  { factory: () => [] }\n);\n\n/**\n * Register custom attribute renderers globally.\n *\n * @example\n * provideSparkAttributeRenderers([\n *   { name: 'video-player', detailComponent: VideoDetailComponent, columnComponent: VideoColumnComponent },\n *   { name: 'color-swatch', detailComponent: ColorDetailComponent, columnComponent: ColorColumnComponent },\n * ])\n */\nexport function provideSparkAttributeRenderers(\n  renderers: SparkAttributeRendererRegistration[]\n): Provider {\n  return {\n    provide: SPARK_ATTRIBUTE_RENDERERS,\n    useValue: renderers,\n  };\n}\n","/**\n * Generated bundle index. Do not edit.\n */\n\nexport * from './index';\n"],"names":[],"mappings":";;AAGA;AACA;AACA,MAAM,cAAc,GAAG,IAAI,GAAG,EAA0B;AAExD;;;AAGG;AACG,SAAU,kBAAkB,CAAC,SAAoB,EAAE,MAA2B,EAAA;IAClF,IAAI,QAAQ,GAAG,cAAc,CAAC,GAAG,CAAC,SAAS,CAAC;IAC5C,IAAI,CAAC,QAAQ,EAAE;QACb,QAAQ,GAAG,IAAI,GAAG,CAAC,oBAAoB,CAAC,SAAS,CAAC,EAAE,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,CAAC,YAAY,CAAC,IAAI,EAAE,CAAC;AAC1F,QAAA,cAAc,CAAC,GAAG,CAAC,SAAS,EAAE,QAAQ,CAAC;IACzC;AACA,IAAA,OAAO,MAAM,CAAC,WAAW,CAAC,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,QAAS,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;AACrF;AAEA;;;;;;AAMG;AACG,SAAU,aAAa,CAAC,IAA2C,EAAA;IACvE,OAAO,IAAI,EAAE,KAAK,IAAI,IAAI,EAAE,MAAM,IAAI,IAAI,EAAE,OAAO;AACrD;AAEA;;;;;;;;;AASG;AACG,SAAU,SAAS,CAAC,KAAuC,EAAA;IAC/D,OAAO,KAAK,EAAE,KAAK;AACrB;;AC9BO,MAAM,yBAAyB,GAAG,IAAI,cAAc,CACzD,yBAAyB,EACzB,EAAE,OAAO,EAAE,MAAM,EAAE,EAAE;AAGvB;;;;;;;;AAQG;AACG,SAAU,8BAA8B,CAC5C,SAA+C,EAAA;IAE/C,OAAO;AACL,QAAA,OAAO,EAAE,yBAAyB;AAClC,QAAA,QAAQ,EAAE,SAAS;KACpB;AACH;;AClCA;;AAEG;;;;"}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@mintplayer/ng-spark",
   "private": false,
-  "version": "22.8.0",
+  "version": "22.9.0",
   "description": "Angular component library for MintPlayer.Spark CRUD applications",
   "repository": {
     "type": "git",
@@ -29,6 +29,10 @@
       "types": "./types/mintplayer-ng-spark.d.ts",
       "default": "./fesm2022/mintplayer-ng-spark.mjs"
     },
+    "./attribute-description": {
+      "types": "./types/mintplayer-ng-spark-attribute-description.d.ts",
+      "default": "./fesm2022/mintplayer-ng-spark-attribute-description.mjs"
+    },
     "./client-operations": {
       "types": "./types/mintplayer-ng-spark-client-operations.d.ts",
       "default": "./fesm2022/mintplayer-ng-spark-client-operations.mjs"

package/types/mintplayer-ng-spark-attribute-description.d.ts

@@ -0,0 +1,30 @@
+import * as _angular_core from '@angular/core';
+import { TranslatedString } from '@mintplayer/ng-spark/models';
+
+type SparkAttributeDescriptionPosition = 'top' | 'bottom' | 'start' | 'end';
+/**
+ * The [i] beside an attribute label: a focusable button whose tooltip shows the attribute's
+ * `description` (#348). Renders nothing when the model declares no description, so every label
+ * site can include it unconditionally.
+ *
+ * Accessibility comes from `*bsTooltip`: it opens on hover AND focus, closes on Escape, and sets
+ * `aria-describedby` on the button while open. The button's own name is the description text, so
+ * a screen reader announces the help on focus without waiting for the tooltip.
+ *
+ * Clicks are stopped: the [i] lives inside sortable grid headers and `<label for>` elements, and
+ * must neither toggle the sort nor move focus into the input.
+ */
+declare class SparkAttributeDescriptionComponent {
+    /** The attribute's `description`; `undefined` (the common case) renders nothing. */
+    description: _angular_core.InputSignal<TranslatedString | undefined>;
+    /** Where the tooltip opens relative to the [i]. */
+    position: _angular_core.InputSignal<SparkAttributeDescriptionPosition>;
+    /** Resolved for the current language; re-evaluates when the user switches language. */
+    text: _angular_core.Signal<string>;
+    onClick(event: MouseEvent): void;
+    static ɵfac: _angular_core.ɵɵFactoryDeclaration<SparkAttributeDescriptionComponent, never>;
+    static ɵcmp: _angular_core.ɵɵComponentDeclaration<SparkAttributeDescriptionComponent, "spark-attribute-description", never, { "description": { "alias": "description"; "required": false; "isSignal": true; }; "position": { "alias": "position"; "required": false; "isSignal": true; }; }, {}, never, never, true, never>;
+}
+
+export { SparkAttributeDescriptionComponent };
+export type { SparkAttributeDescriptionPosition };

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

@@ -123,6 +123,8 @@ interface EntityAttributeDefinition {
     id: string;
     name: string;
     label?: TranslatedString;
+    /** Help text rendered as an [i] tooltip beside the label. Absent when the model declares none. */
+    description?: TranslatedString;
     dataType: string;
     isRequired: boolean;
     isVisible: boolean;
@@ -265,6 +267,8 @@ interface QueryResult {
 interface SparkCellColumn {
     name: string;
     label?: TranslatedString;
+    /** Help text rendered as an [i] tooltip in the column header. Absent when the model declares none. */
+    description?: TranslatedString;
     dataType: string;
     isArray?: boolean;
     renderer?: string;

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

@@ -17,10 +17,12 @@ declare function rendererValue(attr: PersistentObjectAttribute | undefined): any
 /**
  * The renderer-facing value of a query-result cell.
  *
- * A grid row carries no nested objects to fall back to — a projection is flat by construction —
- * so this is deliberately not the same function as {@link rendererValue}. Keeping them separate
- * is what stops a renderer silently receiving `undefined` because it was written against the
- * attribute shape.
+ * A cell is a single channel: whatever a renderer needs is already on `value` — for a single-child
+ * AsDetail column that is the nested PersistentObject itself, put there by the server so this
+ * matches what {@link rendererValue} falls through to on a detail page. There is nothing to fall
+ * back to, which is why this is deliberately not the same function: keeping them separate is what
+ * stops a renderer silently receiving `undefined` because it was written against the attribute
+ * shape's `object` / `objects` fields, which a row does not carry.
  */
 declare function cellValue(value: QueryResultItemValue | undefined): any;