@farmsdotmarket/openauth 0.4.4

package/www/src/content/docs/docs/provider/microsoft.mdx

@@ -0,0 +1,252 @@
+---
+title: MicrosoftProvider
+editUrl: https://github.com/toolbeam/openauth/blob/master/packages/openauth/src/provider/microsoft.ts
+description: Reference doc for the `MicrosoftProvider`.
+---
+
+import { Segment, Section, NestedTitle, InlineSection } from 'toolbeam-docs-theme/components'
+import { Tabs, TabItem } from '@astrojs/starlight/components'
+
+<div class="tsdoc">
+<Section type="about">
+Use this provider to authenticate with Microsoft. Supports both OAuth2 and OIDC.
+
+#### Using OAuth
+
+```ts {5-9}
+import { MicrosoftProvider } from "@openauthjs/openauth/provider/microsoft"
+
+export default issuer({
+  providers: {
+    microsoft: MicrosoftProvider({
+      tenant: "1234567890",
+      clientID: "1234567890",
+      clientSecret: "0987654321"
+    })
+  }
+})
+```
+
+#### Using OIDC
+
+```ts {5-7}
+import { MicrosoftOidcProvider } from "@openauthjs/openauth/provider/microsoft"
+
+export default issuer({
+  providers: {
+    microsoft: MicrosoftOidcProvider({
+      clientID: "1234567890"
+    })
+  }
+})
+```
+</Section>
+---
+## Methods
+### MicrosoftOidcProvider
+<Segment>
+<Section type="signature">
+```ts
+MicrosoftOidcProvider(config)
+```
+</Section>
+<Section type="parameters">
+#### Parameters
+- <p><code class="key">config</code> [<code class="type">MicrosoftOidcConfig</code>](/docs/provider/microsoft#microsoftoidcconfig)</p>
+The config for the provider.
+</Section>
+<InlineSection>
+**Returns** <code class="type">Provider</code>
+</InlineSection>
+Create a Microsoft OIDC provider.
+
+This is useful if you just want to verify the user's email address.
+```ts
+MicrosoftOidcProvider({
+  clientID: "1234567890"
+})
+```
+</Segment>
+### MicrosoftProvider
+<Segment>
+<Section type="signature">
+```ts
+MicrosoftProvider(config)
+```
+</Section>
+<Section type="parameters">
+#### Parameters
+- <p><code class="key">config</code> [<code class="type">MicrosoftConfig</code>](/docs/provider/microsoft#microsoftconfig)</p>
+The config for the provider.
+</Section>
+<InlineSection>
+**Returns** <code class="type">Provider</code>
+</InlineSection>
+Create a Microsoft OAuth2 provider.
+```ts
+MicrosoftProvider({
+  tenant: "1234567890",
+  clientID: "1234567890",
+  clientSecret: "0987654321"
+})
+```
+</Segment>
+## MicrosoftConfig
+<Segment>
+<Section type="parameters">
+- <p>[<code class="key">clientID</code>](#microsoftconfig.clientid) <code class="primitive">string</code></p>
+- <p>[<code class="key">clientSecret</code>](#microsoftconfig.clientsecret) <code class="primitive">string</code></p>
+- <p>[<code class="key">pkce?</code>](#microsoftconfig.pkce) <code class="primitive">boolean</code></p>
+- <p>[<code class="key">query?</code>](#microsoftconfig.query) <code class="primitive">Record</code><code class="symbol">&lt;</code><code class="primitive">string</code>, <code class="primitive">string</code><code class="symbol">&gt;</code></p>
+- <p>[<code class="key">scopes</code>](#microsoftconfig.scopes) <code class="primitive">string</code><code class="symbol">[]</code></p>
+- <p>[<code class="key">tenant</code>](#microsoftconfig.tenant) <code class="primitive">string</code></p>
+</Section>
+</Segment>
+<NestedTitle id="microsoftconfig.clientid" Tag="h4" parent="MicrosoftConfig.">clientID</NestedTitle>
+<Segment>
+<Section type="parameters">
+<InlineSection>
+**Type** <code class="primitive">string</code>
+</InlineSection>
+</Section>
+The client ID.
+
+This is just a string to identify your app.
+```ts
+{
+  clientID: "my-client"
+}
+```
+</Segment>
+<NestedTitle id="microsoftconfig.clientsecret" Tag="h4" parent="MicrosoftConfig.">clientSecret</NestedTitle>
+<Segment>
+<Section type="parameters">
+<InlineSection>
+**Type** <code class="primitive">string</code>
+</InlineSection>
+</Section>
+The client secret.
+
+This is a private key that's used to authenticate your app. It should be kept secret.
+```ts
+{
+  clientSecret: "0987654321"
+}
+```
+</Segment>
+<NestedTitle id="microsoftconfig.pkce" Tag="h4" parent="MicrosoftConfig.">pkce?</NestedTitle>
+<Segment>
+<Section type="parameters">
+<InlineSection>
+**Type** <code class="primitive">boolean</code>
+</InlineSection>
+</Section>
+
+<InlineSection>
+**Default** false
+</InlineSection>
+Whether to use PKCE (Proof Key for Code Exchange) for the authorization code flow.
+Some providers like x.com require this.
+</Segment>
+<NestedTitle id="microsoftconfig.query" Tag="h4" parent="MicrosoftConfig.">query?</NestedTitle>
+<Segment>
+<Section type="parameters">
+<InlineSection>
+**Type** <code class="primitive">Record</code><code class="symbol">&lt;</code><code class="primitive">string</code>, <code class="primitive">string</code><code class="symbol">&gt;</code>
+</InlineSection>
+</Section>
+Any additional parameters that you want to pass to the authorization endpoint.
+```ts
+{
+  query: {
+    access_type: "offline",
+    prompt: "consent"
+  }
+}
+```
+</Segment>
+<NestedTitle id="microsoftconfig.scopes" Tag="h4" parent="MicrosoftConfig.">scopes</NestedTitle>
+<Segment>
+<Section type="parameters">
+<InlineSection>
+**Type** <code class="primitive">string</code><code class="symbol">[]</code>
+</InlineSection>
+</Section>
+A list of OAuth scopes that you want to request.
+```ts
+{
+  scopes: ["email", "profile"]
+}
+```
+</Segment>
+<NestedTitle id="microsoftconfig.tenant" Tag="h4" parent="MicrosoftConfig.">tenant</NestedTitle>
+<Segment>
+<Section type="parameters">
+<InlineSection>
+**Type** <code class="primitive">string</code>
+</InlineSection>
+</Section>
+The tenant ID of the Microsoft account.
+
+This is usually the same as the client ID.
+```ts
+{
+  tenant: "1234567890"
+}
+```
+</Segment>
+## MicrosoftOidcConfig
+<Segment>
+<Section type="parameters">
+- <p>[<code class="key">clientID</code>](#microsoftoidcconfig.clientid) <code class="primitive">string</code></p>
+- <p>[<code class="key">query?</code>](#microsoftoidcconfig.query) <code class="primitive">Record</code><code class="symbol">&lt;</code><code class="primitive">string</code>, <code class="primitive">string</code><code class="symbol">&gt;</code></p>
+- <p>[<code class="key">scopes?</code>](#microsoftoidcconfig.scopes) <code class="primitive">string</code><code class="symbol">[]</code></p>
+</Section>
+</Segment>
+<NestedTitle id="microsoftoidcconfig.clientid" Tag="h4" parent="MicrosoftOidcConfig.">clientID</NestedTitle>
+<Segment>
+<Section type="parameters">
+<InlineSection>
+**Type** <code class="primitive">string</code>
+</InlineSection>
+</Section>
+The client ID.
+
+This is just a string to identify your app.
+```ts
+{
+  clientID: "my-client"
+}
+```
+</Segment>
+<NestedTitle id="microsoftoidcconfig.query" Tag="h4" parent="MicrosoftOidcConfig.">query?</NestedTitle>
+<Segment>
+<Section type="parameters">
+<InlineSection>
+**Type** <code class="primitive">Record</code><code class="symbol">&lt;</code><code class="primitive">string</code>, <code class="primitive">string</code><code class="symbol">&gt;</code>
+</InlineSection>
+</Section>
+Any additional parameters that you want to pass to the authorization endpoint.
+```ts
+{
+  query: {
+    prompt: "consent"
+  }
+}
+```
+</Segment>
+<NestedTitle id="microsoftoidcconfig.scopes" Tag="h4" parent="MicrosoftOidcConfig.">scopes?</NestedTitle>
+<Segment>
+<Section type="parameters">
+<InlineSection>
+**Type** <code class="primitive">string</code><code class="symbol">[]</code>
+</InlineSection>
+</Section>
+A list of OIDC scopes that you want to request.
+```ts
+{
+  scopes: ["openid", "profile", "email"]
+}
+```
+</Segment>
+</div>

package/www/src/content/docs/docs/provider/oauth2.mdx

@@ -0,0 +1,173 @@
+---
+title: Oauth2Provider
+editUrl: https://github.com/toolbeam/openauth/blob/master/packages/openauth/src/provider/oauth2.ts
+description: Reference doc for the `Oauth2Provider`.
+---
+
+import { Segment, Section, NestedTitle, InlineSection } from 'toolbeam-docs-theme/components'
+import { Tabs, TabItem } from '@astrojs/starlight/components'
+
+<div class="tsdoc">
+<Section type="about">
+Use this to connect authentication providers that support OAuth 2.0.
+
+```ts {5-12}
+import { Oauth2Provider } from "@openauthjs/openauth/provider/oauth2"
+
+export default issuer({
+  providers: {
+    oauth2: Oauth2Provider({
+      clientID: "1234567890",
+      clientSecret: "0987654321",
+      endpoint: {
+        authorization: "https://auth.myserver.com/authorize",
+        token: "https://auth.myserver.com/token"
+      }
+    })
+  }
+})
+```
+</Section>
+---
+## Methods
+### Oauth2Provider
+<Segment>
+<Section type="signature">
+```ts
+Oauth2Provider(config)
+```
+</Section>
+<Section type="parameters">
+#### Parameters
+- <p><code class="key">config</code> [<code class="type">Oauth2Config</code>](/docs/provider/oauth2#oauth2config)</p>
+</Section>
+<InlineSection>
+**Returns** <code class="type">Provider</code>
+</InlineSection>
+</Segment>
+## Oauth2Config
+<Segment>
+<Section type="parameters">
+- <p>[<code class="key">clientID</code>](#oauth2config.clientid) <code class="primitive">string</code></p>
+- <p>[<code class="key">clientSecret</code>](#oauth2config.clientsecret) <code class="primitive">string</code></p>
+- <p>[<code class="key">endpoint</code>](#oauth2config.endpoint) <code class="primitive">Object</code></p>
+  - <p>[<code class="key">authorization</code>](#endpoint.authorization) <code class="primitive">string</code></p>
+  - <p>[<code class="key">token</code>](#endpoint.token) <code class="primitive">string</code></p>
+- <p>[<code class="key">pkce?</code>](#oauth2config.pkce) <code class="primitive">boolean</code></p>
+- <p>[<code class="key">query?</code>](#oauth2config.query) <code class="primitive">Record</code><code class="symbol">&lt;</code><code class="primitive">string</code>, <code class="primitive">string</code><code class="symbol">&gt;</code></p>
+- <p>[<code class="key">scopes</code>](#oauth2config.scopes) <code class="primitive">string</code><code class="symbol">[]</code></p>
+</Section>
+</Segment>
+<NestedTitle id="oauth2config.clientid" Tag="h4" parent="Oauth2Config.">clientID</NestedTitle>
+<Segment>
+<Section type="parameters">
+<InlineSection>
+**Type** <code class="primitive">string</code>
+</InlineSection>
+</Section>
+The client ID.
+
+This is just a string to identify your app.
+```ts
+{
+  clientID: "my-client"
+}
+```
+</Segment>
+<NestedTitle id="oauth2config.clientsecret" Tag="h4" parent="Oauth2Config.">clientSecret</NestedTitle>
+<Segment>
+<Section type="parameters">
+<InlineSection>
+**Type** <code class="primitive">string</code>
+</InlineSection>
+</Section>
+The client secret.
+
+This is a private key that's used to authenticate your app. It should be kept secret.
+```ts
+{
+  clientSecret: "0987654321"
+}
+```
+</Segment>
+<NestedTitle id="oauth2config.endpoint" Tag="h4" parent="Oauth2Config.">endpoint</NestedTitle>
+<Segment>
+<Section type="parameters">
+<InlineSection>
+**Type** <code class="primitive">Object</code>
+</InlineSection>
+</Section>
+The URLs of the authorization and token endpoints.
+```ts
+{
+  endpoint: {
+    authorization: "https://auth.myserver.com/authorize",
+    token: "https://auth.myserver.com/token"
+  }
+}
+```
+</Segment>
+<NestedTitle id="endpoint.authorization" Tag="h5" parent="Oauth2Config.endpoint.">authorization</NestedTitle>
+<Segment>
+<Section type="parameters">
+<InlineSection>
+**Type** <code class="primitive">string</code>
+</InlineSection>
+</Section>
+The URL of the authorization endpoint.
+</Segment>
+<NestedTitle id="endpoint.token" Tag="h5" parent="Oauth2Config.endpoint.">token</NestedTitle>
+<Segment>
+<Section type="parameters">
+<InlineSection>
+**Type** <code class="primitive">string</code>
+</InlineSection>
+</Section>
+The URL of the token endpoint.
+</Segment>
+<NestedTitle id="oauth2config.pkce" Tag="h4" parent="Oauth2Config.">pkce?</NestedTitle>
+<Segment>
+<Section type="parameters">
+<InlineSection>
+**Type** <code class="primitive">boolean</code>
+</InlineSection>
+</Section>
+
+<InlineSection>
+**Default** false
+</InlineSection>
+Whether to use PKCE (Proof Key for Code Exchange) for the authorization code flow.
+Some providers like x.com require this.
+</Segment>
+<NestedTitle id="oauth2config.query" Tag="h4" parent="Oauth2Config.">query?</NestedTitle>
+<Segment>
+<Section type="parameters">
+<InlineSection>
+**Type** <code class="primitive">Record</code><code class="symbol">&lt;</code><code class="primitive">string</code>, <code class="primitive">string</code><code class="symbol">&gt;</code>
+</InlineSection>
+</Section>
+Any additional parameters that you want to pass to the authorization endpoint.
+```ts
+{
+  query: {
+    access_type: "offline",
+    prompt: "consent"
+  }
+}
+```
+</Segment>
+<NestedTitle id="oauth2config.scopes" Tag="h4" parent="Oauth2Config.">scopes</NestedTitle>
+<Segment>
+<Section type="parameters">
+<InlineSection>
+**Type** <code class="primitive">string</code><code class="symbol">[]</code>
+</InlineSection>
+</Section>
+A list of OAuth scopes that you want to request.
+```ts
+{
+  scopes: ["email", "profile"]
+}
+```
+</Segment>
+</div>

package/www/src/content/docs/docs/provider/oidc.mdx

@@ -0,0 +1,113 @@
+---
+title: OidcProvider
+editUrl: https://github.com/toolbeam/openauth/blob/master/packages/openauth/src/provider/oidc.ts
+description: Reference doc for the `OidcProvider`.
+---
+
+import { Segment, Section, NestedTitle, InlineSection } from 'toolbeam-docs-theme/components'
+import { Tabs, TabItem } from '@astrojs/starlight/components'
+
+<div class="tsdoc">
+<Section type="about">
+Use this to connect authentication providers that support OIDC.
+
+```ts {5-8}
+import { OidcProvider } from "@openauthjs/openauth/provider/oidc"
+
+export default issuer({
+  providers: {
+    oauth2: OidcProvider({
+      clientId: "1234567890",
+      issuer: "https://auth.myserver.com"
+    })
+  }
+})
+```
+</Section>
+---
+## Methods
+### OidcProvider
+<Segment>
+<Section type="signature">
+```ts
+OidcProvider(config)
+```
+</Section>
+<Section type="parameters">
+#### Parameters
+- <p><code class="key">config</code> [<code class="type">OidcConfig</code>](/docs/provider/oidc#oidcconfig)</p>
+</Section>
+<InlineSection>
+**Returns** <code class="type">Provider</code>
+</InlineSection>
+</Segment>
+## OidcConfig
+<Segment>
+<Section type="parameters">
+- <p>[<code class="key">clientID</code>](#oidcconfig.clientid) <code class="primitive">string</code></p>
+- <p>[<code class="key">issuer</code>](#oidcconfig.issuer) <code class="primitive">string</code></p>
+- <p>[<code class="key">query?</code>](#oidcconfig.query) <code class="primitive">Record</code><code class="symbol">&lt;</code><code class="primitive">string</code>, <code class="primitive">string</code><code class="symbol">&gt;</code></p>
+- <p>[<code class="key">scopes?</code>](#oidcconfig.scopes) <code class="primitive">string</code><code class="symbol">[]</code></p>
+</Section>
+</Segment>
+<NestedTitle id="oidcconfig.clientid" Tag="h4" parent="OidcConfig.">clientID</NestedTitle>
+<Segment>
+<Section type="parameters">
+<InlineSection>
+**Type** <code class="primitive">string</code>
+</InlineSection>
+</Section>
+The client ID.
+
+This is just a string to identify your app.
+```ts
+{
+  clientID: "my-client"
+}
+```
+</Segment>
+<NestedTitle id="oidcconfig.issuer" Tag="h4" parent="OidcConfig.">issuer</NestedTitle>
+<Segment>
+<Section type="parameters">
+<InlineSection>
+**Type** <code class="primitive">string</code>
+</InlineSection>
+</Section>
+The URL of your authorization server.
+```ts
+{
+  issuer: "https://auth.myserver.com"
+}
+```
+</Segment>
+<NestedTitle id="oidcconfig.query" Tag="h4" parent="OidcConfig.">query?</NestedTitle>
+<Segment>
+<Section type="parameters">
+<InlineSection>
+**Type** <code class="primitive">Record</code><code class="symbol">&lt;</code><code class="primitive">string</code>, <code class="primitive">string</code><code class="symbol">&gt;</code>
+</InlineSection>
+</Section>
+Any additional parameters that you want to pass to the authorization endpoint.
+```ts
+{
+  query: {
+    prompt: "consent"
+  }
+}
+```
+</Segment>
+<NestedTitle id="oidcconfig.scopes" Tag="h4" parent="OidcConfig.">scopes?</NestedTitle>
+<Segment>
+<Section type="parameters">
+<InlineSection>
+**Type** <code class="primitive">string</code><code class="symbol">[]</code>
+</InlineSection>
+</Section>
+A list of OIDC scopes that you want to request.
+```ts
+{
+  scopes: ["openid", "profile", "email"]
+}
+```
+</Segment>
+</div>