ObjectStackDocument
Document protocol schemas
Document Version Schema
Represents a single version of a document in a version-controlled system. Each version is immutable and maintains its own metadata and download URL.
@example
{
"versionNumber": 2,
"createdAt": 1704067200000,
"createdBy": "user_123",
"size": 2048576,
"checksum": "a1b2c3d4e5f6",
"downloadUrl": "https://storage.example.com/docs/v2/file.pdf",
"isLatest": true
}Source: packages/spec/src/data/document.zod.ts
TypeScript Usage
import { DocumentSchema, DocumentTemplateSchema, DocumentVersionSchema, ESignatureConfigSchema } from '@objectstack/spec/data';
import type { Document, DocumentTemplate, DocumentVersion, ESignatureConfig } from '@objectstack/spec/data';
// Validate data
const result = DocumentSchema.parse(data);Document
Properties
| Property | Type | Required | Description |
|---|---|---|---|
| id | string | ✅ | Document ID |
| name | string | ✅ | Document name |
| description | string | optional | Document description |
| fileType | string | ✅ | File MIME type |
| fileSize | number | ✅ | File size in bytes |
| category | string | optional | Document category |
| tags | string[] | optional | Document tags |
| versioning | { enabled: boolean; versions: object[]; majorVersion: number; minorVersion: number } | optional | Version control |
| template | { id: string; name: string; description?: string; fileUrl: string; … } | optional | Document template |
| eSignature | { provider: Enum<'docusign' | 'adobe-sign' | 'hellosign' | 'custom'>; enabled: boolean; signers: object[]; expirationDays: number; … } | optional | E-signature config |
| access | { isPublic: boolean; sharedWith?: string[]; expiresAt?: number } | optional | Access control |
| metadata | Record<string, any> | optional | Custom metadata |
DocumentTemplate
Properties
| Property | Type | Required | Description |
|---|---|---|---|
| id | string | ✅ | Template ID |
| name | string | ✅ | Template name |
| description | string | optional | Template description |
| fileUrl | string | ✅ | Template file URL |
| fileType | string | ✅ | File MIME type |
| placeholders | { key: string; label: string; type: Enum<'text' | 'number' | 'date' | 'image'>; required: boolean }[] | ✅ | Template placeholders |
DocumentVersion
Properties
| Property | Type | Required | Description |
|---|---|---|---|
| versionNumber | number | ✅ | Version number |
| createdAt | number | ✅ | Creation timestamp |
| createdBy | string | ✅ | Creator user ID |
| size | number | ✅ | File size in bytes |
| checksum | string | ✅ | File checksum |
| downloadUrl | string | ✅ | Download URL |
| isLatest | boolean | ✅ | Is latest version |
ESignatureConfig
Properties
| Property | Type | Required | Description |
|---|---|---|---|
| provider | Enum<'docusign' | 'adobe-sign' | 'hellosign' | 'custom'> | ✅ | E-signature provider |
| enabled | boolean | ✅ | E-signature enabled |
| signers | { email: string; name: string; role: string; order: number }[] | ✅ | Document signers |
| expirationDays | number | ✅ | Expiration days |
| reminderDays | number | ✅ | Reminder interval days |