@salesforce/lds-adapters-cdp-data-transform 0.1.0-dev1

package/src/raml/api.raml

@@ -0,0 +1,451 @@
+#%RAML 1.0
+securedBy:
+  - OAuth2
+title: Salesforce Connect API
+version: '62.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:
+  CdpUserRepresentation:
+    description: Represents a user
+    type: object
+    properties:
+      id:
+        description: The 18 character user ID
+        type: string
+      name?:
+        description: The name of the user
+        type: string
+      profilePhotoUrl?:
+        description: The Chatter profile photo of the user
+        type: string
+  CdpAssetBaseRepresentation:
+    description: Represents a base Asset
+    type: object
+    discriminator: id
+    properties:
+      createdBy?:
+        description: Created by
+        type: CdpUserRepresentation
+      createdDate?:
+        description: Created date
+        type: string
+      id:
+        description: The 18 character ID of the asset
+        type: string
+      label?:
+        description: Label of the asset
+        type: string
+      lastModifiedBy?:
+        description: Last modified by
+        type: CdpUserRepresentation
+      lastModifiedDate?:
+        description: Last modified date
+        type: string
+      name:
+        description: Name of the asset
+        type: string
+      namespace?:
+        description: Namespace of the asset
+        type: string
+      url?:
+        description: Url
+        type: string
+  TransformValidationIssueRepresentation:
+    description: Data transform validation issue representation
+    type: object
+    properties:
+      errorCode?:
+        description: Error code
+        type: string
+        enum:
+          - DataTransformLimitExceeded
+          - DloNameDoesNotExist
+          - DmoOutputValidationError
+          - InternalServiceError
+          - InvalidDataTransform
+          - InvalidDataTransformCapability
+          - InvalidDataTransformDataObjects
+          - InvalidDataTransformDefMapping
+          - InvalidDataTransformDefinition
+          - InvalidDataTransformRequest
+          - InvalidDataTransformTag
+          - InvalidInputPayload
+          - InvalidTargetDLO
+          - InvalidTargetDMO
+          - NameValidationError
+          - RestrictedDLO
+          - SourceDloNotFound
+          - SqlExpressionIsNull
+          - StreamingTransformCreateForbidden
+          - TagsValidationError
+          - TargetDLOIsRebuilding
+          - TargetDloNotFound
+          - TargetDmoNotFound
+          - TargetObjectNameNull
+          - TypeValidationError
+      errorMessage?:
+        description: Error message
+        type: string
+      errorSeverity:
+        description: Error severity
+        type: string
+        enum:
+          - Error
+          - Fatal
+          - Warning
+  DataObjectFieldRepresentation:
+    description: Data Object Field
+    type: object
+    properties:
+      isPrimaryKey:
+        description: Is Primary Key
+        type: boolean
+      keyQualifierField?:
+        description: Key Qualifier Field
+        type: string
+      label:
+        description: Label
+        type: string
+      name:
+        description: Name
+        type: string
+      type:
+        description: Type
+        type: string
+        enum:
+          - Boolean
+          - Currency
+          - Date
+          - DateOnly
+          - DateTime
+          - Email
+          - Number
+          - Percent
+          - Phone
+          - Text
+          - Url
+  DataObjectRepresentation:
+    description: Data Object
+    discriminator: type
+    type: CdpAssetBaseRepresentation
+    properties:
+      category?:
+        description: Category
+        type: string
+        enum:
+          - Engagement
+          - Other
+          - Profile
+      eventDateTimeFieldName?:
+        description: Event Date Time Field
+        type: string
+      fields?:
+        description: Fields
+        type: array
+        items:
+          type: DataObjectFieldRepresentation
+      recordModifiedFieldName?:
+        description: Record Modified Field
+        type: string
+      type?:
+        description: Type of Data Object
+        type: string
+        enum:
+          - CalculatedInsightObject
+          - DataLakeObject
+          - DataModelObject
+  DataTransformValidationRepresentation:
+    description: Data Transform validations and output data object Representation
+    type: object
+    properties:
+      issues?:
+        description: List of validation issues
+        type: array
+        items:
+          type: TransformValidationIssueRepresentation
+      outputDataObjects?:
+        description: Output representation of target object
+        type: array
+        items:
+          type: DataObjectRepresentation
+  BaseActionRepresentation:
+    description: Base Action Urls
+    type: object
+    properties:
+      refreshStatusAction:
+        description: Url to Refresh Status Action
+        type: string
+      retryAction:
+        description: Url to Retry Action
+        type: string
+  DataTransformDefinitionRepresentation:
+    description: Representation of batch data transform Node
+    discriminator: type
+    type: object
+    properties:
+      outputDataObjects:
+        description: Output Data Objects that are part of the data transform
+        type: array
+        items:
+          type: DataObjectRepresentation
+      type:
+        description: Definition type
+        type: string
+        enum:
+          - Dbt
+          - Sql
+          - Stl
+      version:
+        description: batch data transform version
+        type: string
+  CdpErrorRepresentation:
+    description: Error response representation
+    type: object
+    properties:
+      errorCode:
+        description: Error Code
+        type: string
+      message:
+        description: Message stating the reason for error, if any
+        type: string
+  ScheduleRepresentation:
+    description: Representation of Save Node
+    type: object
+    properties:
+      schedule:
+        description: Schedule cron expression
+        type: string
+      url:
+        description: Url to Data Transform schedule
+        type: string
+  DataTransformRepresentation:
+    description: A Data Prep batch data transform.
+    discriminatorValue: type
+    type: CdpAssetBaseRepresentation
+    properties:
+      actionUrls:
+        description: Actions available for the Data Transform
+        type: BaseActionRepresentation
+      capabilities?:
+        description: Requested capabilities on a data transform
+        type: object
+        properties:
+          //:
+            type: boolean
+      creationType:
+        description: The creation type of the data transform
+        type: string
+        enum:
+          - Custom
+          - System
+      dataSpaceName?:
+        description: Data space for the Data Transform
+        type: string
+      definition:
+        description: Data Transform definition
+        type: DataTransformDefinitionRepresentation
+      description?:
+        description: Description
+        type: string
+      lastRunDate?:
+        description: Last run date
+        type: string
+      lastRunErrorCode?:
+        description: Last run error code
+        type: CdpErrorRepresentation
+      lastRunErrorMessage?:
+        description: The error message for the last run of the transform. Set if last
+          run ended in failure/partial_failure
+        type: string
+      lastRunStatus?:
+        description: The last run status
+        type: string
+        enum:
+          - Canceled
+          - Failure
+          - InProgress
+          - None
+          - PartialFailure
+          - PartiallyCanceled
+          - Pending
+          - RebuildFailure
+          - RebuildPending
+          - RebuildSuccess
+          - Rebuilding
+          - SkippedNoChanges
+          - Success
+      schedule?:
+        description: The schedule cron expression current dataflow.
+        type: ScheduleRepresentation
+      status:
+        description: The status of the Data Transform
+        type: string
+        enum:
+          - Active
+          - Deleting
+          - Error
+          - Processing
+      tags?:
+        description: Tags of a data transforms - consumer specific metadata/event
+          info
+        type: object
+        properties:
+          //:
+            type: string
+      type:
+        description: Type of Data Transform
+        type: string
+        enum:
+          - Batch
+          - Streaming
+      version?:
+        description: Version
+        format: double
+        type: number
+  DataTransformInputRepresentation:
+    description: Input representation for creating a Data Transform
+    type: object
+    properties:
+      capabilities?:
+        description: A map of capabilities that can be requested for a data transform
+        type: object
+        properties:
+          //:
+            type: boolean
+      creationType:
+        description: The creation type of the data transform
+        type: string
+        enum:
+          - Custom
+          - System
+      currencyIsoCode?:
+        description: The currency iso code of the data transform
+        type: string
+      dataSpaceName?:
+        description: The data space the data transform belongs to
+        type: string
+      definition:
+        description: Definition of the data transform. Can be batch or streaming
+        type: object
+        properties:
+          //:
+            type: any
+      description?:
+        description: Description of the data transform
+        type: string
+      label?:
+        description: Label of the data transform
+        type: string
+      name?:
+        description: Name of the data transform
+        type: string
+      primarySource?:
+        description: The primary source for transform when there are table joins
+        type: string
+      tags?:
+        description: A JSON blob of tags for consumers to add metadata/event info
+          to the transforms they create
+        type: object
+        properties:
+          //:
+            type: string
+      type:
+        description: Type of data transform - streaming or batch
+        type: string
+        enum:
+          - Batch
+          - Streaming
+
+/ssot:
+  /data-transforms-validation:
+    post:
+      displayName: postCdpDataTransformValidation
+      description: Validate the data transform
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: DataTransformValidationRepresentation
+      body:
+        application/json:
+          type: DataTransformInputRepresentation
+          (oas-body-name): input
+  /data-transforms:
+    post:
+      displayName: postCdpDataTransformCollection
+      description: Create a new data transform
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: DataTransformRepresentation
+      queryParameters:
+        filterGroup:
+          type: string
+          required: false
+      body:
+        application/json:
+          type: DataTransformInputRepresentation
+          (oas-body-name): dataTransformObject
+  /data-transforms/{dataTransformNameOrId}:
+    get:
+      displayName: getCdpDataTransform
+      description: Get a data transform
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: DataTransformRepresentation
+      queryParameters:
+        filterGroup:
+          type: string
+          required: false
+    delete:
+      displayName: deleteCdpDataTransform
+      description: Delete a data transform
+      responses:
+        '200':
+          description: Success
+    put:
+      displayName: putCdpDataTransform
+      description: Put a data transform
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: DataTransformRepresentation
+      queryParameters:
+        filterGroup:
+          type: string
+          required: false
+      body:
+        application/json:
+          type: DataTransformInputRepresentation
+          (oas-body-name): dataTransformObject
+    uriParameters:
+      dataTransformNameOrId:
+        type: string

package/src/raml/luvio.raml

@@ -0,0 +1,48 @@
+#%RAML 1.0 Overlay
+extends: ./api.raml
+
+uses:
+  luvio: luvio://annotations.raml
+
+(luvio.keyPrefix): 'data-transform'
+(luvio.ttl): 3000000
+
+types:
+  TransformValidationIssueRepresentation:
+    (luvio.opaque): true
+  DataObjectFieldRepresentation:
+    (luvio.opaque): true
+  DataObjectRepresentation:
+    (luvio.opaque): true
+  DataTransformInputRepresentation:
+    (luvio.opaque): true
+  DataTransformValidationRepresentation:
+    (luvio.opaque): true
+  CdpAssetBaseRepresentation:
+    (luvio.key):
+      name: name
+
+/ssot:
+  /data-transforms-validation:
+    post:
+      (luvio.method): get
+      (luvio.adapter):
+        name: validateDataTransforms
+  /data-transforms:
+    post:
+      (luvio.adapter):
+        name: createDataTransform
+  /data-transforms/{dataTransformNameOrId}:
+    get:
+      (luvio.adapter):
+        name: getDataTransform
+      (luvio.key):
+        name: urlParams.dataTransformNameOrId
+    delete:
+      (luvio.adapter):
+        name: deleteDataTransform
+      (luvio.key):
+        name: urlParams.dataTransformNameOrId
+    put:
+      (luvio.adapter):
+        name: updateDataTransform