@faable/auth-sdk 2.2.1 → 2.4.0

package/dist/FaableAuthApi.d.ts

@@ -1,5 +1,5 @@
-import { TeamCreate, UserCreate, UserUpdate } from "./api/api-types.js";
-import { ApiParams, FaableApi } from "@faable/sdk-base";
+import { GeneratedFaableAuthApi } from "./api/generated-client.js";
+import { type ApiParams } from "@faable/sdk-base";
 type FaableAuthApiParams = {
     domain: string;
     /**
@@ -16,7 +16,7 @@ type FaableAuthApiParams = {
         account_id?: string;
     };
 } & ApiParams;
-export declare class FaableAuthApi extends FaableApi {
+export declare class FaableAuthApi extends GeneratedFaableAuthApi {
     constructor(params?: FaableAuthApiParams);
     setUserMetadata(user_id: string, user_metadata: Record<string, string | any[] | boolean | number | null | undefined>): Promise<{
         [key: string]: unknown;
@@ -24,7 +24,9 @@ export declare class FaableAuthApi extends FaableApi {
     getUserMetadata(user_id: string): Promise<{
         [key: string]: unknown;
     }>;
-    currentAccount(): Promise<{
+    isUserMemberOfTeam(user_id: string, team_id: string): Promise<boolean>;
+    /** @deprecated use {@link GeneratedFaableAuthApi.accountCurrent | accountCurrent} */
+    currentAccount(...args: Parameters<GeneratedFaableAuthApi["accountCurrent"]>): Promise<{
         id: string;
         name: string;
         domain: string;
@@ -46,9 +48,8 @@ export declare class FaableAuthApi extends FaableApi {
         createdAt: string;
         updatedAt?: string | undefined;
     }>;
-    listUsers(params?: {
-        email?: string;
-    }): {
+    /** @deprecated use {@link GeneratedFaableAuthApi.userList | userList} */
+    listUsers(...args: Parameters<GeneratedFaableAuthApi["userList"]>): {
         all: () => Promise<{
             id: string;
             name?: string | null | undefined;
@@ -203,7 +204,8 @@ export declare class FaableAuthApi extends FaableApi {
             updatedAt?: string | undefined;
         }>>;
     };
-    getUser(user_id: string): Promise<{
+    /** @deprecated use {@link GeneratedFaableAuthApi.userGet | userGet} */
+    getUser(...args: Parameters<GeneratedFaableAuthApi["userGet"]>): Promise<{
         id: string;
         name?: string | null | undefined;
         username?: string | null | undefined;
@@ -253,7 +255,8 @@ export declare class FaableAuthApi extends FaableApi {
         createdAt: string;
         updatedAt?: string | undefined;
     }>;
-    createUser(data: UserCreate): Promise<{
+    /** @deprecated use {@link GeneratedFaableAuthApi.userCreate | userCreate} */
+    createUser(...args: Parameters<GeneratedFaableAuthApi["userCreate"]>): Promise<{
         id: string;
         name?: string | null | undefined;
         username?: string | null | undefined;
@@ -303,7 +306,8 @@ export declare class FaableAuthApi extends FaableApi {
         createdAt: string;
         updatedAt?: string | undefined;
     }>;
-    updateUser(user_id: string, data: UserUpdate): Promise<{
+    /** @deprecated use {@link GeneratedFaableAuthApi.userUpdate | userUpdate} */
+    updateUser(...args: Parameters<GeneratedFaableAuthApi["userUpdate"]>): Promise<{
         id: string;
         name?: string | null | undefined;
         username?: string | null | undefined;
@@ -353,7 +357,8 @@ export declare class FaableAuthApi extends FaableApi {
         createdAt: string;
         updatedAt?: string | undefined;
     }>;
-    getTeam(team_id: string): Promise<{
+    /** @deprecated use {@link GeneratedFaableAuthApi.teamGet | teamGet} */
+    getTeam(...args: Parameters<GeneratedFaableAuthApi["teamGet"]>): Promise<{
         id: string;
         name: string;
         slug: string;
@@ -366,8 +371,8 @@ export declare class FaableAuthApi extends FaableApi {
         createdAt: string;
         updatedAt?: string | undefined;
     }>;
-    deleteTeam(team_id: string): Promise<any>;
-    createTeam(data: TeamCreate): Promise<{
+    /** @deprecated use {@link GeneratedFaableAuthApi.teamDelete | teamDelete} */
+    deleteTeam(...args: Parameters<GeneratedFaableAuthApi["teamDelete"]>): Promise<{
         id: string;
         name: string;
         slug: string;
@@ -380,9 +385,22 @@ export declare class FaableAuthApi extends FaableApi {
         createdAt: string;
         updatedAt?: string | undefined;
     }>;
-    listTeams(params?: {
-        user_id?: string;
-    }): {
+    /** @deprecated use {@link GeneratedFaableAuthApi.teamCreate | teamCreate} */
+    createTeam(...args: Parameters<GeneratedFaableAuthApi["teamCreate"]>): Promise<{
+        id: string;
+        name: string;
+        slug: string;
+        description: string | null;
+        logo_url: string | null;
+        account: string;
+        metadata: {
+            [key: string]: unknown;
+        };
+        createdAt: string;
+        updatedAt?: string | undefined;
+    }>;
+    /** @deprecated use {@link GeneratedFaableAuthApi.teamList | teamList} */
+    listTeams(...args: Parameters<GeneratedFaableAuthApi["teamList"]>): {
         all: () => Promise<{
             id: string;
             name: string;
@@ -426,9 +444,8 @@ export declare class FaableAuthApi extends FaableApi {
             updatedAt?: string | undefined;
         }>>;
     };
-    listTeamMembers(params: {
-        query?: string;
-    }): {
+    /** @deprecated use {@link GeneratedFaableAuthApi.teammemberList | teammemberList} */
+    listTeamMembers(...args: Parameters<GeneratedFaableAuthApi["teammemberList"]>): {
         all: () => Promise<{
             id: string;
             user: unknown;
@@ -469,8 +486,8 @@ export declare class FaableAuthApi extends FaableApi {
             updatedAt?: string | undefined;
         }>>;
     };
-    isUserMemberOfTeam(user_id: string, team_id: string): Promise<boolean>;
-    listConections(): {
+    /** @deprecated typo — use {@link GeneratedFaableAuthApi.connectionList | connectionList} */
+    listConections(...args: Parameters<GeneratedFaableAuthApi["connectionList"]>): {
         all: () => Promise<{
             id: string;
             connection_name: string;
@@ -589,7 +606,8 @@ export declare class FaableAuthApi extends FaableApi {
             updatedAt?: string | undefined;
         }>>;
     };
-    getConection(connection_id: string): Promise<{
+    /** @deprecated typo — use {@link GeneratedFaableAuthApi.connectionGet | connectionGet} */
+    getConection(...args: Parameters<GeneratedFaableAuthApi["connectionGet"]>): Promise<{
         id: string;
         connection_name: string;
         connection_type: "custom" | "database" | "github" | "figma" | "google_oauth2" | "oidc" | "passwordless_email";
@@ -627,9 +645,8 @@ export declare class FaableAuthApi extends FaableApi {
         createdAt: string;
         updatedAt?: string | undefined;
     }>;
-    listClients(params?: {
-        client_id?: string;
-    }): {
+    /** @deprecated use {@link GeneratedFaableAuthApi.clientList | clientList} */
+    listClients(...args: Parameters<GeneratedFaableAuthApi["clientList"]>): {
         all: () => Promise<{
             id: string;
             name: string;
@@ -733,37 +750,33 @@ export declare class FaableAuthApi extends FaableApi {
             updatedAt?: string | undefined;
         }>>;
     };
-    getClient(client_id: string): Promise<{
+    /** @deprecated use {@link GeneratedFaableAuthApi.clientGet | clientGet} */
+    getClient(...args: Parameters<GeneratedFaableAuthApi["clientGet"]>): Promise<{
         id: string;
-        connection_name: string;
-        connection_type: "custom" | "database" | "github" | "figma" | "google_oauth2" | "oidc" | "passwordless_email";
-        authorize_url: string;
-        token_url: string;
-        userinfo_url: string;
+        name: string;
+        description: string;
         client_id: string;
         client_secret: string;
-        issuer: string;
-        jwks_url: string;
-        response_type: string;
-        enabled: boolean;
-        enabled_clients: string[] | null;
-        scope: string[];
-        authorize_params: {
-            [key: string]: string;
+        callbacks: string[];
+        logout_urls: string[];
+        refresh_token: {
+            expiration_mode: "expire" | "not-expire";
+            infinite_token_lifetime: boolean;
+            token_lifetime: number;
         };
-        claims_mapping?: {
-            [key: string]: string;
-        } | undefined;
-        readonly is_using_default_credentials: boolean;
-        email_oauth_sync_policy?: "preserve_manual" | "always_sync" | undefined;
-        password_policy?: {
-            level: "none" | "low" | "fair" | "good" | "excellent";
-            min_length?: number | undefined;
-            require_lowercase?: boolean | undefined;
-            require_uppercase?: boolean | undefined;
-            require_number?: boolean | undefined;
-            require_special?: boolean | undefined;
-        } | undefined;
+        client_uri?: string | null | undefined;
+        logo_uri?: string | null | undefined;
+        tos_uri?: string | null | undefined;
+        policy_uri?: string | null | undefined;
+        contacts?: string[] | undefined;
+        grant_types?: string[] | undefined;
+        response_types?: string[] | undefined;
+        token_endpoint_auth_method?: string | undefined;
+        application_type?: string | undefined;
+        software_id?: string | null | undefined;
+        software_version?: string | null | undefined;
+        frontchannel_logout_uri?: string | null | undefined;
+        frontchannel_logout_session_required?: boolean | undefined;
         account: string;
         metadata: {
             [key: string]: unknown;

package/dist/FaableAuthApi.js

@@ -1,6 +1,7 @@
 import { getDomain, isPlainObject, requireId } from "./helpers.js";
 import { FaableApiError } from "./error_handler.js";
-import { FaableApi, authClientCredentials } from "@faable/sdk-base";
+import { GeneratedFaableAuthApi } from "./api/generated-client.js";
+import { authClientCredentials } from "@faable/sdk-base";
 import { version } from "./version.js";
 // auth-sdk exists to drive the Faable management API, so a client_credentials
 // client should "just work" against it from `domain` alone. The management API
@@ -30,7 +31,7 @@ const discoverManagementAudience = (baseURL) => {
         return cached;
     };
 };
-export class FaableAuthApi extends FaableApi {
+export class FaableAuthApi extends GeneratedFaableAuthApi {
     constructor(params) {
         if (!params?.domain) {
             throw new FaableApiError("FaableAuthApi: `domain` is required. Pass your account host, e.g. " +
@@ -83,6 +84,8 @@ export class FaableAuthApi extends FaableApi {
             },
         });
     }
+    // ── Custom-logic helpers (not plain CRUD — kept hand-written) ──────────────
+    // Wraps `user_metadata` in the User patch body and returns just the metadata.
     async setUserMetadata(user_id, user_metadata) {
         requireId("user_id", user_id);
         if (!isPlainObject(user_metadata)) {
@@ -93,65 +96,77 @@ export class FaableAuthApi extends FaableApi {
         });
         return user.user_metadata;
     }
+    // Reads the User and returns just its `user_metadata`.
     async getUserMetadata(user_id) {
         requireId("user_id", user_id);
         const user = await this.fetcher.get(`/user/${user_id}`);
         return user.user_metadata;
     }
-    currentAccount() {
-        return this.fetcher.get("/account/current");
-    }
-    listUsers(params = {}) {
-        return this.paginator({ url: "/user", params });
-    }
-    getUser(user_id) {
-        requireId("user_id", user_id);
-        return this.fetcher.get(`/user/${user_id}`);
-    }
-    createUser(data) {
-        return this.fetcher.post(`/user`, data);
-    }
-    updateUser(user_id, data) {
-        requireId("user_id", user_id);
-        return this.fetcher.post(`/user/${user_id}`, data);
-    }
-    getTeam(team_id) {
-        requireId("team_id", team_id);
-        return this.fetcher.get(`/team/${team_id}`);
-    }
-    deleteTeam(team_id) {
-        requireId("team_id", team_id);
-        return this.fetcher.delete(`/team/${team_id}`);
-    }
-    createTeam(data) {
-        return this.fetcher.post(`/team`, data);
-    }
-    listTeams(params) {
-        return this.paginator({ url: "/team", params });
-    }
-    listTeamMembers(params) {
-        return this.paginator({
-            url: `/teammember`,
-            params,
-        });
-    }
+    // Membership check via HTTP status (200/404) rather than a body — distinct
+    // from the generated `teamCheckMember`, which returns the TeamMember object.
     isUserMemberOfTeam(user_id, team_id) {
         requireId("user_id", user_id);
         requireId("team_id", team_id);
         return this.fetcher.check(`/team/${team_id}/member/check/${user_id}`);
     }
-    listConections() {
-        return this.paginator({ url: "/connection" });
-    }
-    getConection(connection_id) {
-        requireId("connection_id", connection_id);
-        return this.fetcher.get(`/connection/${connection_id}`);
-    }
-    listClients(params) {
-        return this.paginator({ url: "/client", params });
-    }
-    getClient(client_id) {
-        requireId("client_id", client_id);
-        return this.fetcher.get(`/client/${client_id}`);
+    // ── Deprecated aliases ─────────────────────────────────────────────────────
+    // Thin forwarders to the auto-generated methods, kept so existing consumers
+    // don't break. Signatures track the generated methods via `Parameters<…>`.
+    // Prefer the generated names; these will be removed in a future major.
+    /** @deprecated use {@link GeneratedFaableAuthApi.accountCurrent | accountCurrent} */
+    currentAccount(...args) {
+        return this.accountCurrent(...args);
+    }
+    /** @deprecated use {@link GeneratedFaableAuthApi.userList | userList} */
+    listUsers(...args) {
+        return this.userList(...args);
+    }
+    /** @deprecated use {@link GeneratedFaableAuthApi.userGet | userGet} */
+    getUser(...args) {
+        return this.userGet(...args);
+    }
+    /** @deprecated use {@link GeneratedFaableAuthApi.userCreate | userCreate} */
+    createUser(...args) {
+        return this.userCreate(...args);
+    }
+    /** @deprecated use {@link GeneratedFaableAuthApi.userUpdate | userUpdate} */
+    updateUser(...args) {
+        return this.userUpdate(...args);
+    }
+    /** @deprecated use {@link GeneratedFaableAuthApi.teamGet | teamGet} */
+    getTeam(...args) {
+        return this.teamGet(...args);
+    }
+    /** @deprecated use {@link GeneratedFaableAuthApi.teamDelete | teamDelete} */
+    deleteTeam(...args) {
+        return this.teamDelete(...args);
+    }
+    /** @deprecated use {@link GeneratedFaableAuthApi.teamCreate | teamCreate} */
+    createTeam(...args) {
+        return this.teamCreate(...args);
+    }
+    /** @deprecated use {@link GeneratedFaableAuthApi.teamList | teamList} */
+    listTeams(...args) {
+        return this.teamList(...args);
+    }
+    /** @deprecated use {@link GeneratedFaableAuthApi.teammemberList | teammemberList} */
+    listTeamMembers(...args) {
+        return this.teammemberList(...args);
+    }
+    /** @deprecated typo — use {@link GeneratedFaableAuthApi.connectionList | connectionList} */
+    listConections(...args) {
+        return this.connectionList(...args);
+    }
+    /** @deprecated typo — use {@link GeneratedFaableAuthApi.connectionGet | connectionGet} */
+    getConection(...args) {
+        return this.connectionGet(...args);
+    }
+    /** @deprecated use {@link GeneratedFaableAuthApi.clientList | clientList} */
+    listClients(...args) {
+        return this.clientList(...args);
+    }
+    /** @deprecated use {@link GeneratedFaableAuthApi.clientGet | clientGet} */
+    getClient(...args) {
+        return this.clientGet(...args);
     }
 }

package/dist/api/api-types.d.ts

@@ -1,10 +1,93 @@
-import { components } from "./types.js";
+import type { components } from "./types.js";
+export type AccountNotificationSettings = components["schemas"]["AccountNotificationSettings"];
+export type Action = components["schemas"]["Action"];
+export type ActionCreate = components["schemas"]["ActionCreate"];
+export type ActionMetadata = components["schemas"]["ActionMetadata"];
+export type Api = components["schemas"]["Api"];
+export type ApiCreate = components["schemas"]["ApiCreate"];
+export type ApiMetadata = components["schemas"]["ApiMetadata"];
+export type ApiSigningAlg = components["schemas"]["ApiSigningAlg"];
+export type ApiTokenDialect = components["schemas"]["ApiTokenDialect"];
+export type ApiUpdate = components["schemas"]["ApiUpdate"];
+export type AuthAccount = components["schemas"]["AuthAccount"];
+export type AuthAccountCreate = components["schemas"]["AuthAccountCreate"];
+export type AuthAccountMetadataCreate = components["schemas"]["AuthAccountMetadataCreate"];
+export type AuthAccountUpdate = components["schemas"]["AuthAccountUpdate"];
+export type Client = components["schemas"]["Client"];
+export type ClientCreate = components["schemas"]["ClientCreate"];
+export type ClientMetadata = components["schemas"]["ClientMetadata"];
+export type ClientMetadataCreate = components["schemas"]["ClientMetadataCreate"];
+export type ClientRegistrationRequest = components["schemas"]["ClientRegistrationRequest"];
+export type ClientRegistrationResponse = components["schemas"]["ClientRegistrationResponse"];
+export type ClientUpdate = components["schemas"]["ClientUpdate"];
+export type Connection = components["schemas"]["Connection"];
+export type ConnectionCreate = components["schemas"]["ConnectionCreate"];
+export type ConnectionMetadata = components["schemas"]["ConnectionMetadata"];
+export type ConnectionMetadataCreate = components["schemas"]["ConnectionMetadataCreate"];
+export type ConnectionUpdate = components["schemas"]["ConnectionUpdate"];
+export type Credential = components["schemas"]["Credential"];
+export type CredentialMetadata = components["schemas"]["CredentialMetadata"];
+export type CredentialsCreate = components["schemas"]["CredentialsCreate"];
+export type CredentialsUpdate = components["schemas"]["CredentialsUpdate"];
+export type Customdomain = components["schemas"]["Customdomain"];
+export type CustomdomainCreate = components["schemas"]["CustomdomainCreate"];
+export type CustomdomainMetadata = components["schemas"]["CustomdomainMetadata"];
+export type CustomdomainMetadataCreate = components["schemas"]["CustomdomainMetadataCreate"];
+export type EmailChangeVerificationMode = components["schemas"]["EmailChangeVerificationMode"];
+export type Identity = components["schemas"]["Identity"];
+export type IdentityCreate = components["schemas"]["IdentityCreate"];
+export type IdentityMetadata = components["schemas"]["IdentityMetadata"];
+export type Log = components["schemas"]["Log"];
+export type LogMetadata = components["schemas"]["LogMetadata"];
+export type LoginCallbackBody = components["schemas"]["LoginCallbackBody"];
+export type NotificationSubscription = components["schemas"]["NotificationSubscription"];
+export type NotificationSubscriptionCreate = components["schemas"]["NotificationSubscriptionCreate"];
+export type NotificationSubscriptionEmail = components["schemas"]["NotificationSubscriptionEmail"];
+export type NotificationSubscriptionEmailConfig = components["schemas"]["NotificationSubscriptionEmailConfig"];
+export type NotificationSubscriptionEmailConfigCreate = components["schemas"]["NotificationSubscriptionEmailConfigCreate"];
+export type NotificationSubscriptionEmailCreate = components["schemas"]["NotificationSubscriptionEmailCreate"];
+export type NotificationSubscriptionEmailMetadata = components["schemas"]["NotificationSubscriptionEmailMetadata"];
+export type NotificationSubscriptionEmailMetadataCreate = components["schemas"]["NotificationSubscriptionEmailMetadataCreate"];
+export type NotificationSubscriptionEmailMetadataUpdate = components["schemas"]["NotificationSubscriptionEmailMetadataUpdate"];
+export type NotificationSubscriptionUpdate = components["schemas"]["NotificationSubscriptionUpdate"];
+export type NotificationSubscriptionWebhook = components["schemas"]["NotificationSubscriptionWebhook"];
+export type NotificationSubscriptionWebhookConfig = components["schemas"]["NotificationSubscriptionWebhookConfig"];
+export type NotificationSubscriptionWebhookConfigCreate = components["schemas"]["NotificationSubscriptionWebhookConfigCreate"];
+export type NotificationSubscriptionWebhookCreate = components["schemas"]["NotificationSubscriptionWebhookCreate"];
+export type NotificationSubscriptionWebhookMetadata = components["schemas"]["NotificationSubscriptionWebhookMetadata"];
+export type NotificationSubscriptionWebhookMetadataCreate = components["schemas"]["NotificationSubscriptionWebhookMetadataCreate"];
+export type NotificationSubscriptionWebhookMetadataUpdate = components["schemas"]["NotificationSubscriptionWebhookMetadataUpdate"];
+export type OAuthGrantType = components["schemas"]["OAuthGrantType"];
+export type OAuthTokenParams = components["schemas"]["OAuthTokenParams"];
+export type Permission = components["schemas"]["Permission"];
+export type PermissionCreate = components["schemas"]["PermissionCreate"];
+export type Role = components["schemas"]["Role"];
+export type RoleCreate = components["schemas"]["RoleCreate"];
+export type RoleMember = components["schemas"]["RoleMember"];
+export type RoleMemberCreate = components["schemas"]["RoleMemberCreate"];
+export type RoleMemberMetadata = components["schemas"]["RoleMemberMetadata"];
+export type RoleMetadata = components["schemas"]["RoleMetadata"];
+export type RoleMetadataCreate = components["schemas"]["RoleMetadataCreate"];
+export type RoleUpdate = components["schemas"]["RoleUpdate"];
+export type Team = components["schemas"]["Team"];
+export type TeamCreate = components["schemas"]["TeamCreate"];
+export type TeamMember = components["schemas"]["TeamMember"];
+export type TeamMemberCreate = components["schemas"]["TeamMemberCreate"];
+export type TeamMemberMetadata = components["schemas"]["TeamMemberMetadata"];
+export type TeamMetadata = components["schemas"]["TeamMetadata"];
+export type TeamMetadataCreate = components["schemas"]["TeamMetadataCreate"];
+export type TeamUpdate = components["schemas"]["TeamUpdate"];
+export type TeamUpdateMetadata = components["schemas"]["TeamUpdateMetadata"];
+export type TokenSigningAlg = components["schemas"]["TokenSigningAlg"];
 export type User = components["schemas"]["User"];
+export type UserAddress = components["schemas"]["UserAddress"];
+export type UserAppCreate = components["schemas"]["UserAppCreate"];
+export type UserAppMetadata = components["schemas"]["UserAppMetadata"];
+export type UserAppMetadataUpdate = components["schemas"]["UserAppMetadataUpdate"];
 export type UserCreate = components["schemas"]["UserCreate"];
+export type UserMetadata = components["schemas"]["UserMetadata"];
 export type UserUpdate = components["schemas"]["UserUpdate"];
-export type Team = components["schemas"]["Team"];
-export type TeamMember = components["schemas"]["TeamMember"];
-export type TeamCreate = components["schemas"]["TeamCreate"];
-export type AuthAccount = components["schemas"]["AuthAccount"];
-export type Connection = components["schemas"]["Connection"];
-export type Client = components["schemas"]["Client"];
+export type UserUserCreate = components["schemas"]["UserUserCreate"];
+export type UserUserMetadata = components["schemas"]["UserUserMetadata"];
+export type UserUserMetadataUpdate = components["schemas"]["UserUserMetadataUpdate"];
+export type UsernamepasswordLoginBody = components["schemas"]["UsernamepasswordLoginBody"];

package/dist/api/api-types.js

@@ -1 +1,4 @@
+// AUTO-GENERATED by scripts/gen-client.mjs — do not edit by hand.
+// Regenerated from the OpenAPI spec on every build (npm run gentypes).
+// One simple-named alias per schema in `components["schemas"]`.
 export {};