@anmiles/google-api-wrapper 2.0.1 → 2.1.0

package/.vscode/settings.json

@@ -1,8 +1,10 @@
 {
 	"cSpell.words": [
 		"anmiles",
+		"Calendarlist",
 		"cicd",
 		"colorette",
+		"Gaxios",
 		"linebreak",
 		"nycrc",
 		"Playlistitems"

package/CHANGELOG.md

@@ -5,6 +5,11 @@ 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).
 
+## [2.0.2](../../tags/v2.0.2) - 2023-03-13
+### Added
+- Calendars list API
+- Export shared `getItems` to use for any other APIs
+
 ## [2.0.1](../../tags/v2.0.1) - 2023-03-12
 ### Changed
 - Fixed exported types

package/package.json

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

package/src/index.ts

@@ -1,4 +1,5 @@
 export * as calendar from './lib/api/calendar';
 export * as youtube from './lib/api/youtube';
+export { getItems } from './lib/api/shared';
 export { createProfile, getProfiles } from './lib/profiles';
 export { login } from './lib/auth';

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

@@ -7,11 +7,11 @@ import apiHelpers from './apiHelpers';
 
 const original = jest.requireActual('../calendar').default as typeof calendar;
 jest.mock<Partial<typeof calendar>>('../calendar', () => ({
-	getAPI : jest.fn().mockImplementation(async () => ({ events : api })),
+	getAPI : jest.fn().mockImplementation(async () => ({ calendarList : calendarsAPI, events : eventsAPI })),
 }));
 
 jest.mock<Partial<typeof shared>>('../shared', () => ({
-	getItems : jest.fn().mockImplementation(async () => events),
+	getItems : jest.fn(),
 }));
 
 jest.mock<Partial<typeof fs>>('fs', () => ({
@@ -20,7 +20,7 @@ jest.mock<Partial<typeof fs>>('fs', () => ({
 
 jest.mock('googleapis', () => ({
 	google : {
-		calendar : jest.fn().mockImplementation(() => ({ events : api })),
+		calendar : jest.fn().mockImplementation(() => ({ calendarList : calendarsAPI, events : eventsAPI })),
 	},
 }));
 
@@ -28,12 +28,27 @@ jest.mock<Partial<typeof auth>>('../../auth', () => ({
 	getAuth : jest.fn().mockImplementation(() => googleAuth),
 }));
 
+const getItemsSpy = jest.spyOn(shared, 'getItems');
+
 const profile = 'username';
 
 const googleAuth = {
 	setCredentials : jest.fn(),
 };
 
+const calendars: Array<{ summary?: string, description?: string, hidden?: boolean }> = [
+	{ summary : 'calendar 1', description : 'calendar 1 description', hidden : false },
+	{ summary : 'calendar 2', description : 'calendar 2 description', hidden : undefined },
+	{ summary : 'calendar 3', description : undefined, hidden : true },
+	{ summary : 'calendar 4', description : undefined, hidden : undefined },
+];
+
+const calendarsResponse = [
+	[ calendars[0], calendars[1] ],
+	null,
+	[ calendars[2], calendars[3] ],
+];
+
 const events: Array<{ summary?: string, source?: { url?: string, title?: string} }> = [
 	{ summary : 'event 1', source : { title : 'source 1', url : 'https://example.com' } },
 	{ summary : 'event 2', source : { title : 'source 2', url : undefined } },
@@ -53,8 +68,8 @@ const pageTokens = [
 	'token2',
 ];
 
-const api  = apiHelpers.getAPI(eventsResponse, pageTokens);
-const args = { timeMin : '2010-01-01T00:00:00', timeMax : '2019-12-31T23:59:59' };
+const calendarsAPI = apiHelpers.getAPI(calendarsResponse, pageTokens);
+const eventsAPI    = apiHelpers.getAPI(eventsResponse, pageTokens);
 
 describe('src/lib/api/calendar', () => {
 	describe('getAPI', () => {
@@ -73,11 +88,43 @@ describe('src/lib/api/calendar', () => {
 		it('should return calendar api', async () => {
 			const result = await original.getAPI(profile);
 
-			expect(result).toEqual({ events : api });
+			expect(result).toEqual({ calendarList : calendarsAPI, events : eventsAPI });
+		});
+	});
+
+	describe('getCalendars', () => {
+		const args = { showHidden : true };
+
+		beforeEach(() => {
+			getItemsSpy.mockResolvedValue(calendars);
+		});
+
+		it('should get api', async () => {
+			await original.getCalendars(profile, args);
+
+			expect(calendar.getAPI).toBeCalledWith(profile);
+		});
+
+		it('should get items', async () => {
+			await original.getCalendars(profile, args);
+
+			expect(getItemsSpy).toBeCalledWith(calendarsAPI, args);
+		});
+
+		it('should return calendars', async () => {
+			const result = await original.getCalendars(profile, args);
+
+			expect(result).toEqual(calendars);
 		});
 	});
 
 	describe('getEvents', () => {
+		const args = { timeMin : '2010-01-01T00:00:00', timeMax : '2019-12-31T23:59:59' };
+
+		beforeEach(() => {
+			getItemsSpy.mockResolvedValue(events);
+		});
+
 		it('should get api', async () => {
 			await original.getEvents(profile, args);
 
@@ -87,7 +134,7 @@ describe('src/lib/api/calendar', () => {
 		it('should get items', async () => {
 			await original.getEvents(profile, args);
 
-			expect(shared.getItems).toBeCalledWith(api, args);
+			expect(getItemsSpy).toBeCalledWith(eventsAPI, args);
 		});
 
 		it('should return events', async () => {
@@ -98,19 +145,19 @@ describe('src/lib/api/calendar', () => {
 	});
 
 	describe('setEvent', () => {
-		const eventId    = 'eventId';
-		const updateArgs = { requestBody : { summary : 'summary' } };
+		const eventId = 'eventId';
+		const args    = { requestBody : { summary : 'summary' } };
 
 		it('should get api', async () => {
-			await original.setEvent(profile, eventId, updateArgs);
+			await original.setEvent(profile, eventId, args);
 
 			expect(calendar.getAPI).toBeCalledWith(profile);
 		});
 
 		it('should set items', async () => {
-			await original.setEvent(profile, eventId, updateArgs);
+			await original.setEvent(profile, eventId, args);
 
-			expect(api.update).toBeCalledWith({ eventId, ...updateArgs });
+			expect(eventsAPI.update).toBeCalledWith({ eventId, ...args });
 		});
 	});
 });

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

@@ -7,11 +7,11 @@ import apiHelpers from './apiHelpers';
 
 const original = jest.requireActual('../youtube').default as typeof youtube;
 jest.mock<Partial<typeof youtube>>('../youtube', () => ({
-	getAPI : jest.fn().mockImplementation(async () => ({ playlistItems : api })),
+	getAPI : jest.fn().mockImplementation(async () => ({ playlistItems : playlistItemsAPI })),
 }));
 
 jest.mock<Partial<typeof shared>>('../shared', () => ({
-	getItems : jest.fn().mockImplementation(async () => playlistItems),
+	getItems : jest.fn(),
 }));
 
 jest.mock<Partial<typeof fs>>('fs', () => ({
@@ -20,7 +20,7 @@ jest.mock<Partial<typeof fs>>('fs', () => ({
 
 jest.mock('googleapis', () => ({
 	google : {
-		youtube : jest.fn().mockImplementation(() => ({ playlistItems : api })),
+		youtube : jest.fn().mockImplementation(() => ({ playlistItems : playlistItemsAPI })),
 	},
 }));
 
@@ -28,6 +28,8 @@ jest.mock<Partial<typeof auth>>('../../auth', () => ({
 	getAuth : jest.fn().mockImplementation(() => googleAuth),
 }));
 
+const getItemsSpy = jest.spyOn(shared, 'getItems');
+
 const profile = 'username';
 
 const googleAuth = {
@@ -53,8 +55,7 @@ const pageTokens = [
 	'token2',
 ];
 
-const api  = apiHelpers.getAPI(playlistItemsResponse, pageTokens);
-const args = { playlistId : 'LL', part : [ 'snippet' ], maxResults : 50 };
+const playlistItemsAPI = apiHelpers.getAPI(playlistItemsResponse, pageTokens);
 
 describe('src/lib/api/youtube', () => {
 	describe('getAPI', () => {
@@ -73,11 +74,17 @@ describe('src/lib/api/youtube', () => {
 		it('should return youtube api', async () => {
 			const result = await original.getAPI(profile);
 
-			expect(result).toEqual({ playlistItems : api });
+			expect(result).toEqual({ playlistItems : playlistItemsAPI });
 		});
 	});
 
 	describe('getPlaylistItems', () => {
+		const args = { playlistId : 'LL', part : [ 'snippet' ], maxResults : 50 };
+
+		beforeEach(() => {
+			getItemsSpy.mockResolvedValue(playlistItems);
+		});
+
 		it('should get api', async () => {
 			await original.getPlaylistItems(profile, args);
 
@@ -87,7 +94,7 @@ describe('src/lib/api/youtube', () => {
 		it('should call getItems', async () => {
 			await original.getPlaylistItems(profile, args);
 
-			expect(shared.getItems).toBeCalledWith(api, args);
+			expect(getItemsSpy).toBeCalledWith(playlistItemsAPI, args);
 		});
 
 		it('should return videos', async () => {

package/src/lib/api/calendar.ts

@@ -4,8 +4,8 @@ import { getAuth } from '../auth';
 import { getItems } from './shared';
 import calendar from './calendar';
 
-export { getAPI, getEvents, setEvent };
-export default { getAPI, getEvents, setEvent };
+export { getAPI, getEvents, getCalendars, setEvent };
+export default { getAPI, getEvents, getCalendars, setEvent };
 
 async function getAPI(profile: string): Promise<GoogleApis.calendar_v3.Calendar> {
 	const googleAuth = await getAuth(profile);
@@ -15,6 +15,12 @@ async function getAPI(profile: string): Promise<GoogleApis.calendar_v3.Calendar>
 		auth    : googleAuth,
 	});
 }
+
+async function getCalendars(profile: string, args: GoogleApis.calendar_v3.Params$Resource$Calendarlist$List) {
+	const api = await calendar.getAPI(profile);
+	return getItems(api.calendarList, args);
+}
+
 async function getEvents(profile: string, args: GoogleApis.calendar_v3.Params$Resource$Events$List) {
 	const api = await calendar.getAPI(profile);
 	return getItems(api.events, args);