@salesforce/lds-adapters-platform-learning 1.299.0

package/sfdc/index.js

@@ -0,0 +1,486 @@
+/**
+ * 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$2, typeCheckConfig as typeCheckConfig$2 } from 'force/luvioEngine';
+
+const { hasOwnProperty: ObjectPrototypeHasOwnProperty } = Object.prototype;
+const { keys: ObjectKeys, create: ObjectCreate } = 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(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 = 'learning';
+
+const { isArray: ArrayIsArray } = Array;
+function createLink(ref) {
+    return {
+        __ref: serializeStructuredKey(ref),
+    };
+}
+
+const TTL = 15000;
+const VERSION = "987ec5d201417fd82d2e377adf8ef5cd";
+function validate(obj, path = 'LearningItemProgressRepresentation') {
+    const v_error = (() => {
+        if (typeof obj !== 'object' || ArrayIsArray(obj) || obj === null) {
+            return new TypeError('Expected "object" but received "' + typeof obj + '" (at "' + path + '")');
+        }
+        const obj_completedDate = obj.completedDate;
+        const path_completedDate = path + '.completedDate';
+        let obj_completedDate_union0 = null;
+        const obj_completedDate_union0_error = (() => {
+            if (typeof obj_completedDate !== 'string') {
+                return new TypeError('Expected "string" but received "' + typeof obj_completedDate + '" (at "' + path_completedDate + '")');
+            }
+        })();
+        if (obj_completedDate_union0_error != null) {
+            obj_completedDate_union0 = obj_completedDate_union0_error.message;
+        }
+        let obj_completedDate_union1 = null;
+        const obj_completedDate_union1_error = (() => {
+            if (obj_completedDate !== null) {
+                return new TypeError('Expected "null" but received "' + typeof obj_completedDate + '" (at "' + path_completedDate + '")');
+            }
+        })();
+        if (obj_completedDate_union1_error != null) {
+            obj_completedDate_union1 = obj_completedDate_union1_error.message;
+        }
+        if (obj_completedDate_union0 && obj_completedDate_union1) {
+            let message = 'Object doesn\'t match union (at "' + path_completedDate + '")';
+            message += '\n' + obj_completedDate_union0.split('\n').map((line) => '\t' + line).join('\n');
+            message += '\n' + obj_completedDate_union1.split('\n').map((line) => '\t' + line).join('\n');
+            return new TypeError(message);
+        }
+        const obj_completedPercent = obj.completedPercent;
+        const path_completedPercent = path + '.completedPercent';
+        let obj_completedPercent_union0 = null;
+        const obj_completedPercent_union0_error = (() => {
+            if (typeof obj_completedPercent !== 'number') {
+                return new TypeError('Expected "number" but received "' + typeof obj_completedPercent + '" (at "' + path_completedPercent + '")');
+            }
+        })();
+        if (obj_completedPercent_union0_error != null) {
+            obj_completedPercent_union0 = obj_completedPercent_union0_error.message;
+        }
+        let obj_completedPercent_union1 = null;
+        const obj_completedPercent_union1_error = (() => {
+            if (obj_completedPercent !== null) {
+                return new TypeError('Expected "null" but received "' + typeof obj_completedPercent + '" (at "' + path_completedPercent + '")');
+            }
+        })();
+        if (obj_completedPercent_union1_error != null) {
+            obj_completedPercent_union1 = obj_completedPercent_union1_error.message;
+        }
+        if (obj_completedPercent_union0 && obj_completedPercent_union1) {
+            let message = 'Object doesn\'t match union (at "' + path_completedPercent + '")';
+            message += '\n' + obj_completedPercent_union0.split('\n').map((line) => '\t' + line).join('\n');
+            message += '\n' + obj_completedPercent_union1.split('\n').map((line) => '\t' + line).join('\n');
+            return new TypeError(message);
+        }
+        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_isCompleted = obj.isCompleted;
+        const path_isCompleted = path + '.isCompleted';
+        if (typeof obj_isCompleted !== 'boolean') {
+            return new TypeError('Expected "boolean" but received "' + typeof obj_isCompleted + '" (at "' + path_isCompleted + '")');
+        }
+        const obj_learningItemId = obj.learningItemId;
+        const path_learningItemId = path + '.learningItemId';
+        if (typeof obj_learningItemId !== 'string') {
+            return new TypeError('Expected "string" but received "' + typeof obj_learningItemId + '" (at "' + path_learningItemId + '")');
+        }
+    })();
+    return v_error === undefined ? null : v_error;
+}
+const RepresentationType = 'LearningItemProgressRepresentation';
+function keyBuilder(luvio, config) {
+    return keyPrefix + '::' + RepresentationType + ':' + config.learning_item_progress_id;
+}
+function keyBuilderFromType(luvio, object) {
+    const keyParams = {
+        learning_item_progress_id: object.id
+    };
+    return keyBuilder(luvio, keyParams);
+}
+function normalize(input, existing, path, luvio, store, timestamp) {
+    return input;
+}
+const select$2 = function LearningItemProgressRepresentationSelect() {
+    return {
+        kind: 'Fragment',
+        version: VERSION,
+        private: [],
+        selections: [
+            {
+                name: 'completedDate',
+                kind: 'Scalar'
+            },
+            {
+                name: 'completedPercent',
+                kind: 'Scalar'
+            },
+            {
+                name: 'id',
+                kind: 'Scalar'
+            },
+            {
+                name: 'isCompleted',
+                kind: 'Scalar'
+            },
+            {
+                name: 'learningItemId',
+                kind: 'Scalar'
+            }
+        ]
+    };
+};
+function equals(existing, incoming) {
+    const existing_isCompleted = existing.isCompleted;
+    const incoming_isCompleted = incoming.isCompleted;
+    if (!(existing_isCompleted === incoming_isCompleted)) {
+        return false;
+    }
+    const existing_id = existing.id;
+    const incoming_id = incoming.id;
+    if (!(existing_id === incoming_id)) {
+        return false;
+    }
+    const existing_learningItemId = existing.learningItemId;
+    const incoming_learningItemId = incoming.learningItemId;
+    if (!(existing_learningItemId === incoming_learningItemId)) {
+        return false;
+    }
+    const existing_completedDate = existing.completedDate;
+    const incoming_completedDate = incoming.completedDate;
+    if (!(existing_completedDate === incoming_completedDate)) {
+        return false;
+    }
+    const existing_completedPercent = existing.completedPercent;
+    const incoming_completedPercent = incoming.completedPercent;
+    if (!(existing_completedPercent === incoming_completedPercent)) {
+        return false;
+    }
+    return true;
+}
+const ingest = function LearningItemProgressRepresentationIngest(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, "learning", 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$1(luvio, params) {
+    return select$2();
+}
+function getResponseCacheKeys$1(storeKeyMap, luvio, resourceParams, response) {
+    getTypeCacheKeys(storeKeyMap, luvio, response);
+}
+function ingestSuccess$1(luvio, resourceParams, response) {
+    const { body } = response;
+    const key = keyBuilderFromType(luvio, body);
+    luvio.storeIngest(key, ingest, body);
+    const snapshot = luvio.storeLookup({
+        recordId: key,
+        node: select$1(),
+        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$1(config) {
+    const headers = {};
+    return {
+        baseUri: '/services/data/v62.0',
+        basePath: '/connect/learningItem/' + config.urlParams.learningItemId + '/actions/evaluate',
+        method: 'post',
+        body: config.body,
+        urlParams: config.urlParams,
+        queryParams: {},
+        headers,
+        priority: 'normal',
+    };
+}
+
+const adapterName$1 = 'evaluateLearningItem';
+const evaluateLearningItem_ConfigPropertyMetadata = [
+    generateParamConfigMetadata('learningItemId', true, 0 /* UrlParameter */, 0 /* String */),
+    generateParamConfigMetadata('details', false, 2 /* Body */, 4 /* Unsupported */),
+];
+const evaluateLearningItem_ConfigPropertyNames = /*#__PURE__*/ buildAdapterValidationConfig(adapterName$1, evaluateLearningItem_ConfigPropertyMetadata);
+const createResourceParams$1 = /*#__PURE__*/ createResourceParams$2(evaluateLearningItem_ConfigPropertyMetadata);
+function typeCheckConfig$1(untrustedConfig) {
+    const config = {};
+    typeCheckConfig$2(untrustedConfig, config, evaluateLearningItem_ConfigPropertyMetadata);
+    const untrustedConfig_details = untrustedConfig.details;
+    if (untrustedIsObject(untrustedConfig_details)) {
+        const untrustedConfig_details_object = {};
+        const untrustedConfig_details_keys = Object.keys(untrustedConfig_details);
+        for (let i = 0, arrayLength = untrustedConfig_details_keys.length; i < arrayLength; i++) {
+            const key = untrustedConfig_details_keys[i];
+            const untrustedConfig_details_prop = untrustedConfig_details[key];
+            if (untrustedConfig_details_object !== undefined) {
+                untrustedConfig_details_object[key] = untrustedConfig_details_prop;
+            }
+        }
+        if (untrustedConfig_details_object !== undefined && Object.keys(untrustedConfig_details_object).length >= 0) {
+            config.details = untrustedConfig_details_object;
+        }
+    }
+    return config;
+}
+function validateAdapterConfig$1(untrustedConfig, configPropertyNames) {
+    if (!untrustedIsObject(untrustedConfig)) {
+        return null;
+    }
+    if (process.env.NODE_ENV !== 'production') {
+        validateConfig(untrustedConfig, configPropertyNames);
+    }
+    const config = typeCheckConfig$1(untrustedConfig);
+    if (!areRequiredParametersPresent(config, configPropertyNames)) {
+        return null;
+    }
+    return config;
+}
+function buildNetworkSnapshot$1(luvio, config, options) {
+    const resourceParams = createResourceParams$1(config);
+    const request = createResourceRequest$1(resourceParams);
+    return luvio.dispatchResourceRequest(request, options)
+        .then((response) => {
+        return luvio.handleSuccessResponse(() => {
+            const snapshot = ingestSuccess$1(luvio, resourceParams, response);
+            return luvio.storeBroadcast().then(() => snapshot);
+        }, () => {
+            const cache = new StoreKeyMap();
+            getResponseCacheKeys$1(cache, luvio, resourceParams, response.body);
+            return cache;
+        });
+    }, (response) => {
+        deepFreeze(response);
+        throw response;
+    });
+}
+const evaluateLearningItemAdapterFactory = (luvio) => {
+    return function evaluateLearningItem(untrustedConfig) {
+        const config = validateAdapterConfig$1(untrustedConfig, evaluateLearningItem_ConfigPropertyNames);
+        // Invalid or incomplete config
+        if (config === null) {
+            throw new Error('Invalid config for "evaluateLearningItem"');
+        }
+        return buildNetworkSnapshot$1(luvio, config);
+    };
+};
+
+function select(luvio, params) {
+    return select$2();
+}
+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/v62.0',
+        basePath: '/connect/communities/' + config.urlParams.communityId + '/learningItem/' + config.urlParams.learningItemId + '/actions/evaluate',
+        method: 'post',
+        body: config.body,
+        urlParams: config.urlParams,
+        queryParams: {},
+        headers,
+        priority: 'normal',
+    };
+}
+
+const adapterName = 'evaluateLearningItemForCommunity';
+const evaluateLearningItemForCommunity_ConfigPropertyMetadata = [
+    generateParamConfigMetadata('communityId', true, 0 /* UrlParameter */, 0 /* String */),
+    generateParamConfigMetadata('learningItemId', true, 0 /* UrlParameter */, 0 /* String */),
+    generateParamConfigMetadata('details', false, 2 /* Body */, 4 /* Unsupported */),
+];
+const evaluateLearningItemForCommunity_ConfigPropertyNames = /*#__PURE__*/ buildAdapterValidationConfig(adapterName, evaluateLearningItemForCommunity_ConfigPropertyMetadata);
+const createResourceParams = /*#__PURE__*/ createResourceParams$2(evaluateLearningItemForCommunity_ConfigPropertyMetadata);
+function typeCheckConfig(untrustedConfig) {
+    const config = {};
+    typeCheckConfig$2(untrustedConfig, config, evaluateLearningItemForCommunity_ConfigPropertyMetadata);
+    const untrustedConfig_details = untrustedConfig.details;
+    if (untrustedIsObject(untrustedConfig_details)) {
+        const untrustedConfig_details_object = {};
+        const untrustedConfig_details_keys = Object.keys(untrustedConfig_details);
+        for (let i = 0, arrayLength = untrustedConfig_details_keys.length; i < arrayLength; i++) {
+            const key = untrustedConfig_details_keys[i];
+            const untrustedConfig_details_prop = untrustedConfig_details[key];
+            if (untrustedConfig_details_object !== undefined) {
+                untrustedConfig_details_object[key] = untrustedConfig_details_prop;
+            }
+        }
+        if (untrustedConfig_details_object !== undefined && Object.keys(untrustedConfig_details_object).length >= 0) {
+            config.details = untrustedConfig_details_object;
+        }
+    }
+    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 evaluateLearningItemForCommunityAdapterFactory = (luvio) => {
+    return function evaluateLearningItemForCommunity(untrustedConfig) {
+        const config = validateAdapterConfig(untrustedConfig, evaluateLearningItemForCommunity_ConfigPropertyNames);
+        // Invalid or incomplete config
+        if (config === null) {
+            throw new Error('Invalid config for "evaluateLearningItemForCommunity"');
+        }
+        return buildNetworkSnapshot(luvio, config);
+    };
+};
+
+let evaluateLearningItem;
+let evaluateLearningItemForCommunity;
+// Notify Update Available
+function bindExportsTo(luvio) {
+    // LDS Adapters
+    function unwrapSnapshotData(factory) {
+        const adapter = factory(luvio);
+        return (config) => adapter(config).then((snapshot) => snapshot.data);
+    }
+    return {
+        evaluateLearningItem: unwrapSnapshotData(evaluateLearningItemAdapterFactory),
+        evaluateLearningItemForCommunity: unwrapSnapshotData(evaluateLearningItemForCommunityAdapterFactory),
+        // Imperative GET Adapters
+        // Notify Update Availables
+    };
+}
+withDefaultLuvio((luvio) => {
+    ({ evaluateLearningItem, evaluateLearningItemForCommunity } = bindExportsTo(luvio));
+});
+
+export { evaluateLearningItem, evaluateLearningItemForCommunity };
+// version: 1.299.0-161c48605a

package/src/raml/api.raml

@@ -0,0 +1,98 @@
+#%RAML 1.0
+securedBy:
+  - OAuth2
+title: Salesforce Connect API
+version: '62.0'
+mediaType: application/json
+protocols:
+  - https
+baseUri: /services/data/v62.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:
+  EvaluateLearningItemInputRepresentation:
+    description: Represents the data that's sent for evaluating the learning item
+    type: object
+    properties:
+      details:
+        description: The learning item data, in JSON format, that you want to evaluate.
+        type: object
+        required: false # TODO Hand-rolled W-8253396
+        properties:
+          //:
+            type: any
+  LearningItemProgressRepresentation:
+    description: Represents the response that's returned after a learning item is evaluated successfully
+    type: object
+    properties:
+      completedDate:
+        description: The date when the user completed the learning item
+        type: string | nil
+      completedPercent:
+        description: Percentage of the learning item that's complete
+        #format: double # Hand-rolled format not allowed with union type
+        type: number | nil
+      id:
+        description: The ID of the learning item progress
+        type: string
+      isCompleted:
+        description: Whether the learning item is complete (true) or not (false). The default value is false
+        type: boolean
+      learningItemId:
+        description: The ID of the learning item that was evaluated
+        type: string
+/connect:
+  /communities/{communityId}/learningItem/{learningItemId}/actions/evaluate:
+    post:
+      displayName: postEvaluateLearningItem
+      description: Checks the completion progress of a learning item
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: LearningItemProgressRepresentation
+      body:
+        application/json:
+          type: EvaluateLearningItemInputRepresentation
+          (oas-body-name): evaluateLearningItemInputRepresentation
+    uriParameters:
+      communityId:
+        type: string
+        required: true
+      learningItemId:
+        type: string
+        required: true
+  /learningItem/{learningItemId}/actions/evaluate:
+    post:
+      displayName: postEvaluateLearningItem
+      description: Checks the completion progress of a learning item
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: LearningItemProgressRepresentation
+      body:
+        application/json:
+          type: EvaluateLearningItemInputRepresentation
+          (oas-body-name): evaluateLearningItemInputRepresentation
+    uriParameters:
+      learningItemId:
+        type: string
+        required: true

package/src/raml/luvio.raml

@@ -0,0 +1,24 @@
+#%RAML 1.0 Overlay
+extends: ./api.raml
+
+uses:
+  luvio: luvio://annotations.raml
+
+(luvio.keyPrefix): 'learning'
+(luvio.ttl): 2592000000
+
+types:
+  LearningItemProgressRepresentation:
+    (luvio.ttl): 15000 # 15 seconds
+    (luvio.key):
+      learning_item_progress_id: id
+
+/connect:
+  /communities/{communityId}/learningItem/{learningItemId}/actions/evaluate:
+    post:
+      (luvio.adapter):
+        name: evaluateLearningItemForCommunity
+  /learningItem/{learningItemId}/actions/evaluate:
+    post:
+      (luvio.adapter):
+        name: evaluateLearningItem