@monbolc/lowcode-types 2.0.0

package/es/index.js

@@ -0,0 +1,11 @@
+/**
+ * @monbolc/lowcode-types
+ *
+ * Core type definitions for SapuLowcodeEngine.
+ * This package is a pure-types layer (L0) — no runtime side effects, no React imports.
+ *
+ * Versioning follows semver. Bumping a major version means breaking
+ * type signatures; minor means additive types.
+ */
+export {};
+//# sourceMappingURL=index.js.map

package/es/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG"}

package/lib/index.d.ts

@@ -0,0 +1,179 @@
+/**
+ * @monbolc/lowcode-types
+ *
+ * Core type definitions for SapuLowcodeEngine.
+ * This package is a pure-types layer (L0) — no runtime side effects, no React imports.
+ *
+ * Versioning follows semver. Bumping a major version means breaking
+ * type signatures; minor means additive types.
+ */
+/** Globally unique identifier (uuid v4 in practice). */
+export type ID = string;
+/** Human-readable label, never used as identity. */
+export type Label = string;
+/** JSON-compatible value (used in `props` and `data`). */
+export type JSONValue = string | number | boolean | null | JSONValue[] | {
+    [k: string]: JSONValue;
+};
+/** Anything serializable; opaque to the engine. */
+export type Unknown = unknown;
+/** Schema for a single node in the page tree. */
+export interface IPublicTypeNodeSchema {
+    /** Component name (e.g. "Button", "Page", "Div"). */
+    componentName: string;
+    /** Props passed to the component. */
+    props?: Record<string, JSONValue>;
+    /** Child nodes (declarative; engine resolves them at render time). */
+    children?: IPublicTypeNodeSchema[];
+    /** Optional condition: if expression is falsy, node is hidden. */
+    condition?: IPublicTypeNodeData;
+    /** Loop source: bind `item` and `index` to render a list. */
+    loop?: IPublicTypeNodeData;
+    /** Loop iteration variable name. Default: "item". */
+    loopItemName?: string;
+    /** Loop index variable name. Default: "index". */
+    loopIndexName?: string;
+    /** Unique key for diffing. If absent, the engine generates one. */
+    key?: string;
+    /** Free-form metadata; engine preserves it but does not interpret it. */
+    meta?: Record<string, Unknown>;
+}
+/** Inline data: either a literal value or a JS expression. */
+export type IPublicTypeNodeData = {
+    type: 'literal';
+    value: JSONValue; /** compile-time mock value */
+    mock?: JSONValue;
+} | {
+    type: 'expression';
+    value: string; /** compile-time mock */
+    mock?: JSONValue;
+} | {
+    type: 'binding';
+    value: string;
+    mock?: JSONValue;
+};
+/** Root schema for an entire page. */
+export interface IPublicTypeRootSchema extends IPublicTypeNodeSchema {
+    /** File name (e.g. "page.json"). */
+    fileName: string;
+    /** Optional data-source entries scoped to this page. */
+    dataSources?: Record<string, IPublicTypeDataSource>;
+}
+/** Description of a single component registered in the engine. */
+export interface IPublicTypeComponentSchema {
+    /** Component name. Must match `IPublicTypeNodeSchema.componentName`. */
+    componentName: string;
+    /** Display title in the components panel. */
+    title: string;
+    /** Icon URL or inline SVG string. */
+    icon?: string;
+    /** Tag for grouping (e.g. "Layout", "Form"). */
+    category?: string;
+    /** Where this component may be placed. */
+    nestingRule?: IPublicTypeNestingRule;
+    /** Default props applied at insertion time. */
+    initialProps?: Record<string, JSONValue>;
+    /** Property descriptors (rendered in the settings panel). */
+    configure?: IPublicTypeComponentConfigure;
+}
+/** Restrictions on where a component may live. */
+export interface IPublicTypeNestingRule {
+    /** Whitelist of parent component names. Empty = universal. */
+    parentWhitelist?: string[];
+    /** Blacklist of parent component names (overrides whitelist). */
+    parentBlacklist?: string[];
+    /** Whitelist of child component names. Empty = all. */
+    childWhitelist?: string[];
+    /** Blacklist of child component names. */
+    childBlacklist?: string[];
+}
+/** Field configurations for the settings panel. */
+export interface IPublicTypeComponentConfigure {
+    /** Component-level props. */
+    props?: IPublicTypeFieldConfig[];
+    /** Style override panel. */
+    style?: IPublicTypeFieldConfig[];
+    /** Lifecycle events. */
+    events?: IPublicTypeEventConfig[];
+    /** Conditional rendering / looping. */
+    advanced?: IPublicTypeAdvancedConfig;
+}
+export interface IPublicTypeFieldConfig {
+    /** Prop name in `IPublicTypeNodeSchema.props`. */
+    name: string;
+    /** Display title in the panel. */
+    title: string;
+    /** Editor kind. */
+    setter: string | IPublicTypeSetterConfig;
+    /** Whether the prop is required. */
+    required?: boolean;
+    /** Default value if user does not provide one. */
+    defaultValue?: JSONValue;
+    /** Free-form extra config (e.g. min/max, options, regex). */
+    extraProps?: Record<string, Unknown>;
+}
+export interface IPublicTypeSetterConfig {
+    /** Settler component name. */
+    componentName: string;
+    /** Props forwarded to the setter. */
+    props?: Record<string, Unknown>;
+}
+export interface IPublicTypeEventConfig {
+    /** Event name (e.g. "onClick"). */
+    name: string;
+    /** Display title. */
+    title: string;
+    /** Default action payload. */
+    defaultAction?: IPublicTypeActionContent;
+}
+export interface IPublicTypeAdvancedConfig {
+    /** Show "v-if"-style condition editor. */
+    condition?: boolean;
+    /** Show loop editor. */
+    loop?: boolean;
+}
+export type IPublicTypeActionContent = {
+    type: 'method';
+    value: string; /** mock */
+    mock?: JSONValue;
+} | {
+    type: 'link';
+    value: string;
+} | {
+    type: 'script';
+    value: string;
+    mock?: JSONValue;
+};
+export interface IPublicTypeDataSource {
+    /** Unique id within the schema. */
+    id: ID;
+    /** Display label. */
+    title?: string;
+    /** Request handler id registered in the engine. */
+    handler: string;
+    /** Initial request options. */
+    options?: Record<string, JSONValue>;
+    /** Path into the response to extract the data array. */
+    dataHandler?: string;
+}
+export interface IPublicEngineOptions {
+    /** Root DOM container. */
+    container: HTMLElement | string;
+    /** Initial root schema. */
+    schema?: IPublicTypeRootSchema;
+    /** Registered component schemas (key = componentName). */
+    components?: Record<string, IPublicTypeComponentSchema>;
+    /** Theme: "light" | "dark" | custom CSS object. */
+    theme?: 'light' | 'dark' | Record<string, string>;
+}
+export interface IPublicApiEngine {
+    /** Mount the engine into the container. */
+    init(options: IPublicEngineOptions): Promise<void>;
+    /** Tear down and unmount. */
+    destroy(): Promise<void>;
+    /** Save current page schema. */
+    saveSchema(): IPublicTypeRootSchema;
+    /** Hot-swap the schema (used for live preview). */
+    loadSchema(schema: IPublicTypeRootSchema): void;
+}
+//# sourceMappingURL=index.d.ts.map

package/lib/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAIH,wDAAwD;AACxD,MAAM,MAAM,EAAE,GAAG,MAAM,CAAC;AAExB,oDAAoD;AACpD,MAAM,MAAM,KAAK,GAAG,MAAM,CAAC;AAE3B,0DAA0D;AAC1D,MAAM,MAAM,SAAS,GACjB,MAAM,GACN,MAAM,GACN,OAAO,GACP,IAAI,GACJ,SAAS,EAAE,GACX;IAAE,CAAC,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;CAAE,CAAC;AAE/B,mDAAmD;AACnD,MAAM,MAAM,OAAO,GAAG,OAAO,CAAC;AAI9B,iDAAiD;AACjD,MAAM,WAAW,qBAAqB;IACpC,qDAAqD;IACrD,aAAa,EAAE,MAAM,CAAC;IAEtB,qCAAqC;IACrC,KAAK,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC;IAElC,sEAAsE;IACtE,QAAQ,CAAC,EAAE,qBAAqB,EAAE,CAAC;IAEnC,kEAAkE;IAClE,SAAS,CAAC,EAAE,mBAAmB,CAAC;IAEhC,6DAA6D;IAC7D,IAAI,CAAC,EAAE,mBAAmB,CAAC;IAE3B,qDAAqD;IACrD,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB,kDAAkD;IAClD,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB,mEAAmE;IACnE,GAAG,CAAC,EAAE,MAAM,CAAC;IAEb,yEAAyE;IACzE,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CAChC;AAED,8DAA8D;AAC9D,MAAM,MAAM,mBAAmB,GAC3B;IAAE,IAAI,EAAE,SAAS,CAAC;IAAC,KAAK,EAAE,SAAS,CAAC,CAAC,8BAA8B;IAAC,IAAI,CAAC,EAAE,SAAS,CAAA;CAAE,GACtF;IAAE,IAAI,EAAE,YAAY,CAAC;IAAC,KAAK,EAAE,MAAM,CAAC,CAAC,wBAAwB;IAAC,IAAI,CAAC,EAAE,SAAS,CAAA;CAAE,GAChF;IAAE,IAAI,EAAE,SAAS,CAAC;IAAC,KAAK,EAAE,MAAM,CAAC;IAAC,IAAI,CAAC,EAAE,SAAS,CAAA;CAAE,CAAC;AAEzD,sCAAsC;AACtC,MAAM,WAAW,qBAAsB,SAAQ,qBAAqB;IAClE,oCAAoC;IACpC,QAAQ,EAAE,MAAM,CAAC;IAEjB,wDAAwD;IACxD,WAAW,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,qBAAqB,CAAC,CAAC;CACrD;AAID,kEAAkE;AAClE,MAAM,WAAW,0BAA0B;IACzC,wEAAwE;IACxE,aAAa,EAAE,MAAM,CAAC;IAEtB,6CAA6C;IAC7C,KAAK,EAAE,MAAM,CAAC;IAEd,qCAAqC;IACrC,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd,gDAAgD;IAChD,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB,0CAA0C;IAC1C,WAAW,CAAC,EAAE,sBAAsB,CAAC;IAErC,+CAA+C;IAC/C,YAAY,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC;IAEzC,6DAA6D;IAC7D,SAAS,CAAC,EAAE,6BAA6B,CAAC;CAC3C;AAED,kDAAkD;AAClD,MAAM,WAAW,sBAAsB;IACrC,8DAA8D;IAC9D,eAAe,CAAC,EAAE,MAAM,EAAE,CAAC;IAE3B,iEAAiE;IACjE,eAAe,CAAC,EAAE,MAAM,EAAE,CAAC;IAE3B,uDAAuD;IACvD,cAAc,CAAC,EAAE,MAAM,EAAE,CAAC;IAE1B,0CAA0C;IAC1C,cAAc,CAAC,EAAE,MAAM,EAAE,CAAC;CAC3B;AAED,mDAAmD;AACnD,MAAM,WAAW,6BAA6B;IAC5C,6BAA6B;IAC7B,KAAK,CAAC,EAAE,sBAAsB,EAAE,CAAC;IAEjC,4BAA4B;IAC5B,KAAK,CAAC,EAAE,sBAAsB,EAAE,CAAC;IAEjC,wBAAwB;IACxB,MAAM,CAAC,EAAE,sBAAsB,EAAE,CAAC;IAElC,uCAAuC;IACvC,QAAQ,CAAC,EAAE,yBAAyB,CAAC;CACtC;AAED,MAAM,WAAW,sBAAsB;IACrC,kDAAkD;IAClD,IAAI,EAAE,MAAM,CAAC;IAEb,kCAAkC;IAClC,KAAK,EAAE,MAAM,CAAC;IAEd,mBAAmB;IACnB,MAAM,EAAE,MAAM,GAAG,uBAAuB,CAAC;IAEzC,oCAAoC;IACpC,QAAQ,CAAC,EAAE,OAAO,CAAC;IAEnB,kDAAkD;IAClD,YAAY,CAAC,EAAE,SAAS,CAAC;IAEzB,6DAA6D;IAC7D,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACtC;AAED,MAAM,WAAW,uBAAuB;IACtC,8BAA8B;IAC9B,aAAa,EAAE,MAAM,CAAC;IAEtB,qCAAqC;IACrC,KAAK,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACjC;AAED,MAAM,WAAW,sBAAsB;IACrC,mCAAmC;IACnC,IAAI,EAAE,MAAM,CAAC;IAEb,qBAAqB;IACrB,KAAK,EAAE,MAAM,CAAC;IAEd,8BAA8B;IAC9B,aAAa,CAAC,EAAE,wBAAwB,CAAC;CAC1C;AAED,MAAM,WAAW,yBAAyB;IACxC,0CAA0C;IAC1C,SAAS,CAAC,EAAE,OAAO,CAAC;IAEpB,wBAAwB;IACxB,IAAI,CAAC,EAAE,OAAO,CAAC;CAChB;AAID,MAAM,MAAM,wBAAwB,GAChC;IAAE,IAAI,EAAE,QAAQ,CAAC;IAAC,KAAK,EAAE,MAAM,CAAC,CAAC,WAAW;IAAC,IAAI,CAAC,EAAE,SAAS,CAAA;CAAE,GAC/D;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,KAAK,EAAE,MAAM,CAAA;CAAE,GAC/B;IAAE,IAAI,EAAE,QAAQ,CAAC;IAAC,KAAK,EAAE,MAAM,CAAC;IAAC,IAAI,CAAC,EAAE,SAAS,CAAA;CAAE,CAAC;AAIxD,MAAM,WAAW,qBAAqB;IACpC,mCAAmC;IACnC,EAAE,EAAE,EAAE,CAAC;IAEP,qBAAqB;IACrB,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf,mDAAmD;IACnD,OAAO,EAAE,MAAM,CAAC;IAEhB,+BAA+B;IAC/B,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC;IAEpC,wDAAwD;IACxD,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAID,MAAM,WAAW,oBAAoB;IACnC,0BAA0B;IAC1B,SAAS,EAAE,WAAW,GAAG,MAAM,CAAC;IAEhC,2BAA2B;IAC3B,MAAM,CAAC,EAAE,qBAAqB,CAAC;IAE/B,0DAA0D;IAC1D,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,0BAA0B,CAAC,CAAC;IAExD,mDAAmD;IACnD,KAAK,CAAC,EAAE,OAAO,GAAG,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CACnD;AAID,MAAM,WAAW,gBAAgB;IAC/B,2CAA2C;IAC3C,IAAI,CAAC,OAAO,EAAE,oBAAoB,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEnD,6BAA6B;IAC7B,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAEzB,gCAAgC;IAChC,UAAU,IAAI,qBAAqB,CAAC;IAEpC,mDAAmD;IACnD,UAAU,CAAC,MAAM,EAAE,qBAAqB,GAAG,IAAI,CAAC;CACjD"}

package/lib/index.js

@@ -0,0 +1,11 @@
+/**
+ * @monbolc/lowcode-types
+ *
+ * Core type definitions for SapuLowcodeEngine.
+ * This package is a pure-types layer (L0) — no runtime side effects, no React imports.
+ *
+ * Versioning follows semver. Bumping a major version means breaking
+ * type signatures; minor means additive types.
+ */
+export {};
+//# sourceMappingURL=index.js.map

package/lib/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG"}

package/package.json

@@ -0,0 +1,43 @@
+{
+  "name": "@monbolc/lowcode-types",
+  "version": "2.0.0",
+  "description": "Core type definitions for SapuLowcodeEngine",
+  "license": "MIT",
+  "main": "lib/index.js",
+  "module": "es/index.js",
+  "types": "lib/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./lib/index.d.ts",
+      "import": "./es/index.js",
+      "require": "./lib/index.js"
+    }
+  },
+  "files": [
+    "lib",
+    "es"
+  ],
+  "scripts": {
+    "build": "tsc -p tsconfig.json",
+    "build:es": "tsc -p tsconfig.esm.json",
+    "clean": "rimraf lib es"
+  },
+  "devDependencies": {
+    "rimraf": "^5.0.5",
+    "typescript": "^5.4.5"
+  },
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git@github.com:monbolc/sapu-lowcode-engine.git",
+    "directory": "packages/types"
+  },
+  "keywords": [
+    "lowcode",
+    "engine",
+    "types"
+  ]
+}