@lincs.project/webannotation-schema 1.0.3 → 1.1.0

package/dist/index.mjs

@@ -184,7 +184,7 @@ var require_polyfills = __commonJS({
           Object.setPrototypeOf(read, fs$read);
         return read;
       }(fs4.read);
-      fs4.readSync = typeof fs4.readSync !== "function" ? fs4.readSync : function(fs$readSync) {
+      fs4.readSync = typeof fs4.readSync !== "function" ? fs4.readSync : /* @__PURE__ */ function(fs$readSync) {
         return function(fd, buffer, offset, length, position) {
           var eagCounter = 0;
           while (true) {
@@ -2779,12 +2779,12 @@ var defsId = `https://wa.lincsproject.ca/${VERSION}/defs.jsonld`;
 var schemaContext = {
   "@context": {
     bf: "http://www.openlinksw.com/schemas/bif#",
-    cito: "https://sparontologies.github.io/cito/current/cito.html#",
-    cwrc: "http://id.lincsproject.ca/cwrc#",
-    edit: "http://id.lincsproject.ca/edit/#",
-    fabio: "https://purl.org/spar/fabio#",
-    frbroo: "https://www.iflastandards.info/fr/frbr/frbroo#",
-    wikidata: "https://www.wikidata.org/wiki/",
+    cito: "http://purl.org/spar/cito/",
+    cwrc: "http://id.lincsproject.ca/cwrc/",
+    edit: "http://id.lincsproject.ca/edit/",
+    fabio: "https://purl.org/spar/fabio/",
+    frbroo: "http://iflastandards.info/ns/fr/frbr/frbroo/",
+    wikidata: "http://www.wikidata.org/entity/",
     crm: "http://www.cidoc-crm.org/cidoc-crm/",
     crmdig: "http://www.ics.forth.gr/isl/CRMdig/",
     certainty: {
@@ -2873,7 +2873,7 @@ var softwareSchema = {
 };
 
 // src/v1/schema/definitions/body/index.ts
-import { z as z15 } from "zod";
+import { z as z16 } from "zod";
 
 // src/v1/schema/definitions/body/citation.ts
 import { z as z3 } from "zod";
@@ -2920,7 +2920,10 @@ var CitationEntityType = z3.tuple([
   z3.literal("crm:E73_Information_Object")
 ]);
 var Citation = z3.object({
-  id: z3.string().url({ message: "Must be an URI" }).describe("The IRI that identifies the Body resource."),
+  id: z3.union([
+    z3.string().url({ message: "Must be an URI" }).describe("The IRI that identifies the Body resource."),
+    z3.string().uuid({ message: "Must be an UUID" }).describe("UUID that identifies the annotation's body.")
+  ]),
   entityType: z3.tuple([z3.literal("cito:Citation"), z3.literal("crm:E73_Information_Object")]),
   certainty: Certainty.optional(),
   label: Label.optional(),
@@ -2946,7 +2949,10 @@ var ConceptualObjectEntityType = z4.union([
   ])
 ]);
 var ConceptualObject = z4.object({
-  id: z4.string().url({ message: "Must be an URI" }).describe("The IRI that identifies the Body resource."),
+  id: z4.union([
+    z4.string().url({ message: "Must be an URI" }).describe("The IRI that identifies the Body resource."),
+    z4.string().uuid({ message: "Must be an UUID" }).describe("UUID that identifies the annotation's body.")
+  ]),
   entityType: ConceptualObjectEntityType,
   certainty: Certainty.optional(),
   label: Label.optional(),
@@ -3017,7 +3023,10 @@ var KeywordEntityType = z7.tuple([
   z7.literal("crmdig:D1_Digital_Object")
 ]);
 var Keyword = z7.object({
-  id: z7.string().url().describe("The IRI that identifies the Body resource."),
+  id: z7.union([
+    z7.string().url({ message: "Must be an URI" }).describe("The IRI that identifies the Body resource."),
+    z7.string().uuid({ message: "Must be an UUID" }).describe("UUID that identifies the annotation's body.")
+  ]),
   entityType: KeywordEntityType,
   certainty: Certainty.optional(),
   label: Label.optional(),
@@ -3090,7 +3099,10 @@ var OrganizationEntityType = z10.tuple([
   ])
 ]);
 var Organization = z10.object({
-  id: z10.string().url({ message: "Must be an URI" }).describe("The IRI that identifies the Body resource."),
+  id: z10.union([
+    z10.string().url({ message: "Must be an URI" }).describe("The IRI that identifies the Body resource."),
+    z10.string().uuid({ message: "Must be an UUID" }).describe("UUID that identifies the annotation's body.")
+  ]),
   entityType: OrganizationEntityType,
   certainty: Certainty.optional(),
   label: Label.optional(),
@@ -3125,7 +3137,10 @@ var PersonEntityType = z11.tuple([
   ])
 ]);
 var Person = z11.object({
-  id: z11.string().url({ message: "Must be an URI" }).describe("The IRI that identifies the Body resource."),
+  id: z11.union([
+    z11.string().url({ message: "Must be an URI" }).describe("The IRI that identifies the Body resource."),
+    z11.string().uuid({ message: "Must be an UUID" }).describe("UUID that identifies the annotation's body.")
+  ]),
   entityType: PersonEntityType,
   certainty: Certainty.optional(),
   label: Label.optional(),
@@ -3149,7 +3164,12 @@ var personSchema = {
   type: "object",
   description: "A person entity",
   properties: {
-    id: { type: "string", format: "uri", description: "The IRI that identifies the Body resource" },
+    id: {
+      oneOf: [
+        { type: "string", format: "uri", description: "The IRI that identifies the Body resource" },
+        { type: "string", format: "uuid" }
+      ]
+    },
     entityType: personEntityTypeSchema,
     certainty: { $ref: "defs.jsonld#/definitions/certainty" },
     label: { $ref: "defs.jsonld#/definitions/label" },
@@ -3169,7 +3189,10 @@ var PhysicalThingEntityType = z12.union([
   ])
 ]);
 var PhysicalThing = z12.object({
-  id: z12.string().url({ message: "Must be an URI" }).describe("The IRI that identifies the Body resource."),
+  id: z12.union([
+    z12.string().url({ message: "Must be an URI" }).describe("The IRI that identifies the Body resource."),
+    z12.string().uuid({ message: "Must be an UUID" }).describe("UUID that identifies the annotation's body.")
+  ]),
   entityType: PhysicalThingEntityType,
   certainty: Certainty.optional(),
   label: Label.optional(),
@@ -3200,7 +3223,10 @@ var PlaceEntityType = z13.union([
   ])
 ]);
 var Place = z13.object({
-  id: z13.string().url({ message: "Must be an URI" }).describe("The IRI that identifies the Body resource."),
+  id: z13.union([
+    z13.string().url({ message: "Must be an URI" }).describe("The IRI that identifies the Body resource."),
+    z13.string().uuid({ message: "Must be an UUID" }).describe("UUID that identifies the annotation's body.")
+  ]),
   entityType: PlaceEntityType,
   certainty: Certainty.optional(),
   precision: Precision.optional(),
@@ -3232,7 +3258,10 @@ var WorkEntityType = z14.tuple([
   ])
 ]);
 var Work = z14.object({
-  id: z14.string().url({ message: "Must be an URI" }).describe("The IRI that identifies the Body resource."),
+  id: z14.union([
+    z14.string().url({ message: "Must be an URI" }).describe("The IRI that identifies the Body resource."),
+    z14.string().uuid({ message: "Must be an UUID" }).describe("UUID that identifies the annotation's body.")
+  ]),
   entityType: WorkEntityType,
   certainty: Certainty.optional(),
   label: Label.optional(),
@@ -3253,15 +3282,33 @@ var workEntityTypeSchema = {
   ]
 };
 
-// src/v1/schema/definitions/body/index.ts
-var DATE_PATTERN = "^(\\d{4})-(\\d{2})-(\\d{2})T(\\d{2}):(\\d{2}):(\\d{2}(?:.\\d*)?)((-(\\d{2}):(\\d{2})|Z)?)\\/(\\d{4})-(\\d{2})-(\\d{2})T(\\d{2}):(\\d{2}):(\\d{2}(?:.\\d*)?)((-(\\d{2}):(\\d{2})|Z)?)$";
-var Body = z15.object({
+// src/v1/schema/definitions/body/event.ts
+import { z as z15 } from "zod";
+var EventEntityType = z15.literal("PLACEHOLDER_FOR_EVENT");
+var Event = z15.object({
   id: z15.union([
     z15.string().url({ message: "Must be an URI" }).describe("The IRI that identifies the Body resource."),
     z15.string().uuid({ message: "Must be an UUID" }).describe("UUID that identifies the annotation's body.")
   ]),
-  type: z15.literal("TextualBody").optional(),
-  entityType: z15.union([
+  entityType: EventEntityType,
+  certainty: Certainty.optional(),
+  label: Label.optional(),
+  description: Description.optional()
+}).describe("Organization");
+var eventEntityTypeSchema = {
+  type: "string",
+  const: "PLACEHOLDER_FOR_EVENT"
+};
+
+// src/v1/schema/definitions/body/index.ts
+var DATE_PATTERN = "^(\\d{4})-(\\d{2})-(\\d{2})T(\\d{2}):(\\d{2}):(\\d{2}(?:.\\d*)?)((-(\\d{2}):(\\d{2})|Z)?)\\/(\\d{4})-(\\d{2})-(\\d{2})T(\\d{2}):(\\d{2}):(\\d{2}(?:.\\d*)?)((-(\\d{2}):(\\d{2})|Z)?)$";
+var Body = z16.object({
+  id: z16.union([
+    z16.string().url({ message: "Must be an URI" }).describe("The IRI that identifies the Body resource."),
+    z16.string().uuid({ message: "Must be an UUID" }).describe("UUID that identifies the annotation's body.")
+  ]),
+  type: z16.literal("TextualBody").optional(),
+  entityType: z16.union([
     PersonEntityType,
     PlaceEntityType,
     OrganizationEntityType,
@@ -3274,10 +3321,11 @@ var Body = z15.object({
     CorrectionEntityType,
     KeywordEntityType,
     KeywordFolksnomyEntityType,
-    LinkEntityType
+    LinkEntityType,
+    EventEntityType
   ]),
-  additionalType: z15.union([z15.string(), z15.string().array()]).optional().describe("Extra types that refines the body"),
-  value: z15.string().describe("The value of the body").optional(),
+  additionalType: z16.union([z16.string(), z16.string().array()]).optional().describe("Extra types that refines the body"),
+  value: z16.string().describe("The value of the body").optional(),
   certainty: Certainty.optional(),
   precision: Precision.optional(),
   label: Label.optional(),
@@ -3308,7 +3356,8 @@ var bodySchema = {
         correctionEntityTypeSchema,
         keywordEntityTypeSchema,
         keywordFolksnomyEntityTypeSchema,
-        linkEntityTypeSchema
+        linkEntityTypeSchema,
+        eventEntityTypeSchema
       ]
     },
     additionalType: {
@@ -3423,7 +3472,18 @@ var bodySchema = {
       },
       else: {
         type: "object",
-        properties: { id: { type: "string", format: "uri" } }
+        properties: {
+          id: {
+            oneOf: [
+              {
+                type: "string",
+                format: "uri",
+                description: "The IRI that identifies the Body resource"
+              },
+              { type: "string", format: "uuid" }
+            ]
+          }
+        }
       }
     }
     // ? TODO: Add more restrictions
@@ -3434,21 +3494,21 @@ var bodySchema = {
 };
 
 // src/v1/schema/definitions/target/index.ts
-import { z as z20 } from "zod";
+import { z as z21 } from "zod";
 
 // src/v1/schema/definitions/target/selector/range.ts
-import { z as z18 } from "zod";
+import { z as z19 } from "zod";
 
 // src/v1/schema/definitions/target/selector/xpath.ts
-import { z as z17 } from "zod";
+import { z as z18 } from "zod";
 
 // src/v1/schema/definitions/target/selector/textPosition.ts
-import { z as z16 } from "zod";
-var TextPositionSelector = z16.object({
-  id: z16.string().url().describe("The IRI that identifies the target resource."),
-  type: z16.tuple([z16.literal("TextPositionSelector"), z16.literal("crm:E73_Information_Object")]),
-  start: z16.number().min(0).describe("The starting position of the segment. The first byte is character position 0."),
-  end: z16.number().describe(
+import { z as z17 } from "zod";
+var TextPositionSelector = z17.object({
+  id: z17.string().url().describe("The IRI that identifies the target resource."),
+  type: z17.tuple([z17.literal("TextPositionSelector"), z17.literal("crm:E73_Information_Object")]),
+  start: z17.number().min(0).describe("The starting position of the segment. The first byte is character position 0."),
+  end: z17.number().describe(
     "The end position of the segment. The last character is not included within the segment."
   )
 }).describe("TextPosition Selector");
@@ -3487,10 +3547,10 @@ var textPositionSelectorSchema = {
 };
 
 // src/v1/schema/definitions/target/selector/xpath.ts
-var XpathSelector = z17.object({
-  id: z17.string().uuid().describe("UUID that identifies the selector."),
-  type: z17.tuple([z17.literal("XPathSelector"), z17.literal("crm:E73_Information_Object")]),
-  value: z17.string().min(1).describe("The xpath to the selected segment."),
+var XpathSelector = z18.object({
+  id: z18.string().uuid().describe("UUID that identifies the selector."),
+  type: z18.tuple([z18.literal("XPathSelector"), z18.literal("crm:E73_Information_Object")]),
+  value: z18.string().min(1).describe("The xpath to the selected segment."),
   refinedBy: TextPositionSelector.optional().describe(
     "The relationship between a broader selector and the more specific selector that should be applied to the results of the first."
   )
@@ -3528,9 +3588,9 @@ var xpathSelectorSchema = {
 };
 
 // src/v1/schema/definitions/target/selector/range.ts
-var RangeSelector = z18.object({
-  id: z18.string().uuid().describe("UUID that identifies the selector."),
-  type: z18.tuple([z18.literal("RangeSelector"), z18.literal("crm:E73_Information_Object")]),
+var RangeSelector = z19.object({
+  id: z19.string().uuid().describe("UUID that identifies the selector."),
+  type: z19.tuple([z19.literal("RangeSelector"), z19.literal("crm:E73_Information_Object")]),
   startSelector: XpathSelector,
   endSelector: XpathSelector
 }).describe("Range Selector");
@@ -3561,18 +3621,18 @@ var rangeSelectorSchema = {
 };
 
 // src/v1/schema/definitions/target/selector/textQuote.ts
-import { z as z19 } from "zod";
-var TextQuoteSelector = z19.object({
-  id: z19.string().uuid().describe("UUID that identifies the selector."),
-  type: z19.tuple([z19.literal("TextQuoteSelector"), z19.literal("crm:E33_Linguistic_Object")]),
-  exact: z19.string().describe("A copy of the text which is being selected, after normalization."),
-  prefix: z19.string().optional().describe(
+import { z as z20 } from "zod";
+var TextQuoteSelector = z20.object({
+  id: z20.string().uuid().describe("UUID that identifies the selector."),
+  type: z20.tuple([z20.literal("TextQuoteSelector"), z20.literal("crm:E33_Linguistic_Object")]),
+  exact: z20.string().describe("A copy of the text which is being selected, after normalization."),
+  prefix: z20.string().optional().describe(
     "The snippet of text that occurs immediately before the text which is being selected."
   ),
-  sufix: z19.string().optional().describe(
+  sufix: z20.string().optional().describe(
     "The snippet of text that occurs immediately after the text which is being selected."
   ),
-  refinedBy: z19.union([RangeSelector, XpathSelector, TextPositionSelector]).optional().describe(
+  refinedBy: z20.union([RangeSelector, XpathSelector, TextPositionSelector]).optional().describe(
     "The relationship between a broader selector and the more specific selector that should be applied to the results of the first."
   )
 }).describe("Quote Selector");
@@ -3623,28 +3683,28 @@ var textQuoteSelectorSchema = {
 };
 
 // src/v1/schema/definitions/target/index.ts
-var Target = z20.object({
-  id: z20.union([z20.string().url(), z20.string().uuid()]).describe("The IRI that identifies the Target resource."),
-  type: z20.tuple([z20.literal("SpecificResource"), z20.literal("crm:E73_Information_Object")]).describe("The class of the Specific Resource."),
-  format: z20.array(
-    z20.string().min(1).describe(
+var Target = z21.object({
+  id: z21.union([z21.string().url(), z21.string().uuid()]).describe("The IRI that identifies the Target resource."),
+  type: z21.tuple([z21.literal("SpecificResource"), z21.literal("crm:E73_Information_Object")]).describe("The class of the Specific Resource."),
+  format: z21.array(
+    z21.string().min(1).describe(
       "The format of the Web Resource's content. The value of the property should be the media-type of the format, following the [rfc6838] specification."
     )
   ).optional().describe(
     "The formats of the Web Resource's content. The value of the property should and array of  media-types of the format, following the [rfc6838] specification."
   ),
-  language: z20.array(
-    z20.string().min(2).max(3).describe(
+  language: z21.array(
+    z21.string().min(2).max(3).describe(
       "The language of the Web Resource's content. The value of the property should be a language code following the [bcp47] specification."
     )
   ).min(1).optional().describe(
     "The languages of the Web Resource's content. The value of the property should be an array of language code following the [bcp47] specification."
   ),
-  title: z20.string().min(1, { message: "The title cannot be empty" }).optional().describe("The title of the document being annotated."),
+  title: z21.string().min(1, { message: "The title cannot be empty" }).optional().describe("The title of the document being annotated."),
   renderedVia: Software.optional().describe(
     "The relationship between the Specific Resource that represents the Target in the annotation, and the piece of software or other system that was used to render the Target when the annotation was created."
   ),
-  selector: z20.union([TextQuoteSelector, RangeSelector, XpathSelector, TextPositionSelector]).optional().describe("The relationship between a Specific Resource and a Selector. ")
+  selector: z21.union([TextQuoteSelector, RangeSelector, XpathSelector, TextPositionSelector]).optional().describe("The relationship between a Specific Resource and a Selector. ")
 }).describe("Web Annotation Target");
 var targetSchema = {
   type: "object",
@@ -3844,7 +3904,7 @@ var definitionSchema = {
 };
 
 // src/v1/schema/root.ts
-import { z as z21 } from "zod";
+import { z as z22 } from "zod";
 var Status = ["draft", "approved", "published"];
 var Motivation = [
   "identifying",
@@ -3855,32 +3915,32 @@ var Motivation = [
   "linking",
   "citing"
 ];
-var WebAnnotation = z21.object({
-  "@context": z21.tuple([
-    z21.literal("http://www.w3.org/ns/anno.jsonld").describe("W3C Web Annotation Context."),
-    z21.literal(contextUri).describe("LINCS Web Annotation Context.")
+var WebAnnotation = z22.object({
+  "@context": z22.tuple([
+    z22.literal("http://www.w3.org/ns/anno.jsonld").describe("W3C Web Annotation Context."),
+    z22.literal(contextUri).describe("LINCS Web Annotation Context.")
   ]).describe(
     "The context that determines the meaning of the JSON as an Annotation. The itens should point to a URI containing the defiintion used in this schema."
   ),
-  id: z21.union([
-    z21.string().url(),
+  id: z22.union([
+    z22.string().url(),
     //? We can improve this making it a regexp to make sure that this URI contains a search params named 'annoID' with n UUID value".])
-    z21.string().uuid()
+    z22.string().uuid()
   ]).describe(
     "The identity of the Annotation. It must be a UUID or URI containing a UUID in the search params (URI?annoId=URI)"
   ),
-  type: z21.tuple([z21.literal("Annotation"), z21.literal("crm:E33_Linguistic_Object")]).describe("The type of the Annotation."),
-  motivation: z21.tuple([z21.enum(Motivation), z21.literal("crm:E33_Linguistic_Object")]).describe("The relationship between an Annotation and a Motivation."),
-  created: z21.string().datetime().describe("The time at which the resource was created."),
-  modified: z21.string().datetime().optional().describe("The time at which the resource was modified, after creation."),
-  status: z21.enum(Status).describe("The status of this annotation in a workflow."),
+  type: z22.tuple([z22.literal("Annotation"), z22.literal("crm:E33_Linguistic_Object")]).describe("The type of the Annotation."),
+  motivation: z22.tuple([z22.enum(Motivation), z22.literal("crm:E33_Linguistic_Object")]).describe("The relationship between an Annotation and a Motivation."),
+  created: z22.string().datetime().describe("The time at which the resource was created."),
+  modified: z22.string().datetime().optional().describe("The time at which the resource was modified, after creation."),
+  status: z22.enum(Status).describe("The status of this annotation in a workflow."),
   creator: User.describe("The agent responsible for creating the resource.").optional(),
-  contributor: z21.array(User.describe("The agents responsible for modifying the resource.")).nonempty().optional().describe("The agents responsible for modifying the resource."),
+  contributor: z22.array(User.describe("The agents responsible for modifying the resource.")).nonempty().optional().describe("The agents responsible for modifying the resource."),
   generator: Software.describe(
     "The agent responsible for generating the serialization of the Annotation. "
   ),
   target: Target.describe("The relationship between an Annotation and its Target."),
-  body: z21.union([Body, z21.array(Body)]).describe("The relationship between an Annotation and its Body.")
+  body: z22.union([Body, z22.array(Body)]).describe("The relationship between an Annotation and its Body.")
 }).describe("Web Annotation Root");
 var webAnnotationSchema = {
   $id: schemaId,
@@ -4010,7 +4070,8 @@ var webAnnotationSchema = {
                   workEntityTypeSchema,
                   physicalThingEntityTypeSchema,
                   conceptualObjectEntityTypeSchema,
-                  dateEntityTypeSchema
+                  dateEntityTypeSchema,
+                  eventEntityTypeSchema
                 ]
               }
             }
@@ -4204,18 +4265,18 @@ import Ajv from "ajv";
 import addFormats from "ajv-formats";
 
 // src/v1/validator/types.ts
-import { z as z22 } from "zod";
-var ValidationError = z22.object({
-  message: z22.string(),
-  path: z22.string(),
-  suggestion: z22.string().optional(),
-  context: z22.object({
-    errorType: z22.string()
-  }).and(z22.unknown())
+import { z as z23 } from "zod";
+var ValidationError = z23.object({
+  message: z23.string(),
+  path: z23.string(),
+  suggestion: z23.string().optional(),
+  context: z23.object({
+    errorType: z23.string()
+  }).and(z23.unknown())
 });
-var ValidateResult = z22.object({
-  valid: z22.boolean(),
-  errors: z22.array(ValidationError).optional()
+var ValidateResult = z23.object({
+  valid: z23.boolean(),
+  errors: z23.array(ValidationError).optional()
 });
 
 // src/v1/validator/index.ts

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lincs.project/webannotation-schema",
-  "version": "1.0.3",
+  "version": "1.1.0",
   "description": "lincs project web annotation json-ld schema",
   "keywords": [
     "lincs project",
@@ -58,23 +58,22 @@
     "@apideck/better-ajv-errors": "^0.3.6",
     "ajv": "^8.12.0",
     "ajv-formats": "^2.1.1",
-    "typescript": "^5.2.2",
+    "typescript": "^5.3.2",
     "zod": "^3.22.4"
   },
   "devDependencies": {
     "@jest/globals": "^29.7.0",
-    "@types/fs-extra": "^11.0.3",
-    "@types/jest": "^29.5.7",
-    "@types/node": "^20.8.10",
-    "eslint": "^8.52.0",
+    "@types/fs-extra": "^11.0.4",
+    "@types/jest": "^29.5.11",
+    "@types/node": "^20.10.3",
+    "eslint": "^8.55.0",
     "eslint-config-custom": "*",
-    "fs-extra": "^11.1.1",
+    "fs-extra": "^11.2.0",
     "jest": "^29.7.0",
     "kleur": "^4.1.5",
     "ts-jest": "^29.1.1",
     "ts-node": "^10.9.1",
-    "tsconfig": "*",
-    "tsup": "^7.2.0",
-    "typedoc": "^0.25.3"
+    "tsup": "^8.0.1",
+    "typedoc": "^0.25.4"
   }
 }