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

package/util-jira-v3-api/atlassian-app.api.md

@@ -4,49 +4,6 @@
 
 ```ts
 
-// @public (undocumented)
-export interface AtlassianDocumentFormat {
-    // (undocumented)
-    content: AtlassianDocumentFormatNode[];
-    // (undocumented)
-    type: 'doc';
-    // (undocumented)
-    version: number;
-}
-
-// @public (undocumented)
-export interface AtlassianDocumentFormatBlockNode {
-    // (undocumented)
-    content: AtlassianDocumentFormatNode[];
-    // (undocumented)
-    type: string;
-}
-
-// @public (undocumented)
-export interface AtlassianDocumentFormatInlineNode {
-    // (undocumented)
-    type: string;
-}
-
-// @public (undocumented)
-export type AtlassianDocumentFormatNode = AtlassianDocumentFormatInlineNode | AtlassianDocumentFormatBlockNode;
-
-// @public (undocumented)
-export interface AtlassianDocumentFormatParagraphNode extends AtlassianDocumentFormatBlockNode {
-    // (undocumented)
-    content: AtlassianDocumentFormatInlineNode[];
-    // (undocumented)
-    type: 'paragraph';
-}
-
-// @public (undocumented)
-export interface AtlassianDocumentFormatTextNode extends AtlassianDocumentFormatInlineNode {
-    // (undocumented)
-    text: string;
-    // (undocumented)
-    type: 'text';
-}
-
 // @public (undocumented)
 export interface AvatarUrls {
     // (undocumented)
@@ -82,8 +39,10 @@ export interface CreatedIssue {
 
 // @public (undocumented)
 export interface CreateIssue {
+    // Warning: (ae-forgotten-export) The symbol "AdfDoc" needs to be exported by the entry point util-jira-v3-api.d.ts
+    //
     // (undocumented)
-    fields: IssueFields<AtlassianDocumentFormat | string>;
+    fields: IssueFields<AdfDoc | string>;
     // (undocumented)
     historyMetadata?: HistoryMetadata;
     // (undocumented)
@@ -183,13 +142,7 @@ export interface HistoryMetadataParticipant {
 }
 
 // @public (undocumented)
-export function isAtlassianDocumentFormatParagraphNode(node: AtlassianDocumentFormatNode): node is AtlassianDocumentFormatParagraphNode;
-
-// @public (undocumented)
-export function isAtlassianDocumentFormatTextNode(node: AtlassianDocumentFormatNode): node is AtlassianDocumentFormatTextNode;
-
-// @public (undocumented)
-export interface Issue<T = AtlassianDocumentFormat> {
+export interface Issue<T = AdfDoc> {
     // (undocumented)
     expand?: string;
     // (undocumented)
@@ -214,7 +167,7 @@ export type IssueAssetFieldValue = {
 // @public (undocumented)
 export type IssueComment = {
     author: User;
-    body: AtlassianDocumentFormat;
+    body: AdfDoc;
     created: string;
     id: string;
     self: string;
@@ -224,7 +177,7 @@ export type IssueComment = {
 };
 
 // @public (undocumented)
-export type IssueFields<T = AtlassianDocumentFormat> = CustomFields & StaticIssueFields<T>;
+export type IssueFields<T = AdfDoc> = CustomFields & StaticIssueFields<T>;
 
 // @public (undocumented)
 export interface IssueLink {
@@ -250,7 +203,7 @@ export interface IssueLink {
 export interface IssueLinkRequest {
     // (undocumented)
     comment?: {
-        body: AtlassianDocumentFormat;
+        body: AdfDoc;
     };
     // (undocumented)
     inwardIssue: {
@@ -551,7 +504,7 @@ export interface RemoteIssueLink {
 }
 
 // @public (undocumented)
-export interface StaticIssueFields<T = AtlassianDocumentFormat> {
+export interface StaticIssueFields<T = AdfDoc> {
     // (undocumented)
     aggregatetimespent?: number;
     // (undocumented)
@@ -657,7 +610,7 @@ export interface TransitionIssueRequest {
 // @public (undocumented)
 export interface UpdateIssue {
     // (undocumented)
-    fields?: IssueFields<AtlassianDocumentFormat | string>;
+    fields?: IssueFields<AdfDoc | string>;
     // (undocumented)
     historyMetadata?: HistoryMetadata;
     // (undocumented)

package/util-jira-v3-api/index.cjs.js

@@ -1 +1 @@
-"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const e=require("../atlassian/jira/shared/util-jira-v3-api/src/lib/issue/index.cjs.js"),t=require("../atlassian/jira/shared/util-jira-v3-api/src/lib/jira-server-info/index.cjs.js");exports.FIX_VERSIONS_FIELD=e.FIX_VERSIONS_FIELD;exports.isAtlassianDocumentFormatParagraphNode=e.isAtlassianDocumentFormatParagraphNode;exports.isAtlassianDocumentFormatTextNode=e.isAtlassianDocumentFormatTextNode;exports.switchAtlassianApiUrlToUseSiteUrl=t.switchAtlassianApiUrlToUseSiteUrl;
+"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const e=require("../atlassian/jira/shared/util-jira-v3-api/src/lib/issue/index.cjs.js"),i=require("../atlassian/jira/shared/util-jira-v3-api/src/lib/jira-server-info/index.cjs.js");exports.FIX_VERSIONS_FIELD=e.FIX_VERSIONS_FIELD;exports.switchAtlassianApiUrlToUseSiteUrl=i.switchAtlassianApiUrlToUseSiteUrl;

package/util-jira-v3-api/index.d.ts

@@ -1,28 +1,42 @@
-export declare interface AtlassianDocumentFormat {
+/** Root document node */
+declare interface AdfDoc {
     type: 'doc';
-    version: number;
-    content: AtlassianDocumentFormatNode[];
+    version: 1;
+    content: AdfNode[];
 }
 
-export 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>;
 }
 
-export 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[];
 }
 
-export declare type AtlassianDocumentFormatNode = AtlassianDocumentFormatInlineNode | AtlassianDocumentFormatBlockNode;
-
-export declare interface AtlassianDocumentFormatParagraphNode extends AtlassianDocumentFormatBlockNode {
-    type: 'paragraph';
-    content: AtlassianDocumentFormatInlineNode[];
-}
-
-export declare interface AtlassianDocumentFormatTextNode extends AtlassianDocumentFormatInlineNode {
-    type: 'text';
-    text: string;
+/**
+ * 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;
 }
 
 export declare interface AvatarUrls {
@@ -49,7 +63,7 @@ export declare interface CreatedIssue {
 }
 
 export declare interface CreateIssue {
-    fields: IssueFields<AtlassianDocumentFormat | string>;
+    fields: IssueFields<AdfDoc | string>;
     properties?: {
         key: string;
         value: unknown;
@@ -108,11 +122,7 @@ export declare interface HistoryMetadataParticipant {
     url: string;
 }
 
-export declare function isAtlassianDocumentFormatParagraphNode(node: AtlassianDocumentFormatNode): node is AtlassianDocumentFormatParagraphNode;
-
-export declare function isAtlassianDocumentFormatTextNode(node: AtlassianDocumentFormatNode): node is AtlassianDocumentFormatTextNode;
-
-export declare interface Issue<T = AtlassianDocumentFormat> {
+export declare interface Issue<T = AdfDoc> {
     id: string;
     expand?: string;
     key: string;
@@ -129,7 +139,7 @@ export declare type IssueAssetFieldValue = {
 
 export declare type IssueComment = {
     author: User;
-    body: AtlassianDocumentFormat;
+    body: AdfDoc;
     created: string;
     id: string;
     self: string;
@@ -138,7 +148,7 @@ export declare type IssueComment = {
     visibility: Visibility;
 };
 
-export declare type IssueFields<T = AtlassianDocumentFormat> = CustomFields & StaticIssueFields<T>;
+export declare type IssueFields<T = AdfDoc> = CustomFields & StaticIssueFields<T>;
 
 export declare interface IssueLink {
     id: string;
@@ -164,7 +174,7 @@ export declare interface IssueLinkRequest {
         key?: string;
     };
     comment?: {
-        body: AtlassianDocumentFormat;
+        body: AdfDoc;
     };
     type: {
         id?: string;
@@ -359,7 +369,7 @@ export declare interface RemoteIssueLink {
     self?: string;
 }
 
-export declare interface StaticIssueFields<T = AtlassianDocumentFormat> {
+export declare interface StaticIssueFields<T = AdfDoc> {
     statuscategorychangedate?: string;
     fixVersions?: FixVersions;
     resolution?: unknown;
@@ -430,7 +440,7 @@ export declare interface TransitionIssueRequest {
 }
 
 export declare interface UpdateIssue {
-    fields?: IssueFields<AtlassianDocumentFormat | string>;
+    fields?: IssueFields<AdfDoc | string>;
     properties?: {
         key: string;
         value: unknown;

package/util-jira-v3-api/index.es.js

@@ -1,8 +1,6 @@
-import { FIX_VERSIONS_FIELD as o, isAtlassianDocumentFormatParagraphNode as r, isAtlassianDocumentFormatTextNode as s } from "../atlassian/jira/shared/util-jira-v3-api/src/lib/issue/index.es.js";
+import { FIX_VERSIONS_FIELD as t } from "../atlassian/jira/shared/util-jira-v3-api/src/lib/issue/index.es.js";
 import { switchAtlassianApiUrlToUseSiteUrl as i } from "../atlassian/jira/shared/util-jira-v3-api/src/lib/jira-server-info/index.es.js";
 export {
-  o as FIX_VERSIONS_FIELD,
-  r as isAtlassianDocumentFormatParagraphNode,
-  s as isAtlassianDocumentFormatTextNode,
+  t as FIX_VERSIONS_FIELD,
   i as switchAtlassianApiUrlToUseSiteUrl
 };