@salesforce/lds-adapters-service-serviceplan 1.295.0

package/sfdc/index.js

@@ -0,0 +1,457 @@
+/**
+ * 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, typeCheckConfig as typeCheckConfig$1 } 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 = 'servicePlan';
+
+const { isArray: ArrayIsArray } = Array;
+function equalsArray(a, b, equalsItem) {
+    const aLength = a.length;
+    const bLength = b.length;
+    if (aLength !== bLength) {
+        return false;
+    }
+    for (let i = 0; i < aLength; i++) {
+        if (equalsItem(a[i], b[i]) === false) {
+            return false;
+        }
+    }
+    return true;
+}
+function createLink(ref) {
+    return {
+        __ref: serializeStructuredKey(ref),
+    };
+}
+
+const VERSION$2 = "49ecad43516b5e32603856ae2fd27e4c";
+function validate$2(obj, path = 'ServicePlanStepExecutionSummaryRepresentation') {
+    const v_error = (() => {
+        if (typeof obj !== 'object' || ArrayIsArray(obj) || obj === null) {
+            return new TypeError('Expected "object" but received "' + typeof obj + '" (at "' + path + '")');
+        }
+        const obj_message = obj.message;
+        const path_message = path + '.message';
+        if (typeof obj_message !== 'string') {
+            return new TypeError('Expected "string" but received "' + typeof obj_message + '" (at "' + path_message + '")');
+        }
+        const obj_status = obj.status;
+        const path_status = path + '.status';
+        if (typeof obj_status !== 'string') {
+            return new TypeError('Expected "string" but received "' + typeof obj_status + '" (at "' + path_status + '")');
+        }
+    })();
+    return v_error === undefined ? null : v_error;
+}
+const select$3 = function ServicePlanStepExecutionSummaryRepresentationSelect() {
+    return {
+        kind: 'Fragment',
+        version: VERSION$2,
+        private: [],
+        selections: [
+            {
+                name: 'message',
+                kind: 'Scalar'
+            },
+            {
+                name: 'status',
+                kind: 'Scalar'
+            }
+        ]
+    };
+};
+function equals$2(existing, incoming) {
+    const existing_message = existing.message;
+    const incoming_message = incoming.message;
+    if (!(existing_message === incoming_message)) {
+        return false;
+    }
+    const existing_status = existing.status;
+    const incoming_status = incoming.status;
+    if (!(existing_status === incoming_status)) {
+        return false;
+    }
+    return true;
+}
+
+const VERSION$1 = "0786fbab705610a53f80f4db85b8cfa3";
+function validate$1(obj, path = 'ServicePlanExecutionSummaryRepresentation') {
+    const v_error = (() => {
+        if (typeof obj !== 'object' || ArrayIsArray(obj) || obj === null) {
+            return new TypeError('Expected "object" but received "' + typeof obj + '" (at "' + path + '")');
+        }
+        const obj_executedDate = obj.executedDate;
+        const path_executedDate = path + '.executedDate';
+        if (typeof obj_executedDate !== 'string') {
+            return new TypeError('Expected "string" but received "' + typeof obj_executedDate + '" (at "' + path_executedDate + '")');
+        }
+        const obj_status = obj.status;
+        const path_status = path + '.status';
+        if (typeof obj_status !== 'string') {
+            return new TypeError('Expected "string" but received "' + typeof obj_status + '" (at "' + path_status + '")');
+        }
+        const obj_steps = obj.steps;
+        const path_steps = path + '.steps';
+        if (!ArrayIsArray(obj_steps)) {
+            return new TypeError('Expected "array" but received "' + typeof obj_steps + '" (at "' + path_steps + '")');
+        }
+        for (let i = 0; i < obj_steps.length; i++) {
+            const obj_steps_item = obj_steps[i];
+            const path_steps_item = path_steps + '[' + i + ']';
+            const referencepath_steps_itemValidationError = validate$2(obj_steps_item, path_steps_item);
+            if (referencepath_steps_itemValidationError !== null) {
+                let message = 'Object doesn\'t match ServicePlanStepExecutionSummaryRepresentation (at "' + path_steps_item + '")\n';
+                message += referencepath_steps_itemValidationError.message.split('\n').map((line) => '\t' + line).join('\n');
+                return new TypeError(message);
+            }
+        }
+    })();
+    return v_error === undefined ? null : v_error;
+}
+const select$2 = function ServicePlanExecutionSummaryRepresentationSelect() {
+    const { selections: ServicePlanStepExecutionSummaryRepresentation__selections, opaque: ServicePlanStepExecutionSummaryRepresentation__opaque, } = select$3();
+    return {
+        kind: 'Fragment',
+        version: VERSION$1,
+        private: [],
+        selections: [
+            {
+                name: 'executedDate',
+                kind: 'Scalar'
+            },
+            {
+                name: 'status',
+                kind: 'Scalar'
+            },
+            {
+                name: 'steps',
+                kind: 'Object',
+                plural: true,
+                selections: ServicePlanStepExecutionSummaryRepresentation__selections
+            }
+        ]
+    };
+};
+function equals$1(existing, incoming) {
+    const existing_executedDate = existing.executedDate;
+    const incoming_executedDate = incoming.executedDate;
+    if (!(existing_executedDate === incoming_executedDate)) {
+        return false;
+    }
+    const existing_status = existing.status;
+    const incoming_status = incoming.status;
+    if (!(existing_status === incoming_status)) {
+        return false;
+    }
+    const existing_steps = existing.steps;
+    const incoming_steps = incoming.steps;
+    const equals_steps_items = equalsArray(existing_steps, incoming_steps, (existing_steps_item, incoming_steps_item) => {
+        if (!(equals$2(existing_steps_item, incoming_steps_item))) {
+            return false;
+        }
+    });
+    if (equals_steps_items === false) {
+        return false;
+    }
+    return true;
+}
+
+const VERSION = "0b6d5d82884b30861149227a18c79e34";
+function validate(obj, path = 'ServicePlanExecutionOutputRepresentation') {
+    const v_error = (() => {
+        if (typeof obj !== 'object' || ArrayIsArray(obj) || obj === null) {
+            return new TypeError('Expected "object" but received "' + typeof obj + '" (at "' + path + '")');
+        }
+        const obj_reason = obj.reason;
+        const path_reason = path + '.reason';
+        if (typeof obj_reason !== 'string') {
+            return new TypeError('Expected "string" but received "' + typeof obj_reason + '" (at "' + path_reason + '")');
+        }
+        const obj_reasonDetails = obj.reasonDetails;
+        const path_reasonDetails = path + '.reasonDetails';
+        if (typeof obj_reasonDetails !== 'string') {
+            return new TypeError('Expected "string" but received "' + typeof obj_reasonDetails + '" (at "' + path_reasonDetails + '")');
+        }
+        const obj_servicePlan = obj.servicePlan;
+        const path_servicePlan = path + '.servicePlan';
+        const referencepath_servicePlanValidationError = validate$1(obj_servicePlan, path_servicePlan);
+        if (referencepath_servicePlanValidationError !== null) {
+            let message = 'Object doesn\'t match ServicePlanExecutionSummaryRepresentation (at "' + path_servicePlan + '")\n';
+            message += referencepath_servicePlanValidationError.message.split('\n').map((line) => '\t' + line).join('\n');
+            return new TypeError(message);
+        }
+        const obj_status = obj.status;
+        const path_status = path + '.status';
+        if (typeof obj_status !== 'string') {
+            return new TypeError('Expected "string" but received "' + typeof obj_status + '" (at "' + path_status + '")');
+        }
+    })();
+    return v_error === undefined ? null : v_error;
+}
+const RepresentationType = 'ServicePlanExecutionOutputRepresentation';
+function keyBuilder(luvio, config) {
+    return keyPrefix + '::' + RepresentationType + ':' + config.id;
+}
+function keyBuilderFromType(luvio, object) {
+    const keyParams = {
+        id: object.reason
+    };
+    return keyBuilder(luvio, keyParams);
+}
+function normalize(input, existing, path, luvio, store, timestamp) {
+    return input;
+}
+const select$1 = function ServicePlanExecutionOutputRepresentationSelect() {
+    const { selections: ServicePlanExecutionSummaryRepresentation__selections, opaque: ServicePlanExecutionSummaryRepresentation__opaque, } = select$2();
+    return {
+        kind: 'Fragment',
+        version: VERSION,
+        private: [],
+        selections: [
+            {
+                name: 'reason',
+                kind: 'Scalar'
+            },
+            {
+                name: 'reasonDetails',
+                kind: 'Scalar'
+            },
+            {
+                name: 'servicePlan',
+                kind: 'Object',
+                selections: ServicePlanExecutionSummaryRepresentation__selections
+            },
+            {
+                name: 'status',
+                kind: 'Scalar'
+            }
+        ]
+    };
+};
+function equals(existing, incoming) {
+    const existing_reason = existing.reason;
+    const incoming_reason = incoming.reason;
+    if (!(existing_reason === incoming_reason)) {
+        return false;
+    }
+    const existing_reasonDetails = existing.reasonDetails;
+    const incoming_reasonDetails = incoming.reasonDetails;
+    if (!(existing_reasonDetails === incoming_reasonDetails)) {
+        return false;
+    }
+    const existing_status = existing.status;
+    const incoming_status = incoming.status;
+    if (!(existing_status === incoming_status)) {
+        return false;
+    }
+    const existing_servicePlan = existing.servicePlan;
+    const incoming_servicePlan = incoming.servicePlan;
+    if (!(equals$1(existing_servicePlan, incoming_servicePlan))) {
+        return false;
+    }
+    return true;
+}
+const ingest = function ServicePlanExecutionOutputRepresentationIngest(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 = path.ttl !== undefined ? path.ttl : 500;
+    ingestShape(input, path, luvio, store, timestamp, ttlToUse, key, normalize, "servicePlan", 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/v62.0',
+        basePath: '/connect/service-plan/execute/' + config.urlParams.generatedPlanId + '',
+        method: 'put',
+        body: config.body,
+        urlParams: config.urlParams,
+        queryParams: {},
+        headers,
+        priority: 'normal',
+    };
+}
+
+const adapterName = 'executeServicePlan';
+const executeServicePlan_ConfigPropertyMetadata = [
+    generateParamConfigMetadata('generatedPlanId', true, 0 /* UrlParameter */, 0 /* String */),
+    generateParamConfigMetadata('intent', true, 2 /* Body */, 0 /* String */),
+    generateParamConfigMetadata('planId', true, 2 /* Body */, 0 /* String */),
+    generateParamConfigMetadata('sessionId', true, 2 /* Body */, 0 /* String */),
+];
+const executeServicePlan_ConfigPropertyNames = /*#__PURE__*/ buildAdapterValidationConfig(adapterName, executeServicePlan_ConfigPropertyMetadata);
+const createResourceParams = /*#__PURE__*/ createResourceParams$1(executeServicePlan_ConfigPropertyMetadata);
+function typeCheckConfig(untrustedConfig) {
+    const config = {};
+    typeCheckConfig$1(untrustedConfig, config, executeServicePlan_ConfigPropertyMetadata);
+    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 executeServicePlanAdapterFactory = (luvio) => {
+    return function executeServicePlan(untrustedConfig) {
+        const config = validateAdapterConfig(untrustedConfig, executeServicePlan_ConfigPropertyNames);
+        // Invalid or incomplete config
+        if (config === null) {
+            throw new Error('Invalid config for "executeServicePlan"');
+        }
+        return buildNetworkSnapshot(luvio, config);
+    };
+};
+
+let executeServicePlan;
+// Notify Update Available
+function bindExportsTo(luvio) {
+    // LDS Adapters
+    function unwrapSnapshotData(factory) {
+        const adapter = factory(luvio);
+        return (config) => adapter(config).then((snapshot) => snapshot.data);
+    }
+    return {
+        executeServicePlan: unwrapSnapshotData(executeServicePlanAdapterFactory),
+        // Imperative GET Adapters
+        // Notify Update Availables
+    };
+}
+withDefaultLuvio((luvio) => {
+    ({ executeServicePlan } = bindExportsTo(luvio));
+});
+
+export { executeServicePlan };
+// version: 1.295.0-e85f207c7

package/src/raml/api.raml

@@ -0,0 +1,233 @@
+#%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:
+  ServicePlanExecutionInputRepresentation:
+    description: Represents a generated service plan input context required for service
+      plan execution
+    type: object
+    properties:
+      intent:
+        description: Intent
+        type: string
+      planId:
+        description: Copilot planId
+        type: string
+      sessionId:
+        description: Copilot SessionId
+        type: string
+  ServicePlanExecutionOutputRepresentation:
+    description: Represent the service plan execution result
+    type: object
+    properties:
+      reason:
+        description: The reason of the service plan execution request job failure
+        type: string
+      reasonDetails:
+        description: The details of the service plan execution request job failure
+        type: string
+      servicePlan:
+        description: The generated service plan
+        type: ServicePlanExecutionSummaryRepresentation
+      status:
+        description: The Status of the service plan execution request job
+        type: string
+  ServicePlanExecutionSummaryRepresentation:
+    description: Represents the execution summary of a Service Plan
+    type: object # TODO Hand-rolled W-15545227
+    properties:
+      executedDate:
+        description: Executed Date
+        type: string
+      status:
+        description: Service Plan Status
+        type: string
+      steps:
+        description: Executed Steps
+        type: array
+        items:
+          type: ServicePlanStepExecutionSummaryRepresentation
+  ServicePlanGenerationInputParamRepresentation:
+    description: Represents a request for generating a service plan
+    type: object
+    properties:
+      additionalContext:
+        description: Additional context for the plan generation request
+        type: object
+        properties:
+          //:
+            type: string
+      mode:
+        description: Plan generation mode
+        type: string
+        enum:
+          - NoSave
+          - Save
+      source:
+        description: Origin for the plan generation request
+        type: string
+  ServicePlanGenerationSessionInformationOutputRepresentation:
+    description: Represent the session information of a Service Plan Generation
+    type: object
+    properties:
+      botId:
+        description: Bot id used for invoking the planner service
+        type: string
+      botVersionId:
+        description: Bot id used for invoking the planner service
+        type: string
+      clientFeatureId:
+        description: Client Feature Id used for feedback on the plan generation
+        type: string
+      generationsId:
+        description: Generations Id used for feedback on the plan generation
+        type: string
+      planId:
+        description: Plan id used for plan execution or plan modification
+        type: string
+      sessionId:
+        description: Session id used for plan execution or plan modification
+        type: string
+  ServicePlanOutputRepresentation:
+    description: Represent the generated Service Plan
+    type: object
+    properties:
+      copilot:
+        description: The copilot used to generate the service plan
+        type: string
+      createdDate:
+        description: The created date of the service plan
+        type: string
+      generatedPlanId:
+        description: The Id of the plan record
+        type: string
+      rawPlan:
+        description: The raw plan generated by the copilot
+        type: string
+      sessionInformation:
+        description: The session information related to the copilot generating the
+          plan
+        type: ServicePlanGenerationSessionInformationOutputRepresentation
+      steps:
+        description: The steps of the service plan
+        type: array
+        items:
+          type: ServicePlanStepRepresentation
+      topic:
+        description: The topic identified when generating the service plan
+        type: string
+      topicDescription:
+        description: The description of topic identified when generating the service
+          plan
+        type: string
+  ServicePlanRepresentation:
+    description: Service Plan representation
+    type: object
+    properties:
+      copilot:
+        description: Copilot
+        type: string
+      generatedPlanId:
+        description: Plan Id
+        type: string
+      sessionInformation:
+        description: Session details
+        type: ServicePlanGenerationSessionInformationOutputRepresentation
+      topic:
+        description: Topic Name
+        type: string
+      topicDescription:
+        description: Topic Description
+        type: string
+  ServicePlanStepAttributeRepresentation:
+    description: Represent an attribute in a step of a generated Service Plan
+    type: object
+    properties:
+      name:
+        description: The name of the step attribute
+        type: string
+      value:
+        description: The value of the step attribute
+        type: string
+  ServicePlanStepExecutionSummaryRepresentation:
+    description: Represents the execution summary of a Service Plan Step
+    type: object # TODO Hand-rolled W-15545227
+    properties:
+      message:
+        description: Message
+        type: string
+      status:
+        description: Status
+        type: string
+  ServicePlanStepRepresentation:
+    description: Represent a step of a generated Service Plan
+    type: object
+    properties:
+      description:
+        description: The description of the service plan step
+        type: string
+      functionName:
+        description: The name of the service plan step
+        type: string
+      inputs:
+        description: The list of inputs of the service plan step
+        type: array
+        items:
+          type: ServicePlanStepAttributeRepresentation
+      outputCollection:
+        description: The output collection of the service plan step
+        type: string
+      outputVariable:
+        description: The output variable of the service plan step
+        type: string
+/connect/service-plan:
+  /execute/{generatedPlanId}:
+    get:
+      displayName: getServicePlanExecution
+      description: Returns Service Plan execution summary
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: ServicePlanExecutionOutputRepresentation
+    put:
+      displayName: putServicePlanExecution
+      description: Executes a Service Plan
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: ServicePlanExecutionOutputRepresentation
+      body:
+        application/json:
+          type: ServicePlanExecutionInputRepresentation
+          (oas-body-name): servicePlanInputRepresentation
+    uriParameters:
+      generatedPlanId:
+        type: string
+        required: true