@simpleapps-com/augur-api 2026.4.5 → 2026.4.6

package/dist/index.d.mts

@@ -0,0 +1,178 @@
+import { A as AugurAPI } from './client-H1o7nRhe.mjs';
+export { a as AgrInfoClient, b as AgrSiteClient, c as AgrWorkClient, d as AugurAPIConfig, e as AugurContext, f as AugurRequestConfig, g as AugurRequestError, h as AugurResponse, i as AvalaraClient, B as BaseResponse, j as BaseResponseSchema, k as Basecamp2Client, l as BrandFolderClient, C as CommerceClient, m as ContextCreationError, n as CustomersClient, D as DiscoveryEndpoint, E as EndpointSearchResult, G as GregorovichClient, H as HealthCheckData, o as HealthCheckDataSchema, I as ItemsClient, J as JoomlaClient, L as LegacyClient, p as LogisticsClient, N as NexusClient, O as OpenSearchClient, q as OrdersClient, P as P21ApisClient, r as P21CoreClient, s as P21PimClient, t as P21SismClient, u as PaginationParamsSchema, v as PaymentsClient, w as PricingClient, R as RequestConfig, S as ServiceMap, x as ShippingClient, y as SlackClient, z as SmartyStreetsClient, U as UPSClient, V as VMIClient } from './client-H1o7nRhe.mjs';
+import 'valibot';
+
+/**
+ * Cross-site authentication utility
+ * @description Streamlined utility for authenticating users across different Augur sites
+ * using augur_info privileges
+ */
+/**
+ * Parameters for cross-site authentication
+ */
+interface CrossSiteAuthParams {
+    /** Target site ID to authenticate against */
+    targetSiteId: string;
+    /** Username or email */
+    username: string;
+    /** User password */
+    password: string;
+    /** JWT token with augur_info admin privileges */
+    augurInfoToken: string;
+}
+/**
+ * Result of cross-site authentication
+ */
+interface CrossSiteAuthResult {
+    /** Whether authentication was successful */
+    success: boolean;
+    /** User ID if authentication succeeded */
+    userId?: string;
+    /** Username if authentication succeeded */
+    username?: string;
+    /** Email if authentication succeeded */
+    email?: string;
+    /** JWT token scoped to target site if authentication succeeded */
+    token?: string;
+    /** Target site ID */
+    targetSiteId: string;
+    /** Error message if authentication failed */
+    error?: string;
+    /** API client configured for target site (only if authentication succeeded) */
+    targetSiteAPI?: AugurAPI;
+}
+/**
+ * Authenticate a user against a target site using augur_info privileges
+ * @description This utility function simplifies cross-site authentication by:
+ * 1. Creating an augur_info API client with admin privileges
+ * 2. Using verifyPassword with the target siteId in the request body
+ * 3. Returning a ready-to-use API client for the target site on success
+ *
+ * @param params Cross-site authentication parameters
+ * @returns Promise resolving to authentication result with optional target site API client
+ *
+ * @example
+ * ```typescript
+ * const result = await authenticateUserForSite({
+ *   targetSiteId: 'tenant_site_1',
+ *   username: 'user@tenant.com',
+ *   password: 'userpassword',
+ *   augurInfoToken: 'admin-jwt-token'
+ * });
+ *
+ * if (result.success) {
+ *   // Use the pre-configured API client
+ *   const userData = await result.targetSiteAPI!.joomla.users.get(result.userId!);
+ *   console.log('User data:', userData);
+ * } else {
+ *   console.error('Authentication failed:', result.error);
+ * }
+ * ```
+ */
+declare function authenticateUserForSite(params: CrossSiteAuthParams): Promise<CrossSiteAuthResult>;
+/**
+ * Create a cross-site authentication function bound to specific augur_info credentials
+ * @description Factory function for creating a reusable cross-site authenticator
+ *
+ * @param augurInfoToken JWT token with augur_info admin privileges
+ * @returns Function that can authenticate users for any target site
+ *
+ * @example
+ * ```typescript
+ * // Create reusable authenticator
+ * const crossSiteAuth = createCrossSiteAuthenticator('admin-jwt-token');
+ *
+ * // Use it for multiple sites
+ * const result1 = await crossSiteAuth('tenant_site_1', 'user1@tenant.com', 'pass1');
+ * const result2 = await crossSiteAuth('tenant_site_2', 'user2@tenant.com', 'pass2');
+ * ```
+ */
+declare function createCrossSiteAuthenticator(augurInfoToken: string): (targetSiteId: string, username: string, password: string) => Promise<CrossSiteAuthResult>;
+
+/** Validation issue — compatible with both Zod and Valibot error formats */
+interface ValidationIssue {
+    path: (string | number)[];
+    message: string;
+    code: string;
+    received?: unknown;
+    expected?: unknown;
+}
+interface AugurAPIError extends Error {
+    code: string;
+    statusCode: number;
+    service: string;
+    endpoint: string;
+    requestId?: string;
+    validationErrors?: ValidationIssue[];
+}
+declare class AugurError extends Error implements AugurAPIError {
+    code: string;
+    statusCode: number;
+    service: string;
+    endpoint: string;
+    requestId?: string;
+    validationErrors?: ValidationIssue[];
+    constructor(params: {
+        message: string;
+        code: string;
+        statusCode: number;
+        service: string;
+        endpoint: string;
+        requestId?: string;
+        validationErrors?: ValidationIssue[];
+    });
+}
+declare class ValidationError extends AugurError {
+    constructor(params: {
+        message: string;
+        service: string;
+        endpoint: string;
+        validationErrors: ValidationIssue[];
+    });
+    /**
+     * Format validation errors into human-readable messages
+     * @returns Array of formatted error messages
+     */
+    getFormattedErrors(): string[];
+    /**
+     * Get detailed validation error information for debugging
+     * @returns Object with detailed error information
+     */
+    getDetailedErrors(): Array<{
+        path: string;
+        message: string;
+        code: string;
+        received?: unknown;
+        expected?: unknown;
+    }>;
+    /**
+     * Override toString to include formatted validation errors
+     * @returns String representation with validation details
+     */
+    toString(): string;
+}
+declare class AuthenticationError extends AugurError {
+    constructor(params: {
+        message: string;
+        service: string;
+        endpoint: string;
+    });
+}
+declare class NotFoundError extends AugurError {
+    constructor(params: {
+        message: string;
+        service: string;
+        endpoint: string;
+    });
+}
+declare class RateLimitError extends AugurError {
+    constructor(params: {
+        message: string;
+        service: string;
+        endpoint: string;
+    });
+}
+
+declare const VERSION = "2026.4.6";
+
+export { AugurAPI, type AugurAPIError, AugurError, AuthenticationError, type CrossSiteAuthParams, type CrossSiteAuthResult, NotFoundError, RateLimitError, VERSION, ValidationError, authenticateUserForSite, createCrossSiteAuthenticator };

package/dist/index.d.ts

@@ -0,0 +1,178 @@
+import { A as AugurAPI } from './client-H1o7nRhe.js';
+export { a as AgrInfoClient, b as AgrSiteClient, c as AgrWorkClient, d as AugurAPIConfig, e as AugurContext, f as AugurRequestConfig, g as AugurRequestError, h as AugurResponse, i as AvalaraClient, B as BaseResponse, j as BaseResponseSchema, k as Basecamp2Client, l as BrandFolderClient, C as CommerceClient, m as ContextCreationError, n as CustomersClient, D as DiscoveryEndpoint, E as EndpointSearchResult, G as GregorovichClient, H as HealthCheckData, o as HealthCheckDataSchema, I as ItemsClient, J as JoomlaClient, L as LegacyClient, p as LogisticsClient, N as NexusClient, O as OpenSearchClient, q as OrdersClient, P as P21ApisClient, r as P21CoreClient, s as P21PimClient, t as P21SismClient, u as PaginationParamsSchema, v as PaymentsClient, w as PricingClient, R as RequestConfig, S as ServiceMap, x as ShippingClient, y as SlackClient, z as SmartyStreetsClient, U as UPSClient, V as VMIClient } from './client-H1o7nRhe.js';
+import 'valibot';
+
+/**
+ * Cross-site authentication utility
+ * @description Streamlined utility for authenticating users across different Augur sites
+ * using augur_info privileges
+ */
+/**
+ * Parameters for cross-site authentication
+ */
+interface CrossSiteAuthParams {
+    /** Target site ID to authenticate against */
+    targetSiteId: string;
+    /** Username or email */
+    username: string;
+    /** User password */
+    password: string;
+    /** JWT token with augur_info admin privileges */
+    augurInfoToken: string;
+}
+/**
+ * Result of cross-site authentication
+ */
+interface CrossSiteAuthResult {
+    /** Whether authentication was successful */
+    success: boolean;
+    /** User ID if authentication succeeded */
+    userId?: string;
+    /** Username if authentication succeeded */
+    username?: string;
+    /** Email if authentication succeeded */
+    email?: string;
+    /** JWT token scoped to target site if authentication succeeded */
+    token?: string;
+    /** Target site ID */
+    targetSiteId: string;
+    /** Error message if authentication failed */
+    error?: string;
+    /** API client configured for target site (only if authentication succeeded) */
+    targetSiteAPI?: AugurAPI;
+}
+/**
+ * Authenticate a user against a target site using augur_info privileges
+ * @description This utility function simplifies cross-site authentication by:
+ * 1. Creating an augur_info API client with admin privileges
+ * 2. Using verifyPassword with the target siteId in the request body
+ * 3. Returning a ready-to-use API client for the target site on success
+ *
+ * @param params Cross-site authentication parameters
+ * @returns Promise resolving to authentication result with optional target site API client
+ *
+ * @example
+ * ```typescript
+ * const result = await authenticateUserForSite({
+ *   targetSiteId: 'tenant_site_1',
+ *   username: 'user@tenant.com',
+ *   password: 'userpassword',
+ *   augurInfoToken: 'admin-jwt-token'
+ * });
+ *
+ * if (result.success) {
+ *   // Use the pre-configured API client
+ *   const userData = await result.targetSiteAPI!.joomla.users.get(result.userId!);
+ *   console.log('User data:', userData);
+ * } else {
+ *   console.error('Authentication failed:', result.error);
+ * }
+ * ```
+ */
+declare function authenticateUserForSite(params: CrossSiteAuthParams): Promise<CrossSiteAuthResult>;
+/**
+ * Create a cross-site authentication function bound to specific augur_info credentials
+ * @description Factory function for creating a reusable cross-site authenticator
+ *
+ * @param augurInfoToken JWT token with augur_info admin privileges
+ * @returns Function that can authenticate users for any target site
+ *
+ * @example
+ * ```typescript
+ * // Create reusable authenticator
+ * const crossSiteAuth = createCrossSiteAuthenticator('admin-jwt-token');
+ *
+ * // Use it for multiple sites
+ * const result1 = await crossSiteAuth('tenant_site_1', 'user1@tenant.com', 'pass1');
+ * const result2 = await crossSiteAuth('tenant_site_2', 'user2@tenant.com', 'pass2');
+ * ```
+ */
+declare function createCrossSiteAuthenticator(augurInfoToken: string): (targetSiteId: string, username: string, password: string) => Promise<CrossSiteAuthResult>;
+
+/** Validation issue — compatible with both Zod and Valibot error formats */
+interface ValidationIssue {
+    path: (string | number)[];
+    message: string;
+    code: string;
+    received?: unknown;
+    expected?: unknown;
+}
+interface AugurAPIError extends Error {
+    code: string;
+    statusCode: number;
+    service: string;
+    endpoint: string;
+    requestId?: string;
+    validationErrors?: ValidationIssue[];
+}
+declare class AugurError extends Error implements AugurAPIError {
+    code: string;
+    statusCode: number;
+    service: string;
+    endpoint: string;
+    requestId?: string;
+    validationErrors?: ValidationIssue[];
+    constructor(params: {
+        message: string;
+        code: string;
+        statusCode: number;
+        service: string;
+        endpoint: string;
+        requestId?: string;
+        validationErrors?: ValidationIssue[];
+    });
+}
+declare class ValidationError extends AugurError {
+    constructor(params: {
+        message: string;
+        service: string;
+        endpoint: string;
+        validationErrors: ValidationIssue[];
+    });
+    /**
+     * Format validation errors into human-readable messages
+     * @returns Array of formatted error messages
+     */
+    getFormattedErrors(): string[];
+    /**
+     * Get detailed validation error information for debugging
+     * @returns Object with detailed error information
+     */
+    getDetailedErrors(): Array<{
+        path: string;
+        message: string;
+        code: string;
+        received?: unknown;
+        expected?: unknown;
+    }>;
+    /**
+     * Override toString to include formatted validation errors
+     * @returns String representation with validation details
+     */
+    toString(): string;
+}
+declare class AuthenticationError extends AugurError {
+    constructor(params: {
+        message: string;
+        service: string;
+        endpoint: string;
+    });
+}
+declare class NotFoundError extends AugurError {
+    constructor(params: {
+        message: string;
+        service: string;
+        endpoint: string;
+    });
+}
+declare class RateLimitError extends AugurError {
+    constructor(params: {
+        message: string;
+        service: string;
+        endpoint: string;
+    });
+}
+
+declare const VERSION = "2026.4.6";
+
+export { AugurAPI, type AugurAPIError, AugurError, AuthenticationError, type CrossSiteAuthParams, type CrossSiteAuthResult, NotFoundError, RateLimitError, VERSION, ValidationError, authenticateUserForSite, createCrossSiteAuthenticator };