@protobase/client 0.21.9 → 0.21.10

package/dist/auth-types.d.ts

@@ -23,11 +23,16 @@ export type PlatformSignIn = {
   provider: string;
   name: string;
 };
+/** A SAML identity provider of the app: its id, for `signInSaml`, and the name to show. */
+export type SamlSignIn = {
+  id: string;
+  name: string;
+};
 /**
  * `needsAdmin` while no user exists yet; `signInMethods` the ways to sign in the server's policy leaves on;
  * `passwordReset` when the server can email reset links; `signUp` when anyone can make their own account (see
  * `sendSignUpCode`); `socialProviders` the ids of the sign-in providers, for example
- * `github`; `platformSignIn` the one of them the platform adds; `staffSignIn` the operator provider's name when its staff
+ * `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; `plugins` those the app loads before anyone signs in.
  */
@@ -38,6 +43,7 @@ export type SetupStatus = {
   signUp?: boolean;
   socialProviders: string[];
   platformSignIn?: PlatformSignIn;
+  samlProviders: SamlSignIn[];
   staffSignIn?: string;
   /**
    * When people have passkeys made for more than one of the app's domains: those domains, the one new passkeys are made

package/dist/auth.d.ts

@@ -33,6 +33,12 @@ export declare const createAuthSession: (options?: AuthSessionOptions) => {
    * `signup_disabled` when no account here has that provider account or its address.
    */
   signInSocial: (provider: string, callbackURL: string) => Promise<string>;
+  /**
+   * Starts sign-in with one of the app's SAML identity providers by its id: resolves with the provider's sign-in URL,
+   * for the page to go to. The provider sends the browser back to `callbackURL` signed in, or with `?error=<code>`,
+   * for example `EMAIL_DOMAIN_NOT_ALLOWED` for an address outside the provider's domains, or `account_not_linked`.
+   */
+  signInSaml: (providerId: string, callbackURL: string) => Promise<string>;
   signOut: () => Promise<void>;
   /**
    * Emails a reset link when an account has this address; the answer is the same either way. The link leads back to

package/dist/auth.js

@@ -76,6 +76,7 @@ const createAuthSession = (options = {}) => {
 				...body.signUp && { signUp: true },
 				socialProviders: body.socialProviders ?? [],
 				...body.platformSignIn && { platformSignIn: body.platformSignIn },
+				samlProviders: body.samlProviders ?? [],
 				...body.staffSignIn && { staffSignIn: body.staffSignIn },
 				...body.passkeyDomains && { passkeyDomains: body.passkeyDomains },
 				...body.organizations && { organizations: body.organizations },
@@ -104,6 +105,23 @@ const createAuthSession = (options = {}) => {
 			if (error || !data?.url) throw authError(error, "Sign-in failed");
 			return data.url;
 		},
+		/**
+		* Starts sign-in with one of the app's SAML identity providers by its id: resolves with the provider's sign-in URL,
+		* for the page to go to. The provider sends the browser back to `callbackURL` signed in, or with `?error=<code>`,
+		* for example `EMAIL_DOMAIN_NOT_ALLOWED` for an address outside the provider's domains, or `account_not_linked`.
+		*/
+		signInSaml: async (providerId, callbackURL) => {
+			const { data, error } = await client.$fetch("/sign-in/sso", {
+				method: "POST",
+				body: {
+					providerId,
+					callbackURL,
+					errorCallbackURL: callbackURL
+				}
+			});
+			if (error || !data?.url) throw authError(error, "Sign-in failed");
+			return data.url;
+		},
 		signOut: async () => {
 			forget();
 			await client.signOut();

package/dist/index.d.ts

@@ -12,10 +12,10 @@ import { AccountSecurity, AccountSignIn, AuthenticatorSetup, Passkey, RequiredSe
 import { CurrentOrganization, InvitationPreview, InvitationSent, Organization, OrganizationInvitation, OrganizationMember, OrganizationRole, OrganizationsClient } from "./organizations.js";
 import { ActiveRole, RoleOption, RolesClient } from "./roles.js";
 import { StaffSignIn, StaffSignInClient } from "./staff-sign-in.js";
-import { AuthUser, PlatformSignIn, RoleLabel, SetupStatus, SignInMethod, SignInResult, TwoFactorMethod } from "./auth-types.js";
+import { AuthUser, PlatformSignIn, RoleLabel, SamlSignIn, SetupStatus, SignInMethod, SignInResult, TwoFactorMethod } from "./auth-types.js";
 import { AuthError } from "./auth-error.js";
 import { AuthSession, AuthSessionOptions, createAuthSession, tokenExpiry } from "./auth.js";
 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";
-export { type AccountSecurity, type AccountSignIn, type ActiveRole, type Aggregate, type AggregateGroup, type AggregateParams, ApiError, type AssistantClient, type AssistantClientOptions, type AssistantConnection, AuthError, type AuthSession, type AuthSessionOptions, type AuthUser, type AuthenticatorSetup, type BatchOp, type BatchRef, type BatchResult, type Client, type ClientOptions, type CommentPage, type CommentPerson, type CurrentOrganization, type Facet, type FilterInput, type FormChallenge, type FormProof, type Histogram, type HistogramBucket, type HistoryChange, type HistoryPage, type InvitationPreview, type InvitationSent, type InvokeOptions, type ListPage, type ListParams, type MapBounds, type MapBucket, type MapLayerModel, type MapParams, type MapResult, type MentionableUser, type Meta, type MetaResult, type Organization, type OrganizationInvitation, type OrganizationMember, type OrganizationRole, type OrganizationsClient, type Passkey, type PlatformSignIn, type PluginRef, PreconditionFailedError, type ProblemDetails, type ProblemError, type PublicForm, type RecordComment, type RecordOf, type RecordPermissions, type RecordPhotos, type RelatedLabels, type RequiredSetup, type ResourcePermissions, type ResourceRef, type RoleLabel, type RoleOption, type RolesClient, type RuntimeClient, type RuntimeClientOptions, type RuntimeLastUpdate, type RuntimePolicy, type RuntimeStatus, type RuntimeUpdateStage, type Series, type SeriesParams, type SeriesPoint, type SetupStatus, type SignInMethod, type SignInPolicy, type SignInPolicyClient, type SignInPolicyState, type SignInResult, type SignInRule, type SourceMeta, type SourceRef, type StaffAccessRule, type StaffSignIn, type StaffSignInClient, type Stored, type StoredFile, type StoredFileVariant, type TwoFactorMethod, type UploadOptions, type UploadProgress, type UploadResult, createAssistantClient, createAuthSession, createClient, createRuntimeClient, createStaticSession, fileUrl, filterText, isApiError, listWire, routedClient, sourceMeta, tokenExpiry };
+export { type AccountSecurity, type AccountSignIn, type ActiveRole, type Aggregate, type AggregateGroup, type AggregateParams, ApiError, type AssistantClient, type AssistantClientOptions, type AssistantConnection, AuthError, type AuthSession, type AuthSessionOptions, type AuthUser, type AuthenticatorSetup, type BatchOp, type BatchRef, type BatchResult, type Client, type ClientOptions, type CommentPage, type CommentPerson, type CurrentOrganization, type Facet, type FilterInput, type FormChallenge, type FormProof, type Histogram, type HistogramBucket, type HistoryChange, type HistoryPage, type InvitationPreview, type InvitationSent, type InvokeOptions, type ListPage, type ListParams, type MapBounds, type MapBucket, type MapLayerModel, type MapParams, type MapResult, type MentionableUser, type Meta, type MetaResult, type Organization, type OrganizationInvitation, type OrganizationMember, type OrganizationRole, type OrganizationsClient, type Passkey, type PlatformSignIn, type PluginRef, PreconditionFailedError, type ProblemDetails, type ProblemError, type PublicForm, type RecordComment, type RecordOf, type RecordPermissions, type RecordPhotos, type RelatedLabels, type RequiredSetup, type ResourcePermissions, type ResourceRef, 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 SourceMeta, type SourceRef, type StaffAccessRule, type StaffSignIn, type StaffSignInClient, type Stored, type StoredFile, type StoredFileVariant, type TwoFactorMethod, type UploadOptions, type UploadProgress, type UploadResult, createAssistantClient, createAuthSession, createClient, createRuntimeClient, createStaticSession, fileUrl, filterText, isApiError, listWire, routedClient, sourceMeta, tokenExpiry };

package/dist/static-session.js

@@ -19,7 +19,8 @@ const createStaticSession = (token, user = {
 		needsAdmin: false,
 		signInMethods: ["password"],
 		passwordReset: false,
-		socialProviders: []
+		socialProviders: [],
+		samlProviders: []
 	}),
 	session: async () => user,
 	signIn: async () => ({
@@ -38,6 +39,7 @@ const createStaticSession = (token, user = {
 	sendTwoFactorCode: async () => void 0,
 	verifyTwoFactor: async () => user,
 	signInSocial: unsupported("sign in with a provider"),
+	signInSaml: unsupported("sign in with a provider"),
 	signOut: async () => void 0,
 	requestPasswordReset: async () => void 0,
 	resetPassword: async () => void 0,

package/package.json

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