@faable/auth-sdk 1.3.18 → 1.3.20

package/dist/FaableAuthApi.js

@@ -1,5 +1,7 @@
-import { getDomain } from "./helpers.js";
+import { getDomain, isPlainObject, requireId } from "./helpers.js";
+import { FaableApiError } from "./error_handler.js";
 import { FaableApi } from "@faable/sdk-base";
+import { version } from "./version.js";
 export class FaableAuthApi extends FaableApi {
     constructor(params) {
         let baseURL = "https://faable.auth.faable.link";
@@ -12,6 +14,11 @@ export class FaableAuthApi extends FaableApi {
             fetcher: {
                 ...params?.fetcher,
                 headers: {
+                    // Identify ourselves as a first-party client so the auth server can
+                    // tell management-SDK traffic apart from the dashboard or auth-js
+                    // (surfaced as the `client` / `client_version` tags in Sentry /
+                    // canonical logs). Format: `<name>/<version>`.
+                    "x-faable-client": `auth-sdk/${version}`,
                     ...params?.fetcher?.headers,
                     ...(params?.team_id && { "x-faable-team": params.team_id }),
                     ...(params?.account_id && {
@@ -22,12 +29,17 @@ export class FaableAuthApi extends FaableApi {
         });
     }
     async setUserMetadata(user_id, user_metadata) {
+        requireId("user_id", user_id);
+        if (!isPlainObject(user_metadata)) {
+            throw new FaableApiError(`FaableApiError: user_metadata must be an object (received ${JSON.stringify(user_metadata)})`);
+        }
         const user = await this.fetcher.post(`/user/${user_id}`, {
             user_metadata,
         });
         return user.user_metadata;
     }
     async getUserMetadata(user_id) {
+        requireId("user_id", user_id);
         const user = await this.fetcher.get(`/user/${user_id}`);
         return user.user_metadata;
     }
@@ -38,18 +50,22 @@ export class FaableAuthApi extends FaableApi {
         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) {
@@ -65,18 +81,22 @@ export class FaableAuthApi extends FaableApi {
         });
     }
     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}`);
     }
 }

package/dist/error_handler.d.ts

@@ -1,4 +1,4 @@
-import { AxiosError } from "axios";
+import type { AxiosError } from "axios";
 export declare class FaableApiError extends Error {
     constructor(msg: string);
 }

package/dist/helpers.d.ts

@@ -1 +1,3 @@
 export declare const getDomain: (domain: string) => string;
+export declare const requireId: (name: string, value: unknown) => string;
+export declare const isPlainObject: (value: unknown) => value is Record<string, unknown>;

package/dist/helpers.js

@@ -1,3 +1,4 @@
+import { FaableApiError } from "./error_handler.js";
 export const getDomain = (domain) => {
     if (!/^(https|http)?:\/\//.test(domain)) {
         const protocol = "https";
@@ -5,3 +6,14 @@ export const getDomain = (domain) => {
     }
     return domain;
 };
+// Guard required path params (ids) before interpolating them into a URL.
+// Without this, a `null`/`undefined` id silently builds e.g. `/user/null`
+// and the server rejects it with a confusing 400 — failing fast here gives
+// the caller a clear error and keeps that noise out of the auth server.
+export const requireId = (name, value) => {
+    if (typeof value !== "string" || value.trim() === "") {
+        throw new FaableApiError(`FaableApiError: ${name} is required and must be a non-empty string (received ${JSON.stringify(value)})`);
+    }
+    return value;
+};
+export const isPlainObject = (value) => typeof value === "object" && value !== null && !Array.isArray(value);

package/dist/version.d.ts

@@ -0,0 +1,2 @@
+declare const version: string;
+export { version };

package/dist/version.js

@@ -0,0 +1,9 @@
+import { createRequire } from "node:module";
+// Read the published package version at runtime. semantic-release bumps
+// package.json at publish time (after `npm run build`), so a build-time
+// constant would always be stale; reading it from the installed package
+// instead always reflects the real version. From dist/version.js,
+// "../package.json" resolves to the package root.
+const require = createRequire(import.meta.url);
+const { version } = require("../package.json");
+export { version };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@faable/auth-sdk",
-  "version": "1.3.18",
+  "version": "1.3.20",
   "author": "Marc Pomar <marc@faable.com>",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

package/spec/openapi.json

@@ -3,7 +3,7 @@
   "info": {
     "title": "@faablecloud/auth",
     "description": "Auth Platform made by Faable. Manage Users and Roles",
-    "version": "1.8.15",
+    "version": "1.8.16",
     "license": {
       "name": "private",
       "url": "https://faable.com/docs/platform/privacy-policy"