@protobase/client 0.62.4 → 0.62.5

package/dist/account-security.d.ts

@@ -1,4 +1,5 @@
 import { BetterAuthClient } from "./better-auth-client.js";
+import { PersonalMailLink } from "./auth-types.js";
 import { SignInPolicy } from "./sign-in-policy.js";
 //#region src/account-security.d.ts
 /** What a sign-in policy can require that an account sets up once. */
@@ -68,6 +69,14 @@ export declare const accountSecurity: (client: BetterAuthClient) => {
    * `?error=<code>` when the link did not go through, for example `account_already_linked_to_different_user`.
    */
   linkProvider: (provider: string, callbackURL: string) => Promise<string>;
+  /** The ids of the mail providers of `links` the account is linked to with every scope they ask for, for example `gmail`. */
+  linkedPersonalMail: (links: PersonalMailLink[]) => Promise<string[]>;
+  /**
+   * Starts linking a mailbox, such as Gmail through Google sign-in with leave to send mail: resolves with the provider's
+   * authorization URL, for the page to go to. The provider sends the browser back to `callbackURL`, with
+   * `?error=<code>` when the link did not go through.
+   */
+  linkPersonalMail: (link: PersonalMailLink, callbackURL: string) => Promise<string>;
   /** The apps the person allowed to act as them, newest first; on an app with MCP on. */
   connectedApps: () => Promise<ConnectedApp[]>;
   /** Disconnects an app: it is forgotten, and its access ends within 15 minutes; it has to ask again to come back. */

package/dist/account-security.js

@@ -85,6 +85,30 @@ const accountSecurity = (client) => ({
 		if (error || !data?.url) throw authError(error, "Could not start linking the account");
 		return data.url;
 	},
+	/** The ids of the mail providers of `links` the account is linked to with every scope they ask for, for example `gmail`. */
+	linkedPersonalMail: async (links) => {
+		const { data, error } = await client.listAccounts();
+		if (error || !data) throw authError(error, "Could not read your linked accounts");
+		const holds = (link) => data.some((account) => account.providerId === link.provider && link.scopes.every((scope) => account.scopes.includes(scope)));
+		return links.filter(holds).map((link) => link.id);
+	},
+	/**
+	* Starts linking a mailbox, such as Gmail through Google sign-in with leave to send mail: resolves with the provider's
+	* authorization URL, for the page to go to. The provider sends the browser back to `callbackURL`, with
+	* `?error=<code>` when the link did not go through.
+	*/
+	linkPersonalMail: async (link, callbackURL) => {
+		const { data, error } = await client.linkSocial({
+			provider: link.provider,
+			scopes: link.scopes,
+			additionalParams: link.params,
+			callbackURL,
+			errorCallbackURL: callbackURL,
+			disableRedirect: true
+		});
+		if (error || !data?.url) throw authError(error, "Could not start linking the mailbox");
+		return data.url;
+	},
 	/** The apps the person allowed to act as them, newest first; on an app with MCP on. */
 	connectedApps: async () => {
 		const { data, error } = await client.$fetch("/account/connected-apps");

package/dist/auth-types.d.ts

@@ -24,6 +24,18 @@ export type PlatformSignIn = {
   provider: string;
   name: string;
 };
+/**
+ * A mail provider people may link their own mailbox with, for the app to send mail from it: its id and name, such as
+ * `gmail` and `Gmail`, the sign-in provider it links through, such as `google`, the scopes the link asks for and more
+ * authorization parameters of the link.
+ */
+export type PersonalMailLink = {
+  id: string;
+  name: string;
+  provider: string;
+  scopes: string[];
+  params: Record<string, string>;
+};
 /** A SAML identity provider of the app: its id, for `signInSaml`, and the name to show. */
 export type SamlSignIn = {
   id: string;
@@ -37,7 +49,7 @@ export type SamlSignIn = {
  * `sendSignUpCode`); `socialProviders` the ids of the sign-in providers, for example
  * `github`; `platformSignIn` the one of them the platform adds; `samlProviders` the app's SAML identity providers; `staffSignIn` the operator provider's name when its staff
  * can sign in as people; `organizations` when the app has them; `anonymous` when visitors may browse what the project's
- * anonymous role reads without signing in; `mcp` when MCP clients can connect, with the `url` of the app's MCP endpoint, so the account page shows it and lists the clients; `plugins`
+ * anonymous role reads without signing in; `personalMail` the mail providers people may link their mailbox with (see `account.linkPersonalMail`); `mcp` when MCP clients can connect, with the `url` of the app's MCP endpoint, so the account page shows it and lists the clients; `plugins`
  * those the app loads before anyone signs in; `locale` the language the app sets for everyone, which the screens before
  * `/meta` are in.
  */
@@ -67,6 +79,7 @@ export type SetupStatus = {
   mcp?: {
     url: string;
   };
+  personalMail?: PersonalMailLink[];
   plugins?: PluginRef[];
   locale?: Locale;
 };

package/dist/auth.d.ts

@@ -1,10 +1,10 @@
 import { DeviceSession } from "./account-profile.js";
+import { AuthUser, PersonalMailLink, RoleLabel, SetupStatus, SignInResult, TwoFactorMethod } from "./auth-types.js";
 import { SignInPolicy, SignInPolicyState } from "./sign-in-policy.js";
 import { AccountSignIn, AuthenticatorSetup, ConnectedApp, Passkey } from "./account-security.js";
 import { ConnectingClient } from "./connect.js";
 import { CurrentOrganization, InvitationPreview, InvitationSent, Organization, OrganizationInvitation, OrganizationMember, OrganizationPerson, OrganizationRole, OrganizationsFound } from "./organizations.js";
 import { ActiveRole } from "./roles.js";
-import { AuthUser, RoleLabel, SetupStatus, SignInResult, TwoFactorMethod } from "./auth-types.js";
 import { AppUser, UserInvitation, UserInvitationSent, UsersFound } from "./users.js";
 import { StaffSignIn } from "./staff-sign-in.js";
 import { AuthError } from "./auth-error.js";
@@ -76,6 +76,8 @@ export declare const createAuthSession: (options?: AuthSessionOptions) => {
     turnOffTwoFactor: (password?: string) => Promise<void>;
     linkedProviders: () => Promise<string[]>;
     linkProvider: (provider: string, callbackURL: string) => Promise<string>;
+    linkedPersonalMail: (links: PersonalMailLink[]) => Promise<string[]>;
+    linkPersonalMail: (link: PersonalMailLink, callbackURL: string) => Promise<string>;
     connectedApps: () => Promise<ConnectedApp[]>;
     disconnectApp: (clientId: string) => Promise<void>;
     newBackupCodes: (password?: string) => Promise<string[]>;

package/dist/auth.js

@@ -89,6 +89,7 @@ const createAuthSession = (options = {}) => {
 				...body.organizations && { organizations: body.organizations },
 				...body.anonymous && { anonymous: true },
 				...body.mcp && { mcp: { url: body.mcp.url } },
+				...body.personalMail && body.personalMail.length > 0 && { personalMail: body.personalMail },
 				...body.plugins && body.plugins.length > 0 && { plugins: body.plugins },
 				...isLocale(body.locale) && { locale: body.locale }
 			};

package/dist/index.d.ts

@@ -17,12 +17,12 @@ import { fileUrl } from "./file-urls.js";
 import { routedClient } from "./routed-client.js";
 import { SourceMeta, sourceMeta } from "./source-meta.js";
 import { DeviceSession } from "./account-profile.js";
+import { AuthUser, PersonalMailLink, PlatformSignIn, RoleLabel, SamlSignIn, SetupStatus, SignInMethod, SignInResult, TwoFactorMethod } from "./auth-types.js";
 import { SignInPolicy, SignInPolicyClient, SignInPolicyState, SignInRule, StaffAccessRule } from "./sign-in-policy.js";
 import { AccountSecurity, AccountSignIn, AuthenticatorSetup, ConnectedApp, Passkey, RequiredSetup } from "./account-security.js";
 import { ConnectClient, ConnectingClient } from "./connect.js";
 import { CurrentOrganization, InvitationPreview, InvitationSent, Organization, OrganizationInvitation, OrganizationMember, OrganizationPerson, OrganizationRole, OrganizationsClient, OrganizationsFound } from "./organizations.js";
 import { ActiveRole, RoleOption, RolesClient } from "./roles.js";
-import { AuthUser, PlatformSignIn, RoleLabel, SamlSignIn, SetupStatus, SignInMethod, SignInResult, TwoFactorMethod } from "./auth-types.js";
 import { AppUser, UserInvitation, UserInvitationSent, UsersClient, UsersFound } from "./users.js";
 import { StaffSignIn, StaffSignInClient } from "./staff-sign-in.js";
 import { AuthError } from "./auth-error.js";
@@ -31,4 +31,4 @@ import { createStaticSession } from "./static-session.js";
 import { AssistantClient, AssistantClientOptions, AssistantConnection, createAssistantClient } from "./assistant.js";
 import { RuntimeClient, RuntimeClientOptions, RuntimeLastUpdate, RuntimePolicy, RuntimeStatus, RuntimeUpdateStage, createRuntimeClient } from "./runtime.js";
 import { availabilities, heldStatus, maxStatusText, statusTextProblem } from "@protobase/schema/internal";
-export { type AccountSecurity, type AccountSignIn, type ActiveRole, type Aggregate, type AggregateGroup, type AggregateParams, type AggregateSplitTotal, ApiError, type AppUser, type AssistantClient, type AssistantClientOptions, type AssistantConnection, AuthError, type AuthSession, type AuthSessionOptions, type AuthUser, type AuthenticatorSetup, type Availability, type BatchOp, type BatchRef, type BatchResult, type CallRing, type Channel, type ChannelError, type ChannelMessage, ChannelRefusal, type ChannelStatus, type ChannelUser, type Client, type ClientOptions, type CommentPage, type CommentPerson, type ConnectClient, type ConnectedApp, type ConnectingClient, type CurrentOrganization, type DeviceSession, type DevicesClient, type Facet, type FilterInput, type FormChallenge, type FormProof, type Histogram, type HistogramBucket, type HistoryChange, type HistoryPage, type InboxNotification, type InboxPage, type InvitationPreview, type InvitationSent, type InvokeOptions, type ListPage, type ListParams, type LiveChange, type LiveHandlers, type MapBounds, type MapBucket, type MapLayerModel, type MapParams, type MapResult, type MentionableUser, type Meta, type MetaResult, type NotificationHistoryClient, type Organization, type OrganizationInvitation, type OrganizationMember, type OrganizationPerson, type OrganizationRole, type OrganizationsClient, type OrganizationsFound, type Passkey, type PersonStatus, type PlatformSignIn, type PluginRef, PreconditionFailedError, type PresenceChange, type PresenceEntry, type ProblemDetails, type ProblemError, type PublicForm, type RecordCall, type RecordCallsHandlers, type RecordComment, type RecordOf, type RecordPermissions, type RecordPhotos, type RegisteredDevice, type RelatedLabels, type RequiredSetup, type ResourcePermissions, type ResourceRef, type RingsClient, type RoleLabel, type RoleOption, type RolesClient, type RuntimeClient, type RuntimeClientOptions, type RuntimeLastUpdate, type RuntimePolicy, type RuntimeStatus, type RuntimeUpdateStage, type SamlSignIn, type Series, type SeriesParams, type SeriesPoint, type SetupStatus, type SignInMethod, type SignInPolicy, type SignInPolicyClient, type SignInPolicyState, type SignInResult, type SignInRule, type SocketLike, type SourceMeta, type SourceRef, type StaffAccessRule, type StaffSignIn, type StaffSignInClient, type StatusClient, type StatusInput, type Stored, type StoredFile, type StoredFileVariant, type TwoFactorMethod, type UploadOptions, type UploadProgress, type UploadResult, type UserInvitation, type UserInvitationSent, type UsersClient, type UsersFound, type WebDeviceRegistration, availabilities, createAssistantClient, createAuthSession, createClient, createRuntimeClient, createStaticSession, fileUrl, filterText, heldStatus, isApiError, listWire, maxStatusText, routedClient, sourceMeta, statusTextProblem, tokenExpiry };
+export { type AccountSecurity, type AccountSignIn, type ActiveRole, type Aggregate, type AggregateGroup, type AggregateParams, type AggregateSplitTotal, ApiError, type AppUser, type AssistantClient, type AssistantClientOptions, type AssistantConnection, AuthError, type AuthSession, type AuthSessionOptions, type AuthUser, type AuthenticatorSetup, type Availability, type BatchOp, type BatchRef, type BatchResult, type CallRing, type Channel, type ChannelError, type ChannelMessage, ChannelRefusal, type ChannelStatus, type ChannelUser, type Client, type ClientOptions, type CommentPage, type CommentPerson, type ConnectClient, type ConnectedApp, type ConnectingClient, type CurrentOrganization, type DeviceSession, type DevicesClient, type Facet, type FilterInput, type FormChallenge, type FormProof, type Histogram, type HistogramBucket, type HistoryChange, type HistoryPage, type InboxNotification, type InboxPage, type InvitationPreview, type InvitationSent, type InvokeOptions, type ListPage, type ListParams, type LiveChange, type LiveHandlers, type MapBounds, type MapBucket, type MapLayerModel, type MapParams, type MapResult, type MentionableUser, type Meta, type MetaResult, type NotificationHistoryClient, type Organization, type OrganizationInvitation, type OrganizationMember, type OrganizationPerson, type OrganizationRole, type OrganizationsClient, type OrganizationsFound, type Passkey, type PersonStatus, type PersonalMailLink, type PlatformSignIn, type PluginRef, PreconditionFailedError, type PresenceChange, type PresenceEntry, type ProblemDetails, type ProblemError, type PublicForm, type RecordCall, type RecordCallsHandlers, type RecordComment, type RecordOf, type RecordPermissions, type RecordPhotos, type RegisteredDevice, type RelatedLabels, type RequiredSetup, type ResourcePermissions, type ResourceRef, type RingsClient, type RoleLabel, type RoleOption, type RolesClient, type RuntimeClient, type RuntimeClientOptions, type RuntimeLastUpdate, type RuntimePolicy, type RuntimeStatus, type RuntimeUpdateStage, type SamlSignIn, type Series, type SeriesParams, type SeriesPoint, type SetupStatus, type SignInMethod, type SignInPolicy, type SignInPolicyClient, type SignInPolicyState, type SignInResult, type SignInRule, type SocketLike, type SourceMeta, type SourceRef, type StaffAccessRule, type StaffSignIn, type StaffSignInClient, type StatusClient, type StatusInput, type Stored, type StoredFile, type StoredFileVariant, type TwoFactorMethod, type UploadOptions, type UploadProgress, type UploadResult, type UserInvitation, type UserInvitationSent, type UsersClient, type UsersFound, type WebDeviceRegistration, availabilities, createAssistantClient, createAuthSession, createClient, createRuntimeClient, createStaticSession, fileUrl, filterText, heldStatus, isApiError, listWire, maxStatusText, routedClient, sourceMeta, statusTextProblem, tokenExpiry };

package/dist/static-session.js

@@ -75,6 +75,8 @@ const createStaticSession = (token, user = {
 		newBackupCodes: unsupported("make backup codes"),
 		linkedProviders: async () => [],
 		linkProvider: unsupported("link a sign-in provider"),
+		linkedPersonalMail: async () => [],
+		linkPersonalMail: unsupported("link a mailbox"),
 		connectedApps: async () => [],
 		disconnectApp: unsupported("disconnect an app"),
 		updateName: unsupported("change its name"),

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@protobase/client",
-  "version": "0.62.4",
+  "version": "0.62.5",
   "description": "Typed fetch client for the Protobase REST API.",
   "license": "Apache-2.0",
   "repository": {
@@ -31,8 +31,8 @@
   },
   "dependencies": {
     "@better-auth/passkey": "^1.7.12",
-    "@protobase/layout": "0.62.4",
-    "@protobase/schema": "0.62.4",
+    "@protobase/layout": "0.62.5",
+    "@protobase/schema": "0.62.5",
     "@simplewebauthn/browser": "^13.3.0",
     "better-auth": "^1.7.12"
   }