@salesforce/lds-adapters-platform-i18n 0.1.0-dev1

package/src/raml/api.raml

@@ -0,0 +1,176 @@
+#%RAML 1.0
+securedBy:
+  - OAuth2
+title: Salesforce Connect API
+version: '58.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:
+  AddressCountry:
+    description: Output representations of Address Country object.
+    type: object
+    properties:
+      active:
+        description: Country active flag.
+        type: boolean
+      isoCode:
+        description: Country IsoCode.
+        type: string
+      label:
+        description: Country localized label.
+        type: string
+      orgDefault:
+        description: Country orgDefault flag.
+        type: boolean
+      phoneCountryCode:
+        description: Phone country code associated with Country.
+        type: integer
+      standard:
+        description: Country if standard flag.
+        type: boolean
+      stateNameType:
+        description: Type of states supported in Country.
+        type: string
+      states:
+        description: List of states belonging to the Country.
+        type: array
+        items:
+          type: AddressState
+      visible:
+        description: Country visible flag.
+        type: boolean
+      zipNameType:
+        description: Type of zip codes supported in Country.
+        type: string
+  AddressState:
+    description: Address State Representation
+    type: object
+    properties:
+      active:
+        description: State active flag
+        type: boolean
+      isoCode:
+        description: State IsoCode
+        type: string
+      label:
+        description: State localized label.
+        type: string
+      standard:
+        description: State standard flag.
+        type: boolean
+      visible:
+        description: State visible flag
+        type: boolean
+  StateCountryInputRequest:
+    description: Input Representation to get locale and filter params for State and
+      Country list API.
+    type: object
+    properties:
+      countries:
+        description: Property representing the list of countries to skip from output.
+        type: array
+        items:
+          type: string
+      filterType:
+        description: Property representing the filter type
+        type: string
+        enum:
+          - E
+          - Exclude
+          - I
+          - Include
+      locale:
+        description: Property representing the locale for translation.
+        type: string
+      states:
+        description: Property representing the list of states to skip from the output.
+        type: array
+        items:
+          type: string
+  StateCountryOutputRepresentation:
+    description: Representation for StateAndCountryTranslations
+    type: object
+    properties:
+      addressCountry:
+        description: List of Countries and respective states in localized way.
+        type: array
+        items:
+          type: string
+  StateCountryTranslations:
+    description: Output representations of State and Country translations APIs response.
+    type: object
+    properties:
+      addressCountries:
+        description: List of addressCountries.
+        type: array
+        items:
+          type: AddressCountry
+  TimezoneOutputRepresentation:
+    description: Representation of Timezone localized list.
+    type: object
+    properties:
+      timezones:
+        description: List of Timezones with localized labels.
+        type: array
+        items:
+          type: TimezoneRepresentation
+  TimezoneRepresentation:
+    description: Representation of Timezone
+    type: object
+    properties:
+      displayLabel:
+        description: Timezone localized display label.
+        type: string
+      offset:
+        description: Timezone Offset.
+        type: string
+      timezoneId:
+        description: Timezone Id.
+        type: string
+/connect/i18n:
+  /statecountry:
+    # TODO: Hand rolled
+    # post:
+    #   description: Retrieve the list of States and Countries with labels in given
+    #     locales language.
+    #   responses:
+    #     '200':
+    #       description: Success
+    #       body:
+    #         application/json:
+    #           type: StateCountryTranslations
+    #   body:
+    #     application/json:
+    #       type: StateCountryInputRequest
+    #       (oas-body-name): stateCountryInput
+  /timezones/{locale}:
+    get:
+      description: Fetch list of timezones supported with localized labels.
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: TimezoneOutputRepresentation
+    uriParameters:
+      locale:
+        type: string

package/src/raml/luvio.raml

@@ -0,0 +1,18 @@
+#%RAML 1.0 Overlay
+extends: ./api.raml
+
+uses:
+  luvio: luvio://annotations.raml
+
+(luvio.keyPrefix): 'platformi18n'
+(luvio.ttl): 2592000000
+
+types:
+  TimezoneOutputRepresentation:
+    (luvio.opaque): true
+
+/connect/i18n:
+  /timezones/{locale}:
+    get:
+      (luvio.adapter):
+        name: getTimezonesByLocale