@genesislcap/grid-tabulator 14.214.2 → 14.214.4

package/dist/dts/grid-tabulator.d.ts

@@ -49,6 +49,11 @@ declare const GridTabulator_base: (new (...args: any[]) => {
     readonly clientTop: number;
     readonly clientWidth: number;
     id: string;
+    /**
+     * The grid-tabulator component registration.
+     * @public
+     * @privateRemarks explicitly declaring for extensibility
+     */
     readonly localName: string;
     readonly namespaceURI: string;
     onfullscreenchange: (this: Element, ev: Event) => any;
@@ -345,6 +350,20 @@ export declare class GridTabulator extends GridTabulator_base {
     private rehydrationAttempted;
     connectedCallback(): void;
     disconnectedCallback(): void;
+    /**
+     * The current grid options.
+     * @public
+     * @example
+     * ```ts
+     *  ...
+     *  const options = this.grid.getOptions();
+     *  logger.debug(options); // { data: [...], columns: [...], filterMode: "local", groupBy: false, ... }
+     *  ...
+     * ```
+     * @remarks
+     * See https://tabulator.info/docs/6.3/options for more details.
+     */
+    get gridOptions(): Options;
     set gridOptions(options: Options);
     get statePersistanceEnabled(): boolean;
     saveGridState(): void;
@@ -373,12 +392,21 @@ export declare class GridTabulator extends GridTabulator_base {
     private insertFontFace;
     private destroyFontFace;
 }
+/**
+ * The grid-tabulator component registration.
+ * @public
+ * @privateRemarks explicitly declaring for extensibility
+ */
 export declare const gridTabulatorShadowOptions: ShadowRootInit;
+/**
+ * The default grid-tabulator configuration.
+ * @public
+ */
 export declare const defaultGridTabulatorConfig: {
     shadowOptions: any;
 };
 /**
- * The Foundation GridTabulator
+ * The Foundation grid-tabulator
  *
  * @alpha
  * @remarks

package/dist/dts/grid-tabulator.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"grid-tabulator.d.ts","sourceRoot":"","sources":["../../src/grid-tabulator.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,iBAAiB,EAAE,MAAM,4BAA4B,CAAC;AAE/D,OAAO,EACL,eAAe,EACf,YAAY,EACZ,OAAO,EACP,cAAc,EACd,aAAa,IAAI,SAAS,EAC3B,MAAM,kBAAkB,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAiB1B;;;GAGG;AACH,qBAAa,aAAc,SAAQ,kBAAiC;IACtD,IAAI,EAAE,SAAS,GAAG,SAAS,CAAC;IAC5B,OAAO,EAAE,cAAc,CAAC;IAExB,YAAY,SAAgC;IAC5C,UAAU,EAAE,MAAM,CAAC;IAEnB,OAAO,EAAE,GAAG,EAAE,CAAC;IAC3B,cAAc,CAAC,QAAQ,KAAA,EAAE,QAAQ,KAAA;IAOjC,sBAAsB,EAAE,OAAO,CAAS;IAEwB,mBAAmB,EAAE,OAAO,CACpF;IAEyC,qBAAqB,EAAE,MAAM,CAAC;IAEzE,SAAS,EAAE,MAAM,CAAoB;IAErC,KAAK,EAAE,MAAM,CAAY;IAC/B,YAAY,CAAC,QAAQ,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM;IAY/C,OAAO,CAAC,oBAAoB,CAAS;IAOrC,iBAAiB,IAAI,IAAI;IAOzB,oBAAoB,IAAI,IAAI;IAO5B,IAAI,WAAW,CAAC,OAAO,EAAE,OAAO,EA6B/B;IAED,IAAI,uBAAuB,IAAI,OAAO,CAKrC;IAED,aAAa;IAcb,gBAAgB;IAoBhB;;;;;;;OAOG;IACH,SAAS,CAAC,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,YAAY,CAAC,EAAE,YAAY;IAItF;;;;;;;;;OASG;IACH,cAAc,CACZ,IAAI,EAAE,KAAK,GAAG,MAAM,GAAG,MAAM,EAC7B,QAAQ,EAAE,MAAM,EAChB,MAAM,CAAC,EAAE,eAAe,EACxB,MAAM,CAAC,EAAE,cAAc;IAKzB,OAAO,CAAC,eAAe,CAAa;IAEpC,OAAO,CAAC,cAAc;IAStB,OAAO,CAAC,eAAe;CAMxB;AAGD,eAAO,MAAM,0BAA0B,EAAE,cAA0B,CAAC;AAEpE,eAAO,MAAM,0BAA0B;;CAEtC,CAAC;AAEF;;;;;;GAMG;AACH,eAAO,MAAM,uBAAuB;;;;;;;;;;wBAMlC,CAAC"}
+{"version":3,"file":"grid-tabulator.d.ts","sourceRoot":"","sources":["../../src/grid-tabulator.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,iBAAiB,EAAE,MAAM,4BAA4B,CAAC;AAE/D,OAAO,EACL,eAAe,EACf,YAAY,EACZ,OAAO,EACP,cAAc,EACd,aAAa,IAAI,SAAS,EAC3B,MAAM,kBAAkB,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IA0N1B;;;;OAIG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA7MH;;;GAGG;AACH,qBAAa,aAAc,SAAQ,kBAAiC;IACtD,IAAI,EAAE,SAAS,GAAG,SAAS,CAAC;IAC5B,OAAO,EAAE,cAAc,CAAC;IAExB,YAAY,SAAgC;IAC5C,UAAU,EAAE,MAAM,CAAC;IAEnB,OAAO,EAAE,GAAG,EAAE,CAAC;IAC3B,cAAc,CAAC,QAAQ,KAAA,EAAE,QAAQ,KAAA;IAOjC,sBAAsB,EAAE,OAAO,CAAS;IAEwB,mBAAmB,EAAE,OAAO,CACpF;IAEyC,qBAAqB,EAAE,MAAM,CAAC;IAEzE,SAAS,EAAE,MAAM,CAAoB;IAErC,KAAK,EAAE,MAAM,CAAY;IAC/B,YAAY,CAAC,QAAQ,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM;IAY/C,OAAO,CAAC,oBAAoB,CAAS;IAOrC,iBAAiB,IAAI,IAAI;IAOzB,oBAAoB,IAAI,IAAI;IAO5B;;;;;;;;;;;;OAYG;IACH,IAAI,WAAW,IAAI,OAAO,CAEzB;IAED,IAAI,WAAW,CAAC,OAAO,EAAE,OAAO,EA6B/B;IAED,IAAI,uBAAuB,IAAI,OAAO,CAKrC;IAED,aAAa;IAcb,gBAAgB;IAoBhB;;;;;;;OAOG;IACH,SAAS,CAAC,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,YAAY,CAAC,EAAE,YAAY;IAItF;;;;;;;;;OASG;IACH,cAAc,CACZ,IAAI,EAAE,KAAK,GAAG,MAAM,GAAG,MAAM,EAC7B,QAAQ,EAAE,MAAM,EAChB,MAAM,CAAC,EAAE,eAAe,EACxB,MAAM,CAAC,EAAE,cAAc;IAKzB,OAAO,CAAC,eAAe,CAAa;IAEpC,OAAO,CAAC,cAAc;IAStB,OAAO,CAAC,eAAe;CAMxB;AAED;;;;GAIG;AACH,eAAO,MAAM,0BAA0B,EAAE,cAA0B,CAAC;AAEpE;;;GAGG;AACH,eAAO,MAAM,0BAA0B;;CAEtC,CAAC;AAEF;;;;;;GAMG;AACH,eAAO,MAAM,uBAAuB;;;;;;;;;;wBAMlC,CAAC"}

package/dist/dts/grid-tabulator.definitions.d.ts

@@ -1,7 +1,46 @@
-export declare function getFilterByFieldType(type: string): any;
-export declare function getColumnType(metadataType: string): any;
-export declare function getFilterParamsByFieldType(type: string): any;
-export declare function dateValueFormatter({ value }: any): any;
-export declare function dateTimeValueFormatter({ value }: any): any;
+import { FilterParams } from 'tabulator-tables';
+/**
+ * Get the filter type based on the field type.
+ * @param type - The field type.
+ * @returns The filter type.
+ * @public
+ */
+export declare function getFilterByFieldType(type: string): string;
+/**
+ * Get the column type based on the metadata type.
+ * @param metadataType - The metadata type.
+ * @returns The column type.
+ * @public
+ */
+export declare function getColumnType(metadataType: string): string;
+/**
+ * Get the filter params based on the field type.
+ * @param type - The field type.
+ * @returns The filter params.
+ * @public
+ */
+export declare function getFilterParamsByFieldType(type: string): FilterParams;
+/**
+ * Format a date value.
+ * @remarks Formats [DATE] UNIX Timestamps (with time) to readable strings
+ * @param param - The field type.
+ * @returns The filter params.
+ * @public
+ */
+export declare function dateValueFormatter({ value }: any): string;
+/**
+ * Format a date time value to a readable string.
+ * @remarks Formats [DATETIME] UNIX Timestamps (with time) to readable strings
+ * @param param - The field type.
+ * @returns The filter params.
+ * @public
+ */
+export declare function dateTimeValueFormatter({ value }: any): string;
+/**
+ * Format am epoch value to a readable ISO date string.
+ * @param epoch - The epoch number.
+ * @returns The formatted date value.
+ * @public
+ */
 export declare function formatDateExtra(epoch: number): string;
 //# sourceMappingURL=grid-tabulator.definitions.d.ts.map

package/dist/dts/grid-tabulator.definitions.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"grid-tabulator.definitions.d.ts","sourceRoot":"","sources":["../../src/grid-tabulator.definitions.ts"],"names":[],"mappings":"AAEA,wBAAgB,oBAAoB,CAAC,IAAI,EAAE,MAAM,GAAG,GAAG,CActD;AAED,wBAAgB,aAAa,CAAC,YAAY,EAAE,MAAM,GAAG,GAAG,CASvD;AAED,wBAAgB,0BAA0B,CAAC,IAAI,EAAE,MAAM,GAAG,GAAG,CAwC5D;AAED,wBAAgB,kBAAkB,CAAC,EAAE,KAAK,EAAE,EAAE,GAAG,GAAG,GAAG,CAEtD;AAED,wBAAgB,sBAAsB,CAAC,EAAE,KAAK,EAAE,EAAE,GAAG,GAAG,GAAG,CAE1D;AAID,wBAAgB,eAAe,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAMrD"}
+{"version":3,"file":"grid-tabulator.definitions.d.ts","sourceRoot":"","sources":["../../src/grid-tabulator.definitions.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,YAAY,EAAE,MAAM,kBAAkB,CAAC;AAEhD;;;;;GAKG;AACH,wBAAgB,oBAAoB,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAczD;AAED;;;;;GAKG;AACH,wBAAgB,aAAa,CAAC,YAAY,EAAE,MAAM,GAAG,MAAM,CAS1D;AAED;;;;;GAKG;AACH,wBAAgB,0BAA0B,CAAC,IAAI,EAAE,MAAM,GAAG,YAAY,CAwCrE;AAED;;;;;;GAMG;AACH,wBAAgB,kBAAkB,CAAC,EAAE,KAAK,EAAE,EAAE,GAAG,GAAG,MAAM,CAEzD;AAED;;;;;;GAMG;AACH,wBAAgB,sBAAsB,CAAC,EAAE,KAAK,EAAE,EAAE,GAAG,GAAG,MAAM,CAE7D;AAKD;;;;;GAKG;AACH,wBAAgB,eAAe,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAMrD"}

package/dist/dts/grid-tabulator.styles.d.ts

@@ -1,3 +1,7 @@
 import type { ElementStyles } from '@microsoft/fast-element';
+/**
+ * The styles for the grid-tabulator component
+ * @public
+ */
 export declare const gridTabulatorStyles: ElementStyles;
 //# sourceMappingURL=grid-tabulator.styles.d.ts.map

package/dist/dts/grid-tabulator.styles.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"grid-tabulator.styles.d.ts","sourceRoot":"","sources":["../../src/grid-tabulator.styles.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,yBAAyB,CAAC;AAG7D,eAAO,MAAM,mBAAmB,EAAE,aAWjC,CAAC"}
+{"version":3,"file":"grid-tabulator.styles.d.ts","sourceRoot":"","sources":["../../src/grid-tabulator.styles.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,yBAAyB,CAAC;AAG7D;;;GAGG;AACH,eAAO,MAAM,mBAAmB,EAAE,aAWjC,CAAC"}

package/dist/dts/grid-tabulator.template.d.ts

@@ -1,3 +1,7 @@
 import type { ViewTemplate } from '@microsoft/fast-element';
+/**
+ * The template for the `grid-tabulator` component.
+ * @public
+ */
 export declare const gridTabulatorTemplate: ViewTemplate;
 //# sourceMappingURL=grid-tabulator.template.d.ts.map

package/dist/dts/grid-tabulator.template.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"grid-tabulator.template.d.ts","sourceRoot":"","sources":["../../src/grid-tabulator.template.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,yBAAyB,CAAC;AAG5D,eAAO,MAAM,qBAAqB,EAAE,YAInC,CAAC"}
+{"version":3,"file":"grid-tabulator.template.d.ts","sourceRoot":"","sources":["../../src/grid-tabulator.template.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,yBAAyB,CAAC;AAG5D;;;GAGG;AACH,eAAO,MAAM,qBAAqB,EAAE,YAInC,CAAC"}

package/dist/dts/grid-tabulator.types.d.ts

@@ -5,15 +5,38 @@ import { CSSVarTokenMap } from '@genesislcap/foundation-ui';
  */
 export declare enum GridCSSVars {
 }
+/**
+ * The available `grid-tabulator` themes
+ * @public
+ */
 export declare enum GridTabulatorTheme {
     default = "default-theme",
     rapid = "rapid-theme"
 }
+/**
+ * Get the token map class name for the `grid-tabulator` themes
+ * @param themeName - The theme name
+ * @returns The token map class name for the `grid-tabulator` themes
+ * @public
+ */
 export declare const themeTokenMapClassname: (themeName: string) => string;
+/**
+ * Get the Fonts ID for the theme's name
+ * @param themeName - The theme name
+ * @returns The theme's fonts ID
+ * @public
+ */
 export declare const themeFontsId: (themeName: string) => string;
+/**
+ * Get the CSS for the theme's token map
+ * @param themeName - The theme name
+ * @param tokenMap - The token map
+ * @returns The CSS for the theme's token map
+ * @public
+ */
 export declare const themeTokenMapCSS: (themeName: string, tokenMap: CSSVarTokenMap<any>) => import("@microsoft/fast-element").ElementStyles;
 /**
- * The available Grid Tabulator Renderer Types
+ * The available `grid-tabulator` Renderer Types
  * @public
  */
 export declare enum GridTabulatorCellRendererTypes {

package/dist/dts/grid-tabulator.types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"grid-tabulator.types.d.ts","sourceRoot":"","sources":["../../src/grid-tabulator.types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAsB,cAAc,EAAE,MAAM,4BAA4B,CAAC;AAGhF;;;GAGG;AACH,oBAAY,WAAW;CAAG;AA8C1B,oBAAY,kBAAkB;IAC5B,OAAO,kBAAkB;IACzB,KAAK,gBAAgB;CACtB;AAED,eAAO,MAAM,sBAAsB,cAAe,MAAM,WAA6B,CAAC;AACtF,eAAO,MAAM,YAAY,cAAe,MAAM,WAAyB,CAAC;AAExE,eAAO,MAAM,gBAAgB,cAAe,MAAM,YAAY,eAAe,GAAG,CAAC,oDAIhF,CAAC;AAEF;;;GAGG;AACH,oBAAY,8BAA8B;IACxC,MAAM,WAAW;IACjB,WAAW,gBAAgB;IAC3B,OAAO,YAAY;IACnB,IAAI,SAAS;IACb,MAAM,WAAW;CAClB"}
+{"version":3,"file":"grid-tabulator.types.d.ts","sourceRoot":"","sources":["../../src/grid-tabulator.types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAsB,cAAc,EAAE,MAAM,4BAA4B,CAAC;AAGhF;;;GAGG;AACH,oBAAY,WAAW;CAAG;AA8C1B;;;GAGG;AACH,oBAAY,kBAAkB;IAC5B,OAAO,kBAAkB;IACzB,KAAK,gBAAgB;CACtB;AAED;;;;;GAKG;AACH,eAAO,MAAM,sBAAsB,cAAe,MAAM,WAA6B,CAAC;AAEtF;;;;;GAKG;AACH,eAAO,MAAM,YAAY,cAAe,MAAM,WAAyB,CAAC;AAExE;;;;;;GAMG;AACH,eAAO,MAAM,gBAAgB,cAAe,MAAM,YAAY,eAAe,GAAG,CAAC,oDAIhF,CAAC;AAEF;;;GAGG;AACH,oBAAY,8BAA8B;IACxC,MAAM,WAAW;IACjB,WAAW,gBAAgB;IAC3B,OAAO,YAAY;IACnB,IAAI,SAAS;IACb,MAAM,WAAW;CAClB"}

package/dist/dts/tsdoc-metadata.json

@@ -0,0 +1,11 @@
+// This file is read by tools that parse documentation comments conforming to the TSDoc standard.
+// It should be published with your NPM package.  It should not be tracked by Git.
+{
+  "tsdocVersion": "0.12",
+  "toolPackages": [
+    {
+      "packageName": "@microsoft/api-extractor",
+      "packageVersion": "7.34.9"
+    }
+  ]
+}

package/dist/dts/utils/logger.d.ts

@@ -1,2 +1,6 @@
+/**
+ * Logger for the `grid-tabulator` package
+ * @public
+ */
 export declare const logger: import("@genesislcap/foundation-logger").Logger;
 //# sourceMappingURL=logger.d.ts.map

package/dist/dts/utils/logger.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"logger.d.ts","sourceRoot":"","sources":["../../../src/utils/logger.ts"],"names":[],"mappings":"AAEA,eAAO,MAAM,MAAM,iDAAiC,CAAC"}
+{"version":3,"file":"logger.d.ts","sourceRoot":"","sources":["../../../src/utils/logger.ts"],"names":[],"mappings":"AAEA;;;GAGG;AACH,eAAO,MAAM,MAAM,iDAAiC,CAAC"}

package/dist/esm/external/index.js

@@ -1,5 +1,9 @@
 import { css } from '@microsoft/fast-element';
 import { tabulatorThemeSimpleCSS } from './tabulator-theme-simple-css';
+/**
+ * External styles for the Tabulator grid.
+ * @public
+ */
 export const tabulatorExternalStockStyles = css `
   ${tabulatorThemeSimpleCSS}
 `;

package/dist/esm/external/tabulator-theme-simple-css.js

@@ -1,4 +1,8 @@
 import { css } from '@microsoft/fast-element';
+/**
+ * External styles for the Tabulator grid.
+ * @public
+ */
 export const tabulatorThemeSimpleCSS = css `
   .tabulator {
     position: relative;

package/dist/esm/grid-tabulator.components.js

@@ -5,6 +5,10 @@ import { foundationGridTabulatorActionRenderer,
 // foundationAgTextRenderer,
  } from './cell-renderers';
 import { foundationGridTabulator } from './grid-tabulator';
+/**
+ * All `grid-tabulator` components.
+ * @public
+ */
 export const foundationGridTabulatorComponents = {
     foundationGridTabulatorActionRenderer,
     // foundationGridProActionsMenuRenderer,

package/dist/esm/grid-tabulator.definitions.js

@@ -1,4 +1,10 @@
 import { formatDateTimestamp, formatDateTimeTimestamp } from '@genesislcap/foundation-utils';
+/**
+ * Get the filter type based on the field type.
+ * @param type - The field type.
+ * @returns The filter type.
+ * @public
+ */
 export function getFilterByFieldType(type) {
     switch (type) {
         // case 'int':
@@ -14,6 +20,12 @@ export function getFilterByFieldType(type) {
             return 'agTextColumnFilter';
     }
 }
+/**
+ * Get the column type based on the metadata type.
+ * @param metadataType - The metadata type.
+ * @returns The column type.
+ * @public
+ */
 export function getColumnType(metadataType) {
     switch (metadataType === null || metadataType === void 0 ? void 0 : metadataType.toLowerCase()) {
         case 'int':
@@ -24,6 +36,12 @@ export function getColumnType(metadataType) {
             return 'numericColumn';
     }
 }
+/**
+ * Get the filter params based on the field type.
+ * @param type - The field type.
+ * @returns The filter params.
+ * @public
+ */
 export function getFilterParamsByFieldType(type) {
     switch (type) {
         // case FieldTypeEnum.DATE:
@@ -60,14 +78,34 @@ export function getFilterParamsByFieldType(type) {
         }
     }
 }
+/**
+ * Format a date value.
+ * @remarks Formats [DATE] UNIX Timestamps (with time) to readable strings
+ * @param param - The field type.
+ * @returns The filter params.
+ * @public
+ */
 export function dateValueFormatter({ value }) {
     return formatDateTimestamp(value);
 }
+/**
+ * Format a date time value to a readable string.
+ * @remarks Formats [DATETIME] UNIX Timestamps (with time) to readable strings
+ * @param param - The field type.
+ * @returns The filter params.
+ * @public
+ */
 export function dateTimeValueFormatter({ value }) {
     return formatDateTimeTimestamp(value);
 }
 // TODO: possible duplicate - need to evaluate the differences
 const isoDateTimeSliceEnd = 19;
+/**
+ * Format am epoch value to a readable ISO date string.
+ * @param epoch - The epoch number.
+ * @returns The formatted date value.
+ * @public
+ */
 export function formatDateExtra(epoch) {
     return new Date(epoch)
         .toISOString()

package/dist/esm/grid-tabulator.js

@@ -60,6 +60,22 @@ export class GridTabulator extends LifecycleMixin(FoundationElement) {
         if (!this.shouldRunDisconnect)
             return;
     }
+    /**
+     * The current grid options.
+     * @public
+     * @example
+     * ```ts
+     *  ...
+     *  const options = this.grid.getOptions();
+     *  logger.debug(options); // { data: [...], columns: [...], filterMode: "local", groupBy: false, ... }
+     *  ...
+     * ```
+     * @remarks
+     * See https://tabulator.info/docs/6.3/options for more details.
+     */
+    get gridOptions() {
+        return this.grid.options;
+    }
     set gridOptions(options) {
         DOM.queueUpdate(() => {
             this.grid = new Tabulator(this.gridDiv, Object.assign({ rowHeight: this.rowHeight }, options));
@@ -187,13 +203,21 @@ __decorate([
 __decorate([
     attr
 ], GridTabulator.prototype, "theme", void 0);
-// explicitly declaring for extensibility
+/**
+ * The grid-tabulator component registration.
+ * @public
+ * @privateRemarks explicitly declaring for extensibility
+ */
 export const gridTabulatorShadowOptions = undefined;
+/**
+ * The default grid-tabulator configuration.
+ * @public
+ */
 export const defaultGridTabulatorConfig = {
     shadowOptions: undefined,
 };
 /**
- * The Foundation GridTabulator
+ * The Foundation grid-tabulator
  *
  * @alpha
  * @remarks

package/dist/esm/grid-tabulator.styles.js

@@ -1,5 +1,9 @@
 import { css } from '@microsoft/fast-element';
 import { tabulatorExternalStockStyles } from './external';
+/**
+ * The styles for the grid-tabulator component
+ * @public
+ */
 export const gridTabulatorStyles = css `
   ${tabulatorExternalStockStyles}
 

package/dist/esm/grid-tabulator.template.js

@@ -1,4 +1,8 @@
 import { html, ref } from '@microsoft/fast-element';
+/**
+ * The template for the `grid-tabulator` component.
+ * @public
+ */
 export const gridTabulatorTemplate = html `
   <template>
     <div ${ref('gridDiv')} id="grid"></div>

package/dist/esm/grid-tabulator.types.js

@@ -51,20 +51,43 @@ export var GridCSSVars;
 // modalOverlayBackgroundColor = '--ag-modal-overlay-background-color',
 // inputFocusBoxShadow = '--ag-input-focus-box-shadow',
 // inputFocusBorderColor = '--ag-input-focus-border-color',
+/**
+ * The available `grid-tabulator` themes
+ * @public
+ */
 export var GridTabulatorTheme;
 (function (GridTabulatorTheme) {
     GridTabulatorTheme["default"] = "default-theme";
     GridTabulatorTheme["rapid"] = "rapid-theme";
 })(GridTabulatorTheme || (GridTabulatorTheme = {}));
+/**
+ * Get the token map class name for the `grid-tabulator` themes
+ * @param themeName - The theme name
+ * @returns The token map class name for the `grid-tabulator` themes
+ * @public
+ */
 export const themeTokenMapClassname = (themeName) => `${themeName}-token-map`;
+/**
+ * Get the Fonts ID for the theme's name
+ * @param themeName - The theme name
+ * @returns The theme's fonts ID
+ * @public
+ */
 export const themeFontsId = (themeName) => `${themeName}-fonts`;
+/**
+ * Get the CSS for the theme's token map
+ * @param themeName - The theme name
+ * @param tokenMap - The token map
+ * @returns The CSS for the theme's token map
+ * @public
+ */
 export const themeTokenMapCSS = (themeName, tokenMap) => css `
   .${themeTokenMapClassname(themeName)} {
     ${new CSSVarsTokenMapper(tokenMap)}
   }
 `;
 /**
- * The available Grid Tabulator Renderer Types
+ * The available `grid-tabulator` Renderer Types
  * @public
  */
 export var GridTabulatorCellRendererTypes;

package/dist/esm/utils/logger.js

@@ -1,2 +1,6 @@
 import { createLogger } from '@genesislcap/foundation-logger';
+/**
+ * Logger for the `grid-tabulator` package
+ * @public
+ */
 export const logger = createLogger('grid-tabulator');