@salesforce/lds-adapters-community-info 1.286.0 → 1.287.0-dev1

package/dist/es/es2018/community-info.js

@@ -7,7 +7,7 @@
 import { serializeStructuredKey, ingestShape, deepFreeze, buildNetworkSnapshotCachePolicy as buildNetworkSnapshotCachePolicy$1, typeCheckConfig as typeCheckConfig$1, StoreKeyMap, createResourceParams as createResourceParams$1 } from '@luvio/engine';
 
 const { hasOwnProperty: ObjectPrototypeHasOwnProperty } = Object.prototype;
-const { keys: ObjectKeys, create: ObjectCreate } = Object;
+const { keys: ObjectKeys$1, create: ObjectCreate$1 } = Object;
 const { isArray: ArrayIsArray$1 } = Array;
 /**
  * Validates an adapter config is well-formed.
@@ -31,7 +31,7 @@ function validateConfig(config, adapter, oneOf) {
         throw new TypeError(`adapter ${displayName} does not yet support ${unsupported.sort().join(', ')}`);
     }
     const supported = required.concat(optional);
-    if (ObjectKeys(config).some(key => !supported.includes(key))) {
+    if (ObjectKeys$1(config).some(key => !supported.includes(key))) {
         throw new TypeError(`adapter ${displayName} configuration supports only ${supported.sort().join(', ')}`);
     }
 }
@@ -71,7 +71,9 @@ function buildAdapterValidationConfig(displayName, paramsMeta) {
 }
 const keyPrefix = 'CommunityInfo';
 
+const { keys: ObjectKeys, create: ObjectCreate, assign: ObjectAssign } = Object;
 const { isArray: ArrayIsArray } = Array;
+const { stringify: JSONStringify } = JSON;
 function createLink(ref) {
     return {
         __ref: serializeStructuredKey(ref),
@@ -939,6 +941,20 @@ function getTypeCacheKeys(rootKeySet, luvio, input, fullPathFactory) {
         mergeable: false
     });
 }
+const notifyUpdateAvailableFactory = (luvio) => {
+    return function notifyCommunityUpdateAvailable(configs) {
+        if (process.env.NODE_ENV !== 'production') {
+            const requiredKeyParams = ['id'];
+            configs.forEach(config => {
+                if (false === requiredKeyParams.every(req => req in config)) {
+                    throw new Error(`one of the configs did not contain all required parameters: ${JSONStringify(ObjectKeys(config))}`);
+                }
+            });
+        }
+        const keys = configs.map(c => keyBuilder$2(luvio, c));
+        return luvio.notifyStoreUpdateAvailable(keys);
+    };
+};
 
 function select(luvio, params) {
     return select$1();
@@ -1080,4 +1096,4 @@ const getCommunityAdapterFactory = (luvio) => function CommunityInfo__getCommuni
     buildCachedSnapshotCachePolicy, buildNetworkSnapshotCachePolicy);
 };
 
-export { getCommunityAdapterFactory };
+export { getCommunityAdapterFactory, notifyUpdateAvailableFactory as notifyCommunityUpdateAvailableFactory };

package/dist/es/es2018/types/src/generated/artifacts/main.d.ts

@@ -1 +1,2 @@
 export { getCommunityAdapterFactory } from '../adapters/getCommunity';
+export { notifyUpdateAvailableFactory as notifyCommunityUpdateAvailableFactory } from '../types/CommunityRepresentation';

package/dist/es/es2018/types/src/generated/artifacts/sfdc.d.ts

@@ -1,3 +1,5 @@
 declare let getCommunity: any;
 declare let getCommunity_imperative: any;
+declare let notifyCommunityUpdateAvailable: any;
 export { getCommunity, getCommunity_imperative };
+export { notifyCommunityUpdateAvailable };

package/dist/es/es2018/types/src/generated/types/CommunityRepresentation.d.ts

@@ -102,3 +102,4 @@ export interface CommunityRepresentation {
     url: string | null;
     urlPathPrefix: string | null;
 }
+export declare const notifyUpdateAvailableFactory: (luvio: $64$luvio_engine_Luvio) => (configs: Partial<KeyParams>[]) => Promise<void>;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@salesforce/lds-adapters-community-info",
-    "version": "1.286.0",
+    "version": "1.287.0-dev1",
     "license": "SEE LICENSE IN LICENSE.txt",
     "description": "Gets info about the community",
     "main": "dist/es/es2018/community-info.js",
@@ -44,11 +44,11 @@
         "test:unit": "jest"
     },
     "dependencies": {
-        "@salesforce/lds-bindings": "^1.286.0"
+        "@salesforce/lds-bindings": "^1.287.0-dev1"
     },
     "devDependencies": {
-        "@salesforce/lds-compiler-plugins": "^1.286.0",
-        "@salesforce/lds-karma": "^1.286.0"
+        "@salesforce/lds-compiler-plugins": "^1.287.0-dev1",
+        "@salesforce/lds-karma": "^1.287.0-dev1"
     },
     "nx": {
         "targets": {

package/sfdc/index.js

@@ -17,7 +17,7 @@ import { withDefaultLuvio } from 'force/ldsEngine';
 import { serializeStructuredKey, ingestShape, deepFreeze, buildNetworkSnapshotCachePolicy as buildNetworkSnapshotCachePolicy$1, typeCheckConfig as typeCheckConfig$1, StoreKeyMap, createResourceParams as createResourceParams$1 } from 'force/luvioEngine';
 
 const { hasOwnProperty: ObjectPrototypeHasOwnProperty } = Object.prototype;
-const { keys: ObjectKeys, create: ObjectCreate } = Object;
+const { keys: ObjectKeys$1, create: ObjectCreate$1 } = Object;
 const { isArray: ArrayIsArray$1 } = Array;
 /**
  * Validates an adapter config is well-formed.
@@ -41,7 +41,7 @@ function validateConfig(config, adapter, oneOf) {
         throw new TypeError(`adapter ${displayName} does not yet support ${unsupported.sort().join(', ')}`);
     }
     const supported = required.concat(optional);
-    if (ObjectKeys(config).some(key => !supported.includes(key))) {
+    if (ObjectKeys$1(config).some(key => !supported.includes(key))) {
         throw new TypeError(`adapter ${displayName} configuration supports only ${supported.sort().join(', ')}`);
     }
 }
@@ -81,7 +81,9 @@ function buildAdapterValidationConfig(displayName, paramsMeta) {
 }
 const keyPrefix = 'CommunityInfo';
 
+const { keys: ObjectKeys, create: ObjectCreate, assign: ObjectAssign } = Object;
 const { isArray: ArrayIsArray } = Array;
+const { stringify: JSONStringify } = JSON;
 function createLink(ref) {
     return {
         __ref: serializeStructuredKey(ref),
@@ -949,6 +951,20 @@ function getTypeCacheKeys(rootKeySet, luvio, input, fullPathFactory) {
         mergeable: false
     });
 }
+const notifyUpdateAvailableFactory = (luvio) => {
+    return function notifyCommunityUpdateAvailable(configs) {
+        if (process.env.NODE_ENV !== 'production') {
+            const requiredKeyParams = ['id'];
+            configs.forEach(config => {
+                if (false === requiredKeyParams.every(req => req in config)) {
+                    throw new Error(`one of the configs did not contain all required parameters: ${JSONStringify(ObjectKeys(config))}`);
+                }
+            });
+        }
+        const keys = configs.map(c => keyBuilder$2(luvio, c));
+        return luvio.notifyStoreUpdateAvailable(keys);
+    };
+};
 
 function select(luvio, params) {
     return select$1();
@@ -1096,6 +1112,7 @@ let getCommunity_imperative;
 // Adapter Metadata
 const getCommunityMetadata = { apiFamily: 'CommunityInfo', name: 'getCommunity', ttl: 3600000 };
 // Notify Update Available
+let notifyCommunityUpdateAvailable;
 function bindExportsTo(luvio) {
     // LDS Adapters
     const getCommunity_ldsAdapter = createInstrumentedAdapter(createLDSAdapter(luvio, 'getCommunity', getCommunityAdapterFactory), getCommunityMetadata);
@@ -1104,11 +1121,13 @@ function bindExportsTo(luvio) {
         // Imperative GET Adapters
         getCommunity_imperative: createImperativeAdapter(luvio, getCommunity_ldsAdapter, getCommunityMetadata),
         // Notify Update Availables
+        notifyCommunityUpdateAvailable: createLDSAdapter(luvio, 'notifyCommunityUpdateAvailable', notifyUpdateAvailableFactory),
     };
 }
 withDefaultLuvio((luvio) => {
-    ({ getCommunity, getCommunity_imperative } = bindExportsTo(luvio));
+    ({ getCommunity, getCommunity_imperative, notifyCommunityUpdateAvailable } =
+        bindExportsTo(luvio));
 });
 
-export { getCommunity, getCommunity_imperative };
-// version: 1.286.0-27bef7c46
+export { getCommunity, getCommunity_imperative, notifyCommunityUpdateAvailable };
+// version: 1.287.0-dev1-bb4d690c6

package/src/raml/luvio.raml

@@ -12,6 +12,10 @@ types:
     (luvio.ttl): 3600000
     (luvio.key):
       id: id
+    (luvio.updateAvailable):
+      name: notifyCommunityUpdateAvailable
+      parameters:
+        id: id
 
 /connect/communities/{communityId}:
   get: