Did migration, move routing to query param

Author: joepio

Cargo.lock

@@ -37,11 +37,6 @@ export function SubjectField({
   // as plain read-only text.
   const isDID = value.startsWith('did:') || value.startsWith('_');
 
-  const [origin, path] =
-    isDID || readOnly ? ['unknown', 'subject'] : getPath(value);
-
-  const [inputValue, setInputValue] = useState(path);
-
   if (isDID || readOnly) {
     return (
       <Field
@@ -56,6 +51,9 @@ export function SubjectField({
     );
   }
 
+  const [origin, path] = getPath(value);
+  const [inputValue, setInputValue] = useState(path);
+
   const handleChange = (v: string) => {
     const subject = new URL(normalizePath(v), value);
     setInputValue(subject.pathname.slice(1));

browser/data-browser/src/components/forms/NewForm/SubjectField.tsx

@@ -1,4 +1,4 @@
-import { Agent, SubtleCryptoProvider } from '@tomic/react';
+import { Agent, SubtleCryptoProvider, JSCryptoProvider } from '@tomic/react';
 import { del, get, set } from 'idb-keyval';
 
 const AGENT_IDB_KEY = 'atomic.agent';

browser/data-browser/src/helpers/agentStorage.ts

@@ -90,27 +90,22 @@ function InvitePage({ resource }: ResourcePageProps): JSX.Element {
     name?: string,
   ) => {
     const resourceToSave = store.getResourceLoading(subject);
-
     try {
       if (name?.trim()) {
         await resourceToSave.set(core.properties.name, name);
       }
-
       const currentIsA =
         (await resourceToSave.get(core.properties.isA)) ?? ([] as string[]);
-
       if (!currentIsA.includes(core.classes.agent)) {
         await resourceToSave.set(core.properties.isA, [
           ...currentIsA,
           core.classes.agent,
         ]);
       }
-
       if (destination) {
         try {
           const target = await store.fetchResourceFromServer(destination);
           const driveSubject = await getResourcesDrive(target, store);
-
           if (driveSubject) {
             resourceToSave.push(server.properties.drives, [driveSubject]);
           }
@@ -120,7 +115,6 @@ function InvitePage({ resource }: ResourcePageProps): JSX.Element {
           );
         }
       }
-
       await resourceToSave.save();
     } catch (e) {
       store.notifyError(
@@ -133,13 +127,10 @@ function InvitePage({ resource }: ResourcePageProps): JSX.Element {
     onSuccess: async () => {
       setAgentSecret(undefined);
       const agentSubject = agent?.subject;
-
       if (!agentSubject) {
         goToRedirect();
-
         return;
       }
-
       goToRedirect();
       void persistAgentAfterInvite(agentSubject, redirectURL, agentName);
     },
@@ -194,15 +185,13 @@ function InvitePage({ resource }: ResourcePageProps): JSX.Element {
 
     if (redirect.error) {
       store.notifyError(redirect.error);
-
       return;
     }
 
     const destination = await getRedirectDestination(redirect);
 
     if (!destination) {
       store.notifyError(new Error('Invite accepted, but no destination was returned.'));
-
       return;
     }
 
@@ -229,7 +218,6 @@ function InvitePage({ resource }: ResourcePageProps): JSX.Element {
       setRedirectURL(destination);
       goToRedirect(destination);
       void persistAgentAfterInvite(agentSubject!, destination, undefined);
-
       return;
     }
 

browser/data-browser/src/views/InvitePage.tsx

@@ -64,7 +64,8 @@ export class Agent implements AgentInterface {
           // Fallback to JS crypto if SubtleCrypto doesn't support Ed25519
           // (e.g. in some headless browser environments)
           try {
-            const [provider, subject] = JSCryptoProvider.fromSecret(secretB64);
+            const [provider, subject] =
+              JSCryptoProvider.fromSecret(secretB64);
             resolve(new Agent(provider, subject));
           } catch (e) {
             reject(e);

browser/lib/src/agent.ts

@@ -117,7 +117,7 @@ export class Resource<C extends OptionalClass = any> {
 
       throw new Error(
         'Invalid subject given to resource, must be a string, found ' +
-          typeof subject,
+        typeof subject,
       );
     }
 
@@ -225,11 +225,6 @@ export class Resource<C extends OptionalClass = any> {
     });
   }
 
-  /** Returns `true` when there are locally-signed commits waiting to be pushed. */
-  public get hasPendingCommits(): boolean {
-    return this._pendingCommits.length > 0;
-  }
-
   private get store(): Store {
     if (!this._store) {
       console.error(`Resource ${this.subject} has no store`);
@@ -552,10 +547,9 @@ export class Resource<C extends OptionalClass = any> {
   public getCommitsCollectionSubject(): string {
     // For DID subjects (or other non-HTTP URIs) we can't derive the server
     // origin from the subject itself — use the store's server URL instead.
-    const base =
-      this.subject.startsWith('did:') || this.subject.startsWith('_')
-        ? this.store.getServerUrl()
-        : this.subject;
+    const base = this.subject.startsWith('did:') || this.subject.startsWith('_')
+      ? this.store.getServerUrl()
+      : this.subject;
     const url = new URL('/commits', base);
     url.searchParams.append('property', commits.properties.subject);
     url.searchParams.append('value', this.subject);
@@ -605,8 +599,9 @@ export class Resource<C extends OptionalClass = any> {
     const commitsCollection = await this.store.fetchResourceFromServer(
       this.getCommitsCollectionSubject(),
     );
-    const commitList = (commitsCollection.get(collections.properties.members) ??
-      []) as string[];
+    const commitList = (commitsCollection.get(
+      collections.properties.members,
+    ) ?? []) as string[];
 
     const builtVersions: Version[] = [];
 
@@ -883,6 +878,11 @@ export class Resource<C extends OptionalClass = any> {
     return commit;
   }
 
+  /** Returns `true` when there are locally-signed commits waiting to be pushed. */
+  public get hasPendingCommits(): boolean {
+    return this._pendingCommits.length > 0;
+  }
+
   /**
    * Push all locally-queued commits to the server, in order.
    *
@@ -895,9 +895,7 @@ export class Resource<C extends OptionalClass = any> {
     }
 
     const endpoint = this.getCommitEndpoint();
-    const wasNew =
-      this._pendingCommits.length > 0 &&
-      this._pendingCommits[0].previousCommit === undefined;
+    const wasNew = this._pendingCommits.length > 0 && this._pendingCommits[0].previousCommit === undefined;
 
     let lastCommitId: string | undefined;
 
@@ -937,6 +935,19 @@ export class Resource<C extends OptionalClass = any> {
     }
   }
 
+  /** Resolves the `/commit` endpoint for this resource. */
+  private getCommitEndpoint(): string {
+    if (this.subject.startsWith('did:')) {
+      return new URL('/commit', this.store.getServerUrl()).toString();
+    }
+
+    try {
+      return new URL(this.subject).origin + `/commit`;
+    } catch {
+      return new URL('/commit', this.store.getServerUrl()).toString();
+    }
+  }
+
   /**
    * Commits the changes and sends the Commit to the resource's `/commit`
    * endpoint. Returns the Url of the created Commit. If you don't pass an Agent
@@ -989,9 +1000,7 @@ export class Resource<C extends OptionalClass = any> {
     });
 
     // Keep a backup of the commit builder in case push fails.
-    const oldCommitBuilder = hasChanges
-      ? this.commitBuilder.clone()
-      : undefined;
+    const oldCommitBuilder = hasChanges ? this.commitBuilder.clone() : undefined;
     const wasNew = this.new;
 
     try {
@@ -1141,19 +1150,6 @@ export class Resource<C extends OptionalClass = any> {
     });
   }
 
-  /** Resolves the `/commit` endpoint for this resource. */
-  private getCommitEndpoint(): string {
-    if (this.subject.startsWith('did:')) {
-      return new URL('/commit', this.store.getServerUrl()).toString();
-    }
-
-    try {
-      return new URL(this.subject).origin + `/commit`;
-    } catch {
-      return new URL('/commit', this.store.getServerUrl()).toString();
-    }
-  }
-
   private isParentNew() {
     const parentSubject = this.propvals.get(core.properties.parent) as string;
 

browser/lib/src/resource.ts

@@ -294,7 +294,7 @@ export class Store {
         !storeResource.loading &&
         !storeResource.new &&
         storeResource.get(commits.properties.lastCommit) ===
-          resource.get(commits.properties.lastCommit)
+        resource.get(commits.properties.lastCommit)
       ) {
         return;
       }
@@ -431,6 +431,11 @@ export class Store {
     return this.findAvailableSubject(path, parentUrl);
   }
 
+  /** Creates a random HTTP subject under the given parent URL. */
+  private createHTTPSubject(parentSubject: string): string {
+    return `${parentSubject}/${this.randomPart()}`;
+  }
+
   /**
    * Always fetches the resource from the server then adds it to the store.
    */
@@ -465,14 +470,12 @@ export class Store {
 
       if (existing) {
         existing.loading = false;
-
         return existing as Resource<C>;
       }
 
       const local = new Resource<C>(normalizedSubject, true);
       local.loading = false;
       this.addResources(local, { skipCommitCompare: true });
-
       return local;
     }
 
@@ -506,13 +509,15 @@ export class Store {
         ? { agent: this.agent, serverURL: this.getServerUrl() }
         : undefined;
 
-      const { resource, createdResources } =
-        await this.client.fetchResourceHTTP(fetchSubject, {
+      const { resource, createdResources } = await this.client.fetchResourceHTTP(
+        fetchSubject,
+        {
           from: opts.fromProxy ? this.getServerUrl() : undefined,
           method: opts.method,
           body: opts.body,
           signInfo,
-        });
+        },
+      );
 
       // The client already returns the requested top-level resource as `resource`.
       this.addResources(resource, {
@@ -524,10 +529,7 @@ export class Store {
 
       // Any other resources that were returned (e.g. linked resources)
       createdResources.forEach(r => {
-        if (
-          this.normalizeSubject(r.subject) !==
-          this.normalizeSubject(resource.subject)
-        ) {
+        if (this.normalizeSubject(r.subject) !== this.normalizeSubject(resource.subject)) {
           this.addResources(r);
         }
       });
@@ -617,10 +619,7 @@ export class Store {
     let resource = this.resources.get(resolved);
 
     if (!resource) {
-      resource = new Resource<C>(
-        normalized,
-        opts.newResource || isTemporarySubject,
-      );
+      resource = new Resource<C>(normalized, opts.newResource || isTemporarySubject);
 
       // New resources don't have to load, they are just created.
       if (!opts.newResource && !isTemporarySubject) {
@@ -1312,11 +1311,6 @@ export class Store {
     await loadResourceTreeInner(resource, treeTemplate);
   }
 
-  /** Creates a random HTTP subject under the given parent URL. */
-  private createHTTPSubject(parentSubject: string): string {
-    return `${parentSubject}/${this.randomPart()}`;
-  }
-
   private randomPart(): string {
     return ulid().toLowerCase();
   }

browser/lib/src/store.ts

@@ -71,6 +71,7 @@
 
 - [Atomic Data Extended](extended.md)
   - [Agents](agents.md)
+  - [Decentralized Identifiers (DIDs)](did.md)
   - [Hierarchy and authorization](hierarchy.md)
   - [Authentication](authentication.md)
   - [Invitations and sharing](invitations.md)

docs/src/SUMMARY.md

@@ -29,9 +29,10 @@ The `publicKey` is used to verify commit signatures by that Agent, to check if t
 
 ## Creating an Agent
 
-An Agent is identified by a DID (Decentralized Identifier) derived from its public key: `did:ad:{publicKey}`.
+An Agent is identified by a DID (Decentralized Identifier) derived from its public key: `did:ad:agent:{publicKey}`.
 When a client generates a keypair, the public key immediately determines the Agent's subject, without needing to register it on a server first.
+See the [DID specification](did.md) for details on how agent DIDs work and are resolved.
 
 One way to start using your Agent is by accepting an [Invite](invitations.md) with your public key.
-The server will derive the `did:ad:` identifier and grant the requested rights.
+The server will derive the `did:ad:agent:` identifier and grant the requested rights.
 Alternatively, you can host an [Atomic Server](https://crates.io/crates/atomic-server) and use the `/setup` invite to configure the root Agent.