@anmiles/google-api-wrapper 14.0.0 → 14.1.0

package/CHANGELOG.md

@@ -5,6 +5,10 @@ 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).
 
+## [14.1.0](../../tags/v14.1.0) - 2023-08-06
+### Added
+- Filtering profiles
+
 ## [14.0.0](../../tags/v14.0.0) - 2023-06-11
 ### Added
 - Warn if trying to store non-readonly credentials in a file
@@ -21,7 +25,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - All existing google APIs are now available
 ### Changed
 - Single entry point for creating any APIs
-  - BEFORE: 
+  - BEFORE:
 	```
 	import { getCalendarAPI } from '@anmiles/google-api-wrapper';
 	const calendarAPI = getCalendarAPI(profile);
@@ -32,7 +36,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 	const calendarAPI = getAPI('calendar', profile);
 	```
 - Changed signature for `getItems`. Also explicit types are now redundant.
-  - BEFORE: 
+  - BEFORE:
 	```
 	const events = await getItems<GoogleApis.calendar_v3.Schema$Event, GoogleApis.calendar_v3.Params$Resource$Events$List>(calendarAPI.events, { ...args });
 	```

package/dist/index.d.ts

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

package/dist/index.js

@@ -1,11 +1,12 @@
 "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.filterProfiles = 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; } });
 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; } });
+Object.defineProperty(exports, "filterProfiles", { enumerable: true, get: function () { return profiles_1.filterProfiles; } });
 var auth_1 = require("./lib/auth");
 Object.defineProperty(exports, "login", { enumerable: true, get: function () { return auth_1.login; } });
 Object.defineProperty(exports, "getAuth", { enumerable: true, get: function () { return auth_1.getAuth; } });

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;AAAA,iCAAmC;AAA1B,6FAAA,MAAM,OAAA;AACf,2CAA4D;AAAnD,yGAAA,aAAa,OAAA;AAAE,uGAAA,WAAW,OAAA;AACnC,mCAA4C;AAAnC,6FAAA,KAAK,OAAA;AAAE,+FAAA,OAAO,OAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;AAAA,iCAAmC;AAA1B,6FAAA,MAAM,OAAA;AACf,2CAA4E;AAAnE,yGAAA,aAAa,OAAA;AAAE,uGAAA,WAAW,OAAA;AAAE,0GAAA,cAAc,OAAA;AACnD,mCAA4C;AAAnC,6FAAA,KAAK,OAAA;AAAE,+FAAA,OAAO,OAAA"}

package/dist/lib/profiles.d.ts

@@ -1,11 +1,13 @@
 import '@anmiles/prototypes';
-export { getProfiles, setProfiles, createProfile };
+export { getProfiles, setProfiles, createProfile, filterProfiles };
 declare const _default: {
     getProfiles: typeof getProfiles;
     setProfiles: typeof setProfiles;
     createProfile: typeof createProfile;
+    filterProfiles: typeof filterProfiles;
 };
 export default _default;
 declare function getProfiles(): string[];
 declare function setProfiles(profiles: string[]): void;
 declare function createProfile(profile: string): void;
+declare function filterProfiles(profile?: string): string[];

package/dist/lib/profiles.js

@@ -3,12 +3,12 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.createProfile = exports.setProfiles = exports.getProfiles = void 0;
+exports.filterProfiles = exports.createProfile = exports.setProfiles = exports.getProfiles = void 0;
 const fs_1 = __importDefault(require("fs"));
 require("@anmiles/prototypes");
 const paths_1 = require("./paths");
 const profiles_1 = __importDefault(require("./profiles"));
-exports.default = { getProfiles, setProfiles, createProfile };
+exports.default = { getProfiles, setProfiles, createProfile, filterProfiles };
 function getProfiles() {
     const profilesFile = (0, paths_1.getProfilesFile)();
     return fs_1.default.getJSON(profilesFile, () => []);
@@ -31,4 +31,18 @@ function createProfile(profile) {
     profiles_1.default.setProfiles(existingProfiles);
 }
 exports.createProfile = createProfile;
+function filterProfiles(profile) {
+    const existingProfiles = profiles_1.default.getProfiles();
+    if (existingProfiles.length === 0) {
+        throw 'Please `npm run create` at least one profile';
+    }
+    if (!profile) {
+        return existingProfiles;
+    }
+    if (existingProfiles.includes(profile)) {
+        return [profile];
+    }
+    throw `Profile '${profile}' does not exist`;
+}
+exports.filterProfiles = filterProfiles;
 //# sourceMappingURL=profiles.js.map

package/dist/lib/profiles.js.map

@@ -1 +1 @@
-{"version":3,"file":"profiles.js","sourceRoot":"","sources":["../../src/lib/profiles.ts"],"names":[],"mappings":";;;;;;AAAA,4CAAoB;AACpB,+BAA6B;AAC7B,mCAA0C;AAE1C,0DAAkC;AAGlC,kBAAe,EAAE,WAAW,EAAE,WAAW,EAAE,aAAa,EAAE,CAAC;AAE3D,SAAS,WAAW;IACnB,MAAM,YAAY,GAAG,IAAA,uBAAe,GAAE,CAAC;IACvC,OAAO,YAAE,CAAC,OAAO,CAAC,YAAY,EAAE,GAAG,EAAE,CAAC,EAAE,CAAC,CAAC;AAC3C,CAAC;AANQ,kCAAW;AAQpB,SAAS,WAAW,CAAC,QAAkB;IACtC,MAAM,YAAY,GAAG,IAAA,uBAAe,GAAE,CAAC;IACvC,YAAE,CAAC,SAAS,CAAC,YAAY,EAAE,QAAQ,CAAC,CAAC;AACtC,CAAC;AAXqB,kCAAW;AAajC,SAAS,aAAa,CAAC,OAAe;IACrC,IAAI,CAAC,OAAO,EAAE;QACb,MAAM,kFAAkF,CAAC;KACzF;IAED,MAAM,gBAAgB,GAAG,kBAAQ,CAAC,WAAW,EAAE,CAAC;IAEhD,IAAI,gBAAgB,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE;QACvC,OAAO;KACP;IAED,gBAAgB,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAC/B,kBAAQ,CAAC,WAAW,CAAC,gBAAgB,CAAC,CAAC;AACxC,CAAC;AA1BkC,sCAAa"}
+{"version":3,"file":"profiles.js","sourceRoot":"","sources":["../../src/lib/profiles.ts"],"names":[],"mappings":";;;;;;AAAA,4CAAoB;AACpB,+BAA6B;AAC7B,mCAA0C;AAE1C,0DAAkC;AAGlC,kBAAe,EAAE,WAAW,EAAE,WAAW,EAAE,aAAa,EAAE,cAAc,EAAE,CAAC;AAE3E,SAAS,WAAW;IACnB,MAAM,YAAY,GAAG,IAAA,uBAAe,GAAE,CAAC;IACvC,OAAO,YAAE,CAAC,OAAO,CAAC,YAAY,EAAE,GAAG,EAAE,CAAC,EAAE,CAAC,CAAC;AAC3C,CAAC;AANQ,kCAAW;AAQpB,SAAS,WAAW,CAAC,QAAkB;IACtC,MAAM,YAAY,GAAG,IAAA,uBAAe,GAAE,CAAC;IACvC,YAAE,CAAC,SAAS,CAAC,YAAY,EAAE,QAAQ,CAAC,CAAC;AACtC,CAAC;AAXqB,kCAAW;AAajC,SAAS,aAAa,CAAC,OAAe;IACrC,IAAI,CAAC,OAAO,EAAE;QACb,MAAM,kFAAkF,CAAC;KACzF;IAED,MAAM,gBAAgB,GAAG,kBAAQ,CAAC,WAAW,EAAE,CAAC;IAEhD,IAAI,gBAAgB,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE;QACvC,OAAO;KACP;IAED,gBAAgB,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAC/B,kBAAQ,CAAC,WAAW,CAAC,gBAAgB,CAAC,CAAC;AACxC,CAAC;AA1BkC,sCAAa;AA4BhD,SAAS,cAAc,CAAC,OAAgB;IACvC,MAAM,gBAAgB,GAAG,kBAAQ,CAAC,WAAW,EAAE,CAAC;IAEhD,IAAI,gBAAgB,CAAC,MAAM,KAAK,CAAC,EAAE;QAClC,MAAM,8CAA8C,CAAC;KACrD;IAED,IAAI,CAAC,OAAO,EAAE;QACb,OAAO,gBAAgB,CAAC;KACxB;IAED,IAAI,gBAAgB,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE;QACvC,OAAO,CAAE,OAAO,CAAE,CAAC;KACnB;IAED,MAAM,YAAY,OAAO,kBAAkB,CAAC;AAC7C,CAAC;AA5CiD,wCAAc"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@anmiles/google-api-wrapper",
-  "version": "14.0.0",
+  "version": "14.1.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 { createProfile, getProfiles } from './lib/profiles';
+export { createProfile, getProfiles, filterProfiles } from './lib/profiles';
 export { login, getAuth } from './lib/auth';

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

@@ -5,9 +5,10 @@ import paths from '../paths';
 import profiles from '../profiles';
 const original = jest.requireActual('../profiles').default as typeof profiles;
 jest.mock<typeof profiles>('../profiles', () => ({
-	getProfiles   : jest.fn().mockImplementation(() => existingProfiles),
-	setProfiles   : jest.fn(),
-	createProfile : jest.fn(),
+	getProfiles    : jest.fn().mockImplementation(() => existingProfiles),
+	setProfiles    : jest.fn(),
+	createProfile  : jest.fn(),
+	filterProfiles : jest.fn(),
 }));
 
 jest.mock<Partial<typeof fs>>('fs', () => ({
@@ -26,13 +27,13 @@ jest.mock<Partial<typeof paths>>('../paths', () => ({
 	getProfilesFile : jest.fn().mockImplementation(() => profilesFile),
 }));
 
-const json             = { key : 'value' };
-const existingProfiles = [ 'username1', 'username2' ];
-const profilesFile     = 'profilesFile';
-const profile1         = 'username1';
-const profile2         = 'username2';
-const allProfiles      = [ profile1, profile2 ];
+const json         = { key : 'value' };
+const profilesFile = 'profilesFile';
+const profile1     = 'username1';
+const profile2     = 'username2';
+const allProfiles  = [ profile1, profile2 ];
 
+let existingProfiles: string[];
 let existingFiles: string[] = [];
 
 let getJSONSpy: jest.SpyInstance;
@@ -46,7 +47,9 @@ beforeAll(() => {
 beforeEach(() => {
 	getJSONSpy.mockImplementation(() => json);
 	writeJSONSpy.mockImplementation();
-	existingFiles = [];
+
+	existingFiles    = [];
+	existingProfiles = [ 'username1', 'username2' ];
 });
 
 afterAll(() => {
@@ -118,4 +121,40 @@ describe('src/lib/profiles', () => {
 			expect(profiles.setProfiles).toHaveBeenCalledWith([ 'username1', 'username2', 'newProfile' ]);
 		});
 	});
+
+	describe('filterProfiles', () => {
+		it('should get profiles', () => {
+			original.filterProfiles();
+
+			expect(profiles.getProfiles).toHaveBeenCalled();
+		});
+
+		it('should output error if no profiles', () => {
+			existingProfiles = [];
+
+			const func = () => original.filterProfiles();
+
+			expect(func).toThrow('Please `npm run create` at least one profile');
+		});
+
+		it('should output error if profile does not exist', () => {
+			const newProfile = 'newProfile';
+
+			const func = () => original.filterProfiles(newProfile);
+
+			expect(func).toThrow(`Profile '${newProfile}' does not exist`);
+		});
+
+		it('should return array with requested profile if it exists', () => {
+			const found = original.filterProfiles(profile1);
+
+			expect(found).toEqual([ profile1 ]);
+		});
+
+		it('should return all profiles if nothing requested', () => {
+			const found = original.filterProfiles();
+
+			expect(found).toEqual(existingProfiles);
+		});
+	});
 });

package/src/lib/profiles.ts

@@ -4,8 +4,8 @@ import { getProfilesFile } from './paths';
 
 import profiles from './profiles';
 
-export { getProfiles, setProfiles, createProfile };
-export default { getProfiles, setProfiles, createProfile };
+export { getProfiles, setProfiles, createProfile, filterProfiles };
+export default { getProfiles, setProfiles, createProfile, filterProfiles };
 
 function getProfiles(): string[] {
 	const profilesFile = getProfilesFile();
@@ -31,3 +31,21 @@ function createProfile(profile: string): void {
 	existingProfiles.push(profile);
 	profiles.setProfiles(existingProfiles);
 }
+
+function filterProfiles(profile?: string): string[] {
+	const existingProfiles = profiles.getProfiles();
+
+	if (existingProfiles.length === 0) {
+		throw 'Please `npm run create` at least one profile';
+	}
+
+	if (!profile) {
+		return existingProfiles;
+	}
+
+	if (existingProfiles.includes(profile)) {
+		return [ profile ];
+	}
+
+	throw `Profile '${profile}' does not exist`;
+}