@protobase/client 0.68.5 → 0.69.0

package/dist/account-security.d.ts

@@ -39,6 +39,24 @@ export type ConnectedApp = {
     organization?: string;
   }[];
 };
+/**
+ * A connection a workflow plugin declares, which the person connects an account through for their workflows' steps to
+ * use: its `<plugin>:<connection>` key, label, the provider and scopes it links with, and their accounts that fit it,
+ * each marked when a trigger waits for it to be connected again. Tokens never leave the server.
+ */
+export type WorkflowConnection = {
+  key: string;
+  label: string;
+  provider: string;
+  scopes: string[];
+  link_params: Record<string, string>;
+  accounts: {
+    id: string;
+    scopes: string[];
+    created_at: string;
+    needs_sign_in: boolean;
+  }[];
+};
 /** A new authenticator app: the `otpauth://` URI it scans, and the backup codes that work once each instead of a code. */
 export type AuthenticatorSetup = {
   totpURI: string;
@@ -77,6 +95,15 @@ export declare const accountSecurity: (client: BetterAuthClient) => {
    * `?error=<code>` when the link did not go through.
    */
   linkPersonalMail: (link: PersonalMailLink, callbackURL: string) => Promise<string>;
+  /** The connections the app's workflow plugins declare, with the person's accounts that fit each; none in an app without. */
+  workflowConnections: () => Promise<WorkflowConnection[]>;
+  /**
+   * Starts connecting an account for a workflow connection: 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 it did not go through.
+   */
+  connectAccount: (connection: WorkflowConnection, callbackURL: string) => Promise<string>;
+  /** Disconnects an account: its token is revoked at the provider and deleted, and the triggers on it wait for a new one. */
+  disconnectAccount: (accountId: string) => Promise<void>;
   /** 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

@@ -109,6 +109,37 @@ const accountSecurity = (client) => ({
 		if (error || !data?.url) throw authError(error, "Could not start linking the mailbox");
 		return data.url;
 	},
+	/** The connections the app's workflow plugins declare, with the person's accounts that fit each; none in an app without. */
+	workflowConnections: async () => {
+		const { data, error } = await client.$fetch("/connections");
+		if (error?.status === 404) return [];
+		if (error || !data) throw authError(error, "Could not read your connections");
+		return data.connections;
+	},
+	/**
+	* Starts connecting an account for a workflow connection: 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 it did not go through.
+	*/
+	connectAccount: async (connection, callbackURL) => {
+		const { data, error } = await client.linkSocial({
+			provider: connection.provider,
+			scopes: connection.scopes,
+			additionalParams: connection.link_params,
+			callbackURL,
+			errorCallbackURL: callbackURL,
+			disableRedirect: true
+		});
+		if (error || !data?.url) throw authError(error, "Could not start connecting the account");
+		return data.url;
+	},
+	/** Disconnects an account: its token is revoked at the provider and deleted, and the triggers on it wait for a new one. */
+	disconnectAccount: async (accountId) => {
+		const { error } = await client.$fetch("/connections/disconnect", {
+			method: "POST",
+			body: { accountId }
+		});
+		if (error) throw authError(error, "Could not disconnect the account");
+	},
 	/** 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.d.ts

@@ -1,7 +1,7 @@
 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 { AccountSignIn, AuthenticatorSetup, ConnectedApp, Passkey, WorkflowConnection } 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";
@@ -78,6 +78,9 @@ export declare const createAuthSession: (options?: AuthSessionOptions) => {
     linkProvider: (provider: string, callbackURL: string) => Promise<string>;
     linkedPersonalMail: (links: PersonalMailLink[]) => Promise<string[]>;
     linkPersonalMail: (link: PersonalMailLink, callbackURL: string) => Promise<string>;
+    workflowConnections: () => Promise<WorkflowConnection[]>;
+    connectAccount: (connection: WorkflowConnection, callbackURL: string) => Promise<string>;
+    disconnectAccount: (accountId: string) => Promise<void>;
     connectedApps: () => Promise<ConnectedApp[]>;
     disconnectApp: (clientId: string) => Promise<void>;
     sendConfirmationCode: () => Promise<void>;

package/dist/index.d.ts

@@ -21,7 +21,7 @@ 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 { AccountSecurity, AccountSignIn, AuthenticatorSetup, ConnectedApp, Passkey, RequiredSetup, WorkflowConnection } 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";
@@ -33,4 +33,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 LiveSocket, 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, type PollThenSocketOptions, 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, type WorkflowTypeEntry, type WorkflowTypeList, availabilities, createAssistantClient, createAuthSession, createClient, createRuntimeClient, createStaticSession, fileUrl, filterText, heldStatus, isApiError, listWire, maxStatusText, pollThenSocket, 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 LiveSocket, 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, type PollThenSocketOptions, 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, type WorkflowConnection, type WorkflowTypeEntry, type WorkflowTypeList, availabilities, createAssistantClient, createAuthSession, createClient, createRuntimeClient, createStaticSession, fileUrl, filterText, heldStatus, isApiError, listWire, maxStatusText, pollThenSocket, routedClient, sourceMeta, statusTextProblem, tokenExpiry };

package/dist/static-session.js

@@ -80,6 +80,9 @@ const createStaticSession = (token, user = {
 		linkProvider: unsupported("link a sign-in provider"),
 		linkedPersonalMail: async () => [],
 		linkPersonalMail: unsupported("link a mailbox"),
+		workflowConnections: async () => [],
+		connectAccount: unsupported("connect an account"),
+		disconnectAccount: unsupported("disconnect an account"),
 		connectedApps: async () => [],
 		disconnectApp: unsupported("disconnect an app"),
 		updateName: unsupported("change its name"),

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@protobase/client",
-  "version": "0.68.5",
+  "version": "0.69.0",
   "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.68.5",
-    "@protobase/schema": "0.68.5",
+    "@protobase/layout": "0.69.0",
+    "@protobase/schema": "0.69.0",
     "@simplewebauthn/browser": "^13.3.0",
     "better-auth": "^1.7.12"
   }