Implement Solid stores

packages/nde-erfgoed-client/lib/index.ts

@@ -1,2 +1,2 @@
-export { login, handleIncomingRedirect, logout } from '@inrupt/solid-client-authn-browser';
-export { getSolidDataset, getThing, getStringNoLocale, getUrl } from '@inrupt/solid-client';
+export { login, handleIncomingRedirect, logout, fetch, getDefaultSession } from '@inrupt/solid-client-authn-browser';
+export { getSolidDataset, getThing, getStringNoLocale, getStringNoLocaleAll, getUrl, getStringByLocaleAll, getStringWithLocale, getStringWithLocaleAll, getThingAll, getUrlAll, removeAll, removeThing, saveSolidDatasetAt, setThing, removeUrl, Thing, addStringWithLocale, addStringNoLocale, addUrl, addDatetime, getDatetime, createThing, asUrl, overwriteFile, deleteFile, ThingPersisted } from '@inrupt/solid-client';

packages/nde-erfgoed-components/lib/collections/object-card.component.ts

@@ -52,11 +52,11 @@ export class ObjectCardComponent extends LitElement {
       <nde-card>
         ${this.object.image && this.object.image !== 'undefined' ? html`<img slot="image" src="${this.object.image}" alt="card image"/>` : html`<div slot="image">${unsafeSVG(Picture)}</div>`}
         <span slot='title'>
-          ${this.object.name ?? this.translator.translate('nde.features.collections.card.name-unavailable')}
+          ${this.object.name ?? this.translator?.translate('nde.features.collections.card.name-unavailable')}
         </span>
         <span slot='subtitle'>
           <span class='subject'>
-            ${this.object.subject ?? this.translator.translate('nde.features.collections.card.subject-unavailable')}
+            ${this.object.subject ?? this.translator?.translate('nde.features.collections.card.subject-unavailable')}
           </span>
           <span class='time-ago'>
              ${this.object.updated ? ` - ${timeAgo}` : ''}

packages/nde-erfgoed-components/lib/demo/demo-form.component.ts

@@ -62,7 +62,7 @@ export class DemoFormComponent extends RxLitElement {
    * The actor controlling this component.
    */
   @property({ type: Object })
-  public actor: Interpreter<FormContext<Collection>>;
+  public actor: Interpreter<FormContext<Partial<Collection>>>;
 
   /**
    * Enables or disables the submit button.
@@ -79,7 +79,7 @@ export class DemoFormComponent extends RxLitElement {
     super();
 
     this.actor = interpret(
-      formMachine<Collection>(validator, submitter).withContext({
+      formMachine<Partial<Collection>>(validator, submitter).withContext({
         data: { uri: '', name: 'Test', description: 'Test desc' },
         original: { uri: '', name: 'Test', description: 'Test desc' },
       }),

packages/nde-erfgoed-components/lib/sidebar/sidebar-list-item.component.ts

@@ -82,7 +82,6 @@ export class SidebarListItemComponent extends RxLitElement {
       }
 
       .actions {
-        margin-right: var(--gap-small);
         display: flex;
         flex-direction: row;
         gap: var(--gap-normal);

packages/nde-erfgoed-core/lib/collections/collection-object-memory-store.spec.ts

@@ -1,4 +1,5 @@
 import { ArgumentError } from '../errors/argument-error';
+import { Collection } from './collection';
 import { CollectionObject } from './collection-object';
 import { CollectionObjectMemoryStore } from './collection-object-memory-store';
 
@@ -8,7 +9,8 @@ describe('CollectionObjectMemoryStore', () => {
     uri: 'collection-uri-1',
     name: 'Collection 1',
     description: 'This is collection 1',
-  };
+    objectsUri: 'objects-uri',
+  } as Collection;
 
   const resources: CollectionObject[] = [
     {
@@ -109,4 +111,20 @@ describe('CollectionObjectMemoryStore', () => {
 
   });
 
+  describe('getObject()', () => {
+
+    it('should throw error when collection is undefined', async () => {
+
+      await expect(service.getObject(undefined)).rejects.toThrow(ArgumentError);
+
+    });
+
+    it('should return object with matching uri', async () => {
+
+      await expect(service.getObject(resources[0].uri)).resolves.toEqual(resources[0]);
+
+    });
+
+  });
+
 });

packages/nde-erfgoed-core/lib/collections/collection-object-memory-store.ts

@@ -17,6 +17,23 @@ export class CollectionObjectMemoryStore extends MemoryStore<CollectionObject> i
 
   }
 
+  /**
+   * Retrieves a single CollectionObject
+   *
+   * @param uri The URI of the CollectionObject
+   */
+  async getObject(uri: string): Promise<CollectionObject> {
+
+    if (!uri) {
+
+      throw new ArgumentError('Argument uri should be set.', uri);
+
+    }
+
+    return this.resources.find((resource) => resource.uri === uri);
+
+  }
+
   /**
    * Retrieves all objects for a specific collection.
    *

packages/nde-erfgoed-core/lib/collections/collection-object-store.ts

@@ -12,4 +12,11 @@ export interface CollectionObjectStore extends Store<CollectionObject> {
    * @param collection The collection for which to retrieve objects.
    */
   getObjectsForCollection(collection: Collection): Promise<CollectionObject[]>;
+
+  /**
+   * Retrieves a single CollectionObject
+   *
+   * @param uri The URI of the CollectionObject
+   */
+  getObject(uri: string): Promise<CollectionObject>;
 }

packages/nde-erfgoed-core/lib/collections/collection-store.ts

@@ -0,0 +1,15 @@
+import { Store } from '../stores/store';
+import { Collection } from './collection';
+
+/**
+ * A store for collections.
+ */
+export interface CollectionStore extends Store<Collection> {
+
+  /**
+   * Retrieves a single collection
+   *
+   * @param uri The URI of the collection.
+   */
+  getCollection(uri: string): Promise<Collection>;
+}

packages/nde-erfgoed-core/lib/collections/collection.ts

@@ -13,4 +13,14 @@ export interface Collection extends Resource {
    * The description of the collection.
    */
   description: string;
+
+  /**
+   * The URI of this collection's objects
+   */
+  objectsUri: string;
+
+  /**
+   * The distribution URI of this collection
+   */
+  distribution: string;
 }

packages/nde-erfgoed-core/lib/index.ts

@@ -2,6 +2,7 @@
  * Exports the modules of the package.
  */
 export * from './collections/collection';
+export * from './collections/collection-store';
 export * from './collections/collection-object';
 export * from './collections/collection-object-memory-store';
 export * from './collections/collection-object-store';

packages/nde-erfgoed-core/lib/stores/memory-store.spec.ts

@@ -8,24 +8,32 @@ describe('MemoryStore', () => {
     uri: 'collection-uri-1',
     name: 'Collection 1',
     description: 'This is collection 1',
+    objectsUri: 'objects-uri',
+    distribution: 'distribution-uri',
   };
 
   const collection2: Collection = {
     uri: 'collection-uri-2',
     name: 'Collection 2',
     description: 'This is collection 2',
+    objectsUri: 'objects-uri',
+    distribution: 'distribution-uri',
   };
 
   const collection3: Collection = {
     uri: 'collection-uri-3',
     name: 'Collection 3',
     description: 'This is collection 3',
+    objectsUri: 'objects-uri',
+    distribution: 'distribution-uri',
   };
 
   const collection2Updated: Collection = {
     uri: 'collection-uri-2',
     name: 'Collection 2',
     description: 'This is collection 2 with update',
+    objectsUri: 'objects-uri',
+    distribution: 'distribution-uri',
   };
 
   const resources: Collection[] = [ collection1, collection2 ];

packages/nde-erfgoed-manage/lib/app-root.component.spec.ts

@@ -17,6 +17,8 @@ describe('AppRootComponent', () => {
     uri: 'collection-uri-3',
     name: 'Collection 3',
     description: 'This is collection 3',
+    objectsUri: 'test-uri',
+    distribution: 'test-uri',
   };
 
   beforeEach(() => {
@@ -27,11 +29,15 @@ describe('AppRootComponent', () => {
           uri: 'collection-uri-1',
           name: 'Collection 1',
           description: 'This is collection 1',
+          objectsUri: 'test-uri',
+          distribution: 'test-uri',
         },
         {
           uri: 'collection-uri-2',
           name: 'Collection 2',
           description: 'This is collection 2',
+          objectsUri: 'test-uri',
+          distribution: 'test-uri',
         },
       ]),
       new CollectionObjectMemoryStore([

packages/nde-erfgoed-manage/lib/app-root.component.ts

@@ -1,8 +1,8 @@
 import { html, property, PropertyValues, internalProperty, unsafeCSS, css, CSSResult, TemplateResult } from 'lit-element';
 import { interpret, State } from 'xstate';
 import { from } from 'rxjs';
-import { filter, map } from 'rxjs/operators';
-import { ArgumentError, Collection, ConsoleLogger, Logger, LoggerLevel, MemoryTranslator, Translator, CollectionObjectMemoryStore, MemoryStore } from '@digita-ai/nde-erfgoed-core';
+import { map } from 'rxjs/operators';
+import { ArgumentError, Collection, ConsoleLogger, Logger, LoggerLevel, MemoryTranslator, Translator } from '@digita-ai/nde-erfgoed-core';
 import { Alert } from '@digita-ai/nde-erfgoed-components';
 import { RxLitElement } from 'rx-lit';
 import { Theme, Logout, Logo, Plus } from '@digita-ai/nde-erfgoed-theme';
@@ -11,8 +11,10 @@ import { AppActors, AppAuthenticateStates, AppContext, AppFeatureStates, appMach
 import nlNL from './i8n/nl-NL.json';
 import { AppEvents } from './app.events';
 import { SolidSDKService } from './common/solid/solid-sdk.service';
-import { CollectionEvents, SelectedCollectionEvent } from './features/collection/collection.events';
+import { CollectionEvents } from './features/collection/collection.events';
 import { SolidProfile } from './common/solid/solid-profile';
+import { CollectionSolidStore } from './common/solid/collection-solid-store';
+import { CollectionObjectSolidStore } from './common/solid/collection-object-solid-store';
 
 /**
  * The root page of the application.
@@ -51,64 +53,14 @@ export class AppRootComponent extends RxLitElement {
   actor = interpret(
     (appMachine(
       new SolidSDKService(this.logger),
-      new MemoryStore<Collection>([
-        {
-          uri: 'collection-uri-1',
-          name: 'Collection 1',
-          description: 'This is collection 1',
-        },
-        {
-          uri: 'collection-uri-2',
-          name: 'Collection 2',
-          description: 'This is collection 2',
-        },
-      ]),
-      new CollectionObjectMemoryStore([
-        {
-          uri: 'object-uri-1',
-          name: 'Object 1',
-          description: 'This is object 1',
-          image: 'https://images.unsplash.com/photo-1615390164801-cf2e70f32b53?ixid=MnwxMjA3fDB8MHxwcm9maWxlLXBhZ2V8M3x8fGVufDB8fHx8&ixlib=rb-1.2.1&w=1000&q=80',
-          subject: null,
-          type: null,
-          updated: 0,
-          collection: 'collection-uri-1',
-        },
-        {
-          uri: 'object-uri-2',
-          name: 'Object 2',
-          description: 'This is object 2',
-          image: 'https://images.unsplash.com/photo-1615390164801-cf2e70f32b53?ixid=MnwxMjA3fDB8MHxwcm9maWxlLXBhZ2V8M3x8fGVufDB8fHx8&ixlib=rb-1.2.1&w=1000&q=80',
-          subject: null,
-          type: null,
-          updated: 0,
-          collection: 'collection-uri-1',
-        },
-        {
-          uri: 'object-uri-3',
-          name: 'Object 3',
-          description: 'This is object 3',
-          image: 'https://images.unsplash.com/photo-1615390164801-cf2e70f32b53?ixid=MnwxMjA3fDB8MHxwcm9maWxlLXBhZ2V8M3x8fGVufDB8fHx8&ixlib=rb-1.2.1&w=1000&q=80',
-          subject: null,
-          type: null,
-          updated: 0,
-          collection: 'collection-uri-1',
-        },
-        {
-          uri: 'object-uri-4',
-          name: 'Object 4',
-          description: 'This is object 4',
-          image: 'https://images.unsplash.com/photo-1615390164801-cf2e70f32b53?ixid=MnwxMjA3fDB8MHxwcm9maWxlLXBhZ2V8M3x8fGVufDB8fHx8&ixlib=rb-1.2.1&w=1000&q=80',
-          subject: null,
-          type: null,
-          updated: 0,
-          collection: 'collection-uri-1',
-        },
-      ]),
+      new CollectionSolidStore(),
+      new CollectionObjectSolidStore(),
       {
         uri: null,
         name: this.translator.translate('nde.features.collections.new-collection-name'),
         description: this.translator.translate('nde.features.collections.new-collection-description'),
+        objectsUri: undefined,
+        distribution: undefined,
       },
     )).withContext({
       alerts: [],

packages/nde-erfgoed-manage/lib/app.machine.ts

@@ -1,5 +1,5 @@
 import { Alert, State } from '@digita-ai/nde-erfgoed-components';
-import { Collection, CollectionObjectStore, Store } from '@digita-ai/nde-erfgoed-core';
+import { Collection, CollectionObjectStore, CollectionStore } from '@digita-ai/nde-erfgoed-core';
 import { createMachine, forwardTo } from 'xstate';
 import { assign, log, send } from 'xstate/lib/actions';
 import { addAlert, addCollection, AppEvent, AppEvents, dismissAlert, removeSession, setCollections, setProfile, setSession } from './app.events';
@@ -94,7 +94,7 @@ export type AppStates = AppRootStates | AppFeatureStates | AppAuthenticateStates
  */
 export const appMachine = (
   solid: SolidService,
-  collectionStore: Store<Collection>,
+  collectionStore: CollectionStore,
   objectStore: CollectionObjectStore,
   template: Collection,
 ) =>
@@ -105,7 +105,7 @@ export const appMachine = (
       [CollectionEvents.SELECTED_COLLECTION]: {
         actions:
         [
-          (context, event) => forwardTo(AppActors.COLLECTION_MACHINE),
+          forwardTo(AppActors.COLLECTION_MACHINE),
           assign({ selected: (context, event) => event.collection }),
         ],
       },
@@ -146,7 +146,6 @@ export const appMachine = (
               {
                 id: AppActors.COLLECTION_MACHINE,
                 src: collectionMachine(collectionStore, objectStore),
-                autoForward: true,
                 onError: {
                   actions: send({ type: AppEvents.ERROR }),
                 },
@@ -263,7 +262,8 @@ export const appMachine = (
                     setCollections,
                     send((context, event) => ({
                       type: CollectionEvents.SELECTED_COLLECTION,
-                      collection: context.selected ? context.selected : event.data[0],
+                      collection: event.data.find((collection: Collection) =>
+                        context.selected?.uri === collection.uri) ?? event.data[0],
                     })),
                   ],
                   cond: (context, event) => event.data.length > 0,
@@ -272,6 +272,9 @@ export const appMachine = (
                   target: AppDataStates.CREATING,
                 },
               ],
+              onError: {
+                actions: send((context, event) => ({ type: AppEvents.ERROR, data: event.data })),
+              },
             },
           },
           /**
@@ -290,6 +293,11 @@ export const appMachine = (
                   send((context, event) => ({ type: CollectionEvents.SELECTED_COLLECTION, collection: event.data })),
                 ],
               },
+              onError: {
+                actions: [
+                  send((context, event) => ({ type: AppEvents.ERROR, data: event.data })),
+                ],
+              },
             },
           },
         },