@mayurajs/auth-facebook 0.0.0-stage → 1.2.0

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/NOTICE

@@ -0,0 +1,8 @@
+Mayura
+Copyright 2026 The Mayura Authors
+
+This product includes software developed by the Mayura contributors.
+
+Third-party dependencies retain their own copyright and license terms. Exact
+resolved versions are recorded in pnpm-lock.yaml and reviewed by the release
+artifact and dependency qualification procedures.

package/README.md

@@ -1,3 +1,51 @@
-# Temporary Holding Version
+# @mayurajs/auth-facebook
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+Facebook sign-in for Mayura, on any runtime, with no dependency:
+
+- `facebookAuthenticator`: Facebook Login user access tokens sent straight to Mayura's server, checked with Facebook,
+  and iOS Limited Login tokens, checked with Facebook's keys;
+- `facebookSignIn`: Facebook as a better-auth social login (with `mayura/auth/better-auth`), reading no more of the
+  profile than signing in needs.
+
+```bash
+npm install mayura @mayurajs/auth-facebook
+```
+
+```ts
+import { principalId } from 'mayura/auth';
+import { facebookAuthenticator, facebookSignIn } from '@mayurajs/auth-facebook';
+
+const authenticate = facebookAuthenticator({
+  appId: process.env.FACEBOOK_APP_ID!,
+  appSecret: process.env.FACEBOOK_APP_SECRET!,
+  requiredScopes: ['email'],
+  identity: session => ({
+    principalId: principalId('facebook', session.userId),
+    projectId: 'acme',
+    agentIds: ['support'],
+    capabilities: ['runs:submit', 'runs:read'],
+  }),
+});
+
+// Or sign people in with better-auth:
+// betterAuth({ socialProviders: { facebook: facebookSignIn({ clientId, clientSecret }) }, ... })
+```
+
+- **Access tokens are opaque**, so each one is checked with Facebook's `debug_token` (Graph API `v26.0` unless
+  `graphVersion`), using your app's token (`appId|appSecret`, which never leaves your server and never appears in an
+  error). A token passes only when Facebook says it is valid, a user's, for your app, unexpired, and holds every
+  `requiredScopes` permission. That is a call to Facebook per request: `cacheTtlMs` (up to 5 minutes, 0 by default)
+  keeps Facebook's answer for that long, so a token the user revokes then works for that long more. A call takes at
+  most `timeoutMs` (5 s); when Facebook cannot answer, the server answers that authentication is unavailable.
+- **Limited Login** (with `limitedLogin: true`): iOS Limited Login tokens are OIDC JWTs, checked with no call per
+  request: RS256 with Facebook's keys, issued by `https://www.facebook.com`, for your app. Check the token's `nonce`
+  in your app, which made it.
+- **What you get.** `identity` receives `kind` (`access_token` or `limited_login`), `userId` (app-scoped: the same
+  person has a different id in each of your apps), `scopes`, `email` and `name` (Limited Login), and `expiresAtMs`.
+  Nothing is granted unless `identity` grants it.
+- **`facebookSignIn`** gives better-auth's `socialProviders.facebook` reading only `id`, `name` and `email` (`picture`
+  if asked), with no permissions beyond better-auth's `email` and `public_profile` unless you add `scopes`.
+- Options: `facebookAuthenticator({ appId, appSecret, identity, requiredScopes, limitedLogin, cacheTtlMs, timeoutMs,
+  graphVersion, clockSkewMs, maxIdentityMs, fetch })`, `facebookSignIn({ clientId, clientSecret, picture, scopes })`.
+
+See [Authentication and API keys](https://mayurajs.com/docs/guides/authentication/). Apache-2.0.

package/dist/index.d.ts

@@ -0,0 +1,67 @@
+import { type Authenticator, type IdentityGrant } from 'mayura/auth';
+/** A verified Facebook user: from a Login access token (checked with Facebook) or a Limited Login token. */
+export interface FacebookSession {
+    /** `access_token` for a Facebook Login user access token; `limited_login` for an iOS Limited Login token. */
+    readonly kind: 'access_token' | 'limited_login';
+    /** The app-scoped user id: the same user has a different id in each of your apps. */
+    readonly userId: string;
+    /** The permissions the user granted your app (access tokens). */
+    readonly scopes: readonly string[];
+    readonly email: string | null;
+    readonly name: string | null;
+    /** When the token expires, in milliseconds since the epoch; null where Facebook gives none. */
+    readonly expiresAtMs: number | null;
+}
+export interface FacebookAuthenticatorOptions {
+    /** Your Facebook app's ID. */
+    readonly appId: string;
+    /** Your app's secret, to ask Facebook about access tokens; it stays on your server. */
+    readonly appSecret: string;
+    /** What a Facebook user may do, or null to refuse. */
+    readonly identity: (session: FacebookSession) => IdentityGrant | null | Promise<IdentityGrant | null>;
+    /** Permissions the user must have granted your app, such as `email`. */
+    readonly requiredScopes?: readonly string[];
+    /** Also accept iOS Limited Login tokens (OIDC JWTs, checked with Facebook's keys, with no call per request). */
+    readonly limitedLogin?: boolean;
+    /**
+     * Keep what Facebook said about an access token for this long; 0 by default, so each request asks Facebook and a
+     * token the user revoked stops at once. At most 5 minutes.
+     */
+    readonly cacheTtlMs?: number;
+    /** The longest wait for Facebook; 5 s by default (1 s to 30 s). */
+    readonly timeoutMs?: number;
+    /** The Graph API version; `v26.0` by default. */
+    readonly graphVersion?: string;
+    /** Clock difference allowed for Limited Login tokens; 5 s by default. */
+    readonly clockSkewMs?: number;
+    /** The longest an identity lasts before the token is checked again; 60 s by default. */
+    readonly maxIdentityMs?: number;
+    /** For tests and proxies: the fetch to use. */
+    readonly fetch?: typeof fetch;
+}
+/**
+ * A server `authenticate` for Facebook users. Login access tokens are opaque, so each is checked with Facebook's
+ * `debug_token` (a call per request unless `cacheTtlMs`): it must be valid, a user's, for your app, and hold the
+ * permissions you require. With `limitedLogin`, iOS Limited Login tokens are checked as JWTs: RS256 with Facebook's
+ * keys, from `https://www.facebook.com`, for your app. `identity` decides what the user may do.
+ */
+export declare function facebookAuthenticator(options: FacebookAuthenticatorOptions): Authenticator;
+/** Facebook sign-in for better-auth's `socialProviders.facebook`, as `facebookSignIn` makes it. */
+export interface FacebookSignInOptions {
+    readonly clientId: string;
+    readonly clientSecret: string;
+    readonly fields: string[];
+    readonly scope?: string[];
+}
+/**
+ * Facebook sign-in for better-auth (`socialProviders: { facebook: facebookSignIn({ clientId, clientSecret }) }`), reading
+ * no more of the profile than signing in needs (`id`, `name`, `email`; `picture` only if asked), and asking for no
+ * permissions beyond better-auth's `email` and `public_profile` unless given.
+ */
+export declare function facebookSignIn(options: {
+    readonly clientId: string;
+    readonly clientSecret: string;
+    readonly picture?: boolean;
+    readonly scopes?: readonly string[];
+}): FacebookSignInOptions;
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAEA,OAAO,EAEL,KAAK,aAAa,EAAE,KAAK,aAAa,EACvC,MAAM,aAAa,CAAC;AAErB,4GAA4G;AAC5G,MAAM,WAAW,eAAe;IAC9B,6GAA6G;IAC7G,QAAQ,CAAC,IAAI,EAAE,cAAc,GAAG,eAAe,CAAC;IAChD,qFAAqF;IACrF,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,iEAAiE;IACjE,QAAQ,CAAC,MAAM,EAAE,SAAS,MAAM,EAAE,CAAC;IACnC,QAAQ,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IAC9B,QAAQ,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IAC7B,+FAA+F;IAC/F,QAAQ,CAAC,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;CACrC;AAED,MAAM,WAAW,4BAA4B;IAC3C,8BAA8B;IAC9B,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB,uFAAuF;IACvF,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;IAC3B,sDAAsD;IACtD,QAAQ,CAAC,QAAQ,EAAE,CAAC,OAAO,EAAE,eAAe,KAAK,aAAa,GAAG,IAAI,GAAG,OAAO,CAAC,aAAa,GAAG,IAAI,CAAC,CAAC;IACtG,wEAAwE;IACxE,QAAQ,CAAC,cAAc,CAAC,EAAE,SAAS,MAAM,EAAE,CAAC;IAC5C,gHAAgH;IAChH,QAAQ,CAAC,YAAY,CAAC,EAAE,OAAO,CAAC;IAChC;;;OAGG;IACH,QAAQ,CAAC,UAAU,CAAC,EAAE,MAAM,CAAC;IAC7B,mEAAmE;IACnE,QAAQ,CAAC,SAAS,CAAC,EAAE,MAAM,CAAC;IAC5B,iDAAiD;IACjD,QAAQ,CAAC,YAAY,CAAC,EAAE,MAAM,CAAC;IAC/B,yEAAyE;IACzE,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAC;IAC9B,wFAAwF;IACxF,QAAQ,CAAC,aAAa,CAAC,EAAE,MAAM,CAAC;IAChC,+CAA+C;IAC/C,QAAQ,CAAC,KAAK,CAAC,EAAE,OAAO,KAAK,CAAC;CAC/B;AAaD;;;;;GAKG;AACH,wBAAgB,qBAAqB,CAAC,OAAO,EAAE,4BAA4B,GAAG,aAAa,CA+D1F;AAED,mGAAmG;AACnG,MAAM,WAAW,qBAAqB;IACpC,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;IAC1B,QAAQ,CAAC,YAAY,EAAE,MAAM,CAAC;IAC9B,QAAQ,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC;IAC1B,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,EAAE,CAAC;CAC3B;AAED;;;;GAIG;AACH,wBAAgB,cAAc,CAAC,OAAO,EAAE;IAAE,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;IAAC,QAAQ,CAAC,YAAY,EAAE,MAAM,CAAC;IAAC,QAAQ,CAAC,OAAO,CAAC,EAAE,OAAO,CAAC;IAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,SAAS,MAAM,EAAE,CAAA;CAAE,GAAG,qBAAqB,CAS5L"}

package/dist/index.js

@@ -0,0 +1,123 @@
+import { MayuraError } from 'mayura';
+import { sha256Hex } from 'mayura/core/host';
+import { jwtVerifier, peekIssuer, remoteJwks, serverIdentity, } from 'mayura/auth';
+/** Facebook Login user access tokens: opaque, starting `EA`. */
+const accessToken = /^EA[A-Za-z0-9]{20,1024}$/u;
+const limitedIssuer = 'https://www.facebook.com';
+const text = (value) => typeof value === 'string' && value !== '' ? value : null;
+function bounded(value, name, fallback, min, max) {
+    const result = value ?? fallback;
+    if (!Number.isSafeInteger(result) || result < min || result > max)
+        throw new MayuraError('INVALID_CONFIG', `facebookAuthenticator(): ${name} is ${min.toLocaleString('en-US')} to ${max.toLocaleString('en-US')}.`);
+    return result;
+}
+/**
+ * A server `authenticate` for Facebook users. Login access tokens are opaque, so each is checked with Facebook's
+ * `debug_token` (a call per request unless `cacheTtlMs`): it must be valid, a user's, for your app, and hold the
+ * permissions you require. With `limitedLogin`, iOS Limited Login tokens are checked as JWTs: RS256 with Facebook's
+ * keys, from `https://www.facebook.com`, for your app. `identity` decides what the user may do.
+ */
+export function facebookAuthenticator(options) {
+    if (!options || typeof options.identity !== 'function')
+        throw new MayuraError('INVALID_CONFIG', 'facebookAuthenticator(): identity decides what a Facebook user may do.');
+    if (typeof options.appId !== 'string' || !/^\d{5,20}$/u.test(options.appId))
+        throw new MayuraError('INVALID_CONFIG', 'facebookAuthenticator(): appId is your Facebook app\'s ID.');
+    if (typeof options.appSecret !== 'string' || !/^[A-Za-z0-9]{16,128}$/u.test(options.appSecret))
+        throw new MayuraError('INVALID_CONFIG', 'facebookAuthenticator(): appSecret is your app\'s secret.');
+    const required = options.requiredScopes ?? [];
+    if (!Array.isArray(required) || required.some(scope => typeof scope !== 'string' || !/^[a-z_]{1,64}$/u.test(scope)))
+        throw new MayuraError('INVALID_CONFIG', 'facebookAuthenticator(): requiredScopes are permissions such as email or public_profile.');
+    if (options.limitedLogin !== undefined && typeof options.limitedLogin !== 'boolean')
+        throw new MayuraError('INVALID_CONFIG', 'facebookAuthenticator(): limitedLogin must be a boolean.');
+    const cacheTtlMs = bounded(options.cacheTtlMs, 'cacheTtlMs', 0, 0, 300_000);
+    const timeoutMs = bounded(options.timeoutMs, 'timeoutMs', 5_000, 1_000, 30_000);
+    const maxIdentityMs = bounded(options.maxIdentityMs, 'maxIdentityMs', 60_000, 1_000, 3_600_000);
+    const version = options.graphVersion ?? 'v26.0';
+    if (typeof version !== 'string' || !/^v\d{1,3}\.\d{1,2}$/u.test(version))
+        throw new MayuraError('INVALID_CONFIG', 'facebookAuthenticator(): graphVersion is a Graph API version such as v26.0.');
+    const fetcher = options.fetch ?? globalThis.fetch;
+    const appToken = `${options.appId}|${options.appSecret}`;
+    const cache = new Map();
+    const limited = options.limitedLogin === true ? jwtVerifier({
+        issuer: limitedIssuer, audience: options.appId, algorithms: ['RS256'], clockSkewMs: options.clockSkewMs ?? 5_000,
+        keys: remoteJwks({ url: 'https://www.facebook.com/.well-known/oauth/openid/jwks/', ...(options.fetch ? { fetch: options.fetch } : {}) }),
+    }) : undefined;
+    /** What Facebook says about an access token; null when it is not a valid user token for this app. */
+    const inspect = async (token, signal) => {
+        const url = `https://graph.facebook.com/${version}/debug_token?${new URLSearchParams({ input_token: token, access_token: appToken })}`;
+        let response;
+        try {
+            response = await fetcher(url, { signal: AbortSignal.any([signal, AbortSignal.timeout(timeoutMs)]), headers: { accept: 'application/json' }, redirect: 'error' });
+        }
+        // The URL holds the app secret: no error may carry it.
+        catch {
+            throw signal.aborted ? new MayuraError('CANCELLED', 'Authentication was cancelled.') : new MayuraError('TOOL_FAILED', 'Facebook could not be reached to check the token.');
+        }
+        if (!response.ok) {
+            void response.body?.cancel().catch(() => undefined);
+            throw new MayuraError('TOOL_FAILED', `Facebook answered HTTP ${response.status} when checking the token.`);
+        }
+        const body = await response.json().catch(() => undefined);
+        const data = body?.data;
+        if (!data || typeof data !== 'object')
+            throw new MayuraError('TOOL_FAILED', 'Facebook\'s answer about the token is not one Mayura knows.');
+        if (data['is_valid'] !== true || data['app_id'] !== options.appId || data['type'] !== 'USER' || typeof data['user_id'] !== 'string' || data['user_id'] === '')
+            return null;
+        const scopes = Array.isArray(data['scopes']) ? data['scopes'].filter((scope) => typeof scope === 'string') : [];
+        if (required.some(scope => !scopes.includes(scope)))
+            return null;
+        const expires = data['expires_at'];
+        // 0 is Facebook's "does not expire".
+        const expiresAtMs = typeof expires === 'number' && expires > 0 ? expires * 1_000 : null;
+        return Object.freeze({ kind: 'access_token', userId: data['user_id'], scopes: Object.freeze(scopes), email: null, name: null, expiresAtMs });
+    };
+    const accepts = (token) => typeof token === 'string' && (accessToken.test(token) || (limited !== undefined && peekIssuer(token) === limitedIssuer));
+    const authenticate = async ({ token, signal }) => {
+        if (typeof token !== 'string')
+            return null;
+        let session = null;
+        if (accessToken.test(token)) {
+            const key = sha256Hex(token);
+            const cached = cache.get(key);
+            if (cached && cached.until > Date.now())
+                session = cached.session;
+            else {
+                session = await inspect(token, signal);
+                // Without cacheTtlMs an answer is out of date the moment it is kept.
+                if (cache.size >= 10_000)
+                    cache.delete(cache.keys().next().value);
+                cache.set(key, { session, until: Date.now() + cacheTtlMs });
+            }
+        }
+        else if (limited !== undefined && peekIssuer(token) === limitedIssuer) {
+            const result = await limited.verify(token, { signal });
+            if (result.ok && typeof result.claims.sub === 'string' && result.claims.sub !== '') {
+                session = Object.freeze({ kind: 'limited_login', userId: result.claims.sub, scopes: Object.freeze([]), email: text(result.claims['email']), name: text(result.claims['name']), expiresAtMs: result.claims.exp * 1_000 });
+            }
+        }
+        if (!session)
+            return null;
+        return serverIdentity(await options.identity(session), { credentialExpiresAtMs: session.expiresAtMs ?? Number.MAX_SAFE_INTEGER, maxIdentityMs });
+    };
+    return Object.assign(authenticate, { accepts });
+}
+/**
+ * Facebook sign-in for better-auth (`socialProviders: { facebook: facebookSignIn({ clientId, clientSecret }) }`), reading
+ * no more of the profile than signing in needs (`id`, `name`, `email`; `picture` only if asked), and asking for no
+ * permissions beyond better-auth's `email` and `public_profile` unless given.
+ */
+export function facebookSignIn(options) {
+    if (!options || typeof options.clientId !== 'string' || !/^\d{5,20}$/u.test(options.clientId))
+        throw new MayuraError('INVALID_CONFIG', 'facebookSignIn(): clientId is your Facebook app\'s ID.');
+    if (typeof options.clientSecret !== 'string' || options.clientSecret === '')
+        throw new MayuraError('INVALID_CONFIG', 'facebookSignIn(): clientSecret is your app\'s secret.');
+    if (options.picture !== undefined && typeof options.picture !== 'boolean')
+        throw new MayuraError('INVALID_CONFIG', 'facebookSignIn(): picture must be a boolean.');
+    if (options.scopes !== undefined && (!Array.isArray(options.scopes) || options.scopes.some(scope => typeof scope !== 'string' || !/^[a-z_]{1,64}$/u.test(scope))))
+        throw new MayuraError('INVALID_CONFIG', 'facebookSignIn(): scopes are extra permissions such as user_birthday.');
+    return Object.freeze({
+        clientId: options.clientId, clientSecret: options.clientSecret, fields: ['id', 'name', 'email', ...(options.picture === true ? ['picture'] : [])],
+        ...(options.scopes?.length ? { scope: [...options.scopes] } : {}),
+    });
+}
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,QAAQ,CAAC;AACrC,OAAO,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAC;AAC7C,OAAO,EACL,WAAW,EAAE,UAAU,EAAE,UAAU,EAAE,cAAc,GAEpD,MAAM,aAAa,CAAC;AA4CrB,gEAAgE;AAChE,MAAM,WAAW,GAAG,2BAA2B,CAAC;AAChD,MAAM,aAAa,GAAG,0BAA0B,CAAC;AACjD,MAAM,IAAI,GAAG,CAAC,KAAc,EAAE,EAAE,CAAC,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC;AAE1F,SAAS,OAAO,CAAC,KAAyB,EAAE,IAAY,EAAE,QAAgB,EAAE,GAAW,EAAE,GAAW;IAClG,MAAM,MAAM,GAAG,KAAK,IAAI,QAAQ,CAAC;IACjC,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,MAAM,CAAC,IAAI,MAAM,GAAG,GAAG,IAAI,MAAM,GAAG,GAAG;QAAE,MAAM,IAAI,WAAW,CAAC,gBAAgB,EAAE,4BAA4B,IAAI,OAAO,GAAG,CAAC,cAAc,CAAC,OAAO,CAAC,OAAO,GAAG,CAAC,cAAc,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;IACpN,OAAO,MAAM,CAAC;AAChB,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,qBAAqB,CAAC,OAAqC;IACzE,IAAI,CAAC,OAAO,IAAI,OAAO,OAAO,CAAC,QAAQ,KAAK,UAAU;QAAE,MAAM,IAAI,WAAW,CAAC,gBAAgB,EAAE,wEAAwE,CAAC,CAAC;IAC1K,IAAI,OAAO,OAAO,CAAC,KAAK,KAAK,QAAQ,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC;QAAE,MAAM,IAAI,WAAW,CAAC,gBAAgB,EAAE,4DAA4D,CAAC,CAAC;IACnL,IAAI,OAAO,OAAO,CAAC,SAAS,KAAK,QAAQ,IAAI,CAAC,wBAAwB,CAAC,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC;QAAE,MAAM,IAAI,WAAW,CAAC,gBAAgB,EAAE,2DAA2D,CAAC,CAAC;IACrM,MAAM,QAAQ,GAAG,OAAO,CAAC,cAAc,IAAI,EAAE,CAAC;IAC9C,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,IAAI,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,OAAO,KAAK,KAAK,QAAQ,IAAI,CAAC,iBAAiB,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAAE,MAAM,IAAI,WAAW,CAAC,gBAAgB,EAAE,0FAA0F,CAAC,CAAC;IACzP,IAAI,OAAO,CAAC,YAAY,KAAK,SAAS,IAAI,OAAO,OAAO,CAAC,YAAY,KAAK,SAAS;QAAE,MAAM,IAAI,WAAW,CAAC,gBAAgB,EAAE,0DAA0D,CAAC,CAAC;IACzL,MAAM,UAAU,GAAG,OAAO,CAAC,OAAO,CAAC,UAAU,EAAE,YAAY,EAAE,CAAC,EAAE,CAAC,EAAE,OAAO,CAAC,CAAC;IAC5E,MAAM,SAAS,GAAG,OAAO,CAAC,OAAO,CAAC,SAAS,EAAE,WAAW,EAAE,KAAK,EAAE,KAAK,EAAE,MAAM,CAAC,CAAC;IAChF,MAAM,aAAa,GAAG,OAAO,CAAC,OAAO,CAAC,aAAa,EAAE,eAAe,EAAE,MAAM,EAAE,KAAK,EAAE,SAAS,CAAC,CAAC;IAChG,MAAM,OAAO,GAAG,OAAO,CAAC,YAAY,IAAI,OAAO,CAAC;IAChD,IAAI,OAAO,OAAO,KAAK,QAAQ,IAAI,CAAC,sBAAsB,CAAC,IAAI,CAAC,OAAO,CAAC;QAAE,MAAM,IAAI,WAAW,CAAC,gBAAgB,EAAE,6EAA6E,CAAC,CAAC;IACjM,MAAM,OAAO,GAAG,OAAO,CAAC,KAAK,IAAI,UAAU,CAAC,KAAK,CAAC;IAClD,MAAM,QAAQ,GAAG,GAAG,OAAO,CAAC,KAAK,IAAI,OAAO,CAAC,SAAS,EAAE,CAAC;IACzD,MAAM,KAAK,GAAG,IAAI,GAAG,EAAgF,CAAC;IACtG,MAAM,OAAO,GAAG,OAAO,CAAC,YAAY,KAAK,IAAI,CAAC,CAAC,CAAC,WAAW,CAAC;QAC1D,MAAM,EAAE,aAAa,EAAE,QAAQ,EAAE,OAAO,CAAC,KAAK,EAAE,UAAU,EAAE,CAAC,OAAO,CAAC,EAAE,WAAW,EAAE,OAAO,CAAC,WAAW,IAAI,KAAK;QAChH,IAAI,EAAE,UAAU,CAAC,EAAE,GAAG,EAAE,yDAAyD,EAAE,GAAG,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,OAAO,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC;KACzI,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;IAEf,qGAAqG;IACrG,MAAM,OAAO,GAAG,KAAK,EAAE,KAAa,EAAE,MAAmB,EAAmC,EAAE;QAC5F,MAAM,GAAG,GAAG,8BAA8B,OAAO,gBAAgB,IAAI,eAAe,CAAC,EAAE,WAAW,EAAE,KAAK,EAAE,YAAY,EAAE,QAAQ,EAAE,CAAC,EAAE,CAAC;QACvI,IAAI,QAAkB,CAAC;QACvB,IAAI,CAAC;YAAC,QAAQ,GAAG,MAAM,OAAO,CAAC,GAAG,EAAE,EAAE,MAAM,EAAE,WAAW,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,WAAW,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,EAAE,MAAM,EAAE,kBAAkB,EAAE,EAAE,QAAQ,EAAE,OAAO,EAAE,CAAC,CAAC;QAAC,CAAC;QACzK,uDAAuD;QACvD,MAAM,CAAC;YAAC,MAAM,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,WAAW,CAAC,WAAW,EAAE,+BAA+B,CAAC,CAAC,CAAC,CAAC,IAAI,WAAW,CAAC,aAAa,EAAE,mDAAmD,CAAC,CAAC;QAAC,CAAC;QACrL,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;YAAC,KAAK,QAAQ,CAAC,IAAI,EAAE,MAAM,EAAE,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,SAAS,CAAC,CAAC;YAAC,MAAM,IAAI,WAAW,CAAC,aAAa,EAAE,0BAA0B,QAAQ,CAAC,MAAM,2BAA2B,CAAC,CAAC;QAAC,CAAC;QACtL,MAAM,IAAI,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,SAAS,CAAmD,CAAC;QAC5G,MAAM,IAAI,GAAG,IAAI,EAAE,IAAI,CAAC;QACxB,IAAI,CAAC,IAAI,IAAI,OAAO,IAAI,KAAK,QAAQ;YAAE,MAAM,IAAI,WAAW,CAAC,aAAa,EAAE,6DAA6D,CAAC,CAAC;QAC3I,IAAI,IAAI,CAAC,UAAU,CAAC,KAAK,IAAI,IAAI,IAAI,CAAC,QAAQ,CAAC,KAAK,OAAO,CAAC,KAAK,IAAI,IAAI,CAAC,MAAM,CAAC,KAAK,MAAM,IAAI,OAAO,IAAI,CAAC,SAAS,CAAC,KAAK,QAAQ,IAAI,IAAI,CAAC,SAAS,CAAC,KAAK,EAAE;YAAE,OAAO,IAAI,CAAC;QAC3K,MAAM,MAAM,GAAG,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,MAAM,CAAC,CAAC,KAAK,EAAmB,EAAE,CAAC,OAAO,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;QACjI,IAAI,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;YAAE,OAAO,IAAI,CAAC;QACjE,MAAM,OAAO,GAAG,IAAI,CAAC,YAAY,CAAC,CAAC;QACnC,qCAAqC;QACrC,MAAM,WAAW,GAAG,OAAO,OAAO,KAAK,QAAQ,IAAI,OAAO,GAAG,CAAC,CAAC,CAAC,CAAC,OAAO,GAAG,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC;QACxF,OAAO,MAAM,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,cAAuB,EAAE,MAAM,EAAE,IAAI,CAAC,SAAS,CAAC,EAAE,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,KAAK,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,WAAW,EAAE,CAAC,CAAC;IACxJ,CAAC,CAAC;IAEF,MAAM,OAAO,GAAG,CAAC,KAAa,EAAE,EAAE,CAAC,OAAO,KAAK,KAAK,QAAQ,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,KAAK,SAAS,IAAI,UAAU,CAAC,KAAK,CAAC,KAAK,aAAa,CAAC,CAAC,CAAC;IAC5J,MAAM,YAAY,GAAG,KAAK,EAAE,EAAE,KAAK,EAAE,MAAM,EAA4D,EAAE,EAAE;QACzG,IAAI,OAAO,KAAK,KAAK,QAAQ;YAAE,OAAO,IAAI,CAAC;QAC3C,IAAI,OAAO,GAA2B,IAAI,CAAC;QAC3C,IAAI,WAAW,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC;YAC5B,MAAM,GAAG,GAAG,SAAS,CAAC,KAAK,CAAC,CAAC;YAAC,MAAM,MAAM,GAAG,KAAK,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;YAC5D,IAAI,MAAM,IAAI,MAAM,CAAC,KAAK,GAAG,IAAI,CAAC,GAAG,EAAE;gBAAE,OAAO,GAAG,MAAM,CAAC,OAAO,CAAC;iBAC7D,CAAC;gBACJ,OAAO,GAAG,MAAM,OAAO,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;gBACvC,qEAAqE;gBACrE,IAAI,KAAK,CAAC,IAAI,IAAI,MAAM;oBAAE,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC,IAAI,EAAE,CAAC,KAAM,CAAC,CAAC;gBACnE,KAAK,CAAC,GAAG,CAAC,GAAG,EAAE,EAAE,OAAO,EAAE,KAAK,EAAE,IAAI,CAAC,GAAG,EAAE,GAAG,UAAU,EAAE,CAAC,CAAC;YAC9D,CAAC;QACH,CAAC;aAAM,IAAI,OAAO,KAAK,SAAS,IAAI,UAAU,CAAC,KAAK,CAAC,KAAK,aAAa,EAAE,CAAC;YACxE,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC,MAAM,CAAC,KAAK,EAAE,EAAE,MAAM,EAAE,CAAC,CAAC;YACvD,IAAI,MAAM,CAAC,EAAE,IAAI,OAAO,MAAM,CAAC,MAAM,CAAC,GAAG,KAAK,QAAQ,IAAI,MAAM,CAAC,MAAM,CAAC,GAAG,KAAK,EAAE,EAAE,CAAC;gBACnF,OAAO,GAAG,MAAM,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,eAAwB,EAAE,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC,GAAG,EAAE,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC,EAAE,KAAK,EAAE,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,EAAE,IAAI,EAAE,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,WAAW,EAAE,MAAM,CAAC,MAAM,CAAC,GAAG,GAAG,KAAK,EAAE,CAAC,CAAC;YACpO,CAAC;QACH,CAAC;QACD,IAAI,CAAC,OAAO;YAAE,OAAO,IAAI,CAAC;QAC1B,OAAO,cAAc,CAAC,MAAM,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE,EAAE,qBAAqB,EAAE,OAAO,CAAC,WAAW,IAAI,MAAM,CAAC,gBAAgB,EAAE,aAAa,EAAE,CAAC,CAAC;IACnJ,CAAC,CAAC;IACF,OAAO,MAAM,CAAC,MAAM,CAAC,YAAY,EAAE,EAAE,OAAO,EAAE,CAAC,CAAC;AAClD,CAAC;AAUD;;;;GAIG;AACH,MAAM,UAAU,cAAc,CAAC,OAAsI;IACnK,IAAI,CAAC,OAAO,IAAI,OAAO,OAAO,CAAC,QAAQ,KAAK,QAAQ,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC;QAAE,MAAM,IAAI,WAAW,CAAC,gBAAgB,EAAE,wDAAwD,CAAC,CAAC;IACjM,IAAI,OAAO,OAAO,CAAC,YAAY,KAAK,QAAQ,IAAI,OAAO,CAAC,YAAY,KAAK,EAAE;QAAE,MAAM,IAAI,WAAW,CAAC,gBAAgB,EAAE,uDAAuD,CAAC,CAAC;IAC9K,IAAI,OAAO,CAAC,OAAO,KAAK,SAAS,IAAI,OAAO,OAAO,CAAC,OAAO,KAAK,SAAS;QAAE,MAAM,IAAI,WAAW,CAAC,gBAAgB,EAAE,8CAA8C,CAAC,CAAC;IACnK,IAAI,OAAO,CAAC,MAAM,KAAK,SAAS,IAAI,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,OAAO,KAAK,KAAK,QAAQ,IAAI,CAAC,iBAAiB,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC;QAAE,MAAM,IAAI,WAAW,CAAC,gBAAgB,EAAE,uEAAuE,CAAC,CAAC;IACpR,OAAO,MAAM,CAAC,MAAM,CAAC;QACnB,QAAQ,EAAE,OAAO,CAAC,QAAQ,EAAE,YAAY,EAAE,OAAO,CAAC,YAAY,EAAE,MAAM,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,GAAG,CAAC,OAAO,CAAC,OAAO,KAAK,IAAI,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;QACjJ,GAAG,CAAC,OAAO,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,GAAG,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;KAClE,CAAC,CAAC;AACL,CAAC","sourcesContent":["import { MayuraError } from 'mayura';\nimport { sha256Hex } from 'mayura/core/host';\nimport {\n  jwtVerifier, peekIssuer, remoteJwks, serverIdentity,\n  type Authenticator, type IdentityGrant,\n} from 'mayura/auth';\n\n/** A verified Facebook user: from a Login access token (checked with Facebook) or a Limited Login token. */\nexport interface FacebookSession {\n  /** `access_token` for a Facebook Login user access token; `limited_login` for an iOS Limited Login token. */\n  readonly kind: 'access_token' | 'limited_login';\n  /** The app-scoped user id: the same user has a different id in each of your apps. */\n  readonly userId: string;\n  /** The permissions the user granted your app (access tokens). */\n  readonly scopes: readonly string[];\n  readonly email: string | null;\n  readonly name: string | null;\n  /** When the token expires, in milliseconds since the epoch; null where Facebook gives none. */\n  readonly expiresAtMs: number | null;\n}\n\nexport interface FacebookAuthenticatorOptions {\n  /** Your Facebook app's ID. */\n  readonly appId: string;\n  /** Your app's secret, to ask Facebook about access tokens; it stays on your server. */\n  readonly appSecret: string;\n  /** What a Facebook user may do, or null to refuse. */\n  readonly identity: (session: FacebookSession) => IdentityGrant | null | Promise<IdentityGrant | null>;\n  /** Permissions the user must have granted your app, such as `email`. */\n  readonly requiredScopes?: readonly string[];\n  /** Also accept iOS Limited Login tokens (OIDC JWTs, checked with Facebook's keys, with no call per request). */\n  readonly limitedLogin?: boolean;\n  /**\n   * Keep what Facebook said about an access token for this long; 0 by default, so each request asks Facebook and a\n   * token the user revoked stops at once. At most 5 minutes.\n   */\n  readonly cacheTtlMs?: number;\n  /** The longest wait for Facebook; 5 s by default (1 s to 30 s). */\n  readonly timeoutMs?: number;\n  /** The Graph API version; `v26.0` by default. */\n  readonly graphVersion?: string;\n  /** Clock difference allowed for Limited Login tokens; 5 s by default. */\n  readonly clockSkewMs?: number;\n  /** The longest an identity lasts before the token is checked again; 60 s by default. */\n  readonly maxIdentityMs?: number;\n  /** For tests and proxies: the fetch to use. */\n  readonly fetch?: typeof fetch;\n}\n\n/** Facebook Login user access tokens: opaque, starting `EA`. */\nconst accessToken = /^EA[A-Za-z0-9]{20,1024}$/u;\nconst limitedIssuer = 'https://www.facebook.com';\nconst text = (value: unknown) => typeof value === 'string' && value !== '' ? value : null;\n\nfunction bounded(value: number | undefined, name: string, fallback: number, min: number, max: number): number {\n  const result = value ?? fallback;\n  if (!Number.isSafeInteger(result) || result < min || result > max) throw new MayuraError('INVALID_CONFIG', `facebookAuthenticator(): ${name} is ${min.toLocaleString('en-US')} to ${max.toLocaleString('en-US')}.`);\n  return result;\n}\n\n/**\n * A server `authenticate` for Facebook users. Login access tokens are opaque, so each is checked with Facebook's\n * `debug_token` (a call per request unless `cacheTtlMs`): it must be valid, a user's, for your app, and hold the\n * permissions you require. With `limitedLogin`, iOS Limited Login tokens are checked as JWTs: RS256 with Facebook's\n * keys, from `https://www.facebook.com`, for your app. `identity` decides what the user may do.\n */\nexport function facebookAuthenticator(options: FacebookAuthenticatorOptions): Authenticator {\n  if (!options || typeof options.identity !== 'function') throw new MayuraError('INVALID_CONFIG', 'facebookAuthenticator(): identity decides what a Facebook user may do.');\n  if (typeof options.appId !== 'string' || !/^\\d{5,20}$/u.test(options.appId)) throw new MayuraError('INVALID_CONFIG', 'facebookAuthenticator(): appId is your Facebook app\\'s ID.');\n  if (typeof options.appSecret !== 'string' || !/^[A-Za-z0-9]{16,128}$/u.test(options.appSecret)) throw new MayuraError('INVALID_CONFIG', 'facebookAuthenticator(): appSecret is your app\\'s secret.');\n  const required = options.requiredScopes ?? [];\n  if (!Array.isArray(required) || required.some(scope => typeof scope !== 'string' || !/^[a-z_]{1,64}$/u.test(scope))) throw new MayuraError('INVALID_CONFIG', 'facebookAuthenticator(): requiredScopes are permissions such as email or public_profile.');\n  if (options.limitedLogin !== undefined && typeof options.limitedLogin !== 'boolean') throw new MayuraError('INVALID_CONFIG', 'facebookAuthenticator(): limitedLogin must be a boolean.');\n  const cacheTtlMs = bounded(options.cacheTtlMs, 'cacheTtlMs', 0, 0, 300_000);\n  const timeoutMs = bounded(options.timeoutMs, 'timeoutMs', 5_000, 1_000, 30_000);\n  const maxIdentityMs = bounded(options.maxIdentityMs, 'maxIdentityMs', 60_000, 1_000, 3_600_000);\n  const version = options.graphVersion ?? 'v26.0';\n  if (typeof version !== 'string' || !/^v\\d{1,3}\\.\\d{1,2}$/u.test(version)) throw new MayuraError('INVALID_CONFIG', 'facebookAuthenticator(): graphVersion is a Graph API version such as v26.0.');\n  const fetcher = options.fetch ?? globalThis.fetch;\n  const appToken = `${options.appId}|${options.appSecret}`;\n  const cache = new Map<string, { readonly session: FacebookSession | null; readonly until: number }>();\n  const limited = options.limitedLogin === true ? jwtVerifier({\n    issuer: limitedIssuer, audience: options.appId, algorithms: ['RS256'], clockSkewMs: options.clockSkewMs ?? 5_000,\n    keys: remoteJwks({ url: 'https://www.facebook.com/.well-known/oauth/openid/jwks/', ...(options.fetch ? { fetch: options.fetch } : {}) }),\n  }) : undefined;\n\n  /** What Facebook says about an access token; null when it is not a valid user token for this app. */\n  const inspect = async (token: string, signal: AbortSignal): Promise<FacebookSession | null> => {\n    const url = `https://graph.facebook.com/${version}/debug_token?${new URLSearchParams({ input_token: token, access_token: appToken })}`;\n    let response: Response;\n    try { response = await fetcher(url, { signal: AbortSignal.any([signal, AbortSignal.timeout(timeoutMs)]), headers: { accept: 'application/json' }, redirect: 'error' }); }\n    // The URL holds the app secret: no error may carry it.\n    catch { throw signal.aborted ? new MayuraError('CANCELLED', 'Authentication was cancelled.') : new MayuraError('TOOL_FAILED', 'Facebook could not be reached to check the token.'); }\n    if (!response.ok) { void response.body?.cancel().catch(() => undefined); throw new MayuraError('TOOL_FAILED', `Facebook answered HTTP ${response.status} when checking the token.`); }\n    const body = await response.json().catch(() => undefined) as { data?: Record<string, unknown> } | undefined;\n    const data = body?.data;\n    if (!data || typeof data !== 'object') throw new MayuraError('TOOL_FAILED', 'Facebook\\'s answer about the token is not one Mayura knows.');\n    if (data['is_valid'] !== true || data['app_id'] !== options.appId || data['type'] !== 'USER' || typeof data['user_id'] !== 'string' || data['user_id'] === '') return null;\n    const scopes = Array.isArray(data['scopes']) ? data['scopes'].filter((scope): scope is string => typeof scope === 'string') : [];\n    if (required.some(scope => !scopes.includes(scope))) return null;\n    const expires = data['expires_at'];\n    // 0 is Facebook's \"does not expire\".\n    const expiresAtMs = typeof expires === 'number' && expires > 0 ? expires * 1_000 : null;\n    return Object.freeze({ kind: 'access_token' as const, userId: data['user_id'], scopes: Object.freeze(scopes), email: null, name: null, expiresAtMs });\n  };\n\n  const accepts = (token: string) => typeof token === 'string' && (accessToken.test(token) || (limited !== undefined && peekIssuer(token) === limitedIssuer));\n  const authenticate = async ({ token, signal }: { readonly token: string; readonly signal: AbortSignal }) => {\n    if (typeof token !== 'string') return null;\n    let session: FacebookSession | null = null;\n    if (accessToken.test(token)) {\n      const key = sha256Hex(token); const cached = cache.get(key);\n      if (cached && cached.until > Date.now()) session = cached.session;\n      else {\n        session = await inspect(token, signal);\n        // Without cacheTtlMs an answer is out of date the moment it is kept.\n        if (cache.size >= 10_000) cache.delete(cache.keys().next().value!);\n        cache.set(key, { session, until: Date.now() + cacheTtlMs });\n      }\n    } else if (limited !== undefined && peekIssuer(token) === limitedIssuer) {\n      const result = await limited.verify(token, { signal });\n      if (result.ok && typeof result.claims.sub === 'string' && result.claims.sub !== '') {\n        session = Object.freeze({ kind: 'limited_login' as const, userId: result.claims.sub, scopes: Object.freeze([]), email: text(result.claims['email']), name: text(result.claims['name']), expiresAtMs: result.claims.exp * 1_000 });\n      }\n    }\n    if (!session) return null;\n    return serverIdentity(await options.identity(session), { credentialExpiresAtMs: session.expiresAtMs ?? Number.MAX_SAFE_INTEGER, maxIdentityMs });\n  };\n  return Object.assign(authenticate, { accepts });\n}\n\n/** Facebook sign-in for better-auth's `socialProviders.facebook`, as `facebookSignIn` makes it. */\nexport interface FacebookSignInOptions {\n  readonly clientId: string;\n  readonly clientSecret: string;\n  readonly fields: string[];\n  readonly scope?: string[];\n}\n\n/**\n * Facebook sign-in for better-auth (`socialProviders: { facebook: facebookSignIn({ clientId, clientSecret }) }`), reading\n * no more of the profile than signing in needs (`id`, `name`, `email`; `picture` only if asked), and asking for no\n * permissions beyond better-auth's `email` and `public_profile` unless given.\n */\nexport function facebookSignIn(options: { readonly clientId: string; readonly clientSecret: string; readonly picture?: boolean; readonly scopes?: readonly string[] }): FacebookSignInOptions {\n  if (!options || typeof options.clientId !== 'string' || !/^\\d{5,20}$/u.test(options.clientId)) throw new MayuraError('INVALID_CONFIG', 'facebookSignIn(): clientId is your Facebook app\\'s ID.');\n  if (typeof options.clientSecret !== 'string' || options.clientSecret === '') throw new MayuraError('INVALID_CONFIG', 'facebookSignIn(): clientSecret is your app\\'s secret.');\n  if (options.picture !== undefined && typeof options.picture !== 'boolean') throw new MayuraError('INVALID_CONFIG', 'facebookSignIn(): picture must be a boolean.');\n  if (options.scopes !== undefined && (!Array.isArray(options.scopes) || options.scopes.some(scope => typeof scope !== 'string' || !/^[a-z_]{1,64}$/u.test(scope)))) throw new MayuraError('INVALID_CONFIG', 'facebookSignIn(): scopes are extra permissions such as user_birthday.');\n  return Object.freeze({\n    clientId: options.clientId, clientSecret: options.clientSecret, fields: ['id', 'name', 'email', ...(options.picture === true ? ['picture'] : [])],\n    ...(options.scopes?.length ? { scope: [...options.scopes] } : {}),\n  });\n}\n\n"]}

package/package.json

@@ -1,6 +1,45 @@
 {
   "name": "@mayurajs/auth-facebook",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "1.2.0",
+  "description": "Facebook Login access tokens (checked with Facebook) and Limited Login tokens as Mayura server identities, and a preset for better-auth's Facebook sign-in.",
+  "author": {
+    "name": "Aryabh",
+    "email": "dev@rokad.co"
+  },
+  "license": "Apache-2.0",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/KartikeyAI/mayura.git",
+    "directory": "extensions/auth-facebook"
+  },
+  "homepage": "https://github.com/KartikeyAI/mayura#readme",
+  "bugs": {
+    "url": "https://github.com/KartikeyAI/mayura/issues"
+  },
+  "type": "module",
+  "sideEffects": false,
+  "engines": {
+    "node": ">=22.12.0 <23 || >=24.14.1 <25"
+  },
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist",
+    "src/**/*.ts",
+    "README.md",
+    "LICENSE",
+    "NOTICE"
+  ],
+  "dependencies": {},
+  "peerDependencies": {
+    "mayura": "^1.2.0"
+  },
+  "publishConfig": {
+    "access": "public",
+    "provenance": true
+  }
+}

package/src/index.ts

@@ -0,0 +1,155 @@
+import { MayuraError } from 'mayura';
+import { sha256Hex } from 'mayura/core/host';
+import {
+  jwtVerifier, peekIssuer, remoteJwks, serverIdentity,
+  type Authenticator, type IdentityGrant,
+} from 'mayura/auth';
+
+/** A verified Facebook user: from a Login access token (checked with Facebook) or a Limited Login token. */
+export interface FacebookSession {
+  /** `access_token` for a Facebook Login user access token; `limited_login` for an iOS Limited Login token. */
+  readonly kind: 'access_token' | 'limited_login';
+  /** The app-scoped user id: the same user has a different id in each of your apps. */
+  readonly userId: string;
+  /** The permissions the user granted your app (access tokens). */
+  readonly scopes: readonly string[];
+  readonly email: string | null;
+  readonly name: string | null;
+  /** When the token expires, in milliseconds since the epoch; null where Facebook gives none. */
+  readonly expiresAtMs: number | null;
+}
+
+export interface FacebookAuthenticatorOptions {
+  /** Your Facebook app's ID. */
+  readonly appId: string;
+  /** Your app's secret, to ask Facebook about access tokens; it stays on your server. */
+  readonly appSecret: string;
+  /** What a Facebook user may do, or null to refuse. */
+  readonly identity: (session: FacebookSession) => IdentityGrant | null | Promise<IdentityGrant | null>;
+  /** Permissions the user must have granted your app, such as `email`. */
+  readonly requiredScopes?: readonly string[];
+  /** Also accept iOS Limited Login tokens (OIDC JWTs, checked with Facebook's keys, with no call per request). */
+  readonly limitedLogin?: boolean;
+  /**
+   * Keep what Facebook said about an access token for this long; 0 by default, so each request asks Facebook and a
+   * token the user revoked stops at once. At most 5 minutes.
+   */
+  readonly cacheTtlMs?: number;
+  /** The longest wait for Facebook; 5 s by default (1 s to 30 s). */
+  readonly timeoutMs?: number;
+  /** The Graph API version; `v26.0` by default. */
+  readonly graphVersion?: string;
+  /** Clock difference allowed for Limited Login tokens; 5 s by default. */
+  readonly clockSkewMs?: number;
+  /** The longest an identity lasts before the token is checked again; 60 s by default. */
+  readonly maxIdentityMs?: number;
+  /** For tests and proxies: the fetch to use. */
+  readonly fetch?: typeof fetch;
+}
+
+/** Facebook Login user access tokens: opaque, starting `EA`. */
+const accessToken = /^EA[A-Za-z0-9]{20,1024}$/u;
+const limitedIssuer = 'https://www.facebook.com';
+const text = (value: unknown) => typeof value === 'string' && value !== '' ? value : null;
+
+function bounded(value: number | undefined, name: string, fallback: number, min: number, max: number): number {
+  const result = value ?? fallback;
+  if (!Number.isSafeInteger(result) || result < min || result > max) throw new MayuraError('INVALID_CONFIG', `facebookAuthenticator(): ${name} is ${min.toLocaleString('en-US')} to ${max.toLocaleString('en-US')}.`);
+  return result;
+}
+
+/**
+ * A server `authenticate` for Facebook users. Login access tokens are opaque, so each is checked with Facebook's
+ * `debug_token` (a call per request unless `cacheTtlMs`): it must be valid, a user's, for your app, and hold the
+ * permissions you require. With `limitedLogin`, iOS Limited Login tokens are checked as JWTs: RS256 with Facebook's
+ * keys, from `https://www.facebook.com`, for your app. `identity` decides what the user may do.
+ */
+export function facebookAuthenticator(options: FacebookAuthenticatorOptions): Authenticator {
+  if (!options || typeof options.identity !== 'function') throw new MayuraError('INVALID_CONFIG', 'facebookAuthenticator(): identity decides what a Facebook user may do.');
+  if (typeof options.appId !== 'string' || !/^\d{5,20}$/u.test(options.appId)) throw new MayuraError('INVALID_CONFIG', 'facebookAuthenticator(): appId is your Facebook app\'s ID.');
+  if (typeof options.appSecret !== 'string' || !/^[A-Za-z0-9]{16,128}$/u.test(options.appSecret)) throw new MayuraError('INVALID_CONFIG', 'facebookAuthenticator(): appSecret is your app\'s secret.');
+  const required = options.requiredScopes ?? [];
+  if (!Array.isArray(required) || required.some(scope => typeof scope !== 'string' || !/^[a-z_]{1,64}$/u.test(scope))) throw new MayuraError('INVALID_CONFIG', 'facebookAuthenticator(): requiredScopes are permissions such as email or public_profile.');
+  if (options.limitedLogin !== undefined && typeof options.limitedLogin !== 'boolean') throw new MayuraError('INVALID_CONFIG', 'facebookAuthenticator(): limitedLogin must be a boolean.');
+  const cacheTtlMs = bounded(options.cacheTtlMs, 'cacheTtlMs', 0, 0, 300_000);
+  const timeoutMs = bounded(options.timeoutMs, 'timeoutMs', 5_000, 1_000, 30_000);
+  const maxIdentityMs = bounded(options.maxIdentityMs, 'maxIdentityMs', 60_000, 1_000, 3_600_000);
+  const version = options.graphVersion ?? 'v26.0';
+  if (typeof version !== 'string' || !/^v\d{1,3}\.\d{1,2}$/u.test(version)) throw new MayuraError('INVALID_CONFIG', 'facebookAuthenticator(): graphVersion is a Graph API version such as v26.0.');
+  const fetcher = options.fetch ?? globalThis.fetch;
+  const appToken = `${options.appId}|${options.appSecret}`;
+  const cache = new Map<string, { readonly session: FacebookSession | null; readonly until: number }>();
+  const limited = options.limitedLogin === true ? jwtVerifier({
+    issuer: limitedIssuer, audience: options.appId, algorithms: ['RS256'], clockSkewMs: options.clockSkewMs ?? 5_000,
+    keys: remoteJwks({ url: 'https://www.facebook.com/.well-known/oauth/openid/jwks/', ...(options.fetch ? { fetch: options.fetch } : {}) }),
+  }) : undefined;
+
+  /** What Facebook says about an access token; null when it is not a valid user token for this app. */
+  const inspect = async (token: string, signal: AbortSignal): Promise<FacebookSession | null> => {
+    const url = `https://graph.facebook.com/${version}/debug_token?${new URLSearchParams({ input_token: token, access_token: appToken })}`;
+    let response: Response;
+    try { response = await fetcher(url, { signal: AbortSignal.any([signal, AbortSignal.timeout(timeoutMs)]), headers: { accept: 'application/json' }, redirect: 'error' }); }
+    // The URL holds the app secret: no error may carry it.
+    catch { throw signal.aborted ? new MayuraError('CANCELLED', 'Authentication was cancelled.') : new MayuraError('TOOL_FAILED', 'Facebook could not be reached to check the token.'); }
+    if (!response.ok) { void response.body?.cancel().catch(() => undefined); throw new MayuraError('TOOL_FAILED', `Facebook answered HTTP ${response.status} when checking the token.`); }
+    const body = await response.json().catch(() => undefined) as { data?: Record<string, unknown> } | undefined;
+    const data = body?.data;
+    if (!data || typeof data !== 'object') throw new MayuraError('TOOL_FAILED', 'Facebook\'s answer about the token is not one Mayura knows.');
+    if (data['is_valid'] !== true || data['app_id'] !== options.appId || data['type'] !== 'USER' || typeof data['user_id'] !== 'string' || data['user_id'] === '') return null;
+    const scopes = Array.isArray(data['scopes']) ? data['scopes'].filter((scope): scope is string => typeof scope === 'string') : [];
+    if (required.some(scope => !scopes.includes(scope))) return null;
+    const expires = data['expires_at'];
+    // 0 is Facebook's "does not expire".
+    const expiresAtMs = typeof expires === 'number' && expires > 0 ? expires * 1_000 : null;
+    return Object.freeze({ kind: 'access_token' as const, userId: data['user_id'], scopes: Object.freeze(scopes), email: null, name: null, expiresAtMs });
+  };
+
+  const accepts = (token: string) => typeof token === 'string' && (accessToken.test(token) || (limited !== undefined && peekIssuer(token) === limitedIssuer));
+  const authenticate = async ({ token, signal }: { readonly token: string; readonly signal: AbortSignal }) => {
+    if (typeof token !== 'string') return null;
+    let session: FacebookSession | null = null;
+    if (accessToken.test(token)) {
+      const key = sha256Hex(token); const cached = cache.get(key);
+      if (cached && cached.until > Date.now()) session = cached.session;
+      else {
+        session = await inspect(token, signal);
+        // Without cacheTtlMs an answer is out of date the moment it is kept.
+        if (cache.size >= 10_000) cache.delete(cache.keys().next().value!);
+        cache.set(key, { session, until: Date.now() + cacheTtlMs });
+      }
+    } else if (limited !== undefined && peekIssuer(token) === limitedIssuer) {
+      const result = await limited.verify(token, { signal });
+      if (result.ok && typeof result.claims.sub === 'string' && result.claims.sub !== '') {
+        session = Object.freeze({ kind: 'limited_login' as const, userId: result.claims.sub, scopes: Object.freeze([]), email: text(result.claims['email']), name: text(result.claims['name']), expiresAtMs: result.claims.exp * 1_000 });
+      }
+    }
+    if (!session) return null;
+    return serverIdentity(await options.identity(session), { credentialExpiresAtMs: session.expiresAtMs ?? Number.MAX_SAFE_INTEGER, maxIdentityMs });
+  };
+  return Object.assign(authenticate, { accepts });
+}
+
+/** Facebook sign-in for better-auth's `socialProviders.facebook`, as `facebookSignIn` makes it. */
+export interface FacebookSignInOptions {
+  readonly clientId: string;
+  readonly clientSecret: string;
+  readonly fields: string[];
+  readonly scope?: string[];
+}
+
+/**
+ * Facebook sign-in for better-auth (`socialProviders: { facebook: facebookSignIn({ clientId, clientSecret }) }`), reading
+ * no more of the profile than signing in needs (`id`, `name`, `email`; `picture` only if asked), and asking for no
+ * permissions beyond better-auth's `email` and `public_profile` unless given.
+ */
+export function facebookSignIn(options: { readonly clientId: string; readonly clientSecret: string; readonly picture?: boolean; readonly scopes?: readonly string[] }): FacebookSignInOptions {
+  if (!options || typeof options.clientId !== 'string' || !/^\d{5,20}$/u.test(options.clientId)) throw new MayuraError('INVALID_CONFIG', 'facebookSignIn(): clientId is your Facebook app\'s ID.');
+  if (typeof options.clientSecret !== 'string' || options.clientSecret === '') throw new MayuraError('INVALID_CONFIG', 'facebookSignIn(): clientSecret is your app\'s secret.');
+  if (options.picture !== undefined && typeof options.picture !== 'boolean') throw new MayuraError('INVALID_CONFIG', 'facebookSignIn(): picture must be a boolean.');
+  if (options.scopes !== undefined && (!Array.isArray(options.scopes) || options.scopes.some(scope => typeof scope !== 'string' || !/^[a-z_]{1,64}$/u.test(scope)))) throw new MayuraError('INVALID_CONFIG', 'facebookSignIn(): scopes are extra permissions such as user_birthday.');
+  return Object.freeze({
+    clientId: options.clientId, clientSecret: options.clientSecret, fields: ['id', 'name', 'email', ...(options.picture === true ? ['picture'] : [])],
+    ...(options.scopes?.length ? { scope: [...options.scopes] } : {}),
+  });
+}
+