@salesforce/lds-adapters-platform-lightning-types 1.321.0

package/src/raml/api.raml

@@ -0,0 +1,393 @@
+#%RAML 1.0
+securedBy:
+  - OAuth2
+title: Salesforce Connect API
+version: '63.0'
+mediaType: application/json
+protocols:
+  - https
+baseUri: /services/data/v63.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:
+  ExperienceModelDesignConfigInputRepresentation:
+    description: Input Representation for Experience Model type design configuration
+    type: object
+    properties:
+      actionConfig:
+        description: Boolean property if actions should be included
+        type: boolean
+      subViewDefinitions:
+        description: Boolean property if sub-view should be included
+        type: boolean
+      target:
+        description: A design configuration target. To fetch the design configuration
+          for a particular target.
+        type: string
+        enum:
+          - Default
+          - EnhancedMessaging
+          - LightningDesktopCopilot
+          - LightningDesktopDesign
+          - LightningMiawCopilot
+          - LightningMobileCopilot
+          - MiawCopilot
+          - ScEveryWhere
+          - SlackCopilot
+  ExperienceModelFilterConfigInputRepresentation:
+    description: Input Representation for Experience Model type Filter configuration
+    type: object
+    properties:
+      propertyNames:
+        description: Indicates wrapper for list of properties to filter
+        type: array
+        items:
+          type: string
+  ExperienceModelFilterPropertyNamesListWrapper:
+    description: List Wrapper for Experience Model property names filter
+    type: object
+    properties:
+      propertyNamesList:
+        description: Indicates list of properties to filter
+        type: array
+        items:
+          type: string
+  ExperienceModelRenditionConfigInputRepresentation:
+    description: Input Representation for Experience Model type rendition configuration
+    type: object
+    properties:
+      actionConfig:
+        description: Boolean property if actions should be included
+        type: boolean
+      subViewDefinitions:
+        description: Boolean property if sub-view should be included
+        type: boolean
+      target:
+        description: A rendition configuration target. To fetch the rendition configuration
+          for a particular target.
+        type: string
+        enum:
+          - Default
+          - Detail
+          - Email
+          - EnhancedMessaging
+          - LightningDesktopCopilot
+          - LightningDesktopDesign
+          - LightningMiawCopilot
+          - LightningMobileCopilot
+          - MiawCopilot
+          - ScEveryWhere
+          - SlackCopilot
+          - Summary
+  ExperienceModelSchemaConfigInputRepresentation:
+    description: Input Representation for Experience Model type schema configuration
+    type: object
+    properties:
+      filterConfig:
+        description: Filter configuration for schema
+        type: object
+        properties:
+          //:
+            type: any
+      subSchemaDefinitions:
+        description: Boolean property if sub-schema should be included
+        type: boolean
+  ExperienceModelSourceDescriptorInputRepresentation:
+    description: Input Representation for Experience Model source descriptor
+    type: object
+    properties:
+      descriptor:
+        description: Source descriptor
+        type: string
+      propertyName:
+        description: Property name filter for source descriptor
+        type: string
+  ExperienceModelTypesCollectionRepresentation:
+    description: Represents a list/collection of Types.
+    type: object
+    properties:
+      types:
+        description: The list of Types ordered alphabetically by title.
+        type: array
+        items:
+          type: ExperienceModelTypesRepresentation
+  ExperienceModelTypesConfigInputListWrapper:
+    description: List wrapper for Experience Model type config input
+    type: object
+    properties:
+      typeConfigList:
+        description: The list of Experience Model Types Configuration
+        type: array
+        items:
+          type: object
+          properties:
+            //:
+              type: any
+  ExperienceModelTypesConfigInputRepresentation:
+    description: Input Representation for Experience Model types configuration
+    type: object
+    properties:
+      descriptor:
+        description: The descriptor of type.
+        type: string
+      designConfig:
+        description: The design config.
+        type: object
+        properties:
+          //:
+            type: any
+      renditionConfig:
+        description: The rendition config.
+        type: object
+        properties:
+          //:
+            type: any
+      schemaConfig:
+        description: The schema config.
+        type: object
+        properties:
+          //:
+            type: any
+      sourceDescriptor:
+        description: The source descriptor.
+        type: object
+        properties:
+          //:
+            type: any
+  ExperienceModelTypesErrorRepresentation:
+    description: Experience Mode Types Error Representation
+    type: object
+    properties:
+      errorDescription:
+        description: Error Description
+        type: string
+      errorTitle:
+        description: Error Title
+        type: string
+  ExperienceModelTypesInputRepresentation:
+    description: Input Representation for Experience Model types
+    type: object
+    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 wrapper for Experience Model Types Configuration '
+        type: array
+        items:
+          type: object
+          properties:
+            //:
+              type: any
+  ExperienceModelTypesRepresentation:
+    description: Represents the details about Types.
+    type: object
+    properties:
+      bundleType:
+        description: The bundle type of the Type that was given in type descriptor
+          in query params.
+        type: string
+      description:
+        description: The description of the Type that was given in its schema.json.
+        type: string
+      descriptor:
+        description: The type descriptor of the Type that was given in query params.
+        type: string
+      designConfig:
+        description: The design configuration for the specified target.
+        type: object
+        properties:
+          //:
+            type: any
+      developerName:
+        description: The developer name (aka apiName) of the Type.
+        type: string
+      errorDetails:
+        description: Experience Model Types Error Details
+        type: ExperienceModelTypesErrorRepresentation
+      id:
+        description: The 18-char String ID of the Type. This is returned for the DB-Based
+          (Custom) Types only.
+        type: string
+      namespacePrefix:
+        description: The namespace prefix that is associated with the Type. Refer
+          to a Type using the namespacePrefix__developerName notation (aka fullyQualifiedName).
+        type: string
+      renditionConfig:
+        description: The rendition configuration for the specified target.
+        type: object
+        properties:
+          //:
+            type: any
+      schema:
+        description: The JSON Schema definition (schema.json) of the Type
+        type: object
+        properties:
+          //:
+            type: any
+      sourceDescriptor:
+        description: The source descriptor of the Type that was given in query params.
+        type: object
+        properties:
+          //:
+            type: string
+      title:
+        description: The title of the Type that was given in its schema.json.
+        type: string
+  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
+/connect:
+  #/experience-model/types: # #Hand-rolled This api does not need to be exposed
+  #  post:
+  #    displayName: postExperienceModelTypes
+  #    description: Fetch the detailed information about a Property Type.
+  #    responses:
+  #      '200':
+  #        description: Success
+  #        body:
+  #          application/json:
+  #            type: ExperienceModelTypesCollectionRepresentation
+  #    body:
+  #      application/json:
+  #        description: Experience Model Types Input
+  #        type: ExperienceModelTypesInputRepresentation
+  # required: false #Hand-rolled issue #22 in (https://salesforce.quip.com/NxVhAkxL6RTW)
+  #        (oas-body-name): experienceModelTypes
+  /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
+            - LightningDesktopCopilot
+            - LightningDesktopDesign
+            - LightningMiawCopilot
+            - LightningMobileCopilot
+            - MiawCopilot
+            - ScEveryWhere
+            - SlackCopilot
+        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
+            - LightningDesktopCopilot
+            - LightningDesktopDesign
+            - LightningMiawCopilot
+            - LightningMobileCopilot
+            - MiawCopilot
+            - ScEveryWhere
+            - SlackCopilot
+            - Summary

package/src/raml/luvio.raml

@@ -0,0 +1,21 @@
+#%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
+    (luvio.key):
+      id: developerName
+
+/connect/lightning-types:
+  get:
+    (luvio.adapter):
+      name: getLightningTypes