@fabriktor/client 0.0.29 → 0.0.32

package/dist/src/chat/chat.d.ts

@@ -2,15 +2,9 @@ import { type Chat, type ChatRoom, type ChatRoomMember, type ID, type InChat, ty
 import type { TokenProvider } from "../core/auth.js";
 import type { DeleteManyOptionsCRUD, DeleteOneOptionsCRUD, FindOneOptionsCRUD, InsertOneOptionsCRUD, OperationResultOf, QueryOptionsCRUD, ReplaceOneOptionsCRUD, SearchManyOptionsCRUD, SearchResultOf } from "../core/crud.js";
 import type { HTTPDoer } from "../core/http.js";
+import { type WSCloseHandler, type WSConnection, type WSErrorHandler, type WSMessageHandler } from "../core/ws.js";
 export type ReactChatOptions = PLChatReact;
 export type EnsureChatRoomOptions = PLChatEnsure;
-export type WSMessageHandler<T> = (v: T, ev: MessageEvent<string>) => void;
-export type WSErrorHandler = (ev: Event) => void;
-export type WSCloseHandler = (ev: CloseEvent) => void;
-export type WSConnection<T> = {
-    socket: WebSocket;
-    close(code?: number, reason?: string): void;
-};
 export type WSChatsOptions = {
     owner_id: string;
     chat_room_id: string;
@@ -57,9 +51,9 @@ export interface ChatOperator {
     searchManyChatRoomMembers(opts?: SearchManyOptionsCRUD): Promise<OperationResultOf<SearchResultOf<ChatRoomMember>>>;
     reactChat(opts: ReactChatOptions): Promise<void>;
     ensureChatRoom(opts: EnsureChatRoomOptions): Promise<ID>;
-    wsChats(opts: WSChatsOptions): Promise<WSConnection<Chat>>;
-    wsChatRooms(opts: WSChatRoomsOptions): Promise<WSConnection<ChatRoom>>;
-    wsChatRoom(opts: WSChatRoomOptions): Promise<WSConnection<ChatRoom>>;
+    wsChats(opts: WSChatsOptions): Promise<WSConnection>;
+    wsChatRooms(opts: WSChatRoomsOptions): Promise<WSConnection>;
+    wsChatRoom(opts: WSChatRoomOptions): Promise<WSConnection>;
 }
 export declare class ChatClient implements ChatOperator {
     private chats;
@@ -90,8 +84,8 @@ export declare class ChatClient implements ChatOperator {
     searchManyChatRoomMembers(opts?: SearchManyOptionsCRUD): Promise<OperationResultOf<SearchResultOf<ChatRoomMember>>>;
     reactChat(opts: ReactChatOptions): Promise<void>;
     ensureChatRoom(opts: EnsureChatRoomOptions): Promise<ID>;
-    wsChats(opts: WSChatsOptions): Promise<WSConnection<Chat>>;
-    wsChatRooms(opts: WSChatRoomsOptions): Promise<WSConnection<ChatRoom>>;
-    wsChatRoom(opts: WSChatRoomOptions): Promise<WSConnection<ChatRoom>>;
+    wsChats(opts: WSChatsOptions): Promise<WSConnection>;
+    wsChatRooms(opts: WSChatRoomsOptions): Promise<WSConnection>;
+    wsChatRoom(opts: WSChatRoomOptions): Promise<WSConnection>;
 }
 export declare function newChatClient(opts: ChatClientOptions): ChatClient;

package/dist/src/chat/chat.js

@@ -5,16 +5,10 @@
 // a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
 import { ColChatChatRoomMembers, ColChatChatRooms, ColChatChats, HTTPMethodPost, PathChatEnsure, PathChatReact, PathChatWS, PathChatWSMine, SvcChat, } from "@fabriktor/schema";
 import { requiredToken } from "../core/auth.js";
+import { queryParam, queryParams, withQuery } from "../core/col.js";
 import { newCRUDClient } from "../core/crud.js";
 import { buildPath } from "../core/path.js";
-const protocolFirebase = "firebase";
-const schemeHTTP = "http:";
-const schemeHTTPS = "https:";
-const schemeWS = "ws:";
-const schemeWSS = "wss:";
-const queryID = "id";
-const queryOwnerID = "owner_id";
-const queryChatRoomID = "chat_room_id";
+import { openWS, } from "../core/ws.js";
 export class ChatClient {
     chats;
     chat_rooms;
@@ -130,8 +124,10 @@ export class ChatClient {
         return openWS({
             base_url: this.base_url,
             path: withQuery(chatPath(PathChatWS), {
-                [queryOwnerID]: opts.owner_id,
-                [queryChatRoomID]: opts.chat_room_id,
+                query: queryParams({
+                    owner_id: opts.owner_id,
+                    chat_room_id: opts.chat_room_id,
+                }),
             }),
             token,
             on_message: opts.on_message,
@@ -144,7 +140,7 @@ export class ChatClient {
         return openWS({
             base_url: this.base_url,
             path: withQuery(chatRoomPath(PathChatWS), {
-                [queryID]: opts.id,
+                query: queryParam("id", opts.id),
             }),
             token,
             on_message: opts.on_message,
@@ -157,7 +153,7 @@ export class ChatClient {
         return openWS({
             base_url: this.base_url,
             path: withQuery(chatRoomPath(PathChatWSMine), {
-                [queryOwnerID]: opts.owner_id,
+                query: queryParam("owner_id", opts.owner_id),
             }),
             token,
             on_message: opts.on_message,
@@ -183,52 +179,3 @@ function chatRoomPath(action) {
         action,
     });
 }
-function openWS(opts) {
-    const socket = new WebSocket(wsURL(opts.base_url, opts.path), [
-        protocolFirebase,
-        opts.token,
-    ]);
-    socket.addEventListener("message", (ev) => {
-        if (typeof ev.data !== "string") {
-            return;
-        }
-        opts.on_message(JSON.parse(ev.data), ev);
-    });
-    if (opts.on_error !== undefined) {
-        socket.addEventListener("error", opts.on_error);
-    }
-    if (opts.on_close !== undefined) {
-        socket.addEventListener("close", opts.on_close);
-    }
-    return {
-        socket,
-        close(code, reason) {
-            socket.close(code, reason);
-        },
-    };
-}
-function wsURL(base, path) {
-    const u = new URL(path.replace(/^\/+/g, ""), ensureSlash(base));
-    if (u.protocol === schemeHTTPS) {
-        u.protocol = schemeWSS;
-        return u.toString();
-    }
-    if (u.protocol === schemeHTTP) {
-        u.protocol = schemeWS;
-        return u.toString();
-    }
-    return u.toString();
-}
-function ensureSlash(x) {
-    return x.endsWith("/") ? x : `${x}/`;
-}
-function withQuery(path, query) {
-    const q = new URLSearchParams();
-    for (const [k, v] of Object.entries(query)) {
-        if (v !== undefined && v.trim() !== "") {
-            q.set(k, v);
-        }
-    }
-    const s = q.toString();
-    return s === "" ? path : `${path}?${s}`;
-}

package/dist/src/core/col.d.ts

@@ -1,5 +1,8 @@
+export type FieldOf<T> = Extract<keyof T, string>;
 export type QueryValue = string | number | boolean | undefined | null;
-export type QueryOptions = Record<string, QueryValue | QueryValue[]>;
+export type QueryInputValue = QueryValue | QueryValue[];
+export type QueryOptions = Record<string, QueryInputValue>;
+export type TypedQueryOptions<T> = Partial<Record<FieldOf<T>, QueryInputValue>>;
 export type CollectionPathOptions = {
     svc: string;
     col: string;
@@ -12,4 +15,7 @@ export type BuildQueryOptions = {
 };
 export declare function collectionPath(opts: CollectionPathOptions): string;
 export declare function idPath(opts: IDPathOptions): string;
+export declare function queryParam<T>(key: FieldOf<T>, value: QueryInputValue): QueryOptions;
+export declare function queryParams<T>(query: TypedQueryOptions<T>): QueryOptions;
+export declare function mergeQueryOptions(...queries: Array<QueryOptions | undefined>): QueryOptions;
 export declare function withQuery(path: string, opts?: BuildQueryOptions): string;

package/dist/src/core/col.js

@@ -17,26 +17,23 @@ export function idPath(opts) {
         id: opts.id,
     });
 }
+export function queryParam(key, value) {
+    return { [key]: value };
+}
+export function queryParams(query) {
+    return query;
+}
+export function mergeQueryOptions(...queries) {
+    return Object.assign({}, ...queries);
+}
 export function withQuery(path, opts) {
     const query = opts?.query;
-    if (!query) {
+    if (query === undefined) {
         return path;
     }
     const params = new URLSearchParams();
     for (const [key, value] of Object.entries(query)) {
-        if (value === undefined || value === null) {
-            continue;
-        }
-        if (Array.isArray(value)) {
-            for (const item of value) {
-                if (item === undefined || item === null) {
-                    continue;
-                }
-                params.append(key, String(item));
-            }
-            continue;
-        }
-        params.set(key, String(value));
+        appendQueryValue(params, key, value);
     }
     const raw = params.toString();
     if (raw === "") {
@@ -44,3 +41,21 @@ export function withQuery(path, opts) {
     }
     return `${path}?${raw}`;
 }
+function appendQueryValue(params, key, value) {
+    if (value === undefined || value === null) {
+        return;
+    }
+    if (Array.isArray(value)) {
+        for (const item of value) {
+            appendQuerySingleValue(params, key, item);
+        }
+        return;
+    }
+    appendQuerySingleValue(params, key, value);
+}
+function appendQuerySingleValue(params, key, value) {
+    if (value === undefined || value === null) {
+        return;
+    }
+    params.append(key, String(value));
+}

package/dist/src/core/http.d.ts

@@ -1,13 +1,9 @@
 import { HTTPMethodDelete, HTTPMethodGet, HTTPMethodPatch, HTTPMethodPost } from "@fabriktor/schema";
-import type { OperationResult } from "@fabriktor/schema";
 import type { IdempotencyStore } from "./idempotency.js";
 export declare const headerAuthorization = "authorization";
 export declare const headerContentType = "content-type";
 export declare const prefixBearer = "Bearer";
 export type Method = typeof HTTPMethodGet | typeof HTTPMethodPost | typeof HTTPMethodPatch | typeof HTTPMethodDelete;
-export type Op<T> = Omit<OperationResult, "value"> & {
-    value?: T;
-};
 export type HTTPOptions<T> = {
     base_url: string;
     path: string;

package/dist/src/core/ws.d.ts

@@ -0,0 +1,16 @@
+export type WSMessageHandler<T> = (v: T, ev: MessageEvent<string>) => void;
+export type WSErrorHandler = (ev: Event) => void;
+export type WSCloseHandler = (ev: CloseEvent) => void;
+export type WSConnection = {
+    socket: WebSocket;
+    close(code?: number, reason?: string): void;
+};
+export type OpenWSOptions<T> = {
+    base_url: string;
+    path: string;
+    token: string;
+    on_message: WSMessageHandler<T>;
+    on_error?: WSErrorHandler;
+    on_close?: WSCloseHandler;
+};
+export declare function openWS<T>(opts: OpenWSOptions<T>): WSConnection;

package/dist/src/core/ws.js

@@ -0,0 +1,51 @@
+// Copyright (C) Fabriktor, Inc. 2025-present.
+//
+// Licensed under the Apache License, Version 2.0 (the "License"); you may
+// not use this file except in compliance with the License. You may obtain
+// a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
+import { HTTPScheme, HTTPSScheme } from "@fabriktor/schema";
+const protocolFirebase = "firebase";
+const schemeWS = "ws:";
+const schemeWSS = "wss:";
+export function openWS(opts) {
+    const socket = new WebSocket(wsURL(opts.base_url, opts.path), [
+        protocolFirebase,
+        opts.token,
+    ]);
+    socket.addEventListener("message", (ev) => {
+        if (typeof ev.data !== "string") {
+            return;
+        }
+        opts.on_message(JSON.parse(ev.data), ev);
+    });
+    if (opts.on_error !== undefined) {
+        socket.addEventListener("error", opts.on_error);
+    }
+    if (opts.on_close !== undefined) {
+        socket.addEventListener("close", opts.on_close);
+    }
+    return {
+        socket,
+        close(code, reason) {
+            socket.close(code, reason);
+        },
+    };
+}
+function wsURL(base, path) {
+    const u = new URL(path.replace(/^\/+/g, ""), ensureSlash(base));
+    if (u.protocol === protocolOf(HTTPSScheme)) {
+        u.protocol = schemeWSS;
+        return u.toString();
+    }
+    if (u.protocol === protocolOf(HTTPScheme)) {
+        u.protocol = schemeWS;
+        return u.toString();
+    }
+    return u.toString();
+}
+function protocolOf(scheme) {
+    return `${scheme}:`;
+}
+function ensureSlash(x) {
+    return x.endsWith("/") ? x : `${x}/`;
+}

package/dist/src/index.d.ts

@@ -11,6 +11,7 @@ export * from "./core/http.js";
 export * from "./core/idempotency.js";
 export * from "./core/multipart.js";
 export * from "./core/path.js";
+export * from "./core/ws.js";
 export * from "./feed/feed.js";
 export * from "./fulfillments/fulfillments.js";
 export * from "./jobs/jobs.js";

package/dist/src/index.js

@@ -11,6 +11,7 @@ export * from "./core/http.js";
 export * from "./core/idempotency.js";
 export * from "./core/multipart.js";
 export * from "./core/path.js";
+export * from "./core/ws.js";
 export * from "./feed/feed.js";
 export * from "./fulfillments/fulfillments.js";
 export * from "./jobs/jobs.js";

package/dist/src/storage/storage.js

@@ -5,6 +5,7 @@
 // a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
 import { ColStorageCalls, ColStorageChat, ColStorageContacts, ColStorageJobs, ColStorageLocations, ColStorageMemos, ColStorageQR, ColStorageReports, ColStorageTickets, ColStorageUsers, HTTPMethodPost, PathStorageDownload, PathStorageUpload, SvcStorage, } from "@fabriktor/schema";
 import { requiredToken } from "../core/auth.js";
+import { withQuery } from "../core/col.js";
 import { newCRUDClient } from "../core/crud.js";
 import { newMultipartClient } from "../core/multipart.js";
 import { buildPath } from "../core/path.js";
@@ -205,9 +206,11 @@ export function newStorageClient(opts) {
 }
 function uploadPath(col, opts) {
     return withQuery(storagePath(col, PathStorageUpload), {
-        [queryOwnerID]: opts.owner_id,
-        [queryUploaderID]: opts.uploader_id,
-        [queryFullQuality]: opts.full_quality === undefined ? undefined : String(opts.full_quality),
+        query: {
+            [queryOwnerID]: opts.owner_id,
+            [queryUploaderID]: opts.uploader_id,
+            [queryFullQuality]: opts.full_quality,
+        },
     });
 }
 function storagePath(col, action) {
@@ -237,13 +240,3 @@ function appendFile(form, f) {
 function isFile(f) {
     return typeof File !== "undefined" && f instanceof File;
 }
-function withQuery(path, query) {
-    const q = new URLSearchParams();
-    for (const [k, v] of Object.entries(query)) {
-        if (v !== undefined && v.trim() !== "") {
-            q.set(k, v);
-        }
-    }
-    const s = q.toString();
-    return s === "" ? path : `${path}?${s}`;
-}

package/dist/src/users/tmp_usernames.d.ts

@@ -1,10 +1,11 @@
 import { type PLUsersUsername } from "@fabriktor/schema";
 import type { TokenProvider } from "../core/auth.js";
-import type { HTTPDoer, Op } from "../core/http.js";
+import type { OperationResultOf } from "../core/crud.js";
+import type { HTTPDoer } from "../core/http.js";
 export type VerifyUsernameOptions = PLUsersUsername;
 export type UsernameVerification = string[];
 export interface TmpUsernamesOperator {
-    verify(opts: VerifyUsernameOptions): Promise<Op<UsernameVerification>>;
+    verify(opts: VerifyUsernameOptions): Promise<OperationResultOf<UsernameVerification>>;
 }
 export type TmpUsernamesClientOptions = {
     http: HTTPDoer;
@@ -16,6 +17,6 @@ export declare class TmpUsernamesClient implements TmpUsernamesOperator {
     private base_url;
     private get_token?;
     constructor(opts: TmpUsernamesClientOptions);
-    verify(opts: VerifyUsernameOptions): Promise<Op<UsernameVerification>>;
+    verify(opts: VerifyUsernameOptions): Promise<OperationResultOf<UsernameVerification>>;
 }
 export declare function newTmpUsernamesClient(opts: TmpUsernamesClientOptions): TmpUsernamesClient;

package/dist/src/users/users.d.ts

@@ -1,6 +1,7 @@
 import { type InUser, type OperationResult, type PLUsersContactList, type PLUsersForgotPassword, type PLUsersResolveUsername, type PLUsersSignInLink, type PLUsersVerifyEmail, type UpsertResult, type User } from "@fabriktor/schema";
 import type { TokenProvider } from "../core/auth.js";
-import type { HTTPDoer, Op } from "../core/http.js";
+import type { OperationResultOf } from "../core/crud.js";
+import type { HTTPDoer } from "../core/http.js";
 export type BootstrapOptions = {
     in: InUser;
 };
@@ -17,15 +18,15 @@ export type GetByUIDOptions = {
     uid: string;
 };
 export interface UsersOperator {
-    bootstrap(opts: BootstrapOptions): Promise<Op<UpsertResult>>;
+    bootstrap(opts: BootstrapOptions): Promise<OperationResultOf<UpsertResult>>;
     sync(): Promise<OperationResult>;
     sendEmailVerification(opts: SendEmailVerificationOptions): Promise<void>;
     forgotPassword(opts: ForgotPasswordOptions): Promise<void>;
     sendSignInLink(opts: SendSignInLinkOptions): Promise<void>;
-    resolveUsername(opts: ResolveUsernameOptions): Promise<Op<string>>;
-    match(opts: MatchOptions): Promise<Op<User[]>>;
-    search(opts: SearchOptions): Promise<Op<User[]>>;
-    getByUID(opts: GetByUIDOptions): Promise<Op<User[]>>;
+    resolveUsername(opts: ResolveUsernameOptions): Promise<OperationResultOf<string>>;
+    match(opts: MatchOptions): Promise<OperationResultOf<User[]>>;
+    search(opts: SearchOptions): Promise<OperationResultOf<User[]>>;
+    getByUID(opts: GetByUIDOptions): Promise<OperationResultOf<User[]>>;
 }
 export type UsersClientOptions = {
     http: HTTPDoer;
@@ -37,14 +38,14 @@ export declare class UsersClient implements UsersOperator {
     private base_url;
     private get_token?;
     constructor(opts: UsersClientOptions);
-    bootstrap(opts: BootstrapOptions): Promise<Op<UpsertResult>>;
+    bootstrap(opts: BootstrapOptions): Promise<OperationResultOf<UpsertResult>>;
     sync(): Promise<OperationResult>;
     sendEmailVerification(opts: SendEmailVerificationOptions): Promise<void>;
     forgotPassword(opts: ForgotPasswordOptions): Promise<void>;
     sendSignInLink(opts: SendSignInLinkOptions): Promise<void>;
-    resolveUsername(opts: ResolveUsernameOptions): Promise<Op<string>>;
-    match(opts: MatchOptions): Promise<Op<User[]>>;
-    search(opts: SearchOptions): Promise<Op<User[]>>;
-    getByUID(opts: GetByUIDOptions): Promise<Op<User[]>>;
+    resolveUsername(opts: ResolveUsernameOptions): Promise<OperationResultOf<string>>;
+    match(opts: MatchOptions): Promise<OperationResultOf<User[]>>;
+    search(opts: SearchOptions): Promise<OperationResultOf<User[]>>;
+    getByUID(opts: GetByUIDOptions): Promise<OperationResultOf<User[]>>;
 }
 export declare function newUsersClient(opts: UsersClientOptions): UsersClient;

package/dist/src/users/users.js

@@ -5,6 +5,7 @@
 // a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
 import { ColUsersUsers, HTTPMethodGet, HTTPMethodPost, PathSearch, PathUsersBootstrap, PathUsersForgotPassword, PathUsersMatch, PathUsersResolveUsername, PathUsersSendEmailVerification, PathUsersSendSignInLink, PathUsersSync, SvcUsers, } from "@fabriktor/schema";
 import { requiredToken } from "../core/auth.js";
+import { queryParam, withQuery } from "../core/col.js";
 import { buildPath } from "../core/path.js";
 export class UsersClient {
     http;
@@ -105,7 +106,9 @@ export class UsersClient {
         const token = await requiredToken(this.get_token);
         return await this.http.do({
             base_url: this.base_url,
-            path: `${collectionPath()}?uid=${encodeURIComponent(opts.uid)}`,
+            path: withQuery(collectionPath(), {
+                query: queryParam("uid", opts.uid),
+            }),
             method: HTTPMethodGet,
             token,
         });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fabriktor/client",
-  "version": "0.0.29",
+  "version": "0.0.32",
   "description": "![Fabriktor Logo](./img/fabriktor-character.gif)",
   "type": "module",
   "exports": {