@djangocfg/ext-newsletter 1.0.0

package/src/contexts/newsletter/NewsletterContext.tsx

@@ -0,0 +1,264 @@
+/**
+ * Newsletter Context
+ * 
+ * Manages newsletter campaigns and subscriptions using generated SWR hooks
+ * 
+ * Features:
+ * - Campaign management (create, update, delete, send)
+ * - Subscription management (subscribe, unsubscribe)
+ * - Campaign lists with pagination
+ * - Subscription lists with pagination
+ */
+
+"use client";
+
+import { createContext, useContext, ReactNode } from 'react';
+import { useSWRConfig } from 'swr';
+import { ExtensionProvider } from '@djangocfg/ext-base/hooks';
+
+import { extensionConfig } from '../../config';
+import { apiNewsletter } from '../../api';
+import {
+  useNewsletterCampaignsList,
+  useNewsletterCampaignsRetrieve,
+  useCreateNewsletterCampaignsCreate,
+  useUpdateNewsletterCampaignsUpdate,
+  usePartialUpdateNewsletterCampaignsPartialUpdate,
+  useDeleteNewsletterCampaignsDestroy,
+  useCreateNewsletterCampaignsSendCreate,
+  useNewsletterSubscriptionsList,
+  useCreateNewsletterSubscribeCreate,
+  useCreateNewsletterUnsubscribeCreate,
+} from '../../api/generated/ext_newsletter/_utils/hooks';
+import type {
+  NewsletterCampaign,
+  NewsletterCampaignRequest,
+  PatchedNewsletterCampaignRequest,
+  NewsletterSubscription,
+  PaginatedNewsletterCampaignList,
+  PaginatedNewsletterSubscriptionList,
+  SubscribeRequest,
+  SubscribeResponse,
+  UnsubscribeRequest,
+  SuccessResponse,
+  SendCampaignRequest,
+  SendCampaignResponse,
+} from './types';
+
+// ─────────────────────────────────────────────────────────────────────────
+// Context Type
+// ─────────────────────────────────────────────────────────────────────────
+
+export interface NewsletterContextValue {
+  // Campaigns list state
+  campaigns: NewsletterCampaign[];
+  isLoadingCampaigns: boolean;
+  campaignsError: Error | null;
+  pagination?: {
+    count: number;
+    next: number | null;
+    previous: number | null;
+  };
+
+  // Campaign operations
+  getCampaign: (id: number) => { data?: NewsletterCampaign; error?: Error; isLoading: boolean };
+  createCampaign: (data: NewsletterCampaignRequest) => Promise<NewsletterCampaign>;
+  updateCampaign: (id: number, data: NewsletterCampaignRequest) => Promise<NewsletterCampaign>;
+  partialUpdateCampaign: (id: number, data: PatchedNewsletterCampaignRequest) => Promise<NewsletterCampaign>;
+  deleteCampaign: (id: number) => Promise<void>;
+  sendCampaign: (campaignId: number) => Promise<SendCampaignResponse>;
+
+  // Subscriptions list state
+  subscriptions: NewsletterSubscription[];
+  isLoadingSubscriptions: boolean;
+  subscriptionsError: Error | null;
+
+  // Subscription operations
+  subscribe: (data: SubscribeRequest) => Promise<SubscribeResponse>;
+  unsubscribe: (data: UnsubscribeRequest) => Promise<SuccessResponse>;
+}
+
+// ─────────────────────────────────────────────────────────────────────────
+// Context
+// ─────────────────────────────────────────────────────────────────────────
+
+const NewsletterContext = createContext<NewsletterContextValue | undefined>(undefined);
+
+// ─────────────────────────────────────────────────────────────────────────
+// Provider Props
+// ─────────────────────────────────────────────────────────────────────────
+
+interface NewsletterProviderProps {
+  children: ReactNode;
+  page?: number;
+  pageSize?: number;
+}
+
+// ─────────────────────────────────────────────────────────────────────────
+// Provider Component
+// ─────────────────────────────────────────────────────────────────────────
+
+export function NewsletterProvider({ 
+  children, 
+  page = 1, 
+  pageSize = 100 
+}: NewsletterProviderProps) {
+  const { mutate } = useSWRConfig();
+  
+  const swrConfig = {
+    revalidateOnFocus: false,
+    revalidateOnReconnect: false,
+    revalidateIfStale: false,
+  };
+
+  // List params for proper revalidation
+  const listParams = { page, page_size: pageSize };
+
+  // Campaigns list
+  const {
+    data: campaignsData,
+    error: campaignsError,
+    isLoading: isLoadingCampaigns,
+  } = useNewsletterCampaignsList(listParams, apiNewsletter);
+
+  // Subscriptions list
+  const {
+    data: subscriptionsData,
+    error: subscriptionsError,
+    isLoading: isLoadingSubscriptions,
+  } = useNewsletterSubscriptionsList(listParams, apiNewsletter);
+
+  // Mutation hooks
+  const createCampaignMutation = useCreateNewsletterCampaignsCreate();
+  const updateCampaignMutation = useUpdateNewsletterCampaignsUpdate();
+  const partialUpdateCampaignMutation = usePartialUpdateNewsletterCampaignsPartialUpdate();
+  const deleteCampaignMutation = useDeleteNewsletterCampaignsDestroy();
+  const sendCampaignMutation = useCreateNewsletterCampaignsSendCreate();
+  const subscribeMutation = useCreateNewsletterSubscribeCreate();
+  const unsubscribeMutation = useCreateNewsletterUnsubscribeCreate();
+
+  // Extract data from paginated responses
+  const campaigns = campaignsData?.results || [];
+  const subscriptions = subscriptionsData?.results || [];
+
+  // Get single campaign
+  const getCampaign = (id: number) => {
+    const { data, error, isLoading } = useNewsletterCampaignsRetrieve(id, apiNewsletter);
+    return { data, error, isLoading };
+  };
+
+  // Create campaign
+  const createCampaign = async (data: NewsletterCampaignRequest): Promise<NewsletterCampaign> => {
+    const result = await createCampaignMutation(data, apiNewsletter);
+    await mutate(['cfg-newsletter-campaigns-list', listParams]);
+    return result as NewsletterCampaign;
+  };
+
+  // Update campaign (full)
+  const updateCampaign = async (id: number, data: NewsletterCampaignRequest): Promise<NewsletterCampaign> => {
+    const result = await updateCampaignMutation(id, data, apiNewsletter);
+    await mutate(['cfg-newsletter-campaigns-list', listParams]);
+    await mutate(['cfg-newsletter-campaigns-retrieve', id]);
+    return result as NewsletterCampaign;
+  };
+
+  // Partial update campaign (currently not supported by generated API)
+  const partialUpdateCampaign = async (id: number, data: PatchedNewsletterCampaignRequest): Promise<NewsletterCampaign> => {
+    // TODO: Fix generator to include data parameter for PATCH requests
+    // const result = await partialUpdateCampaignMutation(id, data);
+    // For now, fallback to full update
+    const result = await updateCampaignMutation(id, data as NewsletterCampaignRequest);
+    await mutate(['cfg-newsletter-campaigns-list', listParams]);
+    await mutate(['cfg-newsletter-campaigns-retrieve', id]);
+    return result as NewsletterCampaign;
+  };
+
+  // Delete campaign
+  const deleteCampaign = async (id: number): Promise<void> => {
+    await deleteCampaignMutation(id, apiNewsletter);
+    await mutate(['cfg-newsletter-campaigns-list', listParams]);
+  };
+
+  // Send campaign
+  const sendCampaign = async (campaignId: number): Promise<SendCampaignResponse> => {
+    const result = await sendCampaignMutation({ campaign_id: campaignId }, apiNewsletter);
+    await mutate(['cfg-newsletter-campaigns-list', listParams]);
+    await mutate(['cfg-newsletter-campaigns-retrieve', campaignId]);
+    return result as SendCampaignResponse;
+  };
+
+  // Subscribe
+  const subscribe = async (data: SubscribeRequest): Promise<SubscribeResponse> => {
+    const result = await subscribeMutation(data, apiNewsletter);
+    await mutate(['cfg-newsletter-subscriptions-list', listParams]);
+    return result as SubscribeResponse;
+  };
+
+  // Unsubscribe
+  const unsubscribe = async (data: UnsubscribeRequest): Promise<SuccessResponse> => {
+    const result = await unsubscribeMutation(data, apiNewsletter);
+    await mutate(['cfg-newsletter-subscriptions-list', listParams]);
+    return result as SuccessResponse;
+  };
+
+  const value: NewsletterContextValue = {
+    campaigns,
+    isLoadingCampaigns,
+    campaignsError,
+    pagination: campaignsData ? {
+      count: campaignsData.count,
+      next: campaignsData.next_page ?? null,
+      previous: campaignsData.previous_page ?? null,
+    } : undefined,
+    getCampaign,
+    createCampaign,
+    updateCampaign,
+    partialUpdateCampaign,
+    deleteCampaign,
+    sendCampaign,
+    subscriptions,
+    isLoadingSubscriptions,
+    subscriptionsError,
+    subscribe,
+    unsubscribe,
+  };
+
+  return (
+    <ExtensionProvider metadata={extensionConfig} options={swrConfig}>
+      <NewsletterContext.Provider value={value}>
+        {children}
+      </NewsletterContext.Provider>
+    </ExtensionProvider>
+  );
+}
+
+// ─────────────────────────────────────────────────────────────────────────
+// Hook
+// ─────────────────────────────────────────────────────────────────────────
+
+export function useNewsletterContext(): NewsletterContextValue {
+  const context = useContext(NewsletterContext);
+  if (!context) {
+    throw new Error('useNewsletterContext must be used within NewsletterProvider');
+  }
+  return context;
+}
+
+// ─────────────────────────────────────────────────────────────────────────
+// Re-export types for external use
+// ─────────────────────────────────────────────────────────────────────────
+
+export type {
+  NewsletterCampaign,
+  NewsletterCampaignRequest,
+  PatchedNewsletterCampaignRequest,
+  NewsletterSubscription,
+  PaginatedNewsletterCampaignList,
+  PaginatedNewsletterSubscriptionList,
+  SubscribeRequest,
+  SubscribeResponse,
+  UnsubscribeRequest,
+  SuccessResponse,
+  SendCampaignRequest,
+  SendCampaignResponse,
+} from './types';

package/src/contexts/newsletter/types.ts

@@ -0,0 +1,32 @@
+/**
+ * Newsletter Types
+ * Centralized type definitions for newsletter context
+ */
+
+import type {
+  useNewsletterCampaignsList,
+  useNewsletterCampaignsRetrieve,
+  useUpdateNewsletterCampaignsUpdate,
+  usePartialUpdateNewsletterCampaignsPartialUpdate,
+  useNewsletterSubscriptionsList,
+  useCreateNewsletterSubscribeCreate,
+  useCreateNewsletterUnsubscribeCreate,
+  useCreateNewsletterCampaignsSendCreate,
+} from '../../api/generated/ext_newsletter/_utils/hooks';
+
+// ─────────────────────────────────────────────────────────────────────────
+// Newsletter Types
+// ─────────────────────────────────────────────────────────────────────────
+
+export type PaginatedNewsletterCampaignList = NonNullable<Awaited<ReturnType<typeof useNewsletterCampaignsList>>['data']>;
+export type NewsletterCampaign = NonNullable<Awaited<ReturnType<typeof useNewsletterCampaignsRetrieve>>['data']>;
+export type NewsletterCampaignRequest = Parameters<ReturnType<typeof useUpdateNewsletterCampaignsUpdate>>[1];
+export type PatchedNewsletterCampaignRequest = Parameters<ReturnType<typeof usePartialUpdateNewsletterCampaignsPartialUpdate>>[1];
+export type PaginatedNewsletterSubscriptionList = NonNullable<Awaited<ReturnType<typeof useNewsletterSubscriptionsList>>['data']>;
+export type NewsletterSubscription = NonNullable<Awaited<ReturnType<typeof useNewsletterSubscriptionsList>>['data']> extends { results: infer T } ? T extends Array<infer U> ? U : never : never;
+export type SubscribeRequest = Parameters<ReturnType<typeof useCreateNewsletterSubscribeCreate>>[0];
+export type SubscribeResponse = Awaited<ReturnType<ReturnType<typeof useCreateNewsletterSubscribeCreate>>>;
+export type UnsubscribeRequest = Parameters<ReturnType<typeof useCreateNewsletterUnsubscribeCreate>>[0];
+export type SuccessResponse = Awaited<ReturnType<ReturnType<typeof useCreateNewsletterUnsubscribeCreate>>>;
+export type SendCampaignRequest = Parameters<ReturnType<typeof useCreateNewsletterCampaignsSendCreate>>[1];
+export type SendCampaignResponse = Awaited<ReturnType<ReturnType<typeof useCreateNewsletterCampaignsSendCreate>>>;

package/src/hooks/index.ts

@@ -0,0 +1,21 @@
+'use client';
+
+/**
+ * @djangocfg/ext-newsletter/hooks
+ *
+ * React hooks for newsletter extension.
+ * Use this entry point in client components.
+ */
+
+// Re-export everything from main entry (server-safe code)
+export * from '../index';
+
+// SWR hooks from generated API
+export * from '../api/generated/ext_newsletter/_utils/hooks';
+
+// Newsletter context
+export { NewsletterProvider, useNewsletterContext } from '../contexts/newsletter/NewsletterContext';
+
+// Hero component
+export { Hero } from '../components/Hero';
+export { default as NewsletterHero } from '../components/Hero';

package/src/index.ts

@@ -0,0 +1,14 @@
+/**
+ * @djangocfg/ext-newsletter
+ *
+ * Server-safe entry point.
+ * Use this in server components and API routes.
+ */
+
+// Export generated API types and client
+export * from './api/generated/ext_newsletter';
+export { API } from './api/generated/ext_newsletter';
+export { apiNewsletter } from './api';
+
+// Export component types (server-safe)
+export type { HeroProps, HeroAction } from './components/Hero/types';

package/src/utils/logger.ts

@@ -0,0 +1,9 @@
+import { createConsola } from 'consola';
+
+const isDevelopment = process.env.NODE_ENV === 'development';
+
+export const logger = createConsola({
+  level: isDevelopment ? 4 : 1,
+}).withTag('ext-newsletter');
+
+export const newsletterLogger = logger;