@simpleapps-com/augur-api 0.1.4 → 0.1.5

package/dist/types/utils/cross-site-auth.d.ts

@@ -0,0 +1,88 @@
+import { AugurAPI } from '../client';
+/**
+ * Cross-site authentication utility
+ * @description Streamlined utility for authenticating users across different Augur sites
+ * using augur_info privileges
+ */
+/**
+ * Parameters for cross-site authentication
+ */
+export 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
+ */
+export 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);
+ * }
+ * ```
+ */
+export 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');
+ * ```
+ */
+export declare function createCrossSiteAuthenticator(augurInfoToken: string): (targetSiteId: string, username: string, password: string) => Promise<CrossSiteAuthResult>;
+//# sourceMappingURL=cross-site-auth.d.ts.map

package/dist/types/utils/cross-site-auth.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"cross-site-auth.d.ts","sourceRoot":"","sources":["../../../src/utils/cross-site-auth.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,WAAW,CAAC;AAGrC;;;;GAIG;AAEH;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC,6CAA6C;IAC7C,YAAY,EAAE,MAAM,CAAC;IACrB,wBAAwB;IACxB,QAAQ,EAAE,MAAM,CAAC;IACjB,oBAAoB;IACpB,QAAQ,EAAE,MAAM,CAAC;IACjB,iDAAiD;IACjD,cAAc,EAAE,MAAM,CAAC;CACxB;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC,4CAA4C;IAC5C,OAAO,EAAE,OAAO,CAAC;IACjB,0CAA0C;IAC1C,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,2CAA2C;IAC3C,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,wCAAwC;IACxC,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,kEAAkE;IAClE,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,qBAAqB;IACrB,YAAY,EAAE,MAAM,CAAC;IACrB,6CAA6C;IAC7C,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,+EAA+E;IAC/E,aAAa,CAAC,EAAE,QAAQ,CAAC;CAC1B;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,wBAAsB,uBAAuB,CAC3C,MAAM,EAAE,mBAAmB,GAC1B,OAAO,CAAC,mBAAmB,CAAC,CA+C9B;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAgB,4BAA4B,CAAC,cAAc,EAAE,MAAM,IAE/D,cAAc,MAAM,EACpB,UAAU,MAAM,EAChB,UAAU,MAAM,KACf,OAAO,CAAC,mBAAmB,CAAC,CAQhC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@simpleapps-com/augur-api",
-  "version": "0.1.4",
+  "version": "0.1.5",
   "description": "TypeScript client library for Augur microservices API endpoints",
   "keywords": [
     "augur",
@@ -25,7 +25,8 @@
     "test": "tests"
   },
   "files": [
-    "dist"
+    "dist",
+    "README.md"
   ],
   "scripts": {
     "build": "npm run build:cjs && npm run build:esm && npm run build:types && npm run build:package-json",