@solidxai/core 0.1.16-beta.2 → 0.1.16-beta.4

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@solidxai/core",
-  "version": "0.1.16-beta.2",
+  "version": "0.1.16-beta.4",
   "description": "This module is a NestJS module containing all the required core providers required by a Solid application",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

package/postman/signup-issues

@@ -1,2 +1,3 @@
-fullName -> not set in the case of public registration
-userType is not set in the case of public registration
+userType is not set in the case of public registration (pending)
+need to test with transactional and mobile type (pending)
+need to check the oauth flow as well

package/src/controllers/chatter-message-details.controller.ts

@@ -5,10 +5,7 @@ import { ChatterMessageDetailsService } from '../services/chatter-message-detail
 import { CreateChatterMessageDetailsDto } from '../dtos/create-chatter-message-details.dto';
 import { UpdateChatterMessageDetailsDto } from '../dtos/update-chatter-message-details.dto';
 
-enum ShowSoftDeleted {
-  INCLUSIVE = "inclusive",
-  EXCLUSIVE = "exclusive",
-}
+import { ShowSoftDeleted } from '../enums/show-soft-deleted.enum';
 
 @ApiTags('Solid Core')
 @Controller('chatter-message-details')

package/src/controllers/chatter-message.controller.ts

@@ -10,10 +10,7 @@ import { SolidRequestContextDecorator } from 'src/decorators/solid-request-conte
 import { SolidRequestContextDto } from 'src/dtos/solid-request-context.dto';
 import { Public } from 'src/decorators/public.decorator';
 
-enum ShowSoftDeleted {
-  INCLUSIVE = "inclusive",
-  EXCLUSIVE = "exclusive",
-}
+import { ShowSoftDeleted } from '../enums/show-soft-deleted.enum';
 
 @ApiTags('Solid Core')
 @Controller('chatter-message')

package/src/controllers/dashboard-user-layout.controller.ts

@@ -5,10 +5,7 @@ import { DashboardUserLayoutService } from '../services/dashboard-user-layout.se
 import { CreateDashboardUserLayoutDto } from '../dtos/create-dashboard-user-layout.dto';
 import { UpdateDashboardUserLayoutDto } from '../dtos/update-dashboard-user-layout.dto';
 
-enum ShowSoftDeleted {
-  INCLUSIVE = "inclusive",
-  EXCLUSIVE = "exclusive",
-}
+import { ShowSoftDeleted } from '../enums/show-soft-deleted.enum';
 
 @ApiTags('Solid Core')
 @Controller('dashboard-user-layout')

package/src/controllers/import-transaction-error-log.controller.ts

@@ -5,10 +5,7 @@ import { ImportTransactionErrorLogService } from '../services/import-transaction
 import { CreateImportTransactionErrorLogDto } from '../dtos/create-import-transaction-error-log.dto';
 import { UpdateImportTransactionErrorLogDto } from '../dtos/update-import-transaction-error-log.dto';
 
-enum ShowSoftDeleted {
-  INCLUSIVE = "inclusive",
-  EXCLUSIVE = "exclusive",
-}
+import { ShowSoftDeleted } from '../enums/show-soft-deleted.enum';
 
 @ApiTags('Solid Core')
 @Controller('import-transaction-error-log')

package/src/controllers/import-transaction.controller.ts

@@ -9,10 +9,7 @@ import { ActiveUser } from 'src/decorators/active-user.decorator';
 import { ActiveUserData } from 'src/interfaces/active-user-data.interface';
 import { setFileDownloadHeaders } from 'src/helpers/file-download.helper';
 
-enum ShowSoftDeleted {
-  INCLUSIVE = "inclusive",
-  EXCLUSIVE = "exclusive",
-}
+import { ShowSoftDeleted } from '../enums/show-soft-deleted.enum';
 
 @ApiTags('Solid Core')
 @Controller('import-transaction')

package/src/controllers/list-of-values.controller.ts

@@ -5,10 +5,7 @@ import { ListOfValuesService } from '../services/list-of-values.service';
 import { CreateListOfValuesDto } from '../dtos/create-list-of-values.dto';
 import { UpdateListOfValuesDto } from '../dtos/update-list-of-values.dto';
 
-enum ShowSoftDeleted {
-  INCLUSIVE = "inclusive",
-  EXCLUSIVE = "exclusive",
-}
+import { ShowSoftDeleted } from '../enums/show-soft-deleted.enum';
 
 @ApiTags('Solid Core')
 @Controller('list-of-values')

package/src/controllers/locale.controller.ts

@@ -7,10 +7,7 @@ import { LocaleService } from 'src/services/locale.service';
 import { CreateLocaleDto } from 'src/dtos/create-locale.dto';
 import { UpdateLocaleDto } from 'src/dtos/update-locale.dto';
 
-enum ShowSoftDeleted {
-  INCLUSIVE = "inclusive",
-  EXCLUSIVE = "exclusive",
-}
+import { ShowSoftDeleted } from '../enums/show-soft-deleted.enum';
 
 @ApiTags('Solid Core')
 @Controller('locale')

package/src/controllers/media.controller.ts

@@ -12,10 +12,7 @@ import { Response } from 'express';
 import { getLowercaseFileExtension, INLINE_SAFE_EXTENSIONS } from 'src/constants/media-file-types';
 import { setFileDownloadHeaders } from 'src/helpers/file-download.helper';
 
-enum ShowSoftDeleted {
-  INCLUSIVE = "inclusive",
-  EXCLUSIVE = "exclusive",
-}
+import { ShowSoftDeleted } from '../enums/show-soft-deleted.enum';
 
 @ApiTags('Solid Core')
 @Controller('media')

package/src/controllers/model-sequence.controller.ts

@@ -5,10 +5,7 @@ import { ModelSequenceService } from '../services/model-sequence.service';
 import { CreateModelSequenceDto } from '../dtos/create-model-sequence.dto';
 import { UpdateModelSequenceDto } from '../dtos/update-model-sequence.dto';
 
-enum ShowSoftDeleted {
-  INCLUSIVE = "inclusive",
-  EXCLUSIVE = "exclusive",
-}
+import { ShowSoftDeleted } from '../enums/show-soft-deleted.enum';
 
 @ApiTags('Solid Core')
 @Controller('model-sequence')

package/src/controllers/saved-filters.controller.ts

@@ -5,10 +5,7 @@ import { SavedFiltersService } from '../services/saved-filters.service';
 import { CreateSavedFiltersDto } from '../dtos/create-saved-filters.dto';
 import { UpdateSavedFiltersDto } from '../dtos/update-saved-filters.dto';
 
-enum ShowSoftDeleted {
-  INCLUSIVE = "inclusive",
-  EXCLUSIVE = "exclusive",
-}
+import { ShowSoftDeleted } from '../enums/show-soft-deleted.enum';
 
 @ApiTags('Solid Core')
 @Controller('saved-filters')

package/src/controllers/scheduled-job.controller.ts

@@ -5,10 +5,7 @@ import { CreateScheduledJobDto } from 'src/dtos/create-scheduled-job.dto';
 import { UpdateScheduledJobDto } from 'src/dtos/update-scheduled-job.dto';
 import { ScheduledJobService } from 'src/services/scheduled-job.service';
 
-enum ShowSoftDeleted {
-  INCLUSIVE = "inclusive",
-  EXCLUSIVE = "exclusive",
-}
+import { ShowSoftDeleted } from '../enums/show-soft-deleted.enum';
 
 @ApiTags('Solid Core')
 @Controller('scheduled-job')

package/src/controllers/security-rule.controller.ts

@@ -5,10 +5,7 @@ import { SecurityRuleService } from '../services/security-rule.service';
 import { CreateSecurityRuleDto } from '../dtos/create-security-rule.dto';
 import { UpdateSecurityRuleDto } from '../dtos/update-security-rule.dto';
 
-enum ShowSoftDeleted {
-  INCLUSIVE = "inclusive",
-  EXCLUSIVE = "exclusive",
-}
+import { ShowSoftDeleted } from '../enums/show-soft-deleted.enum';
 
 @ApiTags('Solid Core')
 @Controller('security-rule')

package/src/controllers/user-activity-history.controller.ts

@@ -5,10 +5,7 @@ import { UserActivityHistoryService } from '../services/user-activity-history.se
 import { CreateUserActivityHistoryDto } from '../dtos/create-user-activity-history.dto';
 import { UpdateUserActivityHistoryDto } from '../dtos/update-user-activity-history.dto';
 
-enum ShowSoftDeleted {
-  INCLUSIVE = "inclusive",
-  EXCLUSIVE = "exclusive",
-}
+import { ShowSoftDeleted } from '../enums/show-soft-deleted.enum';
 
 @ApiTags('Solid Core')
 @Controller('user-activity-history')

package/src/controllers/user-view-metadata.controller.ts

@@ -8,10 +8,7 @@ import { UpsertUserViewMetadataDto } from 'src/dtos/upsert-user-view-metadata.dt
 import { ActiveUser } from 'src/decorators/active-user.decorator';
 import { ActiveUserData } from 'src/interfaces/active-user-data.interface';
 
-enum ShowSoftDeleted {
-  INCLUSIVE = "inclusive",
-  EXCLUSIVE = "exclusive",
-}
+import { ShowSoftDeleted } from '../enums/show-soft-deleted.enum';
 
 @ApiTags('Solid Core')
 @Controller('user-view-metadata')

package/src/controllers/workflow-definition.controller.ts

@@ -8,10 +8,7 @@ import { ExecuteWorkflowDto } from '../dtos/execute-workflow.dto';
 import { WorkflowNodeRegistryService } from '../services/workflow/workflow-node-registry.service';
 import { ValidateWorkflowDefinitionDto } from '../dtos/validate-workflow-definition.dto';
 
-enum ShowSoftDeleted {
-  INCLUSIVE = "inclusive",
-  EXCLUSIVE = "exclusive",
-}
+import { ShowSoftDeleted } from '../enums/show-soft-deleted.enum';
 
 @ApiTags('Solid Core')
 @Controller('workflow-definition')

package/src/controllers/workflow-execution-artifact.controller.ts

@@ -5,10 +5,7 @@ import { WorkflowExecutionArtifactService } from '../services/workflow-execution
 import { CreateWorkflowExecutionArtifactDto } from '../dtos/create-workflow-execution-artifact.dto';
 import { UpdateWorkflowExecutionArtifactDto } from '../dtos/update-workflow-execution-artifact.dto';
 
-enum ShowSoftDeleted {
-  INCLUSIVE = "inclusive",
-  EXCLUSIVE = "exclusive",
-}
+import { ShowSoftDeleted } from '../enums/show-soft-deleted.enum';
 
 @ApiTags('Solid Core')
 @Controller('workflow-execution-artifact')

package/src/controllers/workflow-execution-log.controller.ts

@@ -5,10 +5,7 @@ import { WorkflowExecutionLogService } from '../services/workflow-execution-log.
 import { CreateWorkflowExecutionLogDto } from '../dtos/create-workflow-execution-log.dto';
 import { UpdateWorkflowExecutionLogDto } from '../dtos/update-workflow-execution-log.dto';
 
-enum ShowSoftDeleted {
-  INCLUSIVE = "inclusive",
-  EXCLUSIVE = "exclusive",
-}
+import { ShowSoftDeleted } from '../enums/show-soft-deleted.enum';
 
 @ApiTags('Solid Core')
 @Controller('workflow-execution-log')

package/src/controllers/workflow-execution.controller.ts

@@ -6,10 +6,7 @@ import { CreateWorkflowExecutionDto } from '../dtos/create-workflow-execution.dt
 import { UpdateWorkflowExecutionDto } from '../dtos/update-workflow-execution.dto';
 import { WorkflowRuntimeService } from '../services/workflow/workflow-runtime.service';
 
-enum ShowSoftDeleted {
-  INCLUSIVE = "inclusive",
-  EXCLUSIVE = "exclusive",
-}
+import { ShowSoftDeleted } from '../enums/show-soft-deleted.enum';
 
 @ApiTags('Solid Core')
 @Controller('workflow-execution')

package/src/controllers/workflow-secret.controller.ts

@@ -5,10 +5,7 @@ import { WorkflowSecretService } from '../services/workflow-secret.service';
 import { CreateWorkflowSecretDto } from '../dtos/create-workflow-secret.dto';
 import { UpdateWorkflowSecretDto } from '../dtos/update-workflow-secret.dto';
 
-enum ShowSoftDeleted {
-  INCLUSIVE = "inclusive",
-  EXCLUSIVE = "exclusive",
-}
+import { ShowSoftDeleted } from '../enums/show-soft-deleted.enum';
 
 @ApiTags('Solid Core')
 @Controller('workflow-secret')

package/src/controllers/workflow-step-execution.controller.ts

@@ -5,10 +5,7 @@ import { WorkflowStepExecutionService } from '../services/workflow-step-executio
 import { CreateWorkflowStepExecutionDto } from '../dtos/create-workflow-step-execution.dto';
 import { UpdateWorkflowStepExecutionDto } from '../dtos/update-workflow-step-execution.dto';
 
-enum ShowSoftDeleted {
-  INCLUSIVE = "inclusive",
-  EXCLUSIVE = "exclusive",
-}
+import { ShowSoftDeleted } from '../enums/show-soft-deleted.enum';
 
 @ApiTags('Solid Core')
 @Controller('workflow-step-execution')

package/src/controllers/workflow-trigger-execution.controller.ts

@@ -5,10 +5,7 @@ import { WorkflowTriggerExecutionService } from '../services/workflow-trigger-ex
 import { CreateWorkflowTriggerExecutionDto } from '../dtos/create-workflow-trigger-execution.dto';
 import { UpdateWorkflowTriggerExecutionDto } from '../dtos/update-workflow-trigger-execution.dto';
 
-enum ShowSoftDeleted {
-  INCLUSIVE = "inclusive",
-  EXCLUSIVE = "exclusive",
-}
+import { ShowSoftDeleted } from '../enums/show-soft-deleted.enum';
 
 @ApiTags('Solid Core')
 @Controller('workflow-trigger-execution')

package/src/dtos/basic-filters.dto.ts

@@ -4,11 +4,10 @@ import { IsEnum, IsOptional } from "class-validator";
 import { PaginationQueryDto } from "./pagination-query.dto";
 import { Timestamp } from "typeorm";
 import { BasicGroupFilterDto } from "./basic-group-filters.dto";
+import { ShowSoftDeleted } from "../enums/show-soft-deleted.enum";
 
-export enum SoftDeleteFilter {
-    INCLUSIVE = "inclusive",
-    EXCLUSIVE = "exclusive",
-}
+// Backwards-compatible alias for consumers using the older DTO name.
+export { ShowSoftDeleted as SoftDeleteFilter } from "../enums/show-soft-deleted.enum";
 
 export class BasicFilterDto extends PaginationQueryDto {
 
@@ -41,12 +40,12 @@ export class BasicFilterDto extends PaginationQueryDto {
     // readonly filters: any[];
 
     @IsOptional()
-    @IsEnum(SoftDeleteFilter)
+    @IsEnum(ShowSoftDeleted)
     @ApiProperty({
         description: "showSoftDeleted",
-        enum: SoftDeleteFilter,
+        enum: ShowSoftDeleted,
     })
-    readonly showSoftDeleted?: SoftDeleteFilter;
+    readonly showSoftDeleted?: ShowSoftDeleted;
 
     @IsOptional()
     @ApiProperty({ description: "populateGroup" })

package/src/dtos/otp-sign-up.dto.ts

@@ -1,17 +1,26 @@
-import { IsEmail, IsEnum, IsJSON, IsNotEmpty, IsOptional } from 'class-validator';
+import { IsEmail, IsEnum, IsJSON, IsNotEmpty, IsOptional, IsString } from 'class-validator';
 
 import { PasswordlessRegistrationValidateWhatSources } from "../constants";
+import { ApiProperty } from '@nestjs/swagger';
 
 export class OTPSignUpDto {
+    @IsOptional()
+    @IsString()
+    @ApiProperty()
+    fullName: string;
+
     @IsNotEmpty()
+    @ApiProperty()
     username: string;
 
     @IsOptional()
     @IsEmail()
+    @ApiProperty()
     email: string;
 
     @IsOptional()
     @IsNotEmpty()
+    @ApiProperty()
     mobile: string;
 
     @IsOptional()
@@ -19,5 +28,6 @@ export class OTPSignUpDto {
     validationSources: PasswordlessRegistrationValidateWhatSources[] = [];
 
     @IsOptional()
+    @ApiProperty()
     customPayload: any;
 }

package/src/enums/show-soft-deleted.enum.ts

@@ -0,0 +1,4 @@
+export enum ShowSoftDeleted {
+  INCLUSIVE = "inclusive",
+  EXCLUSIVE = "exclusive",
+}

package/src/index.ts

@@ -194,6 +194,7 @@ export * from './entities/workflow-secret.entity'
 export * from './enums/auth-type.enum'
 export * from './enums/legacy-table-type.enum'
 export * from './enums/signup-intent.enum'
+export * from './enums/show-soft-deleted.enum'
 export * from './decorators/disallow-in-production.decorator'
 
 export * from './filters/http-exception.filter'

package/src/services/authentication.service.ts

@@ -70,9 +70,18 @@ interface otp {
 
 /** Where a signup's role names come from. */
 enum RolesSource {
-  /** None from the caller: performSignUp applies the configured `defaultRole`. */
+  /**
+   * Ask nobody; returning [] lets performSignUp apply the configured `defaultRole`.
+   *
+   * No intent maps here today - it is kept for paths that deliberately bypass the
+   * provider. OAuth is the live example: its DTO can never carry a discriminator, so
+   * it takes `defaultRole` outright (currently inline in UserService).
+   */
   Default,
-  /** `provider.roles(dto)`, unconditionally. */
+  /**
+   * `provider.roles(dto)` - and nothing else. Yields [] when no provider is registered
+   * or when the provider declines to name any, which falls through to `defaultRole`.
+   */
   Provider,
   /** The caller's own `dto.roles`. */
   Caller,
@@ -82,10 +91,18 @@ enum RolesSource {
  * The single place that decides, per intent, which entity a signup builds and where
  * its roles come from.
  *
- * `useProvider` is currently computable from `rolesSource` (`Caller` implies false),
- * but the two answer different questions - "which entity?" and "which roles?" - that
- * merely coincide across these three intents. Keep both, and change behaviour here
- * rather than at a call site.
+ * Where an extension user provider is registered it is the authority on that app's user
+ * roles, so every provider-backed intent asks it. `defaultRole` is the *fallback* for
+ * when it names none - or when there is no provider at all - not the rule.
+ *
+ * SelfRegistration and ExtensionModel resolve identically today. They stay separate
+ * intents because only SelfRegistration is gated on `allowPublicRegistration`, and
+ * because "an anonymous visitor signing themselves up" and "an admin creating a user
+ * from the model's own form" are different things that may yet need to diverge.
+ *
+ * `useProvider` is computable from `rolesSource` today (`Caller` implies false), but the
+ * two answer different questions - "which entity?" and "which roles?" - that merely
+ * coincide across these intents. Keep both, and change behaviour here, not at a call site.
  */
 const SIGNUP_POLICY: Record<
   SignupIntent,
@@ -93,7 +110,7 @@ const SIGNUP_POLICY: Record<
 > = {
   [SignupIntent.SelfRegistration]: {
     useProvider: true,
-    rolesSource: RolesSource.Default,
+    rolesSource: RolesSource.Provider,
   },
   [SignupIntent.ExtensionModel]: {
     useProvider: true,
@@ -246,12 +263,24 @@ export class AuthenticationService {
     dto: Record<string, any>,
     source: RolesSource,
   ): string[] {
+    // Only `Caller` reads dto.roles. Anywhere else, roles in the body are ignored -
+    // which is what keeps an anonymous caller from naming their own on a @Public()
+    // endpoint - so say so rather than dropping them silently.
+    if (source !== RolesSource.Caller && dto.roles?.length) {
+      this.logger.warn(
+        `Ignoring caller-supplied roles for "${dto.username}": roles on this path come from ` +
+          (source === RolesSource.Provider
+            ? "the extension user provider"
+            : "the configured defaultRole"),
+      );
+    }
+
     switch (source) {
       case RolesSource.Provider:
-        // Sole authority. `dto.roles` is deliberately not read - not as a preference,
-        // not as a fallback. Reading it would skip roles(), which is where a provider
-        // validates its discriminator, and CreateUserDto types roles as
-        // UpdateRoleMetadataDto[] where performSignUp expects role-name strings.
+        // Sole authority. Reading dto.roles as a preference or fallback would skip
+        // roles(), which is where a provider validates its discriminator, and
+        // CreateUserDto types roles as UpdateRoleMetadataDto[] where performSignUp
+        // expects role-name strings. [] here falls through to `defaultRole`.
         return (
           this.solidRegistry
             .getExtensionUserCreationProvider()
@@ -262,14 +291,6 @@ export class AuthenticationService {
         return dto.roles ?? [];
 
       case RolesSource.Default:
-        // Public signup: the form has no business naming roles. Returning empty lets
-        // performSignUp apply the configured `defaultRole`, rather than adding a
-        // second mechanism for the same thing.
-        if (dto.roles?.length) {
-          this.logger.warn(
-            `Ignoring caller-supplied roles on public registration for "${dto.username}"`,
-          );
-        }
         return [];
     }
   }
@@ -772,16 +793,31 @@ export class AuthenticationService {
     validationSource: string,
   ): Promise<User> {
     if (isEmpty(existingUser)) {
+      // Resolved before anything is written: where a provider requires its discriminator
+      // roles() throws, and that should surface as a rejected request rather than as a
+      // half-registered user with no roles.
+      const roles = this.resolveSignupRoles(
+        signUpDto,
+        SIGNUP_POLICY[SignupIntent.SelfRegistration].rolesSource,
+      );
+
       // A new registration is saved through whichever repository createUser resolved,
       // which is the provider's when the app registers one.
       const { entity: user, repo } = await this.createUser(signUpDto);
       user.active = false; // User will be activated only after OTP verification, hence setting active to false for new user.
       await this.assignRegistrationOtp(validationSource, user);
       await repo.save(user);
-      await this.userService.addRoleToUser(
-        user.username,
-        this.settingService.getConfigValue<SolidCoreSetting>("defaultRole"),
-      );
+
+      if (roles.length) {
+        await this.userService.addRolesToUser(user.username, roles);
+      } else {
+        // The provider named none, or there is no provider: fall back to the configured
+        // default, matching what performSignUp does on the password paths.
+        await this.userService.addRoleToUser(
+          user.username,
+          this.settingService.getConfigValue<SolidCoreSetting>("defaultRole"),
+        );
+      }
       return user;
     }
 
@@ -812,9 +848,8 @@ export class AuthenticationService {
     entity.username = signUpDto.username;
     entity.email = signUpDto.email;
     entity.mobile = signUpDto.mobile;
-    // OTPSignUpDto declares no `fullName`, so username is the only source here. Mirrors
-    // the fallback in populateForSignup, which this path does not go through.
-    entity.fullName = signUpDto.username;
+    // OTPSignUpDto declares no `fullName`, so username is the only source here. Mirrors the fallback in populateForSignup, which this path does not go through.
+    entity.fullName = signUpDto.fullName?.trim() || signUpDto.username;
     entity.customPayload = signUpDto.customPayload;
     entity.lastLoginProvider = LoginProvider.OTP;