@gmb/bitmark-parser 7.3.0 → 7.4.0

package/README.md

@@ -276,7 +276,15 @@ survives in a lesser form (its value cleared, or one of its segments dropped).
 Both arrive on the conversion's warnings, like every other issue. In practice
 they are rare — a `href` holding a line terminator, a mark kind the grammar has
 no tag for — so treat either as a signal that the JSON holds something bitmark
-cannot express, not as routine noise.
+cannot express, not as routine noise. Likewise `list-number-invalid`: a list
+`start` or item `value` that is not a valid number for its list (`4000` on a
+Roman list), or a `value` on a bullet or task item, is ignored and reported.
+
+Reading bitmark, an inline property list (`==text==|link:…|?hint|`) reports two
+things (PLAN-217): `text-tag-cardinality-exceeded` when a child is given more
+often than it may be (`|?a|?b|` — the later value wins), and
+`text-tag-value-invalid` when a value does not fit its format but is kept
+(`|symbol:…|width:wide|`).
 
 #### canonicalize(input: string, options?: CanonicalizeOptions): string
 

package/config/bitmark-json.tsp

@@ -66,6 +66,14 @@ model BitmarkJson {
   /** Resource-group registry by key (sorted). Here the member list is
    *  authoritative. */
   resourceGroups: Record<ResourceGroup>;
+
+  /** Text tags by JSON type (sorted): the heads of inline property lists
+   *  (`==text==|head:value|child:value|…|`) and the JSON-only marks
+   *  (PLAN-217). Group references are expanded. */
+  textTags: Record<TextTag>;
+
+  /** ProseMirror nodes that are not text tags (sorted): mappings only. */
+  textNodes: Record<TextNode>;
 }
 
 model Locale {
@@ -318,6 +326,107 @@ model BitGroup {
   allowEmpty?: true;
 }
 
+/** A value format of a text tag or child. `none`: no value. `duration`: `P`
+ *  followed by anything (the 8.41.1 grammar rule). */
+union TextFormat {
+  "none",
+  "string",
+  "bitmark+",
+  "boolean",
+  "number",
+  "enum",
+  "duration",
+}
+
+/** What an invalid value or a missing required child does: `warn` keeps it
+ *  and reports; `invalid` rejects the segment and ends the chain. */
+union OnInvalid {
+  "warn",
+  "invalid",
+}
+
+/** A text tag (PLAN-217). */
+model TextTag {
+  description: string;
+
+  /** `mark` decorates the text run; `node` replaces it. */
+  kind: "mark" | "node";
+
+  /** Source spelling of the head; omitted → no bitmark form. An identifier
+   *  (letters, digits and `*`, starting with a letter) followed by `:value`,
+   *  or a sigil — one non-letter BMP character outside the chain syntax
+   *  (`|:^@=*`) — that runs straight into its value (`#`, `►`, `?`). */
+  key?: string;
+
+  format: TextFormat;
+
+  /** Enum vocabulary; emitted only for `enum`. */
+  values?: string[];
+
+  /** `null` = omit (absence is its own state); always `null` for `none`. */
+  default: string | null;
+
+  /** Flag boolean (PLAN-152). */
+  alwaysEmit?: true;
+
+  /** Always emitted: `invalid` for `none`, else `warn` unless authored. */
+  onInvalid: OnInvalid;
+
+  /** `first`: valid only as the first segment; omitted = any position. */
+  headPosition?: "first";
+
+  /** Text tags that may start after this head's chain; omitted = any. */
+  followingHeads?: string[];
+
+  /** A named value transform applied on read. */
+  transform?: "lowercase";
+
+  /** JSON input of this (legacy) type is read as the named text tag. */
+  migrateTo?: string;
+
+  /** `json`: `{"type": <name>, …fields}` — a field value is `"$"` (the
+   *  head's value), `"$text"` (the text between `==`) or a constant. A head
+   *  with a value places it exactly once (`"$"`); a `none` head places none;
+   *  no two fields of the head and its chain write the same path. */
+  mappingKeys?: MappingKeys;
+
+  /** Children in canonical order (D16); omitted when empty. */
+  chain?: TextChild[];
+}
+
+/** A child of a text tag. */
+model TextChild {
+  /** Source spelling (`?`, `►`, `provider`, …); same rules as
+   *  `TextTag.key`. */
+  tag: string;
+  description: string;
+
+  /** Never `none`: a child always takes a value. */
+  format: TextFormat;
+  values?: string[];
+  min: int64;
+
+  /** `-1` = unlimited. */
+  max: int64;
+  default: string | null;
+  alwaysEmit?: true;
+
+  /** Emitted only when `min >= 1`. Always `invalid` for now: `warn` needs
+   *  the `text-tag-missing` warning, added with its first use (D13). */
+  onMissing?: OnInvalid;
+  onInvalid: OnInvalid;
+
+  /** Always has `json`: one field — `"$"` or `["$"]` (append) under
+   *  `attrs` or at the top level. */
+  mappingKeys: MappingKeys;
+}
+
+/** A ProseMirror node that is not a text tag. */
+model TextNode {
+  description: string;
+  mappingKeys?: MappingKeys;
+}
+
 /** A search/filter category over resource types. The member list is the
  *  single home of that fact. */
 model ResourceGroup {