@salesforce/lds-adapters-cdp-semantic-engine 0.1.0-dev1

package/src/raml/api.raml

@@ -0,0 +1,170 @@
+#%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:
+  FormulaMetadataRepresentation:
+    description: Represents Formula Metadata
+    type: object
+    properties:
+      formulaCategory:
+        description: formulaCategory
+        type: string
+        enum:
+          - AggregationFunction
+          - DateAndTimeFunctions
+          - DateFunctions
+          - LogicalFunctions
+          - LogicalOperators
+          - MathFunctions
+          - MathOperators
+          - Nan
+          - NumberFunctions
+          - TextFunctions
+      formulaDescription:
+        description: formulaDescription
+        type: string
+      formulaName:
+        description: formulaName
+        type: string
+      formulaUsageExample:
+        description: formulaUsageExample
+        type: string
+  # TODO hand-rolled (removed semanticDataModel - deprecated)
+  SemanticFormulaMetadataAuthoringResponseRepresentation:
+    description: Represents Formula Metadata Authoring Response
+    type: object
+    properties:
+      supportedFormulaMetadataList:
+        description: supportedFormulaMetadataList
+        type: array
+        items:
+          type: FormulaMetadataRepresentation
+  SemanticQueryRequest:
+    description: Input representation for creating Semantic Query
+    type: object
+    properties:
+      cachingLevelRequest:
+        description: caching Level Request
+        type: string
+        required: false # TODO hand-rolled (required: false)
+      context:
+        description: context
+        type: object
+        required: false # TODO hand-rolled (required: false)
+        properties:
+          //:
+            type: any # TODO hand-rolled (changed from object with no properties)
+      dataspace:
+        description: Data space
+        type: string
+      groupId:
+        description: Group id
+        type: string
+        required: false # TODO hand-rolled (required: false)
+      # TODO hand-rolled (removed semanticContainer and semanticDataModel - deprecated)
+      semanticModel:
+        description: Set SemanticModel
+        type: any # TODO hand-rolled (changed from object with no properties)
+        required: false # TODO hand-rolled (required: false)
+      semanticModelApiName:
+        description: Set semanticModelApiName
+        type: string
+        required: false # TODO hand-rolled (required: false)
+      semanticModelId:
+        description: Set SemanticModelId
+        type: string
+        required: false # TODO hand-rolled (required: false)
+      source:
+        description: source
+        type: string
+      structuredSemanticQuery:
+        description: structuredSemanticQuery
+        type: any # TODO hand-rolled (changed from object with no properties)
+  SemanticQueryResponse:
+    description: Represents Semantic Engine query output
+    type: object
+    properties:
+      cacheLevel:
+        description: cacheLevel
+        type: string
+        required: false # TODO hand-rolled (required: false)
+      context:
+        description: context
+        type: object
+        required: false # TODO hand-rolled (required: false)
+        properties:
+          //:
+            type: any # TODO hand-rolled (changed from object with no properties)
+      errorMessage:
+        description: Error message
+        type: string
+        required: false # TODO hand-rolled (required: false)
+      queryResults:
+        description: Query Results
+        type: any # TODO hand-rolled (changed from object with no properties)
+      status:
+        description: Status ENUM
+        type: string
+/semantic-engine/gateway:
+  post:
+    displayName: postSemanticQuery
+    description: POST method for query Semantic Engine
+    responses:
+      '200':
+        description: Success
+        body:
+          application/json:
+            type: SemanticQueryResponse
+    body:
+      application/json:
+        type: SemanticQueryRequest
+        # TODO hand-rolled W-9271732 (removed required: false)
+        (oas-body-name): semanticQueryRequest
+/semantic-engine/gateway/non-interactive: # not exposed in LDS
+  post:
+    displayName: postSemanticNonInteractiveQuery
+    description: POST method for non interactive query Semantic Engine
+    responses:
+      '200':
+        description: Success
+        body:
+          application/json:
+            type: SemanticQueryResponse
+    body:
+      application/json:
+        type: SemanticQueryRequest
+        # TODO hand-rolled W-9271732 (removed required: false)
+        (oas-body-name): semanticNonInteractiveQueryRequest
+/ssot/semantic/models/formula-metadata: # not exposed in LDS
+  get:
+    displayName: getFormulaMetadata
+    description: GET method for Semantic Engine
+    responses:
+      '200':
+        description: Success
+        body:
+          application/json:
+            type: SemanticFormulaMetadataAuthoringResponseRepresentation

package/src/raml/luvio.raml

@@ -0,0 +1,24 @@
+#%RAML 1.0 Overlay
+extends: ./api.raml
+
+uses:
+  luvio: luvio://annotations.raml
+
+(luvio.keyPrefix): 'SemanticEngine'
+(luvio.ttl): 360000
+
+types:
+  SemanticQueryRequest:
+    (luvio.opaque): true
+  SemanticQueryResponse:
+    (luvio.opaque): true
+    (luvio.key):
+      # There is no unique key in our output representation. Without a key in the output representation, the RAML compilation is throwing an error
+      status: status
+      # Setting the cache entry to 100ms to ensure repeated replacement
+    (luvio.ttl): 100
+
+/semantic-engine/gateway:
+  post:
+    (luvio.adapter):
+      name: executeSemanticQuery