@farmsdotmarket/openauth 0.4.4

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

@@ -0,0 +1,139 @@
+---
+title: DiscordProvider
+editUrl: https://github.com/toolbeam/openauth/blob/master/packages/openauth/src/provider/discord.ts
+description: Reference doc for the `DiscordProvider`.
+---
+
+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 Discord.
+
+```ts {5-8}
+import { DiscordProvider } from "@openauthjs/openauth/provider/discord"
+
+export default issuer({
+  providers: {
+    discord: DiscordProvider({
+      clientID: "1234567890",
+      clientSecret: "0987654321"
+    })
+  }
+})
+```
+</Section>
+---
+## Methods
+### DiscordProvider
+<Segment>
+<Section type="signature">
+```ts
+DiscordProvider(config)
+```
+</Section>
+<Section type="parameters">
+#### Parameters
+- <p><code class="key">config</code> [<code class="type">DiscordConfig</code>](/docs/provider/discord#discordconfig)</p>
+The config for the provider.
+</Section>
+<InlineSection>
+**Returns** <code class="type">Provider</code>
+</InlineSection>
+Create a Discord OAuth2 provider.
+```ts
+DiscordProvider({
+  clientID: "1234567890",
+  clientSecret: "0987654321"
+})
+```
+</Segment>
+## DiscordConfig
+<Segment>
+<Section type="parameters">
+- <p>[<code class="key">clientID</code>](#discordconfig.clientid) <code class="primitive">string</code></p>
+- <p>[<code class="key">clientSecret</code>](#discordconfig.clientsecret) <code class="primitive">string</code></p>
+- <p>[<code class="key">pkce?</code>](#discordconfig.pkce) <code class="primitive">boolean</code></p>
+- <p>[<code class="key">query?</code>](#discordconfig.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>](#discordconfig.scopes) <code class="primitive">string</code><code class="symbol">[]</code></p>
+</Section>
+</Segment>
+<NestedTitle id="discordconfig.clientid" Tag="h4" parent="DiscordConfig.">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="discordconfig.clientsecret" Tag="h4" parent="DiscordConfig.">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="discordconfig.pkce" Tag="h4" parent="DiscordConfig.">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="discordconfig.query" Tag="h4" parent="DiscordConfig.">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="discordconfig.scopes" Tag="h4" parent="DiscordConfig.">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/facebook.mdx

@@ -0,0 +1,233 @@
+---
+title: FacebookProvider
+editUrl: https://github.com/toolbeam/openauth/blob/master/packages/openauth/src/provider/facebook.ts
+description: Reference doc for the `FacebookProvider`.
+---
+
+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 Facebook. Supports both OAuth2 and OIDC.
+
+#### Using OAuth
+
+```ts {5-8}
+import { FacebookProvider } from "@openauthjs/openauth/provider/facebook"
+
+export default issuer({
+  providers: {
+    facebook: FacebookProvider({
+      clientID: "1234567890",
+      clientSecret: "0987654321"
+    })
+  }
+})
+```
+
+#### Using OIDC
+
+```ts {5-7}
+import { FacebookOidcProvider } from "@openauthjs/openauth/provider/facebook"
+
+export default issuer({
+  providers: {
+    facebook: FacebookOidcProvider({
+      clientID: "1234567890"
+    })
+  }
+})
+```
+</Section>
+---
+## Methods
+### FacebookOidcProvider
+<Segment>
+<Section type="signature">
+```ts
+FacebookOidcProvider(config)
+```
+</Section>
+<Section type="parameters">
+#### Parameters
+- <p><code class="key">config</code> [<code class="type">FacebookOidcConfig</code>](/docs/provider/facebook#facebookoidcconfig)</p>
+The config for the provider.
+</Section>
+<InlineSection>
+**Returns** <code class="type">Provider</code>
+</InlineSection>
+Create a Facebook OIDC provider.
+
+This is useful if you just want to verify the user's email address.
+```ts
+FacebookOidcProvider({
+  clientID: "1234567890"
+})
+```
+</Segment>
+### FacebookProvider
+<Segment>
+<Section type="signature">
+```ts
+FacebookProvider(config)
+```
+</Section>
+<Section type="parameters">
+#### Parameters
+- <p><code class="key">config</code> [<code class="type">FacebookConfig</code>](/docs/provider/facebook#facebookconfig)</p>
+The config for the provider.
+</Section>
+<InlineSection>
+**Returns** <code class="type">Provider</code>
+</InlineSection>
+Create a Facebook OAuth2 provider.
+```ts
+FacebookProvider({
+  clientID: "1234567890",
+  clientSecret: "0987654321"
+})
+```
+</Segment>
+## FacebookConfig
+<Segment>
+<Section type="parameters">
+- <p>[<code class="key">clientID</code>](#facebookconfig.clientid) <code class="primitive">string</code></p>
+- <p>[<code class="key">clientSecret</code>](#facebookconfig.clientsecret) <code class="primitive">string</code></p>
+- <p>[<code class="key">pkce?</code>](#facebookconfig.pkce) <code class="primitive">boolean</code></p>
+- <p>[<code class="key">query?</code>](#facebookconfig.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>](#facebookconfig.scopes) <code class="primitive">string</code><code class="symbol">[]</code></p>
+</Section>
+</Segment>
+<NestedTitle id="facebookconfig.clientid" Tag="h4" parent="FacebookConfig.">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="facebookconfig.clientsecret" Tag="h4" parent="FacebookConfig.">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="facebookconfig.pkce" Tag="h4" parent="FacebookConfig.">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="facebookconfig.query" Tag="h4" parent="FacebookConfig.">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="facebookconfig.scopes" Tag="h4" parent="FacebookConfig.">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>
+## FacebookOidcConfig
+<Segment>
+<Section type="parameters">
+- <p>[<code class="key">clientID</code>](#facebookoidcconfig.clientid) <code class="primitive">string</code></p>
+- <p>[<code class="key">query?</code>](#facebookoidcconfig.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>](#facebookoidcconfig.scopes) <code class="primitive">string</code><code class="symbol">[]</code></p>
+</Section>
+</Segment>
+<NestedTitle id="facebookoidcconfig.clientid" Tag="h4" parent="FacebookOidcConfig.">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="facebookoidcconfig.query" Tag="h4" parent="FacebookOidcConfig.">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="facebookoidcconfig.scopes" Tag="h4" parent="FacebookOidcConfig.">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/github.mdx

@@ -0,0 +1,139 @@
+---
+title: GithubProvider
+editUrl: https://github.com/toolbeam/openauth/blob/master/packages/openauth/src/provider/github.ts
+description: Reference doc for the `GithubProvider`.
+---
+
+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 Github.
+
+```ts {5-8}
+import { GithubProvider } from "@openauthjs/openauth/provider/github"
+
+export default issuer({
+  providers: {
+    github: GithubProvider({
+      clientID: "1234567890",
+      clientSecret: "0987654321"
+    })
+  }
+})
+```
+</Section>
+---
+## Methods
+### GithubProvider
+<Segment>
+<Section type="signature">
+```ts
+GithubProvider(config)
+```
+</Section>
+<Section type="parameters">
+#### Parameters
+- <p><code class="key">config</code> [<code class="type">GithubConfig</code>](/docs/provider/github#githubconfig)</p>
+The config for the provider.
+</Section>
+<InlineSection>
+**Returns** <code class="type">Provider</code>
+</InlineSection>
+Create a Github OAuth2 provider.
+```ts
+GithubProvider({
+  clientID: "1234567890",
+  clientSecret: "0987654321"
+})
+```
+</Segment>
+## GithubConfig
+<Segment>
+<Section type="parameters">
+- <p>[<code class="key">clientID</code>](#githubconfig.clientid) <code class="primitive">string</code></p>
+- <p>[<code class="key">clientSecret</code>](#githubconfig.clientsecret) <code class="primitive">string</code></p>
+- <p>[<code class="key">pkce?</code>](#githubconfig.pkce) <code class="primitive">boolean</code></p>
+- <p>[<code class="key">query?</code>](#githubconfig.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>](#githubconfig.scopes) <code class="primitive">string</code><code class="symbol">[]</code></p>
+</Section>
+</Segment>
+<NestedTitle id="githubconfig.clientid" Tag="h4" parent="GithubConfig.">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="githubconfig.clientsecret" Tag="h4" parent="GithubConfig.">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="githubconfig.pkce" Tag="h4" parent="GithubConfig.">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="githubconfig.query" Tag="h4" parent="GithubConfig.">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="githubconfig.scopes" Tag="h4" parent="GithubConfig.">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>