@easyling/sanity-connector 1.3.0 → 2.0.0

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

@@ -1,83 +0,0 @@
-/**
- * DNT (Do Not Translate) field preferences types
- */
-export interface DNTFieldPreference {
-    /** Field path (e.g., 'title', 'content.description') */
-    fieldPath: string;
-    /** Whether this field should not be translated */
-    dnt: boolean;
-    /** Timestamp when preference was set */
-    updatedAt?: string;
-}
-/**
- * Legacy document-specific DNT preferences (deprecated)
- * @deprecated Use document-type-based DNT configuration instead
- */
-export interface DNTPreferences {
-    /** Document ID these preferences apply to */
-    documentId: string;
-    /** Document type */
-    documentType: string;
-    /** Field-level DNT preferences */
-    fields: Record<string, boolean>;
-    /** Last updated timestamp */
-    updatedAt: string;
-}
-/**
- * Document-type-based DNT field configuration
- * When a field is marked DNT for a document type, it applies to ALL documents of that type
- */
-export interface DNTTypeConfig {
-    /** Document type (e.g., 'product', 'article', 'page') */
-    documentType: string;
-    /** Field-level DNT preferences: { [fieldPath]: dnt } */
-    fields: Record<string, boolean>;
-}
-/**
- * DNT Storage interface - supports document-type-based configuration
- */
-export interface DNTStorage {
-    /**
-     * Get DNT field configuration for a document type
-     * @param documentType - The type of document (e.g., 'product', 'article')
-     * @returns Map of field paths to DNT status
-     */
-    getFieldsForType(documentType: string): Promise<Record<string, boolean>>;
-    /**
-     * Set DNT status for a specific field in a document type
-     * @param documentType - The type of document
-     * @param fieldPath - The field path
-     * @param dnt - Whether the field should not be translated
-     */
-    setFieldDNT(documentType: string, fieldPath: string, dnt: boolean): Promise<void>;
-    /**
-     * Toggle DNT status for a field in a document type
-     * @param documentType - The type of document
-     * @param fieldPath - The field path
-     * @returns The new DNT status
-     */
-    toggleFieldDNT(documentType: string, fieldPath: string): Promise<boolean>;
-    /**
-     * Get DNT status for a specific field in a document type
-     * @param documentType - The type of document
-     * @param fieldPath - The field path
-     * @returns Whether the field is marked as DNT
-     */
-    getFieldDNT(documentType: string, fieldPath: string): Promise<boolean>;
-    /**
-     * Clear all DNT fields for a document type
-     * @param documentType - The type of document
-     */
-    clearFieldsForType(documentType: string): Promise<void>;
-    /**
-     * Get all DNT configurations (all document types)
-     * @returns Map of document types to their field DNT configurations
-     */
-    getAllDNTFields(): Promise<Record<string, Record<string, boolean>>>;
-    /** @deprecated Use getFieldsForType instead */
-    getPreferences?(documentId: string): Promise<DNTPreferences | null>;
-    /** @deprecated Use setFieldDNT instead */
-    savePreferences?(preferences: DNTPreferences): Promise<void>;
-    /** @deprecated Use clearFieldsForType instead */
-    clearPreferences?(documentId: string): Promise<void>;
-}

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

@@ -1,11 +0,0 @@
-/**
- * Type definitions index
- * Centralized exports for all plugin types
- */
-export type { LocaleDefinition, LocaleConfig, LocaleValidationResult, LocaleSelectionOptions } from './locale';
-export type { BaseDialogOptions, ConfirmationDialogOptions, SuccessDialogOptions, ErrorDialogOptions, LocaleSelectionDialogOptions, DialogResult, DialogManager } from './dialog';
-export type { EnhancedTranslationRequest, EnhancedTranslationResponse, TranslationProgress, BulkTranslationRequest, EnhancedBulkTranslationSummary, TranslationRequestPayload, TranslationResponse, TranslatableField } from './translation';
-export type { OAuthConfig, AuthenticationResult, StoredAuthData, AuthState, AuthStateData } from './oauth';
-export { OAuthErrorType, OAuthError } from './oauth';
-export type { DNTFieldPreference, DNTPreferences, DNTTypeConfig, DNTStorage } from './dnt';
-export type { PluginConfiguration, DocumentCreationMode, ContentType } from './pluginConfig';

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

@@ -1,115 +0,0 @@
-/**
- * Locale configuration type definitions
- * Requirements: 5.1, 5.2, 5.3
- */
-/**
- * Individual locale definition with metadata
- */
-export interface LocaleDefinition {
-    /** Locale code in ISO 639-1 + ISO 3166-1 format (e.g., "en-US", "fr-FR") */
-    code: string;
-    /** Human-readable display name (e.g., "English (United States)") */
-    displayName: string;
-    /** Whether this locale is enabled for translation */
-    enabled: boolean;
-    /** Timestamp when this locale was created */
-    createdAt: string;
-    /** Timestamp when this locale was last updated */
-    updatedAt: string;
-}
-/**
- * Complete locale configuration for the plugin
- */
-export interface LocaleConfig {
-    /** Array of configured locales */
-    locales: LocaleDefinition[];
-    /** Optional default locale code */
-    defaultLocale?: string;
-    /** Timestamp when configuration was last updated */
-    lastUpdated: string;
-    /** Configuration version for migration purposes */
-    version: string;
-}
-/**
- * Validation result for locale operations
- */
-export interface LocaleValidationResult {
-    /** Whether the validation passed */
-    isValid: boolean;
-    /** Array of validation error messages */
-    errors: string[];
-    /** Array of validation warning messages */
-    warnings: string[];
-}
-/**
- * Options for locale selection operations
- */
-export interface LocaleSelectionOptions {
-    /** Available locales to choose from */
-    availableLocales: LocaleDefinition[];
-    /** Currently selected locale codes */
-    selectedLocales: string[];
-    /** Whether multiple locales can be selected */
-    allowMultiple: boolean;
-    /** Whether selection is required (cannot be empty) */
-    required: boolean;
-}
-/**
- * Locale code validation regex (ISO 639-1 + ISO 3166-1 format)
- * Format: two lowercase letters, hyphen, two uppercase letters (e.g., en-US, fr-FR)
- */
-export declare const LOCALE_CODE_REGEX: RegExp;
-/**
- * Validates a locale code format
- * Requirements: 1.2, 1.3
- *
- * @param code - The locale code to validate
- * @returns True if the code matches ISO 639-1 + ISO 3166-1 format
- *
- * @example
- * validateLocaleCode('en-US') // true
- * validateLocaleCode('fr-FR') // true
- * validateLocaleCode('en_US') // false
- * validateLocaleCode('EN-US') // false
- * validateLocaleCode('e-US') // false
- */
-export declare function validateLocaleCode(code: string): boolean;
-/**
- * Validates a locale definition object
- * Requirements: 1.2, 1.3
- *
- * @param locale - The locale definition to validate
- * @returns Validation result with errors and warnings
- */
-export declare function validateLocaleDefinition(locale: Partial<LocaleDefinition>): LocaleValidationResult;
-/**
- * Validates a locale configuration object
- * Requirements: 1.2, 1.3
- *
- * @param config - The locale configuration to validate
- * @returns Validation result with errors and warnings
- */
-export declare function validateLocaleConfig(config: Partial<LocaleConfig>): LocaleValidationResult;
-/**
- * Checks if a locale code exists in a locale configuration
- *
- * @param config - The locale configuration to search
- * @param code - The locale code to find
- * @returns True if the locale code exists in the configuration
- */
-export declare function localeExists(config: LocaleConfig, code: string): boolean;
-/**
- * Gets enabled locales from a configuration
- *
- * @param config - The locale configuration
- * @returns Array of enabled locale definitions
- */
-export declare function getEnabledLocales(config: LocaleConfig): LocaleDefinition[];
-/**
- * Finds a locale definition by code
- *
- * @param config - The locale configuration to search
- * @param code - The locale code to find
- * @returns The locale definition or undefined if not found
- */
-export declare function findLocaleByCode(config: LocaleConfig, code: string): LocaleDefinition | undefined;

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

@@ -1,89 +0,0 @@
-/**
- * Easyling Authentication Type Definitions
- *
- * This file contains all TypeScript interfaces, types, and enums
- * for Easyling authentication implementation in the Sanity Translation Plugin.
- */
-/**
- * Easyling configuration for connecting to the translation service
- */
-export interface OAuthConfig {
-    /** Project ID for the Easyling project */
-    projectId: string;
-    /** Long-lived access token provided by Easyling */
-    accessToken: string;
-}
-/**
- * Result of the authentication process
- */
-export interface AuthenticationResult {
-    /** Whether authentication was successful */
-    success: boolean;
-    /** Access token if authentication succeeded */
-    accessToken?: string;
-    /** Selected project ID if authentication succeeded */
-    projectId?: string;
-    /** Error message if authentication failed */
-    error?: string;
-}
-/**
- * Stored authentication data persisted in storage
- */
-export interface StoredAuthData {
-    /** Access token for API requests */
-    accessToken: string;
-    /** Selected project ID */
-    projectId: string;
-    /** Optional project name for display purposes */
-    projectName?: string;
-    /** Timestamp when data was stored (Unix timestamp in milliseconds) */
-    storedAt: number;
-}
-/**
- * Authentication state enumeration
- */
-export type AuthState = 'unauthenticated' | 'authenticated' | 'error';
-/**
- * Authentication state data with additional context
- */
-export interface AuthStateData {
-    /** Current authentication state */
-    state: AuthState;
-    /** Selected project ID if authenticated */
-    projectId?: string;
-    /** Project name for display if available */
-    projectName?: string;
-    /** Error message if state is 'error' */
-    error?: string;
-}
-/**
- * Authentication error types for categorizing failures
- */
-export declare enum OAuthErrorType {
-    /** Invalid configuration */
-    INVALID_CONFIG = "invalid_config",
-    /** Network error during API request */
-    NETWORK_ERROR = "network_error",
-    /** Authentication failed */
-    AUTH_FAILED = "auth_failed",
-    /** Storage operation failed */
-    STORAGE_ERROR = "storage_error"
-}
-/**
- * Custom error class for OAuth-related errors
- */
-export declare class OAuthError extends Error {
-    /** Error type for categorization */
-    readonly type: OAuthErrorType;
-    /** Additional error details */
-    readonly details?: unknown;
-    constructor(type: OAuthErrorType, message: string, details?: unknown);
-    /**
-     * Get a user-friendly error message based on error type
-     */
-    getUserMessage(): string;
-    /**
-     * Check if this error is recoverable (user can retry)
-     */
-    isRecoverable(): boolean;
-}

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

@@ -1,46 +0,0 @@
-/**
- * Plugin configuration type definitions
- * Requirements: 1.1, 1.5, 2.3, 3.3, 4.2
- */
-import { LocaleDefinition } from './locale';
-import { DNTTypeConfig } from './dnt';
-/**
- * Document creation mode options
- * Determines whether translated documents are created as drafts or published
- */
-export type DocumentCreationMode = 'draft' | 'published';
-/**
- * Content type options for requests/responses
- * Specifies the serialization format for translation API communication
- */
-export type ContentType = 'application/json' | 'application/x-protobuf';
-/**
- * Complete plugin configuration interface
- * Represents all configurable settings for the Easyling Translation Plugin
- */
-export interface PluginConfiguration {
-    /** Easyling project ID */
-    projectId?: string;
-    /** Long-lived access token for API authentication */
-    accessToken?: string;
-    /** URL endpoint where translation requests are sent */
-    translationApiEndpoint?: string;
-    /** Content-Type header for translation request payloads */
-    requestContentType?: ContentType;
-    /** Accept header for translation response format negotiation */
-    responseAcceptHeader?: ContentType;
-    /** Default mode for creating translated documents (draft or published) */
-    defaultDocumentCreationMode?: DocumentCreationMode;
-    /** Array of configured locales for translation */
-    locales?: LocaleDefinition[];
-    /** Default source locale code */
-    defaultLocale?: string;
-    /** Document-type-based DNT field configurations */
-    dntFieldConfigurations?: DNTTypeConfig[];
-    /** When enabled, displays additional DNT status badges on all fields */
-    debugMode?: boolean;
-    /** Configuration schema version for migration purposes */
-    version?: string;
-    /** ISO 8601 timestamp of last configuration update */
-    lastUpdated?: string;
-}

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';