next-ssr-middleware 0.6.2 → 0.8.5

package/ReadMe.md

@@ -7,6 +7,23 @@
 
 [![NPM](https://nodei.co/npm/next-ssr-middleware.png?downloads=true&downloadRank=true&stars=true)][5]
 
+## Versions
+
+| SemVer  |    status    |    MobX     | [MobX i18n][6] |
+| :-----: | :----------: | :---------: | :------------: |
+| `>=0.7` | ✅developing |  `>=6.11`   |    `>=0.5`     |
+| `<0.7`  | ❌deprecated | `>=4 <6.11` |     `<0.5`     |
+
+## Middlewares
+
+1. Router
+2. Error logger
+3. JWT verifier
+4. Props cache
+5. i18n loader
+6. OAuth 2 signer (with common providers)
+    1. GitHub
+
 ## Usage
 
 ### `pages/user/[id].tsx`
@@ -60,9 +77,13 @@ export default function UserDetailPage({
 ## Cases
 
 1. https://github.com/idea2app/Next-Bootstrap-ts
+2. https://github.com/kaiyuanshe/kaiyuanshe.github.io
+3. https://github.com/kaiyuanshe/OpenHackathon-Web
+4. https://github.com/kaiyuanshe/OSS-toolbox
 
 [1]: https://koajs.com/
 [2]: https://nextjs.org/
 [3]: https://libraries.io/npm/next-ssr-middleware
 [4]: https://github.com/idea2app/Next-SSR-middleware/actions/workflows/main.yml
 [5]: https://nodei.co/npm/next-ssr-middleware/
+[6]: https://github.com/idea2app/MobX-i18n

package/dist/compose.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.compose = void 0;
+exports.compose = compose;
 var tslib_1 = require("tslib");
 function compose() {
     var _this = this;
@@ -23,5 +23,4 @@ function compose() {
         return first(context, next);
     });
 }
-exports.compose = compose;
 //# sourceMappingURL=compose.js.map

package/dist/compose.js.map

@@ -1 +1 @@
-{"version":3,"file":"compose.js","sourceRoot":"","sources":["../source/compose.ts"],"names":[],"mappings":";;;;AAaA,SAAgB,OAAO;IAAvB,iBAcC;IAVC,qBAAkC;SAAlC,UAAkC,EAAlC,qBAAkC,EAAlC,IAAkC;QAAlC,gCAAkC;;IAChC,OAAO,CAAC,UAAA,OAAO;QACJ,IAAA,KAAK,GAAa,WAAW,GAAxB,EAAK,IAAI,GAAI,WAAW,SAAf,CAAgB;QAErC,IAAM,IAAI,GAAG;;;;4BACR,qBAAM,CAAA,MAAA,IAAI,CAAC,KAAK,EAAE,0CAAG,OAAO,EAAE,IAAI,CAAC,CAAA,EAAA;4BAApC,sBAAA,CAAC,SAAmC,CAAC;4BACpC,EAAE,KAAK,EAAE,EAAE,EAAkC,EAAA;;;aAAA,CAAC;QAEnD,OAAO,KAAK,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;IAChC,CAAC,CAAM,CAAC;AACZ,CAAC;AAdD,0BAcC"}
+{"version":3,"file":"compose.js","sourceRoot":"","sources":["../source/compose.ts"],"names":[],"mappings":";;AAaA,0BAcC;;AAdD,SAAgB,OAAO;IAAvB,iBAcC;IAVC,qBAAkC;SAAlC,UAAkC,EAAlC,qBAAkC,EAAlC,IAAkC;QAAlC,gCAAkC;;IAChC,OAAO,CAAC,UAAA,OAAO;QACJ,IAAA,KAAK,GAAa,WAAW,GAAxB,EAAK,IAAI,GAAI,WAAW,SAAf,CAAgB;QAErC,IAAM,IAAI,GAAG;;;;4BACR,qBAAM,CAAA,MAAA,IAAI,CAAC,KAAK,EAAE,0CAAG,OAAO,EAAE,IAAI,CAAC,CAAA,EAAA;4BAApC,sBAAA,CAAC,SAAmC,CAAC;4BACpC,EAAE,KAAK,EAAE,EAAE,EAAkC,EAAA;;;aAAA,CAAC;QAEnD,OAAO,KAAK,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;IAChC,CAAC,CAAM,CAAC;AACZ,CAAC"}

package/dist/middleware/index.d.ts

@@ -0,0 +1,2 @@
+export * from './local';
+export * from './remote';

package/dist/middleware/index.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+var tslib_1 = require("tslib");
+tslib_1.__exportStar(require("./local"), exports);
+tslib_1.__exportStar(require("./remote"), exports);
+//# sourceMappingURL=index.js.map

package/dist/middleware/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../source/middleware/index.ts"],"names":[],"mappings":";;;AAAA,kDAAwB;AACxB,mDAAyB"}

package/dist/{middleware.d.ts → middleware/local.d.ts}

@@ -1,9 +1,8 @@
-/// <reference types="node" />
 import { JwtPayload, VerifyOptions } from 'jsonwebtoken';
 import { TranslationModel } from 'mobx-i18n';
 import { GetServerSidePropsContext, GetServerSidePropsResult } from 'next';
 import { ParsedUrlQuery } from 'querystring';
-import { DataObject, Middleware } from './compose';
+import { DataObject, Middleware } from '../compose';
 export declare function errorLogger<I extends DataObject, O extends DataObject = {}>(context: GetServerSidePropsContext<I>, next: () => Promise<GetServerSidePropsResult<O>>): Promise<GetServerSidePropsResult<O>>;
 export interface RouteProps<T extends ParsedUrlQuery = {}> {
     route: Pick<GetServerSidePropsContext<T>, 'resolvedUrl' | 'params' | 'query' | 'locales'>;

package/dist/{middleware.js → middleware/local.js}

@@ -1,8 +1,13 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.translator = exports.cache = exports.jwtVerifier = exports.router = exports.errorLogger = void 0;
+exports.errorLogger = errorLogger;
+exports.router = router;
+exports.jwtVerifier = jwtVerifier;
+exports.cache = cache;
+exports.translator = translator;
 var tslib_1 = require("tslib");
 var jsonwebtoken_1 = require("jsonwebtoken");
+var koajax_1 = require("koajax");
 var mobx_i18n_1 = require("mobx-i18n");
 var web_utility_1 = require("web-utility");
 function errorLogger(context, next) {
@@ -17,16 +22,17 @@ function errorLogger(context, next) {
                 case 2:
                     error_1 = _a.sent();
                     console.error(error_1);
-                    status_1 = error_1.status;
-                    if (status_1 === 404)
-                        return [2 /*return*/, { notFound: true, props: {} }];
+                    if (error_1 instanceof koajax_1.HTTPError) {
+                        status_1 = error_1.response.status;
+                        if (status_1 === 404)
+                            return [2 /*return*/, { notFound: true, props: {} }];
+                    }
                     throw error_1;
                 case 3: return [2 /*return*/];
             }
         });
     });
 }
-exports.errorLogger = errorLogger;
 function router(context, next) {
     return tslib_1.__awaiter(this, void 0, void 0, function () {
         var options, resolvedUrl, params, query, locales;
@@ -40,38 +46,34 @@ function router(context, next) {
         });
     });
 }
-exports.router = router;
 function jwtVerifier(tokenKey, secretKey, options) {
     var _this = this;
     if (tokenKey === void 0) { tokenKey = 'token'; }
     if (secretKey === void 0) { secretKey = 'JWT_SECRET'; }
     if (options === void 0) { options = {}; }
-    return function (_a, next) {
-        var _b = _a.req, url = _b.url, cookies = _b.cookies;
-        return tslib_1.__awaiter(_this, void 0, void 0, function () {
-            var token, jwtPayload, data;
-            return tslib_1.__generator(this, function (_c) {
-                switch (_c.label) {
-                    case 0:
-                        token = cookies[tokenKey];
-                        try {
-                            jwtPayload = (0, jsonwebtoken_1.verify)(token, process.env[secretKey], options);
-                        }
-                        catch (error) {
-                            console.error(url, error);
-                        }
-                        return [4 /*yield*/, next()];
-                    case 1:
-                        data = _c.sent();
-                        if ('props' in data && jwtPayload)
-                            data.props['jwtPayload'] = jwtPayload;
-                        return [2 /*return*/, data];
-                }
-            });
+    return function (_a, next_1) { return tslib_1.__awaiter(_this, [_a, next_1], void 0, function (_b, next) {
+        var token, jwtPayload, data;
+        var _c = _b.req, url = _c.url, cookies = _c.cookies;
+        return tslib_1.__generator(this, function (_d) {
+            switch (_d.label) {
+                case 0:
+                    token = cookies[tokenKey];
+                    try {
+                        jwtPayload = (0, jsonwebtoken_1.verify)(token, process.env[secretKey], options);
+                    }
+                    catch (error) {
+                        console.error(url, error);
+                    }
+                    return [4 /*yield*/, next()];
+                case 1:
+                    data = _d.sent();
+                    if ('props' in data && jwtPayload)
+                        data.props['jwtPayload'] = jwtPayload;
+                    return [2 /*return*/, data];
+            }
         });
-    };
+    }); };
 }
-exports.jwtVerifier = jwtVerifier;
 var serverRenderCache = {};
 function cache(oneInterval, allInterval) {
     var _this = this;
@@ -109,22 +111,21 @@ function cache(oneInterval, allInterval) {
         });
     }); });
 }
-exports.cache = cache;
 function translator(i18n) {
     var _this = this;
-    return function (context, next) { return tslib_1.__awaiter(_this, void 0, void 0, function () {
-        var _a, language, languages;
-        return tslib_1.__generator(this, function (_b) {
-            switch (_b.label) {
+    return function (_a, next_1) { return tslib_1.__awaiter(_this, [_a, next_1], void 0, function (_b, next) {
+        var _c, language, languages;
+        var _d = _b.req, headers = _d.headers, cookies = _d.cookies;
+        return tslib_1.__generator(this, function (_e) {
+            switch (_e.label) {
                 case 0:
-                    _a = context.req.cookies.language, language = _a === void 0 ? '' : _a, languages = (0, mobx_i18n_1.parseLanguageHeader)(context.req.headers['accept-language'] || '');
+                    _c = cookies.language, language = _c === void 0 ? '' : _c, languages = (0, mobx_i18n_1.parseLanguageHeader)(headers['accept-language'] || '');
                     return [4 /*yield*/, i18n.loadLanguages(tslib_1.__spreadArray([language], languages, true).filter(Boolean))];
                 case 1:
-                    _b.sent();
+                    _e.sent();
                     return [2 /*return*/, next()];
             }
         });
     }); };
 }
-exports.translator = translator;
-//# sourceMappingURL=middleware.js.map
+//# sourceMappingURL=local.js.map

package/dist/middleware/local.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"local.js","sourceRoot":"","sources":["../../source/middleware/local.ts"],"names":[],"mappings":";;AASA,kCAmBC;AASD,wBAgBC;AAMD,kCAoBC;AAUD,sBAqCC;AAED,gCAcC;;AA9ID,6CAAiE;AACjE,iCAAmC;AACnC,uCAAkE;AAGlE,2CAA0C;AAI1C,SAAsB,WAAW,CAI7B,OAAqC,EACrC,IAAgD;;;;;;;oBAGrC,qBAAM,IAAI,EAAE,EAAA;wBAAnB,sBAAO,SAAY,EAAC;;;oBAEpB,OAAO,CAAC,KAAK,CAAC,OAAK,CAAC,CAAC;oBAErB,IAAI,OAAK,YAAY,kBAAS,EAAE,CAAC;wBACrB,WAAW,OAAK,CAAC,QAAQ,OAAnB,CAAoB;wBAElC,IAAI,QAAM,KAAK,GAAG;4BAAE,sBAAO,EAAE,QAAQ,EAAE,IAAI,EAAE,KAAK,EAAE,EAAO,EAAE,EAAC;oBAClE,CAAC;oBACD,MAAM,OAAK,CAAC;;;;;CAEnB;AASD,SAAsB,MAAM,CACxB,OAAqC,EACrC,IAAgD;;;;;wBAE/B,qBAAM,IAAI,EAAE,EAAA;;oBAAvB,OAAO,GAAG,CAAC,SAAY,CAAC,IAAK,EAAmC,EAChE,WAAW,GAA6B,OAAO,YAApC,EAAE,MAAM,GAAqB,OAAO,OAA5B,EAAE,KAAK,GAAc,OAAO,MAArB,EAAE,OAAO,GAAK,OAAO,QAAZ;oBAEzC,sBAAO,sCACA,OAAO,KACV,KAAK,wCACE,CAAC,OAAO,IAAI,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC,KAC5C,KAAK,EAAE,IAAI,CAAC,KAAK,CACb,IAAI,CAAC,SAAS,CAAC,EAAE,WAAW,aAAA,EAAE,MAAM,QAAA,EAAE,KAAK,OAAA,EAAE,OAAO,SAAA,EAAE,CAAC,CAC1D,MAEuC,EAAC;;;;CACpD;AAMD,SAAgB,WAAW,CACvB,QAAkB,EAClB,SAAwB,EACxB,OAA2B;IAH/B,iBAoBC;IAnBG,yBAAA,EAAA,kBAAkB;IAClB,0BAAA,EAAA,wBAAwB;IACxB,wBAAA,EAAA,YAA2B;IAE3B,OAAO,wFAAO,EAAyB,EAAE,IAAI;;YAA7B,WAAqB,EAAd,GAAG,SAAA,EAAE,OAAO,aAAA;;;;oBACzB,KAAK,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAC;oBAEhC,IAAI,CAAC;wBACG,UAAU,GAAG,IAAA,qBAAM,EAAC,KAAK,EAAE,OAAO,CAAC,GAAG,CAAC,SAAS,CAAC,EAAE,OAAO,CAAC,CAAC;oBACpE,CAAC;oBAAC,OAAO,KAAK,EAAE,CAAC;wBACb,OAAO,CAAC,KAAK,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;oBAC9B,CAAC;oBACY,qBAAM,IAAI,EAAE,EAAA;;oBAAnB,IAAI,GAAG,SAAY;oBAEzB,IAAI,OAAO,IAAI,IAAI,IAAI,UAAU;wBAC7B,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC,GAAG,UAAU,CAAC;oBAE1C,sBAAO,IAAI,EAAC;;;SACf,CAAC;AACN,CAAC;AAQD,IAAM,iBAAiB,GAA+B,EAAE,CAAC;AAEzD,SAAgB,KAAK,CACjB,WAAyB,EACzB,WAAiB;IAFrB,iBAqCC;IApCG,4BAAA,EAAA,cAAc,EAAE,GAAG,oBAAM;IACzB,4BAAA,EAAA,cAAc,iBAAG;IAEjB,SAAS,UAAU;QACf,KAAmC,UAAiC,EAAjC,KAAA,MAAM,CAAC,OAAO,CAAC,iBAAiB,CAAC,EAAjC,cAAiC,EAAjC,IAAiC;YAAzD,IAAA,WAAoB,EAAnB,GAAG,QAAA,EAAI,SAAS,kBAAA;YACxB,IAAI,IAAI,CAAC,GAAG,EAAE,GAAG,SAAS,GAAG,WAAW;gBACpC,OAAO,iBAAiB,CAAC,GAAG,CAAC,CAAC;SAAA;IAC1C,CAAC;IAED,OAAO,CAAC,UAAO,OAAO,EAAE,IAAI;;;YAChB,WAAW,GAAK,OAAO,YAAZ,CAAa;YAC1B,KAAK,GAAG,CAAC,iBAAiB,CAAC,WAAW,MAA7B,iBAAiB,CAAC,WAAW,IAAM,EAAE,EAAC,EACjD,KAAK,GAAG,sBAAe,WAAW,CAAE,CAAC;YACjC,IAAI,GAAoB,KAAK,KAAzB,EAAE,KAAkB,KAAK,UAAV,EAAb,SAAS,mBAAG,CAAC,KAAA,CAAW;YAEtC,IAAI,CAAC,CAAC,IAAI,IAAI,SAAS,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC;gBACrD,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;gBAEpB,KAAK,CAAC,MAAM,GAAG,IAAI,EAAE;qBAChB,IAAI,CAAC,UAAA,IAAI;oBACN,KAAK,CAAC,IAAI,GAAG,IAAI,CAAC;oBAClB,KAAK,CAAC,SAAS,GAAG,IAAI,CAAC,GAAG,EAAE,GAAG,WAAW,CAAC;oBAE3C,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;oBAEnB,OAAO,IAAI,CAAC;gBAChB,CAAC,CAAC;qBACD,OAAO,CAAC;oBACL,OAAO,KAAK,CAAC,MAAM,CAAC;oBACpB,UAAU,EAAE,CAAC;oBAEb,OAAO,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;gBAC3B,CAAC,CAAC,CAAC;YACX,CAAC;YACD,sBAAO,IAAI,IAAI,KAAK,CAAC,MAAM,EAAC;;SAC/B,CAAqB,CAAC;AAC3B,CAAC;AAED,SAAgB,UAAU,CACtB,IAAsC;IAD1C,iBAcC;IAXG,OAAO,wFACH,EAA2D,EAC3D,IAAgD;;YAD9C,WAAyB,EAAlB,OAAO,aAAA,EAAE,OAAO,aAAA;;;;oBAGjB,KAAkB,OAAO,SAAZ,EAAb,QAAQ,mBAAG,EAAE,KAAA,EACjB,SAAS,GAAG,IAAA,+BAAmB,EAAC,OAAO,CAAC,iBAAiB,CAAC,IAAI,EAAE,CAAC,CAAC;oBAEtE,qBAAM,IAAI,CAAC,aAAa,CAAC,uBAAC,QAAQ,GAAK,SAAS,QAAE,MAAM,CAAC,OAAO,CAAC,CAAC,EAAA;;oBAAlE,SAAkE,CAAC;oBAEnE,sBAAO,IAAI,EAAE,EAAC;;;SACjB,CAAC;AACN,CAAC"}

package/dist/middleware/remote.d.ts

@@ -0,0 +1,27 @@
+import { DataObject, Middleware } from '../compose';
+export type OAuth2Ticket = {
+    code: string;
+    state?: string;
+    [key: string]: string;
+};
+export interface OAuth2Option {
+    signInURL: (pageURL: string) => string;
+    accessToken: (ticket: OAuth2Ticket) => Promise<string>;
+    userProfile: (token: string) => Promise<DataObject>;
+    tokenKey?: string;
+}
+export interface OAuth2Props<T extends DataObject> {
+    token: string;
+    user: T;
+}
+export declare function oauth2Signer<I extends DataObject, O extends DataObject = {}>({ signInURL, accessToken, userProfile, tokenKey }: OAuth2Option): Middleware<I, O>;
+export type GitHubAPIOperation = 'admin' | 'write' | 'read' | 'delete';
+export type GitHubOAuthScope = `repo${'' | ':status' | '_deployment' | ':invite'}` | 'public_repo' | 'security_events' | `${Exclude<GitHubAPIOperation, 'delete'>}:${'repo_hook' | 'org' | 'public_key' | 'gpg_key'}` | 'admin:org_hook' | 'gist' | 'notifications' | `user${'' | ':email' | ':follow'}` | `read:${'user' | 'project'}` | 'project' | 'delete_repo' | `${Exclude<GitHubAPIOperation, 'admin'>}:packages` | 'codespace' | 'workflow';
+/**
+ * @see {@link https://docs.github.com/en/apps/oauth-apps/building-oauth-apps/authorizing-oauth-apps#web-application-flow}
+ */
+export interface GitHubOAuthOption extends Partial<Record<'rootBaseURL' | 'apiBaseURL' | 'login', string>>, Record<'client_id' | 'client_secret', string> {
+    scopes?: GitHubOAuthScope[];
+    allow_signup?: boolean;
+}
+export declare function githubOAuth2<I extends DataObject, O extends DataObject = {}>({ rootBaseURL, apiBaseURL, client_id, client_secret, scopes, allow_signup }: GitHubOAuthOption): Middleware<I, O>;

package/dist/middleware/remote.js

@@ -0,0 +1,116 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.oauth2Signer = oauth2Signer;
+exports.githubOAuth2 = githubOAuth2;
+var tslib_1 = require("tslib");
+var web_utility_1 = require("web-utility");
+var VERCEL_URL = process.env.VERCEL_URL;
+var Host = VERCEL_URL ? "https://".concat(VERCEL_URL) : 'http://127.0.0.1:3000';
+function oauth2Signer(_a) {
+    var _this = this;
+    var signInURL = _a.signInURL, accessToken = _a.accessToken, userProfile = _a.userProfile, _b = _a.tokenKey, tokenKey = _b === void 0 ? 'token' : _b;
+    return function (_a, next_1) { return tslib_1.__awaiter(_this, [_a, next_1], void 0, function (_b, next) {
+        var token, pageURL, token_1, user, data, props, _c;
+        var _d = _b.req, url = _d.url, headers = _d.headers, cookies = _d.cookies, query = _b.query, res = _b.res;
+        return tslib_1.__generator(this, function (_e) {
+            switch (_e.label) {
+                case 0:
+                    token = cookies[tokenKey];
+                    pageURL = new URL(url || '/', headers['origin'] || Host) + '';
+                    if (!query.code) return [3 /*break*/, 2];
+                    return [4 /*yield*/, accessToken(query)];
+                case 1:
+                    token_1 = _e.sent();
+                    res.setHeader('Set-Cookie', "token=".concat(token_1, "; Path=/"));
+                    return [2 /*return*/, {
+                            redirect: {
+                                destination: pageURL.split('?')[0],
+                                permanent: false
+                            },
+                            props: {}
+                        }];
+                case 2:
+                    if (!token) return [3 /*break*/, 7];
+                    _e.label = 3;
+                case 3:
+                    _e.trys.push([3, 6, , 7]);
+                    return [4 /*yield*/, userProfile(token)];
+                case 4:
+                    user = _e.sent();
+                    return [4 /*yield*/, next()];
+                case 5:
+                    data = _e.sent();
+                    props = 'props' in data
+                        ? tslib_1.__assign(tslib_1.__assign({}, data.props), { token: token, user: user }) : {};
+                    return [2 /*return*/, tslib_1.__assign(tslib_1.__assign({}, data), { props: props })];
+                case 6:
+                    _c = _e.sent();
+                    return [3 /*break*/, 7];
+                case 7: return [2 /*return*/, {
+                        redirect: {
+                            destination: signInURL(pageURL + ''),
+                            permanent: false
+                        },
+                        props: {}
+                    }];
+            }
+        });
+    }); };
+}
+function githubOAuth2(_a) {
+    var _this = this;
+    var _b = _a.rootBaseURL, rootBaseURL = _b === void 0 ? 'https://github.com' : _b, _c = _a.apiBaseURL, apiBaseURL = _c === void 0 ? 'https://api.github.com' : _c, client_id = _a.client_id, client_secret = _a.client_secret, scopes = _a.scopes, _d = _a.allow_signup, allow_signup = _d === void 0 ? true : _d;
+    return oauth2Signer({
+        signInURL: function (redirect_uri) {
+            return "https://github.com/login/oauth/authorize?".concat((0, web_utility_1.buildURLData)({
+                client_id: client_id,
+                scope: scopes === null || scopes === void 0 ? void 0 : scopes.join(' '),
+                allow_signup: allow_signup,
+                redirect_uri: redirect_uri
+            }));
+        },
+        accessToken: function (_a) { return tslib_1.__awaiter(_this, [_a], void 0, function (_b) {
+            var response, _c, error, access_token;
+            var code = _b.code;
+            return tslib_1.__generator(this, function (_d) {
+                switch (_d.label) {
+                    case 0: return [4 /*yield*/, fetch(new URL('login/oauth/access_token', rootBaseURL), {
+                            method: 'POST',
+                            headers: {
+                                Accept: 'application/json',
+                                'Content-Type': 'application/json'
+                            },
+                            body: JSON.stringify({ client_id: client_id, client_secret: client_secret, code: code })
+                        })];
+                    case 1:
+                        response = _d.sent();
+                        return [4 /*yield*/, response.json()];
+                    case 2:
+                        _c = _d.sent(), error = _c.error, access_token = _c.access_token;
+                        if (error)
+                            throw new URIError(error);
+                        return [2 /*return*/, access_token];
+                }
+            });
+        }); },
+        userProfile: function (token) { return tslib_1.__awaiter(_this, void 0, void 0, function () {
+            var response;
+            return tslib_1.__generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, fetch(new URL('user', apiBaseURL), {
+                            headers: {
+                                Authorization: "Bearer ".concat(token),
+                                Accept: 'application/json'
+                            }
+                        })];
+                    case 1:
+                        response = _a.sent();
+                        if (response.status < 300)
+                            return [2 /*return*/, response.json()];
+                        throw new URIError('Invalid GitHub access token');
+                }
+            });
+        }); }
+    });
+}
+//# sourceMappingURL=remote.js.map

package/dist/middleware/remote.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"remote.js","sourceRoot":"","sources":["../../source/middleware/remote.ts"],"names":[],"mappings":";;AAyBA,oCA2CC;AA6BD,oCA8CC;;AA/ID,2CAA2C;AAsBnC,IAAA,UAAU,GAAK,OAAO,CAAC,GAAG,WAAhB,CAAiB;AACnC,IAAM,IAAI,GAAG,UAAU,CAAC,CAAC,CAAC,kBAAW,UAAU,CAAE,CAAC,CAAC,CAAC,uBAAuB,CAAC;AAE5E,SAAgB,YAAY,CAAkD,EAK/D;IALf,iBA2CC;QA1CG,SAAS,eAAA,EACT,WAAW,iBAAA,EACX,WAAW,iBAAA,EACX,gBAAkB,EAAlB,QAAQ,mBAAG,OAAO,KAAA;IAElB,OAAO,wFAAO,EAA8C,EAAE,IAAI;;YAAlD,WAA8B,EAAvB,GAAG,SAAA,EAAE,OAAO,aAAA,EAAE,OAAO,aAAA,EAAI,KAAK,WAAA,EAAE,GAAG,SAAA;;;;oBAChD,KAAK,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAC;oBAC1B,OAAO,GAAG,IAAI,GAAG,CAAC,GAAG,IAAI,GAAG,EAAE,OAAO,CAAC,QAAQ,CAAC,IAAI,IAAI,CAAC,GAAG,EAAE,CAAC;yBAEhE,KAAK,CAAC,IAAI,EAAV,wBAAU;oBACI,qBAAM,WAAW,CAAC,KAAqB,CAAC,EAAA;;oBAAhD,UAAQ,SAAwC;oBAEtD,GAAG,CAAC,SAAS,CAAC,YAAY,EAAE,gBAAS,OAAK,aAAU,CAAC,CAAC;oBAEtD,sBAAO;4BACH,QAAQ,EAAE;gCACN,WAAW,EAAE,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;gCAClC,SAAS,EAAE,KAAK;6BACnB;4BACD,KAAK,EAAE,EAAO;yBACjB,EAAC;;yBAEF,KAAK,EAAL,wBAAK;;;;oBAEY,qBAAM,WAAW,CAAC,KAAK,CAAC,EAAA;;oBAA/B,IAAI,GAAG,SAAwB;oBAC1B,qBAAM,IAAI,EAAE,EAAA;;oBAAnB,IAAI,GAAG,SAAY;oBACjB,KAAK,GACP,OAAO,IAAI,IAAI;wBACX,CAAC,uCAAM,IAAI,CAAC,KAAK,KAAE,KAAK,OAAA,EAAE,IAAI,MAAA,IAC9B,CAAC,CAAE,EAAQ,CAAC;oBAEpB,4DAAY,IAAI,KAAE,KAAK,OAAA,KAAG;;;;wBAGlC,sBAAO;wBACH,QAAQ,EAAE;4BACN,WAAW,EAAE,SAAS,CAAC,OAAO,GAAG,EAAE,CAAC;4BACpC,SAAS,EAAE,KAAK;yBACnB;wBACD,KAAK,EAAE,EAAO;qBACjB,EAAC;;;SACL,CAAC;AACN,CAAC;AA6BD,SAAgB,YAAY,CAAkD,EAO1D;IAPpB,iBA8CC;QA7CG,mBAAkC,EAAlC,WAAW,mBAAG,oBAAoB,KAAA,EAClC,kBAAqC,EAArC,UAAU,mBAAG,wBAAwB,KAAA,EACrC,SAAS,eAAA,EACT,aAAa,mBAAA,EACb,MAAM,YAAA,EACN,oBAAmB,EAAnB,YAAY,mBAAG,IAAI,KAAA;IAEnB,OAAO,YAAY,CAAO;QACtB,SAAS,EAAE,UAAA,YAAY;YACnB,OAAA,mDAA4C,IAAA,0BAAY,EAAC;gBACrD,SAAS,WAAA;gBACT,KAAK,EAAE,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,IAAI,CAAC,GAAG,CAAC;gBACxB,YAAY,cAAA;gBACZ,YAAY,cAAA;aACf,CAAC,CAAE;QALJ,CAKI;QACR,WAAW,EAAE,wEAAO,EAAQ;;gBAAN,IAAI,UAAA;;;4BACL,qBAAM,KAAK,CACxB,IAAI,GAAG,CAAC,0BAA0B,EAAE,WAAW,CAAC,EAChD;4BACI,MAAM,EAAE,MAAM;4BACd,OAAO,EAAE;gCACL,MAAM,EAAE,kBAAkB;gCAC1B,cAAc,EAAE,kBAAkB;6BACrC;4BACD,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,EAAE,SAAS,WAAA,EAAE,aAAa,eAAA,EAAE,IAAI,MAAA,EAAE,CAAC;yBAC3D,CACJ,EAAA;;wBAVK,QAAQ,GAAG,SAUhB;wBAC+B,qBAAM,QAAQ,CAAC,IAAI,EAAE,EAAA;;wBAA/C,KAA0B,SAAqB,EAA7C,KAAK,WAAA,EAAE,YAAY,kBAAA;wBAE3B,IAAI,KAAK;4BAAE,MAAM,IAAI,QAAQ,CAAC,KAAK,CAAC,CAAC;wBAErC,sBAAO,YAAY,EAAC;;;aACvB;QACD,WAAW,EAAE,UAAM,KAAK;;;;4BACH,qBAAM,KAAK,CAAC,IAAI,GAAG,CAAC,MAAM,EAAE,UAAU,CAAC,EAAE;4BACtD,OAAO,EAAE;gCACL,aAAa,EAAE,iBAAU,KAAK,CAAE;gCAChC,MAAM,EAAE,kBAAkB;6BAC7B;yBACJ,CAAC,EAAA;;wBALI,QAAQ,GAAG,SAKf;wBACF,IAAI,QAAQ,CAAC,MAAM,GAAG,GAAG;4BAAE,sBAAO,QAAQ,CAAC,IAAI,EAAE,EAAC;wBAElD,MAAM,IAAI,QAAQ,CAAC,6BAA6B,CAAC,CAAC;;;aACrD;KACJ,CAAC,CAAC;AACP,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "next-ssr-middleware",
-    "version": "0.6.2",
+    "version": "0.8.5",
     "license": "LGPL-3.0-or-later",
     "author": "shiy2008@gmail.com",
     "description": "Koa-like middlewares for Next.js Server Side Rendering",
@@ -23,24 +23,24 @@
     "main": "dist/index.js",
     "dependencies": {
         "jsonwebtoken": "^9.0.2",
-        "mobx-i18n": "^0.4.2",
-        "tslib": "^2.6.2",
-        "web-utility": "^4.1.3"
+        "mobx-i18n": "^0.5.0",
+        "tslib": "^2.6.3",
+        "web-utility": "^4.4.0"
     },
     "peerDependencies": {
         "next": ">=9.3"
     },
     "devDependencies": {
-        "@types/jsonwebtoken": "^9.0.5",
-        "@types/node": "^18.19.3",
-        "husky": "^8.0.3",
-        "koajax": "^0.9.6",
-        "lint-staged": "^15.2.0",
-        "next": "^14.0.4",
+        "@types/jsonwebtoken": "^9.0.6",
+        "@types/node": "^18.19.45",
+        "husky": "^9.1.5",
+        "koajax": "^2.0.0",
+        "lint-staged": "^15.2.9",
+        "next": "^14.2.5",
         "open-cli": "^8.0.0",
-        "prettier": "^3.1.1",
-        "typedoc": "^0.25.4",
-        "typescript": "~5.3.3"
+        "prettier": "^3.3.3",
+        "typedoc": "^0.26.6",
+        "typescript": "~5.5.4"
     },
     "prettier": {
         "singleQuote": true,
@@ -52,7 +52,7 @@
         "*.{md,json,yml,ts}": "prettier --write"
     },
     "scripts": {
-        "prepare": "husky install",
+        "prepare": "husky",
         "test": "lint-staged",
         "build": "rm -rf dist/ docs/  &&  typedoc source/  &&  tsc",
         "start": "typedoc  &&  open-cli docs/index.html",

package/source/middleware/index.ts

@@ -0,0 +1,2 @@
+export * from './local';
+export * from './remote';

package/source/{middleware.ts → middleware/local.ts}

@@ -5,7 +5,7 @@ import { GetServerSidePropsContext, GetServerSidePropsResult } from 'next';
 import { ParsedUrlQuery } from 'querystring';
 import { Day, Second } from 'web-utility';
 
-import { DataObject, Middleware } from './compose';
+import { DataObject, Middleware } from '../compose';
 
 export async function errorLogger<
     I extends DataObject,
@@ -19,10 +19,11 @@ export async function errorLogger<
     } catch (error) {
         console.error(error);
 
-        const { status } = error as HTTPError;
-
-        if (status === 404) return { notFound: true, props: {} as O };
+        if (error instanceof HTTPError) {
+            const { status } = error.response;
 
+            if (status === 404) return { notFound: true, props: {} as O };
+        }
         throw error;
     }
 }
@@ -129,13 +130,12 @@ export function translator<I extends DataObject, O extends DataObject = {}>(
     i18n: TranslationModel<string, string>
 ): Middleware<I, O> {
     return async (
-        context: GetServerSidePropsContext<I>,
+        { req: { headers, cookies } }: GetServerSidePropsContext<I>,
         next: () => Promise<GetServerSidePropsResult<O>>
     ) => {
-        const { language = '' } = context.req.cookies,
-            languages = parseLanguageHeader(
-                context.req.headers['accept-language'] || ''
-            );
+        const { language = '' } = cookies,
+            languages = parseLanguageHeader(headers['accept-language'] || '');
+
         await i18n.loadLanguages([language, ...languages].filter(Boolean));
 
         return next();

package/source/middleware/remote.ts

@@ -0,0 +1,144 @@
+import { buildURLData } from 'web-utility';
+
+import { DataObject, Middleware } from '../compose';
+
+export type OAuth2Ticket = {
+    code: string;
+    state?: string;
+    [key: string]: string;
+};
+
+export interface OAuth2Option {
+    signInURL: (pageURL: string) => string;
+    accessToken: (ticket: OAuth2Ticket) => Promise<string>;
+    userProfile: (token: string) => Promise<DataObject>;
+    tokenKey?: string;
+}
+
+export interface OAuth2Props<T extends DataObject> {
+    token: string;
+    user: T;
+}
+
+const { VERCEL_URL } = process.env;
+const Host = VERCEL_URL ? `https://${VERCEL_URL}` : 'http://127.0.0.1:3000';
+
+export function oauth2Signer<I extends DataObject, O extends DataObject = {}>({
+    signInURL,
+    accessToken,
+    userProfile,
+    tokenKey = 'token'
+}: OAuth2Option): Middleware<I, O> {
+    return async ({ req: { url, headers, cookies }, query, res }, next) => {
+        const token = cookies[tokenKey];
+        const pageURL = new URL(url || '/', headers['origin'] || Host) + '';
+
+        if (query.code) {
+            const token = await accessToken(query as OAuth2Ticket);
+
+            res.setHeader('Set-Cookie', `token=${token}; Path=/`);
+
+            return {
+                redirect: {
+                    destination: pageURL.split('?')[0],
+                    permanent: false
+                },
+                props: {} as O
+            };
+        }
+        if (token)
+            try {
+                const user = await userProfile(token),
+                    data = await next();
+                const props =
+                    'props' in data
+                        ? { ...data.props, token, user }
+                        : ({} as O);
+
+                return { ...data, props };
+            } catch {}
+
+        return {
+            redirect: {
+                destination: signInURL(pageURL + ''),
+                permanent: false
+            },
+            props: {} as O
+        };
+    };
+}
+
+export type GitHubAPIOperation = 'admin' | 'write' | 'read' | 'delete';
+
+export type GitHubOAuthScope =
+    | `repo${'' | ':status' | '_deployment' | ':invite'}`
+    | 'public_repo'
+    | 'security_events'
+    | `${Exclude<GitHubAPIOperation, 'delete'>}:${'repo_hook' | 'org' | 'public_key' | 'gpg_key'}`
+    | 'admin:org_hook'
+    | 'gist'
+    | 'notifications'
+    | `user${'' | ':email' | ':follow'}`
+    | `read:${'user' | 'project'}`
+    | 'project'
+    | 'delete_repo'
+    | `${Exclude<GitHubAPIOperation, 'admin'>}:packages`
+    | 'codespace'
+    | 'workflow';
+/**
+ * @see {@link https://docs.github.com/en/apps/oauth-apps/building-oauth-apps/authorizing-oauth-apps#web-application-flow}
+ */
+export interface GitHubOAuthOption
+    extends Partial<Record<'rootBaseURL' | 'apiBaseURL' | 'login', string>>,
+        Record<'client_id' | 'client_secret', string> {
+    scopes?: GitHubOAuthScope[];
+    allow_signup?: boolean;
+}
+
+export function githubOAuth2<I extends DataObject, O extends DataObject = {}>({
+    rootBaseURL = 'https://github.com',
+    apiBaseURL = 'https://api.github.com',
+    client_id,
+    client_secret,
+    scopes,
+    allow_signup = true
+}: GitHubOAuthOption) {
+    return oauth2Signer<I, O>({
+        signInURL: redirect_uri =>
+            `https://github.com/login/oauth/authorize?${buildURLData({
+                client_id,
+                scope: scopes?.join(' '),
+                allow_signup,
+                redirect_uri
+            })}`,
+        accessToken: async ({ code }) => {
+            const response = await fetch(
+                new URL('login/oauth/access_token', rootBaseURL),
+                {
+                    method: 'POST',
+                    headers: {
+                        Accept: 'application/json',
+                        'Content-Type': 'application/json'
+                    },
+                    body: JSON.stringify({ client_id, client_secret, code })
+                }
+            );
+            const { error, access_token } = await response.json();
+
+            if (error) throw new URIError(error);
+
+            return access_token;
+        },
+        userProfile: async token => {
+            const response = await fetch(new URL('user', apiBaseURL), {
+                headers: {
+                    Authorization: `Bearer ${token}`,
+                    Accept: 'application/json'
+                }
+            });
+            if (response.status < 300) return response.json();
+
+            throw new URIError('Invalid GitHub access token');
+        }
+    });
+}

package/.vscode/extensions.json

@@ -1,14 +0,0 @@
-{
-    "recommendations": [
-        "yzhang.markdown-all-in-one",
-        "redhat.vscode-yaml",
-        "akamud.vscode-caniuse",
-        "visualstudioexptteam.intellicode-api-usage-examples",
-        "pflannery.vscode-versionlens",
-        "christian-kohler.npm-intellisense",
-        "esbenp.prettier-vscode",
-        "eamodio.gitlens",
-        "github.vscode-pull-request-github",
-        "github.vscode-github-actions"
-    ]
-}

package/dist/middleware.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"middleware.js","sourceRoot":"","sources":["../source/middleware.ts"],"names":[],"mappings":";;;;AAAA,6CAAiE;AAEjE,uCAAkE;AAGlE,2CAA0C;AAI1C,SAAsB,WAAW,CAI7B,OAAqC,EACrC,IAAgD;;;;;;;oBAGrC,qBAAM,IAAI,EAAE,EAAA;wBAAnB,sBAAO,SAAY,EAAC;;;oBAEpB,OAAO,CAAC,KAAK,CAAC,OAAK,CAAC,CAAC;oBAEb,WAAW,OAAkB,OAAvB,CAAwB;oBAEtC,IAAI,QAAM,KAAK,GAAG;wBAAE,sBAAO,EAAE,QAAQ,EAAE,IAAI,EAAE,KAAK,EAAE,EAAO,EAAE,EAAC;oBAE9D,MAAM,OAAK,CAAC;;;;;CAEnB;AAlBD,kCAkBC;AASD,SAAsB,MAAM,CACxB,OAAqC,EACrC,IAAgD;;;;;wBAE/B,qBAAM,IAAI,EAAE,EAAA;;oBAAvB,OAAO,GAAG,CAAC,SAAY,CAAC,IAAK,EAAmC,EAChE,WAAW,GAA6B,OAAO,YAApC,EAAE,MAAM,GAAqB,OAAO,OAA5B,EAAE,KAAK,GAAc,OAAO,MAArB,EAAE,OAAO,GAAK,OAAO,QAAZ;oBAEzC,sBAAO,sCACA,OAAO,KACV,KAAK,wCACE,CAAC,OAAO,IAAI,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC,KAC5C,KAAK,EAAE,IAAI,CAAC,KAAK,CACb,IAAI,CAAC,SAAS,CAAC,EAAE,WAAW,aAAA,EAAE,MAAM,QAAA,EAAE,KAAK,OAAA,EAAE,OAAO,SAAA,EAAE,CAAC,CAC1D,MAEuC,EAAC;;;;CACpD;AAhBD,wBAgBC;AAMD,SAAgB,WAAW,CACvB,QAAkB,EAClB,SAAwB,EACxB,OAA2B;IAH/B,iBAoBC;IAnBG,yBAAA,EAAA,kBAAkB;IAClB,0BAAA,EAAA,wBAAwB;IACxB,wBAAA,EAAA,YAA2B;IAE3B,OAAO,UAAO,EAAyB,EAAE,IAAI;YAA7B,WAAqB,EAAd,GAAG,SAAA,EAAE,OAAO,aAAA;;;;;;wBACzB,KAAK,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAC;wBAEhC,IAAI,CAAC;4BACG,UAAU,GAAG,IAAA,qBAAM,EAAC,KAAK,EAAE,OAAO,CAAC,GAAG,CAAC,SAAS,CAAC,EAAE,OAAO,CAAC,CAAC;wBACpE,CAAC;wBAAC,OAAO,KAAK,EAAE,CAAC;4BACb,OAAO,CAAC,KAAK,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;wBAC9B,CAAC;wBACY,qBAAM,IAAI,EAAE,EAAA;;wBAAnB,IAAI,GAAG,SAAY;wBAEzB,IAAI,OAAO,IAAI,IAAI,IAAI,UAAU;4BAC7B,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC,GAAG,UAAU,CAAC;wBAE1C,sBAAO,IAAI,EAAC;;;;KACf,CAAC;AACN,CAAC;AApBD,kCAoBC;AAQD,IAAM,iBAAiB,GAA+B,EAAE,CAAC;AAEzD,SAAgB,KAAK,CACjB,WAAyB,EACzB,WAAiB;IAFrB,iBAqCC;IApCG,4BAAA,EAAA,cAAc,EAAE,GAAG,oBAAM;IACzB,4BAAA,EAAA,cAAc,iBAAG;IAEjB,SAAS,UAAU;QACf,KAAmC,UAAiC,EAAjC,KAAA,MAAM,CAAC,OAAO,CAAC,iBAAiB,CAAC,EAAjC,cAAiC,EAAjC,IAAiC;YAAzD,IAAA,WAAoB,EAAnB,GAAG,QAAA,EAAI,SAAS,kBAAA;YACxB,IAAI,IAAI,CAAC,GAAG,EAAE,GAAG,SAAS,GAAG,WAAW;gBACpC,OAAO,iBAAiB,CAAC,GAAG,CAAC,CAAC;SAAA;IAC1C,CAAC;IAED,OAAO,CAAC,UAAO,OAAO,EAAE,IAAI;;;YAChB,WAAW,GAAK,OAAO,YAAZ,CAAa;YAC1B,KAAK,GAAG,CAAC,iBAAiB,CAAC,WAAW,MAA7B,iBAAiB,CAAC,WAAW,IAAM,EAAE,EAAC,EACjD,KAAK,GAAG,sBAAe,WAAW,CAAE,CAAC;YACjC,IAAI,GAAoB,KAAK,KAAzB,EAAE,KAAkB,KAAK,UAAV,EAAb,SAAS,mBAAG,CAAC,KAAA,CAAW;YAEtC,IAAI,CAAC,CAAC,IAAI,IAAI,SAAS,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC;gBACrD,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;gBAEpB,KAAK,CAAC,MAAM,GAAG,IAAI,EAAE;qBAChB,IAAI,CAAC,UAAA,IAAI;oBACN,KAAK,CAAC,IAAI,GAAG,IAAI,CAAC;oBAClB,KAAK,CAAC,SAAS,GAAG,IAAI,CAAC,GAAG,EAAE,GAAG,WAAW,CAAC;oBAE3C,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;oBAEnB,OAAO,IAAI,CAAC;gBAChB,CAAC,CAAC;qBACD,OAAO,CAAC;oBACL,OAAO,KAAK,CAAC,MAAM,CAAC;oBACpB,UAAU,EAAE,CAAC;oBAEb,OAAO,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;gBAC3B,CAAC,CAAC,CAAC;YACX,CAAC;YACD,sBAAO,IAAI,IAAI,KAAK,CAAC,MAAM,EAAC;;SAC/B,CAAqB,CAAC;AAC3B,CAAC;AArCD,sBAqCC;AAED,SAAgB,UAAU,CACtB,IAAsC;IAD1C,iBAeC;IAZG,OAAO,UACH,OAAqC,EACrC,IAAgD;;;;;oBAExC,KAAkB,OAAO,CAAC,GAAG,CAAC,OAAO,SAAxB,EAAb,QAAQ,mBAAG,EAAE,KAAA,EACjB,SAAS,GAAG,IAAA,+BAAmB,EAC3B,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,iBAAiB,CAAC,IAAI,EAAE,CAC/C,CAAC;oBACN,qBAAM,IAAI,CAAC,aAAa,CAAC,uBAAC,QAAQ,GAAK,SAAS,QAAE,MAAM,CAAC,OAAO,CAAC,CAAC,EAAA;;oBAAlE,SAAkE,CAAC;oBAEnE,sBAAO,IAAI,EAAE,EAAC;;;SACjB,CAAC;AACN,CAAC;AAfD,gCAeC"}