@fonderie/customers 1.0.0

package/dist/index.d.ts

@@ -0,0 +1,237 @@
+import { CustomerSex, IAddress, ICustomerAddress, ICustomer, ICustomerDetail, ICustomerEmail, ICustomerNote, ICustomerPhone, ICustomerTag, ICustomerDetailD2 } from './types.js';
+export { AddressLabel, CustomerType, EmailLabel, PhoneLabel } from './types.js';
+import { IStoreAdapter } from '@fonderie/store';
+import { IFonderieModule, IFonderieApp } from '@fonderie/core';
+import { EventBus } from '@fonderie/events';
+
+declare const EVENT_KEYS: {
+    readonly customerCreated: "fonderie.customer.created";
+    readonly customerUpdated: "fonderie.customer.updated";
+    readonly customerDeleted: "fonderie.customer.deleted";
+    readonly customerBlacklisted: "fonderie.customer.blacklisted";
+    readonly customerUnblacklisted: "fonderie.customer.unblacklisted";
+};
+type CustomersEventKey = (typeof EVENT_KEYS)[keyof typeof EVENT_KEYS];
+type ICustomersConfig = {
+    /** Prefix used when auto-generating customer reference codes. Defaults to DEFAULT_REFERENCE_CODE_PREFIX. */
+    referenceCodePrefix?: string;
+};
+
+interface ICustomerDTO {
+    id: string;
+    type: string;
+    sex: CustomerSex;
+    firstName: string;
+    lastName: string;
+    companyName: string;
+    avatarUrl: string;
+    locale: string;
+    referenceCode: string;
+    blacklisted: {
+        status: boolean;
+        reason: string | null;
+    };
+    createdBy: string;
+    createdAt: string;
+    updatedAt: string;
+}
+interface ICustomerShallowDTO extends ICustomerDTO {
+    emails: ICustomerEmailDTO[];
+    phones: ICustomerPhoneDTO[];
+    addresses: ICustomerAddressDTO[];
+    notes: ICustomerNoteDTO[];
+    tags: string[];
+}
+type ICustomerRelationshipExpandedDTO = Omit<ICustomerShallowDTO, 'id'> & {
+    id: string;
+    customerId: string;
+    relationship: string;
+    isPrimary: boolean;
+};
+interface ICustomerDetailDTO extends ICustomerDTO {
+    emails: ICustomerEmailDTO[];
+    phones: ICustomerPhoneDTO[];
+    addresses: ICustomerAddressDTO[];
+    notes: ICustomerNoteDTO[];
+    relationships: ICustomerRelationshipExpandedDTO[];
+    tags: string[];
+}
+interface ICustomerEmailDTO {
+    id: string;
+    email: string;
+    label: string;
+    isPrimary: boolean;
+    createdAt: string;
+}
+interface ICustomerPhoneDTO {
+    id: string;
+    phone: string;
+    label: string;
+    isPrimary: boolean;
+    createdAt: string;
+}
+interface IAddressDTO {
+    countryIso: string;
+    subdivision1Iso: string;
+    subdivision2Iso: string;
+    zipPostalCode: string;
+    unit: string;
+    line1: string;
+    line2: string;
+}
+interface ICustomerAddressDTO {
+    id: string;
+    label: string;
+    isPrimary: boolean;
+    address: IAddressDTO;
+}
+interface ICustomerNoteDTO {
+    id: string;
+    authorId: string;
+    body: string;
+    createdAt: string;
+    updatedAt: string;
+}
+interface ICustomerTagDTO {
+    tag: string;
+}
+declare function toCustomerDTO(c: ICustomer): ICustomerDTO;
+declare function toCustomerDetailDTO(c: ICustomerDetail): ICustomerDetailDTO;
+declare function toAddressDTO(a: IAddress): IAddressDTO;
+declare function toCustomerEmailDTO(e: ICustomerEmail): ICustomerEmailDTO;
+declare function toCustomerPhoneDTO(p: ICustomerPhone): ICustomerPhoneDTO;
+declare function toCustomerAddressDTO(ca: ICustomerAddress): ICustomerAddressDTO;
+declare function toCustomerNoteDTO(n: ICustomerNote): ICustomerNoteDTO;
+declare function toCustomerTagDTO(t: ICustomerTag): ICustomerTagDTO;
+
+interface ListCustomersOpts {
+    workspaceId: string;
+    search?: string | undefined;
+    blacklisted?: boolean | undefined;
+    limit?: number | undefined;
+    offset?: number | undefined;
+}
+interface CreateCustomerOpts {
+    workspaceId: string;
+    type?: string;
+    sex?: string;
+    firstName?: string | null;
+    lastName?: string | null;
+    companyName?: string | null;
+    avatarUrl?: string | null;
+    locale?: string;
+    /** Explicit code to assign. Omit to auto-generate ({prefix}-0001, …). */
+    referenceCode?: string;
+    /** Prefix used when auto-generating. Defaults to 'CLT'. */
+    referenceCodePrefix?: string;
+    createdBy?: string | null;
+}
+interface UpdateCustomerOpts {
+    type?: string;
+    sex?: string;
+    firstName?: string | null;
+    lastName?: string | null;
+    companyName?: string | null;
+    avatarUrl?: string | null;
+    locale?: string;
+    /** Explicit code to assign. Omit to keep existing or auto-generate if none. */
+    referenceCode?: string;
+}
+declare class CustomerModel {
+    private readonly store;
+    constructor(store: IStoreAdapter);
+    private allocateCode;
+    list(opts: ListCustomersOpts): Promise<ICustomer[]>;
+    findById(id: string, workspaceId: string): Promise<ICustomer | null>;
+    findDetail(id: string, workspaceId: string, depth: 2): Promise<ICustomerDetailD2 | null>;
+    findDetail(id: string, workspaceId: string, depth?: 1): Promise<ICustomerDetail | null>;
+    create(opts: CreateCustomerOpts): Promise<ICustomer>;
+    update(id: string, workspaceId: string, opts: UpdateCustomerOpts, referenceCodePrefix?: string): Promise<ICustomer | null>;
+    delete(id: string, workspaceId: string): Promise<void>;
+    blacklist(id: string, workspaceId: string, reason?: string | null): Promise<void>;
+    unblacklist(id: string, workspaceId: string): Promise<void>;
+}
+
+declare class CustomerAddressModel {
+    private readonly store;
+    constructor(store: IStoreAdapter);
+    list(customerId: string): Promise<ICustomerAddress[]>;
+    add(opts: {
+        customerId: string;
+        countryIso: string;
+        subdivision1Iso?: string | null;
+        subdivision2Iso?: string | null;
+        zipPostalCode: string;
+        unit?: string | null;
+        line1?: string | null;
+        line2?: string | null;
+        labelId: string;
+        isPrimary?: boolean;
+    }): Promise<ICustomerAddress>;
+    updateLabel(addrId: string, customerId: string, labelId: string): Promise<ICustomerAddress>;
+    setPrimary(addrId: string, customerId: string): Promise<void>;
+    remove(addrId: string, customerId: string): Promise<void>;
+}
+
+declare class CustomerEmailModel {
+    private readonly store;
+    constructor(store: IStoreAdapter);
+    list(customerId: string): Promise<ICustomerEmail[]>;
+    add(opts: {
+        customerId: string;
+        email: string;
+        labelId: string;
+        isPrimary?: boolean;
+    }): Promise<ICustomerEmail>;
+    updateLabel(emailId: string, customerId: string, labelId: string): Promise<ICustomerEmail>;
+    setPrimary(emailId: string, customerId: string): Promise<void>;
+    remove(emailId: string, customerId: string): Promise<void>;
+}
+
+declare class CustomerNoteModel {
+    private readonly store;
+    constructor(store: IStoreAdapter);
+    list(customerId: string): Promise<ICustomerNote[]>;
+    create(opts: {
+        customerId: string;
+        authorId?: string | null;
+        body: string;
+    }): Promise<ICustomerNote>;
+    update(noteId: string, customerId: string, body: string): Promise<ICustomerNote | null>;
+    delete(noteId: string, customerId: string): Promise<void>;
+}
+
+declare class CustomerPhoneModel {
+    private readonly store;
+    constructor(store: IStoreAdapter);
+    list(customerId: string): Promise<ICustomerPhone[]>;
+    add(opts: {
+        customerId: string;
+        phone: string;
+        labelId: string;
+        isPrimary?: boolean;
+    }): Promise<ICustomerPhone>;
+    updateLabel(phoneId: string, customerId: string, labelId: string): Promise<ICustomerPhone>;
+    setPrimary(phoneId: string, customerId: string): Promise<void>;
+    remove(phoneId: string, customerId: string): Promise<void>;
+}
+
+declare class CustomerTagModel {
+    private readonly store;
+    constructor(store: IStoreAdapter);
+    list(customerId: string): Promise<string[]>;
+    add(customerId: string, tag: string): Promise<void>;
+    remove(customerId: string, tag: string): Promise<void>;
+}
+
+declare class CustomersModule implements IFonderieModule {
+    private store;
+    private config;
+    private bus?;
+    readonly name = "@fonderie/customers";
+    readonly deps: string[];
+    constructor(store: IStoreAdapter, config?: ICustomersConfig, bus?: EventBus | undefined);
+    install(app: IFonderieApp): void;
+}
+
+export { CustomerAddressModel, CustomerEmailModel, CustomerModel, CustomerNoteModel, CustomerPhoneModel, CustomerTagModel, type CustomersEventKey, CustomersModule, EVENT_KEYS, IAddress, type IAddressDTO, ICustomer, ICustomerAddress, type ICustomerAddressDTO, type ICustomerDTO, ICustomerDetail, type ICustomerDetailDTO, ICustomerEmail, type ICustomerEmailDTO, ICustomerNote, type ICustomerNoteDTO, ICustomerPhone, type ICustomerPhoneDTO, ICustomerTag, type ICustomerTagDTO, type ICustomersConfig, toAddressDTO, toCustomerAddressDTO, toCustomerDTO, toCustomerDetailDTO, toCustomerEmailDTO, toCustomerNoteDTO, toCustomerPhoneDTO, toCustomerTagDTO };