alliance-shared-types 1.0.0

package/README.md

@@ -0,0 +1,79 @@
+# Alliance Shared Types
+
+This package contains shared TypeScript type definitions for the Alliance B2B Travel Portal. It ensures type consistency between the frontend and backend applications.
+
+## Installation
+
+### Local Development
+
+During local development, you can use the package directly from your local filesystem:
+
+```bash
+# From the frontend or backend project
+npm install ../alliance-shared-types
+```
+
+### Using npm
+
+Once published to npm:
+
+```bash
+npm install alliance-shared-types
+```
+
+### Using GitHub
+
+You can also install directly from GitHub:
+
+```bash
+npm install git+https://github.com/yourusername/alliance-shared-types.git
+```
+
+## Usage
+
+```typescript
+// Import specific types
+import { UserData, AuthResponse, USER_ROLES } from 'alliance-shared-types';
+
+// Use in your code
+const user: UserData = {
+  userId: '123',
+  email: 'user@example.com',
+  role: USER_ROLES.ADMIN,
+  agentId: '456',
+  status: 'active'
+};
+```
+
+## Available Types
+
+### Authentication
+
+- `UserCredentials` - Login credentials
+- `AuthResponse` - Authentication response with token and user data
+- `UserData` - User information
+- `JwtPayload` - JWT token payload structure
+- `TokenData` - Token data with expiration
+
+### Enums and Constants
+
+- `UserRole` and `USER_ROLES` - User role types and constants
+- `UserStatus` and `USER_STATUSES` - User status types and constants
+- `AgentType` and `AGENT_TYPES` - Agent type types and constants
+- `KycStatus` and `KYC_STATUSES` - KYC status types and constants
+- `AgentStatus` and `AGENT_STATUSES` - Agent status types and constants
+
+## Development
+
+To build the package:
+
+```bash
+npm run build
+```
+
+## Publishing
+
+```bash
+npm login
+npm publish
+```

package/dist/index.d.ts

@@ -0,0 +1 @@
+export * from './types/auth.types';

package/dist/index.js

@@ -0,0 +1,18 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+// Export all types from the types directory
+__exportStar(require("./types/auth.types"), exports);

package/dist/types/auth.types.d.ts

@@ -0,0 +1,56 @@
+export interface UserCredentials {
+    email: string;
+    password: string;
+}
+export interface AuthResponse {
+    token: string;
+    user: UserData;
+}
+export interface UserData {
+    userId: string;
+    email: string;
+    role: string;
+    agentId: string;
+    agentType?: string;
+    status: string;
+}
+export interface JwtPayload {
+    userId: string;
+    email: string;
+    role: string;
+    agentId: string;
+}
+export interface TokenData {
+    token: string;
+    expiresIn: string | number;
+}
+export type UserRole = 'admin' | 'staff' | 'agent_user';
+export declare const USER_ROLES: {
+    ADMIN: UserRole;
+    STAFF: UserRole;
+    AGENT_USER: UserRole;
+};
+export type UserStatus = 'active' | 'inactive' | 'suspended';
+export declare const USER_STATUSES: {
+    ACTIVE: UserStatus;
+    INACTIVE: UserStatus;
+    SUSPENDED: UserStatus;
+};
+export type AgentType = 'admin' | 'distributor' | 'retailer';
+export declare const AGENT_TYPES: {
+    ADMIN: AgentType;
+    DISTRIBUTOR: AgentType;
+    RETAILER: AgentType;
+};
+export type KycStatus = 'pending' | 'verified' | 'rejected';
+export declare const KYC_STATUSES: {
+    PENDING: KycStatus;
+    VERIFIED: KycStatus;
+    REJECTED: KycStatus;
+};
+export type AgentStatus = 'active' | 'inactive' | 'suspended';
+export declare const AGENT_STATUSES: {
+    ACTIVE: AgentStatus;
+    INACTIVE: AgentStatus;
+    SUSPENDED: AgentStatus;
+};

package/dist/types/auth.types.js

@@ -0,0 +1,33 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AGENT_STATUSES = exports.KYC_STATUSES = exports.AGENT_TYPES = exports.USER_STATUSES = exports.USER_ROLES = void 0;
+// Constants for user roles
+exports.USER_ROLES = {
+    ADMIN: 'admin',
+    STAFF: 'staff',
+    AGENT_USER: 'agent_user'
+};
+// Constants for user statuses
+exports.USER_STATUSES = {
+    ACTIVE: 'active',
+    INACTIVE: 'inactive',
+    SUSPENDED: 'suspended'
+};
+// Constants for agent types
+exports.AGENT_TYPES = {
+    ADMIN: 'admin',
+    DISTRIBUTOR: 'distributor',
+    RETAILER: 'retailer'
+};
+// Constants for KYC statuses
+exports.KYC_STATUSES = {
+    PENDING: 'pending',
+    VERIFIED: 'verified',
+    REJECTED: 'rejected'
+};
+// Constants for agent statuses
+exports.AGENT_STATUSES = {
+    ACTIVE: 'active',
+    INACTIVE: 'inactive',
+    SUSPENDED: 'suspended'
+};

package/package.json

@@ -0,0 +1,28 @@
+{
+  "name": "alliance-shared-types",
+  "version": "1.0.0",
+  "description": "Shared TypeScript types for Alliance B2B Travel Portal",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "tsc",
+    "prepare": "npm run build"
+  },
+  "keywords": [
+    "typescript",
+    "types",
+    "alliance",
+    "travel"
+  ],
+  "author": "",
+  "license": "ISC",
+  "devDependencies": {
+    "typescript": "^5.0.0"
+  },
+  "peerDependencies": {
+    "typescript": ">=4.0.0"
+  }
+}