Fixes attachment validation.

Author: ryasmi

dist/schemaRules/attachment.js

@@ -1,13 +1,26 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 var rulr_1 = require("rulr");
+var lodash_1 = require("lodash");
 var factory_1 = require("../factory");
-exports.default = rulr_1.restrictToSchema({
-    usageType: rulr_1.required(factory_1.iri),
-    display: rulr_1.required(factory_1.languageMap),
-    description: rulr_1.optional(factory_1.languageMap),
-    contentType: rulr_1.required(factory_1.imt),
-    length: rulr_1.required(factory_1.integerValue),
-    sha2: rulr_1.required(factory_1.stringValue),
-    fileUrl: rulr_1.optional(factory_1.iri),
-});
+var SignedContentTypeWarning_1 = require("../warnings/SignedContentTypeWarning");
+exports.default = rulr_1.composeRules([
+    rulr_1.restrictToSchema({
+        usageType: rulr_1.required(factory_1.iri),
+        display: rulr_1.required(factory_1.languageMap),
+        description: rulr_1.optional(factory_1.languageMap),
+        contentType: rulr_1.required(factory_1.imt),
+        length: rulr_1.required(factory_1.integerValue),
+        sha2: rulr_1.required(factory_1.stringValue),
+        fileUrl: rulr_1.optional(factory_1.iri),
+    }),
+    function (data, path) {
+        if (!lodash_1.isPlainObject(data))
+            return [];
+        if (data.usageType === 'http://adlnet.gov/expapi/attachments/signature' &&
+            data.contentType !== 'application/octet-stream') {
+            return [new SignedContentTypeWarning_1.default(data, path, data.contentType)];
+        }
+        return [];
+    }
+]);

dist/tests/schemaRules/attachment.js

@@ -1,8 +1,17 @@
 "use strict";
+var __assign = (this && this.__assign) || Object.assign || function(t) {
+    for (var s, i = 1, n = arguments.length; i < n; i++) {
+        s = arguments[i];
+        for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
+            t[p] = s[p];
+    }
+    return t;
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 var describeRequiredProp_1 = require("../describeRequiredProp");
 var describeOptionalProp_1 = require("../describeOptionalProp");
 var itsInvalid_1 = require("../itsInvalid");
+var itsValid_1 = require("../itsValid");
 var factory_1 = require("../factory");
 var validData = {
     usageType: 'http://www.example.com',
@@ -15,6 +24,8 @@ var validData = {
 };
 exports.default = function (test) {
     itsInvalid_1.default(10, 'not an object', test);
+    itsInvalid_1.default(__assign({}, validData, { usageType: 'http://adlnet.gov/expapi/attachments/signature', contentType: 'application/json' }), 'not a valid signed content type', test);
+    itsValid_1.default(__assign({}, validData, { usageType: 'http://adlnet.gov/expapi/attachments/signature', contentType: 'application/octet-stream' }), test);
     describeRequiredProp_1.default('usageType', factory_1.iri, validData, test);
     describeRequiredProp_1.default('display', factory_1.languageMap, validData, test);
     describeOptionalProp_1.default('description', factory_1.languageMap, validData, test);

dist/warnings/SignedContentTypeWarning.d.ts

@@ -0,0 +1,5 @@
+import { Path, Warning } from 'rulr';
+export default class SignedContentTypeWarning extends Warning {
+    contentType: string;
+    constructor(data: any, path: Path, contentType: string);
+}

dist/warnings/SignedContentTypeWarning.js

@@ -0,0 +1,23 @@
+"use strict";
+var __extends = (this && this.__extends) || (function () {
+    var extendStatics = Object.setPrototypeOf ||
+        ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
+        function (d, b) { for (var p in b) if (b.hasOwnProperty(p)) d[p] = b[p]; };
+    return function (d, b) {
+        extendStatics(d, b);
+        function __() { this.constructor = d; }
+        d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+var rulr_1 = require("rulr");
+var SignedContentTypeWarning = (function (_super) {
+    __extends(SignedContentTypeWarning, _super);
+    function SignedContentTypeWarning(data, path, contentType) {
+        var _this = _super.call(this, data, path) || this;
+        _this.contentType = contentType;
+        return _this;
+    }
+    return SignedContentTypeWarning;
+}(rulr_1.Warning));
+exports.default = SignedContentTypeWarning;

src/schemaRules/attachment.ts

@@ -1,12 +1,26 @@
-import { restrictToSchema, optional, required, Rule } from 'rulr';
+import { composeRules, restrictToSchema, optional, required, Rule } from 'rulr';
+import { isPlainObject } from 'lodash';
 import { iri, languageMap, imt, integerValue, stringValue } from '../factory';
+import SignedContentTypeWarning from '../warnings/SignedContentTypeWarning';
 
-export default restrictToSchema({
-  usageType: required(iri),
-  display: required(languageMap),
-  description: optional(languageMap),
-  contentType: required(imt),
-  length: required(integerValue),
-  sha2: required(stringValue),
-  fileUrl: optional(iri),
-}) as Rule;
+export default composeRules([
+  restrictToSchema({
+    usageType: required(iri),
+    display: required(languageMap),
+    description: optional(languageMap),
+    contentType: required(imt),
+    length: required(integerValue),
+    sha2: required(stringValue),
+    fileUrl: optional(iri),
+  }),
+  (data, path) => {
+    if (!isPlainObject(data)) return [];
+    if (
+      data.usageType === 'http://adlnet.gov/expapi/attachments/signature' &&
+      data.contentType !== 'application/octet-stream'
+    ) {
+      return [new SignedContentTypeWarning(data, path, data.contentType)];
+    }
+    return [];
+  }
+]) as Rule;

src/tests/schemaRules/attachment.ts

@@ -2,6 +2,7 @@ import Test from '../helpers/test';
 import describeRequiredProp from '../describeRequiredProp';
 import describeOptionalProp from '../describeOptionalProp';
 import itsInvalid from '../itsInvalid';
+import itsValid from '../itsValid';
 import { iri, languageMap, imt, integerValue, stringValue } from '../factory';
 
 const validData = {
@@ -16,6 +17,16 @@ const validData = {
 
 export default (test: Test) => {
   itsInvalid(10, 'not an object', test);
+  itsInvalid({
+    ...validData,
+    usageType: 'http://adlnet.gov/expapi/attachments/signature',
+    contentType: 'application/json',
+  }, 'not a valid signed content type', test);
+  itsValid({
+    ...validData,
+    usageType: 'http://adlnet.gov/expapi/attachments/signature',
+    contentType: 'application/octet-stream',
+  }, test);
   describeRequiredProp('usageType', iri, validData, test);
   describeRequiredProp('display', languageMap, validData, test);
   describeOptionalProp('description', languageMap, validData, test);

src/warnings/SignedContentTypeWarning.ts

@@ -0,0 +1,7 @@
+import { Path, Warning } from 'rulr';
+
+export default class SignedContentTypeWarning extends Warning {
+  constructor(data: any, path: Path, public contentType: string) {
+    super(data, path);
+  }
+}