@genesislcap/foundation-comms 14.187.1-alpha-3406925.0 → 14.187.1

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

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

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

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

package/dist/dts/testing/mocks/resources/genesis/genesis.d.ts

@@ -1,16 +0,0 @@
-import { ResourceType } from '../../../../datasource';
-import type { GenesisResources, ResourceItem } from '../../../../resources';
-/**
- * @public
- */
-export declare class GenesisResourcesMock implements GenesisResources {
-    resources: ResourceItem[];
-    nextIsValidResourceResponse: boolean;
-    nextResourceTypeForResponse: ResourceType;
-    /** {@inheritDoc GenesisResources.isValidResource} */
-    isValidResource(resourceName: string): Promise<boolean>;
-    /** {@inheritDoc GenesisResources.getResourceTypeFor} */
-    getResourceTypeFor(resourceName: string): Promise<ResourceType>;
-    destroy(): void;
-}
-//# sourceMappingURL=genesis.d.ts.map

package/dist/dts/testing/mocks/resources/genesis/genesis.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"genesis.d.ts","sourceRoot":"","sources":["../../../../../../src/testing/mocks/resources/genesis/genesis.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,wBAAwB,CAAC;AACtD,OAAO,KAAK,EAAE,gBAAgB,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAC;AAE5E;;GAEG;AACH,qBAAa,oBAAqB,YAAW,gBAAgB;IAC3D,SAAS,EAAE,YAAY,EAAE,CAAM;IAC/B,2BAA2B,EAAE,OAAO,CAAQ;IAC5C,2BAA2B,EAAE,YAAY,CAA2B;IAEpE,qDAAqD;IAC/C,eAAe,CAAC,YAAY,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAI7D,wDAAwD;IAClD,kBAAkB,CAAC,YAAY,EAAE,MAAM,GAAG,OAAO,CAAC,YAAY,CAAC;IAIrE,OAAO;CACR"}

package/dist/dts/testing/mocks/resources/genesis/index.d.ts

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

package/dist/dts/testing/mocks/resources/genesis/index.d.ts.map

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

package/dist/dts/testing/mocks/resources/index.d.ts

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

package/dist/dts/testing/mocks/resources/index.d.ts.map

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

package/dist/esm/datasource/datasource.config.js

@@ -1,41 +0,0 @@
-import { DI } from '@microsoft/fast-foundation';
-import { criteriaFiltersToFields } from './criteriaFiltersToFields';
-import { dataServerResultFilter } from './dataServerResultFilter';
-/**
- * Default values for a DatasourceConfig
- * @public
- */
-export class DatasourceDefaults {
-}
-DatasourceDefaults.MAX_ROWS_250 = 250;
-DatasourceDefaults.MAX_VIEW_1000 = 1000;
-DatasourceDefaults.REQ_REP_POLLING_INTERVAL_MS = 10000;
-DatasourceDefaults.DATASERVER_ROW_ID = 'ROW_REF';
-DatasourceDefaults.REQUEST_SERVER_ROW_ID = 'RECORD_ID';
-/**
- * Default DatasourceConfig DI implementation.
- * @public
- */
-export const defaultDatasourceConfig = {
-    options: {
-        criteria: '',
-        isSnapshot: false,
-        maxRows: DatasourceDefaults.MAX_ROWS_250,
-        maxView: DatasourceDefaults.MAX_VIEW_1000,
-        pollingInterval: DatasourceDefaults.REQ_REP_POLLING_INTERVAL_MS,
-        movingView: false,
-        orderBy: '',
-        resourceName: '',
-        reverse: false,
-    },
-    criteriaToFields: criteriaFiltersToFields,
-    dataServerResultFilter: dataServerResultFilter,
-};
-/**
- * DatasourceConfig DI key.
- *
- * @internal
- * @privateRemarks
- * Marked as internal to stop api-extractor becoming confused cross-linking tokens with the same name.
- */
-export const DatasourceConfig = DI.createInterface((x) => x.instance(defaultDatasourceConfig));

package/dist/esm/datasource/datasource.mixins.js

@@ -1,86 +0,0 @@
-import { __decorate } from "tslib";
-import { observable } from '@microsoft/fast-element';
-import { logger } from '../utils';
-import { DatasourceStatusChanged, } from './datasource.types';
-/**
- * Datasource event handler mixin for target classes that use or are interested in datasource status changes.
- *
- * @remarks
- * Classes that use the mixin are not required to own the datasource itself, there may be several interested parties.
- *
- * @example
- * ```ts
- * import { DatasourceEventHandler, DatasourceStatus } from '@genesislcap/foundation-comms';
- * ...
- * class MyComponent extends DatasourceEventHandler(FASTElement) {
- *     resourceName: string = 'some-resource';
- *     ...
- *     datasourceStatusChanged(prev: DatasourceStatus, next: DatasourceStatus) {
- *         // Respond to changes in the target datasource.
- *     }
- * }
- * ```
- *
- * @privateRemarks
- * Unfortunately our datasource ui components do not share a common baseclass. Given datasource ui components contain a
- * Datasource and currently await their `init`, usage is more for example at this point, ie. how could we allow interested
- * parties to monitor and respond to changes, given they will exist at different levels of DOM hierarchy etc. Datasource
- * itself is also transient DI injectable, so each interested party would not have access to the same instance, nor would
- * we necessarily want to expose that via the event to prevent them operating on it to cause unwanted side effects.
- *
- * @param Target - The class to mix the event handler with.
- *
- * @public
- */
-export const DatasourceEventHandler = (Target) => {
-    // @ts-ignore
-    class Mixin extends Target {
-        constructor() {
-            super();
-            if (!this.hasOwnProperty('onDatasourceStatusChanged')) {
-                this.onDatasourceStatusChanged = (event) => {
-                    var _a;
-                    if (!this.resourceName) {
-                        logger.warn(`Target classes must have a resourceName property to use the DatasourceEventHandler mixin.`);
-                    }
-                    const next = event.detail;
-                    if (next.name === this.resourceName) {
-                        const prev = (_a = this.datasourceStatus) !== null && _a !== void 0 ? _a : {
-                            isInitialized: false,
-                            hasMetadata: false,
-                        };
-                        const hasChanged = prev.isInitialized !== next.isInitialized ||
-                            (next.metadataRequired && prev.hasMetadata !== next.hasMetadata);
-                        if (hasChanged) {
-                            this.datasourceStatus = next;
-                        }
-                    }
-                };
-            }
-        }
-        /**
-         * @remarks
-         * Override this method to respond to changes in the target datasource.
-         */
-        datasourceStatusChanged(prev, next) {
-            logger.debug('Target classes should override the datasourceStatusChanged method of the DatasourceEventHandler mixin to respond to changes in the target datasource.');
-        }
-        connectedCallback() {
-            super.connectedCallback();
-            document.addEventListener(DatasourceStatusChanged, this.onDatasourceStatusChanged, {
-                passive: true,
-                capture: true,
-            });
-        }
-        disconnectedCallback() {
-            super.disconnectedCallback();
-            document.removeEventListener(DatasourceStatusChanged, this.onDatasourceStatusChanged, {
-                capture: true,
-            });
-        }
-    }
-    __decorate([
-        observable
-    ], Mixin.prototype, "datasourceStatus", void 0);
-    return Mixin;
-};

package/dist/esm/resources/genesis/config.js

@@ -1,51 +0,0 @@
-import { registerTypedBroadcastChannel, } from '@genesislcap/foundation-broadcast-channel';
-import { DI } from '@microsoft/fast-foundation';
-import { GenesisResourcesChannelId } from './types';
-/**
- * Default GenesisResourcesConfig implementation.
- * @public
- */
-export const defaultGenesisResourcesConfig = {
-    throwWhenUnavailable: true,
-    throwWhenUnknown: false,
-};
-/**
- * GenesisResourcesConfig DI key.
- * @internal
- * @privateRemarks
- * Marked as internal to stop api-extractor becoming confused cross-linking tokens with the same name.
- */
-export const GenesisResourcesConfig = DI.createInterface((x) => x.instance(defaultGenesisResourcesConfig));
-/**
- * GenesisResourcesChannel DI key.
- * @internal
- * @privateRemarks
- * Marked as internal to stop api-extractor becoming confused cross-linking tokens with the same name.
- */
-export const GenesisResourcesChannel = registerTypedBroadcastChannel(GenesisResourcesChannelId);
-/**
- * Gets GenesisResourcesChannel from the DI container.
- *
- * @remarks
- * A utility method for host applications that are not using decorators or the DI container.
- *
- * @example
- * ```ts
- * import { getGenesisResourcesChannel } from '@genesislcap/foundation-comms';
- * ...
- * const channel = getGenesisResourcesChannel();
- * ...
- * channel.onmessage = (e) => {
- *  if (channel.isMessageType('resources-loaded', e)) {
- *    logger.debug('resources-loaded', e.data.detail);
- *    return;
- *  }
- * }
- * ...
- * channel.close();
- * ```
- * @public
- */
-export function getGenesisResourcesChannel() {
-    return DI.getOrCreateDOMContainer().get(GenesisResourcesChannel);
-}

package/dist/esm/resources/genesis/genesis.js

@@ -1,114 +0,0 @@
-import { __awaiter, __decorate, __param } from "tslib";
-import { DI } from '@microsoft/fast-foundation';
-import { Connect } from '../../connect';
-import { logger } from '../../utils';
-import { GenesisResourcesConfig, getGenesisResourcesChannel } from './config';
-/**
- * Default GenesisResources implementation.
- * @public
- */
-let DefaultGenesisResources = class DefaultGenesisResources {
-    constructor(connect, config) {
-        this.connect = connect;
-        this.config = config;
-    }
-    /** {@inheritDoc GenesisResources.isValidResource} */
-    isValidResource(resourceName) {
-        return __awaiter(this, void 0, void 0, function* () {
-            resourceName = resourceName === null || resourceName === void 0 ? void 0 : resourceName.trim();
-            if (!resourceName) {
-                return false;
-            }
-            yield this.getResources();
-            const resourceItem = this.resources.find((item) => item.RESOURCE_NAME === resourceName);
-            return !!resourceItem;
-        });
-    }
-    /** {@inheritDoc GenesisResources.getResourceTypeFor} */
-    getResourceTypeFor(resourceName) {
-        return __awaiter(this, void 0, void 0, function* () {
-            yield this.getResources();
-            const resourceItem = this.resources.find((item) => item.RESOURCE_NAME === resourceName);
-            if (resourceItem) {
-                return resourceItem.RESOURCE_TYPE;
-            }
-            const message = `${resourceName} resource does not exist.`;
-            logger.error(message);
-            if (this.config.throwWhenUnknown) {
-                throw new Error(message);
-            }
-        });
-    }
-    /** {@inheritDoc GenesisResources.destroy} */
-    destroy() {
-        this.resources = undefined;
-        this.resourcesPromise = undefined;
-    }
-    getResources() {
-        var _a;
-        return __awaiter(this, void 0, void 0, function* () {
-            if (!this.resourcesPromise) {
-                /**
-                 * Await a resources request
-                 */
-                this.resourcesPromise = this.connect.getAvailableResources();
-                const data = yield this.resourcesPromise;
-                this.resources = data === null || data === void 0 ? void 0 : data.RESOURCES;
-                if (!((_a = this.resources) === null || _a === void 0 ? void 0 : _a.length)) {
-                    const message = `Genesis resources unavailable.`;
-                    logger.error(message);
-                    if (this.config.throwWhenUnavailable) {
-                        throw new Error(message);
-                    }
-                }
-                this.postLoadedMessage();
-                this.resourcesPromise = undefined;
-            }
-            else {
-                /**
-                 * Await the in-progress resources request
-                 */
-                yield this.resourcesPromise;
-            }
-        });
-    }
-    postLoadedMessage() {
-        /**
-         * Normally we'd inject channels into components and call their `channel.close()` api on `disconnectedCallback`.
-         * However, in shared long-lived service instances like this, channels may lead to tests failing to exit as they are
-         * not garbage collected by default. Creating and destroying the channel on on-demand poses less risk.
-         */
-        const channel = getGenesisResourcesChannel();
-        channel.postMessage('resources-loaded', this.resources);
-        channel.close();
-    }
-};
-DefaultGenesisResources = __decorate([
-    __param(0, Connect),
-    __param(1, GenesisResourcesConfig)
-], DefaultGenesisResources);
-export { DefaultGenesisResources };
-/**
- * GenesisResources DI key.
- * @internal
- * @privateRemarks
- * Marked as internal to stop api-extractor becoming confused cross-linking tokens with the same name.
- */
-export const GenesisResources = DI.createInterface((x) => x.singleton(DefaultGenesisResources));
-/**
- * Gets GenesisResources from the DI container.
- *
- * @remarks
- * A utility method for host applications that are not using decorators or the DI container.
- *
- * @example
- * ```ts
- * import { getGenesisResources } from '@genesislcap/foundation-comms';
- * ...
- * const genesisResources = getGenesisResources();
- * ```
- * @public
- */
-export function getGenesisResources() {
-    return DI.getOrCreateDOMContainer().get(GenesisResources);
-}

package/dist/esm/resources/genesis/index.js

@@ -1,3 +0,0 @@
-export * from './config';
-export * from './genesis';
-export * from './types';

package/dist/esm/resources/genesis/types.js

@@ -1,4 +0,0 @@
-/**
- * @public
- */
-export const GenesisResourcesChannelId = 'genesis-resources';

package/dist/esm/resources/index.js

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

package/dist/esm/testing/mocks/resources/genesis/genesis.js

@@ -1,25 +0,0 @@
-import { __awaiter } from "tslib";
-import { ResourceType } from '../../../../datasource';
-/**
- * @public
- */
-export class GenesisResourcesMock {
-    constructor() {
-        this.resources = [];
-        this.nextIsValidResourceResponse = true;
-        this.nextResourceTypeForResponse = ResourceType.DATASERVER;
-    }
-    /** {@inheritDoc GenesisResources.isValidResource} */
-    isValidResource(resourceName) {
-        return __awaiter(this, void 0, void 0, function* () {
-            return this.nextIsValidResourceResponse;
-        });
-    }
-    /** {@inheritDoc GenesisResources.getResourceTypeFor} */
-    getResourceTypeFor(resourceName) {
-        return __awaiter(this, void 0, void 0, function* () {
-            return this.nextResourceTypeForResponse;
-        });
-    }
-    destroy() { }
-}

package/dist/esm/testing/mocks/resources/genesis/index.js

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

package/dist/esm/testing/mocks/resources/index.js

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

package/docs/api/foundation-comms.connect.host.md

@@ -1,11 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [Connect](./foundation-comms.connect.md) &gt; [host](./foundation-comms.connect.host.md)
-
-## Connect.host property
-
-**Signature:**
-
-```typescript
-host: string;
-```

package/docs/api/foundation-comms.datasourceconfig.eventemitter.md

@@ -1,18 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [DatasourceConfig](./foundation-comms.datasourceconfig.md) &gt; [eventEmitter](./foundation-comms.datasourceconfig.eventemitter.md)
-
-## DatasourceConfig.eventEmitter property
-
-The element to emit events from.
-
-**Signature:**
-
-```typescript
-eventEmitter?: HTMLElement;
-```
-
-## Remarks
-
-If omitted the document is used.
-