CHANGELOG.md

5.2.0 (2022-05-09)

Build System / Dependencies

• deps: bump ajv from 5.5.2 to 6.12.6 (#228) (a46dc62d)

5.0.0 (2022-02-09)

New Features

• compat: update dependencies and use firebase v9 compat (#225) (aeb54a3e)

4.4.2 (2021-06-12)

Build System / Dependencies

• update release script (5506f78a)

Chores

• update dependencies (a6cc0899)

Code Style Changes

• fix up code to pass linting test (33276661)

Tests

• GeoTransaction: disable tests that can't run on the emulator (effacba3)
• firebase: use emulator to run tests (64ec3ac3)

4.4.1 (2020-12-13)

Build System / Dependencies

• deps: bump ini from 1.3.5 to 1.3.7 (#204) (a9cc0ab0)

Chores

• update geofirestore-core. fixes #202 (a6fd4134)
• github: configure stalebot (9aee4ad2)
• firebase: update firestore indexes (42ee6e0f)

4.4.0 (2020-11-26)

Build System / Dependencies

• update GitHub actions to only run in certain cases (383990c6)
• deps: bump bl from 4.0.2 to 4.0.3 (#191) (84fcb96a)

Chores

• typescript: update typescript (95858bd1)
• update dependencies (d8bcb322)

Code Style Changes

• test: fix formating of test code (962969fa)

Tests

• update tests and remove settings from GeoFirestore (4b1bd275)

4.3.0 (2020-08-01)

Build System / Dependencies

• include comments in dist/**/*.d.ts files (ef4e6366)

New Features

• GeoFirestore:
  • add method for settings (cace72c9)
  • add method for doc (3992c978)
  • add method for collectionGroup, fixes #187 (7d34d877)

4.2.1 (2020-07-19)

Bug Fixes

• README: fix CI badge in README (3767b8a7)

4.2.0 (2020-07-19)

Build System / Dependencies

• run GitHub action for pushes, pull requests, and releases (0c1a8045)
• deps: bump lodash from 4.17.15 to 4.17.19 (#186) (cdcc4801)

New Features

• GeoWriteBatch: allow custom key to be defined at write batch level (d1d61436)
• GeoTransaction: allow custom key to be defined at transaction level (924accad)
• GeoCollectionReference: allow custom key to be defined at collection level (284c90c6)

4.1.3 (2020-07-05)

Build System / Dependencies

• update ci so only one workflow runs on a tag (949e4719)

Documentation Changes

• README: clarify security rules (2fd87cb6)

4.1.2 (2020-07-02)

Chores

• remove @types/node from devDependencies (f8b2cd36)

4.1.1 (2020-07-02)

Chores

• update geofirestore-core to v4.1.0 (c35ee4da)
• update tests (2d834fb5)

Documentation Changes

• README: add details about security rules (90503ef3)

4.1.0 (2020-06-22)

Documentation Changes

• update README to use initializeApp (833975ba)

New Features

• initializeApp: add function to create new GeoFirestore instance (bb319907)

Bug Fixes

• lint: add ; to utils.test.ts for linting (8fb13947)

Refactors

• use geofirestore-core (4fa86038)

4.0.1 (2020-06-16)

Build System / Dependencies

• update firestore rules version (52f39722)

Chores

• update rules for viewers collection (609202cb)

4.0.0 (2020-06-16)

Chores

• add upgrade directions and warning (4cafcbb7)

Documentation Changes

• README:
  • add warning for v4.0.0 (83af3c3d)
  • update Data Structure section (a3546a29)

Refactors

• simplify logic (3e0cc7b2)
• use g instead of .g for geofirestore data (9444cae0)
• flatten document structure so user data is top level (e2ad5e5c)

Tests

• update tests for new data structure (5a2e6693)

3.6.0 (2020-06-08)

Bug Fixes

• GeoQuery: fix near when radius is set to 0, fixes #178 (65db67fa)

Tests

• add tests (2b5fb326)

3.5.2 (2020-06-08)

Build System / Dependencies

• --ignore-scripts on npm install (a78dc597)
• use npm-cache (f14ab269)

Documentation Changes

• README: add links for badges (bde3c166)

3.5.1 (2020-06-08)

New Features

• add issue template (37c04989)

Bug Fixes

• docs: set typedoc to 0.15.0 (8ce71a0f)

3.5.0 (2020-06-08)

Build System / Dependencies

• lint /test folder (f00ff208)
• move to GitHub Actions for CI (1bc2014c)
• deps: bump websocket-extensions from 0.1.3 to 0.1.4 (#177) (91f00715)

Chores

• viewers: update viewers example (95107175)
• update dependencies and build (0d892c96)
• re-add Firebase to license (1aab19cd)

Documentation Changes

• README: update badges and compound queries documentation (a90c653e)

Bug Fixes

• set deploy on tag push and fix firebase-tools install (ac410034)
• mocha:
  • exit tests (886cd283)
  • remove module from tsconfig.json (84786da8)
• rollup: add module override (a45529eb)

3.4.3 (2020-05-04)

Documentation Changes

• update ci url (170fe26d)

3.4.2 (2020-05-04)

Build System / Dependencies

• deps:
  • bump jquery from 3.4.1 to 3.5.0 (#172) (326ddaa1)
  • bump acorn from 6.4.0 to 6.4.1 (419e62ef)

Chores

• update GitHub repository (b8a315c8)
• update dependencies (02f42a5e)

Tests

• update linter (b1ea40cd)

3.4.1 (2020-01-21)

Bug Fixes

• typescript: rollback to typescript 3.6.x, fixes #156 (21b40d62)

3.4.0 (2020-01-16)

Build System / Dependencies

• deps:
  • bump mixin-deep from 1.3.1 to 1.3.2 (1ba81a18)
  • bump mixin-deep from 1.3.1 to 1.3.2 (676f0794)

Chores

• loosen and update dependencies, use google typescript style guide (9d848d75)
• add project.json for firebaseopensource.com (e0500546)
• update dependencies (e29f80d7)

Documentation Changes

• fix typo (6548096e)
• fix typo in README (bd8a9389)
• README: add example to add a GeoDocument, fixes #134 (e7c5d136)

New Features

• expose native classes (29ef5c4a)

Bug Fixes

• set postinstall to pretest for npm installs (1fa16169)

Tests

• fix typing issues in tests (d2131b5e)

3.3.1 (2019-05-16)

Build System / Dependencies

• copy modified protobufjs module into @firebase/firestore's node modules (6b05ccfc)

Chores

• extend support for firebase 6.x.x (d0080f1a)

Documentation Changes

• README: update CDN and import sample (256df9b7)

Bug Fixes

• GeoQuery: check if typeof _radius is "undefined" incase it is set to 0, fixes #102 (62682118)

3.3.0 (2019-04-23)

Chores

• tighten firestore rules (941a8dd8)

New Features

• findCoordinates: findCoordinatesKey now findCoordinates as it returns GeoPoint rather than the key of the GeoPoint, can also find embedded keys, fixes #88 (94161a4e)

Bug Fixes

• very small typo in README (69c9ae19)
• very small typo in README (f2266663)

Refactors

• examples: update viewers firebase version and separate add/update functions (f90c4cab)

3.2.3 (2019-03-26)

Bug Fixes

• sanitize customKey in set methods (cee17d76)

Refactors

• test: lint test code (1ed836a3)

3.2.2 (2019-02-17)

Bug Fixes

• react-native-firebase: check if docChanges is an array (fc1622e4)

3.2.1 (2019-02-11)

Chores

• package.json: update homepage (52df32b2)

Bug Fixes

• travis: fix after_deploy script (eaef13ef)

3.2.0 (2019-02-10)

Build System / Dependencies

• rollup: change copy plugin for GeoFirestoreTypes.ts (2a585845)

Chores

• update dependencies (ca387c00)

Documentation Changes

• add details to README.md and a code example for runTransaction (167e0728)

New Features

• GeoTransaction:
  • add remaining transaction functions (6b1bbb8b)
  • add delete function (e48a7427)
  • stub GeoTransaction class (0b68729e)

Bug Fixes

• GeoFirestoreTypes: ignore no-shadowed-variable tslint rule, fixes #83 (5e8684e5)

Refactors

• GeoDocumentReference: reorder functions (cc8cf1bf)
• GeoQuery: where() -> startAt() (51be1b20)

Tests

• GeoTransaction:
  • adjust timing of promise resolution, fixes #72 (4d668500)
  • bring coverage to 100% (b9a63743)
• GeoFirestore: add tests for runTransaction (23f59ce8)

3.1.0 (2019-01-19)

Documentation Changes

• README:
  • added limitations, fixes #75 (aa5e320f)
  • Added limitations (659e2310)

New Features

• GeoQuery: expose limit function, fixes #68 #26 #8 (5fb5de08)

Bug Fixes

• GeoJoinerOnSnapshot:
  • remove unchanged docs from (133e3d60)
  • return properly computed oldIndex and newIndex (ad9c657b)

Tests

• GeoQuery: add tests for new limit method (d524789c)

3.0.2 (2019-01-15)

Chores

• update dev dependencies (92a4c7b6)

Bug Fixes

• GeoJoinerOnSnapshot: emit snapshot on empty queries and update docs array when doc removed, fixes #73 (85f2e260)

3.0.1 (2019-01-03)

Chores

• update dev dependencies (b2ae17f4)

Documentation Changes

• README: fix typo and add dependency badge, fixes #69 (55fd7bd3)

3.0.0 (2019-01-02)

Chores

• README:
  • add some badges (d1f2c220)
  • update badges (bb2aa25f)
• examples: update viewers example (aed1a369)
• update dependencies and typings (36cd49d3)
• generate and deploy docs site (5273128f)

Documentation Changes

• update README.md to reference https://geofirestore.com, as well as other tweaks (d07efafc)
• fix up docs and max all lines to 140 characters (06af76c7)

New Features

• GeoJoinerGet: move join logic of get functions to own class with logic to filter out items not in radius of query (5716654a)
• GeoJoinerOnSnapshot: add ability to join GeoQuerySnapshot events from onSnapshot (ba829244)
• GeoDocumentSnapshot: add GeoDocumentSnapshot for for doc references and queries (1abb499b)
• GeoDocumentReference: add GeoDocumentReference for returns of doc and add (9a5af9a5)
• GeoQuery: implement remaining Firestore Query functions (3cd3e0e3)
• GeoWriteBatch: add batch functionality to geofirestore (f01de430)
• GeoQuerySnapshot: filter out locations not in query (b0ce13cb)
• GeoFirestore: start rewrite to better align library to firestore sdk (bf1d4273)

Bug Fixes

• GeoFirestoreTypes: DocumentChange doc should return QueryDocumentSnapshot (3b2e5d6c)
• GeoDocumentReference: fix update function to use encodeUpdateDocument util function (97baf212)
• GeoWriteBatch: fix update function to use fieldNames (e27e668a)

Refactors

• small change to onSnapshot and how geoqueries are generated (7beffe69)
• simply GeoFirestoreTypes and remove incompatible GeoQuery functions (0edef6de)
• GeoQuery: remove unneeded function (76fa5af1)
• GeoFirestoreTypes: rename and put together all interfaces into GeoFirestoreTypes (9141fb37)

Tests

• GeoJoinerOnSnapshot: increase code coverage (27803b3a)
• utils: add code coverage for utils (7872c290)
• GeoDocumentSnapshot: bring coverage to 100% (5caa5b10)
• GeoDocumentReference: increase code coverage (e9811ad1)
• GeoQuerySnapshot: bring coverage to 100% (51122f9d)
• GeoQuery:
  • bring coverage to 100% (6252222b)
  • add basic tests for GeoQuery (56cc5c44)
• GeoCollectionReference: bring coverage to 100% (47a17f6e)
• GeoWriteBatch: create basic tests for GeoWriteBatch (687c3061)
• GeoFirestore: add basic tests for new GeoFirestore (74f97d75)

2.4.0 (2018-12-31)

New Features

• GeoFirestoreQuery: add error listener for on function, fixes #60 (b01d6906)

Refactors

• GeoFirestoreQuery: use where instead of startAt and endAt, fixes #63 (f475fa01)

2.3.0 (2018-12-17)

Documentation Changes

• GeoFirestore: add docs for update function of GeoFirestore (869e1893)

New Features

• GeoFirestore:
  • add ability to update documents, fixes #52 (555c9bc4)
  • add ability to update documents (2f0b127e)
  • add ability to update documents (d0a327df)

Refactors

• utils: remove unused import, restore findCoordinatesKey (324aa960)
• GeoFirestore: remove merge from batch.set (7ed3586b)

Code Style Changes

• private method _ & alphabetical order (716eda9e)
• geoFirestore: TS Lint (d4ed971b)

Tests

• GeoFirestore:
  • Corrected some EBKAC (c9bf4f35)
  • removed exit(); (a739d254)
  • add tests for update,validateDoc..HasCoordinates` (77915930)

2.2.3 (2018-11-15)

Chores

• README: update badges (dfc9f1ba)
• update firebase settings and dependencies (2b95d766)
• update README.md (d55b979a)
• rename COMMITS.md to CONTRIBUTING.md (f37e95ee)
• LICENSE: update license (7dc3064e)
• COC: add a Code of Conduct (e018ddba)

Bug Fixes

• lint: resolve linting issues in some firebase projects, fixes #48 (a9fe161a)

2.2.2 (2018-10-10)

Documentation Changes

• update docs around query functions (073991f4)

2.2.1 (2018-09-25)

Chores

• update dependencies (504d7e09)

Refactors

• GeoFirestoreQuery: move around event firing and fix typing (ff5fa228)

2.2.0 (2018-09-17)

New Features

• GeoFirestore: add ability to use with persistence options, fixes #31 (9e2a2e40)

2.1.2 (2018-08-24)

Chores

• node: add node typings (344602f0)

Bug Fixes

• firebase-admin: fix docChanges prop/method issue while adding more extensive typing (8c1d77f5)

2.1.1 (2018-08-08)

Build System / Dependencies

• add lint to travis (8318f861)

Bug Fixes

• resolve cloud typings, fixes #22 (4496b16c)

2.1.0 (2018-08-07)

Chores

• update dependencies (346cd080)
• fix coveralls badge in README (a1843f9e)

Documentation Changes

• GeoFirestoreQuery: add docs for query function of GeoFirestoreQuery's GeoFirestoreObj, fixes #8 (79976caf)
• add example application as well as site deployment (1192262a)

New Features

• add support for firebase-admin sdk, fixes #9 (8a763041)
• query: add ability to write custom query function for GeoFirestoreQuery (05bccde5)

Bug Fixes

• test: fix a remove test for GeoFirestore (521adabe)
• validateCriteria: check QueryCriteria's query to ensure it is of a valid type (4c299c80)

Performance Improvements

• examples: throttle queries to Firestore (be8ab9a5)

Tests

• GeoFirestoreQuery:
  • add tests for _queryToString and _stringToQuery (44677f0c)
  • use consts for query comparisons (72531203)
  • add coverage for query function of QueryCriteria (01cc594c)
• expand coverage for util functions (12b10e59)
• GeoFirestore:
  • write better remove function tests (e6b77890)
  • add coverage for remove function (da11c3b3)

2.0.2 (2018-07-23)

Build System / Dependencies

• add coveralls to testing process (e670b279)

Documentation Changes

• README: stop referencing location where document should be used (72cc61af)

Refactors

• remove external dependency of firebase (df31a871)

2.0.1 (2018-07-23)

Build System / Dependencies

• set browser build to iife (7b0df7f0)

Documentation Changes

• Fix minor typos in README.md (1ed6d659)

Refactors

• modify how firestore is imported (8525def6)

2.0.0 (2018-07-18)

Build System / Dependencies

• change build to use rollup (dddb80a2)
• configure npm deploy for master AND tag (7fd7c539)

Chores

• release: minor version release (81a9d979)
• lock to firebase 5.x.x (8779a2c7)
• bump firebase to v5.x.x (1442de38)

Documentation Changes

• update docs (f040e981)

New Features

• query:
  • add 'on_modified' event, this fixes #7 (8a69d9e8)
  • return document instead of just coordinates (94fdc711)
• add: add ability to add/insert documents without set (1663b0e1)
• set: update set function to use GeoPoints (5cf04fbd)
• remove: update remove function to no longer depend on set function (51814436)
• get: update get function to reflect new GeoFirestoreObj type (ec4ac975)

Bug Fixes

• tweak some validations (7303a350)

Refactors

• GeoFirestoreQuery: use Maps instead of Objects as well as general clean up (2263bccd)

Tests

• update tests for new structure (37600fb6)

1.2.0 (2018-05-29)

Chores

• lock to firebase 5.x.x (295e9f7b)
• update dependencies (b45d9e8e)

1.1.1 (2018-05-24)

Bug Fixes

• scripts: remove postinstall script (d2712d36)

1.1.0 (2018-05-24)

Build System / Dependencies

• include dist in npm deploy (0fe8aca3)

Chores

• add scripts to generate changelogs and update version (3b90de44)
• add commit guidline and update readme to include contributing section (6c519ad5)
• repurpose as a geofirestore npm package (f887310c)

New Features

• firestore: early implementation of geofirestore (51e76bda)

Bug Fixes

• firestore:
  • set data from snapshot to variable to pass into decode (e750c65f)
  • fix single location removal by set function (ffb377aa)

Refactors

• renamed folders and small tweaks (261445e6)
• change vars to consts and use in instead of hasOwnProperty (4a0d3127)

Tests

• firestore:
  • modify "'key_exited' registrations can be cancelled" timing (b5da5ee4)
  • implement test against realtime db to firestore (b73d800e)
• increase mocha timeout (aa7b084e)
• reintroduce coveralls support with tweaks (361fc5b4)
• fix tests for geofire callbacks and implement for geofirestore (8c007d81)
• geofirestore: check location against array instead of object (dd93bcde)