skyllful-auth-integration 1.0.0

package/README.md

@@ -0,0 +1,78 @@
+# skyllful-auth-integration
+
+Get user information from the current browser URL including userId, firstName, lastName, and permission flags.
+
+## Installation
+
+```bash
+npm install skyllful-auth-integration
+```
+
+## Usage
+
+```typescript
+import { getUserInfo } from 'skyllful-auth-integration';
+
+// In browser environment
+// Current URL: https://app.example.com/?userId=456&firstName=Jane&lastName=Smith&permissions=simulator,iq
+const userInfo = await getUserInfo();
+
+console.log(userInfo);
+// {
+//   userId: '456',
+//   firstName: 'Jane',
+//   lastName: 'Smith',
+//   hasSimulatorPermission: true,
+//   hasIqPermission: true,
+//   hasStudioPermission: false
+// }
+```
+
+Or use the default export:
+
+```typescript
+import getUserInfo from 'skyllful-auth-integration';
+
+const userInfo = await getUserInfo();
+```
+
+## API
+
+### `getUserInfo()`
+
+Get user information from the current browser URL.
+
+**Returns:** `Promise<UserInfo>` that resolves to an object with:
+- `userId` (string): The user ID from the `userId` URL parameter
+- `firstName` (string): The user's first name from the `firstName` URL parameter
+- `lastName` (string): The user's last name from the `lastName` URL parameter
+- `hasSimulatorPermission` (boolean): True if `permissions` includes "simulator"
+- `hasIqPermission` (boolean): True if `permissions` includes "iq"
+- `hasStudioPermission` (boolean): True if `permissions` includes "studio"
+
+**Note:** This function only works in browser environments and will throw an error in Node.js.
+
+**Expected URL parameters:**
+- `userId` - The user ID
+- `firstName` - The user's first name
+- `lastName` - The user's last name
+- `permissions` - Comma-separated list of permissions (e.g., `simulator,iq,studio`)
+
+## TypeScript
+
+This package includes TypeScript definitions. The following type is exported:
+
+```typescript
+interface UserInfo {
+  userId: string;
+  firstName: string;
+  lastName: string;
+  hasSimulatorPermission: boolean;
+  hasIqPermission: boolean;
+  hasStudioPermission: boolean;
+}
+```
+
+## License
+
+ISC

package/dist/index.d.ts

@@ -0,0 +1,15 @@
+export interface UserInfo {
+    userId: string;
+    firstName: string;
+    lastName: string;
+    hasSimulatorPermission: boolean;
+    hasIqPermission: boolean;
+    hasStudioPermission: boolean;
+}
+/**
+ * Get user information from the current browser URL
+ * Note: This function only works in browser environments
+ * @returns Promise resolving to UserInfo object with parsed authentication data
+ */
+export declare function getUserInfo(): Promise<UserInfo>;
+export default getUserInfo;

package/dist/index.js

@@ -0,0 +1,30 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getUserInfo = getUserInfo;
+/**
+ * Get user information from the current browser URL
+ * Note: This function only works in browser environments
+ * @returns Promise resolving to UserInfo object with parsed authentication data
+ */
+async function getUserInfo() {
+    if (typeof window === 'undefined' || !window.location) {
+        throw new Error('getUserInfo can only be used in browser environments');
+    }
+    const params = new URL(window.location.href).searchParams;
+    const userId = params.get('userId') || '';
+    const firstName = params.get('firstName') || '';
+    const lastName = params.get('lastName') || '';
+    const permissionsStr = params.get('permissions') || '';
+    const permissions = permissionsStr
+        ? permissionsStr.split(',').map(p => p.trim().toLowerCase()).filter(p => p)
+        : [];
+    return {
+        userId,
+        firstName,
+        lastName,
+        hasSimulatorPermission: permissions.includes('simulator'),
+        hasIqPermission: permissions.includes('iq'),
+        hasStudioPermission: permissions.includes('studio')
+    };
+}
+exports.default = getUserInfo;

package/package.json

@@ -0,0 +1,25 @@
+{
+  "name": "skyllful-auth-integration",
+  "version": "1.0.0",
+  "description": "Parse authentication parameters from URL and extract user information",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "scripts": {
+    "build": "tsc",
+    "prepublishOnly": "npm run build"
+  },
+  "keywords": [
+    "authentication",
+    "auth",
+    "url-params",
+    "user-info"
+  ],
+  "author": "",
+  "license": "ISC",
+  "files": [
+    "dist"
+  ],
+  "devDependencies": {
+    "typescript": "^5.9.3"
+  }
+}