adstxt-validator 1.2.3

package/dist/locales/en/validation.json

@@ -0,0 +1,89 @@
+{
+    "validation_errors": {
+        "missingFields": {
+            "message": "Missing required fields",
+            "description": "Ads.txt entries require three mandatory fields: domain, account ID, and relationship",
+            "helpUrl": "/help/#missing-fields"
+        },
+        "invalidFormat": {
+            "message": "Invalid format",
+            "description": "The ads.txt entry format is incorrect. Please use comma-separated format",
+            "helpUrl": "/help/#invalid-format"
+        },
+        "invalidRelationship": {
+            "message": "Invalid relationship",
+            "description": "Relationship must be either 'DIRECT' or 'RESELLER'",
+            "helpUrl": "/help/#invalid-relationship"
+        },
+        "invalidDomain": {
+            "message": "Invalid domain",
+            "description": "The specified domain '{{domain}}' is not a valid domain format",
+            "helpUrl": "/help/#invalid-domain"
+        },
+        "emptyAccountId": {
+            "message": "Account ID is empty",
+            "description": "Account ID is a required field",
+            "helpUrl": "/help/#empty-account-id"
+        },
+        "emptyFile": {
+            "message": "File is empty",
+            "description": "The ads.txt file contains no content",
+            "helpUrl": "/help/#empty-file"
+        },
+        "invalidCharacters": {
+            "message": "Contains invalid characters",
+            "description": "The ads.txt file contains non-printable or control characters",
+            "helpUrl": "/help/#invalid-characters"
+        },
+        "noSellersJson": {
+            "message": "sellers.json file not found for {{domain}}",
+            "description": "The specified advertising system does not have a sellers.json file",
+            "helpUrl": "/help/#no-sellers-json"
+        },
+        "directAccountIdNotInSellersJson": {
+            "message": "DIRECT entry account ID '{{accountId}}' not found in sellers.json",
+            "description": "DIRECT relationship entries must have their account ID registered in the corresponding sellers.json file",
+            "helpUrl": "/help/#direct-account-id-not-in-sellers-json"
+        },
+        "resellerAccountIdNotInSellersJson": {
+            "message": "RESELLER entry account ID '{{accountId}}' not found in sellers.json",
+            "description": "RESELLER relationship entries must have their account ID registered in the corresponding sellers.json file",
+            "helpUrl": "/help/#reseller-account-id-not-in-sellers-json"
+        },
+        "domainMismatch": {
+            "message": "Domain mismatch: {{sellerDomain}}",
+            "description": "The domain in sellers.json does not match the OWNERDOMAIN/MANAGERDOMAIN in ads.txt",
+            "helpUrl": "/help/#domain-mismatch"
+        },
+        "directNotPublisher": {
+            "message": "DIRECT entry seller_type is not 'PUBLISHER'",
+            "description": "DIRECT relationship entries should have seller_type as 'PUBLISHER' or 'BOTH' in sellers.json",
+            "helpUrl": "/help/#direct-not-publisher"
+        },
+        "sellerIdNotUnique": {
+            "message": "Account ID '{{accountId}}' is duplicated",
+            "description": "The same account ID is used in multiple entries",
+            "helpUrl": "/help/#seller-id-not-unique"
+        },
+        "resellerNotIntermediary": {
+            "message": "RESELLER entry seller_type is not 'INTERMEDIARY'",
+            "description": "RESELLER relationship entries should have seller_type as 'INTERMEDIARY' or 'BOTH' in sellers.json",
+            "helpUrl": "/help/#reseller-not-intermediary"
+        },
+        "implimentedEntry": {
+            "message": "Duplicate entry",
+            "description": "Multiple ads.txt entries with the same content exist",
+            "helpUrl": "/help/#implimented-entry"
+        },
+        "noValidRecords": {
+            "message": "No valid records found",
+            "description": "The uploaded file or provided data does not contain any valid ads.txt records",
+            "helpUrl": "/help/#no-valid-records"
+        },
+        "parsingError": {
+            "message": "Parsing error: {{message}}",
+            "description": "An error occurred while parsing the file or data",
+            "helpUrl": "/help/#parsing-error"
+        }
+    }
+}

package/dist/locales/ja/validation.json

@@ -0,0 +1,89 @@
+{
+    "validation_errors": {
+        "missingFields": {
+            "message": "必須フィールドが不足しています",
+            "description": "ads.txtエントリには、ドメイン、アカウントID、関係性の3つの必須フィールドが必要です",
+            "helpUrl": "/help/#missing-fields"
+        },
+        "invalidFormat": {
+            "message": "無効なフォーマットです",
+            "description": "ads.txtエントリの形式が正しくありません。カンマで区切られた形式で入力してください",
+            "helpUrl": "/help/#invalid-format"
+        },
+        "invalidRelationship": {
+            "message": "無効な関係性です",
+            "description": "関係性は「DIRECT」または「RESELLER」である必要があります",
+            "helpUrl": "/help/#invalid-relationship"
+        },
+        "invalidDomain": {
+            "message": "無効なドメインです",
+            "description": "指定されたドメイン「{{domain}}」は有効なドメイン形式ではありません",
+            "helpUrl": "/help/#invalid-domain"
+        },
+        "emptyAccountId": {
+            "message": "アカウントIDが空です",
+            "description": "アカウントIDは必須フィールドです",
+            "helpUrl": "/help/#empty-account-id"
+        },
+        "emptyFile": {
+            "message": "ファイルが空です",
+            "description": "ads.txtファイルにコンテンツがありません",
+            "helpUrl": "/help/#empty-file"
+        },
+        "invalidCharacters": {
+            "message": "無効な文字が含まれています",
+            "description": "ads.txtファイルに印刷できない文字や制御文字が含まれています",
+            "helpUrl": "/help/#invalid-characters"
+        },
+        "noSellersJson": {
+            "message": "{{domain}}のsellers.jsonファイルが見つかりません",
+            "description": "指定された広告システムにsellers.jsonファイルが存在しません",
+            "helpUrl": "/help/#no-sellers-json"
+        },
+        "directAccountIdNotInSellersJson": {
+            "message": "DIRECTエントリのアカウントID「{{accountId}}」がsellers.jsonに見つかりません",
+            "description": "DIRECT関係のエントリは、対応するsellers.jsonファイルにアカウントIDが登録されている必要があります",
+            "helpUrl": "/help/#direct-account-id-not-in-sellers-json"
+        },
+        "resellerAccountIdNotInSellersJson": {
+            "message": "RESELLERエントリのアカウントID「{{accountId}}」がsellers.jsonに見つかりません",
+            "description": "RESELLER関係のエントリは、対応するsellers.jsonファイルにアカウントIDが登録されている必要があります",
+            "helpUrl": "/help/#reseller-account-id-not-in-sellers-json"
+        },
+        "domainMismatch": {
+            "message": "ドメインの不一致: {{sellerDomain}}",
+            "description": "sellers.jsonのドメインとads.txtのOWNERDOMAIN/MANAGERDOMAINが一致しません",
+            "helpUrl": "/help/#domain-mismatch"
+        },
+        "directNotPublisher": {
+            "message": "DIRECTエントリのseller_typeが「PUBLISHER」ではありません",
+            "description": "DIRECT関係のエントリは、sellers.jsonでseller_typeが「PUBLISHER」または「BOTH」である必要があります",
+            "helpUrl": "/help/#direct-not-publisher"
+        },
+        "sellerIdNotUnique": {
+            "message": "アカウントID「{{accountId}}」が重複しています",
+            "description": "同じアカウントIDが複数のエントリで使用されています",
+            "helpUrl": "/help/#seller-id-not-unique"
+        },
+        "resellerNotIntermediary": {
+            "message": "RESELLERエントリのseller_typeが「INTERMEDIARY」ではありません",
+            "description": "RESELLER関係のエントリは、sellers.jsonでseller_typeが「INTERMEDIARY」または「BOTH」である必要があります",
+            "helpUrl": "/help/#reseller-not-intermediary"
+        },
+        "implimentedEntry": {
+            "message": "重複したエントリです",
+            "description": "同じ内容のads.txtエントリが複数存在します",
+            "helpUrl": "/help/#implimented-entry"
+        },
+        "noValidRecords": {
+            "message": "有効なレコードがありません",
+            "description": "アップロードされたファイルまたは提供されたデータに有効なads.txtレコードが含まれていません",
+            "helpUrl": "/help/#no-valid-records"
+        },
+        "parsingError": {
+            "message": "解析エラー: {{message}}",
+            "description": "ファイルまたはデータの解析中にエラーが発生しました",
+            "helpUrl": "/help/#parsing-error"
+        }
+    }
+}

package/dist/messages.d.ts

@@ -0,0 +1,263 @@
+/**
+ * Message system for ads-txt-validator
+ * Provides internationalized messages and help links for validation results
+ */
+export interface ValidationMessage {
+    key: string;
+    severity: Severity;
+    message: string;
+    description?: string;
+    helpUrl?: string;
+    placeholders: string[];
+}
+export interface MessageData {
+    message: string;
+    description?: string;
+    helpUrl?: string;
+}
+export interface MessageProvider {
+    getMessage(key: string, locale?: string): MessageData | null;
+    formatMessage(key: string, placeholders: string[], locale?: string): ValidationMessage | null;
+}
+import { Severity } from './index';
+declare const messages: {
+    readonly ja: {
+        validation_errors: {
+            missingFields: {
+                message: string;
+                description: string;
+                helpUrl: string;
+            };
+            invalidFormat: {
+                message: string;
+                description: string;
+                helpUrl: string;
+            };
+            invalidRelationship: {
+                message: string;
+                description: string;
+                helpUrl: string;
+            };
+            invalidDomain: {
+                message: string;
+                description: string;
+                helpUrl: string;
+            };
+            emptyAccountId: {
+                message: string;
+                description: string;
+                helpUrl: string;
+            };
+            emptyFile: {
+                message: string;
+                description: string;
+                helpUrl: string;
+            };
+            invalidCharacters: {
+                message: string;
+                description: string;
+                helpUrl: string;
+            };
+            noSellersJson: {
+                message: string;
+                description: string;
+                helpUrl: string;
+            };
+            directAccountIdNotInSellersJson: {
+                message: string;
+                description: string;
+                helpUrl: string;
+            };
+            resellerAccountIdNotInSellersJson: {
+                message: string;
+                description: string;
+                helpUrl: string;
+            };
+            domainMismatch: {
+                message: string;
+                description: string;
+                helpUrl: string;
+            };
+            directNotPublisher: {
+                message: string;
+                description: string;
+                helpUrl: string;
+            };
+            sellerIdNotUnique: {
+                message: string;
+                description: string;
+                helpUrl: string;
+            };
+            resellerNotIntermediary: {
+                message: string;
+                description: string;
+                helpUrl: string;
+            };
+            implimentedEntry: {
+                message: string;
+                description: string;
+                helpUrl: string;
+            };
+            noValidRecords: {
+                message: string;
+                description: string;
+                helpUrl: string;
+            };
+            parsingError: {
+                message: string;
+                description: string;
+                helpUrl: string;
+            };
+        };
+    };
+    readonly en: {
+        validation_errors: {
+            missingFields: {
+                message: string;
+                description: string;
+                helpUrl: string;
+            };
+            invalidFormat: {
+                message: string;
+                description: string;
+                helpUrl: string;
+            };
+            invalidRelationship: {
+                message: string;
+                description: string;
+                helpUrl: string;
+            };
+            invalidDomain: {
+                message: string;
+                description: string;
+                helpUrl: string;
+            };
+            emptyAccountId: {
+                message: string;
+                description: string;
+                helpUrl: string;
+            };
+            emptyFile: {
+                message: string;
+                description: string;
+                helpUrl: string;
+            };
+            invalidCharacters: {
+                message: string;
+                description: string;
+                helpUrl: string;
+            };
+            noSellersJson: {
+                message: string;
+                description: string;
+                helpUrl: string;
+            };
+            directAccountIdNotInSellersJson: {
+                message: string;
+                description: string;
+                helpUrl: string;
+            };
+            resellerAccountIdNotInSellersJson: {
+                message: string;
+                description: string;
+                helpUrl: string;
+            };
+            domainMismatch: {
+                message: string;
+                description: string;
+                helpUrl: string;
+            };
+            directNotPublisher: {
+                message: string;
+                description: string;
+                helpUrl: string;
+            };
+            sellerIdNotUnique: {
+                message: string;
+                description: string;
+                helpUrl: string;
+            };
+            resellerNotIntermediary: {
+                message: string;
+                description: string;
+                helpUrl: string;
+            };
+            implimentedEntry: {
+                message: string;
+                description: string;
+                helpUrl: string;
+            };
+            noValidRecords: {
+                message: string;
+                description: string;
+                helpUrl: string;
+            };
+            parsingError: {
+                message: string;
+                description: string;
+                helpUrl: string;
+            };
+        };
+    };
+};
+export type SupportedLocale = keyof typeof messages;
+/**
+ * Configuration for message provider
+ */
+export interface MessageConfig {
+    defaultLocale?: SupportedLocale;
+    baseUrl?: string;
+}
+/**
+ * Default message provider implementation
+ */
+export declare class DefaultMessageProvider implements MessageProvider {
+    private defaultLocale;
+    private baseUrl?;
+    constructor(defaultLocale?: SupportedLocale, config?: MessageConfig);
+    /**
+     * Get raw message data for a validation key
+     */
+    getMessage(key: string, locale?: string): MessageData | null;
+    /**
+     * Format help URL with base URL if configured
+     */
+    private formatHelpUrl;
+    /**
+     * Format a message with placeholders and create a ValidationMessage
+     */
+    formatMessage(key: string, placeholders?: string[], locale?: string): ValidationMessage | null;
+    /**
+     * Replace {{placeholder}} and {{0}}, {{1}} style placeholders
+     */
+    private replacePlaceholders;
+    /**
+     * Determine severity from validation key
+     */
+    private getSeverityFromKey;
+}
+/**
+ * Set the global message provider
+ */
+export declare function setMessageProvider(provider: MessageProvider): void;
+/**
+ * Configure the global message provider with baseUrl
+ */
+export declare function configureMessages(config: MessageConfig): void;
+/**
+ * Get the current message provider
+ */
+export declare function getMessageProvider(): MessageProvider;
+/**
+ * Convenience function to create a validation message
+ */
+export declare function createValidationMessage(key: string, placeholders?: string[], locale?: string): ValidationMessage | null;
+/**
+ * Check if a locale is supported
+ */
+export declare function isSupportedLocale(locale: string): locale is SupportedLocale;
+/**
+ * Get list of supported locales
+ */
+export declare function getSupportedLocales(): SupportedLocale[];
+export {};

package/dist/messages.js

@@ -0,0 +1,189 @@
+"use strict";
+/**
+ * Message system for ads-txt-validator
+ * Provides internationalized messages and help links for validation results
+ */
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DefaultMessageProvider = void 0;
+exports.setMessageProvider = setMessageProvider;
+exports.configureMessages = configureMessages;
+exports.getMessageProvider = getMessageProvider;
+exports.createValidationMessage = createValidationMessage;
+exports.isSupportedLocale = isSupportedLocale;
+exports.getSupportedLocales = getSupportedLocales;
+const validation_json_1 = __importDefault(require("./locales/ja/validation.json"));
+const validation_json_2 = __importDefault(require("./locales/en/validation.json"));
+// Import severity from main index
+const index_1 = require("./index");
+// Message resources
+const messages = {
+    ja: validation_json_1.default,
+    en: validation_json_2.default,
+};
+/**
+ * Default message provider implementation
+ */
+class DefaultMessageProvider {
+    constructor(defaultLocale = 'ja', config) {
+        this.defaultLocale = 'ja';
+        this.defaultLocale = config?.defaultLocale || defaultLocale;
+        this.baseUrl = config?.baseUrl;
+    }
+    /**
+     * Get raw message data for a validation key
+     */
+    getMessage(key, locale) {
+        const targetLocale = locale || this.defaultLocale;
+        const messageBundle = messages[targetLocale] || messages[this.defaultLocale];
+        const messageData = messageBundle.validation_errors[key];
+        if (!messageData) {
+            return null;
+        }
+        return {
+            message: messageData.message,
+            description: messageData.description,
+            helpUrl: this.formatHelpUrl(messageData.helpUrl),
+        };
+    }
+    /**
+     * Format help URL with base URL if configured
+     */
+    formatHelpUrl(helpUrl) {
+        if (!helpUrl) {
+            return undefined;
+        }
+        // If helpUrl is already a full URL (starts with http/https), return as-is
+        if (helpUrl.startsWith('http://') || helpUrl.startsWith('https://')) {
+            return helpUrl;
+        }
+        // If baseUrl is configured and helpUrl is relative, combine them
+        if (this.baseUrl && helpUrl.startsWith('/')) {
+            return `${this.baseUrl.replace(/\/$/, '')}${helpUrl}`;
+        }
+        // Return helpUrl as-is for other cases
+        return helpUrl;
+    }
+    /**
+     * Format a message with placeholders and create a ValidationMessage
+     */
+    formatMessage(key, placeholders = [], locale) {
+        const messageData = this.getMessage(key, locale);
+        if (!messageData) {
+            return null;
+        }
+        // Replace placeholders in the message
+        const formattedMessage = this.replacePlaceholders(messageData.message, placeholders);
+        const formattedDescription = messageData.description
+            ? this.replacePlaceholders(messageData.description, placeholders)
+            : undefined;
+        // Determine severity based on key
+        const severity = this.getSeverityFromKey(key);
+        return {
+            key,
+            severity,
+            message: formattedMessage,
+            description: formattedDescription,
+            helpUrl: messageData.helpUrl,
+            placeholders,
+        };
+    }
+    /**
+     * Replace {{placeholder}} and {{0}}, {{1}} style placeholders
+     */
+    replacePlaceholders(template, placeholders) {
+        let result = template;
+        // Replace numbered placeholders like {{0}}, {{1}}
+        result = result.replace(/\{\{(\d+)\}\}/g, (match, index) => {
+            const placeholderIndex = parseInt(index, 10);
+            return placeholders[placeholderIndex] || match;
+        });
+        // Replace named placeholders
+        if (placeholders.length > 0) {
+            // Common placeholder names
+            const placeholderNames = ['domain', 'accountId', 'sellerDomain', 'accountType'];
+            placeholderNames.forEach((name, index) => {
+                if (index < placeholders.length) {
+                    result = result.replace(new RegExp(`\\{\\{${name}\\}\\}`, 'g'), placeholders[index]);
+                }
+            });
+        }
+        return result;
+    }
+    /**
+     * Determine severity from validation key
+     */
+    getSeverityFromKey(key) {
+        // Keys that should be errors
+        const errorKeys = [
+            'missingFields',
+            'invalidFormat',
+            'invalidRelationship',
+            'invalidDomain',
+            'emptyAccountId',
+            'emptyFile',
+            'invalidCharacters',
+            'directAccountIdNotInSellersJson',
+            'resellerAccountIdNotInSellersJson',
+        ];
+        if (errorKeys.includes(key)) {
+            return index_1.Severity.ERROR;
+        }
+        // Keys that should be warnings
+        const warningKeys = [
+            'noSellersJson',
+            'domainMismatch',
+            'directNotPublisher',
+            'resellerNotIntermediary',
+            'sellerIdNotUnique',
+        ];
+        if (warningKeys.includes(key)) {
+            return index_1.Severity.WARNING;
+        }
+        // Default to info
+        return index_1.Severity.INFO;
+    }
+}
+exports.DefaultMessageProvider = DefaultMessageProvider;
+/**
+ * Global message provider instance
+ */
+let globalMessageProvider = new DefaultMessageProvider();
+/**
+ * Set the global message provider
+ */
+function setMessageProvider(provider) {
+    globalMessageProvider = provider;
+}
+/**
+ * Configure the global message provider with baseUrl
+ */
+function configureMessages(config) {
+    globalMessageProvider = new DefaultMessageProvider(config.defaultLocale, config);
+}
+/**
+ * Get the current message provider
+ */
+function getMessageProvider() {
+    return globalMessageProvider;
+}
+/**
+ * Convenience function to create a validation message
+ */
+function createValidationMessage(key, placeholders = [], locale) {
+    return globalMessageProvider.formatMessage(key, placeholders, locale);
+}
+/**
+ * Check if a locale is supported
+ */
+function isSupportedLocale(locale) {
+    return locale in messages;
+}
+/**
+ * Get list of supported locales
+ */
+function getSupportedLocales() {
+    return Object.keys(messages);
+}

package/package.json

@@ -0,0 +1,55 @@
+{
+  "name": "adstxt-validator",
+  "version": "1.2.3",
+  "description": "A TypeScript library for validating ads.txt files and sellers.json files",
+  "type": "module",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist/**/*",
+    "src/locales/**/*.json",
+    "README.md",
+    "LICENSE"
+  ],
+  "scripts": {
+    "build": "tsc",
+    "lint": "eslint src --ext .ts",
+    "lint:fix": "eslint src --ext .ts --fix",
+    "format": "prettier --write \"src/**/*.ts\"",
+    "format:check": "prettier --check \"src/**/*.ts\"",
+    "prepublishOnly": "npm run build",
+    "test": "echo \"Tests will be implemented in future versions\" && exit 0"
+  },
+  "keywords": [
+    "ads.txt",
+    "sellers.json",
+    "advertising",
+    "validation",
+    "typescript"
+  ],
+  "author": "Yoshihiko Miyaichi",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/miyaichi/adstxt-validator.git"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "dependencies": {
+    "psl": "^1.9.0"
+  },
+  "devDependencies": {
+    "@eslint/js": "^9.39.2",
+    "@types/node": "^20.0.0",
+    "@types/psl": "^1.1.3",
+    "@typescript-eslint/eslint-plugin": "^8.49.0",
+    "@typescript-eslint/parser": "^8.49.0",
+    "eslint": "^9.39.2",
+    "eslint-config-prettier": "^10.1.8",
+    "eslint-plugin-prettier": "^5.5.4",
+    "prettier": "^3.7.4",
+    "typescript": "^5.0.4",
+    "typescript-eslint": "^8.49.0"
+  }
+}