@salesforce/lds-adapters-platform-formula 0.1.0-dev1

package/src/raml/api.raml

@@ -0,0 +1,199 @@
+#%RAML 1.0
+securedBy:
+  - OAuth2
+title: Salesforce Connect API
+version: '60.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:
+  ExplainPromptInputRepresentation:
+    description: The input representation for a explain prompt
+    type: object
+    properties:
+      entityName:
+        description: Entity Name from the formula builder
+        type: string
+      formula:
+        description: Formula for which description needs to be generated
+        type: string
+      formulaType:
+        description: Formula Type
+        type: string
+        enum:
+          - CustomField
+          - DefaultValue
+          - Validation
+      returnType:
+        description: Return type of the formula
+        type: string
+        enum:
+          - Boolean
+          - Currency
+          - Date
+          - DateTime
+          - Number
+          - Percent
+          - Text
+          - Time
+  FixFormulaInputRepresentation:
+    description: The input representation for fixing a formula
+    type: object
+    properties:
+      entityName:
+        description: Entity Name from the formula builder
+        type: string
+      fieldName:
+        description: Field name if the formula is already saved
+        type: string
+        required: false
+      formula:
+        description: Formula which needs to be fixed
+        type: string
+      formulaType:
+        description: Formula Type
+        type: string
+        enum:
+          - CustomField
+          - DefaultValue
+          - Validation
+      returnType:
+        description: Return type of the formula
+        type: string
+        enum:
+          - Boolean
+          - Currency
+          - Date
+          - DateTime
+          - Number
+          - Percent
+          - Text
+          - Time
+  FixFormulaRepresentation:
+    description: Fix Formula
+    type: object
+    properties:
+      generationId:
+        description: Einstein generationId. If formula is valid, this should be null/empty
+        type: string
+      response:
+        description: Fixed formula if the formula is invalid. If formula is valid,
+          returns error response
+        type: string
+  FormulaExplanationRepresentation:
+    description: Formula Explanation
+    type: object
+    properties:
+      explanation:
+        description: Explanation of a formula
+        type: string
+      generationId:
+        description: Generation ID of response from open ai
+        type: string
+  FormulaValidationInputRepresentation:
+    description: The input representation for validating a formula
+    type: object
+    properties:
+      entityName:
+        description: Entity Name from the formula builder
+        type: string
+      fieldName:
+        description: Field name if the formula is already saved
+        type: string
+        required: false
+      formula:
+        description: Formula which needs to be validated
+        type: string
+      formulaType:
+        description: Formula Type
+        type: string
+        enum:
+          - CustomField
+          - DefaultValue
+          - Validation
+      returnType:
+        description: Return type of the formula
+        type: string
+        enum:
+          - Boolean
+          - Currency
+          - Date
+          - DateTime
+          - Number
+          - Percent
+          - Text
+          - Time
+  FormulaValidationRepresentation:
+    description: Formula Validation
+    type: object
+    properties:
+      isFormulaValid:
+        description: Returns if the formula is valid
+        type: boolean
+      message:
+        description: Failure message if validation was unsuccessful.  If validation
+          passes, this should be null/empty
+        type: string | nil
+        required: false
+/connect/formula:
+  /einstein:
+    /explain:
+      post:
+        displayName: postFormulaExplanation
+        description: Gets explanation for a salesforce formula
+        responses:
+          '200':
+            description: Success
+            body:
+              application/json:
+                type: FormulaExplanationRepresentation
+        body:
+          application/json:
+            type: ExplainPromptInputRepresentation
+            (oas-body-name): formulaExplainInput
+    /fix:
+      post:
+        displayName: postFormulaFix
+        description: Fixes a Salesforce formula
+        responses:
+          '200':
+            description: Success
+            body:
+              application/json:
+                type: FixFormulaRepresentation
+        body:
+          application/json:
+            type: FixFormulaInputRepresentation
+            (oas-body-name): formulaFixInput
+  /validate:
+    post:
+      displayName: postFormulaValidation
+      description: Validates a Salesforce formula
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: FormulaValidationRepresentation
+      body:
+        application/json:
+          type: FormulaValidationInputRepresentation
+          (oas-body-name): formulaValidateInput

package/src/raml/luvio.raml

@@ -0,0 +1,37 @@
+#%RAML 1.0 Overlay
+extends: ./api.raml
+
+uses:
+  luvio: luvio://annotations.raml
+
+(luvio.keyPrefix): 'Formula'
+
+# almost no-cache
+types:
+  FormulaExplanationRepresentation:
+    (luvio.ttl): 100
+    (luvio.key):
+      generationId: generationId
+  FormulaValidationRepresentation:
+    (luvio.ttl): 100
+    (luvio.key):
+      isFormulaValid: isFormulaValid
+  FixFormulaRepresentation:
+    (luvio.ttl): 100
+    (luvio.key):
+      generationId: generationId
+
+/connect/formula:
+  /einstein:
+    /explain:
+      post:
+        (luvio.adapter):
+          name: getExplanation
+    /fix:
+      post:
+        (luvio.adapter):
+          name: fixFormula
+  /validate:
+    post:
+      (luvio.adapter):
+        name: validateFormula