@sqrzro/addon-addresses 4.0.0-alpha.1

package/LICENSE

@@ -0,0 +1,5 @@
+Copyright 2024 Richard Carter
+
+Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

package/dist/forms/AddressForm/index.d.ts

@@ -0,0 +1,7 @@
+import { Default } from '@sqrzro/ui/forms';
+import type { AddressFormFields } from './interfaces';
+interface AddressFormProps {
+    defaults?: Default<AddressFormFields> | null;
+}
+declare function AddressForm({ defaults }: Readonly<AddressFormProps>): React.ReactElement;
+export default AddressForm;

package/dist/forms/AddressForm/index.js

@@ -0,0 +1,14 @@
+'use client';
+import { jsx as _jsx, jsxs as _jsxs } from "react/jsx-runtime";
+import { EditableForm, EditableTextFormField, useEditableForm } from '@sqrzro/ui/forms';
+import { formatPostcode } from '@sqrzro/utility';
+import submit from './server';
+function AddressForm({ defaults }) {
+    const { fieldProps, formProps } = useEditableForm({
+        defaults: defaults ?? {},
+        onSubmit: submit,
+        title: 'Address',
+    });
+    return (_jsxs(EditableForm, { ...formProps, children: [_jsx(EditableTextFormField, { ...fieldProps('line1', 'Line 1') }), _jsx(EditableTextFormField, { ...fieldProps('line2', 'Line 2') }), _jsx(EditableTextFormField, { ...fieldProps('city') }), _jsx(EditableTextFormField, { ...fieldProps('county') }), _jsx(EditableTextFormField, { ...fieldProps('postcode'), renderValue: formatPostcode })] }));
+}
+export default AddressForm;

package/dist/forms/AddressForm/interfaces.d.ts

@@ -0,0 +1,10 @@
+import { AddressID } from '../../utility/ids';
+export interface AddressFormFields {
+    city: string;
+    county: string;
+    id: AddressID;
+    line1: string;
+    line2: string;
+    postcode: string;
+    subjectID: string;
+}

package/dist/forms/AddressForm/interfaces.js

@@ -0,0 +1 @@
+export {};

package/dist/forms/AddressForm/server.d.ts

@@ -0,0 +1,5 @@
+import { FormResponse } from '@sqrzro/server/forms';
+import type { Address } from '../../utility/interfaces';
+import type { AddressFormFields } from './interfaces';
+declare function submit(formData: AddressFormFields): FormResponse<Address>;
+export default submit;

package/dist/forms/AddressForm/server.js

@@ -0,0 +1,29 @@
+'use server';
+import { submitForm } from '@sqrzro/server/forms';
+import { z } from 'zod';
+import AddressRepository from '../../repositories/AddressRepository';
+import getPostcodeRule from '../../rules/postcode';
+const schema = z.object({
+    city: z.string().min(4).max(20).nonoptional(),
+    county: z.string().min(4).max(20).nonoptional(),
+    id: AddressRepository.getIDRule('id').validator.optional(),
+    line1: z.string().min(4).max(30).nonoptional(),
+    line2: z.string().max(30).nullable().optional(),
+    subjectID: z.string().nonoptional(),
+    postcode: getPostcodeRule().validator.nonoptional(),
+});
+async function fn(data) {
+    const { id, ...rest } = data;
+    if (typeof id !== 'undefined') {
+        return AddressRepository.update({ id, ...rest });
+    }
+    return AddressRepository.create(rest);
+}
+async function submit(formData) {
+    return submitForm({
+        fn,
+        formData,
+        schema,
+    });
+}
+export default submit;

package/dist/index.d.ts

@@ -0,0 +1,6 @@
+export * from './utility/ids';
+export * from './utility/interfaces';
+export { addressTable } from './schema';
+export { default as AddressForm } from './forms/AddressForm';
+export { default as AddressRepository } from './repositories/AddressRepository';
+export { withAddresses, withAddressesConfig } from './repository';

package/dist/index.js

@@ -0,0 +1,6 @@
+export * from './utility/ids';
+export * from './utility/interfaces';
+export { addressTable } from './schema';
+export { default as AddressForm } from './forms/AddressForm';
+export { default as AddressRepository } from './repositories/AddressRepository';
+export { withAddresses, withAddressesConfig } from './repository';

package/dist/interfaces.d.ts

@@ -0,0 +1,2 @@
+export * from './utility/ids';
+export * from './utility/interfaces';

package/dist/interfaces.js

@@ -0,0 +1,2 @@
+export * from './utility/ids';
+export * from './utility/interfaces';

package/dist/repositories/AddressRepository.d.ts

@@ -0,0 +1,174 @@
+import { AddressID } from '../utility/ids';
+import type { Address, AddressData, AddressFilters } from '../utility/interfaces';
+declare function ensureBySubjectID(subjectID: string): Promise<Address>;
+declare function getBySubjectID(subjectID: string): Promise<Address | null>;
+declare const _default: {
+    ensureBySubjectID: typeof ensureBySubjectID;
+    getBySubjectID: typeof getBySubjectID;
+    create: (data: AddressData) => Promise<{
+        id: `add_${string}`;
+        subjectID: string;
+        line1: string;
+        line2: string | null;
+        city: string;
+        county: string;
+        postcode: string;
+        createdAt: Date;
+        deletedAt: Date | null;
+    }>;
+    delete: (id: `add_${string}`) => Promise<void>;
+    ensureByID: (id: `add_${string}`, fnConfig?: import("@sqrzro/server/database").SelectFunctionConfig<Partial<AddressFilters> | null, never> | undefined) => Promise<{
+        id: `add_${string}`;
+        subjectID: string;
+        line1: string;
+        line2: string | null;
+        city: string;
+        county: string;
+        postcode: string;
+        createdAt: Date;
+        deletedAt: Date | null;
+    }>;
+    ensureByIndex: <K extends string>(key: K, value: any, fnConfig?: import("@sqrzro/server/database").SelectFunctionConfig<Partial<AddressFilters> | null, never> | undefined) => Promise<{
+        id: `add_${string}`;
+        subjectID: string;
+        line1: string;
+        line2: string | null;
+        city: string;
+        county: string;
+        postcode: string;
+        createdAt: Date;
+        deletedAt: Date | null;
+    }>;
+    ensureFromParams: (params?: Promise<Record<string, string>> | Record<string, string> | null, fnConfig?: import("@sqrzro/server/database").SelectFunctionConfig<Partial<AddressFilters> | null, never> | undefined) => Promise<{
+        id: `add_${string}`;
+        subjectID: string;
+        line1: string;
+        line2: string | null;
+        city: string;
+        county: string;
+        postcode: string;
+        createdAt: Date;
+        deletedAt: Date | null;
+    }>;
+    ensureFromSearchParams: (searchParams?: Promise<Record<string, string>> | Record<string, string> | null, fnConfig?: import("@sqrzro/server/database").SelectFunctionConfig<Partial<AddressFilters> | null, never> | undefined, key?: string) => Promise<{
+        id: `add_${string}`;
+        subjectID: string;
+        line1: string;
+        line2: string | null;
+        city: string;
+        county: string;
+        postcode: string;
+        createdAt: Date;
+        deletedAt: Date | null;
+    }>;
+    ensureID: (id: string | null | undefined) => `add_${string}`;
+    ensureIDFromParams: (params?: Promise<Record<string, string>> | Record<string, string> | null) => Promise<`add_${string}`>;
+    ensureIDFromSearchParams: (searchParams?: Promise<Record<string, string>> | Record<string, string> | null, key?: string) => Promise<`add_${string}`>;
+    getAll: (fnConfig?: import("@sqrzro/server/database").SelectFunctionConfig<Partial<AddressFilters> | null, never> | undefined) => Promise<{
+        id: `add_${string}`;
+        subjectID: string;
+        line1: string;
+        line2: string | null;
+        city: string;
+        county: string;
+        postcode: string;
+        createdAt: Date;
+        deletedAt: Date | null;
+    }[]>;
+    getAutocomplete: {
+        ({ id, }: {
+            id?: `add_${string}` | undefined;
+        }, fnConfig?: import("@sqrzro/server/database").SelectFunctionConfig<Partial<AddressFilters> | null, never> | undefined): Promise<null>;
+        ({ search, }: {
+            search?: string;
+        }, fnConfig?: import("@sqrzro/server/database").SelectFunctionConfig<Partial<AddressFilters> | null, never> | undefined): Promise<never[]>;
+    };
+    getByID: (id: `add_${string}`, fnConfig?: import("@sqrzro/server/database").SelectFunctionConfig<Partial<AddressFilters> | null, never> | undefined) => Promise<{
+        id: `add_${string}`;
+        subjectID: string;
+        line1: string;
+        line2: string | null;
+        city: string;
+        county: string;
+        postcode: string;
+        createdAt: Date;
+        deletedAt: Date | null;
+    } | null>;
+    getByIndex: <K extends string>(key: K, value: any, fnConfig?: import("@sqrzro/server/database").SelectFunctionConfig<Partial<AddressFilters> | null, never> | undefined) => Promise<{
+        id: `add_${string}`;
+        subjectID: string;
+        line1: string;
+        line2: string | null;
+        city: string;
+        county: string;
+        postcode: string;
+        createdAt: Date;
+        deletedAt: Date | null;
+    } | null>;
+    getDropdown: (fnConfig?: import("@sqrzro/server/database").SelectFunctionConfig<Partial<AddressFilters> | null, never> | undefined) => Promise<never[]>;
+    getFromParams: (params?: Promise<Record<string, string>> | Record<string, string> | null, fnConfig?: import("@sqrzro/server/database").SelectFunctionConfig<Partial<AddressFilters> | null, never> | undefined) => Promise<{
+        id: `add_${string}`;
+        subjectID: string;
+        line1: string;
+        line2: string | null;
+        city: string;
+        county: string;
+        postcode: string;
+        createdAt: Date;
+        deletedAt: Date | null;
+    } | null>;
+    getFromSearchParams: (searchParams?: Promise<Record<string, string>> | Record<string, string> | null, fnConfig?: import("@sqrzro/server/database").SelectFunctionConfig<Partial<AddressFilters> | null, never> | undefined, key?: string) => Promise<{
+        id: `add_${string}`;
+        subjectID: string;
+        line1: string;
+        line2: string | null;
+        city: string;
+        county: string;
+        postcode: string;
+        createdAt: Date;
+        deletedAt: Date | null;
+    } | null>;
+    getIDFromParams: (params?: Promise<Record<string, string>> | Record<string, string> | null) => Promise<`add_${string}` | null>;
+    getIDFromSearchParams: (searchParams?: Promise<Record<string, string>> | Record<string, string> | null, key?: string) => Promise<`add_${string}` | null>;
+    getIDRule: (idKey: string) => import("@sqrzro/server/database").ValidationRule<import("zod").ZodTemplateLiteral<`add_${string}`>, <T>(data: T) => Promise<T & Record<string, {
+        id: `add_${string}`;
+        subjectID: string;
+        line1: string;
+        line2: string | null;
+        city: string;
+        county: string;
+        postcode: string;
+        createdAt: Date;
+        deletedAt: Date | null;
+    }>>, undefined>;
+    getPaginated: (fnConfig?: import("@sqrzro/server/database").PaginatedFunctionConfig<Partial<AddressFilters> | null, never> | undefined) => Promise<import("@sqrzro/server/utility").Paginated<{
+        id: `add_${string}`;
+        subjectID: string;
+        line1: string;
+        line2: string | null;
+        city: string;
+        county: string;
+        postcode: string;
+        createdAt: Date;
+        deletedAt: Date | null;
+    }>>;
+    guardID: {
+        (id: (string | null | undefined)[]): `add_${string}`[];
+        (id: string | null | undefined): `add_${string}` | null;
+    };
+    undelete: (id: `add_${string}`) => Promise<void>;
+    update: (data: Partial<AddressData> & {
+        id: AddressID;
+    }) => Promise<{
+        id: `add_${string}`;
+        subjectID: string;
+        line1: string;
+        line2: string | null;
+        city: string;
+        county: string;
+        postcode: string;
+        createdAt: Date;
+        deletedAt: Date | null;
+    }>;
+};
+export default _default;

package/dist/repositories/AddressRepository.js

@@ -0,0 +1,72 @@
+import { db } from '@sqrzro/server/database';
+import { createRepository } from '@sqrzro/server/database';
+import { generateID } from '@sqrzro/server/utility';
+import { pick } from '@sqrzro/utility';
+import { and, eq, inArray } from 'drizzle-orm';
+import { ADDRESS_PREFIX } from '../utility/ids';
+import { addressTable } from '../schema';
+const fillable = [
+    'city',
+    'county',
+    'line1',
+    'line2',
+    'postcode',
+    'subjectID',
+];
+const AddressRepository = createRepository({
+    async applyFilters(filters) {
+        const conditions = [];
+        if (filters?.id) {
+            conditions.push(inArray(addressTable.id, filters.id));
+        }
+        if (filters?.subjectID) {
+            if (Array.isArray(filters.subjectID)) {
+                conditions.push(inArray(addressTable.subjectID, filters.subjectID));
+            }
+            else {
+                conditions.push(eq(addressTable.subjectID, filters.subjectID));
+            }
+        }
+        return conditions;
+    },
+    indexes: { id: addressTable.id, subjectID: addressTable.subjectID },
+    async makeQuery(conditions, config) {
+        return db
+            .select()
+            .from(addressTable)
+            .where(and(...conditions))
+            .limit(config.limit)
+            .offset(config.offset);
+    },
+    async makeDeleteMutation(id) {
+        await db.update(addressTable).set({ deletedAt: new Date() }).where(eq(addressTable.id, id));
+    },
+    async makeUndeleteMutation(id) {
+        await db.update(addressTable).set({ deletedAt: null }).where(eq(addressTable.id, id));
+    },
+    async makeInsertMutation(data) {
+        const values = {
+            id: generateID(ADDRESS_PREFIX),
+            ...pick(data, fillable),
+        };
+        const [result] = await db.insert(addressTable).values(values).returning();
+        return result;
+    },
+    async makeUpdateMutation(data) {
+        const [result] = await db
+            .update(addressTable)
+            .set(data)
+            .where(eq(addressTable.id, data.id))
+            .returning();
+        return result;
+    },
+    paramKey: 'address',
+    prefix: ADDRESS_PREFIX,
+});
+function ensureBySubjectID(subjectID) {
+    return AddressRepository.ensureByIndex('subjectID', subjectID);
+}
+function getBySubjectID(subjectID) {
+    return AddressRepository.getByIndex('subjectID', subjectID);
+}
+export default { ...AddressRepository, ensureBySubjectID, getBySubjectID };

package/dist/repository/index.d.ts

@@ -0,0 +1,17 @@
+import { RepositoryConfig, UnwrapModel } from '@sqrzro/server/database';
+import { Address, AddressData, WithAddress } from '../utility/interfaces';
+interface AddressesRepositoryConfig {
+}
+export declare function withAddressesConfig<T extends RepositoryConfig>(cfg: T): T & {
+    makeQuery: (conditions: import("@sqrzro/server/database").QueryConditions, config: import("@sqrzro/server/database").QueryConfig) => Promise<WithAddress<UnwrapModel<T>>[]>;
+};
+export declare function withAddresses(config: AddressesRepositoryConfig): <TRepo extends {
+    ensureByID: (...args: any[]) => any;
+    update: (...args: any[]) => any;
+}>(repository: TRepo) => TRepo & {
+    attachAddress: (subjectID: string, data: AddressData) => Promise<Address>;
+    withAddress: <T extends {
+        id: string;
+    }>(subject: T) => Promise<WithAddress<T>>;
+};
+export {};

package/dist/repository/index.js

@@ -0,0 +1,42 @@
+import AddressRepository from '../repositories/AddressRepository';
+export function withAddressesConfig(cfg) {
+    return {
+        ...cfg,
+        makeQuery: async (...args) => {
+            const results = await cfg.makeQuery?.(...args);
+            const ids = results?.map((item) => item.id) ?? [];
+            const addresses = await AddressRepository.getAll({ filters: { subjectID: ids } });
+            return (results?.map((item) => ({
+                ...item,
+                address: addresses.find((a) => a.subjectID === item.id) ?? null,
+            })) ?? []);
+        },
+    };
+}
+export function withAddresses(config) {
+    return function (repository) {
+        async function attachAddress(subjectID, data) {
+            const model = (await repository.ensureByID(subjectID));
+            if (model.addressID) {
+                return AddressRepository.update({ ...data, id: model.addressID });
+            }
+            const address = await AddressRepository.create(data);
+            await repository.update({ id: subjectID, addressID: address.id });
+            return address;
+        }
+        async function withAddress(subject) {
+            const [address] = await AddressRepository.getAll({
+                filters: { subjectID: subject.id },
+            });
+            return {
+                ...subject,
+                address: address ?? null,
+            };
+        }
+        return {
+            ...repository,
+            attachAddress,
+            withAddress,
+        };
+    };
+}

package/dist/rules/postcode.d.ts

@@ -0,0 +1,3 @@
+import z from 'zod';
+declare function getPostcodeRule(): import("@sqrzro/server/database").ValidationRule<z.ZodPreprocess<z.ZodNonOptional<z.ZodString>>, undefined, undefined>;
+export default getPostcodeRule;

package/dist/rules/postcode.js

@@ -0,0 +1,16 @@
+import { createRule } from '@sqrzro/server/forms';
+import z from 'zod';
+function preprocess(value) {
+    if (typeof value === 'string') {
+        return value.replace(/[\s-]/g, '').toUpperCase();
+    }
+    return value;
+}
+function getPostcodeRule() {
+    const validator = z.preprocess(preprocess, z
+        .string()
+        .regex(/^[A-Z]{1,2}\d[A-Z\d]?\d[A-Z]{2}$/u)
+        .nonoptional());
+    return createRule({ validator });
+}
+export default getPostcodeRule;

package/dist/schema.d.ts

@@ -0,0 +1,163 @@
+export declare const addressTable: import("drizzle-orm/pg-core").PgTableWithColumns<{
+    name: "addresses";
+    schema: undefined;
+    columns: {
+        id: import("drizzle-orm/pg-core").PgColumn<{
+            name: "id";
+            tableName: "addresses";
+            dataType: "string";
+            columnType: "PgText";
+            data: `add_${string}`;
+            driverParam: string;
+            notNull: true;
+            hasDefault: false;
+            isPrimaryKey: true;
+            isAutoincrement: false;
+            hasRuntimeDefault: false;
+            enumValues: [string, ...string[]];
+            baseColumn: never;
+            identity: undefined;
+            generated: undefined;
+        }, {}, {
+            $type: `add_${string}`;
+        }>;
+        subjectID: import("drizzle-orm/pg-core").PgColumn<{
+            name: "subjectID";
+            tableName: "addresses";
+            dataType: "string";
+            columnType: "PgText";
+            data: string;
+            driverParam: string;
+            notNull: true;
+            hasDefault: false;
+            isPrimaryKey: false;
+            isAutoincrement: false;
+            hasRuntimeDefault: false;
+            enumValues: [string, ...string[]];
+            baseColumn: never;
+            identity: undefined;
+            generated: undefined;
+        }, {}, {}>;
+        line1: import("drizzle-orm/pg-core").PgColumn<{
+            name: "line1";
+            tableName: "addresses";
+            dataType: "string";
+            columnType: "PgText";
+            data: string;
+            driverParam: string;
+            notNull: true;
+            hasDefault: false;
+            isPrimaryKey: false;
+            isAutoincrement: false;
+            hasRuntimeDefault: false;
+            enumValues: [string, ...string[]];
+            baseColumn: never;
+            identity: undefined;
+            generated: undefined;
+        }, {}, {}>;
+        line2: import("drizzle-orm/pg-core").PgColumn<{
+            name: "line2";
+            tableName: "addresses";
+            dataType: "string";
+            columnType: "PgText";
+            data: string;
+            driverParam: string;
+            notNull: false;
+            hasDefault: false;
+            isPrimaryKey: false;
+            isAutoincrement: false;
+            hasRuntimeDefault: false;
+            enumValues: [string, ...string[]];
+            baseColumn: never;
+            identity: undefined;
+            generated: undefined;
+        }, {}, {}>;
+        city: import("drizzle-orm/pg-core").PgColumn<{
+            name: "city";
+            tableName: "addresses";
+            dataType: "string";
+            columnType: "PgText";
+            data: string;
+            driverParam: string;
+            notNull: true;
+            hasDefault: false;
+            isPrimaryKey: false;
+            isAutoincrement: false;
+            hasRuntimeDefault: false;
+            enumValues: [string, ...string[]];
+            baseColumn: never;
+            identity: undefined;
+            generated: undefined;
+        }, {}, {}>;
+        county: import("drizzle-orm/pg-core").PgColumn<{
+            name: "county";
+            tableName: "addresses";
+            dataType: "string";
+            columnType: "PgText";
+            data: string;
+            driverParam: string;
+            notNull: true;
+            hasDefault: false;
+            isPrimaryKey: false;
+            isAutoincrement: false;
+            hasRuntimeDefault: false;
+            enumValues: [string, ...string[]];
+            baseColumn: never;
+            identity: undefined;
+            generated: undefined;
+        }, {}, {}>;
+        postcode: import("drizzle-orm/pg-core").PgColumn<{
+            name: "postcode";
+            tableName: "addresses";
+            dataType: "string";
+            columnType: "PgText";
+            data: string;
+            driverParam: string;
+            notNull: true;
+            hasDefault: false;
+            isPrimaryKey: false;
+            isAutoincrement: false;
+            hasRuntimeDefault: false;
+            enumValues: [string, ...string[]];
+            baseColumn: never;
+            identity: undefined;
+            generated: undefined;
+        }, {}, {}>;
+        createdAt: import("drizzle-orm/pg-core").PgColumn<{
+            name: "createdAt";
+            tableName: "addresses";
+            dataType: "date";
+            columnType: "PgTimestamp";
+            data: Date;
+            driverParam: string;
+            notNull: true;
+            hasDefault: true;
+            isPrimaryKey: false;
+            isAutoincrement: false;
+            hasRuntimeDefault: false;
+            enumValues: undefined;
+            baseColumn: never;
+            identity: undefined;
+            generated: undefined;
+        }, {}, {}>;
+        deletedAt: import("drizzle-orm/pg-core").PgColumn<{
+            name: "deletedAt";
+            tableName: "addresses";
+            dataType: "date";
+            columnType: "PgTimestamp";
+            data: Date;
+            driverParam: string;
+            notNull: false;
+            hasDefault: false;
+            isPrimaryKey: false;
+            isAutoincrement: false;
+            hasRuntimeDefault: false;
+            enumValues: undefined;
+            baseColumn: never;
+            identity: undefined;
+            generated: undefined;
+        }, {}, {}>;
+    };
+    dialect: "pg";
+}>;
+export type AddressTable = typeof addressTable.$inferSelect;

package/dist/schema.js

@@ -0,0 +1,15 @@
+import { sql } from 'drizzle-orm';
+import { pgTable, text, timestamp } from 'drizzle-orm/pg-core';
+export const addressTable = pgTable('addresses', {
+    id: text('id').$type().primaryKey(),
+    subjectID: text('subjectID').notNull(),
+    line1: text('line1').notNull(),
+    line2: text('line2'),
+    city: text('city').notNull(),
+    county: text('county').notNull(),
+    postcode: text('postcode').notNull(),
+    createdAt: timestamp('createdAt')
+        .notNull()
+        .default(sql `CURRENT_TIMESTAMP`),
+    deletedAt: timestamp('deletedAt'),
+});

package/dist/server.d.ts

@@ -0,0 +1,2 @@
+export { default as AddressRepository } from './repositories/AddressRepository';
+export { withAddresses, withAddressesConfig } from './repository';

package/dist/server.js

@@ -0,0 +1,2 @@
+export { default as AddressRepository } from './repositories/AddressRepository';
+export { withAddresses, withAddressesConfig } from './repository';

package/dist/ui.d.ts

@@ -0,0 +1 @@
+export { default as AddressForm } from './forms/AddressForm';

package/dist/ui.js

@@ -0,0 +1 @@
+export { default as AddressForm } from './forms/AddressForm';

package/dist/utility/ids.d.ts

@@ -0,0 +1,2 @@
+export declare const ADDRESS_PREFIX = "add";
+export type AddressID = `${typeof ADDRESS_PREFIX}_${string}`;

package/dist/utility/ids.js

@@ -0,0 +1 @@
+export const ADDRESS_PREFIX = 'add';

package/dist/utility/interfaces.d.ts

@@ -0,0 +1,13 @@
+import { MakeNullOptional } from '@sqrzro/server/utility';
+import type { AddressTable } from '../schema';
+import type { AddressID } from './ids';
+export type Address = AddressTable;
+export type AddressDataWithID = MakeNullOptional<Omit<Address, 'createdAt' | 'deletedAt'>>;
+export type AddressData = Omit<AddressDataWithID, 'id'>;
+export interface AddressFilters {
+    id: AddressID[];
+    subjectID: string | string[];
+}
+export type WithAddress<T> = T & {
+    address: Address | null;
+};

package/dist/utility/interfaces.js

@@ -0,0 +1 @@
+export {};

package/package.json

@@ -0,0 +1,47 @@
+{
+  "name": "@sqrzro/addon-addresses",
+  "type": "module",
+  "version": "4.0.0-alpha.1",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "exports": {
+    "./interfaces": {
+      "default": "./dist/interfaces.js",
+      "types": "./dist/interfaces.d.ts"
+    },
+    "./schema": {
+      "default": "./dist/schema.js",
+      "types": "./dist/schema.d.ts"
+    },
+    "./server": {
+      "default": "./dist/server.js",
+      "types": "./dist/server.d.ts"
+    },
+    "./ui": {
+      "default": "./dist/ui.js",
+      "types": "./dist/ui.d.ts"
+    }
+  },
+  "dependencies": {
+    "drizzle-orm": "^0.45.1",
+    "zod": "^4.3.6",
+    "@sqrzro/server": "^4.0.0-alpha.62",
+    "@sqrzro/ui": "^4.0.0-alpha.76",
+    "@sqrzro/utility": "^4.0.0-alpha.22"
+  },
+  "devDependencies": {
+    "@types/react": "^19.2.14",
+    "typescript": "^5.9.3",
+    "szx": "^4.0.0-alpha.18"
+  },
+  "peerDependencies": {
+    "next": "^16.1.6",
+    "react": "^19.2.4"
+  },
+  "scripts": {
+    "build": "tsc",
+    "dev": "tsc --watch",
+    "start": "pnpm dev",
+    "szx": "szx"
+  }
+}

package/src/forms/AddressForm/index.tsx

@@ -0,0 +1,31 @@
+'use client';
+
+import { Default, EditableForm, EditableTextFormField, useEditableForm } from '@sqrzro/ui/forms';
+import { formatPostcode } from '@sqrzro/utility';
+
+import submit from './server';
+import type { AddressFormFields } from './interfaces';
+
+interface AddressFormProps {
+    defaults?: Default<AddressFormFields> | null;
+}
+
+function AddressForm({ defaults }: Readonly<AddressFormProps>): React.ReactElement {
+    const { fieldProps, formProps } = useEditableForm({
+        defaults: defaults ?? {},
+        onSubmit: submit,
+        title: 'Address',
+    });
+
+    return (
+        <EditableForm {...formProps}>
+            <EditableTextFormField {...fieldProps('line1', 'Line 1')} />
+            <EditableTextFormField {...fieldProps('line2', 'Line 2')} />
+            <EditableTextFormField {...fieldProps('city')} />
+            <EditableTextFormField {...fieldProps('county')} />
+            <EditableTextFormField {...fieldProps('postcode')} renderValue={formatPostcode} />
+        </EditableForm>
+    );
+}
+
+export default AddressForm;

package/src/forms/AddressForm/interfaces.ts

@@ -0,0 +1,11 @@
+import { AddressID } from '../../utility/ids';
+
+export interface AddressFormFields {
+    city: string;
+    county: string;
+    id: AddressID;
+    line1: string;
+    line2: string;
+    postcode: string;
+    subjectID: string;
+}

package/src/forms/AddressForm/server.ts

@@ -0,0 +1,40 @@
+'use server';
+
+import { FormResponse, submitForm } from '@sqrzro/server/forms';
+import { z } from 'zod';
+
+import AddressRepository from '../../repositories/AddressRepository';
+import getPostcodeRule from '../../rules/postcode';
+import type { Address } from '../../utility/interfaces';
+
+import type { AddressFormFields } from './interfaces';
+
+const schema = z.object({
+    city: z.string().min(4).max(20).nonoptional(),
+    county: z.string().min(4).max(20).nonoptional(),
+    id: AddressRepository.getIDRule('id').validator.optional(),
+    line1: z.string().min(4).max(30).nonoptional(),
+    line2: z.string().max(30).nullable().optional(),
+    subjectID: z.string().nonoptional(),
+    postcode: getPostcodeRule().validator.nonoptional(),
+});
+
+async function fn(data: z.infer<typeof schema>): Promise<Address> {
+    const { id, ...rest } = data;
+
+    if (typeof id !== 'undefined') {
+        return AddressRepository.update({ id, ...rest });
+    }
+
+    return AddressRepository.create(rest);
+}
+
+async function submit(formData: AddressFormFields): FormResponse<Address> {
+    return submitForm({
+        fn,
+        formData,
+        schema,
+    });
+}
+
+export default submit;

package/src/interfaces.ts

@@ -0,0 +1,2 @@
+export * from './utility/ids';
+export * from './utility/interfaces';

package/src/repositories/AddressRepository.ts

@@ -0,0 +1,92 @@
+import { db } from '@sqrzro/server/database';
+import { createRepository } from '@sqrzro/server/database';
+import type { QueryConditions, QueryConfig } from '@sqrzro/server/database';
+import { generateID } from '@sqrzro/server/utility';
+import { pick } from '@sqrzro/utility';
+import { and, eq, inArray } from 'drizzle-orm';
+
+import { ADDRESS_PREFIX, AddressID } from '../utility/ids';
+import type { Address, AddressData, AddressFilters } from '../utility/interfaces';
+
+import { addressTable } from '../schema';
+
+const fillable: (keyof AddressData)[] = [
+    'city',
+    'county',
+    'line1',
+    'line2',
+    'postcode',
+    'subjectID',
+];
+
+const AddressRepository = createRepository({
+    async applyFilters(filters: Partial<AddressFilters> | null): Promise<QueryConditions> {
+        const conditions: QueryConditions = [];
+
+        if (filters?.id) {
+            conditions.push(inArray(addressTable.id, filters.id));
+        }
+
+        if (filters?.subjectID) {
+            if (Array.isArray(filters.subjectID)) {
+                conditions.push(inArray(addressTable.subjectID, filters.subjectID));
+            } else {
+                conditions.push(eq(addressTable.subjectID, filters.subjectID));
+            }
+        }
+
+        return conditions;
+    },
+
+    indexes: { id: addressTable.id, subjectID: addressTable.subjectID },
+
+    async makeQuery(conditions: QueryConditions, config: QueryConfig): Promise<Address[]> {
+        return db
+            .select()
+            .from(addressTable)
+            .where(and(...conditions))
+            .limit(config.limit)
+            .offset(config.offset);
+    },
+
+    async makeDeleteMutation(id: AddressID): Promise<void> {
+        await db.update(addressTable).set({ deletedAt: new Date() }).where(eq(addressTable.id, id));
+    },
+
+    async makeUndeleteMutation(id: AddressID): Promise<void> {
+        await db.update(addressTable).set({ deletedAt: null }).where(eq(addressTable.id, id));
+    },
+
+    async makeInsertMutation(data: AddressData): Promise<Address> {
+        const values = {
+            id: generateID<AddressID>(ADDRESS_PREFIX),
+            ...pick(data, fillable),
+        };
+
+        const [result] = await db.insert(addressTable).values(values).returning();
+        return result;
+    },
+
+    async makeUpdateMutation(data: Partial<AddressData> & { id: AddressID }): Promise<Address> {
+        const [result] = await db
+            .update(addressTable)
+            .set(data)
+            .where(eq(addressTable.id, data.id))
+            .returning();
+
+        return result;
+    },
+
+    paramKey: 'address',
+    prefix: ADDRESS_PREFIX,
+});
+
+function ensureBySubjectID(subjectID: string): Promise<Address> {
+    return AddressRepository.ensureByIndex('subjectID', subjectID);
+}
+
+function getBySubjectID(subjectID: string): Promise<Address | null> {
+    return AddressRepository.getByIndex('subjectID', subjectID);
+}
+
+export default { ...AddressRepository, ensureBySubjectID, getBySubjectID };

package/src/repository/index.ts

@@ -0,0 +1,67 @@
+import { RepositoryConfig, UnwrapModel } from '@sqrzro/server/database';
+
+import AddressRepository from '../repositories/AddressRepository';
+
+import { AddressID } from '../utility/ids';
+import { Address, AddressData, WithAddress } from '../utility/interfaces';
+
+interface AddressesRepositoryConfig {}
+
+export function withAddressesConfig<T extends RepositoryConfig>(cfg: T) {
+    return {
+        ...cfg,
+        makeQuery: async (
+            ...args: Parameters<NonNullable<typeof cfg.makeQuery>>
+        ): Promise<WithAddress<UnwrapModel<T>>[]> => {
+            const results = await cfg.makeQuery?.(...args);
+            const ids = results?.map((item: any) => item.id) ?? [];
+
+            const addresses = await AddressRepository.getAll({ filters: { subjectID: ids } });
+
+            return (
+                results?.map((item: any) => ({
+                    ...item,
+                    address: addresses.find((a) => a.subjectID === item.id) ?? null,
+                })) ?? []
+            );
+        },
+    };
+}
+
+export function withAddresses(config: AddressesRepositoryConfig) {
+    return function <
+        TRepo extends { ensureByID: (...args: any[]) => any; update: (...args: any[]) => any },
+    >(repository: TRepo) {
+        async function attachAddress(subjectID: string, data: AddressData): Promise<Address> {
+            const model = (await repository.ensureByID(subjectID)) as {
+                addressID: AddressID | null;
+            };
+
+            if (model.addressID) {
+                return AddressRepository.update({ ...data, id: model.addressID });
+            }
+
+            const address = await AddressRepository.create(data);
+            await repository.update({ id: subjectID, addressID: address.id });
+
+            return address;
+        }
+
+        async function withAddress<T extends { id: string }>(subject: T): Promise<WithAddress<T>> {
+            const [address] = await AddressRepository.getAll({
+                filters: { subjectID: subject.id },
+            });
+
+            return {
+                ...subject,
+                address: address ?? null,
+            };
+        }
+
+        return {
+            ...repository,
+            attachAddress,
+            withAddress,
+        };
+    };
+}

package/src/rules/postcode.ts

@@ -0,0 +1,22 @@
+import { createRule } from '@sqrzro/server/forms';
+import z from 'zod';
+
+function preprocess(value: unknown): unknown {
+    if (typeof value === 'string') {
+        return value.replace(/[\s-]/g, '').toUpperCase();
+    }
+    return value;
+}
+
+function getPostcodeRule() {
+    const validator = z.preprocess(
+        preprocess,
+        z
+            .string()
+            .regex(/^[A-Z]{1,2}\d[A-Z\d]?\d[A-Z]{2}$/u)
+            .nonoptional()
+    );
+    return createRule({ validator });
+}
+
+export default getPostcodeRule;

package/src/schema.ts

@@ -0,0 +1,20 @@
+import { sql } from 'drizzle-orm';
+import { pgTable, text, timestamp } from 'drizzle-orm/pg-core';
+
+import type { AddressID } from './utility/ids';
+
+export const addressTable = pgTable('addresses', {
+    id: text('id').$type<AddressID>().primaryKey(),
+    subjectID: text('subjectID').notNull(),
+    line1: text('line1').notNull(),
+    line2: text('line2'),
+    city: text('city').notNull(),
+    county: text('county').notNull(),
+    postcode: text('postcode').notNull(),
+    createdAt: timestamp('createdAt')
+        .notNull()
+        .default(sql`CURRENT_TIMESTAMP`),
+    deletedAt: timestamp('deletedAt'),
+});
+
+export type AddressTable = typeof addressTable.$inferSelect;

package/src/server.ts

@@ -0,0 +1,2 @@
+export { default as AddressRepository } from './repositories/AddressRepository';
+export { withAddresses, withAddressesConfig } from './repository';

package/src/ui.ts

@@ -0,0 +1 @@
+export { default as AddressForm } from './forms/AddressForm';

package/src/utility/ids.ts

@@ -0,0 +1,3 @@
+export const ADDRESS_PREFIX = 'add';
+
+export type AddressID = `${typeof ADDRESS_PREFIX}_${string}`;

package/src/utility/interfaces.ts

@@ -0,0 +1,16 @@
+import { MakeNullOptional } from '@sqrzro/server/utility';
+
+import type { AddressTable } from '../schema';
+
+import type { AddressID } from './ids';
+
+export type Address = AddressTable;
+export type AddressDataWithID = MakeNullOptional<Omit<Address, 'createdAt' | 'deletedAt'>>;
+export type AddressData = Omit<AddressDataWithID, 'id'>;
+
+export interface AddressFilters {
+    id: AddressID[];
+    subjectID: string | string[];
+}
+
+export type WithAddress<T> = T & { address: Address | null };

package/tsconfig.json

@@ -0,0 +1,20 @@
+{
+    "compilerOptions": {
+        "allowSyntheticDefaultImports": true,
+        "declaration": true,
+        "esModuleInterop": true,
+        "importHelpers": true,
+        "lib": ["ESNext", "DOM"],
+        "jsx": "react-jsx",
+        "module": "ESNext",
+        "moduleResolution": "bundler",
+        "outDir": "dist",
+        "resolveJsonModule": true,
+        "rootDir": "src",
+        "skipLibCheck": true,
+        "strict": true,
+        "target": "esnext"
+    },
+    "include": ["**/*.ts", "**/*.tsx"],
+    "exclude": ["dist", "./*.d.ts", "node_modules"]
+}