@causa/workspace-google 0.2.0 → 0.3.0

package/dist/functions/google-app-check-generate-token.js

@@ -21,7 +21,7 @@ const TOKEN_TTL = 3600;
 /**
  * Generates a new AppCheck token.
  */
-let GoogleAppCheckGenerateToken = class GoogleAppCheckGenerateToken extends WorkspaceFunction {
+export let GoogleAppCheckGenerateToken = class GoogleAppCheckGenerateToken extends WorkspaceFunction {
     /**
      * The ID of the Firebase app for which the token will be generated.
      * If `undefined`, a Firebase app ID will be found in the configuration or using the API.
@@ -64,4 +64,3 @@ If the Firebase app ID is not specified, it will:
         outputFn: (token) => console.log(token),
     })
 ], GoogleAppCheckGenerateToken);
-export { GoogleAppCheckGenerateToken };

package/dist/functions/google-firebase-storage-merge-rules.js

@@ -27,7 +27,7 @@ const DEFAULT_FIREBASE_STORAGE_SECURITY_RULE_FILE = 'storage.rules';
  * Returns a configuration with `google.firebaseStorage.securityRuleFile` set, such that the function can be used as a
  * processor.
  */
-let GoogleFirebaseStorageMergeRules = class GoogleFirebaseStorageMergeRules extends WorkspaceFunction {
+export let GoogleFirebaseStorageMergeRules = class GoogleFirebaseStorageMergeRules extends WorkspaceFunction {
     tearDown;
     async _call(context) {
         if (this.tearDown) {
@@ -69,4 +69,3 @@ Input files are looked for in the workspace using the globs defined in google.fi
         outputFn: ({ securityRuleFile }) => console.log(securityRuleFile),
     })
 ], GoogleFirebaseStorageMergeRules);
-export { GoogleFirebaseStorageMergeRules };

package/dist/functions/google-firestore-merge-rules.js

@@ -27,7 +27,7 @@ const DEFAULT_FIRESTORE_SECURITY_RULE_FILE = 'firestore.rules';
  * Returns a configuration with `google.firestore.securityRuleFile` set, such that the function can be used as a
  * processor.
  */
-let GoogleFirestoreMergeRules = class GoogleFirestoreMergeRules extends WorkspaceFunction {
+export let GoogleFirestoreMergeRules = class GoogleFirestoreMergeRules extends WorkspaceFunction {
     tearDown;
     async _call(context) {
         if (this.tearDown) {
@@ -69,4 +69,3 @@ Input files are looked for in the workspace using the globs defined in google.fi
         outputFn: ({ securityRuleFile }) => console.log(securityRuleFile),
     })
 ], GoogleFirestoreMergeRules);
-export { GoogleFirestoreMergeRules };

package/dist/functions/google-identity-platform-generate-token.js

@@ -21,7 +21,7 @@ import { GoogleIdentityPlatformGenerateCustomToken } from './google-identity-pla
  * For this function to succeed, the `google.project` should be set, which usually means setting the environment in the
  * context. Also `google.firebase` children can be used to configure (and speed up) how tokens are generated.
  */
-let GoogleIdentityPlatformGenerateToken = class GoogleIdentityPlatformGenerateToken extends WorkspaceFunction {
+export let GoogleIdentityPlatformGenerateToken = class GoogleIdentityPlatformGenerateToken extends WorkspaceFunction {
     /**
      * The ID of the user for which the token will be generated.
      */
@@ -71,4 +71,3 @@ Optional custom claims can be included in the signed token.`,
         outputFn: (token) => console.log(token),
     })
 ], GoogleIdentityPlatformGenerateToken);
-export { GoogleIdentityPlatformGenerateToken };

package/dist/functions/google-services-enable.js

@@ -20,7 +20,7 @@ const MAX_SERVICE_BATCH = 20;
 /**
  * Enables GCP services defined in `google.services` for the GCP project defined in `google.project`.
  */
-let GoogleServicesEnable = class GoogleServicesEnable extends WorkspaceFunction {
+export let GoogleServicesEnable = class GoogleServicesEnable extends WorkspaceFunction {
     tearDown;
     async _call(context) {
         if (this.tearDown) {
@@ -72,4 +72,3 @@ They will be enabled in the 'google.project' GCP project.`,
         outputFn: ({ services }) => console.log(services.join('\n')),
     })
 ], GoogleServicesEnable);
-export { GoogleServicesEnable };

package/dist/functions/index.js

@@ -15,8 +15,10 @@ import { GoogleIdentityPlatformGenerateCustomToken } from './google-identity-pla
 import { GoogleIdentityPlatformGenerateToken } from './google-identity-platform-generate-token.js';
 import { GoogleServicesEnable } from './google-services-enable.js';
 import { GoogleSpannerListDatabases } from './google-spanner-list-databases.js';
-import { ProjectGetArtefactDestinationForServiceContainer } from './project-get-artefact-destination-service-container.js';
+import { ProjectGetArtefactDestinationForCloudFunctions } from './project-get-artefact-destination-cloud-functions.js';
+import { ProjectGetArtefactDestinationForCloudRun } from './project-get-artefact-destination-cloud-run.js';
+import { ProjectPushArtefactForCloudFunctions } from './project-push-artefact-cloud-functions.js';
 import { SecretFetchForGoogleSecretManager } from './secret-fetch-secret-manager.js';
 export function registerFunctions(context) {
-    context.registerFunctionImplementations(EmulatorStartForFirebaseStorage, EmulatorStartForFirestore, EmulatorStartForIdentityPlatform, EmulatorStartForPubSub, EmulatorStartForSpanner, EmulatorStopForFirebaseStorage, EmulatorStopForFirestore, EmulatorStopForIdentityPlatform, EmulatorStopForPubSub, EmulatorStopForSpanner, GoogleAppCheckGenerateToken, GoogleFirebaseStorageMergeRules, GoogleFirestoreMergeRules, GoogleIdentityPlatformGenerateCustomToken, GoogleIdentityPlatformGenerateToken, GoogleServicesEnable, GoogleSpannerListDatabases, ProjectGetArtefactDestinationForServiceContainer, SecretFetchForGoogleSecretManager);
+    context.registerFunctionImplementations(EmulatorStartForFirebaseStorage, EmulatorStartForFirestore, EmulatorStartForIdentityPlatform, EmulatorStartForPubSub, EmulatorStartForSpanner, EmulatorStopForFirebaseStorage, EmulatorStopForFirestore, EmulatorStopForIdentityPlatform, EmulatorStopForPubSub, EmulatorStopForSpanner, GoogleAppCheckGenerateToken, GoogleFirebaseStorageMergeRules, GoogleFirestoreMergeRules, GoogleIdentityPlatformGenerateCustomToken, GoogleIdentityPlatformGenerateToken, GoogleServicesEnable, GoogleSpannerListDatabases, ProjectGetArtefactDestinationForCloudFunctions, ProjectGetArtefactDestinationForCloudRun, ProjectPushArtefactForCloudFunctions, SecretFetchForGoogleSecretManager);
 }

package/dist/functions/project-get-artefact-destination-cloud-functions.d.ts

@@ -0,0 +1,11 @@
+import { WorkspaceContext } from '@causa/workspace';
+import { ProjectGetArtefactDestination } from '@causa/workspace-core';
+/**
+ * Implements the {@link ProjectGetArtefactDestination} function for Cloud Functions projects.
+ * Cloud Functions archives are stored in a Google Cloud Storage bucket, the destination of which must be
+ * defined in the `google.cloudFunctions.archivesStorageLocation` configuration.
+ */
+export declare class ProjectGetArtefactDestinationForCloudFunctions extends ProjectGetArtefactDestination {
+    _call(context: WorkspaceContext): Promise<string>;
+    _supports(context: WorkspaceContext): boolean;
+}

package/dist/functions/project-get-artefact-destination-cloud-functions.js

@@ -0,0 +1,18 @@
+import { ProjectGetArtefactDestination, } from '@causa/workspace-core';
+/**
+ * Implements the {@link ProjectGetArtefactDestination} function for Cloud Functions projects.
+ * Cloud Functions archives are stored in a Google Cloud Storage bucket, the destination of which must be
+ * defined in the `google.cloudFunctions.archivesStorageLocation` configuration.
+ */
+export class ProjectGetArtefactDestinationForCloudFunctions extends ProjectGetArtefactDestination {
+    async _call(context) {
+        const projectName = context.getOrThrow('project.name');
+        const archivesStorageLocation = context.getOrThrow('google.cloudFunctions.archivesStorageLocation');
+        return `${archivesStorageLocation}/${projectName}/${this.tag}.zip`;
+    }
+    _supports(context) {
+        const conf = context.asConfiguration();
+        return (conf.get('project.type') === 'serverlessFunctions' &&
+            conf.get('serverlessFunctions.platform') === 'google.cloudFunctions');
+    }
+}

package/dist/functions/{project-get-artefact-destination-service-container.d.ts → project-get-artefact-destination-cloud-run.d.ts}

@@ -4,7 +4,7 @@ import { ProjectGetArtefactDestination } from '@causa/workspace-core';
  * Implements the {@link ProjectGetArtefactDestination} function for Cloud Run services.
  * The destination Docker repository is expected to be defined in `google.cloudRun.dockerRepository`.
  */
-export declare class ProjectGetArtefactDestinationForServiceContainer extends ProjectGetArtefactDestination {
+export declare class ProjectGetArtefactDestinationForCloudRun extends ProjectGetArtefactDestination {
     _call(context: WorkspaceContext): Promise<string>;
     _supports(context: WorkspaceContext): boolean;
 }

package/dist/functions/{project-get-artefact-destination-service-container.js → project-get-artefact-destination-cloud-run.js}

@@ -3,7 +3,7 @@ import { ProjectGetArtefactDestination, } from '@causa/workspace-core';
  * Implements the {@link ProjectGetArtefactDestination} function for Cloud Run services.
  * The destination Docker repository is expected to be defined in `google.cloudRun.dockerRepository`.
  */
-export class ProjectGetArtefactDestinationForServiceContainer extends ProjectGetArtefactDestination {
+export class ProjectGetArtefactDestinationForCloudRun extends ProjectGetArtefactDestination {
     async _call(context) {
         const projectName = context.getOrThrow('project.name');
         const dockerRepository = context.getOrThrow('google.cloudRun.dockerRepository');

package/dist/functions/project-push-artefact-cloud-functions.d.ts

@@ -0,0 +1,11 @@
+import { WorkspaceContext } from '@causa/workspace';
+import { ProjectPushArtefact } from '@causa/workspace-core';
+/**
+ * Implements the {@link ProjectPushArtefact} function for Cloud Functions projects.
+ * This copies the local archive of the Cloud Functions project to the Google Cloud Storage URI set in
+ * {@link ProjectPushArtefact.destination}.
+ */
+export declare class ProjectPushArtefactForCloudFunctions extends ProjectPushArtefact {
+    _call(context: WorkspaceContext): Promise<string>;
+    _supports(context: WorkspaceContext): boolean;
+}

package/dist/functions/project-push-artefact-cloud-functions.js

@@ -0,0 +1,31 @@
+import { ArtefactAlreadyExistsError, ProjectPushArtefact, } from '@causa/workspace-core';
+import { rm } from 'fs/promises';
+import { CloudStorageService } from '../services/index.js';
+/**
+ * Implements the {@link ProjectPushArtefact} function for Cloud Functions projects.
+ * This copies the local archive of the Cloud Functions project to the Google Cloud Storage URI set in
+ * {@link ProjectPushArtefact.destination}.
+ */
+export class ProjectPushArtefactForCloudFunctions extends ProjectPushArtefact {
+    async _call(context) {
+        context.logger.info(`🚚 Pushing Cloud Functions archive to Cloud Storage.`);
+        const storageService = context.service(CloudStorageService);
+        const destination = storageService.getFileFromGsUri(this.destination);
+        if (!this.overwrite) {
+            const [exists] = await destination.exists();
+            if (exists) {
+                throw new ArtefactAlreadyExistsError(this.destination);
+            }
+        }
+        await destination.bucket.upload(this.artefact, { destination });
+        context.logger.info(`🚚 Successfully pushed archive to '${this.destination}'.`);
+        context.logger.debug(`🔥 Removing local artefact '${this.artefact}'.`);
+        await rm(this.artefact);
+        return this.destination;
+    }
+    _supports(context) {
+        const conf = context.asConfiguration();
+        return (conf.get('project.type') === 'serverlessFunctions' &&
+            conf.get('serverlessFunctions.platform') === 'google.cloudFunctions');
+    }
+}

package/dist/services/index.d.ts

@@ -4,3 +4,5 @@ export { FirebaseEmulatorService } from './firebase-emulator.js';
 export { GcloudEmulatorService } from './gcloud-emulator.js';
 export { GoogleApisService } from './google-apis.js';
 export { GoogleSecretManagerService } from './secret-manager.js';
+export * from './storage.errors.js';
+export { CloudStorageService } from './storage.js';

package/dist/services/index.js

@@ -4,3 +4,5 @@ export { FirebaseEmulatorService } from './firebase-emulator.js';
 export { GcloudEmulatorService } from './gcloud-emulator.js';
 export { GoogleApisService } from './google-apis.js';
 export { GoogleSecretManagerService } from './secret-manager.js';
+export * from './storage.errors.js';
+export { CloudStorageService } from './storage.js';

package/dist/services/storage.d.ts

@@ -0,0 +1,33 @@
+import { File, Storage } from '@google-cloud/storage';
+/**
+ * A service for interacting with Google Cloud Storage.
+ * It exposes a singleton instance of the Google Cloud Storage client.
+ */
+export declare class CloudStorageService {
+    readonly storage: Storage;
+    constructor();
+    /**
+     * Parses a Google Cloud Storage URI into a bucket and path.
+     * Cloud Storage URIs are of the form `gs://<bucket>/<path>`.
+     *
+     * @param uri The Google Cloud Storage URI.
+     * @returns The name of the Google Cloud Storage bucket and the path within the bucket.
+     */
+    parseGsUri(uri: string): {
+        /**
+         * The name of the Google Cloud Storage bucket.
+         */
+        readonly bucket: string;
+        /**
+         * The path within the bucket.
+         */
+        readonly path: string;
+    };
+    /**
+     * Parses a Google Cloud Storage URI into a {@link File}.
+     *
+     * @param uri The Google Cloud Storage URI.
+     * @returns The {@link File} at the given URI.
+     */
+    getFileFromGsUri(uri: string): File;
+}

package/dist/services/storage.errors.d.ts

@@ -0,0 +1,8 @@
+/**
+ * An error thrown when the Cloud Storage URI is invalid.
+ * Cloud Storage URIs are of the form `gs://<bucket>/<path>`.
+ */
+export declare class InvalidCloudStorageUriError extends Error {
+    readonly uri: string;
+    constructor(uri: string);
+}

package/dist/services/storage.errors.js

@@ -0,0 +1,11 @@
+/**
+ * An error thrown when the Cloud Storage URI is invalid.
+ * Cloud Storage URIs are of the form `gs://<bucket>/<path>`.
+ */
+export class InvalidCloudStorageUriError extends Error {
+    uri;
+    constructor(uri) {
+        super(`Invalid Google Cloud Storage URI: '${uri}'.`);
+        this.uri = uri;
+    }
+}

package/dist/services/storage.js

@@ -0,0 +1,36 @@
+import { Storage } from '@google-cloud/storage';
+import { InvalidCloudStorageUriError } from './storage.errors.js';
+/**
+ * A service for interacting with Google Cloud Storage.
+ * It exposes a singleton instance of the Google Cloud Storage client.
+ */
+export class CloudStorageService {
+    storage;
+    constructor() {
+        this.storage = new Storage();
+    }
+    /**
+     * Parses a Google Cloud Storage URI into a bucket and path.
+     * Cloud Storage URIs are of the form `gs://<bucket>/<path>`.
+     *
+     * @param uri The Google Cloud Storage URI.
+     * @returns The name of the Google Cloud Storage bucket and the path within the bucket.
+     */
+    parseGsUri(uri) {
+        const match = uri.match(/^gs:\/\/([^/]+)\/(.*)$/);
+        if (!match) {
+            throw new InvalidCloudStorageUriError(uri);
+        }
+        return { bucket: match[1], path: match[2] };
+    }
+    /**
+     * Parses a Google Cloud Storage URI into a {@link File}.
+     *
+     * @param uri The Google Cloud Storage URI.
+     * @returns The {@link File} at the given URI.
+     */
+    getFileFromGsUri(uri) {
+        const { bucket, path } = this.parseGsUri(uri);
+        return this.storage.bucket(bucket).file(path);
+    }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@causa/workspace-google",
-  "version": "0.2.0",
+  "version": "0.3.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,16 +31,17 @@
   "dependencies": {
     "@causa/cli": ">= 0.3.3 < 1.0.0",
     "@causa/workspace": ">= 0.7.0 < 1.0.0",
-    "@causa/workspace-core": ">= 0.4.0 < 1.0.0",
+    "@causa/workspace-core": ">= 0.6.0 < 1.0.0",
     "@google-cloud/apikeys": "^0.2.2",
     "@google-cloud/iam-credentials": "^2.0.4",
-    "@google-cloud/pubsub": "^3.6.0",
+    "@google-cloud/pubsub": "^3.7.0",
     "@google-cloud/secret-manager": "^4.2.2",
     "@google-cloud/service-usage": "^2.2.2",
-    "@google-cloud/spanner": "^6.10.0",
+    "@google-cloud/spanner": "^6.10.1",
+    "@google-cloud/storage": "^6.10.1",
     "class-validator": "^0.14.0",
-    "firebase": "^9.22.0",
-    "firebase-admin": "^11.8.0",
+    "firebase": "^9.22.1",
+    "firebase-admin": "^11.9.0",
     "globby": "^13.1.4",
     "google-gax": "^3.6.0",
     "googleapis": "^118.0.0",
@@ -48,8 +49,8 @@
   },
   "devDependencies": {
     "@tsconfig/node18": "^2.0.1",
-    "@types/jest": "^29.5.1",
-    "@types/node": "^18.16.14",
+    "@types/jest": "^29.5.2",
+    "@types/node": "^18.16.16",
     "@types/uuid": "^9.0.1",
     "copyfiles": "^2.4.1",
     "eslint": "^8.41.0",
@@ -60,6 +61,6 @@
     "rimraf": "^5.0.1",
     "ts-jest": "^29.1.0",
     "ts-node": "^10.9.1",
-    "typescript": "^5.0.4"
+    "typescript": "^5.1.3"
   }
 }