@genesislcap/foundation-comms 14.288.1-alpha-817ceca.0 → 14.289.1-alpha-fe89166.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (40) hide show
  1. package/dist/dts/connect/connect.d.ts +2 -2
  2. package/dist/dts/connect/http.connect.d.ts +1 -1
  3. package/dist/dts/connect/socket.d.ts +3 -1
  4. package/dist/dts/connect/socket.d.ts.map +1 -1
  5. package/dist/dts/connect/socket.status.d.ts +1 -1
  6. package/dist/dts/connect/socket.status.d.ts.map +1 -1
  7. package/dist/dts/datasource/datasource.d.ts +16 -4
  8. package/dist/dts/datasource/datasource.d.ts.map +1 -1
  9. package/dist/dts/resources/genesis/genesis.d.ts +2 -2
  10. package/dist/dts/resources/genesis/genesis.d.ts.map +1 -1
  11. package/dist/dts/testing/mocks/datasource/datasource.d.ts +1 -0
  12. package/dist/dts/testing/mocks/datasource/datasource.d.ts.map +1 -1
  13. package/dist/dts/user/user.d.ts +4 -4
  14. package/dist/esm/connect/connect.js +1 -1
  15. package/dist/esm/connect/http.connect.js +1 -1
  16. package/dist/esm/connect/socket.js +4 -2
  17. package/dist/esm/datasource/datasource.js +40 -19
  18. package/dist/esm/resources/genesis/genesis.js +1 -1
  19. package/dist/esm/user/user.js +3 -3
  20. package/dist/foundation-comms.api.json +37 -102
  21. package/dist/foundation-comms.d.ts +30 -15
  22. package/docs/api/foundation-comms.connect.connect.md +1 -1
  23. package/docs/api/foundation-comms.currentuser.md +1 -1
  24. package/docs/api/foundation-comms.datasourcemetadata.md +1 -0
  25. package/docs/api/foundation-comms.datasourcemetadata.startstreamrequired.md +11 -0
  26. package/docs/api/foundation-comms.defaultconnect.setvalidsession.md +1 -1
  27. package/docs/api/foundation-comms.defaultdatasource.md +0 -3
  28. package/docs/api/foundation-comms.defaultgenesisresources.getallresources.md +1 -0
  29. package/docs/api/foundation-comms.defaultgenesisresources.md +1 -1
  30. package/docs/api/foundation-comms.defaulthttpconnect.setvalidsession.md +1 -1
  31. package/docs/api/foundation-comms.defaultsocket.hasvalidsession.md +5 -0
  32. package/docs/api/foundation-comms.genesisresources.getallresources.md +1 -1
  33. package/docs/api/foundation-comms.genesisresources.md +1 -1
  34. package/docs/api/foundation-comms.serializedsocketstatus.hasvalidsession.md +1 -1
  35. package/docs/api/foundation-comms.user.md +1 -1
  36. package/docs/api-report.md +11 -9
  37. package/package.json +13 -13
  38. package/docs/api/foundation-comms.defaultdatasource.allparams.md +0 -11
  39. package/docs/api/foundation-comms.defaultdatasource.dataserverparams.md +0 -11
  40. package/docs/api/foundation-comms.defaultdatasource.requestparams.md +0 -11
package/dist/dts/connect/connect.d.ts CHANGED
@@ -51,7 +51,7 @@ export interface Connect {
51
51
  /**
52
52
  * Connects to a server at the specified host.
53
53
  * @public
54
- * @param host - The host to connect to. Defaults to {@link @genesislcap/foundation-utils#GENESIS_SOCKET_URL | GENESIS_SOCKET_URL}.
54
+ * @param host - The host to connect to. Defaults to GENESIS_SOCKET_URL.
55
55
  * @returns A promise that resolves with a boolean indicating whether the connection was successful.
56
56
  */
57
57
  connect(host?: string): Promise<boolean>;
@@ -189,7 +189,7 @@ export declare class DefaultConnect implements Connect {
189
189
  constructor(socket: Socket, messageBuilder: MessageBuilder, metaCache: MetaCache, events: ConnectEventsEmitter, config: ConnectConfig);
190
190
  httpMode(): boolean;
191
191
  /**
192
- * @deprecated - Please reference {@link @genesislcap/foundation-user#User} instead.',
192
+ * @deprecated - Please reference `User` from `@genesislcap/foundation-user` instead.
193
193
  */
194
194
  setValidSession(valid: boolean): void;
195
195
  send<T>(message: Message<any>, needsHandling?: boolean): Promise<any>;
package/dist/dts/connect/http.connect.d.ts CHANGED
@@ -43,7 +43,7 @@ export declare class DefaultHttpConnect implements Connect {
43
43
  send<T>(message: Message<any>, needsHandling?: boolean): Promise<any>;
44
44
  httpMode(): boolean;
45
45
  /**
46
- * @deprecated - Please reference {@link @genesislcap/foundation-user#User} instead.',
46
+ * @deprecated - Please reference `User` from `@genesislcap/foundation-user` instead.
47
47
  */
48
48
  setValidSession(valid: boolean): void;
49
49
  connect(host: string): Promise<boolean>;
package/dist/dts/connect/socket.d.ts CHANGED
@@ -125,7 +125,9 @@ export declare class DefaultSocket implements Socket {
125
125
  get isDisconnected(): boolean;
126
126
  get isDisconnectedByServer(): boolean;
127
127
  get isReconnecting(): boolean;
128
- /** {@inheritDoc SerializedSocketStatus.hasValidSession} */
128
+ /**
129
+ * @deprecated - Use `User.isAuthenticated` from `@genesislcap/foundation-user` instead.
130
+ */
129
131
  get hasValidSession(): boolean;
130
132
  set hasValidSession(value: boolean);
131
133
  get host(): string;
package/dist/dts/connect/socket.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"socket.d.ts","sourceRoot":"","sources":["../../../src/connect/socket.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,8BAA8B,CAAC;AAEpD,OAAO,EAAsB,cAAc,EAAE,IAAI,EAAE,MAAM,+BAA+B,CAAC;AAGzF,OAAO,EAAE,UAAU,EAAgB,OAAO,EAAE,YAAY,EAAyB,MAAM,MAAM,CAAC;AAG9F,OAAO,EAAE,OAAO,EAAE,MAAM,YAAY,CAAC;AAErC,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAChD,OAAO,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AAC9B,OAAO,EAEL,OAAO,EACP,cAAc,EAIf,MAAM,WAAW,CAAC;AACnB,OAAO,EAKL,sBAAsB,EAEvB,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAC;AAC/C,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,gBAAgB,CAAC;AAG3D;;;;GAIG;AACH,qBAAa,aAAa,CAAC,CAAC,CAAE,SAAQ,OAAO,CAAC,CAAC,CAAC;;CAI/C;AAED;;;;GAIG;AACH,qBAAa,gBAAgB,CAAC,CAAC,CAAE,SAAQ,UAAU,CAAC,CAAC,CAAC;gBACxC,GAAG,IAAI,EAAE,GAAG,EAAE;CAG3B;AAED;;;GAGG;AACH,OAAO,EAAE,YAAY,IAAI,kBAAkB,EAAE,CAAC;AAE9C;;;GAGG;AACH,qBAAa,oBAAoB;gBACnB,OAAO,EAAE,OAAO,EAAE,SAAS,EAAE,QAAQ,EAAE,OAAO,EAAE,QAAQ,EAAE,cAAc,EAAE,OAAO;IAO7F;;;OAGG;IACH,IAAI,WAAW,IAAI,OAAO,CAEzB;IAED;;;OAGG;IACH,IAAI,iBAAiB,IAAI,QAAQ,CAEhC;IAED;;;OAGG;IACH,IAAI,eAAe,IAAI,QAAQ,CAE9B;IAED;;;OAGG;IACH,IAAI,cAAc,IAAI,OAAO,CAE5B;IAED;;OAEG;IACH,OAAO,CAAC,QAAQ,CAAU;IAE1B;;OAEG;IACH,OAAO,CAAC,UAAU,CAAW;IAE7B;;OAEG;IACH,OAAO,CAAC,QAAQ,CAAW;IAE3B;;OAEG;IACH,OAAO,CAAC,eAAe,CAAU;CAClC;AAED;;;;GAIG;AACH,MAAM,WAAW,MACf,SAAQ,IAAI,CACV,YAAY,EACV,WAAW,GACX,SAAS,GACT,0BAA0B,GAC1B,YAAY,GACZ,cAAc,GACd,aAAa,CAChB;IACD,OAAO,CACL,IAAI,EAAE,MAAM,EACZ,OAAO,CAAC,EAAE,oBAAoB,EAC9B,gBAAgB,CAAC,EAAE,sBAAsB,GACxC,OAAO,CAAC,OAAO,CAAC,CAAC;IAEpB;;OAEG;IACH,KAAK,IAAI,IAAI,CAAC;IAEd,IAAI,CAAC,CAAC,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC,GAAG,GAAG,CAAC,EAAE,aAAa,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,OAAO,GAAG,GAAG,CAAC,CAAC;IAEpF,aAAa,CAAC,CAAC,EACb,OAAO,EAAE,OAAO,CAAC,CAAC,GAAG,GAAG,CAAC,EACzB,SAAS,EAAE,QAAQ,EACnB,OAAO,EAAE,QAAQ,EACjB,UAAU,CAAC,EAAE,QAAQ,GACpB,UAAU,CAAC,OAAO,CAAC,CAAC;IAEvB;;;;;;;OAOG;IACH,4BAA4B,CAAC,CAAC,EAC5B,OAAO,EAAE,OAAO,CAAC,CAAC,GAAG,GAAG,CAAC,EACzB,SAAS,EAAE,QAAQ,EACnB,OAAO,EAAE,QAAQ,GAChB,UAAU,CAAC,OAAO,CAAC,CAAC;IAEvB,cAAc,IAAI,aAAa,CAAC,OAAO,CAAC,CAAC;IACzC,IAAI,EAAE,MAAM,CAAC;CACd;AAED;;;GAGG;AACH,qBAAa,aAAc,YAAW,MAAM;IA4ExB,OAAO,CAAC,cAAc;IAC7B,OAAO,CAAC,OAAO;IACR,OAAO,CAAC,UAAU;IAC5B,OAAO,CAAC,IAAI;IACJ,OAAO,CAAC,MAAM;IAC5B;;OAEG;IACG,SAAS,CAAC,IAAI,EAAE,IAAI;IACX,SAAS,CAAC,MAAM,EAAE,aAAa;IApFhD,OAAO,CAAC,QAAQ,CAAC,eAAe,CAAS;IACzC,OAAO,CAAC,QAAQ,CAAC,iBAAiB,CAAQ;IAG1C,OAAO,CAAC,SAAS,CAAwB;IAGzC,OAAO,CAAC,UAAU,CAAyB;IAG3C,OAAO,CAAC,iBAAiB,CAAoC;IAEvD,IAAI,EAAE,IAAI,CAAC;IAEjB,IAAI,YAAY,YAEf;IAED,IAAI,YAAY,YAEf;IAED,IAAI,WAAW,YAEd;IAED,IAAI,kBAAkB,4CAErB;IAED,IAAI,cAAc,YAEjB;IAED,IAAI,sBAAsB,YAEzB;IAED,IAAI,cAAc,YAEjB;IAED,2DAA2D;IAC3D,IAAI,eAAe,IASQ,OAAO,CAFjC;IAED,IAAI,eAAe,CAAC,KAAK,EAAE,OAAO,EAMjC;IAED,IAAI,IAAI,WAEP;IAGD,OAAO,CAAC,kBAAkB,CAAQ;IAClC,OAAO,CAAC,iBAAiB,CAAwB;IACjD,OAAO,CAAC,eAAe,CAAS;IAEhC,OAAO,CAAC,GAAG,CAAS;IACpB,OAAO,CAAC,cAAc,CAAuB;IAC7C,OAAO,CAAC,gBAAgB,CAAyB;IACjD,OAAO,CAAC,kBAAkB,CAAe;gBAGf,cAAc,EAAE,cAAc,EACrC,OAAO,EAAE,OAAO,EACT,UAAU,EAAE,cAAc,EACpC,IAAI,EAAE,IAAI,EACF,MAAM,EAAE,YAAY;IAC1C;;OAEG;IACa,IAAI,EAAE,IAAI,EACD,MAAM,EAAE,aAAa;IAGhD,OAAO,KAAK,yBAAyB,GAEpC;IAED,OAAO,KAAK,uBAAuB,GAElC;IAEM,OAAO,CACZ,IAAI,GAAE,MAA2B,EACjC,cAAc,CAAC,EAAE,oBAAoB,EACrC,gBAAgB,CAAC,EAAE,sBAAsB,GACxC,OAAO,CAAC,OAAO,CAAC;IAiKnB;;;;;OAKG;YACW,oBAAoB;IAclC,OAAO,CAAC,MAAM,CAAC,sBAAsB,CAAsB;YAE7C,uBAAuB;IA2CrC,OAAO,CAAC,cAAc;IAOtB,OAAO,CAAC,6BAA6B;IAWrC,OAAO,CAAC,gBAAgB;IAiDxB,OAAO,CAAC,SAAS;IAsEV,KAAK,IAAI,IAAI;IAQpB,OAAO,CAAC,aAAa;IAMd,IAAI,CAAC,CAAC,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC,GAAG,GAAG,CAAC,EAAE,aAAa,UAAO,GAAG,OAAO,CAAC,OAAO,GAAG,GAAG,CAAC;IAyBhF,aAAa,CAAC,CAAC,EACpB,OAAO,EAAE,OAAO,CAAC,CAAC,GAAG,GAAG,CAAC,EACzB,SAAS,EAAE,QAAQ,EACnB,OAAO,EAAE,QAAQ,EACjB,UAAU,CAAC,EAAE,QAAQ,GACpB,UAAU,CAAC,OAAO,CAAC;IAgDf,4BAA4B,CAAC,CAAC,EACnC,OAAO,EAAE,OAAO,CAAC,CAAC,GAAG,GAAG,CAAC,EACzB,SAAS,EAAE,QAAQ,EACnB,OAAO,EAAE,QAAQ,GAChB,UAAU,CAAC,OAAO,CAAC;IAcf,cAAc,QAAO,cAAc,OAAO,CAAC,CAAoB;IAEtE,OAAO,CAAC,iBAAiB;IAezB,OAAO,CAAC,cAAc;IAItB,OAAO,CAAC,oBAAoB;IAI5B,OAAO,CAAC,iBAAiB;IAUzB,OAAO,CAAC,kBAAkB;CAkB3B;AAED;;;GAGG;AACH,eAAO,MAAM,MAAM,8DAAgE,CAAC;AAEpF;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,SAAS,IAAI,MAAM,CAElC"}
1
+ {"version":3,"file":"socket.d.ts","sourceRoot":"","sources":["../../../src/connect/socket.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,8BAA8B,CAAC;AAEpD,OAAO,EAAsB,cAAc,EAAE,IAAI,EAAE,MAAM,+BAA+B,CAAC;AAGzF,OAAO,EAAE,UAAU,EAAgB,OAAO,EAAE,YAAY,EAAyB,MAAM,MAAM,CAAC;AAG9F,OAAO,EAAE,OAAO,EAAE,MAAM,YAAY,CAAC;AAErC,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAChD,OAAO,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AAC9B,OAAO,EAEL,OAAO,EACP,cAAc,EAIf,MAAM,WAAW,CAAC;AACnB,OAAO,EAKL,sBAAsB,EAEvB,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAC;AAC/C,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,gBAAgB,CAAC;AAG3D;;;;GAIG;AACH,qBAAa,aAAa,CAAC,CAAC,CAAE,SAAQ,OAAO,CAAC,CAAC,CAAC;;CAI/C;AAED;;;;GAIG;AACH,qBAAa,gBAAgB,CAAC,CAAC,CAAE,SAAQ,UAAU,CAAC,CAAC,CAAC;gBACxC,GAAG,IAAI,EAAE,GAAG,EAAE;CAG3B;AAED;;;GAGG;AACH,OAAO,EAAE,YAAY,IAAI,kBAAkB,EAAE,CAAC;AAE9C;;;GAGG;AACH,qBAAa,oBAAoB;gBACnB,OAAO,EAAE,OAAO,EAAE,SAAS,EAAE,QAAQ,EAAE,OAAO,EAAE,QAAQ,EAAE,cAAc,EAAE,OAAO;IAO7F;;;OAGG;IACH,IAAI,WAAW,IAAI,OAAO,CAEzB;IAED;;;OAGG;IACH,IAAI,iBAAiB,IAAI,QAAQ,CAEhC;IAED;;;OAGG;IACH,IAAI,eAAe,IAAI,QAAQ,CAE9B;IAED;;;OAGG;IACH,IAAI,cAAc,IAAI,OAAO,CAE5B;IAED;;OAEG;IACH,OAAO,CAAC,QAAQ,CAAU;IAE1B;;OAEG;IACH,OAAO,CAAC,UAAU,CAAW;IAE7B;;OAEG;IACH,OAAO,CAAC,QAAQ,CAAW;IAE3B;;OAEG;IACH,OAAO,CAAC,eAAe,CAAU;CAClC;AAED;;;;GAIG;AACH,MAAM,WAAW,MACf,SAAQ,IAAI,CACV,YAAY,EACV,WAAW,GACX,SAAS,GACT,0BAA0B,GAC1B,YAAY,GACZ,cAAc,GACd,aAAa,CAChB;IACD,OAAO,CACL,IAAI,EAAE,MAAM,EACZ,OAAO,CAAC,EAAE,oBAAoB,EAC9B,gBAAgB,CAAC,EAAE,sBAAsB,GACxC,OAAO,CAAC,OAAO,CAAC,CAAC;IAEpB;;OAEG;IACH,KAAK,IAAI,IAAI,CAAC;IAEd,IAAI,CAAC,CAAC,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC,GAAG,GAAG,CAAC,EAAE,aAAa,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,OAAO,GAAG,GAAG,CAAC,CAAC;IAEpF,aAAa,CAAC,CAAC,EACb,OAAO,EAAE,OAAO,CAAC,CAAC,GAAG,GAAG,CAAC,EACzB,SAAS,EAAE,QAAQ,EACnB,OAAO,EAAE,QAAQ,EACjB,UAAU,CAAC,EAAE,QAAQ,GACpB,UAAU,CAAC,OAAO,CAAC,CAAC;IAEvB;;;;;;;OAOG;IACH,4BAA4B,CAAC,CAAC,EAC5B,OAAO,EAAE,OAAO,CAAC,CAAC,GAAG,GAAG,CAAC,EACzB,SAAS,EAAE,QAAQ,EACnB,OAAO,EAAE,QAAQ,GAChB,UAAU,CAAC,OAAO,CAAC,CAAC;IAEvB,cAAc,IAAI,aAAa,CAAC,OAAO,CAAC,CAAC;IACzC,IAAI,EAAE,MAAM,CAAC;CACd;AAED;;;GAGG;AACH,qBAAa,aAAc,YAAW,MAAM;IA8ExB,OAAO,CAAC,cAAc;IAC7B,OAAO,CAAC,OAAO;IACR,OAAO,CAAC,UAAU;IAC5B,OAAO,CAAC,IAAI;IACJ,OAAO,CAAC,MAAM;IAC5B;;OAEG;IACG,SAAS,CAAC,IAAI,EAAE,IAAI;IACX,SAAS,CAAC,MAAM,EAAE,aAAa;IAtFhD,OAAO,CAAC,QAAQ,CAAC,eAAe,CAAS;IACzC,OAAO,CAAC,QAAQ,CAAC,iBAAiB,CAAQ;IAG1C,OAAO,CAAC,SAAS,CAAwB;IAGzC,OAAO,CAAC,UAAU,CAAyB;IAG3C,OAAO,CAAC,iBAAiB,CAAoC;IAEvD,IAAI,EAAE,IAAI,CAAC;IAEjB,IAAI,YAAY,YAEf;IAED,IAAI,YAAY,YAEf;IAED,IAAI,WAAW,YAEd;IAED,IAAI,kBAAkB,4CAErB;IAED,IAAI,cAAc,YAEjB;IAED,IAAI,sBAAsB,YAEzB;IAED,IAAI,cAAc,YAEjB;IAED;;OAEG;IACH,IAAI,eAAe,IASQ,OAAO,CAFjC;IAED,IAAI,eAAe,CAAC,KAAK,EAAE,OAAO,EAMjC;IAED,IAAI,IAAI,WAEP;IAGD,OAAO,CAAC,kBAAkB,CAAQ;IAClC,OAAO,CAAC,iBAAiB,CAAwB;IACjD,OAAO,CAAC,eAAe,CAAS;IAEhC,OAAO,CAAC,GAAG,CAAS;IACpB,OAAO,CAAC,cAAc,CAAuB;IAC7C,OAAO,CAAC,gBAAgB,CAAyB;IACjD,OAAO,CAAC,kBAAkB,CAAe;gBAGf,cAAc,EAAE,cAAc,EACrC,OAAO,EAAE,OAAO,EACT,UAAU,EAAE,cAAc,EACpC,IAAI,EAAE,IAAI,EACF,MAAM,EAAE,YAAY;IAC1C;;OAEG;IACa,IAAI,EAAE,IAAI,EACD,MAAM,EAAE,aAAa;IAGhD,OAAO,KAAK,yBAAyB,GAEpC;IAED,OAAO,KAAK,uBAAuB,GAElC;IAEM,OAAO,CACZ,IAAI,GAAE,MAA2B,EACjC,cAAc,CAAC,EAAE,oBAAoB,EACrC,gBAAgB,CAAC,EAAE,sBAAsB,GACxC,OAAO,CAAC,OAAO,CAAC;IAiKnB;;;;;OAKG;YACW,oBAAoB;IAclC,OAAO,CAAC,MAAM,CAAC,sBAAsB,CAAsB;YAE7C,uBAAuB;IA2CrC,OAAO,CAAC,cAAc;IAOtB,OAAO,CAAC,6BAA6B;IAWrC,OAAO,CAAC,gBAAgB;IAiDxB,OAAO,CAAC,SAAS;IAsEV,KAAK,IAAI,IAAI;IAQpB,OAAO,CAAC,aAAa;IAMd,IAAI,CAAC,CAAC,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC,GAAG,GAAG,CAAC,EAAE,aAAa,UAAO,GAAG,OAAO,CAAC,OAAO,GAAG,GAAG,CAAC;IAyBhF,aAAa,CAAC,CAAC,EACpB,OAAO,EAAE,OAAO,CAAC,CAAC,GAAG,GAAG,CAAC,EACzB,SAAS,EAAE,QAAQ,EACnB,OAAO,EAAE,QAAQ,EACjB,UAAU,CAAC,EAAE,QAAQ,GACpB,UAAU,CAAC,OAAO,CAAC;IAgDf,4BAA4B,CAAC,CAAC,EACnC,OAAO,EAAE,OAAO,CAAC,CAAC,GAAG,GAAG,CAAC,EACzB,SAAS,EAAE,QAAQ,EACnB,OAAO,EAAE,QAAQ,GAChB,UAAU,CAAC,OAAO,CAAC;IAcf,cAAc,QAAO,cAAc,OAAO,CAAC,CAAoB;IAEtE,OAAO,CAAC,iBAAiB;IAezB,OAAO,CAAC,cAAc;IAItB,OAAO,CAAC,oBAAoB;IAI5B,OAAO,CAAC,iBAAiB;IAUzB,OAAO,CAAC,kBAAkB;CAkB3B;AAED;;;GAGG;AACH,eAAO,MAAM,MAAM,8DAAgE,CAAC;AAEpF;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,SAAS,IAAI,MAAM,CAElC"}
package/dist/dts/connect/socket.status.d.ts CHANGED
@@ -15,7 +15,7 @@ export interface SerializedSocketStatus {
15
15
  isDisconnectedByServer: boolean;
16
16
  isReconnecting: boolean;
17
17
  reconnectionLimitReached: boolean;
18
- /** @deprecated - Use {@link @genesislcap/foundation-user#User.isAuthenticated} instead. */
18
+ /** @deprecated - Use `User.isAuthenticated` from `@genesislcap/foundation-user` instead. */
19
19
  hasValidSession: boolean;
20
20
  readonly closedCode: number;
21
21
  readonly closedReason: string;
package/dist/dts/connect/socket.status.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"socket.status.d.ts","sourceRoot":"","sources":["../../../src/connect/socket.status.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,8BAA8B,CAAC;AAGpD,OAAO,EAAE,eAAe,EAAE,MAAM,MAAM,CAAC;AAEvC;;;GAGG;AACH,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,YAAY,EAAE,OAAO,CAAC;IACtB,YAAY,EAAE,OAAO,CAAC;IACtB,WAAW,EAAE,OAAO,CAAC;IACrB,cAAc,EAAE,OAAO,CAAC;IACxB,sBAAsB,EAAE,OAAO,CAAC;IAChC,cAAc,EAAE,OAAO,CAAC;IACxB,wBAAwB,EAAE,OAAO,CAAC;IAClC,2FAA2F;IAC3F,eAAe,EAAE,OAAO,CAAC;IACzB,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC;IAC5B,QAAQ,CAAC,YAAY,EAAE,MAAM,CAAC;IAC9B,QAAQ,CAAC,WAAW,EAAE,OAAO,CAAC;CAC/B;AAED;;;GAGG;AACH,MAAM,WAAW,YAAa,SAAQ,sBAAsB;IAC1D,kBAAkB,EAAE,eAAe,CAAC,OAAO,CAAC,CAAC;IAC7C,SAAS,IAAI,sBAAsB,CAAC;IACpC,OAAO,CAAC,UAAU,EAAE,UAAU,GAAG,IAAI,CAAC;CACvC;AAED;;;GAGG;AACH,qBAAa,mBAAoB,YAAW,YAAY;IAC1C,YAAY,UAAS;IACrB,YAAY,UAAS;IACrB,WAAW,UAAS;IACpB,cAAc,UAAS;IACvB,wBAAwB,UAAS;IACjC,UAAU,MAAC;IACX,YAAY,MAAC;IACb,WAAW,MAAC;IAElB,SAAS,CAAC,IAAI,EAAE,IAAI,CAAC;IAE3B,2DAA2D;IAC3D,IAAI,eAAe,YAElB;IAED,IAAI,cAAc,YAEjB;IAED,IAAI,sBAAsB,YAEzB;IAEM,kBAAkB,2BAAyC;IAElE,SAAS,CAAC,kBAAkB;IAS5B,SAAS,CAAC,qBAAqB;IAM/B,SAAS,CAAC,gBAAgB;IAM1B,SAAS,IAAI,sBAAsB;IAgBnC,OAAO,CAAC,KAAK,EAAE,UAAU;CAM1B;AAED;;;;;;;GAOG;AACH,eAAO,MAAM,YAAY,oEAExB,CAAC;AAEF;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,eAAe,IAAI,YAAY,CAE9C"}
1
+ {"version":3,"file":"socket.status.d.ts","sourceRoot":"","sources":["../../../src/connect/socket.status.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,8BAA8B,CAAC;AAGpD,OAAO,EAAE,eAAe,EAAE,MAAM,MAAM,CAAC;AAEvC;;;GAGG;AACH,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,YAAY,EAAE,OAAO,CAAC;IACtB,YAAY,EAAE,OAAO,CAAC;IACtB,WAAW,EAAE,OAAO,CAAC;IACrB,cAAc,EAAE,OAAO,CAAC;IACxB,sBAAsB,EAAE,OAAO,CAAC;IAChC,cAAc,EAAE,OAAO,CAAC;IACxB,wBAAwB,EAAE,OAAO,CAAC;IAClC,4FAA4F;IAC5F,eAAe,EAAE,OAAO,CAAC;IACzB,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC;IAC5B,QAAQ,CAAC,YAAY,EAAE,MAAM,CAAC;IAC9B,QAAQ,CAAC,WAAW,EAAE,OAAO,CAAC;CAC/B;AAED;;;GAGG;AACH,MAAM,WAAW,YAAa,SAAQ,sBAAsB;IAC1D,kBAAkB,EAAE,eAAe,CAAC,OAAO,CAAC,CAAC;IAC7C,SAAS,IAAI,sBAAsB,CAAC;IACpC,OAAO,CAAC,UAAU,EAAE,UAAU,GAAG,IAAI,CAAC;CACvC;AAED;;;GAGG;AACH,qBAAa,mBAAoB,YAAW,YAAY;IAC1C,YAAY,UAAS;IACrB,YAAY,UAAS;IACrB,WAAW,UAAS;IACpB,cAAc,UAAS;IACvB,wBAAwB,UAAS;IACjC,UAAU,MAAC;IACX,YAAY,MAAC;IACb,WAAW,MAAC;IAElB,SAAS,CAAC,IAAI,EAAE,IAAI,CAAC;IAE3B,2DAA2D;IAC3D,IAAI,eAAe,YAElB;IAED,IAAI,cAAc,YAEjB;IAED,IAAI,sBAAsB,YAEzB;IAEM,kBAAkB,2BAAyC;IAElE,SAAS,CAAC,kBAAkB;IAS5B,SAAS,CAAC,qBAAqB;IAM/B,SAAS,CAAC,gBAAgB;IAM1B,SAAS,IAAI,sBAAsB;IAgBnC,OAAO,CAAC,KAAK,EAAE,UAAU;CAM1B;AAED;;;;;;;GAOG;AACH,eAAO,MAAM,YAAY,oEAExB,CAAC;AAEF;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,eAAe,IAAI,YAAY,CAE9C"}
package/dist/dts/datasource/datasource.d.ts CHANGED
@@ -16,6 +16,7 @@ export interface DatasourceMetadata {
16
16
  readonly fieldMetadata: FieldMetadata[];
17
17
  readonly requestFields: MetadataDetail[];
18
18
  readonly customRequestFields: MetadataDetail[];
19
+ startStreamRequired: boolean;
19
20
  }
20
21
  /**
21
22
  * Datasource interface.
@@ -174,7 +175,7 @@ export declare class DefaultDatasource implements Datasource {
174
175
  status: DatasourceStatus;
175
176
  /** {@inheritDoc DatasourceMetadata.fetchMetadataRequired} */
176
177
  fetchMetadataRequired: boolean;
177
- /** {@inheritDoc DatasourceMetadata.startStream} */
178
+ /** {@inheritDoc DatasourceMetadata.startStreamRequired} */
178
179
  startStreamRequired: boolean;
179
180
  /** {@inheritDoc DatasourceMetadata.originalFieldDef} */
180
181
  originalFieldDef: MetadataDetail[];
@@ -192,6 +193,7 @@ export declare class DefaultDatasource implements Datasource {
192
193
  protected options: DatasourceOptions;
193
194
  resourceType: ResourceType;
194
195
  stream: SocketObservable<FilteredDataServerResult | RequestServerResult>;
196
+ private _allParams;
195
197
  constructor(connect: Connect, auth: Auth, resources: GenesisResources, config: DatasourceConfig);
196
198
  /**
197
199
  * @deprecated - Please use {@link (GenesisResources:interface).isValidResource} instead.
@@ -201,9 +203,18 @@ export declare class DefaultDatasource implements Datasource {
201
203
  startStream(): Promise<void>;
202
204
  /** {@inheritDoc Datasource.destroy} */
203
205
  destroy(): void;
204
- get allParams(): any;
205
- get dataserverParams(): DataserverParams;
206
- get requestParams(): RequestParams;
206
+ /**
207
+ * @internal
208
+ */
209
+ get allResourceParams(): DataserverParams & RequestParams;
210
+ /**
211
+ * @internal
212
+ */
213
+ get dataserverOnlyParams(): DataserverParams;
214
+ /**
215
+ * @internal
216
+ */
217
+ get requestOnlyParams(): RequestParams;
207
218
  snapshot(overrideParams?: any): Promise<Message>;
208
219
  snapshotFiltered(rowId?: string): Promise<any[]>;
209
220
  private createStream;
@@ -218,6 +229,7 @@ export declare class DefaultDatasource implements Datasource {
218
229
  * @internal
219
230
  */
220
231
  protected normaliseStatus(status: Partial<DatasourceStatus>): DatasourceStatus;
232
+ private invalidateCache;
221
233
  }
222
234
  /**
223
235
  * The DI token for the Datasource interface.
package/dist/dts/datasource/datasource.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"datasource.d.ts","sourceRoot":"","sources":["../../../src/datasource/datasource.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,IAAI,EAAE,MAAM,SAAS,CAAC;AAC/B,OAAO,EAAE,OAAO,EAAE,gBAAgB,EAAE,OAAO,EAAE,aAAa,EAAE,gBAAgB,EAAE,MAAM,YAAY,CAAC;AACjG,OAAO,KAAK,EACV,aAAa,EACb,wBAAwB,EACxB,WAAW,EACX,cAAc,EAEd,mBAAmB,EACpB,MAAM,4BAA4B,CAAC;AAEpC,OAAO,EAAE,gBAAgB,EAAE,MAAM,cAAc,CAAC;AAEhD,OAAO,EAAE,gBAAgB,EAAE,MAAM,qBAAqB,CAAC;AACvD,OAAO,KAAK,EAAE,iBAAiB,EAAE,gBAAgB,EAAE,QAAQ,EAAE,MAAM,oBAAoB,CAAC;AACxF,OAAO,EAA2B,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAE3E;;;GAGG;AACH,MAAM,WAAW,kBAAkB;IACjC,qBAAqB,EAAE,OAAO,CAAC;IAC/B,QAAQ,CAAC,gBAAgB,EAAE,WAAW,EAAE,CAAC;IACzC,QAAQ,CAAC,gBAAgB,EAAE,cAAc,EAAE,CAAC;IAC5C,QAAQ,CAAC,aAAa,EAAE,aAAa,EAAE,CAAC;IACxC,QAAQ,CAAC,aAAa,EAAE,cAAc,EAAE,CAAC;IACzC,QAAQ,CAAC,mBAAmB,EAAE,cAAc,EAAE,CAAC;CAChD;AAED;;;;;GAKG;AACH,MAAM,WAAW,UAAW,SAAQ,kBAAkB;IACpD;;OAEG;IACH,MAAM,EAAE,OAAO,CAAC,gBAAgB,CAAC,CAAC;IAElC;;;OAGG;IACH,WAAW,EAAE,OAAO,CAAC;IAErB;;;;OAIG;IACH,QAAQ,EAAE,OAAO,CAAC;IAElB;;;OAGG;IACH,YAAY,EAAE,YAAY,CAAC;IAE3B;;;OAGG;IACH,MAAM,EAAE,gBAAgB,CAAC,wBAAwB,GAAG,mBAAmB,CAAC,CAAC;IAEzE;;;;OAIG;IACH,iBAAiB,CAAC,YAAY,EAAE,MAAM,GAAG,OAAO,CAAC;IAEjD;;;;;;;OAOG;IACH,IAAI,CAAC,OAAO,EAAE,iBAAiB,EAAE,SAAS,CAAC,EAAE,OAAO,EAAE,WAAW,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;IAE/F;;;OAGG;IACH,WAAW,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAE7B;;;;OAIG;IACH,OAAO,IAAI,IAAI,CAAC;IAEhB;;;;;OAKG;IACH,WAAW,CAAC,CAAC,YAAY,EAAE,MAAM,GAAG,OAAO,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC,CAAC;IAElE;;;;OAIG;IACH,QAAQ,CAAC,cAAc,CAAC,EAAE,GAAG,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;IAEjD;;;;OAIG;IACH,gBAAgB,CAAC,KAAK,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,EAAE,CAAC,CAAC;IAEjD;;;;;OAKG;IACH,UAAU,CAAC,CAAC,IAAI,EAAE,KAAK,CAAC,GAAG,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAE7C;;;;;OAKG;IACH,WAAW,CAAC,CAAC,IAAI,EAAE,KAAK,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC,GAAG,CAAC,CAAC;IAE3C;;;;OAIG;IACH,OAAO,CAAC,CAAC,IAAI,EAAE,QAAQ,GAAG,IAAI,CAAC;IAE/B;;;;OAIG;IACH,QAAQ,CAAC,CAAC,IAAI,EAAE,QAAQ,GAAG,IAAI,CAAC;IAEhC;;;;;;;OAOG;IACH,SAAS,CAAC,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,EAAE,IAAI,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEnE;;;;;OAKG;IACH,WAAW,CAAC,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAE1C;;;;;OAKG;IACH,UAAU,CAAC,CAAC,IAAI,EAAE,GAAG,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;IAExC;;;;;OAKG;IACH,UAAU,CAAC,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAE3C;;;;;;OAMG;IACH,UAAU,CAAC,CAAC,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,GAAG,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CACvD;AAED;;;GAGG;AACH,qBAAa,iBAAkB,YAAW,UAAU;IAyCvC,SAAS,CAAC,OAAO,EAAE,OAAO;IAC7B,SAAS,CAAC,IAAI,EAAE,IAAI;IACR,SAAS,CAAC,SAAS,EAAE,gBAAgB;IACrC,SAAS,CAAC,MAAM,EAAE,gBAAgB;IA3CtD;;OAEG;IACS,MAAM,EAAE,gBAAgB,CAAC;IAErC,6DAA6D;IACjD,qBAAqB,UAAQ;IAEzC,mDAAmD;IACvC,mBAAmB,UAAQ;IAEvC,wDAAwD;IAC5C,gBAAgB,EAAE,cAAc,EAAE,CAAM;IAEpD,qDAAqD;IACzC,aAAa,EAAE,aAAa,EAAE,CAAM;IAEhD,qDAAqD;IACzC,aAAa,EAAE,cAAc,EAAE,CAAM;IAEjD,2DAA2D;IAC/C,mBAAmB,EAAE,cAAc,EAAE,CAAM;IAEvD,wDAAwD;IAC5C,gBAAgB,EAAE,WAAW,EAAE,CAAM;IAEjD,2CAA2C;IAC3C,IAAI,WAAW,YAEd;IAGM,QAAQ,UAAQ;IAEvB,SAAS,CAAC,OAAO,EAAE,iBAAiB,CAAC;IAC9B,YAAY,EAAE,YAAY,CAAC;IAEtB,MAAM,EAAE,gBAAgB,CAAC,wBAAwB,GAAG,mBAAmB,CAAC,CAAC;gBAGhE,OAAO,EAAE,OAAO,EACnB,IAAI,EAAE,IAAI,EACE,SAAS,EAAE,gBAAgB,EAC3B,MAAM,EAAE,gBAAgB;IAGtD;;OAEG;IACH,iBAAiB,CAAC,YAAY,EAAE,MAAM,GAAG,OAAO;IAW1C,IAAI,CACR,OAAO,EAAE,iBAAiB,EAC1B,SAAS,GAAE,OAAoC,EAC/C,WAAW,GAAE,OAAkC,GAC9C,OAAO,CAAC,OAAO,CAAC;IAkDb,WAAW,IAAI,OAAO,CAAC,IAAI,CAAC;IAMlC,uCAAuC;IACvC,OAAO;IAaP,IAAI,SAAS,QAkCZ;IAED,IAAI,gBAAgB,IAAI,gBAAgB,CAWvC;IAED,IAAI,aAAa,IAAI,aAAa,CAuBjC;IAEK,QAAQ,CAAC,cAAc,CAAC,EAAE,GAAG,GAAG,OAAO,CAAC,OAAO,CAAC;IAsBhD,gBAAgB,CAAC,KAAK,GAAE,MAAkB,GAAG,OAAO,CAAC,GAAG,EAAE,CAAC;YAYnD,YAAY;YAeZ,sBAAsB;IAYpC,OAAO,CAAC,kBAAkB;cAgBV,qBAAqB,CAAC,YAAY,EAAE,MAAM;IA2B1D;;OAEG;IACH,SAAS,CAAC,YAAY,CAAC,MAAM,GAAE,OAAO,CAAC,gBAAgB,CAAM;IAa7D;;OAEG;IACH,SAAS,CAAC,eAAe,CAAC,MAAM,EAAE,OAAO,CAAC,gBAAgB,CAAC,GAAG,gBAAgB;CAY/E;AAED;;;GAGG;AACH,eAAO,MAAM,UAAU,kEAAwE,CAAC;AAEhG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AACH,wBAAgB,aAAa,IAAI,UAAU,CAE1C"}
1
+ {"version":3,"file":"datasource.d.ts","sourceRoot":"","sources":["../../../src/datasource/datasource.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,IAAI,EAAE,MAAM,SAAS,CAAC;AAC/B,OAAO,EAAE,OAAO,EAAE,gBAAgB,EAAE,OAAO,EAAE,aAAa,EAAE,gBAAgB,EAAE,MAAM,YAAY,CAAC;AACjG,OAAO,KAAK,EACV,aAAa,EACb,wBAAwB,EACxB,WAAW,EACX,cAAc,EAEd,mBAAmB,EACpB,MAAM,4BAA4B,CAAC;AAEpC,OAAO,EAAE,gBAAgB,EAAE,MAAM,cAAc,CAAC;AAEhD,OAAO,EAAE,gBAAgB,EAAE,MAAM,qBAAqB,CAAC;AACvD,OAAO,KAAK,EAAE,iBAAiB,EAAE,gBAAgB,EAAE,QAAQ,EAAE,MAAM,oBAAoB,CAAC;AACxF,OAAO,EAA2B,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAE3E;;;GAGG;AACH,MAAM,WAAW,kBAAkB;IACjC,qBAAqB,EAAE,OAAO,CAAC;IAC/B,QAAQ,CAAC,gBAAgB,EAAE,WAAW,EAAE,CAAC;IACzC,QAAQ,CAAC,gBAAgB,EAAE,cAAc,EAAE,CAAC;IAC5C,QAAQ,CAAC,aAAa,EAAE,aAAa,EAAE,CAAC;IACxC,QAAQ,CAAC,aAAa,EAAE,cAAc,EAAE,CAAC;IACzC,QAAQ,CAAC,mBAAmB,EAAE,cAAc,EAAE,CAAC;IAC/C,mBAAmB,EAAE,OAAO,CAAC;CAC9B;AAED;;;;;GAKG;AACH,MAAM,WAAW,UAAW,SAAQ,kBAAkB;IACpD;;OAEG;IACH,MAAM,EAAE,OAAO,CAAC,gBAAgB,CAAC,CAAC;IAElC;;;OAGG;IACH,WAAW,EAAE,OAAO,CAAC;IAErB;;;;OAIG;IACH,QAAQ,EAAE,OAAO,CAAC;IAElB;;;OAGG;IACH,YAAY,EAAE,YAAY,CAAC;IAE3B;;;OAGG;IACH,MAAM,EAAE,gBAAgB,CAAC,wBAAwB,GAAG,mBAAmB,CAAC,CAAC;IAEzE;;;;OAIG;IACH,iBAAiB,CAAC,YAAY,EAAE,MAAM,GAAG,OAAO,CAAC;IAEjD;;;;;;;OAOG;IACH,IAAI,CAAC,OAAO,EAAE,iBAAiB,EAAE,SAAS,CAAC,EAAE,OAAO,EAAE,WAAW,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;IAE/F;;;OAGG;IACH,WAAW,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAE7B;;;;OAIG;IACH,OAAO,IAAI,IAAI,CAAC;IAEhB;;;;;OAKG;IACH,WAAW,CAAC,CAAC,YAAY,EAAE,MAAM,GAAG,OAAO,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC,CAAC;IAElE;;;;OAIG;IACH,QAAQ,CAAC,cAAc,CAAC,EAAE,GAAG,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;IAEjD;;;;OAIG;IACH,gBAAgB,CAAC,KAAK,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,EAAE,CAAC,CAAC;IAEjD;;;;;OAKG;IACH,UAAU,CAAC,CAAC,IAAI,EAAE,KAAK,CAAC,GAAG,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAE7C;;;;;OAKG;IACH,WAAW,CAAC,CAAC,IAAI,EAAE,KAAK,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC,GAAG,CAAC,CAAC;IAE3C;;;;OAIG;IACH,OAAO,CAAC,CAAC,IAAI,EAAE,QAAQ,GAAG,IAAI,CAAC;IAE/B;;;;OAIG;IACH,QAAQ,CAAC,CAAC,IAAI,EAAE,QAAQ,GAAG,IAAI,CAAC;IAEhC;;;;;;;OAOG;IACH,SAAS,CAAC,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,EAAE,IAAI,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEnE;;;;;OAKG;IACH,WAAW,CAAC,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAE1C;;;;;OAKG;IACH,UAAU,CAAC,CAAC,IAAI,EAAE,GAAG,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;IAExC;;;;;OAKG;IACH,UAAU,CAAC,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAE3C;;;;;;OAMG;IACH,UAAU,CAAC,CAAC,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,GAAG,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CACvD;AAED;;;GAGG;AACH,qBAAa,iBAAkB,YAAW,UAAU;IA2CvC,SAAS,CAAC,OAAO,EAAE,OAAO;IAC7B,SAAS,CAAC,IAAI,EAAE,IAAI;IACR,SAAS,CAAC,SAAS,EAAE,gBAAgB;IACrC,SAAS,CAAC,MAAM,EAAE,gBAAgB;IA7CtD;;OAEG;IACS,MAAM,EAAE,gBAAgB,CAAC;IAErC,6DAA6D;IACjD,qBAAqB,UAAQ;IAEzC,2DAA2D;IAC/C,mBAAmB,UAAQ;IAEvC,wDAAwD;IAC5C,gBAAgB,EAAE,cAAc,EAAE,CAAM;IAEpD,qDAAqD;IACzC,aAAa,EAAE,aAAa,EAAE,CAAM;IAEhD,qDAAqD;IACzC,aAAa,EAAE,cAAc,EAAE,CAAM;IAEjD,2DAA2D;IAC/C,mBAAmB,EAAE,cAAc,EAAE,CAAM;IAEvD,wDAAwD;IAC5C,gBAAgB,EAAE,WAAW,EAAE,CAAM;IAEjD,2CAA2C;IAC3C,IAAI,WAAW,YAEd;IAGM,QAAQ,UAAQ;IAEvB,SAAS,CAAC,OAAO,EAAE,iBAAiB,CAAC;IAC9B,YAAY,EAAE,YAAY,CAAC;IAEtB,MAAM,EAAE,gBAAgB,CAAC,wBAAwB,GAAG,mBAAmB,CAAC,CAAC;IAErF,OAAO,CAAC,UAAU,CAAoB;gBAGjB,OAAO,EAAE,OAAO,EACnB,IAAI,EAAE,IAAI,EACE,SAAS,EAAE,gBAAgB,EAC3B,MAAM,EAAE,gBAAgB;IAGtD;;OAEG;IACH,iBAAiB,CAAC,YAAY,EAAE,MAAM,GAAG,OAAO;IAW1C,IAAI,CACR,OAAO,EAAE,iBAAiB,EAC1B,SAAS,GAAE,OAAoC,EAC/C,WAAW,GAAE,OAAkC,GAC9C,OAAO,CAAC,OAAO,CAAC;IAwDb,WAAW,IAAI,OAAO,CAAC,IAAI,CAAC;IAMlC,uCAAuC;IACvC,OAAO;IAaP;;OAEG;IACH,IAAI,iBAAiB,IAAI,gBAAgB,GAAG,aAAa,CAwCxD;IAED;;OAEG;IACH,IAAI,oBAAoB,IAAI,gBAAgB,CAW3C;IAED;;OAEG;IACH,IAAI,iBAAiB,IAAI,aAAa,CAuBrC;IAEK,QAAQ,CAAC,cAAc,CAAC,EAAE,GAAG,GAAG,OAAO,CAAC,OAAO,CAAC;IAsBhD,gBAAgB,CAAC,KAAK,GAAE,MAAkB,GAAG,OAAO,CAAC,GAAG,EAAE,CAAC;YAYnD,YAAY;YAeZ,sBAAsB;IAYpC,OAAO,CAAC,kBAAkB;cAgBV,qBAAqB,CAAC,YAAY,EAAE,MAAM;IA2B1D;;OAEG;IACH,SAAS,CAAC,YAAY,CAAC,MAAM,GAAE,OAAO,CAAC,gBAAgB,CAAM;IAa7D;;OAEG;IACH,SAAS,CAAC,eAAe,CAAC,MAAM,EAAE,OAAO,CAAC,gBAAgB,CAAC,GAAG,gBAAgB;IAa9E,OAAO,CAAC,eAAe;CAGxB;AAED;;;GAGG;AACH,eAAO,MAAM,UAAU,kEAAwE,CAAC;AAEhG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AACH,wBAAgB,aAAa,IAAI,UAAU,CAE1C"}
package/dist/dts/resources/genesis/genesis.d.ts CHANGED
@@ -21,7 +21,7 @@ export interface GenesisResources {
21
21
  */
22
22
  getResourceTypeFor: (resourceName: string) => Promise<ResourceType>;
23
23
  /**
24
- * All available resources
24
+ * Returns all available resources.
25
25
  */
26
26
  getAllResources: () => Promise<ResourceItem[]>;
27
27
  /**
@@ -43,7 +43,7 @@ export declare class DefaultGenesisResources implements GenesisResources {
43
43
  isValidResource(resourceName: string): Promise<boolean>;
44
44
  /** {@inheritDoc GenesisResources.getResourceTypeFor} */
45
45
  getResourceTypeFor(resourceName: string): Promise<ResourceType>;
46
- /** {@inheritDoc GenesisResources.allResources} */
46
+ /** {@inheritDoc GenesisResources.getAllResources} */
47
47
  getAllResources(): Promise<ResourceItem[]>;
48
48
  /** {@inheritDoc GenesisResources.destroy} */
49
49
  destroy(): void;
package/dist/dts/resources/genesis/genesis.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"genesis.d.ts","sourceRoot":"","sources":["../../../../src/resources/genesis/genesis.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,OAAO,EAAE,gBAAgB,EAAE,MAAM,eAAe,CAAC;AAC1D,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,kBAAkB,CAAC;AAErD,OAAO,EAAE,sBAAsB,EAA8B,MAAM,UAAU,CAAC;AAC9E,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AAE5C;;;;;;GAMG;AACH,MAAM,WAAW,gBAAgB;IAC/B;;;OAGG;IACH,eAAe,EAAE,CAAC,YAAY,EAAE,MAAM,KAAK,OAAO,CAAC,OAAO,CAAC,CAAC;IAC5D;;;OAGG;IACH,kBAAkB,EAAE,CAAC,YAAY,EAAE,MAAM,KAAK,OAAO,CAAC,YAAY,CAAC,CAAC;IACpE;;OAEG;IACH,eAAe,EAAE,MAAM,OAAO,CAAC,YAAY,EAAE,CAAC,CAAC;IAC/C;;OAEG;IACH,OAAO,EAAE,MAAM,IAAI,CAAC;CACrB;AAED;;;GAGG;AACH,qBAAa,uBAAwB,YAAW,gBAAgB;IAKnD,SAAS,CAAC,OAAO,EAAE,OAAO;IACX,SAAS,CAAC,MAAM,EAAE,sBAAsB;IALlE,SAAS,CAAC,SAAS,EAAE,YAAY,EAAE,CAAC;IACpC,SAAS,CAAC,gBAAgB,EAAE,OAAO,CAAC,gBAAgB,CAAC,CAAC;gBAGjC,OAAO,EAAE,OAAO,EACD,MAAM,EAAE,sBAAsB;IAGlE,qDAAqD;IAC/C,eAAe,CAAC,YAAY,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAU7D,wDAAwD;IAClD,kBAAkB,CAAC,YAAY,EAAE,MAAM,GAAG,OAAO,CAAC,YAAY,CAAC;IAarE,kDAAkD;IAC5C,eAAe,IAAI,OAAO,CAAC,YAAY,EAAE,CAAC;IAQhD,6CAA6C;IAC7C,OAAO;cAKS,cAAc,IAAI,OAAO,CAAC,IAAI,CAAC;IA6B/C,SAAS,CAAC,iBAAiB;CAU5B;AAED;;;;;GAKG;AACH,eAAO,MAAM,gBAAgB,wEAE5B,CAAC;AAEF;;;;;;;;;;;;;GAaG;AACH,wBAAgB,mBAAmB,IAAI,gBAAgB,CAEtD"}
1
+ {"version":3,"file":"genesis.d.ts","sourceRoot":"","sources":["../../../../src/resources/genesis/genesis.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,OAAO,EAAE,gBAAgB,EAAE,MAAM,eAAe,CAAC;AAC1D,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,kBAAkB,CAAC;AAErD,OAAO,EAAE,sBAAsB,EAA8B,MAAM,UAAU,CAAC;AAC9E,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AAE5C;;;;;;GAMG;AACH,MAAM,WAAW,gBAAgB;IAC/B;;;OAGG;IACH,eAAe,EAAE,CAAC,YAAY,EAAE,MAAM,KAAK,OAAO,CAAC,OAAO,CAAC,CAAC;IAC5D;;;OAGG;IACH,kBAAkB,EAAE,CAAC,YAAY,EAAE,MAAM,KAAK,OAAO,CAAC,YAAY,CAAC,CAAC;IACpE;;OAEG;IACH,eAAe,EAAE,MAAM,OAAO,CAAC,YAAY,EAAE,CAAC,CAAC;IAC/C;;OAEG;IACH,OAAO,EAAE,MAAM,IAAI,CAAC;CACrB;AAED;;;GAGG;AACH,qBAAa,uBAAwB,YAAW,gBAAgB;IAKnD,SAAS,CAAC,OAAO,EAAE,OAAO;IACX,SAAS,CAAC,MAAM,EAAE,sBAAsB;IALlE,SAAS,CAAC,SAAS,EAAE,YAAY,EAAE,CAAC;IACpC,SAAS,CAAC,gBAAgB,EAAE,OAAO,CAAC,gBAAgB,CAAC,CAAC;gBAGjC,OAAO,EAAE,OAAO,EACD,MAAM,EAAE,sBAAsB;IAGlE,qDAAqD;IAC/C,eAAe,CAAC,YAAY,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAU7D,wDAAwD;IAClD,kBAAkB,CAAC,YAAY,EAAE,MAAM,GAAG,OAAO,CAAC,YAAY,CAAC;IAarE,qDAAqD;IAC/C,eAAe,IAAI,OAAO,CAAC,YAAY,EAAE,CAAC;IAQhD,6CAA6C;IAC7C,OAAO;cAKS,cAAc,IAAI,OAAO,CAAC,IAAI,CAAC;IA6B/C,SAAS,CAAC,iBAAiB;CAU5B;AAED;;;;;GAKG;AACH,eAAO,MAAM,gBAAgB,wEAE5B,CAAC;AAEF;;;;;;;;;;;;;GAaG;AACH,wBAAgB,mBAAmB,IAAI,gBAAgB,CAEtD"}
package/dist/dts/testing/mocks/datasource/datasource.d.ts CHANGED
@@ -13,6 +13,7 @@ export declare class DatasourceMock implements Datasource {
13
13
  requestFields: MetadataDetail[];
14
14
  customRequestFields: MetadataDetail[];
15
15
  availableIndexes: IndexDetail[];
16
+ startStreamRequired: boolean;
16
17
  initialized: boolean;
17
18
  readOnly: boolean;
18
19
  resourceType: ResourceType;
package/dist/dts/testing/mocks/datasource/datasource.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"datasource.d.ts","sourceRoot":"","sources":["../../../../../src/testing/mocks/datasource/datasource.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,OAAO,EAAE,gBAAgB,EAAE,MAAM,kBAAkB,CAAC;AAC7D,OAAO,KAAK,EACV,UAAU,EACV,iBAAiB,EACjB,gBAAgB,EAChB,QAAQ,EACR,YAAY,EACb,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EAEL,aAAa,EACb,wBAAwB,EACxB,WAAW,EACX,QAAQ,EACR,cAAc,EACd,mBAAmB,EAEpB,MAAM,mBAAmB,CAAC;AAE3B;;GAEG;AACH,qBAAa,cAAe,YAAW,UAAU;IACnC,MAAM,EAAE,gBAAgB,CAAC;IACzB,qBAAqB,UAAQ;IACzC,SAAS,CAAC,gBAAgB,UAAS;IACvB,gBAAgB,EAAE,cAAc,EAAE,CAAM;IACxC,aAAa,EAAE,aAAa,EAAE,CAAM;IACpC,aAAa,EAAE,cAAc,EAAE,CAAM;IACrC,mBAAmB,EAAE,cAAc,EAAE,CAAM;IAC3C,gBAAgB,EAAE,WAAW,EAAE,CAAM;IAEjD,WAAW,EAAE,OAAO,CAAC;IACrB,QAAQ,EAAE,OAAO,CAAC;IAClB,YAAY,EAAE,YAAY,CAAC;IAC3B,MAAM,EAAE,gBAAgB,CAAC,wBAAwB,GAAG,mBAAmB,CAAC,CAAC;IAEzE,IAAI,CAAC,OAAO,EAAE,iBAAiB,EAAE,SAAS,EAAE,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC;IAItE,WAAW,IAAI,OAAO,CAAC,IAAI,CAAC;IAI5B;;;OAGG;IACH,WAAW,CAAC,IAAI,EAAE,QAAQ;IAS1B,WAAW;IAQX;;;OAGG;IACH,SAAS,CAAC,OAAO,EAAE,OAAO;IAI1B,WAAW;IAIX,MAAM;IAEN,OAAO;IAEP,iBAAiB,CAAC,YAAY,EAAE,MAAM,GAAG,OAAO;IAMhD,WAAW,CAAC,CAAC,YAAY,EAAE,MAAM,GAAG,OAAO,CAAC,aAAa,EAAE,CAAC;IAI5D,QAAQ,CAAC,MAAM,CAAC,EAAE,GAAG,GAAG,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;IAG7C,gBAAgB,CAAC,KAAK,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,EAAE,CAAC;IAIhD,UAAU,CAAC,CAAC,IAAI,EAAE,GAAG,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC;IAIvC,WAAW,CAAC,CAAC,IAAI,EAAE,GAAG,EAAE,GAAG,GAAG,EAAE;IAIhC,OAAO,CAAC,CAAC,IAAI,EAAE,QAAQ,GAAG,IAAI;IAE9B,QAAQ,CAAC,CAAC,IAAI,EAAE,QAAQ,GAAG,IAAI;IAE/B,SAAS,CAAC,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,EAAE,IAAI,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAIlE,WAAW,CAAC,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAIzC,UAAU,CAAC,CAAC,IAAI,EAAE,GAAG,GAAG,OAAO,CAAC,MAAM,CAAC;IAIvC,UAAU,CAAC,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAI1C,UAAU,CAAC,CAAC,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,GAAG,GAAG,OAAO,CAAC,IAAI,CAAC;CAGtD"}
1
+ {"version":3,"file":"datasource.d.ts","sourceRoot":"","sources":["../../../../../src/testing/mocks/datasource/datasource.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,OAAO,EAAE,gBAAgB,EAAE,MAAM,kBAAkB,CAAC;AAC7D,OAAO,KAAK,EACV,UAAU,EACV,iBAAiB,EACjB,gBAAgB,EAChB,QAAQ,EACR,YAAY,EACb,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EAEL,aAAa,EACb,wBAAwB,EACxB,WAAW,EACX,QAAQ,EACR,cAAc,EACd,mBAAmB,EAEpB,MAAM,mBAAmB,CAAC;AAE3B;;GAEG;AACH,qBAAa,cAAe,YAAW,UAAU;IACnC,MAAM,EAAE,gBAAgB,CAAC;IACzB,qBAAqB,UAAQ;IACzC,SAAS,CAAC,gBAAgB,UAAS;IACvB,gBAAgB,EAAE,cAAc,EAAE,CAAM;IACxC,aAAa,EAAE,aAAa,EAAE,CAAM;IACpC,aAAa,EAAE,cAAc,EAAE,CAAM;IACrC,mBAAmB,EAAE,cAAc,EAAE,CAAM;IAC3C,gBAAgB,EAAE,WAAW,EAAE,CAAM;IAEjD,mBAAmB,EAAE,OAAO,CAAC;IAC7B,WAAW,EAAE,OAAO,CAAC;IACrB,QAAQ,EAAE,OAAO,CAAC;IAClB,YAAY,EAAE,YAAY,CAAC;IAC3B,MAAM,EAAE,gBAAgB,CAAC,wBAAwB,GAAG,mBAAmB,CAAC,CAAC;IAEzE,IAAI,CAAC,OAAO,EAAE,iBAAiB,EAAE,SAAS,EAAE,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC;IAItE,WAAW,IAAI,OAAO,CAAC,IAAI,CAAC;IAI5B;;;OAGG;IACH,WAAW,CAAC,IAAI,EAAE,QAAQ;IAS1B,WAAW;IAQX;;;OAGG;IACH,SAAS,CAAC,OAAO,EAAE,OAAO;IAI1B,WAAW;IAIX,MAAM;IAEN,OAAO;IAEP,iBAAiB,CAAC,YAAY,EAAE,MAAM,GAAG,OAAO;IAMhD,WAAW,CAAC,CAAC,YAAY,EAAE,MAAM,GAAG,OAAO,CAAC,aAAa,EAAE,CAAC;IAI5D,QAAQ,CAAC,MAAM,CAAC,EAAE,GAAG,GAAG,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;IAG7C,gBAAgB,CAAC,KAAK,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,EAAE,CAAC;IAIhD,UAAU,CAAC,CAAC,IAAI,EAAE,GAAG,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC;IAIvC,WAAW,CAAC,CAAC,IAAI,EAAE,GAAG,EAAE,GAAG,GAAG,EAAE;IAIhC,OAAO,CAAC,CAAC,IAAI,EAAE,QAAQ,GAAG,IAAI;IAE9B,QAAQ,CAAC,CAAC,IAAI,EAAE,QAAQ,GAAG,IAAI;IAE/B,SAAS,CAAC,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,EAAE,IAAI,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAIlE,WAAW,CAAC,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAIzC,UAAU,CAAC,CAAC,IAAI,EAAE,GAAG,GAAG,OAAO,CAAC,MAAM,CAAC;IAIvC,UAAU,CAAC,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAI1C,UAAU,CAAC,CAAC,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,GAAG,GAAG,OAAO,CAAC,IAAI,CAAC;CAGtD"}
package/dist/dts/user/user.d.ts CHANGED
@@ -2,7 +2,7 @@ import { User as NextUser, DefaultUser as DefaultNextUser } from '@genesislcap/f
2
2
  /**
3
3
  * Represents a User object with associated permissions and profiles.
4
4
  *
5
- * @deprecated - Use {@link @genesislcap/foundation-user#User} instead.
5
+ * @deprecated - Use `User` from `@genesislcap/foundation-user` instead.
6
6
  *
7
7
  * @public
8
8
  */
@@ -11,7 +11,7 @@ export interface User extends NextUser {
11
11
  /**
12
12
  * Represents the current user (i.e. the user that is currently logged in).
13
13
  *
14
- * @deprecated - Use {@link @genesislcap/foundation-user#DefaultUser} instead.
14
+ * @deprecated - Use `DefaultUser` from `@genesislcap/foundation-user` instead.
15
15
  *
16
16
  * @public
17
17
  */
@@ -22,9 +22,9 @@ export declare class CurrentUser extends DefaultNextUser implements User {
22
22
  *
23
23
  * @privateRemarks
24
24
  * Marked as internal to stop api-extractor becoming confused cross-linking tokens with the same name.
25
- * Using aliasTo to point to {@link @genesislcap/foundation-user#User}.
25
+ * Using aliasTo to point to `User`.
26
26
  *
27
- * @deprecated - Use {@link @genesislcap/foundation-user#User} instead.
27
+ * @deprecated - Use `User` from `@genesislcap/foundation-user` instead.
28
28
  *
29
29
  * @internal
30
30
  */
package/dist/esm/connect/connect.js CHANGED
@@ -41,7 +41,7 @@ let DefaultConnect = class DefaultConnect {
41
41
  return false;
42
42
  }
43
43
  /**
44
- * @deprecated - Please reference {@link @genesislcap/foundation-user#User} instead.',
44
+ * @deprecated - Please reference `User` from `@genesislcap/foundation-user` instead.
45
45
  */
46
46
  setValidSession(valid) {
47
47
  logger.deprecated('setValidSession', 'Please refrain from calling this API as this state is managed internally.', '15.0.0');
package/dist/esm/connect/http.connect.js CHANGED
@@ -76,7 +76,7 @@ let DefaultHttpConnect = class DefaultHttpConnect {
76
76
  return true;
77
77
  }
78
78
  /**
79
- * @deprecated - Please reference {@link @genesislcap/foundation-user#User} instead.',
79
+ * @deprecated - Please reference `User` from `@genesislcap/foundation-user` instead.
80
80
  */
81
81
  setValidSession(valid) {
82
82
  logger.deprecated('setValidSession', 'Please refrain from calling this API as this state is managed internally.', '15.0.0');
package/dist/esm/connect/socket.js CHANGED
@@ -106,9 +106,11 @@ let DefaultSocket = class DefaultSocket {
106
106
  get isReconnecting() {
107
107
  return this.status.isReconnecting;
108
108
  }
109
- /** {@inheritDoc SerializedSocketStatus.hasValidSession} */
109
+ /**
110
+ * @deprecated - Use `User.isAuthenticated` from `@genesislcap/foundation-user` instead.
111
+ */
110
112
  get hasValidSession() {
111
- logger.deprecated('get hasValidSession', 'Use {@link @genesislcap/foundation-user#User.isAuthenticated} directly instead.', '15.0.0');
113
+ logger.deprecated('get hasValidSession', 'Use `User.isAuthenticated` from `@genesislcap/foundation-user` instead.', '15.0.0');
112
114
  return this.user.isAuthenticated;
113
115
  }
114
116
  set hasValidSession(value) {
package/dist/esm/datasource/datasource.js CHANGED
@@ -27,7 +27,7 @@ let DefaultDatasource = class DefaultDatasource {
27
27
  this.config = config;
28
28
  /** {@inheritDoc DatasourceMetadata.fetchMetadataRequired} */
29
29
  this.fetchMetadataRequired = true;
30
- /** {@inheritDoc DatasourceMetadata.startStream} */
30
+ /** {@inheritDoc DatasourceMetadata.startStreamRequired} */
31
31
  this.startStreamRequired = true;
32
32
  /** {@inheritDoc DatasourceMetadata.originalFieldDef} */
33
33
  this.originalFieldDef = [];
@@ -40,6 +40,7 @@ let DefaultDatasource = class DefaultDatasource {
40
40
  /** {@inheritDoc DatasourceMetadata.availableIndexes} */
41
41
  this.availableIndexes = [];
42
42
  this.readOnly = true;
43
+ this._allParams = null;
43
44
  }
44
45
  /**
45
46
  * @deprecated - Please use {@link (GenesisResources:interface).isValidResource} instead.
@@ -57,6 +58,8 @@ let DefaultDatasource = class DefaultDatasource {
57
58
  return __awaiter(this, void 0, void 0, function* () {
58
59
  this.fetchMetadataRequired = fetchMeta;
59
60
  this.options = Object.assign(Object.assign({}, this.config.options), options);
61
+ // Invalidate parameter cache when options change
62
+ this.invalidateCache();
60
63
  const resourceName = this.options.resourceName;
61
64
  const connected = this.connect.isConnected || (yield this.connect.connect());
62
65
  if (!connected) {
@@ -78,6 +81,8 @@ let DefaultDatasource = class DefaultDatasource {
78
81
  }
79
82
  if (this.fetchMetadataRequired) {
80
83
  yield this.fetchAndApplyMetadata(this.options.resourceName);
84
+ // Invalidate cache again after metadata fetch as availableIndexes may have changed
85
+ this._allParams = null;
81
86
  }
82
87
  logger.debug(`Initializing ${resourceName} datasource from ${this.connect.host}`);
83
88
  if (!this.options.isSnapshot && startStream) {
@@ -109,8 +114,14 @@ let DefaultDatasource = class DefaultDatasource {
109
114
  this.requestFields = [];
110
115
  this.stream = undefined;
111
116
  }
112
- get allParams() {
117
+ /**
118
+ * @internal
119
+ */
120
+ get allResourceParams() {
113
121
  var _a;
122
+ if (this._allParams) {
123
+ return this._allParams;
124
+ }
114
125
  let ORDER_BY;
115
126
  if (this.options.orderBy) {
116
127
  if (((_a = this.availableIndexes) === null || _a === void 0 ? void 0 : _a.findIndex((i) => i.NAME === this.options.orderBy)) > -1) {
@@ -121,7 +132,7 @@ let DefaultDatasource = class DefaultDatasource {
121
132
  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);
122
133
  }
123
134
  }
124
- const params = {
135
+ this._allParams = {
125
136
  // Common between DATASERVER and REQUEST_SERVER (REQ-REP)
126
137
  CRITERIA_MATCH: this.options.criteria,
127
138
  MAX_ROWS: this.options.maxRows,
@@ -137,23 +148,30 @@ let DefaultDatasource = class DefaultDatasource {
137
148
  POLLING_INTERVAL: this.options.pollingInterval,
138
149
  REQUEST: this.options.request,
139
150
  };
140
- return params;
151
+ logger.debug('Getting configured params:', this._allParams);
152
+ return this._allParams;
141
153
  }
142
- get dataserverParams() {
154
+ /**
155
+ * @internal
156
+ */
157
+ get dataserverOnlyParams() {
143
158
  return {
144
- CRITERIA_MATCH: this.allParams.CRITERIA_MATCH,
145
- MAX_ROWS: this.allParams.MAX_ROWS,
146
- VIEW_NUMBER: this.allParams.VIEW_NUMBER,
147
- FIELDS: this.allParams.FIELDS,
148
- MAX_VIEW: this.allParams.MAX_VIEW,
149
- MOVING_VIEW: this.allParams.MOVING_VIEW,
150
- ORDER_BY: this.allParams.ORDER_BY,
151
- REVERSE: this.allParams.REVERSE,
159
+ CRITERIA_MATCH: this.allResourceParams.CRITERIA_MATCH,
160
+ MAX_ROWS: this.allResourceParams.MAX_ROWS,
161
+ VIEW_NUMBER: this.allResourceParams.VIEW_NUMBER,
162
+ FIELDS: this.allResourceParams.FIELDS,
163
+ MAX_VIEW: this.allResourceParams.MAX_VIEW,
164
+ MOVING_VIEW: this.allResourceParams.MOVING_VIEW,
165
+ ORDER_BY: this.allResourceParams.ORDER_BY,
166
+ REVERSE: this.allResourceParams.REVERSE,
152
167
  };
153
168
  }
154
- get requestParams() {
169
+ /**
170
+ * @internal
171
+ */
172
+ get requestOnlyParams() {
155
173
  var _a;
156
- const _b = this.allParams, { REQUEST } = _b, DETAILS = __rest(_b, ["REQUEST"]);
174
+ const _b = this.allResourceParams, { REQUEST } = _b, DETAILS = __rest(_b, ["REQUEST"]);
157
175
  const reqParams = {
158
176
  DETAILS: {
159
177
  CRITERIA_MATCH: !this.options.requestAutoSetup ? DETAILS.CRITERIA_MATCH : undefined,
@@ -177,9 +195,9 @@ let DefaultDatasource = class DefaultDatasource {
177
195
  logger.debug(`Requesting snapshot for ${this.options.resourceName} (${this.resourceType}).`);
178
196
  switch (this.resourceType) {
179
197
  case ResourceType.DATASERVER:
180
- return this.connect.snapshot(this.options.resourceName, Object.assign(Object.assign({}, this.dataserverParams), overrideParams));
198
+ return this.connect.snapshot(this.options.resourceName, Object.assign(Object.assign({}, this.dataserverOnlyParams), overrideParams));
181
199
  case ResourceType.REQUEST_SERVER: {
182
- return this.connect.request(this.options.resourceName, Object.assign(Object.assign({}, this.requestParams), overrideParams));
200
+ return this.connect.request(this.options.resourceName, Object.assign(Object.assign({}, this.requestOnlyParams), overrideParams));
183
201
  }
184
202
  default:
185
203
  throw new Error(`Snapshot not supported for selected resource type: ${this.resourceType}`);
@@ -216,11 +234,11 @@ let DefaultDatasource = class DefaultDatasource {
216
234
  return __awaiter(this, void 0, void 0, function* () {
217
235
  const onMessage = (message) => { };
218
236
  const onError = (error) => logger.error(error);
219
- return this.connect.stream(this.options.resourceName, onMessage, onError, this.dataserverParams);
237
+ return this.connect.stream(this.options.resourceName, onMessage, onError, this.dataserverOnlyParams);
220
238
  });
221
239
  }
222
240
  createReqRepStream() {
223
- return timer(0, this.allParams.DISABLE_POLLING ? undefined : this.allParams.POLLING_INTERVAL).pipe(switchMap(() => {
241
+ return timer(0, this.allResourceParams.DISABLE_POLLING ? undefined : this.allResourceParams.POLLING_INTERVAL).pipe(switchMap(() => {
224
242
  // Combine the isConnected status with the isLoggedIn status
225
243
  return combineLatest([this.connect.isConnected$, this.auth.isLoggedIn$]).pipe(
226
244
  // Use takeWhile to continue polling until isConnected becomes false or isLoggedIn becomes false
@@ -288,6 +306,9 @@ let DefaultDatasource = class DefaultDatasource {
288
306
  hasMetadata,
289
307
  };
290
308
  }
309
+ invalidateCache() {
310
+ this._allParams = null;
311
+ }
291
312
  };
292
313
  __decorate([
293
314
  observable
package/dist/esm/resources/genesis/genesis.js CHANGED
@@ -39,7 +39,7 @@ let DefaultGenesisResources = class DefaultGenesisResources {
39
39
  }
40
40
  });
41
41
  }
42
- /** {@inheritDoc GenesisResources.allResources} */
42
+ /** {@inheritDoc GenesisResources.getAllResources} */
43
43
  getAllResources() {
44
44
  return __awaiter(this, void 0, void 0, function* () {
45
45
  if (!this.resources) {
package/dist/esm/user/user.js CHANGED
@@ -3,7 +3,7 @@ import { DI } from '@microsoft/fast-foundation';
3
3
  /**
4
4
  * Represents the current user (i.e. the user that is currently logged in).
5
5
  *
6
- * @deprecated - Use {@link @genesislcap/foundation-user#DefaultUser} instead.
6
+ * @deprecated - Use `DefaultUser` from `@genesislcap/foundation-user` instead.
7
7
  *
8
8
  * @public
9
9
  */
@@ -14,9 +14,9 @@ export class CurrentUser extends DefaultNextUser {
14
14
  *
15
15
  * @privateRemarks
16
16
  * Marked as internal to stop api-extractor becoming confused cross-linking tokens with the same name.
17
- * Using aliasTo to point to {@link @genesislcap/foundation-user#User}.
17
+ * Using aliasTo to point to `User`.
18
18
  *
19
- * @deprecated - Use {@link @genesislcap/foundation-user#User} instead.
19
+ * @deprecated - Use `User` from `@genesislcap/foundation-user` instead.
20
20
  *
21
21
  * @internal
22
22
  */
package/dist/foundation-comms.api.json CHANGED
@@ -1221,7 +1221,7 @@
1221
1221
  {
1222
1222
  "kind": "MethodSignature",
1223
1223
  "canonicalReference": "@genesislcap/foundation-comms!Connect#connect:member(1)",
1224
- "docComment": "/**\n * Connects to a server at the specified host.\n *\n * @param host - The host to connect to. Defaults to {@link @genesislcap/foundation-utils#GENESIS_SOCKET_URL | GENESIS_SOCKET_URL}.\n *\n * @returns A promise that resolves with a boolean indicating whether the connection was successful.\n *\n * @public\n */\n",
1224
+ "docComment": "/**\n * Connects to a server at the specified host.\n *\n * @param host - The host to connect to. Defaults to GENESIS_SOCKET_URL.\n *\n * @returns A promise that resolves with a boolean indicating whether the connection was successful.\n *\n * @public\n */\n",
1225
1225
  "excerptTokens": [
1226
1226
  {
1227
1227
  "kind": "Content",
@@ -4385,7 +4385,7 @@
4385
4385
  {
4386
4386
  "kind": "Class",
4387
4387
  "canonicalReference": "@genesislcap/foundation-comms!CurrentUser:class",
4388
- "docComment": "/**\n * Represents the current user (i.e. the user that is currently logged in).\n *\n * @deprecated\n *\n * - Use {@link @genesislcap/foundation-user#DefaultUser} instead.\n *\n * @public\n */\n",
4388
+ "docComment": "/**\n * Represents the current user (i.e. the user that is currently logged in).\n *\n * @deprecated\n *\n * - Use `DefaultUser` from `@genesislcap/foundation-user` instead.\n *\n * @public\n */\n",
4389
4389
  "excerptTokens": [
4390
4390
  {
4391
4391
  "kind": "Content",
@@ -9128,6 +9128,33 @@
9128
9128
  "startIndex": 1,
9129
9129
  "endIndex": 3
9130
9130
  }
9131
+ },
9132
+ {
9133
+ "kind": "PropertySignature",
9134
+ "canonicalReference": "@genesislcap/foundation-comms!DatasourceMetadata#startStreamRequired:member",
9135
+ "docComment": "",
9136
+ "excerptTokens": [
9137
+ {
9138
+ "kind": "Content",
9139
+ "text": "startStreamRequired: "
9140
+ },
9141
+ {
9142
+ "kind": "Content",
9143
+ "text": "boolean"
9144
+ },
9145
+ {
9146
+ "kind": "Content",
9147
+ "text": ";"
9148
+ }
9149
+ ],
9150
+ "isReadonly": false,
9151
+ "isOptional": false,
9152
+ "releaseTag": "Public",
9153
+ "name": "startStreamRequired",
9154
+ "propertyTypeTokenRange": {
9155
+ "startIndex": 1,
9156
+ "endIndex": 2
9157
+ }
9131
9158
  }
9132
9159
  ],
9133
9160
  "extendsTokenRanges": []
@@ -11398,7 +11425,7 @@
11398
11425
  {
11399
11426
  "kind": "Method",
11400
11427
  "canonicalReference": "@genesislcap/foundation-comms!DefaultConnect#setValidSession:member(1)",
11401
- "docComment": "/**\n * @deprecated\n *\n * - Please reference {@link @genesislcap/foundation-user#User} instead.',\n */\n",
11428
+ "docComment": "/**\n * @deprecated\n *\n * - Please reference `User` from `@genesislcap/foundation-user` instead.\n */\n",
11402
11429
  "excerptTokens": [
11403
11430
  {
11404
11431
  "kind": "Content",
@@ -13990,36 +14017,6 @@
13990
14017
  }
13991
14018
  ]
13992
14019
  },
13993
- {
13994
- "kind": "Property",
13995
- "canonicalReference": "@genesislcap/foundation-comms!DefaultDatasource#allParams:member",
13996
- "docComment": "",
13997
- "excerptTokens": [
13998
- {
13999
- "kind": "Content",
14000
- "text": "get allParams(): "
14001
- },
14002
- {
14003
- "kind": "Content",
14004
- "text": "any"
14005
- },
14006
- {
14007
- "kind": "Content",
14008
- "text": ";"
14009
- }
14010
- ],
14011
- "isReadonly": true,
14012
- "isOptional": false,
14013
- "releaseTag": "Public",
14014
- "name": "allParams",
14015
- "propertyTypeTokenRange": {
14016
- "startIndex": 1,
14017
- "endIndex": 2
14018
- },
14019
- "isStatic": false,
14020
- "isProtected": false,
14021
- "isAbstract": false
14022
- },
14023
14020
  {
14024
14021
  "kind": "Property",
14025
14022
  "canonicalReference": "@genesislcap/foundation-comms!DefaultDatasource#auth:member",
@@ -14183,37 +14180,6 @@
14183
14180
  "isProtected": false,
14184
14181
  "isAbstract": false
14185
14182
  },
14186
- {
14187
- "kind": "Property",
14188
- "canonicalReference": "@genesislcap/foundation-comms!DefaultDatasource#dataserverParams:member",
14189
- "docComment": "",
14190
- "excerptTokens": [
14191
- {
14192
- "kind": "Content",
14193
- "text": "get dataserverParams(): "
14194
- },
14195
- {
14196
- "kind": "Reference",
14197
- "text": "DataserverParams",
14198
- "canonicalReference": "@genesislcap/foundation-comms!DataserverParams:type"
14199
- },
14200
- {
14201
- "kind": "Content",
14202
- "text": ";"
14203
- }
14204
- ],
14205
- "isReadonly": true,
14206
- "isOptional": false,
14207
- "releaseTag": "Public",
14208
- "name": "dataserverParams",
14209
- "propertyTypeTokenRange": {
14210
- "startIndex": 1,
14211
- "endIndex": 2
14212
- },
14213
- "isStatic": false,
14214
- "isProtected": false,
14215
- "isAbstract": false
14216
- },
14217
14183
  {
14218
14184
  "kind": "Method",
14219
14185
  "canonicalReference": "@genesislcap/foundation-comms!DefaultDatasource#destroy:member(1)",
@@ -14610,37 +14576,6 @@
14610
14576
  "isProtected": false,
14611
14577
  "isAbstract": false
14612
14578
  },
14613
- {
14614
- "kind": "Property",
14615
- "canonicalReference": "@genesislcap/foundation-comms!DefaultDatasource#requestParams:member",
14616
- "docComment": "",
14617
- "excerptTokens": [
14618
- {
14619
- "kind": "Content",
14620
- "text": "get requestParams(): "
14621
- },
14622
- {
14623
- "kind": "Reference",
14624
- "text": "RequestParams",
14625
- "canonicalReference": "@genesislcap/foundation-comms!RequestParams:type"
14626
- },
14627
- {
14628
- "kind": "Content",
14629
- "text": ";"
14630
- }
14631
- ],
14632
- "isReadonly": true,
14633
- "isOptional": false,
14634
- "releaseTag": "Public",
14635
- "name": "requestParams",
14636
- "propertyTypeTokenRange": {
14637
- "startIndex": 1,
14638
- "endIndex": 2
14639
- },
14640
- "isStatic": false,
14641
- "isProtected": false,
14642
- "isAbstract": false
14643
- },
14644
14579
  {
14645
14580
  "kind": "Property",
14646
14581
  "canonicalReference": "@genesislcap/foundation-comms!DefaultDatasource#resources:member",
@@ -14857,7 +14792,7 @@
14857
14792
  {
14858
14793
  "kind": "Property",
14859
14794
  "canonicalReference": "@genesislcap/foundation-comms!DefaultDatasource#startStreamRequired:member",
14860
- "docComment": "/**\n * {@inheritDoc DatasourceMetadata.startStream}\n */\n",
14795
+ "docComment": "/**\n * {@inheritDoc DatasourceMetadata.startStreamRequired}\n */\n",
14861
14796
  "excerptTokens": [
14862
14797
  {
14863
14798
  "kind": "Content",
@@ -15452,7 +15387,7 @@
15452
15387
  {
15453
15388
  "kind": "Method",
15454
15389
  "canonicalReference": "@genesislcap/foundation-comms!DefaultGenesisResources#getAllResources:member(1)",
15455
- "docComment": "/**\n * {@inheritDoc GenesisResources.allResources}\n */\n",
15390
+ "docComment": "/**\n * {@inheritDoc GenesisResources.getAllResources}\n */\n",
15456
15391
  "excerptTokens": [
15457
15392
  {
15458
15393
  "kind": "Content",
@@ -17068,7 +17003,7 @@
17068
17003
  {
17069
17004
  "kind": "Method",
17070
17005
  "canonicalReference": "@genesislcap/foundation-comms!DefaultHttpConnect#setValidSession:member(1)",
17071
- "docComment": "/**\n * @deprecated\n *\n * - Please reference {@link @genesislcap/foundation-user#User} instead.',\n */\n",
17006
+ "docComment": "/**\n * @deprecated\n *\n * - Please reference `User` from `@genesislcap/foundation-user` instead.\n */\n",
17072
17007
  "excerptTokens": [
17073
17008
  {
17074
17009
  "kind": "Content",
@@ -20655,7 +20590,7 @@
20655
20590
  {
20656
20591
  "kind": "Property",
20657
20592
  "canonicalReference": "@genesislcap/foundation-comms!DefaultSocket#hasValidSession:member",
20658
- "docComment": "",
20593
+ "docComment": "/**\n * @deprecated\n *\n * - Use `User.isAuthenticated` from `@genesislcap/foundation-user` instead.\n */\n",
20659
20594
  "excerptTokens": [
20660
20595
  {
20661
20596
  "kind": "Content",
@@ -23150,7 +23085,7 @@
23150
23085
  {
23151
23086
  "kind": "PropertySignature",
23152
23087
  "canonicalReference": "@genesislcap/foundation-comms!GenesisResources#getAllResources:member",
23153
- "docComment": "/**\n * All available resources\n */\n",
23088
+ "docComment": "/**\n * Returns all available resources.\n */\n",
23154
23089
  "excerptTokens": [
23155
23090
  {
23156
23091
  "kind": "Content",
@@ -29169,7 +29104,7 @@
29169
29104
  {
29170
29105
  "kind": "PropertySignature",
29171
29106
  "canonicalReference": "@genesislcap/foundation-comms!SerializedSocketStatus#hasValidSession:member",
29172
- "docComment": "/**\n * @deprecated\n *\n * - Use {@link @genesislcap/foundation-user#User.isAuthenticated} instead.\n */\n",
29107
+ "docComment": "/**\n * @deprecated\n *\n * - Use `User.isAuthenticated` from `@genesislcap/foundation-user` instead.\n */\n",
29173
29108
  "excerptTokens": [
29174
29109
  {
29175
29110
  "kind": "Content",
@@ -32438,7 +32373,7 @@
32438
32373
  {
32439
32374
  "kind": "Interface",
32440
32375
  "canonicalReference": "@genesislcap/foundation-comms!User:interface",
32441
- "docComment": "/**\n * Represents a User object with associated permissions and profiles.\n *\n * @deprecated\n *\n * - Use {@link @genesislcap/foundation-user#User} instead.\n *\n * @public\n */\n",
32376
+ "docComment": "/**\n * Represents a User object with associated permissions and profiles.\n *\n * @deprecated\n *\n * - Use `User` from `@genesislcap/foundation-user` instead.\n *\n * @public\n */\n",
32442
32377
  "excerptTokens": [
32443
32378
  {
32444
32379
  "kind": "Content",
package/dist/foundation-comms.d.ts CHANGED
@@ -230,7 +230,7 @@ export declare interface Connect {
230
230
  /**
231
231
  * Connects to a server at the specified host.
232
232
  * @public
233
- * @param host - The host to connect to. Defaults to {@link @genesislcap/foundation-utils#GENESIS_SOCKET_URL | GENESIS_SOCKET_URL}.
233
+ * @param host - The host to connect to. Defaults to GENESIS_SOCKET_URL.
234
234
  * @returns A promise that resolves with a boolean indicating whether the connection was successful.
235
235
  */
236
236
  connect(host?: string): Promise<boolean>;
@@ -796,7 +796,7 @@ export declare function criteriaFiltersToFields(filters: string): Record<string,
796
796
  /**
797
797
  * Represents the current user (i.e. the user that is currently logged in).
798
798
  *
799
- * @deprecated - Use {@link @genesislcap/foundation-user#DefaultUser} instead.
799
+ * @deprecated - Use `DefaultUser` from `@genesislcap/foundation-user` instead.
800
800
  *
801
801
  * @public
802
802
  */
@@ -1419,6 +1419,7 @@ export declare interface DatasourceMetadata {
1419
1419
  readonly fieldMetadata: FieldMetadata[];
1420
1420
  readonly requestFields: MetadataDetail[];
1421
1421
  readonly customRequestFields: MetadataDetail[];
1422
+ startStreamRequired: boolean;
1422
1423
  }
1423
1424
 
1424
1425
  /**
@@ -1433,6 +1434,7 @@ export declare class DatasourceMock implements Datasource {
1433
1434
  requestFields: MetadataDetail[];
1434
1435
  customRequestFields: MetadataDetail[];
1435
1436
  availableIndexes: IndexDetail[];
1437
+ startStreamRequired: boolean;
1436
1438
  initialized: boolean;
1437
1439
  readOnly: boolean;
1438
1440
  resourceType: ResourceType;
@@ -1664,7 +1666,7 @@ export declare class DefaultConnect implements Connect {
1664
1666
  constructor(socket: Socket, messageBuilder: MessageBuilder, metaCache: MetaCache, events: ConnectEventsEmitter, config: ConnectConfig);
1665
1667
  httpMode(): boolean;
1666
1668
  /**
1667
- * @deprecated - Please reference {@link @genesislcap/foundation-user#User} instead.',
1669
+ * @deprecated - Please reference `User` from `@genesislcap/foundation-user` instead.
1668
1670
  */
1669
1671
  setValidSession(valid: boolean): void;
1670
1672
  send<T>(message: Message<any>, needsHandling?: boolean): Promise<any>;
@@ -1785,7 +1787,7 @@ export declare class DefaultDatasource implements Datasource {
1785
1787
  status: DatasourceStatus;
1786
1788
  /** {@inheritDoc DatasourceMetadata.fetchMetadataRequired} */
1787
1789
  fetchMetadataRequired: boolean;
1788
- /** {@inheritDoc DatasourceMetadata.startStream} */
1790
+ /** {@inheritDoc DatasourceMetadata.startStreamRequired} */
1789
1791
  startStreamRequired: boolean;
1790
1792
  /** {@inheritDoc DatasourceMetadata.originalFieldDef} */
1791
1793
  originalFieldDef: MetadataDetail[];
@@ -1803,6 +1805,7 @@ export declare class DefaultDatasource implements Datasource {
1803
1805
  protected options: DatasourceOptions;
1804
1806
  resourceType: ResourceType;
1805
1807
  stream: SocketObservable<FilteredDataServerResult | RequestServerResult>;
1808
+ private _allParams;
1806
1809
  constructor(connect: Connect, auth: Auth, resources: GenesisResources, config: DatasourceConfig);
1807
1810
  /**
1808
1811
  * @deprecated - Please use {@link (GenesisResources:interface).isValidResource} instead.
@@ -1812,9 +1815,18 @@ export declare class DefaultDatasource implements Datasource {
1812
1815
  startStream(): Promise<void>;
1813
1816
  /** {@inheritDoc Datasource.destroy} */
1814
1817
  destroy(): void;
1815
- get allParams(): any;
1816
- get dataserverParams(): DataserverParams;
1817
- get requestParams(): RequestParams;
1818
+ /**
1819
+ * @internal
1820
+ */
1821
+ get allResourceParams(): DataserverParams & RequestParams;
1822
+ /**
1823
+ * @internal
1824
+ */
1825
+ get dataserverOnlyParams(): DataserverParams;
1826
+ /**
1827
+ * @internal
1828
+ */
1829
+ get requestOnlyParams(): RequestParams;
1818
1830
  snapshot(overrideParams?: any): Promise<Message>;
1819
1831
  snapshotFiltered(rowId?: string): Promise<any[]>;
1820
1832
  private createStream;
@@ -1829,6 +1841,7 @@ export declare class DefaultDatasource implements Datasource {
1829
1841
  * @internal
1830
1842
  */
1831
1843
  protected normaliseStatus(status: Partial<DatasourceStatus>): DatasourceStatus;
1844
+ private invalidateCache;
1832
1845
  }
1833
1846
 
1834
1847
  /**
@@ -1902,7 +1915,7 @@ export declare class DefaultGenesisResources implements GenesisResources {
1902
1915
  isValidResource(resourceName: string): Promise<boolean>;
1903
1916
  /** {@inheritDoc GenesisResources.getResourceTypeFor} */
1904
1917
  getResourceTypeFor(resourceName: string): Promise<ResourceType>;
1905
- /** {@inheritDoc GenesisResources.allResources} */
1918
+ /** {@inheritDoc GenesisResources.getAllResources} */
1906
1919
  getAllResources(): Promise<ResourceItem[]>;
1907
1920
  /** {@inheritDoc GenesisResources.destroy} */
1908
1921
  destroy(): void;
@@ -1962,7 +1975,7 @@ export declare class DefaultHttpConnect implements Connect {
1962
1975
  send<T>(message: Message<any>, needsHandling?: boolean): Promise<any>;
1963
1976
  httpMode(): boolean;
1964
1977
  /**
1965
- * @deprecated - Please reference {@link @genesislcap/foundation-user#User} instead.',
1978
+ * @deprecated - Please reference `User` from `@genesislcap/foundation-user` instead.
1966
1979
  */
1967
1980
  setValidSession(valid: boolean): void;
1968
1981
  connect(host: string): Promise<boolean>;
@@ -2322,7 +2335,9 @@ export declare class DefaultSocket implements Socket {
2322
2335
  get isDisconnected(): boolean;
2323
2336
  get isDisconnectedByServer(): boolean;
2324
2337
  get isReconnecting(): boolean;
2325
- /** {@inheritDoc SerializedSocketStatus.hasValidSession} */
2338
+ /**
2339
+ * @deprecated - Use `User.isAuthenticated` from `@genesislcap/foundation-user` instead.
2340
+ */
2326
2341
  get hasValidSession(): boolean;
2327
2342
  set hasValidSession(value: boolean);
2328
2343
  get host(): string;
@@ -2682,7 +2697,7 @@ export declare interface GenesisResources {
2682
2697
  */
2683
2698
  getResourceTypeFor: (resourceName: string) => Promise<ResourceType>;
2684
2699
  /**
2685
- * All available resources
2700
+ * Returns all available resources.
2686
2701
  */
2687
2702
  getAllResources: () => Promise<ResourceItem[]>;
2688
2703
  /**
@@ -4110,7 +4125,7 @@ export declare interface SerializedSocketStatus {
4110
4125
  isDisconnectedByServer: boolean;
4111
4126
  isReconnecting: boolean;
4112
4127
  reconnectionLimitReached: boolean;
4113
- /** @deprecated - Use {@link @genesislcap/foundation-user#User.isAuthenticated} instead. */
4128
+ /** @deprecated - Use `User.isAuthenticated` from `@genesislcap/foundation-user` instead. */
4114
4129
  hasValidSession: boolean;
4115
4130
  readonly closedCode: number;
4116
4131
  readonly closedReason: string;
@@ -4753,7 +4768,7 @@ export declare function until(conditionFunc: () => boolean, timeoutMs?: number):
4753
4768
  /**
4754
4769
  * Represents a User object with associated permissions and profiles.
4755
4770
  *
4756
- * @deprecated - Use {@link @genesislcap/foundation-user#User} instead.
4771
+ * @deprecated - Use `User` from `@genesislcap/foundation-user` instead.
4757
4772
  *
4758
4773
  * @public
4759
4774
  */
@@ -4765,9 +4780,9 @@ export declare interface User extends User_2 {
4765
4780
  *
4766
4781
  * @privateRemarks
4767
4782
  * Marked as internal to stop api-extractor becoming confused cross-linking tokens with the same name.
4768
- * Using aliasTo to point to {@link @genesislcap/foundation-user#User}.
4783
+ * Using aliasTo to point to `User`.
4769
4784
  *
4770
- * @deprecated - Use {@link @genesislcap/foundation-user#User} instead.
4785
+ * @deprecated - Use `User` from `@genesislcap/foundation-user` instead.
4771
4786
  *
4772
4787
  * @internal
4773
4788
  */
package/docs/api/foundation-comms.connect.connect.md CHANGED
@@ -16,7 +16,7 @@ connect(host?: string): Promise<boolean>;
16
16
 
17
17
  | Parameter | Type | Description |
18
18
  | --- | --- | --- |
19
- | host | string | _(Optional)_ The host to connect to. Defaults to . |
19
+ | host | string | _(Optional)_ The host to connect to. Defaults to GENESIS\_SOCKET\_URL. |
20
20
 
21
21
  **Returns:**
22
22
 
package/docs/api/foundation-comms.currentuser.md CHANGED
@@ -6,7 +6,7 @@
6
6
 
7
7
  > Warning: This API is now obsolete.
8
8
  >
9
- > - Use instead.
9
+ > - Use `DefaultUser` from `@genesislcap/foundation-user` instead.
10
10
  >
11
11
 
12
12
  Represents the current user (i.e. the user that is currently logged in).
package/docs/api/foundation-comms.datasourcemetadata.md CHANGED
@@ -22,4 +22,5 @@ export interface DatasourceMetadata
22
22
  | [fieldMetadata](./foundation-comms.datasourcemetadata.fieldmetadata.md) | <code>readonly</code> | [FieldMetadata](./foundation-comms.fieldmetadata.md)<!-- -->\[\] | |
23
23
  | [originalFieldDef](./foundation-comms.datasourcemetadata.originalfielddef.md) | <code>readonly</code> | [MetadataDetail](./foundation-comms.metadatadetail.md)<!-- -->\[\] | |
24
24
  | [requestFields](./foundation-comms.datasourcemetadata.requestfields.md) | <code>readonly</code> | [MetadataDetail](./foundation-comms.metadatadetail.md)<!-- -->\[\] | |
25
+ | [startStreamRequired](./foundation-comms.datasourcemetadata.startstreamrequired.md) | | boolean | |
25
26
 
package/docs/api/foundation-comms.datasourcemetadata.startstreamrequired.md ADDED
@@ -0,0 +1,11 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [DatasourceMetadata](./foundation-comms.datasourcemetadata.md) &gt; [startStreamRequired](./foundation-comms.datasourcemetadata.startstreamrequired.md)
4
+
5
+ ## DatasourceMetadata.startStreamRequired property
6
+
7
+ **Signature:**
8
+
9
+ ```typescript
10
+ startStreamRequired: boolean;
11
+ ```
package/docs/api/foundation-comms.defaultconnect.setvalidsession.md CHANGED
@@ -6,7 +6,7 @@
6
6
 
7
7
  > Warning: This API is now obsolete.
8
8
  >
9
- > - Please reference instead.',
9
+ > - Please reference `User` from `@genesislcap/foundation-user` instead.
10
10
  >
11
11
 
12
12
  **Signature:**
package/docs/api/foundation-comms.defaultdatasource.md CHANGED
@@ -23,13 +23,11 @@ export declare class DefaultDatasource implements Datasource
23
23
 
24
24
  | Property | Modifiers | Type | Description |
25
25
  | --- | --- | --- | --- |
26
- | [allParams](./foundation-comms.defaultdatasource.allparams.md) | <code>readonly</code> | any | |
27
26
  | [auth](./foundation-comms.defaultdatasource.auth.md) | <code>protected</code> | [Auth](./foundation-comms.auth.md) | |
28
27
  | [availableIndexes](./foundation-comms.defaultdatasource.availableindexes.md) | | [IndexDetail](./foundation-comms.indexdetail.md)<!-- -->\[\] | |
29
28
  | [config](./foundation-comms.defaultdatasource.config.md) | <code>protected</code> | [DatasourceConfig](./foundation-comms.datasourceconfig.md) | |
30
29
  | [connect](./foundation-comms.defaultdatasource.connect.md) | <code>protected</code> | [Connect](./foundation-comms.connect.md) | |
31
30
  | [customRequestFields](./foundation-comms.defaultdatasource.customrequestfields.md) | | [MetadataDetail](./foundation-comms.metadatadetail.md)<!-- -->\[\] | |
32
- | [dataserverParams](./foundation-comms.defaultdatasource.dataserverparams.md) | <code>readonly</code> | [DataserverParams](./foundation-comms.dataserverparams.md) | |
33
31
  | [fetchMetadataRequired](./foundation-comms.defaultdatasource.fetchmetadatarequired.md) | | boolean | |
34
32
  | [fieldMetadata](./foundation-comms.defaultdatasource.fieldmetadata.md) | | [FieldMetadata](./foundation-comms.fieldmetadata.md)<!-- -->\[\] | |
35
33
  | [initialized](./foundation-comms.defaultdatasource.initialized.md) | <code>readonly</code> | boolean | Indicates whether the datasource has been initialized. |
@@ -37,7 +35,6 @@ export declare class DefaultDatasource implements Datasource
37
35
  | [originalFieldDef](./foundation-comms.defaultdatasource.originalfielddef.md) | | [MetadataDetail](./foundation-comms.metadatadetail.md)<!-- -->\[\] | |
38
36
  | [readOnly](./foundation-comms.defaultdatasource.readonly.md) | | boolean | |
39
37
  | [requestFields](./foundation-comms.defaultdatasource.requestfields.md) | | [MetadataDetail](./foundation-comms.metadatadetail.md)<!-- -->\[\] | |
40
- | [requestParams](./foundation-comms.defaultdatasource.requestparams.md) | <code>readonly</code> | [RequestParams](./foundation-comms.requestparams.md) | |
41
38
  | [resources](./foundation-comms.defaultdatasource.resources.md) | <code>protected</code> | [GenesisResources](./foundation-comms.genesisresources.md) | |
42
39
  | [resourceType](./foundation-comms.defaultdatasource.resourcetype.md) | | [ResourceType](./foundation-comms.resourcetype.md) | |
43
40
  | [startStreamRequired](./foundation-comms.defaultdatasource.startstreamrequired.md) | | boolean | |
package/docs/api/foundation-comms.defaultgenesisresources.getallresources.md CHANGED
@@ -4,6 +4,7 @@
4
4
 
5
5
  ## DefaultGenesisResources.getAllResources() method
6
6
 
7
+ Returns all available resources.
7
8
 
8
9
  **Signature:**
9
10
 
package/docs/api/foundation-comms.defaultgenesisresources.md CHANGED
@@ -34,7 +34,7 @@ export declare class DefaultGenesisResources implements GenesisResources
34
34
  | --- | --- | --- |
35
35
  | [destroy()](./foundation-comms.defaultgenesisresources.destroy.md) | | Destroy and garbage collect |
36
36
  | [fetchResources()](./foundation-comms.defaultgenesisresources.fetchresources.md) | <code>protected</code> | |
37
- | [getAllResources()](./foundation-comms.defaultgenesisresources.getallresources.md) | | |
37
+ | [getAllResources()](./foundation-comms.defaultgenesisresources.getallresources.md) | | Returns all available resources. |
38
38
  | [getResourceTypeFor(resourceName)](./foundation-comms.defaultgenesisresources.getresourcetypefor.md) | | Gets the type of resource |
39
39
  | [isValidResource(resourceName)](./foundation-comms.defaultgenesisresources.isvalidresource.md) | | Checks if the resource exists |
40
40
  | [postLoadedMessage()](./foundation-comms.defaultgenesisresources.postloadedmessage.md) | <code>protected</code> | |
package/docs/api/foundation-comms.defaulthttpconnect.setvalidsession.md CHANGED
@@ -6,7 +6,7 @@
6
6
 
7
7
  > Warning: This API is now obsolete.
8
8
  >
9
- > - Please reference instead.',
9
+ > - Please reference `User` from `@genesislcap/foundation-user` instead.
10
10
  >
11
11
 
12
12
  **Signature:**
package/docs/api/foundation-comms.defaultsocket.hasvalidsession.md CHANGED
@@ -4,6 +4,11 @@
4
4
 
5
5
  ## DefaultSocket.hasValidSession property
6
6
 
7
+ > Warning: This API is now obsolete.
8
+ >
9
+ > - Use `User.isAuthenticated` from `@genesislcap/foundation-user` instead.
10
+ >
11
+
7
12
  **Signature:**
8
13
 
9
14
  ```typescript
package/docs/api/foundation-comms.genesisresources.getallresources.md CHANGED
@@ -4,7 +4,7 @@
4
4
 
5
5
  ## GenesisResources.getAllResources property
6
6
 
7
- All available resources
7
+ Returns all available resources.
8
8
 
9
9
  **Signature:**
10
10
 
package/docs/api/foundation-comms.genesisresources.md CHANGED
@@ -21,7 +21,7 @@ A lazy shared Genesis Resources lookup system. N number of callers can request i
21
21
  | Property | Modifiers | Type | Description |
22
22
  | --- | --- | --- | --- |
23
23
  | [destroy](./foundation-comms.genesisresources.destroy.md) | | () =&gt; void | Destroy and garbage collect |
24
- | [getAllResources](./foundation-comms.genesisresources.getallresources.md) | | () =&gt; Promise&lt;[ResourceItem](./foundation-comms.resourceitem.md)<!-- -->\[\]&gt; | All available resources |
24
+ | [getAllResources](./foundation-comms.genesisresources.getallresources.md) | | () =&gt; Promise&lt;[ResourceItem](./foundation-comms.resourceitem.md)<!-- -->\[\]&gt; | Returns all available resources. |
25
25
  | [getResourceTypeFor](./foundation-comms.genesisresources.getresourcetypefor.md) | | (resourceName: string) =&gt; Promise&lt;[ResourceType](./foundation-comms.resourcetype.md)<!-- -->&gt; | Gets the type of resource |
26
26
  | [isValidResource](./foundation-comms.genesisresources.isvalidresource.md) | | (resourceName: string) =&gt; Promise&lt;boolean&gt; | Checks if the resource exists |
27
27
 
package/docs/api/foundation-comms.serializedsocketstatus.hasvalidsession.md CHANGED
@@ -6,7 +6,7 @@
6
6
 
7
7
  > Warning: This API is now obsolete.
8
8
  >
9
- > - Use instead.
9
+ > - Use `User.isAuthenticated` from `@genesislcap/foundation-user` instead.
10
10
  >
11
11
 
12
12
  **Signature:**
package/docs/api/foundation-comms.user.md CHANGED
@@ -6,7 +6,7 @@
6
6
 
7
7
  > Warning: This API is now obsolete.
8
8
  >
9
- > - Use instead.
9
+ > - Use `User` from `@genesislcap/foundation-user` instead.
10
10
  >
11
11
 
12
12
  Represents a User object with associated permissions and profiles.
package/docs/api-report.md CHANGED
@@ -788,6 +788,8 @@ export interface DatasourceMetadata {
788
788
  readonly originalFieldDef: MetadataDetail[];
789
789
  // (undocumented)
790
790
  readonly requestFields: MetadataDetail[];
791
+ // (undocumented)
792
+ startStreamRequired: boolean;
791
793
  }
792
794
 
793
795
  // Warning: (ae-internal-missing-underscore) The name "DatasourceMock" should be prefixed with an underscore because the declaration is marked as @internal
@@ -845,6 +847,8 @@ export class DatasourceMock implements Datasource {
845
847
  // (undocumented)
846
848
  startStream(): Promise<void>;
847
849
  // (undocumented)
850
+ startStreamRequired: boolean;
851
+ // (undocumented)
848
852
  status: DatasourceStatus;
849
853
  // (undocumented)
850
854
  stream: SocketObservable<FilteredDataServerResult | RequestServerResult>;
@@ -1096,8 +1100,8 @@ export const defaultCredentialRequestOptions: GetCredentialOptions;
1096
1100
  // @public
1097
1101
  export class DefaultDatasource implements Datasource {
1098
1102
  constructor(connect: Connect, auth: Auth, resources: GenesisResources, config: DatasourceConfig);
1099
- // (undocumented)
1100
- get allParams(): any;
1103
+ // @internal (undocumented)
1104
+ get allResourceParams(): DataserverParams & RequestParams;
1101
1105
  // (undocumented)
1102
1106
  protected auth: Auth;
1103
1107
  // (undocumented)
@@ -1108,8 +1112,8 @@ export class DefaultDatasource implements Datasource {
1108
1112
  protected connect: Connect;
1109
1113
  // (undocumented)
1110
1114
  customRequestFields: MetadataDetail[];
1111
- // (undocumented)
1112
- get dataserverParams(): DataserverParams;
1115
+ // @internal (undocumented)
1116
+ get dataserverOnlyParams(): DataserverParams;
1113
1117
  // Warning: (ae-unresolved-inheritdoc-reference) The @inheritDoc reference could not be resolved: The reference is ambiguous because "Datasource" has more than one declaration; you need to add a TSDoc member reference selector
1114
1118
  //
1115
1119
  // (undocumented)
@@ -1138,8 +1142,8 @@ export class DefaultDatasource implements Datasource {
1138
1142
  protected reportStatus(detail?: Partial<DatasourceStatus>): void;
1139
1143
  // (undocumented)
1140
1144
  requestFields: MetadataDetail[];
1141
- // (undocumented)
1142
- get requestParams(): RequestParams;
1145
+ // @internal (undocumented)
1146
+ get requestOnlyParams(): RequestParams;
1143
1147
  // (undocumented)
1144
1148
  protected resources: GenesisResources;
1145
1149
  // (undocumented)
@@ -1150,8 +1154,6 @@ export class DefaultDatasource implements Datasource {
1150
1154
  snapshotFiltered(rowId?: string): Promise<any[]>;
1151
1155
  // (undocumented)
1152
1156
  startStream(): Promise<void>;
1153
- // Warning: (ae-unresolved-inheritdoc-reference) The @inheritDoc reference could not be resolved: No member was found with name "startStream"
1154
- //
1155
1157
  // (undocumented)
1156
1158
  startStreamRequired: boolean;
1157
1159
  // Warning: (ae-unresolved-inheritdoc-reference) The @inheritDoc reference could not be resolved: The reference is ambiguous because "Datasource" has more than one declaration; you need to add a TSDoc member reference selector
@@ -1514,7 +1516,7 @@ export class DefaultSocket implements Socket {
1514
1516
  protected config: ConnectConfig;
1515
1517
  // (undocumented)
1516
1518
  connect(host?: string, connectOptions?: SocketConnectOptions, reconnectOptions?: SocketReconnectOptions): Promise<boolean>;
1517
- // (undocumented)
1519
+ // @deprecated (undocumented)
1518
1520
  get hasValidSession(): boolean;
1519
1521
  set hasValidSession(value: boolean);
1520
1522
  // (undocumented)
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@genesislcap/foundation-comms",
3
3
  "description": "Genesis Foundation UI Comms",
4
- "version": "14.288.1-alpha-817ceca.0",
4
+ "version": "14.289.1-alpha-fe89166.0",
5
5
  "sideEffects": false,
6
6
  "license": "SEE LICENSE IN license.txt",
7
7
  "main": "dist/esm/index.js",
@@ -75,23 +75,23 @@
75
75
  }
76
76
  },
77
77
  "devDependencies": {
78
- "@genesislcap/foundation-testing": "14.288.1-alpha-817ceca.0",
79
- "@genesislcap/genx": "14.288.1-alpha-817ceca.0",
80
- "@genesislcap/rollup-builder": "14.288.1-alpha-817ceca.0",
81
- "@genesislcap/ts-builder": "14.288.1-alpha-817ceca.0",
82
- "@genesislcap/uvu-playwright-builder": "14.288.1-alpha-817ceca.0",
83
- "@genesislcap/vite-builder": "14.288.1-alpha-817ceca.0",
84
- "@genesislcap/webpack-builder": "14.288.1-alpha-817ceca.0",
78
+ "@genesislcap/foundation-testing": "14.289.1-alpha-fe89166.0",
79
+ "@genesislcap/genx": "14.289.1-alpha-fe89166.0",
80
+ "@genesislcap/rollup-builder": "14.289.1-alpha-fe89166.0",
81
+ "@genesislcap/ts-builder": "14.289.1-alpha-fe89166.0",
82
+ "@genesislcap/uvu-playwright-builder": "14.289.1-alpha-fe89166.0",
83
+ "@genesislcap/vite-builder": "14.289.1-alpha-fe89166.0",
84
+ "@genesislcap/webpack-builder": "14.289.1-alpha-fe89166.0",
85
85
  "@types/js-cookie": "^3.0.2",
86
86
  "@types/json-schema": "^7.0.11",
87
87
  "@types/webappsec-credential-management": "^0.6.2",
88
88
  "rimraf": "^5.0.0"
89
89
  },
90
90
  "dependencies": {
91
- "@genesislcap/foundation-broadcast-channel": "14.288.1-alpha-817ceca.0",
92
- "@genesislcap/foundation-logger": "14.288.1-alpha-817ceca.0",
93
- "@genesislcap/foundation-user": "14.288.1-alpha-817ceca.0",
94
- "@genesislcap/foundation-utils": "14.288.1-alpha-817ceca.0",
91
+ "@genesislcap/foundation-broadcast-channel": "14.289.1-alpha-fe89166.0",
92
+ "@genesislcap/foundation-logger": "14.289.1-alpha-fe89166.0",
93
+ "@genesislcap/foundation-user": "14.289.1-alpha-fe89166.0",
94
+ "@genesislcap/foundation-utils": "14.289.1-alpha-fe89166.0",
95
95
  "@microsoft/fast-element": "1.14.0",
96
96
  "@microsoft/fast-foundation": "2.49.6",
97
97
  "analytics": "^0.8.0",
@@ -111,5 +111,5 @@
111
111
  "publishConfig": {
112
112
  "access": "public"
113
113
  },
114
- "gitHead": "fe90725f2af80d0dbd64a5e1325290d9597031b3"
114
+ "gitHead": "b48a2f87c94dac3817086bafdd2f672a89042b37"
115
115
  }
package/docs/api/foundation-comms.defaultdatasource.allparams.md DELETED
@@ -1,11 +0,0 @@
1
- <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
-
3
- [Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [DefaultDatasource](./foundation-comms.defaultdatasource.md) &gt; [allParams](./foundation-comms.defaultdatasource.allparams.md)
4
-
5
- ## DefaultDatasource.allParams property
6
-
7
- **Signature:**
8
-
9
- ```typescript
10
- get allParams(): any;
11
- ```
package/docs/api/foundation-comms.defaultdatasource.dataserverparams.md DELETED
@@ -1,11 +0,0 @@
1
- <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
-
3
- [Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [DefaultDatasource](./foundation-comms.defaultdatasource.md) &gt; [dataserverParams](./foundation-comms.defaultdatasource.dataserverparams.md)
4
-
5
- ## DefaultDatasource.dataserverParams property
6
-
7
- **Signature:**
8
-
9
- ```typescript
10
- get dataserverParams(): DataserverParams;
11
- ```
package/docs/api/foundation-comms.defaultdatasource.requestparams.md DELETED
@@ -1,11 +0,0 @@
1
- <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
-
3
- [Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [DefaultDatasource](./foundation-comms.defaultdatasource.md) &gt; [requestParams](./foundation-comms.defaultdatasource.requestparams.md)
4
-
5
- ## DefaultDatasource.requestParams property
6
-
7
- **Signature:**
8
-
9
- ```typescript
10
- get requestParams(): RequestParams;
11
- ```