@lincs.project/webannotation-schema 1.0.0

package/lib/schema/root.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"root.d.ts","sourceRoot":"","sources":["../../src/schema/root.ts"],"names":[],"mappings":"AAAA,OAAY,EAAE,cAAc,EAAE,MAAM,KAAK,CAAC;AAE1C,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AA2BxB,eAAO,MAAM,MAAM,6CAA8C,CAAC;AAClE,MAAM,MAAM,MAAM,GAAG,CAAC,OAAO,MAAM,CAAC,CAAC,MAAM,CAAC,CAAC;AAiB7C,eAAO,MAAM,UAAU,qGAQb,CAAC;AAEX,MAAM,MAAM,UAAU,GAAG,CAAC,OAAO,UAAU,CAAC,CAAC,MAAM,CAAC,CAAC;AAuBrD,eAAO,MAAM,aAAa;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EA8CQ,CAAC;AAEnC,MAAM,MAAM,aAAa,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,aAAa,CAAC,CAAC;AAI1D,eAAO,MAAM,mBAAmB,EAAE,cAAc,CAAC,QAAQ,CAAC,aAAa,CAAC,CAkTvE,CAAC"}

package/lib/schema/root.js

@@ -0,0 +1,408 @@
+import Ajv from 'ajv';
+import addFormats from 'ajv-formats';
+import { z } from 'zod';
+import { schemaId, contextUri } from './config';
+import { Body, Software, Target, User, personEntityTypeSchema } from './definitions';
+import { citationEntityTypeSchema } from './definitions/body/citation';
+import { conceptualObjectEntityTypeSchema } from './definitions/body/conceptualObject';
+import { correctionEntityTypeSchema } from './definitions/body/correction';
+import { dateEntityTypeSchema } from './definitions/body/date';
+import { keywordEntityTypeSchema, keywordFolksnomyEntityTypeSchema, } from './definitions/body/keyword';
+import { linkEntityTypeSchema } from './definitions/body/link';
+import { noteEntityTypeSchema } from './definitions/body/note';
+import { organizationEntityTypeSchema } from './definitions/body/organization';
+import { physicalThingEntityTypeSchema } from './definitions/body/physicalThing';
+import { placeEntityTypeSchema } from './definitions/body/place';
+import { workEntityTypeSchema } from './definitions/body/work';
+const ajv = new Ajv(); // options can be passed, e.g. {allErrors: true}
+addFormats(ajv);
+// * Pure Typescript Type - Just for reference
+// type Status = 'draft' | 'approved' | 'published';
+// * Type using Zod & Inference
+export const Status = ['draft', 'approved', 'published'];
+//** -------------- */
+// * Pure Typescript Type - Just for reference
+// type Motivation =
+//   | 'identifying'
+//   | 'describing'
+//   | 'correcting'
+//   | 'tagging'
+//   | 'classifying'
+//   | 'linking'
+//   | 'citing';
+// * Type using Zod & Inference
+export const Motivation = [
+    'identifying',
+    'describing',
+    'correcting',
+    'tagging',
+    'classifying',
+    'linking',
+    'citing',
+];
+//** -------------- */
+// * Pure Typescript Type - Just for reference
+// interface WebAnnotationRoot {
+//   '@context': ['http://www.w3.org/ns/anno.jsonld', contextUri];
+//   id: string;
+//   type: ['Annotation', 'crm:E33_Linguistic_Object'];
+//   motivation: [Motivation, 'crm:E33_Linguistic_Object'];
+//   created: string;
+//   modified?: string;
+//   creator: User;
+//   contributor?: User[];
+//   generator: Software;
+//   target: Target;
+//   body: Body;
+//   status: Status;
+// }
+// * Type using Zod & Inference
+export const WebAnnotation = z
+    .object({
+    '@context': z
+        .tuple([
+        z.literal('http://www.w3.org/ns/anno.jsonld').describe('W3C Web Annotation Context.'),
+        z
+            .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: z
+        .union([
+        z.string().url(),
+        z.string().uuid(),
+    ])
+        .describe('The identity of the Annotation. It must be a URI or UUID.'),
+    type: z
+        .tuple([z.literal('Annotation'), z.literal('crm:E33_Linguistic_Object')])
+        .describe('The type of the Annotation.'),
+    motivation: z
+        .tuple([z.enum(Motivation), z.literal('crm:E33_Linguistic_Object')])
+        .describe('The relationship between an Annotation and a Motivation.'),
+    created: z
+        .string()
+        .datetime() //* generates format: 'date-time'. But we might need 'iso-data-time',
+        .describe('The time at which the resource was created.'),
+    modified: z
+        .string()
+        .datetime() //* generates format: 'date-time'. But we might need 'iso-data-time',
+        .optional()
+        .describe('The time at which the resource was modified, after creation.'),
+    status: z.enum(Status).describe('The status of this annotation in a workflow.'),
+    creator: User.describe('The agent responsible for creating the resource.'),
+    contributor: z
+        .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: Body.describe('The relationship between an Annotation and its Body.'),
+})
+    .describe('Web Annotation Root');
+// * JSONSchema
+export const webAnnotationSchema = {
+    $id: schemaId,
+    type: 'object',
+    description: 'Web Annotation',
+    properties: {
+        '@context': {
+            type: 'array',
+            minItems: 2,
+            maxItems: 2,
+            items: [
+                { type: 'string', const: 'http://www.w3.org/ns/anno.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.',
+        },
+        id: {
+            anyOf: [
+                {
+                    type: 'string',
+                    format: 'uri',
+                    description: 'Idealy, this this uri must be a concatenation of an URI and UUID with an "_".',
+                },
+                { type: 'string', format: 'uuid' },
+            ],
+            description: 'The identity of the Annotation. It must be a URI or UUID.',
+        },
+        type: {
+            type: 'array',
+            minItems: 2,
+            maxItems: 2,
+            items: [
+                { type: 'string', const: 'Annotation' },
+                { type: 'string', const: 'crm:E33_Linguistic_Object' },
+            ],
+            description: 'The type of the Annotation.',
+        },
+        motivation: {
+            type: 'array',
+            minItems: 2,
+            maxItems: 2,
+            items: [
+                { type: 'string', enum: Motivation },
+                { type: 'string', const: 'crm:E33_Linguistic_Object' },
+            ],
+            description: 'The relationship between an Annotation and a Motivation.',
+        },
+        created: {
+            type: 'string',
+            format: 'date-time',
+            description: 'The time at which the resource was created.',
+        },
+        modified: {
+            type: 'string',
+            format: 'date-time',
+            description: 'The time at which the resource was modified, after creation.',
+        },
+        creator: { $ref: 'defs.jsonld#/definitions/creator' },
+        contributor: {
+            type: 'array',
+            items: { $ref: 'defs.jsonld#/definitions/creator' },
+            minItems: 1,
+        },
+        generator: { $ref: 'defs.jsonld#/definitions/software' },
+        target: { $ref: 'defs.jsonld#/definitions/target' },
+        body: { $ref: 'defs.jsonld#/definitions/body' },
+        status: { type: 'string', enum: Status },
+    },
+    required: [
+        '@context',
+        'id',
+        'type',
+        'motivation',
+        'created',
+        'creator',
+        'generator',
+        'target',
+        'body',
+        'status',
+    ],
+    allOf: [
+        {
+            if: {
+                type: 'object',
+                properties: {
+                    status: { const: 'published' },
+                },
+            },
+            then: {
+                type: 'object',
+                properties: {
+                    id: { type: 'string', format: 'uri' },
+                },
+                required: ['status'],
+            },
+            else: {
+                type: 'object',
+                properties: {
+                    id: { type: 'string', format: 'uuid' },
+                },
+                required: ['status'],
+            },
+        },
+        {
+            if: {
+                type: 'object',
+                properties: {
+                    body: {
+                        type: 'object',
+                        properties: {
+                            entityType: {
+                                oneOf: [
+                                    personEntityTypeSchema,
+                                    placeEntityTypeSchema,
+                                    organizationEntityTypeSchema,
+                                    workEntityTypeSchema,
+                                    physicalThingEntityTypeSchema,
+                                    conceptualObjectEntityTypeSchema,
+                                    dateEntityTypeSchema,
+                                ],
+                            },
+                        },
+                    },
+                },
+            },
+            then: {
+                type: 'object',
+                properties: {
+                    motivation: {
+                        type: 'array',
+                        minItems: 2,
+                        maxItems: 2,
+                        items: [
+                            { type: 'string', const: 'identifying' },
+                            { type: 'string', const: 'crm:E33_Linguistic_Object' },
+                        ],
+                    },
+                },
+            },
+            else: {
+                if: {
+                    type: 'object',
+                    properties: {
+                        body: {
+                            type: 'object',
+                            properties: {
+                                entityType: noteEntityTypeSchema,
+                            },
+                        },
+                    },
+                },
+                then: {
+                    type: 'object',
+                    properties: {
+                        motivation: {
+                            type: 'array',
+                            minItems: 2,
+                            maxItems: 2,
+                            items: [
+                                { type: 'string', const: 'describing' },
+                                { type: 'string', const: 'crm:E33_Linguistic_Object' },
+                            ],
+                        },
+                    },
+                },
+                else: {
+                    if: {
+                        type: 'object',
+                        properties: {
+                            body: {
+                                type: 'object',
+                                properties: {
+                                    entityType: correctionEntityTypeSchema,
+                                },
+                            },
+                        },
+                    },
+                    then: {
+                        type: 'object',
+                        properties: {
+                            motivation: {
+                                type: 'array',
+                                minItems: 2,
+                                maxItems: 2,
+                                items: [
+                                    { type: 'string', const: 'correcting' },
+                                    { type: 'string', const: 'crm:E33_Linguistic_Object' },
+                                ],
+                            },
+                        },
+                    },
+                    else: {
+                        if: {
+                            type: 'object',
+                            properties: {
+                                body: {
+                                    type: 'object',
+                                    properties: {
+                                        entityType: keywordFolksnomyEntityTypeSchema,
+                                    },
+                                },
+                            },
+                        },
+                        then: {
+                            type: 'object',
+                            properties: {
+                                motivation: {
+                                    type: 'array',
+                                    minItems: 2,
+                                    maxItems: 2,
+                                    items: [
+                                        { type: 'string', const: 'tagging' },
+                                        { type: 'string', const: 'crm:E33_Linguistic_Object' },
+                                    ],
+                                },
+                            },
+                        },
+                        else: {
+                            if: {
+                                type: 'object',
+                                properties: {
+                                    body: {
+                                        type: 'object',
+                                        properties: {
+                                            entityType: keywordEntityTypeSchema,
+                                        },
+                                    },
+                                },
+                            },
+                            then: {
+                                type: 'object',
+                                properties: {
+                                    motivation: {
+                                        type: 'array',
+                                        minItems: 2,
+                                        maxItems: 2,
+                                        items: [
+                                            { type: 'string', const: 'classifying' },
+                                            { type: 'string', const: 'crm:E33_Linguistic_Object' },
+                                        ],
+                                    },
+                                },
+                            },
+                            else: {
+                                if: {
+                                    type: 'object',
+                                    properties: {
+                                        body: {
+                                            type: 'object',
+                                            properties: {
+                                                entityType: linkEntityTypeSchema,
+                                            },
+                                        },
+                                    },
+                                },
+                                then: {
+                                    type: 'object',
+                                    properties: {
+                                        motivation: {
+                                            type: 'array',
+                                            minItems: 2,
+                                            maxItems: 2,
+                                            items: [
+                                                { type: 'string', const: 'linking' },
+                                                { type: 'string', const: 'crm:E33_Linguistic_Object' },
+                                            ],
+                                        },
+                                    },
+                                },
+                                else: {
+                                    if: {
+                                        type: 'object',
+                                        properties: {
+                                            body: {
+                                                type: 'object',
+                                                properties: {
+                                                    entityType: citationEntityTypeSchema,
+                                                },
+                                            },
+                                        },
+                                    },
+                                    then: {
+                                        type: 'object',
+                                        properties: {
+                                            motivation: {
+                                                type: 'array',
+                                                minItems: 2,
+                                                maxItems: 2,
+                                                items: [
+                                                    { type: 'string', const: 'citing' },
+                                                    { type: 'string', const: 'crm:E33_Linguistic_Object' },
+                                                ],
+                                            },
+                                        },
+                                    },
+                                },
+                            },
+                        },
+                    },
+                },
+            },
+        },
+    ],
+    additionalProperties: false,
+};
+//# sourceMappingURL=root.js.map

package/lib/schema/root.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"root.js","sourceRoot":"","sources":["../../src/schema/root.ts"],"names":[],"mappings":"AAAA,OAAO,GAAuB,MAAM,KAAK,CAAC;AAC1C,OAAO,UAAU,MAAM,aAAa,CAAC;AACrC,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,EAAE,QAAQ,EAAE,UAAU,EAAE,MAAM,UAAU,CAAC;AAChD,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAE,sBAAsB,EAAE,MAAM,eAAe,CAAC;AACrF,OAAO,EAAE,wBAAwB,EAAE,MAAM,6BAA6B,CAAC;AACvE,OAAO,EAAE,gCAAgC,EAAE,MAAM,qCAAqC,CAAC;AACvF,OAAO,EAAE,0BAA0B,EAAE,MAAM,+BAA+B,CAAC;AAC3E,OAAO,EAAE,oBAAoB,EAAE,MAAM,yBAAyB,CAAC;AAC/D,OAAO,EACL,uBAAuB,EACvB,gCAAgC,GACjC,MAAM,4BAA4B,CAAC;AACpC,OAAO,EAAE,oBAAoB,EAAE,MAAM,yBAAyB,CAAC;AAC/D,OAAO,EAAE,oBAAoB,EAAE,MAAM,yBAAyB,CAAC;AAC/D,OAAO,EAAE,4BAA4B,EAAE,MAAM,iCAAiC,CAAC;AAC/E,OAAO,EAAE,6BAA6B,EAAE,MAAM,kCAAkC,CAAC;AACjF,OAAO,EAAE,qBAAqB,EAAE,MAAM,0BAA0B,CAAC;AACjE,OAAO,EAAE,oBAAoB,EAAE,MAAM,yBAAyB,CAAC;AAE/D,MAAM,GAAG,GAAG,IAAI,GAAG,EAAE,CAAC,CAAC,gDAAgD;AACvE,UAAU,CAAC,GAAG,CAAC,CAAC;AAEhB,8CAA8C;AAE9C,oDAAoD;AAEpD,+BAA+B;AAE/B,MAAM,CAAC,MAAM,MAAM,GAAG,CAAC,OAAO,EAAE,UAAU,EAAE,WAAW,CAAU,CAAC;AAGlE,sBAAsB;AAEtB,8CAA8C;AAE9C,oBAAoB;AACpB,oBAAoB;AACpB,mBAAmB;AACnB,mBAAmB;AACnB,gBAAgB;AAChB,oBAAoB;AACpB,gBAAgB;AAChB,gBAAgB;AAEhB,+BAA+B;AAE/B,MAAM,CAAC,MAAM,UAAU,GAAG;IACxB,aAAa;IACb,YAAY;IACZ,YAAY;IACZ,SAAS;IACT,aAAa;IACb,SAAS;IACT,QAAQ;CACA,CAAC;AAIX,sBAAsB;AAEtB,8CAA8C;AAE9C,gCAAgC;AAChC,kEAAkE;AAClE,gBAAgB;AAChB,uDAAuD;AACvD,2DAA2D;AAC3D,qBAAqB;AACrB,uBAAuB;AACvB,mBAAmB;AACnB,0BAA0B;AAC1B,yBAAyB;AACzB,oBAAoB;AACpB,gBAAgB;AAChB,oBAAoB;AACpB,IAAI;AAEJ,+BAA+B;AAE/B,MAAM,CAAC,MAAM,aAAa,GAAG,CAAC;KAC3B,MAAM,CAAC;IACN,UAAU,EAAE,CAAC;SACV,KAAK,CAAC;QACL,CAAC,CAAC,OAAO,CAAC,kCAAkC,CAAC,CAAC,QAAQ,CAAC,6BAA6B,CAAC;QACrF,CAAC;aACE,OAAO,CAAC,UAAU,CAAC;aACnB,QAAQ,CAAC,+BAA+B,CAAC;KAC7C,CAAC;SACD,QAAQ,CACP,sJAAsJ,CACvJ;IACH,EAAE,EAAE,CAAC;SACF,KAAK,CAAC;QACL,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE;QAChB,CAAC,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE;KAClB,CAAC;SACD,QAAQ,CAAC,2DAA2D,CAAC;IACxE,IAAI,EAAE,CAAC;SACJ,KAAK,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,YAAY,CAAC,EAAE,CAAC,CAAC,OAAO,CAAC,2BAA2B,CAAC,CAAC,CAAC;SACxE,QAAQ,CAAC,6BAA6B,CAAC;IAC1C,UAAU,EAAE,CAAC;SACV,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,EAAE,CAAC,CAAC,OAAO,CAAC,2BAA2B,CAAC,CAAC,CAAC;SACnE,QAAQ,CAAC,0DAA0D,CAAC;IACvE,OAAO,EAAE,CAAC;SACP,MAAM,EAAE;SACR,QAAQ,EAAE,CAAC,qEAAqE;SAChF,QAAQ,CAAC,6CAA6C,CAAC;IAC1D,QAAQ,EAAE,CAAC;SACR,MAAM,EAAE;SACR,QAAQ,EAAE,CAAC,qEAAqE;SAChF,QAAQ,EAAE;SACV,QAAQ,CAAC,8DAA8D,CAAC;IAC3E,MAAM,EAAE,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,QAAQ,CAAC,8CAA8C,CAAC;IAC/E,OAAO,EAAE,IAAI,CAAC,QAAQ,CAAC,kDAAkD,CAAC;IAC1E,WAAW,EAAE,CAAC;SACX,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,oDAAoD,CAAC,CAAC;SAC1E,QAAQ,EAAE;SACV,QAAQ,EAAE;SACV,QAAQ,CAAC,oDAAoD,CAAC;IACjE,SAAS,EAAE,QAAQ,CAAC,QAAQ,CAC1B,4EAA4E,CAC7E;IACD,MAAM,EAAE,MAAM,CAAC,QAAQ,CAAC,wDAAwD,CAAC;IACjF,IAAI,EAAE,IAAI,CAAC,QAAQ,CAAC,sDAAsD,CAAC;CAC5E,CAAC;KACD,QAAQ,CAAC,qBAAqB,CAAC,CAAC;AAInC,eAAe;AAEf,MAAM,CAAC,MAAM,mBAAmB,GAA4C;IAC1E,GAAG,EAAE,QAAQ;IACb,IAAI,EAAE,QAAQ;IACd,WAAW,EAAE,gBAAgB;IAC7B,UAAU,EAAE;QACV,UAAU,EAAE;YACV,IAAI,EAAE,OAAO;YACb,QAAQ,EAAE,CAAC;YACX,QAAQ,EAAE,CAAC;YACX,KAAK,EAAE;gBACL,EAAE,IAAI,EAAE,QAAQ,EAAE,KAAK,EAAE,kCAAkC,EAAE;gBAC7D,EAAE,IAAI,EAAE,QAAQ,EAAE,KAAK,EAAE,UAAU,EAAE;aACtC;YACD,WAAW,EACT,sJAAsJ;SACzJ;QACD,EAAE,EAAE;YACF,KAAK,EAAE;gBACL;oBACE,IAAI,EAAE,QAAQ;oBACd,MAAM,EAAE,KAAK;oBACb,WAAW,EACT,+EAA+E;iBAClF;gBACD,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE;aACnC;YACD,WAAW,EAAE,2DAA2D;SACzE;QACD,IAAI,EAAE;YACJ,IAAI,EAAE,OAAO;YACb,QAAQ,EAAE,CAAC;YACX,QAAQ,EAAE,CAAC;YACX,KAAK,EAAE;gBACL,EAAE,IAAI,EAAE,QAAQ,EAAE,KAAK,EAAE,YAAY,EAAE;gBACvC,EAAE,IAAI,EAAE,QAAQ,EAAE,KAAK,EAAE,2BAA2B,EAAE;aACvD;YACD,WAAW,EAAE,6BAA6B;SAC3C;QACD,UAAU,EAAE;YACV,IAAI,EAAE,OAAO;YACb,QAAQ,EAAE,CAAC;YACX,QAAQ,EAAE,CAAC;YACX,KAAK,EAAE;gBACL,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,UAAU,EAAE;gBACpC,EAAE,IAAI,EAAE,QAAQ,EAAE,KAAK,EAAE,2BAA2B,EAAE;aACvD;YACD,WAAW,EAAE,0DAA0D;SACxE;QACD,OAAO,EAAE;YACP,IAAI,EAAE,QAAQ;YACd,MAAM,EAAE,WAAW;YACnB,WAAW,EAAE,6CAA6C;SAC3D;QACD,QAAQ,EAAE;YACR,IAAI,EAAE,QAAQ;YACd,MAAM,EAAE,WAAW;YACnB,WAAW,EAAE,8DAA8D;SAC5E;QACD,OAAO,EAAE,EAAE,IAAI,EAAE,kCAAkC,EAAE;QACrD,WAAW,EAAE;YACX,IAAI,EAAE,OAAO;YACb,KAAK,EAAE,EAAE,IAAI,EAAE,kCAAkC,EAAE;YACnD,QAAQ,EAAE,CAAC;SACL;QACR,SAAS,EAAE,EAAE,IAAI,EAAE,mCAAmC,EAAE;QACxD,MAAM,EAAE,EAAE,IAAI,EAAE,iCAAiC,EAAE;QACnD,IAAI,EAAE,EAAE,IAAI,EAAE,+BAA+B,EAAE;QAC/C,MAAM,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,MAAM,EAAE;KACzC;IACD,QAAQ,EAAE;QACR,UAAU;QACV,IAAI;QACJ,MAAM;QACN,YAAY;QACZ,SAAS;QACT,SAAS;QACT,WAAW;QACX,QAAQ;QACR,MAAM;QACN,QAAQ;KACT;IAED,KAAK,EAAE;QACL;YACE,EAAE,EAAE;gBACF,IAAI,EAAE,QAAQ;gBACd,UAAU,EAAE;oBACV,MAAM,EAAE,EAAE,KAAK,EAAE,WAAW,EAAE;iBAC/B;aACF;YACD,IAAI,EAAE;gBACJ,IAAI,EAAE,QAAQ;gBACd,UAAU,EAAE;oBACV,EAAE,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,EAAE,KAAK,EAAE;iBACtC;gBACD,QAAQ,EAAE,CAAC,QAAQ,CAAC;aACrB;YACD,IAAI,EAAE;gBACJ,IAAI,EAAE,QAAQ;gBACd,UAAU,EAAE;oBACV,EAAE,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE;iBACvC;gBACD,QAAQ,EAAE,CAAC,QAAQ,CAAC;aACrB;SACF;QACD;YACE,EAAE,EAAE;gBACF,IAAI,EAAE,QAAQ;gBACd,UAAU,EAAE;oBACV,IAAI,EAAE;wBACJ,IAAI,EAAE,QAAQ;wBACd,UAAU,EAAE;4BACV,UAAU,EAAE;gCACV,KAAK,EAAE;oCACL,sBAAsB;oCACtB,qBAAqB;oCACrB,4BAA4B;oCAC5B,oBAAoB;oCACpB,6BAA6B;oCAC7B,gCAAgC;oCAChC,oBAAoB;iCACrB;6BACF;yBACF;qBACF;iBACF;aACF;YACD,IAAI,EAAE;gBACJ,IAAI,EAAE,QAAQ;gBACd,UAAU,EAAE;oBACV,UAAU,EAAE;wBACV,IAAI,EAAE,OAAO;wBACb,QAAQ,EAAE,CAAC;wBACX,QAAQ,EAAE,CAAC;wBACX,KAAK,EAAE;4BACL,EAAE,IAAI,EAAE,QAAQ,EAAE,KAAK,EAAE,aAAa,EAAE;4BACxC,EAAE,IAAI,EAAE,QAAQ,EAAE,KAAK,EAAE,2BAA2B,EAAE;yBACvD;qBACF;iBACF;aACF;YACD,IAAI,EAAE;gBACJ,EAAE,EAAE;oBACF,IAAI,EAAE,QAAQ;oBACd,UAAU,EAAE;wBACV,IAAI,EAAE;4BACJ,IAAI,EAAE,QAAQ;4BACd,UAAU,EAAE;gCACV,UAAU,EAAE,oBAAoB;6BACjC;yBACF;qBACF;iBACF;gBACD,IAAI,EAAE;oBACJ,IAAI,EAAE,QAAQ;oBACd,UAAU,EAAE;wBACV,UAAU,EAAE;4BACV,IAAI,EAAE,OAAO;4BACb,QAAQ,EAAE,CAAC;4BACX,QAAQ,EAAE,CAAC;4BACX,KAAK,EAAE;gCACL,EAAE,IAAI,EAAE,QAAQ,EAAE,KAAK,EAAE,YAAY,EAAE;gCACvC,EAAE,IAAI,EAAE,QAAQ,EAAE,KAAK,EAAE,2BAA2B,EAAE;6BACvD;yBACF;qBACF;iBACF;gBACD,IAAI,EAAE;oBACJ,EAAE,EAAE;wBACF,IAAI,EAAE,QAAQ;wBACd,UAAU,EAAE;4BACV,IAAI,EAAE;gCACJ,IAAI,EAAE,QAAQ;gCACd,UAAU,EAAE;oCACV,UAAU,EAAE,0BAA0B;iCACvC;6BACF;yBACF;qBACF;oBACD,IAAI,EAAE;wBACJ,IAAI,EAAE,QAAQ;wBACd,UAAU,EAAE;4BACV,UAAU,EAAE;gCACV,IAAI,EAAE,OAAO;gCACb,QAAQ,EAAE,CAAC;gCACX,QAAQ,EAAE,CAAC;gCACX,KAAK,EAAE;oCACL,EAAE,IAAI,EAAE,QAAQ,EAAE,KAAK,EAAE,YAAY,EAAE;oCACvC,EAAE,IAAI,EAAE,QAAQ,EAAE,KAAK,EAAE,2BAA2B,EAAE;iCACvD;6BACF;yBACF;qBACF;oBACD,IAAI,EAAE;wBACJ,EAAE,EAAE;4BACF,IAAI,EAAE,QAAQ;4BACd,UAAU,EAAE;gCACV,IAAI,EAAE;oCACJ,IAAI,EAAE,QAAQ;oCACd,UAAU,EAAE;wCACV,UAAU,EAAE,gCAAgC;qCAC7C;iCACF;6BACF;yBACF;wBACD,IAAI,EAAE;4BACJ,IAAI,EAAE,QAAQ;4BACd,UAAU,EAAE;gCACV,UAAU,EAAE;oCACV,IAAI,EAAE,OAAO;oCACb,QAAQ,EAAE,CAAC;oCACX,QAAQ,EAAE,CAAC;oCACX,KAAK,EAAE;wCACL,EAAE,IAAI,EAAE,QAAQ,EAAE,KAAK,EAAE,SAAS,EAAE;wCACpC,EAAE,IAAI,EAAE,QAAQ,EAAE,KAAK,EAAE,2BAA2B,EAAE;qCACvD;iCACF;6BACF;yBACF;wBACD,IAAI,EAAE;4BACJ,EAAE,EAAE;gCACF,IAAI,EAAE,QAAQ;gCACd,UAAU,EAAE;oCACV,IAAI,EAAE;wCACJ,IAAI,EAAE,QAAQ;wCACd,UAAU,EAAE;4CACV,UAAU,EAAE,uBAAuB;yCACpC;qCACF;iCACF;6BACF;4BACD,IAAI,EAAE;gCACJ,IAAI,EAAE,QAAQ;gCACd,UAAU,EAAE;oCACV,UAAU,EAAE;wCACV,IAAI,EAAE,OAAO;wCACb,QAAQ,EAAE,CAAC;wCACX,QAAQ,EAAE,CAAC;wCACX,KAAK,EAAE;4CACL,EAAE,IAAI,EAAE,QAAQ,EAAE,KAAK,EAAE,aAAa,EAAE;4CACxC,EAAE,IAAI,EAAE,QAAQ,EAAE,KAAK,EAAE,2BAA2B,EAAE;yCACvD;qCACF;iCACF;6BACF;4BACD,IAAI,EAAE;gCACJ,EAAE,EAAE;oCACF,IAAI,EAAE,QAAQ;oCACd,UAAU,EAAE;wCACV,IAAI,EAAE;4CACJ,IAAI,EAAE,QAAQ;4CACd,UAAU,EAAE;gDACV,UAAU,EAAE,oBAAoB;6CACjC;yCACF;qCACF;iCACF;gCACD,IAAI,EAAE;oCACJ,IAAI,EAAE,QAAQ;oCACd,UAAU,EAAE;wCACV,UAAU,EAAE;4CACV,IAAI,EAAE,OAAO;4CACb,QAAQ,EAAE,CAAC;4CACX,QAAQ,EAAE,CAAC;4CACX,KAAK,EAAE;gDACL,EAAE,IAAI,EAAE,QAAQ,EAAE,KAAK,EAAE,SAAS,EAAE;gDACpC,EAAE,IAAI,EAAE,QAAQ,EAAE,KAAK,EAAE,2BAA2B,EAAE;6CACvD;yCACF;qCACF;iCACF;gCACD,IAAI,EAAE;oCACJ,EAAE,EAAE;wCACF,IAAI,EAAE,QAAQ;wCACd,UAAU,EAAE;4CACV,IAAI,EAAE;gDACJ,IAAI,EAAE,QAAQ;gDACd,UAAU,EAAE;oDACV,UAAU,EAAE,wBAAwB;iDACrC;6CACF;yCACF;qCACF;oCACD,IAAI,EAAE;wCACJ,IAAI,EAAE,QAAQ;wCACd,UAAU,EAAE;4CACV,UAAU,EAAE;gDACV,IAAI,EAAE,OAAO;gDACb,QAAQ,EAAE,CAAC;gDACX,QAAQ,EAAE,CAAC;gDACX,KAAK,EAAE;oDACL,EAAE,IAAI,EAAE,QAAQ,EAAE,KAAK,EAAE,QAAQ,EAAE;oDACnC,EAAE,IAAI,EAAE,QAAQ,EAAE,KAAK,EAAE,2BAA2B,EAAE;iDACvD;6CACF;yCACF;qCACF;iCACF;6BACF;yBACF;qBACF;iBACF;aACF;SACF;KACF;IACD,oBAAoB,EAAE,KAAK;CAC5B,CAAC"}

package/lib/validation.d.ts

@@ -0,0 +1,25 @@
+import { type ValidationError } from '@apideck/better-ajv-errors';
+export type Annotation = {
+    [x: string]: any;
+};
+export interface ValidateResult {
+    errors?: ValidationError[];
+    valid: boolean;
+}
+/**
+ * This function validates an annotation object and returns a validation result.
+ * @param {Annotation} annotation
+ * @returns Oject of type `ValidateResult`. The object has a `valid` property which is a boolean
+ * indicating whether the annotation is valid or not. If the annotation is not valid, the object
+ * also has an `errors` property which is an array of error messages.
+ */
+export declare const validate: (annotation: Annotation) => ValidateResult;
+/**
+ * This function takes an annotation object and returns any validation errors using a schema and validator.
+ * @param {any} annotation
+ * @returns Array of error objects that are generated by the `betterAjvErrors` library. These errors are
+ *  based on the `webAnnotationSchema` schema and the `annotation` data object that is passed as an argument
+ *  to the function.
+ */
+export declare const getErrors: (annotation: any) => ValidationError[];
+//# sourceMappingURL=validation.d.ts.map

package/lib/validation.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"validation.d.ts","sourceRoot":"","sources":["../src/validation.ts"],"names":[],"mappings":"AAAA,OAAO,EAAmB,KAAK,eAAe,EAAE,MAAM,4BAA4B,CAAC;AAInF,MAAM,MAAM,UAAU,GAAG;IAAE,CAAC,CAAC,EAAE,MAAM,GAAG,GAAG,CAAA;CAAE,CAAC;AAE9C,MAAM,WAAW,cAAc;IAC7B,MAAM,CAAC,EAAE,eAAe,EAAE,CAAC;IAC3B,KAAK,EAAE,OAAO,CAAC;CAChB;AAED;;;;;;GAMG;AACH,eAAO,MAAM,QAAQ,eAAgB,UAAU,mBAO9C,CAAC;AAEF;;;;;;GAMG;AACH,eAAO,MAAM,SAAS,eAAgB,GAAG,sBASxC,CAAC"}

package/lib/validation.js

@@ -0,0 +1,35 @@
+import { betterAjvErrors } from '@apideck/better-ajv-errors';
+import { validator } from './';
+import { webAnnotationSchema } from './schema';
+/**
+ * This function validates an annotation object and returns a validation result.
+ * @param {Annotation} annotation
+ * @returns Oject of type `ValidateResult`. The object has a `valid` property which is a boolean
+ * indicating whether the annotation is valid or not. If the annotation is not valid, the object
+ * also has an `errors` property which is an array of error messages.
+ */
+export const validate = (annotation) => {
+    const isValid = validator(annotation);
+    const result = { valid: isValid };
+    if (!isValid)
+        result.errors = getErrors(annotation);
+    return result;
+};
+/**
+ * This function takes an annotation object and returns any validation errors using a schema and validator.
+ * @param {any} annotation
+ * @returns Array of error objects that are generated by the `betterAjvErrors` library. These errors are
+ *  based on the `webAnnotationSchema` schema and the `annotation` data object that is passed as an argument
+ *  to the function.
+ */
+export const getErrors = (annotation) => {
+    const errors = betterAjvErrors({
+        //@ts-ignore
+        schema: webAnnotationSchema,
+        data: annotation,
+        errors: validator.errors,
+        basePath: '{annotation}',
+    });
+    return errors;
+};
+//# sourceMappingURL=validation.js.map

package/lib/validation.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"validation.js","sourceRoot":"","sources":["../src/validation.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAwB,MAAM,4BAA4B,CAAC;AACnF,OAAO,EAAE,SAAS,EAAE,MAAM,IAAI,CAAC;AAC/B,OAAO,EAAE,mBAAmB,EAAE,MAAM,UAAU,CAAC;AAS/C;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,QAAQ,GAAG,CAAC,UAAsB,EAAE,EAAE;IACjD,MAAM,OAAO,GAAG,SAAS,CAAC,UAAU,CAAC,CAAC;IAEtC,MAAM,MAAM,GAAmB,EAAE,KAAK,EAAE,OAAO,EAAE,CAAC;IAClD,IAAI,CAAC,OAAO;QAAE,MAAM,CAAC,MAAM,GAAG,SAAS,CAAC,UAAU,CAAC,CAAC;IAEpD,OAAO,MAAM,CAAC;AAChB,CAAC,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,SAAS,GAAG,CAAC,UAAe,EAAE,EAAE;IAC3C,MAAM,MAAM,GAAG,eAAe,CAAC;QAC7B,YAAY;QACZ,MAAM,EAAE,mBAAmB;QAC3B,IAAI,EAAE,UAAU;QAChB,MAAM,EAAE,SAAS,CAAC,MAAM;QACxB,QAAQ,EAAE,cAAc;KACzB,CAAC,CAAC;IACH,OAAO,MAAM,CAAC;AAChB,CAAC,CAAC"}

package/package.json

@@ -0,0 +1,68 @@
+{
+  "name": "@lincs.project/webannotation-schema",
+  "version": "1.0.0",
+  "description": "lincs project web annotation json schema and validator",
+  "keywords": [
+    "lincs project",
+    "web annotation",
+    "json-ld",
+    "json schema"
+  ],
+  "homepage": "https://gitlab.com/calincs/conversion/lincs-webannotation",
+  "bugs": {
+    "url": "https://gitlab.com/calincs/conversion/lincs-webannotation/-/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://gitlab.com/calincs/conversion/lincs-webannotation.git"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "license": "GPL-2.0",
+  "author": "Luciano Frizzera <lucaju@gmail.com>",
+  "exports": [
+    "./src/index.ts",
+    "./lib/index.js"
+  ],
+  "types": "lib/index.d.ts",
+  "files": [
+    "dist",
+    "lib"
+  ],
+  "module": "src/index.ts",
+  "main": "./dist/index.js",
+  "scripts": {
+    "build": "npm run clean && tsc && npm run generate && npm run build-documentation",
+    "generate": "ts-node ./bin/generate.ts",
+    "clean": "shx rm -rf dist lib public",
+    "build-documentation": "typedoc --out docs src/index.ts",
+    "test": "jest",
+    "test-watch": "jest --watchAll --verbose",
+    "cm": "git-cz",
+    "prepublishOnly": "npm test && npm run build"
+  },
+  "dependencies": {
+    "@apideck/better-ajv-errors": "^0.3.6",
+    "ajv": "^8.12.0",
+    "ajv-formats": "^2.1.1",
+    "typescript": "^5.1.3",
+    "zod": "^3.21.4"
+  },
+  "devDependencies": {
+    "@jest/globals": "^29.5.0",
+    "@types/fs-extra": "^11.0.1",
+    "@types/jest": "^29.5.2",
+    "@types/node": "^20.3.1",
+    "commitizen": "^4.3.0",
+    "eslint": "^8.43.0",
+    "fs-extra": "^11.1.1",
+    "git-cz": "^4.9.0",
+    "jest": "^29.5.0",
+    "kleur": "^4.1.5",
+    "prettier": "^2.8.8",
+    "shx": "^0.3.4",
+    "ts-jest": "^29.1.0",
+    "ts-node": "^10.9.1"
+  }
+}