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

package/src/raml/api.raml

@@ -0,0 +1,210 @@
+#%RAML 1.0
+# TODO: This file was manually constructed; we need to switch to generated copy. See W-9770842.
+securedBy:
+  - OAuth2
+title: Flow Adapter API
+version: '53.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:
+  FlowRuntimeRunFlowRepresentation:
+    type: object
+    properties:
+      flowDevName:
+        type: string
+        required: true
+      flowVersionId:
+        type: string
+        required: false
+      arguments:
+        type: string
+        required: false
+      enableTrace:
+        type: boolean
+        required: false
+      enableRollbackMode:
+        type: boolean
+        required: false
+      useLatestSubflow:
+        type: boolean
+        required: false
+      debugAsUserId:
+        type: string
+        required: false
+      isBuilderDebug:
+        type: boolean
+        required: false
+
+  FlowRuntimeHashbagRepresentation:
+    type: object
+    properties:
+      //:
+        type: any
+
+  FlowRuntimeNavigationFieldValue:
+    type: object
+    properties:
+      field:
+        type: string
+        required: true
+      isVisible:
+        type: boolean | nil
+        required: false
+      value:
+        type: any
+        required: false
+
+  FlowRuntimeNavigateFlowWrapperRepresentation:
+    type: object
+    properties:
+      request:
+        type: FlowRuntimeNavigateFlowRepresentation
+        required: true
+
+  FlowRuntimeNavigateFlowRepresentation:
+    type: object
+    properties:
+      action:
+        type: string
+        required: true
+      serializedState:
+        type: string
+        required: true
+      fields:
+        type: array
+        required: false
+        items:
+          type: FlowRuntimeNavigationFieldValue
+      uiElementVisited:
+        type: boolean
+        required: false
+      enableTrace:
+        type: boolean
+        required: false
+      lcErrors:
+        type: FlowRuntimeHashbagRepresentation
+        required: false
+      isBuilderDebug:
+        type: boolean
+        required: false
+
+  FlowRuntimeResumeFlowRepresentation:
+    type: object
+    properties:
+      pausedInterviewId:
+        type: string
+        required: true
+
+  FlowRuntimeNavigationResult:
+    type: object
+    properties:
+      //:
+        type: any
+
+  FlowRuntimeResponseRepresentation:
+    type: object
+    properties:
+      error:
+        type: any
+        required: false
+      response:
+        type: FlowRuntimeNavigationResult | nil
+        required: false
+
+  FlowRuntimeInvokeActionInputWrapperRepresentation:
+    type: object
+    properties:
+      request:
+        type: FlowRuntimeInvokeActionInputRepresentation
+        required: true
+
+  FlowRuntimeInvokeActionInputRepresentation:
+    description: Invocable actions input values representation
+    type: object
+    properties:
+      actionName:
+        description: ActionName
+        type: string
+      actionType:
+        description: ActionType
+        type: string
+      flowVersionId:
+        description: FlowVersionId
+        type: string
+      inputValues:
+        description: InputValues
+        type: object
+        properties:
+          //:
+            type: any
+
+/connect/interaction/runtime/startFlow:
+  post:
+    responses:
+      '200':
+        description: Success
+        body:
+          application/json:
+            type: FlowRuntimeResponseRepresentation
+    body:
+      application/json:
+        type: FlowRuntimeRunFlowRepresentation
+
+/connect/interaction/runtime/navigateFlow:
+  post:
+    responses:
+      '200':
+        description: Success
+        body:
+          application/json:
+            type: FlowRuntimeResponseRepresentation
+    body:
+      application/json:
+        type: FlowRuntimeNavigateFlowWrapperRepresentation
+        (oas-body-name): request
+
+/connect/interaction/runtime/resumeFlow:
+  post:
+    responses:
+      '200':
+        description: Success
+        body:
+          application/json:
+            type: FlowRuntimeResponseRepresentation
+    body:
+      application/json:
+        type: FlowRuntimeResumeFlowRepresentation
+
+/connect/interaction/runtime/invokeAction:
+  post:
+    displayName: postFlowRuntimeInvokeAction
+    description: Invokes an invocable action
+    responses:
+      '200':
+        description: Success
+        body:
+          application/json:
+            type: FlowRuntimeResponseRepresentation
+    body:
+      application/json:
+        type: FlowRuntimeInvokeActionInputWrapperRepresentation
+        (oas-body-name): request

package/src/raml/luvio.raml

@@ -0,0 +1,44 @@
+#%RAML 1.0 Overlay
+extends: ./api.raml
+
+uses:
+  luvio: luvio://annotations.raml
+
+(luvio.keyPrefix): 'FlowRuntime'
+(luvio.ttl): 2592000000
+
+types:
+  FlowRuntimeResponseRepresentation:
+    (luvio.opaque): true
+
+  FlowRuntimeInvokeActionInputRepresentation:
+    (luvio.ttl): 500
+    (luvio.opaque): true
+
+  FlowRuntimeInvokeActionOutputRepresentation:
+    (luvio.ttl): 500
+    (luvio.opaque): true
+
+/connect/interaction/runtime/startFlow:
+  post:
+    (luvio.adapter):
+      name: startFlow
+    (luvio.method): get
+
+/connect/interaction/runtime/navigateFlow:
+  post:
+    (luvio.adapter):
+      name: navigateFlow
+    (luvio.method): get
+
+/connect/interaction/runtime/resumeFlow:
+  post:
+    (luvio.adapter):
+      name: resumeFlow
+    (luvio.method): get
+
+/connect/interaction/runtime/invokeAction:
+  post:
+    (luvio.adapter):
+      name: invokeAction
+    (luvio.method): get