article-content-renderer-vue2 0.3.0 → 0.4.0

package/dist/types/components/ArticleContentRenderer.vue.d.ts

@@ -1,19 +1,13 @@
 import Vue from 'vue';
-import type { ResolvedCustomSlot } from '../protocols/types.js';
-import type { CustomSlot, RenderIssue, ResolveArticleButtonLink, ValidationResult } from '../types.js';
-declare const _default: import("vue/types/vue").ExtendedVue<Vue<Record<string, any>, Record<string, any>, never, never, (event: string, ...args: any[]) => Vue>, {
-    reportedRuntimeIssues: Set<string>;
-}, {
-    resolveCustomSlots(): ResolvedCustomSlot[];
-    reportRuntimeIssue(issue: RenderIssue): void;
-}, {
-    validation: ValidationResult;
-}, {
+import type { CustomSlot, ResolveArticleButtonLink, ResolveCustomLink } from '../types.js';
+interface ArticleContentRendererProps {
     document: unknown;
     protocolVersion: number;
     strict: boolean;
     customSlots: CustomSlot[];
     imageBaseUrl: string;
-    resolveArticleButtonLink: ResolveArticleButtonLink;
-}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin>;
+    resolveArticleButtonLink?: ResolveArticleButtonLink;
+    resolveCustomLink?: ResolveCustomLink;
+}
+declare const _default: import("vue/types/vue").ExtendedVue<Vue<Record<string, any>, Record<string, any>, never, never, (event: string, ...args: any[]) => Vue>, {}, {}, {}, ArticleContentRendererProps, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin>;
 export default _default;

package/dist/types/index.d.ts

@@ -5,4 +5,4 @@ export default ArticleContentRenderer;
 export declare const ArticleContentRendererPlugin: PluginObject<never>;
 export { CURRENT_PROTOCOL_VERSION, SUPPORTED_PROTOCOL_VERSIONS, validateArticleDocument, } from './protocols/registry.js';
 export { ARTICLE_CONTENT_PROTOCOL_V1 } from './protocols/v1/metadata.js';
-export type { ArticleButtonAttrs, ArticleButtonActionAttrs, ArticleButtonActionNode, ArticleButtonClickPayload, ArticleButtonLink, ArticleButtonLinkAttrs, ArticleButtonLinkDescriptor, ArticleButtonLinkNode, ArticleButtonNode, ArticleButtonStyle, ArticleContentNode, ArticleDocument, ArticleMark, BlockNode, BlockquoteNode, BoldMark, BulletListNode, CodeBlockNode, CodeBlockTextNode, CodeMark, CustomSlot, HeadingNode, HorizontalRuleNode, ImageAlign, ImageNode, ItalicMark, LinkMark, LinkTarget, ListItemNode, OrderedListNode, ParagraphNode, ProtocolVersion, RenderIssue, RenderIssueCode, ResolveArticleButtonLink, StrikeMark, TableCellNode, TableNode, TableRowNode, TextAlign, TextNode, UnderlineMark, ValidationResult, } from './types.js';
+export type { ArticleButtonAttrs, ArticleButtonActionAttrs, ArticleButtonActionNode, ArticleButtonClickPayload, ArticleButtonLink, ArticleButtonLinkAttrs, ArticleButtonLinkDescriptor, ArticleButtonLinkNode, ArticleButtonNode, ArticleButtonStyle, ArticleContentNode, ArticleDocument, ArticleMark, BlockNode, BlockquoteNode, BoldMark, BulletListNode, CodeBlockNode, CodeBlockTextNode, CodeMark, CustomLink, CustomLinkDescriptor, CustomLinkMark, CustomLinkMarkAttrs, CustomSlot, HeadingNode, HorizontalRuleNode, ImageAlign, ImageNode, ItalicMark, HrefLinkMark, HrefLinkMarkAttrs, LinkMark, LinkTarget, ListItemNode, OrderedListNode, ParagraphNode, ProtocolVersion, RenderIssue, RenderIssueCode, ResolveArticleButtonLink, ResolveCustomLink, StrikeMark, TableCellNode, TableNode, TableRowNode, TextAlign, TextNode, UnderlineMark, ValidationResult, } from './types.js';

package/dist/types/protocols/types.d.ts

@@ -1,10 +1,11 @@
 import type { CreateElement, VNode } from 'vue';
-import type { ArticleButtonClickPayload, RenderIssue, ResolveArticleButtonLink, ValidationResult } from '../types.js';
+import type { ArticleButtonClickPayload, RenderIssue, ResolveArticleButtonLink, ResolveCustomLink, ValidationResult } from '../types.js';
 export interface RenderContext {
     createElement: CreateElement;
     customSlots: readonly ResolvedCustomSlot[];
     imageBaseUrl: string;
     resolveArticleButtonLink?: ResolveArticleButtonLink;
+    resolveCustomLink?: ResolveCustomLink;
     emitArticleButtonClick: (payload: ArticleButtonClickPayload) => void;
     reportIssue: (issue: RenderIssue) => void;
 }

package/dist/types/types.d.ts

@@ -22,13 +22,29 @@ export interface UnderlineMark {
 export interface CodeMark {
     type: 'code';
 }
-export interface LinkMark {
+export interface HrefLinkMarkAttrs {
+    type?: 'href';
+    href: string;
+    id?: never;
+    title?: never;
+    target?: LinkTarget;
+}
+export interface CustomLinkMarkAttrs {
+    type: 'custom';
+    id: string;
+    title: string;
+    href?: never;
+    target?: LinkTarget;
+}
+export interface HrefLinkMark {
     type: 'link';
-    attrs: {
-        href: string;
-        target?: LinkTarget;
-    };
+    attrs: HrefLinkMarkAttrs;
+}
+export interface CustomLinkMark {
+    type: 'link';
+    attrs: CustomLinkMarkAttrs;
 }
+export type LinkMark = HrefLinkMark | CustomLinkMark;
 export type ArticleMark = BoldMark | ItalicMark | StrikeMark | UnderlineMark | CodeMark | LinkMark;
 export interface TextNode {
     type: 'text';
@@ -143,6 +159,13 @@ export interface ArticleButtonLinkDescriptor {
 }
 export type ArticleButtonLink = string | ArticleButtonLinkDescriptor | null;
 export type ResolveArticleButtonLink = (attrs: Readonly<ArticleButtonActionAttrs>, node: Readonly<ArticleButtonActionNode>) => ArticleButtonLink;
+export interface CustomLinkDescriptor {
+    href: string;
+    target?: LinkTarget;
+    rel?: string;
+}
+export type CustomLink = string | CustomLinkDescriptor | null;
+export type ResolveCustomLink = (attrs: Readonly<CustomLinkMarkAttrs>, mark: Readonly<CustomLinkMark>) => CustomLink;
 export type RenderIssueCode = 'INVALID_ROOT' | 'INVALID_TYPE' | 'INVALID_CONTENT' | 'INVALID_VALUE' | 'MISSING_PROPERTY' | 'UNKNOWN_PROPERTY' | 'UNKNOWN_NODE' | 'UNKNOWN_MARK' | 'TABLE_COLUMN_MISMATCH' | 'UNSAFE_URL' | 'LINK_RESOLUTION_FAILED' | 'UNSUPPORTED_PROTOCOL';
 export interface RenderIssue {
     code: RenderIssueCode;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "article-content-renderer-vue2",
-  "version": "0.3.0",
+  "version": "0.4.0",
   "description": "A safe Vue 2.7 renderer for the Article Content Protocol ProseMirror JSON format.",
   "author": "NovaVoyager",
   "license": "MIT",

package/protocol/article-content-protocol-v1.json

@@ -422,13 +422,36 @@
     },
     {
       "type": "link",
-      "description": "A hyperlink. Renderers must validate and escape the URL.",
+      "description": "An href or application-defined custom link.",
       "attributes": [
+        {
+          "name": "type",
+          "type": "string",
+          "required": false,
+          "description": "Link destination type. Omission means href for legacy documents.",
+          "defaultValue": "href",
+          "allowedValues": [
+            "href",
+            "custom"
+          ]
+        },
         {
           "name": "href",
           "type": "string",
-          "required": true,
-          "description": "Non-empty URI reference; fragment-only links such as # are valid."
+          "required": false,
+          "description": "Required only for href links. Renderers must validate and escape this URI reference."
+        },
+        {
+          "name": "id",
+          "type": "string",
+          "required": false,
+          "description": "Application-defined identifier required only for custom links."
+        },
+        {
+          "name": "title",
+          "type": "string",
+          "required": false,
+          "description": "Application-defined title required only for custom links."
         },
         {
           "name": "target",
@@ -442,11 +465,24 @@
           ]
         }
       ],
+      "constraints": [
+        {
+          "name": "href-link-fields",
+          "description": "An href link requires href and must not contain id or title. A missing type is treated as href."
+        },
+        {
+          "name": "custom-link-fields",
+          "description": "A custom link requires type=custom, id, and title, and must not contain href."
+        }
+      ],
       "render": {
         "mode": "element",
         "element": "a",
         "attributeBindings": {
+          "type": "data-link-type",
           "href": "href",
+          "id": "data-link-id",
+          "title": "title",
           "target": "target"
         }
       }
@@ -979,25 +1015,63 @@
                 "const": "link"
               },
               "attrs": {
-                "type": "object",
-                "additionalProperties": false,
-                "required": [
-                  "href",
-                  "target"
-                ],
-                "properties": {
-                  "href": {
-                    "type": "string",
-                    "minLength": 1,
-                    "description": "Non-empty URI reference; fragment-only links such as # are valid."
+                "oneOf": [
+                  {
+                    "type": "object",
+                    "additionalProperties": false,
+                    "required": [
+                      "href",
+                      "target"
+                    ],
+                    "properties": {
+                      "type": {
+                        "const": "href",
+                        "default": "href",
+                        "description": "May be omitted in legacy documents; omission means href."
+                      },
+                      "href": {
+                        "type": "string",
+                        "minLength": 1,
+                        "description": "Non-empty URI reference; fragment-only links such as # are valid."
+                      },
+                      "target": {
+                        "enum": [
+                          "_blank",
+                          "_self"
+                        ]
+                      }
+                    }
                   },
-                  "target": {
-                    "enum": [
-                      "_blank",
-                      "_self"
-                    ]
+                  {
+                    "type": "object",
+                    "additionalProperties": false,
+                    "required": [
+                      "type",
+                      "id",
+                      "title",
+                      "target"
+                    ],
+                    "properties": {
+                      "type": {
+                        "const": "custom"
+                      },
+                      "id": {
+                        "type": "string",
+                        "minLength": 1
+                      },
+                      "title": {
+                        "type": "string",
+                        "minLength": 1
+                      },
+                      "target": {
+                        "enum": [
+                          "_blank",
+                          "_self"
+                        ]
+                      }
+                    }
                   }
-                }
+                ]
               }
             }
           }