@turinhub/tale-js-sdk 1.3.0

package/dist/errors.d.ts

@@ -0,0 +1,52 @@
+/**
+ * Unified error classes for the Tale SDK
+ *
+ * This module provides a consistent error handling approach across the entire SDK.
+ * All custom errors extend from TaleSdkError for proper error classification and handling.
+ */
+export declare class TaleSdkError extends Error {
+    readonly code?: string | undefined;
+    readonly statusCode?: number | undefined;
+    constructor(message: string, code?: string | undefined, statusCode?: number | undefined);
+    /**
+     * Check if this error matches a specific error code
+     */
+    hasCode(code: string): boolean;
+    /**
+     * Get a user-friendly error message
+     */
+    getUserMessage(): string;
+}
+export declare class ConfigurationError extends TaleSdkError {
+    constructor(message: string);
+    getUserMessage(): string;
+}
+export declare class ApiError extends TaleSdkError {
+    constructor(message: string, statusCode?: number, apiCode?: string | number);
+    getUserMessage(): string;
+}
+export declare class EnvironmentError extends TaleSdkError {
+    constructor(message: string);
+    getUserMessage(): string;
+}
+export declare class TokenError extends TaleSdkError {
+    constructor(message: string, code?: string);
+    getUserMessage(): string;
+}
+export declare class NetworkError extends TaleSdkError {
+    constructor(message: string);
+    getUserMessage(): string;
+}
+export declare class ValidationError extends TaleSdkError {
+    constructor(message: string, field?: string);
+    readonly field?: string;
+    getUserMessage(): string;
+}
+/**
+ * Utility function to check if an error is a TaleSdkError
+ */
+export declare function isTaleSdkError(error: unknown): error is TaleSdkError;
+/**
+ * Utility function to create an appropriate error from unknown errors
+ */
+export declare function createErrorFromUnknown(error: unknown, defaultMessage?: string): TaleSdkError;

package/dist/errors.js

@@ -0,0 +1,109 @@
+/**
+ * Unified error classes for the Tale SDK
+ *
+ * This module provides a consistent error handling approach across the entire SDK.
+ * All custom errors extend from TaleSdkError for proper error classification and handling.
+ */
+export class TaleSdkError extends Error {
+    constructor(message, code, statusCode) {
+        super(message);
+        this.code = code;
+        this.statusCode = statusCode;
+        this.name = this.constructor.name;
+        // Maintains proper stack trace for where our error was thrown (only available on V8)
+        if (typeof Error.captureStackTrace === "function") {
+            Error.captureStackTrace(this, this.constructor);
+        }
+    }
+    /**
+     * Check if this error matches a specific error code
+     */
+    hasCode(code) {
+        return this.code === code;
+    }
+    /**
+     * Get a user-friendly error message
+     */
+    getUserMessage() {
+        return this.message;
+    }
+}
+export class ConfigurationError extends TaleSdkError {
+    constructor(message) {
+        super(message, "CONFIGURATION_ERROR");
+        this.name = "ConfigurationError";
+    }
+    getUserMessage() {
+        return `Configuration error: ${this.message}`;
+    }
+}
+export class ApiError extends TaleSdkError {
+    constructor(message, statusCode, apiCode) {
+        const code = apiCode ? `API_ERROR_${apiCode}` : "API_ERROR";
+        super(message, code, statusCode);
+        this.name = "ApiError";
+    }
+    getUserMessage() {
+        return `API request failed: ${this.message}`;
+    }
+}
+export class EnvironmentError extends TaleSdkError {
+    constructor(message) {
+        super(message, "ENVIRONMENT_ERROR");
+        this.name = "EnvironmentError";
+    }
+    getUserMessage() {
+        return `Environment error: ${this.message}`;
+    }
+}
+export class TokenError extends TaleSdkError {
+    constructor(message, code) {
+        super(message, code || "TOKEN_ERROR");
+        this.name = "TokenError";
+    }
+    getUserMessage() {
+        return `Token error: ${this.message}`;
+    }
+}
+export class NetworkError extends TaleSdkError {
+    constructor(message) {
+        super(message, "NETWORK_ERROR");
+        this.name = "NetworkError";
+    }
+    getUserMessage() {
+        return `Network error: ${this.message}`;
+    }
+}
+export class ValidationError extends TaleSdkError {
+    constructor(message, field) {
+        super(message, "VALIDATION_ERROR");
+        this.name = "ValidationError";
+        this.field = field;
+    }
+    getUserMessage() {
+        return this.field
+            ? `Validation error for '${this.field}': ${this.message}`
+            : `Validation error: ${this.message}`;
+    }
+}
+/**
+ * Utility function to check if an error is a TaleSdkError
+ */
+export function isTaleSdkError(error) {
+    return error instanceof TaleSdkError;
+}
+/**
+ * Utility function to create an appropriate error from unknown errors
+ */
+export function createErrorFromUnknown(error, defaultMessage = "Unknown error occurred") {
+    if (isTaleSdkError(error)) {
+        return error;
+    }
+    if (error instanceof Error) {
+        return new TaleSdkError(error.message, "UNKNOWN_ERROR");
+    }
+    if (typeof error === "string") {
+        return new TaleSdkError(error, "UNKNOWN_ERROR");
+    }
+    return new TaleSdkError(defaultMessage, "UNKNOWN_ERROR");
+}

package/dist/index.d.ts

@@ -0,0 +1,13 @@
+export * from "./status.js";
+export * from "./token.js";
+export * from "./user/index.js";
+export * from "./auth/index.js";
+export * from "./user-group/index.js";
+export * from "./rbac/index.js";
+export * from "./acl/index.js";
+export * from "./user-attribute/index.js";
+export * from "./task-type/index.js";
+export * from "./task/index.js";
+export * from "./cms/index.js";
+export * from "./errors.js";
+export type { CommonOptions, PageResponse, UserGroup, Role, Privilege, AppInfo, User, Attachment, } from "./common/types.js";

package/dist/index.js

@@ -0,0 +1,12 @@
+export * from "./status.js";
+export * from "./token.js";
+export * from "./user/index.js";
+export * from "./auth/index.js";
+export * from "./user-group/index.js";
+export * from "./rbac/index.js";
+export * from "./acl/index.js";
+export * from "./user-attribute/index.js";
+export * from "./task-type/index.js";
+export * from "./task/index.js";
+export * from "./cms/index.js";
+export * from "./errors.js";

package/dist/rbac/acl.d.ts

@@ -0,0 +1,152 @@
+import type { AclRecord, CreateAclRecordRequest, UpdateAclRecordRequest, ListAclRecordsRequest, CreateAclRecordResponse, UpdateAclRecordResponse, DeleteAclRecordResponse, GetAclRecordResponse, AclTemplate, CreateAclTemplateRequest, UpdateAclTemplateRequest, ListAclTemplatesRequest, CreateAclTemplateResponse, UpdateAclTemplateResponse, DeleteAclTemplateResponse, GetAclTemplateResponse, PaginatedResponse, AclOptions } from './types.js';
+/**
+ * Creates a new ACL record in the Tale application.
+ *
+ * @param recordData - ACL record data to create
+ * @param options - Optional configuration for the request
+ * @returns Promise resolving to the created ACL record information
+ * @throws {ConfigurationError} When required environment variables are missing
+ * @throws {ApiError} When API request fails or returns invalid response
+ * @throws {NetworkError} When network request fails
+ *
+ * @example
+ * ```typescript
+ * import { acl } from '@tale/client';
+ *
+ * try {
+ *   const result = await acl.createRecord({
+ *     template_id: 'template_user_read',
+ *     subject_type: 'user',
+ *     subject_id: 'user_123',
+ *     resource_type: 'document',
+ *     resource_id: 'doc_456',
+ *     effect_type: 'allow',
+ *     priority: 50,
+ *     description: 'Allow user to read document'
+ *   });
+ *   console.log('ACL record created:', result.record.record_id);
+ * } catch (error) {
+ *   console.error('Failed to create ACL record:', error.message);
+ * }
+ * ```
+ */
+export declare function createRecord(recordData: CreateAclRecordRequest, options?: AclOptions): Promise<CreateAclRecordResponse>;
+/**
+ * Updates an existing ACL record by ID.
+ *
+ * @param recordId - ACL record ID to update
+ * @param updateData - ACL record information to update
+ * @param options - Optional configuration for the request
+ * @returns Promise resolving to the updated ACL record information
+ * @throws {ConfigurationError} When required environment variables are missing
+ * @throws {ApiError} When API request fails or returns invalid response
+ * @throws {NetworkError} When network request fails
+ */
+export declare function updateRecord(recordId: string, updateData: UpdateAclRecordRequest, options?: AclOptions): Promise<UpdateAclRecordResponse>;
+/**
+ * Deletes an ACL record by ID.
+ *
+ * @param recordId - ACL record ID to delete
+ * @param options - Optional configuration for the request
+ * @returns Promise resolving to the deletion result
+ * @throws {ConfigurationError} When required environment variables are missing
+ * @throws {ApiError} When API request fails or returns invalid response
+ * @throws {NetworkError} When network request fails
+ */
+export declare function deleteRecord(recordId: string, options?: AclOptions): Promise<DeleteAclRecordResponse>;
+/**
+ * Retrieves ACL record information by ID.
+ *
+ * @param recordId - ACL record ID to query
+ * @param options - Optional configuration for the request
+ * @returns Promise resolving to the ACL record information
+ * @throws {ConfigurationError} When required environment variables are missing
+ * @throws {ApiError} When API request fails or returns invalid response
+ * @throws {NetworkError} When network request fails
+ */
+export declare function getRecordById(recordId: string, options?: AclOptions): Promise<GetAclRecordResponse>;
+/**
+ * Lists ACL records with pagination and filtering.
+ *
+ * @param options - Optional parameters for pagination, filtering, and configuration
+ * @returns Promise resolving to paginated ACL record list with metadata
+ * @throws {ConfigurationError} When required environment variables are missing
+ * @throws {ApiError} When API request fails or returns invalid response
+ * @throws {NetworkError} When network request fails
+ */
+export declare function listRecords(options?: ListAclRecordsRequest & AclOptions): Promise<PaginatedResponse<AclRecord>>;
+/**
+ * Creates a new ACL template in the Tale application.
+ *
+ * @param templateData - ACL template data to create
+ * @param options - Optional configuration for the request
+ * @returns Promise resolving to the created ACL template information
+ * @throws {ConfigurationError} When required environment variables are missing
+ * @throws {ApiError} When API request fails or returns invalid response
+ * @throws {NetworkError} When network request fails
+ *
+ * @example
+ * ```typescript
+ * import { acl } from '@tale/client';
+ *
+ * try {
+ *   const result = await acl.createTemplate({
+ *     template_name: 'User Document Read Template',
+ *     template_code: 'user_doc_read',
+ *     subject_type: 'user',
+ *     resource_type: 'document',
+ *     effect_type: 'allow',
+ *     default_priority: 30,
+ *     description: 'Template for allowing users to read documents'
+ *   });
+ *   console.log('ACL template created:', result.template.template_id);
+ * } catch (error) {
+ *   console.error('Failed to create ACL template:', error.message);
+ * }
+ * ```
+ */
+export declare function createTemplate(templateData: CreateAclTemplateRequest, options?: AclOptions): Promise<CreateAclTemplateResponse>;
+/**
+ * Updates an existing ACL template by ID.
+ *
+ * @param templateId - ACL template ID or code to update
+ * @param updateData - ACL template information to update
+ * @param options - Optional configuration for the request
+ * @returns Promise resolving to the updated ACL template information
+ * @throws {ConfigurationError} When required environment variables are missing
+ * @throws {ApiError} When API request fails or returns invalid response
+ * @throws {NetworkError} When network request fails
+ */
+export declare function updateTemplate(templateId: string, updateData: UpdateAclTemplateRequest, options?: AclOptions): Promise<UpdateAclTemplateResponse>;
+/**
+ * Deletes an ACL template by ID.
+ *
+ * @param templateId - ACL template ID or code to delete
+ * @param options - Optional configuration for the request
+ * @returns Promise resolving to the deletion result
+ * @throws {ConfigurationError} When required environment variables are missing
+ * @throws {ApiError} When API request fails or returns invalid response
+ * @throws {NetworkError} When network request fails
+ */
+export declare function deleteTemplate(templateId: string, options?: AclOptions): Promise<DeleteAclTemplateResponse>;
+/**
+ * Retrieves ACL template information by ID or code.
+ *
+ * @param templateId - ACL template ID or code to query
+ * @param options - Optional configuration for the request
+ * @returns Promise resolving to the ACL template information
+ * @throws {ConfigurationError} When required environment variables are missing
+ * @throws {ApiError} When API request fails or returns invalid response
+ * @throws {NetworkError} When network request fails
+ */
+export declare function getTemplateById(templateId: string, options?: AclOptions): Promise<GetAclTemplateResponse>;
+/**
+ * Lists ACL templates with pagination and filtering.
+ *
+ * @param options - Optional parameters for pagination, filtering, and configuration
+ * @returns Promise resolving to paginated ACL template list with metadata
+ * @throws {ConfigurationError} When required environment variables are missing
+ * @throws {ApiError} When API request fails or returns invalid response
+ * @throws {NetworkError} When network request fails
+ */
+export declare function listTemplates(options?: ListAclTemplatesRequest & AclOptions): Promise<PaginatedResponse<AclTemplate>>;