Merge pull request #1075 from logto-io/charles-log-686-log-687-log-689-js-sdk-references

docs(docs): generate js sdk references

packages/docs/docs/sdk/JavaScript/README.md

@@ -0,0 +1 @@
+# @logto-io/js

packages/docs/docs/sdk/JavaScript/browser/README.md

@@ -0,0 +1,24 @@
+# Browser
+
+## Table of contents
+
+### Classes
+
+- [LogtoClient](classes/LogtoClient.md)
+- [LogtoClientError](classes/LogtoClientError.md)
+- [LogtoError](classes/LogtoError.md)
+- [OidcError](classes/OidcError.md)
+
+### Type Aliases
+
+- [AccessToken](types/AccessToken.md)
+- [IdTokenClaims](types/IdTokenClaims.md)
+- [LogtoClientErrorCode](types/LogtoClientErrorCode.md)
+- [LogtoConfig](types/LogtoConfig.md)
+- [LogtoErrorCode](types/LogtoErrorCode.md)
+- [LogtoSignInSessionItem](types/LogtoSignInSessionItem.md)
+- [UserInfoResponse](types/UserInfoResponse.md)
+
+### Variables
+
+- [LogtoSignInSessionItemSchema](variables/LogtoSignInSessionItemSchema.md)

packages/docs/docs/sdk/JavaScript/browser/classes/LogtoClient.md

@@ -0,0 +1,501 @@
+## Table of contents
+
+### Constructors
+
+- [constructor](LogtoClient.md#constructor)
+
+### Properties
+
+- [\_idToken](LogtoClient.md#_idtoken)
+- [accessTokenMap](LogtoClient.md#accesstokenmap)
+- [getAccessTokenPromiseMap](LogtoClient.md#getaccesstokenpromisemap)
+- [getJwtVerifyGetKey](LogtoClient.md#getjwtverifygetkey)
+- [getOidcConfig](LogtoClient.md#getoidcconfig)
+- [logtoConfig](LogtoClient.md#logtoconfig)
+- [logtoStorageKey](LogtoClient.md#logtostoragekey)
+- [requester](LogtoClient.md#requester)
+
+### Accessors
+
+- [idToken](LogtoClient.md#idtoken)
+- [isAuthenticated](LogtoClient.md#isauthenticated)
+- [refreshToken](LogtoClient.md#refreshtoken)
+- [signInSession](LogtoClient.md#signinsession)
+
+### Methods
+
+- [\_getJwtVerifyGetKey](LogtoClient.md#_getjwtverifygetkey)
+- [\_getOidcConfig](LogtoClient.md#_getoidcconfig)
+- [fetchUserInfo](LogtoClient.md#fetchuserinfo)
+- [getAccessToken](LogtoClient.md#getaccesstoken)
+- [getAccessTokenByRefreshToken](LogtoClient.md#getaccesstokenbyrefreshtoken)
+- [getIdTokenClaims](LogtoClient.md#getidtokenclaims)
+- [handleSignInCallback](LogtoClient.md#handlesignincallback)
+- [isSignInRedirected](LogtoClient.md#issigninredirected)
+- [saveCodeToken](LogtoClient.md#savecodetoken)
+- [signIn](LogtoClient.md#signin)
+- [signOut](LogtoClient.md#signout)
+- [verifyIdToken](LogtoClient.md#verifyidtoken)
+
+## Constructors
+
+### constructor
+
+**new default**(`logtoConfig`, `requester?`)
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `logtoConfig` | [`LogtoConfig`](../types/LogtoConfig.md) |
+| `requester` | <T\>(`input`: `RequestInfo`, `init?`: `RequestInit`) => `Promise`<`T`\> |
+
+#### Defined in
+
+[packages/browser/src/index.ts:75](https://github.com/logto-io/js/blob/5254dee/packages/browser/src/index.ts#L75)
+
+## Properties
+
+### \_idToken
+
+ `Private` **\_idToken**: `Nullable`<`string`\>
+
+#### Defined in
+
+[packages/browser/src/index.ts:73](https://github.com/logto-io/js/blob/5254dee/packages/browser/src/index.ts#L73)
+
+___
+
+### accessTokenMap
+
+ `Protected` `Readonly` **accessTokenMap**: `Map`<`string`, [`AccessToken`](../types/AccessToken.md)\>
+
+#### Defined in
+
+[packages/browser/src/index.ts:70](https://github.com/logto-io/js/blob/5254dee/packages/browser/src/index.ts#L70)
+
+___
+
+### getAccessTokenPromiseMap
+
+ `Private` `Readonly` **getAccessTokenPromiseMap**: `Map`<`string`, `Promise`<`string`\>\>
+
+#### Defined in
+
+[packages/browser/src/index.ts:72](https://github.com/logto-io/js/blob/5254dee/packages/browser/src/index.ts#L72)
+
+___
+
+### getJwtVerifyGetKey
+
+ `Protected` `Readonly` **getJwtVerifyGetKey**: () => `Promise`<`GetKeyFunction`<`JWSHeaderParameters`, `FlattenedJWSInput`\>\>
+
+#### Type declaration
+
+(): `Promise`<`GetKeyFunction`<`JWSHeaderParameters`, `FlattenedJWSInput`\>\>
+
+##### Returns
+
+`Promise`<`GetKeyFunction`<`JWSHeaderParameters`, `FlattenedJWSInput`\>\>
+
+#### Defined in
+
+[packages/browser/src/index.ts:65](https://github.com/logto-io/js/blob/5254dee/packages/browser/src/index.ts#L65)
+
+___
+
+### getOidcConfig
+
+ `Protected` `Readonly` **getOidcConfig**: () => `Promise`<`KeysToCamelCase`<`OidcConfigSnakeCaseResponse`\>\>
+
+#### Type declaration
+
+(): `Promise`<`KeysToCamelCase`<`OidcConfigSnakeCaseResponse`\>\>
+
+##### Returns
+
+`Promise`<`KeysToCamelCase`<`OidcConfigSnakeCaseResponse`\>\>
+
+#### Defined in
+
+[packages/browser/src/index.ts:64](https://github.com/logto-io/js/blob/5254dee/packages/browser/src/index.ts#L64)
+
+___
+
+### logtoConfig
+
+ `Protected` `Readonly` **logtoConfig**: [`LogtoConfig`](../types/LogtoConfig.md)
+
+#### Defined in
+
+[packages/browser/src/index.ts:63](https://github.com/logto-io/js/blob/5254dee/packages/browser/src/index.ts#L63)
+
+___
+
+### logtoStorageKey
+
+ `Protected` `Readonly` **logtoStorageKey**: `string`
+
+#### Defined in
+
+[packages/browser/src/index.ts:67](https://github.com/logto-io/js/blob/5254dee/packages/browser/src/index.ts#L67)
+
+___
+
+### requester
+
+ `Protected` `Readonly` **requester**: <T\>(`input`: `RequestInfo`, `init?`: `RequestInit`) => `Promise`<`T`\>
+
+#### Type declaration
+
+<`T`\>(`input`, `init?`): `Promise`<`T`\>
+
+##### Type parameters
+
+| Name |
+| :------ |
+| `T` |
+
+##### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `input` | `RequestInfo` |
+| `init?` | `RequestInit` |
+
+##### Returns
+
+`Promise`<`T`\>
+
+#### Defined in
+
+[packages/browser/src/index.ts:68](https://github.com/logto-io/js/blob/5254dee/packages/browser/src/index.ts#L68)
+
+## Accessors
+
+### idToken
+
+`get` **idToken**(): `Nullable`<`string`\>
+
+#### Returns
+
+`Nullable`<`string`\>
+
+#### Defined in
+
+[packages/browser/src/index.ts:130](https://github.com/logto-io/js/blob/5254dee/packages/browser/src/index.ts#L130)
+
+`set` **idToken**(`idToken`): `void`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `idToken` | `Nullable`<`string`\> |
+
+#### Returns
+
+`void`
+
+#### Defined in
+
+[packages/browser/src/index.ts:134](https://github.com/logto-io/js/blob/5254dee/packages/browser/src/index.ts#L134)
+
+___
+
+### isAuthenticated
+
+`get` **isAuthenticated**(): `boolean`
+
+#### Returns
+
+`boolean`
+
+#### Defined in
+
+[packages/browser/src/index.ts:82](https://github.com/logto-io/js/blob/5254dee/packages/browser/src/index.ts#L82)
+
+___
+
+### refreshToken
+
+`get` **refreshToken**(): `Nullable`<`string`\>
+
+#### Returns
+
+`Nullable`<`string`\>
+
+#### Defined in
+
+[packages/browser/src/index.ts:114](https://github.com/logto-io/js/blob/5254dee/packages/browser/src/index.ts#L114)
+
+`set` **refreshToken**(`refreshToken`): `void`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `refreshToken` | `Nullable`<`string`\> |
+
+#### Returns
+
+`void`
+
+#### Defined in
+
+[packages/browser/src/index.ts:118](https://github.com/logto-io/js/blob/5254dee/packages/browser/src/index.ts#L118)
+
+___
+
+### signInSession
+
+`Protected` `get` **signInSession**(): `Nullable`<{ `codeVerifier`: `string` ; `redirectUri`: `string` ; `state`: `string`  }\>
+
+#### Returns
+
+`Nullable`<{ `codeVerifier`: `string` ; `redirectUri`: `string` ; `state`: `string`  }\>
+
+#### Defined in
+
+[packages/browser/src/index.ts:86](https://github.com/logto-io/js/blob/5254dee/packages/browser/src/index.ts#L86)
+
+`Protected` `set` **signInSession**(`logtoSignInSessionItem`): `void`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `logtoSignInSessionItem` | `Nullable`<{ `codeVerifier`: `string` ; `redirectUri`: `string` ; `state`: `string`  }\> |
+
+#### Returns
+
+`void`
+
+#### Defined in
+
+[packages/browser/src/index.ts:103](https://github.com/logto-io/js/blob/5254dee/packages/browser/src/index.ts#L103)
+
+## Methods
+
+### \_getJwtVerifyGetKey
+
+`Private` **_getJwtVerifyGetKey**(): `Promise`<`GetKeyFunction`<`JWSHeaderParameters`, `FlattenedJWSInput`\>\>
+
+#### Returns
+
+`Promise`<`GetKeyFunction`<`JWSHeaderParameters`, `FlattenedJWSInput`\>\>
+
+#### Defined in
+
+[packages/browser/src/index.ts:346](https://github.com/logto-io/js/blob/5254dee/packages/browser/src/index.ts#L346)
+
+___
+
+### \_getOidcConfig
+
+`Private` **_getOidcConfig**(): `Promise`<`KeysToCamelCase`<`OidcConfigSnakeCaseResponse`\>\>
+
+#### Returns
+
+`Promise`<`KeysToCamelCase`<`OidcConfigSnakeCaseResponse`\>\>
+
+#### Defined in
+
+[packages/browser/src/index.ts:339](https://github.com/logto-io/js/blob/5254dee/packages/browser/src/index.ts#L339)
+
+___
+
+### fetchUserInfo
+
+**fetchUserInfo**(): `Promise`<[`UserInfoResponse`](../types/UserInfoResponse.md)\>
+
+#### Returns
+
+`Promise`<[`UserInfoResponse`](../types/UserInfoResponse.md)\>
+
+#### Defined in
+
+[packages/browser/src/index.ts:198](https://github.com/logto-io/js/blob/5254dee/packages/browser/src/index.ts#L198)
+
+___
+
+### getAccessToken
+
+**getAccessToken**(`resource?`): `Promise`<`string`\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `resource?` | `string` |
+
+#### Returns
+
+`Promise`<`string`\>
+
+#### Defined in
+
+[packages/browser/src/index.ts:149](https://github.com/logto-io/js/blob/5254dee/packages/browser/src/index.ts#L149)
+
+___
+
+### getAccessTokenByRefreshToken
+
+`Private` **getAccessTokenByRefreshToken**(`resource?`): `Promise`<`string`\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `resource?` | `string` |
+
+#### Returns
+
+`Promise`<`string`\>
+
+#### Defined in
+
+[packages/browser/src/index.ts:304](https://github.com/logto-io/js/blob/5254dee/packages/browser/src/index.ts#L304)
+
+___
+
+### getIdTokenClaims
+
+**getIdTokenClaims**(): `Object`
+
+#### Returns
+
+`Object`
+
+| Name | Type |
+| :------ | :------ |
+| `at_hash?` | `string` |
+| `aud` | `string` |
+| `exp` | `number` |
+| `iat` | `number` |
+| `iss` | `string` |
+| `sub` | `string` |
+
+#### Defined in
+
+[packages/browser/src/index.ts:190](https://github.com/logto-io/js/blob/5254dee/packages/browser/src/index.ts#L190)
+
+___
+
+### handleSignInCallback
+
+**handleSignInCallback**(`callbackUri`): `Promise`<`void`\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `callbackUri` | `string` |
+
+#### Returns
+
+`Promise`<`void`\>
+
+#### Defined in
+
+[packages/browser/src/index.ts:246](https://github.com/logto-io/js/blob/5254dee/packages/browser/src/index.ts#L246)
+
+___
+
+### isSignInRedirected
+
+**isSignInRedirected**(`url`): `boolean`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `url` | `string` |
+
+#### Returns
+
+`boolean`
+
+#### Defined in
+
+[packages/browser/src/index.ts:234](https://github.com/logto-io/js/blob/5254dee/packages/browser/src/index.ts#L234)
+
+___
+
+### saveCodeToken
+
+`Private` **saveCodeToken**(`__namedParameters`): `void`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `__namedParameters` | `KeysToCamelCase`<`SnakeCaseCodeTokenResponse`\> |
+
+#### Returns
+
+`void`
+
+#### Defined in
+
+[packages/browser/src/index.ts:364](https://github.com/logto-io/js/blob/5254dee/packages/browser/src/index.ts#L364)
+
+___
+
+### signIn
+
+**signIn**(`redirectUri`): `Promise`<`void`\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `redirectUri` | `string` |
+
+#### Returns
+
+`Promise`<`void`\>
+
+#### Defined in
+
+[packages/browser/src/index.ts:209](https://github.com/logto-io/js/blob/5254dee/packages/browser/src/index.ts#L209)
+
+___
+
+### signOut
+
+**signOut**(`postLogoutRedirectUri?`): `Promise`<`void`\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `postLogoutRedirectUri?` | `string` |
+
+#### Returns
+
+`Promise`<`void`\>
+
+#### Defined in
+
+[packages/browser/src/index.ts:275](https://github.com/logto-io/js/blob/5254dee/packages/browser/src/index.ts#L275)
+
+___
+
+### verifyIdToken
+
+`Private` **verifyIdToken**(`idToken`): `Promise`<`void`\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `idToken` | `string` |
+
+#### Returns
+
+`Promise`<`void`\>
+
+#### Defined in
+
+[packages/browser/src/index.ts:352](https://github.com/logto-io/js/blob/5254dee/packages/browser/src/index.ts#L352)

packages/docs/docs/sdk/JavaScript/browser/classes/LogtoClientError.md

@@ -0,0 +1,182 @@
+## Hierarchy
+
+- `Error`
+
+  ↳ **`LogtoClientError`**
+
+## Table of contents
+
+### Constructors
+
+- [constructor](LogtoClientError.md#constructor)
+
+### Properties
+
+- [code](LogtoClientError.md#code)
+- [data](LogtoClientError.md#data)
+- [message](LogtoClientError.md#message)
+- [name](LogtoClientError.md#name)
+- [stack](LogtoClientError.md#stack)
+- [prepareStackTrace](LogtoClientError.md#preparestacktrace)
+- [stackTraceLimit](LogtoClientError.md#stacktracelimit)
+
+### Methods
+
+- [captureStackTrace](LogtoClientError.md#capturestacktrace)
+
+## Constructors
+
+### constructor
+
+**new LogtoClientError**(`code`, `data?`)
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `code` | [`LogtoClientErrorCode`](../types/LogtoClientErrorCode.md) |
+| `data?` | `unknown` |
+
+#### Overrides
+
+Error.constructor
+
+#### Defined in
+
+[packages/browser/src/errors.ts:33](https://github.com/logto-io/js/blob/5254dee/packages/browser/src/errors.ts#L33)
+
+## Properties
+
+### code
+
+ **code**: [`LogtoClientErrorCode`](../types/LogtoClientErrorCode.md)
+
+#### Defined in
+
+[packages/browser/src/errors.ts:30](https://github.com/logto-io/js/blob/5254dee/packages/browser/src/errors.ts#L30)
+
+___
+
+### data
+
+ **data**: `unknown`
+
+#### Defined in
+
+[packages/browser/src/errors.ts:31](https://github.com/logto-io/js/blob/5254dee/packages/browser/src/errors.ts#L31)
+
+___
+
+### message
+
+ **message**: `string`
+
+#### Inherited from
+
+Error.message
+
+#### Defined in
+
+node_modules/.pnpm/typescript@4.5.5/node_modules/typescript/lib/lib.es5.d.ts:1023
+
+___
+
+### name
+
+ **name**: `string`
+
+#### Inherited from
+
+Error.name
+
+#### Defined in
+
+node_modules/.pnpm/typescript@4.5.5/node_modules/typescript/lib/lib.es5.d.ts:1022
+
+___
+
+### stack
+
+ `Optional` **stack**: `string`
+
+#### Inherited from
+
+Error.stack
+
+#### Defined in
+
+node_modules/.pnpm/typescript@4.5.5/node_modules/typescript/lib/lib.es5.d.ts:1024
+
+___
+
+### prepareStackTrace
+
+ `Static` `Optional` **prepareStackTrace**: (`err`: `Error`, `stackTraces`: `CallSite`[]) => `any`
+
+#### Type declaration
+
+(`err`, `stackTraces`): `any`
+
+Optional override for formatting stack traces
+
+**`see`** https://v8.dev/docs/stack-trace-api#customizing-stack-traces
+
+##### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `err` | `Error` |
+| `stackTraces` | `CallSite`[] |
+
+##### Returns
+
+`any`
+
+#### Inherited from
+
+Error.prepareStackTrace
+
+#### Defined in
+
+node_modules/.pnpm/@types+node@17.0.19/node_modules/@types/node/globals.d.ts:11
+
+___
+
+### stackTraceLimit
+
+ `Static` **stackTraceLimit**: `number`
+
+#### Inherited from
+
+Error.stackTraceLimit
+
+#### Defined in
+
+node_modules/.pnpm/@types+node@17.0.19/node_modules/@types/node/globals.d.ts:13
+
+## Methods
+
+### captureStackTrace
+
+`Static` **captureStackTrace**(`targetObject`, `constructorOpt?`): `void`
+
+Create .stack property on a target object
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `targetObject` | `object` |
+| `constructorOpt?` | `Function` |
+
+#### Returns
+
+`void`
+
+#### Inherited from
+
+Error.captureStackTrace
+
+#### Defined in
+
+node_modules/.pnpm/@types+node@17.0.19/node_modules/@types/node/globals.d.ts:4

packages/docs/docs/sdk/JavaScript/browser/classes/LogtoError.md

@@ -0,0 +1,182 @@
+## Hierarchy
+
+- `Error`
+
+  ↳ **`LogtoError`**
+
+## Table of contents
+
+### Constructors
+
+- [constructor](LogtoError.md#constructor)
+
+### Properties
+
+- [code](LogtoError.md#code)
+- [data](LogtoError.md#data)
+- [message](LogtoError.md#message)
+- [name](LogtoError.md#name)
+- [stack](LogtoError.md#stack)
+- [prepareStackTrace](LogtoError.md#preparestacktrace)
+- [stackTraceLimit](LogtoError.md#stacktracelimit)
+
+### Methods
+
+- [captureStackTrace](LogtoError.md#capturestacktrace)
+
+## Constructors
+
+### constructor
+
+**new LogtoError**(`code`, `data?`)
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `code` | [`LogtoErrorCode`](../types/LogtoErrorCode.md) |
+| `data?` | `unknown` |
+
+#### Overrides
+
+Error.constructor
+
+#### Defined in
+
+packages/js/lib/utils/errors.d.ts:22
+
+## Properties
+
+### code
+
+ **code**: [`LogtoErrorCode`](../types/LogtoErrorCode.md)
+
+#### Defined in
+
+packages/js/lib/utils/errors.d.ts:20
+
+___
+
+### data
+
+ **data**: `unknown`
+
+#### Defined in
+
+packages/js/lib/utils/errors.d.ts:21
+
+___
+
+### message
+
+ **message**: `string`
+
+#### Inherited from
+
+Error.message
+
+#### Defined in
+
+node_modules/.pnpm/typescript@4.5.5/node_modules/typescript/lib/lib.es5.d.ts:1023
+
+___
+
+### name
+
+ **name**: `string`
+
+#### Inherited from
+
+Error.name
+
+#### Defined in
+
+node_modules/.pnpm/typescript@4.5.5/node_modules/typescript/lib/lib.es5.d.ts:1022
+
+___
+
+### stack
+
+ `Optional` **stack**: `string`
+
+#### Inherited from
+
+Error.stack
+
+#### Defined in
+
+node_modules/.pnpm/typescript@4.5.5/node_modules/typescript/lib/lib.es5.d.ts:1024
+
+___
+
+### prepareStackTrace
+
+ `Static` `Optional` **prepareStackTrace**: (`err`: `Error`, `stackTraces`: `CallSite`[]) => `any`
+
+#### Type declaration
+
+(`err`, `stackTraces`): `any`
+
+Optional override for formatting stack traces
+
+**`see`** https://v8.dev/docs/stack-trace-api#customizing-stack-traces
+
+##### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `err` | `Error` |
+| `stackTraces` | `CallSite`[] |
+
+##### Returns
+
+`any`
+
+#### Inherited from
+
+Error.prepareStackTrace
+
+#### Defined in
+
+node_modules/.pnpm/@types+node@17.0.19/node_modules/@types/node/globals.d.ts:11
+
+___
+
+### stackTraceLimit
+
+ `Static` **stackTraceLimit**: `number`
+
+#### Inherited from
+
+Error.stackTraceLimit
+
+#### Defined in
+
+node_modules/.pnpm/@types+node@17.0.19/node_modules/@types/node/globals.d.ts:13
+
+## Methods
+
+### captureStackTrace
+
+`Static` **captureStackTrace**(`targetObject`, `constructorOpt?`): `void`
+
+Create .stack property on a target object
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `targetObject` | `object` |
+| `constructorOpt?` | `Function` |
+
+#### Returns
+
+`void`
+
+#### Inherited from
+
+Error.captureStackTrace
+
+#### Defined in
+
+node_modules/.pnpm/@types+node@17.0.19/node_modules/@types/node/globals.d.ts:4

packages/docs/docs/sdk/JavaScript/browser/classes/OidcError.md

@@ -0,0 +1,47 @@
+## Table of contents
+
+### Constructors
+
+- [constructor](OidcError.md#constructor)
+
+### Properties
+
+- [error](OidcError.md#error)
+- [errorDescription](OidcError.md#errordescription)
+
+## Constructors
+
+### constructor
+
+**new OidcError**(`error`, `errorDescription`)
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `error` | `string` |
+| `errorDescription` | `string` |
+
+#### Defined in
+
+packages/js/lib/utils/errors.d.ts:31
+
+## Properties
+
+### error
+
+ **error**: `string`
+
+#### Defined in
+
+packages/js/lib/utils/errors.d.ts:29
+
+___
+
+### errorDescription
+
+ **errorDescription**: `string`
+
+#### Defined in
+
+packages/js/lib/utils/errors.d.ts:30

packages/docs/docs/sdk/JavaScript/browser/types/AccessToken.md

@@ -0,0 +1,13 @@
+**AccessToken**: `Object`
+
+#### Type declaration
+
+| Name | Type |
+| :------ | :------ |
+| `expiresAt` | `number` |
+| `scope` | `string` |
+| `token` | `string` |
+
+#### Defined in
+
+[packages/browser/src/index.ts:48](https://github.com/logto-io/js/blob/5254dee/packages/browser/src/index.ts#L48)

packages/docs/docs/sdk/JavaScript/browser/types/IdTokenClaims.md

@@ -0,0 +1,5 @@
+**IdTokenClaims**: `s.Infer`<typeof `IdTokenClaimsSchema`\>
+
+#### Defined in
+
+packages/js/lib/utils/id-token.d.ts:21

packages/docs/docs/sdk/JavaScript/browser/types/LogtoClientErrorCode.md

@@ -0,0 +1,5 @@
+**LogtoClientErrorCode**: `NormalizeKeyPaths`<typeof `logtoClientErrorCodes`\>
+
+#### Defined in
+
+[packages/browser/src/errors.ts:15](https://github.com/logto-io/js/blob/5254dee/packages/browser/src/errors.ts#L15)

packages/docs/docs/sdk/JavaScript/browser/types/LogtoConfig.md

@@ -0,0 +1,15 @@
+**LogtoConfig**: `Object`
+
+#### Type declaration
+
+| Name | Type |
+| :------ | :------ |
+| `appId` | `string` |
+| `endpoint` | `string` |
+| `resources?` | `string`[] |
+| `scopes?` | `string`[] |
+| `usingPersistStorage?` | `boolean` |
+
+#### Defined in
+
+[packages/browser/src/index.ts:40](https://github.com/logto-io/js/blob/5254dee/packages/browser/src/index.ts#L40)

packages/docs/docs/sdk/JavaScript/browser/types/LogtoErrorCode.md

@@ -0,0 +1,5 @@
+**LogtoErrorCode**: `NormalizeKeyPaths`<typeof `logtoErrorCodes`\>
+
+#### Defined in
+
+packages/js/lib/utils/errors.d.ts:18

packages/docs/docs/sdk/JavaScript/browser/types/LogtoSignInSessionItem.md

@@ -0,0 +1,5 @@
+**LogtoSignInSessionItem**: `Infer`<typeof [`LogtoSignInSessionItemSchema`](../variables/LogtoSignInSessionItemSchema.md)\>
+
+#### Defined in
+
+[packages/browser/src/index.ts:60](https://github.com/logto-io/js/blob/5254dee/packages/browser/src/index.ts#L60)

packages/docs/docs/sdk/JavaScript/browser/types/UserInfoResponse.md

@@ -0,0 +1,11 @@
+**UserInfoResponse**: `Object`
+
+#### Type declaration
+
+| Name | Type |
+| :------ | :------ |
+| `sub` | `string` |
+
+#### Defined in
+
+packages/js/lib/core/user-info.d.ts:2

packages/docs/docs/sdk/JavaScript/browser/variables/LogtoSignInSessionItemSchema.md

@@ -0,0 +1,5 @@
+`Const` **LogtoSignInSessionItemSchema**: `Struct`<{ `codeVerifier`: `string` ; `redirectUri`: `string` ; `state`: `string`  }, { `codeVerifier`: `Struct`<`string`, ``null``\> ; `redirectUri`: `Struct`<`string`, ``null``\> ; `state`: `Struct`<`string`, ``null``\>  }\>
+
+#### Defined in
+
+[packages/browser/src/index.ts:54](https://github.com/logto-io/js/blob/5254dee/packages/browser/src/index.ts#L54)

packages/docs/docs/sdk/JavaScript/js/README.md

@@ -0,0 +1,51 @@
+# JS Core
+
+## Table of contents
+
+### Enumerations
+
+- [QueryKey](enums/QueryKey.md)
+- [TokenGrantType](enums/TokenGrantType.md)
+
+### Classes
+
+- [LogtoError](classes/LogtoError.md)
+- [LogtoRequestError](classes/LogtoRequestError.md)
+- [OidcError](classes/OidcError.md)
+
+### Type Aliases
+
+- [CodeTokenResponse](types/CodeTokenResponse.md)
+- [FetchTokenByAuthorizationCodeParameters](types/FetchTokenByAuthorizationCodeParameters.md)
+- [FetchTokenByRefreshTokenParameters](types/FetchTokenByRefreshTokenParameters.md)
+- [IdTokenClaims](types/IdTokenClaims.md)
+- [LogtoErrorCode](types/LogtoErrorCode.md)
+- [OidcConfigResponse](types/OidcConfigResponse.md)
+- [RefreshTokenTokenResponse](types/RefreshTokenTokenResponse.md)
+- [Requester](types/Requester.md)
+- [SignInUriParameters](types/SignInUriParameters.md)
+- [UserInfoResponse](types/UserInfoResponse.md)
+
+### Variables
+
+- [ContentType](variables/ContentType.md)
+- [discoveryPath](variables/discoveryPath.md)
+
+### Functions
+
+- [createRequester](functions/createRequester.md)
+- [decodeIdToken](functions/decodeIdToken.md)
+- [fetchOidcConfig](functions/fetchOidcConfig.md)
+- [fetchTokenByAuthorizationCode](functions/fetchTokenByAuthorizationCode.md)
+- [fetchTokenByRefreshToken](functions/fetchTokenByRefreshToken.md)
+- [fetchUserInfo](functions/fetchUserInfo.md)
+- [generateCodeChallenge](functions/generateCodeChallenge.md)
+- [generateCodeVerifier](functions/generateCodeVerifier.md)
+- [generateSignInUri](functions/generateSignInUri.md)
+- [generateSignOutUri](functions/generateSignOutUri.md)
+- [generateState](functions/generateState.md)
+- [parseUriParameters](functions/parseUriParameters.md)
+- [revoke](functions/revoke.md)
+- [verifyAndParseCodeFromCallbackUri](functions/verifyAndParseCodeFromCallbackUri.md)
+- [verifyIdToken](functions/verifyIdToken.md)
+- [withReservedScopes](functions/withReservedScopes.md)

packages/docs/docs/sdk/JavaScript/js/classes/LogtoError.md

@@ -0,0 +1,182 @@
+## Hierarchy
+
+- `Error`
+
+  ↳ **`LogtoError`**
+
+## Table of contents
+
+### Constructors
+
+- [constructor](LogtoError.md#constructor)
+
+### Properties
+
+- [code](LogtoError.md#code)
+- [data](LogtoError.md#data)
+- [message](LogtoError.md#message)
+- [name](LogtoError.md#name)
+- [stack](LogtoError.md#stack)
+- [prepareStackTrace](LogtoError.md#preparestacktrace)
+- [stackTraceLimit](LogtoError.md#stacktracelimit)
+
+### Methods
+
+- [captureStackTrace](LogtoError.md#capturestacktrace)
+
+## Constructors
+
+### constructor
+
+**new LogtoError**(`code`, `data?`)
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `code` | [`LogtoErrorCode`](../types/LogtoErrorCode.md) |
+| `data?` | `unknown` |
+
+#### Overrides
+
+Error.constructor
+
+#### Defined in
+
+[packages/js/src/utils/errors.ts:39](https://github.com/logto-io/js/blob/5254dee/packages/js/src/utils/errors.ts#L39)
+
+## Properties
+
+### code
+
+ **code**: [`LogtoErrorCode`](../types/LogtoErrorCode.md)
+
+#### Defined in
+
+[packages/js/src/utils/errors.ts:36](https://github.com/logto-io/js/blob/5254dee/packages/js/src/utils/errors.ts#L36)
+
+___
+
+### data
+
+ **data**: `unknown`
+
+#### Defined in
+
+[packages/js/src/utils/errors.ts:37](https://github.com/logto-io/js/blob/5254dee/packages/js/src/utils/errors.ts#L37)
+
+___
+
+### message
+
+ **message**: `string`
+
+#### Inherited from
+
+Error.message
+
+#### Defined in
+
+node_modules/.pnpm/typescript@4.5.5/node_modules/typescript/lib/lib.es5.d.ts:1023
+
+___
+
+### name
+
+ **name**: `string`
+
+#### Inherited from
+
+Error.name
+
+#### Defined in
+
+node_modules/.pnpm/typescript@4.5.5/node_modules/typescript/lib/lib.es5.d.ts:1022
+
+___
+
+### stack
+
+ `Optional` **stack**: `string`
+
+#### Inherited from
+
+Error.stack
+
+#### Defined in
+
+node_modules/.pnpm/typescript@4.5.5/node_modules/typescript/lib/lib.es5.d.ts:1024
+
+___
+
+### prepareStackTrace
+
+ `Static` `Optional` **prepareStackTrace**: (`err`: `Error`, `stackTraces`: `CallSite`[]) => `any`
+
+#### Type declaration
+
+(`err`, `stackTraces`): `any`
+
+Optional override for formatting stack traces
+
+**`see`** https://v8.dev/docs/stack-trace-api#customizing-stack-traces
+
+##### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `err` | `Error` |
+| `stackTraces` | `CallSite`[] |
+
+##### Returns
+
+`any`
+
+#### Inherited from
+
+Error.prepareStackTrace
+
+#### Defined in
+
+node_modules/.pnpm/@types+node@17.0.19/node_modules/@types/node/globals.d.ts:11
+
+___
+
+### stackTraceLimit
+
+ `Static` **stackTraceLimit**: `number`
+
+#### Inherited from
+
+Error.stackTraceLimit
+
+#### Defined in
+
+node_modules/.pnpm/@types+node@17.0.19/node_modules/@types/node/globals.d.ts:13
+
+## Methods
+
+### captureStackTrace
+
+`Static` **captureStackTrace**(`targetObject`, `constructorOpt?`): `void`
+
+Create .stack property on a target object
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `targetObject` | `object` |
+| `constructorOpt?` | `Function` |
+
+#### Returns
+
+`void`
+
+#### Inherited from
+
+Error.captureStackTrace
+
+#### Defined in
+
+node_modules/.pnpm/@types+node@17.0.19/node_modules/@types/node/globals.d.ts:4

packages/docs/docs/sdk/JavaScript/js/classes/LogtoRequestError.md

@@ -0,0 +1,171 @@
+## Hierarchy
+
+- `Error`
+
+  ↳ **`LogtoRequestError`**
+
+## Table of contents
+
+### Constructors
+
+- [constructor](LogtoRequestError.md#constructor)
+
+### Properties
+
+- [code](LogtoRequestError.md#code)
+- [message](LogtoRequestError.md#message)
+- [name](LogtoRequestError.md#name)
+- [stack](LogtoRequestError.md#stack)
+- [prepareStackTrace](LogtoRequestError.md#preparestacktrace)
+- [stackTraceLimit](LogtoRequestError.md#stacktracelimit)
+
+### Methods
+
+- [captureStackTrace](LogtoRequestError.md#capturestacktrace)
+
+## Constructors
+
+### constructor
+
+**new LogtoRequestError**(`code`, `message`)
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `code` | `string` |
+| `message` | `string` |
+
+#### Overrides
+
+Error.constructor
+
+#### Defined in
+
+[packages/js/src/utils/errors.ts:49](https://github.com/logto-io/js/blob/5254dee/packages/js/src/utils/errors.ts#L49)
+
+## Properties
+
+### code
+
+ **code**: `string`
+
+#### Defined in
+
+[packages/js/src/utils/errors.ts:47](https://github.com/logto-io/js/blob/5254dee/packages/js/src/utils/errors.ts#L47)
+
+___
+
+### message
+
+ **message**: `string`
+
+#### Inherited from
+
+Error.message
+
+#### Defined in
+
+node_modules/.pnpm/typescript@4.5.5/node_modules/typescript/lib/lib.es5.d.ts:1023
+
+___
+
+### name
+
+ **name**: `string`
+
+#### Inherited from
+
+Error.name
+
+#### Defined in
+
+node_modules/.pnpm/typescript@4.5.5/node_modules/typescript/lib/lib.es5.d.ts:1022
+
+___
+
+### stack
+
+ `Optional` **stack**: `string`
+
+#### Inherited from
+
+Error.stack
+
+#### Defined in
+
+node_modules/.pnpm/typescript@4.5.5/node_modules/typescript/lib/lib.es5.d.ts:1024
+
+___
+
+### prepareStackTrace
+
+ `Static` `Optional` **prepareStackTrace**: (`err`: `Error`, `stackTraces`: `CallSite`[]) => `any`
+
+#### Type declaration
+
+(`err`, `stackTraces`): `any`
+
+Optional override for formatting stack traces
+
+**`see`** https://v8.dev/docs/stack-trace-api#customizing-stack-traces
+
+##### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `err` | `Error` |
+| `stackTraces` | `CallSite`[] |
+
+##### Returns
+
+`any`
+
+#### Inherited from
+
+Error.prepareStackTrace
+
+#### Defined in
+
+node_modules/.pnpm/@types+node@17.0.19/node_modules/@types/node/globals.d.ts:11
+
+___
+
+### stackTraceLimit
+
+ `Static` **stackTraceLimit**: `number`
+
+#### Inherited from
+
+Error.stackTraceLimit
+
+#### Defined in
+
+node_modules/.pnpm/@types+node@17.0.19/node_modules/@types/node/globals.d.ts:13
+
+## Methods
+
+### captureStackTrace
+
+`Static` **captureStackTrace**(`targetObject`, `constructorOpt?`): `void`
+
+Create .stack property on a target object
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `targetObject` | `object` |
+| `constructorOpt?` | `Function` |
+
+#### Returns
+
+`void`
+
+#### Inherited from
+
+Error.captureStackTrace
+
+#### Defined in
+
+node_modules/.pnpm/@types+node@17.0.19/node_modules/@types/node/globals.d.ts:4

packages/docs/docs/sdk/JavaScript/js/classes/OidcError.md

@@ -0,0 +1,47 @@
+## Table of contents
+
+### Constructors
+
+- [constructor](OidcError.md#constructor)
+
+### Properties
+
+- [error](OidcError.md#error)
+- [errorDescription](OidcError.md#errordescription)
+
+## Constructors
+
+### constructor
+
+**new OidcError**(`error`, `errorDescription?`)
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `error` | `string` |
+| `errorDescription?` | `string` |
+
+#### Defined in
+
+[packages/js/src/utils/errors.ts:59](https://github.com/logto-io/js/blob/5254dee/packages/js/src/utils/errors.ts#L59)
+
+## Properties
+
+### error
+
+ **error**: `string`
+
+#### Defined in
+
+[packages/js/src/utils/errors.ts:56](https://github.com/logto-io/js/blob/5254dee/packages/js/src/utils/errors.ts#L56)
+
+___
+
+### errorDescription
+
+ `Optional` **errorDescription**: `string`
+
+#### Defined in
+
+[packages/js/src/utils/errors.ts:57](https://github.com/logto-io/js/blob/5254dee/packages/js/src/utils/errors.ts#L57)

packages/docs/docs/sdk/JavaScript/js/enums/QueryKey.md

@@ -0,0 +1,213 @@
+## Table of contents
+
+### Enumeration Members
+
+- [ClientId](QueryKey.md#clientid)
+- [Code](QueryKey.md#code)
+- [CodeChallenge](QueryKey.md#codechallenge)
+- [CodeChallengeMethod](QueryKey.md#codechallengemethod)
+- [CodeVerifier](QueryKey.md#codeverifier)
+- [Error](QueryKey.md#error)
+- [ErrorDescription](QueryKey.md#errordescription)
+- [GrantType](QueryKey.md#granttype)
+- [IdToken](QueryKey.md#idtoken)
+- [IdTokenHint](QueryKey.md#idtokenhint)
+- [PostLogoutRedirectUri](QueryKey.md#postlogoutredirecturi)
+- [Prompt](QueryKey.md#prompt)
+- [RedirectUri](QueryKey.md#redirecturi)
+- [RefreshToken](QueryKey.md#refreshtoken)
+- [Resource](QueryKey.md#resource)
+- [ResponseType](QueryKey.md#responsetype)
+- [Scope](QueryKey.md#scope)
+- [State](QueryKey.md#state)
+- [Token](QueryKey.md#token)
+
+## Enumeration Members
+
+### ClientId
+
+ **ClientId**
+
+#### Defined in
+
+[packages/js/src/consts/index.ts:11](https://github.com/logto-io/js/blob/5254dee/packages/js/src/consts/index.ts#L11)
+
+___
+
+### Code
+
+ **Code**
+
+#### Defined in
+
+[packages/js/src/consts/index.ts:12](https://github.com/logto-io/js/blob/5254dee/packages/js/src/consts/index.ts#L12)
+
+___
+
+### CodeChallenge
+
+ **CodeChallenge**
+
+#### Defined in
+
+[packages/js/src/consts/index.ts:13](https://github.com/logto-io/js/blob/5254dee/packages/js/src/consts/index.ts#L13)
+
+___
+
+### CodeChallengeMethod
+
+ **CodeChallengeMethod**
+
+#### Defined in
+
+[packages/js/src/consts/index.ts:14](https://github.com/logto-io/js/blob/5254dee/packages/js/src/consts/index.ts#L14)
+
+___
+
+### CodeVerifier
+
+ **CodeVerifier**
+
+#### Defined in
+
+[packages/js/src/consts/index.ts:15](https://github.com/logto-io/js/blob/5254dee/packages/js/src/consts/index.ts#L15)
+
+___
+
+### Error
+
+ **Error**
+
+#### Defined in
+
+[packages/js/src/consts/index.ts:16](https://github.com/logto-io/js/blob/5254dee/packages/js/src/consts/index.ts#L16)
+
+___
+
+### ErrorDescription
+
+ **ErrorDescription**
+
+#### Defined in
+
+[packages/js/src/consts/index.ts:17](https://github.com/logto-io/js/blob/5254dee/packages/js/src/consts/index.ts#L17)
+
+___
+
+### GrantType
+
+ **GrantType**
+
+#### Defined in
+
+[packages/js/src/consts/index.ts:18](https://github.com/logto-io/js/blob/5254dee/packages/js/src/consts/index.ts#L18)
+
+___
+
+### IdToken
+
+ **IdToken**
+
+#### Defined in
+
+[packages/js/src/consts/index.ts:19](https://github.com/logto-io/js/blob/5254dee/packages/js/src/consts/index.ts#L19)
+
+___
+
+### IdTokenHint
+
+ **IdTokenHint**
+
+#### Defined in
+
+[packages/js/src/consts/index.ts:20](https://github.com/logto-io/js/blob/5254dee/packages/js/src/consts/index.ts#L20)
+
+___
+
+### PostLogoutRedirectUri
+
+ **PostLogoutRedirectUri**
+
+#### Defined in
+
+[packages/js/src/consts/index.ts:21](https://github.com/logto-io/js/blob/5254dee/packages/js/src/consts/index.ts#L21)
+
+___
+
+### Prompt
+
+ **Prompt**
+
+#### Defined in
+
+[packages/js/src/consts/index.ts:22](https://github.com/logto-io/js/blob/5254dee/packages/js/src/consts/index.ts#L22)
+
+___
+
+### RedirectUri
+
+ **RedirectUri**
+
+#### Defined in
+
+[packages/js/src/consts/index.ts:23](https://github.com/logto-io/js/blob/5254dee/packages/js/src/consts/index.ts#L23)
+
+___
+
+### RefreshToken
+
+ **RefreshToken**
+
+#### Defined in
+
+[packages/js/src/consts/index.ts:24](https://github.com/logto-io/js/blob/5254dee/packages/js/src/consts/index.ts#L24)
+
+___
+
+### Resource
+
+ **Resource**
+
+#### Defined in
+
+[packages/js/src/consts/index.ts:25](https://github.com/logto-io/js/blob/5254dee/packages/js/src/consts/index.ts#L25)
+
+___
+
+### ResponseType
+
+ **ResponseType**
+
+#### Defined in
+
+[packages/js/src/consts/index.ts:26](https://github.com/logto-io/js/blob/5254dee/packages/js/src/consts/index.ts#L26)
+
+___
+
+### Scope
+
+ **Scope**
+
+#### Defined in
+
+[packages/js/src/consts/index.ts:27](https://github.com/logto-io/js/blob/5254dee/packages/js/src/consts/index.ts#L27)
+
+___
+
+### State
+
+ **State**
+
+#### Defined in
+
+[packages/js/src/consts/index.ts:28](https://github.com/logto-io/js/blob/5254dee/packages/js/src/consts/index.ts#L28)
+
+___
+
+### Token
+
+ **Token**
+
+#### Defined in
+
+[packages/js/src/consts/index.ts:29](https://github.com/logto-io/js/blob/5254dee/packages/js/src/consts/index.ts#L29)

packages/docs/docs/sdk/JavaScript/js/enums/TokenGrantType.md

@@ -0,0 +1,26 @@
+## Table of contents
+
+### Enumeration Members
+
+- [AuthorizationCode](TokenGrantType.md#authorizationcode)
+- [RefreshToken](TokenGrantType.md#refreshtoken)
+
+## Enumeration Members
+
+### AuthorizationCode
+
+ **AuthorizationCode**
+
+#### Defined in
+
+[packages/js/src/consts/index.ts:6](https://github.com/logto-io/js/blob/5254dee/packages/js/src/consts/index.ts#L6)
+
+___
+
+### RefreshToken
+
+ **RefreshToken**
+
+#### Defined in
+
+[packages/js/src/consts/index.ts:7](https://github.com/logto-io/js/blob/5254dee/packages/js/src/consts/index.ts#L7)

packages/docs/docs/sdk/JavaScript/js/functions/createRequester.md

@@ -0,0 +1,33 @@
+**createRequester**(`fetchFunction?`): <T\>(...`args`: [input: RequestInfo, init?: RequestInit]) => `Promise`<`T`\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `fetchFunction?` | (`input`: `RequestInfo`, `init?`: `RequestInit`) => `Promise`<`Response`\> |
+
+#### Returns
+
+`fn`
+
+<`T`\>(...`args`): `Promise`<`T`\>
+
+##### Type parameters
+
+| Name |
+| :------ |
+| `T` |
+
+##### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `...args` | [input: RequestInfo, init?: RequestInit] |
+
+##### Returns
+
+`Promise`<`T`\>
+
+#### Defined in
+
+[packages/js/src/utils/requester.ts:10](https://github.com/logto-io/js/blob/5254dee/packages/js/src/utils/requester.ts#L10)

packages/docs/docs/sdk/JavaScript/js/functions/decodeIdToken.md

@@ -0,0 +1,24 @@
+**decodeIdToken**(`token`): `Object`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `token` | `string` |
+
+#### Returns
+
+`Object`
+
+| Name | Type |
+| :------ | :------ |
+| `at_hash` | `undefined` \| `string` |
+| `aud` | `string` |
+| `exp` | `number` |
+| `iat` | `number` |
+| `iss` | `string` |
+| `sub` | `string` |
+
+#### Defined in
+
+[packages/js/src/utils/id-token.ts:36](https://github.com/logto-io/js/blob/5254dee/packages/js/src/utils/id-token.ts#L36)

packages/docs/docs/sdk/JavaScript/js/functions/fetchOidcConfig.md

@@ -0,0 +1,16 @@
+**fetchOidcConfig**(`endpoint`, `requester`): `Promise`<`KeysToCamelCase`<`OidcConfigSnakeCaseResponse`\>\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `endpoint` | `string` |
+| `requester` | <T\>(...`args`: [input: RequestInfo, init?: RequestInit]) => `Promise`<`T`\> |
+
+#### Returns
+
+`Promise`<`KeysToCamelCase`<`OidcConfigSnakeCaseResponse`\>\>
+
+#### Defined in
+
+[packages/js/src/core/oidc-config.ts:20](https://github.com/logto-io/js/blob/5254dee/packages/js/src/core/oidc-config.ts#L20)

packages/docs/docs/sdk/JavaScript/js/functions/fetchTokenByAuthorizationCode.md

@@ -0,0 +1,16 @@
+**fetchTokenByAuthorizationCode**(`__namedParameters`, `requester`): `Promise`<`KeysToCamelCase`<`SnakeCaseCodeTokenResponse`\>\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `__namedParameters` | [`FetchTokenByAuthorizationCodeParameters`](../types/FetchTokenByAuthorizationCodeParameters.md) |
+| `requester` | <T\>(...`args`: [input: RequestInfo, init?: RequestInit]) => `Promise`<`T`\> |
+
+#### Returns
+
+`Promise`<`KeysToCamelCase`<`SnakeCaseCodeTokenResponse`\>\>
+
+#### Defined in
+
+[packages/js/src/core/fetch-token.ts:44](https://github.com/logto-io/js/blob/5254dee/packages/js/src/core/fetch-token.ts#L44)

packages/docs/docs/sdk/JavaScript/js/functions/fetchTokenByRefreshToken.md

@@ -0,0 +1,16 @@
+**fetchTokenByRefreshToken**(`__namedParameters`, `requester`): `Promise`<`KeysToCamelCase`<`SnakeCaseRefreshTokenTokenResponse`\>\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `__namedParameters` | [`FetchTokenByRefreshTokenParameters`](../types/FetchTokenByRefreshTokenParameters.md) |
+| `requester` | <T\>(...`args`: [input: RequestInfo, init?: RequestInit]) => `Promise`<`T`\> |
+
+#### Returns
+
+`Promise`<`KeysToCamelCase`<`SnakeCaseRefreshTokenTokenResponse`\>\>
+
+#### Defined in
+
+[packages/js/src/core/fetch-token.ts:75](https://github.com/logto-io/js/blob/5254dee/packages/js/src/core/fetch-token.ts#L75)

packages/docs/docs/sdk/JavaScript/js/functions/fetchUserInfo.md

@@ -0,0 +1,17 @@
+**fetchUserInfo**(`userInfoEndpoint`, `accessToken`, `requester`): `Promise`<[`UserInfoResponse`](../types/UserInfoResponse.md)\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `userInfoEndpoint` | `string` |
+| `accessToken` | `string` |
+| `requester` | <T\>(...`args`: [input: RequestInfo, init?: RequestInit]) => `Promise`<`T`\> |
+
+#### Returns
+
+`Promise`<[`UserInfoResponse`](../types/UserInfoResponse.md)\>
+
+#### Defined in
+
+[packages/js/src/core/user-info.ts:11](https://github.com/logto-io/js/blob/5254dee/packages/js/src/core/user-info.ts#L11)

packages/docs/docs/sdk/JavaScript/js/functions/generateCodeChallenge.md

@@ -0,0 +1,19 @@
+**generateCodeChallenge**(`codeVerifier`): `Promise`<`string`\>
+
+Calculates the S256 PKCE code challenge for an arbitrary code verifier and encodes it in url safe base64
+
+**`link`** [Client Creates the Code Challenge](https://datatracker.ietf.org/doc/html/rfc7636#section-4.2)
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `codeVerifier` | `string` | Code verifier to calculate the S256 code challenge for |
+
+#### Returns
+
+`Promise`<`string`\>
+
+#### Defined in
+
+[packages/js/src/utils/generators.ts:29](https://github.com/logto-io/js/blob/5254dee/packages/js/src/utils/generators.ts#L29)

packages/docs/docs/sdk/JavaScript/js/functions/generateCodeVerifier.md

@@ -0,0 +1,13 @@
+**generateCodeVerifier**(): `string`
+
+Generates code verifier
+
+**`link`** [Client Creates a Code Verifier](https://datatracker.ietf.org/doc/html/rfc7636#section-4.1)
+
+#### Returns
+
+`string`
+
+#### Defined in
+
+[packages/js/src/utils/generators.ts:21](https://github.com/logto-io/js/blob/5254dee/packages/js/src/utils/generators.ts#L21)

packages/docs/docs/sdk/JavaScript/js/functions/generateSignInUri.md

@@ -0,0 +1,15 @@
+**generateSignInUri**(`__namedParameters`): `string`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `__namedParameters` | [`SignInUriParameters`](../types/SignInUriParameters.md) |
+
+#### Returns
+
+`string`
+
+#### Defined in
+
+[packages/js/src/core/sign-in.ts:18](https://github.com/logto-io/js/blob/5254dee/packages/js/src/core/sign-in.ts#L18)

packages/docs/docs/sdk/JavaScript/js/functions/generateSignOutUri.md

@@ -0,0 +1,15 @@
+**generateSignOutUri**(`__namedParameters`): `string`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `__namedParameters` | `SignOutUriParameters` |
+
+#### Returns
+
+`string`
+
+#### Defined in
+
+[packages/js/src/core/sign-out.ts:9](https://github.com/logto-io/js/blob/5254dee/packages/js/src/core/sign-out.ts#L9)

packages/docs/docs/sdk/JavaScript/js/functions/generateState.md

@@ -0,0 +1,11 @@
+**generateState**(): `string`
+
+Generates random string for state and encodes them in url safe base64
+
+#### Returns
+
+`string`
+
+#### Defined in
+
+[packages/js/src/utils/generators.ts:14](https://github.com/logto-io/js/blob/5254dee/packages/js/src/utils/generators.ts#L14)

packages/docs/docs/sdk/JavaScript/js/functions/parseUriParameters.md

@@ -0,0 +1,15 @@
+**parseUriParameters**(`uri`): `URLSearchParams`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `uri` | `string` |
+
+#### Returns
+
+`URLSearchParams`
+
+#### Defined in
+
+[packages/js/src/utils/callback-uri.ts:6](https://github.com/logto-io/js/blob/5254dee/packages/js/src/utils/callback-uri.ts#L6)

packages/docs/docs/sdk/JavaScript/js/functions/revoke.md

@@ -0,0 +1,18 @@
+**revoke**(`revocationEndpoint`, `clientId`, `token`, `requester`): `Promise`<`void`\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `revocationEndpoint` | `string` |
+| `clientId` | `string` |
+| `token` | `string` |
+| `requester` | <T\>(...`args`: [input: RequestInfo, init?: RequestInit]) => `Promise`<`T`\> |
+
+#### Returns
+
+`Promise`<`void`\>
+
+#### Defined in
+
+[packages/js/src/core/revoke.ts:4](https://github.com/logto-io/js/blob/5254dee/packages/js/src/core/revoke.ts#L4)

packages/docs/docs/sdk/JavaScript/js/functions/verifyAndParseCodeFromCallbackUri.md

@@ -0,0 +1,17 @@
+**verifyAndParseCodeFromCallbackUri**(`callbackUri`, `redirectUri`, `state`): `string`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `callbackUri` | `string` |
+| `redirectUri` | `string` |
+| `state` | `string` |
+
+#### Returns
+
+`string`
+
+#### Defined in
+
+[packages/js/src/utils/callback-uri.ts:13](https://github.com/logto-io/js/blob/5254dee/packages/js/src/utils/callback-uri.ts#L13)

packages/docs/docs/sdk/JavaScript/js/functions/verifyIdToken.md

@@ -0,0 +1,18 @@
+**verifyIdToken**(`idToken`, `clientId`, `issuer`, `jwks`): `Promise`<`void`\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `idToken` | `string` |
+| `clientId` | `string` |
+| `issuer` | `string` |
+| `jwks` | `JWTVerifyGetKey` |
+
+#### Returns
+
+`Promise`<`void`\>
+
+#### Defined in
+
+[packages/js/src/utils/id-token.ts:23](https://github.com/logto-io/js/blob/5254dee/packages/js/src/utils/id-token.ts#L23)

packages/docs/docs/sdk/JavaScript/js/functions/withReservedScopes.md

@@ -0,0 +1,17 @@
+**withReservedScopes**(`originalScopes?`): `string`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `originalScopes?` | `string`[] |
+
+#### Returns
+
+`string`
+
+scopes should contain all reserved scopes ( Logto requires `openid` and `offline_access` )
+
+#### Defined in
+
+[packages/js/src/utils/scopes.ts:5](https://github.com/logto-io/js/blob/5254dee/packages/js/src/utils/scopes.ts#L5)

packages/docs/docs/sdk/JavaScript/js/types/CodeTokenResponse.md

@@ -0,0 +1,5 @@
+**CodeTokenResponse**: `KeysToCamelCase`<`SnakeCaseCodeTokenResponse`\>
+
+#### Defined in
+
+[packages/js/src/core/fetch-token.ts:32](https://github.com/logto-io/js/blob/5254dee/packages/js/src/core/fetch-token.ts#L32)

packages/docs/docs/sdk/JavaScript/js/types/FetchTokenByAuthorizationCodeParameters.md

@@ -0,0 +1,16 @@
+**FetchTokenByAuthorizationCodeParameters**: `Object`
+
+#### Type declaration
+
+| Name | Type |
+| :------ | :------ |
+| `clientId` | `string` |
+| `code` | `string` |
+| `codeVerifier` | `string` |
+| `redirectUri` | `string` |
+| `resource?` | `string` |
+| `tokenEndpoint` | `string` |
+
+#### Defined in
+
+[packages/js/src/core/fetch-token.ts:7](https://github.com/logto-io/js/blob/5254dee/packages/js/src/core/fetch-token.ts#L7)

packages/docs/docs/sdk/JavaScript/js/types/FetchTokenByRefreshTokenParameters.md

@@ -0,0 +1,15 @@
+**FetchTokenByRefreshTokenParameters**: `Object`
+
+#### Type declaration
+
+| Name | Type |
+| :------ | :------ |
+| `clientId` | `string` |
+| `refreshToken` | `string` |
+| `resource?` | `string` |
+| `scopes?` | `string`[] |
+| `tokenEndpoint` | `string` |
+
+#### Defined in
+
+[packages/js/src/core/fetch-token.ts:16](https://github.com/logto-io/js/blob/5254dee/packages/js/src/core/fetch-token.ts#L16)

packages/docs/docs/sdk/JavaScript/js/types/IdTokenClaims.md

@@ -0,0 +1,5 @@
+**IdTokenClaims**: `s.Infer`<typeof `IdTokenClaimsSchema`\>
+
+#### Defined in
+
+[packages/js/src/utils/id-token.ts:21](https://github.com/logto-io/js/blob/5254dee/packages/js/src/utils/id-token.ts#L21)

packages/docs/docs/sdk/JavaScript/js/types/LogtoErrorCode.md

@@ -0,0 +1,5 @@
+**LogtoErrorCode**: `NormalizeKeyPaths`<typeof `logtoErrorCodes`\>
+
+#### Defined in
+
+[packages/js/src/utils/errors.ts:21](https://github.com/logto-io/js/blob/5254dee/packages/js/src/utils/errors.ts#L21)

packages/docs/docs/sdk/JavaScript/js/types/OidcConfigResponse.md

@@ -0,0 +1,5 @@
+**OidcConfigResponse**: `KeysToCamelCase`<`OidcConfigSnakeCaseResponse`\>
+
+#### Defined in
+
+[packages/js/src/core/oidc-config.ts:18](https://github.com/logto-io/js/blob/5254dee/packages/js/src/core/oidc-config.ts#L18)

packages/docs/docs/sdk/JavaScript/js/types/RefreshTokenTokenResponse.md

@@ -0,0 +1,5 @@
+**RefreshTokenTokenResponse**: `KeysToCamelCase`<`SnakeCaseRefreshTokenTokenResponse`\>
+
+#### Defined in
+
+[packages/js/src/core/fetch-token.ts:42](https://github.com/logto-io/js/blob/5254dee/packages/js/src/core/fetch-token.ts#L42)

packages/docs/docs/sdk/JavaScript/js/types/Requester.md

@@ -0,0 +1,5 @@
+**Requester**: `ReturnType`<typeof [`createRequester`](../functions/createRequester.md)\>
+
+#### Defined in
+
+[packages/js/src/utils/requester.ts:28](https://github.com/logto-io/js/blob/5254dee/packages/js/src/utils/requester.ts#L28)

packages/docs/docs/sdk/JavaScript/js/types/SignInUriParameters.md

@@ -0,0 +1,17 @@
+**SignInUriParameters**: `Object`
+
+#### Type declaration
+
+| Name | Type |
+| :------ | :------ |
+| `authorizationEndpoint` | `string` |
+| `clientId` | `string` |
+| `codeChallenge` | `string` |
+| `redirectUri` | `string` |
+| `resources?` | `string`[] |
+| `scopes?` | `string`[] |
+| `state` | `string` |
+
+#### Defined in
+
+[packages/js/src/core/sign-in.ts:8](https://github.com/logto-io/js/blob/5254dee/packages/js/src/core/sign-in.ts#L8)

packages/docs/docs/sdk/JavaScript/js/types/UserInfoResponse.md

@@ -0,0 +1,15 @@
+**UserInfoResponse**: `Object`
+
+#### Type declaration
+
+| Name | Type |
+| :------ | :------ |
+| `avatar?` | `string` |
+| `name?` | `string` |
+| `role_names?` | `string`[] |
+| `sub` | `string` |
+| `username?` | `string` |
+
+#### Defined in
+
+[packages/js/src/core/user-info.ts:3](https://github.com/logto-io/js/blob/5254dee/packages/js/src/core/user-info.ts#L3)

packages/docs/docs/sdk/JavaScript/js/variables/ContentType.md

@@ -0,0 +1,12 @@
+`Const` **ContentType**: `Object`
+
+#### Type declaration
+
+| Name | Type |
+| :------ | :------ |
+| `formUrlEncoded` | { `Content-Type`: `string` = 'application/x-www-form-urlencoded' } |
+| `formUrlEncoded.Content-Type` | `string` |
+
+#### Defined in
+
+[packages/js/src/consts/index.ts:1](https://github.com/logto-io/js/blob/5254dee/packages/js/src/consts/index.ts#L1)

packages/docs/docs/sdk/JavaScript/js/variables/discoveryPath.md

@@ -0,0 +1,5 @@
+`Const` **discoveryPath**: ``"/oidc/.well-known/openid-configuration"``
+
+#### Defined in
+
+[packages/js/src/core/oidc-config.ts:16](https://github.com/logto-io/js/blob/5254dee/packages/js/src/core/oidc-config.ts#L16)

packages/docs/docs/sdk/JavaScript/react/README.md

@@ -0,0 +1,25 @@
+# React
+
+## Table of contents
+
+### Classes
+
+- [LogtoClientError](classes/LogtoClientError.md)
+- [LogtoError](classes/LogtoError.md)
+- [OidcError](classes/OidcError.md)
+
+### Type Aliases
+
+- [IdTokenClaims](types/IdTokenClaims.md)
+- [LogtoClientErrorCode](types/LogtoClientErrorCode.md)
+- [LogtoConfig](types/LogtoConfig.md)
+- [LogtoContextProps](types/LogtoContextProps.md)
+- [LogtoErrorCode](types/LogtoErrorCode.md)
+- [LogtoProviderProps](types/LogtoProviderProps.md)
+- [UserInfoResponse](types/UserInfoResponse.md)
+
+### Functions
+
+- [LogtoProvider](functions/LogtoProvider.md)
+- [useHandleSignInCallback](functions/useHandleSignInCallback.md)
+- [useLogto](functions/useLogto.md)

packages/docs/docs/sdk/JavaScript/react/classes/LogtoClientError.md

@@ -0,0 +1,197 @@
+## Hierarchy
+
+- `Error`
+
+  ↳ **`LogtoClientError`**
+
+## Table of contents
+
+### Constructors
+
+- [constructor](LogtoClientError.md#constructor)
+
+### Properties
+
+- [cause](LogtoClientError.md#cause)
+- [code](LogtoClientError.md#code)
+- [data](LogtoClientError.md#data)
+- [message](LogtoClientError.md#message)
+- [name](LogtoClientError.md#name)
+- [stack](LogtoClientError.md#stack)
+- [prepareStackTrace](LogtoClientError.md#preparestacktrace)
+- [stackTraceLimit](LogtoClientError.md#stacktracelimit)
+
+### Methods
+
+- [captureStackTrace](LogtoClientError.md#capturestacktrace)
+
+## Constructors
+
+### constructor
+
+**new LogtoClientError**(`code`, `data?`)
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `code` | [`LogtoClientErrorCode`](../types/LogtoClientErrorCode.md) |
+| `data?` | `unknown` |
+
+#### Overrides
+
+Error.constructor
+
+#### Defined in
+
+packages/browser/lib/errors.d.ts:16
+
+## Properties
+
+### cause
+
+ `Optional` **cause**: `Error`
+
+#### Inherited from
+
+Error.cause
+
+#### Defined in
+
+node_modules/.pnpm/typescript@4.6.2/node_modules/typescript/lib/lib.es2022.error.d.ts:26
+
+___
+
+### code
+
+ **code**: [`LogtoClientErrorCode`](../types/LogtoClientErrorCode.md)
+
+#### Defined in
+
+packages/browser/lib/errors.d.ts:14
+
+___
+
+### data
+
+ **data**: `unknown`
+
+#### Defined in
+
+packages/browser/lib/errors.d.ts:15
+
+___
+
+### message
+
+ **message**: `string`
+
+#### Inherited from
+
+Error.message
+
+#### Defined in
+
+node_modules/.pnpm/typescript@4.6.2/node_modules/typescript/lib/lib.es5.d.ts:1023
+
+___
+
+### name
+
+ **name**: `string`
+
+#### Inherited from
+
+Error.name
+
+#### Defined in
+
+node_modules/.pnpm/typescript@4.6.2/node_modules/typescript/lib/lib.es5.d.ts:1022
+
+___
+
+### stack
+
+ `Optional` **stack**: `string`
+
+#### Inherited from
+
+Error.stack
+
+#### Defined in
+
+node_modules/.pnpm/typescript@4.6.2/node_modules/typescript/lib/lib.es5.d.ts:1024
+
+___
+
+### prepareStackTrace
+
+ `Static` `Optional` **prepareStackTrace**: (`err`: `Error`, `stackTraces`: `CallSite`[]) => `any`
+
+#### Type declaration
+
+(`err`, `stackTraces`): `any`
+
+Optional override for formatting stack traces
+
+**`see`** https://v8.dev/docs/stack-trace-api#customizing-stack-traces
+
+##### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `err` | `Error` |
+| `stackTraces` | `CallSite`[] |
+
+##### Returns
+
+`any`
+
+#### Inherited from
+
+Error.prepareStackTrace
+
+#### Defined in
+
+node_modules/.pnpm/@types+node@17.0.19/node_modules/@types/node/globals.d.ts:11
+
+___
+
+### stackTraceLimit
+
+ `Static` **stackTraceLimit**: `number`
+
+#### Inherited from
+
+Error.stackTraceLimit
+
+#### Defined in
+
+node_modules/.pnpm/@types+node@17.0.19/node_modules/@types/node/globals.d.ts:13
+
+## Methods
+
+### captureStackTrace
+
+`Static` **captureStackTrace**(`targetObject`, `constructorOpt?`): `void`
+
+Create .stack property on a target object
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `targetObject` | `object` |
+| `constructorOpt?` | `Function` |
+
+#### Returns
+
+`void`
+
+#### Inherited from
+
+Error.captureStackTrace
+
+#### Defined in
+
+node_modules/.pnpm/@types+node@17.0.19/node_modules/@types/node/globals.d.ts:4

packages/docs/docs/sdk/JavaScript/react/classes/LogtoError.md

@@ -0,0 +1,197 @@
+## Hierarchy
+
+- `Error`
+
+  ↳ **`LogtoError`**
+
+## Table of contents
+
+### Constructors
+
+- [constructor](LogtoError.md#constructor)
+
+### Properties
+
+- [cause](LogtoError.md#cause)
+- [code](LogtoError.md#code)
+- [data](LogtoError.md#data)
+- [message](LogtoError.md#message)
+- [name](LogtoError.md#name)
+- [stack](LogtoError.md#stack)
+- [prepareStackTrace](LogtoError.md#preparestacktrace)
+- [stackTraceLimit](LogtoError.md#stacktracelimit)
+
+### Methods
+
+- [captureStackTrace](LogtoError.md#capturestacktrace)
+
+## Constructors
+
+### constructor
+
+**new LogtoError**(`code`, `data?`)
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `code` | [`LogtoErrorCode`](../types/LogtoErrorCode.md) |
+| `data?` | `unknown` |
+
+#### Overrides
+
+Error.constructor
+
+#### Defined in
+
+packages/js/lib/utils/errors.d.ts:22
+
+## Properties
+
+### cause
+
+ `Optional` **cause**: `Error`
+
+#### Inherited from
+
+Error.cause
+
+#### Defined in
+
+node_modules/.pnpm/typescript@4.6.2/node_modules/typescript/lib/lib.es2022.error.d.ts:26
+
+___
+
+### code
+
+ **code**: [`LogtoErrorCode`](../types/LogtoErrorCode.md)
+
+#### Defined in
+
+packages/js/lib/utils/errors.d.ts:20
+
+___
+
+### data
+
+ **data**: `unknown`
+
+#### Defined in
+
+packages/js/lib/utils/errors.d.ts:21
+
+___
+
+### message
+
+ **message**: `string`
+
+#### Inherited from
+
+Error.message
+
+#### Defined in
+
+node_modules/.pnpm/typescript@4.6.2/node_modules/typescript/lib/lib.es5.d.ts:1023
+
+___
+
+### name
+
+ **name**: `string`
+
+#### Inherited from
+
+Error.name
+
+#### Defined in
+
+node_modules/.pnpm/typescript@4.6.2/node_modules/typescript/lib/lib.es5.d.ts:1022
+
+___
+
+### stack
+
+ `Optional` **stack**: `string`
+
+#### Inherited from
+
+Error.stack
+
+#### Defined in
+
+node_modules/.pnpm/typescript@4.6.2/node_modules/typescript/lib/lib.es5.d.ts:1024
+
+___
+
+### prepareStackTrace
+
+ `Static` `Optional` **prepareStackTrace**: (`err`: `Error`, `stackTraces`: `CallSite`[]) => `any`
+
+#### Type declaration
+
+(`err`, `stackTraces`): `any`
+
+Optional override for formatting stack traces
+
+**`see`** https://v8.dev/docs/stack-trace-api#customizing-stack-traces
+
+##### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `err` | `Error` |
+| `stackTraces` | `CallSite`[] |
+
+##### Returns
+
+`any`
+
+#### Inherited from
+
+Error.prepareStackTrace
+
+#### Defined in
+
+node_modules/.pnpm/@types+node@17.0.19/node_modules/@types/node/globals.d.ts:11
+
+___
+
+### stackTraceLimit
+
+ `Static` **stackTraceLimit**: `number`
+
+#### Inherited from
+
+Error.stackTraceLimit
+
+#### Defined in
+
+node_modules/.pnpm/@types+node@17.0.19/node_modules/@types/node/globals.d.ts:13
+
+## Methods
+
+### captureStackTrace
+
+`Static` **captureStackTrace**(`targetObject`, `constructorOpt?`): `void`
+
+Create .stack property on a target object
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `targetObject` | `object` |
+| `constructorOpt?` | `Function` |
+
+#### Returns
+
+`void`
+
+#### Inherited from
+
+Error.captureStackTrace
+
+#### Defined in
+
+node_modules/.pnpm/@types+node@17.0.19/node_modules/@types/node/globals.d.ts:4

packages/docs/docs/sdk/JavaScript/react/classes/OidcError.md

@@ -0,0 +1,47 @@
+## Table of contents
+
+### Constructors
+
+- [constructor](OidcError.md#constructor)
+
+### Properties
+
+- [error](OidcError.md#error)
+- [errorDescription](OidcError.md#errordescription)
+
+## Constructors
+
+### constructor
+
+**new OidcError**(`error`, `errorDescription`)
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `error` | `string` |
+| `errorDescription` | `string` |
+
+#### Defined in
+
+packages/js/lib/utils/errors.d.ts:31
+
+## Properties
+
+### error
+
+ **error**: `string`
+
+#### Defined in
+
+packages/js/lib/utils/errors.d.ts:29
+
+___
+
+### errorDescription
+
+ **errorDescription**: `string`
+
+#### Defined in
+
+packages/js/lib/utils/errors.d.ts:30

packages/docs/docs/sdk/JavaScript/react/functions/LogtoProvider.md

@@ -0,0 +1,15 @@
+**LogtoProvider**(`__namedParameters`): `Element`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `__namedParameters` | [`LogtoProviderProps`](../types/LogtoProviderProps.md) |
+
+#### Returns
+
+`Element`
+
+#### Defined in
+
+[packages/react/src/provider.tsx:11](https://github.com/logto-io/js/blob/5254dee/packages/react/src/provider.tsx#L11)

packages/docs/docs/sdk/JavaScript/react/functions/useHandleSignInCallback.md

@@ -0,0 +1,21 @@
+**useHandleSignInCallback**(`returnToPageUrl?`): `Object`
+
+#### Parameters
+
+| Name | Type | Default value |
+| :------ | :------ | :------ |
+| `returnToPageUrl` | `string` | `window.location.origin` |
+
+#### Returns
+
+`Object`
+
+| Name | Type |
+| :------ | :------ |
+| `error` | `undefined` \| `Error` |
+| `isAuthenticated` | `boolean` |
+| `isLoading` | `boolean` |
+
+#### Defined in
+
+[packages/react/src/hooks/index.ts:53](https://github.com/logto-io/js/blob/5254dee/packages/react/src/hooks/index.ts#L53)

packages/docs/docs/sdk/JavaScript/react/functions/useLogto.md

@@ -0,0 +1,9 @@
+**useLogto**(): `Logto`
+
+#### Returns
+
+`Logto`
+
+#### Defined in
+
+[packages/react/src/hooks/index.ts:96](https://github.com/logto-io/js/blob/5254dee/packages/react/src/hooks/index.ts#L96)

packages/docs/docs/sdk/JavaScript/react/types/IdTokenClaims.md

@@ -0,0 +1,5 @@
+**IdTokenClaims**: `s.Infer`<typeof `IdTokenClaimsSchema`\>
+
+#### Defined in
+
+packages/js/lib/utils/id-token.d.ts:21

packages/docs/docs/sdk/JavaScript/react/types/LogtoClientErrorCode.md

@@ -0,0 +1,5 @@
+**LogtoClientErrorCode**: `NormalizeKeyPaths`<typeof `logtoClientErrorCodes`\>
+
+#### Defined in
+
+packages/browser/lib/errors.d.ts:12

packages/docs/docs/sdk/JavaScript/react/types/LogtoConfig.md

@@ -0,0 +1,15 @@
+**LogtoConfig**: `Object`
+
+#### Type declaration
+
+| Name | Type |
+| :------ | :------ |
+| `appId` | `string` |
+| `endpoint` | `string` |
+| `resources?` | `string`[] |
+| `scopes?` | `string`[] |
+| `usingPersistStorage?` | `boolean` |
+
+#### Defined in
+
+packages/browser/lib/index.d.ts:7

packages/docs/docs/sdk/JavaScript/react/types/LogtoContextProps.md

@@ -0,0 +1,17 @@
+**LogtoContextProps**: `Object`
+
+#### Type declaration
+
+| Name | Type |
+| :------ | :------ |
+| `error?` | `Error` |
+| `isAuthenticated` | `boolean` |
+| `loadingCount` | `number` |
+| `logtoClient?` | `LogtoClient` |
+| `setError` | `React.Dispatch`<`React.SetStateAction`<`Error` \| `undefined`\>\> |
+| `setIsAuthenticated` | `React.Dispatch`<`React.SetStateAction`<`boolean`\>\> |
+| `setLoadingCount` | `React.Dispatch`<`React.SetStateAction`<`number`\>\> |
+
+#### Defined in
+
+[packages/react/src/context.tsx:4](https://github.com/logto-io/js/blob/5254dee/packages/react/src/context.tsx#L4)

packages/docs/docs/sdk/JavaScript/react/types/LogtoErrorCode.md

@@ -0,0 +1,5 @@
+**LogtoErrorCode**: `NormalizeKeyPaths`<typeof `logtoErrorCodes`\>
+
+#### Defined in
+
+packages/js/lib/utils/errors.d.ts:18

packages/docs/docs/sdk/JavaScript/react/types/LogtoProviderProps.md

@@ -0,0 +1,12 @@
+**LogtoProviderProps**: `Object`
+
+#### Type declaration
+
+| Name | Type |
+| :------ | :------ |
+| `children?` | `ReactNode` |
+| `config` | [`LogtoConfig`](LogtoConfig.md) |
+
+#### Defined in
+
+[packages/react/src/provider.tsx:6](https://github.com/logto-io/js/blob/5254dee/packages/react/src/provider.tsx#L6)

packages/docs/docs/sdk/JavaScript/react/types/UserInfoResponse.md

@@ -0,0 +1,11 @@
+**UserInfoResponse**: `Object`
+
+#### Type declaration
+
+| Name | Type |
+| :------ | :------ |
+| `sub` | `string` |
+
+#### Defined in
+
+packages/js/lib/core/user-info.d.ts:2

packages/docs/docs/sdk/JavaScript/vue/README.md

@@ -0,0 +1,26 @@
+# Vue
+
+## Table of contents
+
+### Classes
+
+- [LogtoClientError](classes/LogtoClientError.md)
+- [LogtoError](classes/LogtoError.md)
+- [OidcError](classes/OidcError.md)
+
+### Type Aliases
+
+- [IdTokenClaims](types/IdTokenClaims.md)
+- [LogtoClientErrorCode](types/LogtoClientErrorCode.md)
+- [LogtoConfig](types/LogtoConfig.md)
+- [LogtoErrorCode](types/LogtoErrorCode.md)
+- [UserInfoResponse](types/UserInfoResponse.md)
+
+### Variables
+
+- [createLogto](variables/createLogto.md)
+
+### Functions
+
+- [useHandleSignInCallback](functions/useHandleSignInCallback.md)
+- [useLogto](functions/useLogto.md)

packages/docs/docs/sdk/JavaScript/vue/classes/LogtoClientError.md

@@ -0,0 +1,182 @@
+## Hierarchy
+
+- `Error`
+
+  ↳ **`LogtoClientError`**
+
+## Table of contents
+
+### Constructors
+
+- [constructor](LogtoClientError.md#constructor)
+
+### Properties
+
+- [code](LogtoClientError.md#code)
+- [data](LogtoClientError.md#data)
+- [message](LogtoClientError.md#message)
+- [name](LogtoClientError.md#name)
+- [stack](LogtoClientError.md#stack)
+- [prepareStackTrace](LogtoClientError.md#preparestacktrace)
+- [stackTraceLimit](LogtoClientError.md#stacktracelimit)
+
+### Methods
+
+- [captureStackTrace](LogtoClientError.md#capturestacktrace)
+
+## Constructors
+
+### constructor
+
+**new LogtoClientError**(`code`, `data?`)
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `code` | [`LogtoClientErrorCode`](../types/LogtoClientErrorCode.md) |
+| `data?` | `unknown` |
+
+#### Overrides
+
+Error.constructor
+
+#### Defined in
+
+packages/browser/lib/errors.d.ts:16
+
+## Properties
+
+### code
+
+ **code**: [`LogtoClientErrorCode`](../types/LogtoClientErrorCode.md)
+
+#### Defined in
+
+packages/browser/lib/errors.d.ts:14
+
+___
+
+### data
+
+ **data**: `unknown`
+
+#### Defined in
+
+packages/browser/lib/errors.d.ts:15
+
+___
+
+### message
+
+ **message**: `string`
+
+#### Inherited from
+
+Error.message
+
+#### Defined in
+
+node_modules/.pnpm/typescript@4.6.2/node_modules/typescript/lib/lib.es5.d.ts:1023
+
+___
+
+### name
+
+ **name**: `string`
+
+#### Inherited from
+
+Error.name
+
+#### Defined in
+
+node_modules/.pnpm/typescript@4.6.2/node_modules/typescript/lib/lib.es5.d.ts:1022
+
+___
+
+### stack
+
+ `Optional` **stack**: `string`
+
+#### Inherited from
+
+Error.stack
+
+#### Defined in
+
+node_modules/.pnpm/typescript@4.6.2/node_modules/typescript/lib/lib.es5.d.ts:1024
+
+___
+
+### prepareStackTrace
+
+ `Static` `Optional` **prepareStackTrace**: (`err`: `Error`, `stackTraces`: `CallSite`[]) => `any`
+
+#### Type declaration
+
+(`err`, `stackTraces`): `any`
+
+Optional override for formatting stack traces
+
+**`see`** https://v8.dev/docs/stack-trace-api#customizing-stack-traces
+
+##### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `err` | `Error` |
+| `stackTraces` | `CallSite`[] |
+
+##### Returns
+
+`any`
+
+#### Inherited from
+
+Error.prepareStackTrace
+
+#### Defined in
+
+node_modules/.pnpm/@types+node@17.0.19/node_modules/@types/node/globals.d.ts:11
+
+___
+
+### stackTraceLimit
+
+ `Static` **stackTraceLimit**: `number`
+
+#### Inherited from
+
+Error.stackTraceLimit
+
+#### Defined in
+
+node_modules/.pnpm/@types+node@17.0.19/node_modules/@types/node/globals.d.ts:13
+
+## Methods
+
+### captureStackTrace
+
+`Static` **captureStackTrace**(`targetObject`, `constructorOpt?`): `void`
+
+Create .stack property on a target object
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `targetObject` | `object` |
+| `constructorOpt?` | `Function` |
+
+#### Returns
+
+`void`
+
+#### Inherited from
+
+Error.captureStackTrace
+
+#### Defined in
+
+node_modules/.pnpm/@types+node@17.0.19/node_modules/@types/node/globals.d.ts:4

packages/docs/docs/sdk/JavaScript/vue/classes/LogtoError.md

@@ -0,0 +1,182 @@
+## Hierarchy
+
+- `Error`
+
+  ↳ **`LogtoError`**
+
+## Table of contents
+
+### Constructors
+
+- [constructor](LogtoError.md#constructor)
+
+### Properties
+
+- [code](LogtoError.md#code)
+- [data](LogtoError.md#data)
+- [message](LogtoError.md#message)
+- [name](LogtoError.md#name)
+- [stack](LogtoError.md#stack)
+- [prepareStackTrace](LogtoError.md#preparestacktrace)
+- [stackTraceLimit](LogtoError.md#stacktracelimit)
+
+### Methods
+
+- [captureStackTrace](LogtoError.md#capturestacktrace)
+
+## Constructors
+
+### constructor
+
+**new LogtoError**(`code`, `data?`)
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `code` | [`LogtoErrorCode`](../types/LogtoErrorCode.md) |
+| `data?` | `unknown` |
+
+#### Overrides
+
+Error.constructor
+
+#### Defined in
+
+packages/js/lib/utils/errors.d.ts:22
+
+## Properties
+
+### code
+
+ **code**: [`LogtoErrorCode`](../types/LogtoErrorCode.md)
+
+#### Defined in
+
+packages/js/lib/utils/errors.d.ts:20
+
+___
+
+### data
+
+ **data**: `unknown`
+
+#### Defined in
+
+packages/js/lib/utils/errors.d.ts:21
+
+___
+
+### message
+
+ **message**: `string`
+
+#### Inherited from
+
+Error.message
+
+#### Defined in
+
+node_modules/.pnpm/typescript@4.6.2/node_modules/typescript/lib/lib.es5.d.ts:1023
+
+___
+
+### name
+
+ **name**: `string`
+
+#### Inherited from
+
+Error.name
+
+#### Defined in
+
+node_modules/.pnpm/typescript@4.6.2/node_modules/typescript/lib/lib.es5.d.ts:1022
+
+___
+
+### stack
+
+ `Optional` **stack**: `string`
+
+#### Inherited from
+
+Error.stack
+
+#### Defined in
+
+node_modules/.pnpm/typescript@4.6.2/node_modules/typescript/lib/lib.es5.d.ts:1024
+
+___
+
+### prepareStackTrace
+
+ `Static` `Optional` **prepareStackTrace**: (`err`: `Error`, `stackTraces`: `CallSite`[]) => `any`
+
+#### Type declaration
+
+(`err`, `stackTraces`): `any`
+
+Optional override for formatting stack traces
+
+**`see`** https://v8.dev/docs/stack-trace-api#customizing-stack-traces
+
+##### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `err` | `Error` |
+| `stackTraces` | `CallSite`[] |
+
+##### Returns
+
+`any`
+
+#### Inherited from
+
+Error.prepareStackTrace
+
+#### Defined in
+
+node_modules/.pnpm/@types+node@17.0.19/node_modules/@types/node/globals.d.ts:11
+
+___
+
+### stackTraceLimit
+
+ `Static` **stackTraceLimit**: `number`
+
+#### Inherited from
+
+Error.stackTraceLimit
+
+#### Defined in
+
+node_modules/.pnpm/@types+node@17.0.19/node_modules/@types/node/globals.d.ts:13
+
+## Methods
+
+### captureStackTrace
+
+`Static` **captureStackTrace**(`targetObject`, `constructorOpt?`): `void`
+
+Create .stack property on a target object
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `targetObject` | `object` |
+| `constructorOpt?` | `Function` |
+
+#### Returns
+
+`void`
+
+#### Inherited from
+
+Error.captureStackTrace
+
+#### Defined in
+
+node_modules/.pnpm/@types+node@17.0.19/node_modules/@types/node/globals.d.ts:4

packages/docs/docs/sdk/JavaScript/vue/classes/OidcError.md

@@ -0,0 +1,47 @@
+## Table of contents
+
+### Constructors
+
+- [constructor](OidcError.md#constructor)
+
+### Properties
+
+- [error](OidcError.md#error)
+- [errorDescription](OidcError.md#errordescription)
+
+## Constructors
+
+### constructor
+
+**new OidcError**(`error`, `errorDescription`)
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `error` | `string` |
+| `errorDescription` | `string` |
+
+#### Defined in
+
+packages/js/lib/utils/errors.d.ts:31
+
+## Properties
+
+### error
+
+ **error**: `string`
+
+#### Defined in
+
+packages/js/lib/utils/errors.d.ts:29
+
+___
+
+### errorDescription
+
+ **errorDescription**: `string`
+
+#### Defined in
+
+packages/js/lib/utils/errors.d.ts:30

packages/docs/docs/sdk/JavaScript/vue/functions/useHandleSignInCallback.md

@@ -0,0 +1,36 @@
+**useHandleSignInCallback**(`returnToPageUrl?`): `Object`
+
+A Vue composable method that watches browser navigation and automatically handles the sign-in callback
+
+```ts
+import { useLogto } from '@logto/vue';
+import { useHandleSignInCallback } from '@logto/vue';
+
+export default {
+  setup() {
+    useHandleSignInCallback();
+  }
+}
+```
+
+Use this in the setup script of your Callback page to make sure the injection works
+
+#### Parameters
+
+| Name | Type | Default value |
+| :------ | :------ | :------ |
+| `returnToPageUrl` | `string` | `window.location.origin` |
+
+#### Returns
+
+`Object`
+
+| Name | Type |
+| :------ | :------ |
+| `error` | `Readonly`<`Ref`<`undefined` \| `Error`\>\> |
+| `isAuthenticated` | `Readonly`<`Ref`<`boolean`\>\> |
+| `isLoading` | `Readonly`<`Ref`<`boolean`\>\> |
+
+#### Defined in
+
+[packages/vue/src/index.ts:116](https://github.com/logto-io/js/blob/5254dee/packages/vue/src/index.ts#L116)

packages/docs/docs/sdk/JavaScript/vue/functions/useLogto.md

@@ -0,0 +1,30 @@
+**useLogto**(): `Logto`
+
+A Vue composable method that provides the Logto reactive refs and auth methods.
+
+```ts
+import { useLogto } from '@logto/vue';
+
+export default {
+ setup() {
+   const { isAuthenticated, signIn } = useLogto();
+
+   return {
+     isAuthenticated,
+     onClickSignIn: () => {
+       signIn('<your-redirect-uri>');
+     },
+   }
+ }
+}
+```
+
+Use this composable in the setup script of your Vue component to make sure the injection works
+
+#### Returns
+
+`Logto`
+
+#### Defined in
+
+[packages/vue/src/index.ts:90](https://github.com/logto-io/js/blob/5254dee/packages/vue/src/index.ts#L90)

packages/docs/docs/sdk/JavaScript/vue/types/IdTokenClaims.md

@@ -0,0 +1,5 @@
+**IdTokenClaims**: `s.Infer`<typeof `IdTokenClaimsSchema`\>
+
+#### Defined in
+
+packages/js/lib/utils/id-token.d.ts:21

packages/docs/docs/sdk/JavaScript/vue/types/LogtoClientErrorCode.md

@@ -0,0 +1,5 @@
+**LogtoClientErrorCode**: `NormalizeKeyPaths`<typeof `logtoClientErrorCodes`\>
+
+#### Defined in
+
+packages/browser/lib/errors.d.ts:12

packages/docs/docs/sdk/JavaScript/vue/types/LogtoConfig.md

@@ -0,0 +1,15 @@
+**LogtoConfig**: `Object`
+
+#### Type declaration
+
+| Name | Type |
+| :------ | :------ |
+| `appId` | `string` |
+| `endpoint` | `string` |
+| `resources?` | `string`[] |
+| `scopes?` | `string`[] |
+| `usingPersistStorage?` | `boolean` |
+
+#### Defined in
+
+packages/browser/lib/index.d.ts:7

packages/docs/docs/sdk/JavaScript/vue/types/LogtoErrorCode.md

@@ -0,0 +1,5 @@
+**LogtoErrorCode**: `NormalizeKeyPaths`<typeof `logtoErrorCodes`\>
+
+#### Defined in
+
+packages/js/lib/utils/errors.d.ts:18

packages/docs/docs/sdk/JavaScript/vue/types/UserInfoResponse.md

@@ -0,0 +1,11 @@
+**UserInfoResponse**: `Object`
+
+#### Type declaration
+
+| Name | Type |
+| :------ | :------ |
+| `sub` | `string` |
+
+#### Defined in
+
+packages/js/lib/core/user-info.d.ts:2

packages/docs/docs/sdk/JavaScript/vue/variables/createLogto.md

@@ -0,0 +1,22 @@
+`Const` **createLogto**: `LogtoVuePlugin`
+
+Creates the Logto Vue plugin
+
+```ts
+import { createApp } from 'vue';
+import { createLogto } from '@logto/vue';
+
+const app = createApp(App);
+const app.use(createLogto, {
+  appId: '<your-app-id>',
+  endpoint: '<your-oidc-endpoint-domain>',
+});
+
+app.mount('#app');
+```
+
+Use this in your Vue root component to register the plugin
+
+#### Defined in
+
+[packages/vue/src/index.ts:51](https://github.com/logto-io/js/blob/5254dee/packages/vue/src/index.ts#L51)