@valiantys/atlassian-app 3.2.0-alpha-8 → 3.2.0-alpha-10

package/atlassian/jira/shared/util-jira-v3-api/src/lib/issue/index.cjs.js

@@ -1 +1 @@
-"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const a="fixVersions";function e(t){return t.type==="paragraph"}function o(t){return t.type==="text"}exports.FIX_VERSIONS_FIELD=a;exports.isAtlassianDocumentFormatParagraphNode=e;exports.isAtlassianDocumentFormatTextNode=o;
+"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const e="fixVersions";exports.FIX_VERSIONS_FIELD=e;

package/atlassian/jira/shared/util-jira-v3-api/src/lib/issue/index.es.js

@@ -1,12 +1,4 @@
-const a = "fixVersions";
-function e(t) {
-  return t.type === "paragraph";
-}
-function n(t) {
-  return t.type === "text";
-}
+const o = "fixVersions";
 export {
-  a as FIX_VERSIONS_FIELD,
-  e as isAtlassianDocumentFormatParagraphNode,
-  n as isAtlassianDocumentFormatTextNode
+  o as FIX_VERSIONS_FIELD
 };

package/atlassian/shared/util-adf/src/lib/adf/index.cjs.js

@@ -0,0 +1 @@
+"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});function o(t,n){var e,r;for(const a of t)if(a.text!==void 0&&a.text.includes(n)||(r=(e=a.attrs)==null?void 0:e.text)!=null&&r.includes(n)||a.content&&o(a.content,n))return!0;return!1}function p(t,n){return o(t.content,n)}function i(t,n,e){return t.map(r=>{var a;return r.text!==void 0?{...r,text:r.text.replaceAll(n,e)}:((a=r.attrs)==null?void 0:a.text)!==void 0?{...r,attrs:{...r.attrs,text:r.attrs.text.replaceAll(n,e)}}:r.content?{...r,content:i(r.content,n,e)}:r})}function f(t,n,e){return{...t,content:i(t.content,n,e)}}function $(t,n){const e={type:"text",text:n};return{...t,content:[...t.content,{type:"paragraph",content:[e]}]}}function s(t){return t.replaceAll("&","&amp;").replaceAll("<","&lt;").replaceAll(">","&gt;").replaceAll('"',"&quot;")}function g(t,n){return n?n.reduce((e,r)=>{var a,c,l;switch(r.type){case"strong":return`<strong>${e}</strong>`;case"em":return`<em>${e}</em>`;case"code":return`<code>${e}</code>`;case"strike":return`<s>${e}</s>`;case"underline":return`<u>${e}</u>`;case"link":return`<a href="${s(String(((a=r.attrs)==null?void 0:a.href)??""))}">${e}</a>`;case"textColor":return`<span style="color:${s(String(((c=r.attrs)==null?void 0:c.color)??""))}">${e}</span>`;case"subsup":return((l=r.attrs)==null?void 0:l.type)==="sub"?`<sub>${e}</sub>`:`<sup>${e}</sup>`;default:return e}},t):t}function u(t){return(t==null?void 0:t.map(b).join(""))??""}function b(t){var n,e,r,a;switch(t.type){case"text":return g(s(t.text??""),t.marks);case"hardBreak":return"<br>";case"rule":return"<hr>";case"paragraph":return`<p>${u(t.content)}</p>`;case"heading":{const c=Number(((n=t.attrs)==null?void 0:n.level)??1);return`<h${c}>${u(t.content)}</h${c}>`}case"blockquote":return`<blockquote>${u(t.content)}</blockquote>`;case"bulletList":return`<ul>${u(t.content)}</ul>`;case"orderedList":return`<ol>${u(t.content)}</ol>`;case"listItem":return`<li>${u(t.content)}</li>`;case"codeBlock":return`<pre${(e=t.attrs)!=null&&e.language?` data-language="${s(String(t.attrs.language))}"`:""}><code>${u(t.content)}</code></pre>`;case"emoji":case"mention":case"status":return s(String(((r=t.attrs)==null?void 0:r.text)??""));case"inlineCard":{const c=s(String(((a=t.attrs)==null?void 0:a.url)??""));return`<a href="${c}">${c}</a>`}case"table":return`<table>${u(t.content)}</table>`;case"tableRow":return`<tr>${u(t.content)}</tr>`;case"tableHeader":return`<th>${u(t.content)}</th>`;case"tableCell":return`<td>${u(t.content)}</td>`;default:return u(t.content)}}function h(t){return u(t.content)}function x(t){return{type:"doc",version:1,content:[{type:"paragraph",content:[{type:"text",text:t}]}]}}exports.adfToHtml=h;exports.appendParagraph=$;exports.replaceInAdf=f;exports.searchAdf=p;exports.toAdfDoc=x;

package/atlassian/shared/util-adf/src/lib/adf/index.es.js

@@ -0,0 +1,139 @@
+function o(t, n) {
+  var e, r;
+  for (const u of t)
+    if (u.text !== void 0 && u.text.includes(n) || (r = (e = u.attrs) == null ? void 0 : e.text) != null && r.includes(n) || u.content && o(u.content, n))
+      return !0;
+  return !1;
+}
+function $(t, n) {
+  return o(t.content, n);
+}
+function i(t, n, e) {
+  return t.map((r) => {
+    var u;
+    return r.text !== void 0 ? { ...r, text: r.text.replaceAll(n, e) } : ((u = r.attrs) == null ? void 0 : u.text) !== void 0 ? {
+      ...r,
+      attrs: {
+        ...r.attrs,
+        text: r.attrs.text.replaceAll(n, e)
+      }
+    } : r.content ? {
+      ...r,
+      content: i(r.content, n, e)
+    } : r;
+  });
+}
+function g(t, n, e) {
+  return {
+    ...t,
+    content: i(t.content, n, e)
+  };
+}
+function b(t, n) {
+  const e = { type: "text", text: n };
+  return {
+    ...t,
+    content: [...t.content, { type: "paragraph", content: [e] }]
+  };
+}
+function s(t) {
+  return t.replaceAll("&", "&amp;").replaceAll("<", "&lt;").replaceAll(">", "&gt;").replaceAll('"', "&quot;");
+}
+function p(t, n) {
+  return n ? n.reduce((e, r) => {
+    var u, c, l;
+    switch (r.type) {
+      case "strong":
+        return `<strong>${e}</strong>`;
+      case "em":
+        return `<em>${e}</em>`;
+      case "code":
+        return `<code>${e}</code>`;
+      case "strike":
+        return `<s>${e}</s>`;
+      case "underline":
+        return `<u>${e}</u>`;
+      case "link":
+        return `<a href="${s(String(((u = r.attrs) == null ? void 0 : u.href) ?? ""))}">${e}</a>`;
+      case "textColor":
+        return `<span style="color:${s(String(((c = r.attrs) == null ? void 0 : c.color) ?? ""))}">${e}</span>`;
+      case "subsup":
+        return ((l = r.attrs) == null ? void 0 : l.type) === "sub" ? `<sub>${e}</sub>` : `<sup>${e}</sup>`;
+      default:
+        return e;
+    }
+  }, t) : t;
+}
+function a(t) {
+  return (t == null ? void 0 : t.map(f).join("")) ?? "";
+}
+function f(t) {
+  var n, e, r, u;
+  switch (t.type) {
+    case "text":
+      return p(s(t.text ?? ""), t.marks);
+    case "hardBreak":
+      return "<br>";
+    case "rule":
+      return "<hr>";
+    case "paragraph":
+      return `<p>${a(t.content)}</p>`;
+    case "heading": {
+      const c = Number(((n = t.attrs) == null ? void 0 : n.level) ?? 1);
+      return `<h${c}>${a(t.content)}</h${c}>`;
+    }
+    case "blockquote":
+      return `<blockquote>${a(t.content)}</blockquote>`;
+    case "bulletList":
+      return `<ul>${a(t.content)}</ul>`;
+    case "orderedList":
+      return `<ol>${a(t.content)}</ol>`;
+    case "listItem":
+      return `<li>${a(t.content)}</li>`;
+    case "codeBlock":
+      return `<pre${(e = t.attrs) != null && e.language ? ` data-language="${s(String(t.attrs.language))}"` : ""}><code>${a(t.content)}</code></pre>`;
+    case "emoji":
+    case "mention":
+    case "status":
+      return s(String(((r = t.attrs) == null ? void 0 : r.text) ?? ""));
+    case "inlineCard": {
+      const c = s(String(((u = t.attrs) == null ? void 0 : u.url) ?? ""));
+      return `<a href="${c}">${c}</a>`;
+    }
+    case "table":
+      return `<table>${a(t.content)}</table>`;
+    case "tableRow":
+      return `<tr>${a(t.content)}</tr>`;
+    case "tableHeader":
+      return `<th>${a(t.content)}</th>`;
+    case "tableCell":
+      return `<td>${a(t.content)}</td>`;
+    default:
+      return a(t.content);
+  }
+}
+function x(t) {
+  return a(t.content);
+}
+function h(t) {
+  return {
+    type: "doc",
+    version: 1,
+    content: [
+      {
+        type: "paragraph",
+        content: [{
+          type: "text",
+          text: t
+        }]
+      }
+    ]
+  };
+}
+export {
+  x as adfToHtml,
+  b as appendParagraph,
+  g as replaceInAdf,
+  $ as searchAdf,
+  h as toAdfDoc
+};

package/backend-trigger/index.d.ts

@@ -1,22 +1,46 @@
 import { WebTriggerRequest } from '@forge/api/out/webTrigger';
 import { WebTriggerResponse } from '@forge/api/out/webTrigger';
 
-declare interface AtlassianDocumentFormat {
+/** Root document node */
+declare interface AdfDoc {
     type: 'doc';
-    version: number;
-    content: AtlassianDocumentFormatNode[];
+    version: 1;
+    content: AdfNode[];
 }
 
-declare interface AtlassianDocumentFormatBlockNode {
+/**
+ * TypeScript types for Atlassian Document Format (ADF)
+ * Conforms to https://unpkg.com/@atlaskit/adf-schema@52.4.0/dist/json-schema/v1/full.json
+ */
+declare interface AdfMark {
     type: string;
-    content: AtlassianDocumentFormatNode[];
+    attrs?: Record<string, unknown>;
 }
 
-declare interface AtlassianDocumentFormatInlineNode {
+/**
+ * Base for all ADF nodes. `content` is optional because many block nodes
+ * (paragraph, heading, codeBlock, etc.) define it as optional in the schema.
+ * `text` is only populated on text nodes. `attrs` is present on most non-text
+ * nodes. `marks` is present on nodes that support formatting.
+ */
+declare interface AdfNode {
     type: string;
+    text?: string;
+    attrs?: AdfNodeAttrs;
+    content?: AdfNode[];
+    marks?: AdfMark[];
 }
 
-declare type AtlassianDocumentFormatNode = AtlassianDocumentFormatInlineNode | AtlassianDocumentFormatBlockNode;
+/**
+ * Attrs common across node types. Many inline node types (emoji, mention,
+ * status, placeholder, hardBreak, inlineExtension, extension, bodiedExtension)
+ * store their display text in `attrs.text`.
+ */
+declare interface AdfNodeAttrs {
+    text?: string;
+    localId?: string;
+    [key: string]: unknown;
+}
 
 declare interface AvatarUrls {
     '48x48': string;
@@ -43,7 +67,7 @@ declare interface FixVersion {
 
 declare type FixVersions = FixVersion[];
 
-declare interface Issue<T = AtlassianDocumentFormat> {
+declare interface Issue<T = AdfDoc> {
     id: string;
     expand?: string;
     key: string;
@@ -52,7 +76,7 @@ declare interface Issue<T = AtlassianDocumentFormat> {
     renderedFields?: IssueFields<string>;
 }
 
-declare type IssueFields<T = AtlassianDocumentFormat> = CustomFields & StaticIssueFields<T>;
+declare type IssueFields<T = AdfDoc> = CustomFields & StaticIssueFields<T>;
 
 declare interface IssueLink {
     id: string;
@@ -138,7 +162,7 @@ declare interface Project {
     lead?: User;
 }
 
-declare interface StaticIssueFields<T = AtlassianDocumentFormat> {
+declare interface StaticIssueFields<T = AdfDoc> {
     statuscategorychangedate?: string;
     fixVersions?: FixVersions;
     resolution?: unknown;

package/data-access-issue/atlassian-app-data-access-issue.api.json

@@ -244,8 +244,8 @@
                 },
                 {
                   "kind": "Reference",
-                  "text": "AtlassianDocumentFormat",
-                  "canonicalReference": "@valiantys/atlassian-app!~AtlassianDocumentFormat:interface"
+                  "text": "AdfDoc",
+                  "canonicalReference": "@valiantys/atlassian-app!~AdfDoc:interface"
                 },
                 {
                   "kind": "Content",
@@ -1228,8 +1228,8 @@
                 },
                 {
                   "kind": "Reference",
-                  "text": "AtlassianDocumentFormat",
-                  "canonicalReference": "@valiantys/atlassian-app!~AtlassianDocumentFormat:interface"
+                  "text": "AdfDoc",
+                  "canonicalReference": "@valiantys/atlassian-app!~AdfDoc:interface"
                 },
                 {
                   "kind": "Content",
@@ -1459,8 +1459,8 @@
                 },
                 {
                   "kind": "Reference",
-                  "text": "AtlassianDocumentFormat",
-                  "canonicalReference": "@valiantys/atlassian-app!~AtlassianDocumentFormat:interface"
+                  "text": "AdfDoc",
+                  "canonicalReference": "@valiantys/atlassian-app!~AdfDoc:interface"
                 },
                 {
                   "kind": "Content",

package/data-access-issue/atlassian-app.api.md

@@ -9,7 +9,7 @@ export class JiraIssueService {
     // Warning: (ae-forgotten-export) The symbol "AtlassianProductFetchService" needs to be exported by the entry point data-access-issue.d.ts
     constructor(fetchSvc: AtlassianProductFetchService<'jira'>);
     // (undocumented)
-    addIssueComment(issueIdOrKey: string, body: AtlassianDocumentFormat): Promise<IssueComment>;
+    addIssueComment(issueIdOrKey: string, body: AdfDoc): Promise<IssueComment>;
     // Warning: (ae-forgotten-export) The symbol "WorklogCreateRequest" needs to be exported by the entry point data-access-issue.d.ts
     // Warning: (ae-forgotten-export) The symbol "Worklog" needs to be exported by the entry point data-access-issue.d.ts
     //
@@ -68,10 +68,10 @@ export class JiraIssueService {
         startAt?: number;
         projectId?: string[];
     }): Promise<PagedResponseWithNextLink<IssueTypeSchemeForProjects>>;
-    // Warning: (ae-forgotten-export) The symbol "AtlassianDocumentFormat" needs to be exported by the entry point data-access-issue.d.ts
+    // Warning: (ae-forgotten-export) The symbol "AdfDoc" needs to be exported by the entry point data-access-issue.d.ts
     //
     // (undocumented)
-    issueSearch(jql: string, fields: string[], maxResults?: number): Promise<Issue<AtlassianDocumentFormat>[]>;
+    issueSearch(jql: string, fields: string[], maxResults?: number): Promise<Issue<AdfDoc>[]>;
     // (undocumented)
     issueSearchByPage(jql: string, fields: string[], nextPageToken?: string, maxResults?: number): Promise<{
         issues: Issue[];
@@ -80,7 +80,7 @@ export class JiraIssueService {
     // (undocumented)
     static readonly issueUrl = "/rest/api/3/issue";
     // (undocumented)
-    queryForIssuesInProjects(projectIdsOrKeys: string[]): Promise<Issue<AtlassianDocumentFormat>[]>;
+    queryForIssuesInProjects(projectIdsOrKeys: string[]): Promise<Issue<AdfDoc>[]>;
     // Warning: (ae-forgotten-export) The symbol "TransitionIssueRequest" needs to be exported by the entry point data-access-issue.d.ts
     //
     // (undocumented)

package/data-access-issue/index.d.ts

@@ -1,21 +1,45 @@
-declare type APIResponse = Pick<Response, 'json' | 'text' | 'ok' | 'status' | 'statusText' | 'headers'>;
-
-declare interface AtlassianDocumentFormat {
+/** Root document node */
+declare interface AdfDoc {
     type: 'doc';
-    version: number;
-    content: AtlassianDocumentFormatNode[];
+    version: 1;
+    content: AdfNode[];
 }
 
-declare interface AtlassianDocumentFormatBlockNode {
+/**
+ * TypeScript types for Atlassian Document Format (ADF)
+ * Conforms to https://unpkg.com/@atlaskit/adf-schema@52.4.0/dist/json-schema/v1/full.json
+ */
+declare interface AdfMark {
     type: string;
-    content: AtlassianDocumentFormatNode[];
+    attrs?: Record<string, unknown>;
 }
 
-declare interface AtlassianDocumentFormatInlineNode {
+/**
+ * Base for all ADF nodes. `content` is optional because many block nodes
+ * (paragraph, heading, codeBlock, etc.) define it as optional in the schema.
+ * `text` is only populated on text nodes. `attrs` is present on most non-text
+ * nodes. `marks` is present on nodes that support formatting.
+ */
+declare interface AdfNode {
     type: string;
+    text?: string;
+    attrs?: AdfNodeAttrs;
+    content?: AdfNode[];
+    marks?: AdfMark[];
+}
+
+/**
+ * Attrs common across node types. Many inline node types (emoji, mention,
+ * status, placeholder, hardBreak, inlineExtension, extension, bodiedExtension)
+ * store their display text in `attrs.text`.
+ */
+declare interface AdfNodeAttrs {
+    text?: string;
+    localId?: string;
+    [key: string]: unknown;
 }
 
-declare type AtlassianDocumentFormatNode = AtlassianDocumentFormatInlineNode | AtlassianDocumentFormatBlockNode;
+declare type APIResponse = Pick<Response, 'json' | 'text' | 'ok' | 'status' | 'statusText' | 'headers'>;
 
 declare interface AtlassianProductFetchService<P extends Product> {
     productType: P;
@@ -49,7 +73,7 @@ declare interface CreatedIssue {
 }
 
 declare interface CreateIssue {
-    fields: IssueFields<AtlassianDocumentFormat | string>;
+    fields: IssueFields<AdfDoc | string>;
     properties?: {
         key: string;
         value: unknown;
@@ -115,7 +139,7 @@ declare interface HistoryMetadataParticipant {
     url: string;
 }
 
-declare interface Issue<T = AtlassianDocumentFormat> {
+declare interface Issue<T = AdfDoc> {
     id: string;
     expand?: string;
     key: string;
@@ -126,7 +150,7 @@ declare interface Issue<T = AtlassianDocumentFormat> {
 
 declare type IssueComment = {
     author: User;
-    body: AtlassianDocumentFormat;
+    body: AdfDoc;
     created: string;
     id: string;
     self: string;
@@ -135,7 +159,7 @@ declare type IssueComment = {
     visibility: Visibility;
 };
 
-declare type IssueFields<T = AtlassianDocumentFormat> = CustomFields & StaticIssueFields<T>;
+declare type IssueFields<T = AdfDoc> = CustomFields & StaticIssueFields<T>;
 
 declare interface IssueLink {
     id: string;
@@ -161,7 +185,7 @@ declare interface IssueLinkRequest {
         key?: string;
     };
     comment?: {
-        body: AtlassianDocumentFormat;
+        body: AdfDoc;
     };
     type: {
         id?: string;
@@ -237,18 +261,18 @@ export declare class JiraIssueService {
     getIssueFields(issueIdOrKey: string, fields: string[]): Promise<IssueFields | undefined>;
     getIssue(issueIdOrKey: string, fields?: string[], rendered?: boolean): Promise<Issue | undefined>;
     getBulkIssues(issueIdsOrKeys: string[], fields?: string[]): Promise<Issue[]>;
-    issueSearch(jql: string, fields: string[], maxResults?: number): Promise<Issue<AtlassianDocumentFormat>[]>;
+    issueSearch(jql: string, fields: string[], maxResults?: number): Promise<Issue<AdfDoc>[]>;
     issueSearchByPage(jql: string, fields: string[], nextPageToken?: string, maxResults?: number): Promise<{
         issues: Issue[];
         nextPageToken?: string;
     }>;
     addWorklog(issueIdOrKey: string, worklog: WorklogCreateRequest): Promise<Worklog>;
-    queryForIssuesInProjects(projectIdsOrKeys: string[]): Promise<Issue<AtlassianDocumentFormat>[]>;
+    queryForIssuesInProjects(projectIdsOrKeys: string[]): Promise<Issue<AdfDoc>[]>;
     createIssue(body: CreateIssue): Promise<CreatedIssue>;
     updateIssue(issueIdOrKey: string, body: UpdateIssue): Promise<void>;
     getIssueComments(issueIdOrKey: string, startAt?: number): Promise<JiraCommentResponse>;
     getIssueCommentById(issueIdOrKey: string, commentId: string): Promise<IssueComment>;
-    addIssueComment(issueIdOrKey: string, body: AtlassianDocumentFormat): Promise<IssueComment>;
+    addIssueComment(issueIdOrKey: string, body: AdfDoc): Promise<IssueComment>;
     transitionIssue(issueIdOrKey: string, body: TransitionIssueRequest): Promise<void>;
     createIssueLink(issueLinkRequest: IssueLinkRequest): Promise<void>;
     getIssueTypes(): Promise<IssueTypeDetails[]>;
@@ -330,7 +354,7 @@ declare interface RemoteIssueLink {
 
 declare type RequestProductMethod = (url: FetchRoute, init: RequestInit) => Promise<APIResponse>;
 
-declare interface StaticIssueFields<T = AtlassianDocumentFormat> {
+declare interface StaticIssueFields<T = AdfDoc> {
     statuscategorychangedate?: string;
     fixVersions?: FixVersions;
     resolution?: unknown;
@@ -399,7 +423,7 @@ declare interface TransitionIssueRequest {
 }
 
 declare interface UpdateIssue {
-    fields?: IssueFields<AtlassianDocumentFormat | string>;
+    fields?: IssueFields<AdfDoc | string>;
     properties?: {
         key: string;
         value: unknown;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@valiantys/atlassian-app",
-  "version": "3.2.0-alpha-8",
+  "version": "3.2.0-alpha-10",
   "description": "This library provides Atlassian Forge components, wrappers, and utilities to support writing Forge apps that can run deployed or in standalone mode",
   "exports": {
     "./frontend-app": {
@@ -198,6 +198,11 @@
       "require": "./util-jira-v3-api/index.cjs.js",
       "types": "./util-jira-v3-api/index.d.ts"
     },
+    "./util-adf": {
+      "import": "./util-adf/index.es.js",
+      "require": "./util-adf/index.cjs.js",
+      "types": "./util-adf/index.d.ts"
+    },
     "./backend-async-queue": {
       "import": "./backend-async-queue/index.es.js",
       "require": "./backend-async-queue/index.cjs.js",