@rytass/bpm-core-nestjs-module 0.20.1 → 0.21.0

package/src/lib/migrations/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../../libs/bpm-core/src/lib/migrations/index.ts"],"names":[],"mappings":";;;;AACA,0GAAmG;AACnG,sHAA+G;AAC/G,oGAA6F;AAC7F,8GAAuG;AACvG,0GAAmG;AACnG,sFAAgF;AAChF,wFAAkF;AAClF,kGAA4F;AAC5F,8GAAuG;AACvG,oFAA8E;AAC9E,4GAAqG;AACrG,sHAA8G;AAC9G,8GAAuG;AACvG,kGAA2F;AAC3F,oGAA8F;AAC9F,kIAA0H;AAC1H,8GAAsG;AACtG,sFAAgF;AAChF,8FAAwF;AACxF,8GAAuG;AACvG,0GAAkG;AAClG,gGAA0F;AAC1F,4GAAmG;AACnG,4GAAqG;AACrG,0GAAmG;AACnG,oGAA6F;AAC7F,kHAA0G;AAC1G,kHAA0G;AAC1G,oGAA6F;AAC7F,sFAA+E;AAC/E,0HAAkH;AAErG,QAAA,mBAAmB,GAA8C;IAC5E,iFAAqC;IACrC,6FAA2C;IAC3C,2EAAkC;IAClC,qFAAuC;IACvC,iFAAqC;IACrC,8DAA4B;IAC5B,gEAA6B;IAC7B,0EAAkC;IAClC,qFAAuC;IACvC,4DAA2B;IAC3B,mFAAsC;IACtC,4FAA0C;IAC1C,qFAAuC;IACvC,yEAAiC;IACjC,4EAAmC;IACnC,wGAAgD;IAChD,oFAAsC;IACtC,8DAA4B;IAC5B,sEAAgC;IAChC,qFAAuC;IACvC,gFAAoC;IACpC,wEAAiC;IACjC,iFAAoC;IACpC,mFAAsC;IACtC,iFAAqC;IACrC,2EAAkC;IAClC,wFAAwC;IACxC,wFAAwC;IACxC,2EAAkC;IAClC,6DAA2B;IAC3B,gGAA4C;CAC7C,CAAC;AAEF,qFAA2D;AAC3D,2FAAiE;AACjE,kFAAwD;AACxD,uFAA6D;AAC7D,qFAA2D;AAC3D,2EAAiD;AACjD,4EAAkD;AAClD,iFAAuD;AACvD,uFAA6D;AAC7D,0EAAgD;AAChD,sFAA4D;AAC5D,2FAAiE;AACjE,uFAA6D;AAC7D,iFAAuD;AACvD,kFAAwD;AACxD,iGAAuE;AACvE,uFAA6D;AAC7D,2EAAiD;AACjD,+EAAqD;AACrD,uFAA6D;AAC7D,qFAA2D;AAC3D,gFAAsD;AACtD,sFAA4D;AAC5D,sFAA4D;AAC5D,qFAA2D;AAC3D,kFAAwD;AACxD,yFAA+D;AAC/D,yFAA+D;AAC/D,kFAAwD;AACxD,2EAAiD;AACjD,6FAAmE"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../../libs/bpm-core/src/lib/migrations/index.ts"],"names":[],"mappings":";;;;AACA,0GAAmG;AACnG,sHAA+G;AAC/G,oGAA6F;AAC7F,8GAAuG;AACvG,0GAAmG;AACnG,sFAAgF;AAChF,wFAAkF;AAClF,kGAA4F;AAC5F,8GAAuG;AACvG,oFAA8E;AAC9E,4GAAqG;AACrG,sHAA8G;AAC9G,8GAAuG;AACvG,kGAA2F;AAC3F,oGAA8F;AAC9F,kIAA0H;AAC1H,8GAAsG;AACtG,sFAAgF;AAChF,8FAAwF;AACxF,8GAAuG;AACvG,0GAAkG;AAClG,gGAA0F;AAC1F,4GAAmG;AACnG,4GAAqG;AACrG,0GAAmG;AACnG,oGAA6F;AAC7F,kHAA0G;AAC1G,kHAA0G;AAC1G,oGAA6F;AAC7F,sFAA+E;AAC/E,0HAAkH;AAClH,oHAA2G;AAE9F,QAAA,mBAAmB,GAA8C;IAC5E,iFAAqC;IACrC,6FAA2C;IAC3C,2EAAkC;IAClC,qFAAuC;IACvC,iFAAqC;IACrC,8DAA4B;IAC5B,gEAA6B;IAC7B,0EAAkC;IAClC,qFAAuC;IACvC,4DAA2B;IAC3B,mFAAsC;IACtC,4FAA0C;IAC1C,qFAAuC;IACvC,yEAAiC;IACjC,4EAAmC;IACnC,wGAAgD;IAChD,oFAAsC;IACtC,8DAA4B;IAC5B,sEAAgC;IAChC,qFAAuC;IACvC,gFAAoC;IACpC,wEAAiC;IACjC,iFAAoC;IACpC,mFAAsC;IACtC,iFAAqC;IACrC,2EAAkC;IAClC,wFAAwC;IACxC,wFAAwC;IACxC,2EAAkC;IAClC,6DAA2B;IAC3B,gGAA4C;IAC5C,yFAAwC;CACzC,CAAC;AAEF,qFAA2D;AAC3D,2FAAiE;AACjE,kFAAwD;AACxD,uFAA6D;AAC7D,qFAA2D;AAC3D,2EAAiD;AACjD,4EAAkD;AAClD,iFAAuD;AACvD,uFAA6D;AAC7D,0EAAgD;AAChD,sFAA4D;AAC5D,2FAAiE;AACjE,uFAA6D;AAC7D,iFAAuD;AACvD,kFAAwD;AACxD,iGAAuE;AACvE,uFAA6D;AAC7D,2EAAiD;AACjD,+EAAqD;AACrD,uFAA6D;AAC7D,qFAA2D;AAC3D,gFAAsD;AACtD,sFAA4D;AAC5D,sFAA4D;AAC5D,qFAA2D;AAC3D,kFAAwD;AACxD,yFAA+D;AAC/D,yFAA+D;AAC/D,kFAAwD;AACxD,2EAAiD;AACjD,6FAAmE;AACnE,0FAAgE"}

package/src/lib/template/filterable-field-guard.d.ts

@@ -0,0 +1,49 @@
+import { FilterableFieldIssue } from '@rytass/bpm-core-shared';
+import type { FormDefinitionSchema } from '@rytass/bpm-core-shared/form';
+import type { EntityManager } from 'typeorm';
+/**
+ * The enable check of ADR 25 §5.4, run against the database: which filterable
+ * fields of a schema may not take effect for a template (or for every template
+ * that shares a form definition), given the instances already stored.
+ *
+ * Every function takes the `EntityManager` it should read through, so a publish
+ * inside a transaction sees the same snapshot as the rest of that transaction.
+ * Only the filterable paths are read from `form_data`: nothing else is loaded.
+ */
+export interface FilterableFieldIssueReport {
+    readonly templateId: string;
+    readonly templateName: string;
+    readonly issue: FilterableFieldIssue;
+}
+/**
+ * Issues that block a template from using `schema`. Empty when the schema has
+ * no filterable field, which skips every query.
+ *
+ * `readInForceSchema`, when given, reads the form schema of the template's
+ * current version (called only when `schema` has a filterable field), under the template row lock a publish or rollback holds. Its
+ * filterable fields are already guaranteed by the stored data: each was
+ * checked against every instance when it became filterable, and every write
+ * since has been checked against it under the same lock (ADR 25 §6, §15). So
+ * only the paths that are new here, or whose field type changed, are scanned;
+ * a publish that enables nothing reads no instance at all. Without it (the
+ * designer's read-only check), every filterable path is scanned.
+ */
+export declare function readTemplateFilterableFieldIssues(manager: EntityManager, templateId: string, schema: FormDefinitionSchema | null | undefined, readInForceSchema?: () => Promise<FormDefinitionSchema | null>): Promise<readonly FilterableFieldIssueReport[]>;
+/**
+ * Throws a conflict that lists every blocking issue, one per line. Pass a
+ * reader of the current version's schema as `readInForceSchema` (resolving to
+ * null when the template has no published version) to scan only what this
+ * change makes filterable.
+ */
+export declare function assertTemplateFilterableFieldsEnabled(manager: EntityManager, templateId: string, schema: FormDefinitionSchema | null | undefined, readInForceSchema?: () => Promise<FormDefinitionSchema | null>): Promise<void>;
+/**
+ * The designer's view: every template that has instances on a version bound
+ * to `formDefinitionId`, checked against `schema`. A form definition can be
+ * shared by several templates, so one edit may touch more than one.
+ */
+export declare function readFormDefinitionFilterableFieldIssues(manager: EntityManager, formDefinitionId: string, schema: FormDefinitionSchema | null | undefined): Promise<readonly FilterableFieldIssueReport[]>;
+/**
+ * Parses the `schemaJson` argument of the designer query. A value that is not
+ * a JSON object is a bad request, not an empty schema.
+ */
+export declare function readFilterableFieldSchemaFromJson(schemaJson: string): FormDefinitionSchema;

package/src/lib/template/filterable-field-guard.js

@@ -0,0 +1,141 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.readTemplateFilterableFieldIssues = readTemplateFilterableFieldIssues;
+exports.assertTemplateFilterableFieldsEnabled = assertTemplateFilterableFieldsEnabled;
+exports.readFormDefinitionFilterableFieldIssues = readFormDefinitionFilterableFieldIssues;
+exports.readFilterableFieldSchemaFromJson = readFilterableFieldSchemaFromJson;
+const common_1 = require("@nestjs/common");
+const bpm_core_shared_1 = require("@rytass/bpm-core-shared");
+/**
+ * Issues that block a template from using `schema`. Empty when the schema has
+ * no filterable field, which skips every query.
+ *
+ * `readInForceSchema`, when given, reads the form schema of the template's
+ * current version (called only when `schema` has a filterable field), under the template row lock a publish or rollback holds. Its
+ * filterable fields are already guaranteed by the stored data: each was
+ * checked against every instance when it became filterable, and every write
+ * since has been checked against it under the same lock (ADR 25 §6, §15). So
+ * only the paths that are new here, or whose field type changed, are scanned;
+ * a publish that enables nothing reads no instance at all. Without it (the
+ * designer's read-only check), every filterable path is scanned.
+ */
+async function readTemplateFilterableFieldIssues(manager, templateId, schema, readInForceSchema) {
+    const paths = (0, bpm_core_shared_1.readFilterableFieldPaths)(schema);
+    if (paths.length === 0) {
+        return [];
+    }
+    const scannedPaths = readInForceSchema === undefined
+        ? paths
+        : readNewlyFilterablePaths(paths, await readInForceSchema());
+    const history = await readHistoryFormVersions(manager, templateId);
+    const instances = scannedPaths.length === 0
+        ? []
+        : await readInstanceFilterableValues(manager, templateId, scannedPaths.map((item) => item.tableKey ?? item.key));
+    const issues = (0, bpm_core_shared_1.readFilterableFieldIssues)({
+        history: history.map((row) => ({
+            schema: row.schema,
+            versionNumber: Number(row.versionNumber),
+        })),
+        instances,
+        schema,
+    });
+    if (issues.length === 0) {
+        return [];
+    }
+    const templateName = await readTemplateName(manager, templateId);
+    return issues.map((issue) => ({ issue, templateId, templateName }));
+}
+/**
+ * Throws a conflict that lists every blocking issue, one per line. Pass a
+ * reader of the current version's schema as `readInForceSchema` (resolving to
+ * null when the template has no published version) to scan only what this
+ * change makes filterable.
+ */
+async function assertTemplateFilterableFieldsEnabled(manager, templateId, schema, readInForceSchema) {
+    const reports = await readTemplateFilterableFieldIssues(manager, templateId, schema, readInForceSchema);
+    if (reports.length > 0) {
+        throw new common_1.ConflictException(reports.map((report) => (0, bpm_core_shared_1.describeFilterableFieldIssue)(report.issue)).join('\n'));
+    }
+}
+/**
+ * The designer's view: every template that has instances on a version bound
+ * to `formDefinitionId`, checked against `schema`. A form definition can be
+ * shared by several templates, so one edit may touch more than one.
+ */
+async function readFormDefinitionFilterableFieldIssues(manager, formDefinitionId, schema) {
+    if ((0, bpm_core_shared_1.readFilterableFieldPaths)(schema).length === 0) {
+        return [];
+    }
+    const rows = await manager.query(`SELECT DISTINCT tv.template_id AS "templateId"
+       FROM approval_template_versions tv
+       JOIN form_definition_versions fv ON fv.id = tv.form_definition_version_id
+       JOIN approval_templates t ON t.id = tv.template_id AND t.deleted_at IS NULL
+      WHERE fv.form_definition_id = $1
+        AND EXISTS (
+          SELECT 1 FROM approval_instances i WHERE i.template_version_id = tv.id
+        )`, [formDefinitionId]);
+    const reports = await Promise.all(rows.map((row) => readTemplateFilterableFieldIssues(manager, row.templateId, schema)));
+    return reports.flat();
+}
+/**
+ * The paths of `paths` that `inForceSchema` does not already hold as
+ * filterable with the same field type: a field made filterable, a column
+ * moved into a new table path, or a type change (which changes what a stored
+ * value must look like).
+ */
+function readNewlyFilterablePaths(paths, inForceSchema) {
+    const inForceTypes = new Map((0, bpm_core_shared_1.readFilterableFieldPaths)(inForceSchema).map((item) => [item.path, item.field.type]));
+    return paths.filter((item) => inForceTypes.get(item.path) !== item.field.type);
+}
+/**
+ * Parses the `schemaJson` argument of the designer query. A value that is not
+ * a JSON object is a bad request, not an empty schema.
+ */
+function readFilterableFieldSchemaFromJson(schemaJson) {
+    let parsed;
+    try {
+        parsed = JSON.parse(schemaJson);
+    }
+    catch (error) {
+        throw new common_1.BadRequestException(`schemaJson is not valid JSON: ${error instanceof Error ? error.message : 'unknown error'}`);
+    }
+    if (typeof parsed !== 'object' || parsed === null || Array.isArray(parsed)) {
+        throw new common_1.BadRequestException('schemaJson must be an object');
+    }
+    return parsed;
+}
+/**
+ * The form versions that the template's instances were created under, each
+ * once. A type conflict is judged against these, not against every version
+ * that was ever drafted.
+ */
+async function readHistoryFormVersions(manager, templateId) {
+    const rows = await manager.query(`SELECT DISTINCT fv.id, fv.version AS "versionNumber", fv.schema
+       FROM approval_template_versions tv
+       JOIN form_definition_versions fv ON fv.id = tv.form_definition_version_id
+      WHERE tv.template_id = $1
+        AND EXISTS (
+          SELECT 1 FROM approval_instances i WHERE i.template_version_id = tv.id
+        )`, [templateId]);
+    return rows;
+}
+/**
+ * The stored value of each filterable key, for every instance of the template.
+ * The key list is a bound parameter, and a key the instance does not have is
+ * left out of its object, which the checks read as "no value".
+ */
+async function readInstanceFilterableValues(manager, templateId, keys) {
+    const uniqueKeys = [...new Set(keys)];
+    const rows = await manager.query(`SELECT i.id,
+            (SELECT jsonb_object_agg(k, i.form_data -> k)
+               FROM unnest($2::text[]) AS k
+              WHERE i.form_data ? k) AS form_data
+       FROM approval_instances i
+      WHERE i.template_id = $1`, [templateId, uniqueKeys]);
+    return rows.map((row) => ({ formData: row.form_data, id: row.id }));
+}
+async function readTemplateName(manager, templateId) {
+    const rows = await manager.query(`SELECT name FROM approval_templates WHERE id = $1`, [templateId]);
+    return rows[0]?.name ?? '';
+}
+//# sourceMappingURL=filterable-field-guard.js.map

package/src/lib/template/filterable-field-guard.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"filterable-field-guard.js","sourceRoot":"","sources":["../../../../../../libs/bpm-core/src/lib/template/filterable-field-guard.ts"],"names":[],"mappings":";;AA0DA,8EAyCC;AAQD,sFAkBC;AAOD,0FA2BC;AA2BD,8EAkBC;AA5MD,2CAAwE;AACxE,6DAMiC;AAsCjC;;;;;;;;;;;;GAYG;AACI,KAAK,UAAU,iCAAiC,CACrD,OAAsB,EACtB,UAAkB,EAClB,MAA+C,EAC/C,iBAA8D;IAE9D,MAAM,KAAK,GAAG,IAAA,0CAAwB,EAAC,MAAM,CAAC,CAAC;IAE/C,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACvB,OAAO,EAAE,CAAC;IACZ,CAAC;IAED,MAAM,YAAY,GAChB,iBAAiB,KAAK,SAAS;QAC7B,CAAC,CAAC,KAAK;QACP,CAAC,CAAC,wBAAwB,CAAC,KAAK,EAAE,MAAM,iBAAiB,EAAE,CAAC,CAAC;IACjE,MAAM,OAAO,GAAG,MAAM,uBAAuB,CAAC,OAAO,EAAE,UAAU,CAAC,CAAC;IACnE,MAAM,SAAS,GACb,YAAY,CAAC,MAAM,KAAK,CAAC;QACvB,CAAC,CAAC,EAAE;QACJ,CAAC,CAAC,MAAM,4BAA4B,CAChC,OAAO,EACP,UAAU,EACV,YAAY,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,QAAQ,IAAI,IAAI,CAAC,GAAG,CAAC,CACtD,CAAC;IACR,MAAM,MAAM,GAAG,IAAA,2CAAyB,EAAC;QACvC,OAAO,EAAE,OAAO,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC;YAC7B,MAAM,EAAE,GAAG,CAAC,MAAM;YAClB,aAAa,EAAE,MAAM,CAAC,GAAG,CAAC,aAAa,CAAC;SACzC,CAAC,CAAC;QACH,SAAS;QACT,MAAM;KACP,CAAC,CAAC;IAEH,IAAI,MAAM,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACxB,OAAO,EAAE,CAAC;IACZ,CAAC;IAED,MAAM,YAAY,GAAG,MAAM,gBAAgB,CAAC,OAAO,EAAE,UAAU,CAAC,CAAC;IAEjE,OAAO,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,EAAE,KAAK,EAAE,UAAU,EAAE,YAAY,EAAE,CAAC,CAAC,CAAC;AACtE,CAAC;AAED;;;;;GAKG;AACI,KAAK,UAAU,qCAAqC,CACzD,OAAsB,EACtB,UAAkB,EAClB,MAA+C,EAC/C,iBAA8D;IAE9D,MAAM,OAAO,GAAG,MAAM,iCAAiC,CACrD,OAAO,EACP,UAAU,EACV,MAAM,EACN,iBAAiB,CAClB,CAAC;IAEF,IAAI,OAAO,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACvB,MAAM,IAAI,0BAAiB,CACzB,OAAO,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,IAAA,8CAA4B,EAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAC/E,CAAC;IACJ,CAAC;AACH,CAAC;AAED;;;;GAIG;AACI,KAAK,UAAU,uCAAuC,CAC3D,OAAsB,EACtB,gBAAwB,EACxB,MAA+C;IAE/C,IAAI,IAAA,0CAAwB,EAAC,MAAM,CAAC,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAClD,OAAO,EAAE,CAAC;IACZ,CAAC;IAED,MAAM,IAAI,GAAyC,MAAM,OAAO,CAAC,KAAK,CACpE;;;;;;;UAOM,EACN,CAAC,gBAAgB,CAAC,CACnB,CAAC;IACF,MAAM,OAAO,GAAG,MAAM,OAAO,CAAC,GAAG,CAC/B,IAAI,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CACf,iCAAiC,CAAC,OAAO,EAAE,GAAG,CAAC,UAAU,EAAE,MAAM,CAAC,CACnE,CACF,CAAC;IAEF,OAAO,OAAO,CAAC,IAAI,EAAE,CAAC;AACxB,CAAC;AAED;;;;;GAKG;AACH,SAAS,wBAAwB,CAC/B,KAAqC,EACrC,aAA0C;IAE1C,MAAM,YAAY,GAAG,IAAI,GAAG,CAC1B,IAAA,0CAAwB,EAAC,aAAa,CAAC,CAAC,GAAG,CACzC,CAAC,IAAI,EAA6B,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAClE,CACF,CAAC;IAEF,OAAO,KAAK,CAAC,MAAM,CACjB,CAAC,IAAI,EAAE,EAAE,CAAC,YAAY,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,IAAI,CAAC,KAAK,CAAC,IAAI,CAC1D,CAAC;AACJ,CAAC;AAED;;;GAGG;AACH,SAAgB,iCAAiC,CAC/C,UAAkB;IAElB,IAAI,MAAe,CAAC;IAEpB,IAAI,CAAC;QACH,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,UAAU,CAAY,CAAC;IAC7C,CAAC;IAAC,OAAO,KAAc,EAAE,CAAC;QACxB,MAAM,IAAI,4BAAmB,CAC3B,iCAAiC,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,eAAe,EAAE,CAC5F,CAAC;IACJ,CAAC;IAED,IAAI,OAAO,MAAM,KAAK,QAAQ,IAAI,MAAM,KAAK,IAAI,IAAI,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;QAC3E,MAAM,IAAI,4BAAmB,CAAC,8BAA8B,CAAC,CAAC;IAChE,CAAC;IAED,OAAO,MAA8B,CAAC;AACxC,CAAC;AAED;;;;GAIG;AACH,KAAK,UAAU,uBAAuB,CACpC,OAAsB,EACtB,UAAkB;IAElB,MAAM,IAAI,GAAqC,MAAM,OAAO,CAAC,KAAK,CAChE;;;;;;UAMM,EACN,CAAC,UAAU,CAAC,CACb,CAAC;IAEF,OAAO,IAAI,CAAC;AACd,CAAC;AAED;;;;GAIG;AACH,KAAK,UAAU,4BAA4B,CACzC,OAAsB,EACtB,UAAkB,EAClB,IAAuB;IAEvB,MAAM,UAAU,GAAG,CAAC,GAAG,IAAI,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC;IACtC,MAAM,IAAI,GAAmC,MAAM,OAAO,CAAC,KAAK,CAC9D;;;;;+BAK2B,EAC3B,CAAC,UAAU,EAAE,UAAU,CAAC,CACzB,CAAC;IAEF,OAAO,IAAI,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,EAAE,QAAQ,EAAE,GAAG,CAAC,SAAS,EAAE,EAAE,EAAE,GAAG,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC;AACtE,CAAC;AAED,KAAK,UAAU,gBAAgB,CAC7B,OAAsB,EACtB,UAAkB;IAElB,MAAM,IAAI,GAA+B,MAAM,OAAO,CAAC,KAAK,CAC1D,mDAAmD,EACnD,CAAC,UAAU,CAAC,CACb,CAAC;IAEF,OAAO,IAAI,CAAC,CAAC,CAAC,EAAE,IAAI,IAAI,EAAE,CAAC;AAC7B,CAAC"}

package/src/lib/template/filterable-field-issue.object.d.ts

@@ -0,0 +1,21 @@
+export declare enum FilterableFieldIssueKind {
+    TYPE_CHANGED = "TYPE_CHANGED",
+    INVALID_VALUES = "INVALID_VALUES"
+}
+/**
+ * One reason a field cannot be marked filterable yet (ADR 25 §5.4). Only the
+ * fields that matter for the kind are filled: `conflictVersionNumbers` for a
+ * type change, `invalidInstanceCount` and `sampleInstanceIds` for bad values.
+ */
+export declare class FilterableFieldIssueObject {
+    kind: FilterableFieldIssueKind;
+    path: string;
+    label: string;
+    fieldType: string;
+    templateId: string;
+    templateName: string;
+    message: string;
+    conflictVersionNumbers: readonly number[];
+    invalidInstanceCount: number;
+    sampleInstanceIds: readonly string[];
+}

package/src/lib/template/filterable-field-issue.object.js

@@ -0,0 +1,65 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FilterableFieldIssueObject = exports.FilterableFieldIssueKind = void 0;
+const tslib_1 = require("tslib");
+const graphql_1 = require("@nestjs/graphql");
+var FilterableFieldIssueKind;
+(function (FilterableFieldIssueKind) {
+    FilterableFieldIssueKind["TYPE_CHANGED"] = "TYPE_CHANGED";
+    FilterableFieldIssueKind["INVALID_VALUES"] = "INVALID_VALUES";
+})(FilterableFieldIssueKind || (exports.FilterableFieldIssueKind = FilterableFieldIssueKind = {}));
+(0, graphql_1.registerEnumType)(FilterableFieldIssueKind, {
+    name: 'FilterableFieldIssueKind',
+});
+/**
+ * One reason a field cannot be marked filterable yet (ADR 25 §5.4). Only the
+ * fields that matter for the kind are filled: `conflictVersionNumbers` for a
+ * type change, `invalidInstanceCount` and `sampleInstanceIds` for bad values.
+ */
+let FilterableFieldIssueObject = class FilterableFieldIssueObject {
+};
+exports.FilterableFieldIssueObject = FilterableFieldIssueObject;
+tslib_1.__decorate([
+    (0, graphql_1.Field)(() => FilterableFieldIssueKind),
+    tslib_1.__metadata("design:type", String)
+], FilterableFieldIssueObject.prototype, "kind", void 0);
+tslib_1.__decorate([
+    (0, graphql_1.Field)(() => String),
+    tslib_1.__metadata("design:type", String)
+], FilterableFieldIssueObject.prototype, "path", void 0);
+tslib_1.__decorate([
+    (0, graphql_1.Field)(() => String),
+    tslib_1.__metadata("design:type", String)
+], FilterableFieldIssueObject.prototype, "label", void 0);
+tslib_1.__decorate([
+    (0, graphql_1.Field)(() => String),
+    tslib_1.__metadata("design:type", String)
+], FilterableFieldIssueObject.prototype, "fieldType", void 0);
+tslib_1.__decorate([
+    (0, graphql_1.Field)(() => graphql_1.ID),
+    tslib_1.__metadata("design:type", String)
+], FilterableFieldIssueObject.prototype, "templateId", void 0);
+tslib_1.__decorate([
+    (0, graphql_1.Field)(() => String),
+    tslib_1.__metadata("design:type", String)
+], FilterableFieldIssueObject.prototype, "templateName", void 0);
+tslib_1.__decorate([
+    (0, graphql_1.Field)(() => String),
+    tslib_1.__metadata("design:type", String)
+], FilterableFieldIssueObject.prototype, "message", void 0);
+tslib_1.__decorate([
+    (0, graphql_1.Field)(() => [graphql_1.Int]),
+    tslib_1.__metadata("design:type", Array)
+], FilterableFieldIssueObject.prototype, "conflictVersionNumbers", void 0);
+tslib_1.__decorate([
+    (0, graphql_1.Field)(() => graphql_1.Int),
+    tslib_1.__metadata("design:type", Number)
+], FilterableFieldIssueObject.prototype, "invalidInstanceCount", void 0);
+tslib_1.__decorate([
+    (0, graphql_1.Field)(() => [String]),
+    tslib_1.__metadata("design:type", Array)
+], FilterableFieldIssueObject.prototype, "sampleInstanceIds", void 0);
+exports.FilterableFieldIssueObject = FilterableFieldIssueObject = tslib_1.__decorate([
+    (0, graphql_1.ObjectType)('FilterableFieldIssue')
+], FilterableFieldIssueObject);
+//# sourceMappingURL=filterable-field-issue.object.js.map

package/src/lib/template/filterable-field-issue.object.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"filterable-field-issue.object.js","sourceRoot":"","sources":["../../../../../../libs/bpm-core/src/lib/template/filterable-field-issue.object.ts"],"names":[],"mappings":";;;;AAAA,6CAA+E;AAE/E,IAAY,wBAGX;AAHD,WAAY,wBAAwB;IAClC,yDAA6B,CAAA;IAC7B,6DAAiC,CAAA;AACnC,CAAC,EAHW,wBAAwB,wCAAxB,wBAAwB,QAGnC;AAED,IAAA,0BAAgB,EAAC,wBAAwB,EAAE;IACzC,IAAI,EAAE,0BAA0B;CACjC,CAAC,CAAC;AAEH;;;;GAIG;AAEI,IAAM,0BAA0B,GAAhC,MAAM,0BAA0B;CA8BtC,CAAA;AA9BY,gEAA0B;AAErC;IADC,IAAA,eAAK,EAAC,GAAG,EAAE,CAAC,wBAAwB,CAAC;;wDACN;AAGhC;IADC,IAAA,eAAK,EAAC,GAAG,EAAE,CAAC,MAAM,CAAC;;wDACN;AAGd;IADC,IAAA,eAAK,EAAC,GAAG,EAAE,CAAC,MAAM,CAAC;;yDACL;AAGf;IADC,IAAA,eAAK,EAAC,GAAG,EAAE,CAAC,MAAM,CAAC;;6DACD;AAGnB;IADC,IAAA,eAAK,EAAC,GAAG,EAAE,CAAC,YAAE,CAAC;;8DACI;AAGpB;IADC,IAAA,eAAK,EAAC,GAAG,EAAE,CAAC,MAAM,CAAC;;gEACE;AAGtB;IADC,IAAA,eAAK,EAAC,GAAG,EAAE,CAAC,MAAM,CAAC;;2DACH;AAGjB;IADC,IAAA,eAAK,EAAC,GAAG,EAAE,CAAC,CAAC,aAAG,CAAC,CAAC;;0EACwB;AAG3C;IADC,IAAA,eAAK,EAAC,GAAG,EAAE,CAAC,aAAG,CAAC;;wEACa;AAG9B;IADC,IAAA,eAAK,EAAC,GAAG,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC;;qEACgB;qCA7B3B,0BAA0B;IADtC,IAAA,oBAAU,EAAC,sBAAsB,CAAC;GACtB,0BAA0B,CA8BtC"}

package/src/lib/template/filterable-field.queries.d.ts

@@ -0,0 +1,20 @@
+import { Repository } from 'typeorm';
+import { ApprovalTemplateEntity } from './approval-template.entity';
+import { FilterableFieldIssueObject } from './filterable-field-issue.object';
+/**
+ * Read-only check for the designer: does the schema in the editor conflict
+ * with what a template already stored? It blocks nothing. The publish itself
+ * is refused by `TemplateService` (ADR 25 §5.4).
+ *
+ * Designer-only, not merely authenticated: the answer names templates and
+ * instance ids, which a plain member has no business reading.
+ */
+export declare class FilterableFieldQueries {
+    private readonly templateRepository;
+    constructor(templateRepository: Repository<ApprovalTemplateEntity>);
+    /**
+     * Both ids given: only that template. Only `formDefinitionId`: every
+     * template on that form definition. Neither: nothing to check.
+     */
+    filterableFieldIssues(templateId: string | null | undefined, formDefinitionId: string | null | undefined, schemaJson: string): Promise<readonly FilterableFieldIssueObject[]>;
+}

package/src/lib/template/filterable-field.queries.js

@@ -0,0 +1,80 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FilterableFieldQueries = void 0;
+const tslib_1 = require("tslib");
+const graphql_1 = require("@nestjs/graphql");
+const typeorm_1 = require("@nestjs/typeorm");
+const bpm_core_shared_1 = require("@rytass/bpm-core-shared");
+const typeorm_2 = require("typeorm");
+const bpm_auth_1 = require("../bpm-auth");
+const approval_template_entity_1 = require("./approval-template.entity");
+const filterable_field_issue_object_1 = require("./filterable-field-issue.object");
+const filterable_field_guard_1 = require("./filterable-field-guard");
+/**
+ * Read-only check for the designer: does the schema in the editor conflict
+ * with what a template already stored? It blocks nothing. The publish itself
+ * is refused by `TemplateService` (ADR 25 §5.4).
+ *
+ * Designer-only, not merely authenticated: the answer names templates and
+ * instance ids, which a plain member has no business reading.
+ */
+let FilterableFieldQueries = class FilterableFieldQueries {
+    constructor(templateRepository) {
+        this.templateRepository = templateRepository;
+    }
+    /**
+     * Both ids given: only that template. Only `formDefinitionId`: every
+     * template on that form definition. Neither: nothing to check.
+     */
+    async filterableFieldIssues(templateId, formDefinitionId, schemaJson) {
+        const schema = (0, filterable_field_guard_1.readFilterableFieldSchemaFromJson)(schemaJson);
+        const manager = this.templateRepository.manager;
+        const reports = await readIssueReports(manager, templateId ?? null, formDefinitionId ?? null, schema);
+        return reports.map(toFilterableFieldIssueObject);
+    }
+};
+exports.FilterableFieldQueries = FilterableFieldQueries;
+tslib_1.__decorate([
+    (0, graphql_1.Query)(() => [filterable_field_issue_object_1.FilterableFieldIssueObject]),
+    tslib_1.__param(0, (0, graphql_1.Args)('templateId', { nullable: true, type: () => graphql_1.ID })),
+    tslib_1.__param(1, (0, graphql_1.Args)('formDefinitionId', { nullable: true, type: () => graphql_1.ID })),
+    tslib_1.__param(2, (0, graphql_1.Args)('schemaJson', { type: () => String })),
+    tslib_1.__metadata("design:type", Function),
+    tslib_1.__metadata("design:paramtypes", [Object, Object, String]),
+    tslib_1.__metadata("design:returntype", Promise)
+], FilterableFieldQueries.prototype, "filterableFieldIssues", null);
+exports.FilterableFieldQueries = FilterableFieldQueries = tslib_1.__decorate([
+    (0, graphql_1.Resolver)(),
+    (0, bpm_auth_1.BPMDesignerOnly)(),
+    tslib_1.__param(0, (0, typeorm_1.InjectRepository)(approval_template_entity_1.ApprovalTemplateEntity)),
+    tslib_1.__metadata("design:paramtypes", [typeorm_2.Repository])
+], FilterableFieldQueries);
+async function readIssueReports(manager, templateId, formDefinitionId, schema) {
+    if (templateId) {
+        return (0, filterable_field_guard_1.readTemplateFilterableFieldIssues)(manager, templateId, schema);
+    }
+    if (formDefinitionId) {
+        return (0, filterable_field_guard_1.readFormDefinitionFilterableFieldIssues)(manager, formDefinitionId, schema);
+    }
+    return [];
+}
+function toFilterableFieldIssueObject(report) {
+    const { issue } = report;
+    return Object.assign(new filterable_field_issue_object_1.FilterableFieldIssueObject(), {
+        conflictVersionNumbers: issue.kind === 'TYPE_CHANGED'
+            ? issue.conflicts.map((conflict) => conflict.versionNumber)
+            : [],
+        fieldType: issue.type,
+        invalidInstanceCount: issue.kind === 'INVALID_VALUES' ? issue.invalidInstanceCount : 0,
+        kind: filterable_field_issue_object_1.FilterableFieldIssueKind[issue.kind],
+        label: issue.label,
+        message: (0, bpm_core_shared_1.describeFilterableFieldIssue)(issue),
+        path: issue.path,
+        sampleInstanceIds: issue.kind === 'INVALID_VALUES'
+            ? [...new Set(issue.samples.map((sample) => sample.instanceId))]
+            : [],
+        templateId: report.templateId,
+        templateName: report.templateName,
+    });
+}
+//# sourceMappingURL=filterable-field.queries.js.map

package/src/lib/template/filterable-field.queries.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"filterable-field.queries.js","sourceRoot":"","sources":["../../../../../../libs/bpm-core/src/lib/template/filterable-field.queries.ts"],"names":[],"mappings":";;;;AAAA,6CAA4D;AAC5D,6CAAmD;AACnD,6DAAuE;AAEvE,qCAAoD;AACpD,0CAA8C;AAC9C,yEAAoE;AACpE,mFAGyC;AACzC,qEAKkC;AAElC;;;;;;;GAOG;AAGI,IAAM,sBAAsB,GAA5B,MAAM,sBAAsB;IACjC,YAEmB,kBAAsD;QAAtD,uBAAkB,GAAlB,kBAAkB,CAAoC;IACtE,CAAC;IAEJ;;;OAGG;IAEG,AAAN,KAAK,CAAC,qBAAqB,CAEzB,UAAqC,EAErC,gBAA2C,EACC,UAAkB;QAE9D,MAAM,MAAM,GAAG,IAAA,0DAAiC,EAAC,UAAU,CAAC,CAAC;QAC7D,MAAM,OAAO,GAAG,IAAI,CAAC,kBAAkB,CAAC,OAAO,CAAC;QAEhD,MAAM,OAAO,GAAG,MAAM,gBAAgB,CACpC,OAAO,EACP,UAAU,IAAI,IAAI,EAClB,gBAAgB,IAAI,IAAI,EACxB,MAAM,CACP,CAAC;QAEF,OAAO,OAAO,CAAC,GAAG,CAAC,4BAA4B,CAAC,CAAC;IACnD,CAAC;CACF,CAAA;AA9BY,wDAAsB;AAW3B;IADL,IAAA,eAAK,EAAC,GAAG,EAAE,CAAC,CAAC,0DAA0B,CAAC,CAAC;IAEvC,mBAAA,IAAA,cAAI,EAAC,YAAY,EAAE,EAAE,QAAQ,EAAE,IAAI,EAAE,IAAI,EAAE,GAAG,EAAE,CAAC,YAAE,EAAE,CAAC,CAAA;IAEtD,mBAAA,IAAA,cAAI,EAAC,kBAAkB,EAAE,EAAE,QAAQ,EAAE,IAAI,EAAE,IAAI,EAAE,GAAG,EAAE,CAAC,YAAE,EAAE,CAAC,CAAA;IAE5D,mBAAA,IAAA,cAAI,EAAC,YAAY,EAAE,EAAE,IAAI,EAAE,GAAG,EAAE,CAAC,MAAM,EAAE,CAAC,CAAA;;;;mEAa5C;iCA7BU,sBAAsB;IAFlC,IAAA,kBAAQ,GAAE;IACV,IAAA,0BAAe,GAAE;IAGb,mBAAA,IAAA,0BAAgB,EAAC,iDAAsB,CAAC,CAAA;6CACJ,oBAAU;GAHtC,sBAAsB,CA8BlC;AAED,KAAK,UAAU,gBAAgB,CAC7B,OAAsB,EACtB,UAAyB,EACzB,gBAA+B,EAC/B,MAA4B;IAE5B,IAAI,UAAU,EAAE,CAAC;QACf,OAAO,IAAA,0DAAiC,EAAC,OAAO,EAAE,UAAU,EAAE,MAAM,CAAC,CAAC;IACxE,CAAC;IAED,IAAI,gBAAgB,EAAE,CAAC;QACrB,OAAO,IAAA,gEAAuC,EAC5C,OAAO,EACP,gBAAgB,EAChB,MAAM,CACP,CAAC;IACJ,CAAC;IAED,OAAO,EAAE,CAAC;AACZ,CAAC;AAED,SAAS,4BAA4B,CACnC,MAAkC;IAElC,MAAM,EAAE,KAAK,EAAE,GAAG,MAAM,CAAC;IAEzB,OAAO,MAAM,CAAC,MAAM,CAAC,IAAI,0DAA0B,EAAE,EAAE;QACrD,sBAAsB,EACpB,KAAK,CAAC,IAAI,KAAK,cAAc;YAC3B,CAAC,CAAC,KAAK,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,QAAQ,CAAC,aAAa,CAAC;YAC3D,CAAC,CAAC,EAAE;QACR,SAAS,EAAE,KAAK,CAAC,IAAI;QACrB,oBAAoB,EAClB,KAAK,CAAC,IAAI,KAAK,gBAAgB,CAAC,CAAC,CAAC,KAAK,CAAC,oBAAoB,CAAC,CAAC,CAAC,CAAC;QAClE,IAAI,EAAE,wDAAwB,CAAC,KAAK,CAAC,IAAI,CAAC;QAC1C,KAAK,EAAE,KAAK,CAAC,KAAK;QAClB,OAAO,EAAE,IAAA,8CAA4B,EAAC,KAAK,CAAC;QAC5C,IAAI,EAAE,KAAK,CAAC,IAAI;QAChB,iBAAiB,EACf,KAAK,CAAC,IAAI,KAAK,gBAAgB;YAC7B,CAAC,CAAC,CAAC,GAAG,IAAI,GAAG,CAAC,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,CAAC;YAChE,CAAC,CAAC,EAAE;QACR,UAAU,EAAE,MAAM,CAAC,UAAU;QAC7B,YAAY,EAAE,MAAM,CAAC,YAAY;KAClC,CAAC,CAAC;AACL,CAAC"}

package/src/lib/template/index.d.ts

@@ -6,6 +6,7 @@ export * from './dto/approval-template.input';
 export * from './dto/compose-approval-template.input';
 export * from './dto/expression-designer.dto';
 export * from './expression-designer.service';
+export * from './filterable-field-issue.object';
 export * from './template-observer.token';
 export * from './template.enums';
 export * from './template.module';

package/src/lib/template/index.js

@@ -9,6 +9,7 @@ tslib_1.__exportStar(require("./dto/approval-template.input"), exports);
 tslib_1.__exportStar(require("./dto/compose-approval-template.input"), exports);
 tslib_1.__exportStar(require("./dto/expression-designer.dto"), exports);
 tslib_1.__exportStar(require("./expression-designer.service"), exports);
+tslib_1.__exportStar(require("./filterable-field-issue.object"), exports);
 tslib_1.__exportStar(require("./template-observer.token"), exports);
 tslib_1.__exportStar(require("./template.enums"), exports);
 tslib_1.__exportStar(require("./template.module"), exports);

package/src/lib/template/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../../libs/bpm-core/src/lib/template/index.ts"],"names":[],"mappings":";;;AAAA,8EAAoD;AACpD,6EAAmD;AACnD,qEAA2C;AAC3C,6EAAmD;AACnD,wEAA8C;AAC9C,gFAAsD;AACtD,wEAA8C;AAC9C,wEAA8C;AAC9C,oEAA0C;AAC1C,2DAAiC;AACjC,4DAAkC;AAClC,6DAAmC;AACnC,0EAAgD"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../../libs/bpm-core/src/lib/template/index.ts"],"names":[],"mappings":";;;AAAA,8EAAoD;AACpD,6EAAmD;AACnD,qEAA2C;AAC3C,6EAAmD;AACnD,wEAA8C;AAC9C,gFAAsD;AACtD,wEAA8C;AAC9C,wEAA8C;AAC9C,0EAAgD;AAChD,oEAA0C;AAC1C,2DAAiC;AACjC,4DAAkC;AAClC,6DAAmC;AACnC,0EAAgD"}

package/src/lib/template/template.module.js

@@ -13,6 +13,7 @@ const approval_template_version_entity_1 = require("./approval-template-version.
 const compose_template_mutations_1 = require("./compose-template.mutations");
 const expression_designer_queries_1 = require("./expression-designer.queries");
 const expression_designer_service_1 = require("./expression-designer.service");
+const filterable_field_queries_1 = require("./filterable-field.queries");
 const template_mutations_1 = require("./template.mutations");
 const template_queries_1 = require("./template.queries");
 const template_service_1 = require("./template.service");
@@ -35,6 +36,7 @@ exports.TemplateModule = TemplateModule = tslib_1.__decorate([
             compose_template_mutations_1.ComposeTemplateMutations,
             expression_designer_queries_1.ExpressionDesignerQueries,
             expression_designer_service_1.ExpressionDesignerService,
+            filterable_field_queries_1.FilterableFieldQueries,
             template_mutations_1.TemplateMutations,
             template_queries_1.TemplateQueries,
             template_service_1.TemplateService,

package/src/lib/template/template.module.js.map

@@ -1 +1 @@
-{"version":3,"file":"template.module.js","sourceRoot":"","sources":["../../../../../../libs/bpm-core/src/lib/template/template.module.ts"],"names":[],"mappings":";;;;AAAA,2CAAwC;AACxC,6CAAgD;AAChD,oEAAgE;AAChE,2FAAqF;AACrF,qDAAiD;AACjD,2FAAqF;AACrF,yEAAoE;AACpE,yFAAmF;AACnF,6EAAwE;AACxE,+EAA0E;AAC1E,+EAA0E;AAC1E,6DAAyD;AACzD,yDAAqD;AACrD,yDAAqD;AAuB9C,IAAM,cAAc,GAApB,MAAM,cAAc;CAAG,CAAA;AAAjB,wCAAc;yBAAd,cAAc;IArB1B,IAAA,eAAM,EAAC;QACN,OAAO,EAAE;YACP,kCAAe;YACf,wBAAU;YACV,uBAAa,CAAC,UAAU,CAAC;gBACvB,kEAA8B;gBAC9B,iDAAsB;gBACtB,gEAA6B;gBAC7B,4DAA2B;aAC5B,CAAC;SACH;QACD,SAAS,EAAE;YACT,qDAAwB;YACxB,uDAAyB;YACzB,uDAAyB;YACzB,sCAAiB;YACjB,kCAAe;YACf,kCAAe;SAChB;QACD,OAAO,EAAE,CAAC,kCAAe,CAAC;KAC3B,CAAC;GACW,cAAc,CAAG"}
+{"version":3,"file":"template.module.js","sourceRoot":"","sources":["../../../../../../libs/bpm-core/src/lib/template/template.module.ts"],"names":[],"mappings":";;;;AAAA,2CAAwC;AACxC,6CAAgD;AAChD,oEAAgE;AAChE,2FAAqF;AACrF,qDAAiD;AACjD,2FAAqF;AACrF,yEAAoE;AACpE,yFAAmF;AACnF,6EAAwE;AACxE,+EAA0E;AAC1E,+EAA0E;AAC1E,yEAAoE;AACpE,6DAAyD;AACzD,yDAAqD;AACrD,yDAAqD;AAwB9C,IAAM,cAAc,GAApB,MAAM,cAAc;CAAG,CAAA;AAAjB,wCAAc;yBAAd,cAAc;IAtB1B,IAAA,eAAM,EAAC;QACN,OAAO,EAAE;YACP,kCAAe;YACf,wBAAU;YACV,uBAAa,CAAC,UAAU,CAAC;gBACvB,kEAA8B;gBAC9B,iDAAsB;gBACtB,gEAA6B;gBAC7B,4DAA2B;aAC5B,CAAC;SACH;QACD,SAAS,EAAE;YACT,qDAAwB;YACxB,uDAAyB;YACzB,uDAAyB;YACzB,iDAAsB;YACtB,sCAAiB;YACjB,kCAAe;YACf,kCAAe;SAChB;QACD,OAAO,EAAE,CAAC,kCAAe,CAAC;KAC3B,CAAC;GACW,cAAc,CAAG"}

package/src/lib/template/template.service.d.ts

@@ -73,7 +73,19 @@ export declare class TemplateService {
     listApprovalTemplateVersions(templateId: string): Promise<readonly ApprovalTemplateVersionEntity[]>;
     getApprovalTemplateVersion(id: string): Promise<ApprovalTemplateVersionEntity>;
     updateApprovalTemplateDraft(input: UpdateApprovalTemplateDraftInput, manager?: EntityManager): Promise<ApprovalTemplateVersionEntity>;
+    /**
+     * Runs `run` in the caller's transaction when one is passed, otherwise in a
+     * new one, so a template lock taken inside it is held until the write
+     * commits.
+     */
+    private runInTemplateTransaction;
     forkApprovalTemplate(templateId: string, manager?: EntityManager): Promise<ApprovalTemplateVersionEntity>;
+    /**
+     * Forks under the template row lock (ADR 25 §15): the draft check, the
+     * source read and the insert see the template as no concurrent publish or
+     * fork can change it until this commits.
+     */
+    private forkApprovalTemplateLocked;
     publishApprovalTemplateVersion(versionId: string, publishedByMemberId?: string, manager?: EntityManager): Promise<ApprovalTemplateVersionEntity>;
     /**
      * The publish itself, without the observer notification. Split out so
@@ -81,6 +93,11 @@ export declare class TemplateService {
      * and still report a single `COMPOSED` event rather than two.
      */
     private publishVersion;
+    /**
+     * Reads one template row, optionally locked. Locks are only taken inside a
+     * transaction; the caller passes the transaction's manager.
+     */
+    private lockTemplateRow;
     private publishApprovalTemplateVersionWithManager;
     rollbackApprovalTemplateVersion(versionId: string, rolledBackByMemberId?: string): Promise<ApprovalTemplateVersionEntity>;
     /**
@@ -90,6 +107,10 @@ export declare class TemplateService {
      */
     private notifyTemplateObserver;
     private readHostObserver;
+    /**
+     * Returns the bound form schema so the publish can run the filterable-field
+     * check against it without loading the form version a second time.
+     */
     private validatePublishableVersion;
     /** The cel-legacy publish lint, unchanged (docs/24 §1). */
     private lintCelLegacyExpressions;
@@ -121,9 +142,27 @@ export declare class TemplateService {
     private templateVersions;
     private templateCategories;
     private formVersions;
+    /**
+     * The form schema of the template's current version: the one whose
+     * filterable fields the stored instances already satisfy. Null when the
+     * template has no published version yet. Read under the caller's template
+     * row lock, so no write can change what it guarantees before the publish
+     * commits.
+     */
+    private readInForceFormSchema;
+    private readFormSchemaOfVersion;
     private getTemplateOrThrow;
     private getTemplateCategoryOrThrow;
     private setApprovalTemplateActive;
+    /**
+     * Locks the template row FOR UPDATE, the lock a publish, compose or rollback
+     * takes (ADR 25 §15), then reads the row with its category. A template edit
+     * saves the whole entity it read, so reading it unlocked would let a publish
+     * that commits in between be overwritten with the pre-publish
+     * `currentVersionId`; under the lock the read is the latest committed row
+     * and a publish waits for this edit instead.
+     */
+    private readLockedTemplateOrThrow;
     private setApprovalTemplateCategoryActive;
     private getTemplateVersionOrThrow;
     private readNextVersionNumber;