@easyling/sanity-connector 1.4.0 → 2.0.0

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

@@ -1,262 +0,0 @@
-import { SanityDocument, SanityClient } from 'sanity';
-import { TranslationResponse } from './translationService';
-import { CollisionResolutionMode, ExistingDocumentHandling } from '../types/pluginConfig';
-/**
- * Options for document creation from translation
- */
-export interface DocumentCreationOptions {
-    /** Target language code for the translated document */
-    targetLanguage?: string;
-    /** Source language code of the original document */
-    sourceLanguage?: string;
-    /** Whether to create the document as a variant of the original */
-    createAsVariant?: boolean;
-    /** ID of the parent document when creating as a variant */
-    parentDocumentId?: string;
-    /** Creation mode: 'draft' creates a draft document, 'published' creates a published document */
-    creationMode?: 'draft' | 'published';
-    /**
-     * Whether the title was found at the document's top level during extraction.
-     * When false, the translated title should not be written as a top-level field.
-     * This is tracked in-memory by the plugin, not sent to the translation backend.
-     */
-    titleFoundAtTopLevel?: boolean;
-    /**
-     * Whether the body/content was found at the document's top level during extraction.
-     * When false, the translated body should not be written as a top-level field.
-     * This is tracked in-memory by the plugin, not sent to the translation backend.
-     */
-    bodyFoundAtTopLevel?: boolean;
-    /**
-     * The field name where body content was originally found (e.g., 'body', 'content', or nested path).
-     * Used to write translated content back to the correct location.
-     */
-    bodyFieldName?: string;
-    /**
-     * How to handle collisions when a translated document already exists.
-     * - 'replace': Overwrite the existing document with new translations
-     * - 'create': Create a new document (default behavior if not specified)
-     */
-    collisionResolutionMode?: CollisionResolutionMode;
-    /**
-     * How to handle the existing document when creating a new one (only for 'create' mode).
-     * - 'draft': Set the existing document to draft state
-     * - 'delete': Delete the existing document
-     */
-    existingDocumentHandling?: ExistingDocumentHandling;
-}
-export interface SlugFallbackInfo {
-    documentId: string;
-    originalSlug: string;
-    fallbackSlug: string;
-    locale: string;
-    reason: string;
-}
-/**
- * Information about a collision that was detected and resolved
- */
-export interface CollisionResolutionInfo {
-    /** Whether a collision was detected */
-    collisionDetected: boolean;
-    /** The resolution action that was taken */
-    resolutionAction?: 'replaced' | 'created_new' | 'none';
-    /** The ID of the document that was replaced, updated, or deleted */
-    existingDocumentId?: string;
-    /** How the existing document was handled (for 'create' mode) */
-    existingDocumentAction?: 'set_to_draft' | 'deleted' | 'none';
-    /** How the collision was detected */
-    matchedBy?: 'parent' | 'slug-locale';
-}
-export interface DocumentCreationResult {
-    success: boolean;
-    documentId?: string;
-    document?: SanityDocument;
-    error?: string;
-    slugFallback?: SlugFallbackInfo;
-    /** Information about collision detection and resolution */
-    collisionInfo?: CollisionResolutionInfo;
-}
-export interface BulkDocumentCreationResult {
-    totalDocuments: number;
-    successfulCreations: number;
-    failedCreations: number;
-    results: DocumentCreationResult[];
-    errors: string[];
-    rollbackInfo?: RollbackInfo;
-    slugFallbacks: SlugFallbackInfo[];
-}
-export interface RollbackInfo {
-    canRollback: boolean;
-    createdDocumentIds: string[];
-    rollbackInstructions: string[];
-}
-export declare class DocumentCreationService {
-    private client;
-    private defaultCreationMode;
-    private collisionDetectionService;
-    private defaultCollisionResolutionMode;
-    private defaultExistingDocumentHandling;
-    constructor(client: SanityClient, defaultCreationMode?: 'draft' | 'published');
-    /**
-     * Set the default document creation mode
-     * @param mode - The creation mode to use by default ('draft' or 'published')
-     */
-    setDefaultCreationMode(mode: 'draft' | 'published'): void;
-    /**
-     * Set the default collision resolution mode
-     * @param mode - How to handle collisions ('replace' or 'create')
-     */
-    setDefaultCollisionResolutionMode(mode: CollisionResolutionMode): void;
-    /**
-     * Set the default existing document handling mode
-     * @param handling - How to handle existing documents when creating new ('draft' or 'delete')
-     */
-    setDefaultExistingDocumentHandling(handling: ExistingDocumentHandling): void;
-    /**
-     * Configure collision resolution defaults
-     * @param mode - Collision resolution mode
-     * @param handling - Existing document handling (only applicable when mode is 'create')
-     */
-    setCollisionResolutionConfig(mode: CollisionResolutionMode, handling?: ExistingDocumentHandling): void;
-    /**
-     * Replace an existing document with new translated content
-     * Requirements: EARS 4 - Resolution Behavior - Replace
-     *
-     * @param existingDocument - The document to replace
-     * @param newDocument - The new translated document content
-     * @param creationMode - Whether to create as draft or published
-     */
-    private replaceExistingDocument;
-    /**
-     * Handle an existing document when creating a new translation (for 'create' mode)
-     * Requirements: EARS 5 - Resolution Behavior - Create
-     *
-     * @param existingDocument - The existing document to handle
-     * @param handling - How to handle the existing document ('draft' or 'delete')
-     */
-    private handleExistingDocument;
-    /**
-     * Create a new Sanity document from translation response
-     * Requirements: 1.1, 1.2, 2.1, 3.2, 3.4
-     */
-    createDocumentFromTranslation(originalDocument: SanityDocument, translationResponse: TranslationResponse, options?: DocumentCreationOptions): Promise<DocumentCreationResult>;
-    /**
-     * Validate inputs for document creation
-     * Requirements: 4.3, 4.4
-     */
-    private validateInputsForDocumentCreation;
-    /**
-     * Validate business rules for document creation
-     * Requirements: 4.3, 4.4
-     */
-    private validateBusinessRules;
-    /**
-     * Check if document has meaningful content
-     * Searches both top-level and nested fields for title/body content
-     */
-    private documentHasContent;
-    /**
-     * Recursively search nested objects for title or body content
-     */
-    private hasContentInNestedFields;
-    /**
-     * Format error messages with additional context
-     * Requirements: 4.3, 4.4
-     */
-    private formatErrorMessage;
-    /**
-     * Create multiple documents from bulk translation responses
-     * Requirements: 2.1, 3.2, 3.4
-     */
-    createBulkDocumentsFromTranslations(originalDocuments: SanityDocument[], translationResponses: TranslationResponse[], options?: DocumentCreationOptions): Promise<BulkDocumentCreationResult>;
-    /**
-     * Validate bulk translation responses before document creation
-     * Requirements: 4.3, 4.4
-     */
-    private validateBulkTranslationResponses;
-    /**
-     * Validate translation response before document creation
-     * Requirements: 4.3, 4.4
-     */
-    private validateTranslationResponseForCreation;
-    /**
-     * Create rollback plan for failed bulk operations
-     * Requirements: 4.3, 4.4
-     */
-    createRollbackPlan(createdDocumentIds: string[]): RollbackInfo;
-    /**
-     * Parse a field path that may contain array key selectors
-     * e.g., "article.footnotes[_key == \"c82437b14d71\"].footnote"
-     *
-     * @param fieldPath - The field path (may be from the field key or from the path property)
-     * @returns Array of path segments with type information
-     */
-    private parseFieldPath;
-    /**
-     * Unflatten fields with complex paths back into nested objects
-     * Handles both simple dotted paths and GROQ-style array key paths:
-     *   - "metadata.version" → { metadata: { version: ... } }
-     *   - "article.footnotes[_key == \"abc\"].footnote" → { article: { footnotes: [{ _key: "abc", footnote: ... }] } }
-     *
-     * @param fields - Flattened fields with path keys
-     * @param originalDocument - Original document for preserving array structure
-     * @returns Unflattened nested object structure
-     */
-    private unflattenFields;
-    /**
-     * Get the original nested value from the original document using a dotted path
-     *
-     * @param document - The original document
-     * @param fieldPath - The dotted path to the field
-     * @returns The original value at the path, or undefined
-     */
-    private getOriginalValueByPath;
-    /**
-     * Merge translated content back into original document structure
-     * Requirements: 1.2, 3.2, 3.4
-     */
-    private mergeTranslatedContent;
-    /**
-     * Process a translated field value and convert it to the appropriate format
-     * based on the original document's structure
-     */
-    private processTranslatedField;
-    /**
-     * Convert HTML content back to Sanity portable text format
-     * Requirements: 3.2, 3.4
-     */
-    private convertHtmlToPortableText;
-    /**
-     * Parse inline content and handle formatting
-     */
-    private parseInlineContent;
-    /**
-     * Get block style from HTML tag name
-     */
-    private getBlockStyle;
-    /**
-     * Check if content appears to be HTML
-     */
-    private isHtmlContent;
-    /**
-     * Generate a new document ID based on original ID and target language
-     */
-    private generateNewDocumentId;
-    /**
-     * Generate a unique key for portable text blocks
-     */
-    private generateBlockKey;
-    /**
-     * Generate a unique key for spans
-     */
-    private generateSpanKey;
-    /**
-     * Validate document structure before creation
-     * Requirements: 3.4
-     */
-    private validateDocumentStructure;
-    /**
-     * Validate portable text array structure
-     */
-    private validatePortableTextArray;
-}

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

@@ -1,159 +0,0 @@
-/**
- * Locale configuration management service
- * Requirements: 1.1, 1.4, 1.5, 5.4, 5.5, 5.6
- *
- * Provides CRUD operations for locale configuration management with validation,
- * persistence, and error handling capabilities.
- */
-import { LocaleConfig, LocaleDefinition, LocaleValidationResult } from '../types/locale';
-/**
- * Storage interface for locale configuration persistence
- * This allows for different storage implementations (localStorage, Sanity config, etc.)
- */
-export interface LocaleStorageAdapter {
-    load(): Promise<LocaleConfig | null>;
-    save(config: LocaleConfig): Promise<void>;
-}
-/**
- * Error types for locale service operations
- */
-export declare class LocaleServiceError extends Error {
-    code: string;
-    details?: unknown | undefined;
-    constructor(message: string, code: string, details?: unknown | undefined);
-}
-/**
- * Service for managing locale configuration with CRUD operations
- * Requirements: 1.1, 1.4, 1.5, 5.4, 5.5, 5.6
- */
-export declare class LocaleService {
-    private config;
-    private storageAdapter;
-    /**
-     * Creates a new LocaleService instance
-     *
-     * @param storageAdapter - Optional storage adapter for persistence
-     * @param initialConfig - Optional initial configuration (defaults to empty config)
-     */
-    constructor(storageAdapter?: LocaleStorageAdapter | null, initialConfig?: LocaleConfig);
-    /**
-     * Loads locale configuration from storage
-     * Requirements: 1.4, 5.4
-     *
-     * @returns Promise resolving to the loaded configuration
-     * @throws LocaleServiceError if loading fails
-     */
-    loadConfig(): Promise<LocaleConfig>;
-    /**
-     * Saves locale configuration to storage
-     * Requirements: 1.5, 5.5
-     *
-     * @param config - Optional configuration to save (defaults to current config)
-     * @returns Promise resolving when save is complete
-     * @throws LocaleServiceError if saving fails
-     */
-    saveConfig(config?: LocaleConfig): Promise<void>;
-    /**
-     * Gets the current locale configuration
-     *
-     * @returns Current locale configuration
-     */
-    getConfig(): LocaleConfig;
-    /**
-     * Gets all locales from the configuration
-     *
-     * @returns Array of all locale definitions
-     */
-    getAllLocales(): LocaleDefinition[];
-    /**
-     * Gets all enabled locales from the configuration
-     *
-     * @returns Array of enabled locale definitions
-     */
-    getEnabledLocales(): LocaleDefinition[];
-    /**
-     * Gets a locale by its code
-     *
-     * @param code - Locale code to find
-     * @returns Locale definition or undefined if not found
-     */
-    getLocaleByCode(code: string): LocaleDefinition | undefined;
-    /**
-     * Checks if a locale code exists in the configuration
-     *
-     * @param code - Locale code to check
-     * @returns True if the locale exists
-     */
-    hasLocale(code: string): boolean;
-    /**
-     * Adds a new locale to the configuration
-     * Requirements: 1.1, 1.2, 1.3
-     *
-     * @param locale - Locale definition to add
-     * @returns Promise resolving to validation result
-     * @throws LocaleServiceError if locale is invalid or already exists
-     */
-    addLocale(locale: Omit<LocaleDefinition, 'createdAt' | 'updatedAt'>): Promise<LocaleValidationResult>;
-    /**
-     * Updates an existing locale in the configuration
-     * Requirements: 1.6, 1.7
-     *
-     * @param code - Code of the locale to update
-     * @param updates - Partial locale definition with updates
-     * @returns Promise resolving to validation result
-     * @throws LocaleServiceError if locale not found or updates are invalid
-     */
-    updateLocale(code: string, updates: Partial<Omit<LocaleDefinition, 'code' | 'createdAt' | 'updatedAt'>>): Promise<LocaleValidationResult>;
-    /**
-     * Removes a locale from the configuration
-     * Requirements: 1.6
-     *
-     * @param code - Code of the locale to remove
-     * @returns Promise resolving when removal is complete
-     * @throws LocaleServiceError if locale not found
-     */
-    removeLocale(code: string): Promise<void>;
-    /**
-     * Sets the default locale
-     *
-     * @param code - Code of the locale to set as default
-     * @returns Promise resolving when update is complete
-     * @throws LocaleServiceError if locale not found
-     */
-    setDefaultLocale(code: string): Promise<void>;
-    /**
-     * Clears the default locale
-     *
-     * @returns Promise resolving when update is complete
-     */
-    clearDefaultLocale(): Promise<void>;
-    /**
-     * Validates the current configuration
-     * Requirements: 5.6
-     *
-     * @returns Validation result
-     */
-    validateCurrentConfig(): LocaleValidationResult;
-    /**
-     * Resets configuration to default state
-     * Requirements: 5.6
-     *
-     * @returns Promise resolving when reset is complete
-     */
-    resetToDefault(): Promise<void>;
-    /**
-     * Imports a locale configuration
-     * Useful for bulk import or migration scenarios
-     *
-     * @param config - Configuration to import
-     * @returns Promise resolving to validation result
-     * @throws LocaleServiceError if configuration is invalid
-     */
-    importConfig(config: LocaleConfig): Promise<LocaleValidationResult>;
-    /**
-     * Exports the current locale configuration
-     *
-     * @returns Current configuration as a plain object
-     */
-    exportConfig(): LocaleConfig;
-}

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

@@ -1,41 +0,0 @@
-/**
- * Locale Storage Adapter for Sanity Configuration
- * Requirements: 5.1, 5.2, 5.3, 5.7
- *
- * Now delegates to UnifiedConfigStorage for centralized configuration management.
- * Locale settings are stored in the EL_PluginConfiguration document alongside
- * OAuth and DNT configurations.
- */
-import { SanityClient } from 'sanity';
-import { LocaleConfig } from '../types/locale';
-import { LocaleStorageAdapter } from './localeService';
-/**
- * Locale configuration storage adapter
- * Now uses UnifiedConfigStorage for centralized management
- * Requirements: 5.1, 5.2, 5.3, 5.7
- */
-export declare class SanityLocaleStorageAdapter implements LocaleStorageAdapter {
-    private unifiedStorage;
-    private client;
-    constructor(client: SanityClient);
-    /**
-     * Load locale configuration from unified storage
-     * Requirements: 5.2, 5.4
-     */
-    load(): Promise<LocaleConfig | null>;
-    /**
-     * Save locale configuration to unified storage
-     * Requirements: 5.3, 5.5
-     */
-    save(config: LocaleConfig): Promise<void>;
-    /**
-     * Load from legacy locale-specific document
-     * @private
-     */
-    private loadLegacy;
-    /**
-     * Delete legacy locale document after migration
-     * @private
-     */
-    private deleteLegacy;
-}

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

@@ -1,45 +0,0 @@
-/**
- * OAuth Configuration Storage Adapter
- * Requirements: 9.1, 9.4
- *
- * Now delegates to UnifiedConfigStorage for centralized configuration management.
- * OAuth settings are stored in the EL_PluginConfiguration document alongside
- * locale and DNT configurations.
- */
-import { SanityClient } from 'sanity';
-import { OAuthConfig } from '../types/oauth';
-/**
- * OAuth configuration storage adapter
- * Now uses UnifiedConfigStorage for centralized management
- * Requirements: 9.1, 9.4
- */
-export declare class OAuthConfigStorage {
-    private unifiedStorage;
-    private client;
-    constructor(client: SanityClient);
-    /**
-     * Load OAuth configuration from unified storage
-     * Requirements: 9.1, 9.4
-     */
-    load(): Promise<OAuthConfig | null>;
-    /**
-     * Save OAuth configuration to unified storage
-     * Requirements: 9.1, 9.4
-     */
-    save(config: OAuthConfig): Promise<void>;
-    /**
-     * Delete OAuth configuration
-     * Only clears OAuth fields, preserves other configuration
-     */
-    delete(): Promise<void>;
-    /**
-     * Load from legacy OAuth-specific document
-     * @private
-     */
-    private loadLegacy;
-    /**
-     * Delete legacy OAuth document after migration
-     * @private
-     */
-    private deleteLegacy;
-}

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

@@ -1,47 +0,0 @@
-/**
- * Easyling Authentication Service
- *
- * Manages Easyling authentication configuration for the Sanity Translation Plugin.
- * Handles validation and storage of access tokens and project IDs.
- */
-import { OAuthConfig } from '../types/oauth';
-/**
- * Easyling Authentication Service
- *
- * Provides methods for managing Easyling authentication configuration.
- */
-export declare class OAuthService {
-    private config;
-    /**
-     * Create a new Easyling Authentication Service instance
-     *
-     * @param config - Easyling configuration (access token and project ID)
-     * @throws {OAuthError} If configuration is invalid
-     */
-    constructor(config: OAuthConfig);
-    /**
-     * Validate configuration
-     *
-     * @param config - Configuration to validate
-     * @throws {OAuthError} If configuration is invalid
-     */
-    private validateConfig;
-    /**
-     * Get the access token
-     *
-     * @returns The configured access token
-     */
-    getAccessToken(): string;
-    /**
-     * Get the project ID
-     *
-     * @returns The configured project ID
-     */
-    getProjectId(): string;
-    /**
-     * Get the complete configuration
-     *
-     * @returns The complete OAuth configuration
-     */
-    getConfig(): OAuthConfig;
-}