@lincs.project/webannotation-schema 1.11.0 → 1.12.0

package/dist/index.mjs

@@ -13,14 +13,15 @@ var defsId = `https://wa.lincsproject.ca/${VERSION}/defs.jsonld`;
 // src/v1/schema/context.ts
 var schemaContext = {
   "@context": {
+    biography: "http://id.lincsproject.ca/biography/",
     bf: "http://www.openlinksw.com/schemas/bif#",
     cito: "http://purl.org/spar/cito/",
+    crmdig: "http://www.ics.forth.gr/isl/CRMdig/",
     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/",
-    crmdig: "http://www.ics.forth.gr/isl/CRMdig/",
     citing: "edit:citing",
     correcting: "edit:correcting",
     "oa:identifying": {
@@ -65,43 +66,64 @@ var schemaContext = {
   }
 };
 
-// src/v1/schema/definitions/agent.ts
+// src/v1/schema/definitions/agents.ts
 import { z } from "zod";
-var userIdDescription = "The IRI that identifies the agent (Creator or Contributor).";
 var User = z.object({
-  id: z.string().url().describe(userIdDescription),
-  type: z.literal("crm:E21_Person").describe("The type of the Agent."),
-  name: z.string().min(1, { message: "Cannot be empty" }).describe("The name of the agent.")
+  id: z.string().url(),
+  type: z.literal("crm:E21_Person"),
+  name: z.string().min(1, { message: "Cannot be empty" }).describe(`The person's name.`)
 }).describe("Human Agent");
-var creatorSchema = {
+var userSchema = {
   type: "object",
-  description: "Software Agent",
+  description: "User Agent",
   properties: {
-    id: { type: "string", format: "uri", description: userIdDescription },
+    id: { type: "string", format: "uri" },
     type: { type: "string", const: "crm:E21_Person" },
-    name: { type: "string", minLength: 1, description: "The name of the agent." }
+    name: { type: "string", minLength: 1, description: `The person's name.` }
+  },
+  required: ["id", "type", "name"]
+};
+var Group = z.object({
+  id: z.string().url(),
+  type: z.literal("crm:E74_Group"),
+  name: z.string().min(1).describe(`The group's name.`)
+}).describe("Group Agent");
+var groupSchema = {
+  type: "object",
+  description: "Group Agent",
+  properties: {
+    id: { type: "string", format: "uri" },
+    type: { type: "string", const: "crm:E74_Group" },
+    name: { type: "string", minLength: 1, description: `The group's name.` }
   },
   required: ["id", "type", "name"]
 };
-var softwareIdDescription = "The IRI that identifies the agent (software).";
 var Software = z.object({
-  id: z.string().url().describe(softwareIdDescription),
-  type: z.literal("Software").describe("The type of the Agent."),
+  id: z.string().url(),
+  type: z.tuple([z.literal("Software"), z.literal("crm:E73_Information_Object")]),
   P16_used_specific_object: z.string().url().optional().describe("The URI that identifies the agent (software)"),
-  label: z.string().min(1).describe("The name of the software."),
+  name: z.string().min(1).describe(`The software's name.`),
   softwareVersion: z.string().optional().describe("The software version.")
 }).describe("Software Agent");
 var softwareSchema = {
   type: "object",
   description: "Software Agent",
   properties: {
-    id: { type: "string", format: "uri", description: softwareIdDescription },
-    type: { type: "string", const: "Software" },
-    P16_used_specific_object: { type: "string", format: "uri" },
-    label: { type: "string", minLength: 1, description: "The name of the software." },
-    softwareVersion: { type: "string", description: "The software version." }
+    id: { type: "string", format: "uri" },
+    type: {
+      type: "array",
+      minItems: 2,
+      maxItems: 2,
+      items: [
+        { type: "string", const: "Software" },
+        { type: "string", const: "crm:E73_Information_Object" }
+      ]
+    },
+    P16_used_specific_object: { type: "string", format: "uri", nullable: true },
+    name: { type: "string", minLength: 1, description: `The software's name.` },
+    softwareVersion: { type: "string", nullable: true, description: "The software version." }
   },
-  required: ["id", "type", "label"]
+  required: ["id", "type", "name"]
 };
 
 // src/v1/schema/definitions/body/index.ts
@@ -700,8 +722,8 @@ var physicalThingSchema = {
 // src/v1/schema/definitions/body/place.ts
 import { z as z14 } from "zod";
 var PlaceEntityType = z14.union([
-  z14.literal("cwrc:place"),
-  z14.tuple([z14.literal("cwrc:place"), z14.literal("crm:E89_Propositional_Object")])
+  z14.literal("crm:E53_Place"),
+  z14.tuple([z14.literal("biography:fictionalPlace"), z14.literal("crm:E89_Propositional_Object")])
 ]);
 var Place = z14.object({
   id: z14.string().url().describe(bodyIdDescription),
@@ -712,13 +734,13 @@ var Place = z14.object({
 }).describe("Place");
 var placeEntityTypeSchema = {
   oneOf: [
-    { type: "string", const: "cwrc:place" },
+    { type: "string", const: "crm:E53_Place" },
     {
       type: "array",
       minItems: 2,
       maxItems: 2,
       items: [
-        { type: "string", const: "cwrc:place" },
+        { type: "string", const: "biography:fictionalPlace" },
         { type: "string", const: "crm:E89_Propositional_Object" }
       ]
     }
@@ -746,13 +768,13 @@ var placeSchema = {
       then: {
         type: "object",
         properties: {
-          entityType: "cwrc:place"
+          entityType: "crm:E53_Place"
         }
       },
       else: {
         type: "object",
         properties: {
-          entityType: ["cwrc:place", "crm:E89_Propositional_Object"]
+          entityType: ["biography:fictionalPlace", "crm:E89_Propositional_Object"]
         }
       }
     }
@@ -1001,10 +1023,10 @@ var bodySchema = {
 };
 
 // src/v1/schema/definitions/target/index.ts
-import { z as z24 } from "zod";
+import { z as z25 } from "zod";
 
 // src/v1/schema/definitions/target/selector/index.ts
-import { z as z22 } from "zod";
+import { z as z23 } from "zod";
 
 // src/v1/schema/definitions/target/selector/range.ts
 import { z as z21 } from "zod";
@@ -1212,13 +1234,64 @@ var rangeSelectorSchema = {
   required: ["id", "type", "startSelector", "endSelector"]
 };
 
+// src/v1/schema/definitions/target/selector/css.ts
+import { z as z22 } from "zod";
+var CssSelector = z22.object({
+  id: z22.string().describe(selectorIdDescription),
+  type: z22.tuple([z22.literal("CssSelector"), z22.literal("crm:E73_Information_Object")]),
+  value: z22.string().min(1).describe("The CSS to the selected a segment.")
+}).describe("CSS Selector");
+var CssSelectorExtended = CssSelector.extend({
+  refinedBy: z22.union([TextPositionSelector, TextQuoteSelector]).optional().describe(selectorRefinedByDescription)
+});
+var cssSelectorSchema = {
+  type: "object",
+  description: "Css Selector",
+  properties: {
+    id: { type: "string", format: "uri", description: selectorIdDescription },
+    type: {
+      type: "array",
+      minItems: 2,
+      maxItems: 2,
+      items: [
+        { type: "string", const: "CssSelector" },
+        { type: "string", const: "crm:E73_Information_Object" }
+      ],
+      description: "The class of the Selector,"
+    },
+    value: {
+      type: "string",
+      description: "Web Annotation Target Select CSS"
+    }
+  },
+  required: ["id", "type", "value"]
+};
+var cssSelectorExtendedSchema = {
+  type: "object",
+  description: "CSS Selector",
+  properties: {
+    ...cssSelectorSchema.properties,
+    refinedBy: {
+      type: "object",
+      description: selectorRefinedByDescription,
+      anyOf: [
+        { $ref: "defs.jsonld#/definitions/textPositionSelector" },
+        { $ref: "defs.jsonld#/definitions/textQuoteSelector" }
+      ],
+      required: []
+    }
+  },
+  required: ["id", "type", "value"]
+};
+
 // src/v1/schema/definitions/target/selector/index.ts
 var selectorIdDescription = "UUID that identifies the selector.";
 var selectorRefinedByDescription = "The relationship between a broader selector and the more specific selector that should be applied to the results of the first.";
-var Selector = z22.union([
+var Selector = z23.union([
   TextQuoteSelectorExtended,
   TextPositionSelectorExtended,
   XpathSelectorExtended,
+  CssSelectorExtended,
   RangeSelector
 ]);
 var selectorSchema = {
@@ -1227,22 +1300,23 @@ var selectorSchema = {
     textQuoteSelectorExtendedSchema,
     textPositionSelectorExtendedSchema,
     xpathSelectorExtendedSchema,
+    cssSelectorExtendedSchema,
     rangeSelectorSchema
   ],
   required: []
 };
 
 // src/v1/schema/definitions/target/source.ts
-import { z as z23 } from "zod";
+import { z as z24 } from "zod";
 var formatDescription = "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.";
-var Format = z23.string().min(1).describe(formatDescription);
+var Format = z24.string().min(1).describe(formatDescription);
 var formatSchema = {
   type: "string",
   description: formatDescription,
   minLength: 1
 };
 var languageDescription = "The language of the Web Resource's content. The value of the property should be a language code following the [bcp47] specification.";
-var Language = z23.string().min(2).max(3).describe(languageDescription);
+var Language = z24.string().min(2).max(3).describe(languageDescription);
 var languageSchema = {
   type: "string",
   description: languageDescription,
@@ -1250,19 +1324,19 @@ var languageSchema = {
   maxLength: 3
 };
 var sourceIdDescription = "The IRI that identifies the Target source.";
-var isIdentifiedBy = z23.object({
-  id: z23.string().url(),
-  type: z23.literal("crm:E33_E41_Linguistic_Appellation"),
-  title: z23.string().min(1, { message: "The title cannot be empty" }).describe("The title of the document being annotated.")
+var isIdentifiedBy = z24.object({
+  id: z24.string().url(),
+  type: z24.literal("crm:E33_E41_Linguistic_Appellation"),
+  title: z24.string().min(1, { message: "The title cannot be empty" }).describe("The title of the document being annotated.")
 });
-var Source = z23.object({
-  id: z23.string().url().describe(sourceIdDescription),
-  type: z23.literal("crm:D1_Digital_Object"),
-  format: z23.union([Format, z23.array(Format).min(1)]).optional().describe(
+var Source = z24.object({
+  id: z24.string().url().describe(sourceIdDescription),
+  type: z24.literal("crm:D1_Digital_Object"),
+  format: z24.union([Format, z24.array(Format).min(1)]).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."
   ),
   P1_is_identified_by: isIdentifiedBy.optional(),
-  language: z23.union([Language, z23.array(Language).min(1)]).optional().describe(
+  language: z24.union([Language, z24.array(Language).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."
   )
 }).describe("Web Annotation Target");
@@ -1325,14 +1399,14 @@ var sourceSchema = {
 
 // src/v1/schema/definitions/target/index.ts
 var targetIdDescription = "The IRI that identifies the Target resource.";
-var Target = z24.object({
-  id: z24.string().url().describe(targetIdDescription),
-  type: z24.tuple([z24.literal("SpecificResource"), z24.literal("crm:E73_Information_Object")]).describe("The class of the Specific Resource."),
+var Target = z25.object({
+  id: z25.string().url().describe(targetIdDescription),
+  type: z25.tuple([z25.literal("SpecificResource"), z25.literal("crm:E73_Information_Object")]).describe("The class of the Specific Resource."),
   source: Source,
   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: z24.union([Selector, z24.array(Selector)]).describe("The relationship between a Specific Resource and a Selector.").optional()
+  selector: z25.union([Selector, z25.array(Selector)]).describe("The relationship between a Specific Resource and a Selector.").optional()
 }).describe("Web Annotation Target");
 var targetSchema = {
   type: "object",
@@ -1448,6 +1522,33 @@ var targetSchema = {
         }
       }
     },
+    {
+      if: {
+        type: "object",
+        properties: {
+          selector: {
+            type: "object",
+            properties: {
+              type: {
+                type: "array",
+                minItems: 2,
+                maxItems: 2,
+                items: [
+                  { type: "string", const: "CssSelector" },
+                  { type: "string", const: "crm:E73_Information_Object" }
+                ]
+              }
+            }
+          }
+        }
+      },
+      then: {
+        type: "object",
+        properties: {
+          selector: { type: "object", required: ["type", "value"] }
+        }
+      }
+    },
     {
       if: {
         type: "object",
@@ -1479,7 +1580,7 @@ var targetSchema = {
 };
 
 // src/v1/schema/definitions/common.ts
-import { z as z25 } from "zod";
+import { z as z26 } from "zod";
 var Quality = [
   "edit:qualityLow",
   "edit:qualityMedium",
@@ -1487,14 +1588,14 @@ var Quality = [
   "edit:qualityUnknown"
 ];
 var certaintyDescription = "Indicates the degree of certainty associated with some aspect of an assertion, description, identification, or entity linked to the annotation body.";
-var Certainty = z25.enum(Quality).describe(certaintyDescription);
+var Certainty = z26.enum(Quality).describe(certaintyDescription);
 var certaintySchema = {
   type: "string",
   enum: Quality,
   description: certaintyDescription
 };
 var precisionDescription = "Indicates the degree of precision associated with the location of the entity linked to the annotation body.";
-var Precision = z25.enum(Quality).describe(precisionDescription);
+var Precision = z26.enum(Quality).describe(precisionDescription);
 var precisionSchema = {
   type: "string",
   enum: Quality,
@@ -1506,7 +1607,8 @@ var definitionSchema = {
   $id: defsId,
   type: "object",
   definitions: {
-    creator: creatorSchema,
+    user: userSchema,
+    group: groupSchema,
     software: softwareSchema,
     target: targetSchema,
     textPositionSelector: textPositionSelectorSchema,
@@ -1520,7 +1622,7 @@ var definitionSchema = {
 };
 
 // src/v1/schema/root.ts
-import { z as z26 } from "zod";
+import { z as z27 } from "zod";
 var Motivation = [
   "oa:identifying",
   "oa:describing",
@@ -1530,30 +1632,30 @@ var Motivation = [
   "oa:linking",
   "citing"
 ];
-var WebAnnotation = z26.object({
-  "@context": z26.tuple([
-    z26.literal("http://www.w3.org/ns/anno.jsonld").describe("W3C Web Annotation Context."),
-    z26.literal("https://www.cidoc-crm.org/cidoc-crm/json-ld_context.jsonld").describe("CIDOC Web Annotation Context."),
-    z26.literal(contextUri).describe("LINCS Web Annotation Context.")
+var WebAnnotation = z27.object({
+  "@context": z27.tuple([
+    z27.literal("http://www.w3.org/ns/anno.jsonld").describe("W3C Web Annotation Context."),
+    z27.literal("https://www.cidoc-crm.org/cidoc-crm/json-ld_context.jsonld").describe("CIDOC Web Annotation Context."),
+    z27.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: z26.string().url().describe("The identity of the Annotation."),
-  type: z26.tuple([z26.literal("Annotation"), z26.literal("crm:E33_Linguistic_Object")]).describe("The type of the Annotation."),
-  motivation: z26.enum(Motivation).describe("The relationship between an Annotation and a Motivation."),
-  created: z26.string().datetime().describe("The time at which the resource was created."),
-  modified: z26.string().datetime().optional().describe("The time at which the resource was modified, after creation."),
-  creator: User.describe("The agent responsible for creating the resource.").optional(),
-  contributor: z26.array(User.describe("The agents responsible for modifying the resource.")).nonempty().optional().describe("The agents responsible for modifying the resource."),
+  id: z27.string().url().describe("The identity of the Annotation."),
+  type: z27.tuple([z27.literal("Annotation"), z27.literal("crm:E33_Linguistic_Object")]).describe("The type of the Annotation."),
+  motivation: z27.enum(Motivation).describe("The relationship between an Annotation and a Motivation."),
+  created: z27.string().datetime().describe("The time at which the resource was created."),
+  modified: z27.string().datetime().optional().describe("The time at which the resource was modified, after creation."),
+  creator: z27.union([User, Group, Software]).describe("The agent responsible for creating the resource.").optional(),
+  contributor: z27.array(z27.union([User, Group, Software])).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: z26.union([BodyChoice, Body, z26.array(Body)]).describe("The relationship between an Annotation and its Body."),
+  target: z27.union([Target, z27.array(Target)]).describe("The relationship between an Annotation and its Target."),
+  body: z27.union([BodyChoice, Body, z27.array(Body)]).describe("The relationship between an Annotation and its Body."),
   certainty: Certainty.optional(),
   precision: Precision.optional(),
-  label: z26.string().min(1, { message: "The label cannot be empty" }).optional().describe("The descriptive label for the annotation"),
-  P2_has_type: z26.union([z26.string().min(3), z26.array(z26.string().min(3)).min(1)]).optional()
+  label: z27.string().min(1, { message: "The label cannot be empty" }).optional().describe("The descriptive label for the annotation"),
+  P2_has_type: z27.union([z27.string().min(3), z27.array(z27.string().min(3)).min(1)]).optional()
 }).describe("Web Annotation Root");
 var webAnnotationSchema = {
   $id: schemaId,
@@ -1601,16 +1703,38 @@ var webAnnotationSchema = {
       format: "date-time",
       description: "The time at which the resource was modified, after creation."
     },
-    creator: { $ref: "defs.jsonld#/definitions/creator" },
-    // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
+    creator: {
+      oneOf: [
+        { $ref: "defs.jsonld#/definitions/user" },
+        { $ref: "defs.jsonld#/definitions/group" },
+        { $ref: "defs.jsonld#/definitions/software" }
+      ]
+      // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    },
     contributor: {
       type: "array",
-      items: { $ref: "defs.jsonld#/definitions/creator" },
+      items: {
+        oneOf: [
+          { $ref: "defs.jsonld#/definitions/user" },
+          { $ref: "defs.jsonld#/definitions/group" },
+          { $ref: "defs.jsonld#/definitions/software" }
+        ]
+      },
       minItems: 1
       // eslint-disable-next-line @typescript-eslint/no-explicit-any
     },
     generator: { $ref: "defs.jsonld#/definitions/software" },
-    target: { $ref: "defs.jsonld#/definitions/target" },
+    target: {
+      oneOf: [
+        { $ref: "defs.jsonld#/definitions/target" },
+        {
+          type: "array",
+          items: { $ref: "defs.jsonld#/definitions/target" },
+          minItems: 1
+          // eslint-disable-next-line @typescript-eslint/no-explicit-any
+        }
+      ]
+    },
     body: {
       oneOf: [
         { $ref: "defs.jsonld#/definitions/bodyChoice" },
@@ -1797,18 +1921,18 @@ import Ajv from "ajv";
 import addFormats from "ajv-formats";
 
 // src/v1/validator/types.ts
-import { z as z27 } from "zod";
-var ValidationError = z27.object({
-  message: z27.string(),
-  path: z27.string(),
-  suggestion: z27.string().optional(),
-  context: z27.object({
-    errorType: z27.string()
-  }).and(z27.unknown())
+import { z as z28 } from "zod";
+var ValidationError = z28.object({
+  message: z28.string(),
+  path: z28.string(),
+  suggestion: z28.string().optional(),
+  context: z28.object({
+    errorType: z28.string()
+  }).and(z28.unknown())
 });
-var ValidateResult = z27.object({
-  valid: z27.boolean(),
-  errors: z27.array(ValidationError).optional()
+var ValidateResult = z28.object({
+  valid: z28.boolean(),
+  errors: z28.array(ValidationError).optional()
 });
 
 // src/v1/validator/index.ts
@@ -1857,6 +1981,7 @@ __export(v1_exports, {
   Description: () => Description,
   Event: () => Event,
   EventEntityType: () => EventEntityType,
+  Group: () => Group,
   Keyword: () => Keyword,
   KeywordEntityType: () => KeywordEntityType,
   KeywordFolksnomy: () => KeywordFolksnomy,
@@ -1909,7 +2034,6 @@ __export(v1_exports, {
   contextUri: () => contextUri,
   correctionEntityTypeSchema: () => correctionEntityTypeSchema,
   correctionSchema: () => correctionSchema,
-  creatorSchema: () => creatorSchema,
   dateEntityTypeSchema: () => dateEntityTypeSchema,
   dateSchema: () => dateSchema,
   definitionSchema: () => definitionSchema,
@@ -1918,6 +2042,7 @@ __export(v1_exports, {
   eventEntityTypeSchema: () => eventEntityTypeSchema,
   eventSchema: () => eventSchema,
   formatSchema: () => formatSchema,
+  groupSchema: () => groupSchema,
   isIdentifiedBy: () => isIdentifiedBy,
   isIndentifyBySchema: () => isIndentifyBySchema,
   keywordEntityTypeSchema: () => keywordEntityTypeSchema,
@@ -1953,6 +2078,7 @@ __export(v1_exports, {
   textPositionSelectorSchema: () => textPositionSelectorSchema,
   textQuoteSelectorExtendedSchema: () => textQuoteSelectorExtendedSchema,
   textQuoteSelectorSchema: () => textQuoteSelectorSchema,
+  userSchema: () => userSchema,
   validate: () => validate,
   validator: () => validator,
   webAnnotationSchema: () => webAnnotationSchema,
@@ -1978,6 +2104,7 @@ export {
   Description,
   Event,
   EventEntityType,
+  Group,
   Keyword,
   KeywordEntityType,
   KeywordFolksnomy,
@@ -2030,7 +2157,6 @@ export {
   contextUri,
   correctionEntityTypeSchema,
   correctionSchema,
-  creatorSchema,
   dateEntityTypeSchema,
   dateSchema,
   definitionSchema,
@@ -2039,6 +2165,7 @@ export {
   eventEntityTypeSchema,
   eventSchema,
   formatSchema,
+  groupSchema,
   isIdentifiedBy,
   isIndentifyBySchema,
   keywordEntityTypeSchema,
@@ -2074,6 +2201,7 @@ export {
   textPositionSelectorSchema,
   textQuoteSelectorExtendedSchema,
   textQuoteSelectorSchema,
+  userSchema,
   v1_exports as v1,
   validate,
   validator,

package/dist/v1/jsonld/context.jsonld

@@ -1,13 +1,14 @@
 {
   "@context": {
+    "biography": "http://id.lincsproject.ca/biography/",
     "bf": "http://www.openlinksw.com/schemas/bif#",
     "cito": "http://purl.org/spar/cito/",
+    "crmdig": "http://www.ics.forth.gr/isl/CRMdig/",
     "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/",
-    "crmdig": "http://www.ics.forth.gr/isl/CRMdig/",
     "citing": "edit:citing",
     "correcting": "edit:correcting",
     "oa:identifying": {