@sockethub/schemas 3.0.0-alpha.12 → 3.0.0-alpha.13

package/src/index.test.ts

@@ -1,127 +0,0 @@
-import { describe, expect, it } from "bun:test";
-import type { ActivityObject, 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 {
-    addPlatformContext,
-    addPlatformSchema,
-    getPlatformSchema,
-    validateActivityObject,
-    validateActivityStream,
-    validateCredentials,
-    validatePlatformSchema,
-} from "./validator";
-
-const permissiveMessageSchema = {
-    required: ["type"],
-    properties: {
-        type: {
-            type: "string",
-        },
-    },
-};
-
-addPlatformSchema(permissiveMessageSchema, "irc/messages");
-addPlatformSchema(permissiveMessageSchema, "dood/messages");
-addPlatformSchema(
-    testPlatformSchemaData.credentials,
-    "test-platform/credentials",
-);
-addPlatformContext(
-    "irc",
-    "https://sockethub.org/ns/context/platform/irc/v1.jsonld",
-);
-addPlatformContext(
-    "dood",
-    "https://sockethub.org/ns/context/platform/dood/v1.jsonld",
-);
-addPlatformContext(
-    "test-platform",
-    "https://sockethub.org/ns/context/platform/test-platform/v1.jsonld",
-);
-
-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";
-            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 ActivityObject);
-                        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,56 +0,0 @@
-import {
-    AS2_BASE_CONTEXT_URL,
-    buildCanonicalContext,
-    ERROR_PLATFORM_CONTEXT_URL,
-    ERROR_PLATFORM_ID,
-    INTERNAL_PLATFORM_CONTEXT_URL,
-    INTERNAL_PLATFORM_ID,
-    PLATFORM_CONTEXT_PREFIX,
-    SOCKETHUB_BASE_CONTEXT_URL,
-} from "./context.js";
-import { InternalObjectTypesList, 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 { SockethubConfigSchema } from "./schemas/sockethub-config.js";
-import {
-    addPlatformContext,
-    addPlatformSchema,
-    getPlatformSchema,
-    registerSystemPlatformContexts,
-    resolvePlatformId,
-    setValidationErrorOptions,
-    validateActivityObject,
-    validateActivityStream,
-    validateCredentials,
-    validatePlatformSchema,
-} from "./validator.js";
-
-export {
-    AS2_BASE_CONTEXT_URL,
-    SOCKETHUB_BASE_CONTEXT_URL,
-    PLATFORM_CONTEXT_PREFIX,
-    ERROR_PLATFORM_ID,
-    ERROR_PLATFORM_CONTEXT_URL,
-    INTERNAL_PLATFORM_ID,
-    INTERNAL_PLATFORM_CONTEXT_URL,
-    buildCanonicalContext,
-    addPlatformContext,
-    addPlatformSchema,
-    getPlatformSchema,
-    resolvePlatformId,
-    registerSystemPlatformContexts,
-    validatePlatformSchema,
-    validateCredentials,
-    validateActivityStream,
-    validateActivityObject,
-    setValidationErrorOptions,
-    PlatformSchema,
-    ActivityObjectSchema,
-    ActivityStreamSchema,
-    SockethubConfigSchema,
-    ObjectTypesList,
-    InternalObjectTypesList,
-};
-
-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,75 +0,0 @@
-import {
-    AS2_BASE_CONTEXT_URL,
-    SOCKETHUB_BASE_CONTEXT_URL,
-} from "../context.js";
-import {
-    ObjectTypesList,
-    ObjectTypesSchema,
-    validActorRefs,
-    validTargetRefs,
-} from "../helpers/objects.js";
-
-const validObjectRefs = [];
-
-for (const type of ObjectTypesList) {
-    validObjectRefs.push({ $ref: `#/definitions/type/${type}` });
-}
-
-const contextSchema = {
-    type: "array",
-    minItems: 3,
-    maxItems: 3,
-    items: {
-        type: "string",
-    },
-    allOf: [
-        {
-            contains: {
-                const: AS2_BASE_CONTEXT_URL,
-            },
-        },
-        {
-            contains: {
-                const: SOCKETHUB_BASE_CONTEXT_URL,
-            },
-        },
-    ],
-};
-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: {
-        "@context": contextSchema,
-        id: {
-            type: "string",
-        },
-        type: typeSchema,
-        actor: {
-            type: "object",
-            oneOf: validActorRefs,
-        },
-        target: {
-            type: "object",
-            oneOf: validTargetRefs,
-        },
-        object: {
-            type: "object",
-            oneOf: validObjectRefs,
-        },
-        published: {
-            type: "string",
-            format: "date-time",
-        },
-    },
-
-    definitions: {
-        type: ObjectTypesSchema,
-    },
-};

package/src/schemas/json/activity-object.json

@@ -1,405 +0,0 @@
-{
-	"$id": "https://sockethub.org/schemas/3.0.0-alpha.12/activity-object.json",
-	"description": "Schema for Sockethub Activity Objects",
-	"type": "object",
-	"required": [
-		"object"
-	],
-	"properties": {
-		"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/platform"
-				},
-				{
-					"$ref": "#/definitions/type/website"
-				},
-				{
-					"$ref": "#/definitions/type/attendance"
-				},
-				{
-					"$ref": "#/definitions/type/presence"
-				},
-				{
-					"$ref": "#/definitions/type/relationship"
-				},
-				{
-					"$ref": "#/definitions/type/topic"
-				},
-				{
-					"$ref": "#/definitions/type/address"
-				},
-				{
-					"$ref": "#/definitions/type/heartbeat"
-				}
-			]
-		}
-	},
-	"definitions": {
-		"type": {
-			"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"
-					}
-				}
-			},
-			"platform": {
-				"required": [
-					"id",
-					"type"
-				],
-				"additionalProperties": true,
-				"properties": {
-					"id": {
-						"type": "string"
-					},
-					"type": {
-						"enum": [
-							"platform"
-						]
-					},
-					"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/platform"
-							},
-							{
-								"$ref": "#/definitions/type/website"
-							},
-							{
-								"$ref": "#/definitions/type/attendance"
-							},
-							{
-								"$ref": "#/definitions/type/presence"
-							},
-							{
-								"$ref": "#/definitions/type/relationship"
-							},
-							{
-								"$ref": "#/definitions/type/topic"
-							},
-							{
-								"$ref": "#/definitions/type/address"
-							},
-							{
-								"$ref": "#/definitions/type/heartbeat"
-							}
-						]
-					}
-				}
-			},
-			"topic": {
-				"required": [
-					"type"
-				],
-				"additionalProperties": false,
-				"properties": {
-					"type": {
-						"enum": [
-							"topic"
-						]
-					},
-					"content": {
-						"type": "string"
-					}
-				}
-			},
-			"address": {
-				"required": [
-					"type"
-				],
-				"additionalProperties": false,
-				"properties": {
-					"type": {
-						"enum": [
-							"address"
-						]
-					}
-				}
-			},
-			"heartbeat": {
-				"required": [
-					"type",
-					"timestamp"
-				],
-				"additionalProperties": false,
-				"properties": {
-					"type": {
-						"enum": [
-							"heartbeat"
-						]
-					},
-					"timestamp": {
-						"type": "number"
-					}
-				}
-			}
-		}
-	}
-}