@gitkraken/provider-apis 0.25.0 → 0.25.1

package/dist/providers/jira/jira.d.ts

@@ -6,6 +6,8 @@ import { IssueProvider } from '../issueProvider';
 import { Provider } from '../provider';
 export declare class Jira extends Provider implements IssueProvider {
     private _resourceUrlCache;
+    private _issueFieldsCache;
+    private getIssueFieldsForResource;
     private getResourceUrl;
     getCurrentUserForResource(input: {
         resourceId: string;

package/dist/providers/jira/jiraHelpers.d.ts

@@ -2,8 +2,9 @@ import { EnterpriseOptions, NumberedPageInput, SetLabelInput } from '../../types
 import { Issue, IssueComponent, IssueTransition, SetIssueInput, SetStatusInput } from '../../types/exportedTypes/issueProvider';
 import { JiraComponent, JiraUser, SetComponentInput } from '../../types/exportedTypes/jira';
 import { ProviderConfig } from '../../types/exportedTypes/types';
-import { JiraComponentStub, JiraIssue, JiraTransition } from '../../types/internalTypes/jira';
-export declare const normalizeIssue: (issue: JiraIssue, resourceUrl: string | null, resourceId?: string) => Issue;
+import { JiraComponentStub, JiraIssueField, JiraIssue, JiraTransition } from '../../types/internalTypes/jira';
+export type JiraIssueFieldNameToId = Record<string, string>;
+export declare const normalizeIssue: (issue: JiraIssue, fields: JiraIssueFieldNameToId | null, resourceUrl: string | null, resourceId?: string) => Issue;
 export declare const normalizeTransition: (transition: JiraTransition) => IssueTransition;
 export declare const normalizeComponentStub: (component: JiraComponentStub) => IssueComponent;
 export declare const normalizeUserURL: (user: JiraUser, resourceUrl: string | null, isServer: boolean) => string;
@@ -15,15 +16,20 @@ export declare const normalizeUser: (user: JiraUser, resourceUrl: string | null,
     username: string;
     url: string;
 };
+export declare const getIssueFields: (config: ProviderConfig, input: {
+    resourceId?: string;
+}, options?: EnterpriseOptions) => Promise<JiraIssueField[]>;
 export declare const getIssue: (config: ProviderConfig, input: {
     resourceId?: string;
     number: string;
+    fields: JiraIssueFieldNameToId | null;
 } & NumberedPageInput, resourceUrl: string | null, options?: EnterpriseOptions) => Promise<{
     data: Issue;
 }>;
 export declare const getIssuesForResourceForCurrentUser: (config: ProviderConfig, input: {
     resourceId?: string;
     labelNames?: string[];
+    fields: JiraIssueFieldNameToId | null;
 } & NumberedPageInput, resourceUrl: string | null, options?: EnterpriseOptions) => Promise<{
     data: Issue[];
     pageInfo: {
@@ -38,6 +44,7 @@ export declare const getIssuesForProject: (config: ProviderConfig, input: {
     authorLogin?: string;
     mentionLogin?: string;
     labelNames?: string[];
+    fields: JiraIssueFieldNameToId | null;
 } & NumberedPageInput, resourceUrl: string | null, options?: EnterpriseOptions) => Promise<{
     data: Issue[];
     pageInfo: {
@@ -52,6 +59,7 @@ export declare const getIssuesForProjects: (config: ProviderConfig, input: {
     authorLogin?: string;
     mentionLogin?: string;
     labelNames?: string[];
+    fields: JiraIssueFieldNameToId | null;
 } & NumberedPageInput, resourceUrl: string | null, options?: EnterpriseOptions) => Promise<{
     data: Issue[];
     pageInfo: {

package/dist/providers/jira/jiraServer.d.ts

@@ -4,6 +4,8 @@ import { SetComponentInput } from '../../types/exportedTypes/jira';
 import { IssueProvider } from '../issueProvider';
 import { EnterpriseProvider } from '../provider';
 export declare class JiraServer extends EnterpriseProvider implements IssueProvider {
+    private _issueFieldsCache;
+    private getIssueFieldsForResource;
     getCurrentUser(options?: EnterpriseOptions): Promise<{
         data: {
             name: string;

package/dist/types/exportedTypes/issueProvider.d.ts

@@ -29,6 +29,22 @@ export interface IssueComponent {
     name: string;
 }
 export type IssueStatusCategory = 'TO_DO' | 'IN_PROGRESS' | 'DONE';
+export type IssueSprint = {
+    id: string;
+    name: string;
+    isActive: boolean;
+    startDate: Date | null;
+    endDate: Date | null;
+    completedDate: Date | null;
+};
+export type IssueFixVersion = {
+    id: string;
+    description: string;
+    name: string;
+    archived: boolean;
+    released: boolean;
+    releaseDate: Date | null;
+};
 export interface Issue {
     author: Account | null;
     assignees: Account[];
@@ -69,6 +85,8 @@ export interface Issue {
     upvoteCount: number | null;
     url: string | null;
     milestone?: GitMilestone | null;
+    sprints?: IssueSprint[];
+    fixVersions?: IssueFixVersion[];
 }
 export interface SetIssueInput {
     id: string;

package/dist/types/internalTypes/jira.d.ts

@@ -40,10 +40,53 @@ export interface JiraIssueStatus {
         self: string;
     };
 }
-export interface JiraIssue {
+export interface JiraIssueField {
+    clauseNames: string[];
+    custom: boolean;
+    id: string;
+    key: string;
+    name: string;
+    navigable: boolean;
+    orderable: boolean;
+    scope?: {
+        type: string;
+        project: {
+            id: string;
+        };
+    };
+    schema?: {
+        type: string;
+        items: string;
+        custom: string;
+        customId: number;
+    };
+    searchable: boolean;
+    untranslatedName?: string;
+}
+export type JiraIssueSprint = {
+    id: string;
+    name: string;
+    state: string;
+    boardId: number;
+    goal: string;
+    startDate: string;
+    endDate: string;
+    completeDate?: string;
+};
+export type JiraFixVersion = {
+    self: string;
+    id: string;
+    description: string;
+    name: string;
+    archived: boolean;
+    released: boolean;
+    releaseDate?: string;
+};
+export type JiraIssue = {
     expand: string;
     fields: {
         components?: JiraComponentStub[];
+        fixVersions: JiraFixVersion[];
         project: {
             avatarUrls: AvatarUrls;
             id: string;
@@ -83,9 +126,9 @@ export interface JiraIssue {
             self: string;
             votes: number;
         };
-    };
+    } & Record<string, unknown>;
     id: string;
     key: string;
     self: string;
     transitions?: JiraTransition[];
-}
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gitkraken/provider-apis",
-  "version": "0.25.0",
+  "version": "0.25.1",
   "description": "An SDK around different third-party APIs that accepts and returns data in a common format.",
   "author": "Axosoft, LLC dba GitKraken",
   "license": "SEE LICENSE IN LICENSE",