@sockethub/schemas 3.0.0-alpha.8 → 3.0.0-beta.0

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

@@ -1,498 +0,0 @@
-import { ObjectTypesList } from "./helpers/objects";
-
-export default [
-    [
-        "type:send, object:message",
-        {
-            type: "send",
-            context: "irc",
-            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",
-            },
-        },
-        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,
-        '[irc] /published: must match format "date-time"',
-    ],
-
-    [
-        "type:credentials, object:credentials",
-        {
-            type: "credentials",
-            context: "irc",
-            actor: {
-                id: "dood@irc.freenode.net",
-                type: "person",
-                name: "dood",
-            },
-            target: {
-                id: "irc.freenode.net/server",
-                type: "room",
-                name: "sockethub",
-            },
-            object: {
-                type: "credentials",
-            },
-        },
-        true,
-        "",
-    ],
-
-    [
-        "type:credentials",
-        {
-            context: "irc",
-            type: "credentials",
-            actor: {
-                id: "dood@irc.freenode.net",
-                type: "person",
-                name: "dood",
-            },
-            object: {
-                type: "credentials",
-                user: "foo",
-                pass: "bar",
-            },
-        },
-        true,
-        "",
-    ],
-
-    [
-        "bad target",
-        {
-            id: "blah",
-            type: "send",
-            context: "dood",
-            actor: {
-                id: "dood@irc.freenode.net",
-                type: "person",
-                name: "dood",
-            },
-            target: {
-                type: "person",
-                name: "bob",
-            },
-            object: {
-                type: "credentials",
-            },
-        },
-        false,
-        "[dood] /target: must have required property 'id'",
-    ],
-
-    [
-        "bad iri in object id",
-        {
-            type: "feed",
-            context: "dood",
-            actor: {
-                id: "dood@irc.freenode.net",
-                type: "person",
-            },
-            object: {
-                id: "example.org/some/path.html",
-                type: "website",
-            },
-        },
-        false,
-        '[dood] /object/id: must match format "iri"',
-    ],
-
-    [
-        "valid iri in object id",
-        {
-            type: "feed",
-            context: "dood",
-            actor: {
-                id: "dood@irc.freenode.net",
-                type: "person",
-            },
-            object: {
-                id: "https://example.org/some/path.html",
-                type: "website",
-            },
-        },
-        true,
-        "",
-    ],
-
-    [
-        "wrong actor type",
-        {
-            type: "send",
-            context: "dood",
-            actor: {
-                id: "doobar@freenode.net/channel",
-                type: "foo",
-                content: "hi there",
-            },
-            object: {
-                type: "feed",
-                id: "http://rss.example.org/feed.rss",
-            },
-        },
-        false,
-        `[dood] /actor: must match exactly one schema in oneOf: ${ObjectTypesList.join(
-            ", ",
-        )}`,
-    ],
-
-    [
-        "missing actor id",
-        {
-            id: "blah",
-            type: "send",
-            context: "dood",
-            actor: {
-                type: "person",
-                name: "dood",
-            },
-            target: {
-                id: "bob@crusty.net/Home",
-                type: "person",
-                name: "bob",
-            },
-            object: {
-                type: "feed",
-                id: "http://rss.example.org/feed.rss",
-            },
-        },
-        false,
-        "[dood] /actor: must have required property 'id'",
-    ],
-
-    [
-        "attendance request",
-        {
-            id: "blah",
-            type: "observe",
-            context: "dood",
-            actor: {
-                id: "dood",
-                type: "person",
-            },
-            target: {
-                id: "chatroom@crusty.net",
-                type: "room",
-            },
-            object: {
-                type: "attendance",
-            },
-        },
-        true,
-        "",
-    ],
-
-    [
-        "attendance response",
-        {
-            id: "blah",
-            type: "observe",
-            context: "dood",
-            actor: {
-                id: "chatroom@crusty.net",
-                type: "room",
-                name: "chatroom",
-            },
-            object: {
-                type: "attendance",
-                members: ["bill", "bob", "hank"],
-            },
-        },
-        true,
-        "",
-    ],
-
-    [
-        "invalid attendance request",
-        {
-            id: "blah",
-            type: "observe",
-            context: "dood",
-            actor: {
-                id: "dood",
-                type: "person",
-            },
-            target: {
-                id: "chatroom@crusty.net",
-                type: "room",
-            },
-            object: {
-                type: "attendance",
-                status: "foobar",
-            },
-        },
-        false,
-        "[dood] /object: must NOT have additional properties: status",
-    ],
-
-    [
-        "setting presence",
-        {
-            id: "blah",
-            type: "observe",
-            context: "dood",
-            actor: {
-                id: "dood",
-                type: "person",
-            },
-            object: {
-                type: "presence",
-                presence: "away",
-                content: "forgot the milk",
-            },
-            target: {
-                id: "chatroom@crusty.net",
-                type: "room",
-            },
-        },
-        true,
-        "",
-    ],
-
-    [
-        "setting invalid presence",
-        {
-            id: "blah",
-            type: "observe",
-            context: "dood",
-            actor: {
-                id: "dood",
-                type: "person",
-            },
-            object: {
-                type: "presence",
-                presence: "afk",
-                content: "forgot the milk",
-            },
-            target: {
-                id: "chatroom@crusty.net",
-                type: "room",
-            },
-        },
-        false,
-        "[dood] /object/presence: must be equal to one of the allowed values: " +
-            "away, chat, dnd, xa, offline, online",
-    ],
-
-    [
-        "setting topic",
-        {
-            id: "blah",
-            type: "observe",
-            context: "dood",
-            actor: {
-                id: "dood",
-                type: "person",
-            },
-            object: {
-                type: "topic",
-                content: "the topic is goats",
-            },
-            target: {
-                id: "chatroom@crusty.net",
-                type: "room",
-            },
-        },
-        true,
-        "",
-    ],
-
-    [
-        "setting topic incorrectly",
-        {
-            id: "blah",
-            type: "observe",
-            context: "dood",
-            actor: {
-                id: "dood",
-                type: "person",
-            },
-            object: {
-                type: "topic",
-                topic: "the topic is goats",
-            },
-            target: {
-                id: "chatroom@crusty.net",
-                type: "room",
-            },
-        },
-        false,
-        "[dood] /object: must NOT have additional properties: topic",
-    ],
-
-    [
-        "receive topic",
-        {
-            id: "blah",
-            type: "observe",
-            context: "dood",
-            actor: {
-                id: "chatroom@crusty.net",
-                type: "room",
-            },
-            object: {
-                type: "topic",
-                content: "the topic is goats",
-            },
-        },
-        true,
-        "",
-    ],
-
-    [
-        "change user address",
-        {
-            id: "blah",
-            type: "update",
-            context: "dood",
-            actor: {
-                id: "foobar@example.com",
-                type: "person",
-            },
-            object: {
-                type: "address",
-            },
-            target: {
-                id: "futurebar@example.com",
-                type: "person",
-            },
-        },
-        true,
-        "",
-    ],
-
-    [
-        "change user address incorrectly",
-        {
-            type: "update",
-            context: "dood",
-            actor: {
-                id: "foobar@example.com",
-                type: "person",
-            },
-            object: {
-                type: "address",
-                id: "futurebar@example.com",
-            },
-        },
-        false,
-        "[dood] /object: must NOT have additional properties: id",
-    ],
-
-    [
-        "invalid activity stream",
-        {
-            actor: { id: "irc://uuu@localhost", type: "person" },
-            context: "irc",
-            target: { id: "irc://irc.dooder.net/a-room", type: "room" },
-        },
-        false,
-        "[irc] activity stream: must have required property 'type'",
-    ],
-
-    [
-        "invalid room",
-        {
-            context: "irc",
-            type: "credentials",
-            actor: {
-                id: "sh-9K3Vk@irc.freenode.net",
-                type: "person",
-            },
-            target: {
-                type: "room",
-                name: "sh-9K3Vk",
-            },
-        },
-        false,
-        "[irc] /target: must have required property 'id'",
-    ],
-
-    [
-        "relationship",
-        {
-            context: "irc",
-            type: "add",
-            actor: { type: "person", id: "alice@localhost", name: "alice" },
-            target: { type: "person", id: "Kilroy@localhost", name: "Kilroy" },
-            object: {
-                type: "relationship",
-                relationship: "role",
-                subject: {
-                    type: "presence",
-                    role: "owner",
-                },
-                object: {
-                    type: "room",
-                    id: "localhost/#Finnish",
-                    name: "#Finnish",
-                },
-            },
-        },
-        true,
-        "",
-    ],
-
-    [
-        "invalid role in relationship",
-        {
-            context: "irc",
-            type: "add",
-            actor: { type: "person", id: "alice@localhost", name: "alice" },
-            target: { type: "person", id: "Kilroy@localhost", name: "Kilroy" },
-            object: {
-                type: "relationship",
-                relationship: "role",
-                subject: {
-                    type: "presence",
-                    role: "manager",
-                },
-                object: {
-                    type: "room",
-                    id: "localhost/#Finnish",
-                    name: "#Finnish",
-                },
-            },
-        },
-        false,
-        "[irc] /object/subject/role: must be equal to one of the allowed values: " +
-            "owner, member, participant, admin",
-    ],
-];

package/src/index.test.ts

@@ -1,99 +0,0 @@
-import { describe, expect, it } from "bun:test";
-import type { ActivityStream } from "./types";
-
-import testCredentialsData from "./index.test.data.credentials";
-import testActivityObjectsData from "./index.test.data.objects";
-import testPlatformSchemaData from "./index.test.data.platform";
-import testActivityStreamsData from "./index.test.data.streams";
-import { ActivityObjectSchema } from "./schemas/activity-object";
-import { ActivityStreamSchema } from "./schemas/activity-stream";
-import {
-    addPlatformSchema,
-    getPlatformSchema,
-    validateActivityObject,
-    validateActivityStream,
-    validateCredentials,
-    validatePlatformSchema,
-} from "./validator";
-
-describe("schemas/src/index.ts", () => {
-    describe("Platform schema validation", () => {
-        it("returns an empty error for a valid schema", () => {
-            const err = validatePlatformSchema(testPlatformSchemaData);
-            expect(err).toEqual("");
-        });
-        it("returns an error for an invalid schema", () => {
-            const err = validatePlatformSchema({ foo: "bar" });
-            expect(err).toEqual(
-                "platform schema failed to validate:  must have required property 'name'",
-            );
-        });
-    });
-
-    describe("Adding a PlatformSchema", () => {
-        it("returns the same schema when fetched", () => {
-            const platform_type = "test-platform/credentials";
-            addPlatformSchema(testPlatformSchemaData.credentials, platform_type);
-            const compiledSchema = getPlatformSchema(platform_type);
-            expect(compiledSchema.schema).toEqual(
-                testPlatformSchemaData.credentials,
-            );
-        });
-    });
-
-    describe("Credentials", () => {
-        testCredentialsData.forEach(
-            ([name, creds, expectedResult, expectedFailureMessage]) => {
-                describe("validateCredential " + name, () => {
-                    it(`returns expected result`, () => {
-                        const err = validateCredentials(creds as ActivityStream);
-                        expect(err).toEqual(expectedFailureMessage);
-                        expect(!err).toEqual(expectedResult);
-                    });
-                });
-            },
-        );
-    });
-
-    describe("ActivityObject", () => {
-        it("has expected properties", () => {
-            expect(typeof ActivityObjectSchema).toEqual("object");
-            expect(ActivityObjectSchema["$id"]).toEqual(
-                "https://sockethub.org/schemas/v/activity-object.json",
-            );
-        });
-
-        testActivityObjectsData.forEach(
-            ([name, ao, expectedResult, expectedFailureMessage]) => {
-                describe("validateActivityObject " + name, () => {
-                    it(`returns expected result`, () => {
-                        const err = validateActivityObject(ao as ActivityStream);
-                        expect(err).toEqual(expectedFailureMessage);
-                        expect(!err).toEqual(expectedResult);
-                    });
-                });
-            },
-        );
-    });
-
-    describe("ActivityStream", () => {
-        it("has expected properties", () => {
-            expect(typeof ActivityStreamSchema).toEqual("object");
-            expect(ActivityStreamSchema["$id"]).toEqual(
-                "https://sockethub.org/schemas/v/activity-stream.json",
-            );
-        });
-
-        testActivityStreamsData.forEach(
-            ([name, as, expectedResult, expectedFailureMessage]) => {
-                describe("validateActivityStream " + name, () => {
-                    it(`returns expected result`, () => {
-                        const err = validateActivityStream(as as ActivityStream);
-                        expect(err).toEqual(expectedFailureMessage);
-                        expect(!err).toEqual(expectedResult);
-                    });
-                });
-            },
-        );
-    });
-});

package/src/index.ts

@@ -1,27 +0,0 @@
-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 {
-    addPlatformSchema,
-    getPlatformSchema,
-    validatePlatformSchema,
-    validateCredentials,
-    validateActivityStream,
-    validateActivityObject,
-    PlatformSchema,
-    ActivityObjectSchema,
-    ActivityStreamSchema,
-    ObjectTypesList,
-};
-
-export * from "./types.js";

package/src/schemas/activity-object.ts

@@ -1,19 +0,0 @@
-import { validObjectDefs, validObjectRefs } from "../helpers/objects.js";
-
-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,
-        },
-    },
-
-    definitions: {
-        type: validObjectDefs,
-    },
-};

package/src/schemas/activity-stream.ts

@@ -1,54 +0,0 @@
-import { ObjectTypesList, ObjectTypesSchema } from "../helpers/objects.js";
-import { ActivityObjectSchema } from "./activity-object.js";
-
-const validActorRefs = ActivityObjectSchema.properties.object.oneOf;
-const validTargetRefs = ActivityObjectSchema.properties.object.oneOf;
-// console.log(validActorRefs);
-
-const validObjectRefs = [];
-
-for (const type of ObjectTypesList) {
-    validObjectRefs.push({ $ref: `#/definitions/type/${type}` });
-}
-
-const contextSchema = {
-    type: "string",
-};
-const typeSchema = {
-    type: "string",
-};
-
-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: typeSchema,
-        context: contextSchema,
-        actor: {
-            type: "object",
-            oneOf: validActorRefs,
-        },
-        target: {
-            type: "object",
-            oneOf: validTargetRefs,
-        },
-        object: {
-            type: "object",
-            oneOf: validObjectRefs,
-        },
-        published: {
-            type: "string",
-            format: "date-time",
-        },
-    },
-
-    definitions: {
-        type: ObjectTypesSchema,
-    },
-};