@theseam/ui-common 1.0.2-beta.23 → 1.0.2-beta.29

package/graphql/index.d.ts

@@ -3,7 +3,7 @@ import { DocumentNode, ValueNode, Token } from 'graphql/language';
 import { DocumentNode as DocumentNode$1, ValueNode as ValueNode$1, OperationDefinitionNode, VariableDefinitionNode, VariableNode, ArgumentNode, FieldNode, Token as Token$1, GraphQLFormattedError } from 'graphql';
 import { Operation } from '@apollo/client';
 import { Observable } from 'rxjs';
-import { DatatableComponent, SortItem, TheSeamPageInfo, ColumnsDataFilterState, TheSeamColumnsDataFilterDateSearchFormState, TheSeamColumnsDataFilterDateSearchOptions, TheSeamColumnsDataFilterNumericSearchFormState, TheSeamColumnsDataFilterTextSearchFormState, SortEvent } from '@theseam/ui-common/datatable';
+import { DatatableComponent, TheSeamDatatableColumn, SortItem, TheSeamPageInfo, ColumnsDataFilterState, TheSeamColumnsDataFilterDateSearchFormState, TheSeamColumnsDataFilterDateSearchOptions, TheSeamColumnsDataFilterNumericSearchFormState, TheSeamColumnsDataFilterTextSearchFormState, SortEvent } from '@theseam/ui-common/datatable';
 import * as apollo_angular from 'apollo-angular';
 import { QueryRef, WatchQueryOptions, Apollo } from 'apollo-angular';
 import { DataFilterState } from '@theseam/ui-common/data-filters';
@@ -124,7 +124,7 @@ declare class GQLVariable {
     constructor(name: string, type: string);
 }
 
-type GqlDatatableAccessor = Pick<DatatableComponent, 'page' | 'sort' | 'sorts' | 'filterStates' | 'pageInfo' | 'externalSorting'> & {
+type GqlDatatableAccessor = Pick<DatatableComponent, 'page' | 'sort' | 'sorts' | 'filterStates' | 'pageInfo' | 'externalSorting' | 'columns$'> & {
     ngxDatatable: {
         offset: number;
         pageSize: number;
@@ -273,6 +273,7 @@ declare class DatatableGraphQLQueryRef<TData, TVariables extends DatatableGraphQ
 
 type MapperContext<TExtraVariables = EmptyObject> = {
     extraVariables: TExtraVariables;
+    columns?: TheSeamDatatableColumn[];
 } & {
     [name: string]: any;
 };
@@ -361,37 +362,57 @@ type SortsMapperFieldEntry = string | null | ((prop: string, context: MapperCont
 type SortsMapperFieldMap<TRow extends Record<string, any>> = {
     [K in keyof TRow & string]?: SortsMapperFieldEntry;
 };
+/**
+ * Options for {@link createSortsMapper}.
+ */
+interface CreateSortsMapperOptions {
+    /**
+     * When `true` (the default), sort items whose `prop` is not listed in
+     * the field map are automatically mapped using the prop value as the
+     * GQL field name, provided a column with that prop exists in the
+     * current datatable and has `sortable` not explicitly set to `false`.
+     *
+     * This eliminates boilerplate for the common case where column props
+     * match GQL field names. The field map becomes an override/exclusion
+     * map: list only columns that need a different GQL name or `null` to
+     * suppress sorting.
+     *
+     * Set to `false` to require every sortable column to be explicitly
+     * listed in the field map (with a dev-mode error for unmapped props).
+     */
+    autoMap?: boolean;
+}
 /**
  * Creates a {@link SortsMapper} from a declarative field-name map.
  *
- * Each key must correspond to a datatable column `prop` value. The value
- * controls how that column's sort is translated to a GQL sort object:
+ * By default, `autoMap` is enabled: columns not listed in the field map
+ * are automatically mapped using their `prop` as the GQL field name,
+ * provided the column exists in the datatable and has `sortable` not
+ * explicitly set to `false`. This guards against stale sort preferences
+ * for removed columns.
+ *
+ * Each key in `fieldMap` must correspond to a datatable column `prop`
+ * value. The value controls how that column's sort is translated:
  *
  * - `string`   – emits `{ [gqlField]: 'ASC' | 'DESC' }`
  * - `null`     – column is not sortable; the sort item is dropped
  * - `function` – called with `(prop, context)` and may return a field
  *                name or `null` to drop the item dynamically
  *
- * In dev mode an error is thrown when a sort item's `prop` is not present
- * in the map. In production the item is silently dropped.
- *
  * @example
- * // Simple static mapping
+ * // Auto-map all columns, override one
  * const mapSorts = createSortsMapper<MyRow>({
- *   id: 'id',
- *   name: 'name',
+ *   computedField: 'gql_computed_field',
  * })
  *
  * @example
- * // Dynamic mapping with context access
+ * // Opt out of auto-mapping (explicit field map required)
  * const mapSorts = createSortsMapper<MyRow>({
  *   id: 'id',
  *   name: 'name',
- *   computed: (prop, context) =>
- *     context.extraVariables.useAlt ? 'altField' : prop,
- * })
+ * }, { autoMap: false })
  */
-declare function createSortsMapper<TRow extends Record<string, any>>(fieldMap: SortsMapperFieldMap<TRow>): SortsMapper;
+declare function createSortsMapper<TRow extends Record<string, any>>(fieldMap: SortsMapperFieldMap<TRow>, options?: CreateSortsMapperOptions): SortsMapper;
 
 /**
  * NOTE: Any of ApolloClient's WatchQueryOptions properties can be set, but I
@@ -505,6 +526,8 @@ interface FilteredResults<T> {
 declare function filteredResults<T>(items: T[], args: any): FilteredResults<T>;
 
 declare class MockDatatable implements GqlDatatableAccessor {
+    private readonly _columnsSubject;
+    readonly columns$: Observable<TheSeamDatatableColumn[]>;
     private readonly _filterStatesSubject;
     private _sorts;
     private _rows;
@@ -527,6 +550,7 @@ declare class MockDatatable implements GqlDatatableAccessor {
         limit?: number;
         count: number;
     };
+    setColumns(v: TheSeamDatatableColumn[]): void;
     setSorts(v: SortItem[]): void;
     setFilterStates(v: DataFilterState[]): void;
     getNumPages(): number;
@@ -592,4 +616,4 @@ interface SimpleGqlTestVariables extends SimpleGqlTestExtraVariables {
 }
 
 export { DATATABLE_GRAPHQL_SERVICE_CONFIG, DEFAULT_PAGE_SIZE, DEFAULT_TO_REMOVE_ON_UNDEFINED, DatatableGraphQLQueryRef, DatatableGraphqlService, GQLDirection, GQLVariable, HINT_NAMES_CAPTURE_REGEX, HINT_PREFIX_REGEX, HintsKind, MAX_ERROR_RECOVERY_ATTEMPTS, MockDatatable, SIMPLE_GQL_TEST_QUERY, SIMPLE_GQL_TEST_SEARCH_QUERY, baseSchemaFragment, checkRecordsHaveValue, containsVariable, createHintsToken, createMockApolloTestingProvider, createSimpleGqlTestRecord, createSimpleGqlTestRoot, createSortsMapper, filterWhere, filteredResults, getHintsToken, getPageInfo, getTokenAppliesTo, gqlVar, hintNamesFromHintToken, hintsTokensContainingHint, inlineVariable, inlineVariableHintDef, inlineVariableTransformer, isCommentToken, isHintToken, isInlineComment, logQueryLink, mapFilterStates, mapSearchDateColumnsDataFilterStateToGql, mapSearchNumericColumnsDataFilterStateToGql, mapSearchTextColumnsDataFilterStateToGql, mockGraphQLLink, observeRowsWithGqlInputsHandling, parseAst, parseComments, parseHints, queryProcessingLink, removeNotDefinedHintDef, removeNotDefinedTransformer, removeVariable, removeVariableDefinition, removeVariableDefinitionsNotDefined, skipAndTake, sortItems, toGQL };
-export type { DatatableGraphQLDataMapper, DatatableGraphQLDataMapperResult, DatatableGraphQLErrorHandler, DatatableGraphQLVariables, DatatableGraphqlServiceConfig, DatatableQueryOptions, EmptyObject, FilterStateMapper, FilterStateMapperFilter, FilterStateMapperResult, FilterStateMapperVariables, FilterStateMappers, FilteredResults, FilteredResultsPageInfo, GqlDatatableAccessor, HintDefinition, HintTransformOperation, HintTransformer, HintsToken, LogQueryLinkOptions, MapperContext, MockApolloTestingProviderOptions, MockGraphQLLinkOptions, QueryProcessingConfig, QueryProcessingVariablesConfig, SimpleGqlTestExtraVariables, SimpleGqlTestRecord, SimpleGqlTestVariables, SortClause, SortsMapper, SortsMapperFieldEntry, SortsMapperFieldMap, SortsMapperResult, TypedFilterInput, TypedFilterStateMapperResult, WhereArg };
+export type { CreateSortsMapperOptions, DatatableGraphQLDataMapper, DatatableGraphQLDataMapperResult, DatatableGraphQLErrorHandler, DatatableGraphQLVariables, DatatableGraphqlServiceConfig, DatatableQueryOptions, EmptyObject, FilterStateMapper, FilterStateMapperFilter, FilterStateMapperResult, FilterStateMapperVariables, FilterStateMappers, FilteredResults, FilteredResultsPageInfo, GqlDatatableAccessor, HintDefinition, HintTransformOperation, HintTransformer, HintsToken, LogQueryLinkOptions, MapperContext, MockApolloTestingProviderOptions, MockGraphQLLinkOptions, QueryProcessingConfig, QueryProcessingVariablesConfig, SimpleGqlTestExtraVariables, SimpleGqlTestRecord, SimpleGqlTestVariables, SortClause, SortsMapper, SortsMapperFieldEntry, SortsMapperFieldMap, SortsMapperResult, TypedFilterInput, TypedFilterStateMapperResult, WhereArg };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@theseam/ui-common",
-  "version": "1.0.2-beta.23",
+  "version": "1.0.2-beta.29",
   "peerDependencies": {
     "@angular/cdk": "^20.2.3",
     "@angular/common": "^20.3.0",
@@ -16,7 +16,7 @@
     "@fortawesome/free-solid-svg-icons": "^5.15.3"
   },
   "dependencies": {
-    "@marklb/file-type": "~10.6.5",
+    "file-type": "~22.0.0",
     "@marklb/ngx-datatable": "21.0.0-alpha.2",
     "ngx-loading": "^17.0.0",
     "@ng-select/ng-select": "^20.2.2",
@@ -43,7 +43,7 @@
     "@turf/boolean-contains": "^7.2.0",
     "@turf/helpers": "^7.2.0",
     "@turf/kinks": "^7.2.0",
-    "shpjs": "^4.0.2",
+    "shpjs": "^6.2.0",
     "@types/geojson": "^7946.0.8",
     "tslib": "^2.3.0"
   },

package/utils/index.d.ts

@@ -5,7 +5,6 @@ import { Observable } from 'rxjs';
 import { ActivatedRoute, Data, ActivatedRouteSnapshot } from '@angular/router';
 import { FeatureCollection, GeoJSON, Feature, GeoJsonProperties, Geometry, Polygon, MultiPolygon } from 'geojson';
 import { AreaUnits } from '@turf/helpers';
-import { Buffer } from 'buffer/';
 
 /**
  * Finds the closest CdkDrag to an element by looking at the DOM.
@@ -224,7 +223,7 @@ declare function noKinksValidator(): ValidatorFn;
  * Reads a File, or buffer of file content, in GeoJSON or ESRI Shapefile format
  * and returns a GeoJSON `FeatureCollection`.
  */
-declare function readGeoFile(fileOrBuffer: File | ArrayBuffer | Buffer): Promise<FeatureCollection>;
+declare function readGeoFile(fileOrBuffer: File | ArrayBuffer): Promise<FeatureCollection>;
 
 /**
  * Split all MultiPolygon into Polygon. Any properties, other than
@@ -336,16 +335,16 @@ declare function deleteProperty<T extends object, K extends keyof T>(obj: T, pro
 /** Delete properties of object */
 declare function deleteProperties<T extends object, K extends keyof T>(obj: T, propNames: K[]): void;
 
-declare function readFileAsync(file: any): Promise<ArrayBuffer | null>;
+declare function readFileAsync(file: Blob): Promise<ArrayBuffer | null>;
 declare function readFileAsDataUrlAsync(file: Blob): Promise<string | null>;
-declare function fileBufferToBlob(fileBuffer: Buffer, defaultMime?: string): Promise<Blob>;
-declare function fileBufferToObjectUrl(fileBuffer: Buffer, defaultMime?: string): Promise<string>;
+declare function fileBufferToBlob(buffer: Uint8Array | ArrayBuffer, defaultMime?: string): Promise<Blob>;
+declare function fileBufferToObjectUrl(buffer: Uint8Array | ArrayBuffer, defaultMime?: string): Promise<string>;
 interface IFileData {
     ext?: string;
     mime?: string;
     blob: Blob;
 }
-declare function fileDataFromBuffer(fileBuffer: Buffer | Uint8Array | ArrayBuffer, defaultMime?: string): Promise<IFileData>;
+declare function fileDataFromBuffer(buffer: Uint8Array | ArrayBuffer, defaultMime?: string): Promise<IFileData>;
 declare function openBlob(blob: Blob, target?: string, filename?: string): void;
 
 declare function notNullOrUndefined<T>(value: T | null | undefined): value is T;