payload-plugin-newsletter 0.3.2 → 0.4.5

package/dist/types.d.ts

@@ -0,0 +1,350 @@
+import { Field } from 'payload';
+
+interface NewsletterPluginConfig {
+    /**
+     * Enable or disable the plugin
+     * @default true
+     */
+    enabled?: boolean;
+    /**
+     * Slug for the subscribers collection
+     * @default 'subscribers'
+     */
+    subscribersSlug?: string;
+    /**
+     * Slug for the newsletter settings collection
+     * @default 'newsletter-settings'
+     */
+    settingsSlug?: string;
+    /**
+     * Authentication configuration for magic links
+     */
+    auth?: {
+        /**
+         * Enable magic link authentication
+         * @default true
+         */
+        enabled?: boolean;
+        /**
+         * Token expiration time
+         * @default '7d'
+         */
+        tokenExpiration?: string;
+        /**
+         * Path where magic link redirects
+         * @default '/newsletter/verify'
+         */
+        magicLinkPath?: string;
+    };
+    /**
+     * Access control configuration
+     */
+    access?: {
+        /**
+         * Custom function to determine if a user is an admin
+         * @param user - The authenticated user object
+         * @returns true if the user should have admin access
+         */
+        isAdmin?: (user: any) => boolean;
+    };
+    /**
+     * Email provider configuration
+     */
+    providers: {
+        /**
+         * Default provider to use
+         */
+        default: 'resend' | 'broadcast' | string;
+        /**
+         * Resend provider configuration
+         */
+        resend?: ResendProviderConfig;
+        /**
+         * Broadcast provider configuration
+         */
+        broadcast?: BroadcastProviderConfig;
+    };
+    /**
+     * Field customization options
+     */
+    fields?: {
+        /**
+         * Override default fields
+         */
+        overrides?: (args: {
+            defaultFields: Field[];
+        }) => Field[];
+        /**
+         * Additional custom fields
+         */
+        additional?: Field[];
+    };
+    /**
+     * Email template components
+     */
+    templates?: {
+        /**
+         * Welcome email template
+         */
+        welcome?: React.ComponentType<WelcomeEmailProps>;
+        /**
+         * Magic link email template
+         */
+        magicLink?: React.ComponentType<MagicLinkEmailProps>;
+    };
+    /**
+     * Plugin hooks
+     */
+    hooks?: {
+        beforeSubscribe?: (args: BeforeSubscribeArgs) => void | Promise<void>;
+        afterSubscribe?: (args: AfterSubscribeArgs) => void | Promise<void>;
+        beforeUnsubscribe?: (args: BeforeUnsubscribeArgs) => void | Promise<void>;
+        afterUnsubscribe?: (args: AfterUnsubscribeArgs) => void | Promise<void>;
+    };
+    /**
+     * UI component overrides
+     */
+    components?: {
+        signupForm?: React.ComponentType<SignupFormProps>;
+        preferencesForm?: React.ComponentType<PreferencesFormProps>;
+    };
+    /**
+     * Feature flags
+     */
+    features?: {
+        /**
+         * Lead magnet configuration
+         */
+        leadMagnets?: {
+            enabled?: boolean;
+            collection?: string;
+        };
+        /**
+         * Post-signup survey configuration
+         */
+        surveys?: {
+            enabled?: boolean;
+            questions?: SurveyQuestion[];
+        };
+        /**
+         * UTM tracking configuration
+         */
+        utmTracking?: {
+            enabled?: boolean;
+            fields?: string[];
+        };
+        /**
+         * Newsletter scheduling configuration
+         */
+        newsletterScheduling?: {
+            enabled?: boolean;
+            /**
+             * Collections to add newsletter fields to
+             * Can be a string for single collection or array for multiple
+             * @example 'articles' or ['articles', 'posts', 'updates']
+             */
+            collections?: string | string[];
+            /**
+             * Field configuration
+             */
+            fields?: {
+                /**
+                 * Group name for newsletter fields
+                 * @default 'newsletterScheduling'
+                 */
+                groupName?: string;
+                /**
+                 * Rich text field name to use for content
+                 * @default 'content'
+                 */
+                contentField?: string;
+                /**
+                 * Whether to create a markdown companion field
+                 * @default true
+                 */
+                createMarkdownField?: boolean;
+            };
+        };
+    };
+    /**
+     * Internationalization configuration
+     */
+    i18n?: {
+        defaultLocale?: string;
+        locales?: string[];
+    };
+}
+interface ResendProviderConfig {
+    apiKey: string;
+    fromAddress?: string;
+    fromName?: string;
+    audienceIds?: {
+        [locale: string]: {
+            production?: string;
+            development?: string;
+        };
+    };
+}
+interface BroadcastProviderConfig {
+    apiUrl: string;
+    tokens: {
+        production?: string;
+        development?: string;
+    };
+    fromAddress?: string;
+    fromName?: string;
+}
+interface EmailProvider {
+    send(params: SendEmailParams): Promise<void>;
+    addContact(contact: Subscriber): Promise<void>;
+    updateContact(contact: Subscriber): Promise<void>;
+    removeContact(email: string): Promise<void>;
+}
+interface SendEmailParams {
+    to: string | string[];
+    subject: string;
+    html?: string;
+    text?: string;
+    react?: React.ReactElement;
+}
+interface Subscriber {
+    id: string;
+    email: string;
+    name?: string;
+    locale?: string;
+    subscriptionStatus: 'active' | 'unsubscribed' | 'pending';
+    emailPreferences?: {
+        newsletter?: boolean;
+        announcements?: boolean;
+        [key: string]: boolean | undefined;
+    };
+    source?: string;
+    utmParameters?: {
+        source?: string;
+        medium?: string;
+        campaign?: string;
+        content?: string;
+        term?: string;
+    };
+    createdAt: string;
+    updatedAt: string;
+}
+interface WelcomeEmailProps {
+    subscriber: Subscriber;
+    unsubscribeUrl: string;
+    preferencesUrl: string;
+}
+interface MagicLinkEmailProps {
+    magicLinkUrl: string;
+    subscriber: Subscriber;
+}
+interface SignupFormProps {
+    onSuccess?: (subscriber: Subscriber) => void;
+    onError?: (error: Error) => void;
+    showName?: boolean;
+    showPreferences?: boolean;
+    leadMagnet?: {
+        id: string;
+        title: string;
+        description?: string;
+    };
+    className?: string;
+    styles?: {
+        form?: React.CSSProperties;
+        inputGroup?: React.CSSProperties;
+        label?: React.CSSProperties;
+        input?: React.CSSProperties;
+        button?: React.CSSProperties;
+        buttonDisabled?: React.CSSProperties;
+        error?: React.CSSProperties;
+        success?: React.CSSProperties;
+        checkbox?: React.CSSProperties;
+        checkboxInput?: React.CSSProperties;
+        checkboxLabel?: React.CSSProperties;
+    };
+    apiEndpoint?: string;
+    buttonText?: string;
+    loadingText?: string;
+    successMessage?: string;
+    placeholders?: {
+        email?: string;
+        name?: string;
+    };
+    labels?: {
+        email?: string;
+        name?: string;
+        newsletter?: string;
+        announcements?: string;
+    };
+}
+interface PreferencesFormProps {
+    subscriber?: Subscriber;
+    onSuccess?: (subscriber: Subscriber) => void;
+    onError?: (error: Error) => void;
+    className?: string;
+    styles?: {
+        container?: React.CSSProperties;
+        heading?: React.CSSProperties;
+        form?: React.CSSProperties;
+        section?: React.CSSProperties;
+        sectionTitle?: React.CSSProperties;
+        inputGroup?: React.CSSProperties;
+        label?: React.CSSProperties;
+        input?: React.CSSProperties;
+        select?: React.CSSProperties;
+        checkbox?: React.CSSProperties;
+        checkboxInput?: React.CSSProperties;
+        checkboxLabel?: React.CSSProperties;
+        buttonGroup?: React.CSSProperties;
+        button?: React.CSSProperties;
+        primaryButton?: React.CSSProperties;
+        secondaryButton?: React.CSSProperties;
+        dangerButton?: React.CSSProperties;
+        error?: React.CSSProperties;
+        success?: React.CSSProperties;
+        info?: React.CSSProperties;
+    };
+    sessionToken?: string;
+    apiEndpoint?: string;
+    showUnsubscribe?: boolean;
+    locales?: string[];
+    labels?: {
+        title?: string;
+        personalInfo?: string;
+        emailPreferences?: string;
+        name?: string;
+        language?: string;
+        newsletter?: string;
+        announcements?: string;
+        saveButton?: string;
+        unsubscribeButton?: string;
+        saving?: string;
+        saved?: string;
+        unsubscribeConfirm?: string;
+    };
+}
+interface BeforeSubscribeArgs {
+    data: Partial<Subscriber>;
+    req: any;
+}
+interface AfterSubscribeArgs {
+    doc: Subscriber;
+    req: any;
+}
+interface BeforeUnsubscribeArgs {
+    email: string;
+    req: any;
+}
+interface AfterUnsubscribeArgs {
+    doc: Subscriber;
+    req: any;
+}
+interface SurveyQuestion {
+    id: string;
+    question: string;
+    type: 'text' | 'select' | 'multiselect' | 'radio';
+    options?: string[];
+    required?: boolean;
+}
+
+export type { AfterSubscribeArgs, AfterUnsubscribeArgs, BeforeSubscribeArgs, BeforeUnsubscribeArgs, BroadcastProviderConfig, EmailProvider, MagicLinkEmailProps, NewsletterPluginConfig, PreferencesFormProps, ResendProviderConfig, SendEmailParams, SignupFormProps, Subscriber, SurveyQuestion, WelcomeEmailProps };

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

@@ -1,47 +1,69 @@
 {
   "name": "payload-plugin-newsletter",
-  "version": "0.3.2",
+  "version": "0.4.5",
   "description": "Complete newsletter management plugin for Payload CMS with subscriber management, magic link authentication, and email service integration",
   "type": "module",
-  "main": "./src/index.ts",
-  "types": "./src/index.ts",
+  "main": "./dist/index.js",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
   "exports": {
     ".": {
-      "import": "./src/index.ts",
-      "types": "./src/index.ts",
-      "default": "./src/index.ts"
+      "import": {
+        "types": "./dist/index.d.ts",
+        "default": "./dist/index.js"
+      },
+      "require": {
+        "types": "./dist/index.d.cts",
+        "default": "./dist/index.cjs"
+      }
     },
     "./client": {
-      "import": "./src/exports/client.ts",
-      "types": "./src/exports/client.ts",
-      "default": "./src/exports/client.ts"
+      "import": {
+        "types": "./dist/client.d.ts",
+        "default": "./dist/client.js"
+      },
+      "require": {
+        "types": "./dist/client.d.cts",
+        "default": "./dist/client.cjs"
+      }
     },
     "./types": {
-      "import": "./src/exports/types.ts",
-      "types": "./src/exports/types.ts",
-      "default": "./src/exports/types.ts"
+      "import": {
+        "types": "./dist/types.d.ts",
+        "default": "./dist/types.js"
+      },
+      "require": {
+        "types": "./dist/types.d.cts",
+        "default": "./dist/types.cjs"
+      }
     },
     "./components": {
-      "import": "./src/exports/components.ts",
-      "types": "./src/exports/components.ts",
-      "default": "./src/exports/components.ts"
+      "import": {
+        "types": "./dist/components.d.ts",
+        "default": "./dist/components.js"
+      },
+      "require": {
+        "types": "./dist/components.d.cts",
+        "default": "./dist/components.cjs"
+      }
     }
   },
   "scripts": {
-    "build": "bun run build:swc && bun run build:types",
-    "build:swc": "swc ./src -d ./dist --copy-files",
+    "build": "tsup",
+    "build:legacy": "bun run build:swc && bun run build:types",
+    "build:swc": "swc ./src -d ./dist --copy-files --ignore '**/*.test.ts' --ignore '**/*.test.tsx' --ignore '**/__tests__/**'",
     "build:types": "tsc --emitDeclarationOnly --outDir dist",
-    "dev": "bun run build:swc --watch",
+    "dev": "tsup --watch",
     "clean": "rimraf dist",
     "lint": "eslint src",
     "typecheck": "tsc --noEmit",
-    "test": "vitest",
-    "test:unit": "vitest run",
-    "test:integration": "vitest run --config vitest.integration.config.ts",
-    "test:security": "vitest run --config vitest.integration.config.ts src/__tests__/security",
-    "test:watch": "vitest watch",
-    "test:coverage": "vitest run --coverage",
-    "test:ui": "vitest --ui",
+    "test": "npm exec vitest run",
+    "test:unit": "npm exec vitest run",
+    "test:integration": "npm exec vitest run -- --config vitest.integration.config.ts",
+    "test:security": "npm exec vitest run -- --config vitest.integration.config.ts src/__tests__/security",
+    "test:watch": "npm exec vitest watch",
+    "test:coverage": "npm exec vitest run -- --coverage",
+    "test:ui": "npm exec vitest -- --ui",
     "generate:types": "tsc --emitDeclarationOnly --outDir dist",
     "prepublishOnly": "bun run clean && bun run build",
     "release:patch": "./scripts/release.sh patch",
@@ -116,6 +138,7 @@
     "react": "^18.3.0",
     "react-dom": "^18.3.0",
     "rimraf": "^6.0.0",
+    "tsup": "^8.3.5",
     "typescript": "^5.5.0",
     "vitest": "^3.2.3"
   },