@lincs.project/webannotation-schema 1.8.0 → 1.10.0

package/dist/index.mjs

@@ -22,38 +22,44 @@ var schemaContext = {
     wikidata: "http://www.wikidata.org/entity/",
     crm: "http://www.cidoc-crm.org/cidoc-crm/",
     crmdig: "http://www.ics.forth.gr/isl/CRMdig/",
-    additionalType: {
-      "@type": "@id",
-      "@id": "crm:P2_has_type"
+    citing: "edit:citing",
+    correcting: "edit:correcting",
+    "oa:identifying": {
+      type: "crm:E55_Type"
+    },
+    "oa:describing": {
+      type: "crm:E55_Type"
+    },
+    "oa:tagging": {
+      type: "crm:E55_Type"
+    },
+    "oa:classifying": {
+      type: "crm:E55_Type"
+    },
+    "oa:linking": {
+      type: "crm:E55_Type"
     },
     certainty: {
       "@type": "@id",
-      "@id": "crm:P2_has_type"
+      "@id": "http://temp.lincsproject.ca/certainty"
+    },
+    precision: {
+      "@type": "@id",
+      "@id": "http://temp.lincsproject.ca/precision"
     },
     contributor: "dcterms:contributor",
-    description: "rdfs:comment",
     entityType: {
       "@type": "@id",
       "@id": "rdf:type"
     },
-    identifiedBy: "crm:P1_is_identified_by",
-    modeExistence: "edit:ModeExistence",
-    precision: {
-      "@type": "@id",
-      "@id": "crm:P2_has_type"
-    },
-    softwareVersion: "schema:softwareVersion",
-    status: {
+    additionalType: {
       "@type": "@id",
       "@id": "crm:P2_has_type"
     },
+    modeExistence: "edit:ModeExistence",
+    description: "rdfs:comment",
     title: "crm:P190_has_symbolic_content",
-    usedSpecificObject: "crm:P16_used_specific_object",
-    approved: "edit:statusApproved",
-    citing: "edit:citing",
-    correcting: "edit:correcting",
-    draft: "edit:statusDraft",
-    published: "edit:statusPublished"
+    softwareVersion: "schema:softwareVersion"
   }
 };
 
@@ -79,7 +85,7 @@ 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."),
-  usedSpecificObject: z.string().url().optional(),
+  P16_used_specific_object: z.string().url().optional(),
   label: z.string().min(1).describe("The name of the software."),
   softwareVersion: z.string().optional().describe("The software version.")
 }).describe("Software Agent");
@@ -89,7 +95,7 @@ var softwareSchema = {
   properties: {
     id: { type: "string", format: "uri", description: softwareIdDescription },
     type: { type: "string", const: "Software" },
-    usedSpecificObject: { type: "string", format: "uri" },
+    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." }
   },
@@ -1242,7 +1248,7 @@ var languageSchema = {
   maxLength: 3
 };
 var sourceIdDescription = "The IRI that identifies the Target source.";
-var IdentifiedBy = z23.object({
+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.")
@@ -1253,12 +1259,12 @@ var Source = z23.object({
   format: z23.union([Format, z23.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."
   ),
-  identifiedBy: IdentifiedBy.optional(),
+  P1_is_identified_by: isIdentifiedBy.optional(),
   language: z23.union([Language, z23.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");
-var indentifyBySchema = {
+var isIndentifyBySchema = {
   type: "object",
   description: "indentifyBy",
   properties: {
@@ -1291,7 +1297,7 @@ var sourceSchema = {
         }
       ]
     },
-    identifiedBy: { ...indentifyBySchema, nullable: true },
+    P1_is_identified_by: { ...isIndentifyBySchema, nullable: true },
     language: {
       type: ["string", "array"],
       nullable: true,
@@ -1512,69 +1518,40 @@ var definitionSchema = {
 };
 
 // src/v1/schema/root.ts
-import { z as z27 } from "zod";
-
-// src/v1/schema/definitions/motivation.ts
 import { z as z26 } from "zod";
-var MotivationInstance = z26.union([
-  z26.literal("identifying"),
-  z26.literal("describing"),
-  z26.literal("correcting"),
-  z26.literal("tagging"),
-  z26.literal("classifying"),
-  z26.literal("linking"),
-  z26.literal("citing")
-]);
-var MotivationType = z26.object({
-  type: z26.literal("crm:E55_Type")
-});
-var Motivation = z26.record(MotivationInstance, MotivationType).describe("The relationship between an Annotation and a Motivation.");
-var motivationType = {
-  type: "object",
-  properties: {
-    type: { type: "string", const: "crm:E55_Type" }
-  },
-  required: ["type"]
-};
-var motivationSchema = {
-  type: "object",
-  description: "The relationship between an Annotation and a Motivation.",
-  properties: {
-    identifying: { ...motivationType, nullable: true },
-    describing: { ...motivationType, nullable: true },
-    correcting: { ...motivationType, nullable: true },
-    tagging: { ...motivationType, nullable: true },
-    classifying: { ...motivationType, nullable: true },
-    linking: { ...motivationType, nullable: true },
-    citing: { ...motivationType, nullable: true }
-  }
-};
-
-// src/v1/schema/root.ts
-var Status = ["edit:statusDraft", "edit:statusApproved", "edit:statusPublished"];
-var WebAnnotation = z27.object({
-  "@context": z27.tuple([
-    z27.literal("http://www.w3.org/ns/anno.jsonld").describe("W3C Web Annotation Context."),
-    z27.literal(contextUri).describe("LINCS Web Annotation Context.")
+var Motivation = [
+  "oa:identifying",
+  "oa:describing",
+  "correcting",
+  "oa:tagging",
+  "oa:classifying",
+  "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.")
   ]).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: 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: 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."),
+  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: z27.array(User.describe("The agents responsible for modifying the resource.")).nonempty().optional().describe("The agents responsible for modifying the resource."),
+  contributor: z26.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: z27.union([BodyChoice, Body, z27.array(Body)]).describe("The relationship between an Annotation and its Body."),
+  body: z26.union([BodyChoice, Body, z26.array(Body)]).describe("The relationship between an Annotation and its Body."),
   certainty: Certainty.optional(),
   precision: Precision.optional(),
-  label: z27.string().min(1, { message: "The label cannot be empty" }).optional().describe("The descriptive label for the annotation"),
-  status: z27.enum(Status).describe("The status of this annotation in a workflow.")
+  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()
 }).describe("Web Annotation Root");
 var webAnnotationSchema = {
   $id: schemaId,
@@ -1583,10 +1560,11 @@ var webAnnotationSchema = {
   properties: {
     "@context": {
       type: "array",
-      minItems: 2,
-      maxItems: 2,
+      minItems: 3,
+      maxItems: 3,
       items: [
         { type: "string", const: "http://www.w3.org/ns/anno.jsonld" },
+        { type: "string", const: "https://www.cidoc-crm.org/cidoc-crm/json-ld_context.jsonld" },
         { type: "string", const: contextUri }
       ],
       description: "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."
@@ -1606,7 +1584,11 @@ var webAnnotationSchema = {
       ],
       description: "The type of the Annotation."
     },
-    motivation: motivationSchema,
+    motivation: {
+      type: "string",
+      enum: Motivation,
+      description: "The relationship between an Annotation and a Motivation."
+    },
     created: {
       type: "string",
       format: "date-time",
@@ -1642,19 +1624,22 @@ var webAnnotationSchema = {
     certainty: certaintySchema,
     precision: precisionSchema,
     label: { type: "string" },
-    status: { type: "string", enum: Status }
+    P2_has_type: {
+      oneOf: [
+        { type: "string", minLength: 3 },
+        {
+          type: "array",
+          minItems: 1,
+          items: {
+            type: "string",
+            minLength: 3
+          },
+          uniqueItems: true
+        }
+      ]
+    }
   },
-  required: [
-    "@context",
-    "id",
-    "type",
-    "motivation",
-    "created",
-    "generator",
-    "target",
-    "body",
-    "status"
-  ],
+  required: ["@context", "id", "type", "motivation", "created", "generator", "target", "body"],
   additionalProperties: false,
   allOf: [
     {
@@ -1683,17 +1668,7 @@ var webAnnotationSchema = {
       then: {
         type: "object",
         properties: {
-          motivation: {
-            type: "object",
-            properties: {
-              identifying: {
-                type: "object",
-                properties: {
-                  type: { type: "string", const: "crm:E55_Type" }
-                }
-              }
-            }
-          }
+          motivation: { type: "string", const: "oa:identifying" }
         }
       },
       else: {
@@ -1711,17 +1686,7 @@ var webAnnotationSchema = {
         then: {
           type: "object",
           properties: {
-            motivation: {
-              type: "object",
-              properties: {
-                describing: {
-                  type: "object",
-                  properties: {
-                    type: { type: "string", const: "crm:E55_Type" }
-                  }
-                }
-              }
-            }
+            motivation: { type: "string", const: "oa:describing" }
           }
         },
         else: {
@@ -1739,17 +1704,7 @@ var webAnnotationSchema = {
           then: {
             type: "object",
             properties: {
-              motivation: {
-                type: "object",
-                properties: {
-                  correcting: {
-                    type: "object",
-                    properties: {
-                      type: { type: "string", const: "crm:E55_Type" }
-                    }
-                  }
-                }
-              }
+              motivation: { type: "string", const: "correcting" }
             }
           },
           else: {
@@ -1767,17 +1722,7 @@ var webAnnotationSchema = {
             then: {
               type: "object",
               properties: {
-                motivation: {
-                  type: "object",
-                  properties: {
-                    tagging: {
-                      type: "object",
-                      properties: {
-                        type: { type: "string", const: "crm:E55_Type" }
-                      }
-                    }
-                  }
-                }
+                motivation: { type: "string", const: "oa:tagging" }
               }
             },
             else: {
@@ -1795,17 +1740,7 @@ var webAnnotationSchema = {
               then: {
                 type: "object",
                 properties: {
-                  motivation: {
-                    type: "object",
-                    properties: {
-                      classifying: {
-                        type: "object",
-                        properties: {
-                          type: { type: "string", const: "crm:E55_Type" }
-                        }
-                      }
-                    }
-                  }
+                  motivation: { type: "string", const: "oa:classifying" }
                 }
               },
               else: {
@@ -1823,17 +1758,7 @@ var webAnnotationSchema = {
                 then: {
                   type: "object",
                   properties: {
-                    motivation: {
-                      type: "object",
-                      properties: {
-                        linking: {
-                          type: "object",
-                          properties: {
-                            type: { type: "string", const: "crm:E55_Type" }
-                          }
-                        }
-                      }
-                    }
+                    motivation: { type: "string", const: "oa:linking" }
                   }
                 },
                 else: {
@@ -1851,17 +1776,7 @@ var webAnnotationSchema = {
                   then: {
                     type: "object",
                     properties: {
-                      motivation: {
-                        type: "object",
-                        properties: {
-                          citing: {
-                            type: "object",
-                            properties: {
-                              type: { type: "string", const: "crm:E55_Type" }
-                            }
-                          }
-                        }
-                      }
+                      motivation: { type: "string", const: "citing" }
                     }
                   }
                 }
@@ -1880,18 +1795,18 @@ import Ajv from "ajv";
 import addFormats from "ajv-formats";
 
 // src/v1/validator/types.ts
-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())
+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())
 });
-var ValidateResult = z28.object({
-  valid: z28.boolean(),
-  errors: z28.array(ValidationError).optional()
+var ValidateResult = z27.object({
+  valid: z27.boolean(),
+  errors: z27.array(ValidationError).optional()
 });
 
 // src/v1/validator/index.ts
@@ -1937,15 +1852,18 @@ __export(v1_exports, {
   DATE_RANGE_PATTERN: () => DATE_RANGE_PATTERN,
   Date: () => Date,
   DateEntityType: () => DateEntityType,
+  Description: () => Description,
   Event: () => Event,
   EventEntityType: () => EventEntityType,
-  IdentifiedBy: () => IdentifiedBy,
   Keyword: () => Keyword,
   KeywordEntityType: () => KeywordEntityType,
   KeywordFolksnomy: () => KeywordFolksnomy,
   KeywordFolksnomyEntityType: () => KeywordFolksnomyEntityType,
+  Label: () => Label,
   Link: () => Link,
   LinkEntityType: () => LinkEntityType,
+  ModeExistence: () => ModeExistence,
+  Motivation: () => Motivation,
   Note: () => Note,
   NoteEntityType: () => NoteEntityType,
   Organization: () => Organization,
@@ -1962,7 +1880,6 @@ __export(v1_exports, {
   Selector: () => Selector,
   Software: () => Software,
   Source: () => Source,
-  Status: () => Status,
   Target: () => Target,
   TextPositionSelector: () => TextPositionSelector,
   TextPositionSelectorExtended: () => TextPositionSelectorExtended,
@@ -1995,17 +1912,21 @@ __export(v1_exports, {
   dateSchema: () => dateSchema,
   definitionSchema: () => definitionSchema,
   defsId: () => defsId,
+  descriptionSchema: () => descriptionSchema,
   eventEntityTypeSchema: () => eventEntityTypeSchema,
   eventSchema: () => eventSchema,
   formatSchema: () => formatSchema,
-  indentifyBySchema: () => indentifyBySchema,
+  isIdentifiedBy: () => isIdentifiedBy,
+  isIndentifyBySchema: () => isIndentifyBySchema,
   keywordEntityTypeSchema: () => keywordEntityTypeSchema,
   keywordFolksnomyEntityTypeSchema: () => keywordFolksnomyEntityTypeSchema,
   keywordFolksnomySchema: () => keywordFolksnomySchema,
   keywordSchema: () => keywordSchema,
+  labelSchema: () => labelSchema,
   languageSchema: () => languageSchema,
   linkEntityTypeSchema: () => linkEntityTypeSchema,
   linkSchema: () => linkSchema,
+  modeExistenceSchema: () => modeExistenceSchema,
   noteEntityTypeSchema: () => noteEntityTypeSchema,
   noteSchema: () => noteSchema,
   organizationEntityTypeSchema: () => organizationEntityTypeSchema,
@@ -2052,15 +1973,18 @@ export {
   DATE_RANGE_PATTERN,
   Date,
   DateEntityType,
+  Description,
   Event,
   EventEntityType,
-  IdentifiedBy,
   Keyword,
   KeywordEntityType,
   KeywordFolksnomy,
   KeywordFolksnomyEntityType,
+  Label,
   Link,
   LinkEntityType,
+  ModeExistence,
+  Motivation,
   Note,
   NoteEntityType,
   Organization,
@@ -2077,7 +2001,6 @@ export {
   Selector,
   Software,
   Source,
-  Status,
   Target,
   TextPositionSelector,
   TextPositionSelectorExtended,
@@ -2110,17 +2033,21 @@ export {
   dateSchema,
   definitionSchema,
   defsId,
+  descriptionSchema,
   eventEntityTypeSchema,
   eventSchema,
   formatSchema,
-  indentifyBySchema,
+  isIdentifiedBy,
+  isIndentifyBySchema,
   keywordEntityTypeSchema,
   keywordFolksnomyEntityTypeSchema,
   keywordFolksnomySchema,
   keywordSchema,
+  labelSchema,
   languageSchema,
   linkEntityTypeSchema,
   linkSchema,
+  modeExistenceSchema,
   noteEntityTypeSchema,
   noteSchema,
   organizationEntityTypeSchema,

package/dist/v1/jsonld/context.jsonld

@@ -9,37 +9,43 @@
     "wikidata": "http://www.wikidata.org/entity/",
     "crm": "http://www.cidoc-crm.org/cidoc-crm/",
     "crmdig": "http://www.ics.forth.gr/isl/CRMdig/",
-    "additionalType": {
-      "@type": "@id",
-      "@id": "crm:P2_has_type"
+    "citing": "edit:citing",
+    "correcting": "edit:correcting",
+    "oa:identifying": {
+      "type": "crm:E55_Type"
+    },
+    "oa:describing": {
+      "type": "crm:E55_Type"
+    },
+    "oa:tagging": {
+      "type": "crm:E55_Type"
+    },
+    "oa:classifying": {
+      "type": "crm:E55_Type"
+    },
+    "oa:linking": {
+      "type": "crm:E55_Type"
     },
     "certainty": {
       "@type": "@id",
-      "@id": "crm:P2_has_type"
+      "@id": "http://temp.lincsproject.ca/certainty"
+    },
+    "precision": {
+      "@type": "@id",
+      "@id": "http://temp.lincsproject.ca/precision"
     },
     "contributor": "dcterms:contributor",
-    "description": "rdfs:comment",
     "entityType": {
       "@type": "@id",
       "@id": "rdf:type"
     },
-    "identifiedBy": "crm:P1_is_identified_by",
-    "modeExistence": "edit:ModeExistence",
-    "precision": {
-      "@type": "@id",
-      "@id": "crm:P2_has_type"
-    },
-    "softwareVersion": "schema:softwareVersion",
-    "status": {
+    "additionalType": {
       "@type": "@id",
       "@id": "crm:P2_has_type"
     },
+    "modeExistence": "edit:ModeExistence",
+    "description": "rdfs:comment",
     "title": "crm:P190_has_symbolic_content",
-    "usedSpecificObject": "crm:P16_used_specific_object",
-    "approved": "edit:statusApproved",
-    "citing": "edit:citing",
-    "correcting": "edit:correcting",
-    "draft": "edit:statusDraft",
-    "published": "edit:statusPublished"
+    "softwareVersion": "schema:softwareVersion"
   }
 }

package/dist/v1/jsonld/defs.jsonld

@@ -40,7 +40,7 @@
           "type": "string",
           "const": "Software"
         },
-        "usedSpecificObject": {
+        "P16_used_specific_object": {
           "type": "string",
           "format": "uri"
         },
@@ -123,7 +123,7 @@
                 }
               ]
             },
-            "identifiedBy": {
+            "P1_is_identified_by": {
               "type": "object",
               "description": "indentifyBy",
               "properties": {