@anmiles/google-api-wrapper 17.0.9 → 18.0.0

package/src/lib/renderer.ts

@@ -2,8 +2,6 @@ import fs from 'fs';
 import renderer from './renderer';
 import { getTemplateFile } from './paths';
 
-export { templates, renderAuth, renderDone };
-
 const templates = {
 	page  : [ 'css', 'content' ] as const,
 	css   : [ ] as const,
@@ -16,9 +14,9 @@ type TemplateName = keyof typeof templates;
 
 const allHTML = {} as Record<TemplateName, string>;
 
-function renderAuth({ profile, authUrl, scope }: { profile: string, authUrl: string, scope: string[] }) {
+function renderAuth({ profile, authUrl, scope }: { profile : string; authUrl : string; scope : string[] }): string {
 	const scopesList = scope.map((s) => render('scope', {
-		name  : s.split('/').pop() as string,
+		name  : s.split('/').pop()!,
 		title : s.endsWith('.readonly') ? 'Readonly (cannot change or delete your data)' : 'Writable (can change or delete your data)',
 		type  : s.endsWith('.readonly') ? 'readonly' : '',
 	})).join('\n');
@@ -28,26 +26,26 @@ function renderAuth({ profile, authUrl, scope }: { profile: string, authUrl: str
 	return render('page', { css, content });
 }
 
-function renderDone({ profile }: { profile: string }): string {
+function renderDone({ profile }: { profile : string }): string {
 	const css     = render('css', {});
 	const content = render('done', { profile });
 	return render('page', { css, content });
 }
 
 // TODO: Use react
-function render<T extends TemplateName>(templateName: T, values: Record<typeof templates[T][number], string>): string {
+function render<T extends TemplateName>(templateName: T, values: Record<typeof templates[T][number], string | undefined>): string {
 	let html        = renderer.getTemplate(templateName);
-	const allValues = values as Record<typeof templates[TemplateName][number], string>;
+	const allValues = values as Record<typeof templates[TemplateName][number], string | undefined>;
 
 	for (const variable of templates[templateName]) {
-		const value = allValues[variable] || '';
+		const value = allValues[variable] ?? '';
 		html        = html.replace(`\${${variable}}`, value);
 	}
 
 	return html;
 }
 
-function getTemplate(templateName: TemplateName) {
+function getTemplate(templateName: TemplateName): string {
 	if (!(templateName in allHTML)) {
 		const file            = getTemplateFile(templateName);
 		const template        = fs.readFileSync(file).toString();
@@ -57,4 +55,5 @@ function getTemplate(templateName: TemplateName) {
 	return allHTML[templateName];
 }
 
+export { templates, renderAuth, renderDone };
 export default { templates, render, getTemplate, renderAuth, renderDone };

package/src/lib/secrets.ts

@@ -4,16 +4,14 @@ import { open } from 'out-url';
 import enableDestroy from 'server-destroy';
 import type GoogleApis from 'googleapis';
 import { warn } from '@anmiles/logger';
-import type { Secrets, AuthOptions } from '../types';
+import type { Secrets } from '../types/secrets';
+import type { AuthOptions } from '../types/options';
 import '@anmiles/prototypes';
 import { getScopesFile, getSecretsFile, getCredentialsFile } from './paths';
 import { renderAuth, renderDone } from './renderer';
 
 import secrets from './secrets';
 
-export { getSecrets, getCredentials, deleteCredentials };
-export default { getScopes, getSecrets, getCredentials, validateCredentials, createCredentials, deleteCredentials, checkSecrets, getSecretsError, getScopesError };
-
 const port                = 6006;
 const host                = `localhost:${port}`;
 const startURI            = `http://${host}/`;
@@ -24,7 +22,7 @@ const serverRetryInterval = 1000;
 function getScopes(): string[] {
 	const scopesFile = getScopesFile();
 	const scopes     = fs.getJSON<string[]>(scopesFile, () => {
-		throw secrets.getScopesError(scopesFile);
+		throw new Error(secrets.getScopesError(scopesFile));
 	});
 	return scopes;
 }
@@ -32,7 +30,7 @@ function getScopes(): string[] {
 function getSecrets(profile: string): Secrets {
 	const secretsFile   = getSecretsFile(profile);
 	const secretsObject = fs.getJSON<Secrets>(secretsFile, () => {
-		throw secrets.getSecretsError(profile, secretsFile);
+		throw new Error(secrets.getSecretsError(profile, secretsFile));
 	});
 	secrets.checkSecrets(profile, secretsObject, secretsFile);
 	return secretsObject;
@@ -48,12 +46,12 @@ async function getCredentials(profile: string, auth: GoogleApis.Common.OAuth2Cli
 	return fs.getJSONAsync(credentialsFile, async () => {
 		const refreshToken = fs.existsSync(credentialsFile) ? fs.readJSON<GoogleApis.Auth.Credentials>(credentialsFile).refresh_token : undefined;
 		const credentials  = await secrets.createCredentials(profile, auth, options, refreshToken ? undefined : 'consent');
-		// eslint-disable-next-line camelcase
 		return { refresh_token : refreshToken, ...credentials };
 	}, secrets.validateCredentials);
 }
 
-async function validateCredentials(credentials: GoogleApis.Auth.Credentials): Promise<{ isValid: boolean, validationError?: string}> {
+// eslint-disable-next-line @typescript-eslint/require-await -- pass sync function into async context
+async function validateCredentials(credentials: GoogleApis.Auth.Credentials): Promise<{ isValid : boolean; validationError? : string }> {
 	if (!credentials.access_token) {
 		return { isValid : false, validationError : 'Credentials does not have access_token' };
 	}
@@ -74,11 +72,10 @@ async function validateCredentials(credentials: GoogleApis.Auth.Credentials): Pr
 }
 
 async function createCredentials(profile: string, auth: GoogleApis.Auth.OAuth2Client, options?: AuthOptions, prompt?: GoogleApis.Auth.GenerateAuthUrlOpts['prompt']): Promise<GoogleApis.Auth.Credentials> {
-	const scope = options?.scopes || secrets.getScopes();
+	const scope = options?.scopes ?? secrets.getScopes();
 
 	return new Promise((resolve) => {
 		const authUrl = auth.generateAuthUrl({
-			// eslint-disable-next-line camelcase
 			access_type : 'offline',
 			prompt,
 			scope,
@@ -87,7 +84,7 @@ async function createCredentials(profile: string, auth: GoogleApis.Auth.OAuth2Cl
 		const server = http.createServer();
 		enableDestroy(server);
 
-		server.on('request', async (request, response) => {
+		server.on('request', (request, response) => {
 			if (!request.url) {
 				response.end('');
 				return;
@@ -103,8 +100,11 @@ async function createCredentials(profile: string, auth: GoogleApis.Auth.OAuth2Cl
 
 			response.end(renderDone({ profile }));
 			server.destroy();
-			const { tokens } = await auth.getToken(code);
-			resolve(tokens);
+
+			void (async () => {
+				const { tokens } = await auth.getToken(code);
+				resolve(tokens);
+			})();
 		});
 
 		server.on('error', (error: NodeJS.ErrnoException) => {
@@ -115,9 +115,9 @@ async function createCredentials(profile: string, auth: GoogleApis.Auth.OAuth2Cl
 			}
 		});
 
-		server.once('listening', async () => {
+		server.once('listening', () => {
 			warn('Please check your browser for further actions');
-			open(startURI);
+			void open(startURI);
 		});
 
 		server.listen(port);
@@ -132,21 +132,21 @@ function deleteCredentials(profile: string): void {
 	}
 }
 
-function checkSecrets(profile: string, secretsObject: Secrets, secretsFile: string): true | void {
+function checkSecrets(profile: string, secretsObject: Secrets, secretsFile: string): true {
 	if (secretsObject.web.redirect_uris[0] === callbackURI) {
 		return true;
 	}
-	throw `Error in credentials file: redirect URI should be ${callbackURI}.\n${secrets.getSecretsError(profile, secretsFile)}`;
+	throw new Error(`Error in credentials file: redirect URI should be ${callbackURI}.\n${secrets.getSecretsError(profile, secretsFile)}`);
 }
 
-function getScopesError(scopesFile: string) {
+function getScopesError(scopesFile: string): string {
 	return [
 		`File ${scopesFile} not found!`,
 		`This application had to have pre-defined file ${scopesFile} that will declare needed scopes`,
 	].join('\n');
 }
 
-function getSecretsError(profile: string, secretsFile: string) {
+function getSecretsError(profile: string, secretsFile: string): string {
 	return [
 		`File ${secretsFile} not found!`,
 		'Here is how to obtain it:',
@@ -182,3 +182,6 @@ function getSecretsError(profile: string, secretsFile: string) {
 		'Then start this script again',
 	].join('\n');
 }
+
+export { getSecrets, getCredentials, deleteCredentials };
+export default { getScopes, getSecrets, getCredentials, validateCredentials, createCredentials, deleteCredentials, checkSecrets, getSecretsError, getScopesError };

package/src/types/options.ts

@@ -0,0 +1,10 @@
+interface CommonOptions {
+	hideProgress? : boolean;
+}
+
+interface AuthOptions {
+	temporary? : boolean;
+	scopes?    : string[];
+}
+
+export type { CommonOptions, AuthOptions };

package/src/types/secrets.ts

@@ -1,17 +1,13 @@
-export interface Secrets {
+interface Secrets {
 	web: {
-		client_id: `${string}.apps.googleusercontent.com`;
-		project_id: string;
-		auth_uri: 'https://accounts.google.com/o/oauth2/auth';
-		token_uri: 'https://oauth2.googleapis.com/token';
-		auth_provider_x509_cert_url: 'https://www.googleapis.com/oauth2/v1/certs';
-		client_secret: string;
-		redirect_uris: string[];
+		client_id                   : `${string}.apps.googleusercontent.com`;
+		project_id                  : string;
+		auth_uri                    : 'https://accounts.google.com/o/oauth2/auth';
+		token_uri                   : 'https://oauth2.googleapis.com/token';
+		auth_provider_x509_cert_url : 'https://www.googleapis.com/oauth2/v1/certs';
+		client_secret               : string;
+		redirect_uris               : string[];
 	};
 }
 
-export interface AuthOptions {
-	temporary?: boolean;
-	scopes?: string[];
-}
-
+export type { Secrets };

package/tsconfig.build.json

@@ -1,7 +1,7 @@
 {
-	"extends": "./tsconfig.json",
+	"extends" : "./tsconfig.json",
 
-	"exclude": [
+	"exclude" : [
 		"**/__tests__/",
 	],
 }

package/tsconfig.json

@@ -1,12 +1,12 @@
 {
-	"extends": "./node_modules/@anmiles/tsconfig/tsconfig.json",
+	"extends" : "./node_modules/@anmiles/tsconfig/tsconfig.json",
 
-	"compilerOptions": {
-		"rootDir": "./src",
-		"outDir": "./dist",
+	"compilerOptions" : {
+		"rootDir" : "./src",
+		"outDir" : "./dist",
 	},
 
-	"include": [
+	"include" : [
 		"src",
 	],
 }

package/tsconfig.test.json

@@ -1,7 +1,7 @@
 {
-	"extends": "./tsconfig.json",
+	"extends" : "./tsconfig.json",
 
-	"compilerOptions": {
-		"moduleResolution": "Node",
+	"compilerOptions" : {
+		"moduleResolution" : "Node",
 	},
 }

package/.github/workflows/ci.yml

@@ -1,94 +0,0 @@
-name: CI
-
-on:
-  push:
-    branches:
-      - main
-  pull_request:
-  workflow_dispatch:
-
-concurrency:
-  group: "${{ github.workflow }}-${{ github.ref }}"
-  cancel-in-progress: true
-
-jobs:
-  install:
-    runs-on: ubuntu-latest
-    container:
-      image: node:18.14
-    timeout-minutes: 30
-    steps:
-    - uses: actions/checkout@v4
-    - uses: actions/cache@v4
-      with:
-        path: node_modules
-        key: "node_modules-${{ hashFiles('package-lock.json') }}"
-        lookup-only: true
-    - run: npm ci
-
-  build:
-    needs: install
-    runs-on: ubuntu-latest
-    container:
-      image: node:18.14
-    timeout-minutes: 30
-    steps:
-    - uses: actions/checkout@v4
-    - uses: actions/cache@v4
-      with:
-        path: node_modules
-        key: "node_modules-${{ hashFiles('package-lock.json') }}"
-    - run: npm run build:ci
-
-  lint:
-    needs: build
-    runs-on: ubuntu-latest
-    container:
-      image: node:18.14
-    timeout-minutes: 30
-    steps:
-    - uses: actions/checkout@v4
-    - uses: actions/cache@v4
-      with:
-        path: node_modules
-        key: "node_modules-${{ hashFiles('package-lock.json') }}"
-    - run: npm run lint
-
-  test:
-    needs: build
-    runs-on: ubuntu-latest
-    container:
-      image: node:18.14
-    timeout-minutes: 30
-    steps:
-    - uses: actions/checkout@v4
-    - uses: actions/cache@v4
-      with:
-        path: node_modules
-        key: "node_modules-${{ hashFiles('package-lock.json') }}"
-    - uses: actions/cache@v4
-      with:
-        path: coverage
-        key: "coverage-${{ hashFiles('package-lock.json') }}"
-        lookup-only: true
-    - run: npm run test:ci
-
-  coverage:
-    needs:
-    - lint
-    - test
-    runs-on: ubuntu-latest
-    container:
-      image: node:18.14
-    timeout-minutes: 30
-    steps:
-    - uses: actions/checkout@v4
-    - uses: actions/cache@v4
-      with:
-        path: node_modules
-        key: "node_modules-${{ hashFiles('package-lock.json') }}"
-    - uses: actions/cache@v4
-      with:
-        path: coverage
-        key: "coverage-${{ hashFiles('package-lock.json') }}"
-    - run: npm run test:report:coverage

package/dist/types/common.d.ts

@@ -1,4 +0,0 @@
-export interface CommonOptions {
-    hideProgress?: boolean;
-}
-//# sourceMappingURL=common.d.ts.map

package/dist/types/common.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"common.d.ts","sourceRoot":"","sources":["../../src/types/common.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,aAAa;IAC7B,YAAY,CAAC,EAAE,OAAO,CAAA;CACtB"}

package/dist/types/common.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"common.js","sourceRoot":"","sources":["../../src/types/common.ts"],"names":[],"mappings":""}

package/dist/types/index.d.ts

@@ -1,3 +0,0 @@
-export * from './common';
-export * from './secrets';
-//# sourceMappingURL=index.d.ts.map

package/dist/types/index.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/types/index.ts"],"names":[],"mappings":"AAAA,cAAc,UAAU,CAAC;AACzB,cAAc,WAAW,CAAC"}

package/dist/types/index.js

@@ -1,19 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./common"), exports);
-__exportStar(require("./secrets"), exports);
-//# sourceMappingURL=index.js.map

package/dist/types/index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/types/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,2CAAyB;AACzB,4CAA0B"}

package/src/types/common.ts

@@ -1,3 +0,0 @@
-export interface CommonOptions {
-	hideProgress?: boolean
-}

package/src/types/index.ts

@@ -1,2 +0,0 @@
-export * from './common';
-export * from './secrets';