@rytass/bpm-core-nestjs-module 0.1.3 → 0.1.4

package/src/lib/identity/member-base.adapter.ts

@@ -1,244 +0,0 @@
-import { InjectionToken, Provider } from '@nestjs/common';
-import { MemberMetadata } from '@rytass/bpm-core-shared';
-import { BPMAuthContext } from '../bpm-auth';
-import { BPMMemberResolver } from './member-resolver.interface';
-
-/**
- * Structural contract a host identity backend should implement (or a thin
- * adapter wrap) so BPM can be plugged into any `member-base`-style
- * directory without coupling `@rytass/bpm-core-nestjs-module` to a
- * specific identity package.
- *
- * `TMember` is the host's own member shape; the adapter walks it through
- * {@link BPMMemberBaseAdapterOptions} field readers.
- */
-export interface BPMMemberBaseDirectory<TMember> {
-  readonly resolveMember: (memberId: string) => Promise<TMember | null>;
-  readonly resolveMembers?: (
-    memberIds: readonly string[],
-  ) => Promise<readonly TMember[]>;
-  readonly searchMembers?: (searchText: string) => Promise<readonly TMember[]>;
-}
-
-/**
- * Per-host field readers that tell the adapter how to extract canonical
- * BPM fields out of the host's `TMember`. Each reader is optional;
- * sensible defaults are inferred when the host uses common conventions
- * (`memberId` / `id` / `sub` for the member id, `email` for the email,
- * `name` / `displayName` for the name, etc.).
- *
- * Provide `readPermissions` and `readRoles` if you want BPM's
- * `BPMAdminGuard` / `BPMDesignerGuard` to receive the host's RBAC
- * strings; otherwise the resolved `BPMAuthContext` will carry empty
- * arrays.
- */
-export interface BPMMemberBaseAdapterOptions<TMember> {
-  readonly readCustomFields?: (
-    member: TMember,
-  ) => Readonly<Record<string, unknown>>;
-  readonly readEmail?: (member: TMember) => string | null;
-  readonly readMemberId?: (member: TMember) => string | null;
-  readonly readName?: (member: TMember) => string | null;
-  readonly readPermissions?: (member: TMember) => readonly string[];
-  readonly readRoles?: (member: TMember) => readonly string[];
-}
-
-export interface BPMMemberBaseResolverProviderOptions<TMember> {
-  readonly adapterOptions?: BPMMemberBaseAdapterOptions<TMember>;
-  readonly directoryToken: InjectionToken<BPMMemberBaseDirectory<TMember>>;
-  readonly provide: InjectionToken<BPMMemberResolver>;
-}
-
-export class BPMMemberBaseResolverAdapter<TMember>
-  implements BPMMemberResolver
-{
-  constructor(
-    private readonly directory: BPMMemberBaseDirectory<TMember>,
-    private readonly options: BPMMemberBaseAdapterOptions<TMember> = {},
-  ) {}
-
-  async resolve(memberId: string): Promise<MemberMetadata> {
-    const member = await this.directory.resolveMember(memberId);
-
-    if (!member) {
-      throw new Error(`member-base member ${memberId} was not found`);
-    }
-
-    return readMemberMetadataFromMemberBaseMember(member, this.options);
-  }
-
-  async resolveMany(
-    memberIds: readonly string[],
-  ): Promise<ReadonlyMap<string, MemberMetadata>> {
-    const members = this.directory.resolveMembers
-      ? await this.directory.resolveMembers(memberIds)
-      : await Promise.all(
-          memberIds.map((memberId): Promise<TMember | null> =>
-            this.directory.resolveMember(memberId),
-          ),
-        );
-
-    return members
-      .filter((member): member is TMember => Boolean(member))
-      .map((member): MemberMetadata =>
-        readMemberMetadataFromMemberBaseMember(member, this.options),
-      )
-      .reduce<ReadonlyMap<string, MemberMetadata>>(
-        (metadataByMemberId, metadata): ReadonlyMap<string, MemberMetadata> =>
-          new Map(metadataByMemberId).set(metadata.memberId, metadata),
-        new Map(),
-      );
-  }
-
-  async search(searchText: string): Promise<readonly MemberMetadata[]> {
-    if (!this.directory.searchMembers) {
-      return [];
-    }
-
-    return (await this.directory.searchMembers(searchText)).map(
-      (member): MemberMetadata =>
-        readMemberMetadataFromMemberBaseMember(member, this.options),
-    );
-  }
-}
-
-/**
- * Helper for hosts that already hold an authenticated `TMember` (for
- * example from `@rytass/member-base-nestjs-module`) and want to project it
- * into a {@link BPMAuthContext} without writing the boilerplate by hand.
- *
- * Returns `null` when the input is nullish or when the member is missing
- * an id — never throws. Pair this with `BPMRootModuleOptions.authContextFactory`
- * so BPM resolvers receive the projected context on every request.
- *
- * @example
- * ```ts
- * const bpmAuth = createBPMAuthContextFromMemberBaseMember(memberBaseUser, {
- *   readRoles: (m) => m.roles,
- *   readPermissions: (m) => m.permissions,
- *   readCustomFields: (m) => ({ tenantId: m.tenantId }),
- * });
- * ```
- */
-export function createBPMAuthContextFromMemberBaseMember<TMember>(
-  member: TMember | null | undefined,
-  options: BPMMemberBaseAdapterOptions<TMember> = {},
-): BPMAuthContext | null {
-  if (!member) {
-    return null;
-  }
-
-  const memberId = readMemberId(member, options);
-
-  return memberId
-    ? {
-        memberId,
-        metadata: options.readCustomFields?.(member) ?? {},
-        permissions: options.readPermissions?.(member) ?? [],
-        roles: options.readRoles?.(member) ?? [],
-      }
-    : null;
-}
-
-/**
- * Builds a Nest `Provider` that adapts a host-provided
- * {@link BPMMemberBaseDirectory} into a {@link BPMMemberResolver}, then
- * registers it under the host-chosen injection token (typically
- * {@link BPM_MEMBER_RESOLVER}).
- *
- * Pass the result inside `BPMRootModuleOptions.memberResolverProvider`.
- *
- * @example
- * ```ts
- * BPMRootModule.forRoot({
- *   memberResolverProvider: createBPMMemberBaseResolverProvider({
- *     provide: BPM_MEMBER_RESOLVER,
- *     directoryToken: HOST_MEMBER_DIRECTORY,
- *     adapterOptions: {
- *       readEmail: (m) => m.email,
- *       readName: (m) => m.name,
- *     },
- *   }),
- *   // ...
- * });
- * ```
- */
-export function createBPMMemberBaseResolverProvider<TMember>({
-  adapterOptions,
-  directoryToken,
-  provide,
-}: BPMMemberBaseResolverProviderOptions<TMember>): Provider<BPMMemberResolver> {
-  return {
-    inject: [directoryToken],
-    provide,
-    useFactory: (
-      directory: BPMMemberBaseDirectory<TMember>,
-    ): BPMMemberResolver =>
-      new BPMMemberBaseResolverAdapter(directory, adapterOptions),
-  };
-}
-
-export function readMemberMetadataFromMemberBaseMember<TMember>(
-  member: TMember,
-  options: BPMMemberBaseAdapterOptions<TMember> = {},
-): MemberMetadata {
-  const memberId = readMemberId(member, options);
-
-  if (!memberId) {
-    throw new Error('member-base member id is required for BPM integration');
-  }
-
-  return {
-    customFields: options.readCustomFields?.(member) ?? {},
-    email: readMemberEmail(member, options) ?? '',
-    memberId,
-    name: readMemberName(member, options) ?? memberId,
-  };
-}
-
-function readMemberId<TMember>(
-  member: TMember,
-  options: BPMMemberBaseAdapterOptions<TMember>,
-): string | null {
-  return (
-    normalizeText(options.readMemberId?.(member)) ??
-    readStringProperty(member, 'memberId') ??
-    readStringProperty(member, 'id') ??
-    readStringProperty(member, 'sub')
-  );
-}
-
-function readMemberEmail<TMember>(
-  member: TMember,
-  options: BPMMemberBaseAdapterOptions<TMember>,
-): string | null {
-  return normalizeText(options.readEmail?.(member)) ?? readStringProperty(member, 'email');
-}
-
-function readMemberName<TMember>(
-  member: TMember,
-  options: BPMMemberBaseAdapterOptions<TMember>,
-): string | null {
-  return (
-    normalizeText(options.readName?.(member)) ??
-    readStringProperty(member, 'name') ??
-    readStringProperty(member, 'displayName') ??
-    readMemberEmail(member, options)
-  );
-}
-
-function readStringProperty(value: unknown, key: string): string | null {
-  if (!isRecord(value)) {
-    return null;
-  }
-
-  return normalizeText(value[key]);
-}
-
-function normalizeText(value: unknown): string | null {
-  return typeof value === 'string' && value.trim() ? value.trim() : null;
-}
-
-function isRecord(value: unknown): value is Readonly<Record<string, unknown>> {
-  return typeof value === 'object' && value !== null;
-}

package/src/lib/identity/member-metadata-cache.entity.ts

@@ -1,27 +0,0 @@
-import { Field, ID, ObjectType } from '@nestjs/graphql';
-import { Column, Entity, PrimaryGeneratedColumn, Unique } from 'typeorm';
-import { MemberMetadata } from '@rytass/bpm-core-shared';
-
-@Entity('member_metadata_cache')
-@Unique(['memberId'])
-@ObjectType('MemberMetadataCache')
-export class MemberMetadataCacheEntity {
-  @PrimaryGeneratedColumn('uuid')
-  @Field(() => ID)
-  id!: string;
-
-  @Column('text', { name: 'member_id' })
-  @Field()
-  memberId!: string;
-
-  @Column('jsonb')
-  metadata!: MemberMetadata;
-
-  @Column('timestamptz', { name: 'fetched_at' })
-  @Field()
-  fetchedAt!: Date;
-
-  @Column('timestamptz', { name: 'expires_at' })
-  @Field()
-  expiresAt!: Date;
-}

package/src/lib/identity/member-profile.object.ts

@@ -1,28 +0,0 @@
-import { Field, ID, ObjectType } from '@nestjs/graphql';
-import { MemberMetadata } from '@rytass/bpm-core-shared';
-
-@ObjectType('MemberProfile')
-export class MemberProfileObject {
-  @Field(() => ID)
-  memberId!: string;
-
-  @Field()
-  name!: string;
-
-  @Field()
-  email!: string;
-
-  @Field()
-  customFieldsJson!: string;
-}
-
-export function toMemberProfileObject(
-  metadata: MemberMetadata,
-): MemberProfileObject {
-  return {
-    customFieldsJson: JSON.stringify(metadata.customFields),
-    email: metadata.email,
-    memberId: metadata.memberId,
-    name: metadata.name,
-  };
-}

package/src/lib/migrations/0000000000001-enable-postgres-extensions.ts

@@ -1,14 +0,0 @@
-import { MigrationInterface, QueryRunner } from 'typeorm';
-
-export class EnablePostgresExtensions0000000000001 implements MigrationInterface {
-  readonly name = 'EnablePostgresExtensions0000000000001';
-
-  async up(queryRunner: QueryRunner): Promise<void> {
-    await queryRunner.query('CREATE EXTENSION IF NOT EXISTS "uuid-ossp"');
-    await queryRunner.query('CREATE EXTENSION IF NOT EXISTS "ltree"');
-  }
-
-  async down(queryRunner: QueryRunner): Promise<void> {
-    await queryRunner.query('DROP EXTENSION IF EXISTS "ltree"');
-  }
-}

package/src/lib/migrations/0000000011000-remove-attachment-encryption-key.ts

@@ -1,19 +0,0 @@
-import { MigrationInterface, QueryRunner } from 'typeorm';
-
-export class RemoveAttachmentEncryptionKey0000000011000 implements MigrationInterface {
-  name = 'RemoveAttachmentEncryptionKey0000000011000';
-
-  async up(queryRunner: QueryRunner): Promise<void> {
-    await queryRunner.query(`
-      ALTER TABLE "attachments"
-      DROP COLUMN IF EXISTS "encryption_key_id"
-    `);
-  }
-
-  async down(queryRunner: QueryRunner): Promise<void> {
-    await queryRunner.query(`
-      ALTER TABLE "attachments"
-      ADD COLUMN IF NOT EXISTS "encryption_key_id" text NULL
-    `);
-  }
-}

package/src/lib/migrations/0000000012000-notification-sla-idempotency.ts

@@ -1,22 +0,0 @@
-import { MigrationInterface, QueryRunner } from 'typeorm';
-
-export class NotificationSlaIdempotency0000000012000
-  implements MigrationInterface
-{
-  name = 'NotificationSlaIdempotency0000000012000';
-
-  async up(queryRunner: QueryRunner): Promise<void> {
-    await queryRunner.query(`
-      CREATE UNIQUE INDEX IF NOT EXISTS "UQ_notifications_sla_once"
-      ON "notifications" ("task_id", "recipient_member_id", "type", "channel")
-      WHERE "task_id" IS NOT NULL
-        AND "type" IN ('SLA_WARNING', 'SLA_OVERDUE')
-    `);
-  }
-
-  async down(queryRunner: QueryRunner): Promise<void> {
-    await queryRunner.query(
-      'DROP INDEX IF EXISTS "UQ_notifications_sla_once"',
-    );
-  }
-}

package/src/lib/migrations/0000000013000-workflow-query-indexes.ts

@@ -1,113 +0,0 @@
-import { MigrationInterface, QueryRunner } from 'typeorm';
-
-export class WorkflowQueryIndexes0000000013000 implements MigrationInterface {
-  readonly name = 'WorkflowQueryIndexes0000000013000';
-
-  async up(queryRunner: QueryRunner): Promise<void> {
-    await queryRunner.query('CREATE EXTENSION IF NOT EXISTS "pg_trgm"');
-
-    await queryRunner.query(`
-      CREATE INDEX IF NOT EXISTS "IDX_approval_instances_created_desc"
-      ON "approval_instances" ("created_at" DESC)
-    `);
-
-    await queryRunner.query(`
-      CREATE INDEX IF NOT EXISTS "IDX_approval_instances_state_created_desc"
-      ON "approval_instances" ("state", "created_at" DESC)
-    `);
-
-    await queryRunner.query(`
-      CREATE INDEX IF NOT EXISTS "IDX_approval_instances_template_created_desc"
-      ON "approval_instances" ("template_id", "created_at" DESC)
-    `);
-
-    await queryRunner.query(`
-      CREATE INDEX IF NOT EXISTS "IDX_approval_instances_initiator_created_desc"
-      ON "approval_instances" ("initiator_member_id", "created_at" DESC)
-    `);
-
-    await queryRunner.query(`
-      CREATE INDEX IF NOT EXISTS "IDX_approval_instances_title_trgm"
-      ON "approval_instances"
-      USING gin (lower("title") gin_trgm_ops)
-    `);
-
-    await queryRunner.query(`
-      CREATE INDEX IF NOT EXISTS "IDX_approval_instances_initiator_trgm"
-      ON "approval_instances"
-      USING gin (lower("initiator_member_id") gin_trgm_ops)
-    `);
-
-    await queryRunner.query(`
-      CREATE INDEX IF NOT EXISTS "IDX_tasks_instance_assignee_read"
-      ON "tasks" ("instance_id", "assignee_member_id")
-      WHERE "assignee_member_id" IS NOT NULL
-    `);
-
-    await queryRunner.query(`
-      CREATE INDEX IF NOT EXISTS "IDX_tasks_instance_original_assignee_read"
-      ON "tasks" ("instance_id", "original_assignee_member_id")
-      WHERE "original_assignee_member_id" IS NOT NULL
-    `);
-
-    await queryRunner.query(`
-      CREATE INDEX IF NOT EXISTS "IDX_task_candidates_member_task"
-      ON "task_candidates" ("member_id", "task_id")
-    `);
-
-    await queryRunner.query(`
-      CREATE INDEX IF NOT EXISTS "IDX_task_candidates_original_member_task"
-      ON "task_candidates" ("original_member_id", "task_id")
-    `);
-
-    await queryRunner.query(`
-      CREATE INDEX IF NOT EXISTS "IDX_task_decisions_decider_task"
-      ON "task_decisions" ("decided_by_member_id", "task_id")
-    `);
-
-    await queryRunner.query(`
-      CREATE INDEX IF NOT EXISTS "IDX_notifications_recipient_instance"
-      ON "notifications" ("recipient_member_id", "instance_id")
-      WHERE "instance_id" IS NOT NULL
-    `);
-  }
-
-  async down(queryRunner: QueryRunner): Promise<void> {
-    await queryRunner.query(
-      'DROP INDEX IF EXISTS "IDX_notifications_recipient_instance"',
-    );
-    await queryRunner.query(
-      'DROP INDEX IF EXISTS "IDX_task_decisions_decider_task"',
-    );
-    await queryRunner.query(
-      'DROP INDEX IF EXISTS "IDX_task_candidates_original_member_task"',
-    );
-    await queryRunner.query(
-      'DROP INDEX IF EXISTS "IDX_task_candidates_member_task"',
-    );
-    await queryRunner.query(
-      'DROP INDEX IF EXISTS "IDX_tasks_instance_original_assignee_read"',
-    );
-    await queryRunner.query(
-      'DROP INDEX IF EXISTS "IDX_tasks_instance_assignee_read"',
-    );
-    await queryRunner.query(
-      'DROP INDEX IF EXISTS "IDX_approval_instances_initiator_trgm"',
-    );
-    await queryRunner.query(
-      'DROP INDEX IF EXISTS "IDX_approval_instances_title_trgm"',
-    );
-    await queryRunner.query(
-      'DROP INDEX IF EXISTS "IDX_approval_instances_initiator_created_desc"',
-    );
-    await queryRunner.query(
-      'DROP INDEX IF EXISTS "IDX_approval_instances_template_created_desc"',
-    );
-    await queryRunner.query(
-      'DROP INDEX IF EXISTS "IDX_approval_instances_state_created_desc"',
-    );
-    await queryRunner.query(
-      'DROP INDEX IF EXISTS "IDX_approval_instances_created_desc"',
-    );
-  }
-}

package/src/lib/migrations/index.ts

@@ -1,47 +0,0 @@
-import { MigrationInterface } from 'typeorm';
-import { EnablePostgresExtensions0000000000001 } from './0000000000001-enable-postgres-extensions';
-import { IdentityOrganizationFoundation0000000001000 } from './0000000001000-identity-organization-foundation';
-import { FormBuilderFoundation0000000002000 } from './0000000002000-form-builder-foundation';
-import { ApprovalTemplateFoundation0000000003000 } from './0000000003000-approval-template-foundation';
-import { WorkflowEngineFoundation0000000004000 } from './0000000004000-workflow-engine-foundation';
-import { DelegationRules0000000005000 } from './0000000005000-delegation-rules';
-import { NotificationsSla0000000006000 } from './0000000006000-notifications-sla';
-import { SignaturesAttachments0000000007000 } from './0000000007000-signatures-attachments';
-import { ApprovalTemplateCategories0000000008000 } from './0000000008000-approval-template-categories';
-import { TaskCandidates0000000009000 } from './0000000009000-task-candidates';
-import { NotificationDeliveryState0000000010000 } from './0000000010000-notification-delivery-state';
-import { RemoveAttachmentEncryptionKey0000000011000 } from './0000000011000-remove-attachment-encryption-key';
-import { NotificationSlaIdempotency0000000012000 } from './0000000012000-notification-sla-idempotency';
-import { WorkflowQueryIndexes0000000013000 } from './0000000013000-workflow-query-indexes';
-
-export const BPM_CORE_MIGRATIONS: readonly (new () => MigrationInterface)[] = [
-  EnablePostgresExtensions0000000000001,
-  IdentityOrganizationFoundation0000000001000,
-  FormBuilderFoundation0000000002000,
-  ApprovalTemplateFoundation0000000003000,
-  WorkflowEngineFoundation0000000004000,
-  DelegationRules0000000005000,
-  NotificationsSla0000000006000,
-  SignaturesAttachments0000000007000,
-  ApprovalTemplateCategories0000000008000,
-  TaskCandidates0000000009000,
-  NotificationDeliveryState0000000010000,
-  RemoveAttachmentEncryptionKey0000000011000,
-  NotificationSlaIdempotency0000000012000,
-  WorkflowQueryIndexes0000000013000,
-];
-
-export * from './0000000000001-enable-postgres-extensions';
-export * from './0000000001000-identity-organization-foundation';
-export * from './0000000002000-form-builder-foundation';
-export * from './0000000003000-approval-template-foundation';
-export * from './0000000004000-workflow-engine-foundation';
-export * from './0000000005000-delegation-rules';
-export * from './0000000006000-notifications-sla';
-export * from './0000000007000-signatures-attachments';
-export * from './0000000008000-approval-template-categories';
-export * from './0000000009000-task-candidates';
-export * from './0000000010000-notification-delivery-state';
-export * from './0000000011000-remove-attachment-encryption-key';
-export * from './0000000012000-notification-sla-idempotency';
-export * from './0000000013000-workflow-query-indexes';

package/src/lib/notification/dto/notification-preference.input.ts

@@ -1,46 +0,0 @@
-import { Field, InputType } from '@nestjs/graphql';
-import {
-  IsBoolean,
-  IsIn,
-  IsOptional,
-  IsString,
-  Matches,
-} from 'class-validator';
-import { NotificationDigestModeEnum } from '../notification.enums';
-
-const TIME_ONLY_PATTERN = /^([01]\d|2[0-3]):[0-5]\d(?::[0-5]\d)?$/;
-
-@InputType()
-export class UpdateNotificationPreferenceInput {
-  @Field()
-  @IsString()
-  memberId!: string;
-
-  @Field()
-  @IsBoolean()
-  inAppEnabled!: boolean;
-
-  @Field()
-  @IsBoolean()
-  emailEnabled!: boolean;
-
-  @Field(() => NotificationDigestModeEnum)
-  @IsIn(Object.values(NotificationDigestModeEnum))
-  emailDigestMode!: NotificationDigestModeEnum;
-
-  @Field(() => String, { nullable: true })
-  @IsOptional()
-  @IsString()
-  @Matches(TIME_ONLY_PATTERN, {
-    message: 'quietHoursStart must use HH:mm or HH:mm:ss format',
-  })
-  quietHoursStart!: string | null;
-
-  @Field(() => String, { nullable: true })
-  @IsOptional()
-  @IsString()
-  @Matches(TIME_ONLY_PATTERN, {
-    message: 'quietHoursEnd must use HH:mm or HH:mm:ss format',
-  })
-  quietHoursEnd!: string | null;
-}

package/src/lib/notification/notification-delivery-scheduler.service.ts

@@ -1,69 +0,0 @@
-import {
-  Inject,
-  Injectable,
-  Logger,
-  OnApplicationBootstrap,
-  OnApplicationShutdown,
-  Optional,
-} from '@nestjs/common';
-import { NotificationDeliveryService } from './notification-delivery.service';
-import {
-  BPM_NOTIFICATION_OPTIONS,
-  BPMResolvedNotificationOptions,
-  DEFAULT_BPM_NOTIFICATION_OPTIONS,
-} from './notification-options';
-
-@Injectable()
-export class NotificationDeliverySchedulerService
-  implements OnApplicationBootstrap, OnApplicationShutdown
-{
-  private readonly logger = new Logger(
-    NotificationDeliverySchedulerService.name,
-  );
-  private timer: NodeJS.Timeout | null = null;
-
-  constructor(
-    private readonly deliveryService: NotificationDeliveryService,
-    @Optional()
-    @Inject(BPM_NOTIFICATION_OPTIONS)
-    private readonly notificationOptions: BPMResolvedNotificationOptions = DEFAULT_BPM_NOTIFICATION_OPTIONS,
-  ) {}
-
-  onApplicationBootstrap(): void {
-    if (
-      process.env.NODE_ENV === 'test' ||
-      !this.notificationOptions.deliverySchedulerEnabled
-    ) {
-      return;
-    }
-
-    this.timer = setInterval((): void => {
-      void this.scanPendingDeliveries();
-    }, this.notificationOptions.deliveryScanIntervalMs);
-    this.timer.unref();
-  }
-
-  onApplicationShutdown(): void {
-    if (this.timer) {
-      clearInterval(this.timer);
-      this.timer = null;
-    }
-  }
-
-  private async scanPendingDeliveries(): Promise<void> {
-    try {
-      const deliveredCount =
-        await this.deliveryService.deliverPendingNotifications({
-          options: this.notificationOptions,
-        });
-
-      if (deliveredCount) {
-        this.logger.log(`Delivered ${deliveredCount} pending notifications`);
-      }
-    } catch (error: unknown) {
-      this.logger.error(
-        error instanceof Error ? error.message : 'Delivery scan failed',
-      );
-    }
-  }
-}