@salesforce/lds-adapters-industries-eri 0.1.0-dev1

package/sfdc/index.js

@@ -0,0 +1,498 @@
+/**
+ * Copyright (c) 2022, Salesforce, Inc.,
+ * All rights reserved.
+ * For full license text, see the LICENSE.txt file
+ */
+
+/*
+ *  ATTENTION!
+ *  THIS IS A GENERATED FILE FROM https://github.com/salesforce-experience-platform-emu/lds-lightning-platform
+ *  If you would like to contribute to LDS, please follow the steps outlined in the git repo.
+ *  Any changes made to this file in p4 will be automatically overwritten.
+ *  *******************************************************************************************
+ */
+/* proxy-compat-disable */
+import { withDefaultLuvio } from 'force/ldsEngine';
+import { serializeStructuredKey, ingestShape, deepFreeze, StoreKeyMap, createResourceParams as createResourceParams$1 } from 'force/luvioEngine';
+
+const { hasOwnProperty: ObjectPrototypeHasOwnProperty } = Object.prototype;
+const { keys: ObjectKeys$1, create: ObjectCreate$1 } = Object;
+const { isArray: ArrayIsArray$1 } = Array;
+/**
+ * Validates an adapter config is well-formed.
+ * @param config The config to validate.
+ * @param adapter The adapter validation configuration.
+ * @param oneOf The keys the config must contain at least one of.
+ * @throws A TypeError if config doesn't satisfy the adapter's config validation.
+ */
+function validateConfig(config, adapter, oneOf) {
+    const { displayName } = adapter;
+    const { required, optional, unsupported } = adapter.parameters;
+    if (config === undefined ||
+        required.every(req => ObjectPrototypeHasOwnProperty.call(config, req)) === false) {
+        throw new TypeError(`adapter ${displayName} configuration must specify ${required.sort().join(', ')}`);
+    }
+    if (oneOf && oneOf.some(req => ObjectPrototypeHasOwnProperty.call(config, req)) === false) {
+        throw new TypeError(`adapter ${displayName} configuration must specify one of ${oneOf.sort().join(', ')}`);
+    }
+    if (unsupported !== undefined &&
+        unsupported.some(req => ObjectPrototypeHasOwnProperty.call(config, req))) {
+        throw new TypeError(`adapter ${displayName} does not yet support ${unsupported.sort().join(', ')}`);
+    }
+    const supported = required.concat(optional);
+    if (ObjectKeys$1(config).some(key => !supported.includes(key))) {
+        throw new TypeError(`adapter ${displayName} configuration supports only ${supported.sort().join(', ')}`);
+    }
+}
+function untrustedIsObject(untrusted) {
+    return typeof untrusted === 'object' && untrusted !== null && ArrayIsArray$1(untrusted) === false;
+}
+function areRequiredParametersPresent(config, configPropertyNames) {
+    return configPropertyNames.parameters.required.every(req => req in config);
+}
+function generateParamConfigMetadata(name, required, resourceType, typeCheckShape, isArrayShape = false, coerceFn) {
+    return {
+        name,
+        required,
+        resourceType,
+        typeCheckShape,
+        isArrayShape,
+        coerceFn,
+    };
+}
+function buildAdapterValidationConfig(displayName, paramsMeta) {
+    const required = paramsMeta.filter(p => p.required).map(p => p.name);
+    const optional = paramsMeta.filter(p => !p.required).map(p => p.name);
+    return {
+        displayName,
+        parameters: {
+            required,
+            optional,
+        }
+    };
+}
+const keyPrefix = 'eri';
+
+const { keys: ObjectKeys, create: ObjectCreate, assign: ObjectAssign } = Object;
+const { isArray: ArrayIsArray } = Array;
+const { stringify: JSONStringify } = JSON;
+function createLink(ref) {
+    return {
+        __ref: serializeStructuredKey(ref),
+    };
+}
+
+function validate$4(obj, path = 'FollowingInfoInputRepresentation') {
+    const v_error = (() => {
+        if (typeof obj !== 'object' || ArrayIsArray(obj) || obj === null) {
+            return new TypeError('Expected "object" but received "' + typeof obj + '" (at "' + path + '")');
+        }
+        if (obj.demo !== undefined) {
+            const obj_demo = obj.demo;
+            const path_demo = path + '.demo';
+            if (typeof obj_demo !== 'boolean') {
+                return new TypeError('Expected "boolean" but received "' + typeof obj_demo + '" (at "' + path_demo + '")');
+            }
+        }
+        if (obj.filterTypes !== undefined) {
+            const obj_filterTypes = obj.filterTypes;
+            const path_filterTypes = path + '.filterTypes';
+            if (!ArrayIsArray(obj_filterTypes)) {
+                return new TypeError('Expected "array" but received "' + typeof obj_filterTypes + '" (at "' + path_filterTypes + '")');
+            }
+            for (let i = 0; i < obj_filterTypes.length; i++) {
+                const obj_filterTypes_item = obj_filterTypes[i];
+                const path_filterTypes_item = path_filterTypes + '[' + i + ']';
+                if (typeof obj_filterTypes_item !== 'string') {
+                    return new TypeError('Expected "string" but received "' + typeof obj_filterTypes_item + '" (at "' + path_filterTypes_item + '")');
+                }
+            }
+        }
+        if (obj.hasNext !== undefined) {
+            const obj_hasNext = obj.hasNext;
+            const path_hasNext = path + '.hasNext';
+            if (typeof obj_hasNext !== 'boolean') {
+                return new TypeError('Expected "boolean" but received "' + typeof obj_hasNext + '" (at "' + path_hasNext + '")');
+            }
+        }
+        if (obj.page !== undefined) {
+            const obj_page = obj.page;
+            const path_page = path + '.page';
+            if (typeof obj_page !== 'number' || (typeof obj_page === 'number' && Math.floor(obj_page) !== obj_page)) {
+                return new TypeError('Expected "integer" but received "' + typeof obj_page + '" (at "' + path_page + '")');
+            }
+        }
+        if (obj.recordIds !== undefined) {
+            const obj_recordIds = obj.recordIds;
+            const path_recordIds = path + '.recordIds';
+            if (!ArrayIsArray(obj_recordIds)) {
+                return new TypeError('Expected "array" but received "' + typeof obj_recordIds + '" (at "' + path_recordIds + '")');
+            }
+            for (let i = 0; i < obj_recordIds.length; i++) {
+                const obj_recordIds_item = obj_recordIds[i];
+                const path_recordIds_item = path_recordIds + '[' + i + ']';
+                if (typeof obj_recordIds_item !== 'string') {
+                    return new TypeError('Expected "string" but received "' + typeof obj_recordIds_item + '" (at "' + path_recordIds_item + '")');
+                }
+            }
+        }
+    })();
+    return v_error === undefined ? null : v_error;
+}
+
+function validate$3(obj, path = 'ERIDigestInputRepresentation') {
+    const v_error = (() => {
+        if (typeof obj !== 'object' || ArrayIsArray(obj) || obj === null) {
+            return new TypeError('Expected "object" but received "' + typeof obj + '" (at "' + path + '")');
+        }
+        const obj_following = obj.following;
+        const path_following = path + '.following';
+        const referencepath_followingValidationError = validate$4(obj_following, path_following);
+        if (referencepath_followingValidationError !== null) {
+            let message = 'Object doesn\'t match FollowingInfoInputRepresentation (at "' + path_following + '")\n';
+            message += referencepath_followingValidationError.message.split('\n').map((line) => '\t' + line).join('\n');
+            return new TypeError(message);
+        }
+    })();
+    return v_error === undefined ? null : v_error;
+}
+
+function validate$2(obj, path = 'FollowingInfo') {
+    const v_error = (() => {
+        if (typeof obj !== 'object' || ArrayIsArray(obj) || obj === null) {
+            return new TypeError('Expected "object" but received "' + typeof obj + '" (at "' + path + '")');
+        }
+        const obj_filterTypes = obj.filterTypes;
+        const path_filterTypes = path + '.filterTypes';
+        if (!ArrayIsArray(obj_filterTypes)) {
+            return new TypeError('Expected "array" but received "' + typeof obj_filterTypes + '" (at "' + path_filterTypes + '")');
+        }
+        for (let i = 0; i < obj_filterTypes.length; i++) {
+            const obj_filterTypes_item = obj_filterTypes[i];
+            const path_filterTypes_item = path_filterTypes + '[' + i + ']';
+            if (typeof obj_filterTypes_item !== 'string') {
+                return new TypeError('Expected "string" but received "' + typeof obj_filterTypes_item + '" (at "' + path_filterTypes_item + '")');
+            }
+        }
+        const obj_page = obj.page;
+        const path_page = path + '.page';
+        if (typeof obj_page !== 'number' || (typeof obj_page === 'number' && Math.floor(obj_page) !== obj_page)) {
+            return new TypeError('Expected "integer" but received "' + typeof obj_page + '" (at "' + path_page + '")');
+        }
+        const obj_recordIds = obj.recordIds;
+        const path_recordIds = path + '.recordIds';
+        if (!ArrayIsArray(obj_recordIds)) {
+            return new TypeError('Expected "array" but received "' + typeof obj_recordIds + '" (at "' + path_recordIds + '")');
+        }
+        for (let i = 0; i < obj_recordIds.length; i++) {
+            const obj_recordIds_item = obj_recordIds[i];
+            const path_recordIds_item = path_recordIds + '[' + i + ']';
+            if (typeof obj_recordIds_item !== 'string') {
+                return new TypeError('Expected "string" but received "' + typeof obj_recordIds_item + '" (at "' + path_recordIds_item + '")');
+            }
+        }
+    })();
+    return v_error === undefined ? null : v_error;
+}
+
+function validate$1(obj, path = 'DigestNotification') {
+    const v_error = (() => {
+        if (typeof obj !== 'object' || ArrayIsArray(obj) || obj === null) {
+            return new TypeError('Expected "object" but received "' + typeof obj + '" (at "' + path + '")');
+        }
+        const obj_fields = obj.fields;
+        const path_fields = path + '.fields';
+        if (!ArrayIsArray(obj_fields)) {
+            return new TypeError('Expected "array" but received "' + typeof obj_fields + '" (at "' + path_fields + '")');
+        }
+        for (let i = 0; i < obj_fields.length; i++) {
+            const obj_fields_item = obj_fields[i];
+            const path_fields_item = path_fields + '[' + i + ']';
+            if (typeof obj_fields_item !== 'object' || ArrayIsArray(obj_fields_item) || obj_fields_item === null) {
+                return new TypeError('Expected "object" but received "' + typeof obj_fields_item + '" (at "' + path_fields_item + '")');
+            }
+            const obj_fields_item_keys = ObjectKeys(obj_fields_item);
+            for (let i = 0; i < obj_fields_item_keys.length; i++) {
+                const key = obj_fields_item_keys[i];
+                const obj_fields_item_prop = obj_fields_item[key];
+                const path_fields_item_prop = path_fields_item + '["' + key + '"]';
+                if (typeof obj_fields_item_prop !== 'string') {
+                    return new TypeError('Expected "string" but received "' + typeof obj_fields_item_prop + '" (at "' + path_fields_item_prop + '")');
+                }
+            }
+        }
+        const obj_id = obj.id;
+        const path_id = path + '.id';
+        if (typeof obj_id !== 'string') {
+            return new TypeError('Expected "string" but received "' + typeof obj_id + '" (at "' + path_id + '")');
+        }
+        const obj_name = obj.name;
+        const path_name = path + '.name';
+        if (typeof obj_name !== 'string') {
+            return new TypeError('Expected "string" but received "' + typeof obj_name + '" (at "' + path_name + '")');
+        }
+        const obj_navigationLink = obj.navigationLink;
+        const path_navigationLink = path + '.navigationLink';
+        if (typeof obj_navigationLink !== 'string') {
+            return new TypeError('Expected "string" but received "' + typeof obj_navigationLink + '" (at "' + path_navigationLink + '")');
+        }
+        if (obj.read !== undefined) {
+            const obj_read = obj.read;
+            const path_read = path + '.read';
+            if (typeof obj_read !== 'boolean') {
+                return new TypeError('Expected "boolean" but received "' + typeof obj_read + '" (at "' + path_read + '")');
+            }
+        }
+        const obj_recordId = obj.recordId;
+        const path_recordId = path + '.recordId';
+        if (typeof obj_recordId !== 'string') {
+            return new TypeError('Expected "string" but received "' + typeof obj_recordId + '" (at "' + path_recordId + '")');
+        }
+        if (obj.recordTypeId !== undefined) {
+            const obj_recordTypeId = obj.recordTypeId;
+            const path_recordTypeId = path + '.recordTypeId';
+            if (typeof obj_recordTypeId !== 'string') {
+                return new TypeError('Expected "string" but received "' + typeof obj_recordTypeId + '" (at "' + path_recordTypeId + '")');
+            }
+        }
+        const obj_sobjectType = obj.sobjectType;
+        const path_sobjectType = path + '.sobjectType';
+        if (typeof obj_sobjectType !== 'string') {
+            return new TypeError('Expected "string" but received "' + typeof obj_sobjectType + '" (at "' + path_sobjectType + '")');
+        }
+        const obj_sobjectTypeLabel = obj.sobjectTypeLabel;
+        const path_sobjectTypeLabel = path + '.sobjectTypeLabel';
+        if (typeof obj_sobjectTypeLabel !== 'string') {
+            return new TypeError('Expected "string" but received "' + typeof obj_sobjectTypeLabel + '" (at "' + path_sobjectTypeLabel + '")');
+        }
+        const obj_timeStamp = obj.timeStamp;
+        const path_timeStamp = path + '.timeStamp';
+        if (typeof obj_timeStamp !== 'string') {
+            return new TypeError('Expected "string" but received "' + typeof obj_timeStamp + '" (at "' + path_timeStamp + '")');
+        }
+        const obj_type = obj.type;
+        const path_type = path + '.type';
+        if (typeof obj_type !== 'string') {
+            return new TypeError('Expected "string" but received "' + typeof obj_type + '" (at "' + path_type + '")');
+        }
+    })();
+    return v_error === undefined ? null : v_error;
+}
+
+const TTL = 1000;
+const VERSION = "954674f4e56dd5b956cf98542401fda9";
+function validate(obj, path = 'ERIDigestOutputRepresentation') {
+    const v_error = (() => {
+        if (typeof obj !== 'object' || ArrayIsArray(obj) || obj === null) {
+            return new TypeError('Expected "object" but received "' + typeof obj + '" (at "' + path + '")');
+        }
+        if (obj.errorMsg !== undefined) {
+            const obj_errorMsg = obj.errorMsg;
+            const path_errorMsg = path + '.errorMsg';
+            if (typeof obj_errorMsg !== 'string') {
+                return new TypeError('Expected "string" but received "' + typeof obj_errorMsg + '" (at "' + path_errorMsg + '")');
+            }
+        }
+        if (obj.following !== undefined) {
+            const obj_following = obj.following;
+            const path_following = path + '.following';
+            const referencepath_followingValidationError = validate$2(obj_following, path_following);
+            if (referencepath_followingValidationError !== null) {
+                let message = 'Object doesn\'t match FollowingInfo (at "' + path_following + '")\n';
+                message += referencepath_followingValidationError.message.split('\n').map((line) => '\t' + line).join('\n');
+                return new TypeError(message);
+            }
+        }
+        if (obj.notifications !== undefined) {
+            const obj_notifications = obj.notifications;
+            const path_notifications = path + '.notifications';
+            if (!ArrayIsArray(obj_notifications)) {
+                return new TypeError('Expected "array" but received "' + typeof obj_notifications + '" (at "' + path_notifications + '")');
+            }
+            for (let i = 0; i < obj_notifications.length; i++) {
+                const obj_notifications_item = obj_notifications[i];
+                const path_notifications_item = path_notifications + '[' + i + ']';
+                const referencepath_notifications_itemValidationError = validate$1(obj_notifications_item, path_notifications_item);
+                if (referencepath_notifications_itemValidationError !== null) {
+                    let message = 'Object doesn\'t match DigestNotification (at "' + path_notifications_item + '")\n';
+                    message += referencepath_notifications_itemValidationError.message.split('\n').map((line) => '\t' + line).join('\n');
+                    return new TypeError(message);
+                }
+            }
+        }
+        const obj_requestSucceeded = obj.requestSucceeded;
+        const path_requestSucceeded = path + '.requestSucceeded';
+        if (typeof obj_requestSucceeded !== 'boolean') {
+            return new TypeError('Expected "boolean" but received "' + typeof obj_requestSucceeded + '" (at "' + path_requestSucceeded + '")');
+        }
+        const obj_statusCode = obj.statusCode;
+        const path_statusCode = path + '.statusCode';
+        if (typeof obj_statusCode !== 'string') {
+            return new TypeError('Expected "string" but received "' + typeof obj_statusCode + '" (at "' + path_statusCode + '")');
+        }
+    })();
+    return v_error === undefined ? null : v_error;
+}
+const RepresentationType = 'ERIDigestOutputRepresentation';
+function keyBuilder(luvio, config) {
+    return keyPrefix + '::' + RepresentationType + ':' + config.isSuccess;
+}
+function keyBuilderFromType(luvio, object) {
+    const keyParams = {
+        isSuccess: object.requestSucceeded
+    };
+    return keyBuilder(luvio, keyParams);
+}
+function normalize(input, existing, path, luvio, store, timestamp) {
+    return input;
+}
+const select$1 = function ERIDigestOutputRepresentationSelect() {
+    return {
+        kind: 'Fragment',
+        version: VERSION,
+        private: [],
+        opaque: true
+    };
+};
+function equals(existing, incoming) {
+    if (JSONStringify(incoming) !== JSONStringify(existing)) {
+        return false;
+    }
+    return true;
+}
+const ingest = function ERIDigestOutputRepresentationIngest(input, path, luvio, store, timestamp) {
+    if (process.env.NODE_ENV !== 'production') {
+        const validateError = validate(input);
+        if (validateError !== null) {
+            throw validateError;
+        }
+    }
+    const key = keyBuilderFromType(luvio, input);
+    const ttlToUse = TTL;
+    ingestShape(input, path, luvio, store, timestamp, ttlToUse, key, normalize, "eri", VERSION, RepresentationType, equals);
+    return createLink(key);
+};
+function getTypeCacheKeys(rootKeySet, luvio, input, fullPathFactory) {
+    // root cache key (uses fullPathFactory if keyBuilderFromType isn't defined)
+    const rootKey = keyBuilderFromType(luvio, input);
+    rootKeySet.set(rootKey, {
+        namespace: keyPrefix,
+        representationName: RepresentationType,
+        mergeable: false
+    });
+}
+
+function select(luvio, params) {
+    return select$1();
+}
+function getResponseCacheKeys(storeKeyMap, luvio, resourceParams, response) {
+    getTypeCacheKeys(storeKeyMap, luvio, response);
+}
+function ingestSuccess(luvio, resourceParams, response) {
+    const { body } = response;
+    const key = keyBuilderFromType(luvio, body);
+    luvio.storeIngest(key, ingest, body);
+    const snapshot = luvio.storeLookup({
+        recordId: key,
+        node: select(),
+        variables: {},
+    });
+    if (process.env.NODE_ENV !== 'production') {
+        if (snapshot.state !== 'Fulfilled') {
+            throw new Error('Invalid network response. Expected resource response to result in Fulfilled snapshot');
+        }
+    }
+    deepFreeze(snapshot.data);
+    return snapshot;
+}
+function createResourceRequest(config) {
+    const headers = {};
+    return {
+        baseUri: '/services/data/v66.0',
+        basePath: '/connect/eri/digest',
+        method: 'post',
+        body: config.body,
+        urlParams: {},
+        queryParams: {},
+        headers,
+        priority: 'normal',
+    };
+}
+
+const adapterName = 'getERIDigest';
+const getERIDigest_ConfigPropertyMetadata = [
+    generateParamConfigMetadata('eriDigestInput', true, 2 /* Body */, 4 /* Unsupported */),
+];
+const getERIDigest_ConfigPropertyNames = /*#__PURE__*/ buildAdapterValidationConfig(adapterName, getERIDigest_ConfigPropertyMetadata);
+const createResourceParams = /*#__PURE__*/ createResourceParams$1(getERIDigest_ConfigPropertyMetadata);
+function typeCheckConfig(untrustedConfig) {
+    const config = {};
+    const untrustedConfig_eriDigestInput = untrustedConfig.eriDigestInput;
+    const referenceERIDigestInputRepresentationValidationError = validate$3(untrustedConfig_eriDigestInput);
+    if (referenceERIDigestInputRepresentationValidationError === null) {
+        config.eriDigestInput = untrustedConfig_eriDigestInput;
+    }
+    return config;
+}
+function validateAdapterConfig(untrustedConfig, configPropertyNames) {
+    if (!untrustedIsObject(untrustedConfig)) {
+        return null;
+    }
+    if (process.env.NODE_ENV !== 'production') {
+        validateConfig(untrustedConfig, configPropertyNames);
+    }
+    const config = typeCheckConfig(untrustedConfig);
+    if (!areRequiredParametersPresent(config, configPropertyNames)) {
+        return null;
+    }
+    return config;
+}
+function buildNetworkSnapshot(luvio, config, options) {
+    const resourceParams = createResourceParams(config);
+    const request = createResourceRequest(resourceParams);
+    return luvio.dispatchResourceRequest(request, options)
+        .then((response) => {
+        return luvio.handleSuccessResponse(() => {
+            const snapshot = ingestSuccess(luvio, resourceParams, response);
+            return luvio.storeBroadcast().then(() => snapshot);
+        }, () => {
+            const cache = new StoreKeyMap();
+            getResponseCacheKeys(cache, luvio, resourceParams, response.body);
+            return cache;
+        });
+    }, (response) => {
+        deepFreeze(response);
+        throw response;
+    });
+}
+const getERIDigestAdapterFactory = (luvio) => {
+    return function getERIDigest(untrustedConfig) {
+        const config = validateAdapterConfig(untrustedConfig, getERIDigest_ConfigPropertyNames);
+        // Invalid or incomplete config
+        if (config === null) {
+            throw new Error('Invalid config for "getERIDigest"');
+        }
+        return buildNetworkSnapshot(luvio, config);
+    };
+};
+
+let getERIDigest;
+// Notify Update Available
+function bindExportsTo(luvio) {
+    // LDS Adapters
+    function unwrapSnapshotData(factory) {
+        const adapter = factory(luvio);
+        return (config) => adapter(config).then((snapshot) => snapshot.data);
+    }
+    return {
+        getERIDigest: unwrapSnapshotData(getERIDigestAdapterFactory),
+        // Imperative GET Adapters
+        // Notify Update Availables
+    };
+}
+withDefaultLuvio((luvio) => {
+    ({ getERIDigest } = bindExportsTo(luvio));
+});
+
+export { getERIDigest };
+// version: 0.1.0-dev1-c978a7b010

package/src/raml/api.raml

@@ -0,0 +1,173 @@
+#%RAML 1.0
+securedBy:
+  - OAuth2
+title: Salesforce Connect API
+version: '56.0'
+mediaType: application/json
+protocols:
+  - https
+baseUri: /services/data/v66.0
+securitySchemes:
+  OAuth2:
+    type: OAuth 2.0
+    settings:
+      authorizationUri: https://example.com/oauth/authorize
+      accessTokenUri: ''
+      authorizationGrants:
+        - implicit
+annotationTypes:
+  oas-readOnly:
+    type: boolean
+    allowedTargets: TypeDeclaration
+  oas-collectionFormat:
+    type: string
+  oas-body-name:
+    type: string
+    allowedTargets: TypeDeclaration
+types:
+  DigestNotification:
+    description: Digest notification
+    type: object
+    properties:
+      fields:
+        description: Display fields in the notification
+        type: array
+        items:
+          type: object
+          properties:
+            //:
+              type: string
+      id:
+        description: Unique id of the notification in the digest
+        type: string
+      name:
+        description: Record Name referenced in this notification
+        type: string
+      navigationLink:
+        description: Navigation Url
+        type: string
+      recordId:
+        description: Record id referenced in this notification
+        type: string
+      recordTypeId:
+        description: Record id type referenced in this notification
+        type: string
+        required: false
+      sobjectType:
+        description: Sobject Type of the record referenced in this notification
+        type: string
+      sobjectTypeLabel:
+        description: Sobject type label of the record referenced in this notification
+        type: string
+      timeStamp:
+        description: Time when this relationship is found
+        type: string
+      read:
+        description: true if the notification is read by the user
+        type: boolean
+        required: false
+      type:
+        description: Notificatio type
+        type: string
+        enum:
+          - JobChangeNotification
+          - RelationNotification
+          - NewsNotification
+  FollowingInfoInputRepresentation:
+    description: An Input Representation following object
+    type: object
+    properties:
+      filterTypes:
+        description: List of sObjectTypes used in home page mappings
+        type: array
+        required: false
+        items:
+          type: string
+      page:
+        description: 'Page number of the eri relationship digest list '
+        type: integer
+        required: false
+      recordIds:
+        description: List of RecordIds being followed by the user
+        type: array
+        required: false
+        items:
+          type: string
+      hasNext:
+        description: true if there any more recordIds to be queried for notifications else false
+        type: boolean
+        required: false
+      demo:
+        description: true for demo reponse else false
+        type: boolean
+        required: false
+  ERIDigestInputRepresentation:
+    description: An Input Representation for ERI digest
+    type: object
+    properties:
+      following:
+        type: FollowingInfoInputRepresentation
+        description: following input
+  ERIDigestInputRepresentationWrapper:
+    description: Wrapper for ERI digest input representation
+    type: object
+    properties:
+      eriDigestInput:
+        type: ERIDigestInputRepresentation
+        description: ERI Digest input represenation
+  ERIDigestOutputRepresentation:
+    description: Output representation of a ERI  Digest
+    type: object
+    properties:
+      errorMsg:
+        description: Error message
+        type: string
+        required: false
+      following:
+        description: User following records info
+        type: FollowingInfo
+        required: false
+      notifications:
+        description: Notifications list
+        type: array
+        required: false
+        items:
+          type: DigestNotification
+      requestSucceeded:
+        description: true if request is succeeded else false
+        type: boolean
+      statusCode:
+        description: Status code
+        type: string
+  FollowingInfo:
+    description: following info
+    type: object
+    properties:
+      filterTypes:
+        description: List of sObjectTypes used in home page mappings
+        type: array
+        items:
+          type: string
+      page:
+        description: 'Page number of the eri  digest '
+        type: integer
+      recordIds:
+        description: List of RecordIds being followed by the user
+        type: array
+        items:
+          type: string
+
+/connect:
+  /eri/digest:
+    post:
+      description: API to get relationship digest in ERI
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: ERIDigestOutputRepresentation
+      body:
+        application/json:
+          type: ERIDigestInputRepresentationWrapper
+          (oas-body-name): eriDigestInput

package/src/raml/luvio.raml

@@ -0,0 +1,22 @@
+#%RAML 1.0 Overlay
+extends: ./api.raml
+
+uses:
+  luvio: luvio://annotations.raml
+
+(luvio.keyPrefix): 'eri'
+(luvio.ttl): 1000
+
+types:
+  DigestNotification:
+    (luvio.opaque): true
+  ERIDigestOutputRepresentation:
+    (luvio.ttl): 1000
+    (luvio.opaque): true
+    (luvio.key):
+      isSuccess: requestSucceeded
+
+/connect/eri/digest:
+  post:
+    (luvio.adapter):
+      name: getERIDigest