@stndrds/schema 1.0.0-alpha.166 → 1.0.0-alpha.169
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/filters-DRXk4dLI.d.mts +1575 -0
- package/dist/filters-zzsF0GxK.d.ts +1575 -0
- package/dist/helpers-64gmAyw0.d.ts +61 -0
- package/dist/helpers-DOjqrfWE.d.mts +61 -0
- package/dist/index.d.mts +33 -101
- package/dist/index.d.ts +33 -101
- package/dist/index.js +118 -50
- package/dist/index.mjs +109 -52
- package/dist/{types-CUbVw7X2.d.ts → types-Bemfgle3.d.ts} +1 -1
- package/dist/{types-DT8dfR2I.d.mts → types-DxEobsMy.d.mts} +1 -1
- package/dist/validation/all.d.mts +3 -3
- package/dist/validation/all.d.ts +3 -3
- package/dist/validation/all.js +4 -0
- package/dist/validation/all.mjs +1 -1
- package/dist/validation/complex/currency.d.mts +2 -2
- package/dist/validation/complex/currency.d.ts +2 -2
- package/dist/validation/complex/file.d.mts +2 -2
- package/dist/validation/complex/file.d.ts +2 -2
- package/dist/validation/complex/location.d.mts +2 -2
- package/dist/validation/complex/location.d.ts +2 -2
- package/dist/validation/complex/phone.d.mts +2 -2
- package/dist/validation/complex/phone.d.ts +2 -2
- package/dist/validation/complex/relation.d.mts +2 -2
- package/dist/validation/complex/relation.d.ts +2 -2
- package/dist/validation/complex/richtext.d.mts +2 -2
- package/dist/validation/complex/richtext.d.ts +2 -2
- package/dist/validation/complex/select.d.mts +2 -2
- package/dist/validation/complex/select.d.ts +2 -2
- package/dist/validation/complex/user.d.mts +2 -2
- package/dist/validation/complex/user.d.ts +2 -2
- package/dist/validation/computed/formula.d.mts +2 -2
- package/dist/validation/computed/formula.d.ts +2 -2
- package/dist/validation/computed/rollup.d.mts +2 -2
- package/dist/validation/computed/rollup.d.ts +2 -2
- package/dist/validation/config/index.d.mts +1 -1
- package/dist/validation/config/index.d.ts +1 -1
- package/dist/validation/core/index.d.mts +3 -3
- package/dist/validation/core/index.d.ts +3 -3
- package/dist/validation/object/index.d.mts +3 -4
- package/dist/validation/object/index.d.ts +3 -4
- package/dist/validation/primitives/checkbox.d.mts +2 -2
- package/dist/validation/primitives/checkbox.d.ts +2 -2
- package/dist/validation/primitives/date.d.mts +2 -2
- package/dist/validation/primitives/date.d.ts +2 -2
- package/dist/validation/primitives/number.d.mts +2 -2
- package/dist/validation/primitives/number.d.ts +2 -2
- package/dist/validation/primitives/rating.d.mts +2 -2
- package/dist/validation/primitives/rating.d.ts +2 -2
- package/dist/validation/primitives/text.d.mts +2 -2
- package/dist/validation/primitives/text.d.ts +2 -2
- package/package.json +2 -2
- package/dist/attributes-CNpcbVbv.d.ts +0 -667
- package/dist/attributes-DcHM27jS.d.mts +0 -667
- package/dist/helpers-BDn1PUC2.d.mts +0 -860
- package/dist/helpers-oaW8DBAh.d.ts +0 -860
|
@@ -0,0 +1,61 @@
|
|
|
1
|
+
import { z } from 'zod';
|
|
2
|
+
import { A as Attribute, O as ObjectDefinition, j as CompletionStatus } from './filters-zzsF0GxK.js';
|
|
3
|
+
import { V as ValidationMessages, a as ValidationResult } from './types-Bemfgle3.js';
|
|
4
|
+
|
|
5
|
+
/**
|
|
6
|
+
* Create a Zod schema for any attribute type.
|
|
7
|
+
* Returns a strict validator that does NOT handle optional fields.
|
|
8
|
+
* Use createFormAttributeValidator for form validation with optional support.
|
|
9
|
+
*
|
|
10
|
+
* @param attr - The attribute to create a validator for
|
|
11
|
+
* @param messages - Custom validation messages for i18n support
|
|
12
|
+
*/
|
|
13
|
+
declare function createAttributeValidator(attr: Attribute, messages?: ValidationMessages): z.ZodTypeAny;
|
|
14
|
+
/**
|
|
15
|
+
* Create a Zod schema for form validation.
|
|
16
|
+
* - Normalizes empty values (empty strings, empty objects) to null for optional fields
|
|
17
|
+
* - Accepts custom messages for i18n support
|
|
18
|
+
*
|
|
19
|
+
* Use this in UI forms where optional fields may have null/undefined values.
|
|
20
|
+
*
|
|
21
|
+
* @param attr - The attribute to create a validator for
|
|
22
|
+
* @param messages - Custom validation messages for i18n support
|
|
23
|
+
*/
|
|
24
|
+
declare function createFormAttributeValidator(attr: Attribute, messages?: ValidationMessages): z.ZodTypeAny;
|
|
25
|
+
|
|
26
|
+
/**
|
|
27
|
+
* Validate data against an attribute schema
|
|
28
|
+
*/
|
|
29
|
+
declare function validateAttribute(attr: Attribute, value: unknown): ValidationResult;
|
|
30
|
+
/**
|
|
31
|
+
* Validate data against an object schema
|
|
32
|
+
*/
|
|
33
|
+
declare function validateObject(objectDef: ObjectDefinition, data: Record<string, unknown>): ValidationResult;
|
|
34
|
+
/**
|
|
35
|
+
* Validate and throw if invalid
|
|
36
|
+
*/
|
|
37
|
+
declare function validateObjectOrThrow(objectDef: ObjectDefinition, data: Record<string, unknown>): Record<string, unknown>;
|
|
38
|
+
/**
|
|
39
|
+
* Validate data in draft mode.
|
|
40
|
+
* - All attributes are treated as optional (no required validation)
|
|
41
|
+
* - Provided values are still validated for format/type correctness
|
|
42
|
+
*/
|
|
43
|
+
declare function validateDraft(objectDef: ObjectDefinition, data: Record<string, unknown>): ValidationResult;
|
|
44
|
+
/**
|
|
45
|
+
* Validate draft data and throw if format validation fails.
|
|
46
|
+
*/
|
|
47
|
+
declare function validateDraftOrThrow(objectDef: ObjectDefinition, data: Record<string, unknown>): Record<string, unknown>;
|
|
48
|
+
/**
|
|
49
|
+
* Get the list of required attributes that are missing values.
|
|
50
|
+
*/
|
|
51
|
+
declare function getMissingRequiredAttributes(objectDef: ObjectDefinition, data: Record<string, unknown>): Attribute[];
|
|
52
|
+
/**
|
|
53
|
+
* Check if a record is complete (all required attributes have valid values).
|
|
54
|
+
*/
|
|
55
|
+
declare function isRecordComplete(objectDef: ObjectDefinition, data: Record<string, unknown>): boolean;
|
|
56
|
+
/**
|
|
57
|
+
* Compute the completion status of a record based on its data.
|
|
58
|
+
*/
|
|
59
|
+
declare function computeRecordStatus(objectDef: ObjectDefinition, data: Record<string, unknown>): CompletionStatus;
|
|
60
|
+
|
|
61
|
+
export { createFormAttributeValidator as a, validateDraftOrThrow as b, computeRecordStatus as c, validateObject as d, validateObjectOrThrow as e, createAttributeValidator as f, getMissingRequiredAttributes as g, validateAttribute as h, isRecordComplete as i, validateDraft as v };
|
|
@@ -0,0 +1,61 @@
|
|
|
1
|
+
import { z } from 'zod';
|
|
2
|
+
import { A as Attribute, O as ObjectDefinition, j as CompletionStatus } from './filters-DRXk4dLI.mjs';
|
|
3
|
+
import { V as ValidationMessages, a as ValidationResult } from './types-DxEobsMy.mjs';
|
|
4
|
+
|
|
5
|
+
/**
|
|
6
|
+
* Create a Zod schema for any attribute type.
|
|
7
|
+
* Returns a strict validator that does NOT handle optional fields.
|
|
8
|
+
* Use createFormAttributeValidator for form validation with optional support.
|
|
9
|
+
*
|
|
10
|
+
* @param attr - The attribute to create a validator for
|
|
11
|
+
* @param messages - Custom validation messages for i18n support
|
|
12
|
+
*/
|
|
13
|
+
declare function createAttributeValidator(attr: Attribute, messages?: ValidationMessages): z.ZodTypeAny;
|
|
14
|
+
/**
|
|
15
|
+
* Create a Zod schema for form validation.
|
|
16
|
+
* - Normalizes empty values (empty strings, empty objects) to null for optional fields
|
|
17
|
+
* - Accepts custom messages for i18n support
|
|
18
|
+
*
|
|
19
|
+
* Use this in UI forms where optional fields may have null/undefined values.
|
|
20
|
+
*
|
|
21
|
+
* @param attr - The attribute to create a validator for
|
|
22
|
+
* @param messages - Custom validation messages for i18n support
|
|
23
|
+
*/
|
|
24
|
+
declare function createFormAttributeValidator(attr: Attribute, messages?: ValidationMessages): z.ZodTypeAny;
|
|
25
|
+
|
|
26
|
+
/**
|
|
27
|
+
* Validate data against an attribute schema
|
|
28
|
+
*/
|
|
29
|
+
declare function validateAttribute(attr: Attribute, value: unknown): ValidationResult;
|
|
30
|
+
/**
|
|
31
|
+
* Validate data against an object schema
|
|
32
|
+
*/
|
|
33
|
+
declare function validateObject(objectDef: ObjectDefinition, data: Record<string, unknown>): ValidationResult;
|
|
34
|
+
/**
|
|
35
|
+
* Validate and throw if invalid
|
|
36
|
+
*/
|
|
37
|
+
declare function validateObjectOrThrow(objectDef: ObjectDefinition, data: Record<string, unknown>): Record<string, unknown>;
|
|
38
|
+
/**
|
|
39
|
+
* Validate data in draft mode.
|
|
40
|
+
* - All attributes are treated as optional (no required validation)
|
|
41
|
+
* - Provided values are still validated for format/type correctness
|
|
42
|
+
*/
|
|
43
|
+
declare function validateDraft(objectDef: ObjectDefinition, data: Record<string, unknown>): ValidationResult;
|
|
44
|
+
/**
|
|
45
|
+
* Validate draft data and throw if format validation fails.
|
|
46
|
+
*/
|
|
47
|
+
declare function validateDraftOrThrow(objectDef: ObjectDefinition, data: Record<string, unknown>): Record<string, unknown>;
|
|
48
|
+
/**
|
|
49
|
+
* Get the list of required attributes that are missing values.
|
|
50
|
+
*/
|
|
51
|
+
declare function getMissingRequiredAttributes(objectDef: ObjectDefinition, data: Record<string, unknown>): Attribute[];
|
|
52
|
+
/**
|
|
53
|
+
* Check if a record is complete (all required attributes have valid values).
|
|
54
|
+
*/
|
|
55
|
+
declare function isRecordComplete(objectDef: ObjectDefinition, data: Record<string, unknown>): boolean;
|
|
56
|
+
/**
|
|
57
|
+
* Compute the completion status of a record based on its data.
|
|
58
|
+
*/
|
|
59
|
+
declare function computeRecordStatus(objectDef: ObjectDefinition, data: Record<string, unknown>): CompletionStatus;
|
|
60
|
+
|
|
61
|
+
export { createFormAttributeValidator as a, validateDraftOrThrow as b, computeRecordStatus as c, validateObject as d, validateObjectOrThrow as e, createAttributeValidator as f, getMissingRequiredAttributes as g, validateAttribute as h, isRecordComplete as i, validateDraft as v };
|
package/dist/index.d.mts
CHANGED
|
@@ -1,16 +1,15 @@
|
|
|
1
|
-
import {
|
|
2
|
-
export {
|
|
3
|
-
import { j as AttributeType, A as Attribute, k as LocationGranularity, l as Location, e as FormulaAttribute, f as RollupAttribute, d as StatusAttribute, c as SelectAttribute, b as MultiselectAttribute, m as Phone, n as Currency, D as DateAttribute, U as UserAttribute, o as DocumentAttribute, p as FeatureGate, g as CheckboxAttribute, C as CurrencyAttribute, F as FileAttribute, q as FormulaReturnType, L as LocationAttribute, O as Option, N as NumberAttribute, P as PhoneAttribute, h as RatingAttribute, R as RelationAttribute, i as TextAttribute, T as TextAreaAttribute, B as BilateralConfig, S as SingleRelationAttribute, M as MultiRelationAttribute, r as RelationTarget, a as RichtextAttribute, s as RichtextFeature, t as RollupFunction, u as FlagValueType, v as FeatureFlagDefinition, w as FlagLevel, x as FeatureFlagsRepository, y as StaticFlagDefault, z as ResolvedFlag } from './attributes-DcHM27jS.mjs';
|
|
4
|
-
export { E as AttributeGroup, G as BaseAttribute, H as DateFormat, I as DateValue, J as FeatureFlagsConfig, K as FlagOverride, Q as NumberUnit, V as OptionPropertyAttribute, W as PropertyAttribute, X as PropertySchema, Y as PropertyType, Z as RELATION_TARGET_ANY, _ as StatusGroup, $ as hasOptions, a0 as inferInverseCardinality, a1 as isAttributeSortable, a2 as isBilateralRelation, a3 as isUniversalRelation } from './attributes-DcHM27jS.mjs';
|
|
1
|
+
import { k as SortRule, l as FilterState, m as Timestamps, n as AttributeType, V as ViewType, o as ViewConfig, p as ConfigOverrides, j as CompletionStatus, A as Attribute, q as LocationGranularity, r as Location, e as FormulaAttribute, f as RollupAttribute, d as StatusAttribute, c as SelectAttribute, b as MultiselectAttribute, s as Phone, t as Currency, u as ObjectRecord, D as DateAttribute, U as UserAttribute, v as DocumentAttribute, w as DocumentSlotConfig, x as FeatureGate, g as CheckboxAttribute, C as CurrencyAttribute, F as FileAttribute, y as FormulaReturnType, L as LocationAttribute, z as Option, N as NumberAttribute, P as PhoneAttribute, h as RatingAttribute, R as RelationAttribute, i as TextAttribute, T as TextAreaAttribute, B as BilateralConfig, S as SingleRelationAttribute, M as MultiRelationAttribute, E as RelationTarget, a as RichtextAttribute, G as RichtextFeature, H as RollupFunction, I as MigrationDefinition, O as ObjectDefinition, J as DetailViewConfig, K as DetailViewDefinition, Q as DetailViewLayout, W as SidePanelConfig, X as Field, Y as AttributeGroupField, Z as FieldGroup, _ as RelationGroup, $ as Group, a0 as TableTab, a1 as CreateMode, a2 as Tab, a3 as ListViewConfig, a4 as ListViewDefinition, a5 as FlagValueType, a6 as FeatureFlagDefinition, a7 as FlagLevel, a8 as FeatureFlagsRepository, a9 as StaticFlagDefault, aa as ResolvedFlag, ab as ViewDefinition, ac as ListViewTab, ad as FilterOperator, ae as FilterValue } from './filters-DRXk4dLI.mjs';
|
|
2
|
+
export { af as ActivityTab, ag as AdvancedFilterState, ah as AttributeGroup, ai as BaseAttribute, aj as BuiltInTransform, ak as CreateDocument, al as CreateDocumentSlot, am as CreateProcessingJob, an as CurrencyFilterValue, ao as CustomTab, ap as DEFAULT_DOCUMENT_SLOT, aq as DateFormat, ar as DateValue, as as Document, at as DocumentListOptions, au as DocumentSlot, av as DocumentWithSlots, aw as DocumentsTab, ax as ExtendedFilterRule, ay as FeatureFlagsConfig, az as FilterCombinator, aA as FilterGroup, aB as FilterRule, aC as FlagOverride, aD as FormDensity, aE as FormTab, aF as FormsTab, aG as InverseSource, aH as ListViewLayout, aI as MigrationError, aJ as NO_VALUE_OPERATORS, aK as NoValueOperator, aL as NumberUnit, aM as OPERATORS_BY_TYPE, aN as ObjectAttribute, aO as OptionPropertyAttribute, aP as PhoneFilterValue, aQ as ProcessingJob, aR as ProcessingJobStatus, aS as ProcessingJobType, aT as PropertyAttribute, aU as PropertySchema, aV as PropertyType, aW as QueryState, aX as RELATION_TARGET_ANY, aY as RESERVED_ATTRIBUTE_NAMES, aZ as RecordDocuments, a_ as RelationSource, a$ as RelativeDateValue, b0 as ReservedAttributeName, b1 as RichtextTab, b2 as SYSTEM_FIELD_NAMES, b3 as SchemaOperation, b4 as SchemaTransform, b5 as SlotStatus, b6 as SortDirection, b7 as StatusGroup, b8 as SystemFieldName, b9 as TabType, ba as TableSource, bb as TransformSource, bc as UpdateDocument, bd as UpdateDocumentSlot, be as UpdateProcessingJob, bf as ViewOperation, bg as ViewOverlay, bh as ViewTransform, bi as getRollupFilterOperators, bj as hasOptions, bk as inferInverseCardinality, bl as isAttributeSortable, bm as isBilateralRelation, bn as isDetailView, bo as isFieldGroup, bp as isListView, bq as isNoValueOperator, br as isRelationGroup, bs as isUniversalRelation } from './filters-DRXk4dLI.mjs';
|
|
5
3
|
import { MimeType, IconName, ColorId, CountryIso3, CurrencyCode } from '@stndrds/constants';
|
|
6
4
|
import { Uuid, TenantId } from './utils.mjs';
|
|
7
5
|
export { UserId, asTenantId, asUserId, deepEqual, generateId, indexBy } from './utils.mjs';
|
|
8
6
|
import { StandardSchemaV1 } from '@standard-schema/spec';
|
|
9
7
|
export { StandardSchemaV1 } from '@standard-schema/spec';
|
|
10
8
|
import z from 'zod';
|
|
11
|
-
export { V as ValidationMessages } from './types-
|
|
9
|
+
export { V as ValidationMessages } from './types-DxEobsMy.mjs';
|
|
12
10
|
export { DEFAULT_VALIDATION_MESSAGES, formatZodErrors } from './validation/core/index.mjs';
|
|
13
11
|
export { parseAttributeConfig } from './validation/config/index.mjs';
|
|
12
|
+
export { c as computeRecordStatus, a as createFormAttributeValidator, v as validateDraft, b as validateDraftOrThrow, d as validateObject, e as validateObjectOrThrow } from './helpers-DOjqrfWE.mjs';
|
|
14
13
|
|
|
15
14
|
/**
|
|
16
15
|
* Generic list options for pagination and sorting
|
|
@@ -1824,93 +1823,6 @@ interface BuilderConfig {
|
|
|
1824
1823
|
label: string;
|
|
1825
1824
|
}
|
|
1826
1825
|
|
|
1827
|
-
interface Document extends Timestamps {
|
|
1828
|
-
id: Uuid;
|
|
1829
|
-
tenantId: Uuid;
|
|
1830
|
-
title: string;
|
|
1831
|
-
processingStatus: ProcessingStatus;
|
|
1832
|
-
contentHash?: string;
|
|
1833
|
-
searchVector?: unknown;
|
|
1834
|
-
createdBy?: Uuid;
|
|
1835
|
-
updatedBy?: Uuid;
|
|
1836
|
-
deletedAt?: Date | null;
|
|
1837
|
-
values: Record<string, unknown>;
|
|
1838
|
-
}
|
|
1839
|
-
/**
|
|
1840
|
-
* Technical processing lifecycle — never exposed in UI.
|
|
1841
|
-
* User-visible status belongs in document `values`.
|
|
1842
|
-
*/
|
|
1843
|
-
type ProcessingStatus = "draft" | "pending" | "processing" | "completed" | "failed";
|
|
1844
|
-
interface DocumentSlot extends Timestamps {
|
|
1845
|
-
id: Uuid;
|
|
1846
|
-
tenantId: Uuid;
|
|
1847
|
-
documentId: Uuid;
|
|
1848
|
-
slotName: string;
|
|
1849
|
-
isAdditional: boolean;
|
|
1850
|
-
fileId: Uuid;
|
|
1851
|
-
status: SlotStatus;
|
|
1852
|
-
ocrText?: string;
|
|
1853
|
-
ocrConfidence?: number;
|
|
1854
|
-
processedAt?: Date;
|
|
1855
|
-
}
|
|
1856
|
-
type SlotStatus = "uploaded" | "processing" | "completed" | "failed";
|
|
1857
|
-
interface ProcessingJob extends Timestamps {
|
|
1858
|
-
id: Uuid;
|
|
1859
|
-
tenantId: Uuid;
|
|
1860
|
-
documentId: Uuid;
|
|
1861
|
-
slotName?: string | null;
|
|
1862
|
-
type: ProcessingJobType;
|
|
1863
|
-
provider: string;
|
|
1864
|
-
status: ProcessingJobStatus;
|
|
1865
|
-
input?: Record<string, unknown>;
|
|
1866
|
-
result?: Record<string, unknown>;
|
|
1867
|
-
error?: string;
|
|
1868
|
-
startedAt?: Date | null;
|
|
1869
|
-
completedAt?: Date | null;
|
|
1870
|
-
createdBy?: Uuid;
|
|
1871
|
-
}
|
|
1872
|
-
type ProcessingJobType = "ocr";
|
|
1873
|
-
type ProcessingJobStatus = "pending" | "processing" | "completed" | "failed" | "cancelled";
|
|
1874
|
-
interface CreateDocument {
|
|
1875
|
-
title: string;
|
|
1876
|
-
values?: Record<string, unknown>;
|
|
1877
|
-
}
|
|
1878
|
-
interface UpdateDocument {
|
|
1879
|
-
title?: string;
|
|
1880
|
-
values?: Record<string, unknown>;
|
|
1881
|
-
processingStatus?: ProcessingStatus;
|
|
1882
|
-
}
|
|
1883
|
-
interface CreateDocumentSlot {
|
|
1884
|
-
documentId: Uuid;
|
|
1885
|
-
slotName: string;
|
|
1886
|
-
fileId: Uuid;
|
|
1887
|
-
isAdditional?: boolean;
|
|
1888
|
-
}
|
|
1889
|
-
interface UpdateDocumentSlot {
|
|
1890
|
-
status?: SlotStatus;
|
|
1891
|
-
ocrText?: string;
|
|
1892
|
-
ocrConfidence?: number;
|
|
1893
|
-
}
|
|
1894
|
-
interface CreateProcessingJob {
|
|
1895
|
-
documentId: Uuid;
|
|
1896
|
-
slotName?: string;
|
|
1897
|
-
type: ProcessingJobType;
|
|
1898
|
-
provider: string;
|
|
1899
|
-
input?: Record<string, unknown>;
|
|
1900
|
-
}
|
|
1901
|
-
interface UpdateProcessingJob {
|
|
1902
|
-
status?: ProcessingJobStatus;
|
|
1903
|
-
result?: Record<string, unknown>;
|
|
1904
|
-
error?: string;
|
|
1905
|
-
startedAt?: Date;
|
|
1906
|
-
completedAt?: Date;
|
|
1907
|
-
}
|
|
1908
|
-
interface DocumentListOptions {
|
|
1909
|
-
limit?: number;
|
|
1910
|
-
offset?: number;
|
|
1911
|
-
processingStatus?: ProcessingStatus;
|
|
1912
|
-
}
|
|
1913
|
-
|
|
1914
1826
|
/**
|
|
1915
1827
|
* Error codes for schema exceptions
|
|
1916
1828
|
*/
|
|
@@ -3215,6 +3127,29 @@ declare function isNotEmpty(obj: unknown): obj is Record<string, unknown>;
|
|
|
3215
3127
|
*/
|
|
3216
3128
|
declare function toUndefinedIfEmpty<T extends Record<string, unknown>>(obj: T | undefined | null): T | undefined;
|
|
3217
3129
|
|
|
3130
|
+
declare const DOCUMENT_SYSTEM_ATTRIBUTES: {
|
|
3131
|
+
readonly ATTACHMENTS: "attachments";
|
|
3132
|
+
};
|
|
3133
|
+
declare function isDocumentAttribute(attr: Attribute): attr is DocumentAttribute;
|
|
3134
|
+
declare function matchesMime(mime: string, accepted: string[] | undefined): boolean;
|
|
3135
|
+
/**
|
|
3136
|
+
* Returns the slots array for a DocumentAttribute, applying the default
|
|
3137
|
+
* when none is configured. Use everywhere the slots are read so the
|
|
3138
|
+
* default is consistent.
|
|
3139
|
+
*/
|
|
3140
|
+
declare function normaliseDocumentSlots(slots: DocumentSlotConfig[] | undefined): DocumentSlotConfig[];
|
|
3141
|
+
/**
|
|
3142
|
+
* Lightweight validator usable from any package.
|
|
3143
|
+
* Throws plain Error subclasses; runtime wraps them in SchemaError-derived
|
|
3144
|
+
* types via a separate adapter (see runtime/services/document/errors.ts).
|
|
3145
|
+
*/
|
|
3146
|
+
declare class DocumentSlotValidationError extends Error {
|
|
3147
|
+
code: "SLOT_NOT_DECLARED" | "MIME_NOT_ACCEPTED";
|
|
3148
|
+
context: Record<string, unknown>;
|
|
3149
|
+
constructor(code: "SLOT_NOT_DECLARED" | "MIME_NOT_ACCEPTED", message: string, context: Record<string, unknown>);
|
|
3150
|
+
}
|
|
3151
|
+
declare function validateSlotAgainstConfig(slotName: string, mimeType: string, slots: DocumentSlotConfig[]): DocumentSlotConfig;
|
|
3152
|
+
|
|
3218
3153
|
/**
|
|
3219
3154
|
* Default empty value placeholder
|
|
3220
3155
|
*/
|
|
@@ -4270,6 +4205,11 @@ declare class DocumentAttributeBuilder<TName extends string, TRequired extends b
|
|
|
4270
4205
|
* Automatically trigger agent-compatible processing on upload.
|
|
4271
4206
|
*/
|
|
4272
4207
|
autoProcess(): this;
|
|
4208
|
+
/**
|
|
4209
|
+
* Define named upload slots for this document attribute.
|
|
4210
|
+
* An empty array falls back to a single default slot.
|
|
4211
|
+
*/
|
|
4212
|
+
slots(configs: DocumentSlotConfig[]): this;
|
|
4273
4213
|
/**
|
|
4274
4214
|
* Add a child attribute definition for per-document metadata.
|
|
4275
4215
|
* Reuses existing attribute builders directly.
|
|
@@ -5236,10 +5176,6 @@ declare class DetailViewBuilder {
|
|
|
5236
5176
|
* Build the final view definition
|
|
5237
5177
|
*/
|
|
5238
5178
|
build(): DetailViewDefinition;
|
|
5239
|
-
/**
|
|
5240
|
-
* Validate view name format (kebab-case)
|
|
5241
|
-
*/
|
|
5242
|
-
private validateName;
|
|
5243
5179
|
}
|
|
5244
5180
|
/**
|
|
5245
5181
|
* Create a new detail view builder
|
|
@@ -5401,10 +5337,6 @@ declare class ListViewBuilder {
|
|
|
5401
5337
|
* Build the final list view definition
|
|
5402
5338
|
*/
|
|
5403
5339
|
build(): ListViewDefinition;
|
|
5404
|
-
/**
|
|
5405
|
-
* Validate view name format (kebab-case)
|
|
5406
|
-
*/
|
|
5407
|
-
private validateName;
|
|
5408
5340
|
}
|
|
5409
5341
|
/**
|
|
5410
5342
|
* Builder for configuring tabs in list views.
|
|
@@ -6543,4 +6475,4 @@ declare const OPERATOR_SPECS: Record<FilterOperator, OperatorSpec>;
|
|
|
6543
6475
|
*/
|
|
6544
6476
|
declare function evaluateFilterState(state: FilterState, values: Record<string, unknown>, attributes: Attribute[]): boolean;
|
|
6545
6477
|
|
|
6546
|
-
export { type AIAvailableModel, type AIBatchQuestion, type AIBatchQuestionAnswer, type AIBatchQuestionOption, type AIChatMessage, type AIChatMessagePart, type AIChatMessagePartType, type AICompactionSummary, type AIMemoryEntry, type AIMemoryType, type AIMessageRole, type AIProviderMetrics, type AIQuestion, type AIQuestionAnswer, type AIQuestionOption, type AIQuestionType, type AITodoItem, type AITodoList, type AITodoStatus, type AIToolCall, type AIToolCallStatus, type AIUsageMetrics, ALL_ACTIONS, ALL_SYSTEM_RESOURCES, type AccessAction, type AccessActionList, AccessDeniedError, type AccessLevel, type AccessPolicy, type AccessPolicyPreset, type AccessResourceType, type Action, ActivityTabConfig, type Actor, type ActorRoleAssignment, type ActorStatus, type ActorType, type AddAttributeInput, type AgentConfig, type AgentContextEntry, type AgentDashboard, type AgentDefinition, type AgentEvent, type AgentExecutionConfig, type AgentExecutionPolicy, type AgentMessageAttachment, type AgentMessagePart, type AgentQuestion, type AgentRun, type AgentRunStatus, type AgentSchedule, type AgentSession, type AgentSessionMessage, type AgentSessionMode, type AgentSessionStatus, type AgentToolCall, type AgentTriggerDefinition, type AgentTriggerType, type ApiKey, type ApiKeyAuthContext, type ApiKeyPermission, type ApiKeyWithSecret, type AssignActorRoleInput, type AssignRoleInput, Attribute, AttributeGroupField, AttributeInUseError, AttributeNotFoundError, AttributeType, type AttributeUsage, type AuditAction, type AuditActorType, type AuditChange, type AuditListOptions, type AuditLogEntry, type AuditResourceType, type AuditServiceOptions, type AuditSortField, BEHAVIOR_PROPERTIES, BilateralConfig, type BoundingBox, type BuilderConfig, CheckboxAttribute, CompletionStatus, ConcurrentModificationError, ConfigOverrides, type CountMode, type CreateActorInput, type CreateApiKeyInput, type CreateAuditLogInput, type CreateCustomObjectInput, type CreateDBAttribute, type CreateDBForm, type CreateDBFormSubmission, type CreateDBObject, type CreateDBView, type CreateDBViewOverlay, type
|
|
6478
|
+
export { type AIAvailableModel, type AIBatchQuestion, type AIBatchQuestionAnswer, type AIBatchQuestionOption, type AIChatMessage, type AIChatMessagePart, type AIChatMessagePartType, type AICompactionSummary, type AIMemoryEntry, type AIMemoryType, type AIMessageRole, type AIProviderMetrics, type AIQuestion, type AIQuestionAnswer, type AIQuestionOption, type AIQuestionType, type AITodoItem, type AITodoList, type AITodoStatus, type AIToolCall, type AIToolCallStatus, type AIUsageMetrics, ALL_ACTIONS, ALL_SYSTEM_RESOURCES, type AccessAction, type AccessActionList, AccessDeniedError, type AccessLevel, type AccessPolicy, type AccessPolicyPreset, type AccessResourceType, type Action, ActivityTabConfig, type Actor, type ActorRoleAssignment, type ActorStatus, type ActorType, type AddAttributeInput, type AgentConfig, type AgentContextEntry, type AgentDashboard, type AgentDefinition, type AgentEvent, type AgentExecutionConfig, type AgentExecutionPolicy, type AgentMessageAttachment, type AgentMessagePart, type AgentQuestion, type AgentRun, type AgentRunStatus, type AgentSchedule, type AgentSession, type AgentSessionMessage, type AgentSessionMode, type AgentSessionStatus, type AgentToolCall, type AgentTriggerDefinition, type AgentTriggerType, type ApiKey, type ApiKeyAuthContext, type ApiKeyPermission, type ApiKeyWithSecret, type AssignActorRoleInput, type AssignRoleInput, Attribute, AttributeGroupField, AttributeInUseError, AttributeNotFoundError, AttributeType, type AttributeUsage, type AuditAction, type AuditActorType, type AuditChange, type AuditListOptions, type AuditLogEntry, type AuditResourceType, type AuditServiceOptions, type AuditSortField, BEHAVIOR_PROPERTIES, BilateralConfig, type BoundingBox, type BuilderConfig, CheckboxAttribute, CompletionStatus, ConcurrentModificationError, ConfigOverrides, type CountMode, type CreateActorInput, type CreateApiKeyInput, type CreateAuditLogInput, type CreateCustomObjectInput, type CreateDBAttribute, type CreateDBForm, type CreateDBFormSubmission, type CreateDBObject, type CreateDBView, type CreateDBViewOverlay, type CreateFile, CreateMode, type CreateObjectRecord, type CreatePermissionInput, type CreateRoleInput, type CreateSandboxExecution, type CreateUserProfile, type CreateViewInput, type CriticConfig, Currency, CurrencyAttribute, type CustomAttributeValue, CustomTabConfig, type DBAttribute, type DBForm, type DBFormSubmission, type DBObject, type DBView, type DBViewOverlay, DB_COLUMN_FIELDS, DEFAULT_ROLES, DEFAULT_ROLE_DESCRIPTIONS, DEFAULT_ROLE_LABELS, DEFAULT_ROLE_PERMISSIONS, DOCUMENT_SYSTEM_ATTRIBUTES, DateAttribute, type DefaultRoleName, DetailViewBuilder, DetailViewConfig, DetailViewDefinition, DetailViewLayout, DocumentAttribute, DocumentSlotConfig, DocumentSlotValidationError, DocumentsTabConfig, type DomainEvent, DuplicateError, EMPTY_VALUE_PLACEHOLDER, type EffectivePermissions, type EventDataMap, type EventType, type ExtractRecord, type ExtractRecordInput, type ExtractRecordInputStrict, type ExtractRecordStrict, type ExtractRecordUpdate, type ExtractRecordUpdateStrict, FORM_FORBIDDEN_ATTRIBUTE_TYPES, FeatureFlagDefinition, FeatureFlagsRepository, FeatureGate, Field, FieldGroup, type File, FileAttribute, type FileListOptions, type FileVisibility, FilterOperator, FilterState, FilterValue, FlagLevel, FlagRegistry, FlagService, FlagValueType, ForbiddenError, FormBuilder, type FormDefinition, type FormFieldRef, type FormFieldsRow, type FormFreeFieldRef, type FormHeadingRow, FormRegistry, type FormRow, FormRowBuilder, type FormSeparatorRow, type FormSlot, type FormSlotFieldRef, type FormStatus, type FormStep, FormStepBuilder, type FormSubmission, type FormSubmissionStatus, type FormSubmittedAgentEvent, type FormTextRow, FormulaAttribute, type FormulaResult, FormulaReturnType, type GeocodingAdapter, type GeocodingAutocompleteParams, type GeocodingParams, type GeocodingSuggestion, type GlobalSearchGroupedOptions, type GlobalSearchGroupedResult, type GlobalSearchOptions, type GlobalSearchResultItem, type GrantResourceAccessInput, Group, GroupBuilder, IDENTITY_PROPERTIES, type InferAttributeValue, InvalidPathError, type InviteUserInput, type ListOptions, ListViewBuilder, ListViewConfig, ListViewDefinition, ListViewTab, ListViewTabConfigBuilder, Location, LocationAttribute, LocationGranularity, MaxDepthExceededError, MemoryNotFoundError, type MentionEntityType, type MentionReference, type MentionedContext, type MentionedEntityContext, MigrationDefinition, type ModelDefinition, MultiRelationAttribute, MultiselectAttribute, NoopGeocodingAdapter, NotFoundError, NotImplementedError, NumberAttribute, OPERATOR_SPECS, ObjectBuilder, ObjectDefinition, ObjectNotFoundError, type ObjectPermissions, ObjectRecord, ObjectReferencedError, type OcrAdapter, type OcrInput, type OcrOptions, type OcrPage, type OcrResult, type OcrTextBlock, type OperatorSpec, Option, PRESENTATION_PROPERTIES, type PageInfo, type PageOptions, type PageResponse, type PathCardinality, type PathSegment, type PathSegmentType, type Permission, type PermissionScope, Phone, PhoneAttribute, type PolicyContext, PolicyViolationError, type PrincipalType, ProtectedResourceError, ProtectedRoleError, type ProviderName, type QuestionResponse, type QuestionStatus, RatingAttribute, type ReasoningPartData, type RecordAgentEvent, type RecordMetadata, RecordNotFoundError, type RecordPolicy, type RecordReference, RecordReferencedError, RelationAttribute, RelationGroup, RelationGroupBuilder, type RelationOption, type RelationOptionsResponse, RelationTarget, RepositoryError, type RepositoryOperation, ResolvedFlag, type ResourceAccess, type ResourceRef, type RetryPolicy, type ReverseGeocodingParams, RichtextAttribute, RichtextFeature, RichtextTabConfig, type Role, RoleNotFoundError, RollupAttribute, RollupFunction, STANDARD_SCHEMA_VENDOR, SYSTEM_ATTRIBUTES, SYSTEM_ATTRIBUTE_I18N_KEYS, SYSTEM_RESOURCES, SYSTEM_RESOURCE_LABELS, type SandboxExecution, type SandboxExecutionInput, type SandboxExecutionResult, type SandboxExecutionStatus, type SandboxMode, type SandboxTrigger, SchemaError, SchemaErrorCode, type SchemaResolver, type SearchOptions, SelectAttribute, SidePanelConfig, type SidebarExtraItem, SingleRelationAttribute, type SlotMode, SortRule, type SpecificAccessAction, type StandardSchemaIssue, type StandardSchemaResult, StaticFlagDefault, StatusAttribute, StorageError, type StorageOperation, type StorageProvider, type StreamEventCompactionEnd, type StreamEventCompactionFailed, type StreamEventCompactionStart, type StreamEventMessagePersisted, SyncError, type SystemAttribute, type SystemAttributeI18nKey, type SystemFields, type SystemPermissions, type SystemResource, Tab, TabBuilder, TableTab, TableTabConfig, TenantId, TextAreaAttribute, TextAttribute, type TextPartData, type ThinkingPartData, type TimeoutPolicy, Timestamps, type ToolPartData, type ToolPartState, type TriggerEventType, USER_STATUSES, type UpdateActorInput, type UpdateDBAttribute, type UpdateDBForm, type UpdateDBFormSubmission, type UpdateDBObject, type UpdateDBView, type UpdateDBViewOverlay, type UpdateFile, type UpdateObjectInput, type UpdateRoleInput, type UpdateUserProfile, type UpdateViewInput, type UpsertAccessPolicyInput, type UpsertDBAttribute, type UpsertDBObject, type UpsertDBView, UserAttribute, type UserProfile, type UserRoleAssignment, type UserStatus, Uuid, ValidationError, type ValidationErrorDetail, ViewConfig, ViewDefinition, ViewType, type WithCustomAttributes$1 as WithCustomAttributes, accessLevelToActions, actionsToAccessLevel, applyPipes, booleanFlag, checkbox, createFlagRegistry, createFlagService, createStandardSchemaProps, currency, date, detailView, document, evaluateFilterState, evaluateFormula, evaluateFormulaAttribute, evaluateFormulaWithResult, extractAttributeNames, extractFormulaVariables, extractRelationNames, extractRelationReferences, file, flagRegistry, flattenRelationsForEval, form, formRegistry, formatAttributeValue, formatFormulaResult, formula, generateDefaultDetailView, generateDefaultListView, getActiveTab, getErrorMessage, getPathDepth, getRelationPath, getSystemAttributeI18nKey, getSystemAttributeList, getTargetAttributeName, group, hasRelationReferences, isAttributeInUseError, isDefaultRole, isDocumentAttribute, isEmptyObject, isFormDefinition, isFormFieldsRow, isFormFreeFieldRef, isFormHeadingRow, isFormSeparatorRow, isFormSlotFieldRef, isFormTextRow, isLabelExpression, isNotEmpty, isNotFoundError, isObjectReferencedError, isProtectedResourceError, isRecordReferencedError, isSchemaError, isStandardSchema, isValidationError, jsonFlag, listView, location, matchesMime, multiselect, normaliseDocumentSlots, number, numberFlag, object, parsePath, pathHasManyCardinality, phone, rating, registry, relation, relationGroup, renderLabelExpression, resetViewToDefault, richtext, rollup, select, status, stringFlag, text, textarea, toUndefinedIfEmpty, user, validateAttributeName, validateFormulaExpression, validatePath, validateSlotAgainstConfig, viewRegistry };
|
package/dist/index.d.ts
CHANGED
|
@@ -1,16 +1,15 @@
|
|
|
1
|
-
import {
|
|
2
|
-
export {
|
|
3
|
-
import { j as AttributeType, A as Attribute, k as LocationGranularity, l as Location, e as FormulaAttribute, f as RollupAttribute, d as StatusAttribute, c as SelectAttribute, b as MultiselectAttribute, m as Phone, n as Currency, D as DateAttribute, U as UserAttribute, o as DocumentAttribute, p as FeatureGate, g as CheckboxAttribute, C as CurrencyAttribute, F as FileAttribute, q as FormulaReturnType, L as LocationAttribute, O as Option, N as NumberAttribute, P as PhoneAttribute, h as RatingAttribute, R as RelationAttribute, i as TextAttribute, T as TextAreaAttribute, B as BilateralConfig, S as SingleRelationAttribute, M as MultiRelationAttribute, r as RelationTarget, a as RichtextAttribute, s as RichtextFeature, t as RollupFunction, u as FlagValueType, v as FeatureFlagDefinition, w as FlagLevel, x as FeatureFlagsRepository, y as StaticFlagDefault, z as ResolvedFlag } from './attributes-CNpcbVbv.js';
|
|
4
|
-
export { E as AttributeGroup, G as BaseAttribute, H as DateFormat, I as DateValue, J as FeatureFlagsConfig, K as FlagOverride, Q as NumberUnit, V as OptionPropertyAttribute, W as PropertyAttribute, X as PropertySchema, Y as PropertyType, Z as RELATION_TARGET_ANY, _ as StatusGroup, $ as hasOptions, a0 as inferInverseCardinality, a1 as isAttributeSortable, a2 as isBilateralRelation, a3 as isUniversalRelation } from './attributes-CNpcbVbv.js';
|
|
1
|
+
import { k as SortRule, l as FilterState, m as Timestamps, n as AttributeType, V as ViewType, o as ViewConfig, p as ConfigOverrides, j as CompletionStatus, A as Attribute, q as LocationGranularity, r as Location, e as FormulaAttribute, f as RollupAttribute, d as StatusAttribute, c as SelectAttribute, b as MultiselectAttribute, s as Phone, t as Currency, u as ObjectRecord, D as DateAttribute, U as UserAttribute, v as DocumentAttribute, w as DocumentSlotConfig, x as FeatureGate, g as CheckboxAttribute, C as CurrencyAttribute, F as FileAttribute, y as FormulaReturnType, L as LocationAttribute, z as Option, N as NumberAttribute, P as PhoneAttribute, h as RatingAttribute, R as RelationAttribute, i as TextAttribute, T as TextAreaAttribute, B as BilateralConfig, S as SingleRelationAttribute, M as MultiRelationAttribute, E as RelationTarget, a as RichtextAttribute, G as RichtextFeature, H as RollupFunction, I as MigrationDefinition, O as ObjectDefinition, J as DetailViewConfig, K as DetailViewDefinition, Q as DetailViewLayout, W as SidePanelConfig, X as Field, Y as AttributeGroupField, Z as FieldGroup, _ as RelationGroup, $ as Group, a0 as TableTab, a1 as CreateMode, a2 as Tab, a3 as ListViewConfig, a4 as ListViewDefinition, a5 as FlagValueType, a6 as FeatureFlagDefinition, a7 as FlagLevel, a8 as FeatureFlagsRepository, a9 as StaticFlagDefault, aa as ResolvedFlag, ab as ViewDefinition, ac as ListViewTab, ad as FilterOperator, ae as FilterValue } from './filters-zzsF0GxK.js';
|
|
2
|
+
export { af as ActivityTab, ag as AdvancedFilterState, ah as AttributeGroup, ai as BaseAttribute, aj as BuiltInTransform, ak as CreateDocument, al as CreateDocumentSlot, am as CreateProcessingJob, an as CurrencyFilterValue, ao as CustomTab, ap as DEFAULT_DOCUMENT_SLOT, aq as DateFormat, ar as DateValue, as as Document, at as DocumentListOptions, au as DocumentSlot, av as DocumentWithSlots, aw as DocumentsTab, ax as ExtendedFilterRule, ay as FeatureFlagsConfig, az as FilterCombinator, aA as FilterGroup, aB as FilterRule, aC as FlagOverride, aD as FormDensity, aE as FormTab, aF as FormsTab, aG as InverseSource, aH as ListViewLayout, aI as MigrationError, aJ as NO_VALUE_OPERATORS, aK as NoValueOperator, aL as NumberUnit, aM as OPERATORS_BY_TYPE, aN as ObjectAttribute, aO as OptionPropertyAttribute, aP as PhoneFilterValue, aQ as ProcessingJob, aR as ProcessingJobStatus, aS as ProcessingJobType, aT as PropertyAttribute, aU as PropertySchema, aV as PropertyType, aW as QueryState, aX as RELATION_TARGET_ANY, aY as RESERVED_ATTRIBUTE_NAMES, aZ as RecordDocuments, a_ as RelationSource, a$ as RelativeDateValue, b0 as ReservedAttributeName, b1 as RichtextTab, b2 as SYSTEM_FIELD_NAMES, b3 as SchemaOperation, b4 as SchemaTransform, b5 as SlotStatus, b6 as SortDirection, b7 as StatusGroup, b8 as SystemFieldName, b9 as TabType, ba as TableSource, bb as TransformSource, bc as UpdateDocument, bd as UpdateDocumentSlot, be as UpdateProcessingJob, bf as ViewOperation, bg as ViewOverlay, bh as ViewTransform, bi as getRollupFilterOperators, bj as hasOptions, bk as inferInverseCardinality, bl as isAttributeSortable, bm as isBilateralRelation, bn as isDetailView, bo as isFieldGroup, bp as isListView, bq as isNoValueOperator, br as isRelationGroup, bs as isUniversalRelation } from './filters-zzsF0GxK.js';
|
|
5
3
|
import { MimeType, IconName, ColorId, CountryIso3, CurrencyCode } from '@stndrds/constants';
|
|
6
4
|
import { Uuid, TenantId } from './utils.js';
|
|
7
5
|
export { UserId, asTenantId, asUserId, deepEqual, generateId, indexBy } from './utils.js';
|
|
8
6
|
import { StandardSchemaV1 } from '@standard-schema/spec';
|
|
9
7
|
export { StandardSchemaV1 } from '@standard-schema/spec';
|
|
10
8
|
import z from 'zod';
|
|
11
|
-
export { V as ValidationMessages } from './types-
|
|
9
|
+
export { V as ValidationMessages } from './types-Bemfgle3.js';
|
|
12
10
|
export { DEFAULT_VALIDATION_MESSAGES, formatZodErrors } from './validation/core/index.js';
|
|
13
11
|
export { parseAttributeConfig } from './validation/config/index.js';
|
|
12
|
+
export { c as computeRecordStatus, a as createFormAttributeValidator, v as validateDraft, b as validateDraftOrThrow, d as validateObject, e as validateObjectOrThrow } from './helpers-64gmAyw0.js';
|
|
14
13
|
|
|
15
14
|
/**
|
|
16
15
|
* Generic list options for pagination and sorting
|
|
@@ -1824,93 +1823,6 @@ interface BuilderConfig {
|
|
|
1824
1823
|
label: string;
|
|
1825
1824
|
}
|
|
1826
1825
|
|
|
1827
|
-
interface Document extends Timestamps {
|
|
1828
|
-
id: Uuid;
|
|
1829
|
-
tenantId: Uuid;
|
|
1830
|
-
title: string;
|
|
1831
|
-
processingStatus: ProcessingStatus;
|
|
1832
|
-
contentHash?: string;
|
|
1833
|
-
searchVector?: unknown;
|
|
1834
|
-
createdBy?: Uuid;
|
|
1835
|
-
updatedBy?: Uuid;
|
|
1836
|
-
deletedAt?: Date | null;
|
|
1837
|
-
values: Record<string, unknown>;
|
|
1838
|
-
}
|
|
1839
|
-
/**
|
|
1840
|
-
* Technical processing lifecycle — never exposed in UI.
|
|
1841
|
-
* User-visible status belongs in document `values`.
|
|
1842
|
-
*/
|
|
1843
|
-
type ProcessingStatus = "draft" | "pending" | "processing" | "completed" | "failed";
|
|
1844
|
-
interface DocumentSlot extends Timestamps {
|
|
1845
|
-
id: Uuid;
|
|
1846
|
-
tenantId: Uuid;
|
|
1847
|
-
documentId: Uuid;
|
|
1848
|
-
slotName: string;
|
|
1849
|
-
isAdditional: boolean;
|
|
1850
|
-
fileId: Uuid;
|
|
1851
|
-
status: SlotStatus;
|
|
1852
|
-
ocrText?: string;
|
|
1853
|
-
ocrConfidence?: number;
|
|
1854
|
-
processedAt?: Date;
|
|
1855
|
-
}
|
|
1856
|
-
type SlotStatus = "uploaded" | "processing" | "completed" | "failed";
|
|
1857
|
-
interface ProcessingJob extends Timestamps {
|
|
1858
|
-
id: Uuid;
|
|
1859
|
-
tenantId: Uuid;
|
|
1860
|
-
documentId: Uuid;
|
|
1861
|
-
slotName?: string | null;
|
|
1862
|
-
type: ProcessingJobType;
|
|
1863
|
-
provider: string;
|
|
1864
|
-
status: ProcessingJobStatus;
|
|
1865
|
-
input?: Record<string, unknown>;
|
|
1866
|
-
result?: Record<string, unknown>;
|
|
1867
|
-
error?: string;
|
|
1868
|
-
startedAt?: Date | null;
|
|
1869
|
-
completedAt?: Date | null;
|
|
1870
|
-
createdBy?: Uuid;
|
|
1871
|
-
}
|
|
1872
|
-
type ProcessingJobType = "ocr";
|
|
1873
|
-
type ProcessingJobStatus = "pending" | "processing" | "completed" | "failed" | "cancelled";
|
|
1874
|
-
interface CreateDocument {
|
|
1875
|
-
title: string;
|
|
1876
|
-
values?: Record<string, unknown>;
|
|
1877
|
-
}
|
|
1878
|
-
interface UpdateDocument {
|
|
1879
|
-
title?: string;
|
|
1880
|
-
values?: Record<string, unknown>;
|
|
1881
|
-
processingStatus?: ProcessingStatus;
|
|
1882
|
-
}
|
|
1883
|
-
interface CreateDocumentSlot {
|
|
1884
|
-
documentId: Uuid;
|
|
1885
|
-
slotName: string;
|
|
1886
|
-
fileId: Uuid;
|
|
1887
|
-
isAdditional?: boolean;
|
|
1888
|
-
}
|
|
1889
|
-
interface UpdateDocumentSlot {
|
|
1890
|
-
status?: SlotStatus;
|
|
1891
|
-
ocrText?: string;
|
|
1892
|
-
ocrConfidence?: number;
|
|
1893
|
-
}
|
|
1894
|
-
interface CreateProcessingJob {
|
|
1895
|
-
documentId: Uuid;
|
|
1896
|
-
slotName?: string;
|
|
1897
|
-
type: ProcessingJobType;
|
|
1898
|
-
provider: string;
|
|
1899
|
-
input?: Record<string, unknown>;
|
|
1900
|
-
}
|
|
1901
|
-
interface UpdateProcessingJob {
|
|
1902
|
-
status?: ProcessingJobStatus;
|
|
1903
|
-
result?: Record<string, unknown>;
|
|
1904
|
-
error?: string;
|
|
1905
|
-
startedAt?: Date;
|
|
1906
|
-
completedAt?: Date;
|
|
1907
|
-
}
|
|
1908
|
-
interface DocumentListOptions {
|
|
1909
|
-
limit?: number;
|
|
1910
|
-
offset?: number;
|
|
1911
|
-
processingStatus?: ProcessingStatus;
|
|
1912
|
-
}
|
|
1913
|
-
|
|
1914
1826
|
/**
|
|
1915
1827
|
* Error codes for schema exceptions
|
|
1916
1828
|
*/
|
|
@@ -3215,6 +3127,29 @@ declare function isNotEmpty(obj: unknown): obj is Record<string, unknown>;
|
|
|
3215
3127
|
*/
|
|
3216
3128
|
declare function toUndefinedIfEmpty<T extends Record<string, unknown>>(obj: T | undefined | null): T | undefined;
|
|
3217
3129
|
|
|
3130
|
+
declare const DOCUMENT_SYSTEM_ATTRIBUTES: {
|
|
3131
|
+
readonly ATTACHMENTS: "attachments";
|
|
3132
|
+
};
|
|
3133
|
+
declare function isDocumentAttribute(attr: Attribute): attr is DocumentAttribute;
|
|
3134
|
+
declare function matchesMime(mime: string, accepted: string[] | undefined): boolean;
|
|
3135
|
+
/**
|
|
3136
|
+
* Returns the slots array for a DocumentAttribute, applying the default
|
|
3137
|
+
* when none is configured. Use everywhere the slots are read so the
|
|
3138
|
+
* default is consistent.
|
|
3139
|
+
*/
|
|
3140
|
+
declare function normaliseDocumentSlots(slots: DocumentSlotConfig[] | undefined): DocumentSlotConfig[];
|
|
3141
|
+
/**
|
|
3142
|
+
* Lightweight validator usable from any package.
|
|
3143
|
+
* Throws plain Error subclasses; runtime wraps them in SchemaError-derived
|
|
3144
|
+
* types via a separate adapter (see runtime/services/document/errors.ts).
|
|
3145
|
+
*/
|
|
3146
|
+
declare class DocumentSlotValidationError extends Error {
|
|
3147
|
+
code: "SLOT_NOT_DECLARED" | "MIME_NOT_ACCEPTED";
|
|
3148
|
+
context: Record<string, unknown>;
|
|
3149
|
+
constructor(code: "SLOT_NOT_DECLARED" | "MIME_NOT_ACCEPTED", message: string, context: Record<string, unknown>);
|
|
3150
|
+
}
|
|
3151
|
+
declare function validateSlotAgainstConfig(slotName: string, mimeType: string, slots: DocumentSlotConfig[]): DocumentSlotConfig;
|
|
3152
|
+
|
|
3218
3153
|
/**
|
|
3219
3154
|
* Default empty value placeholder
|
|
3220
3155
|
*/
|
|
@@ -4270,6 +4205,11 @@ declare class DocumentAttributeBuilder<TName extends string, TRequired extends b
|
|
|
4270
4205
|
* Automatically trigger agent-compatible processing on upload.
|
|
4271
4206
|
*/
|
|
4272
4207
|
autoProcess(): this;
|
|
4208
|
+
/**
|
|
4209
|
+
* Define named upload slots for this document attribute.
|
|
4210
|
+
* An empty array falls back to a single default slot.
|
|
4211
|
+
*/
|
|
4212
|
+
slots(configs: DocumentSlotConfig[]): this;
|
|
4273
4213
|
/**
|
|
4274
4214
|
* Add a child attribute definition for per-document metadata.
|
|
4275
4215
|
* Reuses existing attribute builders directly.
|
|
@@ -5236,10 +5176,6 @@ declare class DetailViewBuilder {
|
|
|
5236
5176
|
* Build the final view definition
|
|
5237
5177
|
*/
|
|
5238
5178
|
build(): DetailViewDefinition;
|
|
5239
|
-
/**
|
|
5240
|
-
* Validate view name format (kebab-case)
|
|
5241
|
-
*/
|
|
5242
|
-
private validateName;
|
|
5243
5179
|
}
|
|
5244
5180
|
/**
|
|
5245
5181
|
* Create a new detail view builder
|
|
@@ -5401,10 +5337,6 @@ declare class ListViewBuilder {
|
|
|
5401
5337
|
* Build the final list view definition
|
|
5402
5338
|
*/
|
|
5403
5339
|
build(): ListViewDefinition;
|
|
5404
|
-
/**
|
|
5405
|
-
* Validate view name format (kebab-case)
|
|
5406
|
-
*/
|
|
5407
|
-
private validateName;
|
|
5408
5340
|
}
|
|
5409
5341
|
/**
|
|
5410
5342
|
* Builder for configuring tabs in list views.
|
|
@@ -6543,4 +6475,4 @@ declare const OPERATOR_SPECS: Record<FilterOperator, OperatorSpec>;
|
|
|
6543
6475
|
*/
|
|
6544
6476
|
declare function evaluateFilterState(state: FilterState, values: Record<string, unknown>, attributes: Attribute[]): boolean;
|
|
6545
6477
|
|
|
6546
|
-
export { type AIAvailableModel, type AIBatchQuestion, type AIBatchQuestionAnswer, type AIBatchQuestionOption, type AIChatMessage, type AIChatMessagePart, type AIChatMessagePartType, type AICompactionSummary, type AIMemoryEntry, type AIMemoryType, type AIMessageRole, type AIProviderMetrics, type AIQuestion, type AIQuestionAnswer, type AIQuestionOption, type AIQuestionType, type AITodoItem, type AITodoList, type AITodoStatus, type AIToolCall, type AIToolCallStatus, type AIUsageMetrics, ALL_ACTIONS, ALL_SYSTEM_RESOURCES, type AccessAction, type AccessActionList, AccessDeniedError, type AccessLevel, type AccessPolicy, type AccessPolicyPreset, type AccessResourceType, type Action, ActivityTabConfig, type Actor, type ActorRoleAssignment, type ActorStatus, type ActorType, type AddAttributeInput, type AgentConfig, type AgentContextEntry, type AgentDashboard, type AgentDefinition, type AgentEvent, type AgentExecutionConfig, type AgentExecutionPolicy, type AgentMessageAttachment, type AgentMessagePart, type AgentQuestion, type AgentRun, type AgentRunStatus, type AgentSchedule, type AgentSession, type AgentSessionMessage, type AgentSessionMode, type AgentSessionStatus, type AgentToolCall, type AgentTriggerDefinition, type AgentTriggerType, type ApiKey, type ApiKeyAuthContext, type ApiKeyPermission, type ApiKeyWithSecret, type AssignActorRoleInput, type AssignRoleInput, Attribute, AttributeGroupField, AttributeInUseError, AttributeNotFoundError, AttributeType, type AttributeUsage, type AuditAction, type AuditActorType, type AuditChange, type AuditListOptions, type AuditLogEntry, type AuditResourceType, type AuditServiceOptions, type AuditSortField, BEHAVIOR_PROPERTIES, BilateralConfig, type BoundingBox, type BuilderConfig, CheckboxAttribute, CompletionStatus, ConcurrentModificationError, ConfigOverrides, type CountMode, type CreateActorInput, type CreateApiKeyInput, type CreateAuditLogInput, type CreateCustomObjectInput, type CreateDBAttribute, type CreateDBForm, type CreateDBFormSubmission, type CreateDBObject, type CreateDBView, type CreateDBViewOverlay, type
|
|
6478
|
+
export { type AIAvailableModel, type AIBatchQuestion, type AIBatchQuestionAnswer, type AIBatchQuestionOption, type AIChatMessage, type AIChatMessagePart, type AIChatMessagePartType, type AICompactionSummary, type AIMemoryEntry, type AIMemoryType, type AIMessageRole, type AIProviderMetrics, type AIQuestion, type AIQuestionAnswer, type AIQuestionOption, type AIQuestionType, type AITodoItem, type AITodoList, type AITodoStatus, type AIToolCall, type AIToolCallStatus, type AIUsageMetrics, ALL_ACTIONS, ALL_SYSTEM_RESOURCES, type AccessAction, type AccessActionList, AccessDeniedError, type AccessLevel, type AccessPolicy, type AccessPolicyPreset, type AccessResourceType, type Action, ActivityTabConfig, type Actor, type ActorRoleAssignment, type ActorStatus, type ActorType, type AddAttributeInput, type AgentConfig, type AgentContextEntry, type AgentDashboard, type AgentDefinition, type AgentEvent, type AgentExecutionConfig, type AgentExecutionPolicy, type AgentMessageAttachment, type AgentMessagePart, type AgentQuestion, type AgentRun, type AgentRunStatus, type AgentSchedule, type AgentSession, type AgentSessionMessage, type AgentSessionMode, type AgentSessionStatus, type AgentToolCall, type AgentTriggerDefinition, type AgentTriggerType, type ApiKey, type ApiKeyAuthContext, type ApiKeyPermission, type ApiKeyWithSecret, type AssignActorRoleInput, type AssignRoleInput, Attribute, AttributeGroupField, AttributeInUseError, AttributeNotFoundError, AttributeType, type AttributeUsage, type AuditAction, type AuditActorType, type AuditChange, type AuditListOptions, type AuditLogEntry, type AuditResourceType, type AuditServiceOptions, type AuditSortField, BEHAVIOR_PROPERTIES, BilateralConfig, type BoundingBox, type BuilderConfig, CheckboxAttribute, CompletionStatus, ConcurrentModificationError, ConfigOverrides, type CountMode, type CreateActorInput, type CreateApiKeyInput, type CreateAuditLogInput, type CreateCustomObjectInput, type CreateDBAttribute, type CreateDBForm, type CreateDBFormSubmission, type CreateDBObject, type CreateDBView, type CreateDBViewOverlay, type CreateFile, CreateMode, type CreateObjectRecord, type CreatePermissionInput, type CreateRoleInput, type CreateSandboxExecution, type CreateUserProfile, type CreateViewInput, type CriticConfig, Currency, CurrencyAttribute, type CustomAttributeValue, CustomTabConfig, type DBAttribute, type DBForm, type DBFormSubmission, type DBObject, type DBView, type DBViewOverlay, DB_COLUMN_FIELDS, DEFAULT_ROLES, DEFAULT_ROLE_DESCRIPTIONS, DEFAULT_ROLE_LABELS, DEFAULT_ROLE_PERMISSIONS, DOCUMENT_SYSTEM_ATTRIBUTES, DateAttribute, type DefaultRoleName, DetailViewBuilder, DetailViewConfig, DetailViewDefinition, DetailViewLayout, DocumentAttribute, DocumentSlotConfig, DocumentSlotValidationError, DocumentsTabConfig, type DomainEvent, DuplicateError, EMPTY_VALUE_PLACEHOLDER, type EffectivePermissions, type EventDataMap, type EventType, type ExtractRecord, type ExtractRecordInput, type ExtractRecordInputStrict, type ExtractRecordStrict, type ExtractRecordUpdate, type ExtractRecordUpdateStrict, FORM_FORBIDDEN_ATTRIBUTE_TYPES, FeatureFlagDefinition, FeatureFlagsRepository, FeatureGate, Field, FieldGroup, type File, FileAttribute, type FileListOptions, type FileVisibility, FilterOperator, FilterState, FilterValue, FlagLevel, FlagRegistry, FlagService, FlagValueType, ForbiddenError, FormBuilder, type FormDefinition, type FormFieldRef, type FormFieldsRow, type FormFreeFieldRef, type FormHeadingRow, FormRegistry, type FormRow, FormRowBuilder, type FormSeparatorRow, type FormSlot, type FormSlotFieldRef, type FormStatus, type FormStep, FormStepBuilder, type FormSubmission, type FormSubmissionStatus, type FormSubmittedAgentEvent, type FormTextRow, FormulaAttribute, type FormulaResult, FormulaReturnType, type GeocodingAdapter, type GeocodingAutocompleteParams, type GeocodingParams, type GeocodingSuggestion, type GlobalSearchGroupedOptions, type GlobalSearchGroupedResult, type GlobalSearchOptions, type GlobalSearchResultItem, type GrantResourceAccessInput, Group, GroupBuilder, IDENTITY_PROPERTIES, type InferAttributeValue, InvalidPathError, type InviteUserInput, type ListOptions, ListViewBuilder, ListViewConfig, ListViewDefinition, ListViewTab, ListViewTabConfigBuilder, Location, LocationAttribute, LocationGranularity, MaxDepthExceededError, MemoryNotFoundError, type MentionEntityType, type MentionReference, type MentionedContext, type MentionedEntityContext, MigrationDefinition, type ModelDefinition, MultiRelationAttribute, MultiselectAttribute, NoopGeocodingAdapter, NotFoundError, NotImplementedError, NumberAttribute, OPERATOR_SPECS, ObjectBuilder, ObjectDefinition, ObjectNotFoundError, type ObjectPermissions, ObjectRecord, ObjectReferencedError, type OcrAdapter, type OcrInput, type OcrOptions, type OcrPage, type OcrResult, type OcrTextBlock, type OperatorSpec, Option, PRESENTATION_PROPERTIES, type PageInfo, type PageOptions, type PageResponse, type PathCardinality, type PathSegment, type PathSegmentType, type Permission, type PermissionScope, Phone, PhoneAttribute, type PolicyContext, PolicyViolationError, type PrincipalType, ProtectedResourceError, ProtectedRoleError, type ProviderName, type QuestionResponse, type QuestionStatus, RatingAttribute, type ReasoningPartData, type RecordAgentEvent, type RecordMetadata, RecordNotFoundError, type RecordPolicy, type RecordReference, RecordReferencedError, RelationAttribute, RelationGroup, RelationGroupBuilder, type RelationOption, type RelationOptionsResponse, RelationTarget, RepositoryError, type RepositoryOperation, ResolvedFlag, type ResourceAccess, type ResourceRef, type RetryPolicy, type ReverseGeocodingParams, RichtextAttribute, RichtextFeature, RichtextTabConfig, type Role, RoleNotFoundError, RollupAttribute, RollupFunction, STANDARD_SCHEMA_VENDOR, SYSTEM_ATTRIBUTES, SYSTEM_ATTRIBUTE_I18N_KEYS, SYSTEM_RESOURCES, SYSTEM_RESOURCE_LABELS, type SandboxExecution, type SandboxExecutionInput, type SandboxExecutionResult, type SandboxExecutionStatus, type SandboxMode, type SandboxTrigger, SchemaError, SchemaErrorCode, type SchemaResolver, type SearchOptions, SelectAttribute, SidePanelConfig, type SidebarExtraItem, SingleRelationAttribute, type SlotMode, SortRule, type SpecificAccessAction, type StandardSchemaIssue, type StandardSchemaResult, StaticFlagDefault, StatusAttribute, StorageError, type StorageOperation, type StorageProvider, type StreamEventCompactionEnd, type StreamEventCompactionFailed, type StreamEventCompactionStart, type StreamEventMessagePersisted, SyncError, type SystemAttribute, type SystemAttributeI18nKey, type SystemFields, type SystemPermissions, type SystemResource, Tab, TabBuilder, TableTab, TableTabConfig, TenantId, TextAreaAttribute, TextAttribute, type TextPartData, type ThinkingPartData, type TimeoutPolicy, Timestamps, type ToolPartData, type ToolPartState, type TriggerEventType, USER_STATUSES, type UpdateActorInput, type UpdateDBAttribute, type UpdateDBForm, type UpdateDBFormSubmission, type UpdateDBObject, type UpdateDBView, type UpdateDBViewOverlay, type UpdateFile, type UpdateObjectInput, type UpdateRoleInput, type UpdateUserProfile, type UpdateViewInput, type UpsertAccessPolicyInput, type UpsertDBAttribute, type UpsertDBObject, type UpsertDBView, UserAttribute, type UserProfile, type UserRoleAssignment, type UserStatus, Uuid, ValidationError, type ValidationErrorDetail, ViewConfig, ViewDefinition, ViewType, type WithCustomAttributes$1 as WithCustomAttributes, accessLevelToActions, actionsToAccessLevel, applyPipes, booleanFlag, checkbox, createFlagRegistry, createFlagService, createStandardSchemaProps, currency, date, detailView, document, evaluateFilterState, evaluateFormula, evaluateFormulaAttribute, evaluateFormulaWithResult, extractAttributeNames, extractFormulaVariables, extractRelationNames, extractRelationReferences, file, flagRegistry, flattenRelationsForEval, form, formRegistry, formatAttributeValue, formatFormulaResult, formula, generateDefaultDetailView, generateDefaultListView, getActiveTab, getErrorMessage, getPathDepth, getRelationPath, getSystemAttributeI18nKey, getSystemAttributeList, getTargetAttributeName, group, hasRelationReferences, isAttributeInUseError, isDefaultRole, isDocumentAttribute, isEmptyObject, isFormDefinition, isFormFieldsRow, isFormFreeFieldRef, isFormHeadingRow, isFormSeparatorRow, isFormSlotFieldRef, isFormTextRow, isLabelExpression, isNotEmpty, isNotFoundError, isObjectReferencedError, isProtectedResourceError, isRecordReferencedError, isSchemaError, isStandardSchema, isValidationError, jsonFlag, listView, location, matchesMime, multiselect, normaliseDocumentSlots, number, numberFlag, object, parsePath, pathHasManyCardinality, phone, rating, registry, relation, relationGroup, renderLabelExpression, resetViewToDefault, richtext, rollup, select, status, stringFlag, text, textarea, toUndefinedIfEmpty, user, validateAttributeName, validateFormulaExpression, validatePath, validateSlotAgainstConfig, viewRegistry };
|