spiderly 19.11.3 → 19.11.4

package/lib/components/spiderly-data-table/spiderly-data-table.component.d.ts

@@ -1,10 +1,11 @@
-import { AfterViewInit, EventEmitter, OnDestroy, OnInit, TemplateRef } from '@angular/core';
+import { AfterViewInit, EventEmitter, OnDestroy, OnInit, QueryList, TemplateRef } from '@angular/core';
 import { ActivatedRoute, Router } from '@angular/router';
 import { TranslocoService } from '@jsverse/transloco';
 import { SelectItem, SortMeta } from 'primeng/api';
 import { DialogService, DynamicDialogRef } from 'primeng/dynamicdialog';
 import { Table, TableFilterEvent, TableLazyLoadEvent } from 'primeng/table';
 import { Observable } from 'rxjs';
+import { CellTemplateContext, SpiderlyCellTemplateDirective } from '../../directives/spiderly-cell-template.directive';
 import { Filter } from '../../entities/filter';
 import { LazyLoadSelectedIdsResult } from '../../entities/lazy-load-selected-ids-result';
 import { PaginatedResult } from '../../entities/paginated-result';
@@ -28,6 +29,11 @@ export declare class SpiderlyDataTableComponent implements OnInit, AfterViewInit
      * Rendered in the caption action area ahead of the built-in buttons.
      */
     actionsTemplate: TemplateRef<any>;
+    /**
+     * Per-column cell templates projected via `<ng-template spiderlyCellTemplate="field">`.
+     * A column with no template keeps the built-in rendering.
+     */
+    cellTemplates: QueryList<SpiderlyCellTemplateDirective>;
     tableTitle: string;
     tableIcon: string;
     items: any[];
@@ -117,6 +123,15 @@ export declare class SpiderlyDataTableComponent implements OnInit, AfterViewInit
     rowNavigationPath: string;
     constructor(router: Router, dialogService: DialogService, route: ActivatedRoute, messageService: SpiderlyMessageService, translocoService: TranslocoService, configService: ConfigServiceBase, locale: string);
     ngAfterViewInit(): void;
+    /**
+     * The template that renders this column's cells, or null to use the built-in rendering.
+     * Actions columns have no `field`, so they never match one.
+     *
+     * Read straight off the QueryList, which is live — a consumer declaring its templates inside a
+     * `@for`/`@if` is served with no subscription and nothing to invalidate. The scan is over the
+     * TEMPLATED columns only (typically one or two), not over `cols`.
+     */
+    getCellTemplate(col: Column): TemplateRef<CellTemplateContext> | null;
     private setupRemovableSort;
     ngOnInit(): void;
     /**
@@ -179,13 +194,32 @@ export declare class SpiderlyDataTableComponent implements OnInit, AfterViewInit
      */
     private defaultMultiSortMeta;
     private persistedMultiSortMeta;
+    /**
+     * Drops sort meta the backend has no sort case for. Persisted state outlives the rule that
+     * produced it — a sort stored before a column became non-sortable (or before the library
+     * started disabling `*CommaSeparated` headers) would otherwise ride every lazy load, and the
+     * generated `Build` answers an unknown sort field with a 400. There would be no way out from
+     * the UI either: the header that could clear it is exactly the one no longer clickable.
+     * Unknown fields (no matching column) are left alone — a consumer may sort on something it
+     * declares no column for.
+     */
+    private keepSortableMeta;
     private applyDefaultSortIfUnsorted;
     lazyLoad(event: TableLazyLoadEvent): void;
     clientLoad(): void;
     private clientFilterCount;
     filter(event: TableFilterEvent): void;
     private loadFormArrayItems;
-    getColHeaderWidth(filterType: string): "min-width: 12rem;" | "min-width: 10rem;" | "min-width: 8rem;" | "width: 0rem;";
+    /**
+     * Single source for whether a column header offers click-to-sort (drives both
+     * `pSortableColumnDisabled` and the sort icon). Beyond the consumer's explicit `sortable: false`,
+     * `*CommaSeparated` fields are auto-disabled: the backend's `PaginatedResultGenerator` never emits
+     * a sort case for collection columns (the same naming convention decides both), and since unknown
+     * sort fields are rejected with a 400, a clickable header here would be a guaranteed error toast.
+     */
+    isColumnSortable(col: Column): boolean;
+    /** The column's declared {@link Column.minWidth}, or the default for its filter type. */
+    getColHeaderWidth(col: Column): string;
     getColMatchModeOptions(filterType: string): SelectItem<any>[];
     getColMatchMode(filterType: string): any;
     isDropOrMulti(filterType: string): boolean;
@@ -218,7 +252,7 @@ export declare class SpiderlyDataTableComponent implements OnInit, AfterViewInit
     rowUnselect(id: number): void;
     getFormArrayControlByIndex(formControlName: string, index: number): SpiderlyFormControl;
     static ɵfac: i0.ɵɵFactoryDeclaration<SpiderlyDataTableComponent, never>;
-    static ɵcmp: i0.ɵɵComponentDeclaration<SpiderlyDataTableComponent, "spiderly-data-table", never, { "tableTitle": { "alias": "tableTitle"; "required": false; }; "tableIcon": { "alias": "tableIcon"; "required": false; }; "items": { "alias": "items"; "required": false; }; "rows": { "alias": "rows"; "required": false; }; "cols": { "alias": "cols"; "required": false; }; "showPaginator": { "alias": "showPaginator"; "required": false; }; "showCardWrapper": { "alias": "showCardWrapper"; "required": false; }; "readonly": { "alias": "readonly"; "required": false; }; "idField": { "alias": "idField"; "required": false; }; "getPaginatedListObservableMethod": { "alias": "getPaginatedListObservableMethod"; "required": false; }; "exportListToExcelObservableMethod": { "alias": "exportListToExcelObservableMethod"; "required": false; }; "deleteItemFromTableObservableMethod": { "alias": "deleteItemFromTableObservableMethod"; "required": false; }; "deleteListFromTableObservableMethod": { "alias": "deleteListFromTableObservableMethod"; "required": false; }; "newlySelectedItems": { "alias": "newlySelectedItems"; "required": false; }; "unselectedItems": { "alias": "unselectedItems"; "required": false; }; "selectionMode": { "alias": "selectionMode"; "required": false; }; "selectedLazyLoadObservableMethod": { "alias": "selectedLazyLoadObservableMethod"; "required": false; }; "additionalFilterIdLong": { "alias": "additionalFilterIdLong"; "required": false; }; "showAddButton": { "alias": "showAddButton"; "required": false; }; "showExportToExcelButton": { "alias": "showExportToExcelButton"; "required": false; }; "showReloadTableButton": { "alias": "showReloadTableButton"; "required": false; }; "getFormArrayItems": { "alias": "getFormArrayItems"; "required": false; }; "hasLazyLoad": { "alias": "hasLazyLoad"; "required": false; }; "stateKey": { "alias": "stateKey"; "required": false; }; "stateStorage": { "alias": "stateStorage"; "required": false; }; "defaultSortField": { "alias": "defaultSortField"; "required": false; }; "defaultSortOrder": { "alias": "defaultSortOrder"; "required": false; }; "getAlreadySelectedItemIds": { "alias": "getAlreadySelectedItemIds"; "required": false; }; "getAlreadySelectedItems": { "alias": "getAlreadySelectedItems"; "required": false; }; "getFormControl": { "alias": "getFormControl"; "required": false; }; "additionalIndexes": { "alias": "additionalIndexes"; "required": false; }; "navigateOnRowClick": { "alias": "navigateOnRowClick"; "required": false; }; "rowNavigationPath": { "alias": "rowNavigationPath"; "required": false; }; }, { "onTotalRecordsChange": "onTotalRecordsChange"; "onLazyLoad": "onLazyLoad"; "onIsAllSelectedChange": "onIsAllSelectedChange"; "onRowSelect": "onRowSelect"; "onRowUnselect": "onRowUnselect"; }, ["actionsTemplate"], never, true, never>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<SpiderlyDataTableComponent, "spiderly-data-table", never, { "tableTitle": { "alias": "tableTitle"; "required": false; }; "tableIcon": { "alias": "tableIcon"; "required": false; }; "items": { "alias": "items"; "required": false; }; "rows": { "alias": "rows"; "required": false; }; "cols": { "alias": "cols"; "required": false; }; "showPaginator": { "alias": "showPaginator"; "required": false; }; "showCardWrapper": { "alias": "showCardWrapper"; "required": false; }; "readonly": { "alias": "readonly"; "required": false; }; "idField": { "alias": "idField"; "required": false; }; "getPaginatedListObservableMethod": { "alias": "getPaginatedListObservableMethod"; "required": false; }; "exportListToExcelObservableMethod": { "alias": "exportListToExcelObservableMethod"; "required": false; }; "deleteItemFromTableObservableMethod": { "alias": "deleteItemFromTableObservableMethod"; "required": false; }; "deleteListFromTableObservableMethod": { "alias": "deleteListFromTableObservableMethod"; "required": false; }; "newlySelectedItems": { "alias": "newlySelectedItems"; "required": false; }; "unselectedItems": { "alias": "unselectedItems"; "required": false; }; "selectionMode": { "alias": "selectionMode"; "required": false; }; "selectedLazyLoadObservableMethod": { "alias": "selectedLazyLoadObservableMethod"; "required": false; }; "additionalFilterIdLong": { "alias": "additionalFilterIdLong"; "required": false; }; "showAddButton": { "alias": "showAddButton"; "required": false; }; "showExportToExcelButton": { "alias": "showExportToExcelButton"; "required": false; }; "showReloadTableButton": { "alias": "showReloadTableButton"; "required": false; }; "getFormArrayItems": { "alias": "getFormArrayItems"; "required": false; }; "hasLazyLoad": { "alias": "hasLazyLoad"; "required": false; }; "stateKey": { "alias": "stateKey"; "required": false; }; "stateStorage": { "alias": "stateStorage"; "required": false; }; "defaultSortField": { "alias": "defaultSortField"; "required": false; }; "defaultSortOrder": { "alias": "defaultSortOrder"; "required": false; }; "getAlreadySelectedItemIds": { "alias": "getAlreadySelectedItemIds"; "required": false; }; "getAlreadySelectedItems": { "alias": "getAlreadySelectedItems"; "required": false; }; "getFormControl": { "alias": "getFormControl"; "required": false; }; "additionalIndexes": { "alias": "additionalIndexes"; "required": false; }; "navigateOnRowClick": { "alias": "navigateOnRowClick"; "required": false; }; "rowNavigationPath": { "alias": "rowNavigationPath"; "required": false; }; }, { "onTotalRecordsChange": "onTotalRecordsChange"; "onLazyLoad": "onLazyLoad"; "onIsAllSelectedChange": "onIsAllSelectedChange"; "onRowSelect": "onRowSelect"; "onRowUnselect": "onRowUnselect"; }, ["actionsTemplate", "cellTemplates"], never, true, never>;
 }
 export declare class Action {
     name?: string;
@@ -269,6 +303,13 @@ export declare class Column<T = any> {
      * lose its anchor.
      */
     lockVisible?: boolean;
+    /**
+     * CSS length overriding this column's default minimum width (e.g. `'8rem'`). The defaults are
+     * per filter type and sized for the HEADER — filter input plus match-mode dropdown — so they
+     * are generous for a column of short values. It is a MINIMUM, not a width: the table still
+     * distributes the leftover space.
+     */
+    minWidth?: string;
     /**
      * Fired when this column's cell is clicked. Receives a {@link CellClickEvent} with the row id,
      * the column field, the full row, the raw and formatted cell value, the clicked `<td>` element
@@ -279,7 +320,7 @@ export declare class Column<T = any> {
      * Not applied to editable cells — those belong to their inline input.
      */
     onCellClick?: (event: CellClickEvent) => void;
-    constructor({ name, field, filterField, filterType, filterPlaceholder, showMatchModes, showAddButton, dropdownOrMultiselectValues, actions, editable, showTime, decimalPlaces, sortable, visible, lockVisible, onCellClick, }?: {
+    constructor({ name, field, filterField, filterType, filterPlaceholder, showMatchModes, showAddButton, dropdownOrMultiselectValues, actions, editable, showTime, decimalPlaces, sortable, visible, lockVisible, minWidth, onCellClick, }?: {
         name?: string;
         field?: string & keyof T;
         filterField?: string & keyof T;
@@ -295,6 +336,7 @@ export declare class Column<T = any> {
         sortable?: boolean;
         visible?: boolean;
         lockVisible?: boolean;
+        minWidth?: string;
         onCellClick?: (event: CellClickEvent) => void;
     });
 }

package/lib/controls/base-control.d.ts

@@ -19,6 +19,17 @@ export declare class BaseControl {
     constructor(translocoService: TranslocoService);
     ngOnInit(): void;
     ngAfterViewInit(): void;
+    /**
+     * Every control's TEMPLATE renders without a control (`*ngIf="control"`, `control?.errors`,
+     * spiderly-file's no-control custom uploads), and this was the one shared read that did not —
+     * so an absent control took the whole page down through the label rather than rendering
+     * label-less: an unhandled TypeError per change-detection pass, which the global ErrorHandler
+     * turns into the generic error toast.
+     *
+     * That fixes the shared path only. `spiderly-autocomplete`, `spiderly-colorpicker` and
+     * `spiderly-checkbox` (with `initializeToFalse`) still dereference `control` in their own
+     * `ngOnInit`, so those three are not yet safe to hand an absent control.
+     */
     getTranslatedLabel(): string;
     getValidationErrrorMessages(): any;
     static ɵfac: i0.ɵɵFactoryDeclaration<BaseControl, never>;

package/lib/directives/spiderly-cell-template.directive.d.ts

@@ -0,0 +1,47 @@
+import { TemplateRef } from '@angular/core';
+import type { Column } from '../components/spiderly-data-table/spiderly-data-table.component';
+import * as i0 from "@angular/core";
+/**
+ * Context handed to a cell template. Read the row with `let-row`, the rest by name
+ * (`let-value="value"`, `let-displayValue="displayValue"`, `let-col="col"`).
+ *
+ * `value` and `displayValue` mean here exactly what they mean on `CellClickEvent`, the other seam
+ * this component hands a cell to — raw and formatted respectively. One column can use both
+ * (a click handler and a template), so they must not disagree.
+ */
+export interface CellTemplateContext<T = any> {
+    /** The full row object the cell belongs to. */
+    $implicit: T;
+    /** The raw cell value, `row[col.field]`. */
+    value: any;
+    /**
+     * What the table would have rendered — the value formatted for the column's `filterType` and
+     * the app's `LOCALE_ID` (dates, numbers, Yes/No). A template that only adds something around
+     * the value never has to re-implement that formatting.
+     */
+    displayValue: string;
+    /** The column being rendered. */
+    col: Column<T>;
+}
+/**
+ * Renders the cells of ONE column of a `spiderly-data-table`, replacing the plain formatted
+ * value. Bind it to the column's `field`; columns with no matching template keep the built-in
+ * rendering, so a table opts in one column at a time.
+ *
+ * Consumer guide (context, what it does and does not replace, when to prefer it over
+ * `onCellClick`): the `angular-customization` doc, "Custom Cell Content".
+ */
+export declare class SpiderlyCellTemplateDirective<T = any> {
+    readonly template: TemplateRef<CellTemplateContext<T>>;
+    /** The `field` of the column whose cells this template renders. */
+    field: string;
+    constructor(template: TemplateRef<CellTemplateContext<T>>);
+    /**
+     * Without this the `let-` variables are `any` at every consumer, however well
+     * {@link CellTemplateContext} is declared — a directive's injected `TemplateRef<C>` never
+     * reaches the template that declares it. Same mechanism as `SpiderlyTemplateTypeDirective`.
+     */
+    static ngTemplateContextGuard<T>(dir: SpiderlyCellTemplateDirective<T>, ctx: unknown): ctx is CellTemplateContext<T>;
+    static ɵfac: i0.ɵɵFactoryDeclaration<SpiderlyCellTemplateDirective<any>, never>;
+    static ɵdir: i0.ɵɵDirectiveDeclaration<SpiderlyCellTemplateDirective<any>, "ng-template[spiderlyCellTemplate]", never, { "field": { "alias": "spiderlyCellTemplate"; "required": false; }; }, {}, never, never, true, never>;
+}

package/lib/errors/api-error-codes.d.ts

@@ -11,5 +11,8 @@ export declare const ApiErrorCodes: {
     readonly EmailNotVerified: "email_not_verified";
     readonly ExternalProviderNotConfigured: "external_provider_not_configured";
     readonly ExternalEmailMissing: "external_email_missing";
+    readonly UnknownFilterField: "unknown_filter_field";
+    readonly UnknownSortField: "unknown_sort_field";
+    readonly InvalidMatchMode: "invalid_match_mode";
 };
 export type ApiErrorCode = (typeof ApiErrorCodes)[keyof typeof ApiErrorCodes];

package/lib/handlers/spiderly-error-handler.d.ts

@@ -1,13 +1,24 @@
 import { TranslocoService } from '@jsverse/transloco';
 import { ErrorHandler } from '@angular/core';
 import { SpiderlyMessageService } from '../services/spiderly-message.service';
-import { ConfigServiceBase } from '../services/config.service.base';
 import * as i0 from "@angular/core";
+/**
+ * The app's global {@link ErrorHandler}: logs the error and shows the generic error toast. HTTP
+ * errors are skipped entirely — `unauthorizedInterceptor` owns them end to end and has already
+ * logged the failed request and shown the message matched to its status.
+ *
+ * Logging is unconditional, production included. The toast tells the user the team was notified,
+ * and unless the app wires an error tracker this line is the only place the error exists — so
+ * staying quiet in production left a deployed app with a red toast and nothing to open. The
+ * console is a developer surface; a user never sees it.
+ *
+ * An error tracker plugs in by providing an `ErrorHandler` that reports and then delegates here,
+ * which keeps this class's toast copy true (see the PACMS admin's `AdminErrorHandler`).
+ */
 export declare class SpiderlyErrorHandler implements ErrorHandler {
     private messageService;
     private translocoService;
-    private config;
-    constructor(messageService: SpiderlyMessageService, translocoService: TranslocoService, config: ConfigServiceBase);
+    constructor(messageService: SpiderlyMessageService, translocoService: TranslocoService);
     handleError(error: any): void;
     static ɵfac: i0.ɵɵFactoryDeclaration<SpiderlyErrorHandler, never>;
     static ɵprov: i0.ɵɵInjectableDeclaration<SpiderlyErrorHandler>;

package/lib/services/config.service.base.d.ts

@@ -1,6 +1,12 @@
 import { HttpHeaders, HttpParams } from '@angular/common/http';
 import * as i0 from "@angular/core";
 export declare class ConfigServiceBase {
+    /**
+     * Consumer-facing only — nothing in the library reads it. The error handler and the HTTP
+     * interceptor used to gate their `console.error` on it, which left a deployed app's client
+     * errors with nowhere to go; both now log unconditionally. `spiderly init` still scaffolds the
+     * `override`, so apps keep branching on it.
+     */
     production: boolean;
     apiUrl: string;
     frontendUrl: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "spiderly",
-  "version": "19.11.3",
+  "version": "19.11.4",
   "author": "Filip Trivan",
   "license": "MIT",
   "description": "Spiderly Angular Library to use in combination with Spiderly.",

package/public-api.d.ts

@@ -90,5 +90,6 @@ export * from './lib/services/helper-functions';
 export * from './lib/services/spiderly-message.service';
 export * from './lib/services/spiderly-transloco-loader';
 export * from './lib/services/validator-abstract.service';
+export * from './lib/directives/spiderly-cell-template.directive';
 export * from './lib/directives/spiderly-data-table-actions.directive';
 export * from './lib/directives/template-type.directive';