Merge code supporting 3D content in IIIF manifests into manifesto

.gitignore

@@ -6,4 +6,4 @@ coverage
 npm-debug.log
 node_modules
 debug.log
-types
+types

.npmignore

@@ -2,4 +2,4 @@
 **/tsconfig.json
 **/webpack.config.js
 node_modules
-src
+src

README.md

@@ -1,10 +1,12 @@
+README.md is a mess, need to start from manifesto's and re-do!
+
 # manifesto
 
 [![Build Status](https://github.com/IIIF-Commons/manifesto/actions/workflows/build-test.yml/badge.svg?branch=main)](https://github.com/IIIF-Commons/manifesto/actions/workflows/build-test.yml)
 
-IIIF Presentation API client and server utility library.
+Forked from [IIIF-Commons/manifesto](https://github.com/IIIF-Commons/manifesto).
 
-    npm install manifesto.js --save
+Goal of implementing the [Draft API](https://github.com/IIIF/3d/blob/main/temp-draft-4.md) under development by the [IIIF 3D Technical Study Group](https://github.com/IIIF/3d/).
 
 > [!NOTE]
 > 3D extensions to the manifesto.js library are under development in a fork [IIIF-Commons/manifesto-3d](https://github.com/IIIF-Commons/manifesto-3d).
@@ -15,21 +17,61 @@ IIIF Presentation API client and server utility library.
 
 ### Documentation
 
-https://iiif-commons.github.io/manifesto/
+[Manifesto-3D.js](https://iiif-commons.github.io/manifesto-3d/)
+
+### Loading through package manager
+
+    npm install manifesto-3d.js --save
+
+### Demonstration Projects
+[Example manifests](https://github.com/IIIF/3d/tree/main/manifests) conforming to the [Draft API](https://github.com/IIIF/3d/blob/main/temp-draft-4.md) .
+
+[Prototype Viewers](https://github.com/IIIF/3d/issues/28) rendering the example manifests.
+- [Three-JS based viewer](https://codesandbox.io/p/github/JulieWinchester/iiif-threejs-demo)
+- [X3D/X3DOM based viewer](https://codesandbox.io/p/github/vincentmarchetti/iiif-x3dom-demo/main)
+- [Smithsonian Voyager](https://codesandbox.io/p/sandbox/voyager-annotations-demo-forked-l83l6w)
+
+### ChangeLog
+
+From start point of the version distributed  from  [JulieWinchester/manifesto](https://github.com/JulieWinchester/manifesto/tree/3dtsg-dev-dist)
+
+#### To package.json version 4.3.0-draft3dapi.0.1.0  
+distributed from [vincentmarchetti/manifesto#3dtsg-main]() there were these changes:
+
+1. This test is no longer useful for the Target of an Annotation:
+
+        if ( typeof(target) === "string" ){
+            // handle case where target is a Scene
+        }
+
+    Draft manifest [ 3_lights/direction_light_transform ]( https://github.com/IIIF/3d/blob/main/manifests/3_lights/direction_light_transform_rotate.json ) uses two ways of encoding the value of a target property for an Annotation: with a json string value of the IRI, or with an object with `id` property of the IRI for the  Scene. To avoid exponential expansion of if-else code when combined with target property which can also  be `SpecificResource` resources, the parsing code was changed so tha the value returned from `getTarget()` is always an object.
+
+    Since the Target property will always be an object referencing a `Scene`, or a `SpecificResource` whose `source` property is a `Scene`, the code for handling either would be
+
+        if (target.isSpecificResource){
+            // handle a SpecificResource, with  selector property
+            // and whose source property is the Scene
+        }
+        else{
+            // handle a Scene directly
+        }
+
+2. Annotation.getBody3D() is deprecated.
+
+    The `Annotation.getBody()` from the Presentation 3 code has been extended to support the resources that can be included in a 3d Annotation body property. An important difference is that the `getBody()` function  returns an array of objects, while the `getBody3D()` returns a single object. The deprecated function `getBody3D()` should be replaced with `getBody()[0]`
+
+#### To package.json version 4.3.0-draft3dapi.0.2.0
+
+1. Fixed a bug that occurred in determining the 'source' property of a SpecificResource resource that is the "target" property of an Annotation. This bug escaped detection previously because in the 3D case this 'source' property has always been a Scene resource, and the value is not needed for visualization. 
+
+#### To package.json version 4.3.0-draft3dapi.0.3.0
+
+1. Added isSpecificResource and isAnnotationBody properties to the SpecificResource and AnnotationBody classes, in response to developer suggestion. (Slack, Apr 24 2024)
 
-### Developer Setup
+#### To package.json version 4.3.0-draft3dapi.0.4.0
 
-    git clone https://github.com/iiif-commons/manifesto.git
-    npm install
-    npm build
-    npm test
+1. Implemented Perspective Camera properties in the Camera class.
 
-### Publishing Package
+#### To package.json version 4.3.0-draft3dapi.0.5.0
 
-    git checkout main
-    npm version patch
-    npm run docs
-    git add .
-    git commit -m "Release v1.2.3"
-    git tag v1.2.3
-    git push origin main v1.2.3
+1. Implement lookAt property of Camera class and of Light class.

RELEASE.md

@@ -0,0 +1,9 @@
+# Release
+
+To create a new release on NPM you need to create a [release](https://docs.github.com/en/repositories/releasing-projects-on-github/managing-releases-in-a-repository#creating-a-release) on Github and the [release.yml](.github/workflows/release.yml) action will then deploy a release on NPM. 
+
+This requires NPM_TOKEN to be setup as a repository secret. This will update the package at:
+
+https://www.npmjs.com/package/@iiif/3d-manifesto-dev
+
+To update the version number in NPM you will also need to update the version number in [package.json](package.json).

docs/assets/highlight.css

@@ -1,16 +1,20 @@
 :root {
-    --light-hl-0: #000000;
-    --dark-hl-0: #D4D4D4;
-    --light-hl-1: #098658;
-    --dark-hl-1: #B5CEA8;
-    --light-hl-2: #795E26;
-    --dark-hl-2: #DCDCAA;
-    --light-hl-3: #001080;
-    --dark-hl-3: #9CDCFE;
-    --light-hl-4: #0000FF;
-    --dark-hl-4: #569CD6;
-    --light-hl-5: #A31515;
-    --dark-hl-5: #CE9178;
+    --light-hl-0: #0000FF;
+    --dark-hl-0: #569CD6;
+    --light-hl-1: #000000;
+    --dark-hl-1: #D4D4D4;
+    --light-hl-2: #001080;
+    --dark-hl-2: #9CDCFE;
+    --light-hl-3: #795E26;
+    --dark-hl-3: #DCDCAA;
+    --light-hl-4: #008000;
+    --dark-hl-4: #6A9955;
+    --light-hl-5: #098658;
+    --dark-hl-5: #B5CEA8;
+    --light-hl-6: #267F99;
+    --dark-hl-6: #4EC9B0;
+    --light-hl-7: #A31515;
+    --dark-hl-7: #CE9178;
     --light-code-background: #FFFFFF;
     --dark-code-background: #1E1E1E;
 }
@@ -22,6 +26,8 @@
     --hl-3: var(--light-hl-3);
     --hl-4: var(--light-hl-4);
     --hl-5: var(--light-hl-5);
+    --hl-6: var(--light-hl-6);
+    --hl-7: var(--light-hl-7);
     --code-background: var(--light-code-background);
 } }
 
@@ -32,6 +38,8 @@
     --hl-3: var(--dark-hl-3);
     --hl-4: var(--dark-hl-4);
     --hl-5: var(--dark-hl-5);
+    --hl-6: var(--dark-hl-6);
+    --hl-7: var(--dark-hl-7);
     --code-background: var(--dark-code-background);
 } }
 
@@ -42,6 +50,8 @@
     --hl-3: var(--light-hl-3);
     --hl-4: var(--light-hl-4);
     --hl-5: var(--light-hl-5);
+    --hl-6: var(--light-hl-6);
+    --hl-7: var(--light-hl-7);
     --code-background: var(--light-code-background);
 }
 
@@ -52,6 +62,8 @@
     --hl-3: var(--dark-hl-3);
     --hl-4: var(--dark-hl-4);
     --hl-5: var(--dark-hl-5);
+    --hl-6: var(--dark-hl-6);
+    --hl-7: var(--dark-hl-7);
     --code-background: var(--dark-code-background);
 }
 
@@ -61,4 +73,6 @@
 .hl-3 { color: var(--hl-3); }
 .hl-4 { color: var(--hl-4); }
 .hl-5 { color: var(--hl-5); }
+.hl-6 { color: var(--hl-6); }
+.hl-7 { color: var(--hl-7); }
 pre, code { background: var(--code-background); }