@salesforce/lds-adapters-commerce-extensions 0.1.0-dev1

package/src/raml/api.raml

@@ -0,0 +1,351 @@
+#%RAML 1.0
+securedBy:
+  - OAuth2
+title: Salesforce Connect API
+version: '59.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:
+  ApexClassInputRepresentation:
+    description: Input representation of a provider's apex class.
+    type: object
+    properties:
+      classId:
+        description: Unique identifier for the apex class.
+        type: string
+      className:
+        description: Name of the class containing the entry methods.
+        type: string
+  ApexClassOutputRepresentation:
+    description: Output representation of a provider's apex class.
+    type: object
+    properties:
+      classId:
+        description: Unique identifier for the apex class.
+        type: string
+      className:
+        description: Name of the main class containing the entry methods.
+        type: string
+      namespace:
+        description: Unique identifier for the company supplying the provider
+        type: string
+      version:
+        description: The version of the apex class
+        type: string
+  EffectiveMappingRepresentation:
+    description: Output representation of a list of webstores that are effectivly
+      mapped to an Extension.
+    type: object
+    properties:
+      webstoreId:
+        description: The unique webstore identifier.
+        type: string
+  ExtensionOutputCollectionRepresentation:
+    description: Output representation of a list of extensions.
+    type: object
+    properties:
+      count:
+        description: Total count of extensions
+        type: integer
+      items:
+        description: List of extensions.
+        type: array
+        items:
+          type: ExtensionOutputRepresentation
+  ExtensionOutputRepresentation:
+    description: Output representation of one Extension.
+    type: object
+    properties:
+      domain:
+        description: The service domain the Extension belongs to.
+        type: string
+      epn:
+        description: Extension's unique identifier.
+        type: string
+      name:
+        description: The name of the extension.
+        type: string
+      product:
+        description: The Salesforce family the Extension belongs to.
+        type: string
+      type:
+        description: Allowable values are Domain and Endpoint.
+        type: string
+  MappingInputRepresentation:
+    description: Input representation for mapping.
+    type: object
+    properties:
+      epn:
+        description: The extension this provider corresponds to.
+        type: string
+      # handrolled: id needs to be optional
+      id?:
+        description: The unique mapping identifier
+        type: string
+      providerName:
+        description: Unique name of the extension provider.
+        type: string
+      webstoreId:
+        description: The Id of the webstore this mapping corresponds to.
+        type: string
+  MappingOutputCollectionRepresentation:
+    description: Output representation of a list of mapped extensions.
+    type: object
+    properties:
+      count:
+        description: Total count of extensions
+        type: integer
+      items:
+        description: List of mappings.
+        type: array
+        items:
+          type: MappingOutputRepresentation
+  MappingOutputRepresentation:
+    description: Output representation for mapping.
+    type: object
+    properties:
+      epn:
+        description: The extension this provider corresponds to.
+        type: string
+      id:
+        description: The unique mapping identifier
+        type: string
+      providerName:
+        description: Unique name of the extension provider.
+        type: string
+      webstoreId:
+        description: The Id of the webstore this mapping corresponds to.
+        type: string
+  ProviderInputRepresentation:
+    description: Input representation of a Provider
+    type: object
+    properties:
+      apexClass:
+        description: Description of the apex class.
+        type: object
+      configUrl:
+        description: The URL of the administrative application used to configure the
+          provider.
+        type: string
+      description:
+        description: Description of the provider.
+        type: string
+      epn:
+        description: The extension this provider corresponds to.
+        type: string
+      iconUri:
+        description: Representing the extension provider.
+        type: string
+      isApplication:
+        description: If the extension provider is contained within a managed package.
+        type: boolean
+      name:
+        description: Unique name of the extension provider.
+        type: string
+      type:
+        description: The type of extension.
+        type: string
+  ProviderOutputCollectionRepresentation:
+    description: Output representation of a list of extension providers.
+    type: object
+    properties:
+      count:
+        description: Total count of extensions
+        type: integer
+      items:
+        description: List of providers.
+        type: array
+        items:
+          type: ProviderOutputRepresentation
+  ProviderOutputRepresentation:
+    description: Output representation of a Provider
+    type: object
+    properties:
+      apexClass:
+        description: Information about the Apex class implementing this Provider
+        type: ApexClassOutputRepresentation
+      effectiveMappings:
+        description: List of mappings this provider is associated with.
+        type: array
+        items:
+          type: EffectiveMappingRepresentation
+      epn:
+        description: The extension this provider corresponds to.
+        type: string
+      name:
+        description: Unique name of the extension provider.
+        type: string
+      type:
+        description: The type of extension.
+        type: string
+      configUrl:
+        description: The URL of the administrative application used to configure the provider.
+        type: string
+      iconUri:
+        description: Representing the extension provider.
+        type: string
+      description:
+        description: Description of the provider.
+        type: string
+      isApplication:
+        description: If the extension provider is contained within a managed package.
+        type: boolean
+      id:
+        description: The unique provider identifier
+        type: string
+/commerce/extension:
+  /extensions:
+    get:
+      displayName: getExtensionCollection
+      description: Get extensions.
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: ExtensionOutputCollectionRepresentation
+  /mappings:
+    get:
+      displayName: getMappingCollection
+      description: Get Mapped Extension Providers.
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: MappingOutputCollectionRepresentation
+      queryParameters:
+        epn:
+          type: string
+          required: false
+        webstoreId:
+          type: string
+          required: false
+    post:
+      displayName: postMappingCollection
+      description: Create a mapping between an extension provider and a webstore.
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: MappingOutputRepresentation
+      body:
+        application/json:
+          type: MappingInputRepresentation
+          (oas-body-name): mappingInputRepresentation
+  /mappings/{mappingId}:
+    delete:
+      displayName: deleteMapping
+      description: Remove the mapping between an extension provider and a webstore
+      responses:
+        '200':
+          description: Success
+    get:
+      displayName: getMapping
+      description: Get a mapped extension provider.
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: MappingOutputRepresentation
+    put:
+      displayName: putMapping
+      description: Alter an existing mapping between an extension provider and a webstore.
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: MappingOutputRepresentation
+      body:
+        application/json:
+          type: MappingInputRepresentation
+          (oas-body-name): mappingInputRepresentation
+    uriParameters:
+      mappingId:
+        type: string
+        required: true
+  /providers:
+    get:
+      displayName: getGetExtensionProvidersCollection
+      description: Get Extension Providers.
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: ProviderOutputCollectionRepresentation
+      queryParameters:
+        effectiveMappingsWebstoreId:
+          type: string
+          required: false
+        epn:
+          type: string
+          required: false
+    post:
+      displayName: postExtensionProvidersCollection
+      description: Register a provider
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: ProviderOutputRepresentation
+      body:
+        application/json:
+          type: ProviderInputRepresentation
+          (oas-body-name): providerInputRepresentation
+  /providers/{providerId}:
+    delete:
+      displayName: deleteExtensionProvider
+      description: Remove a provider.
+      responses:
+        '200':
+          description: Success
+    get:
+      displayName: getProvider
+      description: Get an extension provider
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: ProviderOutputRepresentation
+    patch:
+      displayName: patchExtensionProvider
+      description: Alter an existing extension provider.
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: ProviderOutputRepresentation
+      body:
+        application/json:
+          type: ProviderInputRepresentation
+          (oas-body-name): providerInputRepresentation
+    uriParameters:
+      providerId:
+        type: string
+        required: true

package/src/raml/luvio.raml

@@ -0,0 +1,71 @@
+#%RAML 1.0 Overlay
+extends: ./api.raml
+
+uses:
+  luvio: luvio://annotations.raml
+
+(luvio.keyPrefix): 'extensions'
+
+#global ttl will NOT cause error response caching to expire, so we need it at every type
+
+types:
+  ExtensionOutputRepresentation:
+    (luvio.ttl): 60000
+    (luvio.key):
+      epn: epn
+  ExtensionOutputCollectionRepresentation:
+    (luvio.ttl): 60000
+  MappingInputRepresentation:
+    (luvio.ttl): 60000
+  MappingOutputRepresentation:
+    (luvio.ttl): 60000
+    (luvio.key):
+      id: id
+    (luvio.updateAvailable):
+      name: notifyMappingUpdateAvailable
+      parameters:
+        id: id
+  MappingOutputCollectionRepresentation:
+    (luvio.ttl): 60000
+  ProviderOutputRepresentation:
+    (luvio.ttl): 60000
+    (luvio.key):
+      id: id
+  ProviderOutputCollectionRepresentation:
+    (luvio.ttl): 60000
+
+/commerce/extension/extensions:
+  get:
+    (luvio.adapter):
+      name: getExtensions
+/commerce/extension/mappings:
+  get:
+    (luvio.adapter):
+      name: getMappings
+  post:
+    (luvio.adapter):
+      name: createMapping
+/commerce/extension/mappings/{mappingId}:
+  get:
+    (luvio.adapter):
+      name: getMapping
+    (luvio.key):
+      id: urlParams.mappingId
+  put:
+    (luvio.adapter):
+      name: updateMapping
+  delete:
+    (luvio.adapter):
+      name: deleteMapping
+    (luvio.key):
+      id: urlParams.mappingId
+/commerce/extension/providers:
+  get:
+    (luvio.adapter):
+      name: getProviders
+/commerce/extension/providers/{providerId}:
+  get:
+    (luvio.adapter):
+      name: getProvider
+    (luvio.key):
+      id: urlParams.providerId