Merge branch 'chat-proof' of https://github.com/SolidOS/solid-ui into chat-proof

Author: SharonStrats

dist/solid-ui.js

@@ -82,7 +82,7 @@ export async function getPrivateKey (webId: NamedNode) {
   return privateKey as string
 }
 
-const deleteKey = async (keyDoc: string) => {
+const deleteKeyAcl = async (keyDoc: string) => {
   await store.fetcher.load(keyDoc)
 
   const keyAclDoc = store.any(store.sym(keyDoc), store.sym('http://www.iana.org/assignments/link-relations/acl'))
@@ -120,7 +120,7 @@ async function saveKey (keyDoc: string, del, add, me: string = '') {
       }
     }
   */
-  await deleteKey(keyDoc)
+  await deleteKeyAcl(keyDoc)
   // save key
   await store.updater.updateMany(del, add) // or a promise store.updater.update ?
 

dist/solid-ui.js.map

@@ -25,12 +25,12 @@ export const getPodRoot = async (webId: NamedNode) => {
     podRoot = storages.find((storage) => webIdURL.origin === new URL(storage.value).origin) as NamedNode
     if (!podRoot) podRoot = storages[0] as NamedNode
   }
-  return podRoot?.value
+  return podRoot as NamedNode
 }
 
 export const pubKeyUrl = async (webId: NamedNode) => {
   try {
-    return await getPodRoot(webId) + 'profile/keys/publicKey.ttl'
+    return (await getPodRoot(webId)).value + 'profile/keys/publicKey.ttl'
   } catch (err) { throw new Error(err) }
 }
 
@@ -40,8 +40,12 @@ export async function getExistingPublicKey (webId: NamedNode, publicKeyUrl: stri
 }
 
 export const privKeyUrl = async (webId: NamedNode) => {
+  let settings = store.any(webId, ns.space('preferencesFile'), null, webId.doc())?.value
+  settings = settings?.split('/').slice(0, -1).join('/')
   try {
-    return await getPodRoot(webId) + 'profile/keys/privateKey.ttl'
+    const podRoot = await getPodRoot(webId)
+    if (!settings?.startsWith(podRoot.value)) throw new Error(`/settings/ is expected to be in ${podRoot.value}`)
+    return `${settings}/keys/privateKey.ttl`
   } catch (err) { throw new Error(err) }
 }
 

dist/solid-ui.min.js

@@ -1,7 +1,7 @@
 # Solid-UI Unit Testing
 The purpose of this README is to provide guidance on how to write tests for solid-ui for beginners.
 
-Although we would love to have 100% test coverage, we realize that this is not a commericial product. solid-ui is an open source, volunteer built library that houses UI components that can be used to build Solid applications. We are working to increase test coverage on existing code, any help is much appreciated. If you add a new component to solid-ui, you should write tests to test the main functionality of your component in order for your PR to be merged.
+Although we would love to have 100% test coverage, we realize that this is not a commericial product. `solid-ui` is an open source, volunteer built library that houses UI components that can be used to build Solid applications. We are working to increase test coverage on existing code, and any help is much appreciated. If you add a new component to `solid-ui`, you should write tests to test the main functionality of your component before your PR will be merged.
 
 ## Running Tests
 
@@ -10,30 +10,35 @@ The following command will run all the tests.
 `npm run test`
 
 ### One file at a time
-There are a lot of tests in `solid-ui` so you will most likely want to run only the test you are working on at the moment. In order to do that you can use the following command.
+There are a lot of tests in `solid-ui`, so you will most likely want to run only the test you are working on at the moment. You can use commands like the following to do that:
 `npm test <filetobetested>`
 `npm test test/unit/utils/keyHelpers/accessData.test.ts`
 
 ### Coverage
 Run the following command:
 `npm run coverage`
 
-Then you can see the results in `coverage/lcov-report/index.html`. If you are using VSCode you can right click and select to `Open in Browser Preview`. Otherwise, you can type the path in your browswer, for instance `file:///Users/<yourhomedirectory>/2023Development/solid-ui/coverage/lcov-report/index.html` is an example.
+The results will be found in `coverage/lcov-report/index.html`. If you are using VSCode, you can right click and select `Open in Browser Preview`. Alternatively, you can type the path in your browser; for instance, the following:
+```
+file:///Users/<yourhomedirectory>/2023Development/solid-ui/coverage/lcov-report/index.html
+```
 
 ## Tips and Tricks
-The following are some tips and tricks in hopes to make testing easier.
+The following are some tips and tricks to make your testing easier.
 
 ### VSCode Debugging
-There is an extension that can be used to aide in debugging jest tests. To find out more about it you can look at [Jest Runner](https://marketplace.visualstudio.com/items?itemName=firsttris.vscode-jest-runner)
+There is an extension that can be used to aide in debugging `jest` tests. To find out more about it, you can look at [Jest Runner](https://marketplace.visualstudio.com/items?itemName=firsttris.vscode-jest-runner).
 
 ### Mocking
-In solid-ui we do not currently follow a MVC pattern therefore there can be some difficulty in testing. The following are patterns to help with this.
+In `solid-ui`, we do not currently follow a MVC pattern, so testing is not always easy. The following are patterns to help with this.
 #### Store methods
 ##### Load
-In SolidOS we use [rdflib.js](https://github.com/linkeddata/rdflib.js/) to work with LinkedData. The way this works is that you first load the document you need to work with into the store. Once the document is loaded you can then access the data by using additional methods on the store such as `any, each,...`. Since the data that gets returned will need to be mocked, `load` doesn't need to do anything. See below for what you need to put in the top of your file in order to mock the `load` method.  
-`import { store } from 'solid-logic'` at the top of your file.
-
-`store.fetcher.load = jest.fn().mockImplementation(() => {})`
+In SolidOS, we use [`rdflib.js`](https://github.com/linkeddata/rdflib.js/) to work with LinkedData. First, you load the document you need to work with into the store. Once the document is loaded, you can access the data by using additional methods on the store such as `any`, `each`, etc. Since the data that gets returned will need to be mocked, `load` doesn't need to do anything. You need to put the following into your file to mock the `load` method:
+```
+import { store } from 'solid-logic'      /* at the top of your file */
+...
+store.fetcher.load = jest.fn().mockImplementation(() => {})
+```
 
 ##### Any
 

dist/solid-ui.min.js.map

@@ -38,7 +38,7 @@ describe('cryptoKeyHelpers', () => {
   describe.skip('privKeyUrl', () => {
     it('returns...', () => {
       const result = privKeyUrl(new NamedNode('https://alice.solid.example/profile/card#me'))
-      expect(result).toEqual('https://alice.solid.example/profile/keys/privateKey.ttl')
+      expect(result).toEqual('https://alice.solid.example/settings/keys/privateKey.ttl')
     })
   })
 
@@ -50,7 +50,7 @@ describe('cryptoKeyHelpers', () => {
     it('returns...', async () => {
       const webId = new NamedNode('https://alice.solid.example/profile/card#me')
       const result = await getPodRoot(webId)
-      expect(result).toBe('https://alice.solid.example')
+      expect(result.value).toBe('https://alice.solid.example')
     })
   })
   describe('getKeyIfExists', () => {