@genesislcap/foundation-utils 14.221.0 → 14.221.1-alpha-457a890.0

package/dist/dts/encoding/base64/decode.d.ts

@@ -0,0 +1,16 @@
+/**
+ * Decodes a value from base64.
+ * @public
+ * @param value - The value to decode from base64.
+ * @returns The decoded value.
+ */
+export declare const decodeFromBase64: (base64Value: string) => string | ArrayBuffer;
+/**
+ * Decodes a value from base64 with a prefix.
+ * @remarks Prefixes are: 'str:' for string and 'bin:' for ArrayBuffer.
+ * @public
+ * @param value - The value to decode from base64.
+ * @returns The decoded value.
+ */
+export declare const decodeFromBase64WithPrefix: (value: string) => string | ArrayBuffer;
+//# sourceMappingURL=decode.d.ts.map

package/dist/dts/encoding/base64/decode.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"decode.d.ts","sourceRoot":"","sources":["../../../../src/encoding/base64/decode.ts"],"names":[],"mappings":"AAEA;;;;;GAKG;AACH,eAAO,MAAM,gBAAgB,gBAAiB,MAAM,KAAG,MAAM,GAAG,WAY/D,CAAC;AAEF;;;;;;GAMG;AACH,eAAO,MAAM,0BAA0B,UAAW,MAAM,KAAG,MAAM,GAAG,WAqBnE,CAAC"}

package/dist/dts/encoding/base64/encode.d.ts

@@ -0,0 +1,16 @@
+/**
+ * Encodes the given value to base64.
+ * @public
+ * @param value - The value to encode to base64.
+ * @returns The base64 encoded value.
+ */
+export declare const encodeToBase64: (value: string | ArrayBuffer) => string;
+/**
+ * Encodes the given value with a prefix to base64.
+ * @remarks Prefixes are: 'str:' for string and 'bin:' for ArrayBuffer.
+ * @public
+ * @param value - The value to encode to base64.
+ * @returns The base64 encoded value with a prefix.
+ */
+export declare const encodeToBase64WithPrefix: (value: string | ArrayBuffer) => string;
+//# sourceMappingURL=encode.d.ts.map

package/dist/dts/encoding/base64/encode.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"encode.d.ts","sourceRoot":"","sources":["../../../../src/encoding/base64/encode.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,eAAO,MAAM,cAAc,UAAW,MAAM,GAAG,WAAW,KAAG,MAU5D,CAAC;AAEF;;;;;;GAMG;AACH,eAAO,MAAM,wBAAwB,UAAW,MAAM,GAAG,WAAW,KAAG,MAUtE,CAAC"}

package/dist/dts/encoding/base64/index.d.ts

@@ -0,0 +1,3 @@
+export * from './decode';
+export * from './encode';
+//# sourceMappingURL=index.d.ts.map

package/dist/dts/encoding/base64/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/encoding/base64/index.ts"],"names":[],"mappings":"AAAA,cAAc,UAAU,CAAC;AACzB,cAAc,UAAU,CAAC"}

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

@@ -0,0 +1,2 @@
+export * from './base64';
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/encoding/index.ts"],"names":[],"mappings":"AAAA,cAAc,UAAU,CAAC"}

package/dist/dts/index.d.ts

@@ -2,6 +2,7 @@ export * from './data';
 export * from './decorators';
 export * from './design-system';
 export * from './directives';
+export * from './encoding';
 export * from './env';
 export * from './error';
 export * from './formatters';

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,QAAQ,CAAC;AACvB,cAAc,cAAc,CAAC;AAC7B,cAAc,iBAAiB,CAAC;AAChC,cAAc,cAAc,CAAC;AAC7B,cAAc,OAAO,CAAC;AACtB,cAAc,SAAS,CAAC;AACxB,cAAc,cAAc,CAAC;AAC7B,cAAc,UAAU,CAAC;AACzB,cAAc,WAAW,CAAC;AAC1B,cAAc,UAAU,CAAC;AACzB,cAAc,YAAY,CAAC;AAC3B,cAAc,WAAW,CAAC;AAC1B,cAAc,YAAY,CAAC;AAC3B,cAAc,eAAe,CAAC;AAC9B,cAAc,SAAS,CAAC;AACxB,cAAc,UAAU,CAAC;AACzB,cAAc,SAAS,CAAC;AACxB,cAAc,QAAQ,CAAC;AACvB,cAAc,UAAU,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,QAAQ,CAAC;AACvB,cAAc,cAAc,CAAC;AAC7B,cAAc,iBAAiB,CAAC;AAChC,cAAc,cAAc,CAAC;AAC7B,cAAc,YAAY,CAAC;AAC3B,cAAc,OAAO,CAAC;AACtB,cAAc,SAAS,CAAC;AACxB,cAAc,cAAc,CAAC;AAC7B,cAAc,UAAU,CAAC;AACzB,cAAc,WAAW,CAAC;AAC1B,cAAc,UAAU,CAAC;AACzB,cAAc,YAAY,CAAC;AAC3B,cAAc,WAAW,CAAC;AAC1B,cAAc,YAAY,CAAC;AAC3B,cAAc,eAAe,CAAC;AAC9B,cAAc,SAAS,CAAC;AACxB,cAAc,UAAU,CAAC;AACzB,cAAc,SAAS,CAAC;AACxB,cAAc,QAAQ,CAAC;AACvB,cAAc,UAAU,CAAC"}

package/dist/esm/encoding/base64/decode.js

@@ -0,0 +1,45 @@
+const base64Pattern = /^(?:[A-Za-z0-9+/]{4})*?(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$/;
+/**
+ * Decodes a value from base64.
+ * @public
+ * @param value - The value to decode from base64.
+ * @returns The decoded value.
+ */
+export const decodeFromBase64 = (base64Value) => {
+    if (base64Pattern.test(base64Value)) {
+        const decodedString = atob(base64Value);
+        const buffer = new Uint8Array(decodedString.length);
+        [...decodedString].forEach((_, i) => {
+            buffer[i] = decodedString.charCodeAt(i);
+        });
+        return buffer.buffer;
+    }
+    return base64Value;
+};
+/**
+ * Decodes a value from base64 with a prefix.
+ * @remarks Prefixes are: 'str:' for string and 'bin:' for ArrayBuffer.
+ * @public
+ * @param value - The value to decode from base64.
+ * @returns The decoded value.
+ */
+export const decodeFromBase64WithPrefix = (value) => {
+    const parts = value.split(':');
+    let prefix;
+    let base64Value;
+    if (parts.length === 2) {
+        [prefix, base64Value] = parts;
+    }
+    else {
+        base64Value = value;
+    }
+    const decodedValue = decodeFromBase64(base64Value);
+    if (prefix === 'str') {
+        const textDecoder = new TextDecoder('utf-8');
+        return textDecoder.decode(decodedValue);
+    }
+    else if (prefix === 'bin') {
+        return decodedValue;
+    }
+    return decodedValue;
+};

package/dist/esm/encoding/base64/encode.js

@@ -0,0 +1,34 @@
+/**
+ * Encodes the given value to base64.
+ * @public
+ * @param value - The value to encode to base64.
+ * @returns The base64 encoded value.
+ */
+export const encodeToBase64 = (value) => {
+    if (typeof value === 'string') {
+        return btoa(value);
+    }
+    else if (value instanceof ArrayBuffer) {
+        const buffer = new Uint8Array(value);
+        const binaryString = buffer.reduce((data, byte) => data + String.fromCharCode(byte), '');
+        return btoa(binaryString);
+    }
+    return '';
+};
+/**
+ * Encodes the given value with a prefix to base64.
+ * @remarks Prefixes are: 'str:' for string and 'bin:' for ArrayBuffer.
+ * @public
+ * @param value - The value to encode to base64.
+ * @returns The base64 encoded value with a prefix.
+ */
+export const encodeToBase64WithPrefix = (value) => {
+    const base64Value = encodeToBase64(value);
+    if (typeof value === 'string') {
+        return `str:${base64Value}`;
+    }
+    else if (value instanceof ArrayBuffer) {
+        return `bin:${base64Value}`;
+    }
+    return '';
+};

package/dist/esm/encoding/base64/index.js

@@ -0,0 +1,2 @@
+export * from './decode';
+export * from './encode';

package/dist/esm/encoding/index.js

@@ -0,0 +1 @@
+export * from './base64';

package/dist/esm/index.js

@@ -2,6 +2,7 @@ export * from './data';
 export * from './decorators';
 export * from './design-system';
 export * from './directives';
+export * from './encoding';
 export * from './env';
 export * from './error';
 export * from './formatters';

package/dist/foundation-utils.api.json

@@ -1621,6 +1621,62 @@
           ],
           "extendsTokenRanges": []
         },
+        {
+          "kind": "Variable",
+          "canonicalReference": "@genesislcap/foundation-utils!decodeFromBase64:var",
+          "docComment": "/**\n * Decodes a value from base64.\n *\n * @param value - The value to decode from base64.\n *\n * @returns The decoded value.\n *\n * @public\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "decodeFromBase64: "
+            },
+            {
+              "kind": "Content",
+              "text": "(base64Value: string) => string | "
+            },
+            {
+              "kind": "Reference",
+              "text": "ArrayBuffer",
+              "canonicalReference": "!ArrayBuffer:interface"
+            }
+          ],
+          "fileUrlPath": "src/encoding/base64/decode.ts",
+          "isReadonly": true,
+          "releaseTag": "Public",
+          "name": "decodeFromBase64",
+          "variableTypeTokenRange": {
+            "startIndex": 1,
+            "endIndex": 3
+          }
+        },
+        {
+          "kind": "Variable",
+          "canonicalReference": "@genesislcap/foundation-utils!decodeFromBase64WithPrefix:var",
+          "docComment": "/**\n * Decodes a value from base64 with a prefix.\n *\n * @remarks\n *\n * Prefixes are: 'str:' for string and 'bin:' for ArrayBuffer.\n *\n * @param value - The value to decode from base64.\n *\n * @returns The decoded value.\n *\n * @public\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "decodeFromBase64WithPrefix: "
+            },
+            {
+              "kind": "Content",
+              "text": "(value: string) => string | "
+            },
+            {
+              "kind": "Reference",
+              "text": "ArrayBuffer",
+              "canonicalReference": "!ArrayBuffer:interface"
+            }
+          ],
+          "fileUrlPath": "src/encoding/base64/decode.ts",
+          "isReadonly": true,
+          "releaseTag": "Public",
+          "name": "decodeFromBase64WithPrefix",
+          "variableTypeTokenRange": {
+            "startIndex": 1,
+            "endIndex": 3
+          }
+        },
         {
           "kind": "Variable",
           "canonicalReference": "@genesislcap/foundation-utils!DEFAULT_ORGANISATION:var",
@@ -2701,6 +2757,70 @@
           ],
           "extendsTokenRanges": []
         },
+        {
+          "kind": "Variable",
+          "canonicalReference": "@genesislcap/foundation-utils!encodeToBase64:var",
+          "docComment": "/**\n * Encodes the given value to base64.\n *\n * @param value - The value to encode to base64.\n *\n * @returns The base64 encoded value.\n *\n * @public\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "encodeToBase64: "
+            },
+            {
+              "kind": "Content",
+              "text": "(value: string | "
+            },
+            {
+              "kind": "Reference",
+              "text": "ArrayBuffer",
+              "canonicalReference": "!ArrayBuffer:interface"
+            },
+            {
+              "kind": "Content",
+              "text": ") => string"
+            }
+          ],
+          "fileUrlPath": "src/encoding/base64/encode.ts",
+          "isReadonly": true,
+          "releaseTag": "Public",
+          "name": "encodeToBase64",
+          "variableTypeTokenRange": {
+            "startIndex": 1,
+            "endIndex": 4
+          }
+        },
+        {
+          "kind": "Variable",
+          "canonicalReference": "@genesislcap/foundation-utils!encodeToBase64WithPrefix:var",
+          "docComment": "/**\n * Encodes the given value with a prefix to base64.\n *\n * @remarks\n *\n * Prefixes are: 'str:' for string and 'bin:' for ArrayBuffer.\n *\n * @param value - The value to encode to base64.\n *\n * @returns The base64 encoded value with a prefix.\n *\n * @public\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "encodeToBase64WithPrefix: "
+            },
+            {
+              "kind": "Content",
+              "text": "(value: string | "
+            },
+            {
+              "kind": "Reference",
+              "text": "ArrayBuffer",
+              "canonicalReference": "!ArrayBuffer:interface"
+            },
+            {
+              "kind": "Content",
+              "text": ") => string"
+            }
+          ],
+          "fileUrlPath": "src/encoding/base64/encode.ts",
+          "isReadonly": true,
+          "releaseTag": "Public",
+          "name": "encodeToBase64WithPrefix",
+          "variableTypeTokenRange": {
+            "startIndex": 1,
+            "endIndex": 4
+          }
+        },
         {
           "kind": "TypeAlias",
           "canonicalReference": "@genesislcap/foundation-utils!ErrorDetailMap:type",

package/dist/foundation-utils.d.ts

@@ -184,6 +184,23 @@ export declare interface DatabaseRecord {
     id: string;
 }
 
+/**
+ * Decodes a value from base64.
+ * @public
+ * @param value - The value to decode from base64.
+ * @returns The decoded value.
+ */
+export declare const decodeFromBase64: (base64Value: string) => string | ArrayBuffer;
+
+/**
+ * Decodes a value from base64 with a prefix.
+ * @remarks Prefixes are: 'str:' for string and 'bin:' for ArrayBuffer.
+ * @public
+ * @param value - The value to decode from base64.
+ * @returns The decoded value.
+ */
+export declare const decodeFromBase64WithPrefix: (value: string) => string | ArrayBuffer;
+
 /**
  * The default Organisation value, used in auth/login flow [`genesislcap-foundation-login`](https://link-to-docs).
  * @remarks Optional.
@@ -334,6 +351,23 @@ export declare interface DTOMapper<TDTO, TEntity> {
     toDTO: (entity: Partial<TEntity>) => TDTO;
 }
 
+/**
+ * Encodes the given value to base64.
+ * @public
+ * @param value - The value to encode to base64.
+ * @returns The base64 encoded value.
+ */
+export declare const encodeToBase64: (value: string | ArrayBuffer) => string;
+
+/**
+ * Encodes the given value with a prefix to base64.
+ * @remarks Prefixes are: 'str:' for string and 'bin:' for ArrayBuffer.
+ * @public
+ * @param value - The value to encode to base64.
+ * @returns The base64 encoded value with a prefix.
+ */
+export declare const encodeToBase64WithPrefix: (value: string | ArrayBuffer) => string;
+
 /**
  * @public
  */

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

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-utils](./foundation-utils.md) &gt; [decodeFromBase64](./foundation-utils.decodefrombase64.md)
+
+## decodeFromBase64 variable
+
+Decodes a value from base64.
+
+**Signature:**
+
+```typescript
+decodeFromBase64: (base64Value: string) => string | ArrayBuffer
+```

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

@@ -0,0 +1,18 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-utils](./foundation-utils.md) &gt; [decodeFromBase64WithPrefix](./foundation-utils.decodefrombase64withprefix.md)
+
+## decodeFromBase64WithPrefix variable
+
+Decodes a value from base64 with a prefix.
+
+**Signature:**
+
+```typescript
+decodeFromBase64WithPrefix: (value: string) => string | ArrayBuffer
+```
+
+## Remarks
+
+Prefixes are: 'str:' for string and 'bin:' for ArrayBuffer.
+

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

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-utils](./foundation-utils.md) &gt; [encodeToBase64](./foundation-utils.encodetobase64.md)
+
+## encodeToBase64 variable
+
+Encodes the given value to base64.
+
+**Signature:**
+
+```typescript
+encodeToBase64: (value: string | ArrayBuffer) => string
+```

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

@@ -0,0 +1,18 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-utils](./foundation-utils.md) &gt; [encodeToBase64WithPrefix](./foundation-utils.encodetobase64withprefix.md)
+
+## encodeToBase64WithPrefix variable
+
+Encodes the given value with a prefix to base64.
+
+**Signature:**
+
+```typescript
+encodeToBase64WithPrefix: (value: string | ArrayBuffer) => string
+```
+
+## Remarks
+
+Prefixes are: 'str:' for string and 'bin:' for ArrayBuffer.
+

package/docs/api/foundation-utils.md

@@ -77,12 +77,16 @@
 |  [API\_HOST](./foundation-utils.api_host.md) | The Genesis Server URL (WebSocket or HTTP). |
 |  [createErrorMap](./foundation-utils.createerrormap.md) | A factory to create the error map. |
 |  [createObserver](./foundation-utils.createobserver.md) | Creates a new event observer instance. |
+|  [decodeFromBase64](./foundation-utils.decodefrombase64.md) | Decodes a value from base64. |
+|  [decodeFromBase64WithPrefix](./foundation-utils.decodefrombase64withprefix.md) | Decodes a value from base64 with a prefix. |
 |  [DEFAULT\_ORGANISATION](./foundation-utils.default_organisation.md) | The default Organisation value, used in auth/login flow \[<code>genesislcap-foundation-login</code>\](https://link-to-docs). |
 |  [DEFAULT\_PASSWORD](./foundation-utils.default_password.md) | The default Password value, used in auth/login flow \[<code>genesislcap-foundation-login</code>\](https://link-to-docs). |
 |  [DEFAULT\_USER](./foundation-utils.default_user.md) | The default Username value, used in auth/login flow \[<code>genesislcap-foundation-login</code>\](https://link-to-docs). |
 |  [defaultEventMap](./foundation-utils.defaulteventmap.md) | A map that associates specific HTML element tags with their corresponding default event names. |
 |  [defaultJSONSerializerConfig](./foundation-utils.defaultjsonserializerconfig.md) | A Default JSONSerializer Config for serializing and deserializing functions. |
 |  [defaultLoggerOptions](./foundation-utils.defaultloggeroptions.md) | The default logger options. |
+|  [encodeToBase64](./foundation-utils.encodetobase64.md) | Encodes the given value to base64. |
+|  [encodeToBase64WithPrefix](./foundation-utils.encodetobase64withprefix.md) | Encodes the given value with a prefix to base64. |
 |  [FORCE\_HTTP](./foundation-utils.force_http.md) | The path to a JSON config file for the HTTP mode. |
 |  [GENESIS\_SOCKET\_URL](./foundation-utils.genesis_socket_url.md) | Genesis Socket URL |
 |  [getFontMixin](./foundation-utils.getfontmixin.md) | Generates a CSS mixin for the specified font family, style, and weight. |

package/docs/api-report.md

@@ -124,6 +124,12 @@ export interface DatabaseRecord {
     id: string;
 }
 
+// @public
+export const decodeFromBase64: (base64Value: string) => string | ArrayBuffer;
+
+// @public
+export const decodeFromBase64WithPrefix: (value: string) => string | ArrayBuffer;
+
 // @public
 export let DEFAULT_ORGANISATION: string;
 
@@ -191,6 +197,12 @@ export interface DTOMapper<TDTO, TEntity> {
     toDTO: (entity: Partial<TEntity>) => TDTO;
 }
 
+// @public
+export const encodeToBase64: (value: string | ArrayBuffer) => string;
+
+// @public
+export const encodeToBase64WithPrefix: (value: string | ArrayBuffer) => string;
+
 // @public (undocumented)
 export type ErrorDetailMap = Record<string, unknown>;
 

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@genesislcap/foundation-utils",
   "description": "Genesis Foundation Utils",
-  "version": "14.221.0",
+  "version": "14.221.1-alpha-457a890.0",
   "sideEffects": false,
   "license": "SEE LICENSE IN license.txt",
   "main": "dist/esm/index.js",
@@ -27,17 +27,17 @@
     }
   },
   "devDependencies": {
-    "@genesislcap/foundation-testing": "14.221.0",
-    "@genesislcap/genx": "14.221.0",
-    "@genesislcap/rollup-builder": "14.221.0",
-    "@genesislcap/ts-builder": "14.221.0",
-    "@genesislcap/uvu-playwright-builder": "14.221.0",
-    "@genesislcap/vite-builder": "14.221.0",
-    "@genesislcap/webpack-builder": "14.221.0",
+    "@genesislcap/foundation-testing": "14.221.1-alpha-457a890.0",
+    "@genesislcap/genx": "14.221.1-alpha-457a890.0",
+    "@genesislcap/rollup-builder": "14.221.1-alpha-457a890.0",
+    "@genesislcap/ts-builder": "14.221.1-alpha-457a890.0",
+    "@genesislcap/uvu-playwright-builder": "14.221.1-alpha-457a890.0",
+    "@genesislcap/vite-builder": "14.221.1-alpha-457a890.0",
+    "@genesislcap/webpack-builder": "14.221.1-alpha-457a890.0",
     "rimraf": "^5.0.0"
   },
   "dependencies": {
-    "@genesislcap/foundation-logger": "14.221.0",
+    "@genesislcap/foundation-logger": "14.221.1-alpha-457a890.0",
     "@microsoft/fast-components": "^2.30.6",
     "@microsoft/fast-element": "^1.12.0",
     "@microsoft/fast-foundation": "2.49.6",
@@ -55,5 +55,5 @@
     "access": "public"
   },
   "customElements": "dist/custom-elements.json",
-  "gitHead": "74cb1a2eb7b1b23c6c56f8852db7b8254968b88b"
+  "gitHead": "d317d9056f89626a925e47be50ae20ea3026522a"
 }