@dforge-core/dforge-mcp 0.1.0-rc.1 → 0.1.0-rc.11

package/resources/schemas/{data-view.schema.json → data-views.schema.json}

@@ -38,7 +38,8 @@
 					"description": "Data sources providing data for this view"
 				},
 				"filter": {
-					"description": "Default filter criteria"
+					"$ref": "#/$defs/filter",
+					"description": "Default filter criteria (applied to all dataSources unless one declares its own)"
 				},
 				"order": {
 					"description": "Default sort order"
@@ -291,6 +292,56 @@
 				"parentSetField": {
 					"type": "string",
 					"description": "Set field name on parent entity linking to this detail level"
+				},
+				"filter": {
+					"$ref": "#/$defs/filter",
+					"description": "Per-source filter criteria; overrides the view-level filter for this source"
+				},
+				"order": {
+					"description": "Per-source sort order (array of {c, d} entries, where d is 'asc' or 'desc')"
+				}
+			},
+			"additionalProperties": false
+		},
+
+		"filter": {
+			"description": "Canonical dForge filter expression. Either a single condition `{c, o, v}` or a group `{g, i: [...]}`. Used by data views, reports, folders (row-level security), and the API.",
+			"oneOf": [
+				{ "$ref": "#/$defs/filterCondition" },
+				{ "$ref": "#/$defs/filterGroup" }
+			]
+		},
+		"filterCondition": {
+			"type": "object",
+			"required": ["c", "o"],
+			"properties": {
+				"c": {
+					"type": "string",
+					"description": "Column code (supports dot navigation: 'customer.name')"
+				},
+				"o": {
+					"type": "string",
+					"description": "Operator: eq, neq, =, !=, gt, gtEq, grEq, lt, ltEq, in, nIn, like, isNull, isNotNull, etc."
+				},
+				"v": {
+					"description": "Comparison value. Scalars, arrays (for in/nIn), or parameter references like '@param_code'."
+				}
+			},
+			"additionalProperties": false
+		},
+		"filterGroup": {
+			"type": "object",
+			"required": ["g", "i"],
+			"properties": {
+				"g": {
+					"type": "string",
+					"enum": ["and", "or"],
+					"description": "Group combinator"
+				},
+				"i": {
+					"type": "array",
+					"items": { "$ref": "#/$defs/filter" },
+					"description": "Group items: nested conditions or sub-groups"
 				}
 			},
 			"additionalProperties": false

package/resources/schemas/entity.schema.json

@@ -33,8 +33,7 @@
 			"description": "SQL SELECT statement for view-backed entities (isView=true). Executed as CREATE OR REPLACE VIEW during module install."
 		},
 		"toString": {
-			"type": "string",
-			"description": "Display pattern using column placeholders, e.g. \"{first_name} {last_name}\""
+			"description": "Display pattern using column placeholders, e.g. \"{first_name} {last_name}\". Optional in extension entities (with `extends`). No `type` constraint here because `toString` collides with Object.prototype.toString in JSON validators — they read the inherited function and reject it, even when the property is absent from the JSON."
 		},
 		"traits": {
 			"type": "array",

package/resources/schemas/folders.schema.json

@@ -0,0 +1,108 @@
+{
+	"$schema": "http://json-schema.org/draft-07/schema#",
+	"$id": "https://dforge.dev/schemas/folders.schema.json",
+	"title": "dForge Folders",
+	"description": "Folder tree for a dForge module. The file IS the root folder (not a map keyed by code). Sub-folders live under `children`, keyed by folder code.",
+	"$ref": "#/$defs/folder",
+	"$defs": {
+		"folder": {
+			"type": "object",
+			"properties": {
+				"label": {
+					"type": "string",
+					"description": "Folder display name"
+				},
+				"description": {
+					"type": "string",
+					"description": "Optional description text (shown in breadcrumb / header area)"
+				},
+				"parentCode": {
+					"type": ["string", "null"],
+					"description": "Parent folder code. Usually omitted: nested folders go under `children` of their parent. Only used by sparse-tree imports."
+				},
+				"folderPath": {
+					"type": "string",
+					"description": "URL-friendly folder path override"
+				},
+				"color": {
+					"type": "string",
+					"description": "Folder accent color (hex, e.g. '#2196F3')"
+				},
+				"icon": {
+					"type": "string",
+					"description": "Bootstrap icon class (e.g. 'bi-folder')"
+				},
+				"inheritSecurity": {
+					"type": "boolean",
+					"description": "Whether to inherit security rights from the parent folder. Default: true."
+				},
+				"entities": {
+					"type": "object",
+					"description": "Entity code → folder-entity binding (which view to show, quick-add, row-level filter).",
+					"additionalProperties": {
+						"$ref": "#/$defs/folderEntity"
+					}
+				},
+				"children": {
+					"type": "object",
+					"description": "Nested folders keyed by sub-folder code. Recursive — children can have their own children.",
+					"additionalProperties": {
+						"$ref": "#/$defs/folder"
+					}
+				}
+			},
+			"additionalProperties": false
+		},
+		"folderEntity": {
+			"type": "object",
+			"properties": {
+				"viewName": {
+					"type": "string",
+					"description": "Entity view name (data view code) to use in this folder. Common values include 'default'."
+				},
+				"quickAdd": {
+					"type": "boolean",
+					"description": "Enable the quick-add (+) button for this entity in this folder"
+				},
+				"rowFilter": {
+					"description": "Row-level filter. Either a SQL expression string (e.g. \"is_customer = true\") or a canonical filter object (`{c,o,v}` for one condition, `{g,i:[]}` for a group).",
+					"oneOf": [
+						{ "type": "string" },
+						{ "$ref": "#/$defs/filter" }
+					]
+				}
+			},
+			"additionalProperties": false
+		},
+
+		"filter": {
+			"description": "Canonical dForge filter expression — same shape as in data_views.json. Either `{c, o, v}` or `{g, i: [...]}`.",
+			"oneOf": [
+				{ "$ref": "#/$defs/filterCondition" },
+				{ "$ref": "#/$defs/filterGroup" }
+			]
+		},
+		"filterCondition": {
+			"type": "object",
+			"required": ["c", "o"],
+			"properties": {
+				"c": { "type": "string" },
+				"o": { "type": "string" },
+				"v": {}
+			},
+			"additionalProperties": false
+		},
+		"filterGroup": {
+			"type": "object",
+			"required": ["g", "i"],
+			"properties": {
+				"g": { "type": "string", "enum": ["and", "or"] },
+				"i": {
+					"type": "array",
+					"items": { "$ref": "#/$defs/filter" }
+				}
+			},
+			"additionalProperties": false
+		}
+	}
+}

package/resources/schemas/jobs.schema.json

@@ -0,0 +1,83 @@
+{
+	"$schema": "https://json-schema.org/draft/2020-12/schema",
+	"title": "dForge Module Scheduled Jobs",
+	"description": "Cron job declarations for a dForge module package (logic/jobs.json). The dForge.Scheduler service polls these and fires each job on its schedule.",
+	"type": "object",
+	"required": ["jobs"],
+	"properties": {
+		"jobs": {
+			"type": "array",
+			"maxItems": 50,
+			"description": "At most 50 jobs per module — guard against accidental fan-out from generated declarations.",
+			"items": {
+				"type": "object",
+				"required": ["code", "action", "schedule", "timeout"],
+				"properties": {
+					"code": {
+						"type": "string",
+						"maxLength": 100,
+						"pattern": "^[a-z][a-z0-9_]*$",
+						"description": "Unique identifier within the module."
+					},
+					"description": {
+						"type": "string",
+						"description": "Human-readable description of what the job does."
+					},
+					"action": {
+						"type": "string",
+						"description": "Action code in this module (e.g. 'generate_invoices'). The scheduler resolves it to action_implementation.impl_id at install time."
+					},
+					"schedule": {
+						"type": "string",
+						"description": "Five-field cron expression (minute granularity). Sub-minute schedules are rejected.",
+						"pattern": "^\\S+\\s+\\S+\\s+\\S+\\s+\\S+\\s+\\S+$"
+					},
+					"params": {
+						"type": "object",
+						"description": "Static parameters passed to the action as __params. Folder-scoped overrides go through module settings, not here.",
+						"additionalProperties": true
+					},
+					"timeout": {
+						"type": "integer",
+						"minimum": 1,
+						"maximum": 3600,
+						"description": "Hard timeout in seconds. Required — there is no implicit default. Must be > 300 only if class = 'long_running' (60-minute hard ceiling)."
+					},
+					"concurrency": {
+						"type": "integer",
+						"minimum": 1,
+						"maximum": 5,
+						"default": 1,
+						"description": "Max parallel runs. 1 means single-instance; the scheduler skips a new fire if a previous one is still in flight (Phase 3 enforcement)."
+					},
+					"idempotencyKey": {
+						"type": "string",
+						"description": "Template like '{job_cd}:{run.month}'. Resolved at fire time. A successful run with the same key blocks re-dispatch (Phase 3 enforcement)."
+					},
+					"class": {
+						"type": "string",
+						"enum": ["standard", "long_running"],
+						"default": "standard",
+						"description": "Routing class. 'long_running' is opt-in and required for any timeout > 300 seconds."
+					},
+					"timeZone": {
+						"type": "string",
+						"description": "IANA tz name (e.g. 'Asia/Tokyo'). Overrides the tenant default. Omit to fall back to auth.tenant.time_zone."
+					},
+					"enabled": {
+						"type": "boolean",
+						"default": true,
+						"description": "Master switch. False fully disables (no scheduler, no manual trigger)."
+					},
+					"paused": {
+						"type": "boolean",
+						"default": false,
+						"description": "Soft pause. Scheduler skips firing, but admin 'trigger now' still works."
+					}
+				},
+				"additionalProperties": false
+			}
+		}
+	},
+	"additionalProperties": false
+}

package/resources/schemas/manifest.schema.json

@@ -21,6 +21,12 @@
 			"pattern": "^[a-z][a-z0-9_-]*$",
 			"description": "Human-readable module code (becomes schema name and module_cd in DB)"
 		},
+		"kind": {
+			"type": "string",
+			"enum": ["module", "pack"],
+			"default": "module",
+			"description": "Package kind. 'module' (default) — a regular module with its own entities/views/actions. 'pack' — a dependency bundle: installs a curated set of other modules via `dependencies` in order, owns no entities itself."
+		},
 		"version": {
 			"type": "string",
 			"pattern": "^\\d+\\.\\d+\\.\\d+",
@@ -68,12 +74,37 @@
 		},
 		"dependencies": {
 			"type": "object",
-			"description": "Module dependencies: module code → semver range",
+			"description": "Module dependencies: module code → semver range OR { version, entities? } object for partial deps that only import specific entities from the dependency.",
 			"additionalProperties": {
-				"type": "string",
-				"description": "Semver version range (e.g. '>=1.0.0')"
+				"oneOf": [
+					{
+						"type": "string",
+						"description": "Semver version range (e.g. '>=1.0.0')"
+					},
+					{
+						"type": "object",
+						"required": ["version"],
+						"properties": {
+							"version": {
+								"type": "string",
+								"description": "Semver version range"
+							},
+							"entities": {
+								"type": "array",
+								"items": { "type": "string" },
+								"description": "Entity codes from the dependency that this module needs. If omitted, all entities are accessible."
+							}
+						},
+						"additionalProperties": false
+					}
+				]
 			}
 		},
+		"auditHistory": {
+			"type": "string",
+			"enum": ["none", "minimal", "full"],
+			"description": "Default audit history mode for entities in this module ('full' captures every field change; 'minimal' captures only inserts/deletes; 'none' disables). Individual entities can override."
+		},
 		"entities": {
 			"type": "object",
 			"description": "Entity definitions and extensions: entity code → relative path to entity JSON file. Dotted keys (e.g. 'fin.invoice') indicate extensions of other modules' entities (the entity file must have an 'extends' property).",
@@ -86,6 +117,11 @@
 			"type": "string",
 			"description": "Module category for display (e.g. 'Integration', 'Finance')"
 		},
+		"tags": {
+			"type": "array",
+			"items": { "type": "string" },
+			"description": "Free-form tags for search and discovery (e.g. ['crm', 'sales', 'leads']). Convention: lowercase, hyphen-separated."
+		},
 		"icon": {
 			"type": "string",
 			"description": "Bootstrap icon class (e.g. 'bi-link-45deg')"
@@ -94,6 +130,16 @@
 			"type": "array",
 			"items": { "type": "string", "pattern": "^[a-z]{2,3}(-[A-Z]{2})?$" },
 			"description": "Non-English locales the package promises to translate. Each entry MUST match a translations/<locale>.json file, and every translatable resource (entity/field labels, folders, views, menus + items, actions + params, reports + datasets + params, settings) MUST have a label in that file. English is the default — don't list 'en' or 'en-US'."
+		},
+		"created": {
+			"type": "string",
+			"format": "date",
+			"description": "Initial creation date of the module package (YYYY-MM-DD). Informational only; not enforced by the installer."
+		},
+		"updated": {
+			"type": "string",
+			"format": "date",
+			"description": "Last edit date of the manifest (YYYY-MM-DD). Informational; bump when shipping a new version."
 		}
 	},
 	"additionalProperties": false

package/resources/schemas/menus.schema.json

@@ -0,0 +1,86 @@
+{
+	"$schema": "http://json-schema.org/draft-07/schema#",
+	"$id": "https://dforge.dev/schemas/menus.schema.json",
+	"title": "dForge Menus",
+	"description": "Menu definitions for a dForge module",
+	"type": "object",
+	"additionalProperties": {
+		"$ref": "#/$defs/menu"
+	},
+	"$defs": {
+		"menu": {
+			"type": "object",
+			"required": ["label", "items"],
+			"properties": {
+				"label": {
+					"type": "string",
+					"description": "Menu display name"
+				},
+				"description": {
+					"type": "string",
+					"description": "Optional description text (tooltip, subtitle)"
+				},
+				"folders": {
+					"type": "array",
+					"items": { "type": "string" },
+					"description": "Folder codes where this menu is available"
+				},
+				"items": {
+					"type": "object",
+					"description": "Menu items keyed by item code",
+					"additionalProperties": {
+						"$ref": "#/$defs/menuItem"
+					}
+				}
+			},
+			"additionalProperties": false
+		},
+		"menuItem": {
+			"type": "object",
+			"required": ["label"],
+			"properties": {
+				"itemType": {
+					"type": ["string", "null"],
+					"enum": ["V", "D", "R", null],
+					"description": "Item type: V=Data View, D=Document, R=Report, null=folder/section"
+				},
+				"dataViewCode": {
+					"type": "string",
+					"description": "Data view code (when itemType is 'V')"
+				},
+				"documentCode": {
+					"type": "string",
+					"description": "Document code (when itemType is 'D')"
+				},
+				"reportCode": {
+					"type": "string",
+					"description": "Report code (when itemType is 'R')"
+				},
+				"orderNum": {
+					"type": "integer",
+					"description": "Display order"
+				},
+				"label": {
+					"type": "string",
+					"description": "Menu item display text"
+				},
+				"description": {
+					"type": "string",
+					"description": "Optional description text (tooltip, subtitle)"
+				},
+				"icon": {
+					"type": "string",
+					"description": "Bootstrap icon name"
+				},
+				"children": {
+					"type": "object",
+					"description": "Child menu items (for folder/section items)",
+					"additionalProperties": {
+						"$ref": "#/$defs/menuItem"
+					}
+				}
+			},
+			"additionalProperties": false
+		}
+	}
+}

package/resources/schemas/print-templates.schema.json

@@ -0,0 +1,82 @@
+{
+	"$schema": "https://json-schema.org/draft/2020-12/schema",
+	"title": "dForge Module Print Templates",
+	"description": "Print template declarations for a dForge module package (ui/print_templates.json). Each key is the template_cd; the value declares either a printable template (default) or a reusable snippet pulled into other templates via {% include 'module_cd.snippet_cd' %}.",
+	"type": "object",
+	"additionalProperties": {
+		"type": "object",
+		"properties": {
+			"type": {
+				"type": "string",
+				"enum": ["template", "snippet"],
+				"default": "template",
+				"description": "'template' (default) — a full printable form bound to an entity. 'snippet' — a reusable Liquid partial, module-scoped, no entity binding, included from other templates."
+			},
+			"entityCd": {
+				"type": "string",
+				"description": "Entity code this template renders. Required when type='template'; ignored when type='snippet'. Cross-module form 'module.entity' is supported (e.g. fin-ch ships a template for fin.invoice)."
+			},
+			"description": {
+				"type": "string",
+				"description": "Human-readable label shown in the print menu."
+			},
+			"template": {
+				"type": "string",
+				"description": "Inline Liquid HTML. Either 'template' or 'file' must be set; 'file' takes precedence when both are present."
+			},
+			"file": {
+				"type": "string",
+				"description": "Relative path under the module's print_templates/ directory (e.g. 'invoice.html'). Loaded at install time."
+			},
+			"css": {
+				"type": "string",
+				"description": "Inline CSS, or a filename ending in .css (resolved relative to print_templates/). Snippets typically inherit CSS from the host template and omit this."
+			},
+			"pageSettings": {
+				"type": "object",
+				"description": "Default page geometry applied when the user prints from the UI. Stored as jsonb on the row; the editor lets users tweak per-template.",
+				"properties": {
+					"size": {
+						"type": "string",
+						"enum": ["A4", "letter", "legal"],
+						"default": "A4"
+					},
+					"orientation": {
+						"type": "string",
+						"enum": ["portrait", "landscape"],
+						"default": "portrait"
+					},
+					"margins": {
+						"type": "object",
+						"properties": {
+							"top":    { "type": "string", "description": "CSS length, e.g. '15mm'." },
+							"right":  { "type": "string" },
+							"bottom": { "type": "string" },
+							"left":   { "type": "string" }
+						},
+						"additionalProperties": false
+					}
+				},
+				"additionalProperties": false
+			}
+		},
+		"additionalProperties": false,
+		"allOf": [
+			{
+				"if": { "properties": { "type": { "const": "snippet" } }, "required": ["type"] },
+				"then": {
+					"description": "Snippets must not declare entityCd and their template_cd must not contain '.' (collides with {% include 'module_cd.snippet_cd' %})."
+				},
+				"else": {
+					"required": ["entityCd"]
+				}
+			},
+			{
+				"anyOf": [
+					{ "required": ["file"] },
+					{ "required": ["template"] }
+				]
+			}
+		]
+	}
+}