@fonderie/customers 1.0.0

package/dist/migrations/sql/010_customer_labels.sql

@@ -0,0 +1,75 @@
+-- fonderie_customer_label_type enum
+CREATE TYPE fonderie_customer_label_type AS ENUM ('email', 'phone', 'address');
+
+-- shared label catalog
+CREATE TABLE IF NOT EXISTS fonderie_customer_labels (
+	id         UUID                         PRIMARY KEY DEFAULT gen_random_uuid(),
+	type       fonderie_customer_label_type NOT NULL,
+	value      TEXT                         NOT NULL,
+	created_at TIMESTAMPTZ                  NOT NULL DEFAULT now(),
+	CONSTRAINT uq_fcl_type_value UNIQUE (type, value)
+);
+
+-- seed defaults
+INSERT INTO fonderie_customer_labels (type, value) VALUES
+	('email',   'work'),
+	('email',   'personal'),
+	('email',   'billing'),
+	('phone',   'mobile'),
+	('phone',   'office'),
+	('phone',   'home'),
+	('phone',   'fax'),
+	('address', 'service'),
+	('address', 'billing'),
+	('address', 'other')
+ON CONFLICT (type, value) DO NOTHING;
+
+-- promote any non-standard values already stored in existing rows
+INSERT INTO fonderie_customer_labels (type, value)
+	SELECT DISTINCT 'email'::fonderie_customer_label_type, label
+	FROM fonderie_customer_emails
+	WHERE label IS NOT NULL
+ON CONFLICT (type, value) DO NOTHING;
+
+INSERT INTO fonderie_customer_labels (type, value)
+	SELECT DISTINCT 'phone'::fonderie_customer_label_type, label
+	FROM fonderie_customer_phones
+	WHERE label IS NOT NULL
+ON CONFLICT (type, value) DO NOTHING;
+
+INSERT INTO fonderie_customer_labels (type, value)
+	SELECT DISTINCT 'address'::fonderie_customer_label_type, label
+	FROM fonderie_customer_addresses
+	WHERE label IS NOT NULL
+ON CONFLICT (type, value) DO NOTHING;
+
+-- add label_id FK columns
+ALTER TABLE fonderie_customer_emails
+	ADD COLUMN IF NOT EXISTS label_id UUID REFERENCES fonderie_customer_labels(id);
+
+ALTER TABLE fonderie_customer_phones
+	ADD COLUMN IF NOT EXISTS label_id UUID REFERENCES fonderie_customer_labels(id);
+
+ALTER TABLE fonderie_customer_addresses
+	ADD COLUMN IF NOT EXISTS label_id UUID REFERENCES fonderie_customer_labels(id);
+
+-- backfill label_id from existing label text
+UPDATE fonderie_customer_emails e
+	SET label_id = l.id
+	FROM fonderie_customer_labels l
+	WHERE l.type = 'email' AND l.value = e.label;
+
+UPDATE fonderie_customer_phones p
+	SET label_id = l.id
+	FROM fonderie_customer_labels l
+	WHERE l.type = 'phone' AND l.value = p.label;
+
+UPDATE fonderie_customer_addresses a
+	SET label_id = l.id
+	FROM fonderie_customer_labels l
+	WHERE l.type = 'address' AND l.value = a.label;
+
+-- mark old text columns as deprecated
+COMMENT ON COLUMN fonderie_customer_emails.label    IS 'deprecated: use label_id → fonderie_customer_labels';
+COMMENT ON COLUMN fonderie_customer_phones.label    IS 'deprecated: use label_id → fonderie_customer_labels';
+COMMENT ON COLUMN fonderie_customer_addresses.label IS 'deprecated: use label_id → fonderie_customer_labels';

package/dist/migrations/sql/011_label_fk_set_null.sql

@@ -0,0 +1,17 @@
+-- Allow label catalog entries to be deleted even when in use.
+-- Affected phone/email/address rows keep their label text column; label_id becomes NULL.
+
+ALTER TABLE fonderie_customer_phones
+    DROP CONSTRAINT IF EXISTS fonderie_customer_phones_label_id_fkey,
+    ADD CONSTRAINT fonderie_customer_phones_label_id_fkey
+        FOREIGN KEY (label_id) REFERENCES fonderie_customer_labels(id) ON DELETE SET NULL;
+
+ALTER TABLE fonderie_customer_emails
+    DROP CONSTRAINT IF EXISTS fonderie_customer_emails_label_id_fkey,
+    ADD CONSTRAINT fonderie_customer_emails_label_id_fkey
+        FOREIGN KEY (label_id) REFERENCES fonderie_customer_labels(id) ON DELETE SET NULL;
+
+ALTER TABLE fonderie_customer_addresses
+    DROP CONSTRAINT IF EXISTS fonderie_customer_addresses_label_id_fkey,
+    ADD CONSTRAINT fonderie_customer_addresses_label_id_fkey
+        FOREIGN KEY (label_id) REFERENCES fonderie_customer_labels(id) ON DELETE SET NULL;

package/dist/types.cjs

@@ -0,0 +1,19 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/types.ts
+var types_exports = {};
+module.exports = __toCommonJS(types_exports);
+//# sourceMappingURL=types.cjs.map

package/dist/types.cjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/types.ts"],"sourcesContent":["export type CustomerType = 'individual' | 'business';\nexport type CustomerSex = 'UNKNOWN' | 'MALE' | 'FEMALE';\nexport type CustomerLabelType = 'email' | 'phone' | 'address';\n\n/** @deprecated resolved dynamically via fonderie_customer_labels */\nexport type EmailLabel = 'work' | 'personal' | 'billing';\n/** @deprecated resolved dynamically via fonderie_customer_labels */\nexport type PhoneLabel = 'mobile' | 'office' | 'home' | 'fax';\n/** @deprecated resolved dynamically via fonderie_customer_labels */\nexport type AddressLabel = 'service' | 'billing' | 'other';\n\nexport interface ICustomerLabel {\n\tid: string;\n\ttype: CustomerLabelType;\n\tvalue: string;\n\tcreatedAt: string;\n}\n\nexport interface ICustomer {\n\tid: string;\n\tworkspaceId: string;\n\ttype: CustomerType;\n\tsex: CustomerSex;\n\tfirstName: string | null;\n\tlastName: string | null;\n\tcompanyName: string | null;\n\tavatarUrl: string | null;\n\tlocale: string;\n\treferenceCode: string | null;\n\tisBlacklisted: boolean;\n\tblacklistReason: string | null;\n\tcreatedBy: string | null;\n\tcreatedAt: string;\n\tupdatedAt: string;\n}\n\nexport interface ICustomerEmail {\n\tid: string;\n\tcustomerId: string;\n\temail: string;\n\tlabelId: string;\n\tlabel: string;\n\tisPrimary: boolean;\n\tcreatedAt: string;\n}\n\nexport interface ICustomerPhone {\n\tid: string;\n\tcustomerId: string;\n\tphone: string;\n\tlabelId: string;\n\tlabel: string;\n\tisPrimary: boolean;\n\tcreatedAt: string;\n}\n\nexport interface IAddress {\n\tid: string;\n\tcountryIso: string;\n\tsubdivision1Iso: string | null;\n\tsubdivision2Iso: string | null;\n\tzipPostalCode: string;\n\tunit: string | null;\n\tline1: string | null;\n\tline2: string | null;\n}\n\nexport interface ICustomerAddress {\n\taddrId: string;\n\tcustomerId: string;\n\tlabelId: string;\n\tlabel: string;\n\tisPrimary: boolean;\n\taddress: IAddress;\n}\n\nexport interface ICustomerNote {\n\tid: string;\n\tcustomerId: string;\n\tauthorId: string | null;\n\tbody: string;\n\tcreatedAt: string;\n\tupdatedAt: string;\n}\n\nexport interface ICustomerTag {\n\tcustomerId: string;\n\ttag: string;\n}\n\nexport interface ICustomerRelationship {\n\tid: string;\n\tworkspaceId: string;\n\tcustomerId: string;\n\trelatedId: string;\n\trelationship: string;\n\tisPrimary: boolean;\n\tcreatedAt: string;\n}\n\nexport interface ICustomerShallow extends ICustomer {\n\temails: ICustomerEmail[];\n\tphones: ICustomerPhone[];\n\taddresses: ICustomerAddress[];\n\tnotes: ICustomerNote[];\n\ttags: string[];\n}\n\nexport interface ICustomerRelationshipExpanded {\n\tid: string;\n\tworkspaceId: string;\n\tcustomerId: string;\n\trelationship: string;\n\tisPrimary: boolean;\n\tcreatedAt: string;\n\tcustomer: ICustomerShallow;\n}\n\nexport interface ICustomerDetail extends ICustomer {\n\temails: ICustomerEmail[];\n\tphones: ICustomerPhone[];\n\taddresses: ICustomerAddress[];\n\tnotes: ICustomerNote[];\n\trelationships: ICustomerRelationshipExpanded[];\n\ttags: string[];\n}\n\n// Depth-2 variants: depth-1 customers have their own relationships resolved.\nexport interface ICustomerShallowD2 extends ICustomerShallow {\n\trelationships: ICustomerRelationshipExpanded[];\n}\n\nexport interface ICustomerRelationshipExpandedD2 extends Omit<ICustomerRelationshipExpanded, 'customer'> {\n\tcustomer: ICustomerShallowD2;\n}\n\nexport interface ICustomerDetailD2 extends Omit<ICustomerDetail, 'relationships'> {\n\trelationships: ICustomerRelationshipExpandedD2[];\n}\n"],"mappings":";;;;;;;;;;;;;;;;AAAA;AAAA;","names":[]}

package/dist/types.d.cts

@@ -0,0 +1,124 @@
+type CustomerType = 'individual' | 'business';
+type CustomerSex = 'UNKNOWN' | 'MALE' | 'FEMALE';
+type CustomerLabelType = 'email' | 'phone' | 'address';
+/** @deprecated resolved dynamically via fonderie_customer_labels */
+type EmailLabel = 'work' | 'personal' | 'billing';
+/** @deprecated resolved dynamically via fonderie_customer_labels */
+type PhoneLabel = 'mobile' | 'office' | 'home' | 'fax';
+/** @deprecated resolved dynamically via fonderie_customer_labels */
+type AddressLabel = 'service' | 'billing' | 'other';
+interface ICustomerLabel {
+    id: string;
+    type: CustomerLabelType;
+    value: string;
+    createdAt: string;
+}
+interface ICustomer {
+    id: string;
+    workspaceId: string;
+    type: CustomerType;
+    sex: CustomerSex;
+    firstName: string | null;
+    lastName: string | null;
+    companyName: string | null;
+    avatarUrl: string | null;
+    locale: string;
+    referenceCode: string | null;
+    isBlacklisted: boolean;
+    blacklistReason: string | null;
+    createdBy: string | null;
+    createdAt: string;
+    updatedAt: string;
+}
+interface ICustomerEmail {
+    id: string;
+    customerId: string;
+    email: string;
+    labelId: string;
+    label: string;
+    isPrimary: boolean;
+    createdAt: string;
+}
+interface ICustomerPhone {
+    id: string;
+    customerId: string;
+    phone: string;
+    labelId: string;
+    label: string;
+    isPrimary: boolean;
+    createdAt: string;
+}
+interface IAddress {
+    id: string;
+    countryIso: string;
+    subdivision1Iso: string | null;
+    subdivision2Iso: string | null;
+    zipPostalCode: string;
+    unit: string | null;
+    line1: string | null;
+    line2: string | null;
+}
+interface ICustomerAddress {
+    addrId: string;
+    customerId: string;
+    labelId: string;
+    label: string;
+    isPrimary: boolean;
+    address: IAddress;
+}
+interface ICustomerNote {
+    id: string;
+    customerId: string;
+    authorId: string | null;
+    body: string;
+    createdAt: string;
+    updatedAt: string;
+}
+interface ICustomerTag {
+    customerId: string;
+    tag: string;
+}
+interface ICustomerRelationship {
+    id: string;
+    workspaceId: string;
+    customerId: string;
+    relatedId: string;
+    relationship: string;
+    isPrimary: boolean;
+    createdAt: string;
+}
+interface ICustomerShallow extends ICustomer {
+    emails: ICustomerEmail[];
+    phones: ICustomerPhone[];
+    addresses: ICustomerAddress[];
+    notes: ICustomerNote[];
+    tags: string[];
+}
+interface ICustomerRelationshipExpanded {
+    id: string;
+    workspaceId: string;
+    customerId: string;
+    relationship: string;
+    isPrimary: boolean;
+    createdAt: string;
+    customer: ICustomerShallow;
+}
+interface ICustomerDetail extends ICustomer {
+    emails: ICustomerEmail[];
+    phones: ICustomerPhone[];
+    addresses: ICustomerAddress[];
+    notes: ICustomerNote[];
+    relationships: ICustomerRelationshipExpanded[];
+    tags: string[];
+}
+interface ICustomerShallowD2 extends ICustomerShallow {
+    relationships: ICustomerRelationshipExpanded[];
+}
+interface ICustomerRelationshipExpandedD2 extends Omit<ICustomerRelationshipExpanded, 'customer'> {
+    customer: ICustomerShallowD2;
+}
+interface ICustomerDetailD2 extends Omit<ICustomerDetail, 'relationships'> {
+    relationships: ICustomerRelationshipExpandedD2[];
+}
+
+export type { AddressLabel, CustomerLabelType, CustomerSex, CustomerType, EmailLabel, IAddress, ICustomer, ICustomerAddress, ICustomerDetail, ICustomerDetailD2, ICustomerEmail, ICustomerLabel, ICustomerNote, ICustomerPhone, ICustomerRelationship, ICustomerRelationshipExpanded, ICustomerRelationshipExpandedD2, ICustomerShallow, ICustomerShallowD2, ICustomerTag, PhoneLabel };

package/dist/types.d.ts

@@ -0,0 +1,124 @@
+type CustomerType = 'individual' | 'business';
+type CustomerSex = 'UNKNOWN' | 'MALE' | 'FEMALE';
+type CustomerLabelType = 'email' | 'phone' | 'address';
+/** @deprecated resolved dynamically via fonderie_customer_labels */
+type EmailLabel = 'work' | 'personal' | 'billing';
+/** @deprecated resolved dynamically via fonderie_customer_labels */
+type PhoneLabel = 'mobile' | 'office' | 'home' | 'fax';
+/** @deprecated resolved dynamically via fonderie_customer_labels */
+type AddressLabel = 'service' | 'billing' | 'other';
+interface ICustomerLabel {
+    id: string;
+    type: CustomerLabelType;
+    value: string;
+    createdAt: string;
+}
+interface ICustomer {
+    id: string;
+    workspaceId: string;
+    type: CustomerType;
+    sex: CustomerSex;
+    firstName: string | null;
+    lastName: string | null;
+    companyName: string | null;
+    avatarUrl: string | null;
+    locale: string;
+    referenceCode: string | null;
+    isBlacklisted: boolean;
+    blacklistReason: string | null;
+    createdBy: string | null;
+    createdAt: string;
+    updatedAt: string;
+}
+interface ICustomerEmail {
+    id: string;
+    customerId: string;
+    email: string;
+    labelId: string;
+    label: string;
+    isPrimary: boolean;
+    createdAt: string;
+}
+interface ICustomerPhone {
+    id: string;
+    customerId: string;
+    phone: string;
+    labelId: string;
+    label: string;
+    isPrimary: boolean;
+    createdAt: string;
+}
+interface IAddress {
+    id: string;
+    countryIso: string;
+    subdivision1Iso: string | null;
+    subdivision2Iso: string | null;
+    zipPostalCode: string;
+    unit: string | null;
+    line1: string | null;
+    line2: string | null;
+}
+interface ICustomerAddress {
+    addrId: string;
+    customerId: string;
+    labelId: string;
+    label: string;
+    isPrimary: boolean;
+    address: IAddress;
+}
+interface ICustomerNote {
+    id: string;
+    customerId: string;
+    authorId: string | null;
+    body: string;
+    createdAt: string;
+    updatedAt: string;
+}
+interface ICustomerTag {
+    customerId: string;
+    tag: string;
+}
+interface ICustomerRelationship {
+    id: string;
+    workspaceId: string;
+    customerId: string;
+    relatedId: string;
+    relationship: string;
+    isPrimary: boolean;
+    createdAt: string;
+}
+interface ICustomerShallow extends ICustomer {
+    emails: ICustomerEmail[];
+    phones: ICustomerPhone[];
+    addresses: ICustomerAddress[];
+    notes: ICustomerNote[];
+    tags: string[];
+}
+interface ICustomerRelationshipExpanded {
+    id: string;
+    workspaceId: string;
+    customerId: string;
+    relationship: string;
+    isPrimary: boolean;
+    createdAt: string;
+    customer: ICustomerShallow;
+}
+interface ICustomerDetail extends ICustomer {
+    emails: ICustomerEmail[];
+    phones: ICustomerPhone[];
+    addresses: ICustomerAddress[];
+    notes: ICustomerNote[];
+    relationships: ICustomerRelationshipExpanded[];
+    tags: string[];
+}
+interface ICustomerShallowD2 extends ICustomerShallow {
+    relationships: ICustomerRelationshipExpanded[];
+}
+interface ICustomerRelationshipExpandedD2 extends Omit<ICustomerRelationshipExpanded, 'customer'> {
+    customer: ICustomerShallowD2;
+}
+interface ICustomerDetailD2 extends Omit<ICustomerDetail, 'relationships'> {
+    relationships: ICustomerRelationshipExpandedD2[];
+}
+
+export type { AddressLabel, CustomerLabelType, CustomerSex, CustomerType, EmailLabel, IAddress, ICustomer, ICustomerAddress, ICustomerDetail, ICustomerDetailD2, ICustomerEmail, ICustomerLabel, ICustomerNote, ICustomerPhone, ICustomerRelationship, ICustomerRelationshipExpanded, ICustomerRelationshipExpandedD2, ICustomerShallow, ICustomerShallowD2, ICustomerTag, PhoneLabel };

package/dist/types.js

@@ -0,0 +1 @@
+//# sourceMappingURL=types.js.map

package/dist/types.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}

package/package.json

@@ -0,0 +1,85 @@
+{
+	"name": "@fonderie/customers",
+	"version": "1.0.0",
+	"description": "Workspace-scoped customer records — individuals and businesses with multiple emails, phones, addresses, notes, and tags.",
+	"keywords": [
+		"fonderie-js",
+		"customers",
+		"saas",
+		"typescript"
+	],
+	"license": "MIT",
+	"type": "module",
+	"engines": {
+		"node": ">=20"
+	},
+	"exports": {
+		".": {
+			"types": "./dist/index.d.ts",
+			"import": "./dist/index.js",
+			"require": "./dist/index.cjs"
+		},
+		"./types": {
+			"types": "./dist/types.d.ts",
+			"import": "./dist/types.js",
+			"require": "./dist/types.cjs"
+		},
+		"./migrations": {
+			"types": "./dist/migrations/index.d.ts",
+			"import": "./dist/migrations/index.js"
+		}
+	},
+	"main": "./dist/index.cjs",
+	"module": "./dist/index.js",
+	"types": "./dist/index.d.ts",
+	"scripts": {
+		"build": "tsup && node -e \"require('node:fs').cpSync('src/migrations/sql', 'dist/migrations/sql', {recursive:true})\"",
+		"dev": "tsup --watch",
+		"typecheck": "tsc --noEmit",
+		"test": "tsx --test src/__tests__/*.test.ts",
+		"lint": "biome lint src",
+		"format": "biome format --write src",
+		"check": "biome check --write src"
+	},
+	"peerDependencies": {
+		"@fonderie/core": "^0.1.0",
+		"@fonderie/events": "^1.0.0",
+		"@fonderie/store": "^0.1.0",
+		"@fonderie/workspaces": "^1.0.0"
+	},
+	"peerDependenciesMeta": {
+		"@fonderie/events": {
+			"optional": true
+		},
+		"@fonderie/workspaces": {
+			"optional": true
+		}
+	},
+	"devDependencies": {
+		"@fonderie/core": "../core",
+		"@fonderie/events": "../events",
+		"@fonderie/store": "../store",
+		"@fonderie/workspaces": "../workspaces",
+		"@types/node": "^25.6.0",
+		"tsup": "^8.5.1",
+		"tsx": "^4.21.0",
+		"typescript": "^6.0.3"
+	},
+	"publishConfig": {
+		"access": "public"
+	},
+	"files": [
+		"dist",
+		"LICENSE",
+		"README.md"
+	],
+	"repository": {
+		"type": "git",
+		"url": "git+https://github.com/fonderie-js/sdk.git",
+		"directory": "packages/customers"
+	},
+	"homepage": "https://github.com/fonderie-js/sdk/tree/main/packages/customers#readme",
+	"bugs": {
+		"url": "https://github.com/fonderie-js/sdk/issues"
+	}
+}