@sockethub/schemas 3.0.0-alpha.3 → 3.0.0-alpha.4

package/dist/helpers/error-parser.js

@@ -12,15 +12,11 @@ function parseMsg(error) {
     return err;
 }
 function getTypeList(msg) {
+    var _a;
     let types = [];
-    if ((typeof msg === 'object') && (msg.type)) {
-        types.push(msg.type);
-    }
-    else {
-        types.push(undefined);
-    }
-    for (let prop in msg) {
-        if ((typeof msg[prop] === 'object') && (msg[prop].type)) {
+    types.push(msg === null || msg === void 0 ? void 0 : msg.type);
+    for (const prop in msg) {
+        if ((_a = msg[prop]) === null || _a === void 0 ? void 0 : _a.type) {
             types = [...types, ...getTypeList(msg[prop])];
         }
     }
@@ -31,7 +27,7 @@ function getSchemaType(error) {
     return schemaTypeRes ? schemaTypeRes[1] : undefined;
 }
 function getErrType(error) {
-    const errTypeRes = error.instancePath.match(/\/([\w]+)/);
+    const errTypeRes = error.instancePath.match(/\/(\w+)/);
     return errTypeRes ? errTypeRes[1] : undefined;
 }
 function getPartsCount(error, types) {
@@ -40,6 +36,9 @@ function getPartsCount(error, types) {
     if (!errType) {
         return -1;
     }
+    if (!types[errType]) {
+        return -1;
+    }
     if (!types[errType].includes(schemaType)) {
         return -1;
     }
@@ -78,7 +77,7 @@ exports.default = getErrorMessage;
 function composeFinalError(error) {
     // if we have yet to build an error message, assume this is an invalid type value (oneOf),
     // try to build a list of valid types
-    let msg = "";
+    let msg;
     if (error.keyword === 'oneOf') {
         msg = `${error.instancePath}: ${error.message}: ` +
             `${objects_1.ObjectTypesList.join(', ')}`;

package/dist/helpers/objects.js

@@ -208,7 +208,7 @@ exports.ObjectTypesSchema = {
     }
 };
 exports.ObjectTypesList = Object.keys(exports.ObjectTypesSchema);
-exports.ObjectTypesList.forEach(function (type, i) {
+exports.ObjectTypesList.forEach(function (type) {
     if (type === 'credentials') {
         return;
     }

package/dist/index.d.ts

@@ -12,4 +12,4 @@ declare const _default: {
 };
 export default _default;
 export { PlatformSchema, ActivityObjectSchema, ActivityStreamSchema, ObjectTypesList };
-export { IActivityStream, IActivityObject } from "./types";
+export * from "./types";

package/dist/index.js

@@ -1,4 +1,18 @@
 "use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
@@ -20,3 +34,4 @@ exports.default = {
     validateActivityStream: validator_1.validateActivityStream,
     validateActivityObject: validator_1.validateActivityObject,
 };
+__exportStar(require("./types"), exports);

package/dist/index.test.data.streams.d.ts

@@ -15,6 +15,24 @@ declare const _default: ((string | boolean | {
         type: string;
         content: string;
     };
+})[] | (string | boolean | {
+    type: string;
+    context: string;
+    published: string;
+    actor: {
+        id: string;
+        type: string;
+        name: string;
+    };
+    target: {
+        id: string;
+        type: string;
+        name: string;
+    };
+    object: {
+        type: string;
+        content: string;
+    };
 })[] | (string | boolean | {
     type: string;
     context: string;

package/dist/index.test.data.streams.js

@@ -25,6 +25,30 @@ exports.default = [
         true,
         ''
     ],
+    [
+        'type:send, object:message bad published value',
+        {
+            type: 'send',
+            context: 'irc',
+            published: "foo",
+            actor: {
+                id: 'dood@irc.freenode.net',
+                type: 'person',
+                name: 'dood'
+            },
+            target: {
+                id: 'irc.freenode.net/server',
+                type: 'room',
+                name: 'sockethub'
+            },
+            object: {
+                type: 'message',
+                content: 'some kind of message'
+            }
+        },
+        false,
+        '/published: must match format "date-time"'
+    ],
     [
         'type:credentials, object:credentials',
         {

package/dist/schemas/activity-stream.d.ts

@@ -25,6 +25,10 @@ declare const _default: {
             type: string;
             oneOf: any[];
         };
+        published: {
+            type: string;
+            format: string;
+        };
     };
     definitions: {
         type: {

package/dist/schemas/activity-stream.js

@@ -9,8 +9,8 @@ const validActorRefs = activity_object_1.default.properties.object.oneOf;
 const validTargetRefs = activity_object_1.default.properties.object.oneOf;
 // eslint-disable-next-line security-node/detect-crlf
 console.log(validActorRefs);
-let validObjectRefs = [];
-objects_1.ObjectTypesList.forEach(function (type, i) {
+const validObjectRefs = [];
+objects_1.ObjectTypesList.forEach(function (type) {
     validObjectRefs.push({ "$ref": "#/definitions/type/" + type });
 });
 const contextSchema = {
@@ -41,6 +41,10 @@ exports.default = {
         "object": {
             "type": "object",
             "oneOf": validObjectRefs
+        },
+        "published": {
+            "type": "string",
+            "format": "date-time"
         }
     },
     "definitions": {

package/dist/schemas/json/activity-stream.json

@@ -142,6 +142,10 @@
 					"$ref": "#/definitions/type/address"
 				}
 			]
+		},
+		"published": {
+			"type": "string",
+			"format": "date-time"
 		}
 	},
 	"definitions": {

package/dist/types.d.ts

@@ -16,5 +16,19 @@ export interface IActivityObjectActor extends IActivityObject {
     name?: string;
 }
 export interface IActivityObjectObject extends IActivityObject {
-    content?: any;
+    content?: never;
 }
+declare type ErrorMsg = string | Error;
+export interface CallbackInterface {
+    (err?: ErrorMsg, data?: unknown): void;
+}
+export interface CallbackActivityStreamInterface {
+    (data: IActivityStream | Error): void;
+}
+export interface CompletedJobHandler {
+    (data: IActivityStream): void;
+}
+export interface LogInterface {
+    (msg: string): void;
+}
+export {};

package/dist/validator.js

@@ -6,6 +6,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.getPlatformSchema = exports.addPlatformSchema = exports.validatePlatformSchema = exports.validateCredentials = exports.validateActivityStream = exports.validateActivityObject = void 0;
 const debug_1 = __importDefault(require("debug"));
 const ajv_1 = __importDefault(require("ajv"));
+const ajv_formats_1 = __importDefault(require("ajv-formats"));
 const ajv_formats_draft2019_1 = __importDefault(require("ajv-formats-draft2019"));
 const error_parser_1 = __importDefault(require("./helpers/error-parser"));
 const platform_1 = __importDefault(require("./schemas/platform"));
@@ -13,12 +14,13 @@ const activity_stream_1 = __importDefault(require("./schemas/activity-stream"));
 const activity_object_1 = __importDefault(require("./schemas/activity-object"));
 const log = (0, debug_1.default)('sockethub:schemas');
 const ajv = new ajv_1.default({ strictTypes: false, allErrors: true });
+(0, ajv_formats_1.default)(ajv);
 (0, ajv_formats_draft2019_1.default)(ajv);
 const schemaURL = 'https://sockethub.org/schemas/v0';
 const schemas = {};
 schemas[`${schemaURL}/activity-stream`] = activity_stream_1.default;
 schemas[`${schemaURL}/activity-object`] = activity_object_1.default;
-for (let uri in schemas) {
+for (const uri in schemas) {
     log(`registering schema ${uri}`);
     ajv.addSchema(schemas[uri], uri);
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@sockethub/schemas",
   "description": "JSON schema files for validating Sockethub Activity Streams",
-  "version": "3.0.0-alpha.3",
+  "version": "3.0.0-alpha.4",
   "private": false,
   "author": "Nick Jennings <nick@silverbucket.net>",
   "license": "MIT",
@@ -25,19 +25,19 @@
   },
   "homepage": "https://github.com/sockethub/sockethub/tree/master/packages/schemas",
   "devDependencies": {
-    "@types/chai": "4.3.0",
+    "@types/chai": "4.3.3",
     "@types/debug": "4.1.7",
-    "@types/eslint": "8.4.1",
-    "@types/mocha": "9.1.0",
+    "@types/eslint": "8.4.6",
+    "@types/mocha": "9.1.1",
     "@types/node": "17.0.13",
-    "@typescript-eslint/parser": "5.12.1",
-    "c8": "7.11.0",
+    "@typescript-eslint/parser": "5.37.0",
+    "c8": "7.12.0",
     "chai": "4.3.6",
-    "eslint": "8.9.0",
+    "eslint": "8.23.1",
     "eslint-cli": "1.1.1",
-    "mocha": "9.2.1",
-    "ts-node": "10.5.0",
-    "typescript": "4.5.5"
+    "mocha": "10.0.0",
+    "ts-node": "10.9.1",
+    "typescript": "4.8.3"
   },
   "scripts": {
     "build": "npx rimraf dist && tsc && ./scripts/export-json-schema.js",
@@ -50,9 +50,10 @@
     "test": "c8 mocha -r ts-node/register src/**/*.test.ts"
   },
   "dependencies": {
-    "ajv": "8.10.0",
+    "ajv": "8.11.0",
+    "ajv-formats": "^2.1.1",
     "ajv-formats-draft2019": "1.6.1",
     "debug": "^4.3.1"
   },
-  "gitHead": "f02238a478b7ffd3f31d8deea292eb67e630a86b"
+  "gitHead": "c6d34ff44d2be479e4ea42c46da649612342a680"
 }

package/src/helpers/error-parser.ts

@@ -20,13 +20,9 @@ function parseMsg(error: ErrorObject): string {
 
 function getTypeList(msg: IActivityStream | IActivityObject): Array<string> {
   let types = [];
-  if ((typeof msg === 'object') && (msg.type)) {
-    types.push(msg.type);
-  } else {
-    types.push(undefined);
-  }
-  for (let prop in msg) {
-    if ((typeof msg[prop] === 'object') && (msg[prop].type)) {
+  types.push(msg?.type);
+  for (const prop in msg) {
+    if (msg[prop]?.type) {
       types = [...types, ...getTypeList(msg[prop])];
     }
   }
@@ -39,7 +35,7 @@ function getSchemaType(error: ErrorObject): string {
 }
 
 function getErrType(error: ErrorObject): string {
-  const errTypeRes = error.instancePath.match(/\/([\w]+)/);
+  const errTypeRes = error.instancePath.match(/\/(\w+)/);
   return errTypeRes ? errTypeRes[1] : undefined;
 }
 
@@ -47,6 +43,7 @@ function getPartsCount(error: ErrorObject, types: TypeBreakdown): number {
   const schemaType = getSchemaType(error);
   const errType = getErrType(error);
   if (!errType) { return -1; }
+  if (!types[errType]) { return -1; }
   if (!types[errType].includes(schemaType)) { return -1; }
   const parts = error.instancePath.split('/');
   return parts.length;
@@ -87,7 +84,7 @@ export default function getErrorMessage(msg, errors: Array<ErrorObject>): string
 function composeFinalError(error) {
   // if we have yet to build an error message, assume this is an invalid type value (oneOf),
   // try to build a list of valid types
-  let msg = "";
+  let msg: string;
   if (error.keyword === 'oneOf') {
     msg = `${error.instancePath}: ${error.message}: ` +
       `${ObjectTypesList.join(', ')}`;

package/src/helpers/objects.ts

@@ -221,7 +221,7 @@ export const ObjectTypesSchema = {
 
 export const ObjectTypesList = Object.keys(ObjectTypesSchema);
 
-ObjectTypesList.forEach(function (type, i) {
+ObjectTypesList.forEach(function (type) {
   if (type === 'credentials') {
     return;
   }

package/src/index.test.data.streams.ts

@@ -25,6 +25,31 @@ export default [
     ''
   ],
 
+  [
+    'type:send, object:message bad published value',
+    {
+      type: 'send',
+      context: 'irc',
+      published: "foo",
+      actor: {
+        id: 'dood@irc.freenode.net',
+        type: 'person',
+        name: 'dood'
+      },
+      target: {
+        id: 'irc.freenode.net/server',
+        type: 'room',
+        name: 'sockethub'
+      },
+      object: {
+        type: 'message',
+        content: 'some kind of message'
+      }
+    },
+    false,
+    '/published: must match format "date-time"'
+  ],
+
   [
     'type:credentials, object:credentials',
     {

package/src/index.test.ts

@@ -1,3 +1,5 @@
+import {IActivityStream} from "./types";
+
 const chai = require('chai');
 const expect = chai.expect;
 
@@ -56,8 +58,7 @@ describe('ActivityObject', () => {
   testActivityObjectsData.forEach(([name, ao, expectedResult, expectedFailureMessage]) => {
     describe("validateActivityObject " + name, () => {
       it(`returns expected result`, () => {
-        // @ts-ignore
-        const err = validateActivityObject(ao);
+        const err = validateActivityObject(ao as IActivityStream);
         expect(err).to.equal(expectedFailureMessage);
         expect(!err).to.equal(expectedResult);
       });

package/src/index.ts

@@ -20,7 +20,4 @@ export {
   ObjectTypesList
 };
 
-export {
-  IActivityStream,
-  IActivityObject
-} from "./types";
+export * from "./types";

package/src/schemas/activity-stream.ts

@@ -6,9 +6,9 @@ const validTargetRefs = activityObject.properties.object.oneOf;
 // eslint-disable-next-line security-node/detect-crlf
 console.log(validActorRefs);
 
-let validObjectRefs = [];
+const validObjectRefs = [];
 
-ObjectTypesList.forEach(function (type, i) {
+ObjectTypesList.forEach(function (type) {
   validObjectRefs.push({ "$ref": "#/definitions/type/" + type });
 });
 
@@ -42,6 +42,10 @@ export default {
     "object": {
       "type": "object",
       "oneOf": validObjectRefs
+    },
+    "published": {
+      "type": "string",
+      "format": "date-time"
     }
   },
 

package/src/types.ts

@@ -19,5 +19,24 @@ export interface IActivityObjectActor extends IActivityObject {
 }
 
 export interface IActivityObjectObject extends IActivityObject {
-  content?: any;
+  content?: never;
 }
+
+type ErrorMsg = string | Error;
+
+export interface CallbackInterface {
+  (err?: ErrorMsg, data?: unknown): void;
+}
+
+export interface CallbackActivityStreamInterface {
+  (data: IActivityStream | Error): void;
+}
+
+export interface CompletedJobHandler {
+  (data: IActivityStream): void;
+}
+
+export interface LogInterface {
+  (msg: string): void;
+}
+

package/src/validator.ts

@@ -1,6 +1,7 @@
 import debug from 'debug';
 import Ajv, {Schema} from 'ajv';
-import ajvFormat2019 from 'ajv-formats-draft2019';
+import addFormats from 'ajv-formats';
+import additionsFormats2019 from 'ajv-formats-draft2019';
 import getErrorMessage from "./helpers/error-parser";
 import {IActivityStream} from "./types";
 import PlatformSchema from './schemas/platform';
@@ -8,7 +9,8 @@ import ActivityStreamsSchema from './schemas/activity-stream';
 import ActivityObjectSchema from './schemas/activity-object';
 const log = debug('sockethub:schemas');
 const ajv = new Ajv({strictTypes: false, allErrors: true});
-ajvFormat2019(ajv);
+addFormats(ajv);
+additionsFormats2019(ajv);
 
 interface SchemasDict {
   string?: Schema
@@ -20,7 +22,7 @@ const schemas: SchemasDict = {};
 schemas[`${schemaURL}/activity-stream`] = ActivityStreamsSchema;
 schemas[`${schemaURL}/activity-object`] = ActivityObjectSchema;
 
-for (let uri in schemas) {
+for (const uri in schemas) {
   log(`registering schema ${uri}`);
   ajv.addSchema(schemas[uri], uri);
 }