@hollware/server 0.9.0 → 0.10.0

package/dist/{ceremonies-D5dIEbha.mjs → ceremonies-DDoGdUD7.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-C2hiR0yd.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-BPr9-wKy.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

@@ -33,6 +33,8 @@ interface StoredEntry {
   readonly publishedAt: string | null;
   /** When a scheduled entry will be published, or `null`. */
   readonly scheduledAt: string | null;
+  /** When the entry went to the trash, or `null`. The reads leave a trashed entry out. */
+  readonly deletedAt: string | null;
   readonly updatedAt: string;
 }
 /** A revision as the store holds it. */
@@ -99,6 +101,8 @@ interface ListQuery {
   readonly locale?: string;
   readonly tag?: string;
   readonly status?: StoredEntry['status'];
+  /** The entries in the trash instead of the others; the published view has none. */
+  readonly trashed?: boolean;
   readonly view: View;
   readonly limit: number;
   /** The `nextCursor` of the previous page. */
@@ -200,6 +204,15 @@ interface OutboxEvent {
   readonly id: string;
   readonly payload: string;
 }
+/** A new entry whose slug or translation an entry in the trash holds: restore that one. */
+interface InTrash {
+  readonly outcome: 'in_trash';
+  readonly view: EntryView;
+}
+/**
+ * The reads of the store leave out an entry in the trash, in every view: for the operations it is
+ * not there until it is restored. Only `listEntries` with `trashed` reads the trash.
+ */
 interface ContentStore {
   /** The entry with that collection, locale and slug, in the given view, or `null`. */
   findEntry(site: string, ref: EntryRef, view: View): Promise<EntryView | null>;
@@ -228,14 +241,41 @@ interface ContentStore {
   lookup(site: string): EntryLookup;
   /** The latest publish or unpublish of an entry, or `null`. */
   lastPublication(site: string, entryId: string): Promise<StoredPublication | null>;
-  /** Creates an entry at version 1 with its first revision, as a draft. */
+  /**
+   * Creates an entry at version 1 with its first revision, as a draft. A slug or a translation
+   * that an entry in the trash holds is `in_trash`, by that entry.
+   */
   createEntry(site: string, entry: EntryRef & {
     readonly translationGroup: string | null;
     readonly revision: NewRevision;
   }): Promise<{
     readonly outcome: 'saved';
     readonly view: EntryView;
-  } | WriteRefusal>;
+  } | WriteRefusal | InTrash>;
+  /**
+   * Moves a draft to the trash, if it is still at `expectedVersion`: the entry gets its
+   * `deletedAt` and the next version, and its pending review is cancelled in the same batch. No
+   * row is deleted. An entry that is published or scheduled is `not_draft`, and nothing is written.
+   */
+  trashEntry(site: string, write: {
+    readonly entryId: string;
+    readonly expectedVersion: number;
+  }): Promise<{
+    readonly outcome: 'trashed' | 'not_draft';
+    readonly view: EntryView;
+  } | Extract<WriteRefusal, {
+    readonly outcome: 'conflict' | 'not_found';
+  }>>;
+  /** Brings an entry back from the trash as the draft it was, at the next version. */
+  restoreEntry(site: string, entryId: string): Promise<{
+    readonly outcome: 'restored';
+    readonly view: EntryView;
+  } | {
+    readonly outcome: 'not_trashed';
+    readonly view: EntryView;
+  } | {
+    readonly outcome: 'not_found';
+  }>;
   /**
    * Appends a revision and makes it the head, if the entry is still at `expectedVersion`. In
    * one batch: the revision, its tags (only where the revision was inserted), the cancellation of
@@ -441,12 +481,16 @@ interface StructureActor {
  */
 interface StructureStore {
   read(site: string): Promise<StoredStructure | null>;
-  /** A new definition, if the version is still `expected`: `conflict` when it moved. */
+  /**
+   * A new definition, if the version is still `expected`: `conflict` when it moved. Its `event`,
+   * a `site.changed`, goes to the outbox in the same batch, and only when the definition does.
+   */
   write(input: {
     readonly site: string;
     readonly expected: number;
     readonly definition: unknown;
     readonly actor: StructureActor;
+    readonly event?: OutboxEvent;
   }): Promise<'written' | 'conflict'>;
   /** A new site with its definition, and its maker as owner: `taken` when the key exists, trashed or not. */
   create(input: {
@@ -707,4 +751,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, StoredReviewComment, StoredRevision, StoredSchedule, StoredStructure, StoredVector, Structure, StructureActor, StructureStore, VectorIndex, VectorMatch, VectorMetadata, View, WriteRefusal };
+export type { Actor, AnalyticsReader, AnalyticsWriter, Clock, ContentStore, Embedder, EntrySummaryView, EntryView, EventMessage, Handlers, InTrash, 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 };