@genesislcap/foundation-comms 14.151.1 → 14.152.0

package/dist/dts/storage/kv/kv.service.d.ts

@@ -1,3 +1,4 @@
+import { Auth } from '../../auth';
 import { Connect } from '../../connect';
 import { KVStorageConfig } from './kv-config.service';
 import { KeyValue, KeyValueTransfer, KVValue, KVEventFailureResponse } from './kv.types';
@@ -26,8 +27,14 @@ export interface KVStorage {
  */
 export declare class DefaultKVStorage implements KVStorage {
     private connect;
+    private auth;
     private kvStorageConfig;
-    constructor(connect: Connect, kvStorageConfig?: KVStorageConfig);
+    constructor(connect: Connect, auth: Auth, kvStorageConfig?: KVStorageConfig);
+    /**
+     * Determine whether KV Storage is available for use.
+     * @internal
+     */
+    private checkAvailability;
     /**
      * Deletes the specified key-value pairs from the KV storage.
      * @alpha

package/dist/dts/storage/kv/kv.service.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"kv.service.d.ts","sourceRoot":"","sources":["../../../../src/storage/kv/kv.service.ts"],"names":[],"mappings":"AACA,OAAO,EAAgB,OAAO,EAA0B,MAAM,eAAe,CAAC;AAE9E,OAAO,EAA0B,eAAe,EAAE,MAAM,qBAAqB,CAAC;AAC9E,OAAO,EACL,QAAQ,EACR,gBAAgB,EAChB,OAAO,EACP,sBAAsB,EAGvB,MAAM,YAAY,CAAC;AAEpB;;;;;;;;;;;;GAYG;AACH,MAAM,WAAW,SAAS;IACxB,MAAM,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,IAAI,GAAG,sBAAsB,CAAC,CAAC;IAC/D,GAAG,CAAC,CAAC,GAAG,OAAO,EAAE,GAAG,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,gBAAgB,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;IAC/D,IAAI,IAAI,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC;IAC1B,GAAG,CAAC,GAAG,EAAE,QAAQ,CAAC,OAAO,CAAC,EAAE,GAAG,OAAO,CAAC,IAAI,GAAG,sBAAsB,CAAC,CAAC;CACvE;AAED;;;GAGG;AACH,qBAAa,gBAAiB,YAAW,SAAS;IAErC,OAAO,CAAC,OAAO;IACG,OAAO,CAAC,eAAe;gBADjC,OAAO,EAAE,OAAO,EACE,eAAe,kBAAyB;IAG7E;;;;;;;;;;;;OAYG;IACG,MAAM,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,IAAI,GAAG,sBAAsB,CAAC;IAuBpE;;;;;;;;;;;;;;;;;OAiBG;IACG,GAAG,CAAC,CAAC,GAAG,OAAO,EAAE,GAAG,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,gBAAgB,CAAC,CAAC,CAAC,EAAE,CAAC;IAwBpE;;;;;;;;;;;OAWG;IACG,IAAI,IAAI,OAAO,CAAC,MAAM,EAAE,CAAC;IAqB/B;;;;;;;;;;;;OAYG;IACG,GAAG,CAAC,GAAG,EAAE,QAAQ,CAAC,OAAO,CAAC,EAAE,GAAG,OAAO,CAAC,IAAI,GAAG,sBAAsB,CAAC;CAsB5E;AAED;;;GAGG;AACH,eAAO,MAAM,SAAS,iEAAsE,CAAC"}
+{"version":3,"file":"kv.service.d.ts","sourceRoot":"","sources":["../../../../src/storage/kv/kv.service.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,IAAI,EAAE,MAAM,YAAY,CAAC;AAClC,OAAO,EAAgB,OAAO,EAA0B,MAAM,eAAe,CAAC;AAE9E,OAAO,EAA0B,eAAe,EAAE,MAAM,qBAAqB,CAAC;AAC9E,OAAO,EACL,QAAQ,EACR,gBAAgB,EAChB,OAAO,EACP,sBAAsB,EAGvB,MAAM,YAAY,CAAC;AAEpB;;;;;;;;;;;;GAYG;AACH,MAAM,WAAW,SAAS;IACxB,MAAM,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,IAAI,GAAG,sBAAsB,CAAC,CAAC;IAC/D,GAAG,CAAC,CAAC,GAAG,OAAO,EAAE,GAAG,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,gBAAgB,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;IAC/D,IAAI,IAAI,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC;IAC1B,GAAG,CAAC,GAAG,EAAE,QAAQ,CAAC,OAAO,CAAC,EAAE,GAAG,OAAO,CAAC,IAAI,GAAG,sBAAsB,CAAC,CAAC;CACvE;AAED;;;GAGG;AACH,qBAAa,gBAAiB,YAAW,SAAS;IAErC,OAAO,CAAC,OAAO;IAClB,OAAO,CAAC,IAAI;IACS,OAAO,CAAC,eAAe;gBAFjC,OAAO,EAAE,OAAO,EACnB,IAAI,EAAE,IAAI,EACW,eAAe,kBAAyB;IAK7E;;;OAGG;YACW,iBAAiB;IAa/B;;;;;;;;;;;;OAYG;IACG,MAAM,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,IAAI,GAAG,sBAAsB,CAAC;IAmBpE;;;;;;;;;;;;;;;;;OAiBG;IACG,GAAG,CAAC,CAAC,GAAG,OAAO,EAAE,GAAG,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,gBAAgB,CAAC,CAAC,CAAC,EAAE,CAAC;IAoBpE;;;;;;;;;;;OAWG;IACG,IAAI,IAAI,OAAO,CAAC,MAAM,EAAE,CAAC;IAiB/B;;;;;;;;;;;;OAYG;IACG,GAAG,CAAC,GAAG,EAAE,QAAQ,CAAC,OAAO,CAAC,EAAE,GAAG,OAAO,CAAC,IAAI,GAAG,sBAAsB,CAAC;CAkB5E;AAED;;;GAGG;AACH,eAAO,MAAM,SAAS,iEAAsE,CAAC"}

package/dist/esm/storage/kv/kv-config.service.js

@@ -7,7 +7,7 @@ export const defaultKVStorageConfig = {
     account: 'genesis',
     namespace: 'default',
     authKey: 'kv-default',
-    authEmail: 'kv@genesis.global',
+    authEmail: undefined,
 };
 /**
  * KVStorageConfig DI key.

package/dist/esm/storage/kv/kv.service.js

@@ -1,5 +1,6 @@
 import { __awaiter, __decorate, __param } from "tslib";
 import { DI, optional } from '@microsoft/fast-foundation';
+import { Auth } from '../../auth';
 import { Connect } from '../../connect';
 import { logger } from '../../utils';
 import { defaultKVStorageConfig, KVStorageConfig } from './kv-config.service';
@@ -9,9 +10,25 @@ import { KVEventMessageType, KVMessageType, } from './kv.types';
  * @alpha
  */
 let DefaultKVStorage = class DefaultKVStorage {
-    constructor(connect, kvStorageConfig = defaultKVStorageConfig) {
+    constructor(connect, auth, kvStorageConfig = defaultKVStorageConfig) {
         this.connect = connect;
+        this.auth = auth;
         this.kvStorageConfig = kvStorageConfig;
+        this.checkAvailability();
+    }
+    /**
+     * Determine whether KV Storage is available for use.
+     * @internal
+     */
+    checkAvailability() {
+        var _a;
+        return __awaiter(this, void 0, void 0, function* () {
+            const allSystemTables = yield this.connect.request('SYSTEM_TABLES');
+            const isKVStoreAvailable = !!((_a = allSystemTables === null || allSystemTables === void 0 ? void 0 : allSystemTables.REPLY) === null || _a === void 0 ? void 0 : _a.find((table) => table.TABLE_NAME === 'KEY_VALUE'));
+            if (!isKVStoreAvailable) {
+                logger.error('KV Storage is not available on the server resources. Update your server to use it.');
+            }
+        });
     }
     /**
      * Deletes the specified key-value pairs from the KV storage.
@@ -34,15 +51,12 @@ let DefaultKVStorage = class DefaultKVStorage {
                 },
             };
             const result = yield this.connect.commitEvent(KVEventMessageType.EVENT_KEY_VALUE_DELETE, params);
-            logger.debug('KV Delete result: ', result);
-            return new Promise((resolve) => {
-                if (result && result.MESSAGE_TYPE === 'EVENT_ACK') {
-                    resolve(true);
-                }
-                else {
-                    resolve({ ERROR: result.ERROR, WARNING: result.WARNING });
-                }
-            });
+            if (result && result.MESSAGE_TYPE === 'EVENT_ACK') {
+                return true;
+            }
+            else {
+                return { ERROR: result.ERROR, WARNING: result.WARNING };
+            }
         });
     }
     /**
@@ -64,24 +78,22 @@ let DefaultKVStorage = class DefaultKVStorage {
      * ```
      */
     get(key) {
+        var _a, _b, _c;
         return __awaiter(this, void 0, void 0, function* () {
             const params = {
                 REQUEST: {
-                    USER_NAME: this.kvStorageConfig.authEmail,
+                    USER_NAME: (_a = this.kvStorageConfig.authEmail) !== null && _a !== void 0 ? _a : (_c = (_b = this.auth) === null || _b === void 0 ? void 0 : _b.currentUser) === null || _c === void 0 ? void 0 : _c.username,
                     KEY: key,
                 },
             };
             const result = yield this.connect.request(KVMessageType.REQ_KEY_VALUE_READ, params);
-            logger.debug('KV Get result: ', result);
-            return new Promise((resolve) => {
-                if (result && result.REPLY && result.REPLY.length > 0) {
-                    const kvs = result.REPLY.map((kv) => ({ kv: { key: kv.KEY, value: kv.VALUE } }));
-                    resolve(kvs);
-                }
-                else {
-                    resolve([]);
-                }
-            });
+            if (result && result.REPLY && result.REPLY.length > 0) {
+                const kvs = result.REPLY.map((kv) => ({ kv: { key: kv.KEY, value: kv.VALUE } }));
+                return kvs;
+            }
+            else {
+                return [];
+            }
         });
     }
     /**
@@ -97,23 +109,21 @@ let DefaultKVStorage = class DefaultKVStorage {
      * ```
      */
     list() {
+        var _a, _b, _c;
         return __awaiter(this, void 0, void 0, function* () {
             const params = {
                 REQUEST: {
-                    USER_NAME: this.kvStorageConfig.authEmail,
+                    USER_NAME: (_a = this.kvStorageConfig.authEmail) !== null && _a !== void 0 ? _a : (_c = (_b = this.auth) === null || _b === void 0 ? void 0 : _b.currentUser) === null || _c === void 0 ? void 0 : _c.username,
                 },
             };
             const result = yield this.connect.request(KVMessageType.REQ_KEY_VALUE_LIST, params);
-            logger.debug('KV List result: ', result);
-            return new Promise((resolve) => {
-                if (result && result.REPLY && result.REPLY.length > 0) {
-                    const keys = result.REPLY.map((kv) => kv.KEY);
-                    resolve(keys);
-                }
-                else {
-                    resolve([]);
-                }
-            });
+            if (result && result.REPLY && result.REPLY.length > 0) {
+                const keys = result.REPLY.map((kv) => kv.KEY);
+                return keys;
+            }
+            else {
+                return [];
+            }
         });
     }
     /**
@@ -140,21 +150,19 @@ let DefaultKVStorage = class DefaultKVStorage {
                 },
             };
             const result = yield this.connect.commitEvent(KVEventMessageType.EVENT_KEY_VALUE_PUT, params);
-            logger.debug('KV Put result: ', result);
-            return new Promise((resolve) => {
-                if (result && result.MESSAGE_TYPE === 'EVENT_ACK') {
-                    resolve(true);
-                }
-                else {
-                    resolve({ ERROR: result.ERROR, WARNING: result.WARNING });
-                }
-            });
+            if (result && result.MESSAGE_TYPE === 'EVENT_ACK') {
+                return true;
+            }
+            else {
+                return { ERROR: result.ERROR, WARNING: result.WARNING };
+            }
         });
     }
 };
 DefaultKVStorage = __decorate([
     __param(0, Connect),
-    __param(1, optional(KVStorageConfig))
+    __param(1, Auth),
+    __param(2, optional(KVStorageConfig))
 ], DefaultKVStorage);
 export { DefaultKVStorage };
 /**

package/dist/foundation-comms.d.ts

@@ -1245,8 +1245,14 @@ export declare const defaultHttpConnectConfig: HttpConnectConfig;
  */
 export declare class DefaultKVStorage implements KVStorage {
     private connect;
+    private auth;
     private kvStorageConfig;
-    constructor(connect: Connect, kvStorageConfig?: KVStorageConfig);
+    constructor(connect: Connect, auth: Auth, kvStorageConfig?: KVStorageConfig);
+    /**
+     * Determine whether KV Storage is available for use.
+     * @internal
+     */
+    private checkAvailability;
     /**
      * Deletes the specified key-value pairs from the KV storage.
      * @alpha

package/docs/api-report.md

@@ -751,7 +751,7 @@ export const defaultHttpConnectConfig: HttpConnectConfig;
 
 // @alpha
 export class DefaultKVStorage implements KVStorage {
-    constructor(connect: Connect, kvStorageConfig?: KVStorageConfig);
+    constructor(connect: Connect, auth: Auth, kvStorageConfig?: KVStorageConfig);
     delete(keys: string[]): Promise<true | KVEventFailureResponse>;
     get<T = KVValue>(key?: string): Promise<KeyValueTransfer<T>[]>;
     list(): Promise<string[]>;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@genesislcap/foundation-comms",
   "description": "Genesis Foundation UI Comms",
-  "version": "14.151.1",
+  "version": "14.152.0",
   "sideEffects": false,
   "license": "SEE LICENSE IN license.txt",
   "main": "dist/esm/index.js",
@@ -59,13 +59,13 @@
     "test:debug": "genx test --debug"
   },
   "devDependencies": {
-    "@genesislcap/foundation-testing": "14.151.1",
-    "@genesislcap/genx": "14.151.1",
-    "@genesislcap/rollup-builder": "14.151.1",
-    "@genesislcap/ts-builder": "14.151.1",
-    "@genesislcap/uvu-playwright-builder": "14.151.1",
-    "@genesislcap/vite-builder": "14.151.1",
-    "@genesislcap/webpack-builder": "14.151.1",
+    "@genesislcap/foundation-testing": "14.152.0",
+    "@genesislcap/genx": "14.152.0",
+    "@genesislcap/rollup-builder": "14.152.0",
+    "@genesislcap/ts-builder": "14.152.0",
+    "@genesislcap/uvu-playwright-builder": "14.152.0",
+    "@genesislcap/vite-builder": "14.152.0",
+    "@genesislcap/webpack-builder": "14.152.0",
     "@types/js-cookie": "^3.0.2",
     "@types/json-schema": "^7.0.11",
     "@types/webappsec-credential-management": "^0.6.2",
@@ -73,8 +73,8 @@
   },
   "dependencies": {
     "@finos/fdc3": "^1.2.0",
-    "@genesislcap/foundation-logger": "14.151.1",
-    "@genesislcap/foundation-utils": "14.151.1",
+    "@genesislcap/foundation-logger": "14.152.0",
+    "@genesislcap/foundation-utils": "14.152.0",
     "@microsoft/fast-element": "^1.12.0",
     "@microsoft/fast-foundation": "^2.49.4",
     "analytics": "^0.8.0",
@@ -91,5 +91,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "b56ae0d22c24098e5fd2e771a9ec1749de9cabbf"
+  "gitHead": "f3d0250895a2e94b877e74ed2e2767831ee7b1de"
 }