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

package/package.json

@@ -1,10 +1,18 @@
 {
   "name": "@sockethub/schemas",
   "description": "JSON schema files for validating Sockethub Activity Streams",
-  "version": "3.0.0-alpha.3",
+  "version": "3.0.0-alpha.5",
+  "type": "module",
   "private": false,
   "author": "Nick Jennings <nick@silverbucket.net>",
   "license": "MIT",
+  "main": "src/index.ts",
+  "files": [
+    "src/schemas"
+  ],
+  "engines": {
+    "bun": ">=1.2"
+  },
   "keywords": [
     "sockethub",
     "sockethub schema",
@@ -12,12 +20,6 @@
     "activity objects",
     "sockethub platforms"
   ],
-  "main": "dist/index.js",
-  "types": "dist/index.d.ts",
-  "files": [
-    "dist/",
-    "src/"
-  ],
   "repository": {
     "type": "git",
     "url": "git+https://github.com/sockethub/sockethub.git",
@@ -25,34 +27,17 @@
   },
   "homepage": "https://github.com/sockethub/sockethub/tree/master/packages/schemas",
   "devDependencies": {
-    "@types/chai": "4.3.0",
-    "@types/debug": "4.1.7",
-    "@types/eslint": "8.4.1",
-    "@types/mocha": "9.1.0",
-    "@types/node": "17.0.13",
-    "@typescript-eslint/parser": "5.12.1",
-    "c8": "7.11.0",
-    "chai": "4.3.6",
-    "eslint": "8.9.0",
-    "eslint-cli": "1.1.1",
-    "mocha": "9.2.1",
-    "ts-node": "10.5.0",
-    "typescript": "4.5.5"
+    "@types/bun": "latest",
+    "@types/debug": "4.1.12"
   },
   "scripts": {
-    "build": "npx rimraf dist && tsc && ./scripts/export-json-schema.js",
-    "clean": "npx rimraf coverage dist",
-    "clean:deps": "npx rimraf node_modules",
-    "compliance": "yarn test && yarn coverage",
-    "coverage": "c8 check-coverage --statements 95 --branches 95 --functions 95 --lines 95",
-    "lint": "eslint \"**/*.ts\"",
-    "lint:fix": "eslint --fix \"**/*.ts\"",
-    "test": "c8 mocha -r ts-node/register src/**/*.test.ts"
+    "build": "bun ./scripts/export-json-schema.ts"
   },
   "dependencies": {
-    "ajv": "8.10.0",
+    "ajv": "8.12.0",
+    "ajv-formats": "2.1.1",
     "ajv-formats-draft2019": "1.6.1",
-    "debug": "^4.3.1"
+    "debug": "4.3.4"
   },
-  "gitHead": "f02238a478b7ffd3f31d8deea292eb67e630a86b"
+  "gitHead": "341ea9eeca6afd1442fe6e01457bc21d112b91a4"
 }

package/src/index.ts

@@ -1,26 +1,27 @@
-import {addPlatformSchema, validateActivityObject, validateActivityStream, validateCredentials,
-  validatePlatformSchema} from "./validator";
-import { ObjectTypesList } from "./helpers/objects";
-import ActivityObjectSchema from "./schemas/activity-object";
-import ActivityStreamSchema from "./schemas/activity-stream";
-import PlatformSchema from "./schemas/platform";
-
-export default {
-  addPlatformSchema,
-  validatePlatformSchema,
-  validateCredentials,
-  validateActivityStream,
-  validateActivityObject,
-};
+import { ObjectTypesList } from "./helpers/objects.js";
+import { ActivityObjectSchema } from "./schemas/activity-object.js";
+import { ActivityStreamSchema } from "./schemas/activity-stream.js";
+import { PlatformSchema } from "./schemas/platform.js";
+import {
+    addPlatformSchema,
+    getPlatformSchema,
+    validateActivityObject,
+    validateActivityStream,
+    validateCredentials,
+    validatePlatformSchema,
+} from "./validator.js";
 
 export {
-  PlatformSchema,
-  ActivityObjectSchema,
-  ActivityStreamSchema,
-  ObjectTypesList
+    addPlatformSchema,
+    getPlatformSchema,
+    validatePlatformSchema,
+    validateCredentials,
+    validateActivityStream,
+    validateActivityObject,
+    PlatformSchema,
+    ActivityObjectSchema,
+    ActivityStreamSchema,
+    ObjectTypesList,
 };
 
-export {
-  IActivityStream,
-  IActivityObject
-} from "./types";
+export * from "./types.js";

package/src/schemas/activity-object.ts

@@ -1,19 +1,19 @@
-import { validObjectRefs, validObjectDefs } from "../helpers/objects";
+import { validObjectDefs, validObjectRefs } from "../helpers/objects.js";
 
-export default {
-  "$id": "https://sockethub.org/schemas/v0/activity-object#",
-  "description": "Schema for Sockethub Activity Objects",
+export const ActivityObjectSchema = {
+    $id: "https://sockethub.org/schemas/v/activity-object.json",
+    description: "Schema for Sockethub Activity Objects",
 
-  "type": "object",
-  "required" : [ "object" ],
-  "properties": {
-    "object": {
-      "type": "object",
-      "oneOf": validObjectRefs
-    }
-  },
+    type: "object",
+    required: ["object"],
+    properties: {
+        object: {
+            type: "object",
+            oneOf: validObjectRefs,
+        },
+    },
 
-  "definitions": {
-    "type": validObjectDefs
-  }
+    definitions: {
+        type: validObjectDefs,
+    },
 };

package/src/schemas/activity-stream.ts

@@ -1,51 +1,54 @@
-import activityObject from "./activity-object";
-import { ObjectTypesList, ObjectTypesSchema } from "../helpers/objects";
+import { ObjectTypesList, ObjectTypesSchema } from "../helpers/objects.js";
+import { ActivityObjectSchema } from "./activity-object.js";
 
-const validActorRefs  = activityObject.properties.object.oneOf;
-const validTargetRefs = activityObject.properties.object.oneOf;
-// eslint-disable-next-line security-node/detect-crlf
-console.log(validActorRefs);
+const validActorRefs = ActivityObjectSchema.properties.object.oneOf;
+const validTargetRefs = ActivityObjectSchema.properties.object.oneOf;
+// console.log(validActorRefs);
 
-let validObjectRefs = [];
+const validObjectRefs = [];
 
-ObjectTypesList.forEach(function (type, i) {
-  validObjectRefs.push({ "$ref": "#/definitions/type/" + type });
-});
+for (const type of ObjectTypesList) {
+    validObjectRefs.push({ $ref: `#/definitions/type/${type}` });
+}
 
 const contextSchema = {
-  "type": "string"
+    type: "string",
 };
 const typeSchema = {
-  "type": "string"
+    type: "string",
 };
 
-export default {
-  "$id": "https://sockethub.org/schemas/v0/activity-stream#",
-  "description": "Schema for Sockethub Activity Streams",
+export const ActivityStreamSchema = {
+    $id: "https://sockethub.org/schemas/v/activity-stream.json",
+    description: "Schema for Sockethub Activity Streams",
 
-  "type": "object",
-  "required" : [ "context", "type", "actor" ],
-  "properties": {
-    "id": {
-      "type": "string"
+    type: "object",
+    required: ["context", "type", "actor"],
+    properties: {
+        id: {
+            type: "string",
+        },
+        type: typeSchema,
+        context: contextSchema,
+        actor: {
+            type: "object",
+            oneOf: validActorRefs,
+        },
+        target: {
+            type: "object",
+            oneOf: validTargetRefs,
+        },
+        object: {
+            type: "object",
+            oneOf: validObjectRefs,
+        },
+        published: {
+            type: "string",
+            format: "date-time",
+        },
     },
-    "type": typeSchema,
-    "context": contextSchema,
-    "actor": {
-      "type": "object",
-      "oneOf": validActorRefs
-    },
-    "target": {
-      "type": "object",
-      "oneOf": validTargetRefs
-    },
-    "object": {
-      "type": "object",
-      "oneOf": validObjectRefs
-    }
-  },
 
-  "definitions": {
-    "type": ObjectTypesSchema
-  }
+    definitions: {
+        type: ObjectTypesSchema,
+    },
 };

package/{dist → src}/schemas/json/activity-object.json

@@ -1,5 +1,5 @@
 {
-	"$id": "https://sockethub.org/schemas/v0/activity-object#",
+	"$id": "https://sockethub.org/schemas/3.0.0-alpha.5/activity-object.json",
 	"description": "Schema for Sockethub Activity Objects",
 	"type": "object",
 	"required": [

package/{dist → src}/schemas/json/activity-stream.json

@@ -1,5 +1,5 @@
 {
-	"$id": "https://sockethub.org/schemas/v0/activity-stream#",
+	"$id": "https://sockethub.org/schemas/3.0.0-alpha.5/activity-stream.json",
 	"description": "Schema for Sockethub Activity Streams",
 	"type": "object",
 	"required": [
@@ -142,6 +142,10 @@
 					"$ref": "#/definitions/type/address"
 				}
 			]
+		},
+		"published": {
+			"type": "string",
+			"format": "date-time"
 		}
 	},
 	"definitions": {

package/{dist → src}/schemas/json/platform.json

@@ -1,4 +1,5 @@
 {
+	"$id": "https://sockethub.org/schemas/3.0.0-alpha.5/platform.json",
 	"type": "object",
 	"required": [
 		"name",

package/src/schemas/json/sockethub-config.json

@@ -0,0 +1,144 @@
+{
+	"$id": "https://sockethub.org/schemas/3.0.0-alpha.5/sockethub-config.json",
+	"description": "Sockethub Config Schema",
+	"type": "object",
+	"required": [
+		"platforms"
+	],
+	"properties": {
+		"examples": {
+			"type": "object",
+			"properties": {
+				"enabled": {
+					"type": "boolean",
+					"default": false
+				},
+				"secret": {
+					"type": "string",
+					"default": "1234567890"
+				}
+			},
+			"additionalProperties": false
+		},
+		"log_file": {
+			"type": "string"
+		},
+		"packageConfig": {
+			"type": "object",
+			"properties": {
+				"@sockethub/activity-streams": {
+					"type": "object",
+					"properties": {
+						"specialObjs": {
+							"type": "array",
+							"items": {
+								"type": "string"
+							},
+							"default": [
+								"credentials"
+							]
+						},
+						"failOnUnknownObjectProperties": {
+							"type": "boolean",
+							"default": true
+						}
+					},
+					"additionalProperties": false
+				},
+				"@sockethub/platform-dummy": {
+					"type": "object",
+					"properties": {
+						"greeting": {
+							"type": "string",
+							"default": "Hello"
+						}
+					},
+					"additionalProperties": false
+				},
+				"@sockethub/platform-feeds": {
+					"type": "object",
+					"properties": {
+						"connectTimeoutMs": {
+							"type": "number"
+						}
+					},
+					"additionalProperties": false
+				},
+				"@sockethub/platform-irc": {
+					"type": "object",
+					"properties": {
+						"connectTimeoutMs": {
+							"type": "number"
+						}
+					},
+					"additionalProperties": false
+				},
+				"@sockethub/platform-xmpp": {
+					"type": "object",
+					"properties": {
+						"connectTimeoutMs": {
+							"type": "number"
+						}
+					},
+					"additionalProperties": false
+				}
+			}
+		},
+		"platforms": {
+			"type": "array",
+			"items": {
+				"type": "string"
+			}
+		},
+		"public": {
+			"type": "object",
+			"properties": {
+				"protocol": {
+					"type": "string",
+					"default": "http"
+				},
+				"host": {
+					"type": "string",
+					"default": "localhost"
+				},
+				"port": {
+					"type": "number",
+					"default": 10550
+				},
+				"path": {
+					"type": "string",
+					"default": "/"
+				}
+			},
+			"additionalProperties": false
+		},
+		"redis": {
+			"type": "object",
+			"properties": {
+				"url": {
+					"type": "string",
+					"default": "redis://127.0.0.1:6379"
+				}
+			},
+			"additionalProperties": false
+		},
+		"sockethub": {
+			"type": "object",
+			"properties": {
+				"port": {
+					"type": "number",
+					"default": 10550
+				},
+				"host": {
+					"type": "string",
+					"default": "localhost"
+				},
+				"path": {
+					"type": "string",
+					"default": "/sockethub"
+				}
+			},
+			"additionalProperties": false
+		}
+	}
+}

package/src/schemas/platform.ts

@@ -18,30 +18,30 @@
 
 // this schema defines the general structure of the schema object which should
 // be returned from platforms.
-export default {
-  'type' : 'object',
-  'required': [ 'name', 'version', 'messages' ],
-  'additionalProperties': false,
-  'properties' : {
+export const PlatformSchema = {
+    $id: "https://sockethub.org/schemas/v/platform.json",
+    type: "object",
+    required: ["name", "version", "messages"],
+    additionalProperties: false,
+    properties: {
+        credentials: {
+            title: "credentials",
+            type: "object",
+        },
 
-    'credentials' : {
-      'title': 'credentials',
-      'type': 'object'
-    },
+        messages: {
+            title: "messages",
+            type: "object",
+        },
 
-    'messages' : {
-      'title': 'messages',
-      'type': 'object',
-    },
+        name: {
+            title: "name",
+            type: "string",
+        },
 
-    'name' : {
-      'title': 'name',
-      'type': 'string',
+        version: {
+            title: "version",
+            type: "string",
+        },
     },
-
-    'version' : {
-      'title': 'version',
-      'type': 'string',
-    }
-  }
 };

package/src/schemas/sockethub-config.ts

@@ -0,0 +1,140 @@
+const connectConfigPlatforms = {
+    connectTimeoutMs: {
+        type: "number",
+    },
+};
+
+export const SockethubConfigSchema = {
+    $id: "https://sockethub.org/schemas/v/sockethub-config.json",
+    description: "Sockethub Config Schema",
+    type: "object",
+    required: ["platforms"],
+    properties: {
+        examples: {
+            type: "object",
+            properties: {
+                enabled: {
+                    type: "boolean",
+                    default: false,
+                },
+                secret: {
+                    type: "string",
+                    default: "1234567890",
+                },
+            },
+            additionalProperties: false,
+        },
+        log_file: {
+            type: "string",
+        },
+        packageConfig: {
+            type: "object",
+            properties: {
+                "@sockethub/activity-streams": {
+                    type: "object",
+                    properties: {
+                        specialObjs: {
+                            type: "array",
+                            items: {
+                                type: "string",
+                            },
+                            default: ["credentials"],
+                        },
+                        failOnUnknownObjectProperties: {
+                            type: "boolean",
+                            default: true,
+                        },
+                    },
+                    additionalProperties: false,
+                },
+                "@sockethub/platform-dummy": {
+                    type: "object",
+                    properties: {
+                        greeting: {
+                            type: "string",
+                            default: "Hello",
+                        },
+                    },
+                    additionalProperties: false,
+                },
+                "@sockethub/platform-feeds": {
+                    type: "object",
+                    properties: {
+                        ...connectConfigPlatforms,
+                    },
+                    additionalProperties: false,
+                },
+                "@sockethub/platform-irc": {
+                    type: "object",
+                    properties: {
+                        ...connectConfigPlatforms,
+                    },
+                    additionalProperties: false,
+                },
+                "@sockethub/platform-xmpp": {
+                    type: "object",
+                    properties: {
+                        ...connectConfigPlatforms,
+                    },
+                    additionalProperties: false,
+                },
+            },
+        },
+        platforms: {
+            type: "array",
+            items: {
+                type: "string",
+            },
+        },
+        public: {
+            type: "object",
+            properties: {
+                protocol: {
+                    type: "string",
+                    default: "http",
+                },
+                host: {
+                    type: "string",
+                    default: "localhost",
+                },
+                port: {
+                    type: "number",
+                    default: 10550,
+                },
+                path: {
+                    type: "string",
+                    default: "/",
+                },
+            },
+            additionalProperties: false,
+        },
+        redis: {
+            type: "object",
+            properties: {
+                url: {
+                    type: "string",
+                    default: "redis://127.0.0.1:6379",
+                },
+            },
+            additionalProperties: false,
+        },
+        sockethub: {
+            type: "object",
+            properties: {
+                port: {
+                    type: "number",
+                    default: 10550,
+                },
+                host: {
+                    type: "string",
+                    default: "localhost",
+                },
+                path: {
+                    type: "string",
+                    default: "/sockethub",
+                },
+            },
+            additionalProperties: false,
+        },
+    },
+};

package/dist/helpers/error-parser.d.ts

@@ -1,9 +0,0 @@
-import { ErrorObject } from "ajv";
-/**
- * Traverses the errors array from ajv, and makes a series of filtering decisions to
- * try to arrive at the most useful error.
- * @param msg
- * @param errors
- * @returns {string}
- */
-export default function getErrorMessage(msg: any, errors: Array<ErrorObject>): string;