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

package/dist/helpers/error-parser.js

@@ -1,90 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const objects_1 = require("./objects");
-function parseMsg(error) {
-    let err = `${error.instancePath ? error.instancePath : 'activity stream'}: ${error.message}`;
-    if (error.keyword === 'additionalProperties') {
-        err += `: ${error.params.additionalProperty}`;
-    }
-    else if (error.keyword === 'enum') {
-        err += `: ${error.params.allowedValues.join(', ')}`;
-    }
-    return err;
-}
-function getTypeList(msg) {
-    var _a;
-    let types = [];
-    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])];
-        }
-    }
-    return types;
-}
-function getSchemaType(error) {
-    const schemaTypeRes = error.schemaPath.match(/#\/\w+\/\w+\/([\w-]+)\//);
-    return schemaTypeRes ? schemaTypeRes[1] : undefined;
-}
-function getErrType(error) {
-    const errTypeRes = error.instancePath.match(/\/(\w+)/);
-    return errTypeRes ? errTypeRes[1] : undefined;
-}
-function getPartsCount(error, types) {
-    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;
-}
-function getTypes(msg) {
-    return {
-        actor: getTypeList(msg.actor),
-        target: getTypeList(msg.target),
-        object: getTypeList(msg.context ? msg.object : msg)
-    };
-}
-/**
- * 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}
- */
-function getErrorMessage(msg, errors) {
-    const types = getTypes(msg);
-    let deepest_entry = 0, highest_depth = -1;
-    for (let i = 0; i < errors.length; i++) {
-        const partsCount = getPartsCount(errors[i], types);
-        if (partsCount > highest_depth) {
-            highest_depth = partsCount;
-            deepest_entry = i;
-        }
-    }
-    return highest_depth >= 0 ?
-        parseMsg(errors[deepest_entry]) :
-        composeFinalError(errors[errors.length - 1]);
-}
-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;
-    if (error.keyword === 'oneOf') {
-        msg = `${error.instancePath}: ${error.message}: ` +
-            `${objects_1.ObjectTypesList.join(', ')}`;
-    }
-    else {
-        msg = `${error.instancePath ?
-            error.instancePath : 'activity stream'}: ${error.message}`;
-    }
-    return msg;
-}

package/dist/helpers/objects.d.ts

@@ -1,206 +0,0 @@
-export declare const validObjectRefs: any[];
-export declare const validObjectDefs: {};
-export declare const ObjectTypesSchema: {
-    credentials: {
-        required: string[];
-        additionalProperties: boolean;
-        properties: {
-            type: {
-                enum: string[];
-            };
-        };
-    };
-    feed: {
-        required: string[];
-        additionalProperties: boolean;
-        properties: {
-            type: {
-                enum: string[];
-            };
-            id: {
-                type: string;
-                format: string;
-            };
-            name: {
-                type: string;
-            };
-            description: {
-                type: string;
-            };
-            author: {
-                type: string;
-            };
-            favicon: {
-                type: string;
-            };
-        };
-    };
-    message: {
-        required: string[];
-        additionalProperties: boolean;
-        properties: {
-            type: {
-                enum: string[];
-            };
-            id: {
-                type: string;
-            };
-            name: {
-                type: string;
-            };
-            content: {
-                type: string;
-            };
-        };
-    };
-    me: {
-        required: string[];
-        additionalProperties: boolean;
-        properties: {
-            type: {
-                enum: string[];
-            };
-            content: {
-                type: string;
-            };
-        };
-    };
-    person: {
-        required: string[];
-        additionalProperties: boolean;
-        properties: {
-            id: {
-                type: string;
-            };
-            type: {
-                enum: string[];
-            };
-            name: {
-                type: string;
-            };
-        };
-    };
-    room: {
-        required: string[];
-        additionalProperties: boolean;
-        properties: {
-            id: {
-                type: string;
-            };
-            type: {
-                enum: string[];
-            };
-            name: {
-                type: string;
-            };
-        };
-    };
-    service: {
-        required: string[];
-        additionalProperties: boolean;
-        properties: {
-            id: {
-                type: string;
-            };
-            type: {
-                enum: string[];
-            };
-            name: {
-                type: string;
-            };
-        };
-    };
-    website: {
-        required: string[];
-        additionalProperties: boolean;
-        properties: {
-            id: {
-                type: string;
-                format: string;
-            };
-            type: {
-                enum: string[];
-            };
-            name: {
-                type: string;
-            };
-        };
-    };
-    attendance: {
-        required: string[];
-        additionalProperties: boolean;
-        properties: {
-            type: {
-                enum: string[];
-            };
-            members: {
-                type: string;
-                items: {
-                    type: string;
-                };
-            };
-        };
-    };
-    presence: {
-        required: string[];
-        additionalProperties: boolean;
-        properties: {
-            type: {
-                enum: string[];
-            };
-            presence: {
-                enum: string[];
-            };
-            role: {
-                enum: string[];
-            };
-            content: {
-                type: string;
-            };
-        };
-    };
-    relationship: {
-        required: string[];
-        additionalProperties: boolean;
-        properties: {
-            type: {
-                enum: string[];
-            };
-            relationship: {
-                enum: string[];
-            };
-            subject: {
-                type: string;
-                oneOf: {
-                    $ref: string;
-                }[];
-            };
-            object: {
-                type: string;
-                oneOf: any[];
-            };
-        };
-    };
-    topic: {
-        required: string[];
-        additionalProperties: boolean;
-        properties: {
-            type: {
-                enum: string[];
-            };
-            content: {
-                type: string;
-            };
-        };
-    };
-    address: {
-        required: string[];
-        additionalProperties: boolean;
-        properties: {
-            type: {
-                enum: string[];
-            };
-        };
-    };
-};
-export declare const ObjectTypesList: string[];

package/dist/helpers/objects.js

@@ -1,217 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ObjectTypesList = exports.ObjectTypesSchema = exports.validObjectDefs = exports.validObjectRefs = void 0;
-exports.validObjectRefs = [];
-exports.validObjectDefs = {};
-exports.ObjectTypesSchema = {
-    "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"
-            }
-        }
-    },
-    // inspired by https://www.w3.org/ns/activitystreams#Relationship
-    "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": exports.validObjectRefs,
-            }
-        }
-    },
-    "topic": {
-        "required": ["type"],
-        "additionalProperties": false,
-        "properties": {
-            "type": {
-                "enum": ["topic"]
-            },
-            "content": {
-                "type": "string"
-            }
-        }
-    },
-    "address": {
-        "required": ["type"],
-        "additionalProperties": false,
-        "properties": {
-            "type": {
-                "enum": ["address"]
-            }
-        }
-    }
-};
-exports.ObjectTypesList = Object.keys(exports.ObjectTypesSchema);
-exports.ObjectTypesList.forEach(function (type) {
-    if (type === 'credentials') {
-        return;
-    }
-    exports.validObjectRefs.push({ "$ref": "#/definitions/type/" + type });
-    exports.validObjectDefs[type] = exports.ObjectTypesSchema[type];
-});

package/dist/index.d.ts

@@ -1,15 +0,0 @@
-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";
-declare const _default: {
-    addPlatformSchema: typeof addPlatformSchema;
-    validatePlatformSchema: typeof validatePlatformSchema;
-    validateCredentials: typeof validateCredentials;
-    validateActivityStream: typeof validateActivityStream;
-    validateActivityObject: typeof validateActivityObject;
-};
-export default _default;
-export { PlatformSchema, ActivityObjectSchema, ActivityStreamSchema, ObjectTypesList };
-export * from "./types";

package/dist/index.js

@@ -1,37 +0,0 @@
-"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 };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ObjectTypesList = exports.ActivityStreamSchema = exports.ActivityObjectSchema = exports.PlatformSchema = void 0;
-const validator_1 = require("./validator");
-const objects_1 = require("./helpers/objects");
-Object.defineProperty(exports, "ObjectTypesList", { enumerable: true, get: function () { return objects_1.ObjectTypesList; } });
-const activity_object_1 = __importDefault(require("./schemas/activity-object"));
-exports.ActivityObjectSchema = activity_object_1.default;
-const activity_stream_1 = __importDefault(require("./schemas/activity-stream"));
-exports.ActivityStreamSchema = activity_stream_1.default;
-const platform_1 = __importDefault(require("./schemas/platform"));
-exports.PlatformSchema = platform_1.default;
-exports.default = {
-    addPlatformSchema: validator_1.addPlatformSchema,
-    validatePlatformSchema: validator_1.validatePlatformSchema,
-    validateCredentials: validator_1.validateCredentials,
-    validateActivityStream: validator_1.validateActivityStream,
-    validateActivityObject: validator_1.validateActivityObject,
-};
-__exportStar(require("./types"), exports);

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

@@ -1,37 +0,0 @@
-declare const _default: ((string | boolean | {
-    type: string;
-    object: {
-        type: string;
-    };
-})[] | (string | boolean | {
-    context: string;
-    object: {
-        type: string;
-    };
-})[] | (string | boolean | {
-    context: string;
-    type: string;
-    object: {
-        type: string;
-        user: string;
-        pass: string;
-    };
-})[] | (string | boolean | {
-    context: string;
-    type: string;
-    object: {
-        type: string;
-        username: string;
-        password: string;
-    };
-})[] | (string | boolean | {
-    context: string;
-    type: string;
-    object: {
-        type: string;
-        username: string;
-        password: string;
-        host: string;
-    };
-})[])[];
-export default _default;

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

@@ -1,69 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.default = [
-    [
-        'credentials with no context',
-        {
-            type: 'credentials',
-            object: {
-                type: 'credentials'
-            }
-        },
-        false,
-        `credential activity streams must have a context set`
-    ],
-    [
-        'credentials with no type',
-        {
-            context: 'test-platform',
-            object: {
-                type: 'credentials'
-            }
-        },
-        false,
-        `credential activity streams must have credentials set as type`
-    ],
-    [
-        'credentials with props',
-        {
-            context: 'test-platform',
-            type: 'credentials',
-            object: {
-                type: 'credentials',
-                user: "foo",
-                pass: "bar"
-            }
-        },
-        false,
-        `/object: must NOT have additional properties`
-    ],
-    [
-        'credentials with props',
-        {
-            context: 'test-platform',
-            type: 'credentials',
-            object: {
-                type: 'credentials',
-                username: "foo",
-                password: "bar"
-            }
-        },
-        false,
-        `/object: must have required property 'host'`
-    ],
-    [
-        'credentials with props',
-        {
-            context: 'test-platform',
-            type: 'credentials',
-            object: {
-                type: 'credentials',
-                username: "foo",
-                password: "bar",
-                host: 'yarg'
-            }
-        },
-        true,
-        ""
-    ],
-];