@fabriktor/client 0.0.29 → 0.0.31

package/dist/src/chat/chat.js

@@ -5,6 +5,7 @@
 // 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";
@@ -12,9 +13,6 @@ const schemeHTTP = "http:";
 const schemeHTTPS = "https:";
 const schemeWS = "ws:";
 const schemeWSS = "wss:";
-const queryID = "id";
-const queryOwnerID = "owner_id";
-const queryChatRoomID = "chat_room_id";
 export class ChatClient {
     chats;
     chat_rooms;
@@ -130,8 +128,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 +144,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 +157,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,
@@ -222,13 +222,3 @@ function wsURL(base, path) {
 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/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.31",
   "description": "![Fabriktor Logo](./img/fabriktor-character.gif)",
   "type": "module",
   "exports": {