@automerge/automerge-repo 2.3.0 → 2.4.0-alpha.0

package/dist/Repo.d.ts

@@ -36,17 +36,23 @@ export declare class Repo extends EventEmitter<RepoEvents> {
     storageSubsystem?: StorageSubsystem;
     /** @hidden */
     synchronizer: CollectionSynchronizer;
-    /** By default, we share generously with all peers. */
-    /** @hidden */
-    sharePolicy: SharePolicy;
     /** maps peer id to to persistence information (storageId, isEphemeral), access by collection synchronizer  */
     /** @hidden */
     peerMetadataByPeerId: Record<PeerId, PeerMetadata>;
-    constructor({ storage, network, peerId, sharePolicy, isEphemeral, enableRemoteHeadsGossiping, denylist, saveDebounceRate, }?: RepoConfig);
+    constructor({ storage, network, peerId, sharePolicy, shareConfig, isEphemeral, enableRemoteHeadsGossiping, denylist, saveDebounceRate, }?: RepoConfig);
     /** Returns all the handles we have cached. */
     get handles(): Record<DocumentId, DocHandle<any>>;
     /** Returns a list of all connected peer ids */
     get peers(): PeerId[];
+    get peerId(): PeerId;
+    /** @hidden */
+    get sharePolicy(): SharePolicy;
+    /** @hidden */
+    set sharePolicy(policy: SharePolicy);
+    /** @hidden */
+    get shareConfig(): ShareConfig;
+    /** @hidden */
+    set shareConfig(config: ShareConfig);
     getStorageIdOfPeer(peerId: PeerId): StorageId | undefined;
     /**
      * Creates a new document and returns a handle to it. The initial value of the document is an
@@ -143,8 +149,15 @@ export interface RepoConfig {
     /**
      * Normal peers typically share generously with everyone (meaning we sync all our documents with
      * all peers). A server only syncs documents that a peer explicitly requests by ID.
+     * @deprecated Use `shareConfig` instead
      */
     sharePolicy?: SharePolicy;
+    /**
+     * Whether to share documents with other peers. By default we announce new
+     * documents to everyone and allow everyone access to documents, see the
+     * documentation for {@link ShareConfig} to override this
+     */
+    shareConfig?: ShareConfig;
     /**
      * Whether to enable the experimental remote heads gossiping feature
      */
@@ -169,6 +182,26 @@ export interface RepoConfig {
  * document with the peer given by `peerId`.
  * */
 export type SharePolicy = (peerId: PeerId, documentId?: DocumentId) => Promise<boolean>;
+/**
+ * A type which determines whether we should share a document with a peer
+ * */
+export type ShareConfig = {
+    /**
+     * Whether we should actively announce a document to a peer
+  
+     * @remarks
+     * This functions is called after checking the `access` policy to determine
+     * whether we should announce a document to a connected peer. For example, a
+     * tab connected to a sync server might want to announce every document to the
+     * sync server, but the sync server would not want to announce every document
+     * to every connected peer
+     */
+    announce: SharePolicy;
+    /**
+     * Whether a peer should have access to the document
+     */
+    access: (peer: PeerId, doc: DocumentId) => Promise<boolean>;
+};
 export interface RepoEvents {
     /** A new document was created or discovered */
     document: (arg: DocumentPayload) => void;

package/dist/Repo.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Repo.d.ts","sourceRoot":"","sources":["../src/Repo.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,YAAY,EAAE,MAAM,eAAe,CAAA;AAQ5C,OAAO,EAEL,SAAS,EAKV,MAAM,gBAAgB,CAAA;AAIvB,OAAO,EACL,uBAAuB,EACvB,KAAK,YAAY,EAClB,MAAM,sCAAsC,CAAA;AAC7C,OAAO,EAAE,gBAAgB,EAAE,MAAM,+BAA+B,CAAA;AAEhE,OAAO,EAAE,uBAAuB,EAAE,MAAM,sCAAsC,CAAA;AAC9E,OAAO,EAAE,gBAAgB,EAAE,MAAM,+BAA+B,CAAA;AAChE,OAAO,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAA;AAC9C,OAAO,EAAE,sBAAsB,EAAE,MAAM,0CAA0C,CAAA;AACjF,OAAO,EACL,cAAc,EAEf,MAAM,gCAAgC,CAAA;AACvC,OAAO,KAAK,EACV,aAAa,EACb,YAAY,EACZ,UAAU,EACV,MAAM,EACP,MAAM,YAAY,CAAA;AACnB,OAAO,EAAa,YAAY,EAAE,MAAM,wBAAwB,CAAA;AAChE,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAA;AAEhD,MAAM,MAAM,uBAAuB,CAAC,CAAC,IAAI,YAAY,CAAC,CAAC,CAAC,GAAG;IACzD,UAAU,EAAE,CAAC,eAAe,EAAE,MAAM,EAAE,KAAK,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAA;IAChE,IAAI,EAAE,MAAM,YAAY,CAAC,CAAC,CAAC,CAAA;IAC3B,SAAS,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE,YAAY,CAAC,CAAC,CAAC,KAAK,IAAI,KAAK,MAAM,IAAI,CAAA;CACzE,CAAA;AAED,MAAM,MAAM,cAAc,CAAC,CAAC,IAAI;IAC9B,IAAI,EAAE,MAAM,YAAY,CAAC,CAAC,CAAC,CAAA;IAC3B,SAAS,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE,YAAY,CAAC,CAAC,CAAC,KAAK,IAAI,KAAK,MAAM,IAAI,CAAA;IACxE,UAAU,EAAE,CAAC,eAAe,EAAE,MAAM,EAAE,KAAK,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAA;CACjE,CAAA;AAMD,8FAA8F;AAC9F;;;;;;GAMG;AACH,qBAAa,IAAK,SAAQ,YAAY,CAAC,UAAU,CAAC;;IAGhD,cAAc;IACd,gBAAgB,EAAE,gBAAgB,CAAA;IAClC,cAAc;IACd,gBAAgB,CAAC,EAAE,gBAAgB,CAAA;IAUnC,cAAc;IACd,YAAY,EAAE,sBAAsB,CAAA;IAEpC,sDAAsD;IACtD,cAAc;IACd,WAAW,EAAE,WAAW,CAAmB;IAE3C,8GAA8G;IAC9G,cAAc;IACd,oBAAoB,EAAE,MAAM,CAAC,MAAM,EAAE,YAAY,CAAC,CAAK;gBAU3C,EACV,OAAO,EACP,OAAY,EACZ,MAAuB,EACvB,WAAW,EACX,WAAmC,EACnC,0BAAkC,EAClC,QAAa,EACb,gBAAsB,GACvB,GAAE,UAAe;IAiRlB,8CAA8C;IAC9C,IAAI,OAAO,uCAEV;IAED,+CAA+C;IAC/C,IAAI,KAAK,IAAI,MAAM,EAAE,CAEpB;IAED,kBAAkB,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,GAAG,SAAS;IAIzD;;;;OAIG;IACH,MAAM,CAAC,CAAC,EAAE,YAAY,CAAC,EAAE,CAAC,GAAG,SAAS,CAAC,CAAC,CAAC;IAuBzC;;;;;;;;;;;;OAYG;IACH,KAAK,CAAC,CAAC,EAAE,YAAY,EAAE,SAAS,CAAC,CAAC,CAAC;IAmBnC,gBAAgB,CAAC,CAAC,EAChB,EAAE,EAAE,aAAa,EACjB,OAAO,GAAE,YAAiB,GACzB,uBAAuB,CAAC,CAAC,CAAC,GAAG,YAAY,CAAC,CAAC,CAAC;IAgKzC,IAAI,CAAC,CAAC,EACV,EAAE,EAAE,aAAa,EACjB,OAAO,GAAE,eAAe,GAAG,YAAiB,GAC3C,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;IA0ExB;;;OAGG;IACG,WAAW,CAAC,CAAC;IACjB,sDAAsD;IACtD,EAAE,EAAE,aAAa,EACjB,OAAO,GAAE,eAAe,GAAG,YAAiB,GAC3C,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;IAmBxB,MAAM;IACJ,oDAAoD;IACpD,EAAE,EAAE,aAAa;IAanB;;;;;;OAMG;IACG,MAAM,CAAC,EAAE,EAAE,aAAa,GAAG,OAAO,CAAC,UAAU,GAAG,SAAS,CAAC;IAQhE;;;;;;;;;;;;;;;OAeG;IACH,MAAM,CAAC,CAAC,EAAE,MAAM,EAAE,UAAU,EAAE,IAAI,CAAC,EAAE;QAAE,KAAK,CAAC,EAAE,UAAU,CAAA;KAAE,GAAG,SAAS,CAAC,CAAC,CAAC;IAoB1E,kBAAkB,GAAI,SAAS,SAAS,EAAE,UASzC;IAED,SAAS,QAAa,OAAO,CAAC,SAAS,GAAG,SAAS,CAAC,CAMnD;IAED;;;;;OAKG;IACG,KAAK,CAAC,SAAS,CAAC,EAAE,UAAU,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC;IAcpD;;;;;OAKG;IACG,eAAe,CAAC,UAAU,EAAE,UAAU;IA8B5C,QAAQ,IAAI,OAAO,CAAC,IAAI,CAAC;IAOzB,OAAO,IAAI;QAAE,SAAS,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;SAAE,CAAA;KAAE;CAGjD;AAED,MAAM,WAAW,UAAU;IACzB,4BAA4B;IAC5B,MAAM,CAAC,EAAE,MAAM,CAAA;IAEf;8DAC0D;IAC1D,WAAW,CAAC,EAAE,OAAO,CAAA;IAErB,gDAAgD;IAChD,OAAO,CAAC,EAAE,uBAAuB,CAAA;IAEjC,iEAAiE;IACjE,OAAO,CAAC,EAAE,uBAAuB,EAAE,CAAA;IAEnC;;;OAGG;IACH,WAAW,CAAC,EAAE,WAAW,CAAA;IAEzB;;OAEG;IACH,0BAA0B,CAAC,EAAE,OAAO,CAAA;IAEpC;;;;OAIG;IACH,QAAQ,CAAC,EAAE,YAAY,EAAE,CAAA;IAEzB;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAA;CAC1B;AAED;;;;;;;KAOK;AACL,MAAM,MAAM,WAAW,GAAG,CACxB,MAAM,EAAE,MAAM,EACd,UAAU,CAAC,EAAE,UAAU,KACpB,OAAO,CAAC,OAAO,CAAC,CAAA;AAGrB,MAAM,WAAW,UAAU;IACzB,+CAA+C;IAC/C,QAAQ,EAAE,CAAC,GAAG,EAAE,eAAe,KAAK,IAAI,CAAA;IACxC,6BAA6B;IAC7B,iBAAiB,EAAE,CAAC,GAAG,EAAE,qBAAqB,KAAK,IAAI,CAAA;IACvD,4FAA4F;IAC5F,sBAAsB,EAAE,CAAC,GAAG,EAAE,qBAAqB,KAAK,IAAI,CAAA;IAC5D,aAAa,EAAE,CAAC,GAAG,EAAE,UAAU,KAAK,IAAI,CAAA;CACzC;AAED,MAAM,WAAW,eAAe;IAC9B,eAAe,CAAC,EAAE,MAAM,EAAE,CAAA;CAC3B;AAED,MAAM,WAAW,eAAe;IAC9B,MAAM,EAAE,SAAS,CAAC,GAAG,CAAC,CAAA;CACvB;AAED,MAAM,WAAW,qBAAqB;IACpC,UAAU,EAAE,UAAU,CAAA;CACvB;AAED,MAAM,MAAM,UAAU,GAClB,cAAc,GACd;IACE,IAAI,EAAE,YAAY,CAAA;IAClB,UAAU,EAAE,UAAU,CAAA;IACtB,cAAc,EAAE,MAAM,CAAA;IACtB,MAAM,EAAE,MAAM,CAAA;IACd,UAAU,EAAE,MAAM,CAAA;CACnB,GACD;IACE,IAAI,EAAE,YAAY,CAAA;IAClB,UAAU,EAAE,UAAU,CAAA;CACvB,CAAA"}
+{"version":3,"file":"Repo.d.ts","sourceRoot":"","sources":["../src/Repo.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,YAAY,EAAE,MAAM,eAAe,CAAA;AAQ5C,OAAO,EAEL,SAAS,EAKV,MAAM,gBAAgB,CAAA;AAIvB,OAAO,EACL,uBAAuB,EACvB,KAAK,YAAY,EAClB,MAAM,sCAAsC,CAAA;AAC7C,OAAO,EAAE,gBAAgB,EAAE,MAAM,+BAA+B,CAAA;AAEhE,OAAO,EAAE,uBAAuB,EAAE,MAAM,sCAAsC,CAAA;AAC9E,OAAO,EAAE,gBAAgB,EAAE,MAAM,+BAA+B,CAAA;AAChE,OAAO,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAA;AAC9C,OAAO,EAAE,sBAAsB,EAAE,MAAM,0CAA0C,CAAA;AACjF,OAAO,EACL,cAAc,EAEf,MAAM,gCAAgC,CAAA;AACvC,OAAO,KAAK,EACV,aAAa,EACb,YAAY,EACZ,UAAU,EACV,MAAM,EACP,MAAM,YAAY,CAAA;AACnB,OAAO,EAAa,YAAY,EAAE,MAAM,wBAAwB,CAAA;AAChE,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAA;AAEhD,MAAM,MAAM,uBAAuB,CAAC,CAAC,IAAI,YAAY,CAAC,CAAC,CAAC,GAAG;IACzD,UAAU,EAAE,CAAC,eAAe,EAAE,MAAM,EAAE,KAAK,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAA;IAChE,IAAI,EAAE,MAAM,YAAY,CAAC,CAAC,CAAC,CAAA;IAC3B,SAAS,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE,YAAY,CAAC,CAAC,CAAC,KAAK,IAAI,KAAK,MAAM,IAAI,CAAA;CACzE,CAAA;AAED,MAAM,MAAM,cAAc,CAAC,CAAC,IAAI;IAC9B,IAAI,EAAE,MAAM,YAAY,CAAC,CAAC,CAAC,CAAA;IAC3B,SAAS,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE,YAAY,CAAC,CAAC,CAAC,KAAK,IAAI,KAAK,MAAM,IAAI,CAAA;IACxE,UAAU,EAAE,CAAC,eAAe,EAAE,MAAM,EAAE,KAAK,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAA;CACjE,CAAA;AAMD,8FAA8F;AAC9F;;;;;;GAMG;AACH,qBAAa,IAAK,SAAQ,YAAY,CAAC,UAAU,CAAC;;IAGhD,cAAc;IACd,gBAAgB,EAAE,gBAAgB,CAAA;IAClC,cAAc;IACd,gBAAgB,CAAC,EAAE,gBAAgB,CAAA;IAUnC,cAAc;IACd,YAAY,EAAE,sBAAsB,CAAA;IAOpC,8GAA8G;IAC9G,cAAc;IACd,oBAAoB,EAAE,MAAM,CAAC,MAAM,EAAE,YAAY,CAAC,CAAK;gBAU3C,EACV,OAAO,EACP,OAAY,EACZ,MAAuB,EACvB,WAAW,EACX,WAAW,EACX,WAAmC,EACnC,0BAAkC,EAClC,QAAa,EACb,gBAAsB,GACvB,GAAE,UAAe;IAkSlB,8CAA8C;IAC9C,IAAI,OAAO,uCAEV;IAED,+CAA+C;IAC/C,IAAI,KAAK,IAAI,MAAM,EAAE,CAEpB;IAED,IAAI,MAAM,IAAI,MAAM,CAEnB;IAED,cAAc;IACd,IAAI,WAAW,IAAI,WAAW,CAE7B;IAED,cAAc;IACd,IAAI,WAAW,CAAC,MAAM,EAAE,WAAW,EAElC;IAED,cAAc;IACd,IAAI,WAAW,IAAI,WAAW,CAE7B;IAED,cAAc;IACd,IAAI,WAAW,CAAC,MAAM,EAAE,WAAW,EAElC;IAED,kBAAkB,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,GAAG,SAAS;IAIzD;;;;OAIG;IACH,MAAM,CAAC,CAAC,EAAE,YAAY,CAAC,EAAE,CAAC,GAAG,SAAS,CAAC,CAAC,CAAC;IAuBzC;;;;;;;;;;;;OAYG;IACH,KAAK,CAAC,CAAC,EAAE,YAAY,EAAE,SAAS,CAAC,CAAC,CAAC;IAmBnC,gBAAgB,CAAC,CAAC,EAChB,EAAE,EAAE,aAAa,EACjB,OAAO,GAAE,YAAiB,GACzB,uBAAuB,CAAC,CAAC,CAAC,GAAG,YAAY,CAAC,CAAC,CAAC;IAgKzC,IAAI,CAAC,CAAC,EACV,EAAE,EAAE,aAAa,EACjB,OAAO,GAAE,eAAe,GAAG,YAAiB,GAC3C,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;IA0ExB;;;OAGG;IACG,WAAW,CAAC,CAAC;IACjB,sDAAsD;IACtD,EAAE,EAAE,aAAa,EACjB,OAAO,GAAE,eAAe,GAAG,YAAiB,GAC3C,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;IAmBxB,MAAM;IACJ,oDAAoD;IACpD,EAAE,EAAE,aAAa;IAanB;;;;;;OAMG;IACG,MAAM,CAAC,EAAE,EAAE,aAAa,GAAG,OAAO,CAAC,UAAU,GAAG,SAAS,CAAC;IAQhE;;;;;;;;;;;;;;;OAeG;IACH,MAAM,CAAC,CAAC,EAAE,MAAM,EAAE,UAAU,EAAE,IAAI,CAAC,EAAE;QAAE,KAAK,CAAC,EAAE,UAAU,CAAA;KAAE,GAAG,SAAS,CAAC,CAAC,CAAC;IAoB1E,kBAAkB,GAAI,SAAS,SAAS,EAAE,UASzC;IAED,SAAS,QAAa,OAAO,CAAC,SAAS,GAAG,SAAS,CAAC,CAMnD;IAED;;;;;OAKG;IACG,KAAK,CAAC,SAAS,CAAC,EAAE,UAAU,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC;IAcpD;;;;;OAKG;IACG,eAAe,CAAC,UAAU,EAAE,UAAU;IA8B5C,QAAQ,IAAI,OAAO,CAAC,IAAI,CAAC;IAOzB,OAAO,IAAI;QAAE,SAAS,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;SAAE,CAAA;KAAE;CAGjD;AAED,MAAM,WAAW,UAAU;IACzB,4BAA4B;IAC5B,MAAM,CAAC,EAAE,MAAM,CAAA;IAEf;8DAC0D;IAC1D,WAAW,CAAC,EAAE,OAAO,CAAA;IAErB,gDAAgD;IAChD,OAAO,CAAC,EAAE,uBAAuB,CAAA;IAEjC,iEAAiE;IACjE,OAAO,CAAC,EAAE,uBAAuB,EAAE,CAAA;IAEnC;;;;OAIG;IACH,WAAW,CAAC,EAAE,WAAW,CAAA;IAEzB;;;;OAIG;IACH,WAAW,CAAC,EAAE,WAAW,CAAA;IAEzB;;OAEG;IACH,0BAA0B,CAAC,EAAE,OAAO,CAAA;IAEpC;;;;OAIG;IACH,QAAQ,CAAC,EAAE,YAAY,EAAE,CAAA;IAEzB;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAA;CAC1B;AAED;;;;;;;KAOK;AACL,MAAM,MAAM,WAAW,GAAG,CACxB,MAAM,EAAE,MAAM,EACd,UAAU,CAAC,EAAE,UAAU,KACpB,OAAO,CAAC,OAAO,CAAC,CAAA;AAErB;;KAEK;AACL,MAAM,MAAM,WAAW,GAAG;IACxB;;;;;;;;;OASG;IACH,QAAQ,EAAE,WAAW,CAAA;IACrB;;OAEG;IACH,MAAM,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,EAAE,UAAU,KAAK,OAAO,CAAC,OAAO,CAAC,CAAA;CAC5D,CAAA;AAGD,MAAM,WAAW,UAAU;IACzB,+CAA+C;IAC/C,QAAQ,EAAE,CAAC,GAAG,EAAE,eAAe,KAAK,IAAI,CAAA;IACxC,6BAA6B;IAC7B,iBAAiB,EAAE,CAAC,GAAG,EAAE,qBAAqB,KAAK,IAAI,CAAA;IACvD,4FAA4F;IAC5F,sBAAsB,EAAE,CAAC,GAAG,EAAE,qBAAqB,KAAK,IAAI,CAAA;IAC5D,aAAa,EAAE,CAAC,GAAG,EAAE,UAAU,KAAK,IAAI,CAAA;CACzC;AAED,MAAM,WAAW,eAAe;IAC9B,eAAe,CAAC,EAAE,MAAM,EAAE,CAAA;CAC3B;AAED,MAAM,WAAW,eAAe;IAC9B,MAAM,EAAE,SAAS,CAAC,GAAG,CAAC,CAAA;CACvB;AAED,MAAM,WAAW,qBAAqB;IACpC,UAAU,EAAE,UAAU,CAAA;CACvB;AAED,MAAM,MAAM,UAAU,GAClB,cAAc,GACd;IACE,IAAI,EAAE,YAAY,CAAA;IAClB,UAAU,EAAE,UAAU,CAAA;IACtB,cAAc,EAAE,MAAM,CAAA;IACtB,MAAM,EAAE,MAAM,CAAA;IACd,UAAU,EAAE,MAAM,CAAA;CACnB,GACD;IACE,IAAI,EAAE,YAAY,CAAA;IAClB,UAAU,EAAE,UAAU,CAAA;CACvB,CAAA"}

package/dist/Repo.js

@@ -34,9 +34,10 @@ export class Repo extends EventEmitter {
     #handleCache = {};
     /** @hidden */
     synchronizer;
-    /** By default, we share generously with all peers. */
-    /** @hidden */
-    sharePolicy = async () => true;
+    #shareConfig = {
+        announce: async () => true,
+        access: async () => true,
+    };
     /** maps peer id to to persistence information (storageId, isEphemeral), access by collection synchronizer  */
     /** @hidden */
     peerMetadataByPeerId = {};
@@ -44,11 +45,23 @@ export class Repo extends EventEmitter {
     #remoteHeadsGossipingEnabled = false;
     #progressCache = {};
     #saveFns = {};
-    constructor({ storage, network = [], peerId = randomPeerId(), sharePolicy, isEphemeral = storage === undefined, enableRemoteHeadsGossiping = false, denylist = [], saveDebounceRate = 100, } = {}) {
+    constructor({ storage, network = [], peerId = randomPeerId(), sharePolicy, shareConfig, isEphemeral = storage === undefined, enableRemoteHeadsGossiping = false, denylist = [], saveDebounceRate = 100, } = {}) {
         super();
         this.#remoteHeadsGossipingEnabled = enableRemoteHeadsGossiping;
         this.#log = debug(`automerge-repo:repo`);
-        this.sharePolicy = sharePolicy ?? this.sharePolicy;
+        // Handle legacy sharePolicy
+        if (sharePolicy != null && shareConfig != null) {
+            throw new Error("cannot provide both sharePolicy and shareConfig at once");
+        }
+        if (sharePolicy) {
+            this.#shareConfig = {
+                announce: sharePolicy,
+                access: async () => true,
+            };
+        }
+        if (shareConfig) {
+            this.#shareConfig = shareConfig;
+        }
         this.on("delete-document", ({ documentId }) => {
             this.synchronizer.removeDocument(documentId);
             if (storageSubsystem) {
@@ -85,7 +98,7 @@ export class Repo extends EventEmitter {
             this.#saveFn = ({ handle, doc }) => {
                 let fn = this.#saveFns[handle.documentId];
                 if (!fn) {
-                    fn = throttle(() => {
+                    fn = throttle(({ doc, handle }) => {
                         void this.storageSubsystem.saveDoc(handle.documentId, doc);
                     }, this.#saveDebounceRate);
                     this.#saveFns[handle.documentId] = fn;
@@ -110,7 +123,8 @@ export class Repo extends EventEmitter {
             if (peerMetadata) {
                 this.peerMetadataByPeerId[peerId] = { ...peerMetadata };
             }
-            this.sharePolicy(peerId)
+            this.#shareConfig
+                .announce(peerId)
                 .then(shouldShare => {
                 if (shouldShare && this.#remoteHeadsGossipingEnabled) {
                     this.#remoteHeadsSubscriptions.addGenerousPeer(peerId);
@@ -258,6 +272,25 @@ export class Repo extends EventEmitter {
     get peers() {
         return this.synchronizer.peers;
     }
+    get peerId() {
+        return this.networkSubsystem.peerId;
+    }
+    /** @hidden */
+    get sharePolicy() {
+        return this.#shareConfig.announce;
+    }
+    /** @hidden */
+    set sharePolicy(policy) {
+        this.#shareConfig.announce = policy;
+    }
+    /** @hidden */
+    get shareConfig() {
+        return this.#shareConfig;
+    }
+    /** @hidden */
+    set shareConfig(config) {
+        this.#shareConfig = config;
+    }
     getStorageIdOfPeer(peerId) {
         return this.peerMetadataByPeerId[peerId]?.storageId;
     }

package/dist/helpers/DummyNetworkAdapter.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"DummyNetworkAdapter.d.ts","sourceRoot":"","sources":["../../src/helpers/DummyNetworkAdapter.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,OAAO,EAAE,cAAc,EAAE,MAAM,EAAE,MAAM,oBAAoB,CAAA;AAEpE,qBAAa,mBAAoB,SAAQ,cAAc;;IASrD,OAAO;IAIP,SAAS;IAYT,UAAU;gBAIE,IAAI,GAAE,OAA8B;IAQhD,OAAO,CAAC,MAAM,EAAE,MAAM;IAItB,UAAU;IAEV,aAAa,CAAC,MAAM,EAAE,MAAM;IAInB,IAAI,CAAC,OAAO,EAAE,OAAO;IAI9B,OAAO,CAAC,OAAO,EAAE,OAAO;IAIxB,MAAM,CAAC,mBAAmB,CAAC,EAAE,OAAY,EAAE,GAAE;QAAE,OAAO,CAAC,EAAE,MAAM,CAAA;KAAO;CAcvE;AAED,KAAK,aAAa,GAAG,CAAC,OAAO,EAAE,OAAO,KAAK,IAAI,CAAA;AAE/C,KAAK,OAAO,GAAG;IACb,UAAU,CAAC,EAAE,OAAO,CAAA;IACpB,WAAW,CAAC,EAAE,aAAa,CAAA;CAC5B,CAAA"}
+{"version":3,"file":"DummyNetworkAdapter.d.ts","sourceRoot":"","sources":["../../src/helpers/DummyNetworkAdapter.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,OAAO,EAAE,cAAc,EAAE,MAAM,EAAE,MAAM,oBAAoB,CAAA;AAEpE,qBAAa,mBAAoB,SAAQ,cAAc;;IAUrD,OAAO;IAIP,SAAS;IAYT,UAAU;gBAIE,IAAI,GAAE,OAA8B;IAQhD,OAAO,CAAC,MAAM,EAAE,MAAM;IAKtB,UAAU;IAIV,aAAa,CAAC,MAAM,EAAE,MAAM;IAInB,IAAI,CAAC,OAAO,EAAE,OAAO;IAO9B,OAAO,CAAC,OAAO,EAAE,OAAO;IAOxB,MAAM,CAAC,mBAAmB,CAAC,EAAE,OAAY,EAAE,GAAE;QAAE,OAAO,CAAC,EAAE,MAAM,CAAA;KAAO;CAcvE;AAED,KAAK,aAAa,GAAG,CAAC,OAAO,EAAE,OAAO,KAAK,IAAI,CAAA;AAE/C,KAAK,OAAO,GAAG;IACb,UAAU,CAAC,EAAE,OAAO,CAAA;IACpB,WAAW,CAAC,EAAE,aAAa,CAAA;CAC5B,CAAA"}

package/dist/helpers/DummyNetworkAdapter.js

@@ -2,6 +2,7 @@ import { pause } from "../../src/helpers/pause.js";
 import { NetworkAdapter } from "../../src/index.js";
 export class DummyNetworkAdapter extends NetworkAdapter {
     #sendMessage;
+    #connected = false;
     #ready = false;
     #readyResolver;
     #readyPromise = new Promise(resolve => {
@@ -31,16 +32,25 @@ export class DummyNetworkAdapter extends NetworkAdapter {
         this.#sendMessage = opts.sendMessage;
     }
     connect(peerId) {
+        this.#connected = true;
         this.peerId = peerId;
     }
-    disconnect() { }
+    disconnect() {
+        this.#connected = false;
+    }
     peerCandidate(peerId) {
         this.emit("peer-candidate", { peerId, peerMetadata: {} });
     }
     send(message) {
+        if (!this.#connected) {
+            return;
+        }
         this.#sendMessage?.(message);
     }
     receive(message) {
+        if (!this.#connected) {
+            return;
+        }
         this.emit("message", message);
     }
     static createConnectedPair({ latency = 10 } = {}) {

package/dist/synchronizer/CollectionSynchronizer.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"CollectionSynchronizer.d.ts","sourceRoot":"","sources":["../../src/synchronizer/CollectionSynchronizer.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAA;AAE3C,OAAO,EAAE,IAAI,EAAE,MAAM,YAAY,CAAA;AACjC,OAAO,EAAE,UAAU,EAAE,MAAM,wBAAwB,CAAA;AACnD,OAAO,EAAE,YAAY,EAAE,UAAU,EAAE,MAAM,EAAE,MAAM,aAAa,CAAA;AAC9D,OAAO,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAA;AACtD,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAA;AAIhD,4FAA4F;AAC5F,qBAAa,sBAAuB,SAAQ,YAAY;;IAa1C,OAAO,CAAC,IAAI;IATxB,kDAAkD;IAClD,cAAc;IACd,gBAAgB,EAAE,MAAM,CAAC,UAAU,EAAE,eAAe,CAAC,CAAK;gBAOtC,IAAI,EAAE,IAAI,EAAE,QAAQ,GAAE,YAAY,EAAO;IAwD7D;;;OAGG;IACG,cAAc,CAAC,OAAO,EAAE,UAAU;IAyCxC;;OAEG;IACH,WAAW,CAAC,MAAM,EAAE,SAAS,CAAC,OAAO,CAAC;IAWtC,sDAAsD;IACtD,cAAc,CAAC,UAAU,EAAE,UAAU;IAUrC,2DAA2D;IAC3D,OAAO,CAAC,MAAM,EAAE,MAAM;IAgBtB,uDAAuD;IACvD,UAAU,CAAC,MAAM,EAAE,MAAM;IASzB,+CAA+C;IAC/C,IAAI,KAAK,IAAI,MAAM,EAAE,CAEpB;IAED,OAAO,IAAI;QACT,CAAC,GAAG,EAAE,MAAM,GAAG;YACb,KAAK,EAAE,MAAM,EAAE,CAAA;YACf,IAAI,EAAE;gBAAE,MAAM,EAAE,MAAM,CAAC;gBAAC,UAAU,EAAE,MAAM,CAAA;aAAE,CAAA;SAC7C,CAAA;KACF;CASF"}
+{"version":3,"file":"CollectionSynchronizer.d.ts","sourceRoot":"","sources":["../../src/synchronizer/CollectionSynchronizer.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAA;AAE3C,OAAO,EAAE,IAAI,EAAE,MAAM,YAAY,CAAA;AACjC,OAAO,EAAE,UAAU,EAAE,MAAM,wBAAwB,CAAA;AACnD,OAAO,EAAE,YAAY,EAAE,UAAU,EAAE,MAAM,EAAE,MAAM,aAAa,CAAA;AAC9D,OAAO,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAA;AACtD,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAA;AAIhD,4FAA4F;AAC5F,qBAAa,sBAAuB,SAAQ,YAAY;;IAa1C,OAAO,CAAC,IAAI;IATxB,kDAAkD;IAClD,cAAc;IACd,gBAAgB,EAAE,MAAM,CAAC,UAAU,EAAE,eAAe,CAAC,CAAK;gBAOtC,IAAI,EAAE,IAAI,EAAE,QAAQ,GAAE,YAAY,EAAO;IAwD7D;;;OAGG;IACG,cAAc,CAAC,OAAO,EAAE,UAAU;IAuDxC;;OAEG;IACH,WAAW,CAAC,MAAM,EAAE,SAAS,CAAC,OAAO,CAAC;IAWtC,sDAAsD;IACtD,cAAc,CAAC,UAAU,EAAE,UAAU;IAUrC,2DAA2D;IAC3D,OAAO,CAAC,MAAM,EAAE,MAAM;IAgBtB,uDAAuD;IACvD,UAAU,CAAC,MAAM,EAAE,MAAM;IASzB,+CAA+C;IAC/C,IAAI,KAAK,IAAI,MAAM,EAAE,CAEpB;IAED,OAAO,IAAI;QACT,CAAC,GAAG,EAAE,MAAM,GAAG;YACb,KAAK,EAAE,MAAM,EAAE,CAAA;YACf,IAAI,EAAE;gBAAE,MAAM,EAAE,MAAM,CAAC;gBAAC,UAAU,EAAE,MAAM,CAAA;aAAE,CAAA;SAC7C,CAAA;KACF;CAiBF"}

package/dist/synchronizer/CollectionSynchronizer.js

@@ -54,7 +54,7 @@ export class CollectionSynchronizer extends Synchronizer {
         const peers = Array.from(this.#peers);
         const generousPeers = [];
         for (const peerId of peers) {
-            const okToShare = await this.repo.sharePolicy(peerId, documentId);
+            const okToShare = await this.#shouldShare(peerId, documentId);
             if (okToShare)
                 generousPeers.push(peerId);
         }
@@ -83,6 +83,16 @@ export class CollectionSynchronizer extends Synchronizer {
             });
             return;
         }
+        const hasAccess = await this.repo.shareConfig.access(message.senderId, documentId);
+        if (!hasAccess) {
+            log("access denied");
+            this.emit("message", {
+                type: "doc-unavailable",
+                documentId,
+                targetId: message.senderId,
+            });
+            return;
+        }
         this.#docSetUp[documentId] = true;
         const handle = await this.repo.find(documentId, {
             allowableStates: ["ready", "unavailable", "requesting"],
@@ -125,7 +135,7 @@ export class CollectionSynchronizer extends Synchronizer {
         this.#peers.add(peerId);
         for (const docSynchronizer of Object.values(this.docSynchronizers)) {
             const { documentId } = docSynchronizer;
-            void this.repo.sharePolicy(peerId, documentId).then(okToShare => {
+            void this.#shouldShare(peerId, documentId).then(okToShare => {
                 if (okToShare)
                     void docSynchronizer.beginSync([peerId]);
             });
@@ -148,4 +158,11 @@ export class CollectionSynchronizer extends Synchronizer {
             return [documentId, synchronizer.metrics()];
         }));
     }
+    async #shouldShare(peerId, documentId) {
+        const [announce, access] = await Promise.all([
+            this.repo.shareConfig.announce(peerId, documentId),
+            this.repo.shareConfig.access(peerId, documentId),
+        ]);
+        return announce && access;
+    }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@automerge/automerge-repo",
-  "version": "2.3.0",
+  "version": "2.4.0-alpha.0",
   "description": "A repository object to manage a collection of automerge documents",
   "repository": "https://github.com/automerge/automerge-repo/tree/master/packages/automerge-repo",
   "author": "Peter van Hardenberg <pvh@pvh.ca>",
@@ -59,5 +59,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "024b98b64a6add14dca52219e92acdfdb5bed230"
+  "gitHead": "d6d7dfd5c4af335ff3db876db053733efada83df"
 }

package/src/Repo.ts

@@ -85,9 +85,10 @@ export class Repo extends EventEmitter<RepoEvents> {
   /** @hidden */
   synchronizer: CollectionSynchronizer
 
-  /** By default, we share generously with all peers. */
-  /** @hidden */
-  sharePolicy: SharePolicy = async () => true
+  #shareConfig: ShareConfig = {
+    announce: async () => true,
+    access: async () => true,
+  }
 
   /** maps peer id to to persistence information (storageId, isEphemeral), access by collection synchronizer  */
   /** @hidden */
@@ -106,6 +107,7 @@ export class Repo extends EventEmitter<RepoEvents> {
     network = [],
     peerId = randomPeerId(),
     sharePolicy,
+    shareConfig,
     isEphemeral = storage === undefined,
     enableRemoteHeadsGossiping = false,
     denylist = [],
@@ -114,7 +116,20 @@ export class Repo extends EventEmitter<RepoEvents> {
     super()
     this.#remoteHeadsGossipingEnabled = enableRemoteHeadsGossiping
     this.#log = debug(`automerge-repo:repo`)
-    this.sharePolicy = sharePolicy ?? this.sharePolicy
+
+    // Handle legacy sharePolicy
+    if (sharePolicy != null && shareConfig != null) {
+      throw new Error("cannot provide both sharePolicy and shareConfig at once")
+    }
+    if (sharePolicy) {
+      this.#shareConfig = {
+        announce: sharePolicy,
+        access: async () => true,
+      }
+    }
+    if (shareConfig) {
+      this.#shareConfig = shareConfig
+    }
 
     this.on("delete-document", ({ documentId }) => {
       this.synchronizer.removeDocument(documentId)
@@ -163,9 +178,12 @@ export class Repo extends EventEmitter<RepoEvents> {
       this.#saveFn = ({ handle, doc }: DocHandleEncodedChangePayload<any>) => {
         let fn = this.#saveFns[handle.documentId]
         if (!fn) {
-          fn = throttle(() => {
-            void this.storageSubsystem!.saveDoc(handle.documentId, doc)
-          }, this.#saveDebounceRate)
+          fn = throttle(
+            ({ doc, handle }: DocHandleEncodedChangePayload<any>) => {
+              void this.storageSubsystem!.saveDoc(handle.documentId, doc)
+            },
+            this.#saveDebounceRate
+          )
           this.#saveFns[handle.documentId] = fn
         }
         fn({ handle, doc })
@@ -197,7 +215,8 @@ export class Repo extends EventEmitter<RepoEvents> {
         this.peerMetadataByPeerId[peerId] = { ...peerMetadata }
       }
 
-      this.sharePolicy(peerId)
+      this.#shareConfig
+        .announce(peerId)
         .then(shouldShare => {
           if (shouldShare && this.#remoteHeadsGossipingEnabled) {
             this.#remoteHeadsSubscriptions.addGenerousPeer(peerId)
@@ -393,6 +412,30 @@ export class Repo extends EventEmitter<RepoEvents> {
     return this.synchronizer.peers
   }
 
+  get peerId(): PeerId {
+    return this.networkSubsystem.peerId
+  }
+
+  /** @hidden */
+  get sharePolicy(): SharePolicy {
+    return this.#shareConfig.announce
+  }
+
+  /** @hidden */
+  set sharePolicy(policy: SharePolicy) {
+    this.#shareConfig.announce = policy
+  }
+
+  /** @hidden */
+  get shareConfig(): ShareConfig {
+    return this.#shareConfig
+  }
+
+  /** @hidden */
+  set shareConfig(config: ShareConfig) {
+    this.#shareConfig = config
+  }
+
   getStorageIdOfPeer(peerId: PeerId): StorageId | undefined {
     return this.peerMetadataByPeerId[peerId]?.storageId
   }
@@ -894,9 +937,17 @@ export interface RepoConfig {
   /**
    * Normal peers typically share generously with everyone (meaning we sync all our documents with
    * all peers). A server only syncs documents that a peer explicitly requests by ID.
+   * @deprecated Use `shareConfig` instead
    */
   sharePolicy?: SharePolicy
 
+  /**
+   * Whether to share documents with other peers. By default we announce new
+   * documents to everyone and allow everyone access to documents, see the
+   * documentation for {@link ShareConfig} to override this
+   */
+  shareConfig?: ShareConfig
+
   /**
    * Whether to enable the experimental remote heads gossiping feature
    */
@@ -928,6 +979,27 @@ export type SharePolicy = (
   documentId?: DocumentId
 ) => Promise<boolean>
 
+/**
+ * A type which determines whether we should share a document with a peer
+ * */
+export type ShareConfig = {
+  /**
+   * Whether we should actively announce a document to a peer
+
+   * @remarks
+   * This functions is called after checking the `access` policy to determine
+   * whether we should announce a document to a connected peer. For example, a
+   * tab connected to a sync server might want to announce every document to the
+   * sync server, but the sync server would not want to announce every document
+   * to every connected peer
+   */
+  announce: SharePolicy
+  /**
+   * Whether a peer should have access to the document
+   */
+  access: (peer: PeerId, doc: DocumentId) => Promise<boolean>
+}
+
 // events & payloads
 export interface RepoEvents {
   /** A new document was created or discovered */

package/src/helpers/DummyNetworkAdapter.ts

@@ -4,6 +4,7 @@ import { Message, NetworkAdapter, PeerId } from "../../src/index.js"
 export class DummyNetworkAdapter extends NetworkAdapter {
   #sendMessage?: SendMessageFn
 
+  #connected = false
   #ready = false
   #readyResolver?: () => void
   #readyPromise: Promise<void> = new Promise<void>(resolve => {
@@ -39,20 +40,29 @@ export class DummyNetworkAdapter extends NetworkAdapter {
   }
 
   connect(peerId: PeerId) {
+    this.#connected = true
     this.peerId = peerId
   }
 
-  disconnect() {}
+  disconnect() {
+    this.#connected = false
+  }
 
   peerCandidate(peerId: PeerId) {
     this.emit("peer-candidate", { peerId, peerMetadata: {} })
   }
 
   override send(message: Message) {
+    if (!this.#connected) {
+      return
+    }
     this.#sendMessage?.(message)
   }
 
   receive(message: Message) {
+    if (!this.#connected) {
+      return
+    }
     this.emit("message", message)
   }
 

package/src/synchronizer/CollectionSynchronizer.ts

@@ -71,7 +71,7 @@ export class CollectionSynchronizer extends Synchronizer {
     const peers = Array.from(this.#peers)
     const generousPeers: PeerId[] = []
     for (const peerId of peers) {
-      const okToShare = await this.repo.sharePolicy(peerId, documentId)
+      const okToShare = await this.#shouldShare(peerId, documentId)
       if (okToShare) generousPeers.push(peerId)
     }
     return generousPeers
@@ -108,6 +108,20 @@ export class CollectionSynchronizer extends Synchronizer {
       return
     }
 
+    const hasAccess = await this.repo.shareConfig.access(
+      message.senderId,
+      documentId
+    )
+    if (!hasAccess) {
+      log("access denied")
+      this.emit("message", {
+        type: "doc-unavailable",
+        documentId,
+        targetId: message.senderId,
+      })
+      return
+    }
+
     this.#docSetUp[documentId] = true
 
     const handle = await this.repo.find(documentId, {
@@ -160,7 +174,7 @@ export class CollectionSynchronizer extends Synchronizer {
     this.#peers.add(peerId)
     for (const docSynchronizer of Object.values(this.docSynchronizers)) {
       const { documentId } = docSynchronizer
-      void this.repo.sharePolicy(peerId, documentId).then(okToShare => {
+      void this.#shouldShare(peerId, documentId).then(okToShare => {
         if (okToShare) void docSynchronizer.beginSync([peerId])
       })
     }
@@ -195,4 +209,12 @@ export class CollectionSynchronizer extends Synchronizer {
       )
     )
   }
+
+  async #shouldShare(peerId: PeerId, documentId: DocumentId): Promise<boolean> {
+    const [announce, access] = await Promise.all([
+      this.repo.shareConfig.announce(peerId, documentId),
+      this.repo.shareConfig.access(peerId, documentId),
+    ])
+    return announce && access
+  }
 }

package/test/Repo.test.ts

@@ -11,7 +11,7 @@ import {
   generateAutomergeUrl,
   stringifyAutomergeUrl,
 } from "../src/AutomergeUrl.js"
-import { Repo } from "../src/Repo.js"
+import { FindProgressWithMethods, Repo, ShareConfig } from "../src/Repo.js"
 import { eventPromise } from "../src/helpers/eventPromise.js"
 import { pause } from "../src/helpers/pause.js"
 import {
@@ -33,6 +33,7 @@ import {
 import { getRandomItem } from "./helpers/getRandomItem.js"
 import { TestDoc } from "./types.js"
 import { StorageId, StorageKey } from "../src/storage/types.js"
+import { FindProgress } from "../src/FindProgress.js"
 
 describe("Repo", () => {
   describe("constructor", () => {
@@ -1709,6 +1710,174 @@ describe("Repo", () => {
       assert.deepEqual(openDocs, 0)
     })
   })
+
+  describe("the sharePolicy", () => {
+    async function connect(left: Repo, right: Repo) {
+      const [leftToRight, rightToLeft] =
+        DummyNetworkAdapter.createConnectedPair({ latency: 0 })
+      left.networkSubsystem.addNetworkAdapter(leftToRight)
+      right.networkSubsystem.addNetworkAdapter(rightToLeft)
+      leftToRight.peerCandidate(right.peerId)
+      rightToLeft.peerCandidate(left.peerId)
+      await Promise.all([
+        left.networkSubsystem.whenReady(),
+        right.networkSubsystem.whenReady(),
+      ])
+      await pause(10)
+    }
+
+    async function withTimeout<T>(
+      promise: Promise<T>,
+      timeout: number
+    ): Promise<T | undefined> {
+      const timeoutPromise = new Promise<T | undefined>(resolve => {
+        setTimeout(() => resolve(undefined), timeout)
+      })
+      return Promise.race([promise, timeoutPromise])
+    }
+
+    async function awaitState(
+      progress: FindProgress<unknown> | FindProgressWithMethods<unknown>,
+      state: string
+    ): Promise<void> {
+      if (progress.state == state) {
+        return
+      }
+      if (!("subscribe" in progress)) {
+        throw new Error(
+          `expected progress in state ${state} but was in final state ${progress.state}`
+        )
+      }
+      await new Promise(resolve => {
+        const unsubscribe = progress.subscribe(progress => {
+          if (progress.state === state) {
+            unsubscribe()
+            resolve(null)
+          }
+        })
+      })
+    }
+
+    // The parts of `RepoConfig` which are either the old sharePolicy API or the new shareConfig API
+    type EitherConfig = { sharePolicy?: SharePolicy; shareConfig?: ShareConfig }
+
+    /// Create two connected peers with the given share configurations
+    async function twoPeers({
+      alice: aliceConfig,
+      bob: bobConfig,
+    }: {
+      alice: EitherConfig
+      bob: EitherConfig
+    }): Promise<{ alice: Repo; bob: Repo }> {
+      const alice = new Repo({
+        peerId: "alice" as PeerId,
+        ...aliceConfig,
+      })
+      const bob = new Repo({
+        peerId: "bob" as PeerId,
+        ...bobConfig,
+      })
+      await connect(alice, bob)
+      return { alice, bob }
+    }
+
+    describe("the legacy API", () => {
+      it("should announce documents to peers for whom the sharePolicy returns true", async () => {
+        const { alice, bob } = await twoPeers({
+          alice: { sharePolicy: async () => true },
+          bob: { sharePolicy: async () => true },
+        })
+        const handle = alice.create({ foo: "bar" })
+
+        // Wait for the announcement to be synced
+        await pause(100)
+
+        // Disconnect and stop alice
+        await alice.shutdown()
+
+        // Bob should have the handle already because it was announced to him
+        const bobHandle = await bob.find(handle.url)
+      })
+
+      it("should not annouce documents to peers for whom the sharePolicy returns false", async () => {
+        const { alice, bob } = await twoPeers({
+          alice: { sharePolicy: async () => false },
+          bob: { sharePolicy: async () => true },
+        })
+        const handle = alice.create({ foo: "bar" })
+
+        // Disconnect and stop alice
+        await alice.shutdown()
+
+        // Bob should have the handle already because it was announced to him
+        const bobHandle = await withTimeout(bob.find(handle.url), 100)
+        assert.equal(bobHandle, null)
+      })
+
+      it("should respond to direct requests for document where the sharePolicy returns false", async () => {
+        const { alice, bob } = await twoPeers({
+          alice: { sharePolicy: async () => false },
+          bob: { sharePolicy: async () => true },
+        })
+        await connect(alice, bob)
+
+        const aliceHandle = alice.create({ foo: "bar" })
+        const bobHandle = await bob.find(aliceHandle.url)
+      })
+    })
+
+    it("should respond to direct requests for document where the announce policy returns false but the access policy returns true", async () => {
+      const { alice, bob } = await twoPeers({
+        alice: {
+          shareConfig: {
+            announce: async () => false,
+            access: async () => true,
+          },
+        },
+        bob: { sharePolicy: async () => true },
+      })
+
+      const aliceHandle = alice.create({ foo: "bar" })
+      const bobHandle = await bob.find(aliceHandle.url)
+    })
+
+    it("should not respond to direct requests for a document where the access policy returns false and the announce policy return trrrue", async () => {
+      const { alice, bob } = await twoPeers({
+        alice: {
+          shareConfig: {
+            announce: async () => true,
+            access: async () => false,
+          },
+        },
+        bob: { sharePolicy: async () => true },
+      })
+      await connect(alice, bob)
+
+      const aliceHandle = alice.create({ foo: "bar" })
+      withTimeout(
+        awaitState(bob.findWithProgress(aliceHandle.url), "unavailable"),
+        500
+      )
+    })
+
+    it("should not respond to direct requests for a document where the access policy and the announce policy return false", async () => {
+      const { alice, bob } = await twoPeers({
+        alice: {
+          shareConfig: {
+            announce: async () => false,
+            access: async () => false,
+          },
+        },
+        bob: { sharePolicy: async () => false },
+      })
+
+      const aliceHandle = alice.create({ foo: "bar" })
+      withTimeout(
+        awaitState(bob.findWithProgress(aliceHandle.url), "unavailable"),
+        500
+      )
+    })
+  })
 })
 
 describe("Repo heads-in-URLs functionality", () => {