@dforge-core/metadata 0.0.54 → 0.0.56

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dforge-core/metadata",
-  "version": "0.0.54",
+  "version": "0.0.56",
   "description": "Canonical dForge authoring registries — field types, base datatypes, column types, traits, data-view kinds and chart types — with derivation helpers. Runtime-dependency-free; the single source of truth shared by editors, the web app and the CLI.",
   "license": "MIT",
   "author": "dForge",

package/schemas/export_templates.schema.json

@@ -0,0 +1,25 @@
+{
+	"$schema": "https://json-schema.org/draft/2020-12/schema",
+	"title": "dForge Module Export Templates",
+	"description": "Excel export template declarations for a dForge module package (ui/export_templates.json). Each key is the template_cd; the value binds an .xlsx file under export_templates/ to an entity. A user picks it from the grid's Export menu, and data.export with that template pours the entity's rows into the workbook: a cell {{rows.column_cd}} repeats once per row, {{_count}} is the row count and {{_today}} today's date.",
+	"type": "object",
+	"additionalProperties": {
+		"type": "object",
+		"properties": {
+			"entityCd": {
+				"type": "string",
+				"description": "Entity code whose rows the template receives. Cross-module form 'module.entity' is supported."
+			},
+			"description": {
+				"type": "string",
+				"description": "Label shown in the Export menu. Defaults to the template code."
+			},
+			"file": {
+				"type": "string",
+				"description": "Relative path of the .xlsx under the module's export_templates/ directory (e.g. 'invoices.xlsx')."
+			}
+		},
+		"required": ["entityCd", "file"],
+		"additionalProperties": false
+	}
+}

package/schemas/manifest.schema.json

@@ -45,7 +45,12 @@
 		},
 		"description": {
 			"type": "string",
-			"description": "Module description"
+			"description": "Module description. The marketplace module page shows it whole when the package has no README; the catalog card shows shortDescription, else the start of this cut at a sentence."
+		},
+		"shortDescription": {
+			"type": "string",
+			"maxLength": 1000,
+			"description": "Marketplace card text (at most 1000 characters). Optional; refreshed on every publish."
 		},
 		"schemaName": {
 			"type": "string",

package/src/dsl/builtins.ts

@@ -212,6 +212,12 @@ export const BUILTINS: Builtin[] = [
 		returns: "string",
 		doc: "`downloadText()` for bytes: decodes `base64` and hands it to the user as `fileName` (`application/octet-stream` unless `mimeType` says otherwise). Returns the signed download URL.",
 	},
+	{
+		name: "exportXlsx",
+		signature: "exportXlsx(entity, templateCd, options?)",
+		returns: "object",
+		doc: "Fill an Excel export template of `entity` with its rows and hand the user the workbook as the action's download. `options`: `filter` (`{c,o,v}` / `{g,i}` as in `select()`, `v` a scalar), `orderBy` (as in `select()`), `fileName` (default: the template's description). The rows are read as `data.export` reads them, under the current user's rights. Returns `{ url, fileName, recordCount }`. Counts as a download; not available in a scheduled or background run.",
+	},
 	{
 		name: "attachText",
 		signature: "attachText(content, fileName, encoding?, mimeType?)",

package/src/export-templates.ts

@@ -0,0 +1,19 @@
+// Export templates — authoring shape of `ui/export_templates.json`.
+// Mirror of export_templates.schema.json.
+
+/**
+ * An Excel export template (value in the export_templates map). The `.xlsx` lives under
+ * the module's `export_templates/` directory; `data.export` with the template pours the
+ * entity's rows into it (`{{rows.column_cd}}` repeats per row, `{{_count}}`, `{{_today}}`).
+ */
+export interface ExportTemplateDef {
+	/** Entity code whose rows the template receives. */
+	entityCd: string;
+	/** Label shown in the grid's Export menu. Defaults to the template code. */
+	description?: string;
+	/** Relative path of the .xlsx under `export_templates/`. */
+	file: string;
+}
+
+/** A `ui/export_templates.json` file: template_cd → definition. */
+export type ExportTemplatesFile = Record<string, ExportTemplateDef>;

package/src/index.ts

@@ -185,6 +185,7 @@ export type { JobsFile, JobDef } from "./jobs";
 export type { TriggersFile, TriggerDef, EntityEvent } from "./triggers";
 export type { WebhooksFile, WebhookSubscription, WebhookPayload } from "./webhooks";
 export type { PrintTemplatesFile, PrintTemplateDef, PrintPageSettings, PrintMargins } from "./print-templates";
+export type { ExportTemplatesFile, ExportTemplateDef } from "./export-templates";
 export type {
 	CardLayoutsFile,
 	CardLayoutDef,

package/src/manifest.ts

@@ -35,6 +35,8 @@ export interface ManifestDef {
 	dbSchemaVersion: string;
 	displayName: string;
 	description?: string;
+	/** Marketplace card text, at most 1000 characters; without it the card shows the start of `description`. */
+	shortDescription?: string;
 	/** Schema name override (defaults to `code`; system modules use 'dForge'). */
 	schemaName?: string;
 	/** System module flag (cannot be uninstalled, admin-only). Omit for regular modules. */