Types

The SDK ships its own type definitions. This page lists the types you're likely to write in your own code: config, schema and property definitions, items, the change feed and publish graph, and errors. Event payload types are on Events. The main entry exports many more, mostly for @seedprotocol/react and @seedprotocol/publish; those aren't listed here.

import type { SeedConfig, SchemaFileFormat, IItem } from '@seedprotocol/sdk'

Everything on this page is exported from the main entry, except JsonImportSchema. @seedprotocol/sdk/node re-exports the config, schema and property types, ItemData, IItem, IItemProperty, MultiTabMode, SyncFromEasOptions and HtmlEmbeddedDataUriPolicy, and the error classes below, apart from FileSystemLockedError, UnsupportedBrowserError and DatabaseNotPersistentError (browser only), with the ItemCreateProblem, ItemCreateErrorCode, PublishValidationError and ConflictResult types. It doesn't re-export the event payload types, the change-feed and publish types or PropertyConflict.

Configuration

Schemas and properties

validation takes { pattern?, minLength?, maxLength?, enum?, custom? }; Validation says what each rule does.

SchemaFileInput requires only metadata.name and models. TypeScript rejects the short { name, models } form for config.schema, which has no metadata, although the SDK accepts it at runtime; see The schema file format.

PropertyDataType is a union of string literals, so plain strings type-check. The members of the ModelPropertyDataTypes enum (exported from the main entry only) fit it too:

import type { PropertyType } from '@seedprotocol/sdk'

const authors: PropertyType = {
  dataType: 'List',
  refValueType: 'Relation',
  ref: 'Author',
}

Items

Item is also a class, and Item<any> works as a type for the values Item.create and model.create return.

None of these types know your model's fields, so item.title is a type error although it works at runtime. Item.create and model.create(values) accept any keys besides the built-in fields, so an object literal with property values type-checks. Typing items in TypeScript shows how to describe them yourself.

Change feed and publishing

These types go with read helpers on Querying.

Errors

The SDK's own error classes. Each sets name to the class name, so instanceof and error.name both work.

validationErrors on ItemPropertySaveValidationError holds objects shaped { field: string; message: string; code: string; severity: 'error' | 'warning' }. That's the ValidationError type, a type-only export: import type { ValidationError } from '@seedprotocol/sdk'.

import { FileSystemLockedError, ItemPropertySaveValidationError } from '@seedprotocol/sdk'

function describe(error: unknown): string {
  if (error instanceof FileSystemLockedError) return 'Close other tabs of this app and retry.'
  if (error instanceof ItemPropertySaveValidationError) {
    return error.validationErrors.map((e) => `${e.field}: ${e.message}`).join('\n')
  }
  return String(error)
}

Two more, HtmlEmbeddedDataUriLimitError and HtmlSeedPropertyRefError, come from preparing Html properties for publishing. Most errors elsewhere in the SDK are plain Errors.

A write that fails in the outbox rejects save(), Item.create or destroy() with OutboxOpFailedError (code: 'OUTBOX_OP_FAILED'). Its errorName names the original error's class. For 'RelationTargetError' and 'StagedValueMissingError', cause is an instance of that class (with targets or path), so error.cause instanceof RelationTargetError works; other classes survive only as errorName. All three classes are exported from both entries; see save.

Related

• Client and configuration
• Schema, Model and ModelProperty
• Item and ItemProperty
• Events
• Your first schema