@hyperscale0/hsx 5.5.0 → 5.7.0

package/CHANGELOG.md

@@ -1,3 +1,24 @@
+# HSX 5.7.0
+
+Follows UDL 4.9.0. Object `entryActions` admits enrolled customers through named
+actor-bound create actions. Product-scoped limits resolve across records with
+matching parties. `programTax` moves use an operator-owned pass-through account.
+
+Late charge creation accepts a slice reference for plans with multiple instalments.
+Financing, collections and lending samples expose repayment child actions.
+Aggregate selectors retain their selected instrument family, including child
+records, so shared limits compare the matching contracts across Builds.
+
+# HSX 5.6.1
+
+Action summaries without authored text use the action title without the instrument id.
+
+# HSX 5.6.0
+
+The compiler records the standard block origin of every instrument compiled
+from a bundled std header: block key, record path and header digest. Travel
+booking cancellations declare `purpose: option`. Follows UDL 4.8.0.
+
 # HSX 5.5.0
 
 Std money moves declare posted economic purposes. Fee legs and recipient choices

package/dist/src/compile.d.ts

@@ -15,6 +15,11 @@ export interface CompileOriginMapEntry {
         line: number;
         column: number;
     };
+    standardBlock?: {
+        key: string;
+        recordPath: string;
+        headerDigest: string;
+    };
 }
 export interface AdapterBindingTarget {
     adapter: ProviderAdapter;

package/dist/src/compile.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"compile.d.ts","sourceRoot":"","sources":["../../src/compile.ts"],"names":[],"mappings":"AAEA,OAAO,EAAwB,KAAK,eAAe,EAAE,MAAM,WAAW,CAAC;AACvE,OAAO,EAeL,KAAK,WAAW,EAOjB,MAAM,kBAAkB,CAAC;AAS1B,OAAO,EAIL,KAAK,UAAU,EAKf,KAAK,IAAI,EACV,MAAM,UAAU,CAAC;AAClB,OAAO,EAA0B,KAAK,eAAe,EAAE,MAAM,kBAAkB,CAAC;AAEhF,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,kBAAkB,CAAC;AAExD,MAAM,WAAW,iBAAkB,SAAQ,UAAU;IACnD,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,OAAO,CAAC;IAClB,KAAK,EAAE,OAAO,GAAG,OAAO,GAAG,OAAO,CAAC;CACpC;AACD,MAAM,WAAW,qBAAqB;IACpC,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,IAAI,GAAG;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAA;KAAE,CAAC;CAC/C;AACD,MAAM,WAAW,oBAAoB;IACnC,OAAO,EAAE,eAAe,CAAC;IACzB,SAAS,EAAE,MAAM,CAAC;CACnB;AACD,MAAM,WAAW,cAAc;IAC7B,eAAe,CAAC,EAAE,eAAe,CAAC;IAClC,eAAe,CAAC,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,oBAAoB,CAAC,CAAC,CAAC;CAClE;AACD,MAAM,WAAW,aAAa;IAC5B,OAAO,EAAE,OAAO,GAAG,SAAS,CAAC;IAC7B,WAAW,EAAE,iBAAiB,EAAE,CAAC;IACjC,SAAS,CAAC,EAAE;QACV,QAAQ,EAAE,WAAW,CAAC;QACtB,YAAY,EAAE,eAAe,CAAC;QAC9B,SAAS,EAAE,qBAAqB,EAAE,CAAC;KACpC,CAAC;CACH;AAqTD,wBAAgB,OAAO,CACrB,MAAM,EAAE,MAAM,EACd,OAAO,GAAE,cAAmB,GAC3B,aAAa,CAmrGf"}
+{"version":3,"file":"compile.d.ts","sourceRoot":"","sources":["../../src/compile.ts"],"names":[],"mappings":"AAEA,OAAO,EAAwB,KAAK,eAAe,EAAE,MAAM,WAAW,CAAC;AACvE,OAAO,EAeL,KAAK,WAAW,EAOjB,MAAM,kBAAkB,CAAC;AAS1B,OAAO,EAIL,KAAK,UAAU,EAKf,KAAK,IAAI,EACV,MAAM,UAAU,CAAC;AAClB,OAAO,EAA0B,KAAK,eAAe,EAAE,MAAM,kBAAkB,CAAC;AAEhF,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,kBAAkB,CAAC;AAExD,MAAM,WAAW,iBAAkB,SAAQ,UAAU;IACnD,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,OAAO,CAAC;IAClB,KAAK,EAAE,OAAO,GAAG,OAAO,GAAG,OAAO,CAAC;CACpC;AACD,MAAM,WAAW,qBAAqB;IACpC,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,IAAI,GAAG;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAA;KAAE,CAAC;IAC9C,aAAa,CAAC,EAAE;QAAE,GAAG,EAAE,MAAM,CAAC;QAAC,UAAU,EAAE,MAAM,CAAC;QAAC,YAAY,EAAE,MAAM,CAAA;KAAE,CAAC;CAC3E;AACD,MAAM,WAAW,oBAAoB;IACnC,OAAO,EAAE,eAAe,CAAC;IACzB,SAAS,EAAE,MAAM,CAAC;CACnB;AACD,MAAM,WAAW,cAAc;IAC7B,eAAe,CAAC,EAAE,eAAe,CAAC;IAClC,eAAe,CAAC,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,oBAAoB,CAAC,CAAC,CAAC;CAClE;AACD,MAAM,WAAW,aAAa;IAC5B,OAAO,EAAE,OAAO,GAAG,SAAS,CAAC;IAC7B,WAAW,EAAE,iBAAiB,EAAE,CAAC;IACjC,SAAS,CAAC,EAAE;QACV,QAAQ,EAAE,WAAW,CAAC;QACtB,YAAY,EAAE,eAAe,CAAC;QAC9B,SAAS,EAAE,qBAAqB,EAAE,CAAC;KACpC,CAAC;CACH;AAqTD,wBAAgB,OAAO,CACrB,MAAM,EAAE,MAAM,EACd,OAAO,GAAE,cAAmB,GAC3B,aAAa,CA8yGf"}

package/dist/src/compile.js

@@ -277,6 +277,7 @@ export function compile(source, options = {}) {
             fail(program, "this release supports SAR", "write currency SAR or omit currency");
         const templates = new Map();
         const declarationSources = new Map();
+        const standardOrigins = new Map();
         const requirementOrigins = new Map();
         const used = new Set();
         for (const use of program.decls.filter((d) => d.kind === "use")) {
@@ -287,6 +288,10 @@ export function compile(source, options = {}) {
             if (!content)
                 fail(use, `unknown header ${use.name}`, "choose a published header");
             sources.set(use.name, content);
+            const bundled = bundledStandardLibrary.source(use.name);
+            const headerDigest = bundled === content
+                ? Array.from(sha256(new TextEncoder().encode(content)), (byte) => byte.toString(16).padStart(2, "0")).join("")
+                : undefined;
             let header;
             try {
                 header = parseHeader(content, use.name);
@@ -310,6 +315,14 @@ export function compile(source, options = {}) {
                     fail(parentDecl, `duplicate instrument ${prefix}`, "give each instrument a distinct name");
                 templates.set(prefix, parentDecl);
                 declarationSources.set(parentDecl, use.name);
+                if (headerDigest) {
+                    const [, root, ...record] = prefix.split(".");
+                    standardOrigins.set(parentDecl, {
+                        key: `${use.name}.${root}`,
+                        recordPath: record.join("."),
+                        headerDigest,
+                    });
+                }
                 const recs = entries(asBlock(entries(parentDecl.body).get("records")));
                 for (const [recName, recBlock] of recs) {
                     const recDecl = {
@@ -441,7 +454,7 @@ export function compile(source, options = {}) {
             }
             return { module: moduleName, exportPath, revision };
         };
-        const addInstrument = (decl, id, arguments_, origin, inherited = new Map(), inheritedEnums = new Map(), attachmentInfo, familyDeclaration) => {
+        const addInstrument = (decl, id, arguments_, origin, inherited = new Map(), inheritedEnums = new Map(), attachmentInfo, familyDeclaration, standardOrigin) => {
             const resolveFamilyInstruments = (family, currentInstId, expr) => {
                 const found = new Set();
                 if (currentInstId && familyDeclaration) {
@@ -1001,6 +1014,7 @@ export function compile(source, options = {}) {
                     "parameterDiagnostics",
                     "reports",
                     "revisioned",
+                    "scope",
                 ].includes(key) &&
                     !key.startsWith("action "))
                     fail(decl, `unknown instrument clause ${key}`, "use fields, lifecycle, actions, invariants, or records");
@@ -1633,7 +1647,7 @@ export function compile(source, options = {}) {
                 const a = {
                     summary: slots.has("summary")
                         ? String(data(slots.get("summary")))
-                        : `${title(name)} ${id}`,
+                        : title(name),
                     publicAction: camel(`${name}_${id}`),
                     event: `${id}.${name}`,
                     actor: "caller",
@@ -2020,9 +2034,38 @@ export function compile(source, options = {}) {
                 inst.actions[name] = a;
                 inst.actionOrder.push(name);
             }
-            for (const key of ["invariants", "reports", "revisioned"])
+            for (const key of [
+                "invariants",
+                "reports",
+                "revisioned",
+                "scope",
+            ])
                 if (body.has(key))
                     inst[key] = data(body.get(key));
+            let usesTax = false;
+            for (const action of Object.values(inst.actions)) {
+                for (const move of action.moves) {
+                    if (!("from" in move))
+                        continue;
+                    for (const endpoint of ["from", "to"]) {
+                        if (move[endpoint] === "party.programTax") {
+                            move[endpoint] = "self.programTaxPayable";
+                            usesTax = true;
+                        }
+                    }
+                }
+            }
+            if (usesTax) {
+                if (inst.fields.some((field) => field.name === "programTaxPayable"))
+                    fail(decl, "programTaxPayable is reserved for the tax account", "rename the authored field");
+                inst.fields.push({
+                    name: "programTaxPayable",
+                    type: "account",
+                    owner: "programOperator",
+                    book: "cash",
+                    key: "programTax",
+                });
+            }
             const shape = udlInstrumentSchema.safeParse(inst);
             if (!shape.success) {
                 const issue = shape.error.issues[0];
@@ -2037,6 +2080,7 @@ export function compile(source, options = {}) {
             origins.push({
                 path: `$.instruments[${document.instruments.length}]`,
                 span: { ...origin, ...lineColAt(source, origin.start) },
+                ...(standardOrigin ? { standardBlock: standardOrigin } : {}),
             });
             if (familyDeclaration && familyDeclaration.revision !== undefined) {
                 inst.family = {
@@ -2082,7 +2126,14 @@ export function compile(source, options = {}) {
                 addInstrument(child, `${id}_${key}`, emptyBlock, origin, new Map([
                     ...environment,
                     ["parent", { kind: "name", value: id, span: origin }],
-                ]), enums, childAttachment, childFamily);
+                ]), enums, childAttachment, childFamily, standardOrigin
+                    ? {
+                        ...standardOrigin,
+                        recordPath: [standardOrigin.recordPath, key]
+                            .filter(Boolean)
+                            .join("."),
+                    }
+                    : undefined);
             }
         };
         const compileObject = (decl) => {
@@ -2090,8 +2141,9 @@ export function compile(source, options = {}) {
             for (const key of body.keys()) {
                 if (key !== "fields" &&
                     key !== "columns" &&
+                    key !== "entryActions" &&
                     !key.startsWith("attach ")) {
-                    fail(decl, `unknown object clause ${key}`, "use fields, columns, or attach");
+                    fail(decl, `unknown object clause ${key}`, "use fields, columns, entryActions, or attach");
                 }
             }
             const authoredFields = [];
@@ -2170,7 +2222,7 @@ export function compile(source, options = {}) {
                         exposed,
                         parties,
                         attachments,
-                    }, templateFamily ? { ...templateFamily } : undefined);
+                    }, templateFamily ? { ...templateFamily } : undefined, standardOrigins.get(template));
                 }
                 catch (error) {
                     if (!(error instanceof CompileFailure))
@@ -2250,9 +2302,17 @@ export function compile(source, options = {}) {
                     fail(columnsExpr, `The object list selects ${columns.length} columns; this release supports 8. The object may retain all its fields.`, `Remove ${columns.length === 9 ? "one name" : `${columns.length - 8} names`} from \`columns\`, not from \`fields\`.`);
                 }
             }
+            const entryExpr = body.get("entryActions");
+            let entryActions;
+            if (entryExpr) {
+                if (entryExpr.kind !== "list" || !entryExpr.items.length)
+                    fail(entryExpr, "entryActions needs a nonempty list", "name exposed create actions bound to actor");
+                entryActions = entryExpr.items.map(text);
+            }
             document.objects.push({
                 id: decl.name,
                 title: decl.title,
+                ...(entryActions ? { entryActions } : {}),
                 authoredFields: authoredNames,
                 attachments,
                 fields: authoredFields,
@@ -2268,7 +2328,7 @@ export function compile(source, options = {}) {
                 if (!template)
                     fail(decl, `unknown instrument ${decl.target}`, `add use ${decl.target.split(".")[0]} and choose a declared instrument`);
                 const templateFamily = resolveFamily(decl.target, decl, false);
-                addInstrument(template, decl.name, decl.body, decl.span, new Map(), new Map(), undefined, templateFamily ? { ...templateFamily } : undefined);
+                addInstrument(template, decl.name, decl.body, decl.span, new Map(), new Map(), undefined, templateFamily ? { ...templateFamily } : undefined, standardOrigins.get(template));
             }
             if (decl.kind === "object") {
                 compileObject(decl);
@@ -2281,6 +2341,25 @@ export function compile(source, options = {}) {
                     .sort((a, b) => a.span.start - b.span.start)
                     .map((d) => diagnostic(d, "check")),
             };
+        // Resolve selectors after every attachment and child has its family.
+        const retainSelectionFamilies = (value) => {
+            if (!value || typeof value !== "object")
+                return;
+            const record = value;
+            const selection = record.selection;
+            if (selection && !selection.family) {
+                const families = [selection.instrument]
+                    .flat()
+                    .map((id) => document.instruments.find((item) => item.id === id)?.family);
+                const family = families[0];
+                if (family &&
+                    families.every((item) => canonicalJson(item) === canonicalJson(family)))
+                    selection.family = family;
+            }
+            for (const child of Object.values(record))
+                retainSelectionFamilies(child);
+        };
+        retainSelectionFamilies(document);
         // Propagate invoked requirements with the conditions on each invocation path.
         let changedInvocations = true;
         let invocationIterations = 0;
@@ -2536,6 +2615,19 @@ export function compile(source, options = {}) {
             if (Object.values(instrument.actions).filter((action) => action.publicAction === decl.name).length > 1)
                 fail(decl, `public action ${decl.name} is used more than once on ${parts.join(".")}`, "give each exposed action a distinct public name");
         }
+        for (const kind of document.objects) {
+            for (const name of kind.entryActions ?? []) {
+                const eligible = kind.attachments.some((attachment) => {
+                    const create = document.instruments.find((instrument) => instrument.id === attachment.instrument)?.actions.create;
+                    return (create?.publicAction === name &&
+                        typeof create.actor === "object" &&
+                        "party" in create.actor &&
+                        create.actor.party === "actor");
+                });
+                if (!eligible)
+                    fail(objects.get(kind.id), `entry action ${name} must create an attachment as actor`, "expose its create action and bind its acting party to actor");
+            }
+        }
         const usedParties = new Set();
         const collectParties = (value) => {
             if (typeof value === "string") {