@ghentcdh/annotation-api 0.0.1-alpha.1 → 0.0.1-alpha.13

package/lib/annotation/annotation.mapper.service.d.ts

@@ -0,0 +1,11 @@
+import { W3CAnnotation } from '@ghentcdh/w3c-utils';
+import { AnnotationContext } from '@ghentcdh/annotation-core';
+import { AnnotationContextService } from '../context/annotation-context.service';
+export declare abstract class AnnotationW3cMapperService<ANNOTATION> {
+    private contextService;
+    constructor(contextService: AnnotationContextService);
+    getW3CAnnotation(type: string, annotation: ANNOTATION): Promise<W3CAnnotation>;
+    fromW3CAnnotation(type: string, annotation: W3CAnnotation): Promise<ANNOTATION>;
+    abstract mapToW3CAnnotation(context: AnnotationContext | undefined | null, annotation: ANNOTATION): W3CAnnotation;
+    abstract mapFromW3CAnnotation(context: AnnotationContext | undefined | null, annotation: W3CAnnotation): ANNOTATION;
+}

package/lib/annotation/annotation.repository.d.ts

@@ -0,0 +1,9 @@
+export declare abstract class AnnotationCrudRepository<ANNOTATION> {
+    abstract delete(id: string): Promise<boolean>;
+    abstract create(annotation: ANNOTATION): Promise<ANNOTATION>;
+    abstract update(id: string, annotation: ANNOTATION): Promise<ANNOTATION>;
+    abstract findOne(id: string): Promise<{
+        annotation: ANNOTATION;
+        type: string;
+    }>;
+}

package/lib/annotation-api.module.d.ts

@@ -1,11 +1,12 @@
-import { DynamicModule, Type } from '@nestjs/common';
+import { DynamicModule } from '@nestjs/common';
 import { AnnotationDefConfig } from '@ghentcdh/annotation-core';
-import { AnnotationDefinitionService } from './service/annotation-definition.service';
-type AnnotationApiConfig = {
-    annotationDefinitionService: Type<AnnotationDefinitionService>;
+import { AnnotationCrudRepository } from './annotation/annotation.repository';
+import { AnnotationW3cMapperService } from './annotation/annotation.mapper.service';
+type AnnotationRepositoryConfig<ANNOTATION> = {
+    repository: new (...args: any[]) => AnnotationCrudRepository<ANNOTATION>;
+    mapper: new (...args: any[]) => AnnotationW3cMapperService<ANNOTATION>;
 };
 export declare class AnnotationApiModule {
-    static forService(config: AnnotationApiConfig): DynamicModule;
-    static forResourceDir(dirPath: string, config: AnnotationDefConfig): Promise<DynamicModule>;
+    static forResourceDir<ANNOTATION>(resourcePath: string, datasourcePath: string, config: AnnotationDefConfig, annotation?: AnnotationRepositoryConfig<ANNOTATION>): Promise<DynamicModule>;
 }
 export {};

package/lib/annotation-namespace.controller.d.ts

@@ -1,65 +1,17 @@
-import { AnnotationDefConfig } from '@ghentcdh/annotation-core';
-import { AnnotationDefinitionService } from './service/annotation-definition.service';
+import { AnnotationJsonResource } from '@ghentcdh/annotation-core';
+import { ResourceConfigRegistry } from '@ghentcdh/crouton-api';
+import { AnnotationContextService } from './context/annotation-context.service';
 export declare class AnnotationNamespaceController {
     private readonly service;
-    private readonly annotationDefConfig;
-    constructor(service: AnnotationDefinitionService, annotationDefConfig: AnnotationDefConfig);
-    getAll(): Promise<{
-        id: string;
-        name: string;
-        columns: Record<string, never>[];
-        color: string;
-        isRoot: boolean;
-        context: unknown;
-        json_schema?: any;
-        json_ld?: any;
-        ui_schema?: any;
-        metadata_schema?: any;
-        type?: string | undefined;
-        icon?: string | undefined;
-        allowedChildren?: string[] | undefined;
-        allowedLinks?: string[] | undefined;
-        target?: "gutter" | "underline" | "highlight" | undefined;
-    }[]>;
-    getJsonLd_(id: string): Promise<any>;
-    getSchemas(id: string): Promise<{
-        id: string;
-        name: string;
-        json_schema: any;
-        ui_schema: any;
-        metadata_schema: any;
-        columns: Record<string, never>[];
-        isRoot: boolean;
-        allowedChildren: string[] | undefined;
-        allowedLinks: string[] | undefined;
-        type: string | undefined;
-        icon: string | undefined;
-        target: "gutter" | "underline" | "highlight" | undefined;
-    }>;
-    getById(id: string): Promise<{
-        id: string;
-        name: string;
-        columns: Record<string, never>[];
-        color: string;
-        isRoot: boolean;
-        context: unknown;
-        json_schema?: any;
-        json_ld?: any;
-        ui_schema?: any;
-        metadata_schema?: any;
-        type?: string | undefined;
-        icon?: string | undefined;
-        allowedChildren?: string[] | undefined;
-        allowedLinks?: string[] | undefined;
-        target?: "gutter" | "underline" | "highlight" | undefined;
-    }>;
-    getFullJsonLd(): Promise<{
-        '@context': Record<string, unknown>;
-    }[]>;
-    getJsonLd(type: string): Promise<{
-        jsonLd: {
-            '@context': Record<string, unknown>;
-        };
-        forms: any;
+    private readonly annotationContextService;
+    constructor(service: ResourceConfigRegistry<AnnotationJsonResource>, annotationContextService: AnnotationContextService);
+    listNames(): Promise<{
+        annotations: {
+            id: string;
+            name: string;
+            schemas: string;
+            jsonld: string;
+        }[];
     }>;
+    getJsonLd_(id: string): Promise<string | undefined>;
 }

package/lib/context/annotation-context.service.d.ts

@@ -0,0 +1,12 @@
+import { AnnotationContext, AnnotationDefConfig, AnnotationResource } from '@ghentcdh/annotation-core';
+import { ResourceConfigRegistry } from '@ghentcdh/crouton-api';
+export declare class AnnotationContextService {
+    private readonly configRegistry;
+    private readonly annotationDefConfig;
+    private readonly contextConfigMap;
+    private readonly prefixMap;
+    constructor(configRegistry: ResourceConfigRegistry<AnnotationResource>, annotationDefConfig: AnnotationDefConfig);
+    reloadAll(): Promise<void>;
+    findById(annotationId: string): Promise<AnnotationContext | null>;
+    getResourceIdFromUri: (uri: string) => string | null;
+}

package/lib/context/index.d.ts

@@ -0,0 +1 @@
+export * from './annotation-context.service';

package/lib/prefix.d.ts

@@ -0,0 +1 @@
+export declare const SCHEMA_PREFIX = "annotation-editor";

package/lib/utils/schemaEnricher.utils.d.ts

@@ -0,0 +1 @@
+export declare const createSchemaEnricher: (baseUrl?: string) => (schema: any) => Record<string, unknown>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ghentcdh/annotation-api",
-  "version": "0.0.1-alpha.1",
+  "version": "0.0.1-alpha.13",
   "repository": {
     "type": "git",
     "url": "https://github.com/GhentCDH/annotation-editor"
@@ -9,7 +9,10 @@
   "main": "./index.js",
   "types": "./index.d.ts",
   "peerDependencies": {
-    "@ghentcdh/w3c-utils": "^1.0.6",
+    "@ghentcdh/w3c-utils": "^1.0.11",
     "@nestjs/common": "^11.1.19"
+  },
+  "dependencies": {
+    "@ghentcdh/crouton-api": "0.0.1-alpha.55"
   }
-}
+}

package/README.md

@@ -1,3 +0,0 @@
-# annotation-api
-
-This library was generated with [Nx](https://nx.dev).

package/lib/resource/annotation-resource-definition.service.d.ts

@@ -1,10 +0,0 @@
-import { AnnotationResourceDefinition } from '@ghentcdh/annotation-core';
-export declare class AnnotationResourceDefinitionService {
-    private readonly byType;
-    constructor(definitions: AnnotationResourceDefinition[]);
-    findAll: () => AnnotationResourceDefinition[];
-    getResourceForType: (type: string) => AnnotationResourceDefinition | null;
-    getResourceFromUri: (uri: string) => (AnnotationResourceDefinition & {
-        id: string;
-    }) | null;
-}

package/lib/resource/annotation-resource.loader.d.ts

@@ -1,2 +0,0 @@
-import { AnnotationResourceDefinition, AnnotationDefConfig } from '@ghentcdh/annotation-core';
-export declare const loadAnnotationResourcesFromDir: (dirPath: string, config: AnnotationDefConfig) => AnnotationResourceDefinition[];

package/lib/service/annotation-definition-from-files.service.d.ts

@@ -1,26 +0,0 @@
-import { AnnotationDefinition, AnnotationDefConfig } from '@ghentcdh/annotation-core';
-import { AnnotationDefinitionService } from './annotation-definition.service';
-type AnnotationDefinitionLoaderFn = () => AnnotationDefinition[];
-export declare class AnnotationDefinitionFromFilesService extends AnnotationDefinitionService {
-    private readonly _initialDefinitions;
-    private readonly _loaderFn?;
-    constructor(config: AnnotationDefConfig, _initialDefinitions: AnnotationDefinition[], _loaderFn?: AnnotationDefinitionLoaderFn | undefined);
-    protected reloadDefinitions: () => Promise<{
-        id: string;
-        name: string;
-        columns: Record<string, never>[];
-        color: string;
-        isRoot: boolean;
-        context: unknown;
-        json_schema?: any;
-        json_ld?: any;
-        ui_schema?: any;
-        metadata_schema?: any;
-        type?: string | undefined;
-        icon?: string | undefined;
-        allowedChildren?: string[] | undefined;
-        allowedLinks?: string[] | undefined;
-        target?: "gutter" | "underline" | "highlight" | undefined;
-    }[]>;
-}
-export {};

package/lib/service/annotation-definition.loader.d.ts

@@ -1,2 +0,0 @@
-import { AnnotationDefinition, AnnotationDefConfig, ContextBuilderFactory } from '@ghentcdh/annotation-core';
-export declare const loadAnnotationDefinitionsFromDir: (dirPath: string, annotationDefConfig: AnnotationDefConfig, contextBuilderFactory: ContextBuilderFactory) => AnnotationDefinition[];

package/lib/service/annotation-definition.service.d.ts

@@ -1,16 +0,0 @@
-import { ContextBuilder } from '@ghentcdh/w3c-utils';
-import { AnnotationDefinition, AnnotationDefConfig } from '@ghentcdh/annotation-core';
-export declare abstract class AnnotationDefinitionService {
-    protected readonly config: AnnotationDefConfig;
-    private definitions;
-    private groupedDefinitions;
-    private cachedAt;
-    constructor(config: AnnotationDefConfig);
-    findAllGrouped(): Promise<Record<string, AnnotationDefinition>>;
-    protected abstract reloadDefinitions(): Promise<AnnotationDefinition[]>;
-    setDefinitions(force?: boolean): Promise<void>;
-    findAll(): Promise<AnnotationDefinition[]>;
-    findById(id: string): Promise<AnnotationDefinition>;
-    getAllContextBuilders(): Promise<ContextBuilder[]>;
-    getContextBuilder(type: string): Promise<ContextBuilder>;
-}