@genesislcap/foundation-comms 14.200.0 → 14.200.1-alpha-eb310c6.0

package/dist/esm/datasource/datasource.js

@@ -27,12 +27,16 @@ let DefaultDatasource = class DefaultDatasource {
         this.config = config;
         /** {@inheritDoc DatasourceMetadata.fetchMetadataRequired} */
         this.fetchMetadataRequired = true;
+        /** {@inheritDoc DatasourceMetadata.startStream} */
+        this.startStreamRequired = true;
         /** {@inheritDoc DatasourceMetadata.originalFieldDef} */
         this.originalFieldDef = [];
         /** {@inheritDoc DatasourceMetadata.fieldMetadata} */
         this.fieldMetadata = [];
         /** {@inheritDoc DatasourceMetadata.requestFields} */
         this.requestFields = [];
+        /** {@inheritDoc DatasourceMetadata.customRequestFields} */
+        this.customRequestFields = [];
         /** {@inheritDoc DatasourceMetadata.availableIndexes} */
         this.availableIndexes = [];
         this.readOnly = true;
@@ -49,7 +53,7 @@ let DefaultDatasource = class DefaultDatasource {
         // additional checks? regex? or maybe we can ask the server if it's a valid resource in the future
         return true;
     }
-    init(options, fetchMeta = this.fetchMetadataRequired) {
+    init(options, fetchMeta = this.fetchMetadataRequired, startStream = this.startStreamRequired) {
         return __awaiter(this, void 0, void 0, function* () {
             this.fetchMetadataRequired = fetchMeta;
             this.options = Object.assign(Object.assign({}, this.config.options), options);
@@ -73,20 +77,28 @@ let DefaultDatasource = class DefaultDatasource {
                 return false;
             }
             logger.debug(`Initializing ${resourceName} datasource from ${this.connect.host}`);
-            if (!this.options.isSnapshot) {
+            if (!this.options.isSnapshot && startStream) {
                 this.stream = yield this.createStream();
             }
             if (this.fetchMetadataRequired) {
                 yield this.fetchAndApplyMetadata(this.options.resourceName);
             }
-            logger.debug(`${resourceName} datasource initialization ${this.initialized ? `success` : 'failed'}`);
+            logger.debug(`${resourceName} datasource initialization ${this.initialized ? `was successful.` : 'has failed.'}`);
             this.reportStatus();
             return this.initialized;
         });
     }
-    deinit() {
+    startStream() {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (!this.options.isSnapshot && this.stream === undefined) {
+                this.stream = yield this.createStream();
+            }
+        });
+    }
+    /** {@inheritDoc Datasource.destroy} */
+    destroy() {
         var _a;
-        logger.debug('Datasource.deinit', (_a = this.options) === null || _a === void 0 ? void 0 : _a.resourceName);
+        logger.debug('Datasource.destroy', (_a = this.options) === null || _a === void 0 ? void 0 : _a.resourceName);
         this.status = undefined;
         this.fetchMetadataRequired = undefined;
         this.options = {};
@@ -95,55 +107,67 @@ let DefaultDatasource = class DefaultDatasource {
         this.originalFieldDef = [];
         this.fieldMetadata = [];
         this.requestFields = [];
-    }
-    /** {@inheritDoc Datasource.destroy} */
-    destroy() {
-        var _a;
-        logger.debug('Datasource.destroy', (_a = this.options) === null || _a === void 0 ? void 0 : _a.resourceName);
-        this.deinit();
-        delete this.stream;
-        this.status = undefined;
+        this.stream = undefined;
     }
     get params() {
         var _a;
-        const params = {
-            CRITERIA_MATCH: this.options.criteria,
-            FIELDS: this.options.fields,
-            MAX_ROWS: this.options.maxRows,
-            MAX_VIEW: this.options.maxView,
-            MOVING_VIEW: this.options.movingView,
-            POLLING_INTERVAL: this.options.pollingInterval,
-            DISABLE_POLLING: this.options.disablePolling,
-            REQUEST: this.options.request,
-            REVERSE: this.options.reverse,
-        };
+        let ORDER_BY;
         if (this.options.orderBy) {
             if (((_a = this.availableIndexes) === null || _a === void 0 ? void 0 : _a.findIndex((i) => i.NAME === this.options.orderBy)) > -1) {
-                params.ORDER_BY = this.options.orderBy;
+                ORDER_BY = this.options.orderBy;
             }
             else {
                 const validIndexes = this.availableIndexes.map((index) => index.NAME);
                 logger.warn('Specified [orderBy] index is not valid and will not be used. See https://learn.genesis.global/docs/database/data-types/index-entities/ - Available indexes:', validIndexes);
             }
         }
+        const params = {
+            // Common between DATASERVER and REQUEST_SERVER (REQ-REP)
+            CRITERIA_MATCH: this.options.criteria,
+            MAX_ROWS: this.options.maxRows,
+            VIEW_NUMBER: this.options.viewNumber,
+            // DATASERVER only
+            FIELDS: this.options.fields,
+            MAX_VIEW: this.options.maxView,
+            MOVING_VIEW: this.options.movingView,
+            ORDER_BY,
+            REVERSE: this.options.reverse,
+            // REQUEST_SERVER only
+            DISABLE_POLLING: this.options.disablePolling,
+            POLLING_INTERVAL: this.options.pollingInterval,
+            REQUEST: this.options.request,
+        };
         logger.debug('Getting configured params:', params);
         return params;
     }
-    snapshot() {
+    snapshot(overrideParams) {
         var _a;
         return __awaiter(this, void 0, void 0, function* () {
             logger.debug(`Requesting snapshot for ${this.options.resourceName} (${this.resourceType}).`);
             switch (this.resourceType) {
                 case ResourceType.DATASERVER:
-                    return this.connect.snapshot(this.options.resourceName, this.params);
+                    return this.connect.snapshot(this.options.resourceName, Object.assign(Object.assign({}, this.params), overrideParams));
                 case ResourceType.REQUEST_SERVER: {
-                    const _b = this.params, { REQUEST, CRITERIA_MATCH } = _b, DETAILS = __rest(_b, ["REQUEST", "CRITERIA_MATCH"]);
-                    const requestFields = Object.assign(Object.assign(Object.assign({}, Object.fromEntries(this.requestFields.map((rf) => [rf.NAME, '*']))), this.params.REQUEST), (((_a = this === null || this === void 0 ? void 0 : this.options) === null || _a === void 0 ? void 0 : _a.criteria) ? this.config.criteriaToFields(this.options.criteria) : {}));
+                    const _b = this.params, { REQUEST } = _b, DETAILS = __rest(_b, ["REQUEST"]);
                     const reqParams = {
-                        DETAILS,
-                        REQUEST: requestFields,
+                        DETAILS: {
+                            CRITERIA_MATCH: DETAILS.CRITERIA_MATCH,
+                            MAX_ROWS: DETAILS.MAX_ROWS,
+                            VIEW_NUMBER: DETAILS.VIEW_NUMBER,
+                        },
+                        REQUEST,
                     };
-                    return this.connect.request(this.options.resourceName, reqParams);
+                    if (!reqParams.REQUEST) {
+                        if (this.options.requestAutoSetup) {
+                            reqParams.REQUEST = Object.assign(Object.assign({}, Object.fromEntries(this.requestFields.map((rf) => [rf.NAME, '*']))), (((_a = this === null || this === void 0 ? void 0 : this.options) === null || _a === void 0 ? void 0 : _a.criteria)
+                                ? this.config.criteriaToFields(this.options.criteria)
+                                : {}));
+                        }
+                        else {
+                            reqParams.REQUEST = {};
+                        }
+                    }
+                    return this.connect.request(this.options.resourceName, Object.assign(Object.assign({}, reqParams), overrideParams));
                 }
                 default:
                     throw new Error(`Snapshot not supported for selected resource type: ${this.resourceType}`);
@@ -203,6 +227,7 @@ let DefaultDatasource = class DefaultDatasource {
                     this.originalFieldDef = extractFieldDefinitions(meta);
                     this.fieldMetadata = toFieldMetadata(this.originalFieldDef);
                     this.requestFields = meta.REQUEST_FIELD || [];
+                    this.customRequestFields = meta.FIELD || [];
                     this.fetchMetadataRequired = false;
                 }
                 this.status = this.normaliseStatus({
@@ -258,6 +283,9 @@ __decorate([
 __decorate([
     observable
 ], DefaultDatasource.prototype, "fetchMetadataRequired", void 0);
+__decorate([
+    observable
+], DefaultDatasource.prototype, "startStreamRequired", void 0);
 __decorate([
     observable
 ], DefaultDatasource.prototype, "originalFieldDef", void 0);
@@ -267,6 +295,9 @@ __decorate([
 __decorate([
     observable
 ], DefaultDatasource.prototype, "requestFields", void 0);
+__decorate([
+    observable
+], DefaultDatasource.prototype, "customRequestFields", void 0);
 __decorate([
     observable
 ], DefaultDatasource.prototype, "availableIndexes", void 0);

package/dist/esm/metadata/metadata.utils.js

@@ -36,12 +36,13 @@ export const toFieldMetadata = (fieldDef) => {
  * @returns An array of metadata detail.
  */
 export const extractFieldDefinitions = (metadata) => {
+    var _a;
     const type = metadata === null || metadata === void 0 ? void 0 : metadata.TYPE;
     if (type === ResourceType.DATASERVER) {
         return metadata.FIELD || [];
     }
     if (type === ResourceType.REQUEST_SERVER) {
-        return metadata.REPLY_FIELD || [];
+        return metadata.REPLY_FIELD || ((_a = metadata.REPLY) === null || _a === void 0 ? void 0 : _a.FIELD) || [];
     }
     throw new Error(`Unsupported resource type: ${type}`);
 };

package/dist/esm/testing/mocks/datasource/datasource.js

@@ -12,11 +12,15 @@ export class DatasourceMock {
         this.originalFieldDef = [];
         this.fieldMetadata = [];
         this.requestFields = [];
+        this.customRequestFields = [];
         this.availableIndexes = [];
     }
     init(options, fetchMeta) {
         return Promise.resolve(this.initialized);
     }
+    startStream() {
+        return Promise.resolve();
+    }
     /**
      * Convenience method to avoid you having to prime connect etc.
      * @param meta - The metadata to set.
@@ -27,6 +31,7 @@ export class DatasourceMock {
         this.originalFieldDef = extractFieldDefinitions(meta);
         this.fieldMetadata = toFieldMetadata(this.originalFieldDef);
         this.requestFields = meta.REQUEST_FIELD || [];
+        this.customRequestFields = meta.FIELD || [];
         this.fetchMetadataRequired = false;
     }
     unsetMedata() {
@@ -58,8 +63,12 @@ export class DatasourceMock {
     getMetadata(resourceName) {
         return Promise.resolve(this.fieldMetadata);
     }
-    snapshot(params) { }
-    snapshotFiltered(rowId) { }
+    snapshot(params) {
+        return Promise.resolve(null);
+    }
+    snapshotFiltered(rowId) {
+        return Promise.resolve(null);
+    }
     updateData(data) {
         return Promise.resolve();
     }
@@ -99,6 +108,9 @@ __decorate([
 __decorate([
     observable
 ], DatasourceMock.prototype, "requestFields", void 0);
+__decorate([
+    observable
+], DatasourceMock.prototype, "customRequestFields", void 0);
 __decorate([
     observable
 ], DatasourceMock.prototype, "availableIndexes", void 0);