@htlkg/data 0.0.20 → 0.0.21

package/src/hooks/useContacts.ts

@@ -0,0 +1,176 @@
+/**
+ * useContacts Hook
+ *
+ * Vue composable for fetching and managing contact data with reactive state.
+ * Provides loading states, error handling, search, pagination, and refetch capabilities.
+ */
+
+import type { Ref, ComputedRef } from "vue";
+import type { Contact } from "@htlkg/core/types";
+import { createDataHook, type BaseHookOptions } from "./createDataHook";
+
+export interface UseContactsOptions extends BaseHookOptions {
+	/** Filter by brand ID */
+	brandId?: string;
+	/** Search query (searches email, firstName, lastName) */
+	search?: string;
+	/** Filter by GDPR consent */
+	gdprConsent?: boolean;
+	/** Filter by marketing opt-in */
+	marketingOptIn?: boolean;
+	/** Filter by tags (contact must have at least one of these tags) */
+	tags?: string[];
+	/** Pagination token for fetching next page */
+	nextToken?: string;
+}
+
+export interface UseContactsReturn {
+	/** Reactive array of contacts */
+	contacts: Ref<Contact[]>;
+	/** Computed array of contacts with GDPR consent */
+	consentedContacts: ComputedRef<Contact[]>;
+	/** Computed array of contacts opted-in for marketing */
+	marketingContacts: ComputedRef<Contact[]>;
+	/** Loading state */
+	loading: Ref<boolean>;
+	/** Error state */
+	error: Ref<Error | null>;
+	/** Refetch contacts */
+	refetch: () => Promise<void>;
+}
+
+/**
+ * Build filter from hook options
+ */
+function buildFilter(options: UseContactsOptions): any {
+	const conditions: any[] = [];
+
+	// Filter by brand
+	if (options.brandId) {
+		conditions.push({ brandId: { eq: options.brandId } });
+	}
+
+	// Search across email, firstName, lastName
+	if (options.search) {
+		conditions.push({
+			or: [
+				{ email: { contains: options.search } },
+				{ firstName: { contains: options.search } },
+				{ lastName: { contains: options.search } },
+			],
+		});
+	}
+
+	// Filter by GDPR consent
+	if (options.gdprConsent !== undefined) {
+		conditions.push({ gdprConsent: { eq: options.gdprConsent } });
+	}
+
+	// Filter by marketing opt-in
+	if (options.marketingOptIn !== undefined) {
+		conditions.push({ marketingOptIn: { eq: options.marketingOptIn } });
+	}
+
+	// Filter by tags (contact must have at least one of these tags)
+	if (options.tags && options.tags.length > 0) {
+		const tagConditions = options.tags.map((tag) => ({
+			tags: { contains: tag },
+		}));
+		conditions.push({ or: tagConditions });
+	}
+
+	// Include any additional custom filter
+	if (options.filter) {
+		conditions.push(options.filter);
+	}
+
+	if (conditions.length === 0) {
+		return undefined;
+	}
+
+	if (conditions.length === 1) {
+		return conditions[0];
+	}
+
+	return { and: conditions };
+}
+
+/**
+ * Internal hook created by factory
+ */
+const useContactsInternal = createDataHook<
+	Contact,
+	UseContactsOptions,
+	{ consentedContacts: Contact[]; marketingContacts: Contact[] }
+>({
+	model: "Contact",
+	dataPropertyName: "contacts",
+	buildFilter,
+	computedProperties: {
+		consentedContacts: (contacts) =>
+			contacts.filter((c) => c.gdprConsent === true),
+		marketingContacts: (contacts) =>
+			contacts.filter((c) => c.marketingOptIn === true),
+	},
+});
+
+/**
+ * Composable for fetching and managing contacts
+ *
+ * @example
+ * ```typescript
+ * import { useContacts } from '@htlkg/data/hooks';
+ *
+ * const { contacts, loading, error, refetch } = useContacts({
+ *   brandId: 'brand-123',
+ *   limit: 25
+ * });
+ * ```
+ *
+ * @example With search
+ * ```typescript
+ * const { contacts, loading } = useContacts({
+ *   brandId: 'brand-123',
+ *   search: 'john',
+ *   limit: 25
+ * });
+ * ```
+ *
+ * @example With GDPR and marketing filters
+ * ```typescript
+ * const { contacts, marketingContacts } = useContacts({
+ *   brandId: 'brand-123',
+ *   gdprConsent: true,
+ *   marketingOptIn: true
+ * });
+ * ```
+ *
+ * @example With computed properties
+ * ```typescript
+ * const { contacts, consentedContacts, marketingContacts } = useContacts({
+ *   brandId: 'brand-123'
+ * });
+ *
+ * // consentedContacts - contacts with GDPR consent
+ * // marketingContacts - contacts opted-in for marketing
+ * ```
+ *
+ * @example With tag filtering
+ * ```typescript
+ * const { contacts } = useContacts({
+ *   brandId: 'brand-123',
+ *   tags: ['vip', 'returning']
+ * });
+ * ```
+ */
+export function useContacts(options: UseContactsOptions = {}): UseContactsReturn {
+	const result = useContactsInternal(options);
+	return {
+		contacts: result.contacts as Ref<Contact[]>,
+		consentedContacts: result.consentedContacts as ComputedRef<Contact[]>,
+		marketingContacts: result.marketingContacts as ComputedRef<Contact[]>,
+		loading: result.loading,
+		error: result.error,
+		refetch: result.refetch,
+	};
+}