anchordb 1.3.0 → 1.3.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/CHANGELOG.md +29 -0
  2. package/README.md +20 -1
  3. package/package.json +3 -3
package/CHANGELOG.md CHANGED
@@ -5,6 +5,35 @@ All notable changes to the `anchordb` packages.
5
5
  This project follows [semantic versioning](https://semver.org/). While the version is `0.x`, minor
6
6
  releases may contain breaking changes.
7
7
 
8
+ ## 1.3.2
9
+
10
+ Documentation only — no code changes.
11
+
12
+ - **Bugs, support and feedback go to the AnchorDB project page**, at
13
+ [nisalanadeera.com/projects/anchordb](https://www.nisalanadeera.com/projects/anchordb#feedback): a form
14
+ that asks for the package, version and platform, and a reply by email.
15
+ - Every package's npm **Homepage** is that page, and **Report a bug** (`npm bugs`) opens the form.
16
+ - Every README links the overview and the form, and says what a bug report that can be acted on
17
+ includes.
18
+ - The package READMEs' family tables list all six packages, with `anchordb-lens-link`.
19
+ - All six packages move to 1.3.2 together.
20
+
21
+ ## 1.3.1
22
+
23
+ **Lens Link keeps both apps running in the background.** Found on a phone: switching from the app to
24
+ Anchor Lens let the phone stop the app within seconds, and the link went with it.
25
+
26
+ - `anchordb-lens-link`: while the link is on, the app runs an Android foreground service with an
27
+ ongoing notification — *Anchor Lens Link on*, then *Anchor Lens connected* — which is what Android
28
+ lets an app use to keep running. `keepAlive: false` turns it off; `link.keepAliveError` says why it
29
+ could not start.
30
+ - `startKeepAlive`, `updateKeepAlive` and `stopKeepAlive` keep a client running the same way. Anchor
31
+ Lens uses them while it is connected to an app, so you can switch between the two.
32
+ - `backgroundStatus()`, `askNotificationPermission()`, `askBatteryUnrestricted()`,
33
+ `openNotificationSettings()` and `openBackgroundSettings()`: the permissions and settings that stop a
34
+ phone overruling it, including Xiaomi's Autostart screen.
35
+ - Only `anchordb-lens-link` changes. The other packages stay at 1.3.0.
36
+
8
37
  ## 1.3.0
9
38
 
10
39
  **Anchor Lens Link: open a QA build's database in Anchor Lens on the same phone, from a file.** Asked
package/README.md CHANGED
@@ -3,6 +3,8 @@
3
3
  **MongoDB + Mongoose, for mobile apps.** A local, persistent document database with a
4
4
  Mongoose-shaped API that works completely offline — and *optionally* synchronises with a backend.
5
5
 
6
+ **[Overview](https://www.nisalanadeera.com/projects/anchordb)** · **[Report a bug or get support](https://www.nisalanadeera.com/projects/anchordb#feedback)**
7
+
6
8
  ```bash
7
9
  npm install anchordb
8
10
  ```
@@ -157,7 +159,7 @@ server-side change streams, text/`2dsphere`/hashed indexes, collation, and the
157
159
 
158
160
  ## The AnchorDB family
159
161
 
160
- Five packages. **Only `anchordb` is required** — the rest exist so that an offline-only app never
162
+ Six packages. **Only `anchordb` is required** — the rest exist so that an offline-only app never
161
163
  has to download Express, and an Express server never has to download React.
162
164
 
163
165
  | Package | What it is | Runs where |
@@ -167,11 +169,28 @@ has to download Express, and an Express server never has to download React.
167
169
  | [`anchordb-angular`](https://www.npmjs.com/package/anchordb-angular) | Angular / Ionic module, DI and RxJS observables | the device |
168
170
  | [`anchordb-sync-server`](https://www.npmjs.com/package/anchordb-sync-server) | Server half of sync — Express, NestJS, Next.js | your backend |
169
171
  | [`anchordb-relay`](https://www.npmjs.com/package/anchordb-relay) | Dev relay for the Anchor Lens inspector | your laptop |
172
+ | [`anchordb-lens-link`](https://www.npmjs.com/package/anchordb-lens-link) | Open a QA build's database in Anchor Lens on the same phone, from a file | the device, in QA builds |
170
173
 
171
174
  Each one needs a different third-party framework as a peer dependency, and npm resolves those per
172
175
  package rather than per import — which is why they are not one package. Full reasoning and API
173
176
  reference: [github.com/knnadeera/anchordb](https://github.com/knnadeera/anchordb).
174
177
 
178
+ ## Bugs, support and feedback
179
+
180
+ Report a bug, ask for help or suggest a feature on the [AnchorDB project page](https://www.nisalanadeera.com/projects/anchordb#feedback) —
181
+ choose `anchordb` as the package, and the reply comes by email.
182
+
183
+ A report that can be acted on straight away has:
184
+
185
+ - the package and exact version — what `npm ls anchordb` prints
186
+ - where it runs — Expo, Ionic, a browser or Node — and which storage adapter
187
+ - the smallest snippet that reproduces it
188
+ - the full error, including `code`, `keyPattern` and `keyValue` for an E11000
189
+ - what you expected to happen instead
190
+
191
+ **Sync problems:** say which conflict strategy you use, and whether the mutation shows as parked in
192
+ Anchor Lens — a push rejected by a unique index is parked rather than retried forever.
193
+
175
194
  ## License
176
195
 
177
196
  MIT
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "anchordb",
3
- "version": "1.3.0",
3
+ "version": "1.3.2",
4
4
  "description": "MongoDB + Mongoose for mobile apps. Offline-first local database with optional sync.",
5
5
  "keywords": [
6
6
  "mongodb",
@@ -156,9 +156,9 @@
156
156
  "url": "git+https://github.com/knnadeera/anchordb.git",
157
157
  "directory": "packages/core"
158
158
  },
159
- "homepage": "https://github.com/knnadeera/anchordb#readme",
159
+ "homepage": "https://www.nisalanadeera.com/projects/anchordb",
160
160
  "bugs": {
161
- "url": "https://github.com/knnadeera/anchordb/issues"
161
+ "url": "https://www.nisalanadeera.com/projects/anchordb#feedback"
162
162
  },
163
163
  "attw": {
164
164
  "ignoreRules": [