Babel plugin changes

.github/workflows/pr-babel-plugin.yml

@@ -0,0 +1,67 @@
+name: Testing Babel Plugin (Pull Request)
+
+env:
+  REALM_DISABLE_ANALYTICS: 1
+
+on:
+  pull_request:
+    paths:
+      - "*"
+      - "lib/**"
+      - "src/**"
+      - "types/**"
+      - "react-native/**"
+      - "vendor/**"
+      # Integration tests
+      - "integration-tests/**"
+      - "packages/babel-plugin/**"
+      - ".github/workflows/pr-babel-plugin.yml"
+      # No need to run when updating documentation
+      - "!**.md"
+jobs:
+  job:
+    name: Build & test
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+        with:
+          submodules: "recursive"
+
+      - uses: actions/setup-node@v1
+        with:
+          node-version: 16
+          registry-url: https://registry.npmjs.org/
+
+      - name: Install npm v7
+        run: npm install -g npm@8
+
+      # Caches
+      - uses: actions/cache@v2
+        name: cached node_modules
+        id: cache-node-modules
+        with:
+          path: node_modules
+          key: node-modules-${{ github.job }}-${{ hashFiles('package-lock.json') }}
+
+      - name: ccache
+        uses: hendrikmuhs/ccache-action@v1
+        with:
+          key: babel-plugin
+
+      - name: Prepend ccache executables to the PATH
+        run: echo PATH="/usr/lib/ccache:/usr/local/opt/ccache/libexec:$PATH" >> $GITHUB_ENV
+
+      - name: Install realm node dependencies
+        run: npm ci
+
+      - name: Bootstrap @realm/babel-plugin
+        run: npx lerna bootstrap --scope @realm/babel-plugin --include-dependencies
+        env:
+          npm_config_realm_local_prebuilds: ${{ github.workspace }}/prebuilds
+      - name: Build realm react
+        working-directory: packages/babel-plugin
+        run: npm run build
+
+      - name: Run tests
+        working-directory: packages/babel-plugin
+        run: npm run test

.github/workflows/publish-babel-plugin.yml

@@ -0,0 +1,33 @@
+name: Publish Babel Plugin
+
+on:
+  push:
+    tags:
+      - babel-plugin-v*
+env:
+  REALM_DISABLE_ANALYTICS: 1
+
+jobs:
+  test-build-and-publish:
+    name: Test, build & publish
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-node@v1
+        with:
+          node-version: 16
+          registry-url: https://registry.npmjs.org/
+      - name: Install npm v7
+        run: npm install -g npm@8
+      # Install the root package (--ignore-scripts to avoid downloading or building the native module)
+      - run: npm ci --ignore-scripts
+      # Bootstrap lerna sub-packages
+      - run: npx lerna bootstrap
+      # Test the package
+      - run: npm test
+        working-directory: packages/babel-plugin
+      # Publish the package
+      - run: npm publish
+        working-directory: packages/babel-plugin
+        env:
+          NODE_AUTH_TOKEN: ${{secrets.npm_token}}

.vscode/launch.json

@@ -180,6 +180,17 @@
                 "--testNamePattern=${input:testNamePattern}"
             ]
         },
+        {
+            "type": "node",
+            "name": "Node Babel Plugin Tests",
+            "request": "launch",
+            "console": "integratedTerminal",
+            "internalConsoleOptions": "neverOpen",
+            "disableOptimisticBPs": true,
+            "cwd": "${workspaceFolder}/packages/babel-plugin",
+            "runtimeExecutable": "npm",
+            "args": ["run", "test", "--", "--runInBand", "--watchAll=false", "--testNamePattern=${input:testNamePattern}"]
+        },
         {
             "type": "node",
             "request": "launch",

CHANGELOG.md

@@ -28,6 +28,7 @@ Based on Realm JS v10.21.1: See changelog below for details on enhancements and
     ```
 ### Enhancements
 * Small improvement to performance by caching JSI property String object [#4863](https://github.com/realm/realm-js/pull/4863)
+* Added new package `@realm/babel-plugin` to enable definining your Realm models using standard Typescript syntax [#4938](https://github.com/realm/realm-js/pull/4938)
 
 ### Fixed
 * None

integration-tests/tests/src/tests/index.ts

@@ -36,3 +36,4 @@ import "./sync/flexible";
 import "./sync/asymmetric";
 import "./sync/sync-as-local";
 import "./transaction";
+import "./types";

integration-tests/tests/src/tests/types.ts

@@ -0,0 +1,48 @@
+////////////////////////////////////////////////////////////////////////////
+//
+// Copyright 2022 Realm Inc.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+//
+////////////////////////////////////////////////////////////////////////////
+
+import { expect } from "chai";
+import Realm from "realm";
+
+describe("Realm.Types namespace", () => {
+  // We specify explicit types on the instance so TS will error if the type def is wrong
+  it("Realm.Types.Decimal128 can be constructed", () => {
+    const instance: Realm.Types.Decimal128 = new Realm.Types.Decimal128();
+    expect(instance).to.be.instanceOf(Realm.BSON.Decimal128);
+  });
+
+  it("Realm.Types.ObjectId can be constructed", () => {
+    const instance: Realm.Types.ObjectId = new Realm.Types.ObjectId();
+    expect(instance).to.be.instanceOf(Realm.BSON.ObjectId);
+  });
+
+  it("Realm.Types.UUID can be constructed", () => {
+    const instance: Realm.Types.UUID = new Realm.Types.UUID();
+    expect(instance).to.be.instanceOf(Realm.BSON.UUID);
+  });
+
+  it("Realm.Types.Date can be constructed", () => {
+    const instance: Realm.Types.Date = new Realm.Types.Date();
+    expect(instance).to.be.instanceOf(Date);
+  });
+
+  it("Realm.Types.Data can be constructed", () => {
+    const instance: Realm.Types.Data = new Realm.Types.Data();
+    expect(instance).to.be.instanceOf(ArrayBuffer);
+  });
+});

lib/extensions.js

@@ -500,35 +500,32 @@ module.exports = function (realmConstructor) {
     };
   }
 
-  // TODO: Remove this now useless object.
-  var types = Object.freeze({
-    BOOL: "bool",
-    INT: "int",
-    FLOAT: "float",
-    DOUBLE: "double",
-    STRING: "string",
-    DATE: "date",
-    DATA: "data",
-    OBJECT: "object",
-    LIST: "list",
-  });
-  Object.defineProperty(realmConstructor, "Types", {
-    get: function () {
-      if (typeof console != "undefined") {
-        /* eslint-disable no-console */
-        var stack = new Error().stack.split("\n").slice(2).join("\n");
-        var msg = "`Realm.Types` is deprecated! Please specify the type name as lowercase string instead!\n" + stack;
-        if (console.warn != undefined) {
-          console.warn(msg);
-        } else {
-          console.log(msg);
-        }
-        /* eslint-enable no-console */
-      }
-      return types;
-    },
-    configurable: true,
-  });
+  realmConstructor.Types = {
+    Decimal128: realmConstructor.BSON.Decimal128,
+    ObjectId: realmConstructor.BSON.ObjectId,
+    UUID: realmConstructor.BSON.UUID,
+    Date: Date,
+    Data: ArrayBuffer,
+    // These types cannot be constructed, but are re-exported so they can be used for `instanceOf`
+    List: realmConstructor.List,
+    Set: realmConstructor.Set,
+    Dictionary: realmConstructor.Dictionary,
+  };
+
+  // Decorators are not intended to be used at runtime and are removed from the source
+  // by @realm/babel-plugin. Therefore, if a decorator is called, this means it is being
+  // used outside of @realm/babel-plugin (or the plugin is incorrectly configured), so
+  // we should throw
+  function handleDecoratorCall(decoratorName) {
+    return function () {
+      throw new Error(
+        `The @${decoratorName} decorator cannot be used without the \`@realm/babel-plugin\` Babel plugin. Please check that you have installed and configured the Babel plugin.`,
+      );
+    };
+  }
+
+  realmConstructor.index = handleDecoratorCall("index");
+  realmConstructor.mapTo = handleDecoratorCall("mapTo");
 
   if (!realmConstructor.JsonSerializationReplacer) {
     Object.defineProperty(realmConstructor, "JsonSerializationReplacer", {

packages/babel-plugin/.gitignore

@@ -0,0 +1,2 @@
+dist
+types/generated/