@salesforce/lds-worker-api 1.209.0 → 1.211.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.
@@ -743,22 +743,47 @@ function createPrimingSession(config) {
743
743
  const { primingEventHandler, concurrency, batchSize } = config;
744
744
  const session = createPrimingSession({ concurrency, batchSize });
745
745
  if (primingEventHandler) {
746
- const { onError, onPrimed } = primingEventHandler;
747
- if (onError) {
748
- session.on('error', onError.bind(primingEventHandler));
749
- }
750
- if (onPrimed) {
751
- session.on('primed', onPrimed.bind(primingEventHandler));
752
- }
753
- }
746
+ addEventHandler(session, primingEventHandler);
747
+ }
748
+ const registerEventHandler = (handler) => {
749
+ // bind creates a new function and we need to retain reference to that function
750
+ // in order to be able to remove it
751
+ const boundCallbacks = {
752
+ onError: handler.onError ? handler.onError.bind(handler) : undefined,
753
+ onPrimed: handler.onPrimed ? handler.onPrimed.bind(handler) : undefined,
754
+ };
755
+ addEventHandler(session, boundCallbacks);
756
+ return () => {
757
+ removeEventHandler(session, boundCallbacks);
758
+ };
759
+ };
754
760
  return {
755
761
  enqueue: session.enqueue.bind(session),
756
762
  cancel: session.cancel.bind(session),
757
763
  on: session.on.bind(session),
758
764
  once: session.once.bind(session),
759
765
  off: session.off.bind(session),
766
+ registerEventHandler,
760
767
  };
761
768
  }
769
+ function addEventHandler(session, handler) {
770
+ const { onError, onPrimed } = handler;
771
+ if (onError) {
772
+ session.on('error', onError);
773
+ }
774
+ if (onPrimed) {
775
+ session.on('primed', onPrimed);
776
+ }
777
+ }
778
+ function removeEventHandler(session, handler) {
779
+ const { onError, onPrimed } = handler;
780
+ if (onError) {
781
+ session.off('error', onError);
782
+ }
783
+ if (onPrimed) {
784
+ session.off('primed', onPrimed);
785
+ }
786
+ }
762
787
 
763
788
  if (process.env.NODE_ENV !== 'production') {
764
789
  // eslint-disable-next-line no-undef
@@ -770,4 +795,4 @@ if (process.env.NODE_ENV !== 'production') {
770
795
  }
771
796
 
772
797
  export { createPrimingSession, draftManager, draftQueue, executeAdapter, executeMutatingAdapter, getImperativeAdapterNames, invokeAdapter, invokeAdapterWithDraftToReplace, invokeAdapterWithMetadata, nimbusDraftQueue, setMetadataTTL, setUiApiRecordTTL, subscribeToAdapter };
773
- // version: 1.209.0-6b633d53a
798
+ // version: 1.211.0-a37f2b789
@@ -1,10 +1,11 @@
1
+ import type { PrimingSession } from '@salesforce/lds-priming';
1
2
  interface PrimingError {
2
3
  ids: string[];
3
4
  code: ErrorCode;
4
5
  message: string;
5
6
  }
6
7
  type ErrorCode = 'precondition-error' | 'not-found' | 'service-unavailable' | 'canceled' | 'unknown';
7
- interface PrimingEventHandler {
8
+ export interface PrimingEventHandler {
8
9
  onError?: (error: PrimingError) => void;
9
10
  onPrimed?: (ids: string[]) => void;
10
11
  }
@@ -16,8 +17,9 @@ export interface PrimingSessionConfig {
16
17
  export declare function createPrimingSession(config: PrimingSessionConfig): {
17
18
  enqueue: (work: PrimingWork) => Promise<void>;
18
19
  cancel: () => void;
19
- on: <K extends keyof import("@salesforce/lds-priming").PrimingEvents>(eventName: K, callback: (payload: import("@salesforce/lds-priming").PrimingEvents[K]) => void) => import("@salesforce/lds-priming").PrimingSession;
20
- once: <K_1 extends keyof import("@salesforce/lds-priming").PrimingEvents>(eventName: K_1, callback: (payload: import("@salesforce/lds-priming").PrimingEvents[K_1]) => void) => import("@salesforce/lds-priming").PrimingSession;
21
- off: <K_2 extends keyof import("@salesforce/lds-priming").PrimingEvents>(eventName: K_2, callback: (payload: import("@salesforce/lds-priming").PrimingEvents[K_2]) => void) => import("@salesforce/lds-priming").PrimingSession;
20
+ on: <K extends keyof import("@salesforce/lds-priming").PrimingEvents>(eventName: K, callback: (payload: import("@salesforce/lds-priming").PrimingEvents[K]) => void) => PrimingSession;
21
+ once: <K_1 extends keyof import("@salesforce/lds-priming").PrimingEvents>(eventName: K_1, callback: (payload: import("@salesforce/lds-priming").PrimingEvents[K_1]) => void) => PrimingSession;
22
+ off: <K_2 extends keyof import("@salesforce/lds-priming").PrimingEvents>(eventName: K_2, callback: (payload: import("@salesforce/lds-priming").PrimingEvents[K_2]) => void) => PrimingSession;
23
+ registerEventHandler: (handler: PrimingEventHandler) => () => void;
22
24
  };
23
25
  export {};
@@ -3862,7 +3862,7 @@ function withDefaultLuvio(callback) {
3862
3862
  }
3863
3863
  callbacks.push(callback);
3864
3864
  }
3865
- // version: 1.209.0-6b633d53a
3865
+ // version: 1.211.0-a37f2b789
3866
3866
 
3867
3867
  // TODO [TD-0081508]: once that TD is fulfilled we can probably change this file
3868
3868
  function instrumentAdapter$1(createFunction, _metadata) {
@@ -15295,7 +15295,7 @@ function parseAndVisit(source) {
15295
15295
  updateReferenceMapWithKnownKey(ast, luvioDocumentNode);
15296
15296
  return luvioDocumentNode;
15297
15297
  }
15298
- // version: 1.209.0-6b633d53a
15298
+ // version: 1.211.0-a37f2b789
15299
15299
 
15300
15300
  function unwrap(data) {
15301
15301
  // The lwc-luvio bindings import a function from lwc called "unwrap".
@@ -16218,7 +16218,7 @@ function createGraphQLWireAdapterConstructor(luvio, adapter, metadata, astResolv
16218
16218
  const { apiFamily, name } = metadata;
16219
16219
  return createGraphQLWireAdapterConstructor$1(adapter, `${apiFamily}.${name}`, luvio, astResolver);
16220
16220
  }
16221
- // version: 1.209.0-6b633d53a
16221
+ // version: 1.211.0-a37f2b789
16222
16222
 
16223
16223
  /**
16224
16224
  * Copyright (c) 2022, Salesforce, Inc.,
@@ -43556,7 +43556,7 @@ withDefaultLuvio((luvio) => {
43556
43556
  });
43557
43557
  throttle(60, 60000, createLDSAdapter(luvio, 'notifyListViewSummaryUpdateAvailable', notifyUpdateAvailableFactory));
43558
43558
  });
43559
- // version: 1.209.0-b5ca8738d
43559
+ // version: 1.211.0-ba06d67e8
43560
43560
 
43561
43561
  var caseSensitiveUserId = '005B0000000GR4OIAW';
43562
43562
 
@@ -60154,7 +60154,7 @@ register({
60154
60154
  id: '@salesforce/lds-network-adapter',
60155
60155
  instrument: instrument$1,
60156
60156
  });
60157
- // version: 1.209.0-6b633d53a
60157
+ // version: 1.211.0-a37f2b789
60158
60158
 
60159
60159
  const { create: create$2, keys: keys$2 } = Object;
60160
60160
  const { stringify: stringify$1, parse: parse$1 } = JSON;
@@ -77497,7 +77497,7 @@ register({
77497
77497
  configuration: { ...configurationForGraphQLAdapters },
77498
77498
  instrument,
77499
77499
  });
77500
- // version: 1.209.0-b5ca8738d
77500
+ // version: 1.211.0-ba06d67e8
77501
77501
 
77502
77502
  // On core the unstable adapters are re-exported with different names,
77503
77503
 
@@ -79744,7 +79744,7 @@ withDefaultLuvio((luvio) => {
79744
79744
  unstable_graphQL_imperative = createImperativeAdapter(luvio, createInstrumentedAdapter(ldsAdapter, adapterMetadata), adapterMetadata);
79745
79745
  graphQLImperative = ldsAdapter;
79746
79746
  });
79747
- // version: 1.209.0-b5ca8738d
79747
+ // version: 1.211.0-ba06d67e8
79748
79748
 
79749
79749
  var gqlApi = /*#__PURE__*/Object.freeze({
79750
79750
  __proto__: null,
@@ -80411,26 +80411,51 @@ function createPrimingSession(config) {
80411
80411
  const { primingEventHandler, concurrency, batchSize } = config;
80412
80412
  const session = createPrimingSession({ concurrency, batchSize });
80413
80413
  if (primingEventHandler) {
80414
- const { onError, onPrimed } = primingEventHandler;
80415
- if (onError) {
80416
- session.on('error', onError.bind(primingEventHandler));
80417
- }
80418
- if (onPrimed) {
80419
- session.on('primed', onPrimed.bind(primingEventHandler));
80420
- }
80421
- }
80414
+ addEventHandler(session, primingEventHandler);
80415
+ }
80416
+ const registerEventHandler = (handler) => {
80417
+ // bind creates a new function and we need to retain reference to that function
80418
+ // in order to be able to remove it
80419
+ const boundCallbacks = {
80420
+ onError: handler.onError ? handler.onError.bind(handler) : undefined,
80421
+ onPrimed: handler.onPrimed ? handler.onPrimed.bind(handler) : undefined,
80422
+ };
80423
+ addEventHandler(session, boundCallbacks);
80424
+ return () => {
80425
+ removeEventHandler(session, boundCallbacks);
80426
+ };
80427
+ };
80422
80428
  return {
80423
80429
  enqueue: session.enqueue.bind(session),
80424
80430
  cancel: session.cancel.bind(session),
80425
80431
  on: session.on.bind(session),
80426
80432
  once: session.once.bind(session),
80427
80433
  off: session.off.bind(session),
80434
+ registerEventHandler,
80428
80435
  };
80429
80436
  }
80437
+ function addEventHandler(session, handler) {
80438
+ const { onError, onPrimed } = handler;
80439
+ if (onError) {
80440
+ session.on('error', onError);
80441
+ }
80442
+ if (onPrimed) {
80443
+ session.on('primed', onPrimed);
80444
+ }
80445
+ }
80446
+ function removeEventHandler(session, handler) {
80447
+ const { onError, onPrimed } = handler;
80448
+ if (onError) {
80449
+ session.off('error', onError);
80450
+ }
80451
+ if (onPrimed) {
80452
+ session.off('primed', onPrimed);
80453
+ }
80454
+ }
80430
80455
 
80431
80456
  // LWR has a "setupLDS" bootstrap service/loader hook, we simulate this in
80432
80457
  const { luvio } = getRuntime();
80433
80458
  setDefaultLuvio({ luvio });
80434
80459
 
80435
80460
  export { createPrimingSession, draftManager, draftQueue, executeAdapter, executeMutatingAdapter, getImperativeAdapterNames, invokeAdapter, invokeAdapterWithDraftToReplace, invokeAdapterWithMetadata, nimbusDraftQueue, registerReportObserver, setMetadataTTL, setUiApiRecordTTL, subscribeToAdapter };
80436
- // version: 1.209.0-6b633d53a
80461
+ // version: 1.211.0-a37f2b789
@@ -1,10 +1,11 @@
1
+ import type { PrimingSession } from '@salesforce/lds-priming';
1
2
  interface PrimingError {
2
3
  ids: string[];
3
4
  code: ErrorCode;
4
5
  message: string;
5
6
  }
6
7
  type ErrorCode = 'precondition-error' | 'not-found' | 'service-unavailable' | 'canceled' | 'unknown';
7
- interface PrimingEventHandler {
8
+ export interface PrimingEventHandler {
8
9
  onError?: (error: PrimingError) => void;
9
10
  onPrimed?: (ids: string[]) => void;
10
11
  }
@@ -16,8 +17,9 @@ export interface PrimingSessionConfig {
16
17
  export declare function createPrimingSession(config: PrimingSessionConfig): {
17
18
  enqueue: (work: PrimingWork) => Promise<void>;
18
19
  cancel: () => void;
19
- on: <K extends keyof import("@salesforce/lds-priming").PrimingEvents>(eventName: K, callback: (payload: import("@salesforce/lds-priming").PrimingEvents[K]) => void) => import("@salesforce/lds-priming").PrimingSession;
20
- once: <K_1 extends keyof import("@salesforce/lds-priming").PrimingEvents>(eventName: K_1, callback: (payload: import("@salesforce/lds-priming").PrimingEvents[K_1]) => void) => import("@salesforce/lds-priming").PrimingSession;
21
- off: <K_2 extends keyof import("@salesforce/lds-priming").PrimingEvents>(eventName: K_2, callback: (payload: import("@salesforce/lds-priming").PrimingEvents[K_2]) => void) => import("@salesforce/lds-priming").PrimingSession;
20
+ on: <K extends keyof import("@salesforce/lds-priming").PrimingEvents>(eventName: K, callback: (payload: import("@salesforce/lds-priming").PrimingEvents[K]) => void) => PrimingSession;
21
+ once: <K_1 extends keyof import("@salesforce/lds-priming").PrimingEvents>(eventName: K_1, callback: (payload: import("@salesforce/lds-priming").PrimingEvents[K_1]) => void) => PrimingSession;
22
+ off: <K_2 extends keyof import("@salesforce/lds-priming").PrimingEvents>(eventName: K_2, callback: (payload: import("@salesforce/lds-priming").PrimingEvents[K_2]) => void) => PrimingSession;
23
+ registerEventHandler: (handler: PrimingEventHandler) => () => void;
22
24
  };
23
25
  export {};
@@ -3868,7 +3868,7 @@
3868
3868
  }
3869
3869
  callbacks.push(callback);
3870
3870
  }
3871
- // version: 1.209.0-6b633d53a
3871
+ // version: 1.211.0-a37f2b789
3872
3872
 
3873
3873
  // TODO [TD-0081508]: once that TD is fulfilled we can probably change this file
3874
3874
  function instrumentAdapter$1(createFunction, _metadata) {
@@ -15301,7 +15301,7 @@
15301
15301
  updateReferenceMapWithKnownKey(ast, luvioDocumentNode);
15302
15302
  return luvioDocumentNode;
15303
15303
  }
15304
- // version: 1.209.0-6b633d53a
15304
+ // version: 1.211.0-a37f2b789
15305
15305
 
15306
15306
  function unwrap(data) {
15307
15307
  // The lwc-luvio bindings import a function from lwc called "unwrap".
@@ -16224,7 +16224,7 @@
16224
16224
  const { apiFamily, name } = metadata;
16225
16225
  return createGraphQLWireAdapterConstructor$1(adapter, `${apiFamily}.${name}`, luvio, astResolver);
16226
16226
  }
16227
- // version: 1.209.0-6b633d53a
16227
+ // version: 1.211.0-a37f2b789
16228
16228
 
16229
16229
  /**
16230
16230
  * Copyright (c) 2022, Salesforce, Inc.,
@@ -43562,7 +43562,7 @@
43562
43562
  });
43563
43563
  throttle(60, 60000, createLDSAdapter(luvio, 'notifyListViewSummaryUpdateAvailable', notifyUpdateAvailableFactory));
43564
43564
  });
43565
- // version: 1.209.0-b5ca8738d
43565
+ // version: 1.211.0-ba06d67e8
43566
43566
 
43567
43567
  var caseSensitiveUserId = '005B0000000GR4OIAW';
43568
43568
 
@@ -60160,7 +60160,7 @@
60160
60160
  id: '@salesforce/lds-network-adapter',
60161
60161
  instrument: instrument$1,
60162
60162
  });
60163
- // version: 1.209.0-6b633d53a
60163
+ // version: 1.211.0-a37f2b789
60164
60164
 
60165
60165
  const { create: create$2, keys: keys$2 } = Object;
60166
60166
  const { stringify: stringify$1, parse: parse$1 } = JSON;
@@ -77503,7 +77503,7 @@
77503
77503
  configuration: { ...configurationForGraphQLAdapters },
77504
77504
  instrument,
77505
77505
  });
77506
- // version: 1.209.0-b5ca8738d
77506
+ // version: 1.211.0-ba06d67e8
77507
77507
 
77508
77508
  // On core the unstable adapters are re-exported with different names,
77509
77509
 
@@ -79750,7 +79750,7 @@
79750
79750
  unstable_graphQL_imperative = createImperativeAdapter(luvio, createInstrumentedAdapter(ldsAdapter, adapterMetadata), adapterMetadata);
79751
79751
  graphQLImperative = ldsAdapter;
79752
79752
  });
79753
- // version: 1.209.0-b5ca8738d
79753
+ // version: 1.211.0-ba06d67e8
79754
79754
 
79755
79755
  var gqlApi = /*#__PURE__*/Object.freeze({
79756
79756
  __proto__: null,
@@ -80417,22 +80417,47 @@
80417
80417
  const { primingEventHandler, concurrency, batchSize } = config;
80418
80418
  const session = createPrimingSession({ concurrency, batchSize });
80419
80419
  if (primingEventHandler) {
80420
- const { onError, onPrimed } = primingEventHandler;
80421
- if (onError) {
80422
- session.on('error', onError.bind(primingEventHandler));
80423
- }
80424
- if (onPrimed) {
80425
- session.on('primed', onPrimed.bind(primingEventHandler));
80426
- }
80427
- }
80420
+ addEventHandler(session, primingEventHandler);
80421
+ }
80422
+ const registerEventHandler = (handler) => {
80423
+ // bind creates a new function and we need to retain reference to that function
80424
+ // in order to be able to remove it
80425
+ const boundCallbacks = {
80426
+ onError: handler.onError ? handler.onError.bind(handler) : undefined,
80427
+ onPrimed: handler.onPrimed ? handler.onPrimed.bind(handler) : undefined,
80428
+ };
80429
+ addEventHandler(session, boundCallbacks);
80430
+ return () => {
80431
+ removeEventHandler(session, boundCallbacks);
80432
+ };
80433
+ };
80428
80434
  return {
80429
80435
  enqueue: session.enqueue.bind(session),
80430
80436
  cancel: session.cancel.bind(session),
80431
80437
  on: session.on.bind(session),
80432
80438
  once: session.once.bind(session),
80433
80439
  off: session.off.bind(session),
80440
+ registerEventHandler,
80434
80441
  };
80435
80442
  }
80443
+ function addEventHandler(session, handler) {
80444
+ const { onError, onPrimed } = handler;
80445
+ if (onError) {
80446
+ session.on('error', onError);
80447
+ }
80448
+ if (onPrimed) {
80449
+ session.on('primed', onPrimed);
80450
+ }
80451
+ }
80452
+ function removeEventHandler(session, handler) {
80453
+ const { onError, onPrimed } = handler;
80454
+ if (onError) {
80455
+ session.off('error', onError);
80456
+ }
80457
+ if (onPrimed) {
80458
+ session.off('primed', onPrimed);
80459
+ }
80460
+ }
80436
80461
 
80437
80462
  // LWR has a "setupLDS" bootstrap service/loader hook, we simulate this in
80438
80463
  const { luvio } = getRuntime();
@@ -80456,4 +80481,4 @@
80456
80481
  Object.defineProperty(exports, '__esModule', { value: true });
80457
80482
 
80458
80483
  }));
80459
- // version: 1.209.0-6b633d53a
80484
+ // version: 1.211.0-a37f2b789
@@ -1,10 +1,11 @@
1
+ import type { PrimingSession } from '@salesforce/lds-priming';
1
2
  interface PrimingError {
2
3
  ids: string[];
3
4
  code: ErrorCode;
4
5
  message: string;
5
6
  }
6
7
  type ErrorCode = 'precondition-error' | 'not-found' | 'service-unavailable' | 'canceled' | 'unknown';
7
- interface PrimingEventHandler {
8
+ export interface PrimingEventHandler {
8
9
  onError?: (error: PrimingError) => void;
9
10
  onPrimed?: (ids: string[]) => void;
10
11
  }
@@ -16,8 +17,9 @@ export interface PrimingSessionConfig {
16
17
  export declare function createPrimingSession(config: PrimingSessionConfig): {
17
18
  enqueue: (work: PrimingWork) => Promise<void>;
18
19
  cancel: () => void;
19
- on: <K extends keyof import("@salesforce/lds-priming").PrimingEvents>(eventName: K, callback: (payload: import("@salesforce/lds-priming").PrimingEvents[K]) => void) => import("@salesforce/lds-priming").PrimingSession;
20
- once: <K_1 extends keyof import("@salesforce/lds-priming").PrimingEvents>(eventName: K_1, callback: (payload: import("@salesforce/lds-priming").PrimingEvents[K_1]) => void) => import("@salesforce/lds-priming").PrimingSession;
21
- off: <K_2 extends keyof import("@salesforce/lds-priming").PrimingEvents>(eventName: K_2, callback: (payload: import("@salesforce/lds-priming").PrimingEvents[K_2]) => void) => import("@salesforce/lds-priming").PrimingSession;
20
+ on: <K extends keyof import("@salesforce/lds-priming").PrimingEvents>(eventName: K, callback: (payload: import("@salesforce/lds-priming").PrimingEvents[K]) => void) => PrimingSession;
21
+ once: <K_1 extends keyof import("@salesforce/lds-priming").PrimingEvents>(eventName: K_1, callback: (payload: import("@salesforce/lds-priming").PrimingEvents[K_1]) => void) => PrimingSession;
22
+ off: <K_2 extends keyof import("@salesforce/lds-priming").PrimingEvents>(eventName: K_2, callback: (payload: import("@salesforce/lds-priming").PrimingEvents[K_2]) => void) => PrimingSession;
23
+ registerEventHandler: (handler: PrimingEventHandler) => () => void;
22
24
  };
23
25
  export {};
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@salesforce/lds-worker-api",
3
- "version": "1.209.0",
3
+ "version": "1.211.0",
4
4
  "license": "SEE LICENSE IN LICENSE.txt",
5
5
  "description": "",
6
6
  "main": "dist/standalone/es/lds-worker-api.js",