@causa/runtime-google 0.30.0 → 0.32.0

package/dist/firebase/firestore-admin-client.type.d.ts

@@ -0,0 +1,6 @@
+import { v1 } from 'firebase-admin/firestore';
+/**
+ * The low-level client to access administrative Firestore operations.
+ */
+export declare const FirestoreAdminClient: typeof import("@google-cloud/firestore/types/v1/firestore_admin_client.js").FirestoreAdminClient;
+export type FirestoreAdminClient = InstanceType<typeof v1.FirestoreAdminClient>;

package/dist/firebase/firestore-admin-client.type.js

@@ -0,0 +1,5 @@
+import { v1 } from 'firebase-admin/firestore';
+/**
+ * The low-level client to access administrative Firestore operations.
+ */
+export const FirestoreAdminClient = v1.FirestoreAdminClient;

package/dist/firebase/index.d.ts

@@ -1,3 +1,4 @@
 export { getDefaultFirebaseApp } from './app.js';
+export { FirestoreAdminClient } from './firestore-admin-client.type.js';
 export { FIREBASE_APP_TOKEN, InjectFirebaseApp, } from './inject-firebase-app.decorator.js';
 export { FirebaseModule } from './module.js';

package/dist/firebase/index.js

@@ -1,3 +1,4 @@
 export { getDefaultFirebaseApp } from './app.js';
+export { FirestoreAdminClient } from './firestore-admin-client.type.js';
 export { FIREBASE_APP_TOKEN, InjectFirebaseApp, } from './inject-firebase-app.decorator.js';
 export { FirebaseModule } from './module.js';

package/dist/firebase/lifecycle.service.d.ts

@@ -1,6 +1,7 @@
 import { OnApplicationShutdown } from '@nestjs/common';
 import { App } from 'firebase-admin/app';
 import { Firestore } from 'firebase-admin/firestore';
+import { FirestoreAdminClient } from './firestore-admin-client.type.js';
 /**
  * A private service that handles the graceful shutdown of the Firebase App.
  * Should be imported in the `FirebaseModule`.
@@ -8,6 +9,7 @@ import { Firestore } from 'firebase-admin/firestore';
 export declare class FirebaseLifecycleService implements OnApplicationShutdown {
     private readonly app;
     private readonly firestore;
-    constructor(app: App, firestore: Firestore);
+    private readonly firestoreAdmin;
+    constructor(app: App, firestore: Firestore, firestoreAdmin: FirestoreAdminClient);
     onApplicationShutdown(): Promise<void>;
 }

package/dist/firebase/lifecycle.service.js

@@ -13,6 +13,7 @@ var __param = (this && this.__param) || function (paramIndex, decorator) {
 import { Injectable } from '@nestjs/common';
 import { deleteApp } from 'firebase-admin/app';
 import { Firestore } from 'firebase-admin/firestore';
+import { FirestoreAdminClient } from './firestore-admin-client.type.js';
 import { InjectFirebaseApp } from './inject-firebase-app.decorator.js';
 /**
  * A private service that handles the graceful shutdown of the Firebase App.
@@ -21,11 +22,14 @@ import { InjectFirebaseApp } from './inject-firebase-app.decorator.js';
 let FirebaseLifecycleService = class FirebaseLifecycleService {
     app;
     firestore;
-    constructor(app, firestore) {
+    firestoreAdmin;
+    constructor(app, firestore, firestoreAdmin) {
         this.app = app;
         this.firestore = firestore;
+        this.firestoreAdmin = firestoreAdmin;
     }
     async onApplicationShutdown() {
+        await this.firestoreAdmin.close();
         await this.firestore.terminate();
         await deleteApp(this.app);
     }
@@ -33,6 +37,7 @@ let FirebaseLifecycleService = class FirebaseLifecycleService {
 FirebaseLifecycleService = __decorate([
     Injectable(),
     __param(0, InjectFirebaseApp()),
-    __metadata("design:paramtypes", [Object, Firestore])
+    __metadata("design:paramtypes", [Object, Firestore,
+        FirestoreAdminClient])
 ], FirebaseLifecycleService);
 export { FirebaseLifecycleService };

package/dist/firebase/module.js

@@ -12,6 +12,7 @@ import { Auth, getAuth } from 'firebase-admin/auth';
 import { Firestore, getFirestore } from 'firebase-admin/firestore';
 import { Messaging, getMessaging } from 'firebase-admin/messaging';
 import { getDefaultFirebaseApp } from './app.js';
+import { FirestoreAdminClient } from './firestore-admin-client.type.js';
 import { FIREBASE_APP_TOKEN } from './inject-firebase-app.decorator.js';
 import { FirebaseLifecycleService } from './lifecycle.service.js';
 /**
@@ -31,6 +32,10 @@ const childProviders = [
         useFactory: getMessaging,
         inject: [FIREBASE_APP_TOKEN],
     },
+    {
+        provide: FirestoreAdminClient,
+        useFactory: () => new FirestoreAdminClient(),
+    },
 ];
 /**
  * Creates the module metadata for the {@link FirebaseModule}.

package/dist/firestore/healthcheck.d.ts

@@ -1,11 +1,16 @@
 import { BaseHealthIndicatorService } from '@causa/runtime/nestjs';
 import { HealthIndicatorResult } from '@nestjs/terminus';
 import { Firestore } from 'firebase-admin/firestore';
+import { FirestoreAdminClient } from '../firebase/index.js';
 /**
  * A service testing the availability of the Firestore service.
  */
 export declare class FirestoreHealthIndicator extends BaseHealthIndicatorService {
-    private readonly firestore;
-    constructor(firestore: Firestore);
+    private readonly admin;
+    /**
+     * The ID of the database used by Firestore.
+     */
+    private readonly databaseId;
+    constructor(admin: FirestoreAdminClient, firestore: Firestore);
     check(): Promise<HealthIndicatorResult>;
 }

package/dist/firestore/healthcheck.js

@@ -11,6 +11,7 @@ import { BaseHealthIndicatorService } from '@causa/runtime/nestjs';
 import { Injectable } from '@nestjs/common';
 import { HealthCheckError } from '@nestjs/terminus';
 import { Firestore } from 'firebase-admin/firestore';
+import { FirestoreAdminClient } from '../firebase/index.js';
 /**
  * The key used to identify the Firestore health indicator.
  */
@@ -19,18 +20,25 @@ const FIRESTORE_HEALTH_KEY = 'google.firestore';
  * A service testing the availability of the Firestore service.
  */
 let FirestoreHealthIndicator = class FirestoreHealthIndicator extends BaseHealthIndicatorService {
-    firestore;
-    constructor(firestore) {
+    admin;
+    /**
+     * The ID of the database used by Firestore.
+     */
+    databaseId;
+    constructor(admin, firestore) {
         super();
-        this.firestore = firestore;
+        this.admin = admin;
+        this.databaseId = firestore.databaseId;
     }
     async check() {
         try {
-            await this.firestore.listCollections();
+            const projectId = await this.admin.getProjectId();
+            const name = this.admin.databasePath(projectId, this.databaseId);
+            await this.admin.getDatabase({ name });
             return this.getStatus(FIRESTORE_HEALTH_KEY, true);
         }
         catch (error) {
-            throw new HealthCheckError('Failed to check health by listing Firestore collections.', this.getStatus(FIRESTORE_HEALTH_KEY, false, {
+            throw new HealthCheckError('Failed to check health by getting Firestore database.', this.getStatus(FIRESTORE_HEALTH_KEY, false, {
                 error: error.message,
             }));
         }
@@ -38,6 +46,7 @@ let FirestoreHealthIndicator = class FirestoreHealthIndicator extends BaseHealth
 };
 FirestoreHealthIndicator = __decorate([
     Injectable(),
-    __metadata("design:paramtypes", [Firestore])
+    __metadata("design:paramtypes", [FirestoreAdminClient,
+        Firestore])
 ], FirestoreHealthIndicator);
 export { FirestoreHealthIndicator };

package/dist/tasks/scheduler.d.ts

@@ -1,4 +1,5 @@
 import { CloudTasksClient, protos } from '@google-cloud/tasks';
+import { ConfigService } from '@nestjs/config';
 import { RetryOptions } from 'google-gax';
 export import Task = protos.google.cloud.tasks.v2.ITask;
 export import HttpMethod = protos.google.cloud.tasks.v2.HttpMethod;
@@ -22,7 +23,16 @@ export type HttpRequestCreation = Omit<HttpRequest, 'body' | 'oidcToken'> & {
  */
 export declare class CloudTasksScheduler {
     private readonly client;
-    constructor(client: CloudTasksClient);
+    private readonly configService;
+    constructor(client: CloudTasksClient, configService: ConfigService);
+    /**
+     * Returns the full path of the queue with the given name.
+     * It gets the path from the configuration, using the `TASKS_QUEUE_` prefix and the uppercase and underscored name.
+     *
+     * @param name The name of the queue.
+     * @returns The full path of the queue, or `null` if the configuration could not be found.
+     */
+    getQueuePath(name: string): string | null;
     /**
      * The promise resolving to the email of the service account used by the Cloud Tasks client.
      * This assumes that it is the account used by the current service / application.

package/dist/tasks/scheduler.js

@@ -9,6 +9,7 @@ var __metadata = (this && this.__metadata) || function (k, v) {
 };
 import { CloudTasksClient, protos } from '@google-cloud/tasks';
 import { Injectable } from '@nestjs/common';
+import { ConfigService } from '@nestjs/config';
 import { grpc } from 'google-gax';
 import { TemporaryCloudTasksError } from './errors.js';
 export var HttpMethod = protos.google.cloud.tasks.v2.HttpMethod;
@@ -44,8 +45,22 @@ const GRPC_RETRYABLE_CODES = [
  */
 let CloudTasksScheduler = class CloudTasksScheduler {
     client;
-    constructor(client) {
+    configService;
+    constructor(client, configService) {
         this.client = client;
+        this.configService = configService;
+    }
+    /**
+     * Returns the full path of the queue with the given name.
+     * It gets the path from the configuration, using the `TASKS_QUEUE_` prefix and the uppercase and underscored name.
+     *
+     * @param name The name of the queue.
+     * @returns The full path of the queue, or `null` if the configuration could not be found.
+     */
+    getQueuePath(name) {
+        const configName = `TASKS_QUEUE_${name.toUpperCase().replace(/[\.-]{1}/g, '_')}`;
+        const queuePath = this.configService.get(configName);
+        return queuePath ?? null;
     }
     /**
      * The promise resolving to the email of the service account used by the Cloud Tasks client.
@@ -124,6 +139,7 @@ let CloudTasksScheduler = class CloudTasksScheduler {
 };
 CloudTasksScheduler = __decorate([
     Injectable(),
-    __metadata("design:paramtypes", [CloudTasksClient])
+    __metadata("design:paramtypes", [CloudTasksClient,
+        ConfigService])
 ], CloudTasksScheduler);
 export { CloudTasksScheduler };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@causa/runtime-google",
-  "version": "0.30.0",
+  "version": "0.32.0",
   "description": "An extension to the Causa runtime SDK (`@causa/runtime`), providing Google-specific features.",
   "repository": "github:causa-io/runtime-typescript-google",
   "license": "ISC",
@@ -31,20 +31,20 @@
   "dependencies": {
     "@causa/runtime": ">= 0.22.0 < 1.0.0",
     "@google-cloud/precise-date": "^4.0.0",
-    "@google-cloud/pubsub": "^4.7.0",
+    "@google-cloud/pubsub": "^4.7.2",
     "@google-cloud/spanner": "^7.14.0",
     "@google-cloud/tasks": "^5.5.0",
-    "@grpc/grpc-js": "^1.11.1",
-    "@nestjs/common": "^10.4.1",
+    "@grpc/grpc-js": "^1.11.3",
+    "@nestjs/common": "^10.4.3",
     "@nestjs/config": "^3.2.3",
-    "@nestjs/core": "^10.4.1",
+    "@nestjs/core": "^10.4.3",
     "@nestjs/passport": "^10.0.3",
-    "@nestjs/swagger": "^7.4.0",
+    "@nestjs/swagger": "^7.4.2",
     "@nestjs/terminus": "^10.2.3",
     "class-transformer": "^0.5.1",
     "class-validator": "^0.14.1",
-    "express": "^4.19.2",
-    "firebase-admin": "^12.4.0",
+    "express": "^4.21.0",
+    "firebase-admin": "^12.5.0",
     "jsonwebtoken": "^9.0.2",
     "nestjs-pino": "^4.1.0",
     "passport-http-bearer": "^1.0.1",
@@ -52,16 +52,16 @@
     "reflect-metadata": "^0.2.2"
   },
   "devDependencies": {
-    "@nestjs/testing": "^10.4.1",
+    "@nestjs/testing": "^10.4.3",
     "@tsconfig/node18": "^18.2.4",
-    "@types/jest": "^29.5.12",
-    "@types/jsonwebtoken": "^9.0.6",
-    "@types/node": "^18.19.49",
+    "@types/jest": "^29.5.13",
+    "@types/jsonwebtoken": "^9.0.7",
+    "@types/node": "^18.19.50",
     "@types/passport-http-bearer": "^1.0.41",
     "@types/supertest": "^6.0.2",
     "@types/uuid": "^10.0.0",
     "dotenv": "^16.4.5",
-    "eslint": "^9.9.1",
+    "eslint": "^9.10.0",
     "eslint-config-prettier": "^9.1.0",
     "eslint-plugin-prettier": "^5.2.1",
     "jest": "^29.7.0",
@@ -71,7 +71,7 @@
     "ts-jest": "^29.2.5",
     "ts-node": "^10.9.2",
     "typescript": "^5.5.4",
-    "typescript-eslint": "^8.4.0",
+    "typescript-eslint": "^8.6.0",
     "uuid": "^10.0.0"
   }
 }