Typesaurus v8

.tool-versions

@@ -0,0 +1 @@
+nodejs 14.15.4

CHANGELOG.md

@@ -7,6 +7,77 @@ This change log follows the format documented in [Keep a CHANGELOG].
 [semantic versioning]: http://semver.org/
 [keep a changelog]: http://keepachangelog.com/
 
+## 8.0.0 - 2021-??-??
+
+Typesaurus v8 includes two important changes that bring the type-safety to another level:
+
+1. TODO
+
+2. TODO
+
+See below for details.
+
+### Fixes
+
+- Fixed `group` type to properly derive the collection model.
+
+### Changed
+
+- **BREAKING**: Use `lazyfire` for ESM-enabled web environments to make Firebase modules load on demand. It ensures maximum performance, but requires installation of additional dependency and change of application initialization.
+
+  So, if you're using webpack or another ESM-enabled bundler, install `lazyfire`:
+
+  ```bash
+  npm install lazyfire --save
+  # Or using Yarn:
+  yarn add lazyfire
+  ```
+
+  And then change `firebase.initializeApp` to `configureApp`:
+
+  ```diff
+  -import * as firebase from 'firebase/app'
+  -import 'firebase/firestore'
+  +import { configureApp } from 'lazyfire'
+
+  -firebase.initializeApp({
+  +configureApp({
+   // Firebase app configuration
+  })
+  ```
+
+- **BREAKING**: Make TypeScript 3.8 the minimal supported version.
+
+- **BREAKING**: `AnyUpdateValue` type was removed.
+
+- **BREAKING**: `UpdateValue` type now accepts two type arguments: object and key instead of a single type.
+
+- **BREAKING**: Disallowed using `value('remove')` on non-optional fields.
+
+- **BREAKING**: Removed `AddModel` and `SetModel` in favor of universal `WriteModel`.
+
+- **BREAKING**: `meta` argument in `doc` is again required.
+
+- **BREAKING**: Make `environment` a required meta property.
+
+- **BREAKING**: Moved `onMissing` to options in `getMany`.
+
+- **BREAKING**: All modules now export functions as named exports instead of using `default`.
+
+- **BREAKING**: `Query` type now exported from `typesaurus` or `typesaurus/types` instead of `typesaurus/query` and `typesaurus/onQuery`.
+
+- **BREAKING**: Unless `firestoreData: true` is specified in the meta, `doc` will convert `undefined` to `null` in the data.
+
+  The idea of the change is to match the Firestore behavior when composing a synthetic doc, which is helpful in tests or Typesaurus extensions.
+
+- Export options types for all functions.
+
+- `TransactionWriteFunction` no longer expect to return a promise.
+
+- Allow quering optional fields, inluding nested map fields using `where`.
+
+- Added `nullifyData` that deeply replaces `undefined` with `null` in the passed data. It used to match the Firestore behavior.
+
 ## 7.2.0 - 2021-05-25
 
 - Replace deprecated `@firebase/rules-testing` with `@firebase/rules-unit-testing`.

Makefile

@@ -29,12 +29,12 @@ test-system-browser-watch:
 
 build:
 	@rm -rf lib
-	@${BIN}/tsc
+	@${BIN}/tsc --project tsconfig.lib.json
 	@${BIN}/prettier "lib/**/*.[jt]s" --write --loglevel silent
 	@cp package.json lib
 	@cp *.md lib
 	@rsync --archive --prune-empty-dirs --exclude '*.ts' --relative src/./ lib
-	@${BIN}/tsc --outDir lib/esm --module es2020 --target es2019
+	@${BIN}/tsc --project tsconfig.lib.json --outDir lib/esm --module es2020 --target es2019
 	@cp src/adaptor/package.esm.json lib/esm/adaptor/package.json
 
 publish: build

README.md

@@ -34,27 +34,53 @@ yarn add typesaurus
 _Note that Typesaurus requires `firebase` package to work in the web environment and `firebase-admin` to work in Node.js. These packages aren't listed as dependencies,
 so that they won't install automatically along with the Typesaurus package._
 
+Additionally, when using with ESM-enabled bundler (like webpack), you'll need to install `lazyfire` that enables asynchronous importing of Firebase modules in the web environment:
+
+```sh
+npm install lazyfire --save
+# Or using Yarn:
+yarn add lazyfire
+```
+
+[Read more about Lazy Fire](https://github.com/kossnocorp/lazyfire).
+
 ## Configuration
 
-Typesaurus does not require additional configuration, however **when using with ESM-enabled bundler, you should transpile `node_modules`**. TypeScript preserves many modern languages features when it compiles to ESM code. So if you have to support older browsers, use Babel to process the dependencies code
+Typesaurus does not require additional configuration, however **when using with ESM-enabled bundler (like webpack), you should transpile `node_modules`**. TypeScript preserves many modern languages features when it compiles to ESM code. So if you have to support older browsers, use Babel to process the dependencies code.
 
 ## Get started
 
 ### Initialization
 
-To start working with Typesaurus, initialize Firebase normally.
+To start working with Typesaurus, you'll need to initialize Firebase.
 
-In the web environment ([see Firebase docs](https://firebase.google.com/docs/web/setup#add-sdks-initialize)):
+#### Web environment
+
+In the web environment when using ESM-enabled bundler (like webpack), use [Lazy Fire](https://github.com/kossnocorp/lazyfire) to configure the Firebase application:
+
+```ts
+import { configureApp } from 'lazyfire'
+
+configureApp({
+  // Firebase app configuration
+})
+```
+
+#### Legacy web environment
+
+In the web environment with ESM-disabled ([see Firebase docs](https://firebase.google.com/docs/web/setup#add-sdks-initialize)):
 
 ```ts
 import * as firebase from 'firebase/app'
 import 'firebase/firestore'
 
 firebase.initializeApp({
-  // Project configuration
+  // Firebase app configuration
 })
 ```
 
+#### Node.js environment
+
 In Node.js ([see Firebase docs](https://firebase.google.com/docs/admin/setup#initialize-sdk)):
 
 ```ts

babel.config.js

@@ -3,5 +3,6 @@ module.exports = {
     ['@babel/preset-env', { targets: { node: 'current' } }],
     '@babel/preset-typescript',
     'power-assert'
-  ]
+  ],
+  plugins: ['@babel/plugin-proposal-optional-chaining']
 }

karma.conf.js

@@ -2,7 +2,7 @@ const webpack = require('webpack')
 
 process.env.CHROME_BIN = require('puppeteer').executablePath()
 
-module.exports = config => {
+module.exports = (config) => {
   config.set({
     files: ['test/karmaTests.ts'],