@cratis/arc 21.9.2 → 21.11.0

package/dist/esm/validation/ValidationResult.d.ts

@@ -6,6 +6,7 @@ export declare class ValidationResult {
     readonly members: string[];
     readonly state: any;
     readonly reason: ValidationResultReason;
-    constructor(severity: ValidationResultSeverity, message: string, members: string[], state: any, reason?: ValidationResultReason);
+    readonly reasonDetail?: string | undefined;
+    constructor(severity: ValidationResultSeverity, message: string, members: string[], state: any, reason?: ValidationResultReason, reasonDetail?: string | undefined);
 }
 //# sourceMappingURL=ValidationResult.d.ts.map

package/dist/esm/validation/ValidationResult.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ValidationResult.d.ts","sourceRoot":"","sources":["../../../validation/ValidationResult.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,sBAAsB,EAAE,MAAM,0BAA0B,CAAC;AAClE,OAAO,EAAE,wBAAwB,EAAE,MAAM,4BAA4B,CAAC;AAOtE,qBAAa,gBAAgB;IAUrB,QAAQ,CAAC,QAAQ,EAAE,wBAAwB;IAC3C,QAAQ,CAAC,OAAO,EAAE,MAAM;IACxB,QAAQ,CAAC,OAAO,EAAE,MAAM,EAAE;IAC1B,QAAQ,CAAC,KAAK,EAAE,GAAG;IACnB,QAAQ,CAAC,MAAM,EAAE,sBAAsB;IAL3C,YACa,QAAQ,EAAE,wBAAwB,EAClC,OAAO,EAAE,MAAM,EACf,OAAO,EAAE,MAAM,EAAE,EACjB,KAAK,EAAE,GAAG,EACV,MAAM,GAAE,sBAAoD,EACxE;CACJ"}
+{"version":3,"file":"ValidationResult.d.ts","sourceRoot":"","sources":["../../../validation/ValidationResult.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,sBAAsB,EAAE,MAAM,0BAA0B,CAAC;AAClE,OAAO,EAAE,wBAAwB,EAAE,MAAM,4BAA4B,CAAC;AAOtE,qBAAa,gBAAgB;IAarB,QAAQ,CAAC,QAAQ,EAAE,wBAAwB;IAC3C,QAAQ,CAAC,OAAO,EAAE,MAAM;IACxB,QAAQ,CAAC,OAAO,EAAE,MAAM,EAAE;IAC1B,QAAQ,CAAC,KAAK,EAAE,GAAG;IACnB,QAAQ,CAAC,MAAM,EAAE,sBAAsB;IACvC,QAAQ,CAAC,YAAY,CAAC,EAAE,MAAM;IANlC,YACa,QAAQ,EAAE,wBAAwB,EAClC,OAAO,EAAE,MAAM,EACf,OAAO,EAAE,MAAM,EAAE,EACjB,KAAK,EAAE,GAAG,EACV,MAAM,GAAE,sBAAoD,EAC5D,YAAY,CAAC,EAAE,MAAM,YAAA,EACjC;CACJ"}

package/dist/esm/validation/ValidationResult.js

@@ -10,6 +10,7 @@ import { ValidationResultReason } from './ValidationResultReason.js';
     members;
     state;
     reason;
+    reasonDetail;
     /**
      * Initializes a new instance of the {@link ValidationResult} class.
      * @param severity The severity of the result.
@@ -17,12 +18,16 @@ import { ValidationResultReason } from './ValidationResultReason.js';
      * @param members The members the result is attributed to.
      * @param state State associated with the result - the rule author's, carried straight through.
      * @param reason What composed the result. Defaults to `rule`, meaning an authored rule rejected the input.
-     */ constructor(severity, message, members, state, reason = ValidationResultReason.Rule){
+     * @param reasonDetail Which specific thing within {@link reason} produced the result - the name of the violated
+     * constraint for `constraintViolation`, for instance. Undefined when the reason carries no finer identity.
+     * Branch on this rather than matching {@link message}, which is prose and free to change.
+     */ constructor(severity, message, members, state, reason = ValidationResultReason.Rule, reasonDetail){
         this.severity = severity;
         this.message = message;
         this.members = members;
         this.state = state;
         this.reason = reason;
+        this.reasonDetail = reasonDetail;
     }
 }
 

package/dist/esm/validation/ValidationResult.js.map

@@ -1 +1 @@
-{"version":3,"file":"ValidationResult.js","sources":["../../../validation/ValidationResult.ts"],"sourcesContent":["// Copyright (c) Cratis. All rights reserved.\n// Licensed under the MIT license. See LICENSE file in the project root for full license information.\n\nimport { ValidationResultReason } from './ValidationResultReason';\nimport { ValidationResultSeverity } from './ValidationResultSeverity';\n\n/* eslint-disable @typescript-eslint/no-explicit-any */\n\n/**\n * Represents a validation error with a message for one or more members.\n */\nexport class ValidationResult {\n    /**\n     * Initializes a new instance of the {@link ValidationResult} class.\n     * @param severity The severity of the result.\n     * @param message The message. A developer diagnostic when {@link reason} is anything but `rule`.\n     * @param members The members the result is attributed to.\n     * @param state State associated with the result - the rule author's, carried straight through.\n     * @param reason What composed the result. Defaults to `rule`, meaning an authored rule rejected the input.\n     */\n    constructor(\n        readonly severity: ValidationResultSeverity,\n        readonly message: string,\n        readonly members: string[],\n        readonly state: any,\n        readonly reason: ValidationResultReason = ValidationResultReason.Rule) {\n    }\n}\n"],"names":["ValidationResult","message","members","reason","ValidationResultReason","Rule","severity","state"],"mappings":";;AAAA;AACA;AAKA;;AAIC,IACM,MAAMA,gBAAAA,CAAAA;;;;;;AACT;;;;;;;AAOC,QACD,YACI,QAA2C,EAClCC,OAAe,EACfC,OAAiB,EAC1B,KAAmB,EACnB,MAASC,GAAiCC,sBAAAA,CAAuBC,IAAI,CAAE;aAJ9DC,QAAAA,GAAAA,QAAAA;aACAL,OAAAA,GAAAA,OAAAA;aACAC,OAAAA,GAAAA,OAAAA;aACAK,KAAAA,GAAAA,KAAAA;aACAJ,MAAAA,GAAAA,MAAAA;AACb,IAAA;AACJ;;;;"}
+{"version":3,"file":"ValidationResult.js","sources":["../../../validation/ValidationResult.ts"],"sourcesContent":["// Copyright (c) Cratis. All rights reserved.\n// Licensed under the MIT license. See LICENSE file in the project root for full license information.\n\nimport { ValidationResultReason } from './ValidationResultReason';\nimport { ValidationResultSeverity } from './ValidationResultSeverity';\n\n/* eslint-disable @typescript-eslint/no-explicit-any */\n\n/**\n * Represents a validation error with a message for one or more members.\n */\nexport class ValidationResult {\n    /**\n     * Initializes a new instance of the {@link ValidationResult} class.\n     * @param severity The severity of the result.\n     * @param message The message. A developer diagnostic when {@link reason} is anything but `rule`.\n     * @param members The members the result is attributed to.\n     * @param state State associated with the result - the rule author's, carried straight through.\n     * @param reason What composed the result. Defaults to `rule`, meaning an authored rule rejected the input.\n     * @param reasonDetail Which specific thing within {@link reason} produced the result - the name of the violated\n     * constraint for `constraintViolation`, for instance. Undefined when the reason carries no finer identity.\n     * Branch on this rather than matching {@link message}, which is prose and free to change.\n     */\n    constructor(\n        readonly severity: ValidationResultSeverity,\n        readonly message: string,\n        readonly members: string[],\n        readonly state: any,\n        readonly reason: ValidationResultReason = ValidationResultReason.Rule,\n        readonly reasonDetail?: string) {\n    }\n}\n"],"names":["ValidationResult","reason","ValidationResultReason","Rule","reasonDetail","severity","message","members","state"],"mappings":";;AAAA;AACA;AAKA;;AAIC,IACM,MAAMA,gBAAAA,CAAAA;;;;;;;AACT;;;;;;;;;;QAWA,WAAA,CACI,QAA2C,EAC3C,OAAwB,EACxB,OAA0B,EAC1B,KAAmB,EACnB,MAASC,GAAiCC,sBAAAA,CAAuBC,IAAI,EAC5DC,YAAqB,CAAE;aALvBC,QAAAA,GAAAA,QAAAA;aACAC,OAAAA,GAAAA,OAAAA;aACAC,OAAAA,GAAAA,OAAAA;aACAC,KAAAA,GAAAA,KAAAA;aACAP,MAAAA,GAAAA,MAAAA;aACAG,YAAAA,GAAAA,YAAAA;AACb,IAAA;AACJ;;;;"}

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@cratis/arc",
-    "version": "21.9.2",
+    "version": "21.11.0",
     "description": "",
     "author": "Cratis",
     "license": "MIT",

package/queries/QueryResult.ts

@@ -38,6 +38,7 @@ type ServerValidationResult = {
     members: string[];
     state: object;
     reason?: string;
+    reasonDetail?: string;
 }
 
 type ServerPagingInfo = {
@@ -94,7 +95,9 @@ export class QueryResult<TDataType = object> implements IQueryResult<TDataType>
                 severity: _.severity,
                 message: _.message,
                 members: _.members,
-                state: _.state
+                state: _.state,
+                reason: _.reason,
+                reasonDetail: _.reasonDetail
             })),
             exceptionMessages: [],
             exceptionStackTrace: '',
@@ -154,7 +157,7 @@ export class QueryResult<TDataType = object> implements IQueryResult<TDataType>
         this.isAuthorized = result.isAuthorized;
         this.isValid = result.isValid;
         this.hasExceptions = result.hasExceptions;
-        this.validationResults = result.validationResults.map(_ => new ValidationResult(_.severity, _.message, _.members, _.state, _.reason));
+        this.validationResults = result.validationResults.map(_ => new ValidationResult(_.severity, _.message, _.members, _.state, _.reason, _.reasonDetail));
         this.exceptionMessages = result.exceptionMessages;
         this.exceptionStackTrace = result.exceptionStackTrace;
         this.paging = new PagingInfo();

package/queries/for_QueryResult/when_constructing_from_a_server_result_with_a_constraint_violation.ts

@@ -0,0 +1,35 @@
+// Copyright (c) Cratis. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+
+import { ValidationResultReason } from '../../validation/ValidationResultReason';
+import { ValidationResultSeverity } from '../../validation/ValidationResultSeverity';
+import { QueryResult } from '../QueryResult';
+
+describe('when constructing from a server result with a constraint violation', () => {
+    const result = new QueryResult({
+        data: {},
+        isSuccess: false,
+        isAuthorized: true,
+        isValid: false,
+        hasExceptions: false,
+        validationResults: [
+            {
+                severity: ValidationResultSeverity.Error,
+                message: 'The organization number is already in use',
+                members: ['organizationNumber'],
+                state: {},
+                reason: ValidationResultReason.ConstraintViolation,
+                reasonDetail: 'UniqueOrganizationNumber'
+            }
+        ],
+        exceptionMessages: [],
+        exceptionStackTrace: '',
+        paging: { page: 0, size: 0, totalItems: 0, totalPages: 0 }
+    }, Object, false);
+
+    it('should carry what kind of thing rejected the query', () =>
+        result.validationResults[0].reason.should.equal(ValidationResultReason.ConstraintViolation));
+
+    it('should carry the name of the violated constraint', () =>
+        result.validationResults[0].reasonDetail!.should.equal('UniqueOrganizationNumber'));
+});

package/queries/for_QueryResult/when_creating_a_validation_failed_result.ts

@@ -0,0 +1,27 @@
+// Copyright (c) Cratis. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+
+import { ValidationResult } from '../../validation/ValidationResult';
+import { ValidationResultReason } from '../../validation/ValidationResultReason';
+import { ValidationResultSeverity } from '../../validation/ValidationResultSeverity';
+import { QueryResult } from '../QueryResult';
+
+// The query side is meant to read the same way the command side does, which only holds if it carries
+// the same fields through - so this is the mirror of the CommandResult spec of the same name.
+describe('when creating a validation failed result', () => {
+    const result = QueryResult.validationFailed([
+        new ValidationResult(
+            ValidationResultSeverity.Error,
+            'The organization number is already in use',
+            ['organizationNumber'],
+            {},
+            ValidationResultReason.ConstraintViolation,
+            'UniqueOrganizationNumber')
+    ], { defaultValue: {}, modelType: Object, enumerable: false });
+
+    it('should keep the reason the caller gave it', () =>
+        result.validationResults[0].reason.should.equal(ValidationResultReason.ConstraintViolation));
+
+    it('should keep the name of the violated constraint', () =>
+        result.validationResults[0].reasonDetail!.should.equal('UniqueOrganizationNumber'));
+});

package/validation/ValidationResult.ts

@@ -17,12 +17,16 @@ export class ValidationResult {
      * @param members The members the result is attributed to.
      * @param state State associated with the result - the rule author's, carried straight through.
      * @param reason What composed the result. Defaults to `rule`, meaning an authored rule rejected the input.
+     * @param reasonDetail Which specific thing within {@link reason} produced the result - the name of the violated
+     * constraint for `constraintViolation`, for instance. Undefined when the reason carries no finer identity.
+     * Branch on this rather than matching {@link message}, which is prose and free to change.
      */
     constructor(
         readonly severity: ValidationResultSeverity,
         readonly message: string,
         readonly members: string[],
         readonly state: any,
-        readonly reason: ValidationResultReason = ValidationResultReason.Rule) {
+        readonly reason: ValidationResultReason = ValidationResultReason.Rule,
+        readonly reasonDetail?: string) {
     }
 }