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

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

@@ -0,0 +1,175 @@
+/**
+ * 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;

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

@@ -0,0 +1,66 @@
+/**
+ * Validation functions for document and payload structure
+ * Requirements: 3.4, 4.3 - Validate document structure and provide clear error messages
+ */
+import { DocumentContent, ExtendedDocumentContent } from '../services/contentExtractor';
+import { TranslationRequestPayload } from '../services/translationService';
+export interface ValidationResult {
+    isValid: boolean;
+    errors: string[];
+    warnings: string[];
+}
+export interface DocumentValidationOptions {
+    requireTitle?: boolean;
+    requireContent?: boolean;
+    allowEmptyFields?: boolean;
+    maxContentLength?: number;
+}
+export interface PayloadValidationOptions {
+    requireMetadata?: boolean;
+    maxPayloadSize?: number;
+    validateHtmlStructure?: boolean;
+}
+export declare class Validator {
+    /**
+     * Validate Sanity document structure
+     * Requirement 3.4: Validate document structure
+     */
+    static validateSanityDocument(document: any, options?: DocumentValidationOptions): ValidationResult;
+    /**
+     * Validate document content structure
+     * Requirement 3.4: Validate extracted content structure
+     */
+    static validateDocumentContent(content: DocumentContent): ValidationResult;
+    /**
+     * Validate extended document content structure
+     */
+    static validateExtendedDocumentContent(content: ExtendedDocumentContent): ValidationResult;
+    /**
+     * Validate translation request payload
+     * Requirement 3.4: Validate payload structure for JSON transmission
+     */
+    static validateTranslationPayload(payload: TranslationRequestPayload, options?: PayloadValidationOptions): ValidationResult;
+    /**
+     * Validate HTML content structure
+     * Requirement 3.2: Validate HTML structure preservation
+     */
+    static validateHtmlContent(html: string): ValidationResult;
+    /**
+     * Validate array of documents for bulk operations
+     * Requirement 2.1: Validate multiple documents for bulk processing
+     */
+    static validateDocumentArray(documents: any[], options?: DocumentValidationOptions): ValidationResult;
+    /**
+     * Validate endpoint URL
+     */
+    static validateEndpoint(endpoint: string): ValidationResult;
+}
+export declare const validator: {
+    validateSanityDocument: typeof Validator.validateSanityDocument;
+    validateDocumentContent: typeof Validator.validateDocumentContent;
+    validateExtendedDocumentContent: typeof Validator.validateExtendedDocumentContent;
+    validateTranslationPayload: typeof Validator.validateTranslationPayload;
+    validateHtmlContent: typeof Validator.validateHtmlContent;
+    validateDocumentArray: typeof Validator.validateDocumentArray;
+    validateEndpoint: typeof Validator.validateEndpoint;
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@easyling/sanity-connector",
-  "version": "0.0.2-rc.1",
+  "version": "0.0.2-rc.3",
   "description": "A Sanity Studio plugin that enables document translation with support for single and bulk operations. Extracts document content as HTML and prepares translation requests for external services.",
   "main": "dist/index.js",
   "module": "dist/index.js",
@@ -19,8 +19,8 @@
     "LICENSE"
   ],
   "scripts": {
-    "build": "npm run clean && tsc",
-    "build:bundle": "npm run clean && webpack build && tsc --project tsconfig.types.json",
+    "build": "npm run clean && webpack build && tsc --project tsconfig.types.json",
+    "build:simple": "npm run clean && tsc",
     "build:watch": "tsc --watch",
     "clean": "rimraf dist dist-types",
     "dev": "npm run build:watch",
@@ -54,11 +54,18 @@
   },
   "homepage": "",
   "peerDependencies": {
-    "react": "^19.0.0",
-    "react-dom": "^19.0.0",
-    "sanity": "^4.0.0"
+    "react": "^19.1.0",
+    "react-dom": "^19.1.0",
+    "sanity": "^4.16.0",
+    "@sanity/icons": "^2.0.0",
+    "@sanity/ui": "^1.0.0"
   },
   "devDependencies": {
+    "react": "^19.0.0",
+    "react-dom": "^19.0.0",
+    "sanity": "^4.0.0",
+    "@sanity/icons": "^2.0.0",
+    "@sanity/ui": "^1.0.0",
     "@testing-library/jest-dom": "^6.9.1",
     "@testing-library/react": "^16.3.0",
     "@types/jest": "^29.0.0",
@@ -79,8 +86,6 @@
     "webpack-cli": "^6.0.1"
   },
   "dependencies": {
-    "@sanity/icons": "^2.0.0",
-    "@sanity/ui": "^1.0.0",
     "protobufjs": "^7.5.4"
   }
 }