@deephaven/jsapi-utils 0.71.0 → 0.71.1-alpha-ui-picker-formatting.9

package/dist/FormatterUtils.d.ts

@@ -1,7 +1,15 @@
+import type { dh as DhType } from '@deephaven/jsapi-types';
 import type { FormattingRule } from './Formatter';
 import Formatter from './Formatter';
 import { DateTimeColumnFormatter } from './formatters';
-import { ColumnFormatSettings, DateTimeFormatSettings } from './Settings';
+import Settings, { ColumnFormatSettings, DateTimeFormatSettings } from './Settings';
+/**
+ * Instantiate a `Formatter` from the given settings.
+ * @param dh The `dh` object
+ * @param settings Optional settings to use
+ * @returns A new `Formatter` instance
+ */
+export declare function createFormatterFromSettings(dh: typeof DhType, settings?: Settings): Formatter;
 export declare function getColumnFormats(settings?: ColumnFormatSettings): FormattingRule[] | undefined;
 export declare function getDateTimeFormatterOptions(settings?: DateTimeFormatSettings | null): ConstructorParameters<typeof DateTimeColumnFormatter>[1];
 /**
@@ -13,6 +21,7 @@ export declare function getDateTimeFormatterOptions(settings?: DateTimeFormatSet
  */
 export declare function isCustomColumnFormatDefined(formatter: Formatter, columnName: string, columnType: string): boolean;
 declare const _default: {
+    createFormatterFromSettings: typeof createFormatterFromSettings;
     getColumnFormats: typeof getColumnFormats;
     getDateTimeFormatterOptions: typeof getDateTimeFormatterOptions;
     isCustomColumnFormatDefined: typeof isCustomColumnFormatDefined;

package/dist/FormatterUtils.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"FormatterUtils.d.ts","sourceRoot":"","sources":["../src/FormatterUtils.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,aAAa,CAAC;AAClD,OAAO,SAAS,MAAM,aAAa,CAAC;AACpC,OAAO,EAAE,uBAAuB,EAAwB,MAAM,cAAc,CAAC;AAC7E,OAAO,EAAE,oBAAoB,EAAE,sBAAsB,EAAE,MAAM,YAAY,CAAC;AAE1E,wBAAgB,gBAAgB,CAC9B,QAAQ,CAAC,EAAE,oBAAoB,GAC9B,cAAc,EAAE,GAAG,SAAS,CAM9B;AAED,wBAAgB,2BAA2B,CACzC,QAAQ,CAAC,EAAE,sBAAsB,GAAG,IAAI,GACvC,qBAAqB,CAAC,OAAO,uBAAuB,CAAC,CAAC,CAAC,CAAC,CAO1D;AAED;;;;;;GAMG;AACH,wBAAgB,2BAA2B,CACzC,SAAS,EAAE,SAAS,EACpB,UAAU,EAAE,MAAM,EAClB,UAAU,EAAE,MAAM,GACjB,OAAO,CAOT;;;;;;AAED,wBAIE"}
+{"version":3,"file":"FormatterUtils.d.ts","sourceRoot":"","sources":["../src/FormatterUtils.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,EAAE,IAAI,MAAM,EAAE,MAAM,wBAAwB,CAAC;AAC3D,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,aAAa,CAAC;AAClD,OAAO,SAAS,MAAM,aAAa,CAAC;AACpC,OAAO,EAAE,uBAAuB,EAAwB,MAAM,cAAc,CAAC;AAC7E,OAAO,QAAQ,EAAE,EACf,oBAAoB,EACpB,sBAAsB,EACvB,MAAM,YAAY,CAAC;AAEpB;;;;;GAKG;AACH,wBAAgB,2BAA2B,CACzC,EAAE,EAAE,OAAO,MAAM,EACjB,QAAQ,CAAC,EAAE,QAAQ,GAClB,SAAS,CAsBX;AAED,wBAAgB,gBAAgB,CAC9B,QAAQ,CAAC,EAAE,oBAAoB,GAC9B,cAAc,EAAE,GAAG,SAAS,CAM9B;AAED,wBAAgB,2BAA2B,CACzC,QAAQ,CAAC,EAAE,sBAAsB,GAAG,IAAI,GACvC,qBAAqB,CAAC,OAAO,uBAAuB,CAAC,CAAC,CAAC,CAAC,CAO1D;AAED;;;;;;GAMG;AACH,wBAAgB,2BAA2B,CACzC,SAAS,EAAE,SAAS,EACpB,UAAU,EAAE,MAAM,EAClB,UAAU,EAAE,MAAM,GACjB,OAAO,CAOT;;;;;;;AAED,wBAKE"}

package/dist/FormatterUtils.js

@@ -1,4 +1,23 @@
+import Formatter from "./Formatter.js";
 import { TableColumnFormatter } from "./formatters/index.js";
+/**
+ * Instantiate a `Formatter` from the given settings.
+ * @param dh The `dh` object
+ * @param settings Optional settings to use
+ * @returns A new `Formatter` instance
+ */
+export function createFormatterFromSettings(dh, settings) {
+  var columnRules = getColumnFormats(settings);
+  var dateTimeOptions = getDateTimeFormatterOptions(settings);
+  var {
+    defaultDecimalFormatOptions,
+    defaultIntegerFormatOptions,
+    truncateNumbersWithPound,
+    showEmptyStrings,
+    showNullStrings
+  } = settings !== null && settings !== void 0 ? settings : {};
+  return new Formatter(dh, columnRules, dateTimeOptions, defaultDecimalFormatOptions, defaultIntegerFormatOptions, truncateNumbersWithPound, showEmptyStrings, showNullStrings);
+}
 export function getColumnFormats(settings) {
   if (settings && settings.formatter) {
     var {
@@ -29,6 +48,7 @@ export function isCustomColumnFormatDefined(formatter, columnName, columnType) {
   return columnFormat != null && (columnFormat.type === TableColumnFormatter.TYPE_CONTEXT_PRESET || columnFormat.type === TableColumnFormatter.TYPE_CONTEXT_CUSTOM);
 }
 export default {
+  createFormatterFromSettings,
   getColumnFormats,
   getDateTimeFormatterOptions,
   isCustomColumnFormatDefined

package/dist/FormatterUtils.js.map

@@ -1 +1 @@
-{"version":3,"file":"FormatterUtils.js","names":["TableColumnFormatter","getColumnFormats","settings","formatter","undefined","getDateTimeFormatterOptions","timeZone","defaultDateTimeFormatString","defaultDateTimeFormat","showTimeZone","showTSeparator","isCustomColumnFormatDefined","columnName","columnType","columnFormat","getColumnFormat","type","TYPE_CONTEXT_PRESET","TYPE_CONTEXT_CUSTOM"],"sources":["../src/FormatterUtils.ts"],"sourcesContent":["import type { FormattingRule } from './Formatter';\nimport Formatter from './Formatter';\nimport { DateTimeColumnFormatter, TableColumnFormatter } from './formatters';\nimport { ColumnFormatSettings, DateTimeFormatSettings } from './Settings';\n\nexport function getColumnFormats(\n  settings?: ColumnFormatSettings\n): FormattingRule[] | undefined {\n  if (settings && settings.formatter) {\n    const { formatter } = settings;\n    return formatter;\n  }\n  return undefined;\n}\n\nexport function getDateTimeFormatterOptions(\n  settings?: DateTimeFormatSettings | null\n): ConstructorParameters<typeof DateTimeColumnFormatter>[1] {\n  return {\n    timeZone: settings?.timeZone,\n    defaultDateTimeFormatString: settings?.defaultDateTimeFormat,\n    showTimeZone: settings?.showTimeZone,\n    showTSeparator: settings?.showTSeparator,\n  };\n}\n\n/**\n * Check if the formatter has a custom format defined for the column name and type\n * @param formatter Formatter to check\n * @param columnName Column name\n * @param columnType Column type\n * @returns True, if a custom format is defined\n */\nexport function isCustomColumnFormatDefined(\n  formatter: Formatter,\n  columnName: string,\n  columnType: string\n): boolean {\n  const columnFormat = formatter.getColumnFormat(columnType, columnName);\n  return (\n    columnFormat != null &&\n    (columnFormat.type === TableColumnFormatter.TYPE_CONTEXT_PRESET ||\n      columnFormat.type === TableColumnFormatter.TYPE_CONTEXT_CUSTOM)\n  );\n}\n\nexport default {\n  getColumnFormats,\n  getDateTimeFormatterOptions,\n  isCustomColumnFormatDefined,\n};\n"],"mappings":"SAEkCA,oBAAoB;AAGtD,OAAO,SAASC,gBAAgBA,CAC9BC,QAA+B,EACD;EAC9B,IAAIA,QAAQ,IAAIA,QAAQ,CAACC,SAAS,EAAE;IAClC,IAAM;MAAEA;IAAU,CAAC,GAAGD,QAAQ;IAC9B,OAAOC,SAAS;EAClB;EACA,OAAOC,SAAS;AAClB;AAEA,OAAO,SAASC,2BAA2BA,CACzCH,QAAwC,EACkB;EAC1D,OAAO;IACLI,QAAQ,EAAEJ,QAAQ,aAARA,QAAQ,uBAARA,QAAQ,CAAEI,QAAQ;IAC5BC,2BAA2B,EAAEL,QAAQ,aAARA,QAAQ,uBAARA,QAAQ,CAAEM,qBAAqB;IAC5DC,YAAY,EAAEP,QAAQ,aAARA,QAAQ,uBAARA,QAAQ,CAAEO,YAAY;IACpCC,cAAc,EAAER,QAAQ,aAARA,QAAQ,uBAARA,QAAQ,CAAEQ;EAC5B,CAAC;AACH;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASC,2BAA2BA,CACzCR,SAAoB,EACpBS,UAAkB,EAClBC,UAAkB,EACT;EACT,IAAMC,YAAY,GAAGX,SAAS,CAACY,eAAe,CAACF,UAAU,EAAED,UAAU,CAAC;EACtE,OACEE,YAAY,IAAI,IAAI,KACnBA,YAAY,CAACE,IAAI,KAAKhB,oBAAoB,CAACiB,mBAAmB,IAC7DH,YAAY,CAACE,IAAI,KAAKhB,oBAAoB,CAACkB,mBAAmB,CAAC;AAErE;AAEA,eAAe;EACbjB,gBAAgB;EAChBI,2BAA2B;EAC3BM;AACF,CAAC"}
+{"version":3,"file":"FormatterUtils.js","names":["Formatter","TableColumnFormatter","createFormatterFromSettings","dh","settings","columnRules","getColumnFormats","dateTimeOptions","getDateTimeFormatterOptions","defaultDecimalFormatOptions","defaultIntegerFormatOptions","truncateNumbersWithPound","showEmptyStrings","showNullStrings","formatter","undefined","timeZone","defaultDateTimeFormatString","defaultDateTimeFormat","showTimeZone","showTSeparator","isCustomColumnFormatDefined","columnName","columnType","columnFormat","getColumnFormat","type","TYPE_CONTEXT_PRESET","TYPE_CONTEXT_CUSTOM"],"sources":["../src/FormatterUtils.ts"],"sourcesContent":["import type { dh as DhType } from '@deephaven/jsapi-types';\nimport type { FormattingRule } from './Formatter';\nimport Formatter from './Formatter';\nimport { DateTimeColumnFormatter, TableColumnFormatter } from './formatters';\nimport Settings, {\n  ColumnFormatSettings,\n  DateTimeFormatSettings,\n} from './Settings';\n\n/**\n * Instantiate a `Formatter` from the given settings.\n * @param dh The `dh` object\n * @param settings Optional settings to use\n * @returns A new `Formatter` instance\n */\nexport function createFormatterFromSettings(\n  dh: typeof DhType,\n  settings?: Settings\n): Formatter {\n  const columnRules = getColumnFormats(settings);\n  const dateTimeOptions = getDateTimeFormatterOptions(settings);\n\n  const {\n    defaultDecimalFormatOptions,\n    defaultIntegerFormatOptions,\n    truncateNumbersWithPound,\n    showEmptyStrings,\n    showNullStrings,\n  } = settings ?? {};\n\n  return new Formatter(\n    dh,\n    columnRules,\n    dateTimeOptions,\n    defaultDecimalFormatOptions,\n    defaultIntegerFormatOptions,\n    truncateNumbersWithPound,\n    showEmptyStrings,\n    showNullStrings\n  );\n}\n\nexport function getColumnFormats(\n  settings?: ColumnFormatSettings\n): FormattingRule[] | undefined {\n  if (settings && settings.formatter) {\n    const { formatter } = settings;\n    return formatter;\n  }\n  return undefined;\n}\n\nexport function getDateTimeFormatterOptions(\n  settings?: DateTimeFormatSettings | null\n): ConstructorParameters<typeof DateTimeColumnFormatter>[1] {\n  return {\n    timeZone: settings?.timeZone,\n    defaultDateTimeFormatString: settings?.defaultDateTimeFormat,\n    showTimeZone: settings?.showTimeZone,\n    showTSeparator: settings?.showTSeparator,\n  };\n}\n\n/**\n * Check if the formatter has a custom format defined for the column name and type\n * @param formatter Formatter to check\n * @param columnName Column name\n * @param columnType Column type\n * @returns True, if a custom format is defined\n */\nexport function isCustomColumnFormatDefined(\n  formatter: Formatter,\n  columnName: string,\n  columnType: string\n): boolean {\n  const columnFormat = formatter.getColumnFormat(columnType, columnName);\n  return (\n    columnFormat != null &&\n    (columnFormat.type === TableColumnFormatter.TYPE_CONTEXT_PRESET ||\n      columnFormat.type === TableColumnFormatter.TYPE_CONTEXT_CUSTOM)\n  );\n}\n\nexport default {\n  createFormatterFromSettings,\n  getColumnFormats,\n  getDateTimeFormatterOptions,\n  isCustomColumnFormatDefined,\n};\n"],"mappings":"OAEOA,SAAS;AAAA,SACkBC,oBAAoB;AAMtD;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASC,2BAA2BA,CACzCC,EAAiB,EACjBC,QAAmB,EACR;EACX,IAAMC,WAAW,GAAGC,gBAAgB,CAACF,QAAQ,CAAC;EAC9C,IAAMG,eAAe,GAAGC,2BAA2B,CAACJ,QAAQ,CAAC;EAE7D,IAAM;IACJK,2BAA2B;IAC3BC,2BAA2B;IAC3BC,wBAAwB;IACxBC,gBAAgB;IAChBC;EACF,CAAC,GAAGT,QAAQ,aAARA,QAAQ,cAARA,QAAQ,GAAI,CAAC,CAAC;EAElB,OAAO,IAAIJ,SAAS,CAClBG,EAAE,EACFE,WAAW,EACXE,eAAe,EACfE,2BAA2B,EAC3BC,2BAA2B,EAC3BC,wBAAwB,EACxBC,gBAAgB,EAChBC,eACF,CAAC;AACH;AAEA,OAAO,SAASP,gBAAgBA,CAC9BF,QAA+B,EACD;EAC9B,IAAIA,QAAQ,IAAIA,QAAQ,CAACU,SAAS,EAAE;IAClC,IAAM;MAAEA;IAAU,CAAC,GAAGV,QAAQ;IAC9B,OAAOU,SAAS;EAClB;EACA,OAAOC,SAAS;AAClB;AAEA,OAAO,SAASP,2BAA2BA,CACzCJ,QAAwC,EACkB;EAC1D,OAAO;IACLY,QAAQ,EAAEZ,QAAQ,aAARA,QAAQ,uBAARA,QAAQ,CAAEY,QAAQ;IAC5BC,2BAA2B,EAAEb,QAAQ,aAARA,QAAQ,uBAARA,QAAQ,CAAEc,qBAAqB;IAC5DC,YAAY,EAAEf,QAAQ,aAARA,QAAQ,uBAARA,QAAQ,CAAEe,YAAY;IACpCC,cAAc,EAAEhB,QAAQ,aAARA,QAAQ,uBAARA,QAAQ,CAAEgB;EAC5B,CAAC;AACH;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASC,2BAA2BA,CACzCP,SAAoB,EACpBQ,UAAkB,EAClBC,UAAkB,EACT;EACT,IAAMC,YAAY,GAAGV,SAAS,CAACW,eAAe,CAACF,UAAU,EAAED,UAAU,CAAC;EACtE,OACEE,YAAY,IAAI,IAAI,KACnBA,YAAY,CAACE,IAAI,KAAKzB,oBAAoB,CAAC0B,mBAAmB,IAC7DH,YAAY,CAACE,IAAI,KAAKzB,oBAAoB,CAAC2B,mBAAmB,CAAC;AAErE;AAEA,eAAe;EACb1B,2BAA2B;EAC3BI,gBAAgB;EAChBE,2BAA2B;EAC3Ba;AACF,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@deephaven/jsapi-utils",
-  "version": "0.71.0",
+  "version": "0.71.1-alpha-ui-picker-formatting.9+1e86dc67",
   "description": "Deephaven JSAPI Utils",
   "author": "Deephaven Data Labs LLC",
   "license": "Apache-2.0",
@@ -21,15 +21,15 @@
     "build:babel": "babel ./src --out-dir ./dist --extensions \".ts,.tsx,.js,.jsx\" --source-maps --root-mode upward"
   },
   "dependencies": {
-    "@deephaven/filters": "^0.71.0",
+    "@deephaven/filters": "^0.71.1-alpha-ui-picker-formatting.9+1e86dc67",
     "@deephaven/jsapi-types": "1.0.0-dev0.33.1",
-    "@deephaven/log": "^0.71.0",
-    "@deephaven/utils": "^0.71.0",
+    "@deephaven/log": "^0.71.1-alpha-ui-picker-formatting.9+1e86dc67",
+    "@deephaven/utils": "^0.71.1-alpha-ui-picker-formatting.9+1e86dc67",
     "lodash.clamp": "^4.0.3",
     "shortid": "^2.2.16"
   },
   "devDependencies": {
-    "@deephaven/jsapi-shim": "^0.71.0"
+    "@deephaven/jsapi-shim": "^0.71.1-alpha-ui-picker-formatting.9+1e86dc67"
   },
   "files": [
     "dist"
@@ -38,5 +38,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "f8a12f75b7bed3e00425e0ee8daa23af1e5a0d94"
+  "gitHead": "1e86dc67aa5a14e89ba2d9c3c0451627b1596e5c"
 }