chore(samples): Flushing out samples (angular#2933)

* Splitting out the samples more * Add sample callouts * Small README changes
mmalerba · Sep 9, 2021 · 402f3ff · 402f3ff
1 parent b22c824
commit 402f3ff
Show file tree

Hide file tree

Showing 224 changed files with 14,624 additions and 146 deletions.
diff --git a/.gitattributes b/.gitattributes
@@ -1,5 +1,5 @@
 src/**/firebase.ts linguist-generated=true
 src/**/rxfire.ts linguist-generated=true
 src/compat/**/base.ts linguist-generated=true
-sample/**/* linguist-generated=true
-sample-compat/**/* linguist-generated=true
+samples/**/* linguist-generated=true
+yarn.lock linguist-generated=true
diff --git a/README.md b/README.md
@@ -87,8 +87,7 @@ Neither AngularFire or Firebase ship with polyfills. To have compatability acros
 | Various ES5+ features  | IE 11<br>Safari &lt; 10 | [`core-js/stable`](https://github.com/zloirock/core-js#readme) | MIT |
 | `globalThis` | [IE 11<br>Chrome &lt; 71<br>Safari &lt; 12.1<br>iOS &lt; 12.2<br>Node &lt; 12](https://caniuse.com/mdn-javascript_builtins_globalthis) | [`globalThis`](https://github.com/es-shims/globalThis#readme) | MIT |
 | `Proxy` | [IE 11<br>Safari &lt; 10](https://caniuse.com/proxy) | [`proxy-polyfill`](https://github.com/GoogleChrome/proxy-polyfill#readme) | Apache 2.0 |
-| `fetch` | [IE 11<br>Node<br>Safari &lt; 10.1<br>iOS &lt; 10.3](https://caniuse.com/fetch) | [`cross-fetch`](https://github.com/lquixada/cross-fetch#readme) | MIT |
-| `Headers` | [IE 11<br>Node<br>Safari &lt; 10.1<br>iOS Safari](https://caniuse.com/mdn-api_headers) | [`cross-fetch`](https://github.com/lquixada/cross-fetch#readme) | MIT |
+| `fetch` | [IE 11<br>Safari &lt; 10.1<br>iOS &lt; 10.3](https://caniuse.com/fetch) | [`cross-fetch`](https://github.com/lquixada/cross-fetch#readme) | MIT |
 
 ## Resources
 
@@ -100,7 +99,17 @@ Neither AngularFire or Firebase ship with polyfills. To have compatability acros
 
 [Upgrading to v7.0? Check out our guide.](docs/version-7-upgrade.md)
 
-**Having troubles?** Get help on our [Q&A board](https://github.com/angular/angularfire/discussions?discussions_q=category%3AQ%26A), the official [Firebase Mailing List](https://groups.google.com/forum/#!forum/firebase-talk), the [Firebase Community Slack](https://firebase.community/) (`#angularfire2`), the [Angular Community Discord](http://discord.gg/angular) (`#firebase`), [Gitter](https://gitter.im/angular/angularfire2), the [Firebase subreddit](https://www.reddit.com/r/firebase), or [Stack Overflow](https://stackoverflow.com/questions/tagged/angularfire2).
+### Sample apps
+
+We have three sample apps in this repository:
+
+1. [`samples/compat`](samples/compat) a kitchen sink application that demonstrates use of the "compatability" API in an Angular Universal app w/TransferState.
+1. [`samples/modular`](samples/modular) a kitchen sink application that demonstrates the new tree-shakable API in an Angular Universal app w/TransferState.
+1. [`samples/advanced`](samples/advanced) the same app as `samples/modular` but demonstrates more advanced concepts such as dynamically importing Firebase feature modules and Firestore data bundling.
+
+### Having troubles?
+
+Get help on our [Q&A board](https://github.com/angular/angularfire/discussions?discussions_q=category%3AQ%26A), the official [Firebase Mailing List](https://groups.google.com/forum/#!forum/firebase-talk), the [Firebase Community Slack](https://firebase.community/) (`#angularfire2`), the [Angular Community Discord](http://discord.gg/angular) (`#firebase`), [Gitter](https://gitter.im/angular/angularfire2), the [Firebase subreddit](https://www.reddit.com/r/firebase), or [Stack Overflow](https://stackoverflow.com/questions/tagged/angularfire2).
 
 > **NOTE:** AngularFire is maintained by Googlers but is not a supported Firebase product. Questions on the mailing list and issues filed here are answered on a <strong>best-effort basis</strong> by maintainers and other community members. If you are able to reproduce a problem with Firebase <em>outside of AngularFire's implementation</em>, please [file an issue on the Firebase JS SDK](https://github.com/firebase/firebase-js-sdk/issues) or reach out to the personalized [Firebase support channel](https://firebase.google.com/support/).
 

diff --git a/SECURITY.md b/SECURITY.md
@@ -4,8 +4,8 @@
 
 | Version | Supported          |
 | ------- | ------------------ |
-| 5.0+    | :white_check_mark: |
-| < 5.0   | :x:                |
+| 6.0+    | :white_check_mark: |
+| < 6.0   | :x:                |
 
 ## Reporting a Vulnerability
 

diff --git a/docs/version-7-upgrade.md b/docs/version-7-upgrade.md
@@ -164,7 +164,7 @@ collection<T>(firestore, 'foo') // CollectionReference<T>
 
 ```ts
 import { collectionGroup } from '@angular/fire/firestore';
-collectionGroup<T>('foo') // Query<T>
+collectionGroup<T>(firestore, 'foo') // Query<T>
 ```
 </td>
         </tr>

diff --git a/package.json b/package.json
@@ -68,14 +68,8 @@
     "semver": "^7.1.3",
     "tslib": "^2.1.0",
     "webpack": "^5.35.0",
-    "ws": "^7.2.1",
-    "xhr2": "^0.1.4",
     "zone.js": "~0.11.4"
   },
-  "optionalDependencies": {
-    "bufferutil": "^4.0.1",
-    "utf-8-validate": "^5.0.2"
-  },
   "devDependencies": {
     "@angular-devkit/build-angular": "^12.0.0",
     "@angular/animations": "~12.0.0",

diff --git a/sample/src/app/auth/GoogleAuthProvider.ts b/sample/src/app/auth/GoogleAuthProvider.ts
diff --git a/sample/src/app/upboats/lazyFirestore.ts b/sample/src/app/upboats/lazyFirestore.ts
diff --git a/sample-compat/.browserslistrc → samples/advanced/.browserslistrc b/sample-compat/.browserslistrc → samples/advanced/.browserslistrc
diff --git a/sample/.editorconfig → samples/advanced/.editorconfig b/sample/.editorconfig → samples/advanced/.editorconfig
diff --git a/sample/.firebaserc → samples/advanced/.firebaserc b/sample/.firebaserc → samples/advanced/.firebaserc
diff --git a/sample/.gitignore → samples/advanced/.gitignore b/sample/.gitignore → samples/advanced/.gitignore
diff --git a/sample/README.md → samples/advanced/README.md b/sample/README.md → samples/advanced/README.md
diff --git a/sample/angular.json → samples/advanced/angular.json b/sample/angular.json → samples/advanced/angular.json
diff --git a/sample/firebase.json → samples/advanced/firebase.json b/sample/firebase.json → samples/advanced/firebase.json
diff --git a/sample/karma.conf.js → samples/advanced/karma.conf.js b/sample/karma.conf.js → samples/advanced/karma.conf.js
diff --git a/sample/ngsw-config.json → samples/advanced/ngsw-config.json b/sample/ngsw-config.json → samples/advanced/ngsw-config.json
diff --git a/sample/package.json → samples/advanced/package.json b/sample/package.json → samples/advanced/package.json
diff --git a/sample/server.ts → samples/advanced/server.ts b/sample/server.ts → samples/advanced/server.ts
diff --git a/samples/advanced/src/app/app-routing.module.ts b/samples/advanced/src/app/app-routing.module.ts
diff --git a/sample/src/app/app.browser.module.ts → ...es/advanced/src/app/app.browser.module.ts b/sample/src/app/app.browser.module.ts → ...es/advanced/src/app/app.browser.module.ts
diff --git a/sample/src/app/app.component.spec.ts → ...es/advanced/src/app/app.component.spec.ts b/sample/src/app/app.component.spec.ts → ...es/advanced/src/app/app.component.spec.ts
diff --git a/samples/advanced/src/app/app.component.ts b/samples/advanced/src/app/app.component.ts
diff --git a/sample/src/app/app.module.ts → samples/advanced/src/app/app.module.ts b/sample/src/app/app.module.ts → samples/advanced/src/app/app.module.ts
diff --git a/samples/advanced/src/app/app.server.module.ts b/samples/advanced/src/app/app.server.module.ts
diff --git a/...ompat/src/app/auth/auth.component.spec.ts → ...anced/src/app/auth/auth.component.spec.ts b/...ompat/src/app/auth/auth.component.spec.ts → ...anced/src/app/auth/auth.component.spec.ts
diff --git a/samples/advanced/src/app/auth/auth.component.ts b/samples/advanced/src/app/auth/auth.component.ts
diff --git a/...c/app/database/database.component.spec.ts → ...c/app/database/database.component.spec.ts b/...c/app/database/database.component.spec.ts → ...c/app/database/database.component.spec.ts
diff --git a/...le/src/app/database/database.component.ts → ...ed/src/app/database/database.component.ts b/...le/src/app/database/database.component.ts → ...ed/src/app/database/database.component.ts
diff --git a/sample/src/app/database/lazyDatabase.ts → ...advanced/src/app/database/lazyDatabase.ts b/sample/src/app/database/lazyDatabase.ts → ...advanced/src/app/database/lazyDatabase.ts
diff --git a/...app/firestore/firestore.component.spec.ts → ...app/firestore/firestore.component.spec.ts b/...app/firestore/firestore.component.spec.ts → ...app/firestore/firestore.component.spec.ts
diff --git a/.../src/app/firestore/firestore.component.ts → .../src/app/firestore/firestore.component.ts b/.../src/app/firestore/firestore.component.ts → .../src/app/firestore/firestore.component.ts
diff --git a/sample/src/app/firestore/lazyFirestore.ts → ...vanced/src/app/firestore/lazyFirestore.ts b/sample/src/app/firestore/lazyFirestore.ts → ...vanced/src/app/firestore/lazyFirestore.ts
diff --git a/...app/functions/functions.component.spec.ts → ...app/functions/functions.component.spec.ts b/...app/functions/functions.component.spec.ts → ...app/functions/functions.component.spec.ts
diff --git a/.../src/app/functions/functions.component.ts → .../src/app/functions/functions.component.ts b/.../src/app/functions/functions.component.ts → .../src/app/functions/functions.component.ts
diff --git a/sample/src/app/functions/lazyFunctions.ts → ...vanced/src/app/functions/lazyFunctions.ts b/sample/src/app/functions/lazyFunctions.ts → ...vanced/src/app/functions/lazyFunctions.ts
diff --git a/sample/src/app/getFirestore.ts → samples/advanced/src/app/getFirestore.ts b/sample/src/app/getFirestore.ts → samples/advanced/src/app/getFirestore.ts
diff --git a/sample/src/app/home/home.component.ts → ...s/advanced/src/app/home/home.component.ts b/sample/src/app/home/home.component.ts → ...s/advanced/src/app/home/home.component.ts
diff --git a/samples/advanced/src/app/login/login-routing.module.ts b/samples/advanced/src/app/login/login-routing.module.ts
diff --git a/samples/advanced/src/app/login/login.component.spec.ts b/samples/advanced/src/app/login/login.component.spec.ts
diff --git a/samples/advanced/src/app/login/login.component.ts b/samples/advanced/src/app/login/login.component.ts
-Original file line number
+Diff line change
@@ Expand Up / @@ -164,7 +164,7 @@ collection<T>(firestore, 'foo') // CollectionReference<T> @@
     ```ts
     import { collectionGroup } from '@angular/fire/firestore';
-    collectionGroup<T>('foo') // Query<T>
+    collectionGroup<T>(firestore, 'foo') // Query<T>
     ```
     </td>
             </tr>
@@ Expand Down @@