@easyling/sanity-connector 1.4.0 → 2.0.0

package/dist-types/types/translation.d.ts

@@ -1,121 +0,0 @@
-/**
- * Enhanced translation request/response type definitions
- * Requirements: 5.1, 5.2, 5.3
- */
-/**
- * Enhanced translation request with locale support
- */
-export interface EnhancedTranslationRequest {
-    /** Unique identifier for the document */
-    documentId: string;
-    /** Sanity document type */
-    documentType: string;
-    /** HTML content to translate */
-    htmlContent: string;
-    /** Array of target locale codes */
-    targetLocales: string[];
-    /** Optional source locale code */
-    sourceLocale?: string;
-    /** Request metadata */
-    metadata: {
-        /** Document title */
-        title: string;
-        /** Request timestamp */
-        timestamp: string;
-        /** Plugin version */
-        pluginVersion: string;
-        /** Unique request identifier */
-        requestId: string;
-    };
-}
-/**
- * Enhanced translation response with multi-locale support
- */
-export interface EnhancedTranslationResponse {
-    /** Whether the overall request was successful */
-    success: boolean;
-    /** Unique request identifier */
-    requestId: string;
-    /** Source locale code */
-    sourceLocale?: string;
-    /** Translations for each requested locale */
-    translations: {
-        [localeCode: string]: {
-            /** Translated content */
-            content: string;
-            /** Translation status */
-            status: 'completed' | 'failed' | 'pending';
-            /** Error message if translation failed */
-            error?: string;
-        };
-    };
-    /** Overall error message if request failed */
-    error?: string;
-}
-/**
- * Translation progress information
- */
-export interface TranslationProgress {
-    /** Total number of translations requested */
-    total: number;
-    /** Number of completed translations */
-    completed: number;
-    /** Number of failed translations */
-    failed: number;
-    /** Number of pending translations */
-    pending: number;
-    /** Current translation being processed */
-    current?: {
-        documentId: string;
-        locale: string;
-    };
-}
-/**
- * Bulk translation request with locale selection
- */
-export interface BulkTranslationRequest {
-    /** Array of document IDs to translate */
-    documentIds: string[];
-    /** Array of target locale codes */
-    targetLocales: string[];
-    /** Optional source locale code */
-    sourceLocale?: string;
-    /** Request metadata */
-    metadata: {
-        /** Request timestamp */
-        timestamp: string;
-        /** Plugin version */
-        pluginVersion: string;
-        /** Unique request identifier */
-        requestId: string;
-    };
-}
-/**
- * Bulk translation summary with locale breakdown
- */
-export interface EnhancedBulkTranslationSummary {
-    /** Total number of documents processed */
-    totalDocuments: number;
-    /** Total number of locale translations requested */
-    totalTranslations: number;
-    /** Number of successful translations */
-    successfulTranslations: number;
-    /** Number of failed translations */
-    failedTranslations: number;
-    /** Breakdown by locale */
-    localeBreakdown: {
-        [localeCode: string]: {
-            /** Number of successful translations for this locale */
-            successful: number;
-            /** Number of failed translations for this locale */
-            failed: number;
-            /** Error messages for failed translations */
-            errors: string[];
-        };
-    };
-    /** Individual translation requests */
-    requests: EnhancedTranslationRequest[];
-    /** Individual translation responses */
-    responses: EnhancedTranslationResponse[];
-}
-export type { TranslationRequestPayload, TranslationResponse, TranslatableField } from '../services/translationService';

package/dist-types/utils/dntDefaults.d.ts

@@ -1,101 +0,0 @@
-/**
- * DNT (Do Not Translate) Defaults Utility
- *
- * Determines whether a field should default to DNT based on:
- * - Field type (slug, date, datetime, reference, image, file, geopoint, number, boolean)
- * - Field name patterns (containing "author" or "contributor")
- * - Group/fieldset name patterns (containing "date" or "time")
- */
-/**
- * Field types that are inherently non-translatable
- * These fields contain data that should not be modified by translation
- */
-export declare const NON_TRANSLATABLE_TYPES: string[];
-/**
- * Field name patterns that indicate DNT by default (case-insensitive)
- * Fields with names containing these strings should not be translated
- */
-export declare const DNT_FIELD_NAME_PATTERNS: string[];
-/**
- * Group/fieldset name patterns that indicate all contained fields should be DNT (case-insensitive)
- */
-export declare const DNT_GROUP_NAME_PATTERNS: string[];
-/**
- * Context information about a field's location in the schema
- */
-export interface FieldContext {
-    /** The field path (e.g., 'title', 'content.author') */
-    fieldPath: string;
-    /** The field name (last segment of path) */
-    fieldName: string;
-    /** The Sanity field type (e.g., 'string', 'date', 'slug') */
-    fieldType?: string;
-    /** Name of the group this field belongs to, if any */
-    groupName?: string;
-    /** Name of the fieldset this field belongs to, if any */
-    fieldsetName?: string;
-}
-/**
- * Result of DNT default computation
- */
-export interface DNTDefaultResult {
-    /** Whether the field should default to DNT */
-    shouldBeDNT: boolean;
-    /** Reason for the DNT default decision */
-    reason: string;
-}
-/**
- * Check if a field type is inherently non-translatable
- *
- * @param fieldType - The Sanity field type
- * @returns True if the field type should not be translated
- */
-export declare function isNonTranslatableType(fieldType: string | undefined): boolean;
-/**
- * Check if a field name matches DNT patterns
- *
- * @param fieldName - The field name to check
- * @returns Object with match status and matched pattern
- */
-export declare function matchesDNTFieldNamePattern(fieldName: string): {
-    matches: boolean;
-    pattern?: string;
-};
-/**
- * Check if a group or fieldset name matches DNT patterns
- *
- * @param groupOrFieldsetName - The group or fieldset name to check
- * @returns Object with match status and matched pattern
- */
-export declare function matchesDNTGroupPattern(groupOrFieldsetName: string | undefined): {
-    matches: boolean;
-    pattern?: string;
-};
-/**
- * Compute the default DNT status for a field based on its context
- *
- * Priority order:
- * 1. Non-translatable field type (slug, date, etc.)
- * 2. Field name contains "author" or "contributor"
- * 3. Field is in a group/fieldset containing "date" or "time"
- *
- * @param context - Field context information
- * @returns DNT default result with reason
- */
-export declare function computeDNTDefault(context: FieldContext): DNTDefaultResult;
-/**
- * Determine if a field should show DNT badge based on translatability
- * Only translatable field types should show the badge
- *
- * @param fieldType - The Sanity field type
- * @returns True if the field should show a DNT badge
- */
-export declare function shouldShowDNTBadge(fieldType: string | undefined): boolean;
-/**
- * Get a human-readable description of the DNT status for debugging
- *
- * @param context - Field context information
- * @param storedDNT - The stored DNT status (if any)
- * @returns Debug description
- */
-export declare function getDNTDebugInfo(context: FieldContext, storedDNT?: boolean): string;

package/dist-types/utils/htmlFormatter.d.ts

@@ -1,65 +0,0 @@
-/**
- * HTML formatting utilities for content processing
- * Requirements: 3.3, 3.4 - Proper HTML formatting and special character escaping
- */
-export interface HtmlFormattingOptions {
-    preserveWhitespace?: boolean;
-    escapeSpecialChars?: boolean;
-    minifyOutput?: boolean;
-    addLineBreaks?: boolean;
-}
-export declare class HtmlFormatter {
-    /**
-     * Escape HTML special characters for JSON transmission
-     * Requirement 3.4: Properly escape special characters for JSON transmission
-     */
-    static escapeHtml(text: string): string;
-    /**
-     * Unescape HTML entities back to regular characters
-     */
-    static unescapeHtml(html: string): string;
-    /**
-     * Format HTML content with proper structure and indentation
-     * Requirement 3.2: Preserve text structure including paragraphs, lists, and formatting
-     */
-    static formatHtml(html: string, options?: HtmlFormattingOptions): string;
-    /**
-     * Clean HTML content by removing unwanted tags and attributes
-     */
-    static cleanHtml(html: string, allowedTags?: string[]): string;
-    /**
-     * Wrap content in appropriate HTML structure
-     * Requirement 3.3: Include HTML content in structured format
-     */
-    static wrapContent(content: string, wrapper?: string, className?: string): string;
-    /**
-     * Extract text content from HTML, removing all tags
-     */
-    static stripHtml(html: string): string;
-    /**
-     * Validate HTML structure and check for common issues
-     */
-    static validateHtml(html: string): {
-        isValid: boolean;
-        errors: string[];
-    };
-    /**
-     * Convert line breaks to HTML paragraphs
-     */
-    static lineBreaksToParagraphs(text: string): string;
-    /**
-     * Truncate HTML content while preserving structure
-     */
-    static truncateHtml(html: string, maxLength: number, suffix?: string): string;
-}
-export declare const htmlFormatter: {
-    escapeHtml: typeof HtmlFormatter.escapeHtml;
-    unescapeHtml: typeof HtmlFormatter.unescapeHtml;
-    formatHtml: typeof HtmlFormatter.formatHtml;
-    cleanHtml: typeof HtmlFormatter.cleanHtml;
-    wrapContent: typeof HtmlFormatter.wrapContent;
-    stripHtml: typeof HtmlFormatter.stripHtml;
-    validateHtml: typeof HtmlFormatter.validateHtml;
-    lineBreaksToParagraphs: typeof HtmlFormatter.lineBreaksToParagraphs;
-    truncateHtml: typeof HtmlFormatter.truncateHtml;
-};

package/dist-types/utils/index.d.ts

@@ -1,16 +0,0 @@
-/**
- * Utility functions for the Sanity Translation Plugin
- * Requirements: 3.3, 3.4, 4.3
- */
-export * from './htmlFormatter';
-export * from './logger';
-export * from './validator';
-export * from './oauthLogger';
-export * from './oauthErrorFeedback';
-export * from './dntDefaults';
-export { HtmlFormatter } from './htmlFormatter';
-export { Logger, LogLevel, defaultLogger } from './logger';
-export { Validator } from './validator';
-export { OAuthLogger, createOAuthLogger } from './oauthLogger';
-export { OAuthErrorFeedback, createOAuthErrorFeedback } from './oauthErrorFeedback';
-export { computeDNTDefault, isNonTranslatableType, matchesDNTFieldNamePattern, matchesDNTGroupPattern, NON_TRANSLATABLE_TYPES, DNT_FIELD_NAME_PATTERNS, DNT_GROUP_NAME_PATTERNS } from './dntDefaults';

package/dist-types/utils/logger.d.ts

@@ -1,104 +0,0 @@
-/**
- * Logging utilities with structured output
- * Requirements: 4.3 - Clear error messages and structured logging
- */
-export declare enum LogLevel {
-    DEBUG = 0,
-    INFO = 1,
-    WARN = 2,
-    ERROR = 3
-}
-export interface LogEntry {
-    timestamp: string;
-    level: LogLevel;
-    message: string;
-    context?: Record<string, any>;
-    error?: Error;
-}
-export interface LoggerConfig {
-    level: LogLevel;
-    enableConsole: boolean;
-    enableStructuredOutput: boolean;
-    prefix?: string;
-}
-export declare class Logger {
-    private config;
-    constructor(config?: Partial<LoggerConfig>);
-    /**
-     * Log debug message
-     */
-    debug(message: string, context?: Record<string, any>): void;
-    /**
-     * Log info message
-     */
-    info(message: string, context?: Record<string, any>): void;
-    /**
-     * Log warning message
-     */
-    warn(message: string, context?: Record<string, any>): void;
-    /**
-     * Log error message
-     * Requirement 4.3: Display clear error messages
-     */
-    error(message: string, error?: Error, context?: Record<string, any>): void;
-    /**
-     * Log translation request with structured format
-     * Requirements: 1.3, 2.4 - Log request body to console for verification
-     */
-    logTranslationRequest(documentId: string, endpoint: string, payload: any): void;
-    /**
-     * Log bulk translation summary
-     * Requirement 2.5: Display summary of processed documents
-     */
-    logBulkTranslationSummary(summary: {
-        totalDocuments: number;
-        processedDocuments: number;
-        failedDocuments: number;
-        duration?: number;
-    }): void;
-    /**
-     * Log document processing progress
-     */
-    logProgress(current: number, total: number, documentId?: string): void;
-    /**
-     * Log validation errors
-     * Requirement 4.3: Clear error messages for validation failures
-     */
-    logValidationError(type: string, errors: string[], context?: Record<string, any>): void;
-    /**
-     * Log performance metrics
-     */
-    logPerformance(operation: string, duration: number, context?: Record<string, any>): void;
-    /**
-     * Core logging method
-     */
-    private log;
-    /**
-     * Output log entry to console with appropriate formatting
-     */
-    private outputToConsole;
-    /**
-     * Serialize error object for logging
-     */
-    private serializeError;
-    /**
-     * Update logger configuration
-     */
-    updateConfig(config: Partial<LoggerConfig>): void;
-    /**
-     * Get current configuration
-     */
-    getConfig(): LoggerConfig;
-}
-export declare const defaultLogger: Logger;
-export declare const logger: {
-    debug: (message: string, context?: Record<string, any>) => void;
-    info: (message: string, context?: Record<string, any>) => void;
-    warn: (message: string, context?: Record<string, any>) => void;
-    error: (message: string, error?: Error, context?: Record<string, any>) => void;
-    logTranslationRequest: (documentId: string, endpoint: string, payload: any) => void;
-    logBulkTranslationSummary: (summary: any) => void;
-    logProgress: (current: number, total: number, documentId?: string) => void;
-    logValidationError: (type: string, errors: string[], context?: Record<string, any>) => void;
-    logPerformance: (operation: string, duration: number, context?: Record<string, any>) => void;
-};

package/dist-types/utils/oauthErrorFeedback.d.ts

@@ -1,75 +0,0 @@
-/**
- * OAuth Error Feedback Utility
- *
- * Provides user-friendly error feedback for OAuth authentication errors
- * using Sanity UI toast notifications and dialogs.
- *
- * Requirements: 7.2, 7.3, 7.4
- */
-import { OAuthError, OAuthErrorType } from '../types/oauth';
-import { DialogService } from '../services/dialogService';
-/**
- * OAuth Error Feedback Handler
- *
- * Provides methods for displaying user-friendly error messages
- * with appropriate help text and retry options.
- */
-export declare class OAuthErrorFeedback {
-    private dialogService;
-    /**
-     * Create a new OAuth error feedback handler
-     *
-     * @param dialogService - Dialog service instance
-     */
-    constructor(dialogService: DialogService);
-    /**
-     * Show an error dialog for an OAuth error
-     *
-     * Requirements: 7.2, 7.3, 7.4
-     *
-     * @param error - OAuth error to display
-     * @param onRetry - Optional callback for retry action
-     * @returns Promise that resolves to true if user clicked retry, false otherwise
-     */
-    showError(error: OAuthError, onRetry?: () => void): Promise<boolean>;
-    /**
-     * Show an error dialog for a generic error
-     *
-     * Requirements: 7.2, 7.3
-     *
-     * @param message - Error message to display
-     * @param details - Optional additional details
-     * @param showRetry - Whether to show retry button
-     * @param onRetry - Optional callback for retry action
-     * @returns Promise that resolves to true if user clicked retry, false otherwise
-     */
-    showGenericError(message: string, details?: string, showRetry?: boolean, onRetry?: () => void): Promise<boolean>;
-    /**
-     * Show a success message
-     *
-     * @param message - Success message to display
-     * @param details - Optional additional details
-     */
-    showSuccess(message: string, details?: string): void;
-    /**
-     * Get help text for a specific error type
-     *
-     * @param errorType - OAuth error type
-     * @returns Help text for the error type
-     */
-    getHelpText(errorType: OAuthErrorType): string;
-    /**
-     * Format an error for logging (sanitizes sensitive data)
-     *
-     * @param error - Error to format
-     * @returns Formatted error object safe for logging
-     */
-    formatErrorForLogging(error: OAuthError): Record<string, unknown>;
-}
-/**
- * Create an OAuth error feedback handler
- *
- * @param dialogService - Dialog service instance
- * @returns OAuth error feedback handler
- */
-export declare function createOAuthErrorFeedback(dialogService: DialogService): OAuthErrorFeedback;

package/dist-types/utils/oauthLogger.d.ts

@@ -1,175 +0,0 @@
-/**
- * OAuth Logger Utility
- *
- * Provides structured logging for OAuth authentication events with timestamps
- * and component identification. Never logs sensitive data like tokens or secrets.
- *
- * Requirements: 7.1, 8.5
- */
-/**
- * Log level enumeration
- */
-export declare enum LogLevel {
-    INFO = "info",
-    WARN = "warn",
-    ERROR = "error"
-}
-/**
- * OAuth component identifier
- */
-export type OAuthComponent = 'OAuthService' | 'TokenStorage' | 'AuthStateManager' | 'OAuthCallback' | 'AuthStatus' | 'TranslationService';
-/**
- * OAuth log entry structure
- */
-export interface OAuthLogEntry {
-    /** ISO timestamp of the log entry */
-    timestamp: string;
-    /** Log level */
-    level: LogLevel;
-    /** Component that generated the log */
-    component: OAuthComponent;
-    /** Event name or description */
-    event: string;
-    /** Optional additional details (never contains sensitive data) */
-    details?: Record<string, unknown>;
-}
-/**
- * OAuth Logger
- *
- * Provides structured logging methods for OAuth-related events.
- * Automatically sanitizes sensitive data from log output.
- */
-export declare class OAuthLogger {
-    private component;
-    /**
-     * Create a new OAuth logger for a specific component
-     *
-     * @param component - Component identifier
-     */
-    constructor(component: OAuthComponent);
-    /**
-     * Sanitize details object to remove sensitive data
-     *
-     * @param details - Details object to sanitize
-     * @returns Sanitized details object
-     */
-    private sanitizeDetails;
-    /**
-     * Create a log entry
-     *
-     * @param level - Log level
-     * @param event - Event name
-     * @param details - Optional details
-     * @returns OAuth log entry
-     */
-    private createLogEntry;
-    /**
-     * Format log entry for console output
-     *
-     * @param entry - OAuth log entry to format
-     * @returns Formatted log message
-     */
-    private formatLogEntry;
-    /**
-     * Log an info-level event
-     *
-     * @param event - Event name
-     * @param details - Optional details
-     */
-    info(event: string, details?: Record<string, unknown>): void;
-    /**
-     * Log a warning-level event
-     *
-     * @param event - Event name
-     * @param details - Optional details
-     */
-    warn(event: string, details?: Record<string, unknown>): void;
-    /**
-     * Log an error-level event
-     *
-     * @param event - Event name
-     * @param details - Optional details
-     */
-    error(event: string, details?: Record<string, unknown>): void;
-    /**
-     * Log OAuth flow initiation
-     *
-     * @param authUrl - Authorization URL (without sensitive params)
-     */
-    logFlowInitiation(authUrl: string): void;
-    /**
-     * Log OAuth callback received
-     *
-     * @param hasCode - Whether authorization code was received
-     * @param hasError - Whether error was received
-     * @param projectId - Project ID if available
-     */
-    logCallbackReceived(hasCode: boolean, hasError: boolean, projectId?: string): void;
-    /**
-     * Log token exchange attempt
-     */
-    logTokenExchange(): void;
-    /**
-     * Log token exchange success
-     *
-     * @param expiresIn - Token expiration time in seconds
-     * @param hasRefreshToken - Whether refresh token was received
-     */
-    logTokenExchangeSuccess(expiresIn: number, hasRefreshToken: boolean): void;
-    /**
-     * Log token exchange failure
-     *
-     * @param error - Error message
-     * @param statusCode - HTTP status code if available
-     */
-    logTokenExchangeFailure(error: string, statusCode?: number): void;
-    /**
-     * Log token refresh attempt
-     */
-    logTokenRefresh(): void;
-    /**
-     * Log token refresh success
-     *
-     * @param expiresIn - New token expiration time in seconds
-     */
-    logTokenRefreshSuccess(expiresIn: number): void;
-    /**
-     * Log token refresh failure
-     *
-     * @param error - Error message
-     */
-    logTokenRefreshFailure(error: string): void;
-    /**
-     * Log authentication state change
-     *
-     * @param fromState - Previous state
-     * @param toState - New state
-     * @param projectId - Project ID if available
-     */
-    logStateChange(fromState: string, toState: string, projectId?: string): void;
-    /**
-     * Log logout event
-     */
-    logLogout(): void;
-    /**
-     * Log storage operation
-     *
-     * @param operation - Operation type (store, retrieve, clear)
-     * @param success - Whether operation succeeded
-     */
-    logStorageOperation(operation: 'store' | 'retrieve' | 'clear', success: boolean): void;
-    /**
-     * Sanitize URL to remove sensitive query parameters
-     *
-     * @param url - URL to sanitize
-     * @returns Sanitized URL string
-     */
-    private sanitizeUrl;
-}
-/**
- * Create a logger instance for a specific component
- *
- * @param component - Component identifier
- * @returns Logger instance
- */
-export declare function createOAuthLogger(component: OAuthComponent): OAuthLogger;