@kodaeditor/core 1.0.1 → 1.0.2

package/dist/license.d.ts

@@ -1,90 +1,86 @@
 /**
- * Состояния лицензии.
+ * License states.
  *
- * 'invalid' и 'unreachable' РАЗНЫЕ, и различие не косметическое: первое
- * означает «сервер сказал нет», второе - «мы не смогли спросить». Наказывать
- * покупателя за нашу недоступность нельзя, поэтому пометка в выгрузках
- * ставится только при 'invalid' и 'unconfigured' (см. web-component).
+ * 'invalid' and 'unreachable' are deliberately different: the first means the
+ * validation service said no, the second that it could not be asked. You are
+ * never marked because our service is down, so the evaluation marks appear
+ * only for 'invalid' and 'unconfigured'.
  */
 export type LicenseStatus = 'valid' | 'grace' | 'invalid' | 'unreachable' | 'unconfigured';
 export interface LicenseResult {
     status: LicenseStatus;
     /**
-     * Список из ответа сервера. НИЧЕГО НЕ ОГРАНИЧИВАЕТ: ключ открывает все
-     * возможности редактора, деления на тарифы нет, и ни одна функция не
-     * сверяется с этим списком - проверено по всему ядру 12.09.2026.
+     * A list returned by the validation service. It RESTRICTS NOTHING: a
+     * license unlocks the whole editor, there are no tiers, and no feature
+     * checks itself against this list.
      *
-     * Поле осталось от замысла продавать возможности по отдельности и сейчас
-     * служит только одному: оно входит в подписываемую строку ответа, поэтому
-     * убрать его нельзя, не меняя протокол подписи на обеих сторонах.
-     *
-     * Комментарий здесь раньше обещал feature-gating. Это было неправдой и
-     * вводило в заблуждение любого, кто читал ответ /validate и видел там два
-     * названия вместо всех возможностей, за которые заплатил.
+     * The field is kept only because it is part of the signed response, so
+     * removing it would change the signature protocol on both sides. If you see
+     * two names here rather than every feature you paid for, nothing is being
+     * withheld.
      */
     plugins: string[];
-    /** Показывать ли водяной знак. */
+    /** Whether to show the watermark. */
     watermark: boolean;
     message?: string;
 }
 export interface LicenseOptions {
-    /** Лицензионный ключ клиента. */
+    /** Your license key. */
     key?: string;
     /**
-     * URL license-сервера. По умолчанию - наш боевой адрес (DEFAULT_ENDPOINT),
-     * задавать его клиенту НЕ нужно. Переопределяют только те, кто проксирует
-     * проверку через собственный домен.
+     * URL of the validation service. Defaults to ours (DEFAULT_ENDPOINT), so
+     * you do not need to set it. Override it only if you proxy validation
+     * through your own domain.
      */
     endpoint?: string;
-    /** Сколько дней жить по кэшу при недоступной сети. */
+    /** How many days to keep working from cache while the network is unreachable. */
     graceDays?: number;
 }
 /**
- * Адрес проверки лицензий по умолчанию.
+ * Default address of the validation service.
  *
- * Зашит намеренно: раньше адрес был обязательным атрибутом, и во всех наших
- * же сниппетах стоял плейсхолдер вида https://your-domain.com/validate, то
- * есть домен ПОКУПАТЕЛЯ, где такого эндпоинта нет. Клиент подключал по
- * документации и получал водяной знак на проде. Адрес наш и меняться не
- * должен: он остаётся в коде у всех выданных лицензий бессрочно.
+ * Built in on purpose, so that a working installation needs no endpoint
+ * configuration at all. The address is ours and does not change: it stays in
+ * the code of every license issued.
  */
 export declare const DEFAULT_ENDPOINT = "https://api.kodaeditor.com/validate";
 /**
- * Проверяет лицензию.
+ * Validates a license key.
  *
- * Порядок: свежий кэш (моложе суток) отвечает сразу и обновляется в фоне;
- * иначе идём на сервер; если сервер недоступен - живём по кэшу в пределах
- * grace-периода; иначе деградация (водяной знак, редактор продолжает работать).
+ * Order of play: a fresh cache (less than a day old) answers at once and is
+ * refreshed in the background; otherwise the service is asked; if it cannot
+ * be reached, the cache keeps the installation clean for the grace period;
+ * only after that does the editor fall back to trial mode. It keeps working
+ * either way - nothing is switched off.
  *
- * Сознательно НЕ делаем поблажку «первая установка при недоступном сервере»:
- * ключ на этом этапе ещё ни разу не подтверждён, и любое такое окно означало
- * бы, что произвольная строка в атрибуте license плюс закрытый доступ к нашему
- * домену дают чистый редактор. Доступность сервера - наша задача, а не повод
- * ослабить проверку.
+ * There is deliberately no exception for a first install while the service is
+ * unreachable: at that point the key has never been confirmed, and such a
+ * window would mean any string in the license attribute plus a blocked domain
+ * yields an unmarked editor.
  */
 export declare function validateLicense(opts: LicenseOptions): Promise<LicenseResult>;
 export interface OfflineLicenseOptions {
     /**
-     * URL подписанного файла лицензии (обычно свой же домен: /license.json).
-     * Взаимоисключимо с fileContent - если задан fileContent, fileUrl
-     * игнорируется.
+     * URL of the signed license file, usually on your own domain
+     * (/license.json). Mutually exclusive with fileContent: if fileContent is
+     * given, fileUrl is ignored.
      */
     fileUrl?: string;
     /**
-     * Содержимое файла лицензии ИНЛАЙНОМ, без fetch. Обязательно для
-     * страниц, открытых напрямую file:// (там fetch() к соседнему файлу не
-     * работает вовсе - браузерное ограничение, не наше) - сценарий агента
-     * в поле без интернета и без локального веб-сервера: HTML/JS/подпись
-     * поставляются одним пакетом, ничего не грузится по сети.
+     * The license file INLINE, with no fetch. Required for pages opened
+     * directly from disk over file://, where the browser refuses to fetch a
+     * neighbouring file at all. This is the case of a machine in the field with
+     * no internet and no local web server: HTML, JavaScript and the signed
+     * license ship together and nothing is loaded over the network.
      */
     fileContent?: string;
 }
 /**
- * Полностью офлайн-проверка: подпись файла проверяется локально (Web
- * Crypto API), без обращения к license-серверу. Содержимое либо
- * загружается (fileUrl - для same-origin/localhost развёртываний), либо
- * передаётся сразу (fileContent - для true-offline file:// страниц, где
- * fetch физически недоступен). Никогда не бросает - при любой проблеме
- * возвращает деградацию (водяной знак), как и онлайн-путь validateLicense().
+ * Fully offline validation: the file's signature is checked locally through
+ * the Web Crypto API, with no request to the validation service ever. The
+ * contents are either fetched (fileUrl, for same-origin deployments) or
+ * passed in directly (fileContent, for file:// pages where fetch is not
+ * available). Never throws: any problem falls back to trial mode, exactly as
+ * the online path does.
  */
 export declare function validateLicenseOffline(opts: OfflineLicenseOptions): Promise<LicenseResult>;

package/dist/schema.d.ts

@@ -1,13 +1,13 @@
 /**
- * Схема документа KodaEditor.
+ * The KodaEditor document schema.
  *
- * Документ хранится как структурированная модель ProseMirror, а не как
- * «сырой» HTML из contenteditable. Благодаря этому вывод всегда чистый —
- * никаких `<span style>` и пустых тегов, которыми грешит TinyMCE.
+ * The document is held as a structured ProseMirror model rather than as raw
+ * contenteditable HTML, which is why the output stays clean: no stray
+ * `<span style>` and no empty tags.
  *
- * За основу взята проверенная prosemirror-schema-basic, расширенная
- * списками и дополнительными марками (подчёркивание, зачёркивание),
- * которые корпоративные редакторы ожидают по умолчанию.
+ * It builds on prosemirror-schema-basic, extended with lists and the extra
+ * marks a business document is expected to have, such as underline and
+ * strikethrough.
  */
 import { Schema, type MarkSpec, type NodeSpec } from 'prosemirror-model';
 export declare const editorSchema: Schema<keyof import("orderedmap").default<NodeSpec>, keyof import("orderedmap").default<MarkSpec>>;

package/dist/serialize.d.ts

@@ -1,20 +1,20 @@
 /**
- * Сериализация и парсинг документа.
+ * Serialising and parsing the document.
  *
- * Выход — чистый HTML, построенный из модели документа через
- * официальный DOMSerializer ProseMirror. Вход — строгий парсинг входного
- * HTML обратно в модель, что попутно отбрасывает небезопасный/мусорный
- * разметочный шум (база для будущего paste-санитайзера).
+ * Output is clean HTML, built from the document model through ProseMirror's
+ * own DOMSerializer. Input is parsed strictly back into the model, which
+ * discards unsafe and junk markup along the way.
  */
 import { type Node as PMNode } from 'prosemirror-model';
-/** Документ ProseMirror -> чистая HTML-строка. */
+/** Turns a ProseMirror document into a clean HTML string. */
 export declare function docToHTML(doc: PMNode): string;
 /**
- * HTML-строка -> документ ProseMirror (по схеме редактора).
+ * Turns an HTML string into a ProseMirror document, following the editor
+ * schema.
  *
- * Перед парсингом HTML прогоняется через DOMPurify: это отсекает
- * исполняемые векторы (`<script>`, `onerror=`, `<svg onload>` и т.п.),
- * которые иначе срабатывают при присваивании в innerHTML — даже несмотря
- * на то, что ProseMirror потом отбросит сами узлы. Защита от XSS на входе.
+ * The HTML is sanitised first: executable vectors such as `<script>`,
+ * `onerror=` and `<svg onload>` would otherwise fire the moment the markup is
+ * assigned to innerHTML, even though ProseMirror discards those nodes
+ * afterwards. This is the XSS barrier on input.
  */
 export declare function htmlToDoc(html: string): PMNode;