chore: set gitRevision to always be main to reduce changes in docs

monerium · Aug 7, 2024 · 2540e69 · 2540e69
1 parent ffeefd2
commit 2540e69
Show file tree

Hide file tree

Showing 104 changed files with 372 additions and 368 deletions.
diff --git a/packages/sdk-react-provider/docs/generated/enumerations/OrderState.md b/packages/sdk-react-provider/docs/generated/enumerations/OrderState.md
@@ -6,7 +6,7 @@
 
 | Enumeration Member | Value         | Defined in              |
 | ------------------ | ------------- | ----------------------- |
-| `pending`          | `"pending"`   | sdk/dist/index.d.ts:199 |
-| `placed`           | `"placed"`    | sdk/dist/index.d.ts:198 |
-| `processed`        | `"processed"` | sdk/dist/index.d.ts:200 |
-| `rejected`         | `"rejected"`  | sdk/dist/index.d.ts:201 |
+| `pending`          | `"pending"`   | sdk/dist/index.d.ts:195 |
+| `placed`           | `"placed"`    | sdk/dist/index.d.ts:194 |
+| `processed`        | `"processed"` | sdk/dist/index.d.ts:196 |
+| `rejected`         | `"rejected"`  | sdk/dist/index.d.ts:197 |
diff --git a/packages/sdk-react-provider/docs/generated/functions/MoneriumProvider.md b/packages/sdk-react-provider/docs/generated/functions/MoneriumProvider.md
@@ -2,22 +2,23 @@
 
 # Function: MoneriumProvider()
 
-> **MoneriumProvider**(`params`: \{`children`: `ReactNode`;`clientId`: `'f99e629b-6dca-11ee-8aa6-5273f65ed05b'`;`environment`: `'sandbox'`;`redirectUrl`: `'http://localhost:5173'`; \}): `Element`
+> **MoneriumProvider**(`params`: \{`children`: `ReactNode`;`clientId`: `string`;`environment`: `'sandbox'`;`redirectUri`: `string`;`redirectUrl`: `string`; \}): `Element`
 
 ## Parameters
 
 | Parameter             | Type                          | Description                      |
 | --------------------- | ----------------------------- | -------------------------------- |
 | `params`              | `object`                      |                                  |
 | `params.children`     | `ReactNode`                   | Rest of the application.         |
-| `params.clientId`?    | `string`                      | Monerium auth flow client id.    |
+| `params.clientId`     | `string`                      | Monerium auth flow client id.    |
 | `params.environment`? | `"sandbox"` \| `"production"` | Monerium environment.            |
-| `params.redirectUrl`? | `string`                      | Monerium auth flow redirect url. |
+| `params.redirectUri`  | `string`                      | Monerium auth flow redirect url. |
+| `params.redirectUrl`? | `string`                      | **Deprecated** use redirectUri   |
 
 ## Returns
 
 `Element`
 
 ## Defined in
 
-[sdk-react-provider/src/lib/provider.tsx:20](https://github.com/monerium/js-monorepo/blob/ae1055c12538e860127a655bc059162d414323b3/packages/sdk-react-provider/src/lib/provider.tsx#L20)
+[sdk-react-provider/src/lib/provider.tsx:19](https://github.com/monerium/js-monorepo/blob/main/packages/sdk-react-provider/src/lib/provider.tsx#L19)
diff --git a/packages/sdk-react-provider/docs/generated/functions/useAuth.md b/packages/sdk-react-provider/docs/generated/functions/useAuth.md
@@ -23,8 +23,11 @@
 const { authorize, isAuthorized, isLoading, error } = useAuth();
 
 authorize(); // Redirects to the Monerium auth flow.
+
+// To opt-in to automated wallet linking, pass the address, signature and chain.
+authorize({ address, signature, chain }).
 ```
 
 ## Defined in
 
-[sdk-react-provider/src/lib/hooks.tsx:82](https://github.com/monerium/js-monorepo/blob/ae1055c12538e860127a655bc059162d414323b3/packages/sdk-react-provider/src/lib/hooks.tsx#L82)
+[sdk-react-provider/src/lib/hooks.tsx:85](https://github.com/monerium/js-monorepo/blob/main/packages/sdk-react-provider/src/lib/hooks.tsx#L85)
diff --git a/packages/sdk-react-provider/docs/generated/functions/useAuthContext.md b/packages/sdk-react-provider/docs/generated/functions/useAuthContext.md
@@ -38,4 +38,4 @@ const {
 
 ## Defined in
 
-[sdk-react-provider/src/lib/hooks.tsx:122](https://github.com/monerium/js-monorepo/blob/ae1055c12538e860127a655bc059162d414323b3/packages/sdk-react-provider/src/lib/hooks.tsx#L122)
+[sdk-react-provider/src/lib/hooks.tsx:125](https://github.com/monerium/js-monorepo/blob/main/packages/sdk-react-provider/src/lib/hooks.tsx#L125)
diff --git a/packages/sdk-react-provider/docs/generated/functions/useBalances.md b/packages/sdk-react-provider/docs/generated/functions/useBalances.md
@@ -39,4 +39,4 @@ const {
 
 ## Defined in
 
-[sdk-react-provider/src/lib/hooks.tsx:334](https://github.com/monerium/js-monorepo/blob/ae1055c12538e860127a655bc059162d414323b3/packages/sdk-react-provider/src/lib/hooks.tsx#L334)
+[sdk-react-provider/src/lib/hooks.tsx:337](https://github.com/monerium/js-monorepo/blob/main/packages/sdk-react-provider/src/lib/hooks.tsx#L337)
diff --git a/packages/sdk-react-provider/docs/generated/functions/useLinkAddress.md b/packages/sdk-react-provider/docs/generated/functions/useLinkAddress.md
@@ -41,4 +41,4 @@ const {
 
 ## Defined in
 
-[sdk-react-provider/src/lib/hooks.tsx:600](https://github.com/monerium/js-monorepo/blob/ae1055c12538e860127a655bc059162d414323b3/packages/sdk-react-provider/src/lib/hooks.tsx#L600)
+[sdk-react-provider/src/lib/hooks.tsx:594](https://github.com/monerium/js-monorepo/blob/main/packages/sdk-react-provider/src/lib/hooks.tsx#L594)
diff --git a/packages/sdk-react-provider/docs/generated/functions/useOrder.md b/packages/sdk-react-provider/docs/generated/functions/useOrder.md
@@ -39,4 +39,4 @@ const {
 
 ## Defined in
 
-[sdk-react-provider/src/lib/hooks.tsx:389](https://github.com/monerium/js-monorepo/blob/ae1055c12538e860127a655bc059162d414323b3/packages/sdk-react-provider/src/lib/hooks.tsx#L389)
+[sdk-react-provider/src/lib/hooks.tsx:389](https://github.com/monerium/js-monorepo/blob/main/packages/sdk-react-provider/src/lib/hooks.tsx#L389)
diff --git a/packages/sdk-react-provider/docs/generated/functions/useOrders.md b/packages/sdk-react-provider/docs/generated/functions/useOrders.md
@@ -43,4 +43,4 @@ const {
 
 ## Defined in
 
-[sdk-react-provider/src/lib/hooks.tsx:449](https://github.com/monerium/js-monorepo/blob/ae1055c12538e860127a655bc059162d414323b3/packages/sdk-react-provider/src/lib/hooks.tsx#L449)
+[sdk-react-provider/src/lib/hooks.tsx:449](https://github.com/monerium/js-monorepo/blob/main/packages/sdk-react-provider/src/lib/hooks.tsx#L449)
diff --git a/packages/sdk-react-provider/docs/generated/functions/usePlaceOrder.md b/packages/sdk-react-provider/docs/generated/functions/usePlaceOrder.md
@@ -43,4 +43,4 @@ const {
 
 ## Defined in
 
-[sdk-react-provider/src/lib/hooks.tsx:510](https://github.com/monerium/js-monorepo/blob/ae1055c12538e860127a655bc059162d414323b3/packages/sdk-react-provider/src/lib/hooks.tsx#L510)
+[sdk-react-provider/src/lib/hooks.tsx:510](https://github.com/monerium/js-monorepo/blob/main/packages/sdk-react-provider/src/lib/hooks.tsx#L510)
diff --git a/packages/sdk-react-provider/docs/generated/functions/useProfile.md b/packages/sdk-react-provider/docs/generated/functions/useProfile.md
@@ -41,4 +41,4 @@ const {
 
 ## Defined in
 
-[sdk-react-provider/src/lib/hooks.tsx:175](https://github.com/monerium/js-monorepo/blob/ae1055c12538e860127a655bc059162d414323b3/packages/sdk-react-provider/src/lib/hooks.tsx#L175)
+[sdk-react-provider/src/lib/hooks.tsx:178](https://github.com/monerium/js-monorepo/blob/main/packages/sdk-react-provider/src/lib/hooks.tsx#L178)
diff --git a/packages/sdk-react-provider/docs/generated/functions/useProfiles.md b/packages/sdk-react-provider/docs/generated/functions/useProfiles.md
@@ -38,4 +38,4 @@ const {
 
 ## Defined in
 
-[sdk-react-provider/src/lib/hooks.tsx:236](https://github.com/monerium/js-monorepo/blob/ae1055c12538e860127a655bc059162d414323b3/packages/sdk-react-provider/src/lib/hooks.tsx#L236)
+[sdk-react-provider/src/lib/hooks.tsx:239](https://github.com/monerium/js-monorepo/blob/main/packages/sdk-react-provider/src/lib/hooks.tsx#L239)
diff --git a/packages/sdk-react-provider/docs/generated/functions/useTokens.md b/packages/sdk-react-provider/docs/generated/functions/useTokens.md
@@ -38,4 +38,4 @@ const {
 
 ## Defined in
 
-[sdk-react-provider/src/lib/hooks.tsx:286](https://github.com/monerium/js-monorepo/blob/ae1055c12538e860127a655bc059162d414323b3/packages/sdk-react-provider/src/lib/hooks.tsx#L286)
+[sdk-react-provider/src/lib/hooks.tsx:289](https://github.com/monerium/js-monorepo/blob/main/packages/sdk-react-provider/src/lib/hooks.tsx#L289)
diff --git a/packages/sdk-react-provider/docs/generated/interfaces/AuthContext.md b/packages/sdk-react-provider/docs/generated/interfaces/AuthContext.md
@@ -6,13 +6,13 @@
 
 | Property         | Type                                                               | Defined in              |
 | ---------------- | ------------------------------------------------------------------ | ----------------------- |
-| `auth`           | \{`method`: `Method`;`subject`: `string`;`verified`: `boolean`; \} | sdk/dist/index.d.ts:127 |
-| `auth.method`    | `Method`                                                           | sdk/dist/index.d.ts:128 |
-| `auth.subject`   | `string`                                                           | sdk/dist/index.d.ts:129 |
-| `auth.verified`  | `boolean`                                                          | sdk/dist/index.d.ts:130 |
-| `defaultProfile` | `string`                                                           | sdk/dist/index.d.ts:132 |
-| `email`          | `string`                                                           | sdk/dist/index.d.ts:124 |
-| `name`           | `string`                                                           | sdk/dist/index.d.ts:125 |
-| `profiles`       | `AuthProfile`[]                                                    | sdk/dist/index.d.ts:133 |
-| `roles`          | `"admin"`[]                                                        | sdk/dist/index.d.ts:126 |
-| `userId`         | `string`                                                           | sdk/dist/index.d.ts:123 |
+| `auth`           | \{`method`: `Method`;`subject`: `string`;`verified`: `boolean`; \} | sdk/dist/index.d.ts:123 |
+| `auth.method`    | `Method`                                                           | sdk/dist/index.d.ts:124 |
+| `auth.subject`   | `string`                                                           | sdk/dist/index.d.ts:125 |
+| `auth.verified`  | `boolean`                                                          | sdk/dist/index.d.ts:126 |
+| `defaultProfile` | `string`                                                           | sdk/dist/index.d.ts:128 |
+| `email`          | `string`                                                           | sdk/dist/index.d.ts:120 |
+| `name`           | `string`                                                           | sdk/dist/index.d.ts:121 |
+| `profiles`       | `AuthProfile`[]                                                    | sdk/dist/index.d.ts:129 |
+| `roles`          | `"admin"`[]                                                        | sdk/dist/index.d.ts:122 |
+| `userId`         | `string`                                                           | sdk/dist/index.d.ts:119 |
diff --git a/packages/sdk-react-provider/docs/generated/interfaces/Balances.md b/packages/sdk-react-provider/docs/generated/interfaces/Balances.md
@@ -6,8 +6,8 @@
 
 | Property   | Type                                                 | Defined in              |
 | ---------- | ---------------------------------------------------- | ----------------------- |
-| `address`  | `string`                                             | sdk/dist/index.d.ts:188 |
-| `balances` | `Balance`[]                                          | sdk/dist/index.d.ts:191 |
-| `chain`    | `Chain`                                              | sdk/dist/index.d.ts:189 |
-| `id`       | `string`                                             | sdk/dist/index.d.ts:187 |
-| `network`  | `"sepolia"` \| `"chiado"` \| `"amoy"` \| `"mainnet"` | sdk/dist/index.d.ts:190 |
+| `address`  | `string`                                             | sdk/dist/index.d.ts:184 |
+| `balances` | `Balance`[]                                          | sdk/dist/index.d.ts:187 |
+| `chain`    | `Chain`                                              | sdk/dist/index.d.ts:185 |
+| `id`       | `string`                                             | sdk/dist/index.d.ts:183 |
+| `network`  | `"sepolia"` \| `"chiado"` \| `"amoy"` \| `"mainnet"` | sdk/dist/index.d.ts:186 |
diff --git a/packages/sdk-react-provider/docs/generated/interfaces/LinkAddress.md b/packages/sdk-react-provider/docs/generated/interfaces/LinkAddress.md
@@ -4,12 +4,10 @@
 
 ## Properties
 
-| Property       | Type                                                 | Description                    | Defined in              |
-| -------------- | ---------------------------------------------------- | ------------------------------ | ----------------------- |
-| `accounts`     | `CurrencyAccounts`[]                                 | -                              | sdk/dist/index.d.ts:333 |
-| `address`      | `string`                                             | -                              | sdk/dist/index.d.ts:330 |
-| ~~`chain?`~~   | `Chain`                                              | **Deprecated** - Use 'chainId' | sdk/dist/index.d.ts:337 |
-| `chainId?`     | `number`                                             | -                              | sdk/dist/index.d.ts:338 |
-| `message`      | `string`                                             | -                              | sdk/dist/index.d.ts:331 |
-| ~~`network?`~~ | `"sepolia"` \| `"chiado"` \| `"amoy"` \| `"mainnet"` | **Deprecated** - Use 'chainId' | sdk/dist/index.d.ts:335 |
-| `signature`    | `string`                                             | -                              | sdk/dist/index.d.ts:332 |
+| Property    | Type                 | Defined in              |
+| ----------- | -------------------- | ----------------------- |
+| `accounts`  | `CurrencyAccounts`[] | sdk/dist/index.d.ts:321 |
+| `address`   | `string`             | sdk/dist/index.d.ts:318 |
+| `chain?`    | `number` \| `Chain`  | sdk/dist/index.d.ts:322 |
+| `message`   | `string`             | sdk/dist/index.d.ts:319 |
+| `signature` | `string`             | sdk/dist/index.d.ts:320 |
diff --git a/packages/sdk-react-provider/docs/generated/interfaces/Order.md b/packages/sdk-react-provider/docs/generated/interfaces/Order.md
@@ -6,17 +6,17 @@
 
 | Property               | Type            | Defined in              |
 | ---------------------- | --------------- | ----------------------- |
-| `accountId`            | `string`        | sdk/dist/index.d.ts:260 |
-| `address`              | `string`        | sdk/dist/index.d.ts:261 |
-| `amount`               | `string`        | sdk/dist/index.d.ts:263 |
-| `counterpart`          | `Counterpart`   | sdk/dist/index.d.ts:267 |
-| `currency`             | `Currency`      | sdk/dist/index.d.ts:264 |
-| `fees`                 | `Fee`[]         | sdk/dist/index.d.ts:266 |
-| `id`                   | `string`        | sdk/dist/index.d.ts:258 |
-| `kind`                 | `OrderKind`     | sdk/dist/index.d.ts:262 |
-| `memo`                 | `string`        | sdk/dist/index.d.ts:268 |
-| `meta`                 | `OrderMetadata` | sdk/dist/index.d.ts:271 |
-| `profile`              | `string`        | sdk/dist/index.d.ts:259 |
-| `rejectedReason`       | `string`        | sdk/dist/index.d.ts:269 |
-| `supportingDocumentId` | `string`        | sdk/dist/index.d.ts:270 |
-| `totalFee`             | `string`        | sdk/dist/index.d.ts:265 |
+| `accountId`            | `string`        | sdk/dist/index.d.ts:254 |
+| `address`              | `string`        | sdk/dist/index.d.ts:255 |
+| `amount`               | `string`        | sdk/dist/index.d.ts:257 |
+| `counterpart`          | `Counterpart`   | sdk/dist/index.d.ts:261 |
+| `currency`             | `Currency`      | sdk/dist/index.d.ts:258 |
+| `fees`                 | `Fee`[]         | sdk/dist/index.d.ts:260 |
+| `id`                   | `string`        | sdk/dist/index.d.ts:252 |
+| `kind`                 | `OrderKind`     | sdk/dist/index.d.ts:256 |
+| `memo`                 | `string`        | sdk/dist/index.d.ts:262 |
+| `meta`                 | `OrderMetadata` | sdk/dist/index.d.ts:265 |
+| `profile`              | `string`        | sdk/dist/index.d.ts:253 |
+| `rejectedReason`       | `string`        | sdk/dist/index.d.ts:263 |
+| `supportingDocumentId` | `string`        | sdk/dist/index.d.ts:264 |
+| `totalFee`             | `string`        | sdk/dist/index.d.ts:259 |
diff --git a/packages/sdk-react-provider/docs/generated/interfaces/Profile.md b/packages/sdk-react-provider/docs/generated/interfaces/Profile.md
@@ -6,9 +6,9 @@
 
 | Property   | Type          | Defined in              |
 | ---------- | ------------- | ----------------------- |
-| `accounts` | `Account`[]   | sdk/dist/index.d.ts:180 |
-| `email`    | `string`      | sdk/dist/index.d.ts:177 |
-| `id`       | `string`      | sdk/dist/index.d.ts:175 |
-| `kind`     | `ProfileType` | sdk/dist/index.d.ts:179 |
-| `kyc`      | `KYC`         | sdk/dist/index.d.ts:178 |
-| `name`     | `string`      | sdk/dist/index.d.ts:176 |
+| `accounts` | `Account`[]   | sdk/dist/index.d.ts:176 |
+| `email`    | `string`      | sdk/dist/index.d.ts:173 |
+| `id`       | `string`      | sdk/dist/index.d.ts:171 |
+| `kind`     | `ProfileType` | sdk/dist/index.d.ts:175 |
+| `kyc`      | `KYC`         | sdk/dist/index.d.ts:174 |
+| `name`     | `string`      | sdk/dist/index.d.ts:172 |
diff --git a/packages/sdk-react-provider/docs/generated/interfaces/Token.md b/packages/sdk-react-provider/docs/generated/interfaces/Token.md
@@ -8,10 +8,10 @@ Information about the EURe token on different networks.
 
 | Property   | Type                                                 | Description                                      | Defined in              |
 | ---------- | ---------------------------------------------------- | ------------------------------------------------ | ----------------------- |
-| `address`  | `string`                                             | The address of the EURe contract on this network | sdk/dist/index.d.ts:283 |
-| `chain`    | `Chain`                                              | -                                                | sdk/dist/index.d.ts:280 |
-| `currency` | `Currency`                                           | -                                                | sdk/dist/index.d.ts:277 |
-| `decimals` | `number`                                             | How many decimals this token supports            | sdk/dist/index.d.ts:285 |
-| `network`  | `"sepolia"` \| `"chiado"` \| `"amoy"` \| `"mainnet"` | -                                                | sdk/dist/index.d.ts:281 |
-| `symbol`   | `TokenSymbol`                                        | -                                                | sdk/dist/index.d.ts:279 |
-| `ticker`   | `Ticker`                                             | -                                                | sdk/dist/index.d.ts:278 |
+| `address`  | `string`                                             | The address of the EURe contract on this network | sdk/dist/index.d.ts:277 |
+| `chain`    | `Chain`                                              | -                                                | sdk/dist/index.d.ts:274 |
+| `currency` | `Currency`                                           | -                                                | sdk/dist/index.d.ts:271 |
+| `decimals` | `number`                                             | How many decimals this token supports            | sdk/dist/index.d.ts:279 |
+| `network`  | `"sepolia"` \| `"chiado"` \| `"amoy"` \| `"mainnet"` | -                                                | sdk/dist/index.d.ts:275 |
+| `symbol`   | `TokenSymbol`                                        | -                                                | sdk/dist/index.d.ts:273 |
+| `ticker`   | `Ticker`                                             | -                                                | sdk/dist/index.d.ts:272 |
diff --git a/packages/sdk-react-provider/docs/generated/type-aliases/AuthorizeParams.md b/packages/sdk-react-provider/docs/generated/type-aliases/AuthorizeParams.md
@@ -2,8 +2,8 @@
 
 # Type Alias: AuthorizeParams
 
-> **AuthorizeParams**: \{`address`: `string`;`chainId`: `ChainId`;`signature`: `string`; \} \| \{`state`: `string`; \} \| \{\}
+> **AuthorizeParams**: \{`address`: `string`;`chainId`: `ChainId`;`signature`: `string`; \} \| \{`scope`: `string`;`state`: `string`; \} \| \{\}
 
 ## Defined in
 
-[sdk-react-provider/src/lib/types.ts:16](https://github.com/monerium/js-monorepo/blob/ae1055c12538e860127a655bc059162d414323b3/packages/sdk-react-provider/src/lib/types.ts#L16)
+[sdk-react-provider/src/lib/types.ts:16](https://github.com/monerium/js-monorepo/blob/main/packages/sdk-react-provider/src/lib/types.ts#L16)
diff --git a/packages/sdk-react-provider/docs/generated/type-aliases/MutationOptions.md b/packages/sdk-react-provider/docs/generated/type-aliases/MutationOptions.md
@@ -63,4 +63,4 @@ useMutationHook({
 
 ## Defined in
 
-[sdk-react-provider/src/lib/types.ts:202](https://github.com/monerium/js-monorepo/blob/ae1055c12538e860127a655bc059162d414323b3/packages/sdk-react-provider/src/lib/types.ts#L202)
+[sdk-react-provider/src/lib/types.ts:202](https://github.com/monerium/js-monorepo/blob/main/packages/sdk-react-provider/src/lib/types.ts#L202)
diff --git a/packages/sdk-react-provider/docs/generated/type-aliases/MutationResult.md b/packages/sdk-react-provider/docs/generated/type-aliases/MutationResult.md
@@ -52,4 +52,4 @@ const {
 
 ## Defined in
 
-[sdk-react-provider/src/lib/types.ts:247](https://github.com/monerium/js-monorepo/blob/ae1055c12538e860127a655bc059162d414323b3/packages/sdk-react-provider/src/lib/types.ts#L247)
+[sdk-react-provider/src/lib/types.ts:247](https://github.com/monerium/js-monorepo/blob/main/packages/sdk-react-provider/src/lib/types.ts#L247)
diff --git a/packages/sdk-react-provider/docs/generated/type-aliases/QueryOptions.md b/packages/sdk-react-provider/docs/generated/type-aliases/QueryOptions.md
@@ -74,4 +74,4 @@ useQueryHook({
 
 ## Defined in
 
-[sdk-react-provider/src/lib/types.ts:96](https://github.com/monerium/js-monorepo/blob/ae1055c12538e860127a655bc059162d414323b3/packages/sdk-react-provider/src/lib/types.ts#L96)
+[sdk-react-provider/src/lib/types.ts:96](https://github.com/monerium/js-monorepo/blob/main/packages/sdk-react-provider/src/lib/types.ts#L96)
diff --git a/packages/sdk-react-provider/docs/generated/type-aliases/QueryResult.md b/packages/sdk-react-provider/docs/generated/type-aliases/QueryResult.md
@@ -63,4 +63,4 @@ See [Tanstack Query - useQuery](https://tanstack.com/query/latest/docs/framework
 
 ## Defined in
 
-[sdk-react-provider/src/lib/types.ts:149](https://github.com/monerium/js-monorepo/blob/ae1055c12538e860127a655bc059162d414323b3/packages/sdk-react-provider/src/lib/types.ts#L149)
+[sdk-react-provider/src/lib/types.ts:149](https://github.com/monerium/js-monorepo/blob/main/packages/sdk-react-provider/src/lib/types.ts#L149)