Class CommitBuilder

lib/src/commit.ts:30–77

/** A {@link Commit} without its signature, signer and timestamp */
export class CommitBuilder implements CommitBuilderI {
  subject: string;
  set: Record<string, JSONValue>;
  remove: string[];
  destroy?: boolean;

  /** Removes any query parameters from the Subject */
  constructor(subject: string) {
    this.subject = removeQueryParamsFromURL(subject);
    this.set = {};
    this.remove = [];
  }

  /**
   * Signs the commit using the privateKey of the Agent, and returns a full
   * Commit which is ready to be sent to an Atomic-Server `/commit` endpoint.
   */
  async sign(privateKey: string, agentSubject: string): Promise<Commit> {
    const commit = await signAt(
      this.clone(),
      agentSubject,
      privateKey,
      getTimestampNow(),
    );
    return commit;
  }

  /** Returns true if the CommitBuilder has non-empty changes (set, remove, destroy) */
  hasUnsavedChanges(): boolean {
    return (
      Object.keys(this.set).length > 0 || this.destroy || this.remove.length > 0
    );
  }

  /**
   * Creates a clone of the CommitBuilder. This is required, because I want to
   * prevent any adjustments to the CommitBuilder while signing, as this could
   * cause race conditions with wrong signatures
   */
  // Warning: I'm not sure whether this actually solves the issue. Might be a good idea to remove this.
  clone(): CommitBuilder {
    const cm = new CommitBuilder(this.subject);
    cm.set = this.set;
    cm.destroy = this.destroy;
    cm.remove = this.remove;
    return cm;
  }
}

/** A {@link Commit} without its signature, but with a signer and timestamp */
interface CommitPreSigned extends CommitBuilderI {