@jskit-ai/users-core 0.1.65 → 0.1.67

package/src/server/accountSecurity/accountSecurityActions.js

@@ -1,9 +1,18 @@
 import {
   resolveRequest
 } from "@jskit-ai/kernel/shared/actions/actionContributorHelpers";
+import { composeSchemaDefinitions } from "@jskit-ai/kernel/shared/validators";
 import { userSettingsResource } from "../../shared/resources/userSettingsResource.js";
 import { resolveActionUser } from "../common/support/resolveActionUser.js";
 
+const oauthLinkStartInputValidator = composeSchemaDefinitions([
+  userSettingsResource.operations.oauthLinkStart.params,
+  userSettingsResource.operations.oauthLinkStart.query
+], {
+  mode: "patch",
+  context: "accountSecurityActions.oauthLinkStartInputValidator"
+});
+
 const accountSecurityActions = Object.freeze([
   {
     id: "settings.security.password.change",
@@ -14,10 +23,8 @@ const accountSecurityActions = Object.freeze([
     permission: {
       require: "authenticated"
     },
-    inputValidator: {
-      payload: userSettingsResource.operations.passwordChange.bodyValidator
-    },
-    outputValidator: userSettingsResource.operations.passwordChange.outputValidator,
+    input: userSettingsResource.operations.passwordChange.body,
+    output: null,
     idempotency: "none",
     audit: {
       actionName: "settings.security.password.change"
@@ -27,7 +34,7 @@ const accountSecurityActions = Object.freeze([
       return deps.accountSecurityService.changePassword(
         resolveRequest(context),
         resolveActionUser(context, input),
-        input.payload,
+        input,
         {
           context
         }
@@ -43,10 +50,8 @@ const accountSecurityActions = Object.freeze([
     permission: {
       require: "authenticated"
     },
-    inputValidator: {
-      payload: userSettingsResource.operations.passwordMethodToggle.bodyValidator
-    },
-    outputValidator: userSettingsResource.operations.passwordMethodToggle.outputValidator,
+    input: userSettingsResource.operations.passwordMethodToggle.body,
+    output: null,
     idempotency: "none",
     audit: {
       actionName: "settings.security.password_method.toggle"
@@ -56,7 +61,7 @@ const accountSecurityActions = Object.freeze([
       return deps.accountSecurityService.setPasswordMethodEnabled(
         resolveRequest(context),
         resolveActionUser(context, input),
-        input.payload,
+        input,
         {
           context
         }
@@ -72,8 +77,8 @@ const accountSecurityActions = Object.freeze([
     permission: {
       require: "authenticated"
     },
-    inputValidator: [userSettingsResource.operations.oauthLinkStart.paramsValidator, userSettingsResource.operations.oauthLinkStart.queryValidator],
-    outputValidator: userSettingsResource.operations.oauthLinkStart.outputValidator,
+    input: oauthLinkStartInputValidator,
+    output: null,
     idempotency: "none",
     audit: {
       actionName: "settings.security.oauth.link.start"
@@ -99,8 +104,8 @@ const accountSecurityActions = Object.freeze([
     permission: {
       require: "authenticated"
     },
-    inputValidator: userSettingsResource.operations.oauthUnlink.paramsValidator,
-    outputValidator: userSettingsResource.operations.oauthUnlink.outputValidator,
+    input: userSettingsResource.operations.oauthUnlink.params,
+    output: null,
     idempotency: "none",
     audit: {
       actionName: "settings.security.oauth.unlink"
@@ -126,8 +131,8 @@ const accountSecurityActions = Object.freeze([
     permission: {
       require: "authenticated"
     },
-    inputValidator: userSettingsResource.operations.logoutOtherSessions.bodyValidator,
-    outputValidator: userSettingsResource.operations.logoutOtherSessions.outputValidator,
+    input: userSettingsResource.operations.logoutOtherSessions.body,
+    output: null,
     idempotency: "none",
     audit: {
       actionName: "settings.security.sessions.logout_others"

package/src/server/accountSecurity/accountSecurityService.js

@@ -1,5 +1,6 @@
 import { AppError } from "@jskit-ai/kernel/server/runtime/errors";
 import { createValidationError } from "@jskit-ai/kernel/server/runtime";
+import { returnJsonApiData, returnJsonApiMeta } from "@jskit-ai/http-runtime/shared";
 import {
   resolveUserProfile,
   resolveSecurityStatus
@@ -28,11 +29,18 @@ function createService({
       });
     }
 
-    return authService.changePassword(request, {
+    const result = await authService.changePassword(request, {
       currentPassword: payload.currentPassword,
       newPassword: payload.newPassword,
       confirmPassword: payload.confirmPassword
     });
+
+    return {
+      session: result?.session || null,
+      response: returnJsonApiMeta({
+        message: "Password updated."
+      })
+    };
   }
 
   async function setPasswordMethodEnabled(request, user, payload = {}, options = {}) {
@@ -51,7 +59,7 @@ function createService({
     const settings = await userSettingsRepository.ensureForUserId(profile.id);
     const securityStatus = await resolveSecurityStatus(authService, request);
 
-    return {
+    return returnJsonApiData({
       ...(response && typeof response === "object" ? response : {}),
       settings: accountSettingsResponseFormatter({
         profile,
@@ -59,7 +67,7 @@ function createService({
         securityStatus,
         authService
       })
-    };
+    });
   }
 
   async function startOAuthProviderLink(request, user, payload = {}, options = {}) {
@@ -78,9 +86,9 @@ function createService({
       throw new AppError(501, "OAuth unlink is not available.");
     }
 
-    return authService.unlinkProvider(request, {
+    return returnJsonApiData(await authService.unlinkProvider(request, {
       provider: payload.provider
-    });
+    }));
   }
 
   async function logoutOtherSessions(request, _user, options = {}) {
@@ -88,7 +96,9 @@ function createService({
       throw new AppError(501, "Logout other sessions is not available.");
     }
 
-    return authService.signOutOtherSessions(request);
+    await authService.signOutOtherSessions(request);
+
+    return null;
   }
 
   return Object.freeze({

package/src/server/accountSecurity/bootAccountSecurityRoutes.js

@@ -1,6 +1,20 @@
-import { Type } from "@fastify/type-provider-typebox";
+import { createSchema } from "json-rest-schema";
+import { createJsonApiResourceRouteContract } from "@jskit-ai/http-runtime/shared/validators/jsonApiRouteTransport";
 import { withStandardErrorResponses } from "@jskit-ai/http-runtime/shared/validators/errorResponses";
+import { deepFreeze } from "@jskit-ai/kernel/shared/support/deepFreeze";
 import { userSettingsResource } from "../../shared/resources/userSettingsResource.js";
+import { resolveAccountSettingsResourceId } from "../common/support/accountSettingsJsonApiTransport.js";
+
+const passwordChangeMetaOutputValidator = deepFreeze({
+  schema: createSchema({
+    message: {
+      type: "string",
+      required: true,
+      minLength: 1
+    }
+  }),
+  mode: "replace"
+});
 
 function bootAccountSecurityRoutes(app) {
   if (!app || typeof app.make !== "function") {
@@ -8,7 +22,6 @@ function bootAccountSecurityRoutes(app) {
   }
 
   const router = app.make("jskit.http.router");
-  const authService = app.make("authService");
 
   router.register(
     "POST",
@@ -19,13 +32,13 @@ function bootAccountSecurityRoutes(app) {
         tags: ["settings"],
         summary: "Set or change authenticated user's password"
       },
-      bodyValidator: userSettingsResource.operations.passwordChange.bodyValidator,
-      responseValidators: withStandardErrorResponses(
-        {
-          200: userSettingsResource.operations.passwordChange.outputValidator
-        },
-        { includeValidation400: true }
-      ),
+      ...createJsonApiResourceRouteContract({
+        requestType: "user-password-changes",
+        body: userSettingsResource.operations.passwordChange.body,
+        output: passwordChangeMetaOutputValidator,
+        outputKind: "meta",
+        includeValidation400: true
+      }),
       rateLimit: {
         max: 10,
         timeWindow: "1 minute"
@@ -34,19 +47,15 @@ function bootAccountSecurityRoutes(app) {
     async function (request, reply) {
       const result = await request.executeAction({
         actionId: "settings.security.password.change",
-        input: {
-          payload: request.input.body
-        }
+        input: request.input.body
       });
 
+      const authService = app.make("authService");
       if (result?.session && typeof authService.writeSessionCookies === "function") {
         authService.writeSessionCookies(reply, result.session);
       }
 
-      reply.code(200).send({
-        ok: true,
-        message: result?.message || "Password updated."
-      });
+      reply.code(200).send(result?.response || result);
     }
   );
 
@@ -59,13 +68,15 @@ function bootAccountSecurityRoutes(app) {
         tags: ["settings"],
         summary: "Enable or disable password sign-in method"
       },
-      bodyValidator: userSettingsResource.operations.passwordMethodToggle.bodyValidator,
-      responseValidators: withStandardErrorResponses(
-        {
-          200: userSettingsResource.operations.passwordMethodToggle.outputValidator
-        },
-        { includeValidation400: true }
-      ),
+      ...createJsonApiResourceRouteContract({
+        requestType: "user-password-method-settings",
+        responseType: "user-security-settings",
+        body: userSettingsResource.operations.passwordMethodToggle.body,
+        output: userSettingsResource.operations.passwordMethodToggle.output,
+        outputKind: "record",
+        getRecordId: resolveAccountSettingsResourceId,
+        includeValidation400: true
+      }),
       rateLimit: {
         max: 20,
         timeWindow: "1 minute"
@@ -74,9 +85,7 @@ function bootAccountSecurityRoutes(app) {
     async function (request, reply) {
       const response = await request.executeAction({
         actionId: "settings.security.password_method.toggle",
-        input: {
-          payload: request.input.body
-        }
+        input: request.input.body
       });
 
       reply.code(200).send(response);
@@ -93,11 +102,11 @@ function bootAccountSecurityRoutes(app) {
         tags: ["settings"],
         summary: "Start linking an OAuth provider for authenticated user"
       },
-      paramsValidator: userSettingsResource.operations.oauthLinkStart.paramsValidator,
-      queryValidator: userSettingsResource.operations.oauthLinkStart.queryValidator,
-      responseValidators: withStandardErrorResponses(
+      params: userSettingsResource.operations.oauthLinkStart.params,
+      query: userSettingsResource.operations.oauthLinkStart.query,
+      responses: withStandardErrorResponses(
         {
-          302: { schema: Type.Unknown() }
+          302: userSettingsResource.operations.oauthLinkStart.output
         },
         { includeValidation400: true }
       ),
@@ -128,13 +137,14 @@ function bootAccountSecurityRoutes(app) {
         tags: ["settings"],
         summary: "Unlink an OAuth provider from authenticated account"
       },
-      paramsValidator: userSettingsResource.operations.oauthUnlink.paramsValidator,
-      responseValidators: withStandardErrorResponses(
-        {
-          200: userSettingsResource.operations.oauthUnlink.outputValidator
-        },
-        { includeValidation400: true }
-      ),
+      params: userSettingsResource.operations.oauthUnlink.params,
+      ...createJsonApiResourceRouteContract({
+        responseType: "user-security-settings",
+        output: userSettingsResource.operations.oauthUnlink.output,
+        outputKind: "record",
+        getRecordId: resolveAccountSettingsResourceId,
+        includeValidation400: true
+      }),
       rateLimit: {
         max: 20,
         timeWindow: "1 minute"
@@ -161,8 +171,10 @@ function bootAccountSecurityRoutes(app) {
         tags: ["settings"],
         summary: "Sign out from other active sessions"
       },
-      responseValidators: withStandardErrorResponses({
-        200: userSettingsResource.operations.logoutOtherSessions.outputValidator
+      ...createJsonApiResourceRouteContract({
+        responseType: "user-security-session-operations",
+        outputKind: "no-content",
+        successStatus: 204
       }),
       rateLimit: {
         max: 20,
@@ -174,7 +186,7 @@ function bootAccountSecurityRoutes(app) {
         actionId: "settings.security.sessions.logout_others",
         input: {}
       });
-      reply.code(200).send(response);
+      reply.code(204).send(response);
     }
   );
 }

package/src/server/common/formatters/accountSettingsResponseFormatter.js

@@ -1,8 +1,8 @@
 import { normalizeLowerText, normalizeText } from "@jskit-ai/kernel/shared/actions/textNormalization";
 import {
-  USER_SETTINGS_SECTIONS,
-  userSettingsFields
-} from "../../../shared/resources/userSettingsFields.js";
+  USER_SETTINGS_NOTIFICATION_KEYS,
+  USER_SETTINGS_PREFERENCE_KEYS
+} from "../../../shared/resources/userSettingsResource.js";
 import { accountAvatarFormatter } from "./accountAvatarFormatter.js";
 import { accountSecurityStatusFormatter } from "./accountSecurityStatusFormatter.js";
 
@@ -21,22 +21,12 @@ function resolveAuthProfileSettings(authService) {
   };
 }
 
-function formatUserSettingsSection(section, settings = {}) {
+function formatUserSettingsSection(fieldKeys, settings = {}) {
   const source = settings && typeof settings === "object" ? settings : {};
   const formatted = {};
 
-  for (const field of userSettingsFields) {
-    if (field.section !== section) {
-      continue;
-    }
-    const rawValue = Object.hasOwn(source, field.key)
-      ? source[field.key]
-      : field.resolveDefault({
-          settings: source
-        });
-    formatted[field.key] = field.normalizeOutput(rawValue, {
-      settings: source
-    });
+  for (const fieldKey of fieldKeys) {
+    formatted[fieldKey] = source[fieldKey];
   }
 
   return formatted;
@@ -54,8 +44,8 @@ function accountSettingsResponseFormatter({ profile, settings, securityStatus, a
       avatar: accountAvatarFormatter(profile, settings)
     },
     security: accountSecurityStatusFormatter(securityStatus),
-    preferences: formatUserSettingsSection(USER_SETTINGS_SECTIONS.PREFERENCES, settings),
-    notifications: formatUserSettingsSection(USER_SETTINGS_SECTIONS.NOTIFICATIONS, settings)
+    preferences: formatUserSettingsSection(USER_SETTINGS_PREFERENCE_KEYS, settings),
+    notifications: formatUserSettingsSection(USER_SETTINGS_NOTIFICATION_KEYS, settings)
   };
 }
 

package/src/server/common/registerCommonRepositories.js

@@ -1,3 +1,4 @@
+import { INTERNAL_JSON_REST_API } from "@jskit-ai/json-rest-api-core/server/jsonRestApiHost";
 import { createRepository as createUserProfilesRepository } from "./repositories/userProfilesRepository.js";
 import { createRepository as createUserSettingsRepository } from "./repositories/userSettingsRepository.js";
 
@@ -7,13 +8,15 @@ function registerCommonRepositories(app) {
   }
 
   app.singleton("internal.repository.user-settings", (scope) => {
+    const api = scope.make(INTERNAL_JSON_REST_API);
     const knex = scope.make("jskit.database.knex");
-    return createUserSettingsRepository(knex);
+    return createUserSettingsRepository({ api, knex });
   });
 
   app.singleton("internal.repository.user-profiles", (scope) => {
+    const api = scope.make(INTERNAL_JSON_REST_API);
     const knex = scope.make("jskit.database.knex");
-    return createUserProfilesRepository(knex);
+    return createUserProfilesRepository({ api, knex });
   });
 }