@alistigo/list-document 0.4.0

package/dist/types/list.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"list.js","sourceRoot":"","sources":["../../src/types/list.ts"],"names":[],"mappings":""}

package/dist/types.d.ts

@@ -0,0 +1,3 @@
+export * from "@alistigo/core-document";
+export * from "./types/list.js";
+//# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,cAAc,yBAAyB,CAAC;AACxC,cAAc,iBAAiB,CAAC"}

package/dist/types.js

@@ -0,0 +1,3 @@
+export * from "@alistigo/core-document";
+export * from "./types/list.js";
+//# sourceMappingURL=types.js.map

package/dist/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,cAAc,yBAAyB,CAAC;AACxC,cAAc,iBAAiB,CAAC"}

package/dist/validate.d.ts

@@ -0,0 +1,12 @@
+export interface ValidationResult {
+    valid: boolean;
+    errors: string[];
+}
+/**
+ * Validate that an unknown JSON value conforms to the Alistigo document schema.
+ *
+ * Lazily resolves `ajv` and `ajv-formats` from the consumer's node_modules so
+ * we don't pull them in for non-validating consumers.
+ */
+export declare function validateDocument(input: unknown): Promise<ValidationResult>;
+//# sourceMappingURL=validate.d.ts.map

package/dist/validate.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"validate.d.ts","sourceRoot":"","sources":["../src/validate.ts"],"names":[],"mappings":"AAKA,MAAM,WAAW,gBAAgB;IAC/B,KAAK,EAAE,OAAO,CAAC;IACf,MAAM,EAAE,MAAM,EAAE,CAAC;CAClB;AAgBD;;;;;GAKG;AACH,wBAAsB,gBAAgB,CAAC,KAAK,EAAE,OAAO,GAAG,OAAO,CAAC,gBAAgB,CAAC,CAiBhF"}

package/dist/validate.js

@@ -0,0 +1,39 @@
+import alistigoDocumentSchema from "@alistigo/core-document/schemas/alistigo-document.json" with {
+    type: "json"
+};
+import documentSchema from "./schemas/document.json" with { type: "json" };
+// schema.org's `Thing` (base of ItemList) defines @context as {type:"string"},
+// which conflicts with our @context object. Register a permissive stub for the
+// schema:ItemList $ref so it resolves without enforcing schema.org constraints.
+// The installed schema-org-json-schemas package is used for schema flattening
+// (via $RefParser.bundle) where AJV is not involved.
+const SCHEMA_ORG_STUBS = [
+    { $id: "schema:Thing", type: "object" },
+    { $id: "schema:Action", type: "object" },
+    { $id: "schema:Person", type: "object" },
+    { $id: "schema:SoftwareApplication", type: "object" },
+    { $id: "schema:ItemList", type: "object" },
+    { $id: "schema:ListItem", type: "object" },
+];
+/**
+ * Validate that an unknown JSON value conforms to the Alistigo document schema.
+ *
+ * Lazily resolves `ajv` and `ajv-formats` from the consumer's node_modules so
+ * we don't pull them in for non-validating consumers.
+ */
+export async function validateDocument(input) {
+    // biome-ignore lint/suspicious/noExplicitAny: dynamic import of optional peer
+    const Ajv = (await import("ajv/dist/2020.js")).default;
+    // biome-ignore lint/suspicious/noExplicitAny: dynamic import of optional peer
+    const addFormats = (await import("ajv-formats")).default;
+    const ajv = new Ajv({ allErrors: true, strict: false });
+    addFormats(ajv);
+    for (const stub of SCHEMA_ORG_STUBS)
+        ajv.addSchema(stub);
+    ajv.addSchema(alistigoDocumentSchema);
+    const validate = ajv.compile(documentSchema);
+    const valid = validate(input);
+    const errors = (validate.errors ?? []).map((e) => `${e.instancePath || "/"} ${e.message ?? ""}`.trim());
+    return { valid, errors };
+}
+//# sourceMappingURL=validate.js.map

package/dist/validate.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"validate.js","sourceRoot":"","sources":["../src/validate.ts"],"names":[],"mappings":"AAAA,OAAO,sBAAsB,MAAM,wDAAwD,CAAC;IAC1F,IAAI,EAAE,MAAM;CACb,CAAC;AACF,OAAO,cAAc,MAAM,yBAAyB,CAAC,OAAO,IAAI,EAAE,MAAM,EAAE,CAAC;AAO3E,+EAA+E;AAC/E,+EAA+E;AAC/E,gFAAgF;AAChF,8EAA8E;AAC9E,qDAAqD;AACrD,MAAM,gBAAgB,GAAG;IACvB,EAAE,GAAG,EAAE,cAAc,EAAE,IAAI,EAAE,QAAQ,EAAE;IACvC,EAAE,GAAG,EAAE,eAAe,EAAE,IAAI,EAAE,QAAQ,EAAE;IACxC,EAAE,GAAG,EAAE,eAAe,EAAE,IAAI,EAAE,QAAQ,EAAE;IACxC,EAAE,GAAG,EAAE,4BAA4B,EAAE,IAAI,EAAE,QAAQ,EAAE;IACrD,EAAE,GAAG,EAAE,iBAAiB,EAAE,IAAI,EAAE,QAAQ,EAAE;IAC1C,EAAE,GAAG,EAAE,iBAAiB,EAAE,IAAI,EAAE,QAAQ,EAAE;CAClC,CAAC;AAEX;;;;;GAKG;AACH,MAAM,CAAC,KAAK,UAAU,gBAAgB,CAAC,KAAc;IACnD,8EAA8E;IAC9E,MAAM,GAAG,GAAG,CAAC,MAAM,MAAM,CAAC,kBAAkB,CAAC,CAAC,CAAC,OAAc,CAAC;IAC9D,8EAA8E;IAC9E,MAAM,UAAU,GAAG,CAAC,MAAM,MAAM,CAAC,aAAa,CAAC,CAAC,CAAC,OAAc,CAAC;IAEhE,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,EAAE,SAAS,EAAE,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,CAAC;IACxD,UAAU,CAAC,GAAG,CAAC,CAAC;IAChB,KAAK,MAAM,IAAI,IAAI,gBAAgB;QAAE,GAAG,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;IACzD,GAAG,CAAC,SAAS,CAAC,sBAAsB,CAAC,CAAC;IAEtC,MAAM,QAAQ,GAAG,GAAG,CAAC,OAAO,CAAC,cAAc,CAAC,CAAC;IAC7C,MAAM,KAAK,GAAG,QAAQ,CAAC,KAAK,CAAY,CAAC;IACzC,MAAM,MAAM,GAAG,CAAC,QAAQ,CAAC,MAAM,IAAI,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,CAA6C,EAAE,EAAE,CAC3F,GAAG,CAAC,CAAC,YAAY,IAAI,GAAG,IAAI,CAAC,CAAC,OAAO,IAAI,EAAE,EAAE,CAAC,IAAI,EAAE,CACrD,CAAC;IACF,OAAO,EAAE,KAAK,EAAE,MAAM,EAAE,CAAC;AAC3B,CAAC"}

package/package.json

@@ -0,0 +1,57 @@
+{
+  "name": "@alistigo/list-document",
+  "version": "0.4.0",
+  "license": "MIT",
+  "author": {
+    "name": "Mikael Labrut",
+    "email": "contact@alistigo.com"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/alistigo/holos.git",
+    "directory": "packages/list-document"
+  },
+  "bugs": {
+    "url": "https://github.com/alistigo/holos/issues"
+  },
+  "homepage": "https://github.com/alistigo/holos/tree/main/packages/list-document#readme",
+  "alistigo": {
+    "type": "document"
+  },
+  "keywords": [
+    "alistigo",
+    "list",
+    "document",
+    "json-schema",
+    "json-ld",
+    "typescript"
+  ],
+  "private": false,
+  "type": "module",
+  "description": "Specification, JSON schemas, and TypeScript types for the Alistigo list document format.",
+  "exports": {
+    ".": {
+      "import": "./dist/index.js",
+      "types": "./dist/index.d.ts"
+    },
+    "./schemas/document.json": "./src/schemas/document.json"
+  },
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "files": [
+    "dist",
+    "src/schemas",
+    "docs"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "dependencies": {
+    "ajv": "^8.17.0",
+    "ajv-formats": "^3.0.1",
+    "schema-dts": "^2.0.0",
+    "@alistigo/list-domain": "0.3.2",
+    "@alistigo/core-document": "0.2.0",
+    "@alistigo/logger": "0.3.2"
+  }
+}

package/src/schemas/alistigo-document.json

@@ -0,0 +1,117 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://schemas.alistigo.com/v1/documents/alistigo-document.json",
+  "title": "Alistigo Document",
+  "description": "Common properties shared by all Alistigo artifact documents",
+  "type": "object",
+  "allOf": [
+    {
+      "$ref": "schema:Thing"
+    }
+  ],
+  "required": ["alistigo:eventLog", "@type", "@id"],
+  "properties": {
+    "alistigo:eventLog": {
+      "type": "array",
+      "items": {
+        "$ref": "#/$defs/Event"
+      }
+    },
+    "alistigo:agents": {
+      "type": "array",
+      "items": {
+        "$ref": "#/$defs/Agent"
+      }
+    },
+    "alistigo:plugins": {
+      "type": "array",
+      "items": {
+        "$ref": "#/$defs/Plugin"
+      }
+    }
+  },
+  "$defs": {
+    "Reference": {
+      "type": "object",
+      "required": ["@id"],
+      "properties": {
+        "@id": { "type": "string" }
+      }
+    },
+    "Event": {
+      "allOf": [
+        {
+          "$ref": "schema:Action"
+        },
+        {
+          "type": "object",
+          "required": ["@id", "alistigo:eventType", "agent", "startTime"],
+          "properties": {
+            "@id": {
+              "type": "string"
+            },
+            "alistigo:eventType": {
+              "type": "string"
+            },
+            "agent": {
+              "$ref": "#/$defs/Reference"
+            },
+            "startTime": {
+              "type": "string",
+              "format": "date-time"
+            }
+          }
+        }
+      ]
+    },
+    "Agent": {
+      "oneOf": [
+        {
+          "$ref": "#/$defs/Person"
+        },
+        {
+          "$ref": "#/$defs/SoftwareApplication"
+        }
+      ]
+    },
+    "Person": {
+      "type": "object",
+      "required": ["@type", "@id", "name"],
+      "properties": {
+        "@type": { "const": "Person" }
+      },
+      "allOf": [
+        {
+          "$ref": "schema:Person"
+        }
+      ]
+    },
+    "SoftwareApplication": {
+      "type": "object",
+      "required": ["@type", "@id", "name"],
+      "properties": {
+        "@type": { "const": "SoftwareApplication" }
+      },
+      "allOf": [
+        {
+          "$ref": "schema:SoftwareApplication"
+        }
+      ]
+    },
+    "Plugin": {
+      "type": "object",
+      "required": ["name"],
+      "properties": {
+        "name": {
+          "type": "string"
+        },
+        "version": {
+          "type": "string"
+        },
+        "config": {
+          "type": "object"
+        }
+      }
+    }
+  }
+}

package/src/schemas/document.json

@@ -0,0 +1,83 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://schemas.alistigo.com/v1/documents/list.json",
+  "title": "Alistigo List Document",
+  "description": "A list document",
+  "type": "object",
+  "allOf": [
+    { "$ref": "schema:ItemList" },
+    { "$ref": "https://schemas.alistigo.com/v1/documents/alistigo-document.json" }
+  ],
+  "required": ["@context", "@type", "@id", "itemListElement"],
+  "properties": {
+    "@context": {
+      "type": "object",
+      "required": ["@vocab", "alistigo"],
+      "properties": {
+        "@vocab": { "type": "string", "const": "https://schema.org/" },
+        "alistigo": { "type": "string", "const": "https://json-ld.alistigo.com/vocab/" }
+      }
+    },
+    "@type": { "type": "string", "const": "ItemList" },
+    "@id": { "type": "string", "pattern": "^lst_" },
+    "name": { "type": "string" },
+    "itemListElement": {
+      "type": "array",
+      "items": { "$ref": "#/$defs/ListItem" }
+    },
+    "alistigo:eventLog": {
+      "type": "array",
+      "items": { "$ref": "#/$defs/ListEventRecord" }
+    }
+  },
+  "$defs": {
+    "Reference": {
+      "type": "object",
+      "required": ["@id"],
+      "properties": {
+        "@id": { "type": "string" }
+      }
+    },
+    "ListItem": {
+      "allOf": [
+        { "$ref": "schema:ListItem" },
+        {
+          "type": "object",
+          "required": ["@type", "alistigo:listElementId", "position", "name"],
+          "properties": {
+            "@type": { "type": "string", "const": "ListItem" },
+            "alistigo:listElementId": { "type": "string", "pattern": "^lse_" },
+            "position": { "type": "integer", "minimum": 1 },
+            "name": { "type": "string", "minLength": 1 },
+            "alistigo:metadatas": {
+              "type": "object",
+              "additionalProperties": { "type": "object" }
+            }
+          }
+        }
+      ]
+    },
+    "ListEventRecord": {
+      "type": "object",
+      "required": ["@id", "alistigo:eventType", "list", "agent", "startTime"],
+      "properties": {
+        "@id": { "type": "string" },
+        "alistigo:eventType": {
+          "type": "string",
+          "enum": [
+            "ListCreated",
+            "ListElementAdded",
+            "ListElementDeleted",
+            "ListExported",
+            "ListElementChecked"
+          ]
+        },
+        "list": { "$ref": "#/$defs/Reference" },
+        "agent": { "$ref": "#/$defs/Reference" },
+        "startTime": { "type": "string", "format": "date-time" },
+        "listItem": { "$ref": "#/$defs/Reference" },
+        "checked": { "type": "boolean" }
+      }
+    }
+  }
+}