@hollware/server 0.5.0 → 0.8.0

package/dist/{ceremonies-BM9G03lZ.mjs → ceremonies-D5dIEbha.mjs}

@@ -1,4 +1,4 @@
-import { a as findInvitation, c as invitationById, d as redeemInvitation, f as saveChallenge, h as userHandle, i as createUser, m as touchPasskey, o as findPasskey, p as takeChallenge, r as createSession, t as addPasskey, u as passkeysOf } from "./store-DiS8UFI2.mjs";
+import { a as findInvitation, c as invitationById, d as redeemInvitation, f as saveChallenge, h as userHandle, i as createUser, m as touchPasskey, o as findPasskey, p as takeChallenge, r as createSession, t as addPasskey, u as passkeysOf } from "./store-C2hiR0yd.mjs";
 import { HollwareError, newId } from "@hollware/core";
 import { generateAuthenticationOptions, generateRegistrationOptions, verifyAuthenticationResponse, verifyRegistrationResponse } from "@simplewebauthn/server";
 import { isoBase64URL } from "@simplewebauthn/server/helpers";

package/dist/index.d.mts

@@ -31,6 +31,8 @@ interface StoredEntry {
   readonly publishedRevision: string | null;
   /** When the entry was first published; republishing keeps it. */
   readonly publishedAt: string | null;
+  /** When a scheduled entry will be published, or `null`. */
+  readonly scheduledAt: string | null;
   readonly updatedAt: string;
 }
 /** A revision as the store holds it. */
@@ -161,6 +163,17 @@ interface StoredReview {
   readonly decidedAt: string | null;
   readonly note: string | null;
 }
+/** A comment on a review (v0.6). */
+interface StoredReviewComment {
+  readonly id: string;
+  readonly reviewId: string;
+  readonly authorId: string;
+  readonly authorName: string | null;
+  /** What the client that wrote it said about itself, or `null`. */
+  readonly authorMeta: Readonly<Record<string, unknown>> | null;
+  readonly body: string;
+  readonly createdAt: string;
+}
 /** A scheduled publication, as the cron trigger reads it. */
 interface StoredSchedule {
   readonly entryId: string;
@@ -295,6 +308,19 @@ interface ContentStore {
     readonly status: ReviewStatus;
     readonly limit: number;
   }): Promise<readonly StoredReview[]>;
+  /** Adds a comment to a review, if it is still pending. */
+  commentReview(site: string, write: {
+    readonly reviewId: string;
+    readonly actor: Actor;
+    readonly body: string;
+  }): Promise<{
+    readonly outcome: 'commented';
+    readonly comment: StoredReviewComment;
+  } | {
+    readonly outcome: 'not_pending' | 'not_found';
+  }>;
+  /** The comments of these reviews, oldest first, by review. */
+  reviewComments(site: string, reviewIds: readonly string[]): Promise<ReadonlyMap<string, readonly StoredReviewComment[]>>;
   /** Closes a pending review with a note, without publishing. */
   requestChanges(site: string, write: {
     readonly id: string;
@@ -397,6 +423,67 @@ interface AnalyticsReader {
     readonly limit: number;
   }): Promise<readonly PageCount[]>;
 }
+/** The stored structure of a site (ADR-033), or `null` for no row or a row with no definition. */
+interface StoredStructure {
+  readonly version: number;
+  readonly definition: unknown;
+  /** When the site went to the trash, or `null`. */
+  readonly deletedAt: string | null;
+}
+/** Who changes a structure: the person, and what their client said about itself. */
+interface StructureActor {
+  readonly userId: string;
+  readonly meta: Readonly<Record<string, unknown>> | null;
+}
+/**
+ * The structure of the sites in D1 (ADR-033): read, written with the version it was read at, and
+ * appended to `site_changes` in the same batch. A write never deletes an entry.
+ */
+interface StructureStore {
+  read(site: string): Promise<StoredStructure | null>;
+  /** A new definition, if the version is still `expected`: `conflict` when it moved. */
+  write(input: {
+    readonly site: string;
+    readonly expected: number;
+    readonly definition: unknown;
+    readonly actor: StructureActor;
+  }): Promise<'written' | 'conflict'>;
+  /** A new site with its definition, and its maker as owner: `taken` when the key exists, trashed or not. */
+  create(input: {
+    readonly site: string;
+    readonly definition: unknown;
+    readonly actor: StructureActor;
+  }): Promise<'created' | 'taken'>;
+  /** Puts a site in the trash, or takes it out: `false` when it was not where it had to be. */
+  trash(site: string, actor: StructureActor): Promise<boolean>;
+  restore(site: string, actor: StructureActor): Promise<boolean>;
+  /** The role of a person in a site, or `null` for none. */
+  roleOf(site: string, userId: string): Promise<'owner' | 'editor' | 'author' | null>;
+  /** How many entries a site holds, by collection and by locale. */
+  counts(site: string): Promise<{
+    readonly byCollection: ReadonlyMap<string, number>;
+    readonly byLocale: ReadonlyMap<string, number>;
+  }>;
+  /** The slug and latest frontmatter of up to `limit` entries of a collection. */
+  frontmatters(site: string, collection: string, limit: number): Promise<readonly {
+    readonly slug: string;
+    readonly frontmatter: unknown;
+  }[]>;
+}
+/** The structure, for the operations that change it, and what makes the Worker see a change at once. */
+interface Structure {
+  readonly store: StructureStore;
+  /** Brings this isolate's sites in line with D1 now, after a change. */
+  readonly changed: () => Promise<void>;
+  /**
+   * The secrets Hollware makes and keeps sealed (ADR-033): a new one for `name`, which replaces
+   * the one before and is answered in clear this once; `null` where the deployment has no
+   * `HOLLWARE_SECRET` to seal it with.
+   */
+  readonly secrets?: {
+    make(site: string, name: string): Promise<string | null>;
+  };
+}
 //#endregion
 //#region src/events/run.d.ts
 /** A message of the events Queue: the site and the id of an outbox row. */
@@ -482,6 +569,8 @@ interface OperationContext {
   readonly semantic?: Semantic | null;
   /** The counts of page views, when the deployment can read them (ADR-031); absent or `null` without. */
   readonly analytics?: AnalyticsReader | null;
+  /** The structure of the sites (ADR-033), where an operation may change it; absent over RPC. */
+  readonly structure?: Structure;
 }
 /** The handler of one operation: its parsed input in, its output out. */
 type OperationHandler<Name extends OperationName> = (input: z.output<OperationByName<Name>['input']>, context: OperationContext) => Promise<z.output<OperationByName<Name>['output']>>;
@@ -520,6 +609,11 @@ export interface HollwareEnv {
    * Origin the Worker answers; without it, every request fails.
    */
   readonly HOLLWARE_PUBLIC_URL: string;
+  /**
+   * The key that seals the secrets Hollware makes for the structure, such as those that sign
+   * webhooks (ADR-033): at least 32 characters, which `hollware deploy` makes when it is missing.
+   */
+  readonly HOLLWARE_SECRET?: string;
   /**
    * The KV namespace of the OAuth server (ADR-026): its clients, grants and tokens, all by hash.
    * Personal tokens work without it; OAuth does not.
@@ -547,6 +641,14 @@ export interface HollwareEnv {
   readonly HOLLWARE_ANALYTICS_ACCOUNT_ID?: string;
   readonly HOLLWARE_ANALYTICS_TOKEN?: string;
   readonly HOLLWARE_ANALYTICS_DATASET?: string;
+  /**
+   * The agents of @hollware/agents (v0.6), over a service binding to their named entrypoint: the
+   * cron trigger of Hollware wakes them every ten minutes, so they need no cron trigger of their
+   * own (the free plan has five for the account). `wrangler types` writes it as a plain
+   * `Service`, as it cannot see the agents' entrypoint, so any binding goes in: one without `run`
+   * is not called.
+   */
+  readonly AGENTS?: object;
 }
 type Output<Spec extends {
   output: z.ZodType;
@@ -593,8 +695,11 @@ export interface HollwareWorker {
   /** The RPC entrypoint, for the user's Worker to export under the name `Hollware`. */
   readonly Hollware: new (ctx: ExecutionContext, env: HollwareEnv) => WorkerEntrypoint<HollwareEnv> & HollwareRpc;
 }
-/** Builds the Worker from the config. The config is resolved once, when the Worker starts. */
-export type CreateHollware = (config: HollwareConfig) => HollwareWorker;
+/**
+ * Builds the Worker. The sites live in D1 (ADR-033); a config of 0.x, when given, is moved there
+ * on the first request, for the sites that have no definition yet, and never read again.
+ */
+export type CreateHollware = (config?: HollwareConfig) => HollwareWorker;
 /**
  * Builds the Worker from the config: `const hollware = createHollware(config)`, then
  * `export default { fetch: hollware.fetch }` and `export class Hollware extends hollware.Hollware {}`.
@@ -602,4 +707,4 @@ export type CreateHollware = (config: HollwareConfig) => HollwareWorker;
  */
 export declare const createHollware: CreateHollware;
 //#endregion
-export type { Actor, AnalyticsReader, AnalyticsWriter, Clock, ContentStore, Embedder, EntrySummaryView, EntryView, EventMessage, Handlers, ListQuery, NewRevision, OperationContext, OperationHandler, OutboxEvent, PageCount, PageView, Principal, PublishWrite, RelatedEntry, ReviewStatus, RevisionSummary, SearchHit, SearchQuery, Semantic, StoredEntry, StoredPublication, StoredReview, StoredRevision, StoredSchedule, StoredVector, VectorIndex, VectorMatch, VectorMetadata, View, WriteRefusal };
+export type { Actor, AnalyticsReader, AnalyticsWriter, Clock, ContentStore, Embedder, EntrySummaryView, EntryView, EventMessage, Handlers, ListQuery, NewRevision, OperationContext, OperationHandler, OutboxEvent, PageCount, PageView, Principal, PublishWrite, RelatedEntry, ReviewStatus, RevisionSummary, SearchHit, SearchQuery, Semantic, StoredEntry, StoredPublication, StoredReview, StoredReviewComment, StoredRevision, StoredSchedule, StoredStructure, StoredVector, Structure, StructureActor, StructureStore, VectorIndex, VectorMatch, VectorMetadata, View, WriteRefusal };