@genesislcap/foundation-comms 14.294.0 → 14.295.1-alpha-523bee0.0

package/docs/api-report.md

@@ -78,6 +78,8 @@ export class AuthMock implements Auth {
     // (undocumented)
     currentUser: User_2;
     // (undocumented)
+    get isLoggedIn$(): Observable<boolean>;
+    // (undocumented)
     isLoggedIn: boolean;
     // (undocumented)
     isWorking: boolean;
@@ -127,6 +129,18 @@ export type BasicCredentialsInput = {
     password: string;
 };
 
+// @public (undocumented)
+export type CommitAckEvent = CustomEvent<CommitAckEventDetail>;
+
+// @public (undocumented)
+export type CommitAckEventDetail = {
+    eventName: string;
+    ack: Message;
+};
+
+// @public (undocumented)
+export const CommitAckEventType = "connect-commit-ack-event";
+
 // @public (undocumented)
 export type CommitEvent = CustomEvent<CommitEventDetail>;
 
@@ -148,6 +162,18 @@ export type CommitParams = {
     [key: string]: any;
 };
 
+// @public (undocumented)
+export type CommitResponseEvent = CustomEvent<CommitResponseEventDetail>;
+
+// @public (undocumented)
+export type CommitResponseEventDetail = {
+    eventName: string;
+    response: Message;
+};
+
+// @public (undocumented)
+export const CommitResponseEventType = "connect-commit-response-event";
+
 // Warning: (ae-internal-mixed-release-tag) Mixed release tags are not allowed for "Connect" because one of its declarations is marked as @internal
 //
 // @public
@@ -202,6 +228,7 @@ export const ConnectConfig: InterfaceSymbol<ConnectConfig>;
 // @public
 export interface ConnectEvents {
     addCommitListener(listener: Listener<CommitEvent>): () => void;
+    addCommitResponseListener(listener: Listener<CommitResponseEvent>): () => void;
     addMetadataListener(listener: Listener<MetadataEvent>): () => void;
     addStreamListener(listener: Listener<StreamEvent>, complete: Listener<StreamCompleteEvent>, error: Listener<StreamErrorEvent>): () => void;
 }
@@ -214,6 +241,7 @@ export const ConnectEvents: InterfaceSymbol<ConnectEvents>;
 // @public
 export interface ConnectEventsEmitter extends ConnectEvents {
     onCommitEvent(eventName: string, message: Message): void;
+    onCommitResponseEvent(eventName: string, response: Message): void;
     onMetadataEvent(resourceName: string, message: Message<MessageDetails.MetaRequest>, error?: any): void;
     onStreamCompleteEvent(resourceName: string, stream: SocketObservable<any>): void;
     onStreamErrorEvent(resourceName: string, stream: SocketObservable<any>, error: any): void;
@@ -223,6 +251,51 @@ export interface ConnectEventsEmitter extends ConnectEvents {
 // @internal
 export const ConnectEventsEmitter: InterfaceSymbol<ConnectEventsEmitter>;
 
+// Warning: (ae-internal-missing-underscore) The name "ConnectEventsMock" should be prefixed with an underscore because the declaration is marked as @internal
+//
+// @internal (undocumented)
+export class ConnectEventsMock {
+    // Warning: (ae-forgotten-export) The symbol "CommitAckEvent_2" needs to be exported by the entry point index.d.ts
+    //
+    // (undocumented)
+    addCommitAckListener(listener: Listener_2<CommitAckEvent_2>): () => void;
+    // Warning: (ae-forgotten-export) The symbol "CommitEvent_2" needs to be exported by the entry point index.d.ts
+    //
+    // (undocumented)
+    addCommitListener(listener: Listener_2<CommitEvent_2>): () => void;
+    // Warning: (ae-forgotten-export) The symbol "CommitResponseEvent_2" needs to be exported by the entry point index.d.ts
+    //
+    // (undocumented)
+    addCommitResponseListener(listener: Listener_2<CommitResponseEvent_2>): () => void;
+    // Warning: (ae-forgotten-export) The symbol "MetadataEvent_2" needs to be exported by the entry point index.d.ts
+    //
+    // (undocumented)
+    addMetadataListener(listener: Listener_2<MetadataEvent_2>): () => void;
+    // Warning: (ae-forgotten-export) The symbol "Listener_2" needs to be exported by the entry point index.d.ts
+    // Warning: (ae-forgotten-export) The symbol "StreamEvent_2" needs to be exported by the entry point index.d.ts
+    // Warning: (ae-forgotten-export) The symbol "StreamCompleteEvent_2" needs to be exported by the entry point index.d.ts
+    // Warning: (ae-forgotten-export) The symbol "StreamErrorEvent_2" needs to be exported by the entry point index.d.ts
+    //
+    // (undocumented)
+    addStreamListener(listener: Listener_2<StreamEvent_2>, complete: Listener_2<StreamCompleteEvent_2>, error: Listener_2<StreamErrorEvent_2>): () => void;
+    // (undocumented)
+    onCommitEvent(eventName: string, message: Message_2): void;
+    // (undocumented)
+    onCommitResponseEvent(eventName: string, response: Message_2): void;
+    // (undocumented)
+    onMetadataEvent(resourceName: string, message: Message_2, error?: any): void;
+    // (undocumented)
+    onStreamCompleteEvent(resourceName: string, stream: SocketObservable_2<any>): void;
+    // (undocumented)
+    onStreamErrorEvent(resourceName: string, stream: SocketObservable_2<any>, error: any): void;
+    // Warning: (ae-forgotten-export) The symbol "Message_2" needs to be exported by the entry point index.d.ts
+    // Warning: (ae-forgotten-export) The symbol "SocketObservable_2" needs to be exported by the entry point index.d.ts
+    // Warning: (ae-forgotten-export) The symbol "StreamEventFunctions_2" needs to be exported by the entry point index.d.ts
+    //
+    // (undocumented)
+    onStreamEvent(resourceName: string, message: Message_2, stream: SocketObservable_2<any>, functions: StreamEventFunctions_2): void;
+}
+
 // @public
 export type ConnectionStatus = 'connected' | 'disconnected' | 'busy';
 
@@ -875,6 +948,7 @@ export interface DatasourceOptions {
     movingView?: boolean;
     orderBy?: string;
     pollingInterval?: number;
+    pollTriggerEvents?: string[];
     request?: any;
     requestAutoSetup?: boolean;
     resourceName?: string;
@@ -999,6 +1073,10 @@ export class DefaultConnectEvents implements ConnectEventsEmitter {
     // Warning: (ae-unresolved-inheritdoc-reference) The @inheritDoc reference could not be resolved: The reference is ambiguous because "ConnectEvents" has more than one declaration; you need to add a TSDoc member reference selector
     //
     // (undocumented)
+    addCommitResponseListener(listener: Listener<CommitResponseEvent>): () => void;
+    // Warning: (ae-unresolved-inheritdoc-reference) The @inheritDoc reference could not be resolved: The reference is ambiguous because "ConnectEvents" has more than one declaration; you need to add a TSDoc member reference selector
+    //
+    // (undocumented)
     addMetadataListener(listener: Listener<MetadataEvent>): () => void;
     // Warning: (ae-unresolved-inheritdoc-reference) The @inheritDoc reference could not be resolved: The reference is ambiguous because "ConnectEvents" has more than one declaration; you need to add a TSDoc member reference selector
     //
@@ -1007,6 +1085,8 @@ export class DefaultConnectEvents implements ConnectEventsEmitter {
     // @internal (undocumented)
     protected commitListeners: Observer<CommitEvent>;
     // @internal (undocumented)
+    protected commitResponseListeners: Observer<CommitResponseEvent>;
+    // @internal (undocumented)
     protected metadataListeners: Observer<MetadataEvent>;
     // Warning: (ae-unresolved-inheritdoc-reference) The @inheritDoc reference could not be resolved: The reference is ambiguous because "ConnectEventsEmitter" has more than one declaration; you need to add a TSDoc member reference selector
     //
@@ -1015,6 +1095,10 @@ export class DefaultConnectEvents implements ConnectEventsEmitter {
     // Warning: (ae-unresolved-inheritdoc-reference) The @inheritDoc reference could not be resolved: The reference is ambiguous because "ConnectEventsEmitter" has more than one declaration; you need to add a TSDoc member reference selector
     //
     // (undocumented)
+    onCommitResponseEvent(eventName: string, response: Message): void;
+    // Warning: (ae-unresolved-inheritdoc-reference) The @inheritDoc reference could not be resolved: The reference is ambiguous because "ConnectEventsEmitter" has more than one declaration; you need to add a TSDoc member reference selector
+    //
+    // (undocumented)
     onMetadataEvent(resourceName: string, message: Message<MessageDetails.MetaRequest>, error?: any): void;
     // Warning: (ae-unresolved-inheritdoc-reference) The @inheritDoc reference could not be resolved: The reference is ambiguous because "ConnectEventsEmitter" has more than one declaration; you need to add a TSDoc member reference selector
     //
@@ -1099,7 +1183,7 @@ export const defaultCredentialRequestOptions: GetCredentialOptions;
 
 // @public
 export class DefaultDatasource implements Datasource {
-    constructor(connect: Connect, auth: Auth, resources: GenesisResources, config: DatasourceConfig);
+    constructor(connect: Connect, auth: Auth, resources: GenesisResources, config: DatasourceConfig, connectEvents: ConnectEvents);
     // @internal (undocumented)
     get allResourceParams(): DataserverParams & RequestParams;
     // (undocumented)
@@ -1111,6 +1195,8 @@ export class DefaultDatasource implements Datasource {
     // (undocumented)
     protected connect: Connect;
     // (undocumented)
+    protected connectEvents: ConnectEvents;
+    // (undocumented)
     customRequestFields: MetadataDetail[];
     // @internal (undocumented)
     get dataserverOnlyParams(): DataserverParams;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@genesislcap/foundation-comms",
   "description": "Genesis Foundation UI Comms",
-  "version": "14.294.0",
+  "version": "14.295.1-alpha-523bee0.0",
   "sideEffects": false,
   "license": "SEE LICENSE IN license.txt",
   "main": "dist/esm/index.js",
@@ -53,7 +53,7 @@
     "dev:webpack": "genx dev -b webpack",
     "serve": "genx serve",
     "test": "genx test",
-    "test:single": "genx test --match connect.test.ts",
+    "test:single": "genx test --match datasource.test.ts",
     "test:single:browser": "genx test --browser --match connect.test.ts",
     "test:single:browser:raw-match": "genx test --browser --raw-match --match ./**/connect.test.ts",
     "test:select": "genx test --match '(connect|reconnectStrategy|kv).test.ts'",
@@ -75,23 +75,24 @@
     }
   },
   "devDependencies": {
-    "@genesislcap/foundation-testing": "14.294.0",
-    "@genesislcap/genx": "14.294.0",
-    "@genesislcap/rollup-builder": "14.294.0",
-    "@genesislcap/ts-builder": "14.294.0",
-    "@genesislcap/uvu-playwright-builder": "14.294.0",
-    "@genesislcap/vite-builder": "14.294.0",
-    "@genesislcap/webpack-builder": "14.294.0",
+    "@genesislcap/foundation-testing": "14.295.1-alpha-523bee0.0",
+    "@genesislcap/genx": "14.295.1-alpha-523bee0.0",
+    "@genesislcap/rollup-builder": "14.295.1-alpha-523bee0.0",
+    "@genesislcap/ts-builder": "14.295.1-alpha-523bee0.0",
+    "@genesislcap/uvu-playwright-builder": "14.295.1-alpha-523bee0.0",
+    "@genesislcap/vite-builder": "14.295.1-alpha-523bee0.0",
+    "@genesislcap/webpack-builder": "14.295.1-alpha-523bee0.0",
     "@types/js-cookie": "^3.0.2",
     "@types/json-schema": "^7.0.11",
     "@types/webappsec-credential-management": "^0.6.2",
-    "rimraf": "^5.0.0"
+    "rimraf": "^5.0.0",
+    "sinon": "^17.0.1"
   },
   "dependencies": {
-    "@genesislcap/foundation-broadcast-channel": "14.294.0",
-    "@genesislcap/foundation-logger": "14.294.0",
-    "@genesislcap/foundation-user": "14.294.0",
-    "@genesislcap/foundation-utils": "14.294.0",
+    "@genesislcap/foundation-broadcast-channel": "14.295.1-alpha-523bee0.0",
+    "@genesislcap/foundation-logger": "14.295.1-alpha-523bee0.0",
+    "@genesislcap/foundation-user": "14.295.1-alpha-523bee0.0",
+    "@genesislcap/foundation-utils": "14.295.1-alpha-523bee0.0",
     "@microsoft/fast-element": "1.14.0",
     "@microsoft/fast-foundation": "2.49.6",
     "analytics": "^0.8.0",
@@ -111,5 +112,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "f7e3720d6f7bd3810a4a8350e4a3e9f436edb078"
+  "gitHead": "fabd074070cd2b0c566ff3a6d07b9b31ae47ca7c"
 }