@causa/workspace-google 0.6.0 → 0.7.1

package/README.md

@@ -65,6 +65,32 @@ secrets:
     backend: google.accessToken
 ```
 
+### Code generation
+
+This module implements the `google.spanner` TypeScript decorator renderer, which can be used to add `@SpannerTable` and `@SpannerColumn` decorators to classes generated from events. Below is an example of how to enable it for a JSONSchema object:
+
+```yaml
+title: MyClass
+type: object
+additionalProperties: false
+causa:
+  # This must be set for the decorators to be added to both the class and its properties.
+  # The content of the object will be passed as the argument to the `@SpannerTable` decorator.
+  tsGoogleSpannerTable:
+    primaryKey: [id]
+properties:
+  id:
+    type: string
+    format: uuid
+    # In most cases, the property-level `tsGoogleSpannerColumn` attribute does not need to be set. The decorator configuration will be automatically inferred.
+    # If needed, the content of `tsGoogleSpannerColumn` will be passed as the argument to the `@SpannerColumn` decorator.
+    # causa:
+    #   tsGoogleSpannerColumn:
+    #     isJson: false
+  myProperty:
+    type: string
+```
+
 ## 🔨 Custom `google` commands
 
 This modules adds a new command to the CLI: `cs google`. Here is the list of subcommands that are exposed.
@@ -136,3 +162,5 @@ 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/code-generation/google-spanner-renderer.d.ts

@@ -0,0 +1,11 @@
+import { ClassContext, ClassPropertyContext, TypeScriptDecorator, TypeScriptDecoratorsRenderer } from '@causa/workspace-typescript';
+/**
+ * A {@link TypeScriptDecoratorsRenderer} that adds Google Spanner decorators from the Causa Google runtime.
+ *
+ * If an object schema is marked with the `tsGoogleSpannerTable` attribute, the `@SpannerTable` decorator is added to
+ * the class, and `@SpannerColumn` decorators are added to all its properties.
+ */
+export declare class GoogleSpannerRenderer extends TypeScriptDecoratorsRenderer {
+    decoratorsForClass(context: ClassContext): TypeScriptDecorator[];
+    decoratorsForProperty(context: ClassPropertyContext): TypeScriptDecorator[];
+}

package/dist/code-generation/google-spanner-renderer.js

@@ -0,0 +1,94 @@
+import { TypeScriptDecoratorsRenderer, getSingleType, typeScriptSourceForObject, } from '@causa/workspace-typescript';
+import { panic } from 'quicktype-core';
+/**
+ * The name of the Causa attribute that should be present for a class to be decorated with Google Spanner decorators.
+ */
+const GOOGLE_SPANNER_TABLE_ATTRIBUTE = 'tsGoogleSpannerTable';
+/**
+ * The name of the Causa attribute that can be present on a class to only generate `@SpannerColumn` decorators for its
+ * properties, but not a `@SpannerTable` decorator for the class itself.
+ */
+const GOOGLE_SPANNER_NESTED_TYPE_ATTRIBUTE = 'tsGoogleSpannerNestedType';
+/**
+ * The name of the optional Causa attribute that can be present on an object property schema to specify options for the
+ * `@SpannerColumn` decorator.
+ */
+const GOOGLE_SPANNER_COLUMN_ATTRIBUTE = 'tsGoogleSpannerColumn';
+/**
+ * The name of the `decoratorOptions` key that can be used to specify the name of the property that should be used as
+ * the soft deletion column.
+ */
+const GOOGLE_SPANNER_SOFT_DELETION_COLUMN_OPTION = 'googleSpannerSoftDeletionColumn';
+/**
+ * The name of the Causa module for the TypeScript Google runtime.
+ */
+const CAUSA_GOOGLE_MODULE = '@causa/runtime-google';
+/**
+ * The list of options that can be passed to the `@SpannerColumn` decorator and that indicates that the JSONSchema
+ * specifies the type of the column. In this case, the renderer should not infer any type information.
+ */
+const TYPE_INFO_COLUMN_ATTRIBUTE_NAMES = [
+    'nestedType',
+    'nullifyNested',
+    'isBigInt',
+    'isInt',
+    'isPreciseDate',
+    'isJson',
+];
+/**
+ * A {@link TypeScriptDecoratorsRenderer} that adds Google Spanner decorators from the Causa Google runtime.
+ *
+ * If an object schema is marked with the `tsGoogleSpannerTable` attribute, the `@SpannerTable` decorator is added to
+ * the class, and `@SpannerColumn` decorators are added to all its properties.
+ */
+export class GoogleSpannerRenderer extends TypeScriptDecoratorsRenderer {
+    decoratorsForClass(context) {
+        const tableAttribute = context.objectAttributes[GOOGLE_SPANNER_TABLE_ATTRIBUTE];
+        if (!tableAttribute) {
+            return [];
+        }
+        if (typeof tableAttribute !== 'object' ||
+            !('primaryKey' in tableAttribute) ||
+            !Array.isArray(tableAttribute.primaryKey)) {
+            panic(`Invalid ${GOOGLE_SPANNER_TABLE_ATTRIBUTE} attribute on ${context.classType.getNames()}`);
+        }
+        const optionsSource = typeScriptSourceForObject(tableAttribute);
+        const decorators = [];
+        this.addDecoratorToList(decorators, context, 'SpannerTable', CAUSA_GOOGLE_MODULE, ['@SpannerTable(', optionsSource, ')']);
+        return decorators;
+    }
+    decoratorsForProperty(context) {
+        if (!context.objectAttributes[GOOGLE_SPANNER_TABLE_ATTRIBUTE] &&
+            !context.objectAttributes[GOOGLE_SPANNER_NESTED_TYPE_ATTRIBUTE]) {
+            return [];
+        }
+        const rawColumnAttributes = context.propertyAttributes[GOOGLE_SPANNER_COLUMN_ATTRIBUTE] ?? {};
+        const columnAttributes = typeof rawColumnAttributes === 'object' ? rawColumnAttributes : {};
+        const softDeletionColumn = this.decoratorOptions[GOOGLE_SPANNER_SOFT_DELETION_COLUMN_OPTION];
+        if (softDeletionColumn && context.jsonName === softDeletionColumn) {
+            columnAttributes.softDelete = true;
+        }
+        if (!context.propertyAttributes.tsType) {
+            const singleTypeInfo = getSingleType(context.property.type);
+            const schemaOverridesTypeInfo = TYPE_INFO_COLUMN_ATTRIBUTE_NAMES.some((name) => name in columnAttributes);
+            if (!schemaOverridesTypeInfo && singleTypeInfo) {
+                switch (singleTypeInfo.type.kind) {
+                    case 'class':
+                    case 'object':
+                    case 'map':
+                        columnAttributes.isJson = true;
+                        break;
+                    case 'integer':
+                        columnAttributes.isInt = true;
+                        break;
+                }
+            }
+        }
+        const optionsSource = typeScriptSourceForObject(columnAttributes, {
+            encoder: (key, value) => key === 'nestedType' ? value : JSON.stringify(value),
+        });
+        const decorators = [];
+        this.addDecoratorToList(decorators, context, 'SpannerColumn', CAUSA_GOOGLE_MODULE, ['@SpannerColumn(', optionsSource, ')']);
+        return decorators;
+    }
+}

package/dist/code-generation/index.d.ts

@@ -0,0 +1 @@
+export { GoogleSpannerRenderer } from './google-spanner-renderer.js';

package/dist/code-generation/index.js

@@ -0,0 +1 @@
+export { GoogleSpannerRenderer } from './google-spanner-renderer.js';

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

@@ -1,6 +1,9 @@
 import { DockerEmulatorService, EmulatorStart, } from '@causa/workspace-core';
 import { Spanner } from '@google-cloud/spanner';
-import { credentials } from '@grpc/grpc-js';
+// The Spanner client depends on `google-gax` rather than `@grpc/grpc-js` directly. By ensuring `google-gax` is kept in
+// sync with the version required by Spanner, and importing `grpc` from `google-gax`, the correct `grpc.credentials`
+// version can be loaded.
+import { grpc } from 'google-gax';
 import { getLocalGcpProject, } from '../../configurations/index.js';
 import { SPANNER_EMULATOR_NAME, SPANNER_GRPC_PORT, SPANNER_HTTP_PORT, SPANNER_IMAGE, getSpannerContainerName, } from '../../emulators/index.js';
 import { GoogleSpannerListDatabases } from '../google-spanner/index.js';
@@ -70,7 +73,7 @@ export class EmulatorStartForSpanner extends EmulatorStart {
             servicePath: '127.0.0.1',
             port: SPANNER_GRPC_PORT,
             projectId: getLocalGcpProject(context),
-            sslCreds: credentials.createInsecure(),
+            sslCreds: grpc.credentials.createInsecure(),
         });
         const { instance, instanceConf } = await this.createInstance(spanner, context);
         const databaseConf = await this.createDatabases(instance, context);

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

@@ -1,5 +1,5 @@
 import { EventTopicBrokerDeleteTopic, } from '@causa/workspace-core';
-import { status } from '@grpc/grpc-js';
+import { grpc } from 'google-gax';
 import { PubSubService } from '../../services/index.js';
 /**
  * Implements {@link EventTopicBrokerDeleteTopic} for Pub/Sub.
@@ -12,7 +12,7 @@ export class EventTopicBrokerDeleteTopicForPubSub extends EventTopicBrokerDelete
             await context.service(PubSubService).pubSub.topic(this.id).delete();
         }
         catch (error) {
-            if (error.code === status.NOT_FOUND) {
+            if (error.code === grpc.status.NOT_FOUND) {
                 context.logger.warn(`⚠️ Pub/Sub topic to delete '${this.id}' does not exist. It might have already been deleted.`);
                 return;
             }

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

@@ -1,5 +1,5 @@
 import { EventTopicBrokerDeleteTriggerResource, } from '@causa/workspace-core';
-import { status } from '@grpc/grpc-js';
+import { grpc } from 'google-gax';
 import { PubSubService } from '../../services/index.js';
 /**
  * Implements {@link EventTopicBrokerDeleteTriggerResource} for Pub/Sub subscriptions.
@@ -15,7 +15,7 @@ export class EventTopicBrokerDeleteTriggerResourceForPubSubSubscription extends
                 .delete();
         }
         catch (error) {
-            if (error.code === status.NOT_FOUND) {
+            if (error.code === grpc.status.NOT_FOUND) {
                 context.logger.warn(`⚠️ Pub/Sub subscription '${this.id}' does not exist. It might have already been deleted.`);
             }
             else {

package/dist/functions/index.js

@@ -9,6 +9,7 @@ import { GoogleServicesEnable } from './google-services/index.js';
 import { GoogleSpannerListDatabases, GoogleSpannerWriteDatabases, } from './google-spanner/index.js';
 import { ProjectGetArtefactDestinationForCloudFunctions, ProjectGetArtefactDestinationForCloudRun, ProjectPushArtefactForCloudFunctions, } from './project/index.js';
 import { SecretFetchForGoogleAccessToken, SecretFetchForGoogleSecretManager, } from './secret/index.js';
+import { TypeScriptGetDecoratorRendererForGoogleSpanner } from './typescript/index.js';
 export function registerFunctions(context) {
-    context.registerFunctionImplementations(EmulatorStartForFirebaseStorage, EmulatorStartForFirestore, EmulatorStartForIdentityPlatform, EmulatorStartForPubSub, EmulatorStartForSpanner, EmulatorStopForFirebaseStorage, EmulatorStopForFirestore, EmulatorStopForIdentityPlatform, EmulatorStopForPubSub, EmulatorStopForSpanner, EventTopicBrokerCreateTopicForPubSub, EventTopicBrokerCreateTriggerForCloudRun, EventTopicBrokerDeleteTopicForPubSub, EventTopicBrokerDeleteTriggerResourceForCloudRunInvokerRole, EventTopicBrokerDeleteTriggerResourceForPubSubSubscription, EventTopicBrokerDeleteTriggerResourceForServiceAccount, EventTopicBrokerGetTopicIdForPubSub, EventTopicBrokerPublishEventsForGoogle, GoogleAppCheckGenerateToken, GoogleFirebaseStorageMergeRules, GoogleFirestoreMergeRules, GoogleIdentityPlatformGenerateCustomToken, GoogleIdentityPlatformGenerateToken, GooglePubSubWriteTopics, GoogleServicesEnable, GoogleSpannerListDatabases, GoogleSpannerWriteDatabases, ProjectGetArtefactDestinationForCloudFunctions, ProjectGetArtefactDestinationForCloudRun, ProjectPushArtefactForCloudFunctions, SecretFetchForGoogleAccessToken, SecretFetchForGoogleSecretManager);
+    context.registerFunctionImplementations(EmulatorStartForFirebaseStorage, EmulatorStartForFirestore, EmulatorStartForIdentityPlatform, EmulatorStartForPubSub, EmulatorStartForSpanner, EmulatorStopForFirebaseStorage, EmulatorStopForFirestore, EmulatorStopForIdentityPlatform, EmulatorStopForPubSub, EmulatorStopForSpanner, EventTopicBrokerCreateTopicForPubSub, EventTopicBrokerCreateTriggerForCloudRun, EventTopicBrokerDeleteTopicForPubSub, EventTopicBrokerDeleteTriggerResourceForCloudRunInvokerRole, EventTopicBrokerDeleteTriggerResourceForPubSubSubscription, EventTopicBrokerDeleteTriggerResourceForServiceAccount, EventTopicBrokerGetTopicIdForPubSub, EventTopicBrokerPublishEventsForGoogle, GoogleAppCheckGenerateToken, GoogleFirebaseStorageMergeRules, GoogleFirestoreMergeRules, GoogleIdentityPlatformGenerateCustomToken, GoogleIdentityPlatformGenerateToken, GooglePubSubWriteTopics, GoogleServicesEnable, GoogleSpannerListDatabases, GoogleSpannerWriteDatabases, ProjectGetArtefactDestinationForCloudFunctions, ProjectGetArtefactDestinationForCloudRun, ProjectPushArtefactForCloudFunctions, SecretFetchForGoogleAccessToken, SecretFetchForGoogleSecretManager, TypeScriptGetDecoratorRendererForGoogleSpanner);
 }

package/dist/functions/typescript/get-decorator-renderer-google-spanner.d.ts

@@ -0,0 +1,10 @@
+import { WorkspaceContext } from '@causa/workspace';
+import { TypeScriptDecoratorsRenderer, TypeScriptGetDecoratorRenderer } from '@causa/workspace-typescript';
+/**
+ * Implements {@link TypeScriptGetDecoratorRenderer} for the {@link GoogleSpannerRenderer}.
+ * The configuration name for the renderer is `google.spanner`.
+ */
+export declare class TypeScriptGetDecoratorRendererForGoogleSpanner extends TypeScriptGetDecoratorRenderer {
+    _call(): new (...args: any[]) => TypeScriptDecoratorsRenderer;
+    _supports(context: WorkspaceContext): boolean;
+}

package/dist/functions/typescript/get-decorator-renderer-google-spanner.js

@@ -0,0 +1,21 @@
+import { TypeScriptGetDecoratorRenderer, } from '@causa/workspace-typescript';
+import { GoogleSpannerRenderer } from '../../code-generation/index.js';
+/**
+ * Implements {@link TypeScriptGetDecoratorRenderer} for the {@link GoogleSpannerRenderer}.
+ * The configuration name for the renderer is `google.spanner`.
+ */
+export class TypeScriptGetDecoratorRendererForGoogleSpanner extends TypeScriptGetDecoratorRenderer {
+    _call() {
+        return GoogleSpannerRenderer;
+    }
+    _supports(context) {
+        if (context.get('project.language') !== 'typescript') {
+            return false;
+        }
+        const decoratorRenderers = context
+            .asConfiguration()
+            .get('typescript.codeGeneration.decoratorRenderers') ?? [];
+        return (decoratorRenderers.length === 0 ||
+            decoratorRenderers.includes('google.spanner'));
+    }
+}

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

@@ -0,0 +1 @@
+export { TypeScriptGetDecoratorRendererForGoogleSpanner } from './get-decorator-renderer-google-spanner.js';

package/dist/functions/typescript/index.js

@@ -0,0 +1 @@
+export { TypeScriptGetDecoratorRendererForGoogleSpanner } from './get-decorator-renderer-google-spanner.js';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@causa/workspace-google",
-  "version": "0.6.0",
+  "version": "0.7.1",
   "description": "The Causa workspace module providing many functionalities related to GCP and its services.",
   "repository": "github:causa-io/workspace-module-google",
   "license": "ISC",
@@ -29,44 +29,46 @@
     "test:cov": "npm run test -- --coverage"
   },
   "dependencies": {
-    "@causa/cli": ">= 0.4.0 < 1.0.0",
-    "@causa/workspace": ">= 0.12.0 < 1.0.0",
-    "@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.4.0",
-    "firebase-admin": "^11.11.0",
-    "globby": "^13.2.2",
-    "google-auth-library": "^9.0.0",
-    "googleapis": "^126.0.1",
-    "pino": "^8.15.1",
+    "@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",
+    "class-validator": "^0.14.1",
+    "firebase": "^10.8.0",
+    "firebase-admin": "^12.0.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",
     "uuid": "^9.0.1"
   },
   "devDependencies": {
     "@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",
+    "@types/jest": "^29.5.12",
+    "@types/node": "^18.19.17",
+    "@types/uuid": "^9.0.8",
+    "@typescript-eslint/eslint-plugin": "^7.0.2",
     "copyfiles": "^2.4.1",
-    "eslint": "^8.50.0",
-    "eslint-config-prettier": "^9.0.0",
-    "eslint-plugin-prettier": "^5.0.0",
+    "eslint": "^8.56.0",
+    "eslint-config-prettier": "^9.1.0",
+    "eslint-plugin-prettier": "^5.1.3",
     "jest": "^29.7.0",
-    "jest-extended": "^4.0.1",
+    "jest-extended": "^4.0.2",
     "rimraf": "^5.0.5",
-    "ts-jest": "^29.1.1",
-    "ts-node": "^10.9.1",
-    "typescript": "^5.2.2"
+    "ts-jest": "^29.1.2",
+    "ts-node": "^10.9.2",
+    "typescript": "^5.3.3"
   }
 }