@salesforce/lds-adapters-platform-lightning-types 0.1.0-dev1

package/src/raml/api.raml

@@ -0,0 +1,561 @@
+#%RAML 1.0
+securedBy:
+  - OAuth2
+title: Salesforce Connect API
+version: '63.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:
+  LightningTypeDetailRepresentation:
+    description: Represents the full/detailed information about a Lightning Type.
+    type: object
+    properties:
+      description:
+        required: false # Hand-rolled fix for validation failure during runtime
+        description: The description of the Type that was given in its schema.json.
+        type: string | nil #Hand-rolled issue #1 in (https://salesforce.quip.com/NxVhAkxL6RTW)
+      developerName:
+        description: The developer name (aka apiName) of the Type.
+        type: string
+      editorConfig:
+        required: false
+        description: The editor configuration for the specified target.
+        type: any
+      id:
+        description: The 18-char String ID of the Type. This is returned for the DB-Based
+          (Custom) Types only.
+        type: string | nil #Hand-rolled issue #1 in (https://salesforce.quip.com/NxVhAkxL6RTW)
+        required: false
+      namespacePrefix:
+        description: The namespace prefix that is associated with the Type. Refer
+          to a Type using the namespacePrefix__developerName notation (aka fullyQualifiedName).
+        type: string
+      rendererConfig:
+        required: false
+        description: The renderer configuration for the specified target.
+        type: any
+      schema:
+        description: The JSON Schema definition (schema.json) of the Type
+        type: object
+        properties:
+          //:
+            type: any
+      title:
+        description: The title of the Type that was given in its schema.json.
+        type: string | nil #Hand-rolled issue #1 in (https://salesforce.quip.com/NxVhAkxL6RTW)
+        required: false
+  LightningTypeCollectionRepresentation:
+    description: Represents a list/collection of Lightning Types.
+    type: object
+    properties:
+      count:
+        description: The number of Types returned.
+        type: integer
+      currentPageUrl:
+        description: URL to this page of the Types.
+        type: string | nil #Hand-rolled issue #1 in (https://salesforce.quip.com/NxVhAkxL6RTW)
+      lightningTypes:
+        description: The list of Lightning Types ordered alphabetically by title.
+        type: array
+        items:
+          type: LightningTypeSummaryRepresentation
+      nextPageUrl:
+        description: URL to the next page of the Types.
+        type: string | nil #Hand-rolled issue #1 in (https://salesforce.quip.com/NxVhAkxL6RTW)
+        required: false # Hand-rolled fix for validation failure during runtime
+      previousPageUrl:
+        description: URL to the previous page of the Types.
+        type: string | nil #Hand-rolled issue #1 in (https://salesforce.quip.com/NxVhAkxL6RTW)
+        required: false # Hand-rolled fix for validation failure during runtime
+  LightningTypeSummaryRepresentation:
+    description: Summary Representation of a Lightning type.A collection of this is
+      returned in the list endpoints.
+    type: object
+    properties:
+      description:
+        description: The description of the Type that was given in its schema.json.
+        type: string | nil #Hand-rolled issue #1 in (https://salesforce.quip.com/NxVhAkxL6RTW)
+        required: false # Hand-rolled fix for validation failure during runtime
+      detailUrl:
+        description: The individual detail resource URL to get the full/detailed information
+          about the Type.
+        type: string | nil #Hand-rolled issue #1 in (https://salesforce.quip.com/NxVhAkxL6RTW)
+        required: false # Hand-rolled fix for validation failure during runtime
+      developerName:
+        description: The developer name (aka apiName) of the Type.
+        type: string | nil #Hand-rolled issue #1 in (https://salesforce.quip.com/NxVhAkxL6RTW)
+      id:
+        description: The 18-char String ID of the Type. This is returned for the DB-Based
+          (Custom) Types only.
+        type: string | nil #Hand-rolled issue #1 in (https://salesforce.quip.com/NxVhAkxL6RTW)
+        required: false # Hand-rolled fix for validation failure during runtime
+      namespacePrefix:
+        description: The namespace prefix that is associated with the Type. Refer
+          to a Type using the namespacePrefix__developerName notation (aka fullyQualifiedName).
+        type: string | nil #Hand-rolled issue #1 in (https://salesforce.quip.com/NxVhAkxL6RTW)
+      title:
+        description: The title of the Type that was given in its schema.json.
+        type: string | nil #Hand-rolled issue #1 in (https://salesforce.quip.com/NxVhAkxL6RTW)
+        required: false # Hand-rolled fix for validation failure during runtime
+  LightningModelTypesCollectionRepresentation:
+    description: Represents a list/collection of Types.
+    type: object
+    properties:
+      types:
+        description: The list of Types ordered alphabetically by title.
+        type: array
+        items:
+          type: LightningModelTypesRepresentation
+  LightningModelTypesRepresentation:
+    description: Represents the details about Types.
+    type: object
+    properties:
+      description:
+        description: The description of the Type that was given in its schema.json.
+        type: string
+        required: false # Hand-rolled fix for validation failure during runtime
+      descriptor:
+        description: The type descriptor of the Type that was given in query params.
+        type: string
+      editorConfig:
+        description: The editor configuration for the specified target.
+        type: any
+        required: false # Hand-rolled fix for validation failure during runtime
+      developerName:
+        description: The developer name (aka apiName) of the Type.
+        type: string
+      errorDetails:
+        description: Lightning Model Types Error Details
+        type: LightningModelTypesErrorRepresentation
+        required: false # Hand-rolled fix for validation failure during runtime
+      id:
+        description: The 18-char String ID of the Type. This is returned for the DB-Based (Custom) Types only.
+        type: string
+        required: false # Hand-rolled fix for validation failure during runtime
+      namespacePrefix:
+        description: The namespace prefix that is associated with the Type. Refer to a Type using the namespacePrefix__developerName notation (aka fullyQualifiedName).
+        type: string
+      rendererConfig:
+        description: The renderer configuration for the specified target.
+        type: any
+        required: false # Hand-rolled fix for validation failure during runtime
+      schema:
+        description: The JSON Schema definition (schema.json) of the Type
+        type: any
+        required: false # Hand-rolled fix for validation failure during runtime
+      title:
+        description: The title of the Type that was given in its schema.json.
+        type: string
+        required: false # Hand-rolled fix for validation failure during runtimes
+      sourceDescriptor:
+        description: The source descriptor of the Type that was given in query params.
+        type: any
+        required: false # Hand-rolled fix for validation failure during runtimes
+  LightningModelSchemaConfigInputRepresentation:
+    type: object
+    description: Input Representation for Lightning Model type schema configuration
+    properties:
+      filterConfig:
+        description: Filter configuration for schema
+        type: LightningModelFilterConfigInputRepresentation
+        required: false # Hand-rolled fix for validation failure during runtime
+      subSchemaDefinitions:
+        description: Boolean property if sub-schema should be included
+        type: boolean
+        required: false # Hand-rolled fix for validation failure during runtime
+  LightningModelSourceDescriptorInputRepresentation:
+    type: object
+    description: Input Representation for Lightning Model source descriptor
+    properties:
+      descriptor:
+        description: Source descriptor
+        type: string
+        required: false # Hand-rolled fix for validation failure during runtime
+      propertyName:
+        description: Property name filter for source descriptor
+        type: string
+        required: false # Hand-rolled fix for validation failure during runtime
+  LightningModelRendererConfigInputRepresentation:
+    type: object
+    description: Input Representation for Lightning Model type renderer configuration
+    properties:
+      target:
+        description: A renderer configuration target. To fetch all the types that have the renderer configuration for a particular target.
+        type: string
+        enum:
+          [
+            Default,
+            Detail,
+            Email,
+            LightningDesktopGenAi,
+            LightningMobileCopilot,
+            Summary,
+            ScEverywhere,
+            SlackCopilot,
+          ]
+        required: false # Hand-rolled fix for validation failure during runtime
+      subViewDefinitions:
+        description: Boolean property if sub-view should be included
+        type: boolean
+        required: false # Hand-rolled fix for validation failure during runtime
+      maxViewDepth:
+        description: Integer property for specifying maximum depth of sub-view definition decomposition
+        type: integer
+        required: false # Hand-rolled fix for validation failure during runtime
+      actionConfig:
+        description: Boolean property if actions should be included
+        type: boolean
+        required: false # Hand-rolled fix for validation failure during runtime
+  LightningModelEditorConfigInputRepresentation:
+    type: object
+    description: Input Representation for Lightning Model type editor configuration
+    properties:
+      target:
+        description: A editor configuration target. To fetch all the types that have the editor configuration for a particular target.
+        type: string
+        enum:
+          [
+            Default,
+            Email,
+            LightningDesktopGenAi,
+            LightningMobileCopilot,
+            LightningCommunity,
+            LightningDesktopDesign,
+            LightningMiawCopilot,
+            EnhancedMessaging,
+            MiawCopilot,
+            ScEveryWhere,
+            SlackCopilot,
+          ]
+        required: false # Hand-rolled fix for validation failure during runtime
+      subViewDefinitions:
+        description: Boolean property if sub-view should be included
+        type: boolean
+        required: false # Hand-rolled fix for validation failure during runtime
+      maxViewDepth:
+        description: Integer property for specifying maximum depth of sub-view definition decomposition
+        type: integer
+        required: false # Hand-rolled fix for validation failure during runtime
+      actionConfig:
+        description: Boolean property if actions should be included
+        type: boolean
+        required: false # Hand-rolled fix for validation failure during runtime
+  LightningModelFilterConfigInputRepresentation:
+    type: object
+    description: Input Representation for Lightning Model type Filter configuration
+    properties:
+      propertyNames:
+        description: Indicates list of properties to filter
+        type: array
+        items:
+          type: string
+  LightningModelTypesErrorRepresentation:
+    type: object
+    description: Lightning Mode Types Error Representation
+    properties:
+      errorDescription:
+        description: Error Description
+        type: string
+      errorTitle:
+        description: Error Title
+        type: string
+  LightningModelTypesConfigInputRepresentation:
+    type: object
+    description: Input Representation for Lightning Model types configuration
+    properties:
+      descriptor:
+        description: The descriptor of type.
+        type: string
+      editorConfig:
+        description: The editor config.
+        type: LightningModelEditorConfigInputRepresentation
+        required: false # Hand-rolled fix for validation failure during runtime
+      rendererConfig:
+        description: The renderer config.
+        type: LightningModelRendererConfigInputRepresentation
+        required: false # Hand-rolled fix for validation failure during runtime
+      schemaConfig:
+        description: The schema config.
+        type: LightningModelSchemaConfigInputRepresentation
+        required: false # Hand-rolled fix for validation failure during runtime
+      sourceDescriptor:
+        description: The source descriptor.
+        type: LightningModelSourceDescriptorInputRepresentation
+        required: false # Hand-rolled fix for validation failure during runtime
+  LightningModelTypesInputRepresentation:
+    type: object
+    description: Input Representation for Lightning Model types
+    properties:
+      language:
+        description: "The language/locale code. e.g., es or en_US. To retrieve
+          the title and description in a particular language. If not provided, the
+          logged-in user’s language is used. The fallback language is ENGLISH in case
+          translations don't exist."
+        type: string
+      typeConfigs:
+        description: The list of Lightning Model Types Configuration
+        type: array
+        items:
+          type: LightningModelTypesConfigInputRepresentation
+  LightningModelValidateFilterConfigInputRepresentation:
+    description: Represents the filter config input parameters for /connect/lightning-model/validate
+    type: object
+    properties:
+      localization:
+        description: Localization filter value for validation
+        type: boolean
+        required: false # TODO Hand-rolled W-9314597
+      readOnly:
+        description: ReadOnly filter value for validation
+        type: boolean
+        required: false # TODO Hand-rolled W-9314597
+  LightningModelValidateInputRepresentation:
+    description: Represents the input parameters for /connect/lightning-model/validate
+    type: object
+    properties:
+      descriptor:
+        description: A descriptor of format <Bundle Type>/<Fully Qualified Name of
+          Type>. Examples include "propertyType/lightning__emailType" or "metaschema/sfdc_cms__propertyType"
+        type: string
+      filterConfig:
+        description: Optional filtering configuration for validation
+        type: LightningModelValidateFilterConfigInputRepresentation # TODO Hand-rolled
+        required: false # TODO Hand-rolled W-9314597
+      payload:
+        description: JSON data to be validated
+        type: object
+        properties:
+          //:
+            type: any # TODO Hand-rolled W-8252808
+  LightningModelValidationErrorRepresentation:
+    description: Represents the errors output
+    type: object
+    properties:
+      arguments:
+        description: Arguments of the error
+        type: array
+        items:
+          type: any # TODO Hand-rolled W-8252808
+      code:
+        description: Code representing the validation error
+        type: string
+      details:
+        description: Details of the error
+        type: object
+        properties:
+          //:
+            type: object
+      message:
+        description: Human-readable error message
+        type: string
+      path:
+        description: Path to the field where the error occurred
+        type: string
+      type:
+        description: Type of the validation rule that failed
+        type: string
+  LightningModelValidationResultRepresentation:
+    description: Represents the validation output
+    type: object
+    properties:
+      errors:
+        description: List of validation errors encountered
+        type: array
+        items:
+          type: LightningModelValidationErrorRepresentation # TODO Hand-rolled specified the type manually instead of object
+      success:
+        description: Indicates whether the validation was successful
+        type: boolean
+/connect:
+  /lightning-types:
+    get:
+      displayName: getLightningTypeCollection
+      description: Fetch or Query the Lightning Types.
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: LightningTypeCollectionRepresentation
+      queryParameters:
+        editorConfigTarget:
+          description: A design configuration target. To fetch all the lightning types
+            that have the editor configuration for a particular target.
+          type: string
+          required: false
+          enum:
+            - Default
+            - EnhancedMessaging
+            - LightningDesktopGenAi
+            - LightningDesktopDesign
+            - LightningMiawCopilot
+            - LightningMobileCopilot
+            - MiawCopilot
+            - ScEveryWhere
+            - SlackCopilot
+        excludeStandardTypes:
+          description: Exclude standard schema types from the response.
+          type: boolean
+          required: false
+        fullyQualifiedNames:
+          description: The list of comma-separated lightning type FQNs. To fetch some
+            specific lightning types by providing their FQNs.
+          type: array
+          required: false
+          items:
+            type: string
+            (oas-collectionFormat): csv
+        language:
+          description: The language/locale code. e.g., es or en_US. To retrieve the
+            title and description in a particular language. If not provided, the logged-in
+            user’s language is used. The fallback language is ENGLISH in case translations
+            don't exist.
+          type: string
+          required: false
+        page:
+          description: An integer specifying a page of items. The default value is
+            0, which returns the first page.
+          type: integer
+          required: false
+        pageSize:
+          description: Specifies the number of items per page. Valid values are from
+            1 through 250.
+          type: integer
+          required: false
+        rendererConfigTarget:
+          description: A rendition configuration target. To fetch all the lightning
+            types that have the rendition configuration for a particular target.
+          type: string
+          required: false
+          enum:
+            - Default
+            - Detail
+            - Email
+            - EnhancedMessaging
+            - LightningDesktopGenAi
+            - LightningDesktopDesign
+            - LightningMiawCopilot
+            - LightningMobileCopilot
+            - MiawCopilot
+            - ScEveryWhere
+            - SlackCopilot
+            - Summary
+  /lightning-types/{fullyQualifiedName}:
+    get:
+      displayName: getLightningType
+      description: Fetch the detailed information about a Lightning Type.
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: LightningTypeDetailRepresentation
+      queryParameters:
+        editorConfigTarget:
+          description: Editor configuration target. To get the editor configuration
+            also included for a particular target in the response.If not specified,
+            editor configuration for default target is included in the response.
+          type: string
+          required: false
+          enum:
+            - Default
+            - EnhancedMessaging
+            - LightningDesktopGenAi
+            - LightningDesktopDesign
+            - LightningMiawCopilot
+            - LightningMobileCopilot
+            - MiawCopilot
+            - ScEveryWhere
+            - SlackCopilot
+        expandConfigs:
+          description: expandConfigs
+          type: boolean
+          required: false
+        includeSubSchemaDefinitions:
+          description: When this is true, the schema definition will include all the
+            referenced external sub-schema definitions also under $defs keyword. The
+            default value is false.
+          type: boolean
+          required: false
+        language:
+          description: The language/locale code. e.g., es or en_US. To retrieve the
+            title and description in a particular language. If not provided, the logged-in
+            user’s language is used. The fallback language is ENGLISH in case translations
+            don't exist.
+          type: string
+          required: false
+        rendererConfigTarget:
+          description: Renderer configuration target.
+          type: string
+          required: false
+          enum:
+            - Default
+            - Detail
+            - Email
+            - EnhancedMessaging
+            - LightningDesktopGenAi
+            - LightningDesktopDesign
+            - LightningMiawCopilot
+            - LightningMobileCopilot
+            - MiawCopilot
+            - ScEveryWhere
+            - SlackCopilot
+            - Summary
+    uriParameters:
+      fullyQualifiedName:
+        description: The Fully Qualified Name of a lightning type to be retrieved.
+        type: string
+        required: true
+  /lightning-model:
+    /types:
+      post:
+        displayName: postLightningModelTypes
+        description: Fetch the detailed information of Lightning types.
+        responses:
+          '200':
+            description: Success
+            body:
+              application/json:
+                type: LightningModelTypesCollectionRepresentation
+        body:
+          application/json:
+            description: Lightning Model Types Input
+            type: LightningModelTypesInputRepresentation
+            # required: false Hand-rolled, not supported W-16968605
+            (oas-body-name): lightningModelTypes
+    /validate:
+      post:
+        displayName: validateLightningModel
+        description: This endpoint validates the provided JSON data against the type
+          specified in the descriptor. Returns validation errors if the data does
+          not conform
+        responses:
+          '200':
+            description: Success
+            body:
+              application/json:
+                type: LightningModelValidationResultRepresentation
+        body:
+          application/json:
+            type: LightningModelValidateInputRepresentation
+            #required: false # TODO hand rolled. W-9275477
+            (oas-body-name): lightningModelValidateInputRepresentation

package/src/raml/luvio.raml

@@ -0,0 +1,98 @@
+#%RAML 1.0 Overlay
+extends: ./api.raml
+
+uses:
+  luvio: luvio://annotations.raml
+
+(luvio.keyPrefix): 'lightning-types'
+
+types:
+  LightningTypeCollectionRepresentation:
+    (luvio.ttl): 100
+  LightningTypeSummaryRepresentation:
+    (luvio.opaque): true
+    (luvio.ttl): 100
+  LightningTypeDetailRepresentation:
+    (luvio.opaque): true
+    (luvio.ttl): 100
+  LightningModelTypesCollectionRepresentation:
+    (luvio.ttl): 3600000
+    (luvio.opaque): true
+  LightningModelTypesRepresentation:
+    (luvio.ttl): 3600000
+    (luvio.opaque): true
+  LightningModelValidationResultRepresentation:
+    (luvio.ttl): 1000
+    (luvio.opaque): true
+
+/connect/lightning-types:
+  get:
+    (luvio.adapter):
+      name: getLightningTypes
+/connect/lightning-types/{fullyQualifiedName}:
+  get:
+    (luvio.adapter):
+      name: getLightningType
+  uriParameters:
+    fullyQualifiedName:
+/connect/lightning-model/types:
+  post:
+    (luvio.method): get
+    (luvio.adapter):
+      name: getTypes
+      tests:
+        validConfigs:
+          - |
+            {
+              "language":"en_US",
+              "typeConfigs": [
+                {
+                  "descriptor": "copilotActionOutput/exp_builder__backgroundImage",
+                  "schemaConfig": {
+                    "subSchemaDefinitions": true
+                  },
+                  "editorConfig": {},
+                  "rendererConfig": {}
+                }
+              ]
+            }
+/connect/lightning-model/validate:
+  post:
+    (luvio.method): get
+    (luvio.adapter):
+      name: validateLightningModel
+      tests:
+        validConfigs:
+          - |
+            {
+              "descriptor": "metadata/propertyType",
+              "payload": {
+                "type": "string",
+                "maxLength": 255,
+                "lightning:textIndexed": true,
+                "lightning:supportsPersonalization": true
+              }
+            }
+          - |
+            {
+              "descriptor": "metadata/propertyType",
+              "payload": {
+                "body":"test body",
+                "excerpt":"test excerpt"
+              },
+              "filterConfig": {
+                "localization": true
+              }
+            }
+        invalidConfigs:
+          - |
+            {
+              "descriptor": "metadata/propertyType"
+            }
+          - |
+            {
+              "payload": {
+                "body":"test body",
+                "excerpt":"test excerpt"
+              }
+            }