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

package/data-access-project/atlassian-app-frontend.api.md

@@ -0,0 +1,39 @@
+## API Report File for "@valiantys/atlassian-app-frontend"
+
+> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
+
+```ts
+
+// @public (undocumented)
+export class JiraProjectService {
+    // Warning: (ae-forgotten-export) The symbol "AtlassianProductFetchService" needs to be exported by the entry point data-access-project.d.ts
+    constructor(fetchSvc: AtlassianProductFetchService<'jira'>);
+    // (undocumented)
+    getAllProjects(): Promise<Project[]>;
+    // Warning: (ae-forgotten-export) The symbol "Project" needs to be exported by the entry point data-access-project.d.ts
+    //
+    // (undocumented)
+    getProject(projectIdOrKey: string): Promise<Project>;
+    // Warning: (ae-forgotten-export) The symbol "IssueTypeDetails" needs to be exported by the entry point data-access-project.d.ts
+    //
+    // (undocumented)
+    getProjectIssueTypes(projectId: string): Promise<IssueTypeDetails[]>;
+    // (undocumented)
+    getProjectProperty<T>(projectIdOrKey: string, propertyKey: string): Promise<T | undefined>;
+    // (undocumented)
+    getProjectStatuses(projectIdOrKey: string): Promise<unknown>;
+    // Warning: (ae-forgotten-export) The symbol "ProjectVersion" needs to be exported by the entry point data-access-project.d.ts
+    //
+    // (undocumented)
+    getVersions(projectIdOrKey: string): Promise<ProjectVersion[]>;
+    // (undocumented)
+    projectSearchByIds(projectIds: string[]): Promise<Project[]>;
+    // (undocumented)
+    static readonly projectUrl = "/rest/api/3/project";
+    // (undocumented)
+    setProjectProperty<T>(projectIdOrKey: string, propertyKey: string, value: T): Promise<T>;
+}
+
+// (No @packageDocumentation comment for this package)
+
+```

package/data-access-project/index.cjs.js

@@ -0,0 +1 @@
+"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const e=require("../atlassian/jira/shared/data-access-project/src/lib/jira-project-service/index.cjs.js");exports.JiraProjectService=e.JiraProjectService;

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

@@ -0,0 +1,110 @@
+declare type APIResponse = Pick<Response, 'json' | 'text' | 'ok' | 'status' | 'statusText' | 'headers'>;
+
+declare interface AtlassianProductFetchService<P extends Product> {
+    productType: P;
+    fetch: FetchSignature;
+    route: (template: TemplateStringsArray, ...parameters: (string | number | URLSearchParams | FetchRoute)[]) => FetchRoute;
+    rawFetch: RequestProductMethod;
+    fullUrl: (path: string) => string;
+}
+
+declare interface AvatarUrls {
+    '48x48': string;
+    '24x24': string;
+    '16x16': string;
+    '32x32': string;
+}
+
+declare type FetchMethod = 'POST' | 'GET' | 'PUT' | 'DELETE' | 'PATCH';
+
+declare interface FetchRequest {
+    method: FetchMethod;
+    url: FetchRoute;
+    responseType?: 'json' | 'text';
+    allowExperimental?: boolean;
+}
+
+declare type FetchRoute = {
+    readonly value: string;
+};
+
+declare type FetchSignature = <T>(request: FetchRequest, body?: any) => Promise<T>;
+
+declare interface IssueTypeDetails {
+    avatarId: number;
+    description: string;
+    hierarchyLevel: number;
+    iconUrl: string;
+    id: string;
+    name: string;
+    self: string;
+    subtask: boolean;
+}
+
+export declare class JiraProjectService {
+    private readonly fetchSvc;
+    static readonly projectUrl = "/rest/api/3/project";
+    constructor(fetchSvc: AtlassianProductFetchService<'jira'>);
+    getVersions(projectIdOrKey: string): Promise<ProjectVersion[]>;
+    getProject(projectIdOrKey: string): Promise<Project>;
+    getAllProjects(): Promise<Project[]>;
+    projectSearchByIds(projectIds: string[]): Promise<Project[]>;
+    getProjectIssueTypes(projectId: string): Promise<IssueTypeDetails[]>;
+    getProjectStatuses(projectIdOrKey: string): Promise<unknown>;
+    getProjectProperty<T>(projectIdOrKey: string, propertyKey: string): Promise<T | undefined>;
+    setProjectProperty<T>(projectIdOrKey: string, propertyKey: string, value: T): Promise<T>;
+}
+
+declare type Product = 'jira' | 'bitbucket' | 'confluence' | 'connected-data';
+
+declare interface Project {
+    self?: string;
+    id: string;
+    key?: string;
+    name?: string;
+    projectTypeKey?: string;
+    simplified?: boolean;
+    avatarUrls?: AvatarUrls;
+    archived?: boolean;
+    lead?: User;
+}
+
+declare interface ProjectVersion {
+    archived: boolean;
+    description: string;
+    id: string;
+    name: string;
+    overdue?: boolean;
+    projectId?: number;
+    releaseDate?: number;
+    releaseDateSet?: boolean;
+    released: boolean;
+    self: string;
+    startDateSet?: boolean;
+    userReleaseDate?: string;
+}
+
+declare type RequestProductMethod = (url: FetchRoute, init: RequestInit) => Promise<APIResponse>;
+
+declare interface User {
+    accountId: string;
+    active: boolean;
+    displayName: string;
+    emailAddress?: string;
+    timeZone: string;
+    avatarUrls?: AvatarUrls;
+    accountType?: string;
+    self?: string;
+    groups?: {
+        items?: UserGroupName[];
+        size?: number;
+    };
+}
+
+declare interface UserGroupName {
+    groupId: string;
+    name: string;
+    self: string;
+}
+
+export { }

package/data-access-project/index.es.js

@@ -0,0 +1,4 @@
+import { JiraProjectService as o } from "../atlassian/jira/shared/data-access-project/src/lib/jira-project-service/index.es.js";
+export {
+  o as JiraProjectService
+};

package/data-access-project/tsdoc-metadata.json

@@ -0,0 +1,11 @@
+// This file is read by tools that parse documentation comments conforming to the TSDoc standard.
+// It should be published with your NPM package.  It should not be tracked by Git.
+{
+  "tsdocVersion": "0.12",
+  "toolPackages": [
+    {
+      "packageName": "@microsoft/api-extractor",
+      "packageVersion": "7.52.8"
+    }
+  ]
+}

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

@@ -33,7 +33,7 @@ declare type FetchRoute = {
     readonly value: string;
 };
 
-declare type FetchSignature = <T>(request: FetchRequest, body?: Record<string, any>) => Promise<T>;
+declare type FetchSignature = <T>(request: FetchRequest, body?: any) => Promise<T>;
 
 declare type Product = 'jira' | 'bitbucket' | 'confluence' | 'connected-data';
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@valiantys/atlassian-app-frontend",
-  "version": "3.0.0-alpha-11",
+  "version": "3.0.0-alpha-18",
   "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": {
@@ -143,6 +143,11 @@
       "require": "./data-access-issue/index.cjs.js",
       "types": "./data-access-issue/index.d.ts"
     },
+    "./data-access-project": {
+      "import": "./data-access-project/index.es.js",
+      "require": "./data-access-project/index.cjs.js",
+      "types": "./data-access-project/index.d.ts"
+    },
     "./data-access-jql": {
       "import": "./data-access-jql/index.es.js",
       "require": "./data-access-jql/index.cjs.js",

package/ui-atlassian-product-fetch/index.d.ts

@@ -24,7 +24,7 @@ declare type FetchRoute = {
     readonly value: string;
 };
 
-declare type FetchSignature = <T>(request: FetchRequest, body?: Record<string, any>) => Promise<T>;
+declare type FetchSignature = <T>(request: FetchRequest, body?: any) => Promise<T>;
 
 declare type Product = 'jira' | 'bitbucket' | 'confluence' | 'connected-data';
 

package/util-atlassian-product-fetch/atlassian-app-frontend-util-atlassian-product-fetch.api.json

@@ -847,11 +847,11 @@
                 },
                 {
                   "kind": "Content",
-                  "text": ", statusCode?: "
+                  "text": ", statusCode: "
                 },
                 {
                   "kind": "Content",
-                  "text": "number | undefined"
+                  "text": "number"
                 },
                 {
                   "kind": "Content",
@@ -884,7 +884,7 @@
                     "startIndex": 3,
                     "endIndex": 4
                   },
-                  "isOptional": true
+                  "isOptional": false
                 },
                 {
                   "parameterName": "message",
@@ -903,11 +903,11 @@
               "excerptTokens": [
                 {
                   "kind": "Content",
-                  "text": "readonly statusCode?: "
+                  "text": "readonly statusCode: "
                 },
                 {
                   "kind": "Content",
-                  "text": "number | undefined"
+                  "text": "number"
                 },
                 {
                   "kind": "Content",
@@ -915,7 +915,7 @@
                 }
               ],
               "isReadonly": true,
-              "isOptional": true,
+              "isOptional": false,
               "releaseTag": "Public",
               "name": "statusCode",
               "propertyTypeTokenRange": {
@@ -967,7 +967,7 @@
                 },
                 {
                   "kind": "Content",
-                  "text": "{\n        statusCode: number | undefined;\n        statusText: string;\n    }"
+                  "text": "{\n        statusCode: number;\n        statusText: string;\n    }"
                 },
                 {
                   "kind": "Content",
@@ -1194,16 +1194,7 @@
             },
             {
               "kind": "Content",
-              "text": ", body?: "
-            },
-            {
-              "kind": "Reference",
-              "text": "Record",
-              "canonicalReference": "!Record:type"
-            },
-            {
-              "kind": "Content",
-              "text": "<string, any>) => "
+              "text": ", body?: any) => "
             },
             {
               "kind": "Reference",
@@ -1224,7 +1215,7 @@
           "name": "FetchSignature",
           "typeTokenRange": {
             "startIndex": 1,
-            "endIndex": 8
+            "endIndex": 6
           }
         },
         {

package/util-atlassian-product-fetch/atlassian-app-frontend.api.md

@@ -42,14 +42,14 @@ export function bearerAuthFetchRaw(authToken: string, url: string, init: Request
 
 // @public (undocumented)
 export class FetchError extends Error {
-    constructor(statusText: string, statusCode?: number | undefined, message?: string);
+    constructor(statusText: string, statusCode: number, message?: string);
     // (undocumented)
-    readonly statusCode?: number | undefined;
+    readonly statusCode: number;
     // (undocumented)
     readonly statusText: string;
     // (undocumented)
     toJSON(): {
-        statusCode: number | undefined;
+        statusCode: number;
         statusText: string;
     };
 }
@@ -75,7 +75,7 @@ export type FetchRoute = {
 };
 
 // @public (undocumented)
-export type FetchSignature = <T>(request: FetchRequest, body?: Record<string, any>) => Promise<T>;
+export type FetchSignature = <T>(request: FetchRequest, body?: any) => Promise<T>;
 
 // @public (undocumented)
 export function jsonFetch<T, U = Record<string, unknown>>(url: string, method: FetchMethod, headers?: Record<string, string>, body?: U, responseType?: 'json' | 'text', includeCredentials?: RequestCredentials): Promise<T>;

package/util-atlassian-product-fetch/index.d.ts

@@ -23,10 +23,10 @@ export declare function bearerAuthFetchRaw(authToken: string, url: string, init:
 
 export declare class FetchError extends Error {
     readonly statusText: string;
-    readonly statusCode?: number | undefined;
-    constructor(statusText: string, statusCode?: number | undefined, message?: string);
+    readonly statusCode: number;
+    constructor(statusText: string, statusCode: number, message?: string);
     toJSON(): {
-        statusCode: number | undefined;
+        statusCode: number;
         statusText: string;
     };
 }
@@ -44,7 +44,7 @@ export declare type FetchRoute = {
     readonly value: string;
 };
 
-export declare type FetchSignature = <T>(request: FetchRequest, body?: Record<string, any>) => Promise<T>;
+export declare type FetchSignature = <T>(request: FetchRequest, body?: any) => Promise<T>;
 
 export declare function jsonFetch<T, U = Record<string, unknown>>(url: string, method: FetchMethod, headers?: Record<string, string>, body?: U, responseType?: 'json' | 'text', includeCredentials?: RequestCredentials): Promise<T>;
 

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

@@ -1176,6 +1176,186 @@
             "endIndex": 0
           }
         },
+        {
+          "kind": "Interface",
+          "canonicalReference": "@valiantys/atlassian-app-frontend!FixVersion:interface",
+          "docComment": "",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export interface FixVersion "
+            }
+          ],
+          "fileUrlPath": "../../jira/shared/util-jira-v3-api/src/lib/issue.d.ts",
+          "releaseTag": "Public",
+          "name": "FixVersion",
+          "preserveMemberOrder": false,
+          "members": [
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@valiantys/atlassian-app-frontend!FixVersion#description:member",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "description?: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "string"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": true,
+              "releaseTag": "Public",
+              "name": "description",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              }
+            },
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@valiantys/atlassian-app-frontend!FixVersion#id:member",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "id: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "string"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "id",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              }
+            },
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@valiantys/atlassian-app-frontend!FixVersion#name:member",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "name: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "string"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "name",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              }
+            },
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@valiantys/atlassian-app-frontend!FixVersion#released:member",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "released?: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "boolean"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": true,
+              "releaseTag": "Public",
+              "name": "released",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              }
+            },
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@valiantys/atlassian-app-frontend!FixVersion#releaseDate:member",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "releaseDate?: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "string"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": true,
+              "releaseTag": "Public",
+              "name": "releaseDate",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              }
+            },
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@valiantys/atlassian-app-frontend!FixVersion#self:member",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "self?: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "string"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": true,
+              "releaseTag": "Public",
+              "name": "self",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              }
+            }
+          ],
+          "extendsTokenRanges": []
+        },
         {
           "kind": "TypeAlias",
           "canonicalReference": "@valiantys/atlassian-app-frontend!FixVersions:type",
@@ -1185,9 +1365,14 @@
               "kind": "Content",
               "text": "export type FixVersions = "
             },
+            {
+              "kind": "Reference",
+              "text": "FixVersion",
+              "canonicalReference": "@valiantys/atlassian-app-frontend!FixVersion:interface"
+            },
             {
               "kind": "Content",
-              "text": "{\n    description: string;\n    id: string;\n    name: string;\n    releaseDate?: string;\n    released: boolean;\n    self: string;\n}[]"
+              "text": "[]"
             },
             {
               "kind": "Content",
@@ -1199,7 +1384,7 @@
           "name": "FixVersions",
           "typeTokenRange": {
             "startIndex": 1,
-            "endIndex": 2
+            "endIndex": 3
           }
         },
         {
@@ -3853,6 +4038,34 @@
                 "endIndex": 2
               }
             },
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@valiantys/atlassian-app-frontend!Project#lead:member",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "lead?: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "User",
+                  "canonicalReference": "@valiantys/atlassian-app-frontend!User:interface"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": true,
+              "releaseTag": "Public",
+              "name": "lead",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              }
+            },
             {
               "kind": "PropertySignature",
               "canonicalReference": "@valiantys/atlassian-app-frontend!Project#name:member",
@@ -3964,6 +4177,91 @@
           ],
           "extendsTokenRanges": []
         },
+        {
+          "kind": "Interface",
+          "canonicalReference": "@valiantys/atlassian-app-frontend!ProjectProperty:interface",
+          "docComment": "",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export interface ProjectProperty<T> "
+            }
+          ],
+          "fileUrlPath": "../../jira/shared/util-jira-v3-api/src/lib/project.d.ts",
+          "releaseTag": "Public",
+          "typeParameters": [
+            {
+              "typeParameterName": "T",
+              "constraintTokenRange": {
+                "startIndex": 0,
+                "endIndex": 0
+              },
+              "defaultTypeTokenRange": {
+                "startIndex": 0,
+                "endIndex": 0
+              }
+            }
+          ],
+          "name": "ProjectProperty",
+          "preserveMemberOrder": false,
+          "members": [
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@valiantys/atlassian-app-frontend!ProjectProperty#key:member",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "key: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "string"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "key",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              }
+            },
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@valiantys/atlassian-app-frontend!ProjectProperty#value:member",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "value: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "T"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "value",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              }
+            }
+          ],
+          "extendsTokenRanges": []
+        },
         {
           "kind": "Interface",
           "canonicalReference": "@valiantys/atlassian-app-frontend!ProjectVersion:interface",