@sockethub/schemas 3.0.0-alpha.3

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

@@ -0,0 +1,465 @@
+{
+	"$id": "https://sockethub.org/schemas/v0/activity-stream#",
+	"description": "Schema for Sockethub Activity Streams",
+	"type": "object",
+	"required": [
+		"context",
+		"type",
+		"actor"
+	],
+	"properties": {
+		"id": {
+			"type": "string"
+		},
+		"type": {
+			"type": "string"
+		},
+		"context": {
+			"type": "string"
+		},
+		"actor": {
+			"type": "object",
+			"oneOf": [
+				{
+					"$ref": "#/definitions/type/feed"
+				},
+				{
+					"$ref": "#/definitions/type/message"
+				},
+				{
+					"$ref": "#/definitions/type/me"
+				},
+				{
+					"$ref": "#/definitions/type/person"
+				},
+				{
+					"$ref": "#/definitions/type/room"
+				},
+				{
+					"$ref": "#/definitions/type/service"
+				},
+				{
+					"$ref": "#/definitions/type/website"
+				},
+				{
+					"$ref": "#/definitions/type/attendance"
+				},
+				{
+					"$ref": "#/definitions/type/presence"
+				},
+				{
+					"$ref": "#/definitions/type/relationship"
+				},
+				{
+					"$ref": "#/definitions/type/topic"
+				},
+				{
+					"$ref": "#/definitions/type/address"
+				}
+			]
+		},
+		"target": {
+			"type": "object",
+			"oneOf": [
+				{
+					"$ref": "#/definitions/type/feed"
+				},
+				{
+					"$ref": "#/definitions/type/message"
+				},
+				{
+					"$ref": "#/definitions/type/me"
+				},
+				{
+					"$ref": "#/definitions/type/person"
+				},
+				{
+					"$ref": "#/definitions/type/room"
+				},
+				{
+					"$ref": "#/definitions/type/service"
+				},
+				{
+					"$ref": "#/definitions/type/website"
+				},
+				{
+					"$ref": "#/definitions/type/attendance"
+				},
+				{
+					"$ref": "#/definitions/type/presence"
+				},
+				{
+					"$ref": "#/definitions/type/relationship"
+				},
+				{
+					"$ref": "#/definitions/type/topic"
+				},
+				{
+					"$ref": "#/definitions/type/address"
+				}
+			]
+		},
+		"object": {
+			"type": "object",
+			"oneOf": [
+				{
+					"$ref": "#/definitions/type/credentials"
+				},
+				{
+					"$ref": "#/definitions/type/feed"
+				},
+				{
+					"$ref": "#/definitions/type/message"
+				},
+				{
+					"$ref": "#/definitions/type/me"
+				},
+				{
+					"$ref": "#/definitions/type/person"
+				},
+				{
+					"$ref": "#/definitions/type/room"
+				},
+				{
+					"$ref": "#/definitions/type/service"
+				},
+				{
+					"$ref": "#/definitions/type/website"
+				},
+				{
+					"$ref": "#/definitions/type/attendance"
+				},
+				{
+					"$ref": "#/definitions/type/presence"
+				},
+				{
+					"$ref": "#/definitions/type/relationship"
+				},
+				{
+					"$ref": "#/definitions/type/topic"
+				},
+				{
+					"$ref": "#/definitions/type/address"
+				}
+			]
+		}
+	},
+	"definitions": {
+		"type": {
+			"credentials": {
+				"required": [
+					"type"
+				],
+				"additionalProperties": true,
+				"properties": {
+					"type": {
+						"enum": [
+							"credentials"
+						]
+					}
+				}
+			},
+			"feed": {
+				"required": [
+					"id",
+					"type"
+				],
+				"additionalProperties": true,
+				"properties": {
+					"type": {
+						"enum": [
+							"feed"
+						]
+					},
+					"id": {
+						"type": "string",
+						"format": "iri"
+					},
+					"name": {
+						"type": "string"
+					},
+					"description": {
+						"type": "string"
+					},
+					"author": {
+						"type": "string"
+					},
+					"favicon": {
+						"type": "string"
+					}
+				}
+			},
+			"message": {
+				"required": [
+					"type",
+					"content"
+				],
+				"additionalProperties": true,
+				"properties": {
+					"type": {
+						"enum": [
+							"message"
+						]
+					},
+					"id": {
+						"type": "string"
+					},
+					"name": {
+						"type": "string"
+					},
+					"content": {
+						"type": "string"
+					}
+				}
+			},
+			"me": {
+				"required": [
+					"type",
+					"content"
+				],
+				"additionalProperties": true,
+				"properties": {
+					"type": {
+						"enum": [
+							"me"
+						]
+					},
+					"content": {
+						"type": "string"
+					}
+				}
+			},
+			"person": {
+				"required": [
+					"id",
+					"type"
+				],
+				"additionalProperties": true,
+				"properties": {
+					"id": {
+						"type": "string"
+					},
+					"type": {
+						"enum": [
+							"person"
+						]
+					},
+					"name": {
+						"type": "string"
+					}
+				}
+			},
+			"room": {
+				"required": [
+					"id",
+					"type"
+				],
+				"additionalProperties": true,
+				"properties": {
+					"id": {
+						"type": "string"
+					},
+					"type": {
+						"enum": [
+							"room"
+						]
+					},
+					"name": {
+						"type": "string"
+					}
+				}
+			},
+			"service": {
+				"required": [
+					"id",
+					"type"
+				],
+				"additionalProperties": true,
+				"properties": {
+					"id": {
+						"type": "string"
+					},
+					"type": {
+						"enum": [
+							"service"
+						]
+					},
+					"name": {
+						"type": "string"
+					}
+				}
+			},
+			"website": {
+				"required": [
+					"id",
+					"type"
+				],
+				"additionalProperties": true,
+				"properties": {
+					"id": {
+						"type": "string",
+						"format": "iri"
+					},
+					"type": {
+						"enum": [
+							"website"
+						]
+					},
+					"name": {
+						"type": "string"
+					}
+				}
+			},
+			"attendance": {
+				"required": [
+					"type"
+				],
+				"additionalProperties": false,
+				"properties": {
+					"type": {
+						"enum": [
+							"attendance"
+						]
+					},
+					"members": {
+						"type": "array",
+						"items": {
+							"type": "string"
+						}
+					}
+				}
+			},
+			"presence": {
+				"required": [
+					"type"
+				],
+				"additionalProperties": false,
+				"properties": {
+					"type": {
+						"enum": [
+							"presence"
+						]
+					},
+					"presence": {
+						"enum": [
+							"away",
+							"chat",
+							"dnd",
+							"xa",
+							"offline",
+							"online"
+						]
+					},
+					"role": {
+						"enum": [
+							"owner",
+							"member",
+							"participant",
+							"admin"
+						]
+					},
+					"content": {
+						"type": "string"
+					}
+				}
+			},
+			"relationship": {
+				"required": [
+					"type",
+					"relationship"
+				],
+				"additionalProperties": false,
+				"properties": {
+					"type": {
+						"enum": [
+							"relationship"
+						]
+					},
+					"relationship": {
+						"enum": [
+							"role"
+						]
+					},
+					"subject": {
+						"type": "object",
+						"oneOf": [
+							{
+								"$ref": "#/definitions/type/presence"
+							}
+						]
+					},
+					"object": {
+						"type": "object",
+						"oneOf": [
+							{
+								"$ref": "#/definitions/type/feed"
+							},
+							{
+								"$ref": "#/definitions/type/message"
+							},
+							{
+								"$ref": "#/definitions/type/me"
+							},
+							{
+								"$ref": "#/definitions/type/person"
+							},
+							{
+								"$ref": "#/definitions/type/room"
+							},
+							{
+								"$ref": "#/definitions/type/service"
+							},
+							{
+								"$ref": "#/definitions/type/website"
+							},
+							{
+								"$ref": "#/definitions/type/attendance"
+							},
+							{
+								"$ref": "#/definitions/type/presence"
+							},
+							{
+								"$ref": "#/definitions/type/relationship"
+							},
+							{
+								"$ref": "#/definitions/type/topic"
+							},
+							{
+								"$ref": "#/definitions/type/address"
+							}
+						]
+					}
+				}
+			},
+			"topic": {
+				"required": [
+					"type"
+				],
+				"additionalProperties": false,
+				"properties": {
+					"type": {
+						"enum": [
+							"topic"
+						]
+					},
+					"content": {
+						"type": "string"
+					}
+				}
+			},
+			"address": {
+				"required": [
+					"type"
+				],
+				"additionalProperties": false,
+				"properties": {
+					"type": {
+						"enum": [
+							"address"
+						]
+					}
+				}
+			}
+		}
+	}
+}

package/dist/schemas/json/platform.json

@@ -0,0 +1,27 @@
+{
+	"type": "object",
+	"required": [
+		"name",
+		"version",
+		"messages"
+	],
+	"additionalProperties": false,
+	"properties": {
+		"credentials": {
+			"title": "credentials",
+			"type": "object"
+		},
+		"messages": {
+			"title": "messages",
+			"type": "object"
+		},
+		"name": {
+			"title": "name",
+			"type": "string"
+		},
+		"version": {
+			"title": "version",
+			"type": "string"
+		}
+	}
+}

package/dist/schemas/platform.d.ts

@@ -0,0 +1,41 @@
+/**
+ * This file is part of Sockethub.
+ *
+ * Developed by Nick Jennings (https://github.com/silverbucket)
+ *
+ * server is licensed under the LGPL.
+ * See the LICENSE file for details.
+ *
+ * The latest version of server can be found here:
+ *   git://github.com/sockethub/sockethub.git
+ *
+ * For more information about Sockethub visit https://sockethub.org/.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
+ */
+declare const _default: {
+    type: string;
+    required: string[];
+    additionalProperties: boolean;
+    properties: {
+        credentials: {
+            title: string;
+            type: string;
+        };
+        messages: {
+            title: string;
+            type: string;
+        };
+        name: {
+            title: string;
+            type: string;
+        };
+        version: {
+            title: string;
+            type: string;
+        };
+    };
+};
+export default _default;

package/dist/schemas/platform.js

@@ -0,0 +1,44 @@
+"use strict";
+/**
+ * This file is part of Sockethub.
+ *
+ * Developed by Nick Jennings (https://github.com/silverbucket)
+ *
+ * server is licensed under the LGPL.
+ * See the LICENSE file for details.
+ *
+ * The latest version of server can be found here:
+ *   git://github.com/sockethub/sockethub.git
+ *
+ * For more information about Sockethub visit https://sockethub.org/.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+// this schema defines the general structure of the schema object which should
+// be returned from platforms.
+exports.default = {
+    'type': 'object',
+    'required': ['name', 'version', 'messages'],
+    'additionalProperties': false,
+    'properties': {
+        'credentials': {
+            'title': 'credentials',
+            'type': 'object'
+        },
+        'messages': {
+            'title': 'messages',
+            'type': 'object',
+        },
+        'name': {
+            'title': 'name',
+            'type': 'string',
+        },
+        'version': {
+            'title': 'version',
+            'type': 'string',
+        }
+    }
+};

package/dist/types.d.ts

@@ -0,0 +1,20 @@
+export interface IActivityStream {
+    type: string;
+    context: string;
+    actor: IActivityObjectActor;
+    object?: IActivityObjectObject;
+    target?: IActivityObjectActor;
+    error?: string;
+    sessionSecret?: string;
+}
+export interface IActivityObject {
+    id?: string;
+    type: string;
+}
+export interface IActivityObjectActor extends IActivityObject {
+    id: string;
+    name?: string;
+}
+export interface IActivityObjectObject extends IActivityObject {
+    content?: any;
+}

package/dist/types.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/validator.d.ts

@@ -0,0 +1,8 @@
+import { Schema } from 'ajv';
+import { IActivityStream } from "./types";
+export declare function validateActivityObject(msg: IActivityStream): string;
+export declare function validateActivityStream(msg: IActivityStream): string;
+export declare function validateCredentials(msg: IActivityStream): string;
+export declare function validatePlatformSchema(schema: Schema): string;
+export declare function addPlatformSchema(schema: Schema, platform_type: string): void;
+export declare function getPlatformSchema(platform_type: string): import("ajv/dist/types").AnyValidateFunction<unknown>;

package/dist/validator.js

@@ -0,0 +1,78 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+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_draft2019_1 = __importDefault(require("ajv-formats-draft2019"));
+const error_parser_1 = __importDefault(require("./helpers/error-parser"));
+const platform_1 = __importDefault(require("./schemas/platform"));
+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_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) {
+    log(`registering schema ${uri}`);
+    ajv.addSchema(schemas[uri], uri);
+}
+function handleValidation(schemaRef, msg, isObject = false) {
+    const validator = ajv.getSchema(schemaRef);
+    let result;
+    if (isObject) {
+        result = validator({ object: msg });
+    }
+    else {
+        result = validator(msg);
+    }
+    if (!result) {
+        return (0, error_parser_1.default)(msg, validator.errors);
+    }
+    return "";
+}
+function validateActivityObject(msg) {
+    return handleValidation(`${schemaURL}/activity-object`, msg, true);
+}
+exports.validateActivityObject = validateActivityObject;
+function validateActivityStream(msg) {
+    return handleValidation(`${schemaURL}/activity-stream`, msg);
+}
+exports.validateActivityStream = validateActivityStream;
+function validateCredentials(msg) {
+    if (!msg.context) {
+        return 'credential activity streams must have a context set';
+    }
+    if (msg.type !== 'credentials') {
+        return 'credential activity streams must have credentials set as type';
+    }
+    return handleValidation(`${schemaURL}/context/${msg.context}/credentials`, msg);
+}
+exports.validateCredentials = validateCredentials;
+function validatePlatformSchema(schema) {
+    const validate = ajv.compile(platform_1.default);
+    // validate schema property
+    const err = validate(schema);
+    if (!err) {
+        return `platform schema failed to validate: ` +
+            `${validate.errors[0].instancePath} ${validate.errors[0].message}`;
+    }
+    else {
+        return "";
+    }
+}
+exports.validatePlatformSchema = validatePlatformSchema;
+function addPlatformSchema(schema, platform_type) {
+    log(`registering schema ${schemaURL}/context/${platform_type}`);
+    ajv.addSchema(schema, `${schemaURL}/context/${platform_type}`);
+}
+exports.addPlatformSchema = addPlatformSchema;
+function getPlatformSchema(platform_type) {
+    return ajv.getSchema(`${schemaURL}/context/${platform_type}`);
+}
+exports.getPlatformSchema = getPlatformSchema;