@dereekb/firebase-server 13.6.16 → 13.7.0

package/test/package.json

@@ -1,15 +1,16 @@
 {
   "name": "@dereekb/firebase-server/test",
-  "version": "13.6.16",
+  "version": "13.7.0",
   "peerDependencies": {
-    "@dereekb/analytics": "13.6.16",
-    "@dereekb/date": "13.6.16",
-    "@dereekb/firebase": "13.6.16",
-    "@dereekb/firebase-server": "13.6.16",
-    "@dereekb/model": "13.6.16",
-    "@dereekb/nestjs": "13.6.16",
-    "@dereekb/rxjs": "13.6.16",
-    "@dereekb/util": "13.6.16",
+    "@dereekb/analytics": "13.7.0",
+    "@dereekb/date": "13.7.0",
+    "@dereekb/firebase": "13.7.0",
+    "@dereekb/firebase-server": "13.7.0",
+    "@dereekb/firebase-server/oidc": "13.7.0",
+    "@dereekb/model": "13.7.0",
+    "@dereekb/nestjs": "13.7.0",
+    "@dereekb/rxjs": "13.7.0",
+    "@dereekb/util": "13.7.0",
     "@google-cloud/firestore": "^7.11.6",
     "@google-cloud/storage": "^7.19.0",
     "@nestjs/common": "^11.1.17",
@@ -18,10 +19,11 @@
     "firebase-functions": "^7.0.0",
     "firebase-functions-test": "3.4.1",
     "jsonwebtoken": "^9.0.0",
-    "make-error": "^1.3.0"
+    "make-error": "^1.3.0",
+    "supertest": "^7.2.2"
   },
   "devDependencies": {
-    "@dereekb/nestjs": "13.6.16"
+    "@dereekb/nestjs": "13.7.0"
   },
   "exports": {
     "./package.json": "./package.json",

package/test/src/lib/firebase/firebase.test.d.ts

@@ -1,5 +1,5 @@
 import { type ExpectFailAssertionFunction } from '@dereekb/util/test';
-import { HttpsError } from 'firebase-functions/v1/https';
+import { HttpsError } from 'firebase-functions/https';
 import { BaseError } from 'make-error';
 /**
  * Error thrown when the error type was different than the expected type.

package/test/src/lib/index.d.ts

@@ -1,3 +1,4 @@
 export * from './firebase';
 export * from './firestore';
+export * from './oidc';
 export * from './storage';

package/test/src/lib/oidc/index.d.ts

@@ -0,0 +1,2 @@
+export * from './oidc.test.flow';
+export * from './oidc.test.fixture';

package/test/src/lib/oidc/oidc.test.fixture.d.ts

@@ -0,0 +1,126 @@
+import request from 'supertest';
+import { type INestApplication } from '@nestjs/common';
+import { AbstractTestContextFixture } from '@dereekb/util/test';
+import { FirebaseAdminNestTestContextFixture } from '../firebase/firebase.admin.nest';
+import { AuthorizedUserTestContextFixture } from '../firebase';
+/**
+ * Configuration for {@link oAuthAuthorizedSuperTestContextFactory}.
+ */
+export interface OAuthAuthorizedSuperTestContextFactoryConfig {
+    /**
+     * OAuth scopes (space-separated). If omitted, all registered scopes are
+     * resolved from `OidcAccountService.providerConfig.claims`.
+     */
+    readonly scopes?: string;
+    /**
+     * OAuth redirect URI. Defaults to `'https://example.com/callback'`.
+     */
+    readonly redirectUri?: string;
+    /**
+     * Client name. Defaults to `'test-oauth-context'`.
+     */
+    readonly clientName?: string;
+    /**
+     * Vitest hook/test timeout in milliseconds. Defaults to `30_000`.
+     */
+    readonly timeout?: number;
+    /**
+     * Optional custom fixture creator.
+     */
+    readonly makeFixture?: () => OAuthAuthorizedSuperTestFixture;
+    /**
+     * Optional custom instance creator.
+     */
+    readonly makeInstance?: (server: ReturnType<INestApplication['getHttpServer']>, accessToken: string) => OAuthAuthorizedSuperTestInstance;
+}
+/**
+ * Parameters passed when invoking the factory returned by {@link oAuthAuthorizedSuperTestContextFactory}.
+ */
+export interface OAuthAuthorizedSuperTestContextParams {
+    /**
+     * A fixture that provides NestJS app access (DI container, HTTP server).
+     */
+    readonly f: FirebaseAdminNestTestContextFixture;
+    /**
+     * A fixture or object that provides the test user's UID.
+     */
+    readonly u: AuthorizedUserTestContextFixture;
+}
+/**
+ * Instance holding authenticated OAuth state for a single test.
+ */
+export declare class OAuthAuthorizedSuperTestInstance {
+    readonly server: ReturnType<INestApplication['getHttpServer']>;
+    readonly accessToken: string;
+    constructor(server: ReturnType<INestApplication['getHttpServer']>, accessToken: string);
+    /**
+     * Apply Bearer auth to a supertest request.
+     *
+     * @example
+     * ```typescript
+     * await oauth.withAuth(request(oauth.server).get('/oidc/me')).expect(200);
+     * await oauth.withAuth(request(oauth.server).post('/api/model/call')).send(body).expect(200);
+     * ```
+     */
+    withAuth(test: request.Test): request.Test;
+    /**
+     * Shorthand: create a supertest request with auth already applied.
+     *
+     * @example
+     * ```typescript
+     * await oauth.authRequest('get', '/oidc/me').expect(200);
+     * await oauth.authRequest('post', '/api/model/call').send(body).expect(200);
+     * ```
+     */
+    authRequest(method: 'get' | 'post' | 'put' | 'patch' | 'delete', path: string): request.Test;
+}
+/**
+ * Fixture that wraps {@link OAuthAuthorizedSuperTestInstance} and delegates to it.
+ */
+export declare class OAuthAuthorizedSuperTestFixture extends AbstractTestContextFixture<OAuthAuthorizedSuperTestInstance> {
+    get server(): any;
+    get accessToken(): string;
+    /**
+     * Apply Bearer auth to a supertest request.
+     *
+     * @example
+     * ```typescript
+     * await oauth.withAuth(request(oauth.server).get('/oidc/me')).expect(200);
+     * ```
+     */
+    withAuth(test: request.Test): request.Test;
+    /**
+     * Shorthand: create a supertest request with auth already applied.
+     *
+     * @example
+     * ```typescript
+     * await oauth.authRequest('get', '/oidc/me').expect(200);
+     * await oauth.authRequest('post', '/api/model/call').send(body).expect(200);
+     * ```
+     */
+    authRequest(method: 'get' | 'post' | 'put' | 'patch' | 'delete', path: string): request.Test;
+}
+/**
+ * Creates a factory that sets up an OAuth-authenticated supertest context.
+ *
+ * The returned factory function performs a full OAuth authorization code flow
+ * and provides an authenticated supertest agent and helper methods.
+ *
+ * @example
+ * ```typescript
+ * // In shared test setup (e.g. fixture.oidc.ts)
+ * export const myOAuthContext = oAuthAuthorizedSuperTestContextFactory();
+ *
+ * // In test file
+ * myAppFunctionContextFactory((f) => {
+ *   authorizedUserContext({ f }, (u) => {
+ *     myOAuthContext({ f, u }, (oauth) => {
+ *       it('should fetch userinfo', async () => {
+ *         await oauth.authRequest('get', '/oidc/me').expect(200);
+ *       });
+ *     });
+ *   });
+ * });
+ * ```
+ */
+export declare function oAuthAuthorizedSuperTestContextFactory(config?: OAuthAuthorizedSuperTestContextFactoryConfig): (params: OAuthAuthorizedSuperTestContextParams, buildTests: (oauth: OAuthAuthorizedSuperTestFixture) => void) => void;

package/test/src/lib/oidc/oidc.test.flow.d.ts

@@ -0,0 +1,43 @@
+import { type INestApplication } from '@nestjs/common';
+import type { OidcTokenEndpointAuthMethod } from '@dereekb/firebase';
+import { OidcClientService } from '@dereekb/firebase-server/oidc';
+/**
+ * Configuration for {@link performFullOAuthFlow}.
+ */
+export interface OAuthTestFlowConfig {
+    /**
+     * Space-separated OAuth scopes to request.
+     *
+     * If omitted, all registered scopes are resolved from {@link OidcAccountService.allRegisteredScopes}.
+     */
+    readonly scopes?: string;
+    /**
+     * OAuth redirect URI. Defaults to `'https://example.com/callback'`.
+     */
+    readonly redirectUri?: string;
+    /**
+     * Client name used when creating the test OAuth client. Defaults to `'test-oauth-context'`.
+     */
+    readonly clientName?: string;
+    /**
+     * Token endpoint auth method. Defaults to `'client_secret_post'`.
+     */
+    readonly tokenEndpointAuthMethod?: OidcTokenEndpointAuthMethod;
+}
+export interface PerformFullOAuthFlowResult {
+    readonly accessToken: string;
+    readonly idToken: string;
+}
+/**
+ * Performs the full OAuth authorization code flow with PKCE and returns tokens.
+ *
+ * Steps: create client → PKCE → auth redirect → login → consent → code exchange → token
+ */
+export declare function performFullOAuthFlow(server: ReturnType<INestApplication['getHttpServer']>, oidcClientService: OidcClientService, nestApp: INestApplication, uid: string, config?: OAuthTestFlowConfig): Promise<PerformFullOAuthFlowResult>;
+/**
+ * Higher-level helper that resolves OIDC services from the NestJS DI container,
+ * rotates JWKS keys, and then performs the full OAuth flow.
+ *
+ * This avoids callers needing to import from `@dereekb/firebase-server/oidc` directly.
+ */
+export declare function setupAndPerformFullOAuthFlow(nestApp: INestApplication, uid: string, config?: OAuthTestFlowConfig): Promise<PerformFullOAuthFlowResult>;

package/zoho/package.json

@@ -1,15 +1,15 @@
 {
   "name": "@dereekb/firebase-server/zoho",
-  "version": "13.6.16",
+  "version": "13.7.0",
   "peerDependencies": {
-    "@dereekb/analytics": "13.6.16",
-    "@dereekb/date": "13.6.16",
-    "@dereekb/model": "13.6.16",
-    "@dereekb/nestjs": "13.6.16",
-    "@dereekb/rxjs": "13.6.16",
-    "@dereekb/firebase": "13.6.16",
-    "@dereekb/util": "13.6.16",
-    "@dereekb/zoho": "13.6.16"
+    "@dereekb/analytics": "13.7.0",
+    "@dereekb/date": "13.7.0",
+    "@dereekb/model": "13.7.0",
+    "@dereekb/nestjs": "13.7.0",
+    "@dereekb/rxjs": "13.7.0",
+    "@dereekb/firebase": "13.7.0",
+    "@dereekb/util": "13.7.0",
+    "@dereekb/zoho": "13.7.0"
   },
   "exports": {
     "./package.json": "./package.json",