{"id":21361691,"url":"https://github.com/webpractik/schema","last_synced_at":"2025-09-03T18:33:49.788Z","repository":{"id":143664271,"uuid":"305732401","full_name":"webpractik/schema","owner":"webpractik","description":null,"archived":false,"fork":false,"pushed_at":"2020-11-19T08:49:00.000Z","size":248,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-03-16T06:44:19.194Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/webpractik.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-10-20T14:20:23.000Z","updated_at":"2020-11-19T08:49:03.000Z","dependencies_parsed_at":null,"dependency_job_id":"9e7eed06-ba81-4f65-8545-f6b2f6aa7fa7","html_url":"https://github.com/webpractik/schema","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/webpractik/schema","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/webpractik%2Fschema","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/webpractik%2Fschema/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/webpractik%2Fschema/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/webpractik%2Fschema/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/webpractik","download_url":"https://codeload.github.com/webpractik/schema/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/webpractik%2Fschema/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":263440666,"owners_count":23466968,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-22T06:10:58.036Z","updated_at":"2025-07-04T03:33:37.166Z","avatar_url":"https://github.com/webpractik.png","language":"JavaScript","readme":"# Upgreat Readable Schema\n\nСхема обмена данных в рамках конкурса [Прочтение](https://ai.upgreat.one/).\n\n- Работа с типом\n- Валидация\n\n## Работа с типом\n\n```ts\nconst schema = Schema.fromJson(jsonDoc);\n```\n\nПри попытке создалть экземпляр, в случае если json не соответствует схеме, вызовется throw new Exception.\n\n## Пример работы валидации\n\n```ts\nasync function example() {\n  // создаем объект Schema\n  const schema = Schema.fromJson(jsonDoc);\n\n  // Скачиваем каталог ошибок\n  const errMap = await ErrorMapFactory.createErrorMap();\n\n  // Создаем экземпляр валидатора\n  const validator = new Validator();\n  validator.setErrorsMap(errMap);\n\n  // Можем добавлять валидации, в данном случае можно добавить проверку на оригальность текста\n  // используя внутренний источник данных\n  const textCheck = new CheckOriginalText((publicId, text) =\u003e {\n    return true;\n  });\n  // Изменить стандартное сообщение\n  textCheck.setErrMessage('new error message');\n  validator.addChecker(textCheck);\n\n  // Получаем результат валидации\n  const resultValidation = validator.validate(schema);\n  console.log(\n    'resultValidation',\n    resultValidation.status,\n    resultValidation.errors,\n  );\n}\n```\n\n## Перечень проверок\n\nДля проверки логики разметки Validator использует ряд проверок:\n\n- CheckEmptyFieldType - Отсутствуют фрагменты с пустыми типами ошибок \"type\"\n- CheckErrorTypeCorrection - У фрагмента ИСП всегда заполнено поле исправление \"correction\"\n- CheckRangeMarkup - Попадение цифр диапазона разметок (начало и конец) в длину текста.\n- CheckStartCoordinates - \"endSelection\" больше чем \"startSelection\"\n- CheckErrorTypes - Соответствие размеченных типов ошибок предмету\n- CheckSubTypes - Соответствие подтипов типам.\n- CheckFullTextErrorsCoordinates - Общие ошибки всегда имеют нулевые \"startSelection\", \"endSelection\"\n- CheckEqualityCoordinates - \"startSelection\" и \"endSelection\" не равны\n- CheckUniqueTag - Отсутствует ситуации с уникальным значением поля \"tag\" в рамках одного файла.\n- CheckOriginalText - проверка на совпадения текста. Присланный текст в json должен совпадать с оригинальным (страхуемся на случай что присланный originalText не был изменен). Для работы ошибки необходимо зарегистрировать callback который берет текст по умолчанию.\n\nВсе проверки кроме CheckOriginalText запускаются по умолчанию.\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwebpractik%2Fschema","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fwebpractik%2Fschema","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwebpractik%2Fschema/lists"}