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

package/dist/docs/Network/index.md

@@ -0,0 +1,128 @@
+---
+title: Network
+---
+
+# Network Module
+
+---
+
+Version Network 1.0.0-next.5
+
+## Table of Contents
+
+- [Table of Contents](#table-of-contents)
+- [Usage](#usage)
+- [Overview](#overview)
+- [Methods](#methods)
+  - [connected](#connected)
+- [Events](#events)
+  - [onConnectedChanged](#onconnectedchanged)
+- [Types](#types)
+  - [Connected](#connected-1)
+
+## Usage
+
+To use the Network module, you can import it into your project from the Firebolt SDK:
+
+```javascript
+import { Network } from '@firebolt-js/core-client'
+```
+
+## Overview
+
+Methods for accessing network information.
+
+## Methods
+
+### connected
+
+Returns whether the device currently has a usable network connection.
+
+To get the value of `connected` call the method like this:
+
+```typescript
+function connected(): Promise<boolean>
+```
+
+Promise resolution:
+
+Capabilities:
+
+| Role | Capability                                |
+| ---- | ----------------------------------------- |
+| uses | xrn:firebolt:capability:network:connected |
+
+#### Examples
+
+Connected example
+
+JavaScript:
+
+```javascript
+import { Network } from '@firebolt-js/core-client'
+
+let success = await Network.connected()
+console.log(success)
+```
+
+Value of `success`:
+
+```javascript
+true
+```
+
+---
+
+To subscribe to notifications when the value changes, call the method like this:
+
+```typescript
+function connected(callback: (success) => boolean): Promise<number>
+```
+
+| Param     | Type      | Required | Description                                                   |
+| --------- | --------- | -------- | ------------------------------------------------------------- |
+| `success` | `boolean` | false    | Whether the device currently has a usable network connection. |
+
+Promise resolution:
+
+```
+number
+```
+
+#### Examples
+
+Connected example
+
+```typescript
+import { Network } from '@firebolt-js/core-client'
+
+let listenerId = await connected((result) => {
+  console.log(result)
+})
+```
+
+Value of `result`:
+
+```javascript
+true
+```
+
+---
+
+## Events
+
+### onConnectedChanged
+
+See: [connected](#connected)
+
+## Types
+
+### Connected
+
+Indicates whether the device currently has a usable network connection.
+
+```typescript
+type Connected = boolean
+```
+
+---

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

@@ -0,0 +1,25 @@
+---
+title: Policies
+---
+
+# Policies
+
+---
+
+## Table of Contents
+
+- [Table of Contents](#table-of-contents)
+- [Types](#types)
+  - [AgePolicy](#agepolicy)
+
+## Types
+
+### AgePolicy
+
+The policy that describes various age groups to which content is directed. See distributor documentation for further details.
+
+```typescript
+type AgePolicy = string | 'app:adult' | 'app:child' | 'app:teen'
+```
+
+---

package/dist/docs/Presentation/index.md

@@ -0,0 +1,53 @@
+---
+title: Presentation
+---
+
+# Presentation Module
+
+---
+
+Version Presentation 1.0.0-next.5
+
+## Table of Contents
+
+- [Table of Contents](#table-of-contents)
+- [Overview](#overview)
+- [Methods](#methods)
+  - [focused](#focused)
+- [Events](#events)
+  - [onFocusedChanged](#onfocusedchanged)
+- [Types](#types)
+
+## Overview
+
+Methods for accessing Presentation preferences.
+
+## Methods
+
+### focused
+
+_This is a private RPC method._
+
+Whether the app is in focus, i.e. receiving key presses. Provided for those apps/runtimes that cannot use Wayland
+
+Result:
+
+Capabilities:
+
+| Role | Capability                                   |
+| ---- | -------------------------------------------- |
+| uses | xrn:firebolt:capability:presentation:general |
+
+#### Examples
+
+Default example
+
+---
+
+## Events
+
+### onFocusedChanged
+
+See: [focused](#focused)
+
+## Types

package/dist/docs/Stats/index.md

@@ -0,0 +1,63 @@
+---
+title: Stats
+---
+
+# Stats Module
+
+---
+
+Version Stats 1.0.0-next.5
+
+## Table of Contents
+
+- [Table of Contents](#table-of-contents)
+- [Overview](#overview)
+- [Methods](#methods)
+  - [memoryUsage](#memoryusage)
+- [Types](#types)
+  - [MemoryUsage](#memoryusage-1)
+
+## Overview
+
+Provides methods to retrieve application-level system information.
+
+## Methods
+
+### memoryUsage
+
+_This is a private RPC method._
+
+Returns information about container memory usage, in bytes.
+
+Result:
+
+[MemoryUsage](#memoryusage-1)
+
+Capabilities:
+
+| Role | Capability                            |
+| ---- | ------------------------------------- |
+| uses | xrn:firebolt:capability:stats:general |
+
+#### Examples
+
+Default example
+
+---
+
+## Types
+
+### MemoryUsage
+
+Describes current and maximum memory usage of the container.
+
+```typescript
+type MemoryUsage = {
+  userMemoryUsed: number // User memory currently used in bytes.
+  userMemoryLimit: number // Maximum user memory available in bytes.
+  gpuMemoryUsed: number // GPU memory currently used in bytes.
+  gpuMemoryLimit: number // Maximum GPU memory available in bytes.
+}
+```
+
+---