@dforge-core/metadata 0.0.44 → 0.0.45

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dforge-core/metadata",
-  "version": "0.0.44",
+  "version": "0.0.45",
   "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/entity.schema.json

@@ -428,7 +428,7 @@
 				"fieldTypeCd": {
 					"type": "string",
 					"enum": [
-						"text", "avatar", "email", "phone", "url", "textarea", "number", "currency", "percent",
+						"text", "avatar", "email", "phone", "url", "textarea", "number", "currency", "percent", "filesize",
 						"checkbox", "date", "datetime", "time",
 						"dropdown", "flags", "tags", "json", "hidden", "color", "image", "file",
 						"markdown", "richtext", "lookup", "user", "grid", "list", "entitylink", "code"

package/src/actions.ts

@@ -60,6 +60,25 @@ export interface ActionDef {
 	 * "Run in Background". A parameterless `isAsync` action is queued directly.
 	 */
 	isAsync?: boolean;
+	/**
+	 * Code of a print template of the action's entity. The run dialog renders it as a PDF beside the params when the
+	 * action is opened on one record, so the user sees the document the action sends before it goes.
+	 */
+	previewTemplate?: string;
+	/**
+	 * Saved parameter sets the module ships for this action, keyed by set name. They install as shared sets owned by
+	 * the module: read-only for users and refreshed on every install, and a user can save a set of their own under the
+	 * same name, which wins for them. Each `values` key must be a param the action declares; a string starting with `=`
+	 * is a formula. Needs the action to declare params.
+	 */
+	paramSets?: Record<string, ActionParamSetDef>;
+}
+
+/** One shipped parameter set of an action. */
+export interface ActionParamSetDef {
+	description?: string;
+	/** Value by param code. */
+	values: Record<string, unknown>;
 }
 
 /** A `ui/actions.json` file: action code → definition. */

package/src/derive.ts

@@ -24,6 +24,7 @@ const TEXT_BACKED = new Set(["textarea", "markdown", "richtext", "code"]);
 const DB_DATATYPE_OVERRIDE: Record<string, string> = {
 	file: "jsonb",
 	image: "jsonb",
+	filesize: "int8",
 };
 
 export interface DeriveOptions {

package/src/dsl/builtins.ts

@@ -151,7 +151,7 @@ export const BUILTINS: Builtin[] = [
 		name: "sendEmail",
 		signature: "sendEmail(to, subjectOrTemplate, dataOrBody?, attachments?)",
 		returns: "void",
-		doc: "Queue an outbound email. Three arguments, and the **second** picks the mode: `sendEmail(to, 'order.shipped', { ref: [code] })` sends a template, `sendEmail(to, 'Your order shipped', '<p>…</p>')` sends raw HTML. A second argument with no spaces that contains `.` or `_` is read as a template code — so a raw subject like `'Shipped.'` silently becomes one; give a raw subject spaces. The optional **fourth** argument attaches files: a `printPdf()` result, or an array of them (`[a, b]`; pass a single file as itself, because a one-name `[a]` reads as a field reference in the DSL). Only a `printPdf()` result can be attached, and only by the user who generated it (or a workspace admin); at most 5 files and 10 MB in all per email (`Email:MaxAttachments`, `Email:MaxAttachmentBytes`). A file the sender may not attach fails the action. Not available in a scheduled job, whose emails with attachments are not queued.",
+		doc: "Queue an outbound email. Three arguments, and the **second** picks the mode: `sendEmail(to, 'order.shipped', { ref: [code] })` sends a template, `sendEmail(to, 'Your order shipped', '<p>…</p>')` sends raw HTML. A second argument with no spaces that contains `.` or `_` is read as a template code — so a raw subject like `'Shipped.'` silently becomes one; give a raw subject spaces. The optional **fourth** argument attaches files: a `printPdf()`, `attachText()` or `attachBase64()` result, or an array of them (`[a, b]`; pass a single file as itself, because a one-name `[a]` reads as a field reference in the DSL). A `printPdf()` file can be attached only by the user who generated it (or a workspace admin) and not in a scheduled job; a file built with `attachText()` / `attachBase64()` has no owner and works everywhere, a scheduled job included. At most 5 files and 10 MB in all per email (`Email:MaxAttachments`, `Email:MaxAttachmentBytes`). A file the sender may not attach fails the action.",
 	},
 
 	// External calls
@@ -206,6 +206,18 @@ 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: "attachText",
+		signature: "attachText(content, fileName, encoding?, mimeType?)",
+		returns: "object",
+		doc: "Build a text file to attach to an email: encodes `content` in `encoding` (`utf-8` by default) and returns a descriptor for `sendEmail()`'s fourth argument, e.g. `sendEmail(to, 'Interview', body, attachText(ics, 'invite.ics', 'utf-8', 'text/calendar'))`. The file keeps `mimeType` (`text/plain` by default). It is the script's own output, so no user's rights are involved and it works in a scheduled job. Only the emails of this run can name it. Max 10 MB per file and 10 files per run, shared with `downloadText()` / `downloadBase64()`.",
+	},
+	{
+		name: "attachBase64",
+		signature: "attachBase64(base64, fileName, mimeType?)",
+		returns: "object",
+		doc: "`attachText()` for bytes given as base64 (`application/octet-stream` unless `mimeType` says otherwise).",
+	},
 	{
 		name: "getSetting",
 		signature: "getSetting(settingCd)",

package/src/field-types.ts

@@ -20,6 +20,7 @@ export const fieldTypes = [
 	{ cd: "number", name: "Number", columnType: "D", baseDatatypeCd: "number", supportedAgg: "SCAM", maxLen: null, precision: null, useStringInFilter: false },
 	{ cd: "currency", name: "Currency", columnType: "D", baseDatatypeCd: "number", supportedAgg: "SCAM", maxLen: null, precision: 2, useStringInFilter: false },
 	{ cd: "percent", name: "Percent", columnType: "D", baseDatatypeCd: "number", supportedAgg: "CAM", maxLen: null, precision: 2, useStringInFilter: false },
+	{ cd: "filesize", name: "File Size", columnType: "D", baseDatatypeCd: "number", supportedAgg: "SCAM", maxLen: null, precision: null, useStringInFilter: false },
 	{ cd: "checkbox", name: "Checkbox", columnType: "D", baseDatatypeCd: "bool", supportedAgg: "C", maxLen: null, precision: null, useStringInFilter: false },
 	{ cd: "date", name: "Date", columnType: "D", baseDatatypeCd: "date", supportedAgg: "CM", maxLen: null, precision: null, useStringInFilter: false },
 	{ cd: "datetime", name: "Date & Time", columnType: "D", baseDatatypeCd: "timestamp", supportedAgg: "CM", maxLen: null, precision: null, useStringInFilter: false },

package/src/index.ts

@@ -185,7 +185,7 @@ export type {
 	TabGroupSection,
 } from "./card-layouts";
 export type { SeedDataFile, SeedDataRepeat } from "./seed-data";
-export type { ActionsFile, ActionDef, ActionExecutionMode } from "./actions";
+export type { ActionsFile, ActionDef, ActionParamSetDef, ActionExecutionMode } from "./actions";
 
 // Flag catalog — the only letters valid on an authored column, at field level and
 // on a per-view override alike (both `flags` patterns in entity.schema.json are

package/src/types.ts

@@ -50,6 +50,7 @@ export type FieldTypeCd =
 	| "number"
 	| "currency"
 	| "percent"
+	| "filesize"
 	| "checkbox"
 	| "date"
 	| "datetime"