@valiantys/atlassian-app-frontend 3.0.0-alpha-9 → 3.0.0-alpha-11

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

@@ -83,7 +83,7 @@ export interface CreatedIssue {
 // @public (undocumented)
 export interface CreateIssue {
     // (undocumented)
-    fields: IssueFields;
+    fields: IssueFields<AtlassianDocumentFormat | string>;
     // (undocumented)
     historyMetadata?: HistoryMetadata;
     // (undocumented)
@@ -180,16 +180,18 @@ export function isAtlassianDocumentFormatParagraphNode(node: AtlassianDocumentFo
 export function isAtlassianDocumentFormatTextNode(node: AtlassianDocumentFormatNode): node is AtlassianDocumentFormatTextNode;
 
 // @public (undocumented)
-export interface Issue {
+export interface Issue<T = AtlassianDocumentFormat> {
     // (undocumented)
     expand?: string;
     // (undocumented)
-    fields: IssueFields;
+    fields: IssueFields<T>;
     // (undocumented)
     id: string;
     // (undocumented)
     key: string;
     // (undocumented)
+    renderedFields?: IssueFields<string>;
+    // (undocumented)
     self?: string;
 }
 
@@ -206,7 +208,7 @@ export type IssueComment = {
 };
 
 // @public (undocumented)
-export type IssueFields = CustomFields & StaticIssueFields;
+export type IssueFields<T = AtlassianDocumentFormat> = CustomFields & StaticIssueFields<T>;
 
 // @public (undocumented)
 export interface IssueLink {
@@ -268,7 +270,7 @@ export interface IssueTransition {
     // (undocumented)
     id: string;
     // (undocumented)
-    looped: boolean;
+    looped?: boolean;
 }
 
 // @public (undocumented)
@@ -331,6 +333,23 @@ export interface JiraServerInfo {
     versionNumbers: number[];
 }
 
+// @public (undocumented)
+export interface PagedResponse<T> {
+    // (undocumented)
+    isLast: boolean;
+    // (undocumented)
+    maxResults: number;
+    // (undocumented)
+    startAt: number;
+    // (undocumented)
+    total: number;
+    // (undocumented)
+    values: T[];
+}
+
+// @public (undocumented)
+export type PagedUsers = PagedResponse<User>;
+
 // @public (undocumented)
 export type Precomputation = {
     id: string;
@@ -363,18 +382,7 @@ export type PrecomputationPayload = {
 };
 
 // @public (undocumented)
-export interface PrecomputationResponse {
-    // (undocumented)
-    isLast: boolean;
-    // (undocumented)
-    maxResults: number;
-    // (undocumented)
-    startAt: number;
-    // (undocumented)
-    total: number;
-    // (undocumented)
-    values: Precomputation[];
-}
+export type PrecomputationResponse = PagedResponse<Precomputation>;
 
 // @public (undocumented)
 export type PrecomputationUpdate = {
@@ -434,23 +442,28 @@ export interface ProjectVersion {
 }
 
 // @public (undocumented)
-export interface StaticIssueFields {
+export interface StaticIssueFields<T = AtlassianDocumentFormat> {
     // (undocumented)
     aggregatetimespent?: number;
     // (undocumented)
     assignee?: User;
     // (undocumented)
+    components?: {
+        id: string;
+        name: string;
+    }[];
+    // (undocumented)
     created?: string;
     // (undocumented)
     creator?: User;
     // (undocumented)
-    description?: AtlassianDocumentFormat;
+    description?: T;
     // (undocumented)
     fixVersions?: FixVersions;
     // (undocumented)
     issuelinks?: IssueLink[];
     // (undocumented)
-    issuetype: {
+    issuetype?: {
         self?: string;
         id: string;
         description?: string;
@@ -472,7 +485,7 @@ export interface StaticIssueFields {
         id: string;
     };
     // (undocumented)
-    project: Project;
+    project?: Project;
     // (undocumented)
     reporter?: User;
     // (undocumented)
@@ -484,7 +497,7 @@ export interface StaticIssueFields {
     // (undocumented)
     statuscategorychangedate?: string;
     // (undocumented)
-    summary: string;
+    summary?: string;
     // (undocumented)
     timeestimate?: number;
     // (undocumented)
@@ -530,7 +543,7 @@ export interface TransitionIssueRequest {
 }
 
 // @public (undocumented)
-export type UpdateIssue = CreatedIssue;
+export type UpdateIssue = CreateIssue;
 
 // @public (undocumented)
 export interface User {
@@ -547,11 +560,26 @@ export interface User {
     // (undocumented)
     emailAddress?: string;
     // (undocumented)
+    groups?: {
+        items?: UserGroupName[];
+        size?: number;
+    };
+    // (undocumented)
     self?: string;
     // (undocumented)
     timeZone: string;
 }
 
+// @public (undocumented)
+export interface UserGroupName {
+    // (undocumented)
+    groupId: string;
+    // (undocumented)
+    name: string;
+    // (undocumented)
+    self: string;
+}
+
 // @public (undocumented)
 export interface UserPickerQueryResponse {
     // (undocumented)

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

@@ -49,7 +49,7 @@ export declare interface CreatedIssue {
 }
 
 export declare interface CreateIssue {
-    fields: IssueFields;
+    fields: IssueFields<AtlassianDocumentFormat | string>;
     properties?: {
         key: string;
         value: unknown;
@@ -110,12 +110,13 @@ export declare function isAtlassianDocumentFormatParagraphNode(node: AtlassianDo
 
 export declare function isAtlassianDocumentFormatTextNode(node: AtlassianDocumentFormatNode): node is AtlassianDocumentFormatTextNode;
 
-export declare interface Issue {
+export declare interface Issue<T = AtlassianDocumentFormat> {
     id: string;
     expand?: string;
     key: string;
     self?: string;
-    fields: IssueFields;
+    fields: IssueFields<T>;
+    renderedFields?: IssueFields<string>;
 }
 
 export declare type IssueComment = {
@@ -129,7 +130,7 @@ export declare type IssueComment = {
     visibility: Visibility;
 };
 
-export declare type IssueFields = CustomFields & StaticIssueFields;
+export declare type IssueFields<T = AtlassianDocumentFormat> = CustomFields & StaticIssueFields<T>;
 
 export declare interface IssueLink {
     outwardIssue?: Issue;
@@ -172,7 +173,7 @@ export declare interface IssueStatus {
 
 export declare interface IssueTransition {
     id: string;
-    looped: boolean;
+    looped?: boolean;
 }
 
 export declare interface IssueTypeDetails {
@@ -210,6 +211,16 @@ export declare interface JiraServerInfo {
     versionNumbers: number[];
 }
 
+export declare interface PagedResponse<T> {
+    startAt: number;
+    isLast: boolean;
+    maxResults: number;
+    total: number;
+    values: T[];
+}
+
+export declare type PagedUsers = PagedResponse<User>;
+
 export declare type Precomputation = {
     id: string;
     value: string;
@@ -239,13 +250,7 @@ export declare type PrecomputationPayload = {
     contextToken?: string;
 };
 
-export declare interface PrecomputationResponse {
-    startAt: number;
-    isLast: boolean;
-    maxResults: number;
-    total: number;
-    values: Precomputation[];
-}
+export declare type PrecomputationResponse = PagedResponse<Precomputation>;
 
 export declare type PrecomputationUpdate = {
     id: string;
@@ -281,7 +286,7 @@ export declare interface ProjectVersion {
     userReleaseDate?: string;
 }
 
-export declare interface StaticIssueFields {
+export declare interface StaticIssueFields<T = AtlassianDocumentFormat> {
     statuscategorychangedate?: string;
     fixVersions?: FixVersions;
     resolution?: unknown;
@@ -291,7 +296,7 @@ export declare interface StaticIssueFields {
         maxResults: number;
         worklogs: Worklog[];
     };
-    issuetype: {
+    issuetype?: {
         self?: string;
         id: string;
         description?: string;
@@ -302,7 +307,7 @@ export declare interface StaticIssueFields {
         hierarchyLevel?: number;
     };
     timespent?: number;
-    project: Project;
+    project?: Project;
     aggregatetimespent?: number;
     resolutiondate?: string;
     lastViewed?: string;
@@ -322,19 +327,23 @@ export declare interface StaticIssueFields {
     };
     created?: string;
     updated?: string;
-    description?: AtlassianDocumentFormat;
+    description?: T;
     timetracking?: {
         remainingEstimate: string;
         timeSpent: string;
         remainingEstimateSeconds: number;
         timeSpentSeconds: number;
     };
-    summary: string;
+    summary?: string;
     status?: IssueStatus;
     creator?: User;
     assignee?: User;
     reporter?: User;
     issuelinks?: IssueLink[];
+    components?: {
+        id: string;
+        name: string;
+    }[];
 }
 
 export declare interface TransitionIssueRequest {
@@ -345,7 +354,7 @@ export declare interface TransitionIssueRequest {
     update?: any;
 }
 
-export declare type UpdateIssue = CreatedIssue;
+export declare type UpdateIssue = CreateIssue;
 
 export declare interface User {
     accountId: string;
@@ -356,6 +365,16 @@ export declare interface User {
     avatarUrls?: AvatarUrls;
     accountType?: string;
     self?: string;
+    groups?: {
+        items?: UserGroupName[];
+        size?: number;
+    };
+}
+
+export declare interface UserGroupName {
+    groupId: string;
+    name: string;
+    self: string;
 }
 
 export declare interface UserPickerQueryResponse {