@easyling/sanity-connector 0.0.1 → 0.0.2-rc.1

package/dist/services/translationService.d.ts

@@ -1,374 +0,0 @@
-import { ExtendedDocumentContent } from './contentExtractor';
-/**
- * Field object structure supporting translation-invariant fields
- */
-export interface TranslatableField {
-    /** The actual field value */
-    value: unknown;
-    /** Do Not Translate flag - if true, the field should not be translated */
-    dnt?: boolean;
-    /** Type of the field value from Sanity (e.g., 'string', 'number', 'date', 'slug', 'array', 'object') */
-    type?: string;
-}
-export interface TranslationRequest {
-    documentId: string;
-    endpoint: string;
-    payload: TranslationRequestPayload;
-}
-/**
- * Request payload sent to the translation service
- *
- * @example Single locale (backward compatible):
- * ```json
- * {
- *   "content": {
- *     "body": "<h1>Welcome</h1><p>This is sample content.</p>",
- *     "title": "Welcome Article",
- *     "slug": "welcome-article",
- *     "fields": {
- *       "author": { "value": "John Doe", "dnt": false },
- *       "category": { "value": "General", "dnt": true }
- *     }
- *   },
- *   "format": "html",
- *   "metadata": {
- *     "documentId": "article-123",
- *     "documentType": "article",
- *     "title": "Welcome Article",
- *     "sourceLanguage": "en",
- *     "targetLanguage": "es"
- *   }
- * }
- * ```
- *
- * @example Multiple locales:
- * ```json
- * {
- *   "content": {
- *     "body": "<h1>Welcome</h1><p>This is sample content.</p>",
- *     "title": "Welcome Article",
- *     "slug": "welcome-article",
- *     "fields": {
- *       "author": { "value": "John Doe", "dnt": false },
- *       "category": { "value": "General", "dnt": true }
- *     }
- *   },
- *   "format": "html",
- *   "metadata": {
- *     "documentId": "article-123",
- *     "documentType": "article",
- *     "title": "Welcome Article",
- *     "sourceLanguage": "en",
- *     "targetLocales": ["es", "fr", "de"]
- *   }
- * }
- * ```
- */
-export interface TranslationRequestPayload {
-    /** Content to be translated */
-    content: {
-        /** HTML content extracted from Sanity document */
-        body: string;
-        /** Document title */
-        title: string;
-        /** Document slug */
-        slug: string;
-        /** Additional document fields with translation control via dnt flag */
-        fields: Record<string, TranslatableField | any>;
-    };
-    /** Content format - always 'html' for this plugin */
-    format: 'html';
-    /** Metadata about the document and translation request */
-    metadata: {
-        /** Unique identifier for the source document */
-        documentId: string;
-        /** Sanity document type (e.g., 'article', 'page', 'post') */
-        documentType: string;
-        /** Document title (same as content.title) */
-        title: string;
-        /** Source language code (optional, e.g., 'en', 'fr', 'es') */
-        sourceLanguage?: string;
-        /** Target language code (optional, e.g., 'en', 'fr', 'es') - for backward compatibility */
-        targetLanguage?: string;
-        /** Array of target locale codes (e.g., ['es', 'fr', 'de']) - for multi-locale support */
-        targetLocales?: string[];
-    };
-}
-/**
- * Translated document structure
- */
-export interface TranslatedDocument {
-    /**
-     * Translated HTML content
-     * - Must be valid HTML
-     * - Should preserve original structure
-     * - Will be converted back to Portable Text by the plugin
-     */
-    body: string;
-    /**
-     * Translated document title
-     * - Must be non-empty string
-     * - No HTML tags allowed
-     */
-    title: string;
-    /**
-     * Translated/localized slug
-     * - Must contain only lowercase letters, numbers, hyphens, and underscores
-     * - Should be URL-friendly and unique
-     * - Pattern: ^[a-z0-9-_]+$
-     */
-    slug: string;
-    /**
-     * Additional translated document fields
-     * - Must be an object (can be empty)
-     * - Translatable text fields should be translated
-     * - Non-translatable fields (dates, IDs) should be preserved
-     * - Fields marked with dnt=true should remain unchanged
-     */
-    fields: Record<string, TranslatableField>;
-    /**
-     * Target locale code for this translation (e.g., 'es', 'fr', 'de')
-     */
-    locale?: string;
-}
-/**
- * Response format expected from the translation service
- *
- * @example Single locale success response:
- * ```json
- * {
- *   "success": true,
- *   "translatedDocuments": [
- *     {
- *       "body": "<h1>Translated HTML</h1><p>Translated content...</p>",
- *       "title": "Translated Title",
- *       "slug": "translated-slug",
- *       "fields": {
- *         "author": { "value": "Translated Author", "dnt": false },
- *         "category": { "value": "General", "dnt": true }
- *       },
- *       "locale": "es"
- *     }
- *   ],
- *   "sourceLocale": "en",
- *   "requestId": "req-123"
- * }
- * ```
- *
- * @example Multi-locale success response:
- * ```json
- * {
- *   "success": true,
- *   "translatedDocuments": [
- *     {
- *       "body": "<h1>HTML traducido</h1><p>Contenido traducido...</p>",
- *       "title": "Título traducido",
- *       "slug": "titulo-traducido",
- *       "fields": {
- *         "author": { "value": "Autor traducido", "dnt": false },
- *         "category": { "value": "General", "dnt": true }
- *       },
- *       "locale": "es"
- *     },
- *     {
- *       "body": "<h1>HTML traduit</h1><p>Contenu traduit...</p>",
- *       "title": "Titre traduit",
- *       "slug": "titre-traduit",
- *       "fields": {
- *         "author": { "value": "Auteur traduit", "dnt": false },
- *         "category": { "value": "General", "dnt": true }
- *       },
- *       "locale": "fr"
- *     }
- *   ],
- *   "sourceLocale": "en",
- *   "requestId": "req-123"
- * }
- * ```
- *
- * @example Error Response:
- * ```json
- * {
- *   "success": false,
- *   "error": "Translation failed: Unsupported language pair",
- *   "requestId": "req-123"
- * }
- * ```
- */
-export interface TranslationResponse {
-    /** Indicates whether the translation was successful */
-    success: boolean;
-    /**
-     * Array of translated documents (required when success is true)
-     * Contains one translated document per target locale
-     */
-    translatedDocuments?: TranslatedDocument[];
-    /** Source locale code (e.g., 'en') */
-    sourceLocale?: string;
-    /**
-     * Error message (required when success is false)
-     * Should provide a clear description of what went wrong
-     */
-    error?: string;
-    /**
-     * Optional unique request identifier for tracking
-     * Useful for debugging and request correlation
-     */
-    requestId?: string;
-    /** @deprecated Use translatedDocuments array instead */
-    translatedContent?: TranslatedDocument;
-    /** @deprecated Use translatedDocuments array instead */
-    translations?: {
-        [localeCode: string]: {
-            content: TranslatedDocument;
-            status: 'completed' | 'failed' | 'pending';
-            error?: string;
-        };
-    };
-}
-export interface BulkTranslationSummary {
-    totalDocuments: number;
-    processedDocuments: number;
-    failedDocuments: number;
-    requests: TranslationRequest[];
-    responses: TranslationResponse[];
-}
-export declare class TranslationService {
-    private placeholderEndpoint;
-    private accessToken?;
-    private projectId?;
-    private requestContentType;
-    private responseAcceptHeader;
-    constructor(placeholderEndpoint?: string, requestContentType?: 'application/json' | 'application/x-protobuf', responseAcceptHeader?: 'application/json' | 'application/x-protobuf');
-    /**
-     * Infer the Sanity field type from a value
-     *
-     * @param value - The field value to inspect
-     * @returns The inferred Sanity type string
-     */
-    private inferSanityType;
-    /**
-     * Set authentication token and project ID
-     * Requirements: 4.1, 4.2, 4.3
-     *
-     * @param token - Access token for API authentication
-     * @param projectId - Project ID to include in requests
-     */
-    setAuthToken(token: string, projectId: string): void;
-    /**
-     * Clear authentication data
-     */
-    clearAuth(): void;
-    /**
-     * Update configuration for content types and endpoint
-     * Allows partial updates - only provided parameters will be updated
-     * Requirements: 1.1, 2.3, 3.3
-     *
-     * @param endpoint - Optional translation API endpoint URL
-     * @param requestContentType - Optional request Content-Type header value
-     * @param responseAcceptHeader - Optional response Accept header value
-     */
-    setConfiguration(endpoint?: string, requestContentType?: 'application/json' | 'application/x-protobuf', responseAcceptHeader?: 'application/json' | 'application/x-protobuf'): void;
-    /**
-     * Convert internal payload to Protocol Buffer binary format
-     * Requirements: Uses @easyling/sanity protobuf library
-     *
-     * @param payload - Internal translation request payload
-     * @returns Binary protobuf message
-     */
-    private convertPayloadToProtobuf;
-    /**
-     * Convert protobuf payload to JSON for logging purposes only
-     *
-     * @param payload - Internal translation request payload
-     * @returns JSON representation for logging
-     */
-    private convertPayloadToProtobufJSON;
-    /**
-     * Normalize field values to ensure consistency
-     * Extracts values from TranslatableField objects and handles various formats
-     */
-    private normalizeTranslatedFields;
-    /**
-     * Convert binary protobuf response to internal format
-     * Requirements: Uses @easyling/sanity protobuf library
-     *
-     * @param binaryData - Binary protobuf response data
-     * @returns Internal translation response format
-     */
-    private convertProtobufBinaryToResponse;
-    /**
-     * Convert protobuf JSON response back to internal format (for legacy support)
-     * Requirements: Uses @easyling/sanity protobuf library
-     *
-     * @param jsonData - JSON response data
-     * @returns Internal translation response format
-     */
-    private convertProtobufJSONToResponse;
-    /**
-     * Prepare a translation request for a single document
-     * Requirements: 1.2, 1.3, 3.3, 2.5, 2.7
-     *
-     * @param content - Document content to translate
-     * @param documentType - Type of the document
-     * @param sourceLanguage - Source language code (optional)
-     * @param targetLanguage - Single target language code (optional, for backward compatibility)
-     * @param targetLocales - Array of target locale codes (optional, for multi-locale support)
-     */
-    prepareTranslationRequest(content: ExtendedDocumentContent, documentType?: string, sourceLanguage?: string, targetLanguage?: string, targetLocales?: string[]): TranslationRequest;
-    /**
-     * Translate a single document
-     * Requirements: 1.2, 1.3, 3.3, 2.5, 2.7
-     *
-     * @param content - Document content to translate
-     * @param documentType - Type of the document
-     * @param sourceLanguage - Source language code (optional)
-     * @param targetLanguage - Single target language code (optional, for backward compatibility)
-     * @param targetLocales - Array of target locale codes (optional, for multi-locale support)
-     */
-    translateDocument(content: ExtendedDocumentContent, documentType?: string, sourceLanguage?: string, targetLanguage?: string, targetLocales?: string[]): Promise<TranslationResponse>;
-    /**
-     * Send translation request to the configured endpoint
-     *
-     * Uses the @easyling/sanity Protocol Buffer library to format messages as JSON
-     * (not binary protobuf) for better compatibility with various backends.
-     * Handles the new array-based response format with backward compatibility.
-     * The service now expects translatedDocuments as an array, but will convert
-     * legacy formats (translatedContent or translations object) to the new format.
-     *
-     * Supports dual mode operation:
-     * - Authenticated mode: Uses Bearer token authentication when configured
-     * - Legacy mode: Works without authentication for backward compatibility
-     */
-    sendTranslationRequest(request: TranslationRequest): Promise<TranslationResponse>;
-    /**
-     * Log translation request to console for verification
-     * Requirements: 1.3, 2.4
-     */
-    logTranslationRequest(request: TranslationRequest): void;
-    /**
-     * Process bulk translation for multiple documents
-     * Requirements: 2.1, 2.2, 2.3, 2.4, 2.5, 2.7
-     *
-     * @param contents - Array of document contents to translate
-     * @param documentType - Type of the documents
-     * @param sourceLanguage - Source language code (optional)
-     * @param targetLanguage - Single target language code (optional, for backward compatibility)
-     * @param targetLocales - Array of target locale codes (optional, for multi-locale support)
-     */
-    processBulkTranslation(contents: ExtendedDocumentContent[], documentType?: string, sourceLanguage?: string, targetLanguage?: string, targetLocales?: string[]): Promise<BulkTranslationSummary>;
-    /**
-     * Log bulk translation summary
-     * Requirements: 2.5
-     */
-    private logBulkTranslationSummary;
-    /**
-     * Update the placeholder endpoint
-     */
-    setEndpoint(endpoint: string): void;
-    /**
-     * Get the current endpoint
-     */
-    getEndpoint(): string;
-}
-//# sourceMappingURL=translationService.d.ts.map

package/dist/services/translationService.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"translationService.d.ts","sourceRoot":"","sources":["../../src/services/translationService.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,uBAAuB,EAAE,MAAM,oBAAoB,CAAC;AAI7D;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC,6BAA6B;IAC7B,KAAK,EAAE,OAAO,CAAC;IACf,0EAA0E;IAC1E,GAAG,CAAC,EAAE,OAAO,CAAC;IACd,wGAAwG;IACxG,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,kBAAkB;IACjC,UAAU,EAAE,MAAM,CAAC;IACnB,QAAQ,EAAE,MAAM,CAAC;IACjB,OAAO,EAAE,yBAAyB,CAAC;CACpC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgDG;AACH,MAAM,WAAW,yBAAyB;IACxC,+BAA+B;IAC/B,OAAO,EAAE;QACP,kDAAkD;QAClD,IAAI,EAAE,MAAM,CAAC;QACb,qBAAqB;QACrB,KAAK,EAAE,MAAM,CAAC;QACd,oBAAoB;QACpB,IAAI,EAAE,MAAM,CAAC;QACb,uEAAuE;QACvE,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,iBAAiB,GAAG,GAAG,CAAC,CAAC;KACjD,CAAC;IAEF,qDAAqD;IACrD,MAAM,EAAE,MAAM,CAAC;IAEf,0DAA0D;IAC1D,QAAQ,EAAE;QACR,gDAAgD;QAChD,UAAU,EAAE,MAAM,CAAC;QACnB,6DAA6D;QAC7D,YAAY,EAAE,MAAM,CAAC;QACrB,6CAA6C;QAC7C,KAAK,EAAE,MAAM,CAAC;QACd,8DAA8D;QAC9D,cAAc,CAAC,EAAE,MAAM,CAAC;QACxB,2FAA2F;QAC3F,cAAc,CAAC,EAAE,MAAM,CAAC;QACxB,yFAAyF;QACzF,aAAa,CAAC,EAAE,MAAM,EAAE,CAAC;KAC1B,CAAC;CACH;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC;;;;;OAKG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;;;OAIG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;;;;OAKG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;;;;;OAMG;IACH,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,iBAAiB,CAAC,CAAC;IAE1C;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+DG;AACH,MAAM,WAAW,mBAAmB;IAClC,uDAAuD;IACvD,OAAO,EAAE,OAAO,CAAC;IAEjB;;;OAGG;IACH,mBAAmB,CAAC,EAAE,kBAAkB,EAAE,CAAC;IAE3C,sCAAsC;IACtC,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAGnB,wDAAwD;IACxD,iBAAiB,CAAC,EAAE,kBAAkB,CAAC;IACvC,wDAAwD;IACxD,YAAY,CAAC,EAAE;QACb,CAAC,UAAU,EAAE,MAAM,GAAG;YACpB,OAAO,EAAE,kBAAkB,CAAC;YAC5B,MAAM,EAAE,WAAW,GAAG,QAAQ,GAAG,SAAS,CAAC;YAC3C,KAAK,CAAC,EAAE,MAAM,CAAC;SAChB,CAAC;KACH,CAAC;CACH;AAED,MAAM,WAAW,sBAAsB;IACrC,cAAc,EAAE,MAAM,CAAC;IACvB,kBAAkB,EAAE,MAAM,CAAC;IAC3B,eAAe,EAAE,MAAM,CAAC;IACxB,QAAQ,EAAE,kBAAkB,EAAE,CAAC;IAC/B,SAAS,EAAE,mBAAmB,EAAE,CAAC;CAClC;AAED,qBAAa,kBAAkB;IAC7B,OAAO,CAAC,mBAAmB,CAAS;IACpC,OAAO,CAAC,WAAW,CAAC,CAAS;IAC7B,OAAO,CAAC,SAAS,CAAC,CAAS;IAC3B,OAAO,CAAC,kBAAkB,CAAgD;IAC1E,OAAO,CAAC,oBAAoB,CAAgD;gBAG1E,mBAAmB,GAAE,MAA0C,EAC/D,kBAAkB,GAAE,kBAAkB,GAAG,wBAA6C,EACtF,oBAAoB,GAAE,kBAAkB,GAAG,wBAA6C;IAO1F;;;;;OAKG;IACH,OAAO,CAAC,eAAe;IAmCvB;;;;;;OAMG;IACH,YAAY,CAAC,KAAK,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG,IAAI;IAKpD;;OAEG;IACH,SAAS,IAAI,IAAI;IAKjB;;;;;;;;OAQG;IACH,gBAAgB,CACd,QAAQ,CAAC,EAAE,MAAM,EACjB,kBAAkB,CAAC,EAAE,kBAAkB,GAAG,wBAAwB,EAClE,oBAAoB,CAAC,EAAE,kBAAkB,GAAG,wBAAwB,GACnE,IAAI;IAYP;;;;;;OAMG;IACH,OAAO,CAAC,wBAAwB;IAyDhC;;;;;OAKG;IACH,OAAO,CAAC,4BAA4B;IA0CpC;;;OAGG;IACH,OAAO,CAAC,yBAAyB;IA6BjC;;;;;;OAMG;IACH,OAAO,CAAC,+BAA+B;IAqDvC;;;;;;OAMG;IACH,OAAO,CAAC,6BAA6B;IAsFrC;;;;;;;;;OASG;IACH,yBAAyB,CACvB,OAAO,EAAE,uBAAuB,EAChC,YAAY,GAAE,MAAmB,EACjC,cAAc,CAAC,EAAE,MAAM,EACvB,cAAc,CAAC,EAAE,MAAM,EACvB,aAAa,CAAC,EAAE,MAAM,EAAE,GACvB,kBAAkB;IA0DrB;;;;;;;;;OASG;IACG,iBAAiB,CACrB,OAAO,EAAE,uBAAuB,EAChC,YAAY,GAAE,MAAmB,EACjC,cAAc,CAAC,EAAE,MAAM,EACvB,cAAc,CAAC,EAAE,MAAM,EACvB,aAAa,CAAC,EAAE,MAAM,EAAE,GACvB,OAAO,CAAC,mBAAmB,CAAC;IAW/B;;;;;;;;;;;;OAYG;IACG,sBAAsB,CAAC,OAAO,EAAE,kBAAkB,GAAG,OAAO,CAAC,mBAAmB,CAAC;IAiKvF;;;OAGG;IACH,qBAAqB,CAAC,OAAO,EAAE,kBAAkB,GAAG,IAAI;IAQxD;;;;;;;;;OASG;IACG,sBAAsB,CAC1B,QAAQ,EAAE,uBAAuB,EAAE,EACnC,YAAY,GAAE,MAAmB,EACjC,cAAc,CAAC,EAAE,MAAM,EACvB,cAAc,CAAC,EAAE,MAAM,EACvB,aAAa,CAAC,EAAE,MAAM,EAAE,GACvB,OAAO,CAAC,sBAAsB,CAAC;IAoDlC;;;OAGG;IACH,OAAO,CAAC,yBAAyB;IAYjC;;OAEG;IACH,WAAW,CAAC,QAAQ,EAAE,MAAM,GAAG,IAAI;IAInC;;OAEG;IACH,WAAW,IAAI,MAAM;CAGtB"}