@causa/workspace-google 1.0.1 → 1.2.0

package/README.md

@@ -130,7 +130,8 @@ additionalProperties: false
 causa:
   # This must be set for the decorators to be added to the class.
   googleFirestoreCollection:
-    # Mandatory, the name of the Firestore collection.
+    # Optional, the name of the Firestore collection.
+    # If not set, the `name` is omitted from the decorator options.
     name: myCollection
     # Mandatory, determines how to create the path for a document.
     path: [property: id]
@@ -166,6 +167,8 @@ model:
           # Same as Spanner globs.
           globs:
             - ../firestore/*.yaml
+          # Optional, generates the document path as an array of segments instead of a slash-joined string.
+          pathAsArray: true
 ```
 
 ## 🔨 Custom `google` commands

package/dist/functions/google-firestore/generate-typescript-decorators.js

@@ -26,7 +26,9 @@ export class ModelGenerateTypeScriptDecoratorsForGoogleFirestore extends ModelGe
         if (!attribute) {
             return [];
         }
-        const globs = this.configuration?.google?.firestore?.globs;
+        const firestoreConfiguration = this.configuration?.google
+            ?.firestore;
+        const globs = firestoreConfiguration?.globs;
         if (Array.isArray(globs)) {
             const projectPath = this._context.getProjectPathOrThrow();
             const absoluteGlobs = globs.map((g) => join(projectPath, g));
@@ -40,8 +42,8 @@ export class ModelGenerateTypeScriptDecoratorsForGoogleFirestore extends ModelGe
             throw new Error(`Invalid '${GOOGLE_FIRESTORE_COLLECTION_EXTENSION}' attribute on '${debugName}'. Expected an object.`);
         }
         const { name, path, hasSoftDelete } = attribute;
-        if (typeof name !== 'string') {
-            throw new Error(`Invalid '${GOOGLE_FIRESTORE_COLLECTION_EXTENSION}' attribute on '${debugName}'. Expected an object with a 'name' string property.`);
+        if (name !== undefined && typeof name !== 'string') {
+            throw new Error(`Invalid '${GOOGLE_FIRESTORE_COLLECTION_EXTENSION}' attribute on '${debugName}'. Expected the 'name' property to be a string.`);
         }
         if (!Array.isArray(path)) {
             throw new Error(`Invalid '${GOOGLE_FIRESTORE_COLLECTION_EXTENSION}' attribute on '${debugName}'. Expected an object with a 'path' array property.`);
@@ -63,9 +65,17 @@ export class ModelGenerateTypeScriptDecoratorsForGoogleFirestore extends ModelGe
             }
             throw new Error(`Invalid path element in '${GOOGLE_FIRESTORE_COLLECTION_EXTENSION}' attribute on '${debugName}'.`);
         });
-        const pathExpression = path.length === 1 ? elements[0] : `[${elements.join(', ')}].join("/")`;
+        const pathExpression = firestoreConfiguration?.pathAsArray === true
+            ? `[${elements.join(', ')}]`
+            : path.length === 1
+                ? elements[0]
+                : `[${elements.join(', ')}].join("/")`;
+        const decoratorOptions = [`path: (doc) => ${pathExpression}`];
+        if (name !== undefined) {
+            decoratorOptions.push(`name: ${JSON.stringify(name)}`);
+        }
         const decorators = [];
-        addDecoratorToList(decorators, { schema: this.schema }, 'FirestoreCollection', CAUSA_GOOGLE_MODULE, (alias) => `@${alias}({ name: ${JSON.stringify(name)}, path: (doc) => ${pathExpression} })`);
+        addDecoratorToList(decorators, { schema: this.schema }, 'FirestoreCollection', CAUSA_GOOGLE_MODULE, (alias) => `@${alias}({ ${decoratorOptions.join(', ')} })`);
         if (hasSoftDelete === true) {
             addDecoratorToList(decorators, { schema: this.schema }, 'SoftDeletedFirestoreCollection', CAUSA_GOOGLE_MODULE, (alias) => `@${alias}()`);
         }

package/dist/functions/index.js

@@ -11,6 +11,7 @@ import { DatabaseQueryRecordsForSpanner, GoogleSpannerListDatabases, GoogleSpann
 import { ProjectGetArtefactDestinationForCloudFunctions, ProjectGetArtefactDestinationForCloudRun, ProjectPushArtefactForCloudFunctions, } from './project/index.js';
 import { SecretFetchForGoogleAccessToken, SecretFetchForGoogleSecretManager, } from './secret/index.js';
 import { ServiceContainerQueryLogsForCloudRun } from './service-container/index.js';
+import { ModelGenerateTypeScriptTriggerDecoratorsForGoogle } from './typescript/index.js';
 export function registerFunctions(context) {
-    context.registerFunctionImplementations(CausaListConfigurationSchemasForGoogle, DatabaseQueryRecordsForFirestore, DatabaseQueryRecordsForSpanner, EmulatorStartForFirebaseStorage, EmulatorStartForFirestore, EmulatorStartForIdentityPlatform, EmulatorStartForPubSub, EmulatorStartForSpanner, EmulatorStopForFirebaseStorage, EmulatorStopForFirestore, EmulatorStopForIdentityPlatform, EmulatorStopForPubSub, EmulatorStopForSpanner, EventTopicBrokerCreateTopicForPubSub, EventTopicBrokerCreateTriggerForCloudRun, EventTopicBrokerDeleteTopicForPubSub, EventTopicBrokerDeleteTriggerResourceForCloudRunInvokerRole, EventTopicBrokerDeleteTriggerResourceForCloudRunService, EventTopicBrokerDeleteTriggerResourceForPubSubSubscription, EventTopicBrokerDeleteTriggerResourceForServiceAccount, EventTopicBrokerGetTopicIdForPubSub, EventTopicBrokerPublishEventsForGoogle, EventTopicBrokerWaitForProcessingForPubSub, EventTopicCreateBackfillSourceForBigQuery, EventTopicQueryEventsForBigQuery, GoogleAppCheckGenerateToken, GoogleFirebaseStorageMergeRules, GoogleFirestoreMergeRules, GoogleIdentityPlatformGenerateCustomToken, GoogleIdentityPlatformGenerateToken, GooglePubSubWriteTopics, GoogleServicesEnable, GoogleSpannerListDatabases, GoogleSpannerWriteDatabases, ModelGenerateTypeScriptDecoratorsForGoogleFirestore, ModelGenerateTypeScriptDecoratorsForGoogleSpanner, ModelSchemaExtractDatabaseForGoogleFirestore, ModelSchemaExtractDatabaseForGoogleSpanner, ProjectGetArtefactDestinationForCloudFunctions, ProjectGetArtefactDestinationForCloudRun, ProjectPushArtefactForCloudFunctions, SecretFetchForGoogleAccessToken, SecretFetchForGoogleSecretManager, ServiceContainerQueryLogsForCloudRun);
+    context.registerFunctionImplementations(CausaListConfigurationSchemasForGoogle, DatabaseQueryRecordsForFirestore, DatabaseQueryRecordsForSpanner, EmulatorStartForFirebaseStorage, EmulatorStartForFirestore, EmulatorStartForIdentityPlatform, EmulatorStartForPubSub, EmulatorStartForSpanner, EmulatorStopForFirebaseStorage, EmulatorStopForFirestore, EmulatorStopForIdentityPlatform, EmulatorStopForPubSub, EmulatorStopForSpanner, EventTopicBrokerCreateTopicForPubSub, EventTopicBrokerCreateTriggerForCloudRun, EventTopicBrokerDeleteTopicForPubSub, EventTopicBrokerDeleteTriggerResourceForCloudRunInvokerRole, EventTopicBrokerDeleteTriggerResourceForCloudRunService, EventTopicBrokerDeleteTriggerResourceForPubSubSubscription, EventTopicBrokerDeleteTriggerResourceForServiceAccount, EventTopicBrokerGetTopicIdForPubSub, EventTopicBrokerPublishEventsForGoogle, EventTopicBrokerWaitForProcessingForPubSub, EventTopicCreateBackfillSourceForBigQuery, EventTopicQueryEventsForBigQuery, GoogleAppCheckGenerateToken, GoogleFirebaseStorageMergeRules, GoogleFirestoreMergeRules, GoogleIdentityPlatformGenerateCustomToken, GoogleIdentityPlatformGenerateToken, GooglePubSubWriteTopics, GoogleServicesEnable, GoogleSpannerListDatabases, GoogleSpannerWriteDatabases, ModelGenerateTypeScriptDecoratorsForGoogleFirestore, ModelGenerateTypeScriptDecoratorsForGoogleSpanner, ModelGenerateTypeScriptTriggerDecoratorsForGoogle, ModelSchemaExtractDatabaseForGoogleFirestore, ModelSchemaExtractDatabaseForGoogleSpanner, ProjectGetArtefactDestinationForCloudFunctions, ProjectGetArtefactDestinationForCloudRun, ProjectPushArtefactForCloudFunctions, SecretFetchForGoogleAccessToken, SecretFetchForGoogleSecretManager, ServiceContainerQueryLogsForCloudRun);
 }

package/dist/functions/typescript/generate-typescript-trigger-decorators.d.ts

@@ -0,0 +1,12 @@
+import { ModelGenerateTypeScriptTriggerDecorators } from '@causa/workspace-typescript';
+import { type TypeScriptDecorator } from '@causa/workspace-typescript/code-generation';
+/**
+ * Implements {@link ModelGenerateTypeScriptTriggerDecorators} for services running on the Google platform.
+ *
+ * Each supported trigger type is mapped to a `@UseEventHandler(...)` decorator with the handler ID of the Google
+ * service backing the trigger (Pub/Sub, Cloud Tasks, Cloud Scheduler, or Eventarc).
+ */
+export declare class ModelGenerateTypeScriptTriggerDecoratorsForGoogle extends ModelGenerateTypeScriptTriggerDecorators {
+    _call(): TypeScriptDecorator[];
+    _supports(): boolean;
+}

package/dist/functions/typescript/generate-typescript-trigger-decorators.js

@@ -0,0 +1,71 @@
+import { ModelGenerateTypeScriptTriggerDecorators } from '@causa/workspace-typescript';
+import { externalImportSpec, externalSymbolAlias, } from '@causa/workspace-typescript/code-generation';
+/**
+ * The name of the Causa module for the TypeScript runtime, from which `UseEventHandler` is imported.
+ */
+const CAUSA_RUNTIME_NESTJS_MODULE = '@causa/runtime/nestjs';
+/**
+ * The name of the Causa module for the TypeScript Google runtime.
+ */
+const CAUSA_GOOGLE_MODULE = '@causa/runtime-google';
+/**
+ * The handler ID symbol to pass to `UseEventHandler` for each supported trigger type, along with the module from
+ * which it should be imported.
+ */
+const HANDLER_IDS_FOR_TRIGGER_TYPES = {
+    event: { module: CAUSA_GOOGLE_MODULE, symbol: 'PUBSUB_EVENT_HANDLER_ID' },
+    'google.pubSub': {
+        module: CAUSA_GOOGLE_MODULE,
+        symbol: 'PUBSUB_EVENT_HANDLER_ID',
+    },
+    task: {
+        module: CAUSA_GOOGLE_MODULE,
+        symbol: 'CLOUD_TASKS_EVENT_HANDLER_ID',
+    },
+    'google.tasks': {
+        module: CAUSA_GOOGLE_MODULE,
+        symbol: 'CLOUD_TASKS_EVENT_HANDLER_ID',
+    },
+    cron: {
+        module: CAUSA_GOOGLE_MODULE,
+        symbol: 'CLOUD_SCHEDULER_EVENT_HANDLER_ID',
+    },
+    'google.scheduler': {
+        module: CAUSA_GOOGLE_MODULE,
+        symbol: 'CLOUD_SCHEDULER_EVENT_HANDLER_ID',
+    },
+    'google.eventarc': {
+        module: CAUSA_RUNTIME_NESTJS_MODULE,
+        symbol: 'CLOUDEVENTS_EVENT_HANDLER_ID',
+    },
+};
+/**
+ * Implements {@link ModelGenerateTypeScriptTriggerDecorators} for services running on the Google platform.
+ *
+ * Each supported trigger type is mapped to a `@UseEventHandler(...)` decorator with the handler ID of the Google
+ * service backing the trigger (Pub/Sub, Cloud Tasks, Cloud Scheduler, or Eventarc).
+ */
+export class ModelGenerateTypeScriptTriggerDecoratorsForGoogle extends ModelGenerateTypeScriptTriggerDecorators {
+    _call() {
+        const handlerId = HANDLER_IDS_FOR_TRIGGER_TYPES[this.trigger.type];
+        if (!handlerId) {
+            return [];
+        }
+        const useEventHandlerAlias = externalSymbolAlias(CAUSA_RUNTIME_NESTJS_MODULE, 'UseEventHandler');
+        const handlerIdAlias = externalSymbolAlias(handlerId.module, handlerId.symbol);
+        const imports = {
+            [CAUSA_RUNTIME_NESTJS_MODULE]: [
+                externalImportSpec(CAUSA_RUNTIME_NESTJS_MODULE, 'UseEventHandler'),
+            ],
+        };
+        (imports[handlerId.module] ??= []).push(externalImportSpec(handlerId.module, handlerId.symbol));
+        return [{ source: `@${useEventHandlerAlias}(${handlerIdAlias})`, imports }];
+    }
+    _supports() {
+        return (this.generator === 'typescriptNestjsController' &&
+            this._context.get('project.language') === 'typescript' &&
+            this._context
+                .asConfiguration()
+                .get('serviceContainer.platform') === 'google.cloudRun');
+    }
+}

package/dist/functions/typescript/index.d.ts

@@ -0,0 +1 @@
+export { ModelGenerateTypeScriptTriggerDecoratorsForGoogle } from './generate-typescript-trigger-decorators.js';

package/dist/functions/typescript/index.js

@@ -0,0 +1 @@
+export { ModelGenerateTypeScriptTriggerDecoratorsForGoogle } from './generate-typescript-trigger-decorators.js';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@causa/workspace-google",
-  "version": "1.0.1",
+  "version": "1.2.0",
   "description": "The Causa workspace module providing many functionalities related to GCP and its services.",
   "repository": {
     "type": "git",
@@ -37,8 +37,8 @@
   "dependencies": {
     "@causa/cli": "^1.0.0",
     "@causa/workspace": "^1.0.1",
-    "@causa/workspace-core": "^1.0.1",
-    "@causa/workspace-typescript": "^1.0.1",
+    "@causa/workspace-core": "^1.1.0",
+    "@causa/workspace-typescript": "^1.1.0",
     "@google-cloud/apikeys": "^2.2.2",
     "@google-cloud/bigquery": "^8.3.1",
     "@google-cloud/iam-credentials": "^4.2.2",
@@ -66,7 +66,7 @@
     "@tsconfig/node22": "^22.0.5",
     "@types/jest": "^30.0.0",
     "@types/micromatch": "^4.0.10",
-    "@types/node": "^20.19.42",
+    "@types/node": "^20.19.43",
     "copyfiles": "^2.4.1",
     "eslint": "^10.4.1",
     "eslint-config-prettier": "^10.1.8",