@livequery/rest 2.0.104 → 2.0.105
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.
- package/README.md +8 -8
- package/dist/RestTransporter.d.ts +1 -1
- package/dist/RestTransporter.d.ts.map +1 -1
- package/dist/Socket.d.ts +1 -1
- package/dist/Socket.d.ts.map +1 -1
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# @livequery/rest
|
|
2
2
|
|
|
3
|
-
`@livequery/rest` is a REST + WebSocket transporter for `@livequery/
|
|
3
|
+
`@livequery/rest` is a REST + WebSocket transporter for `@livequery/client`.
|
|
4
4
|
|
|
5
5
|
This repository is the transport library package, not an application. Changes here should preserve reusable transport behavior unless a task explicitly targets a breaking change.
|
|
6
6
|
|
|
@@ -10,7 +10,7 @@ It adapts the `LivequeryTransporter` interface to:
|
|
|
10
10
|
- optional WebSocket subscriptions for realtime collection updates
|
|
11
11
|
- request/response hooks for auth, caching, logging, or mocking
|
|
12
12
|
|
|
13
|
-
This package does not implement local cache or collection state management. That stays in `@livequery/
|
|
13
|
+
This package does not implement local cache or collection state management. That stays in `@livequery/client`. This package is only the transport layer between a livequery client and your backend.
|
|
14
14
|
|
|
15
15
|
## AI Agent Guidance
|
|
16
16
|
|
|
@@ -19,7 +19,7 @@ Repository-specific agent guidance lives in `AGENTS.md` and `copilot-instruction
|
|
|
19
19
|
- `AGENTS.md` is the implementation-focused guide for coding agents modifying this package.
|
|
20
20
|
- `copilot-instructions.md` provides repo-level instructions for Copilot when generating or reviewing code in this workspace.
|
|
21
21
|
- Both documents assume this repo is a transport library package, so agent changes should avoid app-specific scaffolding and should preserve public API compatibility by default.
|
|
22
|
-
- Agents generating consumer code should build around a shared `RestTransporter` inside a shared `
|
|
22
|
+
- Agents generating consumer code should build around a shared `RestTransporter` inside a shared `LivequeryClient` instance.
|
|
23
23
|
|
|
24
24
|
## Installation
|
|
25
25
|
|
|
@@ -33,7 +33,7 @@ bun add @livequery/rest
|
|
|
33
33
|
|
|
34
34
|
## What It Implements
|
|
35
35
|
|
|
36
|
-
`RestTransporter` implements the `LivequeryTransporter` contract from `@livequery/
|
|
36
|
+
`RestTransporter` implements the `LivequeryTransporter` contract from `@livequery/client`:
|
|
37
37
|
|
|
38
38
|
- `query()` returns an `Observable<Partial<LivequeryQueryResult>>`
|
|
39
39
|
- `add()` sends `POST`
|
|
@@ -66,10 +66,10 @@ const transporter = new RestTransporter({
|
|
|
66
66
|
})
|
|
67
67
|
```
|
|
68
68
|
|
|
69
|
-
### With `@livequery/
|
|
69
|
+
### With `@livequery/client`
|
|
70
70
|
|
|
71
71
|
```ts
|
|
72
|
-
import {
|
|
72
|
+
import { LivequeryClient } from '@livequery/client'
|
|
73
73
|
import { RestTransporter } from '@livequery/rest'
|
|
74
74
|
|
|
75
75
|
const transporter = new RestTransporter({
|
|
@@ -77,7 +77,7 @@ const transporter = new RestTransporter({
|
|
|
77
77
|
ws: 'wss://api.example.com/ws'
|
|
78
78
|
})
|
|
79
79
|
|
|
80
|
-
const core = new
|
|
80
|
+
const core = new LivequeryClient({
|
|
81
81
|
storage,
|
|
82
82
|
transporters: {
|
|
83
83
|
rest: transporter
|
|
@@ -323,7 +323,7 @@ For document reads, `data` should contain `item`:
|
|
|
323
323
|
|
|
324
324
|
## Query Output Shape
|
|
325
325
|
|
|
326
|
-
`query()` converts server data into the shape expected by `@livequery/
|
|
326
|
+
`query()` converts server data into the shape expected by `@livequery/client`:
|
|
327
327
|
|
|
328
328
|
```ts
|
|
329
329
|
type LivequeryQueryResult = {
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import type { Doc, LivequeryTransporter, LivequeryResult, LivequeryQueryResult, LivequeryAction, LivequeryFilters } from '@livequery/
|
|
1
|
+
import type { Doc, LivequeryTransporter, LivequeryResult, LivequeryQueryResult, LivequeryAction, LivequeryFilters } from '@livequery/client';
|
|
2
2
|
export type RestTransporterRequest = {
|
|
3
3
|
url: string;
|
|
4
4
|
method: string;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"RestTransporter.d.ts","sourceRoot":"","sources":["../src/RestTransporter.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,GAAG,EAAE,oBAAoB,EAAE,eAAe,EAAE,oBAAoB,EAAE,eAAe,EAAE,gBAAgB,EAAE,MAAM,
|
|
1
|
+
{"version":3,"file":"RestTransporter.d.ts","sourceRoot":"","sources":["../src/RestTransporter.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,GAAG,EAAE,oBAAoB,EAAE,eAAe,EAAE,oBAAoB,EAAE,eAAe,EAAE,gBAAgB,EAAE,MAAM,mBAAmB,CAAA;AAI5I,MAAM,MAAM,sBAAsB,GAAG;IACjC,GAAG,EAAE,MAAM,CAAA;IACX,MAAM,EAAE,MAAM,CAAA;IACd,KAAK,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;IAC3B,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,MAAM,CAAA;IACnC,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,CAAC,CAAA;CAC/C,CAAA;AAED,MAAM,MAAM,WAAW,CAAC,CAAC,IAAI,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,CAAA;AAE3C,MAAM,MAAM,qBAAqB,GAAG;IAChC,GAAG,EAAE,MAAM,CAAA;IACX,EAAE,CAAC,EAAE,MAAM,CAAA;IACX,SAAS,CAAC,EAAE,CAAC,OAAO,EAAE,sBAAsB,GAAG;QAAE,GAAG,EAAE,MAAM,CAAA;KAAE,KAAK,WAAW,CAAC,OAAO,CAAC,sBAAsB,GAAG;QAAE,QAAQ,CAAC,EAAE,eAAe,CAAC,GAAG,CAAC,CAAA;KAAE,CAAC,CAAC,GAAG,IAAI,CAAA;IAC5J,UAAU,CAAC,EAAE,CAAC,OAAO,EAAE,sBAAsB,GAAG;QAAE,GAAG,EAAE,MAAM,CAAA;KAAE,EAAE,QAAQ,EAAE,eAAe,CAAC,GAAG,CAAC,KAAK,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI,CAAA;CAC3H,CAAA;AAID,MAAM,MAAM,2BAA2B,CAAC,CAAC,SAAS,GAAG,IAAI;IACrD,OAAO,CAAC,EAAE,GAAG,CAAC;IACd,KAAK,EAAE,CAAC,EAAE,CAAC;IACX,IAAI,EAAE,CAAC,CAAA;IACP,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,KAAK,EAAE;QACH,IAAI,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,MAAM,CAAA;KAC7D,CAAA;IACD,GAAG,EAAE;QAAE,IAAI,EAAE,OAAO,CAAC;QAAC,IAAI,EAAE,OAAO,CAAA;KAAE,CAAA;IACrC,MAAM,EAAE;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAA;KAAE,CAAA;CAC1C,CAAA;AAGD,qBAAa,eAAgB,YAAW,oBAAoB;;IAKpD,OAAO,CAAC,MAAM;IAHlB,OAAO,CAAC,MAAM,CAAoB;gBAGtB,MAAM,EAAE,qBAAqB;IA+DzC,KAAK,CAAC,CAAC,SAAS,GAAG,EAAE,EAAE,GAAG,EAAE,OAAO,EAAE,EAAE;QAAE,GAAG,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,gBAAgB,CAAC,CAAC,CAAC,CAAA;KAAE;IAyF9E,GAAG,CAAC,CAAC,SAAS,GAAG,EAAE,GAAG,EAAE,MAAM,EAAE,IAAI,EAAE,OAAO,CAAC,IAAI,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC;IAclE,MAAM,CAAC,CAAC,SAAS,GAAG,EAAE,cAAc,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC,CAAC;IAI1E,MAAM,CAAC,CAAC,SAAS,GAAG,EAAE,cAAc,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM;IAKxD,OAAO,CAAC,CAAC,EAAE,EAAE,GAAG,EAAE,MAAM,EAAE,OAAO,EAAE,EAAE,eAAe;CAGvD"}
|
package/dist/Socket.d.ts
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import { Observable, BehaviorSubject, ReplaySubject } from "rxjs";
|
|
2
|
-
import type { DataChangeEvent } from '@livequery/
|
|
2
|
+
import type { DataChangeEvent } from '@livequery/client';
|
|
3
3
|
export type LivequerySocketMetadata = {
|
|
4
4
|
client_id: string;
|
|
5
5
|
gateway_id?: string;
|
package/dist/Socket.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"Socket.d.ts","sourceRoot":"","sources":["../src/Socket.ts"],"names":[],"mappings":"AAAA,OAAO,EAAa,UAAU,EAAW,eAAe,EAAS,aAAa,EAAqC,MAAM,MAAM,CAAC;AAEhI,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,
|
|
1
|
+
{"version":3,"file":"Socket.d.ts","sourceRoot":"","sources":["../src/Socket.ts"],"names":[],"mappings":"AAAA,OAAO,EAAa,UAAU,EAAW,eAAe,EAAS,aAAa,EAAqC,MAAM,MAAM,CAAC;AAEhI,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAA;AAGxD,MAAM,MAAM,uBAAuB,GAAG;IAClC,SAAS,EAAE,MAAM,CAAA;IACjB,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,SAAS,EAAE,OAAO,CAAA;IAClB,OAAO,EAAE,MAAM,CAAA;CAClB,CAAA;AAED,qBAAa,MAAO,SAAQ,eAAe,CAAC,uBAAuB,CAAC;;IAWpD,OAAO,CAAC,QAAQ;IAT5B,SAAgB,SAAS,SAAW;IACpC,SAAgB,QAAQ,wBAA+B;IACvD,SAAgB,UAAU,2BAA6B;gBAOnC,QAAQ,EAAE,MAAM;IAsDpC,IAAI;IAIJ,OAAO,CAAC,KAAK;IAOb,OAAO,CAAC,MAAM;IAKd,aAAa,CAAC,cAAc,EAAE,MAAM;IAKpC,MAAM,CAAC,GAAG,EAAE,MAAM,GAAG,UAAU,CAAC,eAAe,CAAC;CAmBnD"}
|
package/package.json
CHANGED
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
"repository": {
|
|
4
4
|
"url": "https://github.com/livequery/rest"
|
|
5
5
|
},
|
|
6
|
-
"version": "2.0.
|
|
6
|
+
"version": "2.0.105",
|
|
7
7
|
"type": "module",
|
|
8
8
|
"description": "",
|
|
9
9
|
"main": "./dist/index.js",
|
|
@@ -38,7 +38,7 @@
|
|
|
38
38
|
"uuid": "^13.0.0"
|
|
39
39
|
},
|
|
40
40
|
"devDependencies": {
|
|
41
|
-
"@livequery/
|
|
41
|
+
"@livequery/client": "^2.0.105",
|
|
42
42
|
"typescript": "5.6.3"
|
|
43
43
|
},
|
|
44
44
|
"peerDependencies": {},
|