[bindgen] Refactor namespaces (#5376)

* WIP on improving the type-tests

* Removed a stray comment start

* Fixed missing @ts-expect-error in bundle.d.ts

* Propagate local app name and version

* Renamed AuthClients to Auth

This is to avoid breaking the API just yet.

* Refactored namespaces

* Fixed namespaced Types export

* Fixed InsertionModel types

* Fixed a type-o

* Ensuring named exports are correct

* Updated unit tests to import from ../index

* Fixed some exported types

* Merged Dictionary interface and class

* Reverting removal of `Realm.Credentials`

* Reordered and exporting MutableSubscriptionSet

* Updated AppConfiguration#baseUrl docs

* Adding links to ClientResetError deprecation

* Exporting types pr review

* Adding "CanonicalObjectSchema" to Realm namespace

* Export CanonicalPropertySchema

And added a link to it on the CanonicalObjectSchemaProperty.

install-tests/react-native/cli.ts

@@ -136,7 +136,7 @@ yargs(hideBin(process.argv))
       const env = getEnv({ newArchitecture, engine });
 
       console.log(`Initializing react-native@${reactNativeVersion} template into '${appPath}'`);
-      console.log("New achitecture is", newArchitecture ? "enabled" : "disabled");
+      console.log("New architecture is", newArchitecture ? "enabled" : "disabled");
 
       if (fs.existsSync(appPath) && force) {
         console.log("Deleting existing app directory! (because --force)");

packages/realm/src/Collection.ts

@@ -31,7 +31,6 @@ import { CallbackAdder, IllegalConstructorError, Listeners, assert, binding } fr
  * objects which matched the query when the enumeration is begun, even if some of them are
  * deleted or modified to be excluded by the filter during the enumeration.
  *
- * @memberof Realm
  * @since 0.11.0
  */
 export abstract class Collection<

packages/realm/src/Configuration.ts

@@ -27,14 +27,12 @@ import {
   validateSyncConfiguration,
 } from "./internal";
 
-// export type Configuration = ConfigurationWithSync | ConfigurationWithoutSync;
-export type Configuration = BaseConfiguration;
 /**
  * A function which can be called to migrate a Realm from one version of the schema to another.
  */
 export type MigrationCallback = (oldRealm: Realm, newRealm: Realm) => void;
 
-type BaseConfiguration = {
+export type BaseConfiguration = {
   path?: string;
   schema?: (RealmObjectConstructor<any> | ObjectSchema)[];
   schemaVersion?: number;
@@ -50,13 +48,15 @@ type BaseConfiguration = {
   onMigration?: MigrationCallback;
 };
 
-// type ConfigurationWithSync = BaseConfiguration & {
-//   sync: Record<string, unknown>;
-// };
+export type ConfigurationWithSync = BaseConfiguration & {
+  sync: SyncConfiguration;
+};
 
-// type ConfigurationWithoutSync = BaseConfiguration & {
-//   sync?: never;
-// };
+export type ConfigurationWithoutSync = BaseConfiguration & {
+  sync?: never;
+};
+
+export type Configuration = ConfigurationWithSync | ConfigurationWithoutSync;
 
 // export type PartitionValue = string | number | null | ObjectId | UUID;
 
@@ -123,7 +123,7 @@ type BaseConfiguration = {
 //    *
 //    * Example:
 //    * ```
-//    * const config: Realm.Configuration = {
+//    * const config: Configuration = {
 //    *   sync: {
 //    *     user,
 //    *     flexible: true,
@@ -146,9 +146,9 @@ type BaseConfiguration = {
 //     /**
 //      * Callback called with the {@link Realm} instance to allow you to setup the
 //      * initial set of subscriptions by calling `realm.subscriptions.update`.
-//      * See {@link Realm.App.Sync.SubscriptionSet.update} for more information.
+//      * See {@link SubscriptionSet.update} for more information.
 //      */
-//     update: (subs: Realm.App.Sync.MutableSubscriptionSet, realm: Realm) => void;
+//     update: (subs: MutableSubscriptionSet, realm: Realm) => void;
 //     /**
 //      * If `true`, the {@link update} callback will be rerun every time the Realm is
 //      * opened (e.g. every time a user opens your app), otherwise (by default) it
@@ -264,7 +264,9 @@ export function validateConfiguration(config: unknown): asserts config is Config
   if (encryptionKey !== undefined) {
     assert(
       encryptionKey instanceof ArrayBuffer || ArrayBuffer.isView(encryptionKey) || encryptionKey instanceof Int8Array,
-      `Expected 'encryptionKey' on realm configuration to be an ArrayBuffer, ArrayBufferView (Uint8Array), or Int8Array, got ${TypeAssertionError.deriveType(encryptionKey)}.`,
+      `Expected 'encryptionKey' on realm configuration to be an ArrayBuffer, ArrayBufferView (Uint8Array), or Int8Array, got ${TypeAssertionError.deriveType(
+        encryptionKey,
+      )}.`,
     );
   }
 }

packages/realm/src/Dictionary.ts

@@ -31,12 +31,12 @@ const REALM = Symbol("Dictionary#realm");
 const INTERNAL = Symbol("Dictionary#internal");
 const HELPERS = Symbol("Dictionary#helpers");
 
-type DictionaryChangeSet = {
+export type DictionaryChangeSet = {
   deletions: string[];
   modifications: string[];
   insertions: string[];
 };
-type DictionaryChangeCallback = (dictionary: Dictionary, changes: DictionaryChangeSet) => void;
+export type DictionaryChangeCallback = (dictionary: Dictionary, changes: DictionaryChangeSet) => void;
 
 const DEFAULT_PROPERTY_DESCRIPTOR: PropertyDescriptor = { configurable: true, enumerable: true };
 const PROXY_HANDLER: ProxyHandler<Dictionary> = {
@@ -101,8 +101,6 @@ const PROXY_HANDLER: ProxyHandler<Dictionary> = {
  *
  * Dictionaries behave mostly like a JavaScript object i.e., as a key/value pair
  * where the key is a string.
- *
- * @memberof Realm
  */
 export class Dictionary<T = unknown> extends Collection<string, T, [string, T], [string, T], DictionaryChangeCallback> {
   /**
@@ -184,14 +182,14 @@ export class Dictionary<T = unknown> extends Collection<string, T, [string, T],
    */
   private [HELPERS]!: TypeHelpers;
 
-  // @ts-expect-error We're exposing methods in the end-users namespace of keys
+  /** @ts-expect-error We're exposing methods in the end-users namespace of keys */
   [key: string]: T;
 
   *[Symbol.iterator]() {
     yield* this.entries();
   }
 
-  // @ts-expect-error We're exposing methods in the end-users namespace of keys
+  /** @ts-expect-error We're exposing methods in the end-users namespace of keys */
   *keys() {
     const snapshot = this[INTERNAL].keys.snapshot();
     const size = snapshot.size();
@@ -202,7 +200,7 @@ export class Dictionary<T = unknown> extends Collection<string, T, [string, T],
     }
   }
 
-  // @ts-expect-error We're exposing methods in the end-users namespace of keys
+  /** @ts-expect-error We're exposing methods in the end-users namespace of keys */
   *values() {
     const { fromBinding } = this[HELPERS];
     const snapshot = this[INTERNAL].values.snapshot();
@@ -213,7 +211,7 @@ export class Dictionary<T = unknown> extends Collection<string, T, [string, T],
     }
   }
 
-  // @ts-expect-error We're exposing methods in the end-users namespace of keys
+  /** @ts-expect-error We're exposing methods in the end-users namespace of keys */
   *entries() {
     const { fromBinding } = this[HELPERS];
     const keys = this[INTERNAL].keys.snapshot();
@@ -227,7 +225,7 @@ export class Dictionary<T = unknown> extends Collection<string, T, [string, T],
     }
   }
 
-  // @ts-expect-error We're exposing methods in the end-users namespace of keys
+  /** @ts-expect-error We're exposing methods in the end-users namespace of keys */
   isValid() {
     return this[INTERNAL].isValid;
   }
@@ -238,8 +236,7 @@ export class Dictionary<T = unknown> extends Collection<string, T, [string, T],
    * @throws {@link AssertionError} If not inside a write transaction or if value violates type constraints
    * @returns The dictionary
    * @since 10.6.0
-   */
-  // @ts-expect-error We're exposing methods in the end-users namespace of keys
+   * @ts-expect-error We're exposing methods in the end-users namespace of keys */
   set(elements: { [key: string]: T }): this;
   /**
    * Adds an element with the specified key and value to the dictionary or updates value if key exists.
@@ -276,8 +273,7 @@ export class Dictionary<T = unknown> extends Collection<string, T, [string, T],
    * @throws {@link AssertionError} If not inside a write transaction.
    * @returns The dictionary
    * @since 10.6.0
-   */
-  // @ts-expect-error We're exposing methods in the end-users namespace of keys
+   * @ts-expect-error We're exposing methods in the end-users namespace of keys */
   remove(key: string | string[]): this {
     assert.inTransaction(this[REALM]);
     const internal = this[INTERNAL];
@@ -293,8 +289,7 @@ export class Dictionary<T = unknown> extends Collection<string, T, [string, T],
    * Use circular JSON serialization libraries such as [@ungap/structured-clone](https://www.npmjs.com/package/@ungap/structured-clone)
    * and [flatted](https://www.npmjs.com/package/flatted) to stringify Realm entities that have circular structures.
    * @returns A plain object.
-   **/
-  // @ts-expect-error We're exposing methods in the users value namespace
+   * @ts-expect-error We're exposing methods in the end-users namespace of keys */
   toJSON(_?: string, cache?: unknown): DefaultObject;
   /** @internal */
   toJSON(_?: string, cache = new JSONCacheMap()): DefaultObject {

packages/realm/src/InsertionModel.ts

@@ -18,6 +18,11 @@
 
 import { Collection, Dictionary, List, RealmObject } from "./internal";
 
+type AnyCollection = Collection<any, any, any, any, any>;
+type AnyDictionary = Dictionary<any>;
+type AnyList = List<any>;
+type AnyRealmObject = RealmObject<any>;
+
 type ExtractPropertyNamesOfType<T, PropType> = {
   [K in keyof T]: T[K] extends PropType ? K : never;
 }[keyof T];
@@ -26,7 +31,7 @@ type ExtractPropertyNamesOfType<T, PropType> = {
  * Exchanges properties defined as {@link List<T>} with an optional {@link Array<T | RealmInsertionModel<T>>}.
  */
 type RealmListsRemappedModelPart<T> = {
-  [K in ExtractPropertyNamesOfType<T, List>]?: T[K] extends List<infer GT>
+  [K in ExtractPropertyNamesOfType<T, AnyList>]?: T[K] extends List<infer GT>
     ? Array<GT | RealmInsertionModel<GT>>
     : never;
 };
@@ -35,26 +40,26 @@ type RealmListsRemappedModelPart<T> = {
  * Exchanges properties defined as {@link Dictionary<T>} with an optional key to mixed value object.
  */
 type RealmDictionaryRemappedModelPart<T> = {
-  [K in ExtractPropertyNamesOfType<T, Dictionary>]?: T[K] extends Dictionary<infer ValueType>
+  [K in ExtractPropertyNamesOfType<T, AnyDictionary>]?: T[K] extends Dictionary<infer ValueType>
     ? { [key: string]: ValueType }
     : never;
 };
 
 /** Omits all properties of a model which are not defined by the schema */
 type OmittedRealmTypes<T> = Omit<
   T,
-  | keyof RealmObject
+  | keyof AnyRealmObject
   /* eslint-disable-next-line @typescript-eslint/ban-types */
   | ExtractPropertyNamesOfType<T, Function> // TODO: Figure out the use-case for this
-  | ExtractPropertyNamesOfType<T, Collection>
-  | ExtractPropertyNamesOfType<T, Dictionary>
+  | ExtractPropertyNamesOfType<T, AnyCollection>
+  | ExtractPropertyNamesOfType<T, AnyDictionary>
 >;
 
 /** Remaps realm types to "simpler" types (arrays and objects) */
 type RemappedRealmTypes<T> = RealmListsRemappedModelPart<T> & RealmDictionaryRemappedModelPart<T>;
 
 /**
- * Joins T stripped of all keys which value extends Realm.Collection and all inherited from Realm.Object,
- * with only the keys which value extends Realm.List, remapped as Arrays.
+ * Joins T stripped of all keys which value extends {@link Collection} and all inherited from {@link RealmObject},
+ * with only the keys which value extends {@link List}, remapped as Arrays.
  */
 export type RealmInsertionModel<T> = OmittedRealmTypes<T> & RemappedRealmTypes<T>;

packages/realm/src/List.ts

@@ -18,6 +18,7 @@
 
 import {
   IllegalConstructorError,
+  ObjectSchema,
   OrderedCollection,
   OrderedCollectionHelpers,
   Realm,
@@ -33,9 +34,6 @@ type PartiallyWriteableArray<T> = Pick<Array<T>, "pop" | "push" | "shift" | "uns
  * Lists mostly behave like normal Javascript Arrays, except for that they can
  * only store values of a single type (indicated by the `type` and `optional`
  * properties of the List), and can only be modified inside a {@link Realm.write | write} transaction.
- *
- * @extends Realm.Collection
- * @memberof Realm
  */
 export class List<T = unknown> extends OrderedCollection<T> implements PartiallyWriteableArray<T> {
   /**
@@ -125,7 +123,7 @@ export class List<T = unknown> extends OrderedCollection<T> implements Partially
    *
    * @param items Values to add to the list.
    * @throws {TypeError} If a `value` is not of a type which can be stored in
-   *   the list, or if an object being added to the list does not match the {@link Realm.ObjectSchema} for the list.
+   *   the list, or if an object being added to the list does not match the {@link ObjectSchema} for the list.
    *
    * @throws {@link AssertionError} If not inside a write transaction.
    * @returns A number equal to the new length of

packages/realm/src/Object.ts

@@ -22,14 +22,15 @@ import {
   ClassHelpers,
   Constructor,
   DefaultObject,
+  Dictionary,
   JSONCacheMap,
   ObjectChangeCallback,
   ObjectListeners,
+  OrderedCollection,
   Realm,
   RealmInsertionModel,
   RealmObjectConstructor,
   Results,
-  TypeAssertionError,
   assert,
   binding,
   flags,
@@ -294,11 +295,7 @@ export class RealmObject<T = DefaultObject> {
       if (typeof value == "function") {
         continue;
       }
-      if (
-        value instanceof Realm.Object ||
-        value instanceof Realm.OrderedCollection ||
-        value instanceof Realm.Dictionary
-      ) {
+      if (value instanceof RealmObject || value instanceof OrderedCollection || value instanceof Dictionary) {
         // recursively trigger `toJSON` for Realm instances with the same cache.
         result[key] = value.toJSON(key, cache);
       } else {
@@ -352,7 +349,7 @@ export class RealmObject<T = DefaultObject> {
     assert(collectionHelpers, "collection helpers");
     const tableView = this[INTERNAL].getBacklinkView(tableRef, columnKey);
     const results = binding.Results.fromTableView(this[REALM].internal, tableView);
-    return new Realm.Results(this[REALM], results, collectionHelpers);
+    return new Results(this[REALM], results, collectionHelpers);
   }
 
   /**
@@ -480,4 +477,5 @@ export class RealmObject<T = DefaultObject> {
 }
 
 //  We like to refer to this as "Realm.Object"
+// TODO: Determine if we want to revisit this if we're going away from a namespaced API
 Object.defineProperty(RealmObject, "name", { value: "Realm.Object" });