@easyling/sanity-connector 1.4.0 → 2.0.0

package/dist-types/services/unifiedConfigStorage.d.ts

@@ -1,158 +0,0 @@
-/**
- * Unified Configuration Storage Adapter
- *
- * Provides centralized persistence for all plugin configuration using Sanity's document storage.
- * This replaces separate OAuth and Locale storage adapters with a single unified configuration.
- *
- * Stores in a single EL_PluginConfiguration document:
- * - OAuth configuration (projectId, accessToken)
- * - Locale definitions and settings
- * - DNT field mappings by document type
- */
-import { SanityClient } from 'sanity';
-import { OAuthConfig } from '../types/oauth';
-import { LocaleConfig } from '../types/locale';
-import { CollisionResolutionMode, ExistingDocumentHandling } from '../types/pluginConfig';
-/**
- * Unified plugin configuration structure
- */
-export interface UnifiedPluginConfig {
-    /** OAuth/authentication settings */
-    projectId?: string;
-    accessToken?: string;
-    /** Translation settings */
-    translationApiEndpoint?: string;
-    requestContentType?: 'application/json' | 'application/x-protobuf';
-    responseAcceptHeader?: 'application/json' | 'application/x-protobuf';
-    defaultDocumentCreationMode?: 'draft' | 'published';
-    /** Collision resolution settings */
-    collisionResolutionMode?: CollisionResolutionMode;
-    existingDocumentHandling?: ExistingDocumentHandling;
-    /** Locale configuration */
-    locales?: LocaleConfig['locales'];
-    defaultLocale?: string;
-    /** DNT field map: { [documentType]: { [fieldPath]: boolean } } */
-    dntFieldMap?: Record<string, Record<string, boolean>>;
-    /** Debug mode - when enabled, shows additional DNT badges on all fields */
-    debugMode?: boolean;
-    /** Configuration version for migrations */
-    version?: string;
-    /** Last updated timestamp */
-    lastUpdated?: string;
-}
-/**
- * Unified configuration storage adapter for Sanity
- */
-export declare class UnifiedConfigStorage {
-    private client;
-    constructor(client: SanityClient);
-    /**
-     * Convert array-based DNT configuration (schema format) to map format (internal use)
-     */
-    private convertDNTArrayToMap;
-    /**
-     * Convert map-based DNT configuration (internal format) to array format (schema format)
-     */
-    private convertDNTMapToArray;
-    /**
-     * Load complete unified configuration from Sanity
-     */
-    load(): Promise<UnifiedPluginConfig | null>;
-    /**
-     * Save complete unified configuration to Sanity
-     */
-    save(config: UnifiedPluginConfig): Promise<void>;
-    /**
-     * Update only specific fields without overwriting entire config
-     */
-    update(updates: Partial<UnifiedPluginConfig>): Promise<void>;
-    /**
-     * Delete the unified configuration document
-     */
-    delete(): Promise<void>;
-    /**
-     * Load only OAuth configuration
-     */
-    loadOAuth(): Promise<OAuthConfig | null>;
-    /**
-     * Save OAuth configuration
-     */
-    saveOAuth(oauthConfig: OAuthConfig): Promise<void>;
-    /**
-     * Load only locale configuration
-     */
-    loadLocale(): Promise<LocaleConfig | null>;
-    /**
-     * Save locale configuration
-     */
-    saveLocale(localeConfig: LocaleConfig): Promise<void>;
-    /**
-     * Get DNT field map for a specific document type
-     */
-    getDNTFieldsForType(documentType: string): Promise<Record<string, boolean>>;
-    /**
-     * Set DNT status for a field in a document type
-     */
-    setDNTField(documentType: string, fieldPath: string, dnt: boolean): Promise<void>;
-    /**
-     * Toggle DNT status for a field in a document type
-     */
-    toggleDNTField(documentType: string, fieldPath: string): Promise<boolean>;
-    /**
-     * Get DNT status for a specific field in a document type
-     */
-    getDNTFieldStatus(documentType: string, fieldPath: string): Promise<boolean>;
-    /**
-     * Clear all DNT fields for a document type
-     */
-    clearDNTFieldsForType(documentType: string): Promise<void>;
-    /**
-     * Get all DNT field mappings
-     */
-    getAllDNTFields(): Promise<Record<string, Record<string, boolean>>>;
-    /**
-     * Get translation API endpoint with fallback to default
-     */
-    getTranslationEndpoint(): Promise<string>;
-    /**
-     * Get request content type with fallback to default
-     */
-    getRequestContentType(): Promise<'application/json' | 'application/x-protobuf'>;
-    /**
-     * Get response accept header with fallback to default
-     */
-    getResponseAcceptHeader(): Promise<'application/json' | 'application/x-protobuf'>;
-    /**
-     * Get default document creation mode with fallback to default
-     */
-    getDefaultDocumentCreationMode(): Promise<'draft' | 'published'>;
-    /**
-     * Get collision resolution mode with fallback to default ('replace')
-     */
-    getCollisionResolutionMode(): Promise<CollisionResolutionMode>;
-    /**
-     * Get existing document handling mode with fallback to default ('draft')
-     * Only applicable when collision resolution mode is 'create'
-     */
-    getExistingDocumentHandling(): Promise<ExistingDocumentHandling>;
-    /**
-     * Get complete collision resolution configuration
-     * Returns both the resolution mode and existing document handling settings
-     */
-    getCollisionResolutionConfig(): Promise<{
-        collisionResolutionMode: CollisionResolutionMode;
-        existingDocumentHandling: ExistingDocumentHandling;
-    }>;
-    /**
-     * Set collision resolution configuration
-     */
-    setCollisionResolutionConfig(mode: CollisionResolutionMode, handling?: ExistingDocumentHandling): Promise<void>;
-    /**
-     * Get debug mode status
-     */
-    getDebugMode(): Promise<boolean>;
-    /**
-     * Set debug mode status
-     */
-    setDebugMode(enabled: boolean): Promise<void>;
-}

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

@@ -1,8 +0,0 @@
-/**
- * Test utilities for component testing
- */
-import { ReactElement } from 'react';
-import { RenderOptions } from '@testing-library/react';
-declare const customRender: (ui: ReactElement, options?: Omit<RenderOptions, "wrapper">) => import("@testing-library/react").RenderResult<typeof import("@testing-library/dom/types/queries"), HTMLElement, HTMLElement>;
-export * from '@testing-library/react';
-export { customRender as render };

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

@@ -1,118 +0,0 @@
-/**
- * Dialog system type definitions
- * Requirements: 5.1, 5.2, 5.3
- */
-/**
- * Base dialog configuration options
- */
-export interface BaseDialogOptions {
-    /** Dialog title */
-    title: string;
-    /** Dialog message or content */
-    message: string;
-    /** Whether the dialog can be closed by clicking outside */
-    closable?: boolean;
-    /** Custom CSS class for styling */
-    className?: string;
-}
-/**
- * Confirmation dialog options
- */
-export interface ConfirmationDialogOptions extends BaseDialogOptions {
-    /** Text for the confirm button */
-    confirmText?: string;
-    /** Text for the cancel button */
-    cancelText?: string;
-    /** Visual tone of the dialog */
-    tone?: 'primary' | 'critical' | 'caution';
-    /** Additional details to display */
-    details?: string;
-}
-/**
- * Success dialog options
- */
-export interface SuccessDialogOptions extends BaseDialogOptions {
-    /** Additional details about the success */
-    details?: string;
-    /** Auto-close timeout in milliseconds */
-    autoCloseTimeout?: number;
-}
-/**
- * Error dialog options
- */
-export interface ErrorDialogOptions extends BaseDialogOptions {
-    /** Error object for detailed information */
-    error?: Error;
-    /** Whether to show a retry button */
-    showRetry?: boolean;
-    /** Text for the retry button */
-    retryText?: string;
-}
-/**
- * Locale selection dialog options
- */
-export interface LocaleSelectionDialogOptions extends BaseDialogOptions {
-    /** Available locales to choose from */
-    availableLocales: LocaleDefinition[];
-    /** Currently selected locale codes */
-    selectedLocales: string[];
-    /** Documents being translated (for context) */
-    selectedDocuments: any[];
-    /** Translation mode */
-    mode: 'single' | 'bulk';
-    /** Whether multiple locales can be selected */
-    allowMultiple?: boolean;
-    /** Whether locale selection is required */
-    required?: boolean;
-    /** Whether to show creation mode option in the dialog */
-    showCreationModeOption?: boolean;
-    /** Default creation mode to pre-select */
-    defaultCreationMode?: 'draft' | 'published';
-    /** Whether to show collision resolution override options */
-    showCollisionResolutionOverride?: boolean;
-    /** Default collision resolution mode from config */
-    defaultCollisionResolutionMode?: CollisionResolutionMode;
-    /** Default existing document handling from config */
-    defaultExistingDocumentHandling?: ExistingDocumentHandling;
-}
-/**
- * Locale selection result
- */
-export interface LocaleSelectionResult {
-    /** Selected locale codes */
-    locales: string[];
-    /** Selected creation mode (if showCreationModeOption was true) */
-    creationMode?: 'draft' | 'published';
-    /** Collision resolution mode (if override was enabled) */
-    collisionResolutionMode?: CollisionResolutionMode;
-    /** Existing document handling (if override was enabled) */
-    existingDocumentHandling?: ExistingDocumentHandling;
-}
-/**
- * Dialog result types
- */
-export type DialogResult<T = unknown> = {
-    /** Whether the dialog was confirmed or cancelled */
-    confirmed: boolean;
-    /** Result data from the dialog */
-    data?: T;
-};
-/**
- * Dialog manager interface for centralized dialog handling
- */
-export interface DialogManager {
-    /** Show a confirmation dialog */
-    showConfirmation(options: ConfirmationDialogOptions): Promise<boolean>;
-    /** Show a locale selection dialog */
-    showLocaleSelection(options: LocaleSelectionDialogOptions): Promise<LocaleSelectionResult>;
-    /** Show a success notification */
-    showSuccess(options: SuccessDialogOptions): void;
-    /** Show an error dialog */
-    showError(options: ErrorDialogOptions): Promise<boolean>;
-    /** Close all open dialogs */
-    closeAll(): void;
-}
-import type { LocaleDefinition } from './locale';
-import type { CollisionResolutionMode, ExistingDocumentHandling } from './pluginConfig';
-export type { LocaleDefinition } from './locale';
-export type { CollisionResolutionMode, ExistingDocumentHandling } from './pluginConfig';

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,64 +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';
-/**
- * Collision resolution mode options
- * Determines how to handle existing translated documents when a collision is detected
- * - 'replace': Overwrite the existing translated document with new translations
- * - 'create': Create a new translated document alongside the existing one
- */
-export type CollisionResolutionMode = 'replace' | 'create';
-/**
- * Existing document handling options (only applicable when CollisionResolutionMode is 'create')
- * Determines what happens to the existing translated document when creating a new one
- * - 'draft': Set the existing document to draft state
- * - 'delete': Delete the existing document
- */
-export type ExistingDocumentHandling = 'draft' | 'delete';
-/**
- * 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;
-    /** How to handle collisions when a translated document already exists for the same source and locale */
-    collisionResolutionMode?: CollisionResolutionMode;
-    /** How to handle existing documents when creating new translations (only applicable when mode is 'create') */
-    existingDocumentHandling?: ExistingDocumentHandling;
-    /** 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;
-}