prostgles-client 4.0.178 → 4.0.179
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/dist/prostgles.d.ts +16 -6
- package/dist/prostgles.d.ts.map +1 -1
- package/dist/prostgles.js +6 -5
- package/package.json +2 -2
package/dist/prostgles.d.ts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import type { AnyObject, ClientSchema, ClientSyncHandles, DBSchema, DBSchemaTable, DbJoinMaker, EqualityFilter, FullFilter,
|
|
1
|
+
import type { AnyObject, ClientSchema, ClientSyncHandles, DBSchema, DBSchemaTable, DbJoinMaker, EqualityFilter, FullFilter, SelectReturnType, MethodHandler, SQLHandler, SQLResult, SelectParams, SubscribeParams, TableHandler, ViewHandler } from "prostgles-types";
|
|
2
2
|
import { asName } from "prostgles-types";
|
|
3
3
|
import { type AuthHandler } from "./Auth";
|
|
4
4
|
import type { Sync, SyncDataItem, SyncOne, SyncOneOptions, SyncOptions, SyncedTable } from "./SyncedTable/SyncedTable";
|
|
@@ -40,7 +40,7 @@ export type ViewHandlerClient<T extends AnyObject = AnyObject, S extends DBSchem
|
|
|
40
40
|
* Retrieves a list of matching records from the view/table and subscribes to changes
|
|
41
41
|
*/
|
|
42
42
|
useSubscribe: <SubParams extends SubscribeParams<T, S>>(filter?: FullFilter<T, S>, options?: SubParams) => {
|
|
43
|
-
data:
|
|
43
|
+
data: SelectReturnType<S, SubParams, T, true> | undefined;
|
|
44
44
|
error?: any;
|
|
45
45
|
isLoading: boolean;
|
|
46
46
|
};
|
|
@@ -48,7 +48,7 @@ export type ViewHandlerClient<T extends AnyObject = AnyObject, S extends DBSchem
|
|
|
48
48
|
* Retrieves a matching record from the view/table and subscribes to changes
|
|
49
49
|
*/
|
|
50
50
|
useSubscribeOne: <SubParams extends SubscribeParams<T, S>>(filter?: FullFilter<T, S>, options?: SubParams) => {
|
|
51
|
-
data:
|
|
51
|
+
data: SelectReturnType<S, SubParams, T, false> | undefined;
|
|
52
52
|
error?: any;
|
|
53
53
|
isLoading: boolean;
|
|
54
54
|
};
|
|
@@ -56,7 +56,7 @@ export type ViewHandlerClient<T extends AnyObject = AnyObject, S extends DBSchem
|
|
|
56
56
|
* Retrieves a list of matching records from the view/table
|
|
57
57
|
*/
|
|
58
58
|
useFind: <P extends SelectParams<T, S>>(filter?: FullFilter<T, S>, selectParams?: P) => {
|
|
59
|
-
data: undefined |
|
|
59
|
+
data: undefined | SelectReturnType<S, P, T, true>;
|
|
60
60
|
isLoading: boolean;
|
|
61
61
|
error?: any;
|
|
62
62
|
};
|
|
@@ -64,7 +64,7 @@ export type ViewHandlerClient<T extends AnyObject = AnyObject, S extends DBSchem
|
|
|
64
64
|
* Retrieves first matching record from the view/table
|
|
65
65
|
*/
|
|
66
66
|
useFindOne: <P extends SelectParams<T, S>>(filter?: FullFilter<T, S>, selectParams?: P) => {
|
|
67
|
-
data: undefined |
|
|
67
|
+
data: undefined | SelectReturnType<S, P, T, false>;
|
|
68
68
|
isLoading: boolean;
|
|
69
69
|
error?: any;
|
|
70
70
|
};
|
|
@@ -155,8 +155,18 @@ export type InitOptions<DBSchema = void> = {
|
|
|
155
155
|
* true by default
|
|
156
156
|
*/
|
|
157
157
|
onSchemaChange?: false | (() => void);
|
|
158
|
-
onReady: (
|
|
158
|
+
onReady: (
|
|
159
159
|
/**
|
|
160
|
+
* The database handler object.
|
|
161
|
+
* Only allowed tables and table methods are defined
|
|
162
|
+
*/
|
|
163
|
+
dbo: DBHandlerClient<DBSchema>, methods: MethodHandler | undefined,
|
|
164
|
+
/**
|
|
165
|
+
* Table schema together with column permission details the client has access to
|
|
166
|
+
*/
|
|
167
|
+
tableSchema: DBSchemaTable[] | undefined, auth: AuthHandler, isReconnect: boolean) => any;
|
|
168
|
+
/**
|
|
169
|
+
* Custom handler in case of websocket re-connection.
|
|
160
170
|
* If not provided will fire onReady
|
|
161
171
|
*/
|
|
162
172
|
onReconnect?: (socket: any, error?: any) => any;
|
package/dist/prostgles.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"prostgles.d.ts","sourceRoot":"","sources":["../lib/prostgles.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"prostgles.d.ts","sourceRoot":"","sources":["../lib/prostgles.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EACV,SAAS,EACT,YAAY,EACZ,iBAAiB,EACjB,QAAQ,EACR,aAAa,EACb,WAAW,EACX,cAAc,EACd,UAAU,EACV,gBAAgB,EAChB,aAAa,EACb,UAAU,EACV,SAAS,EACT,YAAY,EACZ,eAAe,EACf,YAAY,EACZ,WAAW,EACZ,MAAM,iBAAiB,CAAC;AAEzB,OAAO,EAAY,MAAM,EAAmB,MAAM,iBAAiB,CAAC;AAEpE,OAAO,EAAE,KAAK,WAAW,EAAa,MAAM,QAAQ,CAAC;AAMrD,OAAO,KAAK,EACV,IAAI,EACJ,YAAY,EACZ,OAAO,EACP,cAAc,EACd,WAAW,EACX,WAAW,EACZ,MAAM,2BAA2B,CAAC;AAInC,eAAO,MAAM,MAAM,SAAgC,CAAC;AACpD,eAAO,MAAM,KAAK,EAAE,GAInB,CAAC;AAEF,cAAc,eAAe,CAAC;AAC9B,cAAc,sBAAsB,CAAC;AACrC,OAAO,EAAE,aAAa,EAAE,SAAS,EAAE,MAAM,EAAE,CAAC;AAE5C,MAAM,MAAM,iBAAiB,CAC3B,CAAC,SAAS,SAAS,GAAG,SAAS,EAC/B,CAAC,SAAS,QAAQ,GAAG,IAAI,GAAG,IAAI,IAC9B,WAAW,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG;IACtB,eAAe,EAAE,MAAM,MAAM,EAAE,CAAC;IAChC,SAAS,CAAC,EAAE,GAAG,CAAC;IAChB,OAAO,CAAC,EAAE,GAAG,CAAC;IACd,IAAI,CAAC,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC;IAEf;;;;;OAKG;IACH,OAAO,CAAC,EAAE,CACR,WAAW,EAAE,cAAc,CAAC,CAAC,CAAC,EAC9B,WAAW,EAAE,WAAW,KACrB;QACH,IAAI,EAAE,SAAS,GAAG,YAAY,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;QAC9C,SAAS,EAAE,OAAO,CAAC;QACnB,KAAK,CAAC,EAAE,GAAG,CAAC;KACb,CAAC;IACF,OAAO,CAAC,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC;IAErB;;;;;OAKG;IACH,UAAU,CAAC,EAAE,CACX,WAAW,EAAE,cAAc,CAAC,CAAC,CAAC,EAC9B,WAAW,EAAE,cAAc,KACxB;QACH,IAAI,EAAE,SAAS,GAAG,YAAY,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC;QAC5C,SAAS,EAAE,OAAO,CAAC;QACnB,KAAK,CAAC,EAAE,GAAG,CAAC;KACb,CAAC;IACF,KAAK,CAAC,EAAE,GAAG,CAAC;IAEZ;;OAEG;IACH,YAAY,EAAE,CAAC,SAAS,SAAS,eAAe,CAAC,CAAC,EAAE,CAAC,CAAC,EACpD,MAAM,CAAC,EAAE,UAAU,CAAC,CAAC,EAAE,CAAC,CAAC,EACzB,OAAO,CAAC,EAAE,SAAS,KAChB;QACH,IAAI,EAAE,gBAAgB,CAAC,CAAC,EAAE,SAAS,EAAE,CAAC,EAAE,IAAI,CAAC,GAAG,SAAS,CAAC;QAC1D,KAAK,CAAC,EAAE,GAAG,CAAC;QACZ,SAAS,EAAE,OAAO,CAAC;KACpB,CAAC;IAEF;;OAEG;IACH,eAAe,EAAE,CAAC,SAAS,SAAS,eAAe,CAAC,CAAC,EAAE,CAAC,CAAC,EACvD,MAAM,CAAC,EAAE,UAAU,CAAC,CAAC,EAAE,CAAC,CAAC,EACzB,OAAO,CAAC,EAAE,SAAS,KAChB;QACH,IAAI,EAAE,gBAAgB,CAAC,CAAC,EAAE,SAAS,EAAE,CAAC,EAAE,KAAK,CAAC,GAAG,SAAS,CAAC;QAC3D,KAAK,CAAC,EAAE,GAAG,CAAC;QACZ,SAAS,EAAE,OAAO,CAAC;KACpB,CAAC;IAEF;;OAEG;IACH,OAAO,EAAE,CAAC,CAAC,SAAS,YAAY,CAAC,CAAC,EAAE,CAAC,CAAC,EACpC,MAAM,CAAC,EAAE,UAAU,CAAC,CAAC,EAAE,CAAC,CAAC,EACzB,YAAY,CAAC,EAAE,CAAC,KACb;QAAE,IAAI,EAAE,SAAS,GAAG,gBAAgB,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,IAAI,CAAC,CAAC;QAAC,SAAS,EAAE,OAAO,CAAC;QAAC,KAAK,CAAC,EAAE,GAAG,CAAA;KAAE,CAAC;IAE5F;;OAEG;IACH,UAAU,EAAE,CAAC,CAAC,SAAS,YAAY,CAAC,CAAC,EAAE,CAAC,CAAC,EACvC,MAAM,CAAC,EAAE,UAAU,CAAC,CAAC,EAAE,CAAC,CAAC,EACzB,YAAY,CAAC,EAAE,CAAC,KACb;QAAE,IAAI,EAAE,SAAS,GAAG,gBAAgB,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,KAAK,CAAC,CAAC;QAAC,SAAS,EAAE,OAAO,CAAC;QAAC,KAAK,CAAC,EAAE,GAAG,CAAA;KAAE,CAAC;IAE7F;;OAEG;IACH,QAAQ,EAAE,CAAC,CAAC,SAAS,YAAY,CAAC,CAAC,EAAE,CAAC,CAAC,EACrC,MAAM,CAAC,EAAE,UAAU,CAAC,CAAC,EAAE,CAAC,CAAC,EACzB,YAAY,CAAC,EAAE,CAAC,KACb;QAAE,IAAI,EAAE,MAAM,GAAG,SAAS,CAAC;QAAC,SAAS,EAAE,OAAO,CAAC;QAAC,KAAK,CAAC,EAAE,GAAG,CAAA;KAAE,CAAC;IAEnE;;OAEG;IACH,OAAO,EAAE,CAAC,CAAC,SAAS,YAAY,CAAC,CAAC,EAAE,CAAC,CAAC,EACpC,MAAM,CAAC,EAAE,UAAU,CAAC,CAAC,EAAE,CAAC,CAAC,EACzB,YAAY,CAAC,EAAE,CAAC,KACb;QAAE,IAAI,EAAE,MAAM,GAAG,SAAS,CAAC;QAAC,SAAS,EAAE,OAAO,CAAC;QAAC,KAAK,CAAC,EAAE,GAAG,CAAA;KAAE,CAAC;CACpE,CAAC;AAEF,MAAM,MAAM,kBAAkB,CAC5B,CAAC,SAAS,SAAS,GAAG,SAAS,EAC/B,CAAC,SAAS,QAAQ,GAAG,IAAI,GAAG,IAAI,IAC9B,iBAAiB,CAAC,CAAC,EAAE,CAAC,CAAC,GACzB,YAAY,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG;IACnB,eAAe,EAAE,MAAM,MAAM,EAAE,CAAC;IAChC,SAAS,CAAC,EAAE,GAAG,CAAC;IAChB,OAAO,CAAC,EAAE,GAAG,CAAC;IACd,IAAI,CAAC,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC;IACf,OAAO,CAAC,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC;IACrB,KAAK,CAAC,EAAE,GAAG,CAAC;CACb,CAAC;AAEJ,MAAM,MAAM,eAAe,CAAC,MAAM,GAAG,IAAI,IAAI,CAAC,MAAM,SAAS,QAAQ,GACnE;KACG,QAAQ,IAAI,MAAM,MAAM,GAAG,MAAM,CAAC,QAAQ,CAAC,CAAC,SAAS,CAAC,SAAS,IAAI,GAClE,iBAAiB,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,SAAS,CAAC,EAAE,MAAM,CAAC,GACtD,kBAAkB,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,SAAS,CAAC,EAAE,MAAM,CAAC;CAC1D,GACD,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,kBAAkB,CAAC,CAAC,CAAC,GAAG;IAC/C,GAAG,CAAC,EAAE,UAAU,CAAC;CAClB,GAAG,WAAW,CAAC;AAEhB,KAAK,WAAW,GAAG;IACjB,GAAG,EAAE,eAAe,GAAG,GAAG,CAAC;IAC3B,OAAO,EAAE,aAAa,GAAG,SAAS,CAAC;IACnC,WAAW,EAAE,aAAa,EAAE,GAAG,SAAS,CAAC;IACzC,IAAI,EAAE,WAAW,CAAC;IAClB,WAAW,EAAE,OAAO,CAAC;CACtB,CAAC;AAEF,KAAK,cAAc,GAAG;IACpB,IAAI,EAAE,MAAM,CAAC;IACb,SAAS,EAAE,MAAM,CAAC;IAClB,WAAW,EAAE,MAAM,CAAC;IACpB,OAAO,EAAE,MAAM,iBAAiB,CAAC;IACjC,IAAI,EAAE,SAAS,CAAC;CACjB,CAAC;AACF,KAAK,UAAU,GACX;IACE,IAAI,EAAE,OAAO,CAAC;IACd,OAAO,EAAE,aAAa,CAAC;IACvB,SAAS,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB,GACD;IACE,IAAI,EAAE,OAAO,CAAC;IACd,OAAO,EAAE,MAAM,kBAAkB,CAAC;IAClC,SAAS,EAAE,MAAM,CAAC;IAClB,IAAI,EAAE,SAAS,CAAC;CACjB,GACD;IACE,IAAI,EAAE,QAAQ,CAAC;IACf,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,EAAE,SAAS,CAAC;CACjB,GACD,cAAc,GACd;IACE,IAAI,EAAE,eAAe,CAAC;IACtB,IAAI,EAAE,YAAY,CAAC;IACnB,KAAK,EAAE,WAAW,GAAG,cAAc,GAAG,aAAa,GAAG,SAAS,CAAC;CACjE,GACD;IACE,IAAI,EAAE,SAAS,CAAC;IAChB,IAAI,EAAE,WAAW,CAAC;CACnB,GACD;IACE,IAAI,EAAE,oBAAoB,CAAC;IAC3B,IAAI,EAAE,WAAW,CAAC;CACnB,GACD;IACE,IAAI,EAAE,cAAc,CAAC;IACrB,IAAI,EAAE,WAAW,CAAC;IAClB,KAAK,EAAE,WAAW,GAAG,cAAc,GAAG,aAAa,GAAG,SAAS,CAAC;CACjE,CAAC;AAEN,MAAM,MAAM,WAAW,CAAC,QAAQ,GAAG,IAAI,IAAI;IACzC,MAAM,EAAE,GAAG,CAAC;IAEZ;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,IAAI,CAAC;IAEtB;;OAEG;IACH,cAAc,CAAC,EAAE,KAAK,GAAG,CAAC,MAAM,IAAI,CAAC,CAAC;IACtC,OAAO,EAAE;IACP;;;OAGG;IACH,GAAG,EAAE,eAAe,CAAC,QAAQ,CAAC,EAC9B,OAAO,EAAE,aAAa,GAAG,SAAS;IAElC;;OAEG;IACH,WAAW,EAAE,aAAa,EAAE,GAAG,SAAS,EACxC,IAAI,EAAE,WAAW,EACjB,WAAW,EAAE,OAAO,KACjB,GAAG,CAAC;IAET;;;OAGG;IACH,WAAW,CAAC,EAAE,CAAC,MAAM,EAAE,GAAG,EAAE,KAAK,CAAC,EAAE,GAAG,KAAK,GAAG,CAAC;IAChD,YAAY,CAAC,EAAE,MAAM,GAAG,CAAC;IAEzB,OAAO,CAAC,EAAE,CAAC,KAAK,EAAE,UAAU,KAAK,GAAG,CAAC;CACtC,CAAC;AAEF,MAAM,MAAM,WAAW,GAAG,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,GAAG,CAAC;AAElD,MAAM,MAAM,UAAU,GAAG;IACvB,SAAS,EAAE,MAAM,CAAC;IAClB,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,CAAC,EAAE,SAAS,CAAC;IACnB,MAAM,CAAC,EAAE,SAAS,CAAC;CACpB,CAAC;AAEF,MAAM,MAAM,eAAe,GAAG;IAAE,IAAI,EAAE,MAAM,EAAE,CAAC;IAAC,QAAQ,EAAE,OAAO,CAAA;CAAE,CAAC;AAEpE,MAAM,MAAM,QAAQ,GAAG;IACrB,SAAS,EAAE,MAAM,EAAE,CAAC;IACpB,YAAY,EAAE,MAAM,CAAC;IACrB,WAAW,EAAE,MAAM,CAAC;CACrB,CAAC;AAOF,wBAAgB,SAAS,CAAC,QAAQ,EAChC,QAAQ,EAAE,WAAW,CAAC,QAAQ,CAAC,EAC/B,WAAW,EAAE,OAAO,WAAW,GAAG,SAAS,oBA0I5C"}
|
package/dist/prostgles.js
CHANGED
|
@@ -39,7 +39,7 @@ exports.debug = debug;
|
|
|
39
39
|
__exportStar(require("./react-hooks"), exports);
|
|
40
40
|
__exportStar(require("./useProstglesClient"), exports);
|
|
41
41
|
function prostgles(initOpts, syncedTable) {
|
|
42
|
-
const { socket, onReady, onDisconnect, onReconnect, onSchemaChange = true, onReload, onDebug } = initOpts;
|
|
42
|
+
const { socket, onReady, onDisconnect, onReconnect, onSchemaChange = true, onReload, onDebug, } = initOpts;
|
|
43
43
|
let schemaAge;
|
|
44
44
|
(0, exports.debug)("prostgles", { initOpts });
|
|
45
45
|
if (onSchemaChange) {
|
|
@@ -57,7 +57,7 @@ function prostgles(initOpts, syncedTable) {
|
|
|
57
57
|
let state;
|
|
58
58
|
return new Promise((resolve, reject) => {
|
|
59
59
|
socket.removeAllListeners(prostgles_types_1.CHANNELS.CONNECTION);
|
|
60
|
-
socket.on(prostgles_types_1.CHANNELS.CONNECTION, error => {
|
|
60
|
+
socket.on(prostgles_types_1.CHANNELS.CONNECTION, (error) => {
|
|
61
61
|
reject(error);
|
|
62
62
|
return "ok";
|
|
63
63
|
});
|
|
@@ -83,8 +83,9 @@ function prostgles(initOpts, syncedTable) {
|
|
|
83
83
|
/** Only destroy existing syncs if schema changed */
|
|
84
84
|
const schemaDidNotChange = (schemaAge === null || schemaAge === void 0 ? void 0 : schemaAge.clientSchema) && (0, react_hooks_1.isEqual)(schemaAge.clientSchema, clientSchema);
|
|
85
85
|
if (!schemaDidNotChange) {
|
|
86
|
-
syncHandler
|
|
87
|
-
.
|
|
86
|
+
syncHandler
|
|
87
|
+
.destroySyncs()
|
|
88
|
+
.catch((error) => console.error("Error while destroying syncs", error));
|
|
88
89
|
}
|
|
89
90
|
if (err) {
|
|
90
91
|
console.error("Error on schema change:", err);
|
|
@@ -121,7 +122,7 @@ function prostgles(initOpts, syncedTable) {
|
|
|
121
122
|
}
|
|
122
123
|
subscriptionHandler.reAttachAll();
|
|
123
124
|
syncHandler.reAttachAll();
|
|
124
|
-
joinTables.flat().map(table => {
|
|
125
|
+
joinTables.flat().map((table) => {
|
|
125
126
|
var _a, _b, _c, _d;
|
|
126
127
|
(_a = dbo.innerJoin) !== null && _a !== void 0 ? _a : (dbo.innerJoin = {});
|
|
127
128
|
(_b = dbo.leftJoin) !== null && _b !== void 0 ? _b : (dbo.leftJoin = {});
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "prostgles-client",
|
|
3
|
-
"version": "4.0.
|
|
3
|
+
"version": "4.0.179",
|
|
4
4
|
"description": "Reactive client for Postgres",
|
|
5
5
|
"main": "dist/prostgles-full.js",
|
|
6
6
|
"types": "dist/prostgles-full.d.ts",
|
|
@@ -28,7 +28,7 @@
|
|
|
28
28
|
"pushpublish": "npm version patch --git-tag-version false && git push && npm publish"
|
|
29
29
|
},
|
|
30
30
|
"dependencies": {
|
|
31
|
-
"prostgles-types": "^4.0.
|
|
31
|
+
"prostgles-types": "^4.0.122"
|
|
32
32
|
},
|
|
33
33
|
"devDependencies": {
|
|
34
34
|
"@types/node": "^14.14.14",
|