@causa/workspace-google 0.7.1 → 0.8.0

package/README.md

@@ -16,6 +16,24 @@ Add `@causa/workspace-google` to your Causa configuration in `causa.modules`.
 
 For all the Google-related configuration in your Causa files, look at [the schema for the `GoogleConfiguration`](./src/configurations/google.ts).
 
+### Firebase
+
+If you use Firebase functionalities and the corresponding CLI commands listed below (e.g. AppCheck, Identity Platform), you may want to set the configuration under the `google.firebase` path. This configuration is optional, but may speed up some CLI commands that would otherwise need to fetch the configuration from GCP using APIs every time they are run. Here is an example of such configuration:
+
+```yaml
+google:
+  firebase:
+    adminServiceAccount: firebase-adminsdk-<random ID>@<GCP project>.iam.gserviceaccount.com
+    apiKey: Public API key, e.g. for iOS, Android, or Web.
+    appId: Firebase App ID for iOS, Android, or Web.
+```
+
+- `adminServiceAccount` references a private service account only known to developers. While it cannot be used without the corresponding IAM credentials, you should ensure only developers with relevant access can read this configuration.
+- `apiKey`: Be sure to select a public API key. For example, keys embedded in client applications are safe because they are distributed to all users anyway.
+- `appId`: Firebase App IDs are also embedded in client applications. Any (public) app ID is safe to set in the configuration.
+
+This makes the `google.firebase` configuration safe to commit in your repository. Getting access to this configuration does not grant any permission that is either public or has to be set separately in IAM.
+
 ## ✨ Supported project types and commands
 
 ### Project types
@@ -162,5 +180,3 @@ Although infrastructure as code tools usually expose this feature as well (e.g.
 ### `GooglePubSubWriteTopics`
 
 [GooglePubSubWriteTopics](./src/functions/google-pubsub-write-topics.ts) writes a configuration file for each event topic, such that it can be picked up by the Causa Pub/Sub Terraform module. This allows automatic setup of Pub/Sub topics, and optionally of the corresponding BigQuery tables.
-
-Documentation of Firebase account + Firebase API key.

package/dist/functions/emulator/start-spanner.js

@@ -116,6 +116,12 @@ export class EmulatorStartForSpanner extends EmulatorStart {
             const [db, operation] = await instance.createDatabase(database.id, {
                 schema: ddls,
             });
+            // While unlikely, the database object might emit errors, e.g "The client has already been closed.".
+            // These errors could simply be ignored, as awaiting on the operation should be enough to ensure the database is
+            // created. However they are logged as warnings for completeness.
+            db.on('error', (error) => {
+                context.logger.warn(`⚠️ Uncaught Spanner database error: '${error.message}'.`);
+            });
             await operation.promise();
             await db.close();
         }));

package/package.json

@@ -1,12 +1,12 @@
 {
   "name": "@causa/workspace-google",
-  "version": "0.7.1",
+  "version": "0.8.0",
   "description": "The Causa workspace module providing many functionalities related to GCP and its services.",
   "repository": "github:causa-io/workspace-module-google",
   "license": "ISC",
   "type": "module",
   "engines": {
-    "node": ">=16"
+    "node": ">=18"
   },
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -29,46 +29,46 @@
     "test:cov": "npm run test -- --coverage"
   },
   "dependencies": {
-    "@causa/cli": ">= 0.4.1 < 1.0.0",
-    "@causa/workspace": ">= 0.12.1 < 1.0.0",
-    "@causa/workspace-core": ">= 0.19.1 < 1.0.0",
-    "@causa/workspace-typescript": ">=0.8.2",
-    "@google-cloud/apikeys": "^1.1.0",
-    "@google-cloud/bigquery": "^7.4.0",
-    "@google-cloud/iam-credentials": "^3.1.0",
-    "@google-cloud/pubsub": "^4.3.2",
-    "@google-cloud/resource-manager": "^5.1.0",
-    "@google-cloud/run": "^1.1.0",
-    "@google-cloud/secret-manager": "^5.1.0",
-    "@google-cloud/service-usage": "^3.2.0",
-    "@google-cloud/spanner": "7.3.0",
-    "@google-cloud/storage": "^7.7.0",
+    "@causa/cli": ">= 0.5.0 < 1.0.0",
+    "@causa/workspace": ">= 0.13.0 < 1.0.0",
+    "@causa/workspace-core": ">= 0.20.0 < 1.0.0",
+    "@causa/workspace-typescript": ">= 0.9.0 < 1.0.0",
+    "@google-cloud/apikeys": "^1.2.0",
+    "@google-cloud/bigquery": "^7.7.0",
+    "@google-cloud/iam-credentials": "^3.2.0",
+    "@google-cloud/pubsub": "^4.4.0",
+    "@google-cloud/resource-manager": "^5.2.0",
+    "@google-cloud/run": "^1.2.0",
+    "@google-cloud/secret-manager": "~5.3.0",
+    "@google-cloud/service-usage": "^3.3.0",
+    "@google-cloud/spanner": "7.7.0",
+    "@google-cloud/storage": "^7.11.0",
     "class-validator": "^0.14.1",
-    "firebase": "^10.8.0",
-    "firebase-admin": "^12.0.0",
+    "firebase": "^10.12.1",
+    "firebase-admin": "^12.1.0",
     "globby": "^14.0.1",
-    "google-auth-library": "^9.6.3",
-    "google-gax": "4.3.0",
-    "googleapis": "^133.0.0",
-    "pino": "^8.19.0",
-    "quicktype-core": "^23.0.104",
+    "google-auth-library": "^9.10.0",
+    "google-gax": "4.3.2",
+    "googleapis": "^137.1.0",
+    "pino": "^9.1.0",
+    "quicktype-core": "^23.0.168",
     "uuid": "^9.0.1"
   },
   "devDependencies": {
-    "@tsconfig/node18": "^18.2.2",
+    "@tsconfig/node20": "^20.1.4",
     "@types/jest": "^29.5.12",
-    "@types/node": "^18.19.17",
+    "@types/node": "^18.19.33",
     "@types/uuid": "^9.0.8",
-    "@typescript-eslint/eslint-plugin": "^7.0.2",
+    "@typescript-eslint/eslint-plugin": "^7.10.0",
     "copyfiles": "^2.4.1",
-    "eslint": "^8.56.0",
+    "eslint": "^8.57.0",
     "eslint-config-prettier": "^9.1.0",
     "eslint-plugin-prettier": "^5.1.3",
     "jest": "^29.7.0",
     "jest-extended": "^4.0.2",
-    "rimraf": "^5.0.5",
-    "ts-jest": "^29.1.2",
+    "rimraf": "^5.0.7",
+    "ts-jest": "^29.1.3",
     "ts-node": "^10.9.2",
-    "typescript": "^5.3.3"
+    "typescript": "^5.4.5"
   }
 }