@d-zero/google-auth

Google APIの認証のための汎用ライブラリです。各Google APIで必要なOAuth2Clientオブジェクトを生成します。

CLI版

CLIで利用する関数の使用方法と、クレデンシャルファイルの準備、認証方法を解説します。

使用にあたって、Google Cloud ConsoleのAPIとサービスからOAuth 2.0 クライアント IDを（アプリケーションの種類はデスクトップとする）発行し、JSON形式のクレデンシャルファイルをローカルにダウンロードする必要があります。

``shell
yarn add -D @d-zero/google-auth
`

クレデンシャルファイルとスコープを設定します。

`ts
import { authentication } from '@d-zero/google-auth';

const auth: Auth = await authentication(
/**
* クレデンシャルファイル
*
* @type {string}
*/
'./path/to/credential.json',

/**
* スコープ
*
* @type {string[]}
* @see https://developers.google.com/identity/protocols/oauth2/scopes?hl=ja
*/
['https://www.googleapis.com/auth/spreadsheets'],

/**
* オプション（省略可）
*
* @type {AuthenticationOptions}
*/
{
tokenFilePath: './path/to/token.json', // カスタムトークンファイルパス
checkTokenExpiry: true, // トークンの有効期限をチェック
},
);
`

$3

:warning: 実行時にローカルにトークンがない場合、対話形式で認証が要求されます。

`terminal
🔑 [ Authorization (Google Sheets, Google Drive) ]

🔰 Access this URL: https://accounts.google.com/o/oauth2/v2/..(略)..&redirect_uri=http%3A%2F%2Flocalhost

Enter the URL from the redirected page here: |
`

URLにアクセスしブラウザで認証をしたあとに、 http://localhost （OAuth 2.0 クライアント IDを発行の方法に依る）に移動します。
サーバーの応答がなかったりページが表示されませんが、移動した先のURLをそのままコピーして、コマンドに貼り付けてエンターキーを押してください。

型のエクスポート

$3

google-auth-libraryのOAuth2Client型のエイリアスです。

`ts
import type { Auth } from '@d-zero/google-auth';
`

$3

authentication関数の第3引数に渡すオプションの型です。

`ts
type AuthenticationOptions = {
readonly tokenFilePath?: string; // トークンファイルの保存先パス（デフォルト: クレデンシャルファイルと同じディレクトリに.token拡張子で保存）
readonly checkTokenExpiry?: boolean; // トークンの有効期限をチェックするかどうか（デフォルト: false）
};
``