@fabriktor/fx 0.0.16 → 0.0.18

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

@@ -0,0 +1,26 @@
+export declare const FXErrKind: {
+    readonly UsernameResolveFailed: "username_resolve_failed";
+    readonly UsernameInvalid: "username_invalid";
+    readonly PhoneRequired: "phone_required";
+    readonly PhoneCodeRequired: "phone_code_required";
+    readonly Unknown: "unknown";
+};
+export type FXErrKind = (typeof FXErrKind)[keyof typeof FXErrKind];
+export type FXErrOptions = {
+    kind: FXErrKind;
+    msg: string;
+    cause?: unknown;
+};
+export declare class FXErr extends Error {
+    readonly kind: FXErrKind;
+    readonly cause?: unknown;
+    constructor(opts: FXErrOptions);
+}
+export declare function errFX(opts: FXErrOptions): FXErr;
+export declare function errUsernameResolveFailed(): FXErr;
+export declare function errUsernameInvalid(msg: string): FXErr;
+export declare function errPhoneRequired(): FXErr;
+export declare function errPhoneCodeRequired(): FXErr;
+export declare function errUnknown(cause: unknown): FXErr;
+export declare function isFXErr(err: unknown): err is FXErr;
+export declare function fxErrMessage(err: unknown): string;

package/dist/src/core/err.js

@@ -0,0 +1,82 @@
+// 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
+const msgUnknownFXErr = "Unknown FX error.";
+const msgUnableToResolveUsername = "Unable to resolve username.";
+const msgPhoneRequired = "Phone number is required.";
+const msgPhoneCodeRequired = "Verification code is required.";
+export const FXErrKind = {
+    UsernameResolveFailed: "username_resolve_failed",
+    UsernameInvalid: "username_invalid",
+    PhoneRequired: "phone_required",
+    PhoneCodeRequired: "phone_code_required",
+    Unknown: "unknown",
+};
+export class FXErr extends Error {
+    kind;
+    cause;
+    constructor(opts) {
+        super(opts.msg);
+        this.name = new.target.name;
+        this.kind = opts.kind;
+        this.cause = opts.cause;
+    }
+}
+export function errFX(opts) {
+    return new FXErr(opts);
+}
+export function errUsernameResolveFailed() {
+    return errFX({
+        kind: FXErrKind.UsernameResolveFailed,
+        msg: msgUnableToResolveUsername,
+    });
+}
+export function errUsernameInvalid(msg) {
+    return errFX({
+        kind: FXErrKind.UsernameInvalid,
+        msg,
+    });
+}
+export function errPhoneRequired() {
+    return errFX({
+        kind: FXErrKind.PhoneRequired,
+        msg: msgPhoneRequired,
+    });
+}
+export function errPhoneCodeRequired() {
+    return errFX({
+        kind: FXErrKind.PhoneCodeRequired,
+        msg: msgPhoneCodeRequired,
+    });
+}
+export function errUnknown(cause) {
+    if (isFXErr(cause)) {
+        return cause;
+    }
+    if (cause instanceof Error) {
+        return errFX({
+            kind: FXErrKind.Unknown,
+            msg: cause.message,
+            cause,
+        });
+    }
+    return errFX({
+        kind: FXErrKind.Unknown,
+        msg: msgUnknownFXErr,
+        cause,
+    });
+}
+export function isFXErr(err) {
+    return err instanceof FXErr;
+}
+export function fxErrMessage(err) {
+    if (isFXErr(err)) {
+        return err.message;
+    }
+    if (err instanceof Error) {
+        return err.message;
+    }
+    return msgUnknownFXErr;
+}

package/dist/src/fx.d.ts

@@ -3,7 +3,6 @@ import type { AuthOperator } from "./auth/auth.js";
 import type { SessionFX, SessionFXOperator } from "./session/session.js";
 import type { UsersFX, UsersFXOperator } from "./users/users.js";
 export type FXOptions = {
-    base_url: string;
     auth: AuthOperator;
     users: UsersOperator;
     tmp_usernames: TmpUsernamesOperator;

package/dist/src/fx.js

@@ -11,8 +11,6 @@ export class FX {
     session;
     constructor(opts) {
         this.users = newUsersFX({
-            base_url: opts.base_url,
-            auth: opts.auth,
             users: opts.users,
             tmp_usernames: opts.tmp_usernames,
             tmp_phones: opts.tmp_phones,
@@ -29,16 +27,21 @@ export function newFX(opts) {
 export function newDefaultFX(opts) {
     const http = newHTTPClient();
     return newFX({
-        base_url: opts.base_url,
         auth: opts.auth,
         users: newUsersClient({
             http,
+            base_url: opts.base_url,
+            get_token: () => opts.auth.getToken(),
         }),
         tmp_usernames: newTmpUsernamesClient({
             http,
+            base_url: opts.base_url,
+            get_token: () => opts.auth.getToken(),
         }),
         tmp_phones: newTmpPhonesClient({
             http,
+            base_url: opts.base_url,
+            get_token: () => opts.auth.getToken(),
         }),
     });
 }

package/dist/src/index.d.ts

@@ -1,4 +1,5 @@
 export * from "./auth/auth.js";
+export * from "./core/err.js";
 export * from "./fx.js";
 export * from "./session/session.js";
 export * from "./users/phone.js";

package/dist/src/index.js

@@ -1,4 +1,5 @@
 export * from "./auth/auth.js";
+export * from "./core/err.js";
 export * from "./fx.js";
 export * from "./session/session.js";
 export * from "./users/phone.js";

package/dist/src/session/session.d.ts

@@ -1,5 +1,5 @@
-import type { InUser, PLUsersForgotPassword, PLUsersSignInLink, UpsertResult } from "@fabriktor/schema";
 import type { Op } from "@fabriktor/client";
+import type { InUser, PLUsersForgotPassword, PLUsersSignInLink, UpsertResult } from "@fabriktor/schema";
 import type { AuthEmailOptions, AuthOperator } from "../auth/auth.js";
 import type { BootstrapOptions, UsersFXOperator } from "../users/users.js";
 export type SignInMode = "email" | "username";

package/dist/src/users/username.js

@@ -7,6 +7,10 @@ const usernameMinLength = 3;
 const usernameMaxLength = 40;
 const usernamePattern = /^[a-z][a-z0-9_]*$/;
 const usernameLetterPattern = /[a-z]/;
+const msgUsernameMinLength = "Username must contain at least 3 characters.";
+const msgUsernameMaxLength = "Username must contain at most 40 characters.";
+const msgUsernamePattern = "Username must start with a lowercase letter and contain only lowercase letters, digits, and underscores.";
+const msgUsernameLetter = "Username must contain at least one letter.";
 export function normalizeUsername(v) {
     return v.trim().toLowerCase();
 }
@@ -16,28 +20,28 @@ export function validateUsernameFormat(v) {
         return {
             valid: false,
             normalized,
-            error: "Username must contain at least 3 characters.",
+            error: msgUsernameMinLength,
         };
     }
     if (normalized.length > usernameMaxLength) {
         return {
             valid: false,
             normalized,
-            error: "Username must contain at most 40 characters.",
+            error: msgUsernameMaxLength,
         };
     }
     if (!usernamePattern.test(normalized)) {
         return {
             valid: false,
             normalized,
-            error: "Username must start with a lowercase letter and contain only lowercase letters, digits, and underscores.",
+            error: msgUsernamePattern,
         };
     }
     if (!usernameLetterPattern.test(normalized)) {
         return {
             valid: false,
             normalized,
-            error: "Username must contain at least one letter.",
+            error: msgUsernameLetter,
         };
     }
     return {

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

@@ -1,9 +1,6 @@
 import type { InUser, OperationResult, PLUsersContactList, PLUsersForgotPassword, PLUsersResolveUsername, PLUsersSendCode, PLUsersSignInLink, PLUsersUsername, PLUsersVerifyCode, UpsertResult, User } from "@fabriktor/schema";
-import type { MatchResult, Op, TmpPhonesOperator, TmpUsernamesOperator, UsernameVerification, UsersOperator } from "@fabriktor/client";
-import type { AuthOperator } from "../auth/auth.js";
+import type { Op, TmpPhonesOperator, TmpUsernamesOperator, UsernameVerification, UsersOperator } from "@fabriktor/client";
 export type UsersFXOptions = {
-    base_url: string;
-    auth: AuthOperator;
     users: UsersOperator;
     tmp_usernames: TmpUsernamesOperator;
     tmp_phones: TmpPhonesOperator;
@@ -29,13 +26,11 @@ export interface UsersFXOperator {
     generateUsernames(opts: PLUsersUsername): Promise<Op<UsernameVerification>>;
     sendPhoneCode(opts: PLUsersSendCode): Promise<void>;
     verifyPhoneCode(opts: PLUsersVerifyCode): Promise<void>;
-    match(opts: PLUsersContactList): Promise<Op<MatchResult>>;
+    match(opts: PLUsersContactList): Promise<Op<User[]>>;
     search(opts: SearchOptions): Promise<Op<User[]>>;
     getByUID(opts: GetByUIDOptions): Promise<Op<User>>;
 }
 export declare class UsersFX implements UsersFXOperator {
-    private base_url;
-    private auth;
     private users;
     private tmp_usernames;
     private tmp_phones;
@@ -50,7 +45,7 @@ export declare class UsersFX implements UsersFXOperator {
     generateUsernames(opts: PLUsersUsername): Promise<Op<UsernameVerification>>;
     sendPhoneCode(opts: PLUsersSendCode): Promise<void>;
     verifyPhoneCode(opts: PLUsersVerifyCode): Promise<void>;
-    match(opts: PLUsersContactList): Promise<Op<MatchResult>>;
+    match(opts: PLUsersContactList): Promise<Op<User[]>>;
     search(opts: SearchOptions): Promise<Op<User[]>>;
     getByUID(opts: GetByUIDOptions): Promise<Op<User>>;
 }

package/dist/src/users/users.js

@@ -3,80 +3,61 @@
 // 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 { errPhoneCodeRequired, errPhoneRequired, errUsernameInvalid, errUsernameResolveFailed, } from "../core/err.js";
 import { normalizePhone, normalizePhoneCode, validatePhone, validatePhoneCode, } from "./phone.js";
 import { normalizeUsername, validateUsernameFormat } from "./username.js";
 export class UsersFX {
-    base_url;
-    auth;
     users;
     tmp_usernames;
     tmp_phones;
     constructor(opts) {
-        this.base_url = opts.base_url;
-        this.auth = opts.auth;
         this.users = opts.users;
         this.tmp_usernames = opts.tmp_usernames;
         this.tmp_phones = opts.tmp_phones;
     }
     async bootstrap(opts) {
-        const token = await this.auth.getToken();
         return await this.users.bootstrap({
-            base_url: this.base_url,
-            token,
             in: opts.in,
         });
     }
     async sync() {
-        const token = await this.auth.getToken();
-        return await this.users.sync({
-            base_url: this.base_url,
-            token,
-        });
+        return await this.users.sync();
     }
     async sendEmailVerification() {
-        const token = await this.auth.getToken();
-        return await this.users.sendEmailVerification({
-            base_url: this.base_url,
-            token,
-        });
+        return await this.users.sendEmailVerification();
     }
     async forgotPassword(opts) {
         return await this.users.forgotPassword({
-            base_url: this.base_url,
             email: opts.email,
         });
     }
     async sendSignInLink(opts) {
         return await this.users.sendSignInLink({
-            base_url: this.base_url,
             email: opts.email,
         });
     }
     async resolveUsername(opts) {
         const username = normalizeUsername(opts.username);
         const out = await this.users.resolveUsername({
-            base_url: this.base_url,
             username,
         });
         if (out.value === undefined) {
-            throw new Error("Unable to resolve username.");
+            throw errUsernameResolveFailed();
         }
         return out.value;
     }
     async verifyUsername(opts) {
         const check = validateUsernameFormat(opts.to_validate);
         if (!check.valid) {
-            throw new Error(check.error);
+            throw errUsernameInvalid(check.error);
         }
         return await this.tmp_usernames.verify({
-            base_url: this.base_url,
             words: opts.words,
             to_validate: check.normalized,
         });
     }
     async generateUsernames(opts) {
         return await this.tmp_usernames.verify({
-            base_url: this.base_url,
             words: opts.words,
             to_validate: "",
         });
@@ -84,10 +65,9 @@ export class UsersFX {
     async sendPhoneCode(opts) {
         const phone = normalizePhone(opts.phone);
         if (!validatePhone(phone)) {
-            throw new Error("Phone number is required.");
+            throw errPhoneRequired();
         }
         return await this.tmp_phones.send({
-            base_url: this.base_url,
             phone,
         });
     }
@@ -95,39 +75,29 @@ export class UsersFX {
         const phone = normalizePhone(opts.phone);
         const code = normalizePhoneCode(opts.code);
         if (!validatePhone(phone)) {
-            throw new Error("Phone number is required.");
+            throw errPhoneRequired();
         }
         if (!validatePhoneCode(code)) {
-            throw new Error("Verification code is required.");
+            throw errPhoneCodeRequired();
         }
         return await this.tmp_phones.verify({
-            base_url: this.base_url,
             phone,
             code,
         });
     }
     async match(opts) {
-        const token = await this.auth.getToken();
         return await this.users.match({
-            base_url: this.base_url,
-            token,
             contacts: opts.contacts,
         });
     }
     async search(opts) {
-        const token = await this.auth.getToken();
         return await this.users.search({
-            base_url: this.base_url,
-            token,
             q: opts.q,
             limit: opts.limit,
         });
     }
     async getByUID(opts) {
-        const token = await this.auth.getToken();
         return await this.users.getByUID({
-            base_url: this.base_url,
-            token,
             uid: opts.uid,
         });
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fabriktor/fx",
-  "version": "0.0.16",
+  "version": "0.0.18",
   "description": "![Fabriktor Logo](./img/fabriktor-character.gif)",
   "type": "module",
   "exports": {
@@ -17,7 +17,7 @@
     "typescript": "^6.0.3"
   },
   "dependencies": {
-    "@fabriktor/client": "^0.0.13",
+    "@fabriktor/client": "^0.0.16",
     "@fabriktor/schema": "^0.0.12"
   }
 }