prostgles-client 4.0.385 → 4.0.387

package/README.md

@@ -41,6 +41,14 @@ CDN
 
 ## Quick Start
 
+### Node.js
+
+```ts
+import prostgles from "prostgles-client";
+
+const prostglesClient = await prostgles({ endpoint, token });
+```
+
 ### React hooks
 
 Subscribe to data changes with automatic re-renders:

package/dist/getAuthHandler.js

@@ -5,7 +5,7 @@ const prostgles_types_1 = require("prostgles-types");
 const prostgles_1 = require("./prostgles");
 const getAuthHandler = ({ authData: authConfig, socket, onReload, endpoint, ...authOpts }) => {
     const urlWithEndpointAndSearch = (route) => {
-        const { search } = window.location;
+        const search = typeof window !== "undefined" ? window.location.search : "";
         let url = route + search;
         if (endpoint)
             url = `${endpoint}${url}`;

package/dist/getProstglesSocket.d.ts

@@ -0,0 +1,10 @@
+import type { ManagerOptions, SocketOptions } from "socket.io-client";
+export type SocketPathOrOptions = string | Partial<ManagerOptions & SocketOptions>;
+export declare const getIO: (throwError?: boolean) => typeof import("socket.io-client").io;
+export declare const getProstglesSocket: ({ endpoint, token, socketOptions: socketPathOrOptions, credentials, }: {
+    endpoint?: string;
+    token?: string;
+    socketOptions?: SocketPathOrOptions;
+    credentials?: RequestCredentials;
+}) => import("socket.io-client").Socket<import("@socket.io/component-emitter").DefaultEventsMap, import("@socket.io/component-emitter").DefaultEventsMap>;
+//# sourceMappingURL=getProstglesSocket.d.ts.map

package/dist/getProstglesSocket.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"getProstglesSocket.d.ts","sourceRoot":"","sources":["../lib/getProstglesSocket.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AAItE,MAAM,MAAM,mBAAmB,GAAG,MAAM,GAAG,OAAO,CAAC,cAAc,GAAG,aAAa,CAAC,CAAC;AAEnF,eAAO,MAAM,KAAK,GAAI,oBAAkB,yCAQvC,CAAC;AAEF,eAAO,MAAM,kBAAkB,GAAI,uEAKhC;IACD,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,aAAa,CAAC,EAAE,mBAAmB,CAAC;IACpC,WAAW,CAAC,EAAE,kBAAkB,CAAC;CAClC,wJAiBA,CAAC"}

package/dist/getProstglesSocket.js

@@ -0,0 +1,31 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getProstglesSocket = exports.getIO = void 0;
+const getIO = (throwError = false) => {
+    try {
+        // eslint-disable-next-line @typescript-eslint/no-require-imports
+        const io = require("socket.io-client");
+        return io;
+    }
+    catch (err) { }
+    if (throwError)
+        throw new Error("Must install socket.io-client");
+    return {};
+};
+exports.getIO = getIO;
+const getProstglesSocket = ({ endpoint, token, socketOptions: socketPathOrOptions, credentials, }) => {
+    const io = (0, exports.getIO)(true);
+    const socketOptions = typeof socketPathOrOptions === "string" ? { path: socketPathOrOptions } : socketPathOrOptions;
+    const socketOptionsWithDefaults = {
+        withCredentials: credentials !== undefined && credentials !== "omit",
+        ...socketOptions,
+        reconnectionDelay: 1000,
+        reconnection: true,
+    };
+    socketOptionsWithDefaults.path ??= "/ws-api";
+    if (token) {
+        socketOptionsWithDefaults.auth = { token };
+    }
+    return endpoint ? io(endpoint, socketOptionsWithDefaults) : io(socketOptionsWithDefaults);
+};
+exports.getProstglesSocket = getProstglesSocket;

package/dist/hooks/useProstglesClient.d.ts

@@ -1,9 +1,8 @@
 import { type DBSchema, type UserLike } from "prostgles-types";
 import type { ClientFunctionHandler } from "../getMethods";
-import type { ManagerOptions, SocketOptions } from "socket.io-client";
 import { type InitOptions, type ClientOnReadyParams } from "../prostgles";
-export declare const getIO: (throwError?: boolean) => typeof import("socket.io-client").io;
-type SocketPathOrOptions = Partial<ManagerOptions & SocketOptions>;
+import { type SocketPathOrOptions } from "../getProstglesSocket";
+export { getIO } from "../getProstglesSocket";
 export type UseProstglesClientProps = Omit<InitOptions<DBSchema>, "onReady" | "socket"> & {
     /**
      * Websocket API token
@@ -26,5 +25,4 @@ export type ProstglesClientState<PGC> = {
     error: unknown;
 };
 export declare const useProstglesClient: <S = void, FuncSchema extends ClientFunctionHandler = ClientFunctionHandler, U extends UserLike = UserLike>({ skip, socketOptions: socketPathOrOptions, endpoint, token, ...initOpts }?: UseProstglesClientProps) => ProstglesClientState<ClientOnReadyParams<S, FuncSchema, U>>;
-export {};
 //# sourceMappingURL=useProstglesClient.d.ts.map

package/dist/hooks/useProstglesClient.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"useProstglesClient.d.ts","sourceRoot":"","sources":["../../lib/hooks/useProstglesClient.ts"],"names":[],"mappings":"AAAA,OAAO,EAAY,KAAK,QAAQ,EAAE,KAAK,QAAQ,EAAE,MAAM,iBAAiB,CAAC;AAEzE,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,eAAe,CAAC;AAC3D,OAAO,KAAK,EAAE,cAAc,EAAU,aAAa,EAAE,MAAM,kBAAkB,CAAC;AAC9E,OAAO,EAAa,KAAK,WAAW,EAAE,KAAK,mBAAmB,EAAE,MAAM,cAAc,CAAC;AAMrF,eAAO,MAAM,KAAK,GAAI,oBAAkB,yCAQvC,CAAC;AAEF,KAAK,mBAAmB,GAAG,OAAO,CAAC,cAAc,GAAG,aAAa,CAAC,CAAC;AAEnE,MAAM,MAAM,uBAAuB,GAAG,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,EAAE,SAAS,GAAG,QAAQ,CAAC,GAAG;IACxF;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,aAAa,CAAC,EAAE,mBAAmB,CAAC;IACpC,IAAI,CAAC,EAAE,OAAO,CAAC;CAChB,CAAC;AACF,MAAM,MAAM,oBAAoB,CAAC,GAAG,IAChC;IAAE,SAAS,EAAE,IAAI,CAAC;IAAC,QAAQ,EAAE,KAAK,CAAC;IAAC,KAAK,CAAC,EAAE,SAAS,CAAA;CAAE,GACvD,CAAC;IAAE,SAAS,EAAE,KAAK,CAAC;IAAC,QAAQ,EAAE,KAAK,CAAC;IAAC,KAAK,CAAC,EAAE,SAAS,CAAA;CAAE,GAAG,GAAG,CAAC,GAChE;IAAE,SAAS,EAAE,KAAK,CAAC;IAAC,QAAQ,EAAE,IAAI,CAAC;IAAC,KAAK,EAAE,OAAO,CAAA;CAAE,CAAC;AAEzD,eAAO,MAAM,kBAAkB,GAC7B,CAAC,GAAG,IAAI,EACR,UAAU,SAAS,qBAAqB,GAAG,qBAAqB,EAChE,CAAC,SAAS,QAAQ,GAAG,QAAQ,EAC7B,6EAMC,uBAA4B,KAAG,oBAAoB,CAAC,mBAAmB,CAAC,CAAC,EAAE,UAAU,EAAE,CAAC,CAAC,CAsE3F,CAAC"}
+{"version":3,"file":"useProstglesClient.d.ts","sourceRoot":"","sources":["../../lib/hooks/useProstglesClient.ts"],"names":[],"mappings":"AAAA,OAAO,EAAY,KAAK,QAAQ,EAAE,KAAK,QAAQ,EAAE,MAAM,iBAAiB,CAAC;AAEzE,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,eAAe,CAAC;AAE3D,OAAO,EAAa,KAAK,WAAW,EAAE,KAAK,mBAAmB,EAAE,MAAM,cAAc,CAAC;AACrF,OAAO,EAAsB,KAAK,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAKrF,OAAO,EAAE,KAAK,EAAE,MAAM,uBAAuB,CAAC;AAE9C,MAAM,MAAM,uBAAuB,GAAG,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,EAAE,SAAS,GAAG,QAAQ,CAAC,GAAG;IACxF;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,aAAa,CAAC,EAAE,mBAAmB,CAAC;IACpC,IAAI,CAAC,EAAE,OAAO,CAAC;CAChB,CAAC;AACF,MAAM,MAAM,oBAAoB,CAAC,GAAG,IAChC;IAAE,SAAS,EAAE,IAAI,CAAC;IAAC,QAAQ,EAAE,KAAK,CAAC;IAAC,KAAK,CAAC,EAAE,SAAS,CAAA;CAAE,GACvD,CAAC;IAAE,SAAS,EAAE,KAAK,CAAC;IAAC,QAAQ,EAAE,KAAK,CAAC;IAAC,KAAK,CAAC,EAAE,SAAS,CAAA;CAAE,GAAG,GAAG,CAAC,GAChE;IAAE,SAAS,EAAE,KAAK,CAAC;IAAC,QAAQ,EAAE,IAAI,CAAC;IAAC,KAAK,EAAE,OAAO,CAAA;CAAE,CAAC;AAEzD,eAAO,MAAM,kBAAkB,GAC7B,CAAC,GAAG,IAAI,EACR,UAAU,SAAS,qBAAqB,GAAG,qBAAqB,EAChE,CAAC,SAAS,QAAQ,GAAG,QAAQ,EAC7B,6EAMC,uBAA4B,KAAG,oBAAoB,CAAC,mBAAmB,CAAC,CAAC,EAAE,UAAU,EAAE,CAAC,CAAC,CA0D3F,CAAC"}

package/dist/hooks/useProstglesClient.js

@@ -3,21 +3,12 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.useProstglesClient = exports.getIO = void 0;
 const prostgles_types_1 = require("prostgles-types");
 const prostgles_1 = require("../prostgles");
+const getProstglesSocket_1 = require("../getProstglesSocket");
 const reactImports_1 = require("./reactImports");
 const useAsyncEffectQueue_1 = require("./useAsyncEffectQueue");
 const useIsMounted_1 = require("./useIsMounted");
-const getIO = (throwError = false) => {
-    try {
-        // eslint-disable-next-line @typescript-eslint/no-require-imports
-        const io = require("socket.io-client");
-        return io;
-    }
-    catch (err) { }
-    if (throwError)
-        throw new Error("Must install socket.io-client");
-    return {};
-};
-exports.getIO = getIO;
+var getProstglesSocket_2 = require("../getProstglesSocket");
+Object.defineProperty(exports, "getIO", { enumerable: true, get: function () { return getProstglesSocket_2.getIO; } });
 const useProstglesClient = ({ skip, socketOptions: socketPathOrOptions, endpoint, token, ...initOpts } = {}) => {
     const { useRef, useState } = (0, reactImports_1.getReact)(true);
     const [onReadyArgs, setOnReadyArgs] = useState({
@@ -30,21 +21,12 @@ const useProstglesClient = ({ skip, socketOptions: socketPathOrOptions, endpoint
         if (skip)
             return undefined;
         socketRef.current?.disconnect();
-        const io = (0, exports.getIO)();
-        const socketOptions = typeof socketPathOrOptions === "string" ?
-            { path: socketPathOrOptions }
-            : socketPathOrOptions;
-        const socketOptionsWithDefaults = {
-            withCredentials: initOpts.credentials && initOpts.credentials !== "omit",
-            ...socketOptions,
-            reconnectionDelay: 1000,
-            reconnection: true,
-        };
-        socketOptionsWithDefaults.path ??= `/ws-api`;
-        if (token) {
-            socketOptionsWithDefaults.auth = { token };
-        }
-        const socket = endpoint ? io(endpoint, socketOptionsWithDefaults) : io(socketOptionsWithDefaults);
+        const socket = (0, getProstglesSocket_1.getProstglesSocket)({
+            endpoint,
+            token,
+            socketOptions: socketPathOrOptions,
+            credentials: initOpts.credentials,
+        });
         socketRef.current = socket;
         await (0, prostgles_1.prostgles)({
             socket,
@@ -75,7 +57,7 @@ const useProstglesClient = ({ skip, socketOptions: socketPathOrOptions, endpoint
                 throw "Socket disconnected";
             };
         };
-    }, [initOpts, socketPathOrOptions, skip], 80);
+    }, [endpoint, initOpts, socketPathOrOptions, skip, token], 80);
     return onReadyArgs;
 };
 exports.useProstglesClient = useProstglesClient;

package/dist/index.d.ts

@@ -1,8 +1,9 @@
 import type { UserLike } from "prostgles-types";
-import { type InitOptions } from "./prostgles";
+import { prostgles as pgls, type InitOptions, type ProstglesInitOptions } from "./prostgles";
 import type { ClientFunctionHandler } from "./getMethods";
-declare function prostgles<DBSchema = void, FuncSchema extends ClientFunctionHandler = ClientFunctionHandler, U extends UserLike = UserLike>(params: InitOptions<DBSchema, FuncSchema, U>): Promise<unknown>;
-export { type DBHandlerClient, type ClientOnReadyParams as OnReadyParams, type ProstglesClientState, type TableHandlerClient, type InitOptions, asName, } from "./prostgles";
+declare function prostgles<DBSchema = void, FuncSchema extends ClientFunctionHandler = ClientFunctionHandler, U extends UserLike = UserLike>(params: ProstglesInitOptions<DBSchema, FuncSchema, U>): ReturnType<typeof pgls<DBSchema, FuncSchema, U>>;
+declare function prostgles<DBSchema = void, FuncSchema extends ClientFunctionHandler = ClientFunctionHandler, U extends UserLike = UserLike>(params: InitOptions<DBSchema, FuncSchema, U>): ReturnType<typeof pgls<DBSchema, FuncSchema, U>>;
+export { type DBHandlerClient, type ClientOnReadyParams as OnReadyParams, type ProstglesClientState, type TableHandlerClient, type InitOptions, type ProstglesInitOptions, asName, } from "./prostgles";
 export * from "./hooks/useSync";
 export * from "./hooks/useSubscribe";
 export * from "./hooks/useProstglesClient";

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../lib/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,iBAAiB,CAAC;AAChD,OAAO,EAAqB,KAAK,WAAW,EAAE,MAAM,aAAa,CAAC;AAClE,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,cAAc,CAAC;AAE1D,iBAAS,SAAS,CAChB,QAAQ,GAAG,IAAI,EACf,UAAU,SAAS,qBAAqB,GAAG,qBAAqB,EAChE,CAAC,SAAS,QAAQ,GAAG,QAAQ,EAC7B,MAAM,EAAE,WAAW,CAAC,QAAQ,EAAE,UAAU,EAAE,CAAC,CAAC,oBAE7C;AAED,OAAO,EACL,KAAK,eAAe,EACpB,KAAK,mBAAmB,IAAI,aAAa,EACzC,KAAK,oBAAoB,EACzB,KAAK,kBAAkB,EACvB,KAAK,WAAW,EAChB,MAAM,GACP,MAAM,aAAa,CAAC;AACrB,cAAc,iBAAiB,CAAC;AAChC,cAAc,sBAAsB,CAAC;AACrC,cAAc,4BAA4B,CAAC;AAC3C,cAAc,oBAAoB,CAAC;AACnC,cAAc,sBAAsB,CAAC;AACrC,cAAc,kBAAkB,CAAC;AACjC,cAAc,uBAAuB,CAAC;AACtC,cAAc,wBAAwB,CAAC;AACvC,cAAc,6BAA6B,CAAC;AAC5C,OAAO,EAAE,YAAY,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AACtE,YAAY,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAClD,YAAY,EAAE,qBAAqB,EAAE,cAAc,EAAE,MAAM,cAAc,CAAC;AAC1E,eAAe,SAAS,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../lib/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,iBAAiB,CAAC;AAChD,OAAO,EAAE,SAAS,IAAI,IAAI,EAAE,KAAK,WAAW,EAAE,KAAK,oBAAoB,EAAE,MAAM,aAAa,CAAC;AAC7F,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,cAAc,CAAC;AAE1D,iBAAS,SAAS,CAChB,QAAQ,GAAG,IAAI,EACf,UAAU,SAAS,qBAAqB,GAAG,qBAAqB,EAChE,CAAC,SAAS,QAAQ,GAAG,QAAQ,EAE7B,MAAM,EAAE,oBAAoB,CAAC,QAAQ,EAAE,UAAU,EAAE,CAAC,CAAC,GACpD,UAAU,CAAC,OAAO,IAAI,CAAC,QAAQ,EAAE,UAAU,EAAE,CAAC,CAAC,CAAC,CAAC;AACpD,iBAAS,SAAS,CAChB,QAAQ,GAAG,IAAI,EACf,UAAU,SAAS,qBAAqB,GAAG,qBAAqB,EAChE,CAAC,SAAS,QAAQ,GAAG,QAAQ,EAC7B,MAAM,EAAE,WAAW,CAAC,QAAQ,EAAE,UAAU,EAAE,CAAC,CAAC,GAAG,UAAU,CAAC,OAAO,IAAI,CAAC,QAAQ,EAAE,UAAU,EAAE,CAAC,CAAC,CAAC,CAAC;AAKlG,OAAO,EACL,KAAK,eAAe,EACpB,KAAK,mBAAmB,IAAI,aAAa,EACzC,KAAK,oBAAoB,EACzB,KAAK,kBAAkB,EACvB,KAAK,WAAW,EAChB,KAAK,oBAAoB,EACzB,MAAM,GACP,MAAM,aAAa,CAAC;AACrB,cAAc,iBAAiB,CAAC;AAChC,cAAc,sBAAsB,CAAC;AACrC,cAAc,4BAA4B,CAAC;AAC3C,cAAc,oBAAoB,CAAC;AACnC,cAAc,sBAAsB,CAAC;AACrC,cAAc,kBAAkB,CAAC;AACjC,cAAc,uBAAuB,CAAC;AACtC,cAAc,wBAAwB,CAAC;AACvC,cAAc,6BAA6B,CAAC;AAC5C,OAAO,EAAE,YAAY,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AACtE,YAAY,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAClD,YAAY,EAAE,qBAAqB,EAAE,cAAc,EAAE,MAAM,cAAc,CAAC;AAC1E,eAAe,SAAS,CAAC"}

package/dist/index.umd.d.ts

@@ -1,3 +1,3 @@
-import { type InitOptions } from "./prostgles";
-export declare function prostgles(params: InitOptions): Promise<unknown>;
+import { type InitOptions, type ProstglesInitOptions } from "./prostgles";
+export declare function prostgles(params: InitOptions | ProstglesInitOptions): Promise<import("./prostgles").ClientOnReadyParams<void, Partial<Record<string, import("./getMethods").FunctionHandle<any, unknown>>>, import("prostgles-types").UserLike>>;
 //# sourceMappingURL=index.umd.d.ts.map

package/dist/index.umd.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.umd.d.ts","sourceRoot":"","sources":["../lib/index.umd.ts"],"names":[],"mappings":"AAAA,OAAO,EAAqB,KAAK,WAAW,EAAE,MAAM,aAAa,CAAC;AAClE,wBAAgB,SAAS,CAAC,MAAM,EAAE,WAAW,oBAE5C"}
+{"version":3,"file":"index.umd.d.ts","sourceRoot":"","sources":["../lib/index.umd.ts"],"names":[],"mappings":"AAAA,OAAO,EAAqB,KAAK,WAAW,EAAE,KAAK,oBAAoB,EAAE,MAAM,aAAa,CAAC;AAE7F,wBAAgB,SAAS,CAAC,MAAM,EAAE,WAAW,GAAG,oBAAoB,8KAEnE"}