@rapidraptor/auth-shared 0.2.0

package/dist/constants.d.ts

@@ -0,0 +1,46 @@
+/**
+ * Error codes
+ * Type is derived from these constants in types.ts (single source of truth)
+ */
+export declare const ERROR_CODES: {
+    readonly SESSION_EXPIRED: "SESSION_EXPIRED";
+    readonly TOKEN_EXPIRED: "TOKEN_EXPIRED";
+    readonly AUTH_FAILED: "AUTH_FAILED";
+    readonly INTERNAL_ERROR: "INTERNAL_ERROR";
+    readonly SERVICE_UNAVAILABLE: "SERVICE_UNAVAILABLE";
+};
+/**
+ * Default configuration values
+ */
+export declare const DEFAULTS: {
+    /**
+     * Default inactivity timeout: 24 hours in milliseconds
+     */
+    readonly INACTIVITY_TIMEOUT_MS: number;
+    /**
+     * Default Firestore write throttle: 5 minutes in milliseconds
+     */
+    readonly FIRESTORE_WRITE_THROTTLE_MS: number;
+    /**
+     * Default Firestore collection name for sessions
+     */
+    readonly FIRESTORE_SESSIONS_COLLECTION_NAME: "user_sessions";
+    /**
+     * Default Firestore collection name for logout records
+     */
+    readonly FIRESTORE_LOGOUTS_COLLECTION_NAME: "user_logouts";
+    /**
+     * Default logout record TTL: 1 hour in milliseconds
+     * Matches typical JWT lifetime
+     */
+    readonly LOGOUT_TTL_MS: 3600000;
+    /**
+     * Default max retries for token refresh
+     */
+    readonly MAX_RETRIES: 1;
+    /**
+     * Default API timeout: 10 seconds
+     */
+    readonly API_TIMEOUT_MS: number;
+};
+//# sourceMappingURL=constants.d.ts.map

package/dist/constants.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../src/constants.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,eAAO,MAAM,WAAW;;;;;;CAMd,CAAC;AAEX;;GAEG;AACH,eAAO,MAAM,QAAQ;IACnB;;OAEG;;IAGH;;OAEG;;IAGH;;OAEG;;IAGH;;OAEG;;IAGH;;;OAGG;;IAGH;;OAEG;;IAGH;;OAEG;;CAEK,CAAC"}

package/dist/constants.js

@@ -0,0 +1,46 @@
+/**
+ * Error codes
+ * Type is derived from these constants in types.ts (single source of truth)
+ */
+export const ERROR_CODES = {
+    SESSION_EXPIRED: 'SESSION_EXPIRED',
+    TOKEN_EXPIRED: 'TOKEN_EXPIRED',
+    AUTH_FAILED: 'AUTH_FAILED',
+    INTERNAL_ERROR: 'INTERNAL_ERROR',
+    SERVICE_UNAVAILABLE: 'SERVICE_UNAVAILABLE',
+};
+/**
+ * Default configuration values
+ */
+export const DEFAULTS = {
+    /**
+     * Default inactivity timeout: 24 hours in milliseconds
+     */
+    INACTIVITY_TIMEOUT_MS: 24 * 60 * 60 * 1000,
+    /**
+     * Default Firestore write throttle: 5 minutes in milliseconds
+     */
+    FIRESTORE_WRITE_THROTTLE_MS: 5 * 60 * 1000,
+    /**
+     * Default Firestore collection name for sessions
+     */
+    FIRESTORE_SESSIONS_COLLECTION_NAME: 'user_sessions',
+    /**
+     * Default Firestore collection name for logout records
+     */
+    FIRESTORE_LOGOUTS_COLLECTION_NAME: 'user_logouts',
+    /**
+     * Default logout record TTL: 1 hour in milliseconds
+     * Matches typical JWT lifetime
+     */
+    LOGOUT_TTL_MS: 3600000,
+    /**
+     * Default max retries for token refresh
+     */
+    MAX_RETRIES: 1,
+    /**
+     * Default API timeout: 10 seconds
+     */
+    API_TIMEOUT_MS: 10 * 1000,
+};
+//# sourceMappingURL=constants.js.map

package/dist/constants.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.js","sourceRoot":"","sources":["../src/constants.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,MAAM,CAAC,MAAM,WAAW,GAAG;IACzB,eAAe,EAAE,iBAAiB;IAClC,aAAa,EAAE,eAAe;IAC9B,WAAW,EAAE,aAAa;IAC1B,cAAc,EAAE,gBAAgB;IAChC,mBAAmB,EAAE,qBAAqB;CAClC,CAAC;AAEX;;GAEG;AACH,MAAM,CAAC,MAAM,QAAQ,GAAG;IACtB;;OAEG;IACH,qBAAqB,EAAE,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,IAAI;IAE1C;;OAEG;IACH,2BAA2B,EAAE,CAAC,GAAG,EAAE,GAAG,IAAI;IAE1C;;OAEG;IACH,kCAAkC,EAAE,eAAe;IAEnD;;OAEG;IACH,iCAAiC,EAAE,cAAc;IAEjD;;;OAGG;IACH,aAAa,EAAE,OAAO;IAEtB;;OAEG;IACH,WAAW,EAAE,CAAC;IAEd;;OAEG;IACH,cAAc,EAAE,EAAE,GAAG,IAAI;CACjB,CAAC"}

package/dist/index.d.ts

@@ -0,0 +1,4 @@
+export type { SessionInfo, ErrorResponse, ErrorCode, ApiClientConfig, SessionServiceConfig, FirestoreSessionDocument, FirestoreLogoutDocument, FirestoreTimestamp, FirebaseAuth, FirebaseUser, } from './types.js';
+export { SessionValidationStatus } from './types.js';
+export { ERROR_CODES, DEFAULTS } from './constants.js';
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA,YAAY,EACV,WAAW,EACX,aAAa,EACb,SAAS,EACT,eAAe,EACf,oBAAoB,EACpB,wBAAwB,EACxB,uBAAuB,EACvB,kBAAkB,EAClB,YAAY,EACZ,YAAY,GACb,MAAM,YAAY,CAAC;AAGpB,OAAO,EAAE,uBAAuB,EAAE,MAAM,YAAY,CAAC;AAGrD,OAAO,EAAE,WAAW,EAAE,QAAQ,EAAE,MAAM,gBAAgB,CAAC"}

package/dist/index.js

@@ -0,0 +1,5 @@
+// Enums
+export { SessionValidationStatus } from './types.js';
+// Constants
+export { ERROR_CODES, DEFAULTS } from './constants.js';
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAcA,QAAQ;AACR,OAAO,EAAE,uBAAuB,EAAE,MAAM,YAAY,CAAC;AAErD,YAAY;AACZ,OAAO,EAAE,WAAW,EAAE,QAAQ,EAAE,MAAM,gBAAgB,CAAC"}

package/dist/types.d.ts

@@ -0,0 +1,99 @@
+import { ERROR_CODES } from './constants.js';
+/**
+ * Session information stored in Firestore and cache
+ */
+export interface SessionInfo {
+    userId: string;
+    createdAt: Date;
+    lastActivityAt: Date;
+    expiresAt: Date;
+}
+/**
+ * Session validation status
+ * Used to avoid boolean blindness when checking session validity
+ * Provides explicit information about why a session is invalid
+ */
+export declare enum SessionValidationStatus {
+    VALID = "VALID",
+    NOT_FOUND = "NOT_FOUND",
+    EXPIRED = "EXPIRED",
+    DATA_INTEGRITY_ERROR = "DATA_INTEGRITY_ERROR"
+}
+/**
+ * Error codes returned by the authentication system
+ * Type derived from ERROR_CODES in constants.ts (single source of truth)
+ * This extracts the union of all values from the ERROR_CODES object
+ */
+export type ErrorCode = (typeof ERROR_CODES)[keyof typeof ERROR_CODES];
+/**
+ * Error response format from server
+ */
+export interface ErrorResponse {
+    error: {
+        code: ErrorCode;
+        message: string;
+        requiresLogout: boolean;
+        sessionExpired: boolean;
+        timestamp: string;
+    };
+}
+/**
+ * Minimal interface representing a Firebase User
+ * Used to avoid firebase dependency in shared package
+ */
+export interface FirebaseUser {
+    getIdToken(forceRefresh?: boolean): Promise<string>;
+}
+/**
+ * Minimal interface representing a Firebase Auth instance
+ * Used to avoid firebase dependency in shared package
+ */
+export interface FirebaseAuth {
+    currentUser: FirebaseUser | null;
+}
+/**
+ * Configuration for API client
+ */
+export interface ApiClientConfig {
+    baseURL: string;
+    auth: FirebaseAuth;
+    onLogout?: () => void | Promise<void>;
+    maxRetries?: number;
+    timeout?: number;
+    logoutEndpoint?: string;
+}
+/**
+ * Session service configuration
+ */
+export interface SessionServiceConfig {
+    inactivityTimeoutMs: number;
+    firestoreWriteThrottleMs: number;
+    firestoreCollectionName?: string;
+    firestoreLogoutsCollectionName?: string;
+    logoutTtlMs?: number;
+}
+/**
+ * Minimal interface representing a Firestore Timestamp
+ * Used to avoid firebase-admin dependency in shared package
+ */
+export interface FirestoreTimestamp {
+    toDate(): Date;
+}
+/**
+ * Firestore document structure for session
+ */
+export interface FirestoreSessionDocument {
+    userId: string;
+    createdAt: FirestoreTimestamp | Date;
+    lastActivityAt: FirestoreTimestamp | Date;
+    expiresAt: FirestoreTimestamp | Date;
+}
+/**
+ * Firestore document structure for logout records
+ */
+export interface FirestoreLogoutDocument {
+    userId: string;
+    loggedOutAt: FirestoreTimestamp | Date;
+    expiresAt: FirestoreTimestamp | Date;
+}
+//# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAE7C;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B,MAAM,EAAE,MAAM,CAAC;IACf,SAAS,EAAE,IAAI,CAAC;IAChB,cAAc,EAAE,IAAI,CAAC;IACrB,SAAS,EAAE,IAAI,CAAC;CACjB;AAED;;;;GAIG;AACH,oBAAY,uBAAuB;IACjC,KAAK,UAAU;IACf,SAAS,cAAc;IACvB,OAAO,YAAY;IACnB,oBAAoB,yBAAyB;CAC9C;AAED;;;;GAIG;AACH,MAAM,MAAM,SAAS,GAAG,CAAC,OAAO,WAAW,CAAC,CAAC,MAAM,OAAO,WAAW,CAAC,CAAC;AAEvE;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B,KAAK,EAAE;QACL,IAAI,EAAE,SAAS,CAAC;QAChB,OAAO,EAAE,MAAM,CAAC;QAChB,cAAc,EAAE,OAAO,CAAC;QACxB,cAAc,EAAE,OAAO,CAAC;QACxB,SAAS,EAAE,MAAM,CAAC;KACnB,CAAC;CACH;AAED;;;GAGG;AACH,MAAM,WAAW,YAAY;IAC3B,UAAU,CAAC,YAAY,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;CACrD;AAED;;;GAGG;AACH,MAAM,WAAW,YAAY;IAC3B,WAAW,EAAE,YAAY,GAAG,IAAI,CAAC;CAClC;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,EAAE,YAAY,CAAC;IACnB,QAAQ,CAAC,EAAE,MAAM,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACtC,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC,mBAAmB,EAAE,MAAM,CAAC;IAC5B,wBAAwB,EAAE,MAAM,CAAC;IACjC,uBAAuB,CAAC,EAAE,MAAM,CAAC;IACjC,8BAA8B,CAAC,EAAE,MAAM,CAAC;IACxC,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED;;;GAGG;AACH,MAAM,WAAW,kBAAkB;IACjC,MAAM,IAAI,IAAI,CAAC;CAChB;AAED;;GAEG;AACH,MAAM,WAAW,wBAAwB;IACvC,MAAM,EAAE,MAAM,CAAC;IACf,SAAS,EAAE,kBAAkB,GAAG,IAAI,CAAC;IACrC,cAAc,EAAE,kBAAkB,GAAG,IAAI,CAAC;IAC1C,SAAS,EAAE,kBAAkB,GAAG,IAAI,CAAC;CACtC;AAED;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACtC,MAAM,EAAE,MAAM,CAAC;IACf,WAAW,EAAE,kBAAkB,GAAG,IAAI,CAAC;IACvC,SAAS,EAAE,kBAAkB,GAAG,IAAI,CAAC;CACtC"}

package/dist/types.js

@@ -0,0 +1,13 @@
+/**
+ * Session validation status
+ * Used to avoid boolean blindness when checking session validity
+ * Provides explicit information about why a session is invalid
+ */
+export var SessionValidationStatus;
+(function (SessionValidationStatus) {
+    SessionValidationStatus["VALID"] = "VALID";
+    SessionValidationStatus["NOT_FOUND"] = "NOT_FOUND";
+    SessionValidationStatus["EXPIRED"] = "EXPIRED";
+    SessionValidationStatus["DATA_INTEGRITY_ERROR"] = "DATA_INTEGRITY_ERROR";
+})(SessionValidationStatus || (SessionValidationStatus = {}));
+//# sourceMappingURL=types.js.map

package/dist/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAYA;;;;GAIG;AACH,MAAM,CAAN,IAAY,uBAKX;AALD,WAAY,uBAAuB;IACjC,0CAAe,CAAA;IACf,kDAAuB,CAAA;IACvB,8CAAmB,CAAA;IACnB,wEAA6C,CAAA;AAC/C,CAAC,EALW,uBAAuB,KAAvB,uBAAuB,QAKlC"}

package/package.json

@@ -0,0 +1,27 @@
+{
+  "name": "@rapidraptor/auth-shared",
+  "version": "0.2.0",
+  "description": "Shared types and constants for @rapidraptor/auth",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    }
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "build": "tsc",
+    "clean": "rm -rf dist",
+    "test": "vitest"
+  },
+  "devDependencies": {
+    "typescript": "^5.4.5"
+  }
+}