@realm/babel-plugin/src/plugin/import-checking.ts

Babel plugin making it easier to declare your Realm schema

////////////////////////////////////////////////////////////////////////////
//
// 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 { types, NodePath } from "@babel/core";

// TODO: Merge the functions below into the functions above

export function isImportedFromRealm(path: NodePath<types.Node>): boolean {
  if (path.isMemberExpression()) {
    return isImportedFromRealm(path.get("object"));
  } else if (path.isTSQualifiedName()) {
    return isImportedFromRealm(path.get("left"));
  } else if (path.isDecorator() && types.isMemberExpression(path.get("expression"))) {
    // Handle decorators with Realm namespace like `@Realm.index`
    return isImportedFromRealm(path.get("expression"));
  } else if (
    path.isDecorator() &&
    types.isCallExpression(path.get("expression")) &&
    types.isMemberExpression(path.get("expression").get("callee"))
  ) {
    // Handle called decorators with Realm namespace like `@Realm.mapTo('xxx')`
    return isImportedFromRealm((path.get("expression") as NodePath<types.CallExpression>).get("callee"));
  } else if (path.isIdentifier() || path.isDecorator()) {
    const node = path.isDecorator()
      ? types.isCallExpression(path.node.expression)
        ? path.node.expression.callee
        : path.node.expression
      : path.node;
    if (!types.isIdentifier(node)) return false;

    const binding = path.scope.getBinding(node.name);

    if (binding && binding.path.parentPath && binding.path.parentPath.isImportDeclaration()) {
      return (
        binding.path.parentPath.get("source").isStringLiteral({ value: "realm" }) ||
        binding.path.parentPath.get("source").isStringLiteral({ value: "@realm/react" })
      );
    }
  }
  return false;
}

export function isPropertyImportedFromRealm(path: NodePath<types.Node>, name: string): boolean {
  if (path.isMemberExpression()) {
    return isImportedFromRealm(path.get("object")) && path.get("property").isIdentifier({ name });
  }
  return false;
}