release(workspace): v5.2.0 release

added collection group support to dbx-firebase components

feat: added firestore collection group support

docs: setup-project docs improvement

.circleci/config.yml

@@ -158,7 +158,7 @@ jobs:
       - run:
           # we grab the relevant tag names before swapping to main
           name: "setup env vars for git changes"
-          command: echo -e "export DEV_TAG_ID=$(git describe --abbrev=0 HEAD^)\nTAG_ID=$(git describe --abbrev=0)" >> $BASH_ENV
+          command: echo -e "export DEV_TAG_ID=$(git describe --tags --abbrev=0 HEAD^)\nTAG_ID=$(git describe --tags --abbrev=0)" >> $BASH_ENV
       - run:
           # copy the commit message before we swap branches, or it will include unrelated changes. Move tag to the main branch after making the merge commit into main
           name: merge release into main and use the release commit message, move tag from release to main
@@ -169,6 +169,7 @@ jobs:
       - run:
           name: delete release branch
           command: git push origin --delete release
+  # Deploys rules and configured projects to Firebase.
   deploy-to-firebase:
     <<: *defaults
     steps:

.prettierrc

@@ -10,5 +10,5 @@
   "tabWidth": 2,
   "htmlWhitespaceSensitivity": "ignore",
   "endOfLine": "lf",
-  "printWidth": 400
+  "printWidth": 500
 }

CHANGELOG.md

@@ -2,6 +2,16 @@
 
 This file was generated using [@jscutlery/semver](https://github.com/jscutlery/semver).
 
+# [5.2.0](https://github.com/dereekb/dbx-components/compare/v5.1.0-dev...v5.2.0) (2022-05-29)
+
+
+### Features
+
+* added collection group support to dbx-firebase components ([9f746c1](https://github.com/dereekb/dbx-components/commit/9f746c12a0e219970dcde12d920f1ef540514ce9))
+* added firestore collection group support ([3b4c4cf](https://github.com/dereekb/dbx-components/commit/3b4c4cfa1dd860604c347ade69acdc2fea1063f8))
+
+
+
 # [5.1.0](https://github.com/dereekb/dbx-components/compare/v5.0.1-dev...v5.1.0) (2022-05-27)
 
 

apps/demo-api/CHANGELOG.md

@@ -2,6 +2,10 @@
 
 This file was generated using [@jscutlery/semver](https://github.com/jscutlery/semver).
 
+# [5.2.0](https://github.com/dereekb/dbx-components/compare/v5.1.0-dev...v5.2.0) (2022-05-29)
+
+
+
 # [5.1.0](https://github.com/dereekb/dbx-components/compare/v5.0.1-dev...v5.1.0) (2022-05-27)
 
 

apps/demo-api/project.json

@@ -12,10 +12,12 @@
     "build-base": {
       "executor": "@nrwl/node:webpack",
       "outputs": ["{options.outputPath}"],
-      "dependsOn": [{
-        "target": "build",
-        "projects": "dependencies"
-      }],
+      "dependsOn": [
+        {
+          "target": "build",
+          "projects": "dependencies"
+        }
+      ],
       "options": {
         "outputPath": "dist/apps/demo-api",
         "main": "apps/demo-api/src/main.ts",
@@ -29,10 +31,12 @@
           "extractLicenses": false,
           "sourceMap": false,
           "inspect": false,
-          "fileReplacements": [{
-            "replace": "apps/demo-api/src/environments/environment.ts",
-            "with": "apps/demo-api/src/environments/environment.prod.ts"
-          }]
+          "fileReplacements": [
+            {
+              "replace": "apps/demo-api/src/environments/environment.ts",
+              "with": "apps/demo-api/src/environments/environment.prod.ts"
+            }
+          ]
         }
       }
     },
@@ -51,7 +55,8 @@
     "serve": {
       "executor": "@nrwl/workspace:run-commands",
       "options": {
-        "commands": [{
+        "commands": [
+          {
             "command": "npx nx build-base demo-api --watch"
           },
           {
@@ -76,10 +81,7 @@
     },
     "run-tests": {
       "executor": "@nrwl/jest:jest",
-      "outputs": [
-        "coverage/apps/demo-api",
-        "./.reports/jest/demo-api.junit.xml"
-      ],
+      "outputs": ["coverage/apps/demo-api", "./.reports/jest/demo-api.junit.xml"],
       "options": {
         "jestConfig": "apps/demo-api/jest.config.ts",
         "passWithNoTests": true
@@ -99,14 +101,18 @@
     },
     "ci-deploy": {
       "executor": "@nrwl/workspace:run-commands",
-      "dependsOn": [{
-        "target": "build",
-        "projects": "self"
-      }],
+      "dependsOn": [
+        {
+          "target": "build",
+          "projects": "self"
+        }
+      ],
       "options": {
-        "commands": [{
+        "commands": [
+          {
             "command": "npx nx run demo-api:build-base:production"
-          }, {
+          },
+          {
             "command": "npx nx make-env demo-api"
           },
           {

apps/demo-api/src/test/fixture.ts

@@ -131,15 +131,7 @@ export class DemoApiGuestbookTestContextFixture<F extends FirebaseAdminFunctionT
 export class DemoApiGuestbookTestContextInstance<F extends FirebaseAdminFunctionTestContextInstance = FirebaseAdminFunctionTestContextInstance> extends ModelTestContextInstance<Guestbook, GuestbookDocument, DemoApiFunctionContextFixtureInstance<F>> {}
 
 export const demoGuestbookContextFactory = () =>
-  modelTestContextFactory<
-    Guestbook,
-    GuestbookDocument,
-    DemoApiGuestbookTestContextParams,
-    DemoApiFunctionContextFixtureInstance<FirebaseAdminFunctionTestContextInstance>,
-    DemoApiFunctionContextFixture<FirebaseAdminFunctionTestContextInstance>,
-    DemoApiGuestbookTestContextInstance<FirebaseAdminFunctionTestContextInstance>,
-    DemoApiGuestbookTestContextFixture<FirebaseAdminFunctionTestContextInstance>
-  >({
+  modelTestContextFactory<Guestbook, GuestbookDocument, DemoApiGuestbookTestContextParams, DemoApiFunctionContextFixtureInstance<FirebaseAdminFunctionTestContextInstance>, DemoApiFunctionContextFixture<FirebaseAdminFunctionTestContextInstance>, DemoApiGuestbookTestContextInstance<FirebaseAdminFunctionTestContextInstance>, DemoApiGuestbookTestContextFixture<FirebaseAdminFunctionTestContextInstance>>({
     makeFixture: (f) => new DemoApiGuestbookTestContextFixture(f),
     getCollection: (fi) => fi.demoFirestoreCollections.guestbookFirestoreCollection,
     makeInstance: (delegate, ref, testInstance) => new DemoApiGuestbookTestContextInstance(delegate, ref, testInstance),
@@ -169,15 +161,7 @@ export class DemoApiGuestbookEntryTestContextFixture<F extends FirebaseAdminFunc
 export class DemoApiGuestbookEntryTestContextInstance<F extends FirebaseAdminFunctionTestContextInstance = FirebaseAdminFunctionTestContextInstance> extends ModelTestContextInstance<GuestbookEntry, GuestbookEntryDocument, DemoApiFunctionContextFixtureInstance<F>> {}
 
 export const demoGuestbookEntryContextFactory = () =>
-  modelTestContextFactory<
-    GuestbookEntry,
-    GuestbookEntryDocument,
-    DemoApiGuestbookEntryTestContextParams,
-    DemoApiFunctionContextFixtureInstance<FirebaseAdminFunctionTestContextInstance>,
-    DemoApiFunctionContextFixture<FirebaseAdminFunctionTestContextInstance>,
-    DemoApiGuestbookEntryTestContextInstance<FirebaseAdminFunctionTestContextInstance>,
-    DemoApiGuestbookEntryTestContextFixture<FirebaseAdminFunctionTestContextInstance>
-  >({
+  modelTestContextFactory<GuestbookEntry, GuestbookEntryDocument, DemoApiGuestbookEntryTestContextParams, DemoApiFunctionContextFixtureInstance<FirebaseAdminFunctionTestContextInstance>, DemoApiFunctionContextFixture<FirebaseAdminFunctionTestContextInstance>, DemoApiGuestbookEntryTestContextInstance<FirebaseAdminFunctionTestContextInstance>, DemoApiGuestbookEntryTestContextFixture<FirebaseAdminFunctionTestContextInstance>>({
     makeFixture: (f) => new DemoApiGuestbookEntryTestContextFixture(f),
     getCollection: (fi, params) => fi.demoFirestoreCollections.guestbookEntryCollectionFactory(params.g.document),
     makeInstance: (delegate, ref, testInstance) => new DemoApiGuestbookEntryTestContextInstance(delegate, ref, testInstance),

apps/demo-e2e/CHANGELOG.md

@@ -2,6 +2,10 @@
 
 This file was generated using [@jscutlery/semver](https://github.com/jscutlery/semver).
 
+# [5.2.0](https://github.com/dereekb/dbx-components/compare/v5.1.0-dev...v5.2.0) (2022-05-29)
+
+
+
 # [5.1.0](https://github.com/dereekb/dbx-components/compare/v5.0.1-dev...v5.1.0) (2022-05-27)
 
 

apps/demo/CHANGELOG.md

@@ -2,6 +2,10 @@
 
 This file was generated using [@jscutlery/semver](https://github.com/jscutlery/semver).
 
+# [5.2.0](https://github.com/dereekb/dbx-components/compare/v5.1.0-dev...v5.2.0) (2022-05-29)
+
+
+
 # [5.1.0](https://github.com/dereekb/dbx-components/compare/v5.0.1-dev...v5.1.0) (2022-05-27)
 
 

components/demo-components/CHANGELOG.md

@@ -2,6 +2,15 @@
 
 This file was generated using [@jscutlery/semver](https://github.com/jscutlery/semver).
 
+# [5.2.0](https://github.com/dereekb/dbx-components/compare/v5.1.0-dev...v5.2.0) (2022-05-29)
+
+
+### Features
+
+* added collection group support to dbx-firebase components ([9f746c1](https://github.com/dereekb/dbx-components/commit/9f746c12a0e219970dcde12d920f1ef540514ce9))
+
+
+
 # [5.1.0](https://github.com/dereekb/dbx-components/compare/v5.0.1-dev...v5.1.0) (2022-05-27)
 
 

components/demo-components/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dereekb/demo-components",
-  "version": "5.1.0",
+  "version": "5.2.0",
   "peerDependencies": {
     "@angular/common": "^13.3.0",
     "@angular/core": "^13.3.0"

components/demo-components/src/lib/modules/guestbook/store/guestbook.entry.collection.store.directive.ts

@@ -1,13 +1,13 @@
 import { Directive } from '@angular/core';
-import { DbxFirebaseCollectionStoreDirective, provideDbxFirebaseCollectionStoreDirective } from '@dereekb/dbx-firebase';
-import { GuestbookEntry, GuestbookEntryDocument } from '@dereekb/demo-firebase';
+import { DbxFirebaseCollectionWithParentStoreDirective, provideDbxFirebaseCollectionWithParentStoreDirective } from '@dereekb/dbx-firebase';
+import { Guestbook, GuestbookDocument, GuestbookEntry, GuestbookEntryDocument } from '@dereekb/demo-firebase';
 import { GuestbookEntryCollectionStore } from './guestbook.entry.collection.store';
 
 @Directive({
   selector: '[demoGuestbookEntryCollection]',
-  providers: provideDbxFirebaseCollectionStoreDirective(DemoGuestbookEntryCollectionStoreDirective, GuestbookEntryCollectionStore)
+  providers: provideDbxFirebaseCollectionWithParentStoreDirective(DemoGuestbookEntryCollectionStoreDirective, GuestbookEntryCollectionStore)
 })
-export class DemoGuestbookEntryCollectionStoreDirective extends DbxFirebaseCollectionStoreDirective<GuestbookEntry, GuestbookEntryDocument, GuestbookEntryCollectionStore> {
+export class DemoGuestbookEntryCollectionStoreDirective extends DbxFirebaseCollectionWithParentStoreDirective<GuestbookEntry, Guestbook, GuestbookEntryDocument, GuestbookDocument, GuestbookEntryCollectionStore> {
   constructor(store: GuestbookEntryCollectionStore) {
     super(store);
   }

components/demo-components/src/lib/modules/guestbook/store/guestbook.entry.collection.store.ts

@@ -6,7 +6,7 @@ import { GuestbookDocumentStore } from './guestbook.document.store';
 @Injectable()
 export class GuestbookEntryCollectionStore extends AbstractDbxFirebaseCollectionWithParentStore<GuestbookEntry, Guestbook, GuestbookEntryDocument, GuestbookDocument> {
   constructor(collections: DemoFirestoreCollections, @Optional() parent: GuestbookDocumentStore) {
-    super({ collectionFactory: collections.guestbookEntryCollectionFactory });
+    super({ collectionFactory: collections.guestbookEntryCollectionFactory, collectionGroup: collections.guestbookEntryCollectionGroup });
     this.setConstraints(publishedGuestbookEntry()); // todo: replace with filter
 
     if (parent) {

components/demo-firebase/CHANGELOG.md

@@ -2,6 +2,15 @@
 
 This file was generated using [@jscutlery/semver](https://github.com/jscutlery/semver).
 
+# [5.2.0](https://github.com/dereekb/dbx-components/compare/v5.1.0-dev...v5.2.0) (2022-05-29)
+
+
+### Features
+
+* added firestore collection group support ([3b4c4cf](https://github.com/dereekb/dbx-components/commit/3b4c4cfa1dd860604c347ade69acdc2fea1063f8))
+
+
+
 # [5.1.0](https://github.com/dereekb/dbx-components/compare/v5.0.1-dev...v5.1.0) (2022-05-27)
 
 

components/demo-firebase/package.json

@@ -1,5 +1,5 @@
 {
   "name": "@dereekb/demo-firebase",
-  "version": "5.1.0",
+  "version": "5.2.0",
   "type": "commonjs"
 }

components/demo-firebase/src/lib/collection.ts

@@ -1,9 +1,10 @@
 import { FirestoreContext } from '@dereekb/firebase';
-import { guestbookEntryFirestoreCollectionFactory, GuestbookEntryFirestoreCollectionFactory, guestbookFirestoreCollection, GuestbookFirestoreCollection, GuestbookFirestoreCollections } from './guestbook';
+import { guestbookEntryFirestoreCollectionFactory, GuestbookEntryFirestoreCollectionFactory, guestbookEntryFirestoreCollectionGroup, GuestbookEntryFirestoreCollectionGroup, guestbookFirestoreCollection, GuestbookFirestoreCollection, GuestbookFirestoreCollections } from './guestbook';
 import { profileFirestoreCollection, ProfileFirestoreCollection, ProfileFirestoreCollections, profilePrivateDataFirestoreCollectionFactory, ProfilePrivateDataFirestoreCollectionFactory } from './profile/profile';
 
 export abstract class DemoFirestoreCollections implements ProfileFirestoreCollections, GuestbookFirestoreCollections {
   abstract readonly guestbookFirestoreCollection: GuestbookFirestoreCollection;
+  abstract readonly guestbookEntryCollectionGroup: GuestbookEntryFirestoreCollectionGroup;
   abstract readonly guestbookEntryCollectionFactory: GuestbookEntryFirestoreCollectionFactory;
   abstract readonly profileFirestoreCollection: ProfileFirestoreCollection;
   abstract readonly profilePrivateDataCollectionFactory: ProfilePrivateDataFirestoreCollectionFactory;
@@ -12,6 +13,7 @@ export abstract class DemoFirestoreCollections implements ProfileFirestoreCollec
 export function makeDemoFirestoreCollections(firestoreContext: FirestoreContext): DemoFirestoreCollections {
   return {
     guestbookFirestoreCollection: guestbookFirestoreCollection(firestoreContext),
+    guestbookEntryCollectionGroup: guestbookEntryFirestoreCollectionGroup(firestoreContext),
     guestbookEntryCollectionFactory: guestbookEntryFirestoreCollectionFactory(firestoreContext),
     profileFirestoreCollection: profileFirestoreCollection(firestoreContext),
     profilePrivateDataCollectionFactory: profilePrivateDataFirestoreCollectionFactory(firestoreContext)

components/demo-firebase/src/lib/guestbook/guestbook.ts

@@ -1,4 +1,4 @@
-import { CollectionReference, AbstractFirestoreDocument, snapshotConverterFunctions, firestoreString, firestoreDate, FirestoreCollection, UserRelatedById, DocumentReferenceRef, FirestoreContext, FirestoreCollectionWithParent, firestoreBoolean, DocumentDataWithId, AbstractFirestoreDocumentWithParent, optionalFirestoreDate } from '@dereekb/firebase';
+import { CollectionReference, AbstractFirestoreDocument, snapshotConverterFunctions, firestoreString, firestoreDate, FirestoreCollection, UserRelatedById, DocumentReferenceRef, FirestoreContext, FirestoreCollectionWithParent, firestoreBoolean, DocumentDataWithId, AbstractFirestoreDocumentWithParent, optionalFirestoreDate, DocumentReference, FirestoreCollectionGroup, CollectionGroup } from '@dereekb/firebase';
 import { Maybe } from '@dereekb/util';
 
 export interface GuestbookFirestoreCollections {
@@ -122,3 +122,18 @@ export function guestbookEntryFirestoreCollectionFactory(firestoreContext: Fires
     });
   };
 }
+
+export function guestbookEntryCollectionReference(context: FirestoreContext): CollectionGroup<GuestbookEntry> {
+  return context.collectionGroup(guestbookCollectionGuestbookEntryCollectionPath).withConverter<GuestbookEntry>(guestbookEntryConverter);
+}
+
+export type GuestbookEntryFirestoreCollectionGroup = FirestoreCollectionGroup<GuestbookEntry, GuestbookEntryDocument>;
+
+export function guestbookEntryFirestoreCollectionGroup(firestoreContext: FirestoreContext): GuestbookEntryFirestoreCollectionGroup {
+  return firestoreContext.firestoreCollectionGroup({
+    itemsPerPage: 50,
+    queryLike: guestbookEntryCollectionReference(firestoreContext),
+    makeDocument: (accessor, documentAccessor) => new GuestbookEntryDocument(undefined, accessor, documentAccessor),
+    firestoreContext
+  });
+}

firebase.json

@@ -3,13 +3,17 @@
     "site": "dereekb-components",
     "public": "dist/apps/demo",
     "ignore": ["firebase.json", "**/.*", "**/node_modules/**"],
-    "headers": [{
-      "source": "*.[0-9a-f][0-9a-f][0-9a-f][0-9a-f][0-9a-f][0-9a-f][0-9a-f][0-9a-f][0-9a-f][0-9a-f][0-9a-f][0-9a-f][0-9a-f][0-9a-f][0-9a-f][0-9a-f][0-9a-f][0-9a-f][0-9a-f][0-9a-f].+(css|js)",
-      "headers": [{
-        "key": "Cache-Control",
-        "value": "public,max-age=31536000,immutable"
-      }]
-    }],
+    "headers": [
+      {
+        "source": "*.[0-9a-f][0-9a-f][0-9a-f][0-9a-f][0-9a-f][0-9a-f][0-9a-f][0-9a-f][0-9a-f][0-9a-f][0-9a-f][0-9a-f][0-9a-f][0-9a-f][0-9a-f][0-9a-f][0-9a-f][0-9a-f][0-9a-f][0-9a-f].+(css|js)",
+        "headers": [
+          {
+            "key": "Cache-Control",
+            "value": "public,max-age=31536000,immutable"
+          }
+        ]
+      }
+    ],
     "rewrites": [
       {
         "source": "/api/**",

firestore.rules

@@ -20,6 +20,17 @@ service cloud.firestore {
       }
     }
 
+    // collection group example
+    // https://firebase.google.com/docs/firestore/security/rules-query#collection_group_queries_and_security_rules
+    match /{path=**}/entry/{entry} {
+
+      // Can read any entry that is owned or published.
+      allow get: if resourceIsPublished() || resourceIsOwnedByAuthUserId();
+
+      // Can only query if the guestbook entry is published.
+      allow list: if resourceIsPublished();
+    }
+
     function resourceIsPublished() {
       return (resource.data.published != false);
     }

make-env.js

@@ -6,14 +6,11 @@
  * node make-env.js
  */
 const fs = require('fs');
-const {
-  parse,
-  stringify
-} = require('envfile');
+const { parse, stringify } = require('envfile');
 
 // NOTE: If run within nx, remember that nx adds all variables within .env to the environment and, thus, process.env.
 // Variables that are within bash take prority.
-const templateFilePath = '.env';  
+const templateFilePath = '.env';
 const templateEnv = fs.readFileSync(templateFilePath).toString();
 const template = parse(templateEnv);
 

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dereekb/dbx-components",
-  "version": "5.1.0",
+  "version": "5.2.0",
   "license": "MIT",
   "scripts": {
     "postinstall": "ngcc --properties es2015 browser module main",

packages/browser/CHANGELOG.md

@@ -2,6 +2,10 @@
 
 This file was generated using [@jscutlery/semver](https://github.com/jscutlery/semver).
 
+# [5.2.0](https://github.com/dereekb/dbx-components/compare/v5.1.0-dev...v5.2.0) (2022-05-29)
+
+
+
 # [5.1.0](https://github.com/dereekb/dbx-components/compare/v5.0.1-dev...v5.1.0) (2022-05-27)
 
 

packages/browser/package.json

@@ -1,5 +1,5 @@
 {
   "name": "@dereekb/browser",
-  "version": "5.1.0",
+  "version": "5.2.0",
   "type": "commonjs"
 }