article-content-renderer-vue2 0.1.0 → 0.3.0

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

@@ -1,22 +1,18 @@
 import Vue from 'vue';
-import type { AdSlot } from '../protocols/types.js';
-import type { AdConfig, PubId, RenderIssue, ResolveArticleButtonLink, ValidationResult } from '../types.js';
+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>;
-    reportedAdConfigIssue: string | null;
 }, {
+    resolveCustomSlots(): ResolvedCustomSlot[];
     reportRuntimeIssue(issue: RenderIssue): void;
 }, {
     validation: ValidationResult;
-    adConfigIssue: RenderIssue | null;
-    adSlots: readonly AdSlot[];
 }, {
     document: unknown;
     protocolVersion: number;
     strict: boolean;
-    adConf: AdConfig;
-    pubid: PubId;
-    adTitle: string;
+    customSlots: CustomSlot[];
     imageBaseUrl: string;
     resolveArticleButtonLink: ResolveArticleButtonLink;
 }, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin>;

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 { AdConfig, ArticleButtonAttrs, ArticleButtonClickPayload, ArticleButtonLink, ArticleButtonLinkDescriptor, ArticleButtonNode, ArticleButtonStyle, ArticleContentNode, ArticleDocument, ArticleMark, BlockNode, BlockquoteNode, BoldMark, BulletListNode, CodeBlockNode, CodeBlockTextNode, CodeMark, HeadingNode, HorizontalRuleNode, ImageAlign, ImageNode, ItalicMark, LinkMark, LinkTarget, ListItemNode, OrderedListNode, ParagraphNode, ProtocolVersion, PubId, 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, 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';

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

@@ -2,20 +2,16 @@ import type { CreateElement, VNode } from 'vue';
 import type { ArticleButtonClickPayload, RenderIssue, ResolveArticleButtonLink, ValidationResult } from '../types.js';
 export interface RenderContext {
     createElement: CreateElement;
-    adSlots: readonly AdSlot[];
-    admPublisherId: string;
-    adsPublisherId: string;
-    adTitle: string;
+    customSlots: readonly ResolvedCustomSlot[];
     imageBaseUrl: string;
     resolveArticleButtonLink?: ResolveArticleButtonLink;
     emitArticleButtonClick: (payload: ArticleButtonClickPayload) => void;
     reportIssue: (issue: RenderIssue) => void;
 }
-export interface AdSlot {
-    index: number;
+export interface ResolvedCustomSlot {
+    id: string;
     location: number;
-    adm: unknown;
-    ads: unknown;
+    content: readonly VNode[];
 }
 export interface ProtocolAdapter {
     version: number;

package/dist/types/types.d.ts

@@ -1,16 +1,11 @@
 export type ProtocolVersion = 1;
 export type TextAlign = 'left' | 'center' | 'right' | 'justify';
 export type ImageAlign = 'left' | 'center' | 'right';
-export type ArticleButtonStyle = 'text' | 'button';
+export type ArticleButtonStyle = 'text' | 'button' | 'link';
 export type LinkTarget = '_blank' | '_self';
-export interface AdConfig {
-    adm?: readonly unknown[];
-    ads?: readonly unknown[];
-    loc: readonly number[];
-}
-export interface PubId {
-    adm: string;
-    ads: string;
+export interface CustomSlot {
+    id: string;
+    location: number;
 }
 export interface BoldMark {
     type: 'bold';
@@ -99,16 +94,30 @@ export interface ImageNode {
         imageAlign?: ImageAlign;
     };
 }
-export interface ArticleButtonAttrs {
-    id: string;
+interface ArticleButtonBaseAttrs {
     title?: string;
     text: string;
-    style: ArticleButtonStyle;
 }
-export interface ArticleButtonNode {
+export interface ArticleButtonActionAttrs extends ArticleButtonBaseAttrs {
+    id: string;
+    style: 'text' | 'button';
+    href?: never;
+}
+export interface ArticleButtonLinkAttrs extends ArticleButtonBaseAttrs {
+    id?: string;
+    style: 'link';
+    href?: string;
+}
+export type ArticleButtonAttrs = ArticleButtonActionAttrs | ArticleButtonLinkAttrs;
+export interface ArticleButtonActionNode {
+    type: 'articleButton';
+    attrs: ArticleButtonActionAttrs;
+}
+export interface ArticleButtonLinkNode {
     type: 'articleButton';
-    attrs: ArticleButtonAttrs;
+    attrs: ArticleButtonLinkAttrs;
 }
+export type ArticleButtonNode = ArticleButtonActionNode | ArticleButtonLinkNode;
 export interface TableNode {
     type: 'table';
     content: TableRowNode[];
@@ -133,8 +142,8 @@ export interface ArticleButtonLinkDescriptor {
     rel?: string;
 }
 export type ArticleButtonLink = string | ArticleButtonLinkDescriptor | null;
-export type ResolveArticleButtonLink = (attrs: Readonly<ArticleButtonAttrs>, node: Readonly<ArticleButtonNode>) => ArticleButtonLink;
-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' | 'AD_CONFIG_LENGTH_MISMATCH';
+export type ResolveArticleButtonLink = (attrs: Readonly<ArticleButtonActionAttrs>, node: Readonly<ArticleButtonActionNode>) => ArticleButtonLink;
+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;
     path: string;
@@ -151,3 +160,4 @@ export interface ArticleButtonClickPayload {
     href: string | null;
     event: MouseEvent;
 }
+export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "article-content-renderer-vue2",
-  "version": "0.1.0",
+  "version": "0.3.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

@@ -257,14 +257,14 @@
     {
       "type": "articleButton",
       "kind": "block",
-      "description": "An article action button identified by a business id and displayed with its text.",
+      "description": "An article action displayed with its text. Link actions may omit the business id.",
       "contentModel": "none",
       "attributes": [
         {
           "name": "id",
           "type": "string",
-          "required": true,
-          "description": "Business identifier used by the consuming application to handle the action."
+          "required": false,
+          "description": "Business identifier used by the consuming application. Required for text and button styles; optional for link style."
         },
         {
           "name": "title",
@@ -282,21 +282,45 @@
           "name": "style",
           "type": "string",
           "required": true,
-          "description": "Controlled visual variant: text is rendered as a text-like action; button as a button-like action.",
+          "description": "Controlled variant: text is a text-like action, button is a button-like action, and link is a hyperlink action.",
           "allowedValues": [
             "text",
-            "button"
+            "button",
+            "link"
           ]
+        },
+        {
+          "name": "href",
+          "type": "string",
+          "required": false,
+          "description": "Optional link destination. This attribute may only be present when style is link."
+        }
+      ],
+      "constraints": [
+        {
+          "name": "link-style-href",
+          "description": "The optional href attribute may only be present when style is link."
+        },
+        {
+          "name": "non-link-style-id",
+          "description": "The id attribute is required when style is text or button, and optional when style is link."
         }
       ],
       "render": {
         "mode": "element",
         "element": "button",
         "textBinding": "text",
+        "elementVariants": {
+          "attribute": "style",
+          "values": {
+            "link": "a"
+          }
+        },
         "attributeBindings": {
           "id": "data-article-button-id",
           "title": "title",
-          "style": "data-article-button-style"
+          "style": "data-article-button-style",
+          "href": "href"
         }
       }
     },
@@ -404,7 +428,7 @@
           "name": "href",
           "type": "string",
           "required": true,
-          "description": "Link destination."
+          "description": "Non-empty URI reference; fragment-only links such as # are valid."
         },
         {
           "name": "target",
@@ -753,7 +777,6 @@
             "type": "object",
             "additionalProperties": false,
             "required": [
-              "id",
               "text",
               "style"
             ],
@@ -773,10 +796,57 @@
               "style": {
                 "enum": [
                   "text",
-                  "button"
+                  "button",
+                  "link"
                 ]
+              },
+              "href": {
+                "type": "string",
+                "minLength": 1
               }
-            }
+            },
+            "allOf": [
+              {
+                "if": {
+                  "properties": {
+                    "style": {
+                      "enum": [
+                        "text",
+                        "button"
+                      ]
+                    }
+                  },
+                  "required": [
+                    "style"
+                  ]
+                },
+                "then": {
+                  "properties": {
+                    "id": {}
+                  },
+                  "required": [
+                    "id"
+                  ]
+                }
+              },
+              {
+                "if": {
+                  "properties": {
+                    "href": {}
+                  },
+                  "required": [
+                    "href"
+                  ]
+                },
+                "then": {
+                  "properties": {
+                    "style": {
+                      "const": "link"
+                    }
+                  }
+                }
+              }
+            ]
           }
         }
       },
@@ -918,7 +988,8 @@
                 "properties": {
                   "href": {
                     "type": "string",
-                    "minLength": 1
+                    "minLength": 1,
+                    "description": "Non-empty URI reference; fragment-only links such as # are valid."
                   },
                   "target": {
                     "enum": [
@@ -935,5 +1006,3 @@
     }
   }
 }
-
-

package/dist/types/components/AdManagerAd.d.ts

@@ -1,39 +0,0 @@
-import Vue from 'vue';
-interface GoogleTagSlot {
-    addService: (service: GoogleTagPubAdsService) => GoogleTagSlot;
-}
-interface GoogleTagSlotRenderEndedEvent {
-    slot: GoogleTagSlot;
-    isEmpty: boolean;
-}
-interface GoogleTagPubAdsService {
-    addEventListener: (eventName: 'slotRenderEnded', listener: (event: GoogleTagSlotRenderEndedEvent) => void) => void;
-    removeEventListener?: (eventName: 'slotRenderEnded', listener: (event: GoogleTagSlotRenderEndedEvent) => void) => void;
-}
-export declare const AdManagerAd: import("vue/types/vue").ExtendedVue<Vue<Record<string, any>, Record<string, any>, never, never, (event: string, ...args: any[]) => Vue>, {
-    observer: IntersectionObserver | null;
-    definedSlot: GoogleTagSlot | null;
-    pubAdsService: GoogleTagPubAdsService | null;
-    slotRenderEnded: ((event: GoogleTagSlotRenderEndedEvent) => void) | null;
-    emptyAdmKey: string | null;
-    cancelled: boolean;
-}, {
-    restartAdManager(): void;
-    startObserver(): void;
-    requestAd(): void;
-    cleanupAdManager(): void;
-}, {
-    admSlotId: string;
-    adsSlotId: string;
-    adUnitPath: string;
-    fallbackKey: string;
-    hasAdSenseFallback: boolean;
-    shouldUseAdSense: boolean;
-}, {
-    publisherId: string;
-    slotId: string | number;
-    title: string;
-    fallbackPublisherId: string;
-    fallbackSlotId: string | number;
-}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin>;
-export default AdManagerAd;

package/dist/types/components/AdSenseAd.d.ts

@@ -1,18 +0,0 @@
-import Vue from 'vue';
-export declare const AdSenseAd: import("vue/types/vue").ExtendedVue<Vue<Record<string, any>, Record<string, any>, never, never, (event: string, ...args: any[]) => Vue>, {
-    observer: IntersectionObserver | null;
-    requestedKey: string | null;
-}, {
-    requestAd(): void;
-    startObserver(): void;
-    stopObserver(): void;
-}, {
-    adClient: string;
-    adSlot: string;
-    requestKey: string;
-}, {
-    publisherId: string;
-    slotId: string | number;
-    title: string;
-}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin>;
-export default AdSenseAd;