@causa/workspace-google 0.4.0 → 0.6.0

package/dist/services/pubsub.js

@@ -0,0 +1,62 @@
+import { PubSub } from '@google-cloud/pubsub';
+import { ResourceManagerService } from './resource-manager.js';
+/**
+ * A service for managing Pub/Sub resources
+ */
+export class PubSubService {
+    /**
+     * The Pub/Sub client.
+     */
+    pubSub;
+    /**
+     * The resource manager service used to get the project number.
+     */
+    resourceManagerService;
+    /**
+     * The ID of the GCP project in which to create Pub/Sub resources.
+     */
+    projectId;
+    constructor(context) {
+        this.pubSub = new PubSub();
+        this.resourceManagerService = context.service(ResourceManagerService);
+        this.projectId = context
+            .asConfiguration()
+            .getOrThrow('google.project');
+    }
+    /**
+     * The cached promise that resolves to the GCP service account used by Pub/Sub.
+     */
+    gcpServiceAccountPromise;
+    /**
+     * Constructs the email of the GCP-owned service account used by Pub/Sub.
+     * This can be used to grant roles to the service account, e.g. for push subscriptions.
+     *
+     * @returns The email of the GCP service account used by Pub/Sub.
+     */
+    async getGcpServiceAccount() {
+        if (!this.gcpServiceAccountPromise) {
+            this.gcpServiceAccountPromise = (async () => {
+                const projectNumber = await this.resourceManagerService.getProjectNumber(this.projectId);
+                return `service-${projectNumber}@gcp-sa-pubsub.iam.gserviceaccount.com`;
+            })();
+        }
+        return await this.gcpServiceAccountPromise;
+    }
+    /**
+     * Constructs the IAM policy bindings that should be added to a service account meant to be used by push
+     * subscriptions.
+     * Those bindings allow the GCP-owned Pub/Sub service account to authenticate as the service account when pushing
+     * messages.
+     *
+     * @returns The bindings.
+     */
+    async getPushServiceAccountBindings() {
+        const pubSubGcpServiceAccount = await this.getGcpServiceAccount();
+        return [
+            {
+                role: 'roles/iam.serviceAccountTokenCreator',
+                members: [`serviceAccount:${pubSubGcpServiceAccount}`],
+            },
+        ];
+    }
+}

package/dist/services/resource-manager.d.ts

@@ -0,0 +1,18 @@
+import { ProjectsClient } from '@google-cloud/resource-manager';
+/**
+ * A service for interacting with the GCP Resource Manager API, handling organizations, folders, and projects.
+ */
+export declare class ResourceManagerService {
+    /**
+     * The client used to manage GCP projects.
+     */
+    readonly projectsClient: ProjectsClient;
+    constructor();
+    /**
+     * Retrieves the project number for a given GCP project ID.
+     *
+     * @param projectId The ID of the GCP project.
+     * @returns The number of the GCP project.
+     */
+    getProjectNumber(projectId: string): Promise<string>;
+}

package/dist/services/resource-manager.js

@@ -0,0 +1,35 @@
+import { ProjectsClient } from '@google-cloud/resource-manager';
+/**
+ * A service for interacting with the GCP Resource Manager API, handling organizations, folders, and projects.
+ */
+export class ResourceManagerService {
+    /**
+     * The client used to manage GCP projects.
+     */
+    projectsClient;
+    constructor() {
+        this.projectsClient = new ProjectsClient();
+    }
+    /**
+     * Retrieves the project number for a given GCP project ID.
+     *
+     * @param projectId The ID of the GCP project.
+     * @returns The number of the GCP project.
+     */
+    async getProjectNumber(projectId) {
+        const [projects] = await this.projectsClient.searchProjects({
+            query: `projectId:${projectId}`,
+            pageSize: 1,
+        });
+        if (projects.length < 1) {
+            throw new Error(`Could not find GCP project '${projectId}'.`);
+        }
+        const [project] = projects;
+        // eslint-disable-next-line @typescript-eslint/no-unused-vars
+        const [projectsConst, projectNumber] = project.name?.split('/') ?? [];
+        if (!projectNumber) {
+            throw new Error(`Failed to parse invalid project name '${project.name}'.`);
+        }
+        return projectNumber;
+    }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@causa/workspace-google",
-  "version": "0.4.0",
+  "version": "0.6.0",
   "description": "The Causa workspace module providing many functionalities related to GCP and its services.",
   "repository": "github:causa-io/workspace-module-google",
   "license": "ISC",
@@ -31,37 +31,42 @@
   "dependencies": {
     "@causa/cli": ">= 0.4.0 < 1.0.0",
     "@causa/workspace": ">= 0.12.0 < 1.0.0",
-    "@causa/workspace-core": ">= 0.8.0 < 1.0.0",
-    "@google-cloud/apikeys": "^0.2.2",
-    "@google-cloud/iam-credentials": "^2.0.4",
-    "@google-cloud/pubsub": "^3.7.3",
-    "@google-cloud/secret-manager": "^4.2.2",
-    "@google-cloud/service-usage": "^2.2.2",
-    "@google-cloud/spanner": "^6.14.0",
-    "@google-cloud/storage": "^6.12.0",
-    "@grpc/grpc-js": "^1.8.20",
+    "@causa/workspace-core": ">= 0.16.0 < 1.0.0",
+    "@google-cloud/apikeys": "^1.0.1",
+    "@google-cloud/bigquery": "^7.3.0",
+    "@google-cloud/iam-credentials": "^3.0.1",
+    "@google-cloud/pubsub": "^4.0.6",
+    "@google-cloud/resource-manager": "^5.0.1",
+    "@google-cloud/run": "^1.0.1",
+    "@google-cloud/secret-manager": "^5.0.1",
+    "@google-cloud/service-usage": "^3.1.0",
+    "@google-cloud/spanner": "^7.0.0",
+    "@google-cloud/storage": "^7.1.0",
+    "@grpc/grpc-js": "^1.9.4",
     "class-validator": "^0.14.0",
-    "firebase": "^10.1.0",
-    "firebase-admin": "^11.10.1",
+    "firebase": "^10.4.0",
+    "firebase-admin": "^11.11.0",
     "globby": "^13.2.2",
-    "googleapis": "^123.0.0",
-    "uuid": "^9.0.0"
+    "google-auth-library": "^9.0.0",
+    "googleapis": "^126.0.1",
+    "pino": "^8.15.1",
+    "uuid": "^9.0.1"
   },
   "devDependencies": {
-    "@tsconfig/node18": "^18.2.0",
-    "@types/jest": "^29.5.3",
-    "@types/node": "^18.17.1",
-    "@types/uuid": "^9.0.2",
-    "@typescript-eslint/eslint-plugin": "^6.2.0",
+    "@tsconfig/node18": "^18.2.2",
+    "@types/jest": "^29.5.5",
+    "@types/node": "^18.18.0",
+    "@types/uuid": "^9.0.4",
+    "@typescript-eslint/eslint-plugin": "^6.7.3",
     "copyfiles": "^2.4.1",
-    "eslint": "^8.45.0",
-    "eslint-config-prettier": "^8.8.0",
+    "eslint": "^8.50.0",
+    "eslint-config-prettier": "^9.0.0",
     "eslint-plugin-prettier": "^5.0.0",
-    "jest": "^29.6.1",
-    "jest-extended": "^4.0.0",
-    "rimraf": "^5.0.1",
+    "jest": "^29.7.0",
+    "jest-extended": "^4.0.1",
+    "rimraf": "^5.0.5",
     "ts-jest": "^29.1.1",
     "ts-node": "^10.9.1",
-    "typescript": "^5.1.6"
+    "typescript": "^5.2.2"
   }
 }