@causa/workspace-google 0.3.1 → 0.5.0

package/dist/functions/event-topic/broker-delete-topic-pubsub.d.ts

@@ -0,0 +1,10 @@
+import { WorkspaceContext } from '@causa/workspace';
+import { EventTopicBrokerDeleteTopic } from '@causa/workspace-core';
+/**
+ * Implements {@link EventTopicBrokerDeleteTopic} for Pub/Sub.
+ * The `id` argument should be a full Pub/Sub topic ID, e.g. `projects/<projectId>/topics/<topicId>`.
+ */
+export declare class EventTopicBrokerDeleteTopicForPubSub extends EventTopicBrokerDeleteTopic {
+    _call(context: WorkspaceContext): Promise<void>;
+    _supports(context: WorkspaceContext): boolean;
+}

package/dist/functions/event-topic/broker-delete-topic-pubsub.js

@@ -0,0 +1,26 @@
+import { EventTopicBrokerDeleteTopic, } from '@causa/workspace-core';
+import { status } from '@grpc/grpc-js';
+import { PubSubService } from '../../services/index.js';
+/**
+ * Implements {@link EventTopicBrokerDeleteTopic} for Pub/Sub.
+ * The `id` argument should be a full Pub/Sub topic ID, e.g. `projects/<projectId>/topics/<topicId>`.
+ */
+export class EventTopicBrokerDeleteTopicForPubSub extends EventTopicBrokerDeleteTopic {
+    async _call(context) {
+        context.logger.info(`📫 Deleting Pub/Sub topic '${this.id}'.`);
+        try {
+            await context.service(PubSubService).pubSub.topic(this.id).delete();
+        }
+        catch (error) {
+            if (error.code === status.NOT_FOUND) {
+                context.logger.warn(`⚠️ Pub/Sub topic to delete '${this.id}' does not exist. It might have already been deleted.`);
+                return;
+            }
+            throw error;
+        }
+    }
+    _supports(context) {
+        return (context.asConfiguration().get('events.broker') ===
+            'google.pubSub');
+    }
+}

package/dist/functions/event-topic/broker-delete-trigger-resource-cloud-run-invoker-role.d.ts

@@ -0,0 +1,11 @@
+import { WorkspaceContext } from '@causa/workspace';
+import { EventTopicBrokerDeleteTriggerResource } from '@causa/workspace-core';
+/**
+ * Implements {@link EventTopicBrokerDeleteTriggerResource} for Cloud Run invoker roles.
+ * When setting up a Pub/Sub trigger for a Cloud Run service, a new binding is added to the Cloud Run service, allowing
+ * a dedicated service account to invoke the service. This function removes that binding.
+ */
+export declare class EventTopicBrokerDeleteTriggerResourceForCloudRunInvokerRole extends EventTopicBrokerDeleteTriggerResource {
+    _call(context: WorkspaceContext): Promise<void>;
+    _supports(context: WorkspaceContext): boolean;
+}

package/dist/functions/event-topic/broker-delete-trigger-resource-cloud-run-invoker-role.js

@@ -0,0 +1,29 @@
+import { EventTopicBrokerDeleteTriggerResource, } from '@causa/workspace-core';
+import { CloudRunService } from '../../services/index.js';
+/**
+ * The regular expression that matches a resource ID representing a Cloud Run invoker role for a given service account.
+ */
+const CLOUD_RUN_INVOKER_ID_REGEX = /^(?<serviceId>projects\/[\w-]+\/locations\/[\w-]+\/services\/[\w-]+)\/invokerBindings\/(?<pubSubServiceAccount>.+)$/;
+/**
+ * Implements {@link EventTopicBrokerDeleteTriggerResource} for Cloud Run invoker roles.
+ * When setting up a Pub/Sub trigger for a Cloud Run service, a new binding is added to the Cloud Run service, allowing
+ * a dedicated service account to invoke the service. This function removes that binding.
+ */
+export class EventTopicBrokerDeleteTriggerResourceForCloudRunInvokerRole extends EventTopicBrokerDeleteTriggerResource {
+    async _call(context) {
+        const match = this.id.match(CLOUD_RUN_INVOKER_ID_REGEX);
+        if (!match?.groups) {
+            throw new Error('Invalid Cloud Run invoker binding resource ID.');
+        }
+        const { serviceId, pubSubServiceAccount } = match.groups;
+        context.logger.info(`🛂 Removing invoker role on Cloud Run service '${serviceId}' for Pub/Sub service account '${pubSubServiceAccount}'.`);
+        await context
+            .service(CloudRunService)
+            .removeInvokerBinding(serviceId, pubSubServiceAccount);
+    }
+    _supports(context) {
+        return (this.id.match(CLOUD_RUN_INVOKER_ID_REGEX) != null &&
+            context.asConfiguration().get('events.broker') ===
+                'google.pubSub');
+    }
+}

package/dist/functions/event-topic/broker-delete-trigger-resource-pubsub-subscription.d.ts

@@ -0,0 +1,10 @@
+import { WorkspaceContext } from '@causa/workspace';
+import { EventTopicBrokerDeleteTriggerResource } from '@causa/workspace-core';
+/**
+ * Implements {@link EventTopicBrokerDeleteTriggerResource} for Pub/Sub subscriptions.
+ * Pub/Sub subscriptions are for example used when creating Cloud Run triggers.
+ */
+export declare class EventTopicBrokerDeleteTriggerResourceForPubSubSubscription extends EventTopicBrokerDeleteTriggerResource {
+    _call(context: WorkspaceContext): Promise<void>;
+    _supports(context: WorkspaceContext): boolean;
+}

package/dist/functions/event-topic/broker-delete-trigger-resource-pubsub-subscription.js

@@ -0,0 +1,31 @@
+import { EventTopicBrokerDeleteTriggerResource, } from '@causa/workspace-core';
+import { status } from '@grpc/grpc-js';
+import { PubSubService } from '../../services/index.js';
+/**
+ * Implements {@link EventTopicBrokerDeleteTriggerResource} for Pub/Sub subscriptions.
+ * Pub/Sub subscriptions are for example used when creating Cloud Run triggers.
+ */
+export class EventTopicBrokerDeleteTriggerResourceForPubSubSubscription extends EventTopicBrokerDeleteTriggerResource {
+    async _call(context) {
+        context.logger.info(`📫 Deleting Pub/Sub subscription '${this.id}'.`);
+        try {
+            await context
+                .service(PubSubService)
+                .pubSub.subscription(this.id)
+                .delete();
+        }
+        catch (error) {
+            if (error.code === status.NOT_FOUND) {
+                context.logger.warn(`⚠️ Pub/Sub subscription '${this.id}' does not exist. It might have already been deleted.`);
+            }
+            else {
+                throw error;
+            }
+        }
+    }
+    _supports(context) {
+        return (this.id.match(/^projects\/[\w-]+\/subscriptions\/[\w-]+$/) != null &&
+            context.asConfiguration().get('events.broker') ===
+                'google.pubSub');
+    }
+}

package/dist/functions/event-topic/broker-delete-trigger-resource-service-account.d.ts

@@ -0,0 +1,11 @@
+import { WorkspaceContext } from '@causa/workspace';
+import { EventTopicBrokerDeleteTriggerResource } from '@causa/workspace-core';
+/**
+ * Implements {@link EventTopicBrokerDeleteTriggerResource} for GCP service accounts.
+ * Service accounts are used by Pub/Sub push subscriptions to authenticate requests when pushing messages (e.g. to Cloud
+ * Run services).
+ */
+export declare class EventTopicBrokerDeleteTriggerResourceForServiceAccount extends EventTopicBrokerDeleteTriggerResource {
+    _call(context: WorkspaceContext): Promise<void>;
+    _supports(context: WorkspaceContext): boolean;
+}

package/dist/functions/event-topic/broker-delete-trigger-resource-service-account.js

@@ -0,0 +1,28 @@
+import { EventTopicBrokerDeleteTriggerResource, } from '@causa/workspace-core';
+import { IamService } from '../../services/index.js';
+/**
+ * Implements {@link EventTopicBrokerDeleteTriggerResource} for GCP service accounts.
+ * Service accounts are used by Pub/Sub push subscriptions to authenticate requests when pushing messages (e.g. to Cloud
+ * Run services).
+ */
+export class EventTopicBrokerDeleteTriggerResourceForServiceAccount extends EventTopicBrokerDeleteTriggerResource {
+    async _call(context) {
+        context.logger.info(`🛂 Deleting Pub/Sub backfilling service account '${this.id}'.`);
+        try {
+            await context.service(IamService).deleteServiceAccount(this.id);
+        }
+        catch (error) {
+            if (error.code === 404) {
+                context.logger.warn(`⚠️ Pub/Sub backfilling service account '${this.id}' does not exist. It might have already been deleted.`);
+            }
+            else {
+                throw error;
+            }
+        }
+    }
+    _supports(context) {
+        return (this.id.match(/^projects\/[\w-]+\/serviceAccounts\/[^/]+$/) != null &&
+            context.asConfiguration().get('events.broker') ===
+                'google.pubSub');
+    }
+}

package/dist/functions/event-topic/broker-get-topic-id-pubsub.d.ts

@@ -0,0 +1,10 @@
+import { WorkspaceContext } from '@causa/workspace';
+import { EventTopicBrokerGetTopicId } from '@causa/workspace-core';
+/**
+ * Implements {@link EventTopicBrokerGetTopicId} for Pub/Sub.
+ * The returned topic ID is a full Pub/Sub topic ID, e.g. `projects/<projectId>/topics/<topicId>`.
+ */
+export declare class EventTopicBrokerGetTopicIdForPubSub extends EventTopicBrokerGetTopicId {
+    _call(context: WorkspaceContext): Promise<string>;
+    _supports(context: WorkspaceContext): boolean;
+}

package/dist/functions/event-topic/broker-get-topic-id-pubsub.js

@@ -0,0 +1,16 @@
+import { EventTopicBrokerGetTopicId, } from '@causa/workspace-core';
+/**
+ * Implements {@link EventTopicBrokerGetTopicId} for Pub/Sub.
+ * The returned topic ID is a full Pub/Sub topic ID, e.g. `projects/<projectId>/topics/<topicId>`.
+ */
+export class EventTopicBrokerGetTopicIdForPubSub extends EventTopicBrokerGetTopicId {
+    async _call(context) {
+        const googleConf = context.asConfiguration();
+        const projectId = googleConf.getOrThrow('google.project');
+        return `projects/${projectId}/topics/${this.eventTopic}`;
+    }
+    _supports(context) {
+        return (context.asConfiguration().get('events.broker') ===
+            'google.pubSub');
+    }
+}

package/dist/functions/event-topic/broker-publish-events-google.d.ts

@@ -0,0 +1,17 @@
+import { WorkspaceContext } from '@causa/workspace';
+import { EventTopicBrokerPublishEvents } from '@causa/workspace-core';
+/**
+ * Implements {@link EventTopicBrokerPublishEvents} for a Google / GCP stack.
+ * The supported message broker is Pub/Sub.
+ */
+export declare class EventTopicBrokerPublishEventsForGoogle extends EventTopicBrokerPublishEvents {
+    /**
+     * Tries to create a {@link BackfillEventsSource} from the provided `source` and `filter`.
+     *
+     * @param context The {@link WorkspaceContext}.
+     * @returns The {@link BackfillEventsSource} to use for backfilling.
+     */
+    private createSource;
+    _call(context: WorkspaceContext): Promise<void>;
+    _supports(context: WorkspaceContext): boolean;
+}

package/dist/functions/event-topic/broker-publish-events-google.js

@@ -0,0 +1,45 @@
+import { EventTopicBrokerPublishEvents, JsonFilesEventSource, } from '@causa/workspace-core';
+import { BigQueryEventsSource, PubSubBackfillEventPublisher, } from '../../backfilling/index.js';
+/**
+ * Implements {@link EventTopicBrokerPublishEvents} for a Google / GCP stack.
+ * The supported message broker is Pub/Sub.
+ */
+export class EventTopicBrokerPublishEventsForGoogle extends EventTopicBrokerPublishEvents {
+    /**
+     * Tries to create a {@link BackfillEventsSource} from the provided `source` and `filter`.
+     *
+     * @param context The {@link WorkspaceContext}.
+     * @returns The {@link BackfillEventsSource} to use for backfilling.
+     */
+    async createSource(context) {
+        if (!this.source) {
+            const googleConf = context.asConfiguration();
+            const projectId = googleConf.getOrThrow('google.project');
+            const rawEventsDatasetId = googleConf.get('google.pubSub.bigQueryStorage.rawEventsDatasetId');
+            if (!rawEventsDatasetId) {
+                throw new Error('Cannot use the default event source because BigQuery storage is not configured.');
+            }
+            const tableName = this.eventTopic.replace(/[-\.]/g, '_');
+            const tableId = `${projectId}.${rawEventsDatasetId}.${tableName}`;
+            return new BigQueryEventsSource(context, tableId);
+        }
+        const bqSource = await BigQueryEventsSource.fromSourceAndFilter(context, this.source, this.filter);
+        if (bqSource) {
+            return bqSource;
+        }
+        const jsonFilesSource = await JsonFilesEventSource.fromSourceAndFilter(context, this.source, this.filter);
+        if (jsonFilesSource) {
+            return jsonFilesSource;
+        }
+        throw new Error(`The event source '${this.source}' is not supported.`);
+    }
+    async _call(context) {
+        const source = await this.createSource(context);
+        const publisher = new PubSubBackfillEventPublisher(context, this.topicId);
+        await publisher.publishFromSource(source);
+    }
+    _supports(context) {
+        return (context.asConfiguration().get('events.broker') ===
+            'google.pubSub');
+    }
+}

package/dist/functions/event-topic/index.d.ts

@@ -0,0 +1,8 @@
+export { EventTopicBrokerCreateTopicForPubSub } from './broker-create-topic-pubsub.js';
+export { EventTopicBrokerCreateTriggerForCloudRun } from './broker-create-trigger-cloud-run.js';
+export { EventTopicBrokerDeleteTopicForPubSub } from './broker-delete-topic-pubsub.js';
+export { EventTopicBrokerDeleteTriggerResourceForCloudRunInvokerRole } from './broker-delete-trigger-resource-cloud-run-invoker-role.js';
+export { EventTopicBrokerDeleteTriggerResourceForPubSubSubscription } from './broker-delete-trigger-resource-pubsub-subscription.js';
+export { EventTopicBrokerDeleteTriggerResourceForServiceAccount } from './broker-delete-trigger-resource-service-account.js';
+export { EventTopicBrokerGetTopicIdForPubSub } from './broker-get-topic-id-pubsub.js';
+export { EventTopicBrokerPublishEventsForGoogle } from './broker-publish-events-google.js';

package/dist/functions/event-topic/index.js

@@ -0,0 +1,8 @@
+export { EventTopicBrokerCreateTopicForPubSub } from './broker-create-topic-pubsub.js';
+export { EventTopicBrokerCreateTriggerForCloudRun } from './broker-create-trigger-cloud-run.js';
+export { EventTopicBrokerDeleteTopicForPubSub } from './broker-delete-topic-pubsub.js';
+export { EventTopicBrokerDeleteTriggerResourceForCloudRunInvokerRole } from './broker-delete-trigger-resource-cloud-run-invoker-role.js';
+export { EventTopicBrokerDeleteTriggerResourceForPubSubSubscription } from './broker-delete-trigger-resource-pubsub-subscription.js';
+export { EventTopicBrokerDeleteTriggerResourceForServiceAccount } from './broker-delete-trigger-resource-service-account.js';
+export { EventTopicBrokerGetTopicIdForPubSub } from './broker-get-topic-id-pubsub.js';
+export { EventTopicBrokerPublishEventsForGoogle } from './broker-publish-events-google.js';

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

@@ -12,8 +12,8 @@ import { WorkspaceFunction } from '@causa/workspace';
 import { AllowMissing } from '@causa/workspace/validation';
 import { IsString } from 'class-validator';
 import { getAppCheck } from 'firebase-admin/app-check';
-import { appCheckCommandDefinition } from '../cli/index.js';
-import { FirebaseAppService } from '../services/index.js';
+import { appCheckCommandDefinition } from '../../cli/index.js';
+import { FirebaseAppService } from '../../services/index.js';
 /**
  * The time to live of generated tokens, in seconds.
  */

package/dist/functions/google-app-check/index.d.ts

@@ -0,0 +1 @@
+export { GoogleAppCheckGenerateToken } from './generate-token.js';

package/dist/functions/google-app-check/index.js

@@ -0,0 +1 @@
+export { GoogleAppCheckGenerateToken } from './generate-token.js';

package/dist/functions/google-firebase-storage/index.d.ts

@@ -0,0 +1 @@
+export { GoogleFirebaseStorageMergeRules } from './merge-rules.js';

package/dist/functions/google-firebase-storage/index.js

@@ -0,0 +1 @@
+export { GoogleFirebaseStorageMergeRules } from './merge-rules.js';

package/dist/functions/{google-firebase-storage-merge-rules.d.ts → google-firebase-storage/merge-rules.d.ts}

@@ -1,6 +1,6 @@
 import { WorkspaceContext, WorkspaceFunction } from '@causa/workspace';
 import { InfrastructureProcessor } from '@causa/workspace-core';
-import { GoogleConfiguration } from '../configurations/index.js';
+import { GoogleConfiguration } from '../../configurations/index.js';
 /**
  * The return value of {@link GoogleFirebaseStorageMergeRules}.
  */

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

@@ -11,8 +11,8 @@ import { CliCommand } from '@causa/cli';
 import { WorkspaceFunction } from '@causa/workspace';
 import { AllowMissing } from '@causa/workspace/validation';
 import { IsBoolean } from 'class-validator';
-import { firebaseStorageCommandDefinition } from '../cli/index.js';
-import { mergeFirebaseRulesFiles } from '../firebase/index.js';
+import { firebaseStorageCommandDefinition } from '../../cli/index.js';
+import { mergeFirebaseRulesFiles } from '../../firebase/index.js';
 /**
  * The default location where the security rules file for Firebase Storage will be written.
  */

package/dist/functions/google-firestore/index.d.ts

@@ -0,0 +1 @@
+export { GoogleFirestoreMergeRules } from './merge-rules.js';

package/dist/functions/google-firestore/index.js

@@ -0,0 +1 @@
+export { GoogleFirestoreMergeRules } from './merge-rules.js';

package/dist/functions/{google-firestore-merge-rules.d.ts → google-firestore/merge-rules.d.ts}

@@ -1,6 +1,6 @@
 import { WorkspaceContext, WorkspaceFunction } from '@causa/workspace';
 import { InfrastructureProcessor } from '@causa/workspace-core';
-import { GoogleConfiguration } from '../configurations/index.js';
+import { GoogleConfiguration } from '../../configurations/index.js';
 /**
  * The return value of {@link GoogleFirestoreMergeRules}.
  */

package/dist/functions/{google-firestore-merge-rules.js → google-firestore/merge-rules.js}

@@ -11,8 +11,8 @@ import { CliCommand } from '@causa/cli';
 import { WorkspaceFunction } from '@causa/workspace';
 import { AllowMissing } from '@causa/workspace/validation';
 import { IsBoolean } from 'class-validator';
-import { firestoreCommandDefinition } from '../cli/index.js';
-import { mergeFirebaseRulesFiles } from '../firebase/index.js';
+import { firestoreCommandDefinition } from '../../cli/index.js';
+import { mergeFirebaseRulesFiles } from '../../firebase/index.js';
 /**
  * The default location where the security rules file for Firestore will be written.
  */

package/dist/functions/{google-identity-platform-generate-custom-token.js → google-identity-platform/generate-custom-token.js}

@@ -11,7 +11,7 @@ import { WorkspaceFunction } from '@causa/workspace';
 import { AllowMissing } from '@causa/workspace/validation';
 import { IsObject, IsString } from 'class-validator';
 import { getAuth } from 'firebase-admin/auth';
-import { FirebaseAppService } from '../index.js';
+import { FirebaseAppService } from '../../services/index.js';
 /**
  * Generates a custom token that can be used to sign in to Identity Platform as a given user.
  * Optionally, custom claims can be set in the token.

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

@@ -13,9 +13,9 @@ import { AllowMissing } from '@causa/workspace/validation';
 import { Transform } from 'class-transformer';
 import { IsObject, IsString } from 'class-validator';
 import { getAuth, signInWithCustomToken } from 'firebase/auth';
-import { identityPlatformCommandDefinition } from '../cli/index.js';
-import { FirebaseAppService } from '../services/index.js';
-import { GoogleIdentityPlatformGenerateCustomToken } from './google-identity-platform-generate-custom-token.js';
+import { identityPlatformCommandDefinition } from '../../cli/index.js';
+import { FirebaseAppService } from '../../services/index.js';
+import { GoogleIdentityPlatformGenerateCustomToken } from './generate-custom-token.js';
 /**
  * Generates an ID token for an Identity Platform end user.
  * For this function to succeed, the `google.project` should be set, which usually means setting the environment in the

package/dist/functions/google-identity-platform/index.d.ts

@@ -0,0 +1,2 @@
+export { GoogleIdentityPlatformGenerateCustomToken } from './generate-custom-token.js';
+export { GoogleIdentityPlatformGenerateToken } from './generate-token.js';

package/dist/functions/google-identity-platform/index.js

@@ -0,0 +1,2 @@
+export { GoogleIdentityPlatformGenerateCustomToken } from './generate-custom-token.js';
+export { GoogleIdentityPlatformGenerateToken } from './generate-token.js';

package/dist/functions/google-pubsub/index.d.ts

@@ -0,0 +1 @@
+export { GooglePubSubWriteTopics } from './write-topics.js';

package/dist/functions/google-pubsub/index.js

@@ -0,0 +1 @@
+export { GooglePubSubWriteTopics } from './write-topics.js';

package/dist/functions/google-pubsub/write-topics.d.ts

@@ -0,0 +1,22 @@
+import { ProcessorResult, WorkspaceContext, WorkspaceFunction } from '@causa/workspace';
+import { InfrastructureProcessor } from '@causa/workspace-core';
+/**
+ * A function that uses {@link EventTopicList} to find all the topics in the workspace, and writes their configurations
+ * to a directory.
+ * The `google.pubSub.topicConfigurationsDirectory` configuration can be used to specify the output location of the
+ * topic configurations.
+ * This function returns a partial configuration, such that it can be used as a processor.
+ */
+export declare class GooglePubSubWriteTopics extends WorkspaceFunction<Promise<ProcessorResult>> implements InfrastructureProcessor {
+    readonly tearDown?: boolean;
+    /**
+     * Returns the path to the directory where Pub/Sub topic configurations should be written.
+     * It is either fetched from the workspace configuration, or the default value is used.
+     *
+     * @param context The {@link WorkspaceContext}.
+     * @returns The path to the directory where topic configurations should be written.
+     */
+    private getConfigurationsDirectory;
+    _call(context: WorkspaceContext): Promise<ProcessorResult>;
+    _supports(): boolean;
+}

package/dist/functions/google-pubsub/write-topics.js

@@ -0,0 +1,80 @@
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+import { WorkspaceFunction, } from '@causa/workspace';
+import { EventTopicList, } from '@causa/workspace-core';
+import { CAUSA_FOLDER } from '@causa/workspace/initialization';
+import { AllowMissing } from '@causa/workspace/validation';
+import { IsBoolean } from 'class-validator';
+import { mkdir, rm, writeFile } from 'fs/promises';
+import { join } from 'path';
+/**
+ * The default directory where Pub/Sub topic configurations are written, relative to the workspace root.
+ */
+const DEFAULT_TOPIC_CONFIGURATIONS_DIRECTORY = join(CAUSA_FOLDER, 'pubsub-topics');
+/**
+ * A function that uses {@link EventTopicList} to find all the topics in the workspace, and writes their configurations
+ * to a directory.
+ * The `google.pubSub.topicConfigurationsDirectory` configuration can be used to specify the output location of the
+ * topic configurations.
+ * This function returns a partial configuration, such that it can be used as a processor.
+ */
+export class GooglePubSubWriteTopics extends WorkspaceFunction {
+    tearDown;
+    /**
+     * Returns the path to the directory where Pub/Sub topic configurations should be written.
+     * It is either fetched from the workspace configuration, or the default value is used.
+     *
+     * @param context The {@link WorkspaceContext}.
+     * @returns The path to the directory where topic configurations should be written.
+     */
+    getConfigurationsDirectory(context) {
+        return (context
+            .asConfiguration()
+            .get('google.pubSub.topicConfigurationsDirectory') ??
+            DEFAULT_TOPIC_CONFIGURATIONS_DIRECTORY);
+    }
+    async _call(context) {
+        const topicConfigurationsDirectory = this.getConfigurationsDirectory(context);
+        const absoluteDir = join(context.rootPath, topicConfigurationsDirectory);
+        await rm(absoluteDir, { recursive: true, force: true });
+        if (this.tearDown) {
+            context.logger.debug(`📫 Tore down Pub/Sub topic configurations directory '${absoluteDir}'.`);
+            return { configuration: {} };
+        }
+        context.logger.info('️📫 Listing and writing Pub/Sub topic configurations.');
+        const topics = await context.call(EventTopicList, {});
+        context.logger.debug(`📫 Writing configurations for Pub/Sub topics: ${topics
+            .map((d) => `'${d.id}'`)
+            .join(', ')}.`);
+        await mkdir(absoluteDir, { recursive: true });
+        await Promise.all(topics.map(async (topic) => {
+            const topicConfiguration = {
+                ...topic,
+                bigQueryTableName: topic.id.replace(/[-\.]/g, '_'),
+            };
+            const topicFile = join(absoluteDir, `${topic.id}.json`);
+            await writeFile(topicFile, JSON.stringify(topicConfiguration));
+        }));
+        context.logger.debug(`️📫 Wrote Pub/Sub topic configurations in '${absoluteDir}'.`);
+        return {
+            configuration: {
+                google: { pubSub: { topicConfigurationsDirectory } },
+            },
+        };
+    }
+    _supports() {
+        return true;
+    }
+}
+__decorate([
+    IsBoolean(),
+    AllowMissing(),
+    __metadata("design:type", Boolean)
+], GooglePubSubWriteTopics.prototype, "tearDown", void 0);

package/dist/functions/{google-services-enable.d.ts → google-services/enable.d.ts}

@@ -1,6 +1,6 @@
 import { WorkspaceContext, WorkspaceFunction } from '@causa/workspace';
 import { InfrastructureProcessor } from '@causa/workspace-core';
-import { GoogleConfiguration } from '../configurations/index.js';
+import { GoogleConfiguration } from '../../configurations/index.js';
 /**
  * The return value of {@link GoogleServicesEnable}.
  */

package/dist/functions/{google-services-enable.js → google-services/enable.js}

@@ -12,7 +12,7 @@ import { WorkspaceFunction } from '@causa/workspace';
 import { AllowMissing } from '@causa/workspace/validation';
 import { ServiceUsageClient } from '@google-cloud/service-usage';
 import { IsBoolean } from 'class-validator';
-import { googleCommandDefinition } from '../cli/index.js';
+import { googleCommandDefinition } from '../../cli/index.js';
 /**
  * The maximum number of GCP services that can be enabled at the same time.
  */

package/dist/functions/google-services/index.d.ts

@@ -0,0 +1 @@
+export { GoogleServicesEnable } from './enable.js';

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

@@ -0,0 +1 @@
+export { GoogleServicesEnable } from './enable.js';

package/dist/functions/google-spanner/index.d.ts

@@ -0,0 +1,2 @@
+export { GoogleSpannerListDatabases } from './list-databases.js';
+export { GoogleSpannerWriteDatabases } from './write-databases.js';

package/dist/functions/google-spanner/index.js

@@ -0,0 +1,2 @@
+export { GoogleSpannerListDatabases } from './list-databases.js';
+export { GoogleSpannerWriteDatabases } from './write-databases.js';

package/dist/functions/google-spanner/write-databases.d.ts

@@ -0,0 +1,22 @@
+import { ProcessorResult, WorkspaceContext, WorkspaceFunction } from '@causa/workspace';
+import { InfrastructureProcessor } from '@causa/workspace-core';
+/**
+ * A function that uses {@link GoogleSpannerListDatabases} to find all the Spanner databases in the workspace, and
+ * writes their configurations to a directory.
+ * The `google.spanner.databaseConfigurationsDirectory` configuration can be used to specify the output location of the
+ * database configurations.
+ * This function returns a partial configuration, such that it can be used as a processor.
+ */
+export declare class GoogleSpannerWriteDatabases extends WorkspaceFunction<Promise<ProcessorResult>> implements InfrastructureProcessor {
+    readonly tearDown?: boolean;
+    /**
+     * Returns the path to the directory where Spanner databases configurations should be written.
+     * It is either fetched from the workspace configuration, or the default value is used.
+     *
+     * @param context The {@link WorkspaceContext}.
+     * @returns The path to the directory where database configurations should be written.
+     */
+    private getConfigurationsDirectory;
+    _call(context: WorkspaceContext): Promise<ProcessorResult>;
+    _supports(): boolean;
+}