@firebolt-js/core-client 1.0.0-next.5

package/dist/docs/Lifecycle2/index.md

@@ -0,0 +1,160 @@
+---
+title: Lifecycle2
+---
+
+# Lifecycle2 Module
+
+---
+
+Version Lifecycle2 1.0.0-next.5
+
+## Table of Contents
+
+- [Table of Contents](#table-of-contents)
+- [Overview](#overview)
+- [Methods](#methods)
+  - [close](#close)
+  - [state](#state)
+- [Events](#events)
+  - [onStateChanged](#onstatechanged)
+- [Types](#types)
+  - [CloseType](#closetype)
+  - [LifecycleState](#lifecyclestate)
+  - [StateChange](#statechange)
+
+## Overview
+
+Methods and events for responding to Lifecycle changes in your app.
+
+## Methods
+
+### close
+
+_This is a private RPC method._
+
+Request the platform to deactivate the app, and possibly take further action.
+
+Parameters:
+
+| Param  | Type                      | Required | Description                                                                                                         |
+| ------ | ------------------------- | -------- | ------------------------------------------------------------------------------------------------------------------- |
+| `type` | [`CloseType`](#closetype) | true     | The type of the close app is requesting <br/>values: `'deactivate' \| 'unload' \| 'killReload' \| 'killReactivate'` |
+
+Result:
+
+Capabilities:
+
+| Role | Capability                                 |
+| ---- | ------------------------------------------ |
+| uses | xrn:firebolt:capability:lifecycle2:general |
+
+#### Examples
+
+Close the app when the user presses back on the app home screen
+
+Close the app when the user selects an exit menu item
+
+---
+
+### state
+
+_This is a private RPC method._
+
+Get the current lifecycle state of the app.
+
+Result:
+
+[LifecycleState](#lifecyclestate)
+
+Capabilities:
+
+| Role | Capability                                 |
+| ---- | ------------------------------------------ |
+| uses | xrn:firebolt:capability:lifecycle2:general |
+
+#### Examples
+
+Default Example
+
+---
+
+## Events
+
+### onStateChanged
+
+_This is a private RPC method._
+
+Notification of lifecycle state change, raised after the platform has transitioned the app/runtime to the new lifecycle state
+
+Parameters:
+
+| Param    | Type      | Required | Description |
+| -------- | --------- | -------- | ----------- |
+| `listen` | `boolean` | false    |             |
+
+Result:
+
+Capabilities:
+
+| Role | Capability                                 |
+| ---- | ------------------------------------------ |
+| uses | xrn:firebolt:capability:lifecycle2:general |
+
+#### Examples
+
+App is active after being initialized
+
+Single transition to paused state
+
+---
+
+## Types
+
+### CloseType
+
+The application close type
+
+```typescript
+CloseType: {
+    DEACTIVATE: 'deactivate',
+    UNLOAD: 'unload',
+    KILL_RELOAD: 'killReload',
+    KILL_REACTIVATE: 'killReactivate',
+},
+
+```
+
+---
+
+### LifecycleState
+
+The application Lifecycle state
+
+```typescript
+LifecycleState: {
+    INITIALIZING: 'initializing',
+    ACTIVE: 'active',
+    PAUSED: 'paused',
+    SUSPENDED: 'suspended',
+    HIBERNATED: 'hibernated',
+    TERMINATING: 'terminating',
+},
+
+```
+
+---
+
+### StateChange
+
+```typescript
+type StateChange = {
+  newState?: LifecycleState // The application Lifecycle state
+  oldState?: LifecycleState // The application Lifecycle state
+}
+```
+
+See also:
+
+[LifecycleState](#lifecyclestate)
+
+---

package/dist/docs/Localization/index.md

@@ -0,0 +1,314 @@
+---
+title: Localization
+---
+
+# Localization Module
+
+---
+
+Version Localization 1.0.0-next.5
+
+## Table of Contents
+
+- [Table of Contents](#table-of-contents)
+- [Usage](#usage)
+- [Overview](#overview)
+- [Methods](#methods)
+  - [country](#country)
+  - [preferredAudioLanguages](#preferredaudiolanguages)
+  - [presentationLanguage](#presentationlanguage)
+- [Events](#events)
+  - [onCountryChanged](#oncountrychanged)
+  - [onPreferredAudioLanguagesChanged](#onpreferredaudiolanguageschanged)
+  - [onPresentationLanguageChanged](#onpresentationlanguagechanged)
+- [Types](#types)
+
+## Usage
+
+To use the Localization module, you can import it into your project from the Firebolt SDK:
+
+```javascript
+import { Localization } from '@firebolt-js/core-client'
+```
+
+## Overview
+
+Methods for accessing location and language preferences.
+
+## Methods
+
+### country
+
+Returns the ISO 3166-1 alpha-2 code for the country device is located in.
+
+To get the value of `country` call the method like this:
+
+```typescript
+function country(): Promise<string>
+```
+
+Promise resolution:
+
+Capabilities:
+
+| Role | Capability                                        |
+| ---- | ------------------------------------------------- |
+| uses | xrn:firebolt:capability:localization:country-code |
+
+#### Examples
+
+Default example
+
+JavaScript:
+
+```javascript
+import { Localization } from '@firebolt-js/core-client'
+
+let code = await Localization.country()
+console.log(code)
+```
+
+Value of `code`:
+
+```javascript
+'US'
+```
+
+Another example
+
+JavaScript:
+
+```javascript
+import { Localization } from '@firebolt-js/core-client'
+
+let code = await Localization.country()
+console.log(code)
+```
+
+Value of `code`:
+
+```javascript
+'US'
+```
+
+---
+
+To subscribe to notifications when the value changes, call the method like this:
+
+```typescript
+function country(callback: (code) => string): Promise<number>
+```
+
+| Param  | Type     | Required | Description                                       |
+| ------ | -------- | -------- | ------------------------------------------------- |
+| `code` | `string` | false    | The device country code. <br/>pattern: ^[A-Z]{2}$ |
+
+Promise resolution:
+
+```
+number
+```
+
+#### Examples
+
+Default example
+
+```typescript
+import { Localization } from '@firebolt-js/core-client'
+
+let listenerId = await country((result) => {
+  console.log(result)
+})
+```
+
+Value of `result`:
+
+```javascript
+'US'
+```
+
+Another example
+
+```typescript
+import { Localization } from '@firebolt-js/core-client'
+
+let listenerId = await country((result) => {
+  console.log(result)
+})
+```
+
+Value of `result`:
+
+```javascript
+'US'
+```
+
+---
+
+### preferredAudioLanguages
+
+Returns a list of ISO 639-2/B codes for the preferred audio languages on this device.
+
+To get the value of `preferredAudioLanguages` call the method like this:
+
+```typescript
+function preferredAudioLanguages(): Promise<string[]>
+```
+
+Promise resolution:
+
+Capabilities:
+
+| Role | Capability                                                     |
+| ---- | -------------------------------------------------------------- |
+| uses | xrn:firebolt:capability:localization:preferred-audio-languages |
+
+#### Examples
+
+Default example
+
+JavaScript:
+
+```javascript
+import { Localization } from '@firebolt-js/core-client'
+
+let languages = await Localization.preferredAudioLanguages()
+console.log(languages)
+```
+
+Value of `languages`:
+
+```javascript
+;['spa', 'eng']
+```
+
+---
+
+To subscribe to notifications when the value changes, call the method like this:
+
+```typescript
+function preferredAudioLanguages(
+  callback: (languages) => string[],
+): Promise<number>
+```
+
+| Param       | Type       | Required | Description                                             |
+| ----------- | ---------- | -------- | ------------------------------------------------------- |
+| `languages` | `string[]` | false    | The preferred audio languages. <br/>pattern: ^[a-z]{3}$ |
+
+Promise resolution:
+
+```
+number
+```
+
+#### Examples
+
+Default example
+
+```typescript
+import { Localization } from '@firebolt-js/core-client'
+
+let listenerId = await preferredAudioLanguages((result) => {
+  console.log(result)
+})
+```
+
+Value of `result`:
+
+```javascript
+;['spa', 'eng']
+```
+
+---
+
+### presentationLanguage
+
+Get the _full_ BCP 47 code, including script, region, variant, etc., for the preferred locale
+
+To get the value of `presentationLanguage` call the method like this:
+
+```typescript
+function presentationLanguage(): Promise<string>
+```
+
+Promise resolution:
+
+Capabilities:
+
+| Role | Capability                                  |
+| ---- | ------------------------------------------- |
+| uses | xrn:firebolt:capability:localization:locale |
+
+#### Examples
+
+Default example
+
+JavaScript:
+
+```javascript
+import { Localization } from '@firebolt-js/core-client'
+
+let locale = await Localization.presentationLanguage()
+console.log(locale)
+```
+
+Value of `locale`:
+
+```javascript
+'en-US'
+```
+
+---
+
+To subscribe to notifications when the value changes, call the method like this:
+
+```typescript
+function presentationLanguage(callback: (locale) => string): Promise<number>
+```
+
+| Param    | Type     | Required | Description                                                   |
+| -------- | -------- | -------- | ------------------------------------------------------------- |
+| `locale` | `string` | false    | The device locale. <br/>pattern: ^[a-zA-Z]+([a-zA-Z0-9\-]\*)$ |
+
+Promise resolution:
+
+```
+number
+```
+
+#### Examples
+
+Default example
+
+```typescript
+import { Localization } from '@firebolt-js/core-client'
+
+let listenerId = await presentationLanguage((result) => {
+  console.log(result)
+})
+```
+
+Value of `result`:
+
+```javascript
+'en-US'
+```
+
+---
+
+## Events
+
+### onCountryChanged
+
+See: [country](#country)
+
+### onPreferredAudioLanguagesChanged
+
+See: [preferredAudioLanguages](#preferredaudiolanguages)
+
+### onPresentationLanguageChanged
+
+See: [presentationLanguage](#presentationlanguage)
+
+## Types

package/dist/docs/Localization/schemas/index.md

@@ -0,0 +1,41 @@
+---
+title: Localization
+---
+
+# Localization
+
+---
+
+## Table of Contents
+
+- [Table of Contents](#table-of-contents)
+- [Types](#types)
+  - [ISO639_2Language](#isolanguage)
+  - [CountryCode](#countrycode)
+  - [Locale](#locale)
+
+## Types
+
+### ISO639_2Language
+
+```typescript
+type ISO639_2Language = string
+```
+
+---
+
+### CountryCode
+
+```typescript
+type CountryCode = string
+```
+
+---
+
+### Locale
+
+```typescript
+type Locale = string
+```
+
+---