@gitkraken/provider-apis 0.14.1 → 0.15.0

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

@@ -0,0 +1,115 @@
+export interface AvatarUrls {
+    '16x16': string;
+    '24x24': string;
+    '32x32': string;
+    '48x48': string;
+}
+export interface JiraUser {
+    accountId?: string;
+    accountType: string;
+    active: boolean;
+    avatarUrls: AvatarUrls;
+    displayName: string;
+    emailAddress: string;
+    key?: string;
+    self: string;
+    timeZone: string;
+    name?: string;
+}
+export interface JiraTransition {
+    id: string;
+    name: string;
+    to: {
+        self: string;
+        description: string;
+        iconUrl: string;
+        name: string;
+        id: string;
+        statusCategory: {
+            self: string;
+            id: number;
+            key: string;
+            colorName: string;
+            name: string;
+        };
+    };
+    hasScreen: boolean;
+    isGlobal: boolean;
+    isInitial: boolean;
+    isAvailable: boolean;
+    isConditional: boolean;
+    isLooped: boolean;
+}
+export interface JiraComponentStub {
+    description?: string;
+    id: string;
+    name: string;
+    self: string;
+}
+export interface JiraComponent {
+    ari?: string;
+    assignee?: JiraUser;
+    assigneeType: string;
+    description?: string;
+    id: string;
+    isAssigneeTypeValid: boolean;
+    lead?: JiraUser;
+    leadUserName?: string;
+    metadata?: unknown;
+    name: string;
+    project: string;
+    projectId: string;
+    realAssignee?: JiraUser;
+    realAssigneeType: string;
+    self: string;
+}
+export interface JiraIssueStatus {
+    name: string;
+    statusCategory: {
+        colorName: string;
+        id: number;
+        key: string;
+        name: 'To Do' | 'In Progress' | 'Done';
+        self: string;
+    };
+}
+export interface JiraIssue {
+    expand: string;
+    fields: {
+        components?: JiraComponentStub[];
+        status: JiraIssueStatus;
+        assignee?: JiraUser;
+        comment: {
+            comments: {
+                author: JiraUser;
+                body: string;
+                created: string;
+                id: string;
+                jsdPublic: boolean;
+                self: string;
+                updateAuthor: JiraUser;
+            }[];
+            maxResults: number;
+            self: string;
+            startAt: number;
+            total: number;
+        };
+        created: string;
+        creator: JiraUser;
+        issuetype: {
+            name: string;
+        };
+        labels?: string[];
+        summary: string;
+        updated: string;
+        votes: {
+            hasVoted: boolean;
+            self: string;
+            votes: number;
+        };
+    };
+    id: string;
+    key: string;
+    self: string;
+    transitions?: JiraTransition[];
+}

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

@@ -1,5 +1,4 @@
 import { EnterpriseOptions } from '../gitProvider';
-import { Issue } from '../issueProvider';
 import { EnterpriseProvider } from '../provider';
 export interface JiraServerProject {
     id: string;
@@ -13,6 +12,7 @@ export declare class JiraServer extends EnterpriseProvider {
             avatarUrl: string;
             id: string;
             username: string;
+            url: null;
         };
     }>;
     getJiraProjects(options?: EnterpriseOptions): Promise<{
@@ -27,13 +27,21 @@ export declare class JiraServer extends EnterpriseProvider {
         authorLogin?: string;
         mentionLogin?: string;
     }, options?: EnterpriseOptions): Promise<{
-        data: Issue[];
+        data: import("../issueProvider").Issue[];
     }>;
     setIssueStatus(input: {
         issueId: string;
         status: string;
     }, options?: EnterpriseOptions): Promise<void>;
-    getLabels(options: EnterpriseOptions): Promise<{
+    setIssueLabels(input: {
+        issueId: string;
+        labelNames: string[];
+    }, options?: EnterpriseOptions): Promise<void>;
+    setIssueComponents(input: {
+        issueId: string;
+        componentIds: string[];
+    }, options?: EnterpriseOptions): Promise<void>;
+    getLabels(options?: EnterpriseOptions): Promise<{
         data: {
             color: null;
             description: null;
@@ -41,4 +49,9 @@ export declare class JiraServer extends EnterpriseProvider {
             name: string;
         }[];
     }>;
+    getComponentsForJiraProject(input: {
+        projectIdOrKey: string;
+    }, options?: EnterpriseOptions): Promise<{
+        data: import("../jira/sharedTypes").JiraComponent[];
+    }>;
 }

package/dist/providers/trello/trello.d.ts

@@ -34,6 +34,7 @@ export declare class Trello extends Provider {
             avatarUrl: string | null;
             id: string;
             username: string;
+            url: string;
         };
     }>;
     getBoardsForCurrentUser(input: {
@@ -55,6 +56,7 @@ export declare class Trello extends Provider {
             username: string;
             email: null;
             avatarUrl: null;
+            url: null;
         }[];
     }>;
     getIssuesForBoard(input: {

package/dist/types.d.ts

@@ -76,3 +76,5 @@ export type PagedResult<T> = {
     pageInfo: CursorPageInfo | NumberedPageInfo;
     data: T[];
 };
+export type FullFieldMap<T> = Record<keyof T, boolean>;
+export type FieldMap<T> = Partial<FullFieldMap<T>>;

package/dist/utils.d.ts

@@ -1 +1,11 @@
+import { FieldMap } from './types';
 export declare const getRequestHeaders: (token?: string, basicAuth?: boolean) => Record<string, string>;
+export declare const toFieldMap: <T, K extends keyof T = keyof T>(fields?: K[] | undefined) => Partial<import("./types").FullFieldMap<T>> | undefined;
+/**
+ * Returns providerQueryString if requestedFields is undefined or if any of the normalized fields depend on the query string.
+ * @param requestedFields
+ * @param normalizedFields
+ * @param providerQueryString
+ * @returns string
+ */
+export declare const fieldQuery: <T>(requestedFields: Partial<import("./types").FullFieldMap<T>> | undefined, normalizedFields: (keyof T)[], providerQueryString: string) => string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gitkraken/provider-apis",
-  "version": "0.14.1",
+  "version": "0.15.0",
   "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",