@gitkraken/provider-apis 0.6.1

package/CHANGELOG.md

@@ -0,0 +1,112 @@
+# Changelog
+
+## 0.6.1
+
+- fixed filtering by `authorLogin` in `getPullRequestsForRepo` and `getPullRequestsForRepos` (Bitbucket)
+
+## 0.6.0
+
+- added `getBlame` (Github and GitLab)
+- added `getReposForAzureProject` (Azure DevOps)
+- added `getPullRequestsForRepo` (GitLab, Bitbucket, and Azure DevOps)
+- added `getIssuesForRepo` (GitLab)
+- added paging support to the following functions:
+  - `getPullRequestsForRepos` (GitHub, GitLab and Azure DevOps)
+  - `getIssuesForRepos` (GitHub and GitLab)
+  - `getIssuesForAzureProject` (Azure DevOps)
+- added `permission` field to `GitRepository` (GitHub only)
+- fixed incorrect `namespace` field in GitLab `GitRepository` objects
+- changed the type of the `number` field in `GitPullRequest` from `string` to `number`
+
+## 0.5.0
+
+- added `namespace` and `project` fields to `GitRepository` type
+
+### ⚠️ Breaking Changes
+
+- ## All functions now return an object with a `data` property. Functions affected:
+  - `getCurrentUser`
+  - `getCurrentUserForInstance` (Azure DevOps)
+  - `getUserForCommit`
+  - `getAccountForEmail`
+  - `getAccountForUsername`
+  - `getRepo`
+  - `getIssue` (GitLab)
+  - `refreshToken` (Bitbucket)
+
+## 0.4.0
+
+### Providers
+
+- added Jira as a supported provider
+- added Trello as a supported provider
+
+### Functions
+
+- added `getIssuesForProject` for Jira
+- added `getIssuesForBoard` for Trello
+- added `getCurrentUser` for all git providers
+- added `getBranches` for all git providers
+- added `getTags` for all git providers
+- added `updateConfig` for all providers, to allow updating the base config
+- added filtering options to `getPullRequestsForRepos` for GitLab
+- added filtering options to `getIssuesForRepos` for GitLab
+- better `avatarUrl` support for GitHub Enterprise
+
+### Return Types
+
+- added `baseRef` (target branch) to the `GitPullRequest` type
+- GitHub user objects now include `email` if the provided token has the scope needed to obtain it
+
+### Config / Options
+
+- added `config.isPat` and `options.isPat` for better Bitbucket and Azure DevOps support
+
+### Bug Fixes
+
+- fixed GitLab `getPullRequestsForRepos` always returning an empty array
+- fixed Bitbucket `getUserForCommit` throwing an error if the commit author doesn't have an associated Bitbucket account
+
+### ⚠️ Breaking Changes
+
+- Changed the return type of the following functions from an array to an object:
+  - `getRepos` (all git providers)
+  - `getPullRequestsForRepos` (all git providers)
+  - `getIssuesForRepos` (GitHub and GitLab)
+  - `getIssuesForAzureProject` (Azure DevOps)
+- `getUserForCommit`: renamed the input field `sha` to `oid`
+- `config.request`'s options now uses `body: string` instead of `data: any`
+
+## 0.3.0
+
+- added support for `fetch`-like request functions
+- replaced `axios.request` as the default request function. native `fetch` will be used if available, otherwise `node-fetch` will be used.
+- allow `baseUrl` option to be set in the GitProvider constructor
+- added `defaultBranch` to `GitRepository` interface
+- temporarily disabled `email` field for GitHub objects
+- added `getBranches`
+- added `getIssue` for GitLab
+- added `getIssuesForRepos` for GitHub and GitLab
+- added `getIssuesForAzureProject` for Azure DevOps
+- fixed GitHub Enterprise functions
+
+## 0.2.0
+
+- added ability to pass provider tokens to GitProvider constructors as an alternative to passing them to every function call
+- all GitHub functions now support the `baseUrl` option
+- added `getAccountForUsername` (GitHub and GitLab only)
+- fixed a bug affecting multiple GitLab functions
+
+BREAKING:
+
+- updated parameters for `getUserForCommit`
+- replaced `getUserForEmail` with `getAccountForEmail`
+
+## 0.1.0
+
+- support for GitHub, GitLab, Bitbucket, Azure DevOps
+- added `getUserForCommit`
+- added `getUserForEmail` (GitHub and GitLab only)
+- added `getRepo`
+- added `getRepos`
+- added `getPullRequestsForRepos`

package/LICENSE

@@ -0,0 +1,19 @@
+Provider APIs License
+
+Copyright (c) 2014-2023 Axosoft, LLC dba GitKraken ("GitKraken")
+
+This software and associated documentation files (the "Software") may be compiled as part of the gitkraken/vscode-gitlens open source project (the "GitLens") to the extent the Software is a required component of the GitLens; provided, however, that the Software and its functionality may only be used if you (and any entity that you represent) have agreed to, and are in compliance with, the GitKraken End User License Agreement, available at https://gitkraken.com/eula (the "EULA"), or other agreement governing the use of the Software, as agreed by you and GitKraken, and otherwise have a valid subscription for the correct number of user seats for the applicable version of the Software (e.g., GitLens Free+, GitLens Pro, GitLens Teams, and GitLens Enterprise) (the “GitKraken Products”).
+
+The Software is licensed, not sold. This license only gives you some rights to use the Software. GitKraken reserves all other rights. Unless applicable law gives you more rights despite this limitation, you may use the Software only as expressly permitted in this license. In doing so, you must comply with any technical limitations in the Software that only allow you to use it in certain ways. You may not (i) work around any technical limitations in the Software, (ii) reverse engineer, decompile or disassemble the Software, or otherwise attempt to derive the source code for the Software, except and to the extent required by third party licensing terms governing use of certain open source components that may be included with the Software, (iii) remove, minimize, block or modify any notices of GitKraken or its suppliers in the Software, (iv) use the software in any way that is against the law, (v) host, share, publish, rent or lease the Software; (vi) distribute the Software as a stand-alone or integrated offering or combine it with any of your applications for others to use, (vii) use the Software other than in connection with validly licensed GitKraken Products or (viii) use any portion of the Software to create software with the same or similar functionality.
+
+You agree that GitKraken and/or its licensors (as applicable) retain all right, title and interest in and to the Software and all modifications and/or patches thereto. You are not granted any other rights beyond what is expressly stated herein. Except as set forth above, it is forbidden to copy, merge, publish, distribute, sublicense, modify and/or sell the Software.
+
+If you give feedback about the Software to GitKraken, you give to GitKraken, without charge, the right to use, share and commercialize your feedback in any way and for any purpose. You will not give feedback that is subject to a license that requires GitKraken to license its software or documentation to third parties because we include your feedback in them. These rights survive this License.
+
+The full text of this Provider APIs License shall be included in all copies or substantial portions of the Software.
+
+This License and the EULA, if applicable, are the entire agreement for the Software. You must comply with all domestic and international export laws and regulations that apply to the Software, which include restrictions on destinations, end users and end use. This License is governed and construed by the laws of the State of Arizona, United States without regard to any choice or conflict of law principles or rules.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL GITKRAKEN, THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+For all third party components incorporated into the Software, those components are licensed under the original license provided by the owner of the applicable component.

package/README.md

@@ -0,0 +1,78 @@
+# provider-apis
+
+[View documenation](/docs/modules.md#default)
+
+## Installation
+
+```
+npm install @@gitkraken/provider-apis
+or
+yarn add @@gitkraken/provider-apis
+```
+
+## Quick Usage
+
+Creating an instance of every provider
+
+```ts
+import ProviderAPIs from '@@gitkraken/provider-apis';
+
+const providerAPIs = ProviderAPIs(config); // returns an object containing an instance of each provider
+
+const repo = await providerAPIs.github.getRepo({ namespace: 'gitkraken', name: 'vscode-gitlens' }, { token: TOKEN });
+```
+
+Creating an instance of a specific provider
+
+```ts
+import { GitHub } from 'provider-apis';
+
+const github = new GitHub(config);
+const repo = await github.getRepo({ namespace: 'gitkraken', name: 'vscode-gitlens' }, { token: TOKEN });
+```
+
+### Authentication
+
+Tokens can be supplied either at construction time or when calling a function. (A token supplied to a function will take priority over one supplied at construction time).
+
+```ts
+const providerAPIs = ProviderAPIS({
+  github: { token: GITHUB_TOKEN },
+  gitlab: { token: GITLAB_TOKEN },
+});
+
+// OR
+
+const github = new GitHub({ token: GITHUB_TOKEN });
+
+// OR
+
+const repo = await github.getRepo({ namespace: 'gitkraken', name: 'vscode-gitlens' }, { token: TOKEN });
+```
+
+## Overwriting the request function
+
+This package allows you to overwrite the function used to make network requests. The function should must either implement `fetch` OR have the following signature:
+
+```ts
+(options: { url: string; method?: string; body?: string; headers?: object }) =>
+  Promise<{
+    status: number;
+    statusText: string;
+    headers: object;
+    body: any;
+  }>;
+```
+
+```ts
+const github = new GitHub({ request: customRequestFn });
+```
+
+## Configuration
+
+All configuration options are optional. All options can be provided either at object creation time or when calling a function as the function's last parameter, with the exception of `request`, which can only be provided at object creation time.
+
+- `request`: The function to use to make network requests
+- `[provider].baseUrl`: The base API endpoint to use (meant for Enterprise support)
+- `[provider].token`: The authentication token to be sent with the request
+- `[provider].isPAT`: Whether or not the provided token is a PAT (as opposed to an OAuth token)

package/dist/defaults.d.ts

@@ -0,0 +1,6 @@
+import nodeFetch from 'node-fetch';
+import { Fetch } from './types';
+declare global {
+    var fetch: Fetch | undefined;
+}
+export declare const defaultRequest: typeof nodeFetch;

package/dist/fetchWrapper.d.ts

@@ -0,0 +1,2 @@
+import { Fetch, RequestFunction } from './types';
+export declare const fetchWrapper: (fetch: Fetch | RequestFunction) => RequestFunction;

package/dist/index.d.ts

@@ -0,0 +1,27 @@
+import { AzureDevOps } from './providers/azureDevops/azureDevOps';
+import { Bitbucket } from './providers/bitbucket/bitbucket';
+import { GitHub } from './providers/github/github';
+import { GitLab } from './providers/gitlab/gitlab';
+import { Jira } from './providers/jira/jira';
+import { Trello } from './providers/trello/trello';
+import { Config } from './types';
+declare const makeProviderAPIs: (config?: Partial<Config>) => {
+    azureDevOps: AzureDevOps;
+    bitbucket: Bitbucket;
+    github: GitHub;
+    gitlab: GitLab;
+    jira: Jira;
+    trello: Trello;
+};
+export default makeProviderAPIs;
+export { AzureDevOps, Bitbucket, GitHub, GitLab };
+export type * from './providers/azureDevops/azureDevOps';
+export type * from './providers/bitbucket/bitbucket';
+export type * from './providers/gitProvider';
+export type * from './providers/github/github';
+export type { FetchIssuesData, FetchPullRequestsData } from './providers/github/githubTypes';
+export type * from './providers/gitlab/gitlab';
+export type * from './providers/issueProvider';
+export type * from './providers/jira/jira';
+export type * from './providers/trello/trello';
+export type * from './types';