@metigan/angular 1.0.0

package/src/lib/types.ts

@@ -0,0 +1,398 @@
+/**
+ * Type definitions for Metigan Angular SDK
+ * @version 1.0.0
+ */
+
+// ============================================
+// EMAIL TYPES
+// ============================================
+
+/**
+ * Email attachment interface for Angular
+ */
+export interface EmailAttachment {
+  content: ArrayBuffer | Uint8Array | string;
+  filename: string;
+  contentType: string;
+}
+
+/**
+ * Email options interface
+ */
+export interface EmailOptions {
+  /** Sender email address (or Name <email>) */
+  from: string;
+  /** List of recipient email addresses */
+  recipients: string[];
+  /** Email subject */
+  subject: string;
+  /** Email content (HTML supported) - Required if not using templateId */
+  content?: string;
+  /** Template ID for using pre-created templates (optional) */
+  templateId?: string;
+  /** Optional file attachments */
+  attachments?: File[] | EmailAttachment[];
+  /** Optional CC recipients */
+  cc?: string[];
+  /** Optional BCC recipients */
+  bcc?: string[];
+  /** Optional reply-to address */
+  replyTo?: string;
+}
+
+/**
+ * API response interface for successful email
+ */
+export interface EmailSuccessResponse {
+  success: true;
+  message: string;
+  successfulEmails: {
+    recipient: string;
+    trackingId: string;
+  }[];
+  failedEmails: {
+    recipient: string;
+    error: string;
+  }[];
+  recipientCount: number;
+  emailsRemaining: number;
+}
+
+/**
+ * API error response interfaces
+ */
+export interface EmailErrorResponse {
+  error: string;
+  message: string;
+}
+
+/**
+ * Union type for all possible API responses
+ */
+export type EmailApiResponse = EmailSuccessResponse | EmailErrorResponse;
+
+// ============================================
+// FORM TYPES
+// ============================================
+
+/**
+ * Form field types
+ */
+export type FormFieldType = 
+  | 'text'
+  | 'email'
+  | 'number'
+  | 'textarea'
+  | 'select'
+  | 'checkbox'
+  | 'radio'
+  | 'date'
+  | 'phone'
+  | 'url'
+  | 'file'
+  | 'step'
+  | 'password'
+  | 'rating'
+  | 'slider'
+  | 'heading'
+  | 'image-choice'
+  | 'matrix';
+
+/**
+ * Form field configuration
+ */
+export interface FormFieldConfig {
+  id: string;
+  type: FormFieldType;
+  label: string;
+  placeholder?: string;
+  required?: boolean;
+  helpText?: string;
+  options?: string[];
+  imageUrls?: string[];
+  defaultValue?: string | number | boolean;
+}
+
+/**
+ * Form settings
+ */
+export interface FormSettings {
+  successMessage?: string;
+  processingMessage?: string;
+  redirectUrl?: string;
+  notifyEmail?: string;
+  enableCaptcha?: boolean;
+  storeResponses?: boolean;
+  allowMultipleSubmissions?: boolean;
+  showProgressBar?: boolean;
+}
+
+/**
+ * Complete form configuration
+ */
+export interface FormConfig {
+  id?: string;
+  title: string;
+  description?: string;
+  coverImage?: string;
+  fields: FormFieldConfig[];
+  audienceId?: string;
+  settings?: FormSettings;
+  published?: boolean;
+  publishedUrl?: string;
+  slug?: string;
+  analytics?: {
+    views: number;
+    submissions: number;
+    conversionRate?: number;
+  };
+  createdAt?: Date;
+  updatedAt?: Date;
+}
+
+/**
+ * Form submission data
+ */
+export interface FormSubmissionData {
+  [fieldId: string]: any;
+}
+
+/**
+ * Form submission options
+ */
+export interface FormSubmissionOptions {
+  formId: string;
+  data: FormSubmissionData;
+}
+
+/**
+ * Form submission response
+ */
+export interface FormSubmissionResponse {
+  success: boolean;
+  message: string;
+  submissionId?: string;
+}
+
+/**
+ * Form list response
+ */
+export interface FormListResponse {
+  forms: FormConfig[];
+  pagination: {
+    total: number;
+    page: number;
+    limit: number;
+    pages: number;
+  };
+}
+
+// ============================================
+// CONTACT TYPES
+// ============================================
+
+/**
+ * Contact status
+ */
+export type ContactStatus = 'subscribed' | 'unsubscribed' | 'pending' | 'bounced' | 'complained';
+
+/**
+ * Contact data
+ */
+export interface Contact {
+  id?: string;
+  email: string;
+  firstName?: string;
+  lastName?: string;
+  phone?: string;
+  status: ContactStatus;
+  audienceId: string;
+  tags?: string[];
+  customFields?: Record<string, any>;
+  createdAt?: Date;
+  updatedAt?: Date;
+}
+
+/**
+ * Contact creation options
+ */
+export interface CreateContactOptions {
+  email: string;
+  firstName?: string;
+  lastName?: string;
+  phone?: string;
+  audienceId: string;
+  tags?: string[];
+  customFields?: Record<string, any>;
+  status?: ContactStatus;
+}
+
+/**
+ * Contact update options
+ */
+export interface UpdateContactOptions {
+  firstName?: string;
+  lastName?: string;
+  phone?: string;
+  tags?: string[];
+  customFields?: Record<string, any>;
+  status?: ContactStatus;
+}
+
+/**
+ * Contact list filters
+ */
+export interface ContactListFilters {
+  audienceId?: string;
+  status?: ContactStatus;
+  tag?: string;
+  search?: string;
+  page?: number;
+  limit?: number;
+}
+
+/**
+ * Contact list response
+ */
+export interface ContactListResponse {
+  contacts: Contact[];
+  pagination: {
+    total: number;
+    page: number;
+    limit: number;
+    pages: number;
+  };
+}
+
+/**
+ * Bulk contact operation result
+ */
+export interface BulkContactResult {
+  success: boolean;
+  imported: number;
+  failed: number;
+  errors?: { email: string; error: string }[];
+}
+
+// ============================================
+// AUDIENCE TYPES
+// ============================================
+
+/**
+ * Audience data
+ */
+export interface Audience {
+  id?: string;
+  name: string;
+  description?: string;
+  count: number;
+  createdAt?: Date;
+  updatedAt?: Date;
+}
+
+/**
+ * Audience creation options
+ */
+export interface CreateAudienceOptions {
+  name: string;
+  description?: string;
+}
+
+/**
+ * Audience update options
+ */
+export interface UpdateAudienceOptions {
+  name?: string;
+  description?: string;
+}
+
+/**
+ * Audience list response
+ */
+export interface AudienceListResponse {
+  audiences: Audience[];
+  pagination: {
+    total: number;
+    page: number;
+    limit: number;
+    pages: number;
+  };
+}
+
+/**
+ * Audience statistics
+ */
+export interface AudienceStats {
+  total: number;
+  subscribed: number;
+  unsubscribed: number;
+  pending: number;
+  bounced: number;
+  complained: number;
+  growthRate?: number;
+}
+
+// ============================================
+// TEMPLATE TYPES
+// ============================================
+
+/**
+ * Email template data
+ */
+export interface EmailTemplate {
+  id: string;
+  name: string;
+  subject: string;
+  components?: any[];
+  styles?: any;
+  createdAt?: Date;
+  updatedAt?: Date;
+}
+
+/**
+ * Email template list response
+ */
+export interface EmailTemplateListResponse {
+  templates: EmailTemplate[];
+  pagination: {
+    total: number;
+    page: number;
+    limit: number;
+    pages: number;
+  };
+}
+
+// ============================================
+// COMMON TYPES
+// ============================================
+
+/**
+ * Pagination options
+ */
+export interface PaginationOptions {
+  page?: number;
+  limit?: number;
+}
+
+/**
+ * Client options for Metigan
+ */
+export interface MetiganClientOptions {
+  /** API Key */
+  apiKey: string;
+  /** User ID for logging */
+  userId?: string;
+  /** Disable logging */
+  disableLogs?: boolean;
+  /** Request timeout in ms */
+  timeout?: number;
+  /** Number of retries */
+  retryCount?: number;
+  /** Delay between retries in ms */
+  retryDelay?: number;
+  /** Enable debug mode */
+  debug?: boolean;
+  /** Custom API URL */
+  apiUrl?: string;
+}
+

package/tsconfig.json

@@ -0,0 +1,38 @@
+{
+  "compileOnSave": false,
+  "compilerOptions": {
+    "baseUrl": "./",
+    "outDir": "./dist/out-tsc",
+    "forceConsistentCasingInFileNames": true,
+    "strict": true,
+    "noImplicitOverride": true,
+    "noPropertyAccessFromIndexSignature": true,
+    "noImplicitReturns": true,
+    "noFallthroughCasesInSwitch": true,
+    "sourceMap": true,
+    "declaration": false,
+    "declarationMap": false,
+    "downlevelIteration": true,
+    "experimentalDecorators": true,
+    "moduleResolution": "node",
+    "importHelpers": true,
+    "target": "ES2022",
+    "module": "ES2022",
+    "lib": [
+      "ES2022",
+      "dom"
+    ],
+    "paths": {
+      "@metigan/angular": [
+        "./src/public-api.ts"
+      ]
+    }
+  },
+  "angularCompilerOptions": {
+    "enableI18nLegacyMessageIdFormat": false,
+    "strictInjectionParameters": true,
+    "strictInputAccessModifiers": true,
+    "strictTemplates": true
+  }
+}
+