checkpoint: demo

dereekb · May 12, 2022 · c5bfe24 · c5bfe24
1 parent 221af8e
commit c5bfe24
Show file tree

Hide file tree

Showing 16 changed files with 160 additions and 31 deletions.
diff --git a/apps/demo-api/src/app/function/guestbook/guestbookentry.function.spec.ts b/apps/demo-api/src/app/function/guestbook/guestbookentry.function.spec.ts
@@ -10,7 +10,7 @@ demoApiFunctionContextFactory((f: DemoApiFunctionContextFixture) => {
 
     demoAuthorizedUserContext({ f }, (u) => {
 
-      demoGuestbookContext({ f, active: true }, (g) => {
+      demoGuestbookContext({ f, published: true }, (g) => {
 
         describe('guestbook is active', () => {
 

diff --git a/apps/demo-api/src/app/function/guestbook/guestbookentry.update.ts b/apps/demo-api/src/app/function/guestbook/guestbookentry.update.ts
@@ -10,6 +10,5 @@ export const updateGuestbookEntry = onCallWithDemoNestContext(inAuthContext(asyn
   const { guestbook: guestbookId } = guestbookEntryUpdateEntry.params;
 
   const guestbookEntryDocument = guestbookEntryForUser(nest, guestbookId, uid);
-
   await guestbookEntryUpdateEntry(guestbookEntryDocument);
 }));
diff --git a/apps/demo-api/src/test/fixture.ts b/apps/demo-api/src/test/fixture.ts
@@ -152,7 +152,7 @@ export const demoGuestbookContextFactory = () => modelTestContextFactory<
 
     await guestbook.accessor.set({
       name: params.name ?? 'test',
-      active: params.active ?? true,
+      published: params.published ?? true,
       locked: params.locked ?? false,
       lockedAt: (params.lockedAt) ?? ((params.locked) ? new Date() : undefined)
     });

diff --git a/apps/demo-firebase/src/lib/guestbook/guestbook.query.ts b/apps/demo-firebase/src/lib/guestbook/guestbook.query.ts
@@ -1,5 +1,9 @@
 import { FirestoreQueryConstraint, where } from "@dereekb/firebase";
 
-export function publishedGuestbookEntries(published = true): FirestoreQueryConstraint {
+export function publishedGuestbook(published = true): FirestoreQueryConstraint {
+  return where('published', '==', published);
+}
+
+export function publishedGuestbookEntry(published = true): FirestoreQueryConstraint {
   return where('published', '==', published);
 }
diff --git a/apps/demo-firebase/src/lib/guestbook/guestbook.ts b/apps/demo-firebase/src/lib/guestbook/guestbook.ts
@@ -12,7 +12,7 @@ export interface Guestbook {
    * 
    * If not active, this item is still considered locked.
    */
-  active: boolean;
+  published?: boolean;
   /**
    * Guestbook name
    */
@@ -37,7 +37,7 @@ export const guestbookCollectionPath = 'guestbook';
 
 export const guestbookConverter = makeSnapshotConverterFunctions<Guestbook>({
   fields: {
-    active: firestoreBoolean(),
+    published: firestoreBoolean(),
     name: firestoreString(),
     locked: firestoreBoolean({ default: false }),
     lockedAt: firestoreDate()
@@ -87,7 +87,7 @@ export interface GuestbookEntryRef extends DocumentReferenceRef<GuestbookEntry>
 
 export class GuestbookEntryDocument extends AbstractFirestoreDocumentWithParent<Guestbook, GuestbookEntry, GuestbookEntryDocument> { }
 
-export const guestbookEntryCollectionPath = 'guestbookEntry';
+export const guestbookCollectionGuestbookEntryCollectionPath = 'entry';
 
 export const guestbookEntryConverter = makeSnapshotConverterFunctions<GuestbookEntry>({
   fields: {
@@ -101,7 +101,7 @@ export const guestbookEntryConverter = makeSnapshotConverterFunctions<GuestbookE
 
 export function guestbookEntryCollectionReferenceFactory(context: FirestoreContext): (guestbook: GuestbookDocument) => CollectionReference<GuestbookEntry> {
   return (guestbook: GuestbookDocument) => {
-    return context.subcollection(guestbook.documentRef, guestbookEntryCollectionPath).withConverter<GuestbookEntry>(guestbookEntryConverter);
+    return context.subcollection(guestbook.documentRef, guestbookCollectionGuestbookEntryCollectionPath).withConverter<GuestbookEntry>(guestbookEntryConverter);
   };
 }
 

diff --git a/apps/demo-firebase/src/lib/profile/profile.ts b/apps/demo-firebase/src/lib/profile/profile.ts
@@ -66,7 +66,7 @@ export interface ProfilePrivateDataRef extends DocumentReferenceRef<ProfilePriva
 
 export class ProfilePrivateDataDocument extends AbstractFirestoreDocument<ProfilePrivateData, ProfilePrivateDataDocument> { }
 
-export const profilePrivateDataCollectionPath = 'profilePrivateData';
+export const profileCollectionProfilePrivateDataCollectionPath = 'private';
 export const profilePrivateDataIdentifier = '0';
 
 export const profilePrivateDataConverter = makeSnapshotConverterFunctions<ProfilePrivateData>({
@@ -78,7 +78,7 @@ export const profilePrivateDataConverter = makeSnapshotConverterFunctions<Profil
 
 export function profilePrivateDataCollectionReferenceFactory(context: FirestoreContext): (profile: ProfileDocument) => CollectionReference<ProfilePrivateData> {
   return (profile: ProfileDocument) => {
-    return context.subcollection(profile.documentRef, profilePrivateDataCollectionPath).withConverter<ProfilePrivateData>(profilePrivateDataConverter);
+    return context.subcollection(profile.documentRef, profileCollectionProfilePrivateDataCollectionPath).withConverter<ProfilePrivateData>(profilePrivateDataConverter);
   };
 }
 

diff --git a/...rc/app/modules/demo/modules/app/modules/guestbook/container/guestbook.view.component.html b/...rc/app/modules/demo/modules/app/modules/guestbook/container/guestbook.view.component.html
@@ -7,6 +7,7 @@ <h2>{{ name$ | async }}</h2>
         <div [ngSwitch]="guestbookEntry.exists$ | async">
           <div *ngSwitchCase="true">
             <p class="dbx-note">You have signed this guest book.</p>
+            <p class="dbx-note" *ngIf="guestbookEntry.unpublished$ | async">Your entry is not public.</p>
             <dbx-button [raised]="true" color="primary" text="Edit Your Entry" (buttonClick)="openEntry()"></dbx-button>
           </div>
           <div *ngSwitchCase="false">

diff --git a/...src/app/modules/demo/modules/shared/modules/guestbook/store/guestbook.collection.store.ts b/...src/app/modules/demo/modules/shared/modules/guestbook/store/guestbook.collection.store.ts
@@ -1,12 +1,13 @@
 import { Injectable } from "@angular/core";
 import { AbstractDbxFirebaseCollectionStore } from "@dereekb/dbx-firebase";
-import { DemoFirestoreCollections, Guestbook, GuestbookDocument } from "@dereekb/demo-firebase";
+import { DemoFirestoreCollections, Guestbook, GuestbookDocument, publishedGuestbook } from "@dereekb/demo-firebase";
 
 @Injectable()
 export class GuestbookCollectionStore extends AbstractDbxFirebaseCollectionStore<Guestbook, GuestbookDocument> {
 
   constructor(collections: DemoFirestoreCollections) {
     super({ firestoreCollection: collections.guestbookFirestoreCollection });
+    this.setConstraints(publishedGuestbook()); // todo: replace with filter
   }
 
 }
diff --git a/...p/modules/demo/modules/shared/modules/guestbook/store/guestbook.entry.collection.store.ts b/...p/modules/demo/modules/shared/modules/guestbook/store/guestbook.entry.collection.store.ts
@@ -1,13 +1,14 @@
 import { Optional, Injectable } from "@angular/core";
 import { AbstractDbxFirebaseCollectionWithParentStore } from "@dereekb/dbx-firebase";
-import { DemoFirestoreCollections, Guestbook, GuestbookDocument, GuestbookEntry, GuestbookEntryDocument } from "@dereekb/demo-firebase";
+import { DemoFirestoreCollections, Guestbook, GuestbookDocument, GuestbookEntry, GuestbookEntryDocument, publishedGuestbookEntry } from "@dereekb/demo-firebase";
 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 });
+    this.setConstraints(publishedGuestbookEntry()); // todo: replace with filter
 
     if (parent) {
       this.setParentStore(parent);

diff --git a/...s/demo/modules/shared/modules/guestbook/store/guestbook.entry.document.store.directive.ts b/...s/demo/modules/shared/modules/guestbook/store/guestbook.entry.document.store.directive.ts
@@ -1,6 +1,7 @@
 import { Directive } from "@angular/core";
 import { DbxFirebaseDocumentStoreDirective, provideDbxFirebaseDocumentStoreDirective } from "@dereekb/dbx-firebase";
 import { GuestbookEntry, GuestbookEntryDocument } from "@dereekb/demo-firebase";
+import { map } from "rxjs";
 import { GuestbookEntryDocumentStore } from "./guestbook.entry.document.store";
 
 @Directive({
@@ -14,4 +15,6 @@ export class DemoGuestbookEntryDocumentStoreDirective extends DbxFirebaseDocumen
     super(store);
   }
 
+  readonly unpublished$ = this.data$.pipe(map((x) => !x.published));
+
 }
diff --git a/...app/modules/demo/modules/shared/modules/guestbook/store/guestbook.entry.document.store.ts b/...app/modules/demo/modules/shared/modules/guestbook/store/guestbook.entry.document.store.ts
@@ -1,4 +1,4 @@
-import { first, Observable, shareReplay, from, switchMap } from 'rxjs';
+import { first, Observable, shareReplay, from, switchMap, map } from 'rxjs';
 import { Optional, Injectable } from "@angular/core";
 import { LoadingState, loadingStateFromObs } from '@dereekb/rxjs';
 import { AbstractDbxFirebaseDocumentWithParentStore } from "@dereekb/dbx-firebase";

diff --git a/apps/demo/src/app/modules/landing/container/layout.component.html b/apps/demo/src/app/modules/landing/container/layout.component.html
@@ -12,7 +12,25 @@ <h1 class="headline">DbxComponents</h1>
           </dbx-anchor>
           <dbx-button-spacer></dbx-button-spacer>
           <dbx-anchor [anchor]="demoAnchor">
-            <button mat-flat-button>View Demo (Coming Soon)</button>
+            <button mat-flat-button>View Demo</button>
+          </dbx-anchor>
+        </div>
+        <p></p>
+        <mat-divider></mat-divider>
+        <p></p>
+        <div>
+          <dbx-anchor [anchor]="circleciAnchor">
+            <img src="https://circleci.com/gh/dereekb/dbx-components/tree/main.svg?style=shield" />
+            <dbx-button-spacer></dbx-button-spacer>
+            <div class="star-on-github-widget">
+              <a class="star-on-github" href="https://github.com/dereekb/dbx-components" rel="noopener" target="_blank"
+                aria-label="Star dereekb/dbx-components on GitHub"><svg viewBox="0 0 16 16" width="14" height="14"
+                  class="octicon octicon-mark-github" aria-hidden="true">
+                  <path fill-rule="evenodd"
+                    d="M8 0C3.58 0 0 3.58 0 8c0 3.54 2.29 6.53 5.47 7.59.4.07.55-.17.55-.38 0-.19-.01-.82-.01-1.49-2.01.37-2.53-.49-2.69-.94-.09-.23-.48-.94-.82-1.13-.28-.15-.68-.52-.01-.53.63-.01 1.08.58 1.23.82.72 1.21 1.87.87 2.33.66.07-.52.28-.87.51-1.07-1.78-.2-3.64-.89-3.64-3.95 0-.87.31-1.59.82-2.15-.08-.2-.36-1.02.08-2.12 0 0 .67-.21 2.2.82.64-.18 1.32-.27 2-.27.68 0 1.36.09 2 .27 1.53-1.04 2.2-.82 2.2-.82.44 1.1.16 1.92.08 2.12.51.56.82 1.27.82 2.15 0 3.07-1.87 3.75-3.65 3.95.29.25.54.73.54 1.48 0 1.07-.01 1.93-.01 2.2 0 .21.15.46.55.38A8.013 8.013 0 0016 8c0-4.42-3.58-8-8-8z">
+                  </path>
+                </svg>&nbsp;<span>Star</span></a>
+            </div>
           </dbx-anchor>
         </div>
       </dbx-content-container>
@@ -39,7 +57,7 @@ <h4>{{ package.name }}</h4>
                 <p class="dbx-label">Primary Packages</p>
                 <ng-container *ngFor="let anchor of package.packages; let last = last;">
                   <dbx-anchor [anchor]="anchor" class="package-primary-package-list-item">
-                    <dbx-anchor-content class="dbx-link" [anchor]="anchor"></dbx-anchor-content>
+                    <dbx-anchor-content class="dbx-link d-fiflex" [anchor]="anchor"></dbx-anchor-content>
                   </dbx-anchor>
                   <span class="dbx-button-spacer" *ngIf="!last">,</span>
                 </ng-container>
@@ -52,7 +70,7 @@ <h4>{{ package.name }}</h4>
           <div class="package-primary-package-list">
             <ng-container *ngFor="let anchor of otherPackages; let last = last;">
               <dbx-anchor [anchor]="anchor" class="package-primary-package-list-item">
-                <dbx-anchor-content class="dbx-link" [anchor]="anchor"></dbx-anchor-content>
+                <dbx-anchor-content class="dbx-link d-fiflex" [anchor]="anchor"></dbx-anchor-content>
               </dbx-anchor>
               <span class="dbx-button-spacer" *ngIf="!last">,</span>
             </ng-container>

diff --git a/apps/demo/src/app/modules/landing/container/layout.component.ts b/apps/demo/src/app/modules/landing/container/layout.component.ts
@@ -1,4 +1,4 @@
-import { ClickableAnchor, ClickableAnchorLink, ClickableIconAnchorLink } from '@dereekb/dbx-core';
+import { ClickableAnchorLink } from '@dereekb/dbx-core';
 import { Component } from '@angular/core';
 import packageInfo from '../../../../../../../package.json';
 
@@ -24,7 +24,20 @@ export class LandingLayoutComponent {
     ref: 'demo'
   };
 
+  readonly circleciAnchor: ClickableAnchorLink = {
+    title: 'CircleCI',
+    url: 'https://circleci.com/gh/dereekb/dbx-components/tree/main'
+  };
+
   readonly packages: LandingItem[] = [{
+    name: '@dereekb/dbx-form',
+    description: 'Forms extension for @dereekb/dbx-web to make composing and consuming form easy.',
+    packages: [{
+      title: '@ngx-formly/schematics',
+      url: 'https://formly.dev/',
+      target: '_blank'
+    }]
+  }, {
     name: '@dereekb/dbx-web',
     description: 'Full set of components for Angular in the browser. Built on top of @angular/material.',
     packages: [{
@@ -33,24 +46,28 @@ export class LandingLayoutComponent {
       target: '_blank'
     }]
   }, {
-    name: '@dereekb/dbx-form',
-    description: 'Forms extension for @dereekb/dbx-web to make composing and consuming form easy.',
+    name: '@dereekb/dbx-core',
+    description: 'Set of directives and utilities for any Angular project.',
     packages: [{
-      title: '@ngx-formly/schematics',
-      url: 'https://formly.dev/',
+      title: 'Angular',
+      url: 'https://angular.io/',
       target: '_blank'
     }]
   }, {
-    name: '@dereekb/dbx-core',
-    description: 'Set of directives and utilities for Angular.',
+    name: '@dereekb/firebase-server',
+    description: 'Extension of @dereekb/firebase for firebase server projects. Provides patterns and tooling for using nestjs in Firebase.',
     packages: [{
-      title: 'Angular',
-      url: 'https://angular.io/',
+      title: 'firebase',
+      url: 'https://firebase.google.com/',
+      target: '_blank'
+    }, {
+      title: 'nestjs',
+      url: 'https://nestjs.com/',
       target: '_blank'
     }]
   }, {
     name: '@dereekb/firebase',
-    description: 'Set of firebase utilities for the firebase for the web.',
+    description: 'Set of firebase patterns for the firebase for the web.',
     packages: [{
       title: 'firebase',
       url: 'https://firebase.google.com/',
@@ -70,7 +87,7 @@ export class LandingLayoutComponent {
     }]
   }, {
     name: '@dereekb/rxjs',
-    description: 'Set of rxjs utilities, including loading states and iterators.',
+    description: 'Set of rxjs utilities, including filters, loading states, rxjs operators, and async iterators.',
     packages: [{
       title: 'rxjs',
       url: 'https://rxjs.dev/',
@@ -80,9 +97,21 @@ export class LandingLayoutComponent {
       url: 'https://ngrx.io/',
       target: '_blank'
     }]
+  }, {
+    name: '@dereekb/model',
+    description: 'Utilities for dealing with models and extensions for the class-transformer and class-validator packages.',
+    packages: [{
+      title: 'class-transformer',
+      url: 'https://github.com/typestack/class-transformer',
+      target: '_blank'
+    }, {
+      title: 'class-validator',
+      url: 'https://github.com/typestack/class-validator',
+      target: '_blank'
+    }]
   }, {
     name: '@dereekb/util',
-    description: 'Set of general utilities, consumed by other @dereekb packages.',
+    description: 'Set of general utilities, data models and patterns that are consumed by other @dereekb packages.',
     packages: []
   }, {
     name: '@dereekb/browser',

diff --git a/apps/demo/src/app/modules/landing/landing.scss b/apps/demo/src/app/modules/landing/landing.scss
@@ -31,3 +31,42 @@
 }
 
 .features {}
+
+.star-on-github-widget {
+  // https://buttons.github.io/
+
+  display: inline-block;
+  overflow: hidden;
+  font-family: -apple-system, BlinkMacSystemFont, Segoe UI, Helvetica, Arial, sans-serif;
+  font-size: 0;
+  line-height: 0;
+  white-space: nowrap;
+
+  .star-on-github {
+    font-family: -apple-system, BlinkMacSystemFont, Segoe UI, Helvetica, Arial, sans-serif;
+    text-decoration: none;
+    outline: 0;
+    color: #24292f;
+    background-color: #ebf0f4;
+    border-color: rgba(27, 31, 36, .15);
+    background-image: linear-gradient(180deg, #f6f8fa, #ebf0f4 90%);
+
+    border-radius: 0.25em;
+
+    position: relative;
+    display: inline-flex;
+    height: 14px;
+    padding: 2px 5px;
+    font-size: 11px;
+    font-weight: 600;
+    line-height: 14px;
+    vertical-align: bottom;
+    cursor: pointer;
+    user-select: none;
+    background-repeat: repeat-x;
+    background-position: -1px -1px;
+    background-size: 110% 110%;
+    border: 1px solid;
+  }
+
+}
diff --git a/firestore.rules b/firestore.rules
@@ -1,8 +1,31 @@
 rules_version = '2';
 service cloud.firestore {
   match /databases/{database}/documents {
-    match /{document=**} {
-      allow read, write: if true;
+
+    match /profile/{profile} {
+      allow read: if resourceIsOwnedByAuthUserId();
     }
+
+    match /guestbook/{guestbook} {
+      allow read: if resourceIsPublished();
+
+      match /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);
+    }
+
+    function resourceIsOwnedByAuthUserId() {
+      return (resource.id == request.auth.uid);
+    }
+
   }
 }
diff --git a/packages/dbx-web/src/lib/layout/style/_style.scss b/packages/dbx-web/src/lib/layout/style/_style.scss
@@ -22,7 +22,9 @@
     padding: 0 !important;
   }
 
-  @each $i, $padding in theming.$padding-map {
+  @each $i,
+  $padding in theming.$padding-map {
+
     .pad-#{$i},
     .padding-#{$i} {
       padding: $padding;
@@ -37,6 +39,15 @@
     display: inline;
   }
 
+  .d-iflex {
+    display: inline-flex;
+  }
+
+  // force
+  .d-fiflex {
+    display: inline-flex !important;
+  }
+
 }
 
 @mixin color($theme-config) {