refactor: don’t use alias for i18n __ local object

getindiekit · May 26, 2023 · 4b4799d · 4b4799d
1 parent bdbb5e3
commit 4b4799d
Show file tree

Hide file tree

Showing 34 changed files with 137 additions and 98 deletions.
diff --git a/packages/endpoint-auth/lib/controllers/authorization.js b/packages/endpoint-auth/lib/controllers/authorization.js
@@ -32,23 +32,23 @@ export const authorizationController = {
       ]) {
         if (!request.query[parameter]) {
           throw IndiekitError.badRequest(
-            response.__("BadRequestError.missingParameter", parameter)
+            response.locals.__("BadRequestError.missingParameter", parameter)
           );
         }
       }
 
       // `response_type` must be `code` (or deprecated `id`)
       if (!/^(code|id)$/.test(request.query.response_type)) {
         throw IndiekitError.badRequest(
-          response.__("BadRequestError.invalidValue", "response_type")
+          response.locals.__("BadRequestError.invalidValue", "response_type")
         );
       }
 
       // `client_id`, `redirect_uri` and `me` (optional) must be valid URLs
       for (const uri of ["client_id", "me", "redirect_uri"]) {
         if (request.query[uri] && !isUrl(request.query[uri])) {
           throw IndiekitError.badRequest(
-            response.__("BadRequestError.invalidValue", uri)
+            response.locals.__("BadRequestError.invalidValue", uri)
           );
         }
 
@@ -65,7 +65,7 @@ export const authorizationController = {
       const validRedirect = validateRedirect(redirect_uri, client_id);
       if (!validRedirect) {
         throw IndiekitError.badRequest(
-          response.__("BadRequestError.invalidValue", "redirect_uri")
+          response.locals.__("BadRequestError.invalidValue", "redirect_uri")
         );
       }
 

diff --git a/packages/endpoint-auth/lib/controllers/consent.js b/packages/endpoint-auth/lib/controllers/consent.js
@@ -14,7 +14,7 @@ export const consentController = {
   get(request, response) {
     if (!request.query.request_uri) {
       throw IndiekitError.badRequest(
-        response.__("BadRequestError.missingParameter", "request_uri")
+        response.locals.__("BadRequestError.missingParameter", "request_uri")
       );
     }
 
@@ -24,7 +24,7 @@ export const consentController = {
 
       if (process.env.PASSWORD_SECRET) {
         response.render("consent", {
-          title: response.__(`auth.consent.${authType}.title`),
+          title: response.locals.__(`auth.consent.${authType}.title`),
           authType,
           me,
           redirect_uri,
@@ -35,7 +35,7 @@ export const consentController = {
       }
     } catch {
       throw IndiekitError.badRequest(
-        response.__("BadRequestError.invalidValue", "request_uri")
+        response.locals.__("BadRequestError.invalidValue", "request_uri")
       );
     }
   },
@@ -60,7 +60,7 @@ export const consentController = {
     const errors = validationResult(request);
     if (!errors.isEmpty()) {
       return response.status(422).render("consent", {
-        title: response.__(`auth.consent.${authType}.title`),
+        title: response.locals.__(`auth.consent.${authType}.title`),
         authType,
         errors: errors.mapped(),
         me,

diff --git a/packages/endpoint-auth/lib/controllers/documentation.js b/packages/endpoint-auth/lib/controllers/documentation.js
@@ -5,7 +5,7 @@
 export const documentationController = (error, request, response, next) => {
   if (request.accepts("html")) {
     response.render("auth", {
-      title: response.__("auth.guidance.title"),
+      title: response.locals.__("auth.guidance.title"),
       error: error.message,
     });
   } else if (request.accepts("json")) {

diff --git a/packages/endpoint-auth/lib/controllers/password.js b/packages/endpoint-auth/lib/controllers/password.js
@@ -10,9 +10,9 @@ export const passwordController = {
     const { name } = request.app.locals.application;
 
     response.render("new-password", {
-      title: response.__("auth.newPassword.title"),
+      title: response.locals.__("auth.newPassword.title"),
       notice: request.query.setup
-        ? response.__("auth.newPassword.setup.text", { app: name })
+        ? response.locals.__("auth.newPassword.setup.text", { app: name })
         : false,
     });
   },
@@ -27,7 +27,7 @@ export const passwordController = {
     const errors = validationResult(request);
     if (!errors.isEmpty()) {
       return response.status(422).render("new-password", {
-        title: response.__("auth.newPassword.title"),
+        title: response.locals.__("auth.newPassword.title"),
         errors: errors.mapped(),
       });
     }
@@ -36,7 +36,7 @@ export const passwordController = {
       const secret = await createPasswordHash(password);
 
       response.render("new-password", {
-        title: response.__("auth.newPassword.title"),
+        title: response.locals.__("auth.newPassword.title"),
         password,
         secret,
       });

diff --git a/packages/endpoint-auth/lib/controllers/token.js b/packages/endpoint-auth/lib/controllers/token.js
@@ -22,7 +22,7 @@ export const tokenController = {
         accessToken = verifyToken(bearerToken);
       } catch {
         throw IndiekitError.unauthorized(
-          response.__("UnauthorizedError.invalidToken")
+          response.locals.__("UnauthorizedError.invalidToken")
         );
       }
 

diff --git a/packages/endpoint-auth/lib/middleware/code.js b/packages/endpoint-auth/lib/middleware/code.js
@@ -24,30 +24,30 @@ export const codeValidator = (request, response, next) => {
     ]) {
       if (!Object.keys(parameters).includes(parameter)) {
         throw IndiekitError.badRequest(
-          response.__("BadRequestError.missingParameter", parameter)
+          response.locals.__("BadRequestError.missingParameter", parameter)
         );
       }
     }
 
     // `grant_type` must equal `authorization_code`
     if (grant_type !== "authorization_code") {
       throw IndiekitError.badRequest(
-        response.__("BadRequestError.invalidValue", "grant_type")
+        response.locals.__("BadRequestError.invalidValue", "grant_type")
       );
     }
 
     // Validate `client_id` against that provided in authorization request
     if (getCanonicalUrl(client_id) !== client.url) {
       throw IndiekitError.unauthorized(
-        response.__("BadRequestError.invalidValue", "client_id")
+        response.locals.__("BadRequestError.invalidValue", "client_id")
       );
     }
 
     // Validate `redirect_uri`
     const validRedirect = validateRedirect(redirect_uri, client_id);
     if (!validRedirect) {
       throw IndiekitError.badRequest(
-        response.__("BadRequestError.invalidValue", "redirect_uri")
+        response.locals.__("BadRequestError.invalidValue", "redirect_uri")
       );
     }
 
@@ -56,7 +56,7 @@ export const codeValidator = (request, response, next) => {
       request.verifiedToken = verifyToken(code);
     } catch {
       throw IndiekitError.unauthorized(
-        response.__("UnauthorizedError.invalidToken")
+        response.locals.__("UnauthorizedError.invalidToken")
       );
     }
 
@@ -66,7 +66,7 @@ export const codeValidator = (request, response, next) => {
       const verifiedCode = verifyCode(code_verifier, code_challenge);
       if (!verifiedCode) {
         throw IndiekitError.unauthorized(
-          response.__("BadRequestError.invalidValue", "code_verifier")
+          response.locals.__("BadRequestError.invalidValue", "code_verifier")
         );
       }
     }

diff --git a/packages/endpoint-auth/lib/middleware/secret.js b/packages/endpoint-auth/lib/middleware/secret.js
@@ -8,7 +8,7 @@ import { IndiekitError } from "@indiekit/error";
 export const hasSecret = (request, response, next) => {
   if (!process.env.SECRET) {
     const error = IndiekitError.notImplemented(
-      response.__("NotImplementedError.secret")
+      response.locals.__("NotImplementedError.secret")
     );
 
     next(error);

diff --git a/packages/endpoint-auth/lib/scope.js b/packages/endpoint-auth/lib/scope.js
@@ -8,7 +8,7 @@ export const scopes = ["create", "update", "draft", "media", "delete"];
  */
 export function getScopeItems(scope, response) {
   return scopes.map((value) => ({
-    text: response.__(`scope.${value}.label`),
+    text: response.locals.__(`scope.${value}.label`),
     value,
     checked: scope?.includes(value),
   }));

diff --git a/packages/endpoint-auth/tests/unit/scope.js b/packages/endpoint-auth/tests/unit/scope.js
@@ -2,7 +2,9 @@ import test from "ava";
 import { getScopeItems } from "../../lib/scope.js";
 
 test("Gets `items` object for checkboxes component", (t) => {
-  const response = { __: (value) => value };
+  const response = {
+    locals: { __: (value) => value },
+  };
   const result = getScopeItems("create update", response);
 
   t.is(result.length, 5);

diff --git a/packages/endpoint-files/lib/controllers/delete.js b/packages/endpoint-files/lib/controllers/delete.js
@@ -10,7 +10,7 @@ export const deleteController = {
 
     if (scope.includes("delete")) {
       return response.render("file-delete", {
-        title: response.__("files.delete.title"),
+        title: response.locals.__("files.delete.title"),
         back,
         parent: { text: fileName },
       });
@@ -39,7 +39,7 @@ export const deleteController = {
     } catch (error) {
       response.status(error.status || 500);
       response.render("file-delete", {
-        title: response.__("files.delete.title"),
+        title: response.locals.__("files.delete.title"),
         parent: { text: fileName },
         error: error.message,
       });

diff --git a/packages/endpoint-files/lib/controllers/file.js b/packages/endpoint-files/lib/controllers/file.js
@@ -13,15 +13,15 @@ export const fileController = async (request, response, next) => {
       file,
       parent: {
         href: back,
-        text: response.__("files.files.title"),
+        text: response.locals.__("files.files.title"),
       },
       actions: [
         scope.includes("delete")
           ? {
               classes: "actions__link--warning",
               href: path.join(request.baseUrl + request.path, "/delete"),
               icon: "delete",
-              text: response.__("files.delete.action"),
+              text: response.locals.__("files.delete.action"),
             }
           : {},
       ],

diff --git a/packages/endpoint-files/lib/controllers/files.js b/packages/endpoint-files/lib/controllers/files.js
@@ -40,13 +40,13 @@ export const filesController = async (request, response, next) => {
      * @todo Remove requirement for private `_count` parameter
      */
     response.render("files", {
-      title: response.__("files.files.title"),
+      title: response.locals.__("files.files.title"),
       actions: [
         scope.includes("create") || scope.includes("media")
           ? {
               href: path.join(request.baseUrl + request.path, "/upload"),
               icon: "uploadFile",
-              text: response.__("files.upload.action"),
+              text: response.locals.__("files.upload.action"),
             }
           : {},
       ],

diff --git a/packages/endpoint-files/lib/controllers/form.js b/packages/endpoint-files/lib/controllers/form.js
@@ -13,7 +13,7 @@ export const formController = {
 
     if (scope.includes("create") || scope.includes("media")) {
       return response.render("file-form", {
-        title: response.__("files.upload.title"),
+        title: response.locals.__("files.upload.title"),
       });
     }
 
@@ -31,7 +31,7 @@ export const formController = {
     const errors = validationResult(request);
     if (!errors.isEmpty()) {
       return response.status(422).render("file-form", {
-        title: response.__("files.upload.title"),
+        title: response.locals.__("files.upload.title"),
         errors: errors.mapped(),
       });
     }
@@ -52,7 +52,7 @@ export const formController = {
     } catch (error) {
       response.status(error.status || 500);
       response.render("file-form", {
-        title: response.__("files.upload.title"),
+        title: response.locals.__("files.upload.title"),
         error: error.message,
       });
     }

diff --git a/packages/endpoint-files/lib/middleware/file-data.js b/packages/endpoint-files/lib/middleware/file-data.js
@@ -42,7 +42,9 @@ export const fileData = {
       let nextError = error;
 
       if (error.message === "Invalid URL") {
-        nextError = IndiekitError.notFound(response.__("NotFoundError.page"));
+        nextError = IndiekitError.notFound(
+          response.locals.__("NotFoundError.page")
+        );
       }
 
       next(nextError);

diff --git a/packages/endpoint-media/lib/controllers/action.js b/packages/endpoint-media/lib/controllers/action.js
@@ -19,7 +19,7 @@ export const actionController = async (request, response, next) => {
     const hasScope = checkScope(scope);
     if (!hasScope) {
       throw IndiekitError.insufficientScope(
-        response.__("ForbiddenError.insufficientScope"),
+        response.locals.__("ForbiddenError.insufficientScope"),
         { scope: action }
       );
     }
@@ -31,7 +31,7 @@ export const actionController = async (request, response, next) => {
         // Check for file in request
         if (!files || !files.file || files.file.truncated) {
           throw IndiekitError.badRequest(
-            response.__("BadRequestError.missingProperty", "file")
+            response.locals.__("BadRequestError.missingProperty", "file")
           );
         }
 
@@ -44,7 +44,7 @@ export const actionController = async (request, response, next) => {
         // Check for URL if deleting a file
         if (action === "delete" && !url) {
           throw IndiekitError.badRequest(
-            response.__("BadRequestError.missingParameter", "url")
+            response.locals.__("BadRequestError.missingParameter", "url")
           );
         }
 
@@ -69,21 +69,21 @@ export const actionController = async (request, response, next) => {
     // Hoist not found error to controller to localise response
     if (error.name === "NotFoundError") {
       nextError = IndiekitError.notFound(
-        response.__("NotFoundError.record", error.message)
+        response.locals.__("NotFoundError.record", error.message)
       );
     }
 
     // Hoist unsupported media type error to controller to localise response
     if (error.name === "UnsupportedMediaTypeError") {
       nextError = IndiekitError.unsupportedMediaType(
-        response.__("UnsupportedMediaTypeError.type", error.message)
+        response.locals.__("UnsupportedMediaTypeError.type", error.message)
       );
     }
 
     // Hoist unsupported post type error to controller to localise response
     if (error.name === "NotImplementedError") {
       nextError = IndiekitError.notImplemented(
-        response.__("NotImplementedError.postType", error.message),
+        response.locals.__("NotImplementedError.postType", error.message),
         { uri: "https://getindiekit.com/configuration/post-types" }
       );
     }

diff --git a/packages/endpoint-media/lib/controllers/query.js b/packages/endpoint-media/lib/controllers/query.js
@@ -16,15 +16,15 @@ export const queryController = async (request, response, next) => {
     const { q, url } = request.query;
     if (!q) {
       throw IndiekitError.badRequest(
-        response.__("BadRequestError.missingParameter", "q")
+        response.locals.__("BadRequestError.missingParameter", "q")
       );
     }
 
     switch (q) {
       case "source": {
         if (!application.hasDatabase) {
           throw IndiekitError.notImplemented(
-            response.__("NotImplementedError.database")
+            response.locals.__("NotImplementedError.database")
           );
         }
 
@@ -44,7 +44,7 @@ export const queryController = async (request, response, next) => {
 
           if (!item) {
             throw IndiekitError.notFound(
-              response.__("NotFoundError.resource", "file")
+              response.locals.__("NotFoundError.resource", "file")
             );
           }
 
@@ -73,7 +73,10 @@ export const queryController = async (request, response, next) => {
 
       default: {
         throw IndiekitError.notImplemented(
-          response.__("NotImplementedError.query", { key: "q", value: q })
+          response.locals.__("NotImplementedError.query", {
+            key: "q",
+            value: q,
+          })
         );
       }
     }