Class: FormStepRepository

Defined in: server/forms/form-step-repository.ts:25

Repository with full CRUD capabilities. Extend this for most repositories that need create, read, update, and delete.

Extends

CrudRepository<PrismaClient, FormSteps, CreateInput, UpdateInput, string, Tx<PrismaClient>>

Constructors

Constructor

new FormStepRepository(prismaClient: PrismaClientLike<Tx<PrismaClient<PrismaClientOptions, never, DefaultArgs>>> & PrismaClient<PrismaClientOptions, never, DefaultArgs>, options?: RepositoryOptions): FormStepRepository;

Defined in: server/persistence/base-repository.ts:68

Parameters

Parameter	Type
`prismaClient`	`PrismaClientLike`<`Tx`<`PrismaClient`<`PrismaClientOptions`, `never`, `DefaultArgs`>>> & `PrismaClient`<`PrismaClientOptions`, `never`, `DefaultArgs`>
`options`	`RepositoryOptions`

Properties

ENTITY_TYPE?

protected readonly optional ENTITY_TYPE?: string;

Defined in: server/persistence/base-repository.ts:61

Set ENTITY_TYPE in child repositories to enable automatic activity logging. When set, create/update/delete operations auto-log unless silenced with .silent. Requires an activity model on the consumer's Prisma schema.

Inherited from

CrudRepository.ENTITY_TYPE

logger?

protected readonly optional logger?: Logger;

Defined in: server/persistence/base-repository.ts:64

Inherited from

CrudRepository.logger

prismaClient

protected prismaClient: PrismaClientLike<Tx<PrismaClient<PrismaClientOptions, never, DefaultArgs>>> & PrismaClient<PrismaClientOptions, never, DefaultArgs>;

Defined in: server/persistence/base-repository.ts:69

Inherited from

CrudRepository.prismaClient

Accessors

actorId

Get Signature

get protected actorId(): string | null | undefined;

Defined in: server/persistence/base-repository.ts:76

Returns

string | null | undefined

Inherited from

CrudRepository.actorId

auditCreate

Get Signature

get protected auditCreate(): {
  createdBy: string | null | undefined;
  updatedBy: string | null | undefined;
};

Defined in: server/persistence/base-repository.ts:90

Returns

{
  createdBy: string | null | undefined;
  updatedBy: string | null | undefined;
}

createdBy

createdBy: string | null | undefined = actorId;

updatedBy

updatedBy: string | null | undefined = actorId;

Inherited from

CrudRepository.auditCreate

auditDelete

Get Signature

get protected auditDelete(): {
  deletedAt: Date;
  deletedBy: string | null | undefined;
};

Defined in: server/persistence/base-repository.ts:99

Returns

{
  deletedAt: Date;
  deletedBy: string | null | undefined;
}

deletedAt

deletedAt: Date;

deletedBy

deletedBy: string | null | undefined;

Inherited from

CrudRepository.auditDelete

auditUpdate

Get Signature

get protected auditUpdate(): {
  updatedBy: string | null | undefined;
};

Defined in: server/persistence/base-repository.ts:95

Returns

{
  updatedBy: string | null | undefined;
}

updatedBy

updatedBy: string | null | undefined;

Inherited from

CrudRepository.auditUpdate

silent

Get Signature

get silent(): this;

Defined in: server/persistence/base-repository.ts:115

Suppress activity logging for the next mutation call. One-shot: the flag is consumed by the next create/update/delete.

Example

await repo.silent.update(id, data);   // no activity logged
await repo.update(id, data);          // activity logged normally

Returns

this

Inherited from

CrudRepository.silent

tx

Get Signature

get protected tx(): TTx;

Defined in: server/persistence/base-repository.ts:86

The current Prisma handle: the active transaction if one is running on this async context, otherwise the raw client.

Returns

TTx

Inherited from

CrudRepository.tx

Methods

_count()

protected _count(): Promise<number>;

Defined in: server/forms/form-step-repository.ts:50

Returns

Promise<number>

Overrides

CrudRepository._count

_create()

protected _create(input: CreateInput): Promise<{
  createdAt: Date;
  createdBy: string | null;
  deletedAt: Date | null;
  deletedBy: string | null;
  description: string | null;
  fields: JsonValue;
  formSchemaVersionId: string;
  id: string;
  key: string;
  label: string | null;
  updatedAt: Date;
  updatedBy: string | null;
}>;

Defined in: server/forms/form-step-repository.ts:71

Parameters

Parameter	Type
`input`	`CreateInput`

Returns

Promise<{ createdAt: Date; createdBy: string | null; deletedAt: Date | null; deletedBy: string | null; description: string | null; fields: JsonValue; formSchemaVersionId: string; id: string; key: string; label: string | null; updatedAt: Date; updatedBy: string | null; }>

Overrides

CrudRepository._create

_exists()

protected _exists(id: string): Promise<boolean>;

Defined in: server/forms/form-step-repository.ts:43

Parameters

Parameter	Type
`id`	`string`

Returns

Promise<boolean>

Overrides

CrudRepository._exists

_findById()

protected _findById(id: string): Promise<
  | {
  createdAt: Date;
  createdBy: string | null;
  deletedAt: Date | null;
  deletedBy: string | null;
  description: string | null;
  fields: JsonValue;
  formSchemaVersionId: string;
  id: string;
  key: string;
  label: string | null;
  updatedAt: Date;
  updatedBy: string | null;
}
| null>;

Defined in: server/forms/form-step-repository.ts:37

Parameters

Parameter	Type
`id`	`string`

Returns

Promise< | { createdAt: Date; createdBy: string | null; deletedAt: Date | null; deletedBy: string | null; description: string | null; fields: JsonValue; formSchemaVersionId: string; id: string; key: string; label: string | null; updatedAt: Date; updatedBy: string | null; } | null>

Overrides

CrudRepository._findById

_findMany()

protected _findMany(pagination: {
  page: number;
  pageSize: number;
}): Promise<{
  items: {
     createdAt: Date;
     createdBy: string | null;
     deletedAt: Date | null;
     deletedBy: string | null;
     description: string | null;
     fields: JsonValue;
     formSchemaVersionId: string;
     id: string;
     key: string;
     label: string | null;
     updatedAt: Date;
     updatedBy: string | null;
  }[];
  total: number;
}>;

Defined in: server/forms/form-step-repository.ts:54

Parameters

Parameter	Type
`pagination`	{ `page`: `number`; `pageSize`: `number`; }
`pagination.page`	`number`
`pagination.pageSize`	`number`

Returns

Promise<{ items: { createdAt: Date; createdBy: string | null; deletedAt: Date | null; deletedBy: string | null; description: string | null; fields: JsonValue; formSchemaVersionId: string; id: string; key: string; label: string | null; updatedAt: Date; updatedBy: string | null; }[]; total: number; }>

Overrides

CrudRepository._findMany

_hardDelete()

protected _hardDelete(id: string): Promise<{
  createdAt: Date;
  createdBy: string | null;
  deletedAt: Date | null;
  deletedBy: string | null;
  description: string | null;
  fields: JsonValue;
  formSchemaVersionId: string;
  id: string;
  key: string;
  label: string | null;
  updatedAt: Date;
  updatedBy: string | null;
}>;

Defined in: server/forms/form-step-repository.ts:98

Parameters

Parameter	Type
`id`	`string`

Returns

Overrides

CrudRepository._hardDelete

_softDelete()

protected _softDelete(id: string): Promise<{
  createdAt: Date;
  createdBy: string | null;
  deletedAt: Date | null;
  deletedBy: string | null;
  description: string | null;
  fields: JsonValue;
  formSchemaVersionId: string;
  id: string;
  key: string;
  label: string | null;
  updatedAt: Date;
  updatedBy: string | null;
}>;

Defined in: server/forms/form-step-repository.ts:91

Parameters

Parameter	Type
`id`	`string`

Returns

Overrides

CrudRepository._softDelete

_update()

protected _update(id: string, patch: UpdateInput): Promise<{
  createdAt: Date;
  createdBy: string | null;
  deletedAt: Date | null;
  deletedBy: string | null;
  description: string | null;
  fields: JsonValue;
  formSchemaVersionId: string;
  id: string;
  key: string;
  label: string | null;
  updatedAt: Date;
  updatedBy: string | null;
}>;

Defined in: server/forms/form-step-repository.ts:80

Parameters

Parameter	Type
`id`	`string`
`patch`	`UpdateInput`

Returns

Overrides

CrudRepository._update

afterCreate()

protected afterCreate(entity: {
  createdAt: Date;
  createdBy: string | null;
  deletedAt: Date | null;
  deletedBy: string | null;
  description: string | null;
  fields: JsonValue;
  formSchemaVersionId: string;
  id: string;
  key: string;
  label: string | null;
  updatedAt: Date;
  updatedBy: string | null;
}, _input: CreateInput): Promise<void>;

Defined in: server/persistence/base-repository.ts:316

Parameters

Parameter	Type
`entity`	{ `createdAt`: `Date`; `createdBy`: `string` \| `null`; `deletedAt`: `Date` \| `null`; `deletedBy`: `string` \| `null`; `description`: `string` \| `null`; `fields`: `JsonValue`; `formSchemaVersionId`: `string`; `id`: `string`; `key`: `string`; `label`: `string` \| `null`; `updatedAt`: `Date`; `updatedBy`: `string` \| `null`; }
`entity.createdAt`	`Date`
`entity.createdBy`	`string` \| `null`
`entity.deletedAt`	`Date` \| `null`
`entity.deletedBy`	`string` \| `null`
`entity.description`	`string` \| `null`
`entity.fields`	`JsonValue`
`entity.formSchemaVersionId`	`string`
`entity.id`	`string`
`entity.key`	`string`
`entity.label`	`string` \| `null`
`entity.updatedAt`	`Date`
`entity.updatedBy`	`string` \| `null`
`_input`	`CreateInput`

Returns

Promise<void>

Inherited from

CrudRepository.afterCreate

afterDelete()

protected afterDelete(_entity: {
  createdAt: Date;
  createdBy: string | null;
  deletedAt: Date | null;
  deletedBy: string | null;
  description: string | null;
  fields: JsonValue;
  formSchemaVersionId: string;
  id: string;
  key: string;
  label: string | null;
  updatedAt: Date;
  updatedBy: string | null;
}, id: string): Promise<void>;

Defined in: server/persistence/base-repository.ts:390

Parameters

Parameter	Type
`_entity`	{ `createdAt`: `Date`; `createdBy`: `string` \| `null`; `deletedAt`: `Date` \| `null`; `deletedBy`: `string` \| `null`; `description`: `string` \| `null`; `fields`: `JsonValue`; `formSchemaVersionId`: `string`; `id`: `string`; `key`: `string`; `label`: `string` \| `null`; `updatedAt`: `Date`; `updatedBy`: `string` \| `null`; }
`_entity.createdAt`	`Date`
`_entity.createdBy`	`string` \| `null`
`_entity.deletedAt`	`Date` \| `null`
`_entity.deletedBy`	`string` \| `null`
`_entity.description`	`string` \| `null`
`_entity.fields`	`JsonValue`
`_entity.formSchemaVersionId`	`string`
`_entity.id`	`string`
`_entity.key`	`string`
`_entity.label`	`string` \| `null`
`_entity.updatedAt`	`Date`
`_entity.updatedBy`	`string` \| `null`
`id`	`string`

Returns

Promise<void>

Inherited from

CrudRepository.afterDelete

afterUpdate()

protected afterUpdate(
   _entity: {
  createdAt: Date;
  createdBy: string | null;
  deletedAt: Date | null;
  deletedBy: string | null;
  description: string | null;
  fields: JsonValue;
  formSchemaVersionId: string;
  id: string;
  key: string;
  label: string | null;
  updatedAt: Date;
  updatedBy: string | null;
}, 
   id: string, 
   input: Partial<Pick<{
  createdAt: Date;
  createdBy: string | null;
  deletedAt: Date | null;
  deletedBy: string | null;
  description: string | null;
  fields: JsonValue;
  formSchemaVersionId: string;
  id: string;
  key: string;
  label: string | null;
  updatedAt: Date;
  updatedBy: string | null;
}, "description" | "updatedBy" | "label"> & {
  fields: {
     additionalInfo?: {
        body?: string;
        title?: string;
     };
     adoptionStatement?: string;
     allowedFonts?: string[];
     asset?: {
        alt?: string;
        fileId?: string;
        filename?: string;
        mimeType?: string;
        url?: string;
     };
     dataSource?: string;
     defaultValue?:   | string
        | {
        from: string;
        to: string | null;
      };
     description?: string;
     fields?: {
        additionalInfo?: {
           body?: ... | ...;
           title?: ... | ...;
        };
        adoptionStatement?: string;
        allowedFonts?: string[];
        asset?: {
           alt?: ... | ...;
           fileId?: ... | ...;
           filename?: ... | ...;
           mimeType?: ... | ...;
           url?: ... | ...;
        };
        dataSource?: string;
        defaultValue?:   | string
           | {
           from: string;
           to: ... | ...;
         };
        description?: string;
        format?: string;
        label: string;
        maxDate?: string;
        maxFiles?: number;
        maxLength?: number;
        minDate?: string;
        name: string;
        options?: (... | ...)[];
        placeholder?: string;
        prefillFrom?: string;
        required: boolean;
        showRange?: boolean;
        showTime?: boolean;
        signatureMode?: "typed" | "drawn";
        timezone?: string;
        type:   | "number"
           | "date"
           | "file"
           | "email"
           | "url"
           | "select"
           | "text"
           | "checkbox"
           | "textarea"
           | "phone"
           | "radio-group"
           | "multiselect"
           | "field-array"
           | "image"
           | "file-download"
           | "section-header"
           | "section-unset"
           | "signature"
           | "signature-adopted";
     }[];
     format?: string;
     label: string;
     maxDate?: string;
     maxFiles?: number;
     maxLength?: number;
     maxRows?: number;
     minDate?: string;
     minRows?: number;
     name: string;
     options?: (
        | string
        | {
        description?: string;
        value: string;
     })[];
     placeholder?: string;
     prefillFrom?: string;
     required: boolean;
     showRange?: boolean;
     showTime?: boolean;
     signatureMode?: "typed" | "drawn";
     timezone?: string;
     type:   | "number"
        | "date"
        | "file"
        | "email"
        | "url"
        | "select"
        | "text"
        | "checkbox"
        | "textarea"
        | "phone"
        | "radio-group"
        | "multiselect"
        | "field-array"
        | "image"
        | "file-download"
        | "section-header"
        | "section-unset"
        | "signature"
        | "signature-adopted";
  }[];
}>
): Promise<void>;

Defined in: server/persistence/base-repository.ts:328

Parameters

Parameter	Type
`_entity`	{ `createdAt`: `Date`; `createdBy`: `string` \| `null`; `deletedAt`: `Date` \| `null`; `deletedBy`: `string` \| `null`; `description`: `string` \| `null`; `fields`: `JsonValue`; `formSchemaVersionId`: `string`; `id`: `string`; `key`: `string`; `label`: `string` \| `null`; `updatedAt`: `Date`; `updatedBy`: `string` \| `null`; }
`_entity.createdAt`	`Date`
`_entity.createdBy`	`string` \| `null`
`_entity.deletedAt`	`Date` \| `null`
`_entity.deletedBy`	`string` \| `null`
`_entity.description`	`string` \| `null`
`_entity.fields`	`JsonValue`
`_entity.formSchemaVersionId`	`string`
`_entity.id`	`string`
`_entity.key`	`string`
`_entity.label`	`string` \| `null`
`_entity.updatedAt`	`Date`
`_entity.updatedBy`	`string` \| `null`
`id`	`string`
`input`	`Partial`<`Pick`<{ `createdAt`: `Date`; `createdBy`: `string` \| `null`; `deletedAt`: `Date` \| `null`; `deletedBy`: `string` \| `null`; `description`: `string` \| `null`; `fields`: `JsonValue`; `formSchemaVersionId`: `string`; `id`: `string`; `key`: `string`; `label`: `string` \| `null`; `updatedAt`: `Date`; `updatedBy`: `string` \| `null`; }, `"description"` \| `"updatedBy"` \| `"label"`> & { `fields`: { `additionalInfo?`: { `body?`: `string`; `title?`: `string`; }; `adoptionStatement?`: `string`; `allowedFonts?`: `string`[]; `asset?`: { `alt?`: `string`; `fileId?`: `string`; `filename?`: `string`; `mimeType?`: `string`; `url?`: `string`; }; `dataSource?`: `string`; `defaultValue?`: \| `string` \| { `from`: `string`; `to`: `string` \| `null`; }; `description?`: `string`; `fields?`: { `additionalInfo?`: { `body?`: ... \| ...; `title?`: ... \| ...; }; `adoptionStatement?`: `string`; `allowedFonts?`: `string`[]; `asset?`: { `alt?`: ... \| ...; `fileId?`: ... \| ...; `filename?`: ... \| ...; `mimeType?`: ... \| ...; `url?`: ... \| ...; }; `dataSource?`: `string`; `defaultValue?`: \| `string` \| { `from`: `string`; `to`: ... \| ...; }; `description?`: `string`; `format?`: `string`; `label`: `string`; `maxDate?`: `string`; `maxFiles?`: `number`; `maxLength?`: `number`; `minDate?`: `string`; `name`: `string`; `options?`: (... \| ...)[]; `placeholder?`: `string`; `prefillFrom?`: `string`; `required`: `boolean`; `showRange?`: `boolean`; `showTime?`: `boolean`; `signatureMode?`: `"typed"` \| `"drawn"`; `timezone?`: `string`; `type`: \| `"number"` \| `"date"` \| `"file"` \| `"email"` \| `"url"` \| `"select"` \| `"text"` \| `"checkbox"` \| `"textarea"` \| `"phone"` \| `"radio-group"` \| `"multiselect"` \| `"field-array"` \| `"image"` \| `"file-download"` \| `"section-header"` \| `"section-unset"` \| `"signature"` \| `"signature-adopted"`; }[]; `format?`: `string`; `label`: `string`; `maxDate?`: `string`; `maxFiles?`: `number`; `maxLength?`: `number`; `maxRows?`: `number`; `minDate?`: `string`; `minRows?`: `number`; `name`: `string`; `options?`: ( \| `string` \| { `description?`: `string`; `value`: `string`; })[]; `placeholder?`: `string`; `prefillFrom?`: `string`; `required`: `boolean`; `showRange?`: `boolean`; `showTime?`: `boolean`; `signatureMode?`: `"typed"` \| `"drawn"`; `timezone?`: `string`; `type`: \| `"number"` \| `"date"` \| `"file"` \| `"email"` \| `"url"` \| `"select"` \| `"text"` \| `"checkbox"` \| `"textarea"` \| `"phone"` \| `"radio-group"` \| `"multiselect"` \| `"field-array"` \| `"image"` \| `"file-download"` \| `"section-header"` \| `"section-unset"` \| `"signature"` \| `"signature-adopted"`; }[]; }>

Returns

Promise<void>

Inherited from

CrudRepository.afterUpdate

beforeCreate()

protected beforeCreate(_input: CreateInput): Promise<void>;

Defined in: server/persistence/base-repository.ts:315

Parameters

Parameter	Type
`_input`	`CreateInput`

Returns

Promise<void>

Inherited from

CrudRepository.beforeCreate

beforeDelete()

protected beforeDelete(_id: string, _existing: {
  createdAt: Date;
  createdBy: string | null;
  deletedAt: Date | null;
  deletedBy: string | null;
  description: string | null;
  fields: JsonValue;
  formSchemaVersionId: string;
  id: string;
  key: string;
  label: string | null;
  updatedAt: Date;
  updatedBy: string | null;
}): Promise<void>;

Defined in: server/persistence/base-repository.ts:388

Parameters

Parameter	Type
`_id`	`string`
`_existing`	{ `createdAt`: `Date`; `createdBy`: `string` \| `null`; `deletedAt`: `Date` \| `null`; `deletedBy`: `string` \| `null`; `description`: `string` \| `null`; `fields`: `JsonValue`; `formSchemaVersionId`: `string`; `id`: `string`; `key`: `string`; `label`: `string` \| `null`; `updatedAt`: `Date`; `updatedBy`: `string` \| `null`; }
`_existing.createdAt`	`Date`
`_existing.createdBy`	`string` \| `null`
`_existing.deletedAt`	`Date` \| `null`
`_existing.deletedBy`	`string` \| `null`
`_existing.description`	`string` \| `null`
`_existing.fields`	`JsonValue`
`_existing.formSchemaVersionId`	`string`
`_existing.id`	`string`
`_existing.key`	`string`
`_existing.label`	`string` \| `null`
`_existing.updatedAt`	`Date`
`_existing.updatedBy`	`string` \| `null`

Returns

Promise<void>

Inherited from

CrudRepository.beforeDelete

beforeUpdate()

protected beforeUpdate(
   _id: string, 
   _input: Partial<Pick<{
  createdAt: Date;
  createdBy: string | null;
  deletedAt: Date | null;
  deletedBy: string | null;
  description: string | null;
  fields: JsonValue;
  formSchemaVersionId: string;
  id: string;
  key: string;
  label: string | null;
  updatedAt: Date;
  updatedBy: string | null;
}, "description" | "updatedBy" | "label"> & {
  fields: {
     additionalInfo?: {
        body?: string;
        title?: string;
     };
     adoptionStatement?: string;
     allowedFonts?: string[];
     asset?: {
        alt?: string;
        fileId?: string;
        filename?: string;
        mimeType?: string;
        url?: string;
     };
     dataSource?: string;
     defaultValue?:   | string
        | {
        from: string;
        to: string | null;
      };
     description?: string;
     fields?: {
        additionalInfo?: {
           body?: ... | ...;
           title?: ... | ...;
        };
        adoptionStatement?: string;
        allowedFonts?: string[];
        asset?: {
           alt?: ... | ...;
           fileId?: ... | ...;
           filename?: ... | ...;
           mimeType?: ... | ...;
           url?: ... | ...;
        };
        dataSource?: string;
        defaultValue?:   | string
           | {
           from: string;
           to: ... | ...;
         };
        description?: string;
        format?: string;
        label: string;
        maxDate?: string;
        maxFiles?: number;
        maxLength?: number;
        minDate?: string;
        name: string;
        options?: (... | ...)[];
        placeholder?: string;
        prefillFrom?: string;
        required: boolean;
        showRange?: boolean;
        showTime?: boolean;
        signatureMode?: "typed" | "drawn";
        timezone?: string;
        type:   | "number"
           | "date"
           | "file"
           | "email"
           | "url"
           | "select"
           | "text"
           | "checkbox"
           | "textarea"
           | "phone"
           | "radio-group"
           | "multiselect"
           | "field-array"
           | "image"
           | "file-download"
           | "section-header"
           | "section-unset"
           | "signature"
           | "signature-adopted";
     }[];
     format?: string;
     label: string;
     maxDate?: string;
     maxFiles?: number;
     maxLength?: number;
     maxRows?: number;
     minDate?: string;
     minRows?: number;
     name: string;
     options?: (
        | string
        | {
        description?: string;
        value: string;
     })[];
     placeholder?: string;
     prefillFrom?: string;
     required: boolean;
     showRange?: boolean;
     showTime?: boolean;
     signatureMode?: "typed" | "drawn";
     timezone?: string;
     type:   | "number"
        | "date"
        | "file"
        | "email"
        | "url"
        | "select"
        | "text"
        | "checkbox"
        | "textarea"
        | "phone"
        | "radio-group"
        | "multiselect"
        | "field-array"
        | "image"
        | "file-download"
        | "section-header"
        | "section-unset"
        | "signature"
        | "signature-adopted";
  }[];
}>, 
   _existing: {
  createdAt: Date;
  createdBy: string | null;
  deletedAt: Date | null;
  deletedBy: string | null;
  description: string | null;
  fields: JsonValue;
  formSchemaVersionId: string;
  id: string;
  key: string;
  label: string | null;
  updatedAt: Date;
  updatedBy: string | null;
}
): Promise<void>;

Defined in: server/persistence/base-repository.ts:323

Parameters

Parameter	Type
`_id`	`string`
`_input`	`Partial`<`Pick`<{ `createdAt`: `Date`; `createdBy`: `string` \| `null`; `deletedAt`: `Date` \| `null`; `deletedBy`: `string` \| `null`; `description`: `string` \| `null`; `fields`: `JsonValue`; `formSchemaVersionId`: `string`; `id`: `string`; `key`: `string`; `label`: `string` \| `null`; `updatedAt`: `Date`; `updatedBy`: `string` \| `null`; }, `"description"` \| `"updatedBy"` \| `"label"`> & { `fields`: { `additionalInfo?`: { `body?`: `string`; `title?`: `string`; }; `adoptionStatement?`: `string`; `allowedFonts?`: `string`[]; `asset?`: { `alt?`: `string`; `fileId?`: `string`; `filename?`: `string`; `mimeType?`: `string`; `url?`: `string`; }; `dataSource?`: `string`; `defaultValue?`: \| `string` \| { `from`: `string`; `to`: `string` \| `null`; }; `description?`: `string`; `fields?`: { `additionalInfo?`: { `body?`: ... \| ...; `title?`: ... \| ...; }; `adoptionStatement?`: `string`; `allowedFonts?`: `string`[]; `asset?`: { `alt?`: ... \| ...; `fileId?`: ... \| ...; `filename?`: ... \| ...; `mimeType?`: ... \| ...; `url?`: ... \| ...; }; `dataSource?`: `string`; `defaultValue?`: \| `string` \| { `from`: `string`; `to`: ... \| ...; }; `description?`: `string`; `format?`: `string`; `label`: `string`; `maxDate?`: `string`; `maxFiles?`: `number`; `maxLength?`: `number`; `minDate?`: `string`; `name`: `string`; `options?`: (... \| ...)[]; `placeholder?`: `string`; `prefillFrom?`: `string`; `required`: `boolean`; `showRange?`: `boolean`; `showTime?`: `boolean`; `signatureMode?`: `"typed"` \| `"drawn"`; `timezone?`: `string`; `type`: \| `"number"` \| `"date"` \| `"file"` \| `"email"` \| `"url"` \| `"select"` \| `"text"` \| `"checkbox"` \| `"textarea"` \| `"phone"` \| `"radio-group"` \| `"multiselect"` \| `"field-array"` \| `"image"` \| `"file-download"` \| `"section-header"` \| `"section-unset"` \| `"signature"` \| `"signature-adopted"`; }[]; `format?`: `string`; `label`: `string`; `maxDate?`: `string`; `maxFiles?`: `number`; `maxLength?`: `number`; `maxRows?`: `number`; `minDate?`: `string`; `minRows?`: `number`; `name`: `string`; `options?`: ( \| `string` \| { `description?`: `string`; `value`: `string`; })[]; `placeholder?`: `string`; `prefillFrom?`: `string`; `required`: `boolean`; `showRange?`: `boolean`; `showTime?`: `boolean`; `signatureMode?`: `"typed"` \| `"drawn"`; `timezone?`: `string`; `type`: \| `"number"` \| `"date"` \| `"file"` \| `"email"` \| `"url"` \| `"select"` \| `"text"` \| `"checkbox"` \| `"textarea"` \| `"phone"` \| `"radio-group"` \| `"multiselect"` \| `"field-array"` \| `"image"` \| `"file-download"` \| `"section-header"` \| `"section-unset"` \| `"signature"` \| `"signature-adopted"`; }[]; }>
`_existing`	{ `createdAt`: `Date`; `createdBy`: `string` \| `null`; `deletedAt`: `Date` \| `null`; `deletedBy`: `string` \| `null`; `description`: `string` \| `null`; `fields`: `JsonValue`; `formSchemaVersionId`: `string`; `id`: `string`; `key`: `string`; `label`: `string` \| `null`; `updatedAt`: `Date`; `updatedBy`: `string` \| `null`; }
`_existing.createdAt`	`Date`
`_existing.createdBy`	`string` \| `null`
`_existing.deletedAt`	`Date` \| `null`
`_existing.deletedBy`	`string` \| `null`
`_existing.description`	`string` \| `null`
`_existing.fields`	`JsonValue`
`_existing.formSchemaVersionId`	`string`
`_existing.id`	`string`
`_existing.key`	`string`
`_existing.label`	`string` \| `null`
`_existing.updatedAt`	`Date`
`_existing.updatedBy`	`string` \| `null`

Returns

Promise<void>

Inherited from

CrudRepository.beforeUpdate

consumeSilent()

protected consumeSilent(): boolean;

Defined in: server/persistence/base-repository.ts:128

Consume and reset the silent flag. Called by template methods.

Returns

boolean

Inherited from

CrudRepository.consumeSilent

count()

count(): Promise<number>;

Defined in: server/persistence/base-repository.ts:191

Returns

Promise<number>

Inherited from

CrudRepository.count

create()

create(input: CreateInput): Promise<{
  createdAt: Date;
  createdBy: string | null;
  deletedAt: Date | null;
  deletedBy: string | null;
  description: string | null;
  fields: JsonValue;
  formSchemaVersionId: string;
  id: string;
  key: string;
  label: string | null;
  updatedAt: Date;
  updatedBy: string | null;
}>;

Defined in: server/persistence/base-repository.ts:292

Parameters

Parameter	Type
`input`	`CreateInput`

Returns

Inherited from

CrudRepository.create

exists()

exists(id: string): Promise<boolean>;

Defined in: server/persistence/base-repository.ts:187

Parameters

Parameter	Type
`id`	`string`

Returns

Promise<boolean>

Inherited from

CrudRepository.exists

findById()

findById(id: string): Promise<
  | {
  createdAt: Date;
  createdBy: string | null;
  deletedAt: Date | null;
  deletedBy: string | null;
  description: string | null;
  fields: JsonValue;
  formSchemaVersionId: string;
  id: string;
  key: string;
  label: string | null;
  updatedAt: Date;
  updatedBy: string | null;
}
| null>;

Defined in: server/persistence/base-repository.ts:177

Parameters

Parameter	Type
`id`	`string`

Returns

Inherited from

CrudRepository.findById

findByIdOrThrow()

findByIdOrThrow(id: string): Promise<{
  createdAt: Date;
  createdBy: string | null;
  deletedAt: Date | null;
  deletedBy: string | null;
  description: string | null;
  fields: JsonValue;
  formSchemaVersionId: string;
  id: string;
  key: string;
  label: string | null;
  updatedAt: Date;
  updatedBy: string | null;
}>;

Defined in: server/persistence/base-repository.ts:181

Parameters

Parameter	Type
`id`	`string`

Returns

Inherited from

CrudRepository.findByIdOrThrow

findByVersionId()

findByVersionId(formSchemaVersionId: string): Promise<{
  createdAt: Date;
  createdBy: string | null;
  deletedAt: Date | null;
  deletedBy: string | null;
  description: string | null;
  fields: JsonValue;
  formSchemaVersionId: string;
  id: string;
  key: string;
  label: string | null;
  updatedAt: Date;
  updatedBy: string | null;
}[]>;

Defined in: server/forms/form-step-repository.ts:104

Parameters

Parameter	Type
`formSchemaVersionId`	`string`

Returns

findByVersionIdAndKey()

findByVersionIdAndKey(formSchemaVersionId: string, key: string): Promise<
  | {
  createdAt: Date;
  createdBy: string | null;
  deletedAt: Date | null;
  deletedBy: string | null;
  description: string | null;
  fields: JsonValue;
  formSchemaVersionId: string;
  id: string;
  key: string;
  label: string | null;
  updatedAt: Date;
  updatedBy: string | null;
}
| null>;

Defined in: server/forms/form-step-repository.ts:111

Parameters

Parameter	Type
`formSchemaVersionId`	`string`
`key`	`string`

Returns

findMany()

findMany(pagination: {
  page: number;
  pageSize: number;
}): Promise<OffsetPaginatedResult<{
  createdAt: Date;
  createdBy: string | null;
  deletedAt: Date | null;
  deletedBy: string | null;
  description: string | null;
  fields: JsonValue;
  formSchemaVersionId: string;
  id: string;
  key: string;
  label: string | null;
  updatedAt: Date;
  updatedBy: string | null;
}>>;

Defined in: server/persistence/base-repository.ts:195

Parameters

Parameter	Type
`pagination`	{ `page`: `number`; `pageSize`: `number`; }
`pagination.page`	`number`
`pagination.pageSize`	`number`

Returns

Promise<OffsetPaginatedResult<{ createdAt: Date; createdBy: string | null; deletedAt: Date | null; deletedBy: string | null; description: string | null; fields: JsonValue; formSchemaVersionId: string; id: string; key: string; label: string | null; updatedAt: Date; updatedBy: string | null; }>>

Inherited from

CrudRepository.findMany

hardDelete()

hardDelete(id: string): Promise<{
  createdAt: Date;
  createdBy: string | null;
  deletedAt: Date | null;
  deletedBy: string | null;
  description: string | null;
  fields: JsonValue;
  formSchemaVersionId: string;
  id: string;
  key: string;
  label: string | null;
  updatedAt: Date;
  updatedBy: string | null;
}>;

Defined in: server/persistence/base-repository.ts:377

Parameters

Parameter	Type
`id`	`string`

Returns

Inherited from

CrudRepository.hardDelete

logActivity()

protected logActivity(
   _entityId: string, 
   _action: string, 
   _metadata?: Record<string, unknown>
): Promise<void>;

Defined in: server/persistence/base-repository.ts:140

Log an activity entry.

NOTE: This is not implemented because there's no activity model implemented in taproot yet! https://linear.app/kaizenlabs/issue/ENG-7846/add-activity-log-tables

Parameters

Parameter	Type
`_entityId`	`string`
`_action`	`string`
`_metadata?`	`Record`<`string`, `unknown`>

Returns

Promise<void>

Inherited from

CrudRepository.logActivity

notFoundError()

protected notFoundError(id: string): Error;

Defined in: server/forms/form-step-repository.ts:33

Create a not-found error. Override to provide custom error types.

Parameters

Parameter	Type
`id`	`string`

Returns

Error

Overrides

CrudRepository.notFoundError

softDelete()

softDelete(id: string): Promise<{
  createdAt: Date;
  createdBy: string | null;
  deletedAt: Date | null;
  deletedBy: string | null;
  description: string | null;
  fields: JsonValue;
  formSchemaVersionId: string;
  id: string;
  key: string;
  label: string | null;
  updatedAt: Date;
  updatedBy: string | null;
}>;

Defined in: server/persistence/base-repository.ts:366

Parameters

Parameter	Type
`id`	`string`

Returns

Inherited from

CrudRepository.softDelete

update()

update(id: string, input: Partial<Pick<{
  createdAt: Date;
  createdBy: string | null;
  deletedAt: Date | null;
  deletedBy: string | null;
  description: string | null;
  fields: JsonValue;
  formSchemaVersionId: string;
  id: string;
  key: string;
  label: string | null;
  updatedAt: Date;
  updatedBy: string | null;
}, "description" | "updatedBy" | "label"> & {
  fields: {
     additionalInfo?: {
        body?: string;
        title?: string;
     };
     adoptionStatement?: string;
     allowedFonts?: string[];
     asset?: {
        alt?: string;
        fileId?: string;
        filename?: string;
        mimeType?: string;
        url?: string;
     };
     dataSource?: string;
     defaultValue?:   | string
        | {
        from: string;
        to: string | null;
      };
     description?: string;
     fields?: {
        additionalInfo?: {
           body?: ... | ...;
           title?: ... | ...;
        };
        adoptionStatement?: string;
        allowedFonts?: string[];
        asset?: {
           alt?: ... | ...;
           fileId?: ... | ...;
           filename?: ... | ...;
           mimeType?: ... | ...;
           url?: ... | ...;
        };
        dataSource?: string;
        defaultValue?:   | string
           | {
           from: string;
           to: ... | ...;
         };
        description?: string;
        format?: string;
        label: string;
        maxDate?: string;
        maxFiles?: number;
        maxLength?: number;
        minDate?: string;
        name: string;
        options?: (... | ...)[];
        placeholder?: string;
        prefillFrom?: string;
        required: boolean;
        showRange?: boolean;
        showTime?: boolean;
        signatureMode?: "typed" | "drawn";
        timezone?: string;
        type:   | "number"
           | "date"
           | "file"
           | "email"
           | "url"
           | "select"
           | "text"
           | "checkbox"
           | "textarea"
           | "phone"
           | "radio-group"
           | "multiselect"
           | "field-array"
           | "image"
           | "file-download"
           | "section-header"
           | "section-unset"
           | "signature"
           | "signature-adopted";
     }[];
     format?: string;
     label: string;
     maxDate?: string;
     maxFiles?: number;
     maxLength?: number;
     maxRows?: number;
     minDate?: string;
     minRows?: number;
     name: string;
     options?: (
        | string
        | {
        description?: string;
        value: string;
     })[];
     placeholder?: string;
     prefillFrom?: string;
     required: boolean;
     showRange?: boolean;
     showTime?: boolean;
     signatureMode?: "typed" | "drawn";
     timezone?: string;
     type:   | "number"
        | "date"
        | "file"
        | "email"
        | "url"
        | "select"
        | "text"
        | "checkbox"
        | "textarea"
        | "phone"
        | "radio-group"
        | "multiselect"
        | "field-array"
        | "image"
        | "file-download"
        | "section-header"
        | "section-unset"
        | "signature"
        | "signature-adopted";
  }[];
}>): Promise<{
  createdAt: Date;
  createdBy: string | null;
  deletedAt: Date | null;
  deletedBy: string | null;
  description: string | null;
  fields: JsonValue;
  formSchemaVersionId: string;
  id: string;
  key: string;
  label: string | null;
  updatedAt: Date;
  updatedBy: string | null;
}>;

Defined in: server/persistence/base-repository.ts:301

Parameters

Parameter Type

id string

input Partial<Pick<{ createdAt: Date; createdBy: string | null; deletedAt: Date | null; deletedBy: string | null; description: string | null; fields: JsonValue; formSchemaVersionId: string; id: string; key: string; label: string | null; updatedAt: Date; updatedBy: string | null; }, "description" | "updatedBy" | "label"> & { fields: { additionalInfo?: { body?: string; title?: string; }; adoptionStatement?: string; allowedFonts?: string[]; asset?: { alt?: string; fileId?: string; filename?: string; mimeType?: string; url?: string; }; dataSource?: string; defaultValue?: | string | { from: string; to: string | null; }; description?: string; fields?: { additionalInfo?: { body?: ... | ...; title?: ... | ...; }; adoptionStatement?: string; allowedFonts?: string[]; asset?: { alt?: ... | ...; fileId?: ... | ...; filename?: ... | ...; mimeType?: ... | ...; url?: ... | ...; }; dataSource?: string; defaultValue?: | string | { from: string; to: ... | ...; }; description?: string; format?: string; label: string; maxDate?: string; maxFiles?: number; maxLength?: number; minDate?: string; name: string; options?: (... | ...)[]; placeholder?: string; prefillFrom?: string; required: boolean; showRange?: boolean; showTime?: boolean; signatureMode?: "typed" | "drawn"; timezone?: string; type: | "number" | "date" | "file" | "email" | "url" | "select" | "text" | "checkbox" | "textarea" | "phone" | "radio-group" | "multiselect" | "field-array" | "image" | "file-download" | "section-header" | "section-unset" | "signature" | "signature-adopted"; }[]; format?: string; label: string; maxDate?: string; maxFiles?: number; maxLength?: number; maxRows?: number; minDate?: string; minRows?: number; name: string; options?: ( | string | { description?: string; value: string; })[]; placeholder?: string; prefillFrom?: string; required: boolean; showRange?: boolean; showTime?: boolean; signatureMode?: "typed" | "drawn"; timezone?: string; type: | "number" | "date" | "file" | "email" | "url" | "select" | "text" | "checkbox" | "textarea" | "phone" | "radio-group" | "multiselect" | "field-array" | "image" | "file-download" | "section-header" | "section-unset" | "signature" | "signature-adopted"; }[]; }>

Returns

Inherited from

CrudRepository.update

Class: FormStepRepository

ExtendsCopy Anchor Link

ConstructorsCopy Anchor Link

ConstructorCopy Anchor Link

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

Inherited fromCopy Anchor Link

PropertiesCopy Anchor Link

ENTITY_TYPE?Copy Anchor Link

Inherited fromCopy Anchor Link

logger?Copy Anchor Link

Inherited fromCopy Anchor Link

prismaClientCopy Anchor Link

Inherited fromCopy Anchor Link

AccessorsCopy Anchor Link

actorIdCopy Anchor Link

Get SignatureCopy Anchor Link

ReturnsCopy Anchor Link

Inherited fromCopy Anchor Link

auditCreateCopy Anchor Link

Get SignatureCopy Anchor Link

ReturnsCopy Anchor Link

createdByCopy Anchor Link

updatedByCopy Anchor Link

Inherited fromCopy Anchor Link

auditDeleteCopy Anchor Link

Get SignatureCopy Anchor Link

ReturnsCopy Anchor Link

deletedAtCopy Anchor Link

deletedByCopy Anchor Link

Inherited fromCopy Anchor Link

auditUpdateCopy Anchor Link

Get SignatureCopy Anchor Link

ReturnsCopy Anchor Link

updatedByCopy Anchor Link

Inherited fromCopy Anchor Link

silentCopy Anchor Link

Get SignatureCopy Anchor Link

ExampleCopy Anchor Link

ReturnsCopy Anchor Link

Inherited fromCopy Anchor Link

txCopy Anchor Link

Get SignatureCopy Anchor Link

ReturnsCopy Anchor Link

Inherited fromCopy Anchor Link

MethodsCopy Anchor Link

_count()Copy Anchor Link

ReturnsCopy Anchor Link

OverridesCopy Anchor Link

_create()Copy Anchor Link

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

OverridesCopy Anchor Link

_exists()Copy Anchor Link

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

OverridesCopy Anchor Link

_findById()Copy Anchor Link

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

OverridesCopy Anchor Link

_findMany()Copy Anchor Link

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

OverridesCopy Anchor Link

_hardDelete()Copy Anchor Link

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

OverridesCopy Anchor Link

_softDelete()Copy Anchor Link

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

OverridesCopy Anchor Link

_update()Copy Anchor Link

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

OverridesCopy Anchor Link

afterCreate()Copy Anchor Link

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

Extends

Constructors

Constructor

Parameters

Returns

Inherited from

Properties

ENTITY_TYPE?

Inherited from

logger?

Inherited from

prismaClient

Inherited from

Accessors

actorId

Get Signature

Returns

Inherited from

auditCreate

Get Signature

Returns

createdBy

updatedBy

Inherited from

auditDelete

Get Signature

Returns

deletedAt

deletedBy

Inherited from

auditUpdate

Get Signature

Returns

updatedBy

Inherited from

silent

Get Signature

Example

Returns

Inherited from

tx

Get Signature

Returns

Inherited from

Methods

_count()

Returns

Overrides

_create()

Parameters

Returns

Overrides

_exists()

Parameters

Returns

Overrides

_findById()

Parameters

Returns

Overrides

_findMany()

Parameters

Returns

Overrides

_hardDelete()

Parameters

Returns

Overrides

_softDelete()

Parameters

Returns

Overrides

_update()

Parameters

Returns

Overrides

afterCreate()

Parameters

Returns

Inherited from