fix isEmpty check to ignore ObjectId

Author: eric-burel

docusaurus/docs/vulcan-fire/mongo.md

@@ -17,10 +17,16 @@ Vulcan Next already does it for you in the `api/graphql` API route.
 
 - Use `GraphqlObjectId` as the `typeName` for every unique identifier in your schemas.
 
+Server to client: this is not strictly needed when queriying document, because ObjectId will serialize to String anyway.
+Client to server: this is needed when filtering or when mutating document, the scalar will convert the string back to an `ObjectId`,
+which is necessary for your search queries or your mutations to work correctly
+
 **If you encounter issues with filtering**, you might have forgotten to add this `typeName`.
 
 Example:
 ```js
+import { GraphqlObjectId } from "@vulcanjs/mongo-apollo"
+...
   schema: {
     _id: {
       type: String,

packages/mongo-apollo/graphqlObjectId.ts

@@ -0,0 +1,10 @@
+/**
+ * GraphQL type for a Mongo ObjectId
+ *
+ * Use as "typeName" in your Vulcan schema for _id, userId, or any field with relations via ids
+ */
+export const GraphQLObjectIdTypeName = "GraphQLObjectId";
+/**
+ * Alias for GraphQLObjectId
+ */
+export const MongoId = GraphQLObjectIdTypeName;

packages/mongo-apollo/index.ts

@@ -1,4 +1 @@
-export * from "./addDefaultMongoConnector";
-export * from "./createMongooseDataSource";
-
-export * from "./objectIdScalar";
+export * from "./graphqlObjectId";

packages/mongo-apollo/package.json

@@ -8,9 +8,17 @@
   ],
   "type": "module",
   "exports": {
-    ".": "./dist/index.js"
+    ".": "./dist/index.js",
+    "./server": "./dist/server/index.js"
   },
   "types": "./dist/index.d.ts",
+  "typesVersions": {
+    "*": {
+      "server": [
+        "./dist/server/index.d.ts"
+      ]
+    }
+  },
   "author": "eric-burel <[email protected]>",
   "homepage": "https://github.com/VulcanJS/vulcan-npm#readme",
   "license": "MIT",

packages/mongo-apollo/addDefaultMongoConnector.ts packages/mongo-apollo/server/addDefaultMongoConnector.ts

@@ -0,0 +1,4 @@
+export * from "./addDefaultMongoConnector";
+export * from "./createMongooseDataSource";
+
+export * from "./objectIdScalar";

packages/mongo-apollo/createMongooseDataSource.ts packages/mongo-apollo/server/createMongooseDataSource.ts

@@ -1,26 +1,20 @@
 // @see https://github.com/CaptorAB/graphql-objectid-scalar
 import { GraphQLObjectId } from "graphql-objectid-scalar";
-
-/**
- * GraphQL type for a Mongo ObjectId
- *
- * Use as "typeName" in your Vulcan schema for _id, userId, or any field with relations via ids
- */
-export const GraphqlObjectId = "GraphQLObjectId";
+import { GraphQLObjectIdTypeName } from "../graphqlObjectId";
 
 /**
  * NOTE: the type is ObjectID to be consistent with GraphQL "ID" type
  * Be careful with the casing
  */
 export const objectIdTypeDefs = `
-scalar ${GraphqlObjectId}
+scalar ${GraphQLObjectIdTypeName}
 
 # Inspired by the String_Selector
 input GraphQLObjectId_Selector {
-  _eq: ${GraphQLObjectId}
-  _in: [${GraphQLObjectId}!]
+  _eq: ${GraphQLObjectIdTypeName}
+  _in: [${GraphQLObjectIdTypeName}!]
   _is_null: Boolean
-  _neq: ${GraphqlObjectId}
+  _neq: ${GraphQLObjectIdTypeName}
 }
 `;
 

packages/mongo-apollo/server/index.ts

@@ -10,6 +10,13 @@ const commonConfig = {
   tsconfig: path.resolve(__dirname, "./tsconfig.build.json"),
 };
 export default defineConfig([
+  {
+    entry: ["server/index.ts"],
+    ...commonConfig,
+    // NOTE: it means CJS will be .js and ESM will be .mjs
+    format: ["esm"],
+    outDir: "dist/server",
+  },
   {
     entry: ["index.ts"],
     ...commonConfig,

packages/mongo-apollo/objectIdScalar.ts packages/mongo-apollo/server/objectIdScalar.ts

@@ -356,4 +356,6 @@ export const isEmptyOrUndefined = (value) =>
   typeof value === "undefined" ||
   value === null ||
   value === "" ||
-  (typeof value === "object" && isEmpty(value) && !(value instanceof Date));
+  (typeof value === "object" &&
+    isEmpty(value) &&
+    !String(value.constructor).match("Object()"));

packages/mongo-apollo/tsup.config.ts

@@ -6,7 +6,7 @@ const models = [User, SampleModel];
 
 // Add default connectors and dataSources creators for models that may miss some
 // @see https://www.apollographql.com/docs/apollo-server/data/data-sources
-import { addDefaultMongoConnector } from "@vulcanjs/mongo-apollo";
+import { addDefaultMongoConnector } from "@vulcanjs/mongo-apollo/server";
 addDefaultMongoConnector(models);
 
 export default models;

packages/utils/string.ts

@@ -25,7 +25,10 @@ import { connectToAppDbMiddleware } from "~/core/server/middlewares/mongoAppConn
  * You may remove it if you prefer string ids (as Meteor does)
  * @see https://stackoverflow.com/questions/27896979/difference-between-storing-an-objectid-and-its-string-form-in-mongodb
  */
-import { objectIdTypeDefs, objectIdResolvers } from "@vulcanjs/mongo-apollo";
+import {
+  objectIdTypeDefs,
+  objectIdResolvers,
+} from "@vulcanjs/mongo-apollo/server";
 
 /**
  * Generate basic CRUD resolvers with Vulcan Fire

starters/next/src/core/models.server.ts

@@ -54,7 +54,10 @@ export default function CrudPage({ modelName }) {
   const model = getCurrentModel(modelName);
 
   // Read
-  const documentsRawResult = useMulti({ model });
+  const documentsRawResult = useMulti<any>({
+    model,
+    //input: { filter: { _id: { _eq: "" } } },
+  });
   const documentsResult = documentsRawResult.documents || [];
 
   // Select
@@ -100,7 +103,7 @@ export default function CrudPage({ modelName }) {
         {
           <List>
             {documentsResult.map((document) => (
-              <ListItem key={document.id}>
+              <ListItem key={document._id}>
                 <ItemCard document={document} model={model} />
               </ListItem>
             ))}

starters/next/src/pages/api/graphql.ts

@@ -9,17 +9,20 @@ import {
   VulcanGraphqlSchema,
 } from "@vulcanjs/graphql";
 import { User } from "~/account/models/user";
+import { MongoId } from "@vulcanjs/mongo-apollo";
 
 export const schema: VulcanGraphqlSchema = {
   /** Unique id of the document in the database. You'll want to leave this field as is. */
   _id: {
+    typeName: MongoId,
     type: String,
     optional: true,
     canRead: ["guests", "anyone"],
   },
   /** _id of the user that created the document. This special field is used to handle the "ownership" of the document. */
   userId: {
     type: String,
+    typeName: MongoId,
     optional: true,
     canRead: ["guests", "anyone"],
     // This means you can resolve the "user" field when fetching for "samples"
@@ -54,6 +57,7 @@ export const schema: VulcanGraphqlSchema = {
   // this may make data fetching easier in the frontend (the client can know the relation)
   demoRelationFieldUserId: {
     type: String,
+    typeName: MongoId,
     optional: true,
     relation: {
       fieldName: "resolvedFieldFromRelation",

starters/next/src/pages/vn/admin/crud/[modelName].tsx

@@ -15,7 +15,7 @@ import { MongoMemoryServer } from "mongodb-memory-server"; // @see https://githu
 import { buildDefaultQueryResolvers } from "@vulcanjs/graphql/server";
 import { createGraphqlModelServer } from "@vulcanjs/graphql/server";
 import { createMongooseConnector } from "@vulcanjs/mongo";
-import { GraphqlObjectId } from "../../../packages/mongo-apollo";
+import { MongoId } from "@vulcanjs/mongo-apollo";
 import { makeApolloServer } from "./utils/server";
 
 // Init an in-memory Mongo server
@@ -45,7 +45,7 @@ const Contributor = createGraphqlModelServer({
   schema: {
     _id: {
       type: String,
-      typeName: GraphqlObjectId,
+      typeName: MongoId,
       optional: true,
       canRead: ["anyone"],
       canCreate: ["anyone"],
@@ -78,7 +78,7 @@ const Repository = createGraphqlModelServer({
   schema: {
     _id: {
       type: String,
-      typeName: GraphqlObjectId,
+      typeName: MongoId,
       optional: true,
       canRead: ["anyone"],
       canCreate: ["anyone"],
@@ -87,6 +87,7 @@ const Repository = createGraphqlModelServer({
     },
     userId: {
       type: String,
+      typeName: MongoId,
       optional: true,
       canRead: ["anyone"],
     },
@@ -100,7 +101,7 @@ const Repository = createGraphqlModelServer({
     },
     contributorId: {
       type: String,
-      typeName: GraphqlObjectId,
+      typeName: MongoId,
       // You will be able to query the "contributor" field of any "repository" object
       relation: {
         fieldName: "contributor",

starters/next/src/vulcan-demo/models/sampleModel.ts

@@ -9,7 +9,10 @@ import { contextFromReq } from "./context";
 import { ApolloServer } from "apollo-server-express";
 
 import { mergeResolvers, mergeTypeDefs } from "@graphql-tools/merge";
-import { objectIdTypeDefs, objectIdResolvers } from "@vulcanjs/mongo-apollo";
+import {
+  objectIdTypeDefs,
+  objectIdResolvers,
+} from "@vulcanjs/mongo-apollo/server";
 
 // Demo Apollo server
 export const makeApolloServer = async (models: Array<VulcanGraphqlModel>) => {

test/integration/server/filtering.test.ts

@@ -15,6 +15,7 @@ module.exports = {
     "packages/mongo/index.ts",
     "packages/mongo/client/index.ts",
     "packages/mongo-apollo/index.ts",
+    "packages/mongo-apollo/server/index.ts",
     "packages/permissions/index.ts",
     "packages/react-hooks/index.ts",
     "packages/react-i18n/index.ts",