@valiantys/atlassian-app 3.2.0-alpha-1

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

@@ -0,0 +1,41 @@
+## API Report File for "@valiantys/atlassian-app"
+
+> 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'>);
+    // @deprecated (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)
+    projectSearchByKeys(projectKeys: 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,114 @@
+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>;
+    /**
+     * @deprecated Use projectSearchByIds instead.
+     */
+    getAllProjects(): Promise<Project[]>;
+    projectSearchByIds(projectIds: string[]): Promise<Project[]>;
+    projectSearchByKeys(projectKeys: 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-resources/atlassian-app-data-access-resources.api.json

@@ -0,0 +1,515 @@
+{
+  "metadata": {
+    "toolPackage": "@microsoft/api-extractor",
+    "toolVersion": "7.52.8",
+    "schemaVersion": 1011,
+    "oldestForwardsCompatibleVersion": 1001,
+    "tsdocConfig": {
+      "$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json",
+      "noStandardTags": true,
+      "tagDefinitions": [
+        {
+          "tagName": "@alpha",
+          "syntaxKind": "modifier"
+        },
+        {
+          "tagName": "@beta",
+          "syntaxKind": "modifier"
+        },
+        {
+          "tagName": "@defaultValue",
+          "syntaxKind": "block"
+        },
+        {
+          "tagName": "@decorator",
+          "syntaxKind": "block",
+          "allowMultiple": true
+        },
+        {
+          "tagName": "@deprecated",
+          "syntaxKind": "block"
+        },
+        {
+          "tagName": "@eventProperty",
+          "syntaxKind": "modifier"
+        },
+        {
+          "tagName": "@example",
+          "syntaxKind": "block",
+          "allowMultiple": true
+        },
+        {
+          "tagName": "@experimental",
+          "syntaxKind": "modifier"
+        },
+        {
+          "tagName": "@inheritDoc",
+          "syntaxKind": "inline"
+        },
+        {
+          "tagName": "@internal",
+          "syntaxKind": "modifier"
+        },
+        {
+          "tagName": "@label",
+          "syntaxKind": "inline"
+        },
+        {
+          "tagName": "@link",
+          "syntaxKind": "inline",
+          "allowMultiple": true
+        },
+        {
+          "tagName": "@override",
+          "syntaxKind": "modifier"
+        },
+        {
+          "tagName": "@packageDocumentation",
+          "syntaxKind": "modifier"
+        },
+        {
+          "tagName": "@param",
+          "syntaxKind": "block",
+          "allowMultiple": true
+        },
+        {
+          "tagName": "@privateRemarks",
+          "syntaxKind": "block"
+        },
+        {
+          "tagName": "@public",
+          "syntaxKind": "modifier"
+        },
+        {
+          "tagName": "@readonly",
+          "syntaxKind": "modifier"
+        },
+        {
+          "tagName": "@remarks",
+          "syntaxKind": "block"
+        },
+        {
+          "tagName": "@returns",
+          "syntaxKind": "block"
+        },
+        {
+          "tagName": "@sealed",
+          "syntaxKind": "modifier"
+        },
+        {
+          "tagName": "@see",
+          "syntaxKind": "block"
+        },
+        {
+          "tagName": "@throws",
+          "syntaxKind": "block",
+          "allowMultiple": true
+        },
+        {
+          "tagName": "@typeParam",
+          "syntaxKind": "block",
+          "allowMultiple": true
+        },
+        {
+          "tagName": "@virtual",
+          "syntaxKind": "modifier"
+        },
+        {
+          "tagName": "@betaDocumentation",
+          "syntaxKind": "modifier"
+        },
+        {
+          "tagName": "@internalRemarks",
+          "syntaxKind": "block"
+        },
+        {
+          "tagName": "@preapproved",
+          "syntaxKind": "modifier"
+        }
+      ],
+      "supportForTags": {
+        "@alpha": true,
+        "@beta": true,
+        "@defaultValue": true,
+        "@decorator": true,
+        "@deprecated": true,
+        "@eventProperty": true,
+        "@example": true,
+        "@experimental": true,
+        "@inheritDoc": true,
+        "@internal": true,
+        "@label": true,
+        "@link": true,
+        "@override": true,
+        "@packageDocumentation": true,
+        "@param": true,
+        "@privateRemarks": true,
+        "@public": true,
+        "@readonly": true,
+        "@remarks": true,
+        "@returns": true,
+        "@sealed": true,
+        "@see": true,
+        "@throws": true,
+        "@typeParam": true,
+        "@virtual": true,
+        "@betaDocumentation": true,
+        "@internalRemarks": true,
+        "@preapproved": true
+      },
+      "reportUnsupportedHtmlElements": false
+    }
+  },
+  "kind": "Package",
+  "canonicalReference": "@valiantys/atlassian-app!",
+  "docComment": "",
+  "name": "@valiantys/atlassian-app",
+  "preserveMemberOrder": false,
+  "members": [
+    {
+      "kind": "EntryPoint",
+      "canonicalReference": "@valiantys/atlassian-app!",
+      "name": "",
+      "preserveMemberOrder": false,
+      "members": [
+        {
+          "kind": "Interface",
+          "canonicalReference": "@valiantys/atlassian-app!AtlassianUserResource:interface",
+          "docComment": "",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export interface AtlassianUserResource "
+            }
+          ],
+          "fileUrlPath": "../../shared/data-access-resources/src/lib/atlassian-user-resource-service.d.ts",
+          "releaseTag": "Public",
+          "name": "AtlassianUserResource",
+          "preserveMemberOrder": false,
+          "members": [
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@valiantys/atlassian-app!AtlassianUserResource#avatarUrl:member",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "avatarUrl: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "string"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "avatarUrl",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              }
+            },
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@valiantys/atlassian-app!AtlassianUserResource#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!AtlassianUserResource#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!AtlassianUserResource#scopes:member",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "scopes: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "string[]"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "scopes",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              }
+            },
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@valiantys/atlassian-app!AtlassianUserResource#url:member",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "url: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "string"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "url",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              }
+            }
+          ],
+          "extendsTokenRanges": []
+        },
+        {
+          "kind": "Class",
+          "canonicalReference": "@valiantys/atlassian-app!AtlassianUserResourceService:class",
+          "docComment": "",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export declare class AtlassianUserResourceService "
+            }
+          ],
+          "fileUrlPath": "../../shared/data-access-resources/src/lib/atlassian-user-resource-service.d.ts",
+          "releaseTag": "Public",
+          "isAbstract": false,
+          "name": "AtlassianUserResourceService",
+          "preserveMemberOrder": false,
+          "members": [
+            {
+              "kind": "Method",
+              "canonicalReference": "@valiantys/atlassian-app!AtlassianUserResourceService#checkUserChosenResource:member(1)",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "checkUserChosenResource(authToken: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "string"
+                },
+                {
+                  "kind": "Content",
+                  "text": ", resourceId?: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "string"
+                },
+                {
+                  "kind": "Content",
+                  "text": "): "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "Promise",
+                  "canonicalReference": "!Promise:interface"
+                },
+                {
+                  "kind": "Content",
+                  "text": "<{\n        hasChosen: true;\n        resource: {\n            name: string;\n            id: string;\n        };\n    } | {\n        hasChosen: false;\n        resources: {\n            name: string;\n            id: string;\n        }[];\n    }>"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isStatic": false,
+              "returnTypeTokenRange": {
+                "startIndex": 5,
+                "endIndex": 7
+              },
+              "releaseTag": "Public",
+              "isProtected": false,
+              "overloadIndex": 1,
+              "parameters": [
+                {
+                  "parameterName": "authToken",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 1,
+                    "endIndex": 2
+                  },
+                  "isOptional": false
+                },
+                {
+                  "parameterName": "resourceId",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 3,
+                    "endIndex": 4
+                  },
+                  "isOptional": true
+                }
+              ],
+              "isOptional": false,
+              "isAbstract": false,
+              "name": "checkUserChosenResource"
+            },
+            {
+              "kind": "Method",
+              "canonicalReference": "@valiantys/atlassian-app!AtlassianUserResourceService#getAtlassianUserResources:member(1)",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "getAtlassianUserResources(authToken: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "string"
+                },
+                {
+                  "kind": "Content",
+                  "text": "): "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "Promise",
+                  "canonicalReference": "!Promise:interface"
+                },
+                {
+                  "kind": "Content",
+                  "text": "<"
+                },
+                {
+                  "kind": "Reference",
+                  "text": "AtlassianUserResource",
+                  "canonicalReference": "@valiantys/atlassian-app!AtlassianUserResource:interface"
+                },
+                {
+                  "kind": "Content",
+                  "text": "[]>"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isStatic": false,
+              "returnTypeTokenRange": {
+                "startIndex": 3,
+                "endIndex": 7
+              },
+              "releaseTag": "Public",
+              "isProtected": false,
+              "overloadIndex": 1,
+              "parameters": [
+                {
+                  "parameterName": "authToken",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 1,
+                    "endIndex": 2
+                  },
+                  "isOptional": false
+                }
+              ],
+              "isOptional": false,
+              "isAbstract": false,
+              "name": "getAtlassianUserResources"
+            },
+            {
+              "kind": "Property",
+              "canonicalReference": "@valiantys/atlassian-app!AtlassianUserResourceService#userResourcesUrl:member",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "readonly userResourcesUrl = "
+                },
+                {
+                  "kind": "Content",
+                  "text": "\"https://api.atlassian.com/oauth/token/accessible-resources\""
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": true,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "userResourcesUrl",
+              "propertyTypeTokenRange": {
+                "startIndex": 0,
+                "endIndex": 0
+              },
+              "initializerTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "isStatic": false,
+              "isProtected": false,
+              "isAbstract": false
+            }
+          ],
+          "implementsTokenRanges": []
+        }
+      ]
+    }
+  ]
+}