@riocrypto/common-server 1.0.2821 → 1.0.2824

package/build/models/compliance-bot-rule-result.d.ts

@@ -11,6 +11,8 @@ interface ComplianceRuleResultAttrs {
     data: string;
     details: string;
     outcome?: ComplianceRuleOutcome;
+    tag?: string;
+    renderMarkdown?: boolean;
 }
 interface ComplianceRuleResultDoc extends mongoose.Document {
     id: string;
@@ -23,6 +25,8 @@ interface ComplianceRuleResultDoc extends mongoose.Document {
     data: string;
     details: string;
     outcome?: ComplianceRuleOutcome;
+    tag?: string;
+    renderMarkdown?: boolean;
 }
 interface ComplianceRuleResultModel extends mongoose.Model<ComplianceRuleResultDoc> {
     build(attrs: ComplianceRuleResultAttrs): HydratedDocument<ComplianceRuleResultDoc>;

package/build/models/compliance-bot-rule-result.js

@@ -44,6 +44,22 @@ const buildComplianceRuleResult = (mongoose) => {
             type: String,
             required: false,
         },
+        // Snapshot of the parent rule's tag at run time. Snapshotted
+        // (not joined back through ruleId) so historical reports
+        // continue to group correctly when rules are renamed,
+        // retagged, or deleted after a session has run.
+        tag: {
+            type: String,
+            required: false,
+        },
+        // Snapshot of the parent rule's renderMarkdown flag at run
+        // time, so the PDF report knows to format this result as
+        // Markdown even if the rule is later changed.
+        renderMarkdown: {
+            type: Boolean,
+            required: false,
+            default: false,
+        },
     }, {
         toJSON: {
             transform(doc, ret) {

package/build/models/compliance-bot-rule.d.ts

@@ -7,6 +7,8 @@ interface ComplianceRuleAttrs {
     ruleType: string;
     stepType: ComplianceStepType;
     ruleSetId?: string;
+    tag?: string;
+    renderMarkdown?: boolean;
 }
 interface ComplianceRuleDoc extends mongoose.Document {
     id: string;
@@ -16,6 +18,8 @@ interface ComplianceRuleDoc extends mongoose.Document {
     ruleType: string;
     stepType: ComplianceStepType;
     ruleSetId?: string;
+    tag?: string;
+    renderMarkdown?: boolean;
 }
 interface ComplianceRuleModel extends mongoose.Model<ComplianceRuleDoc> {
     build(attrs: ComplianceRuleAttrs): HydratedDocument<ComplianceRuleDoc>;

package/build/models/compliance-bot-rule.js

@@ -39,6 +39,22 @@ const buildComplianceRule = (mongoose) => {
             type: String,
             required: false,
         },
+        // Free-text grouping tag used by the PDF report to render
+        // related rules in a shared table. Trimmed by the API layer
+        // before it lands here; an empty/undefined value means
+        // "untagged" (the rule renders on its own in the report).
+        tag: {
+            type: String,
+            required: false,
+        },
+        // When true, the rule's result is authored in Markdown and
+        // the PDF report renders it as formatted content (GFM
+        // tables, headings, lists) instead of plain text.
+        renderMarkdown: {
+            type: Boolean,
+            required: false,
+            default: false,
+        },
     }, {
         toJSON: {
             transform(doc, ret) {
@@ -50,6 +66,10 @@ const buildComplianceRule = (mongoose) => {
     });
     ComplianceRuleSchema.index({ country: 1 });
     ComplianceRuleSchema.index({ ruleSetId: 1 });
+    // Compound index supports the tag-autocomplete query that powers
+    // the "tag" field in the rule editor: distinct(tag) scoped to a
+    // ruleSet, including only rules that actually carry a tag.
+    ComplianceRuleSchema.index({ ruleSetId: 1, tag: 1 });
     ComplianceRuleSchema.statics.build = (attrs) => {
         return new ComplianceRule(attrs);
     };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@riocrypto/common-server",
-  "version": "1.0.2821",
+  "version": "1.0.2824",
   "description": "",
   "main": "./build/index.js",
   "types": "./build/index.d.ts",