@annotorious/core 3.0.0-rc.5 → 3.0.0-rc.7

package/src/model/DrawingStyle.ts

@@ -1,19 +0,0 @@
-type RGB = `rgb(${number}, ${number}, ${number})`;
-
-type RGBA = `rgba(${number}, ${number}, ${number}, ${number})`;
-
-type HEX = `#${string}`;
-
-export type Color = RGB | RGBA | HEX;
-
-export interface DrawingStyle {
-
-  fill?: Color;
-
-  fillOpacity?: number;
-
-  stroke?: Color;
-
-  strokeOpacity?: number;
-
-}

package/src/model/Filter.ts

@@ -1,3 +0,0 @@
-import type { Annotation } from './Annotation';
-
-export type Filter<T extends Annotation = Annotation> = (annotation: T) => boolean;

package/src/model/FormatAdapter.ts

@@ -1,36 +0,0 @@
-import type { Annotation } from './Annotation';
-
-export interface FormatAdapter<A extends Annotation, T extends unknown> {
-
-  parse(serialized: T): ParseResult<A>;
-
-  serialize(core: A): T;
-
-}
-
-export interface ParseResult<A extends Annotation> {
-
-  parsed?: A;
-  
-  error?: Error;
-
-}
-
-export const serializeAll = 
-  <A extends Annotation, T extends unknown>(adapter: FormatAdapter<A, T>) =>
-    (annotations: A[]) => annotations.map(a => adapter.serialize(a));
-
-export const parseAll = 
-  <A extends Annotation, T extends unknown>(adapter: FormatAdapter<A, T>) =>
-    (serialized: T[]) => serialized.reduce((result, next) => {
-      const { parsed, error } = adapter.parse(next);
-
-      return error ? {
-        parsed: result.parsed,
-        failed: [...result.failed, next ]
-      } : {
-        parsed: [...result.parsed, parsed ],
-        failed: result.failed
-      }
-    }, { parsed: [], failed: [] });
-  

package/src/model/User.ts

@@ -1,19 +0,0 @@
-import { customAlphabet } from 'nanoid';
-
-export interface User {
-
-  id: string;
-
-  isGuest?: boolean;
-
-  name?: string;
-
-  avatar?: string;
-
-}
-
-export const createAnonymousGuest = () => {
-  const nanoid = customAlphabet('1234567890abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ_', 20);
-  
-  return { isGuest: true, id: nanoid() }
-}

package/src/model/W3CAnnotation.ts

@@ -1,118 +0,0 @@
-import type { AnnotationBody } from './Annotation';
-
-export interface W3CAnnotation {
-
-  '@context': 'http://www.w3.org/ns/anno.jsonld';
-
-  type: 'Annotation';
-
-  id: string;
-
-  body: W3CAnnotationBody | W3CAnnotationBody[]
-
-  target: W3CAnnotationTarget | W3CAnnotationTarget[];
-
-  [key: string]: any;
-
-}
-
-export interface W3CAnnotationBody {
-
-  id?: string;
-
-  type?: string;
-
-  purpose?: string;
-
-  value?: string;
-
-  source?: string;
-
-  created?: Date;
-
-  creator?: {
-
-    type?: string;
-
-    id: string;
-
-    name?: string;
-
-  };
-
-}
-
-export interface W3CAnnotationTarget {
-
-  source: string;
-
-  selector?: W3CSelector | W3CSelector[];
-
-}
-
-export interface W3CSelector {
-
-  type: string;
-
-  conformsTo?: string;
-
-  value: string;
-}
-
-// https://stackoverflow.com/questions/6122571/simple-non-secure-hash-function-for-javascript
-const hashCode = (obj: Object): string => {
-  const str = JSON.stringify(obj);
-
-  let hash = 0;
-
-  for (let i = 0, len = str.length; i < len; i++) {
-      let chr = str.charCodeAt(i);
-      hash = (hash << 5) - hash + chr;
-      hash |= 0; // Convert to 32bit integer
-  }
-
-  return `${hash}`;
-}
-
-/**
- * Helper to crosswalk the W3C annotation body to a list of core AnnotationBody objects.
- */
-export const parseW3CBodies = (
-  body: W3CAnnotationBody | W3CAnnotationBody[], 
-  annotationId: string
-): AnnotationBody[] => (Array.isArray(body) ? body : [body]).map(body => {
-
-  // Exctract properties that conform to the internal model, but keep custom props
-  const { id, type, purpose, value, created, creator, ...rest } = body;
-
-  // The internal model strictly requires IDs. (Because multi-user scenarios
-  // will have problems without them.) In the W3C model, bodys *may* have IDs.
-  // We'll create ad-hoc IDs for bodies without IDs, but want to make sure that
-  // generating the ID is idempotent: the same body should always get the same ID.
-  // This will avoid unexpected results when checking for equality.  
-  return {
-    id: id || `temp-${hashCode(body)}`,
-    annotation: annotationId,
-    type,
-    purpose,
-    value,
-    created,
-    creator: creator ? 
-      typeof creator === 'object' ? { ...creator }: creator :
-      undefined,
-    ...rest
-  }
-
-});
-
-/** Serialization helper to remove core-specific fields from the annotation body **/
-export const serializeW3CBodies = (bodies: AnnotationBody[]): W3CAnnotationBody[] => 
-  bodies.map(b => {
-    const w3c = { ...b };
-    delete w3c.annotation;
-
-    if (w3c.id?.startsWith('temp-'))
-      delete w3c.id;
-  
-    return w3c;
-  });

package/src/model/index.ts

@@ -1,7 +0,0 @@
-export * from './Annotation';
-export * from './Annotator';
-export * from './DrawingStyle';
-export * from './Filter';
-export * from './FormatAdapter';
-export * from './User';
-export * from './W3CAnnotation';

package/src/presence/Appearance.ts

@@ -1,9 +0,0 @@
-export interface Appearance {
-
-  label: string;
-
-  color: string;
-
-  avatar?: string;
-
-}

package/src/presence/AppearanceProvider.ts

@@ -1,53 +0,0 @@
-import type { User } from '../model';
-import type { Appearance } from './Appearance';
-import type { PresentUser } from './PresentUser';
-import { DEFAULT_PALETTE } from './ColorPalette';
-
-export interface AppearanceProvider {
-
-  addUser(presenceKey: string, user: User): Appearance;
-
-  removeUser(user: PresentUser): void;
-
-}
-
-export const defaultColorProvider = () => {
-
-  const unassignedColors = [...DEFAULT_PALETTE];
-
-  const assignRandomColor = () => {
-    const rnd = Math.floor(Math.random() * unassignedColors.length);
-    const color = unassignedColors[rnd];
-
-    unassignedColors.splice(rnd, 1);
-
-    return color;
-  }
-
-  const releaseColor = (color: string) =>
-    unassignedColors.push(color);
-
-  return { assignRandomColor, releaseColor };
-
-}
-
-export const createDefaultAppearenceProvider = () => {
-
-  const colorProvider = defaultColorProvider();
-
-  const addUser = (presenceKey: string, user: User): Appearance => {
-    const color = colorProvider.assignRandomColor();
-
-    return {
-      label: user.name || user.id,
-      avatar: user.avatar,
-      color
-    };
-  }
-
-  const removeUser = (user: PresentUser) =>
-    colorProvider.releaseColor(user.appearance.color);
-
-  return { addUser, removeUser }
-  
-}

package/src/presence/ColorPalette.ts

@@ -1,14 +0,0 @@
-// SEABORN_BRIGHT
-export const DEFAULT_PALETTE: Palette = [
-  '#ff7c00', // orange
-  '#1ac938', // green
-  '#e8000b', // red
-  '#8b2be2', // purple
-  '#9f4800', // brown
-  '#f14cc1', // pink
-  '#ffc400', // khaki
-  '#00d7ff', // cyan
-  '#023eff'  // blue
-];
-
-export type Palette = string[];

package/src/presence/PresenceEvents.ts

@@ -1,9 +0,0 @@
-import type { PresentUser } from './PresentUser';
-
-export interface PresenceEvents {
-
-  presence: (users: PresentUser[]) => void;
-
-  selectionChange: (from: PresentUser, selection: string[] | null) => void;
-
-}

package/src/presence/PresenceProvider.ts

@@ -1,7 +0,0 @@
-import type { PresenceEvents } from './PresenceEvents';
-
-export interface PresenceProvider {
-
-  on<E extends keyof PresenceEvents>(event: E, callback: PresenceEvents[E]): void;
-
-}

package/src/presence/PresenceState.ts

@@ -1,145 +0,0 @@
-import { nanoid } from 'nanoid';
-import { createNanoEvents, type Unsubscribe } from 'nanoevents';
-import type { User } from '../model';
-import type { PresentUser } from './PresentUser';
-import type { PresenceEvents } from './PresenceEvents';
-import { createDefaultAppearenceProvider } from './AppearanceProvider';
-import type { AppearanceProvider } from './AppearanceProvider';
-
-export interface PresenceState {
-
-  // Get users currently present to this room
-  getPresentUsers(): PresentUser[];
-
-  // Notify of a given present user's activity on the given annotations
-  notifyActivity(presenceKey: string, annotationIds: string[]): void;
-
-  // Add a listener for the given presence event
-  on<E extends keyof PresenceEvents>(event: E, callback: PresenceEvents[E]): Unsubscribe;
-
-  // Initial sync - which users are present under which keys
-  syncUsers(state: { presenceKey: string, user: User }[]): void;
-
-  // Update the selection state for the given prresent user
-  updateSelection(presenceKey: string, selection: string[] | null): void;
-
-}
-
-const isListEqual = (listA: any[], listB: any[]) => 
-  listA.every(a => listA.includes(a)) && listB.every(b => listA.includes(b));
-
-// This client's presence key
-export const PRESENCE_KEY = nanoid();
-
-export const createPresenceState = (
-  appearanceProvider: AppearanceProvider = createDefaultAppearenceProvider()
-): PresenceState => {
-
-  const emitter = createNanoEvents<PresenceEvents>();
-
-  const presentUsers = new Map<string, PresentUser>();
-
-  const selectionStates = new Map<string, string[]>();
-
-  const addUser = (presenceKey: string, user: User) => {
-    if (presentUsers.has(presenceKey)) {
-      console.warn('Attempt to add user that is already present', presenceKey, user);
-      return;    
-    }
-
-    const appearance = appearanceProvider.addUser(presenceKey, user);
-
-    presentUsers.set(presenceKey, { 
-      ...user,
-      presenceKey,
-      appearance
-    });
-  }
-
-  const removeUser = (presenceKey: string) => {
-    const user = presentUsers.get(presenceKey);
-    if (!user) {
-      console.warn('Attempt to remove user that is not present', presenceKey);
-      return;
-    }
-
-    appearanceProvider.removeUser(user);
-
-    presentUsers.delete(presenceKey);
-  }
-
-  const syncUsers = (state: { presenceKey: string, user: User }[]) => {
-    // const keys = new Set(others.map(s => s.presenceKey));
-    const keys = new Set(state.map(s => s.presenceKey));
-
-    // These users need to be added to the presentUsers list
-    // const toAdd = others.filter(({ presenceKey }) => !presentUsers.has(presenceKey));
-    const toAdd = state.filter(({ presenceKey }) => !presentUsers.has(presenceKey));
-
-    // These users need to be dropped from the list
-    const toRemove = Array.from(presentUsers.values()).filter(presentUser =>
-      !keys.has(presentUser.presenceKey));
-
-    toAdd.forEach(({ presenceKey, user }) => addUser(presenceKey, user));
-
-    toRemove.forEach(user => {
-      const { presenceKey } = user;
-
-      // If this user has a selection, fire deselect event
-      if (selectionStates.has(presenceKey))
-        emitter.emit('selectionChange', user, null);
-
-      removeUser(presenceKey)
-    });
-
-    if (toAdd.length > 0 || toRemove.length > 0)
-      emitter.emit('presence', getPresentUsers());
-  }
-
-  const notifyActivity = (presenceKey: string, annotationIds: string[]) => {    
-    const user = presentUsers.get(presenceKey);
-    
-    if (!user) {
-      console.warn('Activity notification from user that is not present');
-      return;
-    }
-
-    const currentSelection = selectionStates.get(presenceKey);
-
-    // Was there a selection change we might have missed?
-    if (!currentSelection || !isListEqual(currentSelection, annotationIds)) {
-      selectionStates.set(presenceKey, annotationIds);
-      emitter.emit('selectionChange', user, annotationIds);
-    }
-  }
-
-  const updateSelection = (presenceKey: string, selection: string[] | null) => {
-    const from = presentUsers.get(presenceKey);
-    if (!from) {
-      console.warn('Selection change for user that is not present', presenceKey);
-      return;
-    }
-
-    if (selection)
-      selectionStates.set(presenceKey, selection);
-    else 
-      selectionStates.delete(presenceKey);
-
-    emitter.emit('selectionChange', from, selection);
-  }
-
-  const getPresentUsers = () =>
-    [...Array.from(presentUsers.values())];
-    
-  const on = <E extends keyof PresenceEvents>(event: E, callback: PresenceEvents[E]) =>
-    emitter.on(event, callback);
-
-  return {
-    getPresentUsers,
-    notifyActivity,
-    on,
-    syncUsers,
-    updateSelection
-  }
-
-}

package/src/presence/PresentUser.ts

@@ -1,10 +0,0 @@
-import type { User } from '../model';
-import type { Appearance } from './Appearance';
-
-export interface PresentUser extends User {
-
-  presenceKey: string;
-
-  appearance: Appearance
-
-}

package/src/presence/index.ts

@@ -1,6 +0,0 @@
-export * from './Appearance';
-export * from './AppearanceProvider';
-export * from './PresenceEvents';
-export * from './PresenceProvider';
-export * from './PresenceState';
-export * from './PresentUser';

package/src/state/Hover.ts

@@ -1,34 +0,0 @@
-import { writable } from 'svelte/store';
-import type { Annotation } from '../model';
-import type { Store } from './Store';
-
-export type HoverState<T extends Annotation> = ReturnType<typeof createHoverState<T>>;
-
-export const createHoverState = <T extends Annotation>(store: Store<T>) => {
-
-  const { subscribe, set } = writable<string>(null);
-
-  let currentHover: string = null;
-
-  subscribe(updated => currentHover = updated);
-
-  // Track store delete and update events
-  store.observe(( { changes }) => {    
-    if (currentHover) {
-      const isDeleted = changes.deleted.some(a => a.id === currentHover);
-      if (isDeleted)
-        set(null);
-    
-      const updated = changes.updated.find(({ oldValue }) => oldValue.id === currentHover);
-      if (updated)
-        set(updated.newValue.id);
-    }
-  });
-
-  return { 
-    get current() { return currentHover },
-    subscribe, 
-    set 
-  };
-
-}

package/src/state/Selection.ts

@@ -1,113 +0,0 @@
-import { writable } from 'svelte/store';
-import type {  Annotation } from '../model';
-import type { Store } from './Store';
-   
-export type Selection = {
-
-  selected: { id: string, editable?: boolean }[],
-
-  pointerEvent?: PointerEvent;
-
-}
-
-export type SelectionState<T extends Annotation> = ReturnType<typeof createSelectionState<T>>;
-
-export enum PointerSelectAction {
-
-  EDIT = 'EDIT', // Make annotation target(s) editable on pointer select
-  
-  SELECT = 'SELECT',  // Just select, but don't make editable
-
-  NONE = 'NONE' // Click won't select - annotation is completely inert
-
-}
-
-const EMPTY: Selection = { selected: [] };
-
-export const createSelectionState = <T extends Annotation>(
-  store: Store<T>,
-  selectAction: PointerSelectAction | ((a: Annotation) => PointerSelectAction) = PointerSelectAction.EDIT
-) => {
-  const { subscribe, set } = writable<Selection>(EMPTY);
-
-  let currentSelection: Selection = EMPTY;
-
-  subscribe(updated => currentSelection = updated);
-
-  const clear = () => set(EMPTY);
-
-  const isEmpty = () => currentSelection.selected?.length === 0;
-
-  const isSelected = (annotationOrId: T | string) => {
-    if (currentSelection.selected.length === 0)
-      return false;
-
-    const id = typeof annotationOrId === 'string' ? annotationOrId : annotationOrId.id;
-    return currentSelection.selected.some(i => i.id === id);
-  }
-
-  // TODO enable CTRL select
-  const clickSelect = (id: string, pointerEvent: PointerEvent) => {
-    const annotation = store.getAnnotation(id);
-    if (annotation) {
-      const action = onPointerSelect(annotation, selectAction);
-      if (action === PointerSelectAction.EDIT)
-        set({ selected: [{ id, editable: true }], pointerEvent }); 
-      else if (action === PointerSelectAction.SELECT)
-        set({ selected: [{ id }], pointerEvent }); 
-      else
-        set({ selected: [], pointerEvent });
-    } else {
-      console.warn('Invalid selection: ' + id);
-    }
-  }
-
-  const setSelected = (idOrIds: string | string[], editable: boolean = true) => {
-    const ids = Array.isArray(idOrIds) ? idOrIds : [idOrIds];
-
-    // Remove invalid
-    const annotations = 
-      ids.map(id => store.getAnnotation(id)).filter(a => a); 
-
-    set({ selected: annotations.map(({ id }) => ({ id, editable })) });
-    
-    if (annotations.length !== ids.length)
-      console.warn('Invalid selection', idOrIds);
-  }
-
-  const removeFromSelection = (ids: string[]) => {
-    if (currentSelection.selected.length === 0)
-      return false;
-
-    const { selected } = currentSelection;
-
-    // Checks which of the given annotations are actually in the selection
-    const toRemove = selected.filter(({ id  }) => ids.includes(id))
-
-    if (toRemove.length > 0)
-      set({ selected: selected.filter(({ id }) => !ids.includes(id)) });
-  }
-
-  // Track store delete and update events
-  store.observe(({ changes }) =>
-    removeFromSelection(changes.deleted.map(a => a.id)));
-
-  return { 
-    clear, 
-    clickSelect, 
-    get selected() { return currentSelection ? [...currentSelection.selected ] : null},
-    get pointerEvent() { return currentSelection ? currentSelection.pointerEvent : null },
-    isEmpty, 
-    isSelected, 
-    setSelected, 
-    subscribe 
-  };
-
-}
-
-export const onPointerSelect = (
-  annotation: Annotation, 
-  action?: PointerSelectAction | ((a: Annotation) => PointerSelectAction)
-): PointerSelectAction => (typeof action === 'function') ?
-    (action(annotation) || PointerSelectAction.EDIT) : 
-    (action || PointerSelectAction.EDIT);