fix: types of octokit

Author: technote-space

__tests__/api-helper1.test.ts

@@ -1,8 +1,8 @@
 /* eslint-disable no-magic-numbers */
 import nock from 'nock';
 import path from 'path';
-import {Utils} from '../src';
 import {
+  getOctokit,
   disableNetConnect,
   testEnv,
   getContext,
@@ -13,9 +13,10 @@ import {
   exportVariableCalledWith,
 } from '@technote-space/github-action-test-helper';
 import {Logger} from '@technote-space/github-action-log-helper';
-import {GitCreateCommitResponseData} from '@octokit/types';
+import {components} from '@octokit/openapi-types';
 import {ApiHelper} from '../src';
 
+type GitCreateCommitResponseData = components['schemas']['git-commit'];
 const rootDir = path.resolve(__dirname, 'fixtures');
 const context = getContext({
   ref: 'refs/heads/test',
@@ -32,7 +33,7 @@ const context = getContext({
     number: 123,
   },
 });
-const octokit = Utils.getOctokit('test-token');
+const octokit = getOctokit();
 const logger  = new Logger();
 
 const createCommitResponse: GitCreateCommitResponseData = {
@@ -162,6 +163,7 @@ describe('ApiHelper', () => {
 
       const commit = await helper.createCommit('test commit message', {
         sha: 'tree-sha',
+        truncated: true,
         tree: [],
         url: '',
       });
@@ -198,6 +200,7 @@ describe('ApiHelper', () => {
       }), logger);
       const commit = await helper.createCommit('test commit message', {
         sha: 'tree-sha',
+        truncated: true,
         tree: [],
         url: '',
       });

__tests__/api-helper2.test.ts

@@ -1,8 +1,8 @@
 /* eslint-disable no-magic-numbers */
 import nock from 'nock';
 import path from 'path';
-import {Utils} from '../src';
 import {
+  getOctokit,
   disableNetConnect,
   testEnv,
   getContext,
@@ -11,9 +11,10 @@ import {
   stdoutCalledWith,
 } from '@technote-space/github-action-test-helper';
 import {Logger} from '@technote-space/github-action-log-helper';
-import {GitCreateCommitResponseData} from '@octokit/types';
+import {components} from '@octokit/openapi-types';
 import {ApiHelper} from '../src';
 
+type GitCreateCommitResponseData = components['schemas']['git-commit'];
 const rootDir = path.resolve(__dirname, 'fixtures');
 const context = getContext({
   ref: 'refs/heads/test',
@@ -33,7 +34,7 @@ const context = getContext({
     },
   },
 });
-const octokit = Utils.getOctokit('test-token');
+const octokit = getOctokit();
 const logger  = new Logger();
 
 const createCommitResponse: GitCreateCommitResponseData = {

__tests__/utils2.test.ts

@@ -2,8 +2,8 @@
 import {testEnv} from '@technote-space/github-action-test-helper';
 import {Utils} from '../src';
 
-const {generateNewPatchVersion, generateNewMinorVersion, generateNewMajorVersion, arrayChunk, versionCompare, isCommandDebug, isOutputDebug} = Utils;
-const {isBranch, isTagRef, normalizeRef, trimRef, getTag, getRefspec, getRemoteRefspec, getLocalRefspec, getOctokit, replaceVariables, mask} = Utils;
+const {generateNewPatchVersion, generateNewMinorVersion, generateNewMajorVersion, arrayChunk, versionCompare, isCommandDebug, isOutputDebug, mask}    = Utils;
+const {isBranch, isTagRef, normalizeRef, trimRef, getTag, getRefspec, getRemoteRefspec, getLocalRefspec, getOctokit, replaceVariables, ensureNotNull} = Utils;
 
 jest.useFakeTimers();
 
@@ -319,3 +319,14 @@ describe('isOutputDebug', () => {
     expect(isOutputDebug()).toBe(false);
   });
 });
+
+describe('ensureNotNull', () => {
+  it('should return value', () => {
+    expect(ensureNotNull('test')).toBe('test');
+  });
+
+  it('should return empty string', () => {
+    expect(ensureNotNull(null)).toBe('');
+    expect(ensureNotNull(undefined)).toBe('');
+  });
+});

package.json

@@ -36,6 +36,7 @@
   "dependencies": {
     "@actions/core": "^1.2.6",
     "@actions/github": "^4.0.0",
+    "@octokit/openapi-types": "^2.0.0",
     "@octokit/plugin-rest-endpoint-methods": "^4.4.1",
     "@technote-space/github-action-log-helper": "^0.1.9",
     "shell-escape": "^0.2.0",

src/api-helper.ts

@@ -3,24 +3,23 @@ import path from 'path';
 import {Context} from '@actions/github/lib/context';
 import {PaginateInterface} from '@octokit/plugin-paginate-rest';
 import {RestEndpointMethods} from '@octokit/plugin-rest-endpoint-methods/dist-types/generated/method-types';
-import {
-  OctokitResponse,
-  GitGetCommitResponseData,
-  PullsGetResponseData,
-  GitCreateTreeResponseData,
-  GitCreateCommitResponseData,
-  GitGetRefResponseData,
-  PullsListResponseData,
-  PullsCreateResponseData,
-  PullsUpdateResponseData,
-  GitListMatchingRefsResponseData,
-} from '@octokit/types';
+import {OctokitResponse} from '@octokit/types';
+import {components} from '@octokit/openapi-types';
 import {exportVariable} from '@actions/core';
 import {Logger} from '@technote-space/github-action-log-helper';
-import {getRefForUpdate, isPrRef, getBranch, trimRef, versionCompare, generateNewPatchVersion, generateNewMajorVersion, generateNewMinorVersion} from './utils';
+import {getRefForUpdate, isPrRef, getBranch, trimRef, versionCompare, generateNewPatchVersion, generateNewMajorVersion, generateNewMinorVersion, ensureNotNull} from './utils';
 import {getSender} from './context-helper';
 import {Octokit} from './types';
 
+type GitGetCommitResponseData = components['schemas']['git-commit'];
+type PullsGetResponseData = components['schemas']['pull-request'];
+type GitCreateTreeResponseData = components['schemas']['git-tree'];
+type GitCreateCommitResponseData = components['schemas']['git-commit'];
+type GitGetRefResponseData = components['schemas']['git-ref'];
+type PullsListResponseData = components['schemas']['pull-request-simple'];
+type PullsCreateResponseData = components['schemas']['pull-request'];
+type PullsUpdateResponseData = components['schemas']['pull-request'];
+
 type PullsUpdateParams = {
   body?: string;
   draft?: boolean;
@@ -163,18 +162,18 @@ export default class ApiHelper {
   /**
    * @param {string} rootDir root dir
    * @param {object} files files
-   * @return {Promise<{ path: string, sha: string }[]>} blobs
+   * @return {Promise<Array<{ path: string, sha: string }>>} blobs
    */
-  public filesToBlobs = async(rootDir: string, files: Array<string>): Promise<{ path: string; sha: string }[]> => await Promise.all(Object.values(files).map(file => this.createBlob(rootDir, file)));
+  public filesToBlobs = async(rootDir: string, files: Array<string>): Promise<Array<{ path: string; sha: string }>> => await Promise.all(files.map(file => this.createBlob(rootDir, file)));
 
   /**
-   * @param {{ path: string, sha: string }[]} blobs blobs
+   * @param {Array<{ path: string, sha: string }>} blobs blobs
    * @return {Promise<GitCreateTreeResponseData>} tree
    */
-  public createTree = async(blobs: { path: string; sha: string }[]): Promise<GitCreateTreeResponseData> => this.getResponseData((this.octokit as RestEndpointMethods).git.createTree({
+  public createTree = async(blobs: Array<{ path: string; sha: string }>): Promise<GitCreateTreeResponseData> => this.getResponseData((this.octokit as RestEndpointMethods).git.createTree({
     ...this.context.repo,
     'base_tree': (await this.getCommit()).tree.sha,
-    tree: Object.values(blobs).map(blob => ({
+    tree: blobs.map(blob => ({
       path: blob.path,
       type: 'blob',
       mode: '100644',
@@ -220,7 +219,7 @@ export default class ApiHelper {
       await (this.octokit as RestEndpointMethods).git.updateRef({
         ...this.context.repo,
         ref: refName,
-        sha: commit.sha,
+        sha: ensureNotNull(commit.sha),
         force,
       });
 
@@ -245,7 +244,7 @@ export default class ApiHelper {
     await (this.octokit as RestEndpointMethods).git.createRef({
       ...this.context.repo,
       ref: refName,
-      sha: commit.sha,
+      sha: ensureNotNull(commit.sha),
     });
   };
 
@@ -264,7 +263,7 @@ export default class ApiHelper {
    * @param {string} branchName branch name
    * @return {Promise<PullsListResponseData | null>} pull request
    */
-  public findPullRequest = async(branchName: string): Promise<PullsListResponseData[number] | null> => {
+  public findPullRequest = async(branchName: string): Promise<PullsListResponseData | null> => {
     const response = await (this.octokit as RestEndpointMethods).pulls.list({
       ...this.context.repo,
       head: `${this.context.repo.owner}:${getBranch(branchName, false)}`,
@@ -278,9 +277,9 @@ export default class ApiHelper {
 
   /**
    * @param {PullsListParams} params params
-   * @return {AsyncIterable<PullsListResponseData>} pull request list
+   * @return {AsyncIterable<Array<PullsListResponseData>>} pull request list
    */
-  public pullsList = (params: PullsListParams): Promise<PullsListResponseData> => (this.octokit.paginate as PaginateInterface)(
+  public pullsList = (params: PullsListParams): Promise<Array<PullsListResponseData>> => (this.octokit.paginate as PaginateInterface)(
     (this.octokit as RestEndpointMethods).pulls.list,
     Object.assign({
       sort: 'created',
@@ -403,10 +402,10 @@ export default class ApiHelper {
   private isProtectedBranchError = (error: Error): boolean => /required status checks?.* (is|are) expected/i.test(error.message);
 
   /**
-   * @param {string[]} files files
+   * @param {Array<string>} files files
    * @return {boolean} diff?
    */
-  private checkDiff = (files: string[]): boolean => {
+  private checkDiff = (files: Array<string>): boolean => {
     if (!files.length) {
       this.callLogger(logger => logger.info('There is no diff.'));
       return false;
@@ -418,10 +417,10 @@ export default class ApiHelper {
   /**
    * @param {string} rootDir root dir
    * @param {string} commitMessage commit message
-   * @param {string[]} files files
+   * @param {Array<string>} files files
    * @return {Promise<GitCreateCommitResponseData>} commit
    */
-  private prepareCommit = async(rootDir: string, commitMessage: string, files: string[]): Promise<GitCreateCommitResponseData> => {
+  private prepareCommit = async(rootDir: string, commitMessage: string, files: Array<string>): Promise<GitCreateCommitResponseData> => {
     this.callLogger(logger => logger.startProcess('Creating blobs...'));
     const blobs = await this.filesToBlobs(rootDir, files);
 
@@ -435,10 +434,10 @@ export default class ApiHelper {
   /**
    * @param {string} rootDir root dir
    * @param {string} commitMessage commit message
-   * @param {string[]} files files
+   * @param {Array<string>} files files
    * @return {Promise<boolean>} result
    */
-  public commit = async(rootDir: string, commitMessage: string, files: string[]): Promise<boolean> => {
+  public commit = async(rootDir: string, commitMessage: string, files: Array<string>): Promise<boolean> => {
     if (!this.checkDiff(files)) {
       return false;
     }
@@ -459,12 +458,12 @@ export default class ApiHelper {
   /**
    * @param {string} rootDir root dir
    * @param {string} commitMessage commit message
-   * @param {string[]} files files
+   * @param {Array<string>} files files
    * @param {string} createBranchName branch name
    * @param {PullsCreateParams} detail detail
    * @return {Promise<boolean|PullsInfo>} result
    */
-  public createPR = async(rootDir: string, commitMessage: string, files: string[], createBranchName: string, detail: PullsCreateParams): Promise<boolean | PullsInfo> => {
+  public createPR = async(rootDir: string, commitMessage: string, files: Array<string>, createBranchName: string, detail: PullsCreateParams): Promise<boolean | PullsInfo> => {
     if (!this.checkDiff(files)) {
       return false;
     }
@@ -530,8 +529,8 @@ export default class ApiHelper {
 
     return {
       login: user.login,
-      email: user.email,
-      name: user.name,
+      email: ensureNotNull(user.email),
+      name: ensureNotNull(user.name),
       id: user.id,
     };
   };
@@ -552,7 +551,7 @@ export default class ApiHelper {
       ...this.context.repo,
       ref: 'tags/',
     },
-  )).map((item): string => trimRef((item as GitListMatchingRefsResponseData[number]).ref));
+  )).map((item): string => trimRef(item.ref));
 
   /**
    * @return {Promise<string>} tag

src/utils.ts

@@ -256,3 +256,5 @@ export const replaceVariables = async(string: string, variables: { key: string;
 export const isCommandDebug = (): boolean => getInput('UTILS_COMMAND_DEBUG') === 'true';
 
 export const isOutputDebug = (): boolean => getInput('UTILS_OUTPUT_DEBUG') === 'true';
+
+export const ensureNotNull = (value: string | null | undefined): string => value ?? '';

tsconfig.json

@@ -2,7 +2,7 @@
   "compilerOptions": {
     /* Basic Options */
     // "incremental": true,                   /* Enable incremental compilation */
-    "target": "es6",
+    "target": "ES2019",
     /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017', 'ES2018', 'ES2019' or 'ESNEXT'. */
     "module": "commonjs",
     /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', or 'ESNext'. */

yarn.lock

@@ -717,7 +717,7 @@
   dependencies:
     "@octokit/types" "^6.0.1"
 
-"@octokit/plugin-rest-endpoint-methods@^4.0.0", "@octokit/plugin-rest-endpoint-methods@^4.2.1", "@octokit/plugin-rest-endpoint-methods@^4.4.1":
+"@octokit/plugin-rest-endpoint-methods@^4.0.0", "@octokit/plugin-rest-endpoint-methods@^4.4.1":
   version "4.4.1"
   resolved "https://registry.yarnpkg.com/@octokit/plugin-rest-endpoint-methods/-/plugin-rest-endpoint-methods-4.4.1.tgz#105cf93255432155de078c9efc33bd4e14d1cd63"
   integrity sha512-+v5PcvrUcDeFXf8hv1gnNvNLdm4C0+2EiuWt9EatjjUmfriM1pTMM+r4j1lLHxeBQ9bVDmbywb11e3KjuavieA==
@@ -770,22 +770,22 @@
   dependencies:
     "@sinonjs/commons" "^1.7.0"
 
-"@technote-space/github-action-log-helper@^0.1.8":
-  version "0.1.8"
-  resolved "https://registry.yarnpkg.com/@technote-space/github-action-log-helper/-/github-action-log-helper-0.1.8.tgz#73b8e1d90a3e81f60d122f0988d0ffc8cae04590"
-  integrity sha512-xGXMF18RWPebt92CzgE0F/dKojLJAj1GCoun+BI6OfIWYA9itu+FgGQXHeykniX24v2PvfFtuoyNfll44tKxKQ==
+"@technote-space/github-action-log-helper@^0.1.9":
+  version "0.1.9"
+  resolved "https://registry.yarnpkg.com/@technote-space/github-action-log-helper/-/github-action-log-helper-0.1.9.tgz#dffa42319cb6aee8365bd1240edbe91b65e184dc"
+  integrity sha512-OqxsuOTYctvfZTZETf3CXPwX1/n4BPOyynlufEplTTu73kpEbl9WQDKMDEYyCQPXuSi8x9QyIk6jW/3VTGNsYw==
   dependencies:
     "@actions/core" "^1.2.6"
     sprintf-js "^1.1.2"
 
-"@technote-space/github-action-test-helper@^0.6.4":
-  version "0.6.4"
-  resolved "https://registry.yarnpkg.com/@technote-space/github-action-test-helper/-/github-action-test-helper-0.6.4.tgz#dd8a97666254ba02782320d6a12dfce47d6f332e"
-  integrity sha512-WLzgkL6OjWWiU/mYRmXSj3gFQihu9emdbTWTHo7ymCGBAf+nkrWH0kn+hYeu4AQH+HkKVGSPC2aSqh/NsAJ2VA==
+"@technote-space/github-action-test-helper@^0.6.5":
+  version "0.6.5"
+  resolved "https://registry.yarnpkg.com/@technote-space/github-action-test-helper/-/github-action-test-helper-0.6.5.tgz#cb5a938e09508edce1d5e939d42dfb16276ad895"
+  integrity sha512-yy28r9Ny0yWjKaKZcqxkoGvWPZbKrJ95tWXoG13GSLqDunCBIZqR+hjEshcaG4GL3fCyglM8aHbhTmQWlwLiMA==
   dependencies:
     "@actions/core" "^1.2.6"
     "@actions/github" "^4.0.0"
-    "@octokit/plugin-rest-endpoint-methods" "^4.2.1"
+    "@octokit/plugin-rest-endpoint-methods" "^4.4.1"
     js-yaml "^3.14.0"
 
 "@types/babel__core@^7.0.0", "@types/babel__core@^7.1.7":
@@ -1560,9 +1560,9 @@ copy-descriptor@^0.1.0:
   integrity sha1-Z29us8OZl8LuGsOpJP1hJHSPV40=
 
 core-js@^3.6.1:
-  version "3.8.0"
-  resolved "https://registry.yarnpkg.com/core-js/-/core-js-3.8.0.tgz#0fc2d4941cadf80538b030648bb64d230b4da0ce"
-  integrity sha512-W2VYNB0nwQQE7tKS7HzXd7r2y/y2SVJl4ga6oH/dnaLFzM0o2lB2P3zCkWj5Wc/zyMYjtgd5Hmhk0ObkQFZOIA==
+  version "3.8.1"
+  resolved "https://registry.yarnpkg.com/core-js/-/core-js-3.8.1.tgz#f51523668ac8a294d1285c3b9db44025fda66d47"
+  integrity sha512-9Id2xHY1W7m8hCl8NkhQn5CufmF/WuR30BTRewvCXc1aZd3kMECwNZ69ndLbekKfakw9Rf2Xyc+QR6E7Gg+obg==
 
 [email protected], core-util-is@~1.0.0:
   version "1.0.2"