@synergy-client/types

Shared Synergy domain types (views, attributes, objects, store) used by the client and the configurator — a single source of truth for types that were previously duplicated in each app.

Usage

import type { ViewItem, ViewAttribute, ListViewTable, Store } from '@synergy-client/types'

Module-API declarations (for editors)

The same types are also emitted as a single ambient .d.ts string, for embedding into a Monaco editor (the configurator's module editor) or a future VS Code extension that highlights the context of saved Synergy modules:

import { moduleApiDts } from '@synergy-client/types/module-api'
// monaco.languages.typescript.javascriptDefaults.addExtraLib(moduleApiDts, '...')

Develop

npm install
npm run build        # tsc -> dist + generates dist/module-api.js
npm link             # to consume locally from the client / configurator

In a consumer: npm link @synergy-client/types.

Publish

Same flow as the other Synergy packages (registry configured in your .npmrc):

npm version patch
npm publish