@fabriktor/fx 0.0.13 → 0.0.14

package/dist/src/fx.d.ts

@@ -1,4 +1,4 @@
-import type { UsersOperator } from "@fabriktor/client";
+import type { TmpPhonesOperator, TmpUsernamesOperator, UsersOperator } from "@fabriktor/client";
 import type { AuthOperator } from "./auth/auth.js";
 import type { SessionFX, SessionFXOperator } from "./session/session.js";
 import type { UsersFX, UsersFXOperator } from "./users/users.js";
@@ -6,6 +6,8 @@ export type FXOptions = {
     base_url: string;
     auth: AuthOperator;
     users: UsersOperator;
+    tmp_usernames: TmpUsernamesOperator;
+    tmp_phones: TmpPhonesOperator;
 };
 export type DefaultFXOptions = {
     base_url: string;

package/dist/src/fx.js

@@ -3,7 +3,7 @@
 // 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 { newHTTPClient, newUsersClient } from "@fabriktor/client";
+import { newHTTPClient, newTmpPhonesClient, newTmpUsernamesClient, newUsersClient, } from "@fabriktor/client";
 import { newSessionFX } from "./session/session.js";
 import { newUsersFX } from "./users/users.js";
 export class FX {
@@ -14,6 +14,8 @@ export class FX {
             base_url: opts.base_url,
             auth: opts.auth,
             users: opts.users,
+            tmp_usernames: opts.tmp_usernames,
+            tmp_phones: opts.tmp_phones,
         });
         this.session = newSessionFX({
             auth: opts.auth,
@@ -25,11 +27,18 @@ export function newFX(opts) {
     return new FX(opts);
 }
 export function newDefaultFX(opts) {
+    const http = newHTTPClient();
     return newFX({
         base_url: opts.base_url,
         auth: opts.auth,
         users: newUsersClient({
-            http: newHTTPClient(),
+            http,
+        }),
+        tmp_usernames: newTmpUsernamesClient({
+            http,
+        }),
+        tmp_phones: newTmpPhonesClient({
+            http,
         }),
     });
 }

package/dist/src/index.d.ts

@@ -1,4 +1,7 @@
 export * from "./auth/auth.js";
 export * from "./fx.js";
 export * from "./session/session.js";
+export * from "./session/signup.js";
+export * from "./users/phone.js";
+export * from "./users/username.js";
 export * from "./users/users.js";

package/dist/src/index.js

@@ -1,4 +1,7 @@
 export * from "./auth/auth.js";
 export * from "./fx.js";
 export * from "./session/session.js";
+export * from "./session/signup.js";
+export * from "./users/phone.js";
+export * from "./users/username.js";
 export * from "./users/users.js";

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

@@ -1,4 +1,4 @@
-import type { InUser, UpsertResult } from "@fabriktor/schema";
+import type { InUser, PLUsersForgotPassword, PLUsersSignInLink, UpsertResult } from "@fabriktor/schema";
 import type { Op } from "@fabriktor/client";
 import type { AuthEmailOptions, AuthOperator } from "../auth/auth.js";
 import type { UsersFXOperator } from "../users/users.js";
@@ -18,7 +18,11 @@ export type SessionFXOptions = {
 export interface SessionFXOperator {
     signUpAndBootstrap(opts: SignUpAndBootstrapOptions): Promise<Op<UpsertResult>>;
     signIn(opts: SignInOptions): Promise<void>;
+    signInWithEmail(opts: AuthEmailOptions): Promise<void>;
     signOut(): Promise<void>;
+    forgotPassword(opts: PLUsersForgotPassword): Promise<void>;
+    sendSignInLink(opts: PLUsersSignInLink): Promise<void>;
+    sendEmailVerification(): Promise<void>;
 }
 export declare class SessionFX implements SessionFXOperator {
     private auth;
@@ -26,6 +30,10 @@ export declare class SessionFX implements SessionFXOperator {
     constructor(opts: SessionFXOptions);
     signUpAndBootstrap(opts: SignUpAndBootstrapOptions): Promise<Op<UpsertResult>>;
     signIn(opts: SignInOptions): Promise<void>;
+    signInWithEmail(opts: AuthEmailOptions): Promise<void>;
     signOut(): Promise<void>;
+    forgotPassword(opts: PLUsersForgotPassword): Promise<void>;
+    sendSignInLink(opts: PLUsersSignInLink): Promise<void>;
+    sendEmailVerification(): Promise<void>;
 }
 export declare function newSessionFX(opts: SessionFXOptions): SessionFX;

package/dist/src/session/session.js

@@ -15,9 +15,11 @@ export class SessionFX {
             email: opts.email,
             password: opts.password,
         });
-        return await this.users.bootstrap({
+        const out = await this.users.bootstrap({
             in: opts.in,
         });
+        await this.users.sendEmailVerification();
+        return out;
     }
     async signIn(opts) {
         const email = opts.mode === "email"
@@ -25,15 +27,27 @@ export class SessionFX {
             : await this.users.resolveUsername({
                 username: opts.identifier,
             });
-        await this.auth.signIn({
+        await this.signInWithEmail({
             email,
             password: opts.password,
         });
+    }
+    async signInWithEmail(opts) {
+        await this.auth.signIn(opts);
         await this.users.sync();
     }
     async signOut() {
         await this.auth.signOut();
     }
+    async forgotPassword(opts) {
+        await this.users.forgotPassword(opts);
+    }
+    async sendSignInLink(opts) {
+        await this.users.sendSignInLink(opts);
+    }
+    async sendEmailVerification() {
+        await this.users.sendEmailVerification();
+    }
 }
 export function newSessionFX(opts) {
     return new SessionFX(opts);

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

@@ -0,0 +1,34 @@
+import { UserTypeClient, UserTypeEmployee, UserTypeEmployer } from "@fabriktor/schema";
+import type { InUser, Owner, Privacy } from "@fabriktor/schema";
+export type SignUpUserType = typeof UserTypeClient | typeof UserTypeEmployee | typeof UserTypeEmployer;
+export type SignUpAddressInput = {
+    address_timezone?: string;
+    lat?: number;
+    lon?: number;
+    street?: string;
+    city?: string;
+    state?: string;
+    postal_code?: string;
+    country?: string;
+    formatted_address?: string;
+    place_name?: string;
+    place_id?: string;
+};
+export type SignUpInput = {
+    email: string;
+    password: string;
+    username: string;
+    first_name: string;
+    last_name: string;
+    company_name?: string;
+    user_type: SignUpUserType;
+    preferred_language: string;
+    phone?: string;
+    address?: SignUpAddressInput;
+    privacy?: Privacy;
+    picture_id?: string;
+    qr_id?: string;
+};
+export declare function newInUserFromSignUp(opts: SignUpInput): InUser;
+export declare function newDefaultPrivacy(): Privacy;
+export declare function newZeroOwner(): Owner;

package/dist/src/session/signup.js

@@ -0,0 +1,42 @@
+// 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
+export function newInUserFromSignUp(opts) {
+    return {
+        address_timezone: opts.address?.address_timezone ?? "",
+        lat: opts.address?.lat ?? 0,
+        lon: opts.address?.lon ?? 0,
+        street: opts.address?.street ?? "",
+        city: opts.address?.city ?? "",
+        state: opts.address?.state ?? "",
+        postal_code: opts.address?.postal_code ?? "",
+        country: opts.address?.country ?? "",
+        formatted_address: opts.address?.formatted_address ?? "",
+        place_name: opts.address?.place_name ?? "",
+        place_id: opts.address?.place_id ?? "",
+        username: opts.username,
+        first_name: opts.first_name,
+        last_name: opts.last_name,
+        phone: opts.phone ?? "",
+        company_name: opts.company_name ?? "",
+        user_type: opts.user_type,
+        user_type_switch: opts.user_type,
+        privacy: opts.privacy ?? newDefaultPrivacy(),
+        picture_id: opts.picture_id ?? "",
+        qr_id: opts.qr_id ?? "",
+        ExternalOwner: newZeroOwner(),
+    };
+}
+export function newDefaultPrivacy() {
+    return {
+        is_searchable: true,
+        is_messageable: true,
+    };
+}
+export function newZeroOwner() {
+    return {
+        owner_id: "",
+    };
+}

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

@@ -0,0 +1,4 @@
+export declare function normalizePhone(v: string): string;
+export declare function normalizePhoneCode(v: string): string;
+export declare function validatePhone(v: string): boolean;
+export declare function validatePhoneCode(v: string): boolean;

package/dist/src/users/phone.js

@@ -0,0 +1,17 @@
+// 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
+export function normalizePhone(v) {
+    return v.trim();
+}
+export function normalizePhoneCode(v) {
+    return v.trim();
+}
+export function validatePhone(v) {
+    return normalizePhone(v).length > 0;
+}
+export function validatePhoneCode(v) {
+    return normalizePhoneCode(v).length > 0;
+}

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

@@ -0,0 +1,7 @@
+export type UsernameFormatResult = {
+    valid: boolean;
+    normalized: string;
+    error: string;
+};
+export declare function normalizeUsername(v: string): string;
+export declare function validateUsernameFormat(v: string): UsernameFormatResult;

package/dist/src/users/username.js

@@ -0,0 +1,48 @@
+// 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 usernameMinLength = 3;
+const usernameMaxLength = 40;
+const usernamePattern = /^[a-z][a-z0-9_]*$/;
+const usernameLetterPattern = /[a-z]/;
+export function normalizeUsername(v) {
+    return v.trim().toLowerCase();
+}
+export function validateUsernameFormat(v) {
+    const normalized = normalizeUsername(v);
+    if (normalized.length < usernameMinLength) {
+        return {
+            valid: false,
+            normalized,
+            error: "Username must contain at least 3 characters.",
+        };
+    }
+    if (normalized.length > usernameMaxLength) {
+        return {
+            valid: false,
+            normalized,
+            error: "Username must contain at most 40 characters.",
+        };
+    }
+    if (!usernamePattern.test(normalized)) {
+        return {
+            valid: false,
+            normalized,
+            error: "Username must start with a lowercase letter and contain only lowercase letters, digits, and underscores.",
+        };
+    }
+    if (!usernameLetterPattern.test(normalized)) {
+        return {
+            valid: false,
+            normalized,
+            error: "Username must contain at least one letter.",
+        };
+    }
+    return {
+        valid: true,
+        normalized,
+        error: "",
+    };
+}

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

@@ -1,31 +1,57 @@
-import type { InUser, OperationResult, UpsertResult } from "@fabriktor/schema";
-import type { Op, UsersOperator } from "@fabriktor/client";
+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";
 export type UsersFXOptions = {
     base_url: string;
     auth: AuthOperator;
     users: UsersOperator;
+    tmp_usernames: TmpUsernamesOperator;
+    tmp_phones: TmpPhonesOperator;
 };
 export type BootstrapOptions = {
     in: InUser;
 };
-export type ResolveUsernameOptions = {
-    username: string;
+export type SearchOptions = {
+    q: string;
+    limit?: number;
+};
+export type GetByUIDOptions = {
+    uid: string;
 };
 export interface UsersFXOperator {
     bootstrap(opts: BootstrapOptions): Promise<Op<UpsertResult>>;
     sync(): Promise<OperationResult>;
     sendEmailVerification(): Promise<void>;
-    resolveUsername(opts: ResolveUsernameOptions): Promise<string>;
+    forgotPassword(opts: PLUsersForgotPassword): Promise<void>;
+    sendSignInLink(opts: PLUsersSignInLink): Promise<void>;
+    resolveUsername(opts: PLUsersResolveUsername): Promise<string>;
+    verifyUsername(opts: PLUsersUsername): Promise<Op<UsernameVerification>>;
+    generateUsernames(opts: PLUsersUsername): Promise<Op<UsernameVerification>>;
+    sendPhoneCode(opts: PLUsersSendCode): Promise<void>;
+    verifyPhoneCode(opts: PLUsersVerifyCode): Promise<void>;
+    match(opts: PLUsersContactList): Promise<Op<MatchResult>>;
+    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;
     constructor(opts: UsersFXOptions);
     bootstrap(opts: BootstrapOptions): Promise<Op<UpsertResult>>;
     sync(): Promise<OperationResult>;
     sendEmailVerification(): Promise<void>;
-    resolveUsername(opts: ResolveUsernameOptions): Promise<string>;
+    forgotPassword(opts: PLUsersForgotPassword): Promise<void>;
+    sendSignInLink(opts: PLUsersSignInLink): Promise<void>;
+    resolveUsername(opts: PLUsersResolveUsername): Promise<string>;
+    verifyUsername(opts: PLUsersUsername): Promise<Op<UsernameVerification>>;
+    generateUsernames(opts: PLUsersUsername): Promise<Op<UsernameVerification>>;
+    sendPhoneCode(opts: PLUsersSendCode): Promise<void>;
+    verifyPhoneCode(opts: PLUsersVerifyCode): Promise<void>;
+    match(opts: PLUsersContactList): Promise<Op<MatchResult>>;
+    search(opts: SearchOptions): Promise<Op<User[]>>;
+    getByUID(opts: GetByUIDOptions): Promise<Op<User>>;
 }
 export declare function newUsersFX(opts: UsersFXOptions): UsersFX;

package/dist/src/users/users.js

@@ -3,14 +3,20 @@
 // 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 { 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();
@@ -34,16 +40,97 @@ export class UsersFX {
             token,
         });
     }
+    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: opts.username,
+            username,
         });
         if (out.value === undefined) {
             throw new Error("Unable to resolve username.");
         }
         return out.value;
     }
+    async verifyUsername(opts) {
+        const check = validateUsernameFormat(opts.to_validate);
+        if (!check.valid) {
+            throw new Error(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: "",
+        });
+    }
+    async sendPhoneCode(opts) {
+        const phone = normalizePhone(opts.phone);
+        if (!validatePhone(phone)) {
+            throw new Error("Phone number is required.");
+        }
+        return await this.tmp_phones.send({
+            base_url: this.base_url,
+            phone,
+        });
+    }
+    async verifyPhoneCode(opts) {
+        const phone = normalizePhone(opts.phone);
+        const code = normalizePhoneCode(opts.code);
+        if (!validatePhone(phone)) {
+            throw new Error("Phone number is required.");
+        }
+        if (!validatePhoneCode(code)) {
+            throw new Error("Verification code is required.");
+        }
+        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,
+        });
+    }
 }
 export function newUsersFX(opts) {
     return new UsersFX(opts);

package/package.json

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