@theseam/ui-common 1.0.0-beta.0 → 1.0.0-beta.2

package/graphql/index.d.ts

@@ -24,6 +24,18 @@ declare function inlineVariable(query: DocumentNode$1, variableName: string, var
 
 declare function parseComments(ast: DocumentNode): Token[];
 
+declare class GQLDirection {
+    readonly direction: string;
+    constructor(direction: string);
+    static readonly ASC: GQLDirection;
+    static readonly DESC: GQLDirection;
+}
+
+interface HintTransformOperation {
+    query: DocumentNode$1;
+    variables: Record<string, any>;
+}
+
 declare enum HintsKind {
     OperationDefinition = "OperationDefinition",
     Field = "Field",
@@ -38,6 +50,15 @@ interface HintsToken {
     kind: HintsKind;
 }
 
+type HintTransformer = (operation: HintTransformOperation, hintsToken: HintsToken) => HintTransformOperation;
+
+interface HintDefinition {
+    readonly name: string;
+    readonly appliesTo: HintsKind[];
+    readonly transformer?: HintTransformer;
+}
+
+declare const DEFAULT_TO_REMOVE_ON_UNDEFINED: string[];
 interface QueryProcessingVariablesConfig {
     removeIfNotDefined?: string[];
     removeIfNotUsed?: string[];
@@ -51,6 +72,12 @@ interface QueryProcessingConfig {
     disablePaging?: boolean;
 }
 
+declare class GQLVariable {
+    readonly name: string;
+    readonly type: string;
+    constructor(name: string, type: string);
+}
+
 type GqlDatatableAccessor = Pick<DatatableComponent, 'page' | 'sort' | 'sorts' | 'filterStates'> & {
     ngxDatatable: {
         offset: number;
@@ -210,6 +237,21 @@ declare const mapSearchNumericColumnsDataFilterStateToGql: (filterState: Columns
 
 declare const mapSearchTextColumnsDataFilterStateToGql: (filterState: ColumnsDataFilterState<TheSeamColumnsDataFilterTextSearchFormState>, context: MapperContext<any>) => FilterStateMapperResult;
 
+declare const inlineVariableTransformer: HintTransformer;
+
+declare const removeNotDefinedTransformer: HintTransformer;
+
+/**
+ * Maps variable value to gql and inlines it into the query.
+ */
+declare const inlineVariableHintDef: HintDefinition;
+
+/**
+ * Remove the variable from the query if it is not defined in the operation
+ * variables.
+ */
+declare const removeNotDefinedHintDef: HintDefinition;
+
 declare const baseSchemaFragment: apollo_angular.TypedDocumentNode<unknown, unknown>;
 
 interface WhereItemDef {
@@ -332,5 +374,5 @@ interface SimpleGqlTestVariables extends SimpleGqlTestExtraVariables {
     where?: any;
 }
 
-export { DATATABLE_GRAPHQL_SERVICE_CONFIG, DEFAULT_PAGE_SIZE, DatatableGraphQLQueryRef, DatatableGraphqlService, HINT_NAMES_CAPTURE_REGEX, HINT_PREFIX_REGEX, MockDatatable, SIMPLE_GQL_TEST_QUERY, baseSchemaFragment, checkRecordsHaveValue, containsVariable, createApolloTestingProvider, createHintsToken, createSimpleGqlTestRecord, createSimpleGqlTestRoot, filterWhere, filteredResults, getHintsToken, getPageInfo, getTokenAppliesTo, gqlVar, hintNamesFromHintToken, hintsTokensContainingHint, inlineVariable, isCommentToken, isHintToken, isInlineComment, mapFilterStates, mapSearchDateColumnsDataFilterStateToGql, mapSearchNumericColumnsDataFilterStateToGql, mapSearchTextColumnsDataFilterStateToGql, observeRowsWithGqlInputsHandling, parseAst, parseComments, parseHints, removeVariable, removeVariableDefinition, removeVariableDefinitionsNotDefined, simpleGqlTestSchema, skipAndTake, toGQL };
-export type { DatatableGraphQLDataMapper, DatatableGraphQLDataMapperResult, DatatableGraphQLVariables, DatatableGraphqlServiceConfig, DatatableQueryOptions, FilterStateMapper, FilterStateMapperFilter, FilterStateMapperResult, FilterStateMapperVariables, FilterStateMappers, FilteredResults, FilteredResultsPageInfo, MapperContext, SimpleGqlTestExtraVariables, SimpleGqlTestRecord, SimpleGqlTestVariables, SortsMapper, SortsMapperResult, WhereArg };
+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, MockDatatable, SIMPLE_GQL_TEST_QUERY, baseSchemaFragment, checkRecordsHaveValue, containsVariable, createApolloTestingProvider, createHintsToken, createSimpleGqlTestRecord, createSimpleGqlTestRoot, filterWhere, filteredResults, getHintsToken, getPageInfo, getTokenAppliesTo, gqlVar, hintNamesFromHintToken, hintsTokensContainingHint, inlineVariable, inlineVariableHintDef, inlineVariableTransformer, isCommentToken, isHintToken, isInlineComment, mapFilterStates, mapSearchDateColumnsDataFilterStateToGql, mapSearchNumericColumnsDataFilterStateToGql, mapSearchTextColumnsDataFilterStateToGql, observeRowsWithGqlInputsHandling, parseAst, parseComments, parseHints, removeNotDefinedHintDef, removeNotDefinedTransformer, removeVariable, removeVariableDefinition, removeVariableDefinitionsNotDefined, simpleGqlTestSchema, skipAndTake, toGQL };
+export type { DatatableGraphQLDataMapper, DatatableGraphQLDataMapperResult, DatatableGraphQLVariables, DatatableGraphqlServiceConfig, DatatableQueryOptions, EmptyObject, FilterStateMapper, FilterStateMapperFilter, FilterStateMapperResult, FilterStateMapperVariables, FilterStateMappers, FilteredResults, FilteredResultsPageInfo, GqlDatatableAccessor, HintDefinition, HintTransformOperation, HintTransformer, HintsToken, MapperContext, QueryProcessingConfig, QueryProcessingVariablesConfig, SimpleGqlTestExtraVariables, SimpleGqlTestRecord, SimpleGqlTestVariables, SortsMapper, SortsMapperResult, WhereArg };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@theseam/ui-common",
-  "version": "1.0.0-beta.0",
+  "version": "1.0.0-beta.2",
   "peerDependencies": {
     "@angular/cdk": "^20.2.3",
     "@angular/common": "^20.3.0",
@@ -134,14 +134,14 @@
       "types": "./ai/index.d.ts",
       "default": "./fesm2022/theseam-ui-common-ai.mjs"
     },
-    "./breadcrumbs": {
-      "types": "./breadcrumbs/index.d.ts",
-      "default": "./fesm2022/theseam-ui-common-breadcrumbs.mjs"
-    },
     "./asset-reader": {
       "types": "./asset-reader/index.d.ts",
       "default": "./fesm2022/theseam-ui-common-asset-reader.mjs"
     },
+    "./breadcrumbs": {
+      "types": "./breadcrumbs/index.d.ts",
+      "default": "./fesm2022/theseam-ui-common-breadcrumbs.mjs"
+    },
     "./buttons": {
       "types": "./buttons/index.d.ts",
       "default": "./fesm2022/theseam-ui-common-buttons.mjs"
@@ -154,30 +154,30 @@
       "types": "./carousel/index.d.ts",
       "default": "./fesm2022/theseam-ui-common-carousel.mjs"
     },
-    "./confirm-dialog": {
-      "types": "./confirm-dialog/index.d.ts",
-      "default": "./fesm2022/theseam-ui-common-confirm-dialog.mjs"
+    "./checkbox": {
+      "types": "./checkbox/index.d.ts",
+      "default": "./fesm2022/theseam-ui-common-checkbox.mjs"
     },
     "./core": {
       "types": "./core/index.d.ts",
       "default": "./fesm2022/theseam-ui-common-core.mjs"
     },
-    "./checkbox": {
-      "types": "./checkbox/index.d.ts",
-      "default": "./fesm2022/theseam-ui-common-checkbox.mjs"
+    "./confirm-dialog": {
+      "types": "./confirm-dialog/index.d.ts",
+      "default": "./fesm2022/theseam-ui-common-confirm-dialog.mjs"
     },
     "./data-exporter": {
       "types": "./data-exporter/index.d.ts",
       "default": "./fesm2022/theseam-ui-common-data-exporter.mjs"
     },
-    "./datatable": {
-      "types": "./datatable/index.d.ts",
-      "default": "./fesm2022/theseam-ui-common-datatable.mjs"
-    },
     "./data-filters": {
       "types": "./data-filters/index.d.ts",
       "default": "./fesm2022/theseam-ui-common-data-filters.mjs"
     },
+    "./datatable": {
+      "types": "./datatable/index.d.ts",
+      "default": "./fesm2022/theseam-ui-common-datatable.mjs"
+    },
     "./datatable-alterations-display": {
       "types": "./datatable-alterations-display/index.d.ts",
       "default": "./fesm2022/theseam-ui-common-datatable-alterations-display.mjs"
@@ -190,6 +190,10 @@
       "types": "./dynamic/index.d.ts",
       "default": "./fesm2022/theseam-ui-common-dynamic.mjs"
     },
+    "./footer-bar": {
+      "types": "./footer-bar/index.d.ts",
+      "default": "./fesm2022/theseam-ui-common-footer-bar.mjs"
+    },
     "./dynamic-component-loader": {
       "types": "./dynamic-component-loader/index.d.ts",
       "default": "./fesm2022/theseam-ui-common-dynamic-component-loader.mjs"
@@ -202,10 +206,6 @@
       "types": "./form-field-error/index.d.ts",
       "default": "./fesm2022/theseam-ui-common-form-field-error.mjs"
     },
-    "./footer-bar": {
-      "types": "./footer-bar/index.d.ts",
-      "default": "./fesm2022/theseam-ui-common-footer-bar.mjs"
-    },
     "./framework": {
       "types": "./framework/index.d.ts",
       "default": "./fesm2022/theseam-ui-common-framework.mjs"
@@ -226,17 +226,13 @@
       "types": "./layout/index.d.ts",
       "default": "./fesm2022/theseam-ui-common-layout.mjs"
     },
-    "./menu": {
-      "types": "./menu/index.d.ts",
-      "default": "./fesm2022/theseam-ui-common-menu.mjs"
-    },
     "./loading": {
       "types": "./loading/index.d.ts",
       "default": "./fesm2022/theseam-ui-common-loading.mjs"
     },
-    "./modal": {
-      "types": "./modal/index.d.ts",
-      "default": "./fesm2022/theseam-ui-common-modal.mjs"
+    "./menu": {
+      "types": "./menu/index.d.ts",
+      "default": "./fesm2022/theseam-ui-common-menu.mjs"
     },
     "./navigation-reload": {
       "types": "./navigation-reload/index.d.ts",
@@ -246,14 +242,22 @@
       "types": "./popover/index.d.ts",
       "default": "./fesm2022/theseam-ui-common-popover.mjs"
     },
-    "./models": {
-      "types": "./models/index.d.ts",
-      "default": "./fesm2022/theseam-ui-common-models.mjs"
+    "./progress": {
+      "types": "./progress/index.d.ts",
+      "default": "./fesm2022/theseam-ui-common-progress.mjs"
+    },
+    "./modal": {
+      "types": "./modal/index.d.ts",
+      "default": "./fesm2022/theseam-ui-common-modal.mjs"
     },
     "./rich-text": {
       "types": "./rich-text/index.d.ts",
       "default": "./fesm2022/theseam-ui-common-rich-text.mjs"
     },
+    "./scrollbar": {
+      "types": "./scrollbar/index.d.ts",
+      "default": "./fesm2022/theseam-ui-common-scrollbar.mjs"
+    },
     "./services": {
       "types": "./services/index.d.ts",
       "default": "./fesm2022/theseam-ui-common-services.mjs"
@@ -262,10 +266,6 @@
       "types": "./shared/index.d.ts",
       "default": "./fesm2022/theseam-ui-common-shared.mjs"
     },
-    "./scrollbar": {
-      "types": "./scrollbar/index.d.ts",
-      "default": "./fesm2022/theseam-ui-common-scrollbar.mjs"
-    },
     "./storage": {
       "types": "./storage/index.d.ts",
       "default": "./fesm2022/theseam-ui-common-storage.mjs"
@@ -278,26 +278,26 @@
       "types": "./tabbed/index.d.ts",
       "default": "./fesm2022/theseam-ui-common-tabbed.mjs"
     },
-    "./table-cell-type": {
-      "types": "./table-cell-type/index.d.ts",
-      "default": "./fesm2022/theseam-ui-common-table-cell-type.mjs"
-    },
     "./table": {
       "types": "./table/index.d.ts",
       "default": "./fesm2022/theseam-ui-common-table.mjs"
     },
+    "./table-cell-type": {
+      "types": "./table-cell-type/index.d.ts",
+      "default": "./fesm2022/theseam-ui-common-table-cell-type.mjs"
+    },
     "./table-cell-types": {
       "types": "./table-cell-types/index.d.ts",
       "default": "./fesm2022/theseam-ui-common-table-cell-types.mjs"
     },
-    "./tel-input": {
-      "types": "./tel-input/index.d.ts",
-      "default": "./fesm2022/theseam-ui-common-tel-input.mjs"
-    },
     "./testing": {
       "types": "./testing/index.d.ts",
       "default": "./fesm2022/theseam-ui-common-testing.mjs"
     },
+    "./tel-input": {
+      "types": "./tel-input/index.d.ts",
+      "default": "./fesm2022/theseam-ui-common-tel-input.mjs"
+    },
     "./tiled-select": {
       "types": "./tiled-select/index.d.ts",
       "default": "./fesm2022/theseam-ui-common-tiled-select.mjs"
@@ -306,17 +306,17 @@
       "types": "./toggle-edit/index.d.ts",
       "default": "./fesm2022/theseam-ui-common-toggle-edit.mjs"
     },
-    "./unsaved-changes-dialog": {
-      "types": "./unsaved-changes-dialog/index.d.ts",
-      "default": "./fesm2022/theseam-ui-common-unsaved-changes-dialog.mjs"
+    "./tooltip": {
+      "types": "./tooltip/index.d.ts",
+      "default": "./fesm2022/theseam-ui-common-tooltip.mjs"
     },
     "./toggle-group": {
       "types": "./toggle-group/index.d.ts",
       "default": "./fesm2022/theseam-ui-common-toggle-group.mjs"
     },
-    "./tooltip": {
-      "types": "./tooltip/index.d.ts",
-      "default": "./fesm2022/theseam-ui-common-tooltip.mjs"
+    "./unsaved-changes-dialog": {
+      "types": "./unsaved-changes-dialog/index.d.ts",
+      "default": "./fesm2022/theseam-ui-common-unsaved-changes-dialog.mjs"
     },
     "./utils": {
       "types": "./utils/index.d.ts",
@@ -338,9 +338,9 @@
       "types": "./widget/index.d.ts",
       "default": "./fesm2022/theseam-ui-common-widget.mjs"
     },
-    "./progress": {
-      "types": "./progress/index.d.ts",
-      "default": "./fesm2022/theseam-ui-common-progress.mjs"
+    "./models": {
+      "types": "./models/index.d.ts",
+      "default": "./fesm2022/theseam-ui-common-models.mjs"
     }
   },
   "sideEffects": false