@valiantys/atlassian-app 3.2.0-alpha-1

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

@@ -0,0 +1,111 @@
+## 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 JiraIssueService {
+    // Warning: (ae-forgotten-export) The symbol "AtlassianProductFetchService" needs to be exported by the entry point data-access-issue.d.ts
+    constructor(fetchSvc: AtlassianProductFetchService<'jira'>);
+    // (undocumented)
+    addIssueComment(issueIdOrKey: string, body: AtlassianDocumentFormat): Promise<IssueComment>;
+    // Warning: (ae-forgotten-export) The symbol "WorklogCreateRequest" needs to be exported by the entry point data-access-issue.d.ts
+    // Warning: (ae-forgotten-export) The symbol "Worklog" needs to be exported by the entry point data-access-issue.d.ts
+    //
+    // (undocumented)
+    addWorklog(issueIdOrKey: string, worklog: WorklogCreateRequest): Promise<Worklog>;
+    // Warning: (ae-forgotten-export) The symbol "CreateIssue" needs to be exported by the entry point data-access-issue.d.ts
+    // Warning: (ae-forgotten-export) The symbol "CreatedIssue" needs to be exported by the entry point data-access-issue.d.ts
+    //
+    // (undocumented)
+    createIssue(body: CreateIssue): Promise<CreatedIssue>;
+    // Warning: (ae-forgotten-export) The symbol "IssueLinkRequest" needs to be exported by the entry point data-access-issue.d.ts
+    //
+    // (undocumented)
+    createIssueLink(issueLinkRequest: IssueLinkRequest): Promise<void>;
+    // Warning: (ae-forgotten-export) The symbol "Issue" needs to be exported by the entry point data-access-issue.d.ts
+    //
+    // (undocumented)
+    getIssue(issueIdOrKey: string, fields?: string[], rendered?: boolean): Promise<Issue | undefined>;
+    // Warning: (ae-forgotten-export) The symbol "IssueComment" needs to be exported by the entry point data-access-issue.d.ts
+    //
+    // (undocumented)
+    getIssueCommentById(issueIdOrKey: string, commentId: string): Promise<IssueComment>;
+    // Warning: (ae-forgotten-export) The symbol "JiraCommentResponse" needs to be exported by the entry point data-access-issue.d.ts
+    //
+    // (undocumented)
+    getIssueComments(issueIdOrKey: string, startAt?: number): Promise<JiraCommentResponse>;
+    // (undocumented)
+    getIssueField<T>(issueIdOrKey: string, field: string): Promise<T | undefined>;
+    // Warning: (ae-forgotten-export) The symbol "IssueFields" needs to be exported by the entry point data-access-issue.d.ts
+    //
+    // (undocumented)
+    getIssueFields(issueIdOrKey: string, fields: string[]): Promise<IssueFields | undefined>;
+    // Warning: (ae-forgotten-export) The symbol "IssueTypeDetails" needs to be exported by the entry point data-access-issue.d.ts
+    //
+    // (undocumented)
+    getIssueTypes(): Promise<IssueTypeDetails[]>;
+    // Warning: (ae-forgotten-export) The symbol "PagedResponseWithNextLink" needs to be exported by the entry point data-access-issue.d.ts
+    // Warning: (ae-forgotten-export) The symbol "IssueTypeSchemeExpanded" needs to be exported by the entry point data-access-issue.d.ts
+    //
+    // (undocumented)
+    getIssueTypeSchemes({ maxResults, orderBy, startAt, expand, id, queryString, }?: {
+        maxResults?: number;
+        orderBy?: 'name' | '-name' | '+name' | 'id' | '-id' | '+id';
+        startAt?: number;
+        expand?: 'projects,issueTypes' | 'projects' | 'issueTypes';
+        id?: string[];
+        queryString?: string;
+    }): Promise<PagedResponseWithNextLink<IssueTypeSchemeExpanded>>;
+    // Warning: (ae-forgotten-export) The symbol "IssueTypeSchemeForProjects" needs to be exported by the entry point data-access-issue.d.ts
+    //
+    // (undocumented)
+    getIssueTypeSchemesForProject({ maxResults, startAt, projectId, }?: {
+        maxResults?: number;
+        startAt?: number;
+        projectId?: string[];
+    }): Promise<PagedResponseWithNextLink<IssueTypeSchemeForProjects>>;
+    // Warning: (ae-forgotten-export) The symbol "AtlassianDocumentFormat" needs to be exported by the entry point data-access-issue.d.ts
+    //
+    // (undocumented)
+    issueSearch(jql: string, fields: string[], maxResults?: number): Promise<Issue<AtlassianDocumentFormat>[]>;
+    // (undocumented)
+    issueSearchByPage(jql: string, fields: string[], nextPageToken?: string, maxResults?: number): Promise<{
+        issues: Issue[];
+        nextPageToken?: string;
+    }>;
+    // (undocumented)
+    static readonly issueUrl = "/rest/api/3/issue";
+    // (undocumented)
+    queryForIssuesInProjects(projectIdsOrKeys: string[]): Promise<Issue<AtlassianDocumentFormat>[]>;
+    // Warning: (ae-forgotten-export) The symbol "TransitionIssueRequest" needs to be exported by the entry point data-access-issue.d.ts
+    //
+    // (undocumented)
+    transitionIssue(issueIdOrKey: string, body: TransitionIssueRequest): Promise<void>;
+    // (undocumented)
+    updateField(issueIdOrKey: string, fieldName: string, value: unknown): Promise<void>;
+    // (undocumented)
+    updateFields(issueIdOrKey: string, fields: Record<string, unknown>): Promise<void>;
+    // Warning: (ae-forgotten-export) The symbol "UpdateIssue" needs to be exported by the entry point data-access-issue.d.ts
+    //
+    // (undocumented)
+    updateIssue(issueIdOrKey: string, body: UpdateIssue): Promise<void>;
+    // (undocumented)
+    updateProperty(issueIdOrKey: string, propertyName: string, value: any): Promise<void>;
+}
+
+// @public (undocumented)
+export class JiraRemoteLinksService {
+    constructor(fetchSvc: AtlassianProductFetchService<'jira'>);
+    // (undocumented)
+    deleteRemoteLinkForIssueById(issueIdOrKey: string, linkId: number): Promise<void>;
+    // Warning: (ae-forgotten-export) The symbol "RemoteIssueLink" needs to be exported by the entry point data-access-issue.d.ts
+    //
+    // (undocumented)
+    getRemoteLinksForIssue(issueIdOrKey: string): Promise<RemoteIssueLink[]>;
+}
+
+// (No @packageDocumentation comment for this package)
+
+```

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

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

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

@@ -0,0 +1,471 @@
+declare type APIResponse = Pick<Response, 'json' | 'text' | 'ok' | 'status' | 'statusText' | 'headers'>;
+
+declare interface AtlassianDocumentFormat {
+    type: 'doc';
+    version: number;
+    content: AtlassianDocumentFormatNode[];
+}
+
+declare interface AtlassianDocumentFormatBlockNode {
+    type: string;
+    content: AtlassianDocumentFormatNode[];
+}
+
+declare interface AtlassianDocumentFormatInlineNode {
+    type: string;
+}
+
+declare type AtlassianDocumentFormatNode = AtlassianDocumentFormatInlineNode | AtlassianDocumentFormatBlockNode;
+
+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 interface CreatedIssue {
+    id: string;
+    key: string;
+    self: string;
+    transition?: {
+        status: number;
+        errorCollection?: {
+            errorMessages: string[];
+            errors: unknown;
+        };
+        warningCollection?: {
+            warnings: string[];
+        };
+    };
+}
+
+declare interface CreateIssue {
+    fields: IssueFields<AtlassianDocumentFormat | string>;
+    properties?: {
+        key: string;
+        value: unknown;
+    }[];
+    transition?: IssueTransition;
+    update?: Record<string, Record<string, unknown>[]>;
+    historyMetadata?: HistoryMetadata;
+}
+
+declare type CustomFields = Record<string, unknown>;
+
+declare interface EntityProperty {
+    key: string;
+    value: unknown;
+}
+
+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 FixVersion {
+    description?: string;
+    id: string;
+    name: string;
+    releaseDate?: string;
+    released?: boolean;
+    self?: string;
+}
+
+declare type FixVersions = FixVersion[];
+
+declare interface HistoryMetadata {
+    activityDescription?: string;
+    activityDescriptionKey?: string;
+    actor?: HistoryMetadataParticipant;
+    cause?: HistoryMetadataParticipant;
+    description?: string;
+    descriptionKey?: string;
+    emailDescription?: string;
+    emailDescriptionKey?: string;
+    extraData?: unknown;
+    generator?: HistoryMetadataParticipant;
+    type?: string;
+}
+
+declare interface HistoryMetadataParticipant {
+    avatarUrl: string;
+    displayName: string;
+    displayNameKey: string;
+    id: string;
+    type: string;
+    url: string;
+}
+
+declare interface Issue<T = AtlassianDocumentFormat> {
+    id: string;
+    expand?: string;
+    key: string;
+    self?: string;
+    fields: IssueFields<T>;
+    renderedFields?: IssueFields<string>;
+}
+
+declare type IssueComment = {
+    author: User;
+    body: AtlassianDocumentFormat;
+    created: string;
+    id: string;
+    self: string;
+    updateAuthor: User;
+    updated: string;
+    visibility: Visibility;
+};
+
+declare type IssueFields<T = AtlassianDocumentFormat> = CustomFields & StaticIssueFields<T>;
+
+declare interface IssueLink {
+    id: string;
+    self: string;
+    outwardIssue?: Issue;
+    inwardIssue?: Issue;
+    type: {
+        id: string;
+        name: string;
+        inward: string;
+        outward: string;
+        self: string;
+    };
+}
+
+declare interface IssueLinkRequest {
+    inwardIssue: {
+        id?: string;
+        key?: string;
+    };
+    outwardIssue: {
+        id?: string;
+        key?: string;
+    };
+    comment?: {
+        body: AtlassianDocumentFormat;
+    };
+    type: {
+        id?: string;
+        name?: string;
+    };
+}
+
+declare interface IssueStatus {
+    self: string;
+    description: string;
+    iconUrl: string;
+    name: string;
+    untranslatedName?: string;
+    id: string;
+    statusCategory: {
+        self: string;
+        id: number;
+        key: string;
+        colorName: string;
+        name: string;
+    };
+}
+
+declare interface IssueTransition {
+    id: string;
+    looped?: boolean;
+}
+
+declare interface IssueTypeDetails {
+    avatarId: number;
+    description: string;
+    hierarchyLevel: number;
+    iconUrl: string;
+    id: string;
+    name: string;
+    self: string;
+    subtask: boolean;
+}
+
+declare interface IssueTypeScheme {
+    id: string;
+    name: string;
+    description?: string;
+    defaultIssueTypeId?: string;
+    isDefault: boolean;
+}
+
+declare interface IssueTypeSchemeExpanded extends IssueTypeScheme {
+    issueTypes?: PagedResponse<IssueTypeDetails>;
+    projects?: PagedResponse<Project>;
+}
+
+declare interface IssueTypeSchemeForProjects {
+    issueTypeScheme: IssueTypeScheme;
+    projectIds: string[];
+}
+
+declare type JiraCommentResponse = {
+    comments: IssueComment[];
+    maxResults: number;
+    startAt: number;
+    total: number;
+};
+
+export declare class JiraIssueService {
+    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[], rendered?: boolean): Promise<Issue | undefined>;
+    issueSearch(jql: string, fields: string[], maxResults?: number): Promise<Issue<AtlassianDocumentFormat>[]>;
+    issueSearchByPage(jql: string, fields: string[], nextPageToken?: string, maxResults?: number): Promise<{
+        issues: Issue[];
+        nextPageToken?: string;
+    }>;
+    addWorklog(issueIdOrKey: string, worklog: WorklogCreateRequest): Promise<Worklog>;
+    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>;
+    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>;
+    getIssueTypes(): Promise<IssueTypeDetails[]>;
+    getIssueTypeSchemes({ maxResults, orderBy, startAt, expand, id, queryString, }?: {
+        maxResults?: number;
+        orderBy?: 'name' | '-name' | '+name' | 'id' | '-id' | '+id';
+        startAt?: number;
+        expand?: 'projects,issueTypes' | 'projects' | 'issueTypes';
+        id?: string[];
+        queryString?: string;
+    }): Promise<PagedResponseWithNextLink<IssueTypeSchemeExpanded>>;
+    getIssueTypeSchemesForProject({ maxResults, startAt, projectId, }?: {
+        maxResults?: number;
+        startAt?: number;
+        projectId?: string[];
+    }): Promise<PagedResponseWithNextLink<IssueTypeSchemeForProjects>>;
+}
+
+export declare class JiraRemoteLinksService {
+    private readonly fetchSvc;
+    constructor(fetchSvc: AtlassianProductFetchService<'jira'>);
+    getRemoteLinksForIssue(issueIdOrKey: string): Promise<RemoteIssueLink[]>;
+    deleteRemoteLinkForIssueById(issueIdOrKey: string, linkId: number): Promise<void>;
+}
+
+declare interface PagedResponse<T> {
+    startAt: number;
+    isLast: boolean;
+    maxResults: number;
+    total: number;
+    values: T[];
+}
+
+declare interface PagedResponseWithNextLink<T> extends PagedResponse<T> {
+    nextPage?: string;
+}
+
+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 RemoteIssueLink {
+    application?: {
+        name?: string;
+        type?: string;
+    };
+    globalId?: string;
+    id?: number;
+    object: {
+        icon?: {
+            title?: string;
+            url16x16?: string;
+        };
+        status?: {
+            icon?: {
+                link?: string;
+                title?: string;
+                url16x16?: string;
+            };
+            resolved?: boolean;
+        };
+        summary?: string;
+        title: string;
+        url: string;
+    };
+    relationship?: string;
+    self?: string;
+}
+
+declare type RequestProductMethod = (url: FetchRoute, init: RequestInit) => Promise<APIResponse>;
+
+declare interface StaticIssueFields<T = AtlassianDocumentFormat> {
+    statuscategorychangedate?: string;
+    fixVersions?: FixVersions;
+    resolution?: unknown;
+    worklog?: {
+        total: number;
+        startAt: number;
+        maxResults: number;
+        worklogs: Worklog[];
+    };
+    issuetype?: {
+        self?: string;
+        id: string;
+        description?: string;
+        iconUrl?: string;
+        name?: string;
+        subtask?: boolean;
+        avatarId?: number;
+        hierarchyLevel?: number;
+    };
+    timespent?: number;
+    project?: Project;
+    aggregatetimespent?: number;
+    resolutiondate?: string;
+    lastViewed?: string;
+    priority?: {
+        self: string;
+        iconUrl: string;
+        name: string;
+        id: string;
+    };
+    labels?: string[];
+    timeestimate?: number;
+    workratio?: number;
+    watches?: {
+        self: string;
+        watchCount: number;
+        isWatching: boolean;
+    };
+    created?: string;
+    updated?: string;
+    description?: T;
+    timetracking?: {
+        remainingEstimate: string;
+        timeSpent: string;
+        remainingEstimateSeconds: number;
+        timeSpentSeconds: number;
+    };
+    summary?: string;
+    status?: IssueStatus;
+    creator?: User;
+    assignee?: User;
+    reporter?: User;
+    issuelinks?: IssueLink[];
+    components?: {
+        id: string;
+        name: string;
+    }[];
+}
+
+declare interface TransitionIssueRequest {
+    fields?: any;
+    historyMetadata?: HistoryMetadata;
+    properties?: EntityProperty[];
+    transition: IssueTransition;
+    update?: any;
+}
+
+declare type UpdateIssue = CreateIssue;
+
+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;
+}
+
+declare type Visibility = {
+    identifier: string;
+    type: string;
+    value: string;
+};
+
+declare interface Worklog extends WorklogCreateRequest {
+    self: string;
+    id: string;
+    author: User;
+    created: string;
+    issueId: string;
+    updateAuthor: User;
+    updated: string;
+}
+
+/**
+ * A comment about the worklog in Atlassian Document Format. Optional when creating or updating a worklog.
+ */
+declare interface WorklogComment {
+    type: 'doc';
+    version: 1;
+    content: [
+        {
+        type: 'paragraph';
+        content: [
+            {
+            type: 'text';
+            text: string;
+        }
+        ];
+    }
+    ];
+}
+
+declare interface WorklogCreateRequest {
+    comment?: WorklogComment;
+    properties?: EntityProperty[];
+    started: string;
+    timeSpent?: string;
+    timeSpentSeconds?: number;
+    visibility?: {
+        identifier: string;
+        type: string;
+        value: string;
+    };
+}
+
+export { }

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

@@ -0,0 +1,6 @@
+import { JiraIssueService as i } from "../atlassian/jira/shared/data-access-issue/src/lib/jira-issue-service/index.es.js";
+import { JiraRemoteLinksService as m } from "../atlassian/jira/shared/data-access-issue/src/lib/jira-remote-links-service/index.es.js";
+export {
+  i as JiraIssueService,
+  m as JiraRemoteLinksService
+};

package/data-access-issue/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"
+    }
+  ]
+}