@genesislcap/foundation-utils 14.196.1 → 14.197.0

package/dist/custom-elements.json

@@ -988,6 +988,27 @@
           ],
           "description": "Formats [DATE|DATETIME] Unix Timestamps to readable strings",
           "privacy": "public"
+        },
+        {
+          "kind": "function",
+          "name": "getDateFormatter",
+          "parameters": [
+            {
+              "name": "locale",
+              "default": "'en-GB'",
+              "type": {
+                "text": "string"
+              }
+            },
+            {
+              "name": "options",
+              "default": "defaultDateOptions",
+              "type": {
+                "text": "Intl.DateTimeFormatOptions"
+              }
+            }
+          ],
+          "privacy": "public"
         }
       ],
       "exports": [
@@ -1014,6 +1035,14 @@
             "name": "formatTimestamp",
             "module": "src/formatters/datetime.ts"
           }
+        },
+        {
+          "kind": "js",
+          "name": "getDateFormatter",
+          "declaration": {
+            "name": "getDateFormatter",
+            "module": "src/formatters/datetime.ts"
+          }
         }
       ]
     },
@@ -1037,6 +1066,14 @@
             "name": "*",
             "package": "./localeNumberParser"
           }
+        },
+        {
+          "kind": "js",
+          "name": "*",
+          "declaration": {
+            "name": "*",
+            "package": "./number"
+          }
         }
       ]
     },
@@ -1132,6 +1169,42 @@
         }
       ]
     },
+    {
+      "kind": "javascript-module",
+      "path": "src/formatters/number.ts",
+      "declarations": [
+        {
+          "kind": "function",
+          "name": "getNumberFormatter",
+          "parameters": [
+            {
+              "name": "format",
+              "type": {
+                "text": "string"
+              }
+            },
+            {
+              "name": "locale",
+              "optional": true,
+              "type": {
+                "text": "string | null"
+              }
+            }
+          ],
+          "privacy": "public"
+        }
+      ],
+      "exports": [
+        {
+          "kind": "js",
+          "name": "getNumberFormatter",
+          "declaration": {
+            "name": "getNumberFormatter",
+            "module": "src/formatters/number.ts"
+          }
+        }
+      ]
+    },
     {
       "kind": "javascript-module",
       "path": "src/logger/index.ts",
@@ -2287,130 +2360,6 @@
         }
       ]
     },
-    {
-      "kind": "javascript-module",
-      "path": "src/mixins/lifecycle/index.ts",
-      "declarations": [],
-      "exports": [
-        {
-          "kind": "js",
-          "name": "*",
-          "declaration": {
-            "name": "*",
-            "package": "./lifecycle"
-          }
-        }
-      ]
-    },
-    {
-      "kind": "javascript-module",
-      "path": "src/mixins/lifecycle/lifecycle.ts",
-      "declarations": [
-        {
-          "kind": "mixin",
-          "description": "",
-          "name": "LifecycleMixin",
-          "members": [
-            {
-              "kind": "method",
-              "name": "cloneNode",
-              "return": {
-                "type": {
-                  "text": "Node"
-                }
-              },
-              "parameters": [
-                {
-                  "name": "deep",
-                  "optional": true,
-                  "type": {
-                    "text": "boolean"
-                  }
-                }
-              ]
-            },
-            {
-              "kind": "method",
-              "name": "deepClone",
-              "return": {
-                "type": {
-                  "text": "Node"
-                }
-              }
-            },
-            {
-              "kind": "field",
-              "name": "shouldRunDisconnect",
-              "return": {
-                "type": {
-                  "text": ""
-                }
-              },
-              "readonly": true
-            },
-            {
-              "kind": "field",
-              "name": "shouldRunConnect",
-              "return": {
-                "type": {
-                  "text": ""
-                }
-              },
-              "readonly": true
-            },
-            {
-              "kind": "method",
-              "name": "#_blockLifecycleDueToTokenChange",
-              "return": {
-                "type": {
-                  "text": "boolean"
-                }
-              },
-              "parameters": [
-                {
-                  "name": "lifecycleType",
-                  "type": {
-                    "text": "Lifecycletype"
-                  }
-                }
-              ]
-            }
-          ],
-          "parameters": [
-            {
-              "name": "Base",
-              "type": {
-                "text": "T"
-              }
-            }
-          ]
-        },
-        {
-          "kind": "variable",
-          "name": "layoutCacheDocument",
-          "description": "Stored on the layout's internal cache to signify that the document is not part of the DOM",
-          "privacy": "public"
-        }
-      ],
-      "exports": [
-        {
-          "kind": "js",
-          "name": "LifecycleMixin",
-          "declaration": {
-            "name": "LifecycleMixin",
-            "module": "src/mixins/lifecycle/lifecycle.ts"
-          }
-        },
-        {
-          "kind": "js",
-          "name": "layoutCacheDocument",
-          "declaration": {
-            "name": "layoutCacheDocument",
-            "module": "src/mixins/lifecycle/lifecycle.ts"
-          }
-        }
-      ]
-    },
     {
       "kind": "javascript-module",
       "path": "src/mappers/dto/index.ts",
@@ -2824,6 +2773,130 @@
       "path": "src/serializers/json/types.ts",
       "declarations": [],
       "exports": []
+    },
+    {
+      "kind": "javascript-module",
+      "path": "src/mixins/lifecycle/index.ts",
+      "declarations": [],
+      "exports": [
+        {
+          "kind": "js",
+          "name": "*",
+          "declaration": {
+            "name": "*",
+            "package": "./lifecycle"
+          }
+        }
+      ]
+    },
+    {
+      "kind": "javascript-module",
+      "path": "src/mixins/lifecycle/lifecycle.ts",
+      "declarations": [
+        {
+          "kind": "mixin",
+          "description": "",
+          "name": "LifecycleMixin",
+          "members": [
+            {
+              "kind": "method",
+              "name": "cloneNode",
+              "return": {
+                "type": {
+                  "text": "Node"
+                }
+              },
+              "parameters": [
+                {
+                  "name": "deep",
+                  "optional": true,
+                  "type": {
+                    "text": "boolean"
+                  }
+                }
+              ]
+            },
+            {
+              "kind": "method",
+              "name": "deepClone",
+              "return": {
+                "type": {
+                  "text": "Node"
+                }
+              }
+            },
+            {
+              "kind": "field",
+              "name": "shouldRunDisconnect",
+              "return": {
+                "type": {
+                  "text": ""
+                }
+              },
+              "readonly": true
+            },
+            {
+              "kind": "field",
+              "name": "shouldRunConnect",
+              "return": {
+                "type": {
+                  "text": ""
+                }
+              },
+              "readonly": true
+            },
+            {
+              "kind": "method",
+              "name": "#_blockLifecycleDueToTokenChange",
+              "return": {
+                "type": {
+                  "text": "boolean"
+                }
+              },
+              "parameters": [
+                {
+                  "name": "lifecycleType",
+                  "type": {
+                    "text": "Lifecycletype"
+                  }
+                }
+              ]
+            }
+          ],
+          "parameters": [
+            {
+              "name": "Base",
+              "type": {
+                "text": "T"
+              }
+            }
+          ]
+        },
+        {
+          "kind": "variable",
+          "name": "layoutCacheDocument",
+          "description": "Stored on the layout's internal cache to signify that the document is not part of the DOM",
+          "privacy": "public"
+        }
+      ],
+      "exports": [
+        {
+          "kind": "js",
+          "name": "LifecycleMixin",
+          "declaration": {
+            "name": "LifecycleMixin",
+            "module": "src/mixins/lifecycle/lifecycle.ts"
+          }
+        },
+        {
+          "kind": "js",
+          "name": "layoutCacheDocument",
+          "declaration": {
+            "name": "layoutCacheDocument",
+            "module": "src/mixins/lifecycle/lifecycle.ts"
+          }
+        }
+      ]
     }
   ]
 }

package/dist/dts/formatters/datetime.d.ts

@@ -15,4 +15,8 @@ export declare function formatDateTimeTimestamp(timestamp: number): string;
  * @param withTime - The flag to determine if formatted value should contain 'time' info.
  */
 export declare function formatTimestamp(timestamp: number, withTime: boolean): string;
+/**
+ * @public
+ */
+export declare function getDateFormatter(locale?: string, options?: Intl.DateTimeFormatOptions): (params: any) => string;
 //# sourceMappingURL=datetime.d.ts.map

package/dist/dts/formatters/datetime.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"datetime.d.ts","sourceRoot":"","sources":["../../../src/formatters/datetime.ts"],"names":[],"mappings":"AACA;;;GAGG;AACH,wBAAgB,mBAAmB,CAAC,SAAS,EAAE,MAAM,GAAG,MAAM,CAG7D;AAGD;;;GAGG;AACH,wBAAgB,uBAAuB,CAAC,SAAS,EAAE,MAAM,GAAG,MAAM,CAGjE;AAED;;;;;GAKG;AACH,wBAAgB,eAAe,CAAC,SAAS,EAAE,MAAM,EAAE,QAAQ,EAAE,OAAO,GAAG,MAAM,CAM5E"}
+{"version":3,"file":"datetime.d.ts","sourceRoot":"","sources":["../../../src/formatters/datetime.ts"],"names":[],"mappings":"AACA;;;GAGG;AACH,wBAAgB,mBAAmB,CAAC,SAAS,EAAE,MAAM,GAAG,MAAM,CAG7D;AAGD;;;GAGG;AACH,wBAAgB,uBAAuB,CAAC,SAAS,EAAE,MAAM,GAAG,MAAM,CAGjE;AAED;;;;;GAKG;AACH,wBAAgB,eAAe,CAAC,SAAS,EAAE,MAAM,EAAE,QAAQ,EAAE,OAAO,GAAG,MAAM,CAM5E;AASD;;GAEG;AACH,wBAAgB,gBAAgB,CAC9B,MAAM,GAAE,MAAgB,EACxB,OAAO,GAAE,IAAI,CAAC,qBAA0C,YAExC,GAAG,YAKpB"}

package/dist/dts/formatters/index.d.ts

@@ -1,3 +1,4 @@
 export * from './datetime';
 export * from './localeNumberParser';
+export * from './number';
 //# sourceMappingURL=index.d.ts.map

package/dist/dts/formatters/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/formatters/index.ts"],"names":[],"mappings":"AAAA,cAAc,YAAY,CAAC;AAC3B,cAAc,sBAAsB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/formatters/index.ts"],"names":[],"mappings":"AAAA,cAAc,YAAY,CAAC;AAC3B,cAAc,sBAAsB,CAAC;AACrC,cAAc,UAAU,CAAC"}

package/dist/dts/formatters/number.d.ts

@@ -0,0 +1,6 @@
+import 'numeral/locales';
+/**
+ * @public
+ */
+export declare function getNumberFormatter(format: string, locale?: string | null): (params: any) => any;
+//# sourceMappingURL=number.d.ts.map

package/dist/dts/formatters/number.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"number.d.ts","sourceRoot":"","sources":["../../../src/formatters/number.ts"],"names":[],"mappings":"AACA,OAAO,iBAAiB,CAAC;AAEzB;;GAEG;AACH,wBAAgB,kBAAkB,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,YACvD,GAAG,SAYpB"}

package/dist/esm/formatters/datetime.js

@@ -30,3 +30,19 @@ export function formatTimestamp(timestamp, withTime) {
     }
     return formatDateTimestamp(timestamp);
 }
+const defaultDateOptions = {
+    year: 'numeric',
+    month: '2-digit',
+    day: '2-digit',
+    timeZone: 'UTC',
+};
+/**
+ * @public
+ */
+export function getDateFormatter(locale = 'en-GB', options = defaultDateOptions) {
+    return (params) => {
+        if (!(params && typeof params.value === 'number'))
+            return '';
+        return new Intl.DateTimeFormat(locale, options).format(params.value);
+    };
+}

package/dist/esm/formatters/index.js

@@ -1,2 +1,3 @@
 export * from './datetime';
 export * from './localeNumberParser';
+export * from './number';

package/dist/esm/formatters/number.js

@@ -0,0 +1,17 @@
+import Numeral from 'numeral';
+import 'numeral/locales';
+/**
+ * @public
+ */
+export function getNumberFormatter(format, locale) {
+    return (params) => {
+        // bigdecimals are sent as strings
+        if (!(params && (typeof params.value === 'number' || typeof params.value === 'string'))) {
+            return '';
+        }
+        if (locale) {
+            Numeral.locale(locale);
+        }
+        return Numeral(params.value).format(format);
+    };
+}

package/dist/foundation-utils.api.json

@@ -3376,6 +3376,68 @@
             "endIndex": 2
           }
         },
+        {
+          "kind": "Function",
+          "canonicalReference": "@genesislcap/foundation-utils!getDateFormatter:function(1)",
+          "docComment": "/**\n * @public\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export declare function getDateFormatter(locale?: "
+            },
+            {
+              "kind": "Content",
+              "text": "string"
+            },
+            {
+              "kind": "Content",
+              "text": ", options?: "
+            },
+            {
+              "kind": "Reference",
+              "text": "Intl.DateTimeFormatOptions",
+              "canonicalReference": "!Intl.DateTimeFormatOptions:interface"
+            },
+            {
+              "kind": "Content",
+              "text": "): "
+            },
+            {
+              "kind": "Content",
+              "text": "(params: any) => string"
+            },
+            {
+              "kind": "Content",
+              "text": ";"
+            }
+          ],
+          "fileUrlPath": "src/formatters/datetime.ts",
+          "returnTypeTokenRange": {
+            "startIndex": 5,
+            "endIndex": 6
+          },
+          "releaseTag": "Public",
+          "overloadIndex": 1,
+          "parameters": [
+            {
+              "parameterName": "locale",
+              "parameterTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "isOptional": true
+            },
+            {
+              "parameterName": "options",
+              "parameterTypeTokenRange": {
+                "startIndex": 3,
+                "endIndex": 4
+              },
+              "isOptional": true
+            }
+          ],
+          "name": "getDateFormatter"
+        },
         {
           "kind": "Variable",
           "canonicalReference": "@genesislcap/foundation-utils!getFontMixin:var",
@@ -3417,6 +3479,67 @@
             "endIndex": 6
           }
         },
+        {
+          "kind": "Function",
+          "canonicalReference": "@genesislcap/foundation-utils!getNumberFormatter:function(1)",
+          "docComment": "/**\n * @public\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export declare function getNumberFormatter(format: "
+            },
+            {
+              "kind": "Content",
+              "text": "string"
+            },
+            {
+              "kind": "Content",
+              "text": ", locale?: "
+            },
+            {
+              "kind": "Content",
+              "text": "string | null"
+            },
+            {
+              "kind": "Content",
+              "text": "): "
+            },
+            {
+              "kind": "Content",
+              "text": "(params: any) => any"
+            },
+            {
+              "kind": "Content",
+              "text": ";"
+            }
+          ],
+          "fileUrlPath": "src/formatters/number.ts",
+          "returnTypeTokenRange": {
+            "startIndex": 5,
+            "endIndex": 6
+          },
+          "releaseTag": "Public",
+          "overloadIndex": 1,
+          "parameters": [
+            {
+              "parameterName": "format",
+              "parameterTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "isOptional": false
+            },
+            {
+              "parameterName": "locale",
+              "parameterTypeTokenRange": {
+                "startIndex": 3,
+                "endIndex": 4
+              },
+              "isOptional": true
+            }
+          ],
+          "name": "getNumberFormatter"
+        },
         {
           "kind": "Variable",
           "canonicalReference": "@genesislcap/foundation-utils!HTTP_CONFIG:var",

package/dist/foundation-utils.d.ts

@@ -451,6 +451,11 @@ export declare type FoundationLayoutContainer = {
  */
 export declare const GENESIS_SOCKET_URL: string;
 
+/**
+ * @public
+ */
+export declare function getDateFormatter(locale?: string, options?: Intl.DateTimeFormatOptions): (params: any) => string;
+
 /**
  * Generates a CSS mixin for the specified font family, style, and weight.
  * @param family - The font family.
@@ -461,6 +466,11 @@ export declare const GENESIS_SOCKET_URL: string;
  */
 export declare const getFontMixin: (family: string, style?: FontStyle, weight?: FontWeight) => string;
 
+/**
+ * @public
+ */
+export declare function getNumberFormatter(format: string, locale?: string | null): (params: any) => any;
+
 /**
  * Configuration settings for HTTP, used in http connect flow [`genesislcap-foundation-comms.HttpConnectConfig`](https://link-to-docs).
  * @remarks Optional.

package/docs/api/foundation-utils.getdateformatter.md

@@ -0,0 +1,24 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-utils](./foundation-utils.md) &gt; [getDateFormatter](./foundation-utils.getdateformatter.md)
+
+## getDateFormatter() function
+
+
+**Signature:**
+
+```typescript
+export declare function getDateFormatter(locale?: string, options?: Intl.DateTimeFormatOptions): (params: any) => string;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  locale | string | _(Optional)_ |
+|  options | Intl.DateTimeFormatOptions | _(Optional)_ |
+
+**Returns:**
+
+(params: any) =&gt; string
+

package/docs/api/foundation-utils.getnumberformatter.md

@@ -0,0 +1,24 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-utils](./foundation-utils.md) &gt; [getNumberFormatter](./foundation-utils.getnumberformatter.md)
+
+## getNumberFormatter() function
+
+
+**Signature:**
+
+```typescript
+export declare function getNumberFormatter(format: string, locale?: string | null): (params: any) => any;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  format | string |  |
+|  locale | string \| null | _(Optional)_ |
+
+**Returns:**
+
+(params: any) =&gt; any
+

package/docs/api/foundation-utils.md

@@ -32,6 +32,8 @@
 |  [formatDateTimestamp(timestamp)](./foundation-utils.formatdatetimestamp.md) | Formats \[DATE\] UNIX Timestamps (without time) to readable strings |
 |  [formatDateTimeTimestamp(timestamp)](./foundation-utils.formatdatetimetimestamp.md) | Formats \[DATETIME\] UNIX Timestamps (with time) to readable strings |
 |  [formatTimestamp(timestamp, withTime)](./foundation-utils.formattimestamp.md) | Formats \[DATE\|DATETIME\] Unix Timestamps to readable strings |
+|  [getDateFormatter(locale, options)](./foundation-utils.getdateformatter.md) |  |
+|  [getNumberFormatter(format, locale)](./foundation-utils.getnumberformatter.md) |  |
 |  [JSONReplacer(key, value)](./foundation-utils.jsonreplacer.md) | JSON replacer function. |
 |  [JSONReviver(key, value)](./foundation-utils.jsonreviver.md) | JSON reviver function. |
 |  [reactive(object, deep)](./foundation-utils.reactive.md) | **_(BETA)_** Converts a plain object to a reactive, observable object. |

package/docs/api-report.md

@@ -256,9 +256,15 @@ export type FoundationLayoutContainer = {
 // @public
 export const GENESIS_SOCKET_URL: string;
 
+// @public (undocumented)
+export function getDateFormatter(locale?: string, options?: Intl.DateTimeFormatOptions): (params: any) => string;
+
 // @public
 export const getFontMixin: (family: string, style?: FontStyle, weight?: FontWeight) => string;
 
+// @public (undocumented)
+export function getNumberFormatter(format: string, locale?: string | null): (params: any) => any;
+
 // @public
 export let HTTP_CONFIG: string;
 

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@genesislcap/foundation-utils",
   "description": "Genesis Foundation Utils",
-  "version": "14.196.1",
+  "version": "14.197.0",
   "sideEffects": false,
   "license": "SEE LICENSE IN license.txt",
   "main": "dist/esm/index.js",
@@ -27,21 +27,22 @@
     }
   },
   "devDependencies": {
-    "@genesislcap/foundation-testing": "14.196.1",
-    "@genesislcap/genx": "14.196.1",
-    "@genesislcap/rollup-builder": "14.196.1",
-    "@genesislcap/ts-builder": "14.196.1",
-    "@genesislcap/uvu-playwright-builder": "14.196.1",
-    "@genesislcap/vite-builder": "14.196.1",
-    "@genesislcap/webpack-builder": "14.196.1",
+    "@genesislcap/foundation-testing": "14.197.0",
+    "@genesislcap/genx": "14.197.0",
+    "@genesislcap/rollup-builder": "14.197.0",
+    "@genesislcap/ts-builder": "14.197.0",
+    "@genesislcap/uvu-playwright-builder": "14.197.0",
+    "@genesislcap/vite-builder": "14.197.0",
+    "@genesislcap/webpack-builder": "14.197.0",
     "rimraf": "^5.0.0"
   },
   "dependencies": {
-    "@genesislcap/foundation-logger": "14.196.1",
+    "@genesislcap/foundation-logger": "14.197.0",
     "@microsoft/fast-components": "^2.30.6",
     "@microsoft/fast-element": "^1.12.0",
     "@microsoft/fast-foundation": "^2.49.4",
     "lossless-json": "^2.0.11",
+    "numeral": "2.0.6",
     "tslib": "^2.3.1",
     "uuid": "^8.3.2"
   },
@@ -54,5 +55,5 @@
     "access": "public"
   },
   "customElements": "dist/custom-elements.json",
-  "gitHead": "bb556c4499cbd190f90c76b1d22f0d29e6b500f7"
+  "gitHead": "1520d802086369c1ef2feb25e9d06a27b6fd09d4"
 }