@synergy-client/types 0.1.0

package/README.md

@@ -0,0 +1,41 @@
+# @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
+
+```ts
+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:
+
+```ts
+import { moduleApiDts } from '@synergy-client/types/module-api'
+// monaco.languages.typescript.javascriptDefaults.addExtraLib(moduleApiDts, '...')
+```
+
+## Develop
+
+```bash
+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`):
+
+```bash
+npm version patch
+npm publish
+```

package/dist/index.d.ts

@@ -0,0 +1,195 @@
+export type ViewType = 'list' | 'detail' | 'other' | 'worker' | 'static' | 'select' | 'component' | 'print';
+export interface SortBy {
+    key: string;
+    order: 'asc' | 'desc' | string;
+}
+/** A form element (field, group, table, button, ...). */
+export interface ViewItem {
+    id: string;
+    type: string;
+    name: string;
+    label: string;
+    labelPosition: 'left' | 'top' | 'none';
+    groupType?: 'toolbar' | 'collapsible';
+    tagName?: string;
+    multiType: boolean;
+    multiTypeVariant: 'common' | 'objects';
+    fieldPath: string;
+    fieldTypePath?: string;
+    dataLinked?: boolean;
+    dataPath?: string;
+    defaultValue?: any;
+    fieldType: string;
+    viewAttribute: boolean;
+    ref: null | string;
+    required: boolean;
+    visible: boolean;
+    translate: boolean;
+    newRow: boolean;
+    fieldCols: number;
+    labelCols: number;
+    contentCols: number | null;
+    itemOffset: number;
+    dataType: 'string' | 'integer' | 'decimal' | 'date' | 'enum';
+    dateType: 'date' | 'datetime' | 'time';
+    disabled: boolean;
+    options?: any;
+    format: string | null;
+    filter?: any;
+    switch?: boolean;
+    maxLength: string | null;
+    numberPrecision: string | null;
+    numberScale: string | null;
+    onChange: string | null;
+    placeholder: string | null;
+    icon: string;
+    tooltip?: any;
+    classes: string | null;
+    styles: string | null;
+    inputClasses: string | null;
+    inputStyles: string | null;
+    multiple?: boolean;
+    showTotals?: boolean;
+    usePagination?: boolean;
+    rowsLimit?: number;
+    maxHeight?: number;
+    selectBtn?: boolean;
+    openBtn?: boolean;
+    addBtn?: boolean;
+    attrs: any;
+    /** Nested items (for groups/tables). */
+    items?: ViewItem[];
+}
+/** A view attribute (form-level field, not bound to the object). */
+export interface ViewAttribute {
+    id: string;
+    title: string;
+    name: string;
+    type: 'field' | 'tableField' | 'dynamicTable' | null;
+    dataType: string | null;
+    standard?: boolean;
+    multiType: boolean;
+    multiTypeVariant: 'common' | 'objects';
+    typeOptions?: any;
+    dateType: string;
+    defaultValue?: any;
+    format: string | null;
+    ref: string | string[] | null;
+    lang?: any;
+    tableName?: string | null;
+    childs: ViewAttribute[];
+}
+export interface ViewAttributeTreeItem extends Omit<ViewAttribute, 'id' | 'childs'> {
+    attrId: string;
+    path: string;
+    fullName: string;
+    fullPath: string;
+    fullTitle: string;
+    expanded?: boolean;
+    viewAttribute?: boolean;
+    dependent: boolean;
+    childs: ViewAttributeTreeItem[];
+}
+/** A field of an app object (catalog/document/register). */
+export interface ObjectField {
+    id: string;
+    name: string;
+    title: string;
+    ref: string | string[] | null;
+    lang?: any;
+    type: string | null;
+    filter?: string | null;
+    format?: string | null;
+    primaryKey: boolean;
+    leading: boolean;
+    multiType: boolean;
+    multiTypeVariant: 'common' | 'objects';
+    defaultValue?: any;
+    dbName?: string;
+    dateType?: string;
+    notNull?: boolean;
+    isTablePart: boolean;
+    model?: string;
+    virtual?: boolean;
+    comment?: string | null;
+    typeOptions?: any;
+    fields?: ObjectField[];
+}
+/** A toolbar button/group. */
+export interface ToolbarItem {
+    id: string;
+    title: string;
+    icon?: string | null;
+    presentation: string;
+    variant: string;
+    size: string;
+    disabled: boolean;
+    visible: boolean;
+    systemDisabled: boolean;
+    systemVisible: boolean;
+    hidden: boolean;
+    tooltip?: string;
+    type?: string;
+    click?: (...args: any[]) => any;
+    items?: ToolbarItem[];
+}
+export interface Toolbar {
+    position: string;
+    buttonsPosition: string;
+    classes: string | null;
+    styles: string | null;
+    items: ToolbarItem[];
+    staticItems: ToolbarItem[];
+    commonCommands: ToolbarItem[];
+}
+/** List/table view data (list and select forms). */
+export interface ListViewTable {
+    items: any[];
+    fields: any[];
+    total: number;
+    page: number;
+    limit: number;
+    filters: Record<string, any>;
+    sort: SortBy[];
+    folders: {
+        items: any[];
+        expanded: any[];
+    };
+}
+/** Current route (vue-router). */
+export interface Route {
+    path: string;
+    fullPath: string;
+    name?: string | symbol | null;
+    params: Record<string, any>;
+    query: Record<string, any>;
+    hash: string;
+    meta: Record<string, any>;
+}
+/** Router instance (vue-router). */
+export interface Router {
+    push(to: any): Promise<any>;
+    replace(to: any): Promise<any>;
+    back(): void;
+    forward(): void;
+    go(delta: number): void;
+}
+/** Entity data store (useStore('object'), or a view's `store`). */
+export interface Store {
+    findByPk(payload?: any): Promise<any>;
+    findAll(payload?: any): Promise<any>;
+    count(payload?: any): Promise<number>;
+    create(payload?: any): Promise<any>;
+    createItem(payload?: any): Promise<any>;
+    update(payload?: any): Promise<any>;
+    updateItem(payload?: any): Promise<any>;
+    delete(payload?: any): Promise<any>;
+    deleteItem(payload?: any): Promise<any>;
+    addNewItem(payload?: any): Promise<any>;
+    changeDeletionMark(payload?: any): Promise<any>;
+    getView(): {
+        object: any;
+        attrs: any;
+        objectMeta: any;
+    };
+}

package/dist/index.js

@@ -0,0 +1,4 @@
+// Shared Synergy domain types used by the client and the configurator.
+// Kept self-contained (no external deps) so the same definitions can also be
+// emitted as an ambient .d.ts for the configurator's Monaco IntelliSense.
+export {};

package/dist/module-api.d.ts

@@ -0,0 +1 @@
+export declare const moduleApiDts: string;

package/dist/module-api.js

@@ -0,0 +1 @@
+export const moduleApiDts = "type ViewType = 'list' | 'detail' | 'other' | 'worker' | 'static' | 'select' | 'component' | 'print';\ninterface SortBy {\n    key: string;\n    order: 'asc' | 'desc' | string;\n}\n/** A form element (field, group, table, button, ...). */\ninterface ViewItem {\n    id: string;\n    type: string;\n    name: string;\n    label: string;\n    labelPosition: 'left' | 'top' | 'none';\n    groupType?: 'toolbar' | 'collapsible';\n    tagName?: string;\n    multiType: boolean;\n    multiTypeVariant: 'common' | 'objects';\n    fieldPath: string;\n    fieldTypePath?: string;\n    dataLinked?: boolean;\n    dataPath?: string;\n    defaultValue?: any;\n    fieldType: string;\n    viewAttribute: boolean;\n    ref: null | string;\n    required: boolean;\n    visible: boolean;\n    translate: boolean;\n    newRow: boolean;\n    fieldCols: number;\n    labelCols: number;\n    contentCols: number | null;\n    itemOffset: number;\n    dataType: 'string' | 'integer' | 'decimal' | 'date' | 'enum';\n    dateType: 'date' | 'datetime' | 'time';\n    disabled: boolean;\n    options?: any;\n    format: string | null;\n    filter?: any;\n    switch?: boolean;\n    maxLength: string | null;\n    numberPrecision: string | null;\n    numberScale: string | null;\n    onChange: string | null;\n    placeholder: string | null;\n    icon: string;\n    tooltip?: any;\n    classes: string | null;\n    styles: string | null;\n    inputClasses: string | null;\n    inputStyles: string | null;\n    multiple?: boolean;\n    showTotals?: boolean;\n    usePagination?: boolean;\n    rowsLimit?: number;\n    maxHeight?: number;\n    selectBtn?: boolean;\n    openBtn?: boolean;\n    addBtn?: boolean;\n    attrs: any;\n    /** Nested items (for groups/tables). */\n    items?: ViewItem[];\n}\n/** A view attribute (form-level field, not bound to the object). */\ninterface ViewAttribute {\n    id: string;\n    title: string;\n    name: string;\n    type: 'field' | 'tableField' | 'dynamicTable' | null;\n    dataType: string | null;\n    standard?: boolean;\n    multiType: boolean;\n    multiTypeVariant: 'common' | 'objects';\n    typeOptions?: any;\n    dateType: string;\n    defaultValue?: any;\n    format: string | null;\n    ref: string | string[] | null;\n    lang?: any;\n    tableName?: string | null;\n    childs: ViewAttribute[];\n}\ninterface ViewAttributeTreeItem extends Omit<ViewAttribute, 'id' | 'childs'> {\n    attrId: string;\n    path: string;\n    fullName: string;\n    fullPath: string;\n    fullTitle: string;\n    expanded?: boolean;\n    viewAttribute?: boolean;\n    dependent: boolean;\n    childs: ViewAttributeTreeItem[];\n}\n/** A field of an app object (catalog/document/register). */\ninterface ObjectField {\n    id: string;\n    name: string;\n    title: string;\n    ref: string | string[] | null;\n    lang?: any;\n    type: string | null;\n    filter?: string | null;\n    format?: string | null;\n    primaryKey: boolean;\n    leading: boolean;\n    multiType: boolean;\n    multiTypeVariant: 'common' | 'objects';\n    defaultValue?: any;\n    dbName?: string;\n    dateType?: string;\n    notNull?: boolean;\n    isTablePart: boolean;\n    model?: string;\n    virtual?: boolean;\n    comment?: string | null;\n    typeOptions?: any;\n    fields?: ObjectField[];\n}\n/** A toolbar button/group. */\ninterface ToolbarItem {\n    id: string;\n    title: string;\n    icon?: string | null;\n    presentation: string;\n    variant: string;\n    size: string;\n    disabled: boolean;\n    visible: boolean;\n    systemDisabled: boolean;\n    systemVisible: boolean;\n    hidden: boolean;\n    tooltip?: string;\n    type?: string;\n    click?: (...args: any[]) => any;\n    items?: ToolbarItem[];\n}\ninterface Toolbar {\n    position: string;\n    buttonsPosition: string;\n    classes: string | null;\n    styles: string | null;\n    items: ToolbarItem[];\n    staticItems: ToolbarItem[];\n    commonCommands: ToolbarItem[];\n}\n/** List/table view data (list and select forms). */\ninterface ListViewTable {\n    items: any[];\n    fields: any[];\n    total: number;\n    page: number;\n    limit: number;\n    filters: Record<string, any>;\n    sort: SortBy[];\n    folders: {\n        items: any[];\n        expanded: any[];\n    };\n}\n/** Current route (vue-router). */\ninterface Route {\n    path: string;\n    fullPath: string;\n    name?: string | symbol | null;\n    params: Record<string, any>;\n    query: Record<string, any>;\n    hash: string;\n    meta: Record<string, any>;\n}\n/** Router instance (vue-router). */\ninterface Router {\n    push(to: any): Promise<any>;\n    replace(to: any): Promise<any>;\n    back(): void;\n    forward(): void;\n    go(delta: number): void;\n}\n/** Entity data store (useStore('object'), or a view's `store`). */\ninterface Store {\n    findByPk(payload?: any): Promise<any>;\n    findAll(payload?: any): Promise<any>;\n    count(payload?: any): Promise<number>;\n    create(payload?: any): Promise<any>;\n    createItem(payload?: any): Promise<any>;\n    update(payload?: any): Promise<any>;\n    updateItem(payload?: any): Promise<any>;\n    delete(payload?: any): Promise<any>;\n    deleteItem(payload?: any): Promise<any>;\n    addNewItem(payload?: any): Promise<any>;\n    changeDeletionMark(payload?: any): Promise<any>;\n    getView(): {\n        object: any;\n        attrs: any;\n        objectMeta: any;\n    };\n}";

package/package.json

@@ -0,0 +1,28 @@
+{
+  "name": "@synergy-client/types",
+  "version": "0.1.0",
+  "description": "Shared Synergy domain types (views, attributes, objects, store) used by the client and the configurator.",
+  "type": "module",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    },
+    "./module-api": {
+      "types": "./dist/module-api.d.ts",
+      "import": "./dist/module-api.js"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "tsc -p tsconfig.json && node scripts/gen-module-api.mjs",
+    "prepublishOnly": "npm run build"
+  },
+  "devDependencies": {
+    "typescript": "^5.6.0"
+  }
+}