add support for new json generator: deprecated, return values, keywords

Author: Efnilite

src/components/docs/Doc.astro

@@ -4,19 +4,33 @@ import DocsFiche from "./DocsFiche.astro";
 import DocData from "./DocData.astro";
 import { DocType } from "./Docs.astro";
 
+/**
+ * A reference to a different Documentation.
+ */
+export interface DocumentationReference {
+    name: string;
+    id: string;
+}
+
+/**
+ * A documentation entry.
+ */
 export interface Documentation {
     id: string,
     new: boolean;
     type: DocType;
     name: string;
     description: string[];
+    deprecated: boolean;
+    cancellable: boolean | null;
     since: string | null;
     requirements: string[] | null;
-    eventValues: string | null;
-    returnType: string | null;
+    eventValues: DocumentationReference[] | null;
+    returnType: DocumentationReference | null;
     events: string[] | null;
     patterns: string[] | null;
     examples: string[] | null;
+    keywords: string[] | null;
 }
 
 interface Props {
@@ -54,7 +68,8 @@ function color(): string {
 
     <div class="flex flex-col gap-1">
         <div class="flex flex-row gap-3 flex-wrap">
-            <h2>{docType.name}</h2>
+            {docType.deprecated ? <h2 class="opacity-50 line-through">{docType.name}</h2> : <h2>{docType.name}</h2>}
+            {[docType.deprecated].filter(x => x).map(x => <DocsFiche text="Deprecated" color="520f0f"/>)}
             {[docType.new].filter(x => x).map(x => <DocsFiche text="New" color="B10003"/>)}
 
             <DocsFiche text={docType.type} color={color()}/>
@@ -67,7 +82,7 @@ function color(): string {
                     </svg>
             </button>
         </div>
-        {docType.description.map((line: string) => <p><Fragment set:html={line}/></p>)}
+        {docType.description?.map((line: string) => <p><Fragment set:html={line}/></p>)}
     </div>
 
     {[docType.patterns]
@@ -76,10 +91,11 @@ function color(): string {
 
     <div>
         <DocData text="Since" value={docType.since}/>
+        <DocData text="Cancellable" value={docType.cancellable != null ? (docType.cancellable ? "Yes" : "No") : null}/>
         <DocData text="Requirements" value={docType.requirements}/>
-        <DocData text="Event values" value={docType.eventValues}/>
+        <DocData text="Event values" value={docType.eventValues?.map(x => x.name.toLowerCase()) ?? null}/>
         <DocData text="Supported events" value={docType.events}/>
-        <DocData text="Returns" value={docType.returnType}/>
+        <DocData text="Returns" value={docType.returnType?.name ?? null}/>
     </div>
 
     {[docType.examples]
@@ -98,5 +114,6 @@ function color(): string {
         {[docType.examples]
             .filter(x => x !== null)
             .map(x => <Code code={`${x?.join("\n")}`} lang="applescript"/>)}
+        <span class="hidden">{docType.keywords?.filter(x => x)}</span>
     </div>
 </section>

src/components/docs/Docs.astro

@@ -18,14 +18,17 @@ const docTypes: Documentation[] = all.map(doc => ({
         : [doc.since]).some(since => since?.includes(latest)),
 
     type: type(doc),
-    since: (doc as any)["since"] || null,
-    description: (doc as any)["description"] || null,
-    examples: (doc as any)["examples"] || null,
-    patterns: (doc as any)["patterns"] || null,
-    requirements: (doc as any)["requirements"] || null,
-    eventValues: null,
-    returnType: (doc as any)["return-type"] || null,
-    events: (doc as any)["events"] || null,
+    since: (doc as any)["since"] ?? null,
+    description: (doc as any)["description"] ?? null,
+    examples: (doc as any)["examples"] ?? null,
+    patterns: (doc as any)["patterns"] ?? null,
+    requirements: (doc as any)["requirements"] ?? null,
+    eventValues: (doc as any)["eventValues"] ?? null,
+    returnType: (doc as any)["returnType"] ?? null,
+    events: (doc as any)["events"] ?? null,
+    deprecated: (doc as any)["deprecated"] ?? null,
+    keywords: (doc as any)["keywords"] ?? null,
+    cancellable: (doc as any)["cancellable"] ?? null
 }));
 
 export enum DocType {
@@ -134,7 +137,8 @@ function type(doc: any): DocType {
             isNew: syntax.new,
             type: syntax.type,
             since: syntax.since!!,
-            name: syntax.name
+            name: syntax.name,
+            deprecated: syntax.deprecated
         }
     })}/>
 

src/components/docs/DocsSyntax.astro

@@ -7,6 +7,7 @@ export interface Syntax {
     type: DocType;
     since: string;
     name: string;
+    deprecated: boolean;
 }
 
 interface Props {
@@ -18,6 +19,7 @@ const { syntax }: Props = Astro.props;
 
 <a href={`#${syntax.id}`}
     data-new={syntax.isNew} data-type={syntax.type} data-since={syntax.since} 
-    class="syntax">
+    class="syntax"
+    style={syntax.deprecated ? 'text-decoration: line-through; opacity: 0.5;' : ''}>
     {syntax.name}
 </a>