pro-editor-schema 1.1.2 → 1.1.4

package/README.md

@@ -18,18 +18,73 @@ npm install
 
 ## Scripts
 
-| Command | Description |
-| --- | --- |
-| `npm run dev` | Build in watch mode |
-| `npm run build` | Build CJS, ESM, and type declarations |
-| `npm run typecheck` | Run TypeScript without emitting files |
-| `npm run lint` | Run ESLint on `src/` |
-| `npm run test` | Run tests once with Vitest |
-| `npm run test:watch` | Run tests in watch mode |
-| `npm run check` | Run the full verification pipeline (`npm ci`, `typecheck`, `lint`, `test`, `build`) |
+| Command              | Description                                                                         |
+| -------------------- | ----------------------------------------------------------------------------------- |
+| `npm run dev`        | Build in watch mode                                                                 |
+| `npm run build`      | Build CJS, ESM, and type declarations                                               |
+| `npm run typecheck`  | Run TypeScript without emitting files                                               |
+| `npm run lint`       | Run ESLint on `src/`                                                                |
+| `npm run test`       | Run tests once with Vitest                                                          |
+| `npm run test:watch` | Run tests in watch mode                                                             |
+| `npm run check`      | Run the full verification pipeline (`npm ci`, `typecheck`, `lint`, `test`, `build`) |
 
 For local development, `npm run check` is the fastest way to verify everything before pushing.
 
+## Publishing
+
+The package is published to npm as `pro-editor-schema`. Use the `staging` tag for pre-release installs, and the default `latest` tag for production.
+
+### Prerequisites
+
+1. You must have publish access to the `pro-editor-schema` package on npm.
+2. Log in if needed:
+
+```bash
+npm login
+```
+
+3. Bump the version in `package.json` (and commit it). npm rejects republishing an existing version.
+4. Verify the package:
+
+```bash
+npm run check
+```
+
+### Publish to staging
+
+```bash
+npm publish --tag staging --access public
+```
+
+Install the staging build in a consumer app with:
+
+```bash
+npm install pro-editor-schema@staging
+```
+
+### Publish to production
+
+Production uses npm’s default `latest` tag:
+
+```bash
+npm publish --access public
+```
+
+Install the production build with:
+
+```bash
+npm install pro-editor-schema
+# or explicitly:
+npm install pro-editor-schema@latest
+```
+
+### Notes
+
+- Always run `npm run check` before publishing so typecheck, lint, tests, and build succeed.
+- Each publish needs a new `version` in `package.json`.
+- Staging and production can point at different versions at the same time (for example `1.1.3` on `staging` and `1.1.2` on `latest`).
+- GitHub Actions also publishes to `latest` when you push a `v*` git tag (see `.github/workflows/publish.yml`).
+
 ## CI
 
 GitHub Actions runs on push and pull requests to `main` / `master`:
@@ -125,12 +180,10 @@ const para = createElement({
 ```ts
 import { validateXml } from "pro-editor-schema";
 
-const errors = validateXml(
-  rootElement,
-  elementsToLink,
-  linkElements,
-  ["para", "heading"],
-);
+const errors = validateXml(rootElement, elementsToLink, linkElements, [
+  "para",
+  "heading",
+]);
 ```
 
 `validateXml` parameters:

package/dist/index.d.mts

@@ -93,7 +93,7 @@ declare const INLINE_ELEMENT_SCHEMAS: Record<InlineSchemaCode, Schema>;
 declare const ATOM_SCHEMAS: Record<AtomSchemaCode, Schema>;
 
 type ValidationErrorLevel = "blocker" | "warning" | "info";
-type ValidationErrorKind = "unlinked" | "forbidden" | "missing" | "converted";
+type ValidationErrorKind = "unlinked" | "forbidden" | "missing" | "converted" | "possible-url" | "unreachable-url";
 type ValidationError = {
     id: string;
     store: string;

package/dist/index.d.ts

@@ -93,7 +93,7 @@ declare const INLINE_ELEMENT_SCHEMAS: Record<InlineSchemaCode, Schema>;
 declare const ATOM_SCHEMAS: Record<AtomSchemaCode, Schema>;
 
 type ValidationErrorLevel = "blocker" | "warning" | "info";
-type ValidationErrorKind = "unlinked" | "forbidden" | "missing" | "converted";
+type ValidationErrorKind = "unlinked" | "forbidden" | "missing" | "converted" | "possible-url" | "unreachable-url";
 type ValidationError = {
     id: string;
     store: string;

package/dist/index.js

@@ -1,7 +1,9 @@
 "use strict";
+var __create = Object.create;
 var __defProp = Object.defineProperty;
 var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
 var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
 var __hasOwnProp = Object.prototype.hasOwnProperty;
 var __export = (target, all) => {
   for (var name in all)
@@ -15,6 +17,14 @@ var __copyProps = (to, from, except, desc) => {
   }
   return to;
 };
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
 var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
 
 // src/index.ts
@@ -2970,6 +2980,54 @@ var validateReferenceCited = (referenceElement, linkElements) => {
   ];
 };
 
+// src/validation/validateWeblink.ts
+var import_mark = __toESM(require("mark.js"));
+var WEB_URI_PATTERN = "(?:(?:https?):\\/\\/|www\\.)(?:[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?\\.)+[a-zA-Z]{2,}(?::\\d{1,5})?(?:\\/[^\\s]*)?";
+var WEB_URI_IN_TEXT_REGEX = new RegExp(WEB_URI_PATTERN, "gi");
+var POSSIBLE_WEBLINK_EXCLUDE_SELECTORS = [
+  "tag",
+  "tag *",
+  ".del",
+  "del *",
+  "uri",
+  "uri *",
+  "query",
+  "query *",
+  "comment",
+  "comment *",
+  ...IGNORED_ELEMENT_SELECTORS
+];
+var collectPossibleWebLinks = (content) => {
+  const clone = content.cloneNode(true);
+  const possibleWebLinks = /* @__PURE__ */ new Set();
+  const instance = new import_mark.default(clone);
+  instance.markRegExp(WEB_URI_IN_TEXT_REGEX, {
+    acrossElements: true,
+    exclude: POSSIBLE_WEBLINK_EXCLUDE_SELECTORS,
+    filter: (_textNode, term) => {
+      possibleWebLinks.add(term);
+      return true;
+    }
+  });
+  return possibleWebLinks;
+};
+var validatePossibleWeblinks = (root) => {
+  const errors = [];
+  const possibleWebLinks = collectPossibleWebLinks(root);
+  for (const possibleWebLink of possibleWebLinks) {
+    errors.push(
+      createValidationIssue({
+        store: possibleWebLink,
+        title: "Possible web link",
+        kind: "possible-url",
+        description: "This looks like a URL. Would you like to add weblink tags?",
+        level: "warning"
+      })
+    );
+  }
+  return errors;
+};
+
 // src/validation/validateXml.ts
 var validateElement = (element, root, elementsToLink, linkElements, schemasToValidateAgainst) => {
   if (isIgnoredElement(element)) {
@@ -3011,6 +3069,7 @@ var validateXml = (xml, elementsToLink, linkElements, schemasToValidateAgainst)
   const errors = [];
   errors.push(...validateConsecutiveFootnotes(xml));
   errors.push(...validateConsecutiveFootnoteCues(xml));
+  errors.push(...validatePossibleWeblinks(xml));
   for (const child of Array.from(xml.children)) {
     errors.push(
       ...validateElement(

package/dist/index.mjs

@@ -2902,6 +2902,54 @@ var validateReferenceCited = (referenceElement, linkElements) => {
   ];
 };
 
+// src/validation/validateWeblink.ts
+import Mark from "mark.js";
+var WEB_URI_PATTERN = "(?:(?:https?):\\/\\/|www\\.)(?:[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?\\.)+[a-zA-Z]{2,}(?::\\d{1,5})?(?:\\/[^\\s]*)?";
+var WEB_URI_IN_TEXT_REGEX = new RegExp(WEB_URI_PATTERN, "gi");
+var POSSIBLE_WEBLINK_EXCLUDE_SELECTORS = [
+  "tag",
+  "tag *",
+  ".del",
+  "del *",
+  "uri",
+  "uri *",
+  "query",
+  "query *",
+  "comment",
+  "comment *",
+  ...IGNORED_ELEMENT_SELECTORS
+];
+var collectPossibleWebLinks = (content) => {
+  const clone = content.cloneNode(true);
+  const possibleWebLinks = /* @__PURE__ */ new Set();
+  const instance = new Mark(clone);
+  instance.markRegExp(WEB_URI_IN_TEXT_REGEX, {
+    acrossElements: true,
+    exclude: POSSIBLE_WEBLINK_EXCLUDE_SELECTORS,
+    filter: (_textNode, term) => {
+      possibleWebLinks.add(term);
+      return true;
+    }
+  });
+  return possibleWebLinks;
+};
+var validatePossibleWeblinks = (root) => {
+  const errors = [];
+  const possibleWebLinks = collectPossibleWebLinks(root);
+  for (const possibleWebLink of possibleWebLinks) {
+    errors.push(
+      createValidationIssue({
+        store: possibleWebLink,
+        title: "Possible web link",
+        kind: "possible-url",
+        description: "This looks like a URL. Would you like to add weblink tags?",
+        level: "warning"
+      })
+    );
+  }
+  return errors;
+};
+
 // src/validation/validateXml.ts
 var validateElement = (element, root, elementsToLink, linkElements, schemasToValidateAgainst) => {
   if (isIgnoredElement(element)) {
@@ -2943,6 +2991,7 @@ var validateXml = (xml, elementsToLink, linkElements, schemasToValidateAgainst)
   const errors = [];
   errors.push(...validateConsecutiveFootnotes(xml));
   errors.push(...validateConsecutiveFootnoteCues(xml));
+  errors.push(...validatePossibleWeblinks(xml));
   for (const child of Array.from(xml.children)) {
     errors.push(
       ...validateElement(

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "pro-editor-schema",
-  "version": "1.1.2",
+  "version": "1.1.4",
   "description": "Pro Editor XML schemas",
   "main": "dist/index.js",
   "module": "dist/index.mjs",
@@ -26,11 +26,15 @@
   },
   "devDependencies": {
     "@eslint/js": "^10.0.1",
+    "@types/mark.js": "^8.11.12",
     "eslint": "^10.6.0",
     "happy-dom": "^20.0.10",
     "tsup": "^8.0.0",
     "typescript": "^5.0.0",
     "typescript-eslint": "^8.62.1",
     "vitest": "^3.2.4"
+  },
+  "dependencies": {
+    "mark.js": "^8.11.1"
   }
 }