@logto/connector-github 1.0.0 → 1.1.0

package/LICENSE

@@ -1,21 +1,379 @@
-MIT License
-
-Copyright (c) 2022 Silverhand
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+Portions of this software are licensed as follows:
+
+* All content that resides under the "packages/cloud" directory of this repository, if that directory exists, is licensed under the license defined in "packages/cloud/LICENSE" (Elastic-2.0).
+* All third party components incorporated into this software are licensed under the original license provided by the owner of the applicable component.
+* Content outside of the above mentioned directories or restrictions above is available under the "MPL-2.0" license as defined below.
+
+Mozilla Public License Version 2.0
+==================================
+
+1. Definitions
+--------------
+
+1.1. "Contributor"
+    means each individual or legal entity that creates, contributes to
+    the creation of, or owns Covered Software.
+
+1.2. "Contributor Version"
+    means the combination of the Contributions of others (if any) used
+    by a Contributor and that particular Contributor's Contribution.
+
+1.3. "Contribution"
+    means Covered Software of a particular Contributor.
+
+1.4. "Covered Software"
+    means Source Code Form to which the initial Contributor has attached
+    the notice in Exhibit A, the Executable Form of such Source Code
+    Form, and Modifications of such Source Code Form, in each case
+    including portions thereof.
+
+1.5. "Incompatible With Secondary Licenses"
+    means
+
+    (a) that the initial Contributor has attached the notice described
+        in Exhibit B to the Covered Software; or
+
+    (b) that the Covered Software was made available under the terms of
+        version 1.1 or earlier of the License, but not also under the
+        terms of a Secondary License.
+
+1.6. "Executable Form"
+    means any form of the work other than Source Code Form.
+
+1.7. "Larger Work"
+    means a work that combines Covered Software with other material, in
+    a separate file or files, that is not Covered Software.
+
+1.8. "License"
+    means this document.
+
+1.9. "Licensable"
+    means having the right to grant, to the maximum extent possible,
+    whether at the time of the initial grant or subsequently, any and
+    all of the rights conveyed by this License.
+
+1.10. "Modifications"
+    means any of the following:
+
+    (a) any file in Source Code Form that results from an addition to,
+        deletion from, or modification of the contents of Covered
+        Software; or
+
+    (b) any new file in Source Code Form that contains any Covered
+        Software.
+
+1.11. "Patent Claims" of a Contributor
+    means any patent claim(s), including without limitation, method,
+    process, and apparatus claims, in any patent Licensable by such
+    Contributor that would be infringed, but for the grant of the
+    License, by the making, using, selling, offering for sale, having
+    made, import, or transfer of either its Contributions or its
+    Contributor Version.
+
+1.12. "Secondary License"
+    means either the GNU General Public License, Version 2.0, the GNU
+    Lesser General Public License, Version 2.1, the GNU Affero General
+    Public License, Version 3.0, or any later versions of those
+    licenses.
+
+1.13. "Source Code Form"
+    means the form of the work preferred for making modifications.
+
+1.14. "You" (or "Your")
+    means an individual or a legal entity exercising rights under this
+    License. For legal entities, "You" includes any entity that
+    controls, is controlled by, or is under common control with You. For
+    purposes of this definition, "control" means (a) the power, direct
+    or indirect, to cause the direction or management of such entity,
+    whether by contract or otherwise, or (b) ownership of more than
+    fifty percent (50%) of the outstanding shares or beneficial
+    ownership of such entity.
+
+2. License Grants and Conditions
+--------------------------------
+
+2.1. Grants
+
+Each Contributor hereby grants You a world-wide, royalty-free,
+non-exclusive license:
+
+(a) under intellectual property rights (other than patent or trademark)
+    Licensable by such Contributor to use, reproduce, make available,
+    modify, display, perform, distribute, and otherwise exploit its
+    Contributions, either on an unmodified basis, with Modifications, or
+    as part of a Larger Work; and
+
+(b) under Patent Claims of such Contributor to make, use, sell, offer
+    for sale, have made, import, and otherwise transfer either its
+    Contributions or its Contributor Version.
+
+2.2. Effective Date
+
+The licenses granted in Section 2.1 with respect to any Contribution
+become effective for each Contribution on the date the Contributor first
+distributes such Contribution.
+
+2.3. Limitations on Grant Scope
+
+The licenses granted in this Section 2 are the only rights granted under
+this License. No additional rights or licenses will be implied from the
+distribution or licensing of Covered Software under this License.
+Notwithstanding Section 2.1(b) above, no patent license is granted by a
+Contributor:
+
+(a) for any code that a Contributor has removed from Covered Software;
+    or
+
+(b) for infringements caused by: (i) Your and any other third party's
+    modifications of Covered Software, or (ii) the combination of its
+    Contributions with other software (except as part of its Contributor
+    Version); or
+
+(c) under Patent Claims infringed by Covered Software in the absence of
+    its Contributions.
+
+This License does not grant any rights in the trademarks, service marks,
+or logos of any Contributor (except as may be necessary to comply with
+the notice requirements in Section 3.4).
+
+2.4. Subsequent Licenses
+
+No Contributor makes additional grants as a result of Your choice to
+distribute the Covered Software under a subsequent version of this
+License (see Section 10.2) or under the terms of a Secondary License (if
+permitted under the terms of Section 3.3).
+
+2.5. Representation
+
+Each Contributor represents that the Contributor believes its
+Contributions are its original creation(s) or it has sufficient rights
+to grant the rights to its Contributions conveyed by this License.
+
+2.6. Fair Use
+
+This License is not intended to limit any rights You have under
+applicable copyright doctrines of fair use, fair dealing, or other
+equivalents.
+
+2.7. Conditions
+
+Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted
+in Section 2.1.
+
+3. Responsibilities
+-------------------
+
+3.1. Distribution of Source Form
+
+All distribution of Covered Software in Source Code Form, including any
+Modifications that You create or to which You contribute, must be under
+the terms of this License. You must inform recipients that the Source
+Code Form of the Covered Software is governed by the terms of this
+License, and how they can obtain a copy of this License. You may not
+attempt to alter or restrict the recipients' rights in the Source Code
+Form.
+
+3.2. Distribution of Executable Form
+
+If You distribute Covered Software in Executable Form then:
+
+(a) such Covered Software must also be made available in Source Code
+    Form, as described in Section 3.1, and You must inform recipients of
+    the Executable Form how they can obtain a copy of such Source Code
+    Form by reasonable means in a timely manner, at a charge no more
+    than the cost of distribution to the recipient; and
+
+(b) You may distribute such Executable Form under the terms of this
+    License, or sublicense it under different terms, provided that the
+    license for the Executable Form does not attempt to limit or alter
+    the recipients' rights in the Source Code Form under this License.
+
+3.3. Distribution of a Larger Work
+
+You may create and distribute a Larger Work under terms of Your choice,
+provided that You also comply with the requirements of this License for
+the Covered Software. If the Larger Work is a combination of Covered
+Software with a work governed by one or more Secondary Licenses, and the
+Covered Software is not Incompatible With Secondary Licenses, this
+License permits You to additionally distribute such Covered Software
+under the terms of such Secondary License(s), so that the recipient of
+the Larger Work may, at their option, further distribute the Covered
+Software under the terms of either this License or such Secondary
+License(s).
+
+3.4. Notices
+
+You may not remove or alter the substance of any license notices
+(including copyright notices, patent notices, disclaimers of warranty,
+or limitations of liability) contained within the Source Code Form of
+the Covered Software, except that You may alter any license notices to
+the extent required to remedy known factual inaccuracies.
+
+3.5. Application of Additional Terms
+
+You may choose to offer, and to charge a fee for, warranty, support,
+indemnity or liability obligations to one or more recipients of Covered
+Software. However, You may do so only on Your own behalf, and not on
+behalf of any Contributor. You must make it absolutely clear that any
+such warranty, support, indemnity, or liability obligation is offered by
+You alone, and You hereby agree to indemnify every Contributor for any
+liability incurred by such Contributor as a result of warranty, support,
+indemnity or liability terms You offer. You may include additional
+disclaimers of warranty and limitations of liability specific to any
+jurisdiction.
+
+4. Inability to Comply Due to Statute or Regulation
+---------------------------------------------------
+
+If it is impossible for You to comply with any of the terms of this
+License with respect to some or all of the Covered Software due to
+statute, judicial order, or regulation then You must: (a) comply with
+the terms of this License to the maximum extent possible; and (b)
+describe the limitations and the code they affect. Such description must
+be placed in a text file included with all distributions of the Covered
+Software under this License. Except to the extent prohibited by statute
+or regulation, such description must be sufficiently detailed for a
+recipient of ordinary skill to be able to understand it.
+
+5. Termination
+--------------
+
+5.1. The rights granted under this License will terminate automatically
+if You fail to comply with any of its terms. However, if You become
+compliant, then the rights granted under this License from a particular
+Contributor are reinstated (a) provisionally, unless and until such
+Contributor explicitly and finally terminates Your grants, and (b) on an
+ongoing basis, if such Contributor fails to notify You of the
+non-compliance by some reasonable means prior to 60 days after You have
+come back into compliance. Moreover, Your grants from a particular
+Contributor are reinstated on an ongoing basis if such Contributor
+notifies You of the non-compliance by some reasonable means, this is the
+first time You have received notice of non-compliance with this License
+from such Contributor, and You become compliant prior to 30 days after
+Your receipt of the notice.
+
+5.2. If You initiate litigation against any entity by asserting a patent
+infringement claim (excluding declaratory judgment actions,
+counter-claims, and cross-claims) alleging that a Contributor Version
+directly or indirectly infringes any patent, then the rights granted to
+You by any and all Contributors for the Covered Software under Section
+2.1 of this License shall terminate.
+
+5.3. In the event of termination under Sections 5.1 or 5.2 above, all
+end user license agreements (excluding distributors and resellers) which
+have been validly granted by You or Your distributors under this License
+prior to termination shall survive termination.
+
+************************************************************************
+*                                                                      *
+*  6. Disclaimer of Warranty                                           *
+*  -------------------------                                           *
+*                                                                      *
+*  Covered Software is provided under this License on an "as is"       *
+*  basis, without warranty of any kind, either expressed, implied, or  *
+*  statutory, including, without limitation, warranties that the       *
+*  Covered Software is free of defects, merchantable, fit for a        *
+*  particular purpose or non-infringing. The entire risk as to the     *
+*  quality and performance of the Covered Software is with You.        *
+*  Should any Covered Software prove defective in any respect, You     *
+*  (not any Contributor) assume the cost of any necessary servicing,   *
+*  repair, or correction. This disclaimer of warranty constitutes an   *
+*  essential part of this License. No use of any Covered Software is   *
+*  authorized under this License except under this disclaimer.         *
+*                                                                      *
+************************************************************************
+
+************************************************************************
+*                                                                      *
+*  7. Limitation of Liability                                          *
+*  --------------------------                                          *
+*                                                                      *
+*  Under no circumstances and under no legal theory, whether tort      *
+*  (including negligence), contract, or otherwise, shall any           *
+*  Contributor, or anyone who distributes Covered Software as          *
+*  permitted above, be liable to You for any direct, indirect,         *
+*  special, incidental, or consequential damages of any character      *
+*  including, without limitation, damages for lost profits, loss of    *
+*  goodwill, work stoppage, computer failure or malfunction, or any    *
+*  and all other commercial damages or losses, even if such party      *
+*  shall have been informed of the possibility of such damages. This   *
+*  limitation of liability shall not apply to liability for death or   *
+*  personal injury resulting from such party's negligence to the       *
+*  extent applicable law prohibits such limitation. Some               *
+*  jurisdictions do not allow the exclusion or limitation of           *
+*  incidental or consequential damages, so this exclusion and          *
+*  limitation may not apply to You.                                    *
+*                                                                      *
+************************************************************************
+
+8. Litigation
+-------------
+
+Any litigation relating to this License may be brought only in the
+courts of a jurisdiction where the defendant maintains its principal
+place of business and such litigation shall be governed by laws of that
+jurisdiction, without reference to its conflict-of-law provisions.
+Nothing in this Section shall prevent a party's ability to bring
+cross-claims or counter-claims.
+
+9. Miscellaneous
+----------------
+
+This License represents the complete agreement concerning the subject
+matter hereof. If any provision of this License is held to be
+unenforceable, such provision shall be reformed only to the extent
+necessary to make it enforceable. Any law or regulation which provides
+that the language of a contract shall be construed against the drafter
+shall not be used to construe this License against a Contributor.
+
+10. Versions of the License
+---------------------------
+
+10.1. New Versions
+
+Mozilla Foundation is the license steward. Except as provided in Section
+10.3, no one other than the license steward has the right to modify or
+publish new versions of this License. Each version will be given a
+distinguishing version number.
+
+10.2. Effect of New Versions
+
+You may distribute the Covered Software under the terms of the version
+of the License under which You originally received the Covered Software,
+or under the terms of any subsequent version published by the license
+steward.
+
+10.3. Modified Versions
+
+If you create software not governed by this License, and you want to
+create a new license for such software, you may create and use a
+modified version of this License if you rename the license and remove
+any references to the name of the license steward (except to note that
+such modified license differs from this License).
+
+10.4. Distributing Source Code Form that is Incompatible With Secondary
+Licenses
+
+If You choose to distribute Source Code Form that is Incompatible With
+Secondary Licenses under the terms of this version of the License, the
+notice described in Exhibit B of this License must be attached.
+
+Exhibit A - Source Code Form License Notice
+-------------------------------------------
+
+  This Source Code Form is subject to the terms of the Mozilla Public
+  License, v. 2.0. If a copy of the MPL was not distributed with this
+  file, You can obtain one at http://mozilla.org/MPL/2.0/.
+
+If it is not possible or desirable to put the notice in a particular
+file, then You may include the notice in a location (such as a LICENSE
+file in a relevant directory) where a recipient would be likely to look
+for such a notice.
+
+You may add additional accurate notices of copyright ownership.
+
+Exhibit B - "Incompatible With Secondary Licenses" Notice
+---------------------------------------------------------
+
+  This Source Code Form is "Incompatible With Secondary Licenses", as
+  defined by the Mozilla Public License, v. 2.0.

package/README.md

@@ -42,17 +42,20 @@ You can also find `Client ID` and generate `Client secrets` in OAuth app detail
 
 Fill out the `clientId` and `clientSecret` field with _Client ID_ and _Client Secret_ you've got from OAuth app detail pages mentioned in the previous section.
 
+`scope` is a space-delimited list of [scopes](https://docs.github.com/en/apps/oauth-apps/building-oauth-apps/scopes-for-oauth-apps). If not provided, scope defaults to be `read:user`.
+
 ### Config types
 
 | Name         | Type   |
 |--------------|--------|
 | clientId     | string |
 | clientSecret | string |
+| scope        | string |
 
 
 ## Test GitHub connector
 
-That's it. The GitHub connector should be available now. Don't forget to [Enable connector in sign-in experience](https://docs.logto.io/docs/tutorials/get-started/enable-social-sign-in#enable-connector-in-sign-in-experience).
+That's it. The GitHub connector should be available now. Don't forget to [Enable connector in sign-in experience](https://docs.logto.io/docs/tutorials/get-started/passwordless-sign-in-by-adding-connectors#enable-social-sign-in).
 
 ## Reference
 

package/lib/index.js

@@ -1,5 +1,5 @@
-import { ConnectorPlatform, ConnectorConfigFormItemType, ConnectorError, ConnectorErrorCodes, ConnectorType, validateConfig, parseJson } from '@logto/connector-kit';
 import { got, HTTPError } from 'got';
+import { ConnectorPlatform, ConnectorConfigFormItemType, ConnectorError, ConnectorErrorCodes, ConnectorType, validateConfig, parseJson } from '@logto/connector-kit';
 import { z } from 'zod';
 
 // https://github.com/facebook/jest/issues/7547
@@ -17,18 +17,14 @@ const notFalsy = (value) => Boolean(value);
 
 const conditional = (exp) => (notFalsy(exp) ? exp : undefined);
 
-var queryString = {};
-
-var strictUriEncode = str => encodeURIComponent(str).replace(/[!'()*]/g, x => `%${x.charCodeAt(0).toString(16).toUpperCase()}`);
-
 var token = '%[a-f0-9]{2}';
-var singleMatcher = new RegExp(token, 'gi');
+var singleMatcher = new RegExp('(' + token + ')|([^%]+?)', 'gi');
 var multiMatcher = new RegExp('(' + token + ')+', 'gi');
 
 function decodeComponents(components, split) {
 	try {
 		// Try to decode the entire string first
-		return decodeURIComponent(components.join(''));
+		return [decodeURIComponent(components.join(''))];
 	} catch (err) {
 		// Do nothing
 	}
@@ -46,16 +42,16 @@ function decodeComponents(components, split) {
 	return Array.prototype.concat.call([], decodeComponents(left), decodeComponents(right));
 }
 
-function decode(input) {
+function decode$1(input) {
 	try {
 		return decodeURIComponent(input);
 	} catch (err) {
-		var tokens = input.match(singleMatcher);
+		var tokens = input.match(singleMatcher) || [];
 
 		for (var i = 1; i < tokens.length; i++) {
 			input = decodeComponents(tokens, i).join('');
 
-			tokens = input.match(singleMatcher);
+			tokens = input.match(singleMatcher) || [];
 		}
 
 		return input;
@@ -75,7 +71,7 @@ function customDecodeURIComponent(input) {
 			// Decode as big chunks as possible
 			replaceMap[match[0]] = decodeURIComponent(match[0]);
 		} catch (err) {
-			var result = decode(match[0]);
+			var result = decode$1(match[0]);
 
 			if (result !== match[0]) {
 				replaceMap[match[0]] = result;
@@ -136,506 +132,221 @@ var splitOnFirst = (string, separator) => {
 	];
 };
 
-var filterObj = function (obj, predicate) {
-	var ret = {};
-	var keys = Object.keys(obj);
-	var isArr = Array.isArray(predicate);
+function parserForArrayFormat(options) {
+	let result;
 
-	for (var i = 0; i < keys.length; i++) {
-		var key = keys[i];
-		var val = obj[key];
+	switch (options.arrayFormat) {
+		case 'index': {
+			return (key, value, accumulator) => {
+				result = /\[(\d*)]$/.exec(key);
 
-		if (isArr ? predicate.indexOf(key) !== -1 : predicate(key, val, obj)) {
-			ret[key] = val;
-		}
-	}
+				key = key.replace(/\[\d*]$/, '');
 
-	return ret;
-};
+				if (!result) {
+					accumulator[key] = value;
+					return;
+				}
 
-(function (exports) {
-	const strictUriEncode$1 = strictUriEncode;
-	const decodeComponent = decodeUriComponent;
-	const splitOnFirst$1 = splitOnFirst;
-	const filterObject = filterObj;
-
-	const isNullOrUndefined = value => value === null || value === undefined;
-
-	const encodeFragmentIdentifier = Symbol('encodeFragmentIdentifier');
-
-	function encoderForArrayFormat(options) {
-		switch (options.arrayFormat) {
-			case 'index':
-				return key => (result, value) => {
-					const index = result.length;
-
-					if (
-						value === undefined ||
-						(options.skipNull && value === null) ||
-						(options.skipEmptyString && value === '')
-					) {
-						return result;
-					}
-
-					if (value === null) {
-						return [...result, [encode(key, options), '[', index, ']'].join('')];
-					}
-
-					return [
-						...result,
-						[encode(key, options), '[', encode(index, options), ']=', encode(value, options)].join('')
-					];
-				};
-
-			case 'bracket':
-				return key => (result, value) => {
-					if (
-						value === undefined ||
-						(options.skipNull && value === null) ||
-						(options.skipEmptyString && value === '')
-					) {
-						return result;
-					}
-
-					if (value === null) {
-						return [...result, [encode(key, options), '[]'].join('')];
-					}
-
-					return [...result, [encode(key, options), '[]=', encode(value, options)].join('')];
-				};
-
-			case 'colon-list-separator':
-				return key => (result, value) => {
-					if (
-						value === undefined ||
-						(options.skipNull && value === null) ||
-						(options.skipEmptyString && value === '')
-					) {
-						return result;
-					}
-
-					if (value === null) {
-						return [...result, [encode(key, options), ':list='].join('')];
-					}
-
-					return [...result, [encode(key, options), ':list=', encode(value, options)].join('')];
-				};
-
-			case 'comma':
-			case 'separator':
-			case 'bracket-separator': {
-				const keyValueSep = options.arrayFormat === 'bracket-separator' ?
-					'[]=' :
-					'=';
-
-				return key => (result, value) => {
-					if (
-						value === undefined ||
-						(options.skipNull && value === null) ||
-						(options.skipEmptyString && value === '')
-					) {
-						return result;
-					}
-
-					// Translate null to an empty string so that it doesn't serialize as 'null'
-					value = value === null ? '' : value;
-
-					if (result.length === 0) {
-						return [[encode(key, options), keyValueSep, encode(value, options)].join('')];
-					}
-
-					return [[result, encode(value, options)].join(options.arrayFormatSeparator)];
-				};
-			}
+				if (accumulator[key] === undefined) {
+					accumulator[key] = {};
+				}
 
-			default:
-				return key => (result, value) => {
-					if (
-						value === undefined ||
-						(options.skipNull && value === null) ||
-						(options.skipEmptyString && value === '')
-					) {
-						return result;
-					}
-
-					if (value === null) {
-						return [...result, encode(key, options)];
-					}
-
-					return [...result, [encode(key, options), '=', encode(value, options)].join('')];
-				};
+				accumulator[key][result[1]] = value;
+			};
 		}
-	}
 
-	function parserForArrayFormat(options) {
-		let result;
-
-		switch (options.arrayFormat) {
-			case 'index':
-				return (key, value, accumulator) => {
-					result = /\[(\d*)\]$/.exec(key);
-
-					key = key.replace(/\[\d*\]$/, '');
-
-					if (!result) {
-						accumulator[key] = value;
-						return;
-					}
-
-					if (accumulator[key] === undefined) {
-						accumulator[key] = {};
-					}
-
-					accumulator[key][result[1]] = value;
-				};
-
-			case 'bracket':
-				return (key, value, accumulator) => {
-					result = /(\[\])$/.exec(key);
-					key = key.replace(/\[\]$/, '');
-
-					if (!result) {
-						accumulator[key] = value;
-						return;
-					}
-
-					if (accumulator[key] === undefined) {
-						accumulator[key] = [value];
-						return;
-					}
-
-					accumulator[key] = [].concat(accumulator[key], value);
-				};
-
-			case 'colon-list-separator':
-				return (key, value, accumulator) => {
-					result = /(:list)$/.exec(key);
-					key = key.replace(/:list$/, '');
-
-					if (!result) {
-						accumulator[key] = value;
-						return;
-					}
-
-					if (accumulator[key] === undefined) {
-						accumulator[key] = [value];
-						return;
-					}
-
-					accumulator[key] = [].concat(accumulator[key], value);
-				};
-
-			case 'comma':
-			case 'separator':
-				return (key, value, accumulator) => {
-					const isArray = typeof value === 'string' && value.includes(options.arrayFormatSeparator);
-					const isEncodedArray = (typeof value === 'string' && !isArray && decode(value, options).includes(options.arrayFormatSeparator));
-					value = isEncodedArray ? decode(value, options) : value;
-					const newValue = isArray || isEncodedArray ? value.split(options.arrayFormatSeparator).map(item => decode(item, options)) : value === null ? value : decode(value, options);
-					accumulator[key] = newValue;
-				};
-
-			case 'bracket-separator':
-				return (key, value, accumulator) => {
-					const isArray = /(\[\])$/.test(key);
-					key = key.replace(/\[\]$/, '');
-
-					if (!isArray) {
-						accumulator[key] = value ? decode(value, options) : value;
-						return;
-					}
-
-					const arrayValue = value === null ?
-						[] :
-						value.split(options.arrayFormatSeparator).map(item => decode(item, options));
-
-					if (accumulator[key] === undefined) {
-						accumulator[key] = arrayValue;
-						return;
-					}
-
-					accumulator[key] = [].concat(accumulator[key], arrayValue);
-				};
-
-			default:
-				return (key, value, accumulator) => {
-					if (accumulator[key] === undefined) {
-						accumulator[key] = value;
-						return;
-					}
-
-					accumulator[key] = [].concat(accumulator[key], value);
-				};
-		}
-	}
+		case 'bracket': {
+			return (key, value, accumulator) => {
+				result = /(\[])$/.exec(key);
+				key = key.replace(/\[]$/, '');
 
-	function validateArrayFormatSeparator(value) {
-		if (typeof value !== 'string' || value.length !== 1) {
-			throw new TypeError('arrayFormatSeparator must be single character string');
-		}
-	}
+				if (!result) {
+					accumulator[key] = value;
+					return;
+				}
+
+				if (accumulator[key] === undefined) {
+					accumulator[key] = [value];
+					return;
+				}
 
-	function encode(value, options) {
-		if (options.encode) {
-			return options.strict ? strictUriEncode$1(value) : encodeURIComponent(value);
+				accumulator[key] = [...accumulator[key], value];
+			};
 		}
 
-		return value;
-	}
+		case 'colon-list-separator': {
+			return (key, value, accumulator) => {
+				result = /(:list)$/.exec(key);
+				key = key.replace(/:list$/, '');
 
-	function decode(value, options) {
-		if (options.decode) {
-			return decodeComponent(value);
-		}
+				if (!result) {
+					accumulator[key] = value;
+					return;
+				}
 
-		return value;
-	}
+				if (accumulator[key] === undefined) {
+					accumulator[key] = [value];
+					return;
+				}
 
-	function keysSorter(input) {
-		if (Array.isArray(input)) {
-			return input.sort();
+				accumulator[key] = [...accumulator[key], value];
+			};
 		}
 
-		if (typeof input === 'object') {
-			return keysSorter(Object.keys(input))
-				.sort((a, b) => Number(a) - Number(b))
-				.map(key => input[key]);
+		case 'comma':
+		case 'separator': {
+			return (key, value, accumulator) => {
+				const isArray = typeof value === 'string' && value.includes(options.arrayFormatSeparator);
+				const isEncodedArray = (typeof value === 'string' && !isArray && decode(value, options).includes(options.arrayFormatSeparator));
+				value = isEncodedArray ? decode(value, options) : value;
+				const newValue = isArray || isEncodedArray ? value.split(options.arrayFormatSeparator).map(item => decode(item, options)) : (value === null ? value : decode(value, options));
+				accumulator[key] = newValue;
+			};
 		}
 
-		return input;
-	}
-
-	function removeHash(input) {
-		const hashStart = input.indexOf('#');
-		if (hashStart !== -1) {
-			input = input.slice(0, hashStart);
-		}
+		case 'bracket-separator': {
+			return (key, value, accumulator) => {
+				const isArray = /(\[])$/.test(key);
+				key = key.replace(/\[]$/, '');
 
-		return input;
-	}
+				if (!isArray) {
+					accumulator[key] = value ? decode(value, options) : value;
+					return;
+				}
 
-	function getHash(url) {
-		let hash = '';
-		const hashStart = url.indexOf('#');
-		if (hashStart !== -1) {
-			hash = url.slice(hashStart);
-		}
+				const arrayValue = value === null
+					? []
+					: value.split(options.arrayFormatSeparator).map(item => decode(item, options));
 
-		return hash;
-	}
+				if (accumulator[key] === undefined) {
+					accumulator[key] = arrayValue;
+					return;
+				}
 
-	function extract(input) {
-		input = removeHash(input);
-		const queryStart = input.indexOf('?');
-		if (queryStart === -1) {
-			return '';
+				accumulator[key] = [...accumulator[key], ...arrayValue];
+			};
 		}
 
-		return input.slice(queryStart + 1);
-	}
+		default: {
+			return (key, value, accumulator) => {
+				if (accumulator[key] === undefined) {
+					accumulator[key] = value;
+					return;
+				}
 
-	function parseValue(value, options) {
-		if (options.parseNumbers && !Number.isNaN(Number(value)) && (typeof value === 'string' && value.trim() !== '')) {
-			value = Number(value);
-		} else if (options.parseBooleans && value !== null && (value.toLowerCase() === 'true' || value.toLowerCase() === 'false')) {
-			value = value.toLowerCase() === 'true';
+				accumulator[key] = [...[accumulator[key]].flat(), value];
+			};
 		}
+	}
+}
 
-		return value;
+function validateArrayFormatSeparator(value) {
+	if (typeof value !== 'string' || value.length !== 1) {
+		throw new TypeError('arrayFormatSeparator must be single character string');
 	}
+}
 
-	function parse(query, options) {
-		options = Object.assign({
-			decode: true,
-			sort: true,
-			arrayFormat: 'none',
-			arrayFormatSeparator: ',',
-			parseNumbers: false,
-			parseBooleans: false
-		}, options);
+function decode(value, options) {
+	if (options.decode) {
+		return decodeUriComponent(value);
+	}
 
-		validateArrayFormatSeparator(options.arrayFormatSeparator);
+	return value;
+}
 
-		const formatter = parserForArrayFormat(options);
+function keysSorter(input) {
+	if (Array.isArray(input)) {
+		return input.sort();
+	}
 
-		// Create an object with no prototype
-		const ret = Object.create(null);
+	if (typeof input === 'object') {
+		return keysSorter(Object.keys(input))
+			.sort((a, b) => Number(a) - Number(b))
+			.map(key => input[key]);
+	}
 
-		if (typeof query !== 'string') {
-			return ret;
-		}
+	return input;
+}
 
-		query = query.trim().replace(/^[?#&]/, '');
+function parseValue(value, options) {
+	if (options.parseNumbers && !Number.isNaN(Number(value)) && (typeof value === 'string' && value.trim() !== '')) {
+		value = Number(value);
+	} else if (options.parseBooleans && value !== null && (value.toLowerCase() === 'true' || value.toLowerCase() === 'false')) {
+		value = value.toLowerCase() === 'true';
+	}
 
-		if (!query) {
-			return ret;
-		}
+	return value;
+}
 
-		for (const param of query.split('&')) {
-			if (param === '') {
-				continue;
-			}
+function parse(query, options) {
+	options = {
+		decode: true,
+		sort: true,
+		arrayFormat: 'none',
+		arrayFormatSeparator: ',',
+		parseNumbers: false,
+		parseBooleans: false,
+		...options,
+	};
 
-			let [key, value] = splitOnFirst$1(options.decode ? param.replace(/\+/g, ' ') : param, '=');
+	validateArrayFormatSeparator(options.arrayFormatSeparator);
 
-			// Missing `=` should be `null`:
-			// http://w3.org/TR/2012/WD-url-20120524/#collect-url-parameters
-			value = value === undefined ? null : ['comma', 'separator', 'bracket-separator'].includes(options.arrayFormat) ? value : decode(value, options);
-			formatter(decode(key, options), value, ret);
-		}
+	const formatter = parserForArrayFormat(options);
 
-		for (const key of Object.keys(ret)) {
-			const value = ret[key];
-			if (typeof value === 'object' && value !== null) {
-				for (const k of Object.keys(value)) {
-					value[k] = parseValue(value[k], options);
-				}
-			} else {
-				ret[key] = parseValue(value, options);
-			}
-		}
+	// Create an object with no prototype
+	const returnValue = Object.create(null);
 
-		if (options.sort === false) {
-			return ret;
-		}
+	if (typeof query !== 'string') {
+		return returnValue;
+	}
 
-		return (options.sort === true ? Object.keys(ret).sort() : Object.keys(ret).sort(options.sort)).reduce((result, key) => {
-			const value = ret[key];
-			if (Boolean(value) && typeof value === 'object' && !Array.isArray(value)) {
-				// Sort object keys, not values
-				result[key] = keysSorter(value);
-			} else {
-				result[key] = value;
-			}
+	query = query.trim().replace(/^[?#&]/, '');
 
-			return result;
-		}, Object.create(null));
+	if (!query) {
+		return returnValue;
 	}
 
-	exports.extract = extract;
-	exports.parse = parse;
-
-	exports.stringify = (object, options) => {
-		if (!object) {
-			return '';
+	for (const parameter of query.split('&')) {
+		if (parameter === '') {
+			continue;
 		}
 
-		options = Object.assign({
-			encode: true,
-			strict: true,
-			arrayFormat: 'none',
-			arrayFormatSeparator: ','
-		}, options);
-
-		validateArrayFormatSeparator(options.arrayFormatSeparator);
+		let [key, value] = splitOnFirst(options.decode ? parameter.replace(/\+/g, ' ') : parameter, '=');
 
-		const shouldFilter = key => (
-			(options.skipNull && isNullOrUndefined(object[key])) ||
-			(options.skipEmptyString && object[key] === '')
-		);
-
-		const formatter = encoderForArrayFormat(options);
-
-		const objectCopy = {};
+		// Missing `=` should be `null`:
+		// http://w3.org/TR/2012/WD-url-20120524/#collect-url-parameters
+		value = value === undefined ? null : (['comma', 'separator', 'bracket-separator'].includes(options.arrayFormat) ? value : decode(value, options));
+		formatter(decode(key, options), value, returnValue);
+	}
 
-		for (const key of Object.keys(object)) {
-			if (!shouldFilter(key)) {
-				objectCopy[key] = object[key];
+	for (const [key, value] of Object.entries(returnValue)) {
+		if (typeof value === 'object' && value !== null) {
+			for (const [key2, value2] of Object.entries(value)) {
+				value[key2] = parseValue(value2, options);
 			}
+		} else {
+			returnValue[key] = parseValue(value, options);
 		}
+	}
 
-		const keys = Object.keys(objectCopy);
-
-		if (options.sort !== false) {
-			keys.sort(options.sort);
-		}
-
-		return keys.map(key => {
-			const value = object[key];
-
-			if (value === undefined) {
-				return '';
-			}
-
-			if (value === null) {
-				return encode(key, options);
-			}
-
-			if (Array.isArray(value)) {
-				if (value.length === 0 && options.arrayFormat === 'bracket-separator') {
-					return encode(key, options) + '[]';
-				}
-
-				return value
-					.reduce(formatter(key), [])
-					.join('&');
-			}
-
-			return encode(key, options) + '=' + encode(value, options);
-		}).filter(x => x.length > 0).join('&');
-	};
-
-	exports.parseUrl = (url, options) => {
-		options = Object.assign({
-			decode: true
-		}, options);
-
-		const [url_, hash] = splitOnFirst$1(url, '#');
-
-		return Object.assign(
-			{
-				url: url_.split('?')[0] || '',
-				query: parse(extract(url), options)
-			},
-			options && options.parseFragmentIdentifier && hash ? {fragmentIdentifier: decode(hash, options)} : {}
-		);
-	};
-
-	exports.stringifyUrl = (object, options) => {
-		options = Object.assign({
-			encode: true,
-			strict: true,
-			[encodeFragmentIdentifier]: true
-		}, options);
-
-		const url = removeHash(object.url).split('?')[0] || '';
-		const queryFromUrl = exports.extract(object.url);
-		const parsedQueryFromUrl = exports.parse(queryFromUrl, {sort: false});
-
-		const query = Object.assign(parsedQueryFromUrl, object.query);
-		let queryString = exports.stringify(query, options);
-		if (queryString) {
-			queryString = `?${queryString}`;
-		}
+	if (options.sort === false) {
+		return returnValue;
+	}
 
-		let hash = getHash(object.url);
-		if (object.fragmentIdentifier) {
-			hash = `#${options[encodeFragmentIdentifier] ? encode(object.fragmentIdentifier, options) : object.fragmentIdentifier}`;
+	// TODO: Remove the use of `reduce`.
+	// eslint-disable-next-line unicorn/no-array-reduce
+	return (options.sort === true ? Object.keys(returnValue).sort() : Object.keys(returnValue).sort(options.sort)).reduce((result, key) => {
+		const value = returnValue[key];
+		if (Boolean(value) && typeof value === 'object' && !Array.isArray(value)) {
+			// Sort object keys, not values
+			result[key] = keysSorter(value);
+		} else {
+			result[key] = value;
 		}
 
-		return `${url}${queryString}${hash}`;
-	};
-
-	exports.pick = (input, filter, options) => {
-		options = Object.assign({
-			parseFragmentIdentifier: true,
-			[encodeFragmentIdentifier]: false
-		}, options);
-
-		const {url, query, fragmentIdentifier} = exports.parseUrl(input, options);
-		return exports.stringifyUrl({
-			url,
-			query: filterObject(query, filter),
-			fragmentIdentifier
-		}, options);
-	};
-
-	exports.exclude = (input, filter, options) => {
-		const exclusionFilter = Array.isArray(filter) ? key => !filter.includes(key) : (key, value) => !filter(key, value);
-
-		return exports.pick(input, exclusionFilter, options);
-	};
-} (queryString));
+		return result;
+	}, Object.create(null));
+}
 
 const authorizationEndpoint = 'https://github.com/login/oauth/authorize';
 const scope = 'read:user';
@@ -675,6 +386,14 @@ const defaultMetadata = {
             required: true,
             placeholder: '<client-secret>',
         },
+        {
+            key: 'scope',
+            type: ConnectorConfigFormItemType.Text,
+            label: 'Scope',
+            required: false,
+            placeholder: '<scope>',
+            description: "The `scope` determines permissions granted by the user's authorization. If you are not sure what to enter, do not worry, just leave it blank.",
+        },
     ],
 };
 const defaultTimeout = 5000;
@@ -682,6 +401,7 @@ const defaultTimeout = 5000;
 const githubConfigGuard = z.object({
     clientId: z.string(),
     clientSecret: z.string(),
+    scope: z.string().optional(),
 });
 const accessTokenResponseGuard = z.object({
     access_token: z.string(),
@@ -708,7 +428,7 @@ const getAuthorizationUri = (getConfig) => async ({ state, redirectUri }) => {
         client_id: config.clientId,
         redirect_uri: redirectUri,
         state,
-        scope, // Only support fixed scope for v1.
+        scope: config.scope ?? scope,
     });
     return `${authorizationEndpoint}?${queryParameters.toString()}`;
 };
@@ -743,7 +463,7 @@ const getAccessToken = async (config, codeObject) => {
         },
         timeout: { request: defaultTimeout },
     });
-    const result = accessTokenResponseGuard.safeParse(queryString.parse(httpResponse.body));
+    const result = accessTokenResponseGuard.safeParse(parse(httpResponse.body));
     if (!result.success) {
         throw new ConnectorError(ConnectorErrorCodes.InvalidResponse, result.error);
     }

package/lib/types.d.ts

@@ -2,10 +2,13 @@ import { z } from 'zod';
 export declare const githubConfigGuard: z.ZodObject<{
     clientId: z.ZodString;
     clientSecret: z.ZodString;
+    scope: z.ZodOptional<z.ZodString>;
 }, "strip", z.ZodTypeAny, {
+    scope?: string | undefined;
     clientId: string;
     clientSecret: string;
 }, {
+    scope?: string | undefined;
     clientId: string;
     clientSecret: string;
 }>;
@@ -15,12 +18,12 @@ export declare const accessTokenResponseGuard: z.ZodObject<{
     scope: z.ZodString;
     token_type: z.ZodString;
 }, "strip", z.ZodTypeAny, {
-    access_token: string;
     scope: string;
+    access_token: string;
     token_type: string;
 }, {
-    access_token: string;
     scope: string;
+    access_token: string;
     token_type: string;
 }>;
 export type AccessTokenResponse = z.infer<typeof accessTokenResponseGuard>;

package/package.json

@@ -1,4 +1,12 @@
 {
+  "name": "@logto/connector-github",
+  "version": "1.1.0",
+  "description": "Github web connector implementation.",
+  "author": "Silverhand Inc. <contact@silverhand.io>",
+  "dependencies": {
+    "@logto/connector-kit": "^1.1.0",
+    "query-string": "^8.0.0"
+  },
   "main": "./lib/index.js",
   "module": "./lib/index.js",
   "exports": "./lib/index.js",
@@ -10,61 +18,34 @@
     "logo.svg",
     "logo-dark.svg"
   ],
-  "dependencies": {
-    "@logto/connector-kit": "^1.0.0",
-    "@silverhand/essentials": "2.1.0",
-    "got": "^12.5.3",
-    "snakecase-keys": "^5.1.0",
-    "zod": "^3.20.2",
-    "query-string": "^7.0.1"
-  },
-  "devDependencies": {
-    "@jest/types": "^29.3.1",
-    "@rollup/plugin-commonjs": "^24.0.0",
-    "@rollup/plugin-json": "^6.0.0",
-    "@rollup/plugin-node-resolve": "^15.0.1",
-    "@rollup/plugin-typescript": "^10.0.1",
-    "@silverhand/eslint-config": "1.3.0",
-    "@silverhand/ts-config": "1.2.1",
-    "@silverhand/jest-config": "1.2.2",
-    "@types/jest": "^29.2.4",
-    "@types/node": "^16.3.1",
-    "@types/supertest": "^2.0.11",
-    "eslint": "^8.21.0",
-    "jest": "^29.3.1",
-    "jest-matcher-specific-error": "^1.0.0",
-    "lint-staged": "^13.0.0",
-    "nock": "^13.2.2",
-    "prettier": "^2.8.1",
-    "rollup": "^3.8.0",
-    "rollup-plugin-summary": "^2.0.0",
-    "supertest": "^6.2.2",
-    "typescript": "^4.9.4"
-  },
   "engines": {
-    "node": "^16.13.0 || ^18.12.0"
+    "node": "^18.12.0"
   },
   "eslintConfig": {
-    "extends": "@silverhand"
+    "extends": "@silverhand",
+    "settings": {
+      "import/core-modules": [
+        "@silverhand/essentials",
+        "got",
+        "nock",
+        "snakecase-keys",
+        "zod"
+      ]
+    }
   },
   "prettier": "@silverhand/eslint-config/.prettierrc",
   "publishConfig": {
     "access": "public"
   },
-  "name": "@logto/connector-github",
-  "version": "1.0.0",
-  "description": "Github web connector implementation.",
-  "author": "Silverhand Inc. <contact@silverhand.io>",
   "scripts": {
-    "package:sync": "cd ../../ && pnpm package:sync",
-    "package:update": "cd ../../ && pnpm package:update",
     "precommit": "lint-staged",
-    "build:test": "rm -rf lib/ && tsc -p tsconfig.test.json",
+    "build:test": "rm -rf lib/ && tsc -p tsconfig.test.json --sourcemap",
     "build": "rm -rf lib/ && tsc -p tsconfig.build.json --noEmit && rollup -c",
     "dev": "tsc -p tsconfig.build.json --watch --preserveWatchOutput --incremental",
     "lint": "eslint --ext .ts src",
     "lint:report": "pnpm lint --format json --output-file report.json",
-    "test": "pnpm build:test && NODE_OPTIONS=--experimental-vm-modules jest",
-    "test:coverage": "pnpm run test --coverage --silent"
+    "test:only": "NODE_OPTIONS=--experimental-vm-modules jest",
+    "test": "pnpm build:test && pnpm test:only",
+    "test:ci": "pnpm test:only --silent --coverage"
   }
 }