Class: FormSchemaWithVersion
Defined in: server/forms/models.ts:192
Extends
Extended by
Constructors
Constructor
new FormSchemaWithVersion(input: {
schema: {
allowUserEditing: boolean;
createdAt: Date;
createdBy: string | null;
currentVersionId: string | null;
deletedAt: Date | null;
deletedBy: string | null;
id: string;
isActive: boolean;
name: string;
organizationId: string | null;
renderMode: string;
type: string;
updatedAt: Date;
updatedBy: string | null;
};
version: {
changeReason: string | null;
createdAt: Date;
createdBy: string | null;
deletedAt: Date | null;
deletedBy: string | null;
entryStepKey: string | null;
formSchemaId: string;
id: string;
publishedAt: Date | null;
schema: JsonValue;
versionNumber: number;
};
}): FormSchemaWithVersion;Defined in: server/forms/models.ts:195
Parameters
| Parameter | Type | Description |
|---|---|---|
input | { schema: { allowUserEditing: boolean; createdAt: Date; createdBy: string | null; currentVersionId: string | null; deletedAt: Date | null; deletedBy: string | null; id: string; isActive: boolean; name: string; organizationId: string | null; renderMode: string; type: string; updatedAt: Date; updatedBy: string | null; }; version: { changeReason: string | null; createdAt: Date; createdBy: string | null; deletedAt: Date | null; deletedBy: string | null; entryStepKey: string | null; formSchemaId: string; id: string; publishedAt: Date | null; schema: JsonValue; versionNumber: number; }; } | - |
input.schema | { allowUserEditing: boolean; createdAt: Date; createdBy: string | null; currentVersionId: string | null; deletedAt: Date | null; deletedBy: string | null; id: string; isActive: boolean; name: string; organizationId: string | null; renderMode: string; type: string; updatedAt: Date; updatedBy: string | null; } | - |
input.schema.allowUserEditing | boolean | - |
input.schema.createdAt | Date | - |
input.schema.createdBy | string | null | - |
input.schema.currentVersionId | string | null | - |
input.schema.deletedAt | Date | null | - |
input.schema.deletedBy | string | null | - |
input.schema.id | string | - |
input.schema.isActive | boolean | - |
input.schema.name | string | - |
input.schema.organizationId | string | null | - |
input.schema.renderMode | string | - |
input.schema.type | string | - |
input.schema.updatedAt | Date | - |
input.schema.updatedBy | string | null | - |
input.version | { changeReason: string | null; createdAt: Date; createdBy: string | null; deletedAt: Date | null; deletedBy: string | null; entryStepKey: string | null; formSchemaId: string; id: string; publishedAt: Date | null; schema: JsonValue; versionNumber: number; } | - |
input.version.changeReason | string | null | - |
input.version.createdAt | Date | - |
input.version.createdBy | string | null | - |
input.version.deletedAt | Date | null | - |
input.version.deletedBy | string | null | - |
input.version.entryStepKey | string | null | - |
input.version.formSchemaId | string | - |
input.version.id | string | - |
input.version.publishedAt | Date | null | - |
input.version.schema | JsonValue | Legacy single-page schema content. Null for multi-step versions — those render from the form_steps table instead. |
input.version.versionNumber | number | - |
Returns
FormSchemaWithVersion
Overrides
Properties
record
readonly record: {
allowUserEditing: boolean;
createdAt: Date;
createdBy: string | null;
currentVersionId: string | null;
deletedAt: Date | null;
deletedBy: string | null;
id: string;
isActive: boolean;
name: string;
organizationId: string | null;
renderMode: string;
type: string;
updatedAt: Date;
updatedBy: string | null;
};Defined in: server/forms/models.ts:13
allowUserEditing
allowUserEditing: boolean;createdAt
createdAt: Date;createdBy
createdBy: string | null;currentVersionId
currentVersionId: string | null;deletedAt
deletedAt: Date | null;deletedBy
deletedBy: string | null;id
id: string;isActive
isActive: boolean;name
name: string;organizationId
organizationId: string | null;renderMode
renderMode: string;type
type: string;updatedAt
updatedAt: Date;updatedBy
updatedBy: string | null;Inherited from
version
readonly version: FormSchemaVersion;Defined in: server/forms/models.ts:193
Accessors
allowUserEditing
Get Signature
get allowUserEditing(): boolean;Defined in: server/forms/models.ts:35
Returns
boolean
Inherited from
createdAt
Get Signature
get createdAt(): Date;Defined in: server/forms/models.ts:43
Returns
Date
Inherited from
createdBy
Get Signature
get createdBy(): string | null;Defined in: server/forms/models.ts:51
Returns
string | null
Inherited from
currentVersion
Get Signature
get currentVersion(): FormSchemaVersion;Defined in: server/forms/models.ts:200
Returns
currentVersionId
Get Signature
get currentVersionId(): string | null;Defined in: server/forms/models.ts:39
Returns
string | null
Inherited from
formSchema
Get Signature
get formSchema(): {
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?: 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;
format?: string;
label: string;
maxDate?: string;
maxFiles?: number;
maxLength?: number;
minDate?: string;
name: string;
options?: (
| string
| {
description?: ... | ...;
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";
}[];
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";
}[];
};Defined in: server/forms/models.ts:204
Returns
{
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?: 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;
format?: string;
label: string;
maxDate?: string;
maxFiles?: number;
maxLength?: number;
minDate?: string;
name: string;
options?: (
| string
| {
description?: ... | ...;
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";
}[];
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";
}[];
}fields
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?: 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;
format?: string;
label: string;
maxDate?: string;
maxFiles?: number;
maxLength?: number;
minDate?: string;
name: string;
options?: (
| string
| {
description?: ... | ...;
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";
}[];
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";
}[];hasCurrentVersion
Get Signature
get hasCurrentVersion(): boolean;Defined in: server/forms/models.ts:63
Returns
boolean
Inherited from
id
Get Signature
get id(): string;Defined in: server/forms/models.ts:19
Returns
string
Inherited from
isActive
Get Signature
get isActive(): boolean;Defined in: server/forms/models.ts:31
Returns
boolean
Inherited from
isDeleted
Get Signature
get isDeleted(): boolean;Defined in: server/forms/models.ts:59
Returns
boolean
Inherited from
name
Get Signature
get name(): string;Defined in: server/forms/models.ts:27
Returns
string
Inherited from
type
Get Signature
get type(): string;Defined in: server/forms/models.ts:23
Returns
string
Inherited from
updatedAt
Get Signature
get updatedAt(): Date;Defined in: server/forms/models.ts:47
Returns
Date
Inherited from
updatedBy
Get Signature
get updatedBy(): string | null;Defined in: server/forms/models.ts:55
Returns
string | null
Inherited from
versionNumber
Get Signature
get versionNumber(): number;Defined in: server/forms/models.ts:208
Returns
number
Methods
toJSON()
toJSON(): {
allowUserEditing: boolean;
createdAt: Date;
createdBy: string | null;
currentVersionId: string | null;
id: string;
isActive: boolean;
isDeleted: boolean;
name: string;
type: string;
updatedAt: Date;
updatedBy: string | null;
version: {
changeReason: string | null;
createdAt: Date;
createdBy: string | null;
entryStepKey: string | null;
formSchemaId: string;
id: string;
isPublished: boolean;
schema: | {
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?: ...[];
asset?: {
alt?: ...;
fileId?: ...;
filename?: ...;
mimeType?: ...;
url?: ...;
};
dataSource?: string;
defaultValue?: | string
| {
from: ...;
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?: ... | ...;
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";
}[];
}
| null;
versionNumber: number;
};
};Defined in: server/forms/models.ts:212
Returns
{
allowUserEditing: boolean;
createdAt: Date;
createdBy: string | null;
currentVersionId: string | null;
id: string;
isActive: boolean;
isDeleted: boolean;
name: string;
type: string;
updatedAt: Date;
updatedBy: string | null;
version: {
changeReason: string | null;
createdAt: Date;
createdBy: string | null;
entryStepKey: string | null;
formSchemaId: string;
id: string;
isPublished: boolean;
schema: | {
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?: ...[];
asset?: {
alt?: ...;
fileId?: ...;
filename?: ...;
mimeType?: ...;
url?: ...;
};
dataSource?: string;
defaultValue?: | string
| {
from: ...;
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?: ... | ...;
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";
}[];
}
| null;
versionNumber: number;
};
}allowUserEditing
allowUserEditing: boolean;createdAt
createdAt: Date;createdBy
createdBy: string | null;currentVersionId
currentVersionId: string | null;id
id: string;isActive
isActive: boolean;isDeleted
isDeleted: boolean;name
name: string;type
type: string;updatedAt
updatedAt: Date;updatedBy
updatedBy: string | null;version
version: {
changeReason: string | null;
createdAt: Date;
createdBy: string | null;
entryStepKey: string | null;
formSchemaId: string;
id: string;
isPublished: boolean;
schema: | {
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?: ...[];
asset?: {
alt?: ...;
fileId?: ...;
filename?: ...;
mimeType?: ...;
url?: ...;
};
dataSource?: string;
defaultValue?: | string
| {
from: ...;
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?: ... | ...;
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";
}[];
}
| null;
versionNumber: number;
};version.changeReason
changeReason: string | null;version.createdAt
createdAt: Date;version.createdBy
createdBy: string | null;version.entryStepKey
entryStepKey: string | null;version.formSchemaId
formSchemaId: string;version.id
id: string;version.isPublished
isPublished: boolean;version.schema
schema:
| {
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?: ...[];
asset?: {
alt?: ...;
fileId?: ...;
filename?: ...;
mimeType?: ...;
url?: ...;
};
dataSource?: string;
defaultValue?: | string
| {
from: ...;
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?: ... | ...;
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";
}[];
}
| null;version.versionNumber
versionNumber: number;Overrides
toRaw()
toRaw(): {
allowUserEditing: boolean;
createdAt: Date;
createdBy: string | null;
currentVersionId: string | null;
deletedAt: Date | null;
deletedBy: string | null;
id: string;
isActive: boolean;
name: string;
organizationId: string | null;
renderMode: string;
type: string;
updatedAt: Date;
updatedBy: string | null;
};Defined in: server/forms/models.ts:67
Returns
{
allowUserEditing: boolean;
createdAt: Date;
createdBy: string | null;
currentVersionId: string | null;
deletedAt: Date | null;
deletedBy: string | null;
id: string;
isActive: boolean;
name: string;
organizationId: string | null;
renderMode: string;
type: string;
updatedAt: Date;
updatedBy: string | null;
}allowUserEditing
allowUserEditing: boolean;createdAt
createdAt: Date;createdBy
createdBy: string | null;currentVersionId
currentVersionId: string | null;deletedAt
deletedAt: Date | null;deletedBy
deletedBy: string | null;id
id: string;isActive
isActive: boolean;name
name: string;organizationId
organizationId: string | null;renderMode
renderMode: string;type
type: string;updatedAt
updatedAt: Date;updatedBy
updatedBy: string | null;