@gitkraken/provider-apis 0.20.0 → 0.21.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (23) hide show
  1. package/CHANGELOG.md +40 -0
  2. package/dist/index.d.ts +3 -1
  3. package/dist/index.js +152 -152
  4. package/dist/providerUtils/azureDevops.d.ts +2 -2
  5. package/dist/providerUtils/bitbucket.d.ts +2 -2
  6. package/dist/providerUtils/bitbucketServer.d.ts +2 -2
  7. package/dist/providerUtils/entityIdentifiers/entityIdentifier.d.ts +5 -0
  8. package/dist/providerUtils/entityIdentifiers/providerEntityIdentifiers/azureDevopsIssueEntityIdentifier.d.ts +9 -0
  9. package/dist/providerUtils/entityIdentifiers/providerEntityIdentifiers/azureDevopsPullRequestEntityIdentifier.d.ts +9 -0
  10. package/dist/providerUtils/entityIdentifiers/providerEntityIdentifiers/bitbucketIssueEntityIdentifier.d.ts +9 -0
  11. package/dist/providerUtils/entityIdentifiers/providerEntityIdentifiers/bitbucketPullRequestEntityIdentifier.d.ts +9 -0
  12. package/dist/providerUtils/entityIdentifiers/providerEntityIdentifiers/githubIssueEntityIdentifier.d.ts +9 -0
  13. package/dist/providerUtils/entityIdentifiers/providerEntityIdentifiers/githubPullRequestEntityIdentifier.d.ts +9 -0
  14. package/dist/providerUtils/entityIdentifiers/providerEntityIdentifiers/gitlabIssueEntityIdentifier.d.ts +9 -0
  15. package/dist/providerUtils/entityIdentifiers/providerEntityIdentifiers/gitlabPullRequestEntityIdentifier.d.ts +9 -0
  16. package/dist/providerUtils/entityIdentifiers/providerEntityIdentifiers/jiraIssueEntityIdentifier.d.ts +9 -0
  17. package/dist/providerUtils/entityIdentifiers/providerEntityIdentifiers/trelloIssueEntityIdentifier.d.ts +9 -0
  18. package/dist/providerUtils/github.d.ts +0 -2
  19. package/dist/providerUtils/gitlab.d.ts +2 -2
  20. package/dist/providerUtils/jira.d.ts +2 -2
  21. package/dist/providerUtils/trello.d.ts +2 -1
  22. package/dist/types/exportedTypes/types.d.ts +37 -0
  23. package/package.json +1 -1
@@ -1,2 +1,2 @@
1
- export declare const getIssueUniqueId: (organizationName: string, projectId: string, issueId: string, domain?: string) => string;
2
- export declare const getPullRequestUniqueId: (organizationName: string, projectId: string, repoId: string, pullRequestId: string, domain?: string) => string;
1
+ declare const _default: {};
2
+ export default _default;
@@ -1,2 +1,2 @@
1
- export declare const getIssueUniqueId: (repoId: string, issueId: string) => string;
2
- export declare const getPullRequestUniqueId: (repoId: string, pullRequestId: string) => string;
1
+ declare const _default: {};
2
+ export default _default;
@@ -1,2 +1,2 @@
1
- export declare const getIssueUniqueId: (repoId: string, issueId: string, domain: string) => string;
2
- export declare const getPullRequestUniqueId: (repoId: string, pullRequestId: string, domain: string) => string;
1
+ declare const _default: {};
2
+ export default _default;
@@ -0,0 +1,5 @@
1
+ import { EntityIdentifier, EntityIdentifierProviderType, EntityType } from '../../types/exportedTypes/types';
2
+ export declare const validate: (entityIdentifier: EntityIdentifier) => void;
3
+ export declare const encode: (entityIdentifier: EntityIdentifier) => string;
4
+ export declare const decode: (entityID: string) => EntityIdentifier;
5
+ export declare const decodeV0: (provider: EntityIdentifierProviderType, entityType: EntityType, entityID: string) => EntityIdentifier;
@@ -0,0 +1,9 @@
1
+ import { EntityIdentifier, EntityIdentifierInterface } from '../../../types/exportedTypes/types';
2
+ type AzureIssueEntityIdentifierInput = Pick<EntityIdentifier, 'organizationName' | 'projectId' | 'entityId' | 'domain'>;
3
+ export declare class AzureDevopsIssueEntityIdentifier implements EntityIdentifierInterface {
4
+ constructor();
5
+ validate(entityIdentifier: AzureIssueEntityIdentifierInput): void;
6
+ encode(entityIdentifier: AzureIssueEntityIdentifierInput): string;
7
+ decode(entityFields: string[]): EntityIdentifier;
8
+ }
9
+ export {};
@@ -0,0 +1,9 @@
1
+ import { EntityIdentifier, EntityIdentifierInterface } from '../../../types/exportedTypes/types';
2
+ type AzurePullRequestEntityIdentifierInput = Pick<EntityIdentifier, 'organizationName' | 'projectId' | 'repoId' | 'entityId' | 'domain'>;
3
+ export declare class AzureDevopsPullRequestEntityIdentifier implements EntityIdentifierInterface {
4
+ constructor();
5
+ validate(entityIdentifier: AzurePullRequestEntityIdentifierInput): void;
6
+ encode(entityIdentifier: AzurePullRequestEntityIdentifierInput): string;
7
+ decode(entityFields: string[]): EntityIdentifier;
8
+ }
9
+ export {};
@@ -0,0 +1,9 @@
1
+ import { EntityIdentifier, EntityIdentifierInterface } from '../../../types/exportedTypes/types';
2
+ type BitbucketIssueEntityIdentifierInput = Pick<EntityIdentifier, 'repoId' | 'entityId' | 'domain'>;
3
+ export declare class BitbucketIssueEntityIdentifier implements EntityIdentifierInterface {
4
+ constructor();
5
+ validate(entityIdentifier: BitbucketIssueEntityIdentifierInput): void;
6
+ encode(entityIdentifier: BitbucketIssueEntityIdentifierInput): string;
7
+ decode(entityFields: string[]): EntityIdentifier;
8
+ }
9
+ export {};
@@ -0,0 +1,9 @@
1
+ import { EntityIdentifier, EntityIdentifierInterface } from '../../../types/exportedTypes/types';
2
+ type BitbucketPullRequestEntityIdentifierInput = Pick<EntityIdentifier, 'repoId' | 'entityId' | 'domain'>;
3
+ export declare class BitbucketPullRequestEntityIdentifier implements EntityIdentifierInterface {
4
+ constructor();
5
+ validate(entityIdentifier: BitbucketPullRequestEntityIdentifierInput): void;
6
+ encode(entityIdentifier: BitbucketPullRequestEntityIdentifierInput): string;
7
+ decode(entityFields: string[]): EntityIdentifier;
8
+ }
9
+ export {};
@@ -0,0 +1,9 @@
1
+ import { EntityIdentifier, EntityIdentifierInterface } from '../../../types/exportedTypes/types';
2
+ type GithubIssueEntityIdentifierInput = Pick<EntityIdentifier, 'entityId' | 'domain'>;
3
+ export declare class GithubIssueEntityIdentifier implements EntityIdentifierInterface {
4
+ constructor();
5
+ validate(entityIdentifier: GithubIssueEntityIdentifierInput): void;
6
+ encode(entityIdentifier: GithubIssueEntityIdentifierInput): string;
7
+ decode(entityFields: string[]): EntityIdentifier;
8
+ }
9
+ export {};
@@ -0,0 +1,9 @@
1
+ import { EntityIdentifier, EntityIdentifierInterface } from '../../../types/exportedTypes/types';
2
+ type GithubPullRequestEntityIdentifierInput = Pick<EntityIdentifier, 'entityId' | 'domain'>;
3
+ export declare class GithubPullRequestEntityIdentifier implements EntityIdentifierInterface {
4
+ constructor();
5
+ validate(entityIdentifier: GithubPullRequestEntityIdentifierInput): void;
6
+ encode(entityIdentifier: GithubPullRequestEntityIdentifierInput): string;
7
+ decode(entityFields: string[]): EntityIdentifier;
8
+ }
9
+ export {};
@@ -0,0 +1,9 @@
1
+ import { EntityIdentifier, EntityIdentifierInterface } from '../../../types/exportedTypes/types';
2
+ type GitlabIssueEntityIdentifierInput = Pick<EntityIdentifier, 'entityId' | 'domain'>;
3
+ export declare class GitlabIssueEntityIdentifier implements EntityIdentifierInterface {
4
+ constructor();
5
+ validate(entityIdentifier: GitlabIssueEntityIdentifierInput): void;
6
+ encode(entityIdentifier: GitlabIssueEntityIdentifierInput): string;
7
+ decode(entityFields: string[]): EntityIdentifier;
8
+ }
9
+ export {};
@@ -0,0 +1,9 @@
1
+ import { EntityIdentifier, EntityIdentifierInterface } from '../../../types/exportedTypes/types';
2
+ type GitlabPullRequestEntityIdentifierInput = Pick<EntityIdentifier, 'entityId' | 'domain'>;
3
+ export declare class GitlabPullRequestEntityIdentifier implements EntityIdentifierInterface {
4
+ constructor();
5
+ validate(entityIdentifier: GitlabPullRequestEntityIdentifierInput): void;
6
+ encode(entityIdentifier: GitlabPullRequestEntityIdentifierInput): string;
7
+ decode(entityFields: string[]): EntityIdentifier;
8
+ }
9
+ export {};
@@ -0,0 +1,9 @@
1
+ import { EntityIdentifier, EntityIdentifierInterface } from '../../../types/exportedTypes/types';
2
+ type JiraIssueEntityIdentifierInput = Pick<EntityIdentifier, 'resourceId' | 'projectId' | 'entityId' | 'domain'>;
3
+ export declare class JiraIssueEntityIdentifier implements EntityIdentifierInterface {
4
+ constructor();
5
+ validate(entityIdentifier: JiraIssueEntityIdentifierInput): void;
6
+ encode(entityIdentifier: JiraIssueEntityIdentifierInput): string;
7
+ decode(entityFields: string[]): EntityIdentifier;
8
+ }
9
+ export {};
@@ -0,0 +1,9 @@
1
+ import { EntityIdentifier, EntityIdentifierInterface } from '../../../types/exportedTypes/types';
2
+ type TrelloIssueEntityIdentifierInput = Pick<EntityIdentifier, 'accountOrOrgId' | 'projectId' | 'entityId' | 'domain'>;
3
+ export declare class TrelloIssueEntityIdentifier implements EntityIdentifierInterface {
4
+ constructor();
5
+ validate(entityIdentifier: TrelloIssueEntityIdentifierInput): void;
6
+ encode(entityIdentifier: TrelloIssueEntityIdentifierInput): string;
7
+ decode(entityFields: string[]): EntityIdentifier;
8
+ }
9
+ export {};
@@ -1,4 +1,2 @@
1
1
  import { GitPullRequest } from '../index';
2
- export declare const getIssueUniqueId: (issueGraphqlId: string, domain?: string) => string;
3
- export declare const getPullRequestUniqueId: (pullRequestGraphqlId: string, domain?: string) => string;
4
2
  export declare const getPullRequestRank: (pr: GitPullRequest, currentUsersGithubDatabaseId: string, isFromMentionedFilter: boolean) => number;
@@ -1,2 +1,2 @@
1
- export declare const getIssueUniqueId: (issueGraphqlId: string, domain?: string) => string;
2
- export declare const getPullRequestUniqueId: (pullRequestGraphqlId: string, domain?: string) => string;
1
+ declare const _default: {};
2
+ export default _default;
@@ -1,2 +1,2 @@
1
- export declare const getIssueUniqueId: (resourceId: string, projectId: string, issueId: string) => string;
2
- export declare const getJiraServerIssueUniqueId: (projectId: string, issueId: string, domain: string) => string;
1
+ declare const _default: {};
2
+ export default _default;
@@ -1 +1,2 @@
1
- export declare const getIssueUniqueId: (accountOrOrgId: string, projectId: string, issueId: string, domain?: string) => string;
1
+ declare const _default: {};
2
+ export default _default;
@@ -89,6 +89,43 @@ export interface PullRequestBucket {
89
89
  priority: number;
90
90
  pullRequests: PullRequestWithUniqueID[];
91
91
  }
92
+ export declare enum EntityVersion {
93
+ Zero = "0",
94
+ One = "1"
95
+ }
96
+ export declare enum EntityType {
97
+ PullRequest = "0",
98
+ Issue = "1"
99
+ }
100
+ export declare enum EntityIdentifierProviderType {
101
+ Azure = "0",
102
+ Github = "1",
103
+ GithubEnterprise = "2",
104
+ Gitlab = "3",
105
+ GitlabSelfHosted = "4",
106
+ Bitbucket = "5",
107
+ BitbucketServer = "6",
108
+ Jira = "7",
109
+ JiraServer = "8",
110
+ Trello = "9"
111
+ }
112
+ export type EntityIdentifier = {
113
+ provider: EntityIdentifierProviderType;
114
+ entityType: EntityType;
115
+ version: EntityVersion;
116
+ domain: string | null;
117
+ resourceId: string | null;
118
+ accountOrOrgId: string | null;
119
+ organizationName: string | null;
120
+ projectId: string | null;
121
+ repoId: string | null;
122
+ entityId: string;
123
+ };
124
+ export interface EntityIdentifierInterface {
125
+ encode(entityIdentifier: EntityIdentifier): string;
126
+ decode(entityFields: string[]): EntityIdentifier;
127
+ validate(entityIdentifier: EntityIdentifier): void;
128
+ }
92
129
  export type EnrichedItemsByUniqueId = {
93
130
  [uuid: string]: EnrichedItem[];
94
131
  };
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@gitkraken/provider-apis",
3
- "version": "0.20.0",
3
+ "version": "0.21.0",
4
4
  "description": "An SDK around different third-party APIs that accepts and returns data in a common format.",
5
5
  "author": "Axosoft, LLC dba GitKraken",
6
6
  "license": "SEE LICENSE IN LICENSE",