Finalize the sharing feature

Author: kossnocorp

Diff for: src/adapter/admin/core.mjs

@@ -264,6 +264,10 @@ export class Ref {
   async remove() {
     return this.collection.remove(this.id);
   }
+
+  as() {
+    return this;
+  }
 }
 
 export class Doc {
@@ -310,6 +314,10 @@ export class Doc {
     const result = cb(this.data);
     if (result) return this;
   }
+
+  as() {
+    return this;
+  }
 }
 
 export function all(adapter) {

Diff for: src/adapter/web/core.mjs

@@ -274,6 +274,10 @@ export class Ref {
   async remove() {
     return this.collection.remove(this.id);
   }
+
+  as() {
+    return this;
+  }
 }
 
 export class Doc {
@@ -320,6 +324,10 @@ export class Doc {
     const result = cb(this.data);
     if (result) return this;
   }
+
+  as() {
+    return this;
+  }
 }
 
 export function all(adapter) {

Diff for: src/index.ts

@@ -52,12 +52,56 @@ export namespace Typesaurus {
   /**
    * Narrows doc type. If your doc has a variable model, the type will help you
    * narrow down the doc type to a specific data type.
+   *
+   * [Learn more on the docs website](https://typesaurus.com/types/typesaurus/#narrowdoc)
    */
   export type NarrowDoc<
     OriginalDoc extends Core.Doc<any, any>,
     NarrowToModel extends Core.ModelObjectType,
   > = Core.NarrowDoc<OriginalDoc, NarrowToModel>;
 
+  /**
+   * Shared ref type. Unlike regular ref, shared ref lacks methods which
+   * type-safety depends on knowing the full type of the model: `set`, `upset`,
+   * and `as`. The `collection` is also limited.
+   *
+   * [Learn more on the docs website](https://typesaurus.com/types/typesaurus/#sharedref)
+   */
+  export type SharedRef<Model extends Core.ModelObjectType> = Shared.Ref<Model>;
+
+  /**
+   * Shared doc type. Unlike regular doc, shared doc lacks methods which
+   * type-safety depends on knowing the full type of the model: `set`, `upset`,
+   * and `as`. The `ref` is also limited.
+   *
+   * [Learn more on the docs website](https://typesaurus.com/types/typesaurus/#shareddoc)
+   */
+  export type SharedDoc<Model extends Core.ModelObjectType> = Shared.Doc<
+    Model,
+    Core.DocProps
+  >;
+
+  /**
+   * Shared ref or doc type. Unlike regular ref and doc, shared doc lacks
+   * methods which type-safety depends on knowing the full type of the model:
+   * `set`, `upset`, and `as`.
+   *
+   * [Learn more on the docs website](https://typesaurus.com/types/typesaurus/#sharedentity)
+   */
+  export type SharedEntity<Model extends Core.ModelObjectType> =
+    | Shared.Ref<Model>
+    | Shared.Doc<Model, Core.DocProps>;
+
+  /**
+   * Shared collection type. Unlike regular collection, shared collection lacks
+   * methods which type-safety depends on knowing the full type of the model:
+   * `add`, `set`, `upset`, and `update`.
+   *
+   * [Learn more on the docs website](https://typesaurus.com/types/typesaurus/#sharedcollection)
+   */
+  export type SharedCollection<Model extends Core.ModelObjectType> =
+    Shared.Collection<Model>;
+
   /**
    * Concats models into single variable model type. Useful to define and export
    * variable models ouside of the centraliazed schema definition.
@@ -141,24 +185,4 @@ export namespace Typesaurus {
     WideModel: Core.NullifyModel<WideModel>;
     Flags: Flags;
   };
-
-  /**
-   * TODO:
-   */
-  export type SharedCollection<Model extends Core.ModelObjectType> =
-    Shared.Collection<Model>;
-
-  /**
-   * TODO:
-   */
-  export type SharedRef<Model extends Core.ModelObjectType> = Shared.Ref<Model>;
-
-  /**
-   * TODO:
-   */
-  export type SharedDoc<Model extends Core.ModelObjectType> = Shared.Doc<
-    Model,
-    // TODO: Allow constraining the props type via Environment
-    Core.DocProps
-  >;
 }

Diff for: src/tests/doc.ts

@@ -266,4 +266,15 @@ describe("doc", () => {
       );
     });
   });
+
+  describe("as", () => {
+    const doc = db.content.doc(db.content.id("42"), {
+      type: "text",
+      text: "Hello, world!",
+    });
+
+    it("returns the doc", () => {
+      expect(doc.as()).toBe(doc);
+    });
+  });
 });

Diff for: src/tests/ref.ts

@@ -22,4 +22,12 @@ describe("ref", () => {
     expect(userRef.collection.path).toBe("users");
     expect("get" in userRef.collection).toBe(true);
   });
+
+  describe("as", () => {
+    const ref = db.users.ref(db.users.id("42"));
+
+    it("returns the ref", () => {
+      expect(ref.as()).toBe(ref);
+    });
+  });
 });