@turinhub/tale-js-sdk 1.3.0

package/dist/user-attribute/index.js

@@ -0,0 +1,615 @@
+import { getAppToken } from "../token.js";
+import { ApiError, ConfigurationError, NetworkError } from "../errors.js";
+// ==================== Helper Functions ====================
+/**
+ * Parses standard API response format: { code, msg, data }
+ */
+function parseApiResponse(json, errorMessage, statusCode) {
+    if (typeof json !== "object" || json === null) {
+        throw new ApiError(`Invalid response: ${errorMessage} - not an object`, statusCode);
+    }
+    const response = json;
+    if (response.code !== 200) {
+        const errorMsg = typeof response.msg === "string" ? response.msg : errorMessage;
+        throw new ApiError(errorMsg, statusCode, response.code);
+    }
+    if (!response.data) {
+        throw new ApiError(`Invalid response: ${errorMessage} - missing data`, statusCode);
+    }
+    return response.data;
+}
+// ==================== Attribute Definition Management ====================
+/**
+ * Creates a new user attribute definition.
+ *
+ * @param request - Attribute definition creation request
+ * @param options - Optional configuration
+ * @returns Promise resolving to created attribute definition
+ * @throws {ConfigurationError} When required environment variables are missing
+ * @throws {ApiError} When API request fails
+ * @throws {NetworkError} When network request fails
+ *
+ * @example
+ * ```typescript
+ * const definition = await createUserAttributeDefinition({
+ *   attribute_name: "department",
+ *   description: "User's department",
+ *   schema_definition: { type: "string" },
+ *   is_enabled: true,
+ * });
+ * ```
+ */
+export async function createUserAttributeDefinition(request, options) {
+    const token = options?.appToken ?? (await getAppToken(options));
+    const env = globalThis?.process?.env ?? import.meta?.env ?? undefined;
+    const base = options?.baseUrl ?? env?.TALE_BASE_URL ?? undefined;
+    if (!base) {
+        throw new ConfigurationError("Missing required environment variable: TALE_BASE_URL");
+    }
+    const url = new URL(String(base).replace(/\/+$/, "") + "/user-attribute/v1/definition");
+    let response;
+    try {
+        response = await globalThis.fetch(url.toString(), {
+            method: "POST",
+            headers: {
+                "Content-Type": "application/json",
+                "x-t-token": token,
+            },
+            body: JSON.stringify(request),
+        });
+    }
+    catch (error) {
+        throw new NetworkError(`Failed to create user attribute definition: ${error instanceof Error ? error.message : "Unknown error"}`);
+    }
+    const json = await response.json();
+    return parseApiResponse(json, "Failed to create user attribute definition", response.status);
+}
+/**
+ * Updates an existing user attribute definition.
+ *
+ * @param openId - Attribute definition open ID
+ * @param request - Attribute definition update request
+ * @param options - Optional configuration
+ * @returns Promise resolving to updated attribute definition
+ * @throws {ConfigurationError} When required environment variables are missing
+ * @throws {ApiError} When API request fails
+ * @throws {NetworkError} When network request fails
+ */
+export async function updateUserAttributeDefinition(openId, request, options) {
+    const token = options?.appToken ?? (await getAppToken(options));
+    const env = globalThis?.process?.env ?? import.meta?.env ?? undefined;
+    const base = options?.baseUrl ?? env?.TALE_BASE_URL ?? undefined;
+    if (!base) {
+        throw new ConfigurationError("Missing required environment variable: TALE_BASE_URL");
+    }
+    const url = new URL(String(base).replace(/\/+$/, "") +
+        `/user-attribute/v1/definition/${encodeURIComponent(openId)}`);
+    let response;
+    try {
+        response = await globalThis.fetch(url.toString(), {
+            method: "PUT",
+            headers: {
+                "Content-Type": "application/json",
+                "x-t-token": token,
+            },
+            body: JSON.stringify(request),
+        });
+    }
+    catch (error) {
+        throw new NetworkError(`Failed to update user attribute definition: ${error instanceof Error ? error.message : "Unknown error"}`);
+    }
+    const json = await response.json();
+    return parseApiResponse(json, "Failed to update user attribute definition", response.status);
+}
+/**
+ * Deletes a user attribute definition.
+ *
+ * @param openId - Attribute definition open ID
+ * @param options - Optional configuration
+ * @throws {ConfigurationError} When required environment variables are missing
+ * @throws {ApiError} When API request fails
+ * @throws {NetworkError} When network request fails
+ */
+export async function deleteUserAttributeDefinition(openId, options) {
+    const token = options?.appToken ?? (await getAppToken(options));
+    const env = globalThis?.process?.env ?? import.meta?.env ?? undefined;
+    const base = options?.baseUrl ?? env?.TALE_BASE_URL ?? undefined;
+    if (!base) {
+        throw new ConfigurationError("Missing required environment variable: TALE_BASE_URL");
+    }
+    const url = new URL(String(base).replace(/\/+$/, "") +
+        `/user-attribute/v1/definition/${encodeURIComponent(openId)}`);
+    let response;
+    try {
+        response = await globalThis.fetch(url.toString(), {
+            method: "DELETE",
+            headers: {
+                "Content-Type": "application/json",
+                "x-t-token": token,
+            },
+        });
+    }
+    catch (error) {
+        throw new NetworkError(`Failed to delete user attribute definition: ${error instanceof Error ? error.message : "Unknown error"}`);
+    }
+    const json = await response.json();
+    if (typeof json !== "object" || json === null) {
+        throw new ApiError("Invalid user attribute definition deletion response", response.status);
+    }
+    const apiResponse = json;
+    if (apiResponse.code !== 200) {
+        const errorMsg = typeof apiResponse.msg === "string"
+            ? apiResponse.msg
+            : "Failed to delete user attribute definition";
+        throw new ApiError(errorMsg, response.status, apiResponse.code);
+    }
+}
+/**
+ * Gets a user attribute definition by open ID.
+ *
+ * @param openId - Attribute definition open ID
+ * @param options - Optional configuration
+ * @returns Promise resolving to attribute definition
+ * @throws {ConfigurationError} When required environment variables are missing
+ * @throws {ApiError} When API request fails
+ * @throws {NetworkError} When network request fails
+ */
+export async function getUserAttributeDefinition(openId, options) {
+    const token = options?.appToken ?? (await getAppToken(options));
+    const env = globalThis?.process?.env ?? import.meta?.env ?? undefined;
+    const base = options?.baseUrl ?? env?.TALE_BASE_URL ?? undefined;
+    if (!base) {
+        throw new ConfigurationError("Missing required environment variable: TALE_BASE_URL");
+    }
+    const url = new URL(String(base).replace(/\/+$/, "") +
+        `/user-attribute/v1/definition/${encodeURIComponent(openId)}`);
+    let response;
+    try {
+        response = await globalThis.fetch(url.toString(), {
+            method: "GET",
+            headers: {
+                "Content-Type": "application/json",
+                "x-t-token": token,
+            },
+        });
+    }
+    catch (error) {
+        throw new NetworkError(`Failed to get user attribute definition: ${error instanceof Error ? error.message : "Unknown error"}`);
+    }
+    const json = await response.json();
+    return parseApiResponse(json, "Failed to get user attribute definition", response.status);
+}
+/**
+ * Lists user attribute definitions with pagination and optional filtering.
+ *
+ * @param request - List request parameters
+ * @param options - Optional configuration
+ * @returns Promise resolving to paginated list of attribute definitions
+ * @throws {ConfigurationError} When required environment variables are missing
+ * @throws {ApiError} When API request fails
+ * @throws {NetworkError} When network request fails
+ *
+ * @example
+ * ```typescript
+ * const result = await listUserAttributeDefinitions({
+ *   page: 0,
+ *   size: 20,
+ *   keyword: "department",
+ * });
+ * console.log(result.content); // Array of definitions
+ * console.log(result.total); // Total count
+ * ```
+ */
+export async function listUserAttributeDefinitions(request) {
+    const token = request?.appToken ?? (await getAppToken(request));
+    const env = globalThis?.process?.env ?? import.meta?.env ?? undefined;
+    const base = request?.baseUrl ?? env?.TALE_BASE_URL ?? undefined;
+    if (!base) {
+        throw new ConfigurationError("Missing required environment variable: TALE_BASE_URL");
+    }
+    const url = new URL(String(base).replace(/\/+$/, "") + "/user-attribute/v1/definition");
+    const { appToken, baseUrl, ...requestParams } = request || {};
+    const queryParams = {
+        page: 0,
+        size: 20,
+        sort: "createdAt,desc",
+        ...requestParams,
+    };
+    Object.entries(queryParams).forEach(([key, value]) => {
+        if (value !== undefined) {
+            url.searchParams.append(key, String(value));
+        }
+    });
+    let response;
+    try {
+        response = await globalThis.fetch(url.toString(), {
+            method: "GET",
+            headers: {
+                "Content-Type": "application/json",
+                "x-t-token": token,
+            },
+        });
+    }
+    catch (error) {
+        throw new NetworkError(`Failed to list user attribute definitions: ${error instanceof Error ? error.message : "Unknown error"}`);
+    }
+    const json = await response.json();
+    return parseApiResponse(json, "Failed to list user attribute definitions", response.status);
+}
+/**
+ * Lists all enabled user attribute definitions.
+ *
+ * @param options - Optional configuration
+ * @returns Promise resolving to array of enabled attribute definitions
+ * @throws {ConfigurationError} When required environment variables are missing
+ * @throws {ApiError} When API request fails
+ * @throws {NetworkError} When network request fails
+ */
+export async function listEnabledUserAttributeDefinitions(options) {
+    const token = options?.appToken ?? (await getAppToken(options));
+    const env = globalThis?.process?.env ?? import.meta?.env ?? undefined;
+    const base = options?.baseUrl ?? env?.TALE_BASE_URL ?? undefined;
+    if (!base) {
+        throw new ConfigurationError("Missing required environment variable: TALE_BASE_URL");
+    }
+    const url = new URL(String(base).replace(/\/+$/, "") + "/user-attribute/v1/definition/enabled");
+    let response;
+    try {
+        response = await globalThis.fetch(url.toString(), {
+            method: "GET",
+            headers: {
+                "Content-Type": "application/json",
+                "x-t-token": token,
+            },
+        });
+    }
+    catch (error) {
+        throw new NetworkError(`Failed to list enabled user attribute definitions: ${error instanceof Error ? error.message : "Unknown error"}`);
+    }
+    const json = await response.json();
+    const result = parseApiResponse(json, "Failed to list enabled user attribute definitions", response.status);
+    if (!Array.isArray(result)) {
+        throw new ApiError("Invalid enabled user attribute definitions response: not an array", response.status);
+    }
+    return result;
+}
+/**
+ * Toggles the enabled status of a user attribute definition.
+ *
+ * @param openId - Attribute definition open ID
+ * @param isEnabled - Whether the definition should be enabled
+ * @param options - Optional configuration
+ * @returns Promise resolving to updated attribute definition
+ * @throws {ConfigurationError} When required environment variables are missing
+ * @throws {ApiError} When API request fails
+ * @throws {NetworkError} When network request fails
+ */
+export async function toggleUserAttributeDefinitionStatus(openId, isEnabled, options) {
+    const token = options?.appToken ?? (await getAppToken(options));
+    const env = globalThis?.process?.env ?? import.meta?.env ?? undefined;
+    const base = options?.baseUrl ?? env?.TALE_BASE_URL ?? undefined;
+    if (!base) {
+        throw new ConfigurationError("Missing required environment variable: TALE_BASE_URL");
+    }
+    const url = new URL(String(base).replace(/\/+$/, "") +
+        `/user-attribute/v1/definition/${encodeURIComponent(openId)}/status`);
+    url.searchParams.append("enabled", String(isEnabled));
+    let response;
+    try {
+        response = await globalThis.fetch(url.toString(), {
+            method: "PUT",
+            headers: {
+                "Content-Type": "application/json",
+                "x-t-token": token,
+            },
+        });
+    }
+    catch (error) {
+        throw new NetworkError(`Failed to toggle user attribute definition status: ${error instanceof Error ? error.message : "Unknown error"}`);
+    }
+    const json = await response.json();
+    return parseApiResponse(json, "Failed to toggle user attribute definition status", response.status);
+}
+// ==================== User Attribute Value Management ====================
+/**
+ * Sets a user attribute value.
+ *
+ * @param userId - User ID
+ * @param attributeDefinitionId - Attribute definition ID
+ * @param request - Attribute value to set
+ * @param options - Optional configuration
+ * @returns Promise resolving to updated user attribute
+ * @throws {ConfigurationError} When required environment variables are missing
+ * @throws {ApiError} When API request fails
+ * @throws {NetworkError} When network request fails
+ */
+export async function setUserAttribute(userId, attributeDefinitionId, request, options) {
+    const token = options?.appToken ?? (await getAppToken(options));
+    const env = globalThis?.process?.env ?? import.meta?.env ?? undefined;
+    const base = options?.baseUrl ?? env?.TALE_BASE_URL ?? undefined;
+    if (!base) {
+        throw new ConfigurationError("Missing required environment variable: TALE_BASE_URL");
+    }
+    const url = new URL(String(base).replace(/\/+$/, "") +
+        `/user-attribute/v1/user/${encodeURIComponent(userId)}/attribute/${encodeURIComponent(attributeDefinitionId)}`);
+    let response;
+    try {
+        response = await globalThis.fetch(url.toString(), {
+            method: "PUT",
+            headers: {
+                "Content-Type": "application/json",
+                "x-t-token": token,
+            },
+            body: JSON.stringify(request),
+        });
+    }
+    catch (error) {
+        throw new NetworkError(`Failed to set user attribute: ${error instanceof Error ? error.message : "Unknown error"}`);
+    }
+    const json = await response.json();
+    return parseApiResponse(json, "Failed to set user attribute", response.status);
+}
+/**
+ * Gets a user attribute value.
+ *
+ * @param userId - User ID
+ * @param attributeDefinitionId - Attribute definition ID
+ * @param options - Optional configuration
+ * @returns Promise resolving to user attribute
+ * @throws {ConfigurationError} When required environment variables are missing
+ * @throws {ApiError} When API request fails
+ * @throws {NetworkError} When network request fails
+ */
+export async function getUserAttribute(userId, attributeDefinitionId, options) {
+    const token = options?.appToken ?? (await getAppToken(options));
+    const env = globalThis?.process?.env ?? import.meta?.env ?? undefined;
+    const base = options?.baseUrl ?? env?.TALE_BASE_URL ?? undefined;
+    if (!base) {
+        throw new ConfigurationError("Missing required environment variable: TALE_BASE_URL");
+    }
+    const url = new URL(String(base).replace(/\/+$/, "") +
+        `/user-attribute/v1/user/${encodeURIComponent(userId)}/attribute/${encodeURIComponent(attributeDefinitionId)}`);
+    let response;
+    try {
+        response = await globalThis.fetch(url.toString(), {
+            method: "GET",
+            headers: {
+                "Content-Type": "application/json",
+                "x-t-token": token,
+            },
+        });
+    }
+    catch (error) {
+        throw new NetworkError(`Failed to get user attribute: ${error instanceof Error ? error.message : "Unknown error"}`);
+    }
+    const json = await response.json();
+    return parseApiResponse(json, "Failed to get user attribute", response.status);
+}
+/**
+ * Deletes a user attribute value.
+ *
+ * @param userId - User ID
+ * @param attributeDefinitionId - Attribute definition ID
+ * @param options - Optional configuration
+ * @throws {ConfigurationError} When required environment variables are missing
+ * @throws {ApiError} When API request fails
+ * @throws {NetworkError} When network request fails
+ */
+export async function deleteUserAttribute(userId, attributeDefinitionId, options) {
+    const token = options?.appToken ?? (await getAppToken(options));
+    const env = globalThis?.process?.env ?? import.meta?.env ?? undefined;
+    const base = options?.baseUrl ?? env?.TALE_BASE_URL ?? undefined;
+    if (!base) {
+        throw new ConfigurationError("Missing required environment variable: TALE_BASE_URL");
+    }
+    const url = new URL(String(base).replace(/\/+$/, "") +
+        `/user-attribute/v1/user/${encodeURIComponent(userId)}/attribute/${encodeURIComponent(attributeDefinitionId)}`);
+    let response;
+    try {
+        response = await globalThis.fetch(url.toString(), {
+            method: "DELETE",
+            headers: {
+                "Content-Type": "application/json",
+                "x-t-token": token,
+            },
+        });
+    }
+    catch (error) {
+        throw new NetworkError(`Failed to delete user attribute: ${error instanceof Error ? error.message : "Unknown error"}`);
+    }
+    const json = await response.json();
+    if (typeof json !== "object" || json === null) {
+        throw new ApiError("Invalid user attribute deletion response", response.status);
+    }
+    const apiResponse = json;
+    if (apiResponse.code !== 200) {
+        const errorMsg = typeof apiResponse.msg === "string"
+            ? apiResponse.msg
+            : "Failed to delete user attribute";
+        throw new ApiError(errorMsg, response.status, apiResponse.code);
+    }
+}
+/**
+ * Gets all attributes for a specific user.
+ *
+ * @param userId - User ID
+ * @param options - Optional configuration
+ * @returns Promise resolving to array of user attributes
+ * @throws {ConfigurationError} When required environment variables are missing
+ * @throws {ApiError} When API request fails
+ * @throws {NetworkError} When network request fails
+ */
+export async function getUserAttributes(userId, options) {
+    const token = options?.appToken ?? (await getAppToken(options));
+    const env = globalThis?.process?.env ?? import.meta?.env ?? undefined;
+    const base = options?.baseUrl ?? env?.TALE_BASE_URL ?? undefined;
+    if (!base) {
+        throw new ConfigurationError("Missing required environment variable: TALE_BASE_URL");
+    }
+    const url = new URL(String(base).replace(/\/+$/, "") +
+        `/user-attribute/v1/user/${encodeURIComponent(userId)}/attribute`);
+    let response;
+    try {
+        response = await globalThis.fetch(url.toString(), {
+            method: "GET",
+            headers: {
+                "Content-Type": "application/json",
+                "x-t-token": token,
+            },
+        });
+    }
+    catch (error) {
+        throw new NetworkError(`Failed to get user attributes: ${error instanceof Error ? error.message : "Unknown error"}`);
+    }
+    const json = await response.json();
+    const result = parseApiResponse(json, "Failed to get user attributes", response.status);
+    if (!Array.isArray(result)) {
+        throw new ApiError("Invalid user attributes response: not an array", response.status);
+    }
+    return result;
+}
+/**
+ * Lists user attributes with pagination.
+ *
+ * @param userId - User ID
+ * @param request - List request parameters
+ * @param options - Optional configuration
+ * @returns Promise resolving to paginated list of user attributes
+ * @throws {ConfigurationError} When required environment variables are missing
+ * @throws {ApiError} When API request fails
+ * @throws {NetworkError} When network request fails
+ */
+export async function listUserAttributes(userId, request) {
+    const token = request?.appToken ?? (await getAppToken(request));
+    const env = globalThis?.process?.env ?? import.meta?.env ?? undefined;
+    const base = request?.baseUrl ?? env?.TALE_BASE_URL ?? undefined;
+    if (!base) {
+        throw new ConfigurationError("Missing required environment variable: TALE_BASE_URL");
+    }
+    const url = new URL(String(base).replace(/\/+$/, "") +
+        `/user-attribute/v1/user/${encodeURIComponent(userId)}/attribute/page`);
+    const { appToken, baseUrl, ...requestParams } = request || {};
+    const queryParams = {
+        page: 0,
+        size: 20,
+        sort: "createdAt,desc",
+        ...requestParams,
+    };
+    Object.entries(queryParams).forEach(([key, value]) => {
+        if (value !== undefined) {
+            url.searchParams.append(key, String(value));
+        }
+    });
+    let response;
+    try {
+        response = await globalThis.fetch(url.toString(), {
+            method: "GET",
+            headers: {
+                "Content-Type": "application/json",
+                "x-t-token": token,
+            },
+        });
+    }
+    catch (error) {
+        throw new NetworkError(`Failed to list user attributes: ${error instanceof Error ? error.message : "Unknown error"}`);
+    }
+    const json = await response.json();
+    return parseApiResponse(json, "Failed to list user attributes", response.status);
+}
+/**
+ * Lists all users who have a specific attribute.
+ *
+ * @param attributeDefinitionId - Attribute definition ID
+ * @param request - List request parameters
+ * @param options - Optional configuration
+ * @returns Promise resolving to paginated list of user attributes
+ * @throws {ConfigurationError} When required environment variables are missing
+ * @throws {ApiError} When API request fails
+ * @throws {NetworkError} When network request fails
+ */
+export async function listAttributeUsers(attributeDefinitionId, request) {
+    const token = request?.appToken ?? (await getAppToken(request));
+    const env = globalThis?.process?.env ?? import.meta?.env ?? undefined;
+    const base = request?.baseUrl ?? env?.TALE_BASE_URL ?? undefined;
+    if (!base) {
+        throw new ConfigurationError("Missing required environment variable: TALE_BASE_URL");
+    }
+    const url = new URL(String(base).replace(/\/+$/, "") +
+        `/user-attribute/v1/definition/${encodeURIComponent(attributeDefinitionId)}/users`);
+    const { appToken, baseUrl, ...requestParams } = request || {};
+    const queryParams = {
+        page: 0,
+        size: 20,
+        ...requestParams,
+    };
+    Object.entries(queryParams).forEach(([key, value]) => {
+        if (value !== undefined) {
+            url.searchParams.append(key, String(value));
+        }
+    });
+    let response;
+    try {
+        response = await globalThis.fetch(url.toString(), {
+            method: "GET",
+            headers: {
+                "Content-Type": "application/json",
+                "x-t-token": token,
+            },
+        });
+    }
+    catch (error) {
+        throw new NetworkError(`Failed to list attribute users: ${error instanceof Error ? error.message : "Unknown error"}`);
+    }
+    const json = await response.json();
+    const data = parseApiResponse(json, "Failed to list attribute users", response.status);
+    if (!Array.isArray(data.content)) {
+        throw new ApiError("Invalid attribute users response: content is not an array", response.status);
+    }
+    return data;
+}
+/**
+ * Lists all user attributes grouped by user with pagination.
+ *
+ * @param request - List request parameters
+ * @param options - Optional configuration
+ * @returns Promise resolving to paginated list of grouped user attributes
+ * @throws {ConfigurationError} When required environment variables are missing
+ * @throws {ApiError} When API request fails
+ * @throws {NetworkError} When network request fails
+ */
+export async function listAllUserAttributes(request) {
+    const token = request?.appToken ?? (await getAppToken(request));
+    const env = globalThis?.process?.env ?? import.meta?.env ?? undefined;
+    const base = request?.baseUrl ?? env?.TALE_BASE_URL ?? undefined;
+    if (!base) {
+        throw new ConfigurationError("Missing required environment variable: TALE_BASE_URL");
+    }
+    const url = new URL(String(base).replace(/\/+$/, "") + "/user-attribute/v1/user/attribute/page");
+    const { appToken, baseUrl, ...requestParams } = request || {};
+    const queryParams = {
+        page: 0,
+        size: 20,
+        sort: "registeredAt,desc",
+        ...requestParams,
+    };
+    Object.entries(queryParams).forEach(([key, value]) => {
+        if (value !== undefined) {
+            url.searchParams.append(key, String(value));
+        }
+    });
+    let response;
+    try {
+        response = await globalThis.fetch(url.toString(), {
+            method: "GET",
+            headers: {
+                "Content-Type": "application/json",
+                "x-t-token": token,
+            },
+        });
+    }
+    catch (error) {
+        throw new NetworkError(`Failed to list all user attributes: ${error instanceof Error ? error.message : "Unknown error"}`);
+    }
+    const json = await response.json();
+    return parseApiResponse(json, "Failed to list all user attributes", response.status);
+}