@causa/workspace-google 1.0.1 → 1.1.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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@causa/workspace-google",
-  "version": "1.0.1",
+  "version": "1.1.0",
   "description": "The Causa workspace module providing many functionalities related to GCP and its services.",
   "repository": {
     "type": "git",