aboutsummaryrefslogtreecommitdiff
path: root/packages/validation/schemas.ts
blob: 0bd73a1e66bdb1482b6a5029cdaf8525bdce4d5c (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
import { z } from "zod"

export const MetadataSchema = z.record(
	z.union([z.string(), z.number(), z.boolean()]),
)
export type Metadata = z.infer<typeof MetadataSchema>

export const VisibilityEnum = z.enum(["public", "private", "unlisted"])
export type Visibility = z.infer<typeof VisibilityEnum>

export const DocumentTypeEnum = z.enum([
	"text",
	"pdf",
	"tweet",
	"google_doc",
	"google_slide",
	"google_sheet",
	"image",
	"video",
	"notion_doc",
	"webpage",
	"onedrive",
])
export type DocumentType = z.infer<typeof DocumentTypeEnum>

export const DocumentStatusEnum = z.enum([
	"unknown",
	"queued",
	"extracting",
	"chunking",
	"embedding",
	"indexing",
	"done",
	"failed",
])
export type DocumentStatus = z.infer<typeof DocumentStatusEnum>

export const ProcessingStepSchema = z.object({
	name: z.string(),
	startTime: z.number(),
	endTime: z.number().optional(),
	status: z.enum(["completed", "failed", "pending"]),
	error: z.string().optional(),
	metadata: z.record(z.unknown()).optional(),
	finalStatus: z.enum(["done", "failed"]).optional(),
})
export type ProcessingStep = z.infer<typeof ProcessingStepSchema>

export const ProcessingMetadataSchema = z.object({
	startTime: z.number(),
	endTime: z.number().optional(),
	duration: z.number().optional(),
	error: z.string().optional(),
	finalStatus: z.enum(["completed", "failed", "done"]).optional(),
	chunkingStrategy: z.string().optional(),
	tokenCount: z.number().optional(),
	steps: z.array(ProcessingStepSchema),
})
export type ProcessingMetadata = z.infer<typeof ProcessingMetadataSchema>

export const DocumentSchema = z.object({
	id: z.string(),
	customId: z.string().nullable().optional(),
	contentHash: z.string().nullable().optional(),

	// Organization and ownership
	orgId: z.string(),
	userId: z.string(),
	connectionId: z.string().nullable().optional(),

	// Content fields
	title: z.string().nullable().optional(),
	content: z.string().nullable().optional(),
	summary: z.string().nullable().optional(),
	url: z.string().nullable().optional(),
	source: z.string().nullable().optional(),
	type: DocumentTypeEnum.default("text"),
	status: DocumentStatusEnum.default("unknown"),

	// Metadata and processing
	metadata: MetadataSchema.nullable().optional(),
	processingMetadata: ProcessingMetadataSchema.nullable().optional(),
	raw: z.any().nullable().optional(), // bytea in DB
	ogImage: z.string().nullable().optional(),

	// Content statistics
	tokenCount: z.number().nullable().optional(),
	wordCount: z.number().nullable().optional(),
	chunkCount: z.number().default(0),
	averageChunkSize: z.number().nullable().optional(),

	summaryEmbedding: z.array(z.number()).nullable().optional(),
	summaryEmbeddingModel: z.string().nullable().optional(),
	summaryEmbeddingNew: z.array(z.number()).nullable().optional(),
	summaryEmbeddingModelNew: z.string().nullable().optional(),

	// Timestamps
	createdAt: z.coerce.date(),
	updatedAt: z.coerce.date(),
})
export type Document = z.infer<typeof DocumentSchema>

export const ChunkTypeEnum = z.enum(["text", "image"])
export type ChunkType = z.infer<typeof ChunkTypeEnum>

export const ChunkSchema = z.object({
	id: z.string(),
	documentId: z.string(),
	content: z.string(),
	embeddedContent: z.string().nullable().optional(),
	type: ChunkTypeEnum.default("text"),
	position: z.number(),
	metadata: MetadataSchema.nullable().optional(),

	embedding: z.array(z.number()).nullable().optional(),
	embeddingModel: z.string().nullable().optional(),
	embeddingNew: z.array(z.number()).nullable().optional(),
	embeddingNewModel: z.string().nullable().optional(),
	matryokshaEmbedding: z.array(z.number()).nullable().optional(),
	matryokshaEmbeddingModel: z.string().nullable().optional(),

	createdAt: z.coerce.date(),
})
export type Chunk = z.infer<typeof ChunkSchema>

export const ConnectionProviderEnum = z.enum([
	"notion",
	"google-drive",
	"onedrive",
])
export type ConnectionProvider = z.infer<typeof ConnectionProviderEnum>

export const ConnectionStateSchema = z.object({
	stateToken: z.string(),
	provider: ConnectionProviderEnum,
	orgId: z.string(),
	userId: z.string(),
	connectionId: z.string(),
	documentLimit: z.number().default(10000),
	redirectUrl: z.string().nullable().optional(),
	metadata: MetadataSchema,
	containerTags: z.array(z.string()).nullable().optional(),
	createdAt: z.coerce.date(),
	expiresAt: z.coerce.date().nullable().optional(),
})
export type ConnectionState = z.infer<typeof ConnectionStateSchema>

export const ConnectionSchema = z.object({
	id: z.string(),
	provider: ConnectionProviderEnum,
	orgId: z.string(),
	userId: z.string(),
	email: z.string().nullable().optional(),
	documentLimit: z.number().default(10000),
	containerTags: z.array(z.string()).nullable().optional(),

	// Token management
	accessToken: z.string().nullable().optional(),
	refreshToken: z.string().nullable().optional(),
	expiresAt: z.coerce.date().nullable().optional(),

	// Provider-specific metadata
	metadata: z.record(z.unknown()),

	createdAt: z.coerce.date(),
})
export type Connection = z.infer<typeof ConnectionSchema>

export const RequestTypeEnum = z.enum([
	"add",
	"search",
	"fast_search",
	"request",
	"update",
	"delete",
	"chat",
	"search_v4",
])
export type RequestType = z.infer<typeof RequestTypeEnum>

export const ApiRequestSchema = z.object({
	id: z.string(),
	type: RequestTypeEnum,
	orgId: z.string(),
	userId: z.string(),
	keyId: z.string().nullable().optional(),
	statusCode: z.number(),
	duration: z.number().nullable().optional(), // duration in ms

	// Request/Response data
	input: z.record(z.unknown()).nullable().optional(),
	output: z.record(z.unknown()).nullable().optional(),

	// Token usage tracking
	originalTokens: z.number().nullable().optional(),
	finalTokens: z.number().nullable().optional(),
	tokensSaved: z.number().nullable().optional(), // computed field

	// Cost tracking
	costSavedUSD: z.number().nullable().optional(),

	// Chat specific fields
	model: z.string().nullable().optional(),
	provider: z.string().nullable().optional(),
	conversationId: z.string().nullable().optional(),

	// Flags
	contextModified: z.boolean().default(false),

	// Metadata
	metadata: MetadataSchema.nullable().optional(),
	origin: z.string().default("api"),

	createdAt: z.coerce.date(),
})
export type ApiRequest = z.infer<typeof ApiRequestSchema>

export const SpaceSchema = z.object({
	id: z.string(),
	name: z.string().nullable().optional(),
	description: z.string().nullable().optional(),
	orgId: z.string(),
	ownerId: z.string(),
	containerTag: z.string().nullable().optional(),
	visibility: VisibilityEnum.default("private"),
	isExperimental: z.boolean().default(false),

	// Content indexing
	contentTextIndex: z.record(z.unknown()).default({}), // KnowledgeBase type
	indexSize: z.number().nullable().optional(),

	metadata: MetadataSchema.nullable().optional(),

	createdAt: z.coerce.date(),
	updatedAt: z.coerce.date(),
})
export type Space = z.infer<typeof SpaceSchema>

export const MemoryRelationEnum = z.enum(["updates", "extends", "derives"])
export type MemoryRelation = z.infer<typeof MemoryRelationEnum>

export const MemoryEntrySchema = z.object({
	id: z.string(),
	memory: z.string(), // The actual memory content
	spaceId: z.string(),
	orgId: z.string(),
	userId: z.string().nullable().optional(),

	// Version control
	version: z.number().default(1),
	isLatest: z.boolean().default(true),
	parentMemoryId: z.string().nullable().optional(),
	rootMemoryId: z.string().nullable().optional(),

	// Memory relationships
	memoryRelations: z.record(MemoryRelationEnum).default({}),

	// Source tracking
	sourceCount: z.number().default(1),

	// Status flags
	isInference: z.boolean().default(false),
	isForgotten: z.boolean().default(false),
	isStatic: z.boolean().default(false),
	forgetAfter: z.coerce.date().nullable().optional(),
	forgetReason: z.string().nullable().optional(),

	// Embeddings
	memoryEmbedding: z.array(z.number()).nullable().optional(),
	memoryEmbeddingModel: z.string().nullable().optional(),
	memoryEmbeddingNew: z.array(z.number()).nullable().optional(),
	memoryEmbeddingNewModel: z.string().nullable().optional(),

	metadata: z.record(z.unknown()).nullable().optional(),

	createdAt: z.coerce.date(),
	updatedAt: z.coerce.date(),
})
export type MemoryEntry = z.infer<typeof MemoryEntrySchema>

export const DocumentsToSpacesSchema = z.object({
	documentId: z.string(),
	spaceId: z.string(),
})
export type DocumentsToSpaces = z.infer<typeof DocumentsToSpacesSchema>

export const MemoryDocumentSourceSchema = z.object({
	memoryEntryId: z.string(),
	documentId: z.string(),
	relevanceScore: z.number().default(100),
	metadata: z.record(z.unknown()).nullable().optional(),
	addedAt: z.coerce.date(),
})
export type MemoryDocumentSource = z.infer<typeof MemoryDocumentSourceSchema>

export const SpaceRoleEnum = z.enum(["owner", "admin", "editor", "viewer"])
export type SpaceRole = z.infer<typeof SpaceRoleEnum>

export const SpacesToMembersSchema = z.object({
	spaceId: z.string(),
	userId: z.string(),
	role: SpaceRoleEnum.default("viewer"),
	metadata: MetadataSchema.nullable().optional(),
	createdAt: z.coerce.date(),
	updatedAt: z.coerce.date(),
})
export type SpacesToMembers = z.infer<typeof SpacesToMembersSchema>

export const OrganizationSettingsSchema = z.object({
	id: z.string(),
	orgId: z.string(),

	// LLM Filtering
	shouldLLMFilter: z.boolean().default(false),
	filterPrompt: z.string().nullable().optional(),
	includeItems: z.array(z.string()).nullable().optional(),
	excludeItems: z.array(z.string()).nullable().optional(),

	// Google Drive custom keys
	googleDriveCustomKeyEnabled: z.boolean().default(false),
	googleDriveClientId: z.string().nullable().optional(),
	googleDriveClientSecret: z.string().nullable().optional(),

	// Notion custom keys
	notionCustomKeyEnabled: z.boolean().default(false),
	notionClientId: z.string().nullable().optional(),
	notionClientSecret: z.string().nullable().optional(),

	// OneDrive custom keys
	onedriveCustomKeyEnabled: z.boolean().default(false),
	onedriveClientId: z.string().nullable().optional(),
	onedriveClientSecret: z.string().nullable().optional(),

	updatedAt: z.coerce.date(),
})
export type OrganizationSettings = z.infer<typeof OrganizationSettingsSchema>

export const schemas = {
	// Base types
	MetadataSchema,
	VisibilityEnum,

	// Content
	DocumentTypeEnum,
	DocumentStatusEnum,
	ProcessingStepSchema,
	ProcessingMetadataSchema,
	DocumentSchema,
	ChunkTypeEnum,
	ChunkSchema,

	// Connections
	ConnectionProviderEnum,
	ConnectionStateSchema,
	ConnectionSchema,

	// Analytics
	RequestTypeEnum,
	ApiRequestSchema,

	// Spaces and Memory
	SpaceSchema,
	MemoryRelationEnum,
	MemoryEntrySchema,
	DocumentsToSpacesSchema,
	MemoryDocumentSourceSchema,
	SpaceRoleEnum,
	SpacesToMembersSchema,

	// Auth
	OrganizationSettingsSchema,
} as const