@logto/connector-github 1.4.1 → 1.5.0

package/README.md

@@ -55,7 +55,7 @@ Fill out the `clientId` and `clientSecret` field with _Client ID_ and _Client Se
 
 ## 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/passwordless-sign-in-by-adding-connectors#enable-social-sign-in).
+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/recipes/configure-connectors/social-connector/enable-social-sign-in/).
 
 ## Reference
 

package/lib/index.js

@@ -1,809 +1,212 @@
-import { ConnectorPlatform, ConnectorConfigFormItemType, ConnectorError, ConnectorErrorCodes, ConnectorType, validateConfig, jsonGuard } from '@logto/connector-kit';
-import { z } from 'zod';
-
-// https://github.com/facebook/jest/issues/7547
-const assert = (value, error) => {
-    if (!value) {
-        // https://github.com/typescript-eslint/typescript-eslint/issues/3814
-        // eslint-disable-next-line @typescript-eslint/no-throw-literal
-        throw error;
-    }
-};
-
-// eslint-disable-next-line id-length
-// eslint-disable-next-line unicorn/prefer-native-coercion-functions
-const notFalsy = (value) => Boolean(value);
-
-/**
- * Conditional return the expression result when it's not {@link Falsy};
- * otherwise return `undefined`.
- *
- * @example
- * ```ts
- * conditional(1 && '2') // '2'
- * conditional(false && '1') // undefined
- * ```
- */
-const conditional = (exp) => (notFalsy(exp) ? exp : undefined);
-
-// Intended
-// eslint-disable-next-line @typescript-eslint/no-empty-function
-const isPromise = (value) => value !== null &&
-    (typeof value === 'object' || typeof value === 'function') &&
-    'then' in value &&
-    typeof value.then === 'function';
-// eslint-disable-next-line @typescript-eslint/promise-function-async
-const trySafe = (exec, onError) => {
-    try {
-        const unwrapped = typeof exec === 'function' ? exec() : exec;
-        return isPromise(unwrapped)
-            ? // eslint-disable-next-line promise/prefer-await-to-then
-                unwrapped.catch((error) => {
-                    onError?.(error);
-                })
-            : unwrapped;
-    }
-    catch (error) {
-        onError?.(error);
-    }
-};
-
-// eslint-lint-disable-next-line @typescript-eslint/naming-convention
-class HTTPError extends Error {
-    constructor(response, request, options) {
-        const code = (response.status || response.status === 0) ? response.status : '';
-        const title = response.statusText || '';
-        const status = `${code} ${title}`.trim();
-        const reason = status ? `status code ${status}` : 'an unknown error';
-        super(`Request failed with ${reason}`);
-        Object.defineProperty(this, "response", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        Object.defineProperty(this, "request", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        Object.defineProperty(this, "options", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        this.name = 'HTTPError';
-        this.response = response;
-        this.request = request;
-        this.options = options;
-    }
-}
-
-class TimeoutError extends Error {
-    constructor(request) {
-        super('Request timed out');
-        Object.defineProperty(this, "request", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        this.name = 'TimeoutError';
-        this.request = request;
-    }
-}
-
-// eslint-disable-next-line @typescript-eslint/ban-types
-const isObject = (value) => value !== null && typeof value === 'object';
-
-const validateAndMerge = (...sources) => {
-    for (const source of sources) {
-        if ((!isObject(source) || Array.isArray(source)) && source !== undefined) {
-            throw new TypeError('The `options` argument must be an object');
-        }
-    }
-    return deepMerge({}, ...sources);
-};
-const mergeHeaders = (source1 = {}, source2 = {}) => {
-    const result = new globalThis.Headers(source1);
-    const isHeadersInstance = source2 instanceof globalThis.Headers;
-    const source = new globalThis.Headers(source2);
-    for (const [key, value] of source.entries()) {
-        if ((isHeadersInstance && value === 'undefined') || value === undefined) {
-            result.delete(key);
-        }
-        else {
-            result.set(key, value);
-        }
-    }
-    return result;
-};
-// TODO: Make this strongly-typed (no `any`).
-const deepMerge = (...sources) => {
-    let returnValue = {};
-    let headers = {};
-    for (const source of sources) {
-        if (Array.isArray(source)) {
-            if (!Array.isArray(returnValue)) {
-                returnValue = [];
-            }
-            returnValue = [...returnValue, ...source];
-        }
-        else if (isObject(source)) {
-            for (let [key, value] of Object.entries(source)) {
-                if (isObject(value) && key in returnValue) {
-                    value = deepMerge(returnValue[key], value);
-                }
-                returnValue = { ...returnValue, [key]: value };
-            }
-            if (isObject(source.headers)) {
-                headers = mergeHeaders(headers, source.headers);
-                returnValue.headers = headers;
-            }
-        }
-    }
-    return returnValue;
-};
-
-const supportsRequestStreams = (() => {
-    let duplexAccessed = false;
-    let hasContentType = false;
-    const supportsReadableStream = typeof globalThis.ReadableStream === 'function';
-    const supportsRequest = typeof globalThis.Request === 'function';
-    if (supportsReadableStream && supportsRequest) {
-        hasContentType = new globalThis.Request('https://empty.invalid', {
-            body: new globalThis.ReadableStream(),
-            method: 'POST',
-            // @ts-expect-error - Types are outdated.
-            get duplex() {
-                duplexAccessed = true;
-                return 'half';
-            },
-        }).headers.has('Content-Type');
-    }
-    return duplexAccessed && !hasContentType;
-})();
-const supportsAbortController = typeof globalThis.AbortController === 'function';
-const supportsResponseStreams = typeof globalThis.ReadableStream === 'function';
-const supportsFormData = typeof globalThis.FormData === 'function';
-const requestMethods = ['get', 'post', 'put', 'patch', 'head', 'delete'];
-const responseTypes = {
-    json: 'application/json',
-    text: 'text/*',
-    formData: 'multipart/form-data',
-    arrayBuffer: '*/*',
-    blob: '*/*',
-};
-// The maximum value of a 32bit int (see issue #117)
-const maxSafeTimeout = 2_147_483_647;
-const stop = Symbol('stop');
-const kyOptionKeys = {
-    json: true,
-    parseJson: true,
-    searchParams: true,
-    prefixUrl: true,
-    retry: true,
-    timeout: true,
-    hooks: true,
-    throwHttpErrors: true,
-    onDownloadProgress: true,
-    fetch: true,
-};
-const requestOptionsRegistry = {
-    method: true,
-    headers: true,
-    body: true,
-    mode: true,
-    credentials: true,
-    cache: true,
-    redirect: true,
-    referrer: true,
-    referrerPolicy: true,
-    integrity: true,
-    keepalive: true,
-    signal: true,
-    window: true,
-    dispatcher: true,
-    duplex: true,
-    priority: true,
-};
-
-const normalizeRequestMethod = (input) => requestMethods.includes(input) ? input.toUpperCase() : input;
-const retryMethods = ['get', 'put', 'head', 'delete', 'options', 'trace'];
-const retryStatusCodes = [408, 413, 429, 500, 502, 503, 504];
-const retryAfterStatusCodes = [413, 429, 503];
-const defaultRetryOptions = {
-    limit: 2,
-    methods: retryMethods,
-    statusCodes: retryStatusCodes,
-    afterStatusCodes: retryAfterStatusCodes,
-    maxRetryAfter: Number.POSITIVE_INFINITY,
-    backoffLimit: Number.POSITIVE_INFINITY,
-    delay: attemptCount => 0.3 * (2 ** (attemptCount - 1)) * 1000,
-};
-const normalizeRetryOptions = (retry = {}) => {
-    if (typeof retry === 'number') {
-        return {
-            ...defaultRetryOptions,
-            limit: retry,
-        };
-    }
-    if (retry.methods && !Array.isArray(retry.methods)) {
-        throw new Error('retry.methods must be an array');
-    }
-    if (retry.statusCodes && !Array.isArray(retry.statusCodes)) {
-        throw new Error('retry.statusCodes must be an array');
-    }
-    return {
-        ...defaultRetryOptions,
-        ...retry,
-        afterStatusCodes: retryAfterStatusCodes,
-    };
-};
-
-// `Promise.race()` workaround (#91)
-async function timeout(request, init, abortController, options) {
-    return new Promise((resolve, reject) => {
-        const timeoutId = setTimeout(() => {
-            if (abortController) {
-                abortController.abort();
-            }
-            reject(new TimeoutError(request));
-        }, options.timeout);
-        void options
-            .fetch(request, init)
-            .then(resolve)
-            .catch(reject)
-            .then(() => {
-            clearTimeout(timeoutId);
-        });
-    });
-}
-
-// https://github.com/sindresorhus/delay/tree/ab98ae8dfcb38e1593286c94d934e70d14a4e111
-async function delay(ms, { signal }) {
-    return new Promise((resolve, reject) => {
-        if (signal) {
-            signal.throwIfAborted();
-            signal.addEventListener('abort', abortHandler, { once: true });
-        }
-        function abortHandler() {
-            clearTimeout(timeoutId);
-            reject(signal.reason);
-        }
-        const timeoutId = setTimeout(() => {
-            signal?.removeEventListener('abort', abortHandler);
-            resolve();
-        }, ms);
-    });
-}
-
-const findUnknownOptions = (request, options) => {
-    const unknownOptions = {};
-    for (const key in options) {
-        if (!(key in requestOptionsRegistry) && !(key in kyOptionKeys) && !(key in request)) {
-            unknownOptions[key] = options[key];
-        }
-    }
-    return unknownOptions;
-};
-
-class Ky {
-    static create(input, options) {
-        const ky = new Ky(input, options);
-        const function_ = async () => {
-            if (typeof ky._options.timeout === 'number' && ky._options.timeout > maxSafeTimeout) {
-                throw new RangeError(`The \`timeout\` option cannot be greater than ${maxSafeTimeout}`);
-            }
-            // Delay the fetch so that body method shortcuts can set the Accept header
-            await Promise.resolve();
-            let response = await ky._fetch();
-            for (const hook of ky._options.hooks.afterResponse) {
-                // eslint-disable-next-line no-await-in-loop
-                const modifiedResponse = await hook(ky.request, ky._options, ky._decorateResponse(response.clone()));
-                if (modifiedResponse instanceof globalThis.Response) {
-                    response = modifiedResponse;
-                }
-            }
-            ky._decorateResponse(response);
-            if (!response.ok && ky._options.throwHttpErrors) {
-                let error = new HTTPError(response, ky.request, ky._options);
-                for (const hook of ky._options.hooks.beforeError) {
-                    // eslint-disable-next-line no-await-in-loop
-                    error = await hook(error);
-                }
-                throw error;
-            }
-            // If `onDownloadProgress` is passed, it uses the stream API internally
-            /* istanbul ignore next */
-            if (ky._options.onDownloadProgress) {
-                if (typeof ky._options.onDownloadProgress !== 'function') {
-                    throw new TypeError('The `onDownloadProgress` option must be a function');
-                }
-                if (!supportsResponseStreams) {
-                    throw new Error('Streams are not supported in your environment. `ReadableStream` is missing.');
-                }
-                return ky._stream(response.clone(), ky._options.onDownloadProgress);
-            }
-            return response;
-        };
-        const isRetriableMethod = ky._options.retry.methods.includes(ky.request.method.toLowerCase());
-        const result = (isRetriableMethod ? ky._retry(function_) : function_());
-        for (const [type, mimeType] of Object.entries(responseTypes)) {
-            result[type] = async () => {
-                // eslint-disable-next-line @typescript-eslint/prefer-nullish-coalescing
-                ky.request.headers.set('accept', ky.request.headers.get('accept') || mimeType);
-                const awaitedResult = await result;
-                const response = awaitedResult.clone();
-                if (type === 'json') {
-                    if (response.status === 204) {
-                        return '';
-                    }
-                    const arrayBuffer = await response.clone().arrayBuffer();
-                    const responseSize = arrayBuffer.byteLength;
-                    if (responseSize === 0) {
-                        return '';
-                    }
-                    if (options.parseJson) {
-                        return options.parseJson(await response.text());
-                    }
-                }
-                return response[type]();
-            };
-        }
-        return result;
-    }
-    // eslint-disable-next-line complexity
-    constructor(input, options = {}) {
-        Object.defineProperty(this, "request", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        Object.defineProperty(this, "abortController", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        Object.defineProperty(this, "_retryCount", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: 0
-        });
-        Object.defineProperty(this, "_input", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        Object.defineProperty(this, "_options", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        this._input = input;
-        const credentials = this._input instanceof Request && 'credentials' in Request.prototype
-            ? this._input.credentials
-            : undefined;
-        this._options = {
-            ...(credentials && { credentials }), // For exactOptionalPropertyTypes
-            ...options,
-            headers: mergeHeaders(this._input.headers, options.headers),
-            hooks: deepMerge({
-                beforeRequest: [],
-                beforeRetry: [],
-                beforeError: [],
-                afterResponse: [],
-            }, options.hooks),
-            method: normalizeRequestMethod(options.method ?? this._input.method),
-            // eslint-disable-next-line @typescript-eslint/prefer-nullish-coalescing
-            prefixUrl: String(options.prefixUrl || ''),
-            retry: normalizeRetryOptions(options.retry),
-            throwHttpErrors: options.throwHttpErrors !== false,
-            timeout: options.timeout ?? 10_000,
-            fetch: options.fetch ?? globalThis.fetch.bind(globalThis),
-        };
-        if (typeof this._input !== 'string' && !(this._input instanceof URL || this._input instanceof globalThis.Request)) {
-            throw new TypeError('`input` must be a string, URL, or Request');
-        }
-        if (this._options.prefixUrl && typeof this._input === 'string') {
-            if (this._input.startsWith('/')) {
-                throw new Error('`input` must not begin with a slash when using `prefixUrl`');
-            }
-            if (!this._options.prefixUrl.endsWith('/')) {
-                this._options.prefixUrl += '/';
-            }
-            this._input = this._options.prefixUrl + this._input;
-        }
-        if (supportsAbortController) {
-            this.abortController = new globalThis.AbortController();
-            if (this._options.signal) {
-                const originalSignal = this._options.signal;
-                this._options.signal.addEventListener('abort', () => {
-                    this.abortController.abort(originalSignal.reason);
-                });
-            }
-            this._options.signal = this.abortController.signal;
-        }
-        if (supportsRequestStreams) {
-            // @ts-expect-error - Types are outdated.
-            this._options.duplex = 'half';
-        }
-        this.request = new globalThis.Request(this._input, this._options);
-        if (this._options.searchParams) {
-            // eslint-disable-next-line unicorn/prevent-abbreviations
-            const textSearchParams = typeof this._options.searchParams === 'string'
-                ? this._options.searchParams.replace(/^\?/, '')
-                : new URLSearchParams(this._options.searchParams).toString();
-            // eslint-disable-next-line unicorn/prevent-abbreviations
-            const searchParams = '?' + textSearchParams;
-            const url = this.request.url.replace(/(?:\?.*?)?(?=#|$)/, searchParams);
-            // To provide correct form boundary, Content-Type header should be deleted each time when new Request instantiated from another one
-            if (((supportsFormData && this._options.body instanceof globalThis.FormData)
-                || this._options.body instanceof URLSearchParams) && !(this._options.headers && this._options.headers['content-type'])) {
-                this.request.headers.delete('content-type');
-            }
-            // The spread of `this.request` is required as otherwise it misses the `duplex` option for some reason and throws.
-            this.request = new globalThis.Request(new globalThis.Request(url, { ...this.request }), this._options);
-        }
-        if (this._options.json !== undefined) {
-            this._options.body = JSON.stringify(this._options.json);
-            this.request.headers.set('content-type', this._options.headers.get('content-type') ?? 'application/json');
-            this.request = new globalThis.Request(this.request, { body: this._options.body });
-        }
-    }
-    _calculateRetryDelay(error) {
-        this._retryCount++;
-        if (this._retryCount <= this._options.retry.limit && !(error instanceof TimeoutError)) {
-            if (error instanceof HTTPError) {
-                if (!this._options.retry.statusCodes.includes(error.response.status)) {
-                    return 0;
-                }
-                const retryAfter = error.response.headers.get('Retry-After');
-                if (retryAfter && this._options.retry.afterStatusCodes.includes(error.response.status)) {
-                    let after = Number(retryAfter);
-                    if (Number.isNaN(after)) {
-                        after = Date.parse(retryAfter) - Date.now();
-                    }
-                    else {
-                        after *= 1000;
-                    }
-                    if (this._options.retry.maxRetryAfter !== undefined && after > this._options.retry.maxRetryAfter) {
-                        return 0;
-                    }
-                    return after;
-                }
-                if (error.response.status === 413) {
-                    return 0;
-                }
-            }
-            const retryDelay = this._options.retry.delay(this._retryCount);
-            return Math.min(this._options.retry.backoffLimit, retryDelay);
-        }
-        return 0;
-    }
-    _decorateResponse(response) {
-        if (this._options.parseJson) {
-            response.json = async () => this._options.parseJson(await response.text());
-        }
-        return response;
-    }
-    async _retry(function_) {
-        try {
-            return await function_();
-        }
-        catch (error) {
-            const ms = Math.min(this._calculateRetryDelay(error), maxSafeTimeout);
-            if (ms !== 0 && this._retryCount > 0) {
-                await delay(ms, { signal: this._options.signal });
-                for (const hook of this._options.hooks.beforeRetry) {
-                    // eslint-disable-next-line no-await-in-loop
-                    const hookResult = await hook({
-                        request: this.request,
-                        options: this._options,
-                        error: error,
-                        retryCount: this._retryCount,
-                    });
-                    // If `stop` is returned from the hook, the retry process is stopped
-                    if (hookResult === stop) {
-                        return;
-                    }
-                }
-                return this._retry(function_);
-            }
-            throw error;
-        }
-    }
-    async _fetch() {
-        for (const hook of this._options.hooks.beforeRequest) {
-            // eslint-disable-next-line no-await-in-loop
-            const result = await hook(this.request, this._options);
-            if (result instanceof Request) {
-                this.request = result;
-                break;
-            }
-            if (result instanceof Response) {
-                return result;
-            }
-        }
-        const nonRequestOptions = findUnknownOptions(this.request, this._options);
-        if (this._options.timeout === false) {
-            return this._options.fetch(this.request.clone(), nonRequestOptions);
-        }
-        return timeout(this.request.clone(), nonRequestOptions, this.abortController, this._options);
-    }
-    /* istanbul ignore next */
-    _stream(response, onDownloadProgress) {
-        const totalBytes = Number(response.headers.get('content-length')) || 0;
-        let transferredBytes = 0;
-        if (response.status === 204) {
-            if (onDownloadProgress) {
-                onDownloadProgress({ percent: 1, totalBytes, transferredBytes }, new Uint8Array());
-            }
-            return new globalThis.Response(null, {
-                status: response.status,
-                statusText: response.statusText,
-                headers: response.headers,
-            });
-        }
-        return new globalThis.Response(new globalThis.ReadableStream({
-            async start(controller) {
-                const reader = response.body.getReader();
-                if (onDownloadProgress) {
-                    onDownloadProgress({ percent: 0, transferredBytes: 0, totalBytes }, new Uint8Array());
-                }
-                async function read() {
-                    const { done, value } = await reader.read();
-                    if (done) {
-                        controller.close();
-                        return;
-                    }
-                    if (onDownloadProgress) {
-                        transferredBytes += value.byteLength;
-                        const percent = totalBytes === 0 ? 0 : transferredBytes / totalBytes;
-                        onDownloadProgress({ percent, transferredBytes, totalBytes }, value);
-                    }
-                    controller.enqueue(value);
-                    await read();
-                }
-                await read();
-            },
-        }), {
-            status: response.status,
-            statusText: response.statusText,
-            headers: response.headers,
-        });
-    }
-}
-
-/*! MIT License © Sindre Sorhus */
-const createInstance = (defaults) => {
-    // eslint-disable-next-line @typescript-eslint/promise-function-async
-    const ky = (input, options) => Ky.create(input, validateAndMerge(defaults, options));
-    for (const method of requestMethods) {
-        // eslint-disable-next-line @typescript-eslint/promise-function-async
-        ky[method] = (input, options) => Ky.create(input, validateAndMerge(defaults, options, { method }));
-    }
-    ky.create = (newDefaults) => createInstance(validateAndMerge(newDefaults));
-    ky.extend = (newDefaults) => createInstance(validateAndMerge(defaults, newDefaults));
-    ky.stop = stop;
-    return ky;
-};
-const ky = createInstance();
-
-const authorizationEndpoint = 'https://github.com/login/oauth/authorize';
-/**
- * `read:user` read user profile data; `user:email` read user email addresses (including private email addresses).
- * Ref: https://docs.github.com/en/apps/oauth-apps/building-oauth-apps/scopes-for-oauth-apps
- */
-const scope = 'read:user user:email';
-const accessTokenEndpoint = 'https://github.com/login/oauth/access_token';
-const userInfoEndpoint = 'https://api.github.com/user';
-// Ref: https://docs.github.com/en/rest/users/emails?apiVersion=2022-11-28#list-email-addresses-for-the-authenticated-user
-const userEmailsEndpoint = 'https://api.github.com/user/emails';
-const defaultMetadata = {
-    id: 'github-universal',
-    target: 'github',
-    platform: ConnectorPlatform.Universal,
-    name: {
-        en: 'GitHub',
-        'zh-CN': 'GitHub',
-        'tr-TR': 'GitHub',
-        ko: 'GitHub',
+// src/index.ts
+import { assert, conditional, trySafe } from "@silverhand/essentials";
+import {
+  ConnectorError,
+  ConnectorErrorCodes,
+  validateConfig,
+  ConnectorType,
+  jsonGuard
+} from "@logto/connector-kit";
+import ky, { HTTPError } from "ky";
+
+// src/constant.ts
+import { ConnectorPlatform, ConnectorConfigFormItemType } from "@logto/connector-kit";
+var authorizationEndpoint = "https://github.com/login/oauth/authorize";
+var scope = "read:user user:email";
+var accessTokenEndpoint = "https://github.com/login/oauth/access_token";
+var userInfoEndpoint = "https://api.github.com/user";
+var userEmailsEndpoint = "https://api.github.com/user/emails";
+var defaultMetadata = {
+  id: "github-universal",
+  target: "github",
+  platform: ConnectorPlatform.Universal,
+  name: {
+    en: "GitHub",
+    "zh-CN": "GitHub",
+    "tr-TR": "GitHub",
+    ko: "GitHub"
+  },
+  logo: "./logo.svg",
+  logoDark: "./logo-dark.svg",
+  description: {
+    en: "GitHub is an online community for software development and version control.",
+    "zh-CN": "GitHub \u662F\u6781\u53D7\u6B22\u8FCE\u7684\u4EE3\u7801\u6258\u7BA1\u4ED3\u5E93\u3002",
+    "tr-TR": "GitHub, yaz\u0131l\u0131m geli\u015Ftirme ve s\xFCr\xFCm kontrol\xFC i\xE7in \xE7evrimi\xE7i bir topluluktur.",
+    ko: "GitHub\uB294 \uC18C\uD504\uD2B8\uC6E8\uC5B4 \uAC1C\uBC1C\uACFC \uBC84\uC804 \uAD00\uB9AC\uB97C \uC704\uD55C \uC628\uB77C\uC778 \uCEE4\uBBA4\uB2C8\uD2F0\uC785\uB2C8\uB2E4."
+  },
+  readme: "./README.md",
+  formItems: [
+    {
+      key: "clientId",
+      type: ConnectorConfigFormItemType.Text,
+      label: "Client ID",
+      required: true,
+      placeholder: "<client-id>"
     },
-    logo: './logo.svg',
-    logoDark: './logo-dark.svg',
-    description: {
-        en: 'GitHub is an online community for software development and version control.',
-        'zh-CN': 'GitHub 是极受欢迎的代码托管仓库。',
-        'tr-TR': 'GitHub, yazılım geliştirme ve sürüm kontrolü için çevrimiçi bir topluluktur.',
-        ko: 'GitHub는 소프트웨어 개발과 버전 관리를 위한 온라인 커뮤니티입니다.',
+    {
+      key: "clientSecret",
+      type: ConnectorConfigFormItemType.Text,
+      label: "Client Secret",
+      required: true,
+      placeholder: "<client-secret>"
     },
-    readme: './README.md',
-    formItems: [
-        {
-            key: 'clientId',
-            type: ConnectorConfigFormItemType.Text,
-            label: 'Client ID',
-            required: true,
-            placeholder: '<client-id>',
-        },
-        {
-            key: 'clientSecret',
-            type: ConnectorConfigFormItemType.Text,
-            label: 'Client Secret',
-            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;
-
-const githubConfigGuard = z.object({
-    clientId: z.string(),
-    clientSecret: z.string(),
-    scope: z.string().optional(),
+    {
+      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."
+    }
+  ]
+};
+var defaultTimeout = 5e3;
+
+// src/types.ts
+import { z } from "zod";
+var githubConfigGuard = z.object({
+  clientId: z.string(),
+  clientSecret: z.string(),
+  scope: z.string().optional()
 });
-/**
- * This guard is used to validate the response from the GitHub API when requesting the user's email addresses.
- * Ref: https://docs.github.com/en/rest/users/emails?apiVersion=2022-11-28#list-email-addresses-for-the-authenticated-user
- */
-const emailAddressGuard = z.object({
-    email: z.string(),
-    primary: z.boolean(),
-    verified: z.boolean(),
-    visibility: z.string().nullable(),
+var emailAddressGuard = z.object({
+  email: z.string(),
+  primary: z.boolean(),
+  verified: z.boolean(),
+  visibility: z.string().nullable()
 });
-const accessTokenResponseGuard = z.object({
-    access_token: z.string(),
-    scope: z.string(),
-    token_type: z.string(),
+var accessTokenResponseGuard = z.object({
+  access_token: z.string(),
+  scope: z.string(),
+  token_type: z.string()
 });
-const userInfoResponseGuard = z.object({
-    id: z.number(),
-    avatar_url: z.string().optional().nullable(),
-    email: z.string().optional().nullable(),
-    name: z.string().optional().nullable(),
+var userInfoResponseGuard = z.object({
+  id: z.number(),
+  avatar_url: z.string().optional().nullable(),
+  email: z.string().optional().nullable(),
+  name: z.string().optional().nullable()
 });
-const authorizationCallbackErrorGuard = z.object({
-    error: z.string(),
-    error_description: z.string(),
-    error_uri: z.string(),
+var authorizationCallbackErrorGuard = z.object({
+  error: z.string(),
+  error_description: z.string(),
+  error_uri: z.string()
 });
-const authResponseGuard = z.object({ code: z.string() });
-
-const getAuthorizationUri = (getConfig) => async ({ state, redirectUri }) => {
-    const config = await getConfig(defaultMetadata.id);
-    validateConfig(config, githubConfigGuard);
-    const queryParameters = new URLSearchParams({
-        client_id: config.clientId,
-        redirect_uri: redirectUri,
-        state,
-        scope: config.scope ?? scope,
-    });
-    return `${authorizationEndpoint}?${queryParameters.toString()}`;
-};
-const authorizationCallbackHandler = async (parameterObject) => {
-    const result = authResponseGuard.safeParse(parameterObject);
-    if (result.success) {
-        return result.data;
-    }
-    const parsedError = authorizationCallbackErrorGuard.safeParse(parameterObject);
-    if (!parsedError.success) {
-        throw new ConnectorError(ConnectorErrorCodes.General, JSON.stringify(parameterObject));
-    }
-    const { error, error_description, error_uri } = parsedError.data;
-    if (error === 'access_denied') {
-        throw new ConnectorError(ConnectorErrorCodes.AuthorizationFailed, error_description);
-    }
-    throw new ConnectorError(ConnectorErrorCodes.General, {
-        error,
-        errorDescription: error_description,
-        error_uri,
-    });
-};
-const getAccessToken = async (config, codeObject) => {
-    const { code } = codeObject;
-    const { clientId: client_id, clientSecret: client_secret } = config;
-    const httpResponse = await ky
-        .post(accessTokenEndpoint, {
-        body: new URLSearchParams({
-            client_id,
-            client_secret,
-            code,
-        }),
-        timeout: defaultTimeout,
-    })
-        .json();
-    const result = accessTokenResponseGuard.safeParse(httpResponse);
-    if (!result.success) {
-        throw new ConnectorError(ConnectorErrorCodes.InvalidResponse, result.error);
-    }
-    const { access_token: accessToken } = result.data;
-    assert(accessToken, new ConnectorError(ConnectorErrorCodes.SocialAuthCodeInvalid));
-    return { accessToken };
-};
-const getUserInfo = (getConfig) => async (data) => {
-    const { code } = await authorizationCallbackHandler(data);
-    const config = await getConfig(defaultMetadata.id);
-    validateConfig(config, githubConfigGuard);
-    const { accessToken } = await getAccessToken(config, { code });
-    const authedApi = ky.create({
-        timeout: defaultTimeout,
-        hooks: {
-            beforeRequest: [
-                (request) => {
-                    request.headers.set('Authorization', `Bearer ${accessToken}`);
-                },
-            ],
-        },
-    });
-    try {
-        /**
-         * If user(s) is using GitHub Apps (instead of OAuth Apps), they can customize
-         * "Account permissions" and restrict the "email addresses" visibility, and GitHub
-         * hence throws error instead of returning an empty array.
-         *
-         * We try catch the error and return an empty array instead.
-         */
-        const [userInfo, userEmails = []] = await Promise.all([
-            authedApi.get(userInfoEndpoint).json(),
-            trySafe(authedApi.get(userEmailsEndpoint).json()),
-        ]);
-        const userInfoResult = userInfoResponseGuard.safeParse(userInfo);
-        const userEmailsResult = emailAddressGuard.array().safeParse(userEmails);
-        if (!userInfoResult.success) {
-            throw new ConnectorError(ConnectorErrorCodes.InvalidResponse, userInfoResult.error);
-        }
-        if (!userEmailsResult.success) {
-            throw new ConnectorError(ConnectorErrorCodes.InvalidResponse, userEmailsResult.error);
-        }
-        const { id, avatar_url: avatar, email: publicEmail, name } = userInfoResult.data;
-        return {
-            id: String(id),
-            avatar: conditional(avatar),
-            email: conditional(publicEmail ??
-                userEmailsResult.data.find(({ verified, primary }) => verified && primary)?.email),
-            name: conditional(name),
-            rawData: jsonGuard.parse({
-                userInfo,
-                userEmails,
-            }),
-        };
-    }
-    catch (error) {
-        if (error instanceof HTTPError) {
-            const { status, body: rawBody } = error.response;
-            if (status === 401) {
-                throw new ConnectorError(ConnectorErrorCodes.SocialAccessTokenInvalid);
-            }
-            throw new ConnectorError(ConnectorErrorCodes.General, JSON.stringify(rawBody));
-        }
-        throw error;
-    }
-};
-const createGithubConnector = async ({ getConfig }) => {
+var authResponseGuard = z.object({ code: z.string() });
+
+// src/index.ts
+var getAuthorizationUri = (getConfig) => async ({ state, redirectUri }) => {
+  const config = await getConfig(defaultMetadata.id);
+  validateConfig(config, githubConfigGuard);
+  const queryParameters = new URLSearchParams({
+    client_id: config.clientId,
+    redirect_uri: redirectUri,
+    state,
+    scope: config.scope ?? scope
+  });
+  return `${authorizationEndpoint}?${queryParameters.toString()}`;
+};
+var authorizationCallbackHandler = async (parameterObject) => {
+  const result = authResponseGuard.safeParse(parameterObject);
+  if (result.success) {
+    return result.data;
+  }
+  const parsedError = authorizationCallbackErrorGuard.safeParse(parameterObject);
+  if (!parsedError.success) {
+    throw new ConnectorError(ConnectorErrorCodes.General, JSON.stringify(parameterObject));
+  }
+  const { error, error_description, error_uri } = parsedError.data;
+  if (error === "access_denied") {
+    throw new ConnectorError(ConnectorErrorCodes.AuthorizationFailed, error_description);
+  }
+  throw new ConnectorError(ConnectorErrorCodes.General, {
+    error,
+    errorDescription: error_description,
+    error_uri
+  });
+};
+var getAccessToken = async (config, codeObject) => {
+  const { code } = codeObject;
+  const { clientId: client_id, clientSecret: client_secret } = config;
+  const httpResponse = await ky.post(accessTokenEndpoint, {
+    body: new URLSearchParams({
+      client_id,
+      client_secret,
+      code
+    }),
+    timeout: defaultTimeout
+  }).json();
+  const result = accessTokenResponseGuard.safeParse(httpResponse);
+  if (!result.success) {
+    throw new ConnectorError(ConnectorErrorCodes.InvalidResponse, result.error);
+  }
+  const { access_token: accessToken } = result.data;
+  assert(accessToken, new ConnectorError(ConnectorErrorCodes.SocialAuthCodeInvalid));
+  return { accessToken };
+};
+var getUserInfo = (getConfig) => async (data) => {
+  const { code } = await authorizationCallbackHandler(data);
+  const config = await getConfig(defaultMetadata.id);
+  validateConfig(config, githubConfigGuard);
+  const { accessToken } = await getAccessToken(config, { code });
+  const authedApi = ky.create({
+    timeout: defaultTimeout,
+    hooks: {
+      beforeRequest: [
+        (request) => {
+          request.headers.set("Authorization", `Bearer ${accessToken}`);
+        }
+      ]
+    }
+  });
+  try {
+    const [userInfo, userEmails = []] = await Promise.all([
+      authedApi.get(userInfoEndpoint).json(),
+      trySafe(authedApi.get(userEmailsEndpoint).json())
+    ]);
+    const userInfoResult = userInfoResponseGuard.safeParse(userInfo);
+    const userEmailsResult = emailAddressGuard.array().safeParse(userEmails);
+    if (!userInfoResult.success) {
+      throw new ConnectorError(ConnectorErrorCodes.InvalidResponse, userInfoResult.error);
+    }
+    if (!userEmailsResult.success) {
+      throw new ConnectorError(ConnectorErrorCodes.InvalidResponse, userEmailsResult.error);
+    }
+    const { id, avatar_url: avatar, email: publicEmail, name } = userInfoResult.data;
     return {
-        metadata: defaultMetadata,
-        type: ConnectorType.Social,
-        configGuard: githubConfigGuard,
-        getAuthorizationUri: getAuthorizationUri(getConfig),
-        getUserInfo: getUserInfo(getConfig),
+      id: String(id),
+      avatar: conditional(avatar),
+      email: conditional(
+        publicEmail ?? userEmailsResult.data.find(({ verified, primary }) => verified && primary)?.email
+      ),
+      name: conditional(name),
+      rawData: jsonGuard.parse({
+        userInfo,
+        userEmails
+      })
     };
-};
-
-export { createGithubConnector as default, getAccessToken };
+  } catch (error) {
+    if (error instanceof HTTPError) {
+      const { status, body: rawBody } = error.response;
+      if (status === 401) {
+        throw new ConnectorError(ConnectorErrorCodes.SocialAccessTokenInvalid);
+      }
+      throw new ConnectorError(ConnectorErrorCodes.General, JSON.stringify(rawBody));
+    }
+    throw error;
+  }
+};
+var createGithubConnector = async ({ getConfig }) => {
+  return {
+    metadata: defaultMetadata,
+    type: ConnectorType.Social,
+    configGuard: githubConfigGuard,
+    getAuthorizationUri: getAuthorizationUri(getConfig),
+    getUserInfo: getUserInfo(getConfig)
+  };
+};
+var src_default = createGithubConnector;
+export {
+  src_default as default,
+  getAccessToken
+};
+//# sourceMappingURL=index.js.map

package/lib/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/index.ts","../src/constant.ts","../src/types.ts"],"sourcesContent":["import { assert, conditional, trySafe } from '@silverhand/essentials';\n\nimport {\n  ConnectorError,\n  ConnectorErrorCodes,\n  validateConfig,\n  ConnectorType,\n  jsonGuard,\n} from '@logto/connector-kit';\nimport type {\n  GetAuthorizationUri,\n  GetUserInfo,\n  SocialConnector,\n  CreateConnector,\n  GetConnectorConfig,\n} from '@logto/connector-kit';\nimport ky, { HTTPError } from 'ky';\n\nimport {\n  authorizationEndpoint,\n  accessTokenEndpoint,\n  scope as defaultScope,\n  userInfoEndpoint,\n  userEmailsEndpoint,\n  defaultMetadata,\n  defaultTimeout,\n} from './constant.js';\nimport type { GithubConfig } from './types.js';\nimport {\n  authorizationCallbackErrorGuard,\n  githubConfigGuard,\n  emailAddressGuard,\n  accessTokenResponseGuard,\n  userInfoResponseGuard,\n  authResponseGuard,\n} from './types.js';\n\nconst getAuthorizationUri =\n  (getConfig: GetConnectorConfig): GetAuthorizationUri =>\n  async ({ state, redirectUri }) => {\n    const config = await getConfig(defaultMetadata.id);\n    validateConfig(config, githubConfigGuard);\n    const queryParameters = new URLSearchParams({\n      client_id: config.clientId,\n      redirect_uri: redirectUri,\n      state,\n      scope: config.scope ?? defaultScope,\n    });\n\n    return `${authorizationEndpoint}?${queryParameters.toString()}`;\n  };\n\nconst authorizationCallbackHandler = async (parameterObject: unknown) => {\n  const result = authResponseGuard.safeParse(parameterObject);\n\n  if (result.success) {\n    return result.data;\n  }\n\n  const parsedError = authorizationCallbackErrorGuard.safeParse(parameterObject);\n\n  if (!parsedError.success) {\n    throw new ConnectorError(ConnectorErrorCodes.General, JSON.stringify(parameterObject));\n  }\n\n  const { error, error_description, error_uri } = parsedError.data;\n\n  if (error === 'access_denied') {\n    throw new ConnectorError(ConnectorErrorCodes.AuthorizationFailed, error_description);\n  }\n\n  throw new ConnectorError(ConnectorErrorCodes.General, {\n    error,\n    errorDescription: error_description,\n    error_uri,\n  });\n};\n\nexport const getAccessToken = async (config: GithubConfig, codeObject: { code: string }) => {\n  const { code } = codeObject;\n  const { clientId: client_id, clientSecret: client_secret } = config;\n\n  const httpResponse = await ky\n    .post(accessTokenEndpoint, {\n      body: new URLSearchParams({\n        client_id,\n        client_secret,\n        code,\n      }),\n      timeout: defaultTimeout,\n    })\n    .json();\n\n  const result = accessTokenResponseGuard.safeParse(httpResponse);\n\n  if (!result.success) {\n    throw new ConnectorError(ConnectorErrorCodes.InvalidResponse, result.error);\n  }\n\n  const { access_token: accessToken } = result.data;\n\n  assert(accessToken, new ConnectorError(ConnectorErrorCodes.SocialAuthCodeInvalid));\n\n  return { accessToken };\n};\n\nconst getUserInfo =\n  (getConfig: GetConnectorConfig): GetUserInfo =>\n  async (data) => {\n    const { code } = await authorizationCallbackHandler(data);\n    const config = await getConfig(defaultMetadata.id);\n    validateConfig(config, githubConfigGuard);\n    const { accessToken } = await getAccessToken(config, { code });\n\n    const authedApi = ky.create({\n      timeout: defaultTimeout,\n      hooks: {\n        beforeRequest: [\n          (request) => {\n            request.headers.set('Authorization', `Bearer ${accessToken}`);\n          },\n        ],\n      },\n    });\n\n    try {\n      /**\n       * If user(s) is using GitHub Apps (instead of OAuth Apps), they can customize\n       * \"Account permissions\" and restrict the \"email addresses\" visibility, and GitHub\n       * hence throws error instead of returning an empty array.\n       *\n       * We try catch the error and return an empty array instead.\n       */\n      const [userInfo, userEmails = []] = await Promise.all([\n        authedApi.get(userInfoEndpoint).json(),\n        trySafe(authedApi.get(userEmailsEndpoint).json()),\n      ]);\n\n      const userInfoResult = userInfoResponseGuard.safeParse(userInfo);\n      const userEmailsResult = emailAddressGuard.array().safeParse(userEmails);\n\n      if (!userInfoResult.success) {\n        throw new ConnectorError(ConnectorErrorCodes.InvalidResponse, userInfoResult.error);\n      }\n\n      if (!userEmailsResult.success) {\n        throw new ConnectorError(ConnectorErrorCodes.InvalidResponse, userEmailsResult.error);\n      }\n\n      const { id, avatar_url: avatar, email: publicEmail, name } = userInfoResult.data;\n\n      return {\n        id: String(id),\n        avatar: conditional(avatar),\n        email: conditional(\n          publicEmail ??\n            userEmailsResult.data.find(({ verified, primary }) => verified && primary)?.email\n        ),\n        name: conditional(name),\n        rawData: jsonGuard.parse({\n          userInfo,\n          userEmails,\n        }),\n      };\n    } catch (error: unknown) {\n      if (error instanceof HTTPError) {\n        const { status, body: rawBody } = error.response;\n\n        if (status === 401) {\n          throw new ConnectorError(ConnectorErrorCodes.SocialAccessTokenInvalid);\n        }\n\n        throw new ConnectorError(ConnectorErrorCodes.General, JSON.stringify(rawBody));\n      }\n\n      throw error;\n    }\n  };\n\nconst createGithubConnector: CreateConnector<SocialConnector> = async ({ getConfig }) => {\n  return {\n    metadata: defaultMetadata,\n    type: ConnectorType.Social,\n    configGuard: githubConfigGuard,\n    getAuthorizationUri: getAuthorizationUri(getConfig),\n    getUserInfo: getUserInfo(getConfig),\n  };\n};\n\nexport default createGithubConnector;\n","import type { ConnectorMetadata } from '@logto/connector-kit';\nimport { ConnectorPlatform, ConnectorConfigFormItemType } from '@logto/connector-kit';\n\nexport const authorizationEndpoint = 'https://github.com/login/oauth/authorize';\n/**\n * `read:user` read user profile data; `user:email` read user email addresses (including private email addresses).\n * Ref: https://docs.github.com/en/apps/oauth-apps/building-oauth-apps/scopes-for-oauth-apps\n */\nexport const scope = 'read:user user:email';\nexport const accessTokenEndpoint = 'https://github.com/login/oauth/access_token';\nexport const userInfoEndpoint = 'https://api.github.com/user';\n// Ref: https://docs.github.com/en/rest/users/emails?apiVersion=2022-11-28#list-email-addresses-for-the-authenticated-user\nexport const userEmailsEndpoint = 'https://api.github.com/user/emails';\n\nexport const defaultMetadata: ConnectorMetadata = {\n  id: 'github-universal',\n  target: 'github',\n  platform: ConnectorPlatform.Universal,\n  name: {\n    en: 'GitHub',\n    'zh-CN': 'GitHub',\n    'tr-TR': 'GitHub',\n    ko: 'GitHub',\n  },\n  logo: './logo.svg',\n  logoDark: './logo-dark.svg',\n  description: {\n    en: 'GitHub is an online community for software development and version control.',\n    'zh-CN': 'GitHub 是极受欢迎的代码托管仓库。',\n    'tr-TR': 'GitHub, yazılım geliştirme ve sürüm kontrolü için çevrimiçi bir topluluktur.',\n    ko: 'GitHub는 소프트웨어 개발과 버전 관리를 위한 온라인 커뮤니티입니다.',\n  },\n  readme: './README.md',\n  formItems: [\n    {\n      key: 'clientId',\n      type: ConnectorConfigFormItemType.Text,\n      label: 'Client ID',\n      required: true,\n      placeholder: '<client-id>',\n    },\n    {\n      key: 'clientSecret',\n      type: ConnectorConfigFormItemType.Text,\n      label: 'Client Secret',\n      required: true,\n      placeholder: '<client-secret>',\n    },\n    {\n      key: 'scope',\n      type: ConnectorConfigFormItemType.Text,\n      label: 'Scope',\n      required: false,\n      placeholder: '<scope>',\n      description:\n        \"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.\",\n    },\n  ],\n};\n\nexport const defaultTimeout = 5000;\n","import { z } from 'zod';\n\nexport const githubConfigGuard = z.object({\n  clientId: z.string(),\n  clientSecret: z.string(),\n  scope: z.string().optional(),\n});\n\nexport type GithubConfig = z.infer<typeof githubConfigGuard>;\n\n/**\n * This guard is used to validate the response from the GitHub API when requesting the user's email addresses.\n * Ref: https://docs.github.com/en/rest/users/emails?apiVersion=2022-11-28#list-email-addresses-for-the-authenticated-user\n */\nexport const emailAddressGuard = z.object({\n  email: z.string(),\n  primary: z.boolean(),\n  verified: z.boolean(),\n  visibility: z.string().nullable(),\n});\n\nexport const accessTokenResponseGuard = z.object({\n  access_token: z.string(),\n  scope: z.string(),\n  token_type: z.string(),\n});\n\nexport type AccessTokenResponse = z.infer<typeof accessTokenResponseGuard>;\n\nexport const userInfoResponseGuard = z.object({\n  id: z.number(),\n  avatar_url: z.string().optional().nullable(),\n  email: z.string().optional().nullable(),\n  name: z.string().optional().nullable(),\n});\n\nexport type UserInfoResponse = z.infer<typeof userInfoResponseGuard>;\n\nexport const authorizationCallbackErrorGuard = z.object({\n  error: z.string(),\n  error_description: z.string(),\n  error_uri: z.string(),\n});\n\nexport const authResponseGuard = z.object({ code: z.string() });\n"],"mappings":";AAAA,SAAS,QAAQ,aAAa,eAAe;AAE7C;AAAA,EACE;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,OACK;AAQP,OAAO,MAAM,iBAAiB;;;ACf9B,SAAS,mBAAmB,mCAAmC;AAExD,IAAM,wBAAwB;AAK9B,IAAM,QAAQ;AACd,IAAM,sBAAsB;AAC5B,IAAM,mBAAmB;AAEzB,IAAM,qBAAqB;AAE3B,IAAM,kBAAqC;AAAA,EAChD,IAAI;AAAA,EACJ,QAAQ;AAAA,EACR,UAAU,kBAAkB;AAAA,EAC5B,MAAM;AAAA,IACJ,IAAI;AAAA,IACJ,SAAS;AAAA,IACT,SAAS;AAAA,IACT,IAAI;AAAA,EACN;AAAA,EACA,MAAM;AAAA,EACN,UAAU;AAAA,EACV,aAAa;AAAA,IACX,IAAI;AAAA,IACJ,SAAS;AAAA,IACT,SAAS;AAAA,IACT,IAAI;AAAA,EACN;AAAA,EACA,QAAQ;AAAA,EACR,WAAW;AAAA,IACT;AAAA,MACE,KAAK;AAAA,MACL,MAAM,4BAA4B;AAAA,MAClC,OAAO;AAAA,MACP,UAAU;AAAA,MACV,aAAa;AAAA,IACf;AAAA,IACA;AAAA,MACE,KAAK;AAAA,MACL,MAAM,4BAA4B;AAAA,MAClC,OAAO;AAAA,MACP,UAAU;AAAA,MACV,aAAa;AAAA,IACf;AAAA,IACA;AAAA,MACE,KAAK;AAAA,MACL,MAAM,4BAA4B;AAAA,MAClC,OAAO;AAAA,MACP,UAAU;AAAA,MACV,aAAa;AAAA,MACb,aACE;AAAA,IACJ;AAAA,EACF;AACF;AAEO,IAAM,iBAAiB;;;AC5D9B,SAAS,SAAS;AAEX,IAAM,oBAAoB,EAAE,OAAO;AAAA,EACxC,UAAU,EAAE,OAAO;AAAA,EACnB,cAAc,EAAE,OAAO;AAAA,EACvB,OAAO,EAAE,OAAO,EAAE,SAAS;AAC7B,CAAC;AAQM,IAAM,oBAAoB,EAAE,OAAO;AAAA,EACxC,OAAO,EAAE,OAAO;AAAA,EAChB,SAAS,EAAE,QAAQ;AAAA,EACnB,UAAU,EAAE,QAAQ;AAAA,EACpB,YAAY,EAAE,OAAO,EAAE,SAAS;AAClC,CAAC;AAEM,IAAM,2BAA2B,EAAE,OAAO;AAAA,EAC/C,cAAc,EAAE,OAAO;AAAA,EACvB,OAAO,EAAE,OAAO;AAAA,EAChB,YAAY,EAAE,OAAO;AACvB,CAAC;AAIM,IAAM,wBAAwB,EAAE,OAAO;AAAA,EAC5C,IAAI,EAAE,OAAO;AAAA,EACb,YAAY,EAAE,OAAO,EAAE,SAAS,EAAE,SAAS;AAAA,EAC3C,OAAO,EAAE,OAAO,EAAE,SAAS,EAAE,SAAS;AAAA,EACtC,MAAM,EAAE,OAAO,EAAE,SAAS,EAAE,SAAS;AACvC,CAAC;AAIM,IAAM,kCAAkC,EAAE,OAAO;AAAA,EACtD,OAAO,EAAE,OAAO;AAAA,EAChB,mBAAmB,EAAE,OAAO;AAAA,EAC5B,WAAW,EAAE,OAAO;AACtB,CAAC;AAEM,IAAM,oBAAoB,EAAE,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,CAAC;;;AFP9D,IAAM,sBACJ,CAAC,cACD,OAAO,EAAE,OAAO,YAAY,MAAM;AAChC,QAAM,SAAS,MAAM,UAAU,gBAAgB,EAAE;AACjD,iBAAe,QAAQ,iBAAiB;AACxC,QAAM,kBAAkB,IAAI,gBAAgB;AAAA,IAC1C,WAAW,OAAO;AAAA,IAClB,cAAc;AAAA,IACd;AAAA,IACA,OAAO,OAAO,SAAS;AAAA,EACzB,CAAC;AAED,SAAO,GAAG,qBAAqB,IAAI,gBAAgB,SAAS,CAAC;AAC/D;AAEF,IAAM,+BAA+B,OAAO,oBAA6B;AACvE,QAAM,SAAS,kBAAkB,UAAU,eAAe;AAE1D,MAAI,OAAO,SAAS;AAClB,WAAO,OAAO;AAAA,EAChB;AAEA,QAAM,cAAc,gCAAgC,UAAU,eAAe;AAE7E,MAAI,CAAC,YAAY,SAAS;AACxB,UAAM,IAAI,eAAe,oBAAoB,SAAS,KAAK,UAAU,eAAe,CAAC;AAAA,EACvF;AAEA,QAAM,EAAE,OAAO,mBAAmB,UAAU,IAAI,YAAY;AAE5D,MAAI,UAAU,iBAAiB;AAC7B,UAAM,IAAI,eAAe,oBAAoB,qBAAqB,iBAAiB;AAAA,EACrF;AAEA,QAAM,IAAI,eAAe,oBAAoB,SAAS;AAAA,IACpD;AAAA,IACA,kBAAkB;AAAA,IAClB;AAAA,EACF,CAAC;AACH;AAEO,IAAM,iBAAiB,OAAO,QAAsB,eAAiC;AAC1F,QAAM,EAAE,KAAK,IAAI;AACjB,QAAM,EAAE,UAAU,WAAW,cAAc,cAAc,IAAI;AAE7D,QAAM,eAAe,MAAM,GACxB,KAAK,qBAAqB;AAAA,IACzB,MAAM,IAAI,gBAAgB;AAAA,MACxB;AAAA,MACA;AAAA,MACA;AAAA,IACF,CAAC;AAAA,IACD,SAAS;AAAA,EACX,CAAC,EACA,KAAK;AAER,QAAM,SAAS,yBAAyB,UAAU,YAAY;AAE9D,MAAI,CAAC,OAAO,SAAS;AACnB,UAAM,IAAI,eAAe,oBAAoB,iBAAiB,OAAO,KAAK;AAAA,EAC5E;AAEA,QAAM,EAAE,cAAc,YAAY,IAAI,OAAO;AAE7C,SAAO,aAAa,IAAI,eAAe,oBAAoB,qBAAqB,CAAC;AAEjF,SAAO,EAAE,YAAY;AACvB;AAEA,IAAM,cACJ,CAAC,cACD,OAAO,SAAS;AACd,QAAM,EAAE,KAAK,IAAI,MAAM,6BAA6B,IAAI;AACxD,QAAM,SAAS,MAAM,UAAU,gBAAgB,EAAE;AACjD,iBAAe,QAAQ,iBAAiB;AACxC,QAAM,EAAE,YAAY,IAAI,MAAM,eAAe,QAAQ,EAAE,KAAK,CAAC;AAE7D,QAAM,YAAY,GAAG,OAAO;AAAA,IAC1B,SAAS;AAAA,IACT,OAAO;AAAA,MACL,eAAe;AAAA,QACb,CAAC,YAAY;AACX,kBAAQ,QAAQ,IAAI,iBAAiB,UAAU,WAAW,EAAE;AAAA,QAC9D;AAAA,MACF;AAAA,IACF;AAAA,EACF,CAAC;AAED,MAAI;AAQF,UAAM,CAAC,UAAU,aAAa,CAAC,CAAC,IAAI,MAAM,QAAQ,IAAI;AAAA,MACpD,UAAU,IAAI,gBAAgB,EAAE,KAAK;AAAA,MACrC,QAAQ,UAAU,IAAI,kBAAkB,EAAE,KAAK,CAAC;AAAA,IAClD,CAAC;AAED,UAAM,iBAAiB,sBAAsB,UAAU,QAAQ;AAC/D,UAAM,mBAAmB,kBAAkB,MAAM,EAAE,UAAU,UAAU;AAEvE,QAAI,CAAC,eAAe,SAAS;AAC3B,YAAM,IAAI,eAAe,oBAAoB,iBAAiB,eAAe,KAAK;AAAA,IACpF;AAEA,QAAI,CAAC,iBAAiB,SAAS;AAC7B,YAAM,IAAI,eAAe,oBAAoB,iBAAiB,iBAAiB,KAAK;AAAA,IACtF;AAEA,UAAM,EAAE,IAAI,YAAY,QAAQ,OAAO,aAAa,KAAK,IAAI,eAAe;AAE5E,WAAO;AAAA,MACL,IAAI,OAAO,EAAE;AAAA,MACb,QAAQ,YAAY,MAAM;AAAA,MAC1B,OAAO;AAAA,QACL,eACE,iBAAiB,KAAK,KAAK,CAAC,EAAE,UAAU,QAAQ,MAAM,YAAY,OAAO,GAAG;AAAA,MAChF;AAAA,MACA,MAAM,YAAY,IAAI;AAAA,MACtB,SAAS,UAAU,MAAM;AAAA,QACvB;AAAA,QACA;AAAA,MACF,CAAC;AAAA,IACH;AAAA,EACF,SAAS,OAAgB;AACvB,QAAI,iBAAiB,WAAW;AAC9B,YAAM,EAAE,QAAQ,MAAM,QAAQ,IAAI,MAAM;AAExC,UAAI,WAAW,KAAK;AAClB,cAAM,IAAI,eAAe,oBAAoB,wBAAwB;AAAA,MACvE;AAEA,YAAM,IAAI,eAAe,oBAAoB,SAAS,KAAK,UAAU,OAAO,CAAC;AAAA,IAC/E;AAEA,UAAM;AAAA,EACR;AACF;AAEF,IAAM,wBAA0D,OAAO,EAAE,UAAU,MAAM;AACvF,SAAO;AAAA,IACL,UAAU;AAAA,IACV,MAAM,cAAc;AAAA,IACpB,aAAa;AAAA,IACb,qBAAqB,oBAAoB,SAAS;AAAA,IAClD,aAAa,YAAY,SAAS;AAAA,EACpC;AACF;AAEA,IAAO,cAAQ;","names":[]}

package/package.json

@@ -1,15 +1,15 @@
 {
   "name": "@logto/connector-github",
-  "version": "1.4.1",
+  "version": "1.5.0",
   "description": "Github web connector implementation.",
   "author": "Silverhand Inc. <contact@silverhand.io>",
   "dependencies": {
-    "@logto/connector-kit": "^3.0.0",
+    "@logto/connector-kit": "^4.0.0",
     "@silverhand/essentials": "^2.9.1",
     "ky": "^1.2.3",
     "query-string": "^9.0.0",
-    "snakecase-keys": "^8.0.0",
-    "zod": "^3.22.4"
+    "snakecase-keys": "^8.0.1",
+    "zod": "^3.23.8"
   },
   "main": "./lib/index.js",
   "module": "./lib/index.js",
@@ -42,30 +42,25 @@
     "access": "public"
   },
   "devDependencies": {
-    "@rollup/plugin-commonjs": "^25.0.7",
-    "@rollup/plugin-json": "^6.1.0",
-    "@rollup/plugin-node-resolve": "^15.2.3",
-    "@rollup/plugin-typescript": "^11.1.6",
     "@silverhand/eslint-config": "6.0.1",
     "@silverhand/ts-config": "6.0.0",
     "@types/node": "^20.11.20",
     "@types/supertest": "^6.0.2",
-    "@vitest/coverage-v8": "^1.4.0",
+    "@vitest/coverage-v8": "^2.0.0",
     "eslint": "^8.56.0",
     "lint-staged": "^15.0.2",
-    "nock": "14.0.0-beta.7",
+    "nock": "14.0.0-beta.9",
     "prettier": "^3.0.0",
-    "rollup": "^4.12.0",
-    "rollup-plugin-output-size": "^1.3.0",
     "supertest": "^7.0.0",
-    "typescript": "^5.3.3",
-    "vitest": "^1.4.0"
+    "tsup": "^8.1.0",
+    "typescript": "^5.5.3",
+    "vitest": "^2.0.0"
   },
   "scripts": {
     "precommit": "lint-staged",
-    "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",
+    "check": "tsc --noEmit",
+    "build": "tsup",
+    "dev": "tsup --watch",
     "lint": "eslint --ext .ts src",
     "lint:report": "pnpm lint --format json --output-file report.json",
     "test": "vitest src",

package/lib/constant.d.ts

@@ -1,12 +0,0 @@
-import type { ConnectorMetadata } from '@logto/connector-kit';
-export declare const authorizationEndpoint = "https://github.com/login/oauth/authorize";
-/**
- * `read:user` read user profile data; `user:email` read user email addresses (including private email addresses).
- * Ref: https://docs.github.com/en/apps/oauth-apps/building-oauth-apps/scopes-for-oauth-apps
- */
-export declare const scope = "read:user user:email";
-export declare const accessTokenEndpoint = "https://github.com/login/oauth/access_token";
-export declare const userInfoEndpoint = "https://api.github.com/user";
-export declare const userEmailsEndpoint = "https://api.github.com/user/emails";
-export declare const defaultMetadata: ConnectorMetadata;
-export declare const defaultTimeout = 5000;

package/lib/index.d.ts

@@ -1,9 +0,0 @@
-import type { SocialConnector, CreateConnector } from '@logto/connector-kit';
-import type { GithubConfig } from './types.js';
-export declare const getAccessToken: (config: GithubConfig, codeObject: {
-    code: string;
-}) => Promise<{
-    accessToken: string;
-}>;
-declare const createGithubConnector: CreateConnector<SocialConnector>;
-export default createGithubConnector;

package/lib/mock.d.ts

@@ -1,4 +0,0 @@
-export declare const mockedConfig: {
-    clientId: string;
-    clientSecret: string;
-};

package/lib/types.d.ts

@@ -1,86 +0,0 @@
-import { z } from 'zod';
-export declare const githubConfigGuard: z.ZodObject<{
-    clientId: z.ZodString;
-    clientSecret: z.ZodString;
-    scope: z.ZodOptional<z.ZodString>;
-}, "strip", z.ZodTypeAny, {
-    clientId: string;
-    clientSecret: string;
-    scope?: string | undefined;
-}, {
-    clientId: string;
-    clientSecret: string;
-    scope?: string | undefined;
-}>;
-export type GithubConfig = z.infer<typeof githubConfigGuard>;
-/**
- * This guard is used to validate the response from the GitHub API when requesting the user's email addresses.
- * Ref: https://docs.github.com/en/rest/users/emails?apiVersion=2022-11-28#list-email-addresses-for-the-authenticated-user
- */
-export declare const emailAddressGuard: z.ZodObject<{
-    email: z.ZodString;
-    primary: z.ZodBoolean;
-    verified: z.ZodBoolean;
-    visibility: z.ZodNullable<z.ZodString>;
-}, "strip", z.ZodTypeAny, {
-    email: string;
-    primary: boolean;
-    verified: boolean;
-    visibility: string | null;
-}, {
-    email: string;
-    primary: boolean;
-    verified: boolean;
-    visibility: string | null;
-}>;
-export declare const accessTokenResponseGuard: z.ZodObject<{
-    access_token: z.ZodString;
-    scope: z.ZodString;
-    token_type: z.ZodString;
-}, "strip", z.ZodTypeAny, {
-    scope: string;
-    access_token: string;
-    token_type: string;
-}, {
-    scope: string;
-    access_token: string;
-    token_type: string;
-}>;
-export type AccessTokenResponse = z.infer<typeof accessTokenResponseGuard>;
-export declare const userInfoResponseGuard: z.ZodObject<{
-    id: z.ZodNumber;
-    avatar_url: z.ZodNullable<z.ZodOptional<z.ZodString>>;
-    email: z.ZodNullable<z.ZodOptional<z.ZodString>>;
-    name: z.ZodNullable<z.ZodOptional<z.ZodString>>;
-}, "strip", z.ZodTypeAny, {
-    id: number;
-    avatar_url?: string | null | undefined;
-    email?: string | null | undefined;
-    name?: string | null | undefined;
-}, {
-    id: number;
-    avatar_url?: string | null | undefined;
-    email?: string | null | undefined;
-    name?: string | null | undefined;
-}>;
-export type UserInfoResponse = z.infer<typeof userInfoResponseGuard>;
-export declare const authorizationCallbackErrorGuard: z.ZodObject<{
-    error: z.ZodString;
-    error_description: z.ZodString;
-    error_uri: z.ZodString;
-}, "strip", z.ZodTypeAny, {
-    error: string;
-    error_description: string;
-    error_uri: string;
-}, {
-    error: string;
-    error_description: string;
-    error_uri: string;
-}>;
-export declare const authResponseGuard: z.ZodObject<{
-    code: z.ZodString;
-}, "strip", z.ZodTypeAny, {
-    code: string;
-}, {
-    code: string;
-}>;