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

package/src/raml/api.raml

@@ -0,0 +1,183 @@
+#%RAML 1.0
+securedBy:
+  - OAuth2
+title: Salesforce Connect API
+version: '61.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:
+  FeatureValidationAccessInfoRepresentation:
+    description: Represents the access info of entities and fields
+    type: object
+    properties:
+      accessLevel:
+        description: the level of access that needs to be validated
+        type: string
+        enum:
+          - Create
+          - Delete
+          - Edit
+          - Read
+      apiName:
+        description: api name of the entity or field
+        type: string
+      hasAccess:
+        description: validates the access level of the entity or field
+        type: boolean
+      type:
+        description: specifies if the given name is an entity or a field
+        type: string
+  FeatureValidationFieldValuesRepresentation:
+    description: Select fields that were validated as part of use-case implementation.
+    type: object
+    properties:
+      fieldName:
+        description: Field name
+        type: string
+      fieldValue:
+        description: Field value
+        type: string
+      message:
+        description: 'Message related to the field. Example: Missing fls permissions.'
+        type: string
+      messageType:
+        description: 'Describes the type of the message. Example: Error, Warning or
+          Info.'
+        type: string
+        enum:
+          - Error
+          - Info
+          - Warning
+      required:
+        description: true if field is required. false otherwise.
+        type: boolean
+  FeatureValidationInputDetailsRepresentation:
+    description: |-
+      Holds BPO recordUsage and bpo recordId. example: {"recordUsage": "Facility",
+            "bpoRecordId": "0bSxx0000000005EAA"}
+    type: object
+    properties:
+      bpoRecordId:
+        description: Input BPO record id
+        type: string
+      recordUsage:
+        description: "How record is used in the feature. Example value: Patient. Note:
+          Account is a bpo name but Patient is a business usage of the patient's
+          account"
+        type: string
+      scenarioName:
+        description: used for access checks, determines the scenario or the flow for
+          the given feature
+        type: string
+  FeatureValidationInputRepresentation:
+    description: Feature validation input
+    type: object
+    properties:
+      featureValidationInputDetails:
+        description: Holds record usage and bpo recordId.
+        type: array
+        items:
+          type: object
+      useCase:
+        description: 'Use-case to validate the data. Example: HealthCloudIAM needs
+          user to pass on practitioner id, facility id, patient id, and worktype id
+          in featureValidationInputDetails.'
+        type: string
+        enum:
+          - HealthCloudIAM
+          - HealthCloudIAMAccessChecks
+  # TODO [W-9807143]: Hand rolled due to issue in Generated RAML Gaps (https://salesforce.quip.com/NxVhAkxL6RTW#dGQACAxyxIv)
+  FeatureValidationWrapperInputRepresentation:
+    description: wrapper of FeatureValidationInputRepresentation
+    type: object
+    properties:
+      FeatureValidationData:
+        description: Input representation for FeatureValidationInputRepresentation
+        type: FeatureValidationInputRepresentation
+  FeatureValidationOutputDetailsRepresentation:
+    description: Holds BPO name, bpoRecordId, select fields from the bpo and related
+      error message.
+    type: object
+    properties:
+      bpoName:
+        description: BPO name
+        type: string
+      bpoRecordId:
+        description: BPO record id
+        type: string
+      featureValidationAccessInfo:
+        description: 'Access check results for the fields/entities '
+        type: array
+        items:
+          type: FeatureValidationAccessInfoRepresentation
+      featureValidationFieldValues:
+        description: Select fields that were validated as part of use-case implementation.
+        type: array
+        items:
+          type: FeatureValidationFieldValuesRepresentation
+      message:
+        description: 'Message related to the bpo. Example: Invalid record Id.'
+        type: string
+      messageType:
+        description: 'Describes the type of the message. Example: Error, Warning or
+          Info.'
+        type: string
+        enum:
+          - Error
+          - Info
+          - Warning
+  FeatureValidationOutputRepresentation:
+    description: FeatureValidation output.
+    type: object
+    properties:
+      errorMessage:
+        description: Get FeatureValidation error messages
+        type: string
+        required: false
+      featureValidationOutputDetails:
+        description: Holds BPO name, bpoRecordId, select fields from the bpo and related
+          error message.
+        type: array
+        items:
+          type: FeatureValidationOutputDetailsRepresentation
+      isSuccess:
+        description: Get FeatureValidation success flag
+        type: boolean
+/connect:
+  /industries:
+    /feature-validation:
+      post:
+        displayName: postFeatureValidation
+        description: |-
+          Run a feature validation to validate data setup for a given use-case and respective record Ids. Supported use cases are @ FeatureValidationUseCaseEnum.
+           To add new usecase, add your implementation to this post method and FeatureValidationUseCaseEnum. Populate FeatureValidationOutputRepresentation with the validated BPOs.
+        responses:
+          '200':
+            description: Success
+            body:
+              application/json:
+                type: FeatureValidationOutputRepresentation
+        body:
+          application/json:
+            type: FeatureValidationWrapperInputRepresentation
+            # TODO [W-12609182]: Hand Rolled Change that removed 'required: false' since the 'required' property is not allowed in RAML 1.0
+            (oas-body-name): FeatureValidationData

package/src/raml/luvio.raml

@@ -0,0 +1,17 @@
+#%RAML 1.0 Overlay
+extends: ./api.raml
+
+uses:
+  luvio: luvio://annotations.raml
+
+(luvio.keyPrefix): 'featurevalidation'
+types:
+  FeatureValidationOutputRepresentation:
+    (luvio.key):
+      isSuccess: isSuccess
+    (luvio.ttl): 300
+
+/connect/industries/feature-validation:
+  post:
+    (luvio.adapter):
+      name: featureValidation