@anmiles/google-api-wrapper 11.0.0 → 13.0.0

package/CHANGELOG.md

@@ -5,7 +5,7 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-## [10.0.0](../../tags/v10.0.0) - 2023-05-31
+## [13.0.0](../../tags/v13.0.0) - 2023-05-31
 ### Added
 - Credentials can be revoked. Useful after working with temporary credentials to not let re-use them
 - All existing google APIs are now available

package/dist/index.d.ts

@@ -1,3 +1,3 @@
-export { getApi } from './lib/api';
+export { getAPI } from './lib/api';
 export { createProfile, getProfiles } from './lib/profiles';
 export { login, getAuth } from './lib/auth';

package/dist/index.js

@@ -1,8 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getAuth = exports.login = exports.getProfiles = exports.createProfile = exports.getApi = void 0;
+exports.getAuth = exports.login = exports.getProfiles = exports.createProfile = exports.getAPI = void 0;
 var api_1 = require("./lib/api");
-Object.defineProperty(exports, "getApi", { enumerable: true, get: function () { return api_1.getApi; } });
+Object.defineProperty(exports, "getAPI", { enumerable: true, get: function () { return api_1.getAPI; } });
 var profiles_1 = require("./lib/profiles");
 Object.defineProperty(exports, "createProfile", { enumerable: true, get: function () { return profiles_1.createProfile; } });
 Object.defineProperty(exports, "getProfiles", { enumerable: true, get: function () { return profiles_1.getProfiles; } });

package/dist/lib/api.d.ts

@@ -1,6 +1,6 @@
 import type GoogleApis from 'googleapis';
 import type { AuthOptions, CommonOptions } from '../types';
-type CommonApi<TItem> = {
+type CommonAPI<TItem> = {
     list: {
         (params?: {
             pageToken: string | undefined;
@@ -15,19 +15,19 @@ type CommonResponse<TItem> = {
     };
     nextPageToken?: string | null | undefined;
 };
-declare class Api<TApi extends keyof typeof allApis> {
-    api: ReturnType<typeof allApis[TApi]>;
+declare class API<TKey extends keyof typeof allAPIs> {
+    api: ReturnType<typeof allAPIs[TKey]>;
     private auth;
     private apiName;
     private profile;
     private authOptions?;
-    constructor(apiName: TApi, profile: string, authOptions?: AuthOptions);
+    constructor(apiName: TKey, profile: string, authOptions?: AuthOptions);
     init(): Promise<void>;
-    getItems<TItem>(selectAPI: (api: ReturnType<typeof allApis[TApi]>) => CommonApi<TItem>, params: any, options?: CommonOptions): Promise<TItem[]>;
+    getItems<TItem>(selectAPI: (api: ReturnType<typeof allAPIs[TKey]>) => CommonAPI<TItem>, params: any, options?: CommonOptions): Promise<TItem[]>;
     revoke(): Promise<GoogleApis.Common.GaxiosResponse<import("google-auth-library/build/src/auth/oauth2client").RevokeCredentialsResult>>;
 }
-declare function getApi<TApi extends keyof typeof allApis>(apiName: TApi, profile: string, authOptions?: AuthOptions): Promise<Api<TApi>>;
-declare const allApis: {
+declare function getAPI<TKey extends keyof typeof allAPIs>(apiName: TKey, profile: string, authOptions?: AuthOptions): Promise<API<TKey>>;
+declare const allAPIs: {
     readonly abusiveexperiencereport: (auth: GoogleApis.Common.OAuth2Client) => GoogleApis.abusiveexperiencereport_v1.Abusiveexperiencereport;
     readonly acceleratedmobilepageurl: (auth: GoogleApis.Common.OAuth2Client) => GoogleApis.acceleratedmobilepageurl_v1.Acceleratedmobilepageurl;
     readonly accessapproval: (auth: GoogleApis.Common.OAuth2Client) => GoogleApis.accessapproval_v1.Accessapproval;
@@ -298,9 +298,9 @@ declare const allApis: {
     readonly youtubeAnalytics: (auth: GoogleApis.Common.OAuth2Client) => GoogleApis.youtubeAnalytics_v1.Youtubeanalytics;
     readonly youtubereporting: (auth: GoogleApis.Common.OAuth2Client) => GoogleApis.youtubereporting_v1.Youtubereporting;
 };
-export { getApi };
+export { getAPI };
 declare const _default: {
-    getApi: typeof getApi;
-    Api: typeof Api;
+    getAPI: typeof getAPI;
+    API: typeof API;
 };
 export default _default;

package/dist/lib/api.js

@@ -3,14 +3,14 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getApi = void 0;
+exports.getAPI = void 0;
 const googleapis_1 = require("googleapis");
 const logger_1 = require("@anmiles/logger");
 const sleep_1 = __importDefault(require("@anmiles/sleep"));
 const auth_1 = require("./auth");
 const secrets_1 = require("./secrets");
 const requestInterval = 300;
-class Api {
+class API {
     constructor(apiName, profile, authOptions) {
         this.apiName = apiName;
         this.profile = profile;
@@ -18,7 +18,7 @@ class Api {
     }
     async init() {
         this.auth = await (0, auth_1.getAuth)(this.profile, this.authOptions);
-        this.api = allApis[this.apiName](this.auth);
+        this.api = allAPIs[this.apiName](this.auth);
     }
     async getItems(selectAPI, params, options) {
         var _a, _b;
@@ -53,14 +53,14 @@ class Api {
         return this.auth.revokeCredentials();
     }
 }
-async function getApi(apiName, profile, authOptions) {
-    const instance = new Api(apiName, profile, authOptions);
+async function getAPI(apiName, profile, authOptions) {
+    const instance = new API(apiName, profile, authOptions);
     await instance.init();
     return instance;
 }
-exports.getApi = getApi;
+exports.getAPI = getAPI;
 /* istanbul ignore next */
-const allApis = {
+const allAPIs = {
     abusiveexperiencereport: (auth) => googleapis_1.google.abusiveexperiencereport({ version: 'v1', auth }),
     acceleratedmobilepageurl: (auth) => googleapis_1.google.acceleratedmobilepageurl({ version: 'v1', auth }),
     accessapproval: (auth) => googleapis_1.google.accessapproval({ version: 'v1', auth }),
@@ -332,5 +332,5 @@ const allApis = {
     youtubeAnalytics: (auth) => googleapis_1.google.youtubeAnalytics({ version: 'v1', auth }),
     youtubereporting: (auth) => googleapis_1.google.youtubereporting({ version: 'v1', auth }),
 };
-exports.default = { getApi, Api };
+exports.default = { getAPI, API };
 //# sourceMappingURL=api.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@anmiles/google-api-wrapper",
-  "version": "11.0.0",
+  "version": "13.0.0",
   "description": "Provides quick interface for getting google API data",
   "keywords": [
     "google",

package/src/index.ts

@@ -1,3 +1,3 @@
-export { getApi } from './lib/api';
+export { getAPI } from './lib/api';
 export { createProfile, getProfiles } from './lib/profiles';
 export { login, getAuth } from './lib/auth';

package/src/lib/__tests__/api.test.ts

@@ -50,7 +50,7 @@ const getAPI = <T>(items: Array<Array<T> | null>, pageTokens: Array<string | und
 const args = { key : 'value' };
 
 const profile     = 'username1';
-const calendarApi = {
+const calendarAPI = {
 	calendarList : getAPI(response, pageTokens),
 };
 
@@ -68,7 +68,7 @@ beforeEach(() => {
 
 jest.mock('googleapis', () => ({
 	google : {
-		calendar : jest.fn().mockImplementation(() => calendarApi),
+		calendar : jest.fn().mockImplementation(() => calendarAPI),
 	},
 }));
 
@@ -87,42 +87,42 @@ jest.mock<Partial<typeof logger>>('@anmiles/logger', () => ({
 jest.mock<Partial<typeof sleep>>('@anmiles/sleep', () => jest.fn());
 
 describe('src/lib/api', () => {
-	describe('getApi', () => {
+	describe('getAPI', () => {
 		it('should call getAuth', async () => {
-			await api.getApi('calendar', profile);
+			await api.getAPI('calendar', profile);
 
 			expect(auth.getAuth).toHaveBeenCalledWith(profile, undefined);
 		});
 
 		it('should pass temporariness and scopes', async () => {
-			await api.getApi('calendar', profile, { scopes, temporary : true });
+			await api.getAPI('calendar', profile, { scopes, temporary : true });
 
 			expect(auth.getAuth).toHaveBeenCalledWith(profile, { scopes, temporary : true });
 		});
 
 		it('should get google api', async () => {
-			await api.getApi('calendar', profile);
+			await api.getAPI('calendar', profile);
 
 			expect(google.calendar).toHaveBeenCalledWith({ version : 'v3', auth : googleAuth });
 		});
 
 		it('should return instance wrapper for google api', async () => {
-			const instance = await api.getApi('calendar', profile, { scopes, temporary : true });
+			const instance = await api.getAPI('calendar', profile, { scopes, temporary : true });
 
-			expect(instance).toEqual({ apiName : 'calendar', profile, authOptions : { scopes, temporary : true }, api : calendarApi, auth : googleAuth });
+			expect(instance).toEqual({ apiName : 'calendar', profile, authOptions : { scopes, temporary : true }, api : calendarAPI, auth : googleAuth });
 		});
 	});
 
-	describe('Api', () => {
-		let instance: InstanceType<typeof api.Api<'calendar'>>;
+	describe('API', () => {
+		let instance: InstanceType<typeof api.API<'calendar'>>;
 
 		beforeEach(async () => {
-			instance = await api.getApi('calendar', profile);
+			instance = await api.getAPI('calendar', profile);
 		});
 
 		describe('constructor', () => {
 			it('should return instance', async () => {
-				const instance = new api.Api('calendar', profile, { scopes, temporary : true });
+				const instance = new api.API('calendar', profile, { scopes, temporary : true });
 
 				expect(instance).toEqual({ apiName : 'calendar', profile, authOptions : { scopes, temporary : true } });
 			});
@@ -133,7 +133,7 @@ describe('src/lib/api', () => {
 				await instance.getItems((api) => api.calendarList, args);
 
 				pageTokens.forEach((pageToken) => {
-					expect(calendarApi.calendarList.list).toHaveBeenCalledWith({ ...args, pageToken });
+					expect(calendarAPI.calendarList.list).toHaveBeenCalledWith({ ...args, pageToken });
 				});
 			});
 

package/src/lib/api.ts

@@ -8,7 +8,7 @@ import { deleteCredentials } from './secrets';
 
 const requestInterval = 300;
 
-type CommonApi<TItem> = {
+type CommonAPI<TItem> = {
 	list: {
 		(params?: { pageToken: string | undefined }, options?: GoogleApis.Common.MethodOptions): Promise<GoogleApis.Common.GaxiosResponse<CommonResponse<TItem>>>;
 		(callback: (err: Error | null, res?: GoogleApis.Common.GaxiosResponse<CommonResponse<TItem>> | null) => void): void;
@@ -23,15 +23,15 @@ type CommonResponse<TItem> = {
 	nextPageToken?: string | null | undefined
 };
 
-class Api<TApi extends keyof typeof allApis> {
-	api: ReturnType<typeof allApis[TApi]>;
+class API<TKey extends keyof typeof allAPIs> {
+	api: ReturnType<typeof allAPIs[TKey]>;
 	private auth: GoogleApis.Common.OAuth2Client;
 
-	private apiName: TApi;
+	private apiName: TKey;
 	private profile: string;
 	private authOptions?: AuthOptions;
 
-	constructor(apiName: TApi, profile: string, authOptions?: AuthOptions) {
+	constructor(apiName: TKey, profile: string, authOptions?: AuthOptions) {
 		this.apiName     = apiName;
 		this.profile     = profile;
 		this.authOptions = authOptions;
@@ -39,10 +39,10 @@ class Api<TApi extends keyof typeof allApis> {
 
 	async init() {
 		this.auth = await getAuth(this.profile, this.authOptions);
-		this.api  = allApis[this.apiName](this.auth) as ReturnType<typeof allApis[TApi]>;
+		this.api  = allAPIs[this.apiName](this.auth) as ReturnType<typeof allAPIs[TKey]>;
 	}
 
-	async getItems<TItem>(selectAPI: (api: ReturnType<typeof allApis[TApi]>) => CommonApi<TItem>, params: any, options?: CommonOptions): Promise<TItem[]> {
+	async getItems<TItem>(selectAPI: (api: ReturnType<typeof allAPIs[TKey]>) => CommonAPI<TItem>, params: any, options?: CommonOptions): Promise<TItem[]> {
 		const items: TItem[] = [];
 
 		let pageToken: string | null | undefined = undefined;
@@ -81,14 +81,14 @@ class Api<TApi extends keyof typeof allApis> {
 	}
 }
 
-async function getApi<TApi extends keyof typeof allApis>(apiName: TApi, profile: string, authOptions?: AuthOptions): Promise<Api<TApi>> {
-	const instance = new Api<TApi>(apiName, profile, authOptions);
+async function getAPI<TKey extends keyof typeof allAPIs>(apiName: TKey, profile: string, authOptions?: AuthOptions): Promise<API<TKey>> {
+	const instance = new API<TKey>(apiName, profile, authOptions);
 	await instance.init();
 	return instance;
 }
 
 /* istanbul ignore next */
-const allApis = {
+const allAPIs = {
 	abusiveexperiencereport          : (auth: GoogleApis.Common.OAuth2Client) => google.abusiveexperiencereport({ version : 'v1', auth }),
 	acceleratedmobilepageurl         : (auth: GoogleApis.Common.OAuth2Client) => google.acceleratedmobilepageurl({ version : 'v1', auth }),
 	accessapproval                   : (auth: GoogleApis.Common.OAuth2Client) => google.accessapproval({ version : 'v1', auth }),
@@ -361,5 +361,5 @@ const allApis = {
 	youtubereporting                 : (auth: GoogleApis.Common.OAuth2Client) => google.youtubereporting({ version : 'v1', auth }),
 } as const;
 
-export { getApi };
-export default { getApi, Api };
+export { getAPI };
+export default { getAPI, API };