Publish documentation for v1.21.0

rakutentech · Jul 30, 2024 · cae3d4d · cae3d4d
1 parent 71fd931
commit cae3d4d
Show file tree

Hide file tree

Showing 82 changed files with 7,380 additions and 0 deletions.
diff --git a/_versions/1.21/1.21.md b/_versions/1.21/1.21.md
@@ -0,0 +1,4 @@
+---
+version: "1.21"
+date: 2024-07-30
+---
diff --git a/docs/1.21/api/README.md b/docs/1.21/api/README.md
@@ -0,0 +1,11 @@
+---
+layout: default
+---
+
+<!-- Redirects to `index.html` from `README.html` -->
+<html>
+    <head>
+        <meta http-equiv="refresh" content="0;url=./index.html" />
+    </head>
+    <body></body>
+</html>
diff --git a/docs/1.21/api/classes/accesstokendata.md b/docs/1.21/api/classes/accesstokendata.md
@@ -0,0 +1,63 @@
+**[js-miniapp-sdk](../README.md)**
+
+> [Globals](../README.md) / AccessTokenData
+
+# Class: AccessTokenData
+
+Token data type.
+
+## Hierarchy
+
+* **AccessTokenData**
+
+## Index
+
+### Constructors
+
+* [constructor](accesstokendata.md#constructor)
+
+### Properties
+
+* [scopes](accesstokendata.md#scopes)
+* [token](accesstokendata.md#token)
+* [validUntil](accesstokendata.md#validuntil)
+
+## Constructors
+
+### constructor
+
+\+ **new AccessTokenData**(`baseToken`: NativeTokenData): [AccessTokenData](accesstokendata.md)
+
+*Defined in [js-miniapp-bridge/src/types/token-data.ts:18](https://github.com/rakutentech/js-miniapp/blob/e6e9208/js-miniapp-bridge/src/types/token-data.ts#L18)*
+
+#### Parameters:
+
+Name | Type |
+------ | ------ |
+`baseToken` | NativeTokenData |
+
+**Returns:** [AccessTokenData](accesstokendata.md)
+
+## Properties
+
+### scopes
+
+• `Readonly` **scopes**: [AccessTokenScopes](accesstokenscopes.md)
+
+*Defined in [js-miniapp-bridge/src/types/token-data.ts:18](https://github.com/rakutentech/js-miniapp/blob/e6e9208/js-miniapp-bridge/src/types/token-data.ts#L18)*
+
+___
+
+### token
+
+• `Readonly` **token**: string
+
+*Defined in [js-miniapp-bridge/src/types/token-data.ts:16](https://github.com/rakutentech/js-miniapp/blob/e6e9208/js-miniapp-bridge/src/types/token-data.ts#L16)*
+
+___
+
+### validUntil
+
+• `Readonly` **validUntil**: Date
+
+*Defined in [js-miniapp-bridge/src/types/token-data.ts:17](https://github.com/rakutentech/js-miniapp/blob/e6e9208/js-miniapp-bridge/src/types/token-data.ts#L17)*
diff --git a/docs/1.21/api/classes/accesstokenscopes.md b/docs/1.21/api/classes/accesstokenscopes.md
@@ -0,0 +1,54 @@
+**[js-miniapp-sdk](../README.md)**
+
+> [Globals](../README.md) / AccessTokenScopes
+
+# Class: AccessTokenScopes
+
+Token permission type.
+
+## Hierarchy
+
+* **AccessTokenScopes**
+
+## Index
+
+### Constructors
+
+* [constructor](accesstokenscopes.md#constructor)
+
+### Properties
+
+* [audience](accesstokenscopes.md#audience)
+* [scopes](accesstokenscopes.md#scopes)
+
+## Constructors
+
+### constructor
+
+\+ **new AccessTokenScopes**(`basePermission`: NativeTokenScopes): [AccessTokenScopes](accesstokenscopes.md)
+
+*Defined in [js-miniapp-bridge/src/types/token-data.ts:30](https://github.com/rakutentech/js-miniapp/blob/e6e9208/js-miniapp-bridge/src/types/token-data.ts#L30)*
+
+#### Parameters:
+
+Name | Type |
+------ | ------ |
+`basePermission` | NativeTokenScopes |
+
+**Returns:** [AccessTokenScopes](accesstokenscopes.md)
+
+## Properties
+
+### audience
+
+• `Readonly` **audience**: string
+
+*Defined in [js-miniapp-bridge/src/types/token-data.ts:29](https://github.com/rakutentech/js-miniapp/blob/e6e9208/js-miniapp-bridge/src/types/token-data.ts#L29)*
+
+___
+
+### scopes
+
+• `Readonly` **scopes**: string[]
+
+*Defined in [js-miniapp-bridge/src/types/token-data.ts:30](https://github.com/rakutentech/js-miniapp/blob/e6e9208/js-miniapp-bridge/src/types/token-data.ts#L30)*
diff --git a/docs/1.21/api/classes/audiencenotsupportederror.md b/docs/1.21/api/classes/audiencenotsupportederror.md
@@ -0,0 +1,82 @@
+**[js-miniapp-sdk](../README.md)**
+
+> [Globals](../README.md) / AudienceNotSupportedError
+
+# Class: AudienceNotSupportedError
+
+## Hierarchy
+
+* [MiniAppError](miniapperror.md)
+
+  ↳ **AudienceNotSupportedError**
+
+## Index
+
+### Constructors
+
+* [constructor](audiencenotsupportederror.md#constructor)
+
+### Properties
+
+* [errorInput](audiencenotsupportederror.md#errorinput)
+* [message](audiencenotsupportederror.md#message)
+* [name](audiencenotsupportederror.md#name)
+* [stack](audiencenotsupportederror.md#stack)
+
+## Constructors
+
+### constructor
+
+\+ **new AudienceNotSupportedError**(`errorInput`: [MiniAppJson](../interfaces/miniappjson.md)): [AudienceNotSupportedError](audiencenotsupportederror.md)
+
+*Overrides [MiniAppError](miniapperror.md).[constructor](miniapperror.md#constructor)*
+
+*Defined in [js-miniapp-bridge/src/types/error-types/auth-errors.ts:9](https://github.com/rakutentech/js-miniapp/blob/e6e9208/js-miniapp-bridge/src/types/error-types/auth-errors.ts#L9)*
+
+#### Parameters:
+
+Name | Type |
+------ | ------ |
+`errorInput` | [MiniAppJson](../interfaces/miniappjson.md) |
+
+**Returns:** [AudienceNotSupportedError](audiencenotsupportederror.md)
+
+## Properties
+
+### errorInput
+
+•  **errorInput**: [MiniAppJson](../interfaces/miniappjson.md)
+
+*Overrides [MiniAppError](miniapperror.md).[errorInput](miniapperror.md#errorinput)*
+
+*Defined in [js-miniapp-bridge/src/types/error-types/auth-errors.ts:10](https://github.com/rakutentech/js-miniapp/blob/e6e9208/js-miniapp-bridge/src/types/error-types/auth-errors.ts#L10)*
+
+___
+
+### message
+
+•  **message**: string
+
+*Inherited from [MiniAppError](miniapperror.md).[message](miniapperror.md#message)*
+
+*Defined in node_modules/typescript/lib/lib.es5.d.ts:1054*
+
+___
+
+### name
+
+•  **name**: string
+
+*Inherited from [MiniAppError](miniapperror.md).[name](miniapperror.md#name)*
+
+*Defined in node_modules/typescript/lib/lib.es5.d.ts:1053*
+
+___
+
+### stack
+
+• `Optional` **stack**: string
+
+*Inherited from [MiniAppError](miniapperror.md).[stack](miniapperror.md#stack)*
+
+*Defined in node_modules/typescript/lib/lib.es5.d.ts:1055*
diff --git a/docs/1.21/api/classes/authorizationfailureerror.md b/docs/1.21/api/classes/authorizationfailureerror.md
@@ -0,0 +1,82 @@
+**[js-miniapp-sdk](../README.md)**
+
+> [Globals](../README.md) / AuthorizationFailureError
+
+# Class: AuthorizationFailureError
+
+## Hierarchy
+
+* [MiniAppError](miniapperror.md)
+
+  ↳ **AuthorizationFailureError**
+
+## Index
+
+### Constructors
+
+* [constructor](authorizationfailureerror.md#constructor)
+
+### Properties
+
+* [errorInput](authorizationfailureerror.md#errorinput)
+* [message](authorizationfailureerror.md#message)
+* [name](authorizationfailureerror.md#name)
+* [stack](authorizationfailureerror.md#stack)
+
+## Constructors
+
+### constructor
+
+\+ **new AuthorizationFailureError**(`errorInput`: [MiniAppJson](../interfaces/miniappjson.md)): [AuthorizationFailureError](authorizationfailureerror.md)
+
+*Overrides [MiniAppError](miniapperror.md).[constructor](miniapperror.md#constructor)*
+
+*Defined in [js-miniapp-bridge/src/types/error-types/auth-errors.ts:25](https://github.com/rakutentech/js-miniapp/blob/e6e9208/js-miniapp-bridge/src/types/error-types/auth-errors.ts#L25)*
+
+#### Parameters:
+
+Name | Type |
+------ | ------ |
+`errorInput` | [MiniAppJson](../interfaces/miniappjson.md) |
+
+**Returns:** [AuthorizationFailureError](authorizationfailureerror.md)
+
+## Properties
+
+### errorInput
+
+•  **errorInput**: [MiniAppJson](../interfaces/miniappjson.md)
+
+*Overrides [MiniAppError](miniapperror.md).[errorInput](miniapperror.md#errorinput)*
+
+*Defined in [js-miniapp-bridge/src/types/error-types/auth-errors.ts:26](https://github.com/rakutentech/js-miniapp/blob/e6e9208/js-miniapp-bridge/src/types/error-types/auth-errors.ts#L26)*
+
+___
+
+### message
+
+•  **message**: string
+
+*Inherited from [MiniAppError](miniapperror.md).[message](miniapperror.md#message)*
+
+*Defined in node_modules/typescript/lib/lib.es5.d.ts:1054*
+
+___
+
+### name
+
+•  **name**: string
+
+*Inherited from [MiniAppError](miniapperror.md).[name](miniapperror.md#name)*
+
+*Defined in node_modules/typescript/lib/lib.es5.d.ts:1053*
+
+___
+
+### stack
+
+• `Optional` **stack**: string
+
+*Inherited from [MiniAppError](miniapperror.md).[stack](miniapperror.md#stack)*
+
+*Defined in node_modules/typescript/lib/lib.es5.d.ts:1055*
diff --git a/docs/1.21/api/classes/bridgeinfoconverter.md b/docs/1.21/api/classes/bridgeinfoconverter.md
@@ -0,0 +1,48 @@
+**[js-miniapp-sdk](../README.md)**
+
+> [Globals](../README.md) / BridgeInfoConverter
+
+# Class: BridgeInfoConverter
+
+## Hierarchy
+
+* **BridgeInfoConverter**
+
+## Index
+
+### Methods
+
+* [convertJsonToPlatformInfo](bridgeinfoconverter.md#convertjsontoplatforminfo)
+* [mapStringToHostBuildType](bridgeinfoconverter.md#mapstringtohostbuildtype)
+
+## Methods
+
+### convertJsonToPlatformInfo
+
+▸ `Static`**convertJsonToPlatformInfo**(`json`: [HostEnvironmentInfo](../interfaces/hostenvironmentinfo.md)): [HostEnvironmentInfo](../interfaces/hostenvironmentinfo.md)
+
+*Defined in [js-miniapp-sdk/src/modules/bridge-info-converter.ts:47](https://github.com/rakutentech/js-miniapp/blob/e6e9208/js-miniapp-sdk/src/modules/bridge-info-converter.ts#L47)*
+
+#### Parameters:
+
+Name | Type |
+------ | ------ |
+`json` | [HostEnvironmentInfo](../interfaces/hostenvironmentinfo.md) |
+
+**Returns:** [HostEnvironmentInfo](../interfaces/hostenvironmentinfo.md)
+
+___
+
+### mapStringToHostBuildType
+
+▸ `Static`**mapStringToHostBuildType**(`value`: string): [HostBuildType](../enums/hostbuildtype.md) \| undefined
+
+*Defined in [js-miniapp-sdk/src/modules/bridge-info-converter.ts:41](https://github.com/rakutentech/js-miniapp/blob/e6e9208/js-miniapp-sdk/src/modules/bridge-info-converter.ts#L41)*
+
+#### Parameters:
+
+Name | Type |
+------ | ------ |
+`value` | string |
+
+**Returns:** [HostBuildType](../enums/hostbuildtype.md) \| undefined