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

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

@@ -49,7 +49,7 @@ declare interface CreatedIssue {
 }
 
 declare interface CreateIssue {
-    fields: IssueFields;
+    fields: IssueFields<AtlassianDocumentFormat | string>;
     properties?: {
         key: string;
         value: unknown;
@@ -113,12 +113,13 @@ declare interface HistoryMetadataParticipant {
     url: string;
 }
 
-declare interface Issue {
+declare interface Issue<T = AtlassianDocumentFormat> {
     id: string;
     expand?: string;
     key: string;
     self?: string;
-    fields: IssueFields;
+    fields: IssueFields<T>;
+    renderedFields?: IssueFields<string>;
 }
 
 declare type IssueComment = {
@@ -132,7 +133,7 @@ declare type IssueComment = {
     visibility: Visibility;
 };
 
-declare type IssueFields = CustomFields & StaticIssueFields;
+declare type IssueFields<T = AtlassianDocumentFormat> = CustomFields & StaticIssueFields<T>;
 
 declare interface IssueLink {
     outwardIssue?: Issue;
@@ -175,7 +176,7 @@ declare interface IssueStatus {
 
 declare interface IssueTransition {
     id: string;
-    looped: boolean;
+    looped?: boolean;
 }
 
 declare type JiraCommentResponse = {
@@ -186,21 +187,22 @@ declare type JiraCommentResponse = {
 };
 
 export declare class JiraIssueService {
-    private fetchSvc;
+    private readonly fetchSvc;
     static readonly issueUrl = "/rest/api/3/issue";
     constructor(fetchSvc: AtlassianProductFetchService<'jira'>);
+    updateProperty(issueIdOrKey: string, propertyName: string, value: any): Promise<void>;
     updateField(issueIdOrKey: string, fieldName: string, value: unknown): Promise<void>;
     updateFields(issueIdOrKey: string, fields: Record<string, unknown>): Promise<void>;
     getIssueField<T>(issueIdOrKey: string, field: string): Promise<T | undefined>;
     getIssueFields(issueIdOrKey: string, fields: string[]): Promise<IssueFields | undefined>;
-    getIssue(issueIdOrKey: string, fields?: string[]): Promise<Issue | undefined>;
-    issueSearch(jql: string, fields: string[], maxResults?: number): Promise<Issue[]>;
+    getIssue(issueIdOrKey: string, fields?: string[], rendered?: boolean): Promise<Issue | undefined>;
+    issueSearch(jql: string, fields: string[], maxResults?: number): Promise<Issue<AtlassianDocumentFormat>[]>;
     addWorklog(issueIdOrKey: string, worklog: WorklogCreateRequest): Promise<Worklog>;
-    queryForIssuesInProjects(projectIds: number[]): Promise<Issue[]>;
+    queryForIssuesInProjects(projectIdsOrKeys: string[]): Promise<Issue<AtlassianDocumentFormat>[]>;
     createIssue(body: CreateIssue): Promise<CreatedIssue>;
     updateIssue(issueIdOrKey: string, body: UpdateIssue): Promise<void>;
-    getIssueComments(issueIdOrKey: string, startAt?: number): Promise<JiraCommentResponse | undefined>;
-    getIssueCommentById(issueIdOrKey: string, commentId: string): Promise<IssueComment | undefined>;
+    getIssueComments(issueIdOrKey: string, startAt?: number): Promise<JiraCommentResponse>;
+    getIssueCommentById(issueIdOrKey: string, commentId: string): Promise<IssueComment>;
     addIssueComment(issueIdOrKey: string, body: AtlassianDocumentFormat): Promise<IssueComment>;
     transitionIssue(issueIdOrKey: string, body: TransitionIssueRequest): Promise<void>;
     createIssueLink(issueLinkRequest: IssueLinkRequest): Promise<void>;
@@ -221,7 +223,7 @@ declare interface Project {
 
 declare type RequestProductMethod = (url: FetchRoute, init: RequestInit) => Promise<APIResponse>;
 
-declare interface StaticIssueFields {
+declare interface StaticIssueFields<T = AtlassianDocumentFormat> {
     statuscategorychangedate?: string;
     fixVersions?: FixVersions;
     resolution?: unknown;
@@ -231,7 +233,7 @@ declare interface StaticIssueFields {
         maxResults: number;
         worklogs: Worklog[];
     };
-    issuetype: {
+    issuetype?: {
         self?: string;
         id: string;
         description?: string;
@@ -242,7 +244,7 @@ declare interface StaticIssueFields {
         hierarchyLevel?: number;
     };
     timespent?: number;
-    project: Project;
+    project?: Project;
     aggregatetimespent?: number;
     resolutiondate?: string;
     lastViewed?: string;
@@ -262,19 +264,23 @@ 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;
+    }[];
 }
 
 declare interface TransitionIssueRequest {
@@ -285,7 +291,7 @@ declare interface TransitionIssueRequest {
     update?: any;
 }
 
-declare type UpdateIssue = CreatedIssue;
+declare type UpdateIssue = CreateIssue;
 
 declare interface User {
     accountId: string;
@@ -296,6 +302,16 @@ declare interface User {
     avatarUrls?: AvatarUrls;
     accountType?: string;
     self?: string;
+    groups?: {
+        items?: UserGroupName[];
+        size?: number;
+    };
+}
+
+declare interface UserGroupName {
+    groupId: string;
+    name: string;
+    self: string;
 }
 
 declare type Visibility = {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@valiantys/atlassian-app-frontend",
-  "version": "3.0.0-alpha-9",
+  "version": "3.0.0-alpha-11",
   "description": "This library provides an Atlassian Forge Custom UI wrapper component that handles all the setup necessary to support an app that can run deployed or in standalone mode",
   "exports": {
     "./atlassian-app": {

package/shared/util-fetch/src/lib/shared-util-fetch/index.cjs.js

@@ -1,2 +1,2 @@
-"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});class h extends Error{constructor(t,e,a=t){super(a),this.statusText=t,this.statusCode=e,this.statusCode=e,this.statusText=t}toJSON(){return{statusCode:this.statusCode,statusText:this.statusText}}}function c(s,t){const e={Authorization:s.startsWith("Bearer ")?s:`Bearer ${s}`};return t?{...t,...e}:e}async function l(s,t,e){const a=c(s,e.headers||{});return fetch(t,{...e,headers:a})}async function j(s,t,e,a,o="json",n={}){return d(t,e,c(s,n),a,o)}async function d(s,t,e,a,o="json"){const n={...e||{},Accept:o==="json"?"application/json":"text/html","Content-Type":o==="json"?"application/json":"text/html"},f=a?JSON.stringify(a):void 0,r=await fetch(s,{method:t,headers:n,body:f});if(r.ok)return t==="DELETE"||r.status===204?void 0:o==="text"?await r.text():await r.json();{let i="";try{i=await r.text()}catch{}const u=`${r.status} ${r.statusText} - ${t} ${s}
- ${i}`;throw console.error(u),new h(r.statusText,r.status,u)}}exports.FetchError=h;exports.addAuthHeader=c;exports.bearerAuthFetch=j;exports.bearerAuthFetchRaw=l;exports.jsonFetch=d;
+"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});class h extends Error{constructor(t,e,a=t){super(a),this.statusText=t,this.statusCode=e,this.statusCode=e,this.statusText=t}toJSON(){return{statusCode:this.statusCode,statusText:this.statusText}}}function c(r,t){const e={Authorization:r.startsWith("Bearer ")?r:`Bearer ${r}`};return t?{...t,...e}:e}async function j(r,t,e){const a=c(r,e.headers||{});return fetch(t,{...e,headers:a})}async function x(r,t,e,a,n="json",o={}){return d(t,e,c(r,o),a,n)}async function d(r,t,e,a,n="json",o){const f={...e??{},Accept:n==="json"?"application/json":"text/html","Content-Type":n==="json"?"application/json":"text/html"},l=a?JSON.stringify(a):void 0,s=await fetch(r,{method:t,headers:f,body:l,credentials:o});if(s.ok)return t==="DELETE"||s.status===204?void 0:n==="text"?await s.text():await s.json();{let u="";try{u=await s.text()}catch{}const i=`${s.status} ${s.statusText} - ${t} ${r}
+ ${u}`;throw console.error(i),new h(s.statusText,s.status,i)}}exports.FetchError=h;exports.addAuthHeader=c;exports.bearerAuthFetch=x;exports.bearerAuthFetchRaw=j;exports.jsonFetch=d;

package/shared/util-fetch/src/lib/shared-util-fetch/index.es.js

@@ -1,6 +1,6 @@
 class f extends Error {
-  constructor(t, s, o = t) {
-    super(o), this.statusText = t, this.statusCode = s, this.statusCode = s, this.statusText = t;
+  constructor(t, e, a = t) {
+    super(a), this.statusText = t, this.statusCode = e, this.statusCode = e, this.statusText = t;
   }
   toJSON() {
     return {
@@ -9,37 +9,38 @@ class f extends Error {
     };
   }
 }
-function u(e, t) {
-  const s = {
-    Authorization: e.startsWith("Bearer ") ? e : `Bearer ${e}`
+function u(s, t) {
+  const e = {
+    Authorization: s.startsWith("Bearer ") ? s : `Bearer ${s}`
   };
-  return t ? { ...t, ...s } : s;
+  return t ? { ...t, ...e } : e;
 }
-async function l(e, t, s) {
-  const o = u(
-    e,
-    s.headers || {}
+async function l(s, t, e) {
+  const a = u(
+    s,
+    e.headers || {}
   );
-  return fetch(t, { ...s, headers: o });
+  return fetch(t, { ...e, headers: a });
 }
-async function j(e, t, s, o, n = "json", a = {}) {
-  return d(
+async function j(s, t, e, a, n = "json", o = {}) {
+  return x(
     t,
-    s,
-    u(e, a),
-    o,
+    e,
+    u(s, o),
+    a,
     n
   );
 }
-async function d(e, t, s, o, n = "json") {
-  const a = {
-    ...s || {},
+async function x(s, t, e, a, n = "json", o) {
+  const h = {
+    ...e ?? {},
     Accept: n === "json" ? "application/json" : "text/html",
     "Content-Type": n === "json" ? "application/json" : "text/html"
-  }, h = o ? JSON.stringify(o) : void 0, r = await fetch(e, {
+  }, d = a ? JSON.stringify(a) : void 0, r = await fetch(s, {
     method: t,
-    headers: a,
-    body: h
+    headers: h,
+    body: d,
+    credentials: o
   });
   if (r.ok)
     return t === "DELETE" || r.status === 204 ? void 0 : n === "text" ? await r.text() : await r.json();
@@ -49,7 +50,7 @@ async function d(e, t, s, o, n = "json") {
       c = await r.text();
     } catch {
     }
-    const i = `${r.status} ${r.statusText} - ${t} ${e}
+    const i = `${r.status} ${r.statusText} - ${t} ${s}
  ${c}`;
     throw console.error(i), new f(r.statusText, r.status, i);
   }
@@ -59,5 +60,5 @@ export {
   u as addAuthHeader,
   j as bearerAuthFetch,
   l as bearerAuthFetchRaw,
-  d as jsonFetch
+  x as jsonFetch
 };

package/ui-oauth-login/atlassian-app-frontend-ui-oauth-login.api.json

@@ -322,6 +322,33 @@
           "name": "OAuthProviderProps",
           "preserveMemberOrder": false,
           "members": [
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@valiantys/atlassian-app-frontend!OAuthProviderProps#appBaseContext:member",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "appBaseContext?: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "string"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": true,
+              "releaseTag": "Public",
+              "name": "appBaseContext",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              }
+            },
             {
               "kind": "PropertySignature",
               "canonicalReference": "@valiantys/atlassian-app-frontend!OAuthProviderProps#appName:member",
@@ -438,6 +465,319 @@
           ],
           "extendsTokenRanges": []
         },
+        {
+          "kind": "Function",
+          "canonicalReference": "@valiantys/atlassian-app-frontend!OAuthRedirectLogin:function(1)",
+          "docComment": "",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export declare function OAuthRedirectLogin(props: "
+            },
+            {
+              "kind": "Reference",
+              "text": "Readonly",
+              "canonicalReference": "!Readonly:type"
+            },
+            {
+              "kind": "Content",
+              "text": "<"
+            },
+            {
+              "kind": "Reference",
+              "text": "OAuthRedirectLoginProps",
+              "canonicalReference": "@valiantys/atlassian-app-frontend!~OAuthRedirectLoginProps:interface"
+            },
+            {
+              "kind": "Content",
+              "text": ">"
+            },
+            {
+              "kind": "Content",
+              "text": "): "
+            },
+            {
+              "kind": "Content",
+              "text": "import(\"react/jsx-runtime\")."
+            },
+            {
+              "kind": "Reference",
+              "text": "JSX.Element",
+              "canonicalReference": "@types/react!JSX.Element:interface"
+            },
+            {
+              "kind": "Content",
+              "text": ";"
+            }
+          ],
+          "fileUrlPath": "../../shared/frontend-feature-oauth-login/src/lib/ui-oauth-redirect-login.d.ts",
+          "returnTypeTokenRange": {
+            "startIndex": 6,
+            "endIndex": 8
+          },
+          "releaseTag": "Public",
+          "overloadIndex": 1,
+          "parameters": [
+            {
+              "parameterName": "props",
+              "parameterTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 5
+              },
+              "isOptional": false
+            }
+          ],
+          "name": "OAuthRedirectLogin"
+        },
+        {
+          "kind": "Function",
+          "canonicalReference": "@valiantys/atlassian-app-frontend!OAuthRoutes:function(1)",
+          "docComment": "",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export declare function OAuthRoutes({ codeTokenExchangeUrl, clientId, oAuthScopes, redirectUri, callbackPath, setAuth, }: "
+            },
+            {
+              "kind": "Reference",
+              "text": "Readonly",
+              "canonicalReference": "!Readonly:type"
+            },
+            {
+              "kind": "Content",
+              "text": "<"
+            },
+            {
+              "kind": "Reference",
+              "text": "OAuthRoutesProps",
+              "canonicalReference": "@valiantys/atlassian-app-frontend!OAuthRoutesProps:interface"
+            },
+            {
+              "kind": "Content",
+              "text": ">"
+            },
+            {
+              "kind": "Content",
+              "text": "): "
+            },
+            {
+              "kind": "Content",
+              "text": "import(\"react/jsx-runtime\")."
+            },
+            {
+              "kind": "Reference",
+              "text": "JSX.Element",
+              "canonicalReference": "@types/react!JSX.Element:interface"
+            },
+            {
+              "kind": "Content",
+              "text": ";"
+            }
+          ],
+          "fileUrlPath": "../../shared/frontend-feature-oauth-login/src/lib/oauth-routes.d.ts",
+          "returnTypeTokenRange": {
+            "startIndex": 6,
+            "endIndex": 8
+          },
+          "releaseTag": "Public",
+          "overloadIndex": 1,
+          "parameters": [
+            {
+              "parameterName": "{ codeTokenExchangeUrl, clientId, oAuthScopes, redirectUri, callbackPath, setAuth, }",
+              "parameterTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 5
+              },
+              "isOptional": false
+            }
+          ],
+          "name": "OAuthRoutes"
+        },
+        {
+          "kind": "Interface",
+          "canonicalReference": "@valiantys/atlassian-app-frontend!OAuthRoutesProps:interface",
+          "docComment": "",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export interface OAuthRoutesProps "
+            }
+          ],
+          "fileUrlPath": "../../shared/frontend-feature-oauth-login/src/lib/oauth-routes.d.ts",
+          "releaseTag": "Public",
+          "name": "OAuthRoutesProps",
+          "preserveMemberOrder": false,
+          "members": [
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@valiantys/atlassian-app-frontend!OAuthRoutesProps#callbackPath:member",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "callbackPath: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "string"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "callbackPath",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              }
+            },
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@valiantys/atlassian-app-frontend!OAuthRoutesProps#clientId:member",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "clientId: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "string"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "clientId",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              }
+            },
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@valiantys/atlassian-app-frontend!OAuthRoutesProps#codeTokenExchangeUrl:member",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "codeTokenExchangeUrl: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "string"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "codeTokenExchangeUrl",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              }
+            },
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@valiantys/atlassian-app-frontend!OAuthRoutesProps#oAuthScopes:member",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "oAuthScopes: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "AtlassianOAuthScopes",
+                  "canonicalReference": "@valiantys/atlassian-app-frontend!AtlassianOAuthScopes:type"
+                },
+                {
+                  "kind": "Content",
+                  "text": "[]"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "oAuthScopes",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 3
+              }
+            },
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@valiantys/atlassian-app-frontend!OAuthRoutesProps#redirectUri:member",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "redirectUri: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "string"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "redirectUri",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              }
+            },
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@valiantys/atlassian-app-frontend!OAuthRoutesProps#setAuth:member",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "setAuth: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "(auth: {\n        token: string;\n        expiresAt: number;\n    }) => void"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "setAuth",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              }
+            }
+          ],
+          "extendsTokenRanges": []
+        },
         {
           "kind": "Function",
           "canonicalReference": "@valiantys/atlassian-app-frontend!useOAuth:function(1)",

package/ui-oauth-login/atlassian-app-frontend.api.md

@@ -21,6 +21,8 @@ export function OAuthProvider({ children, ...config }: PropsWithChildren<OAuthPr
 
 // @public (undocumented)
 export interface OAuthProviderProps {
+    // (undocumented)
+    appBaseContext?: string;
     appName: string;
     // (undocumented)
     clientId: string;
@@ -30,6 +32,33 @@ export interface OAuthProviderProps {
     oAuthScopes: AtlassianOAuthScopes[];
 }
 
+// Warning: (ae-forgotten-export) The symbol "OAuthRedirectLoginProps" needs to be exported by the entry point ui-oauth-login.d.ts
+//
+// @public (undocumented)
+export function OAuthRedirectLogin(props: Readonly<OAuthRedirectLoginProps>): JSX_2.Element;
+
+// @public (undocumented)
+export function OAuthRoutes({ codeTokenExchangeUrl, clientId, oAuthScopes, redirectUri, callbackPath, setAuth, }: Readonly<OAuthRoutesProps>): JSX_2.Element;
+
+// @public (undocumented)
+export interface OAuthRoutesProps {
+    // (undocumented)
+    callbackPath: string;
+    // (undocumented)
+    clientId: string;
+    // (undocumented)
+    codeTokenExchangeUrl: string;
+    // (undocumented)
+    oAuthScopes: AtlassianOAuthScopes[];
+    // (undocumented)
+    redirectUri: string;
+    // (undocumented)
+    setAuth: (auth: {
+        token: string;
+        expiresAt: number;
+    }) => void;
+}
+
 // @public (undocumented)
 export const useOAuth: () => OAuth;
 

package/ui-oauth-login/index.cjs.js

@@ -1 +1 @@
-"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const e=require("../atlassian/shared/frontend-feature-oauth-login/src/lib/feature-oauth/index.cjs.js");exports.OAuthProvider=e.OAuthProvider;exports.useOAuth=e.useOAuth;
+"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const e=require("../atlassian/shared/frontend-feature-oauth-login/src/lib/feature-oauth/index.cjs.js"),t=require("../atlassian/shared/frontend-feature-oauth-login/src/lib/oauth-routes/index.cjs.js"),u=require("../atlassian/shared/frontend-feature-oauth-login/src/lib/ui-oauth-redirect-login/index.cjs.js");exports.OAuthProvider=e.OAuthProvider;exports.useOAuth=e.useOAuth;exports.OAuthRoutes=t.OAuthRoutes;exports.OAuthRedirectLogin=u.OAuthRedirectLogin;