feat(mongoose): add one to one relation

docs/datasources/provided/orm/mongoose.md

@@ -0,0 +1,28 @@
+The sequelize data source allows to import collections from a sequelize instance.
+
+Note that:
+
+- Sequelize scopes will be mapped to Forest Admin segments
+- Sequelize hooks will run
+- Sequelize association, field aliasing, relationships and validation will be respected
+
+```javascript
+const { createAgent } = require('@forestadmin/agent');
+const { createSequelizeDataSource } = require('@forestadmin/datasource-sequelize');
+const { Sequelize, Model, DataTypes } = require('@sequelize/core');
+
+// Create a sequelize instance
+const sequelize = new Sequelize('sqlite::memory:');
+
+class User extends Model {}
+User.init(
+  {
+    username: DataTypes.STRING,
+    birthday: DataTypes.DATE,
+  },
+  { sequelize, modelName: 'user' },
+);
+
+// Create agent and import collections from sequelize
+const agent = createAgent(options).addDataSource(createSequelizeDataSource(sequelize));
+```

packages/_example/scripts/db-seed.ts

@@ -39,6 +39,7 @@ async function createReviewRecords(connection: Connection, storeRecords: any[]):
   for (let i = 0; i < 30; i += 1) {
     reviewsRecords.push({
       title: faker.word.adjective(),
+      rating: faker.datatype.number({ min: 1, max: 5 }),
       message: faker.lorem.paragraphs(1),
       storeId: faker.helpers.randomize(storeRecords.map(({ id }) => id)),
     });

packages/_example/src/agent.ts

@@ -30,7 +30,7 @@ export default async function makeAgent(options: AgentOptions) {
     .addDataSource(createSequelizeDataSource(sequelizePostgres))
     .addDataSource(createSequelizeDataSource(sequelizeMySql))
     .addDataSource(createSequelizeDataSource(sequelizeMsSql))
-    .addDataSource(createMongooseDataSource(mongoose))
+    .addDataSource(createMongooseDataSource(mongoose, ['review:rating']))
 
     .addChart('numRentals', async (context, resultBuilder) => {
       const rentals = context.dataSource.getCollection('rental');

packages/_example/src/datasources/mongoose/mongodb.ts

@@ -1,4 +1,4 @@
-import mongoose from 'mongoose';
+import mongoose, { Schema } from 'mongoose';
 
 const connectionString = 'mongodb://root:password@localhost:27017';
 const connection = mongoose.createConnection(connectionString);
@@ -13,10 +13,33 @@ connection.model(
     message: {
       type: String,
     },
+    rating: {
+      type: Number,
+    },
     storeId: {
       type: Number,
       required: true,
     },
+    testArrayIds: {
+      type: [Number],
+    },
+    ownerIds: {
+      type: [mongoose.Schema.Types.ObjectId],
+      ref: 'ownerMongo',
+    },
+    oldOwnerIds: {
+      type: [mongoose.Schema.Types.ObjectId],
+      ref: 'ownerMongo',
+    },
+  }),
+);
+
+connection.model(
+  'ownerMongo',
+  new Schema({
+    name: {
+      type: String,
+    },
   }),
 );
 

packages/_example/src/typings.ts

@@ -157,6 +157,14 @@ export type Schema = {
     nested: {};
     flat: {};
   };
+  ownerMongo: {
+    plain: {
+      name: string;
+      _id: string;
+    };
+    nested: {};
+    flat: {};
+  };
   post: {
     plain: {
       id: number;
@@ -199,12 +207,18 @@ export type Schema = {
       title: string;
       message: string;
       storeId: number;
+      testArrayIds: Array<number>;
+      ownerIds: string;
+      oldOwnerIds: string;
       _id: string;
     };
     nested: {
+      rating__review__oneToOne: Schema['review__rating']['plain'] & Schema['review__rating']['nested'];
       store: Schema['store']['plain'] & Schema['store']['nested'];
     };
     flat: {
+      'rating__review__oneToOne:_id': string;
+      'rating__review__oneToOne:rating': number;
       'store:id': number;
       'store:name': string;
       'store:ownerId': number;
@@ -221,6 +235,88 @@ export type Schema = {
       'store:address:updatedAt': string;
     };
   };
+  review__ownerMongo__oldOwnerIds: {
+    plain: {
+      review_id: string;
+      ownerMongo_id: string;
+    };
+    nested: {
+      review_id__oldOwnerIds__manyToOne: Schema['review']['plain'] & Schema['review']['nested'];
+      ownerMongo_id__oldOwnerIds__manyToOne: Schema['ownerMongo']['plain'] & Schema['ownerMongo']['nested'];
+    };
+    flat: {
+      'review_id__oldOwnerIds__manyToOne:title': string;
+      'review_id__oldOwnerIds__manyToOne:message': string;
+      'review_id__oldOwnerIds__manyToOne:storeId': number;
+      'review_id__oldOwnerIds__manyToOne:testArrayIds': Array<number>;
+      'review_id__oldOwnerIds__manyToOne:ownerIds': string;
+      'review_id__oldOwnerIds__manyToOne:oldOwnerIds': string;
+      'review_id__oldOwnerIds__manyToOne:_id': string;
+      'review_id__oldOwnerIds__manyToOne:rating__review__oneToOne:_id': string;
+      'review_id__oldOwnerIds__manyToOne:rating__review__oneToOne:rating': number;
+      'review_id__oldOwnerIds__manyToOne:store:id': number;
+      'review_id__oldOwnerIds__manyToOne:store:name': string;
+      'review_id__oldOwnerIds__manyToOne:store:ownerId': number;
+      'review_id__oldOwnerIds__manyToOne:store:ownerFullName': string;
+      'review_id__oldOwnerIds__manyToOne:store:owner:id': number;
+      'review_id__oldOwnerIds__manyToOne:store:owner:firstName': string;
+      'review_id__oldOwnerIds__manyToOne:store:owner:lastName': string;
+      'review_id__oldOwnerIds__manyToOne:store:owner:fullName': string;
+      'review_id__oldOwnerIds__manyToOne:store:address:id': number;
+      'review_id__oldOwnerIds__manyToOne:store:address:zipCode': string;
+      'review_id__oldOwnerIds__manyToOne:store:address:address': string;
+      'review_id__oldOwnerIds__manyToOne:store:address:storeId': number;
+      'review_id__oldOwnerIds__manyToOne:store:address:createdAt': string;
+      'review_id__oldOwnerIds__manyToOne:store:address:updatedAt': string;
+      'ownerMongo_id__oldOwnerIds__manyToOne:name': string;
+      'ownerMongo_id__oldOwnerIds__manyToOne:_id': string;
+    };
+  };
+  review__ownerMongo__ownerIds: {
+    plain: {
+      review_id: string;
+      ownerMongo_id: string;
+    };
+    nested: {
+      review_id__ownerIds__manyToOne: Schema['review']['plain'] & Schema['review']['nested'];
+      ownerMongo_id__ownerIds__manyToOne: Schema['ownerMongo']['plain'] & Schema['ownerMongo']['nested'];
+    };
+    flat: {
+      'review_id__ownerIds__manyToOne:title': string;
+      'review_id__ownerIds__manyToOne:message': string;
+      'review_id__ownerIds__manyToOne:storeId': number;
+      'review_id__ownerIds__manyToOne:testArrayIds': Array<number>;
+      'review_id__ownerIds__manyToOne:ownerIds': string;
+      'review_id__ownerIds__manyToOne:oldOwnerIds': string;
+      'review_id__ownerIds__manyToOne:_id': string;
+      'review_id__ownerIds__manyToOne:rating__review__oneToOne:_id': string;
+      'review_id__ownerIds__manyToOne:rating__review__oneToOne:rating': number;
+      'review_id__ownerIds__manyToOne:store:id': number;
+      'review_id__ownerIds__manyToOne:store:name': string;
+      'review_id__ownerIds__manyToOne:store:ownerId': number;
+      'review_id__ownerIds__manyToOne:store:ownerFullName': string;
+      'review_id__ownerIds__manyToOne:store:owner:id': number;
+      'review_id__ownerIds__manyToOne:store:owner:firstName': string;
+      'review_id__ownerIds__manyToOne:store:owner:lastName': string;
+      'review_id__ownerIds__manyToOne:store:owner:fullName': string;
+      'review_id__ownerIds__manyToOne:store:address:id': number;
+      'review_id__ownerIds__manyToOne:store:address:zipCode': string;
+      'review_id__ownerIds__manyToOne:store:address:address': string;
+      'review_id__ownerIds__manyToOne:store:address:storeId': number;
+      'review_id__ownerIds__manyToOne:store:address:createdAt': string;
+      'review_id__ownerIds__manyToOne:store:address:updatedAt': string;
+      'ownerMongo_id__ownerIds__manyToOne:name': string;
+      'ownerMongo_id__ownerIds__manyToOne:_id': string;
+    };
+  };
+  review__rating: {
+    plain: {
+      _id: string;
+      rating: number;
+    };
+    nested: {};
+    flat: {};
+  };
   store: {
     plain: {
       id: number;

packages/datasource-mongoose/package.json

@@ -9,7 +9,8 @@
   ],
   "dependencies": {
     "@forestadmin/datasource-toolkit": "1.0.0-beta.16",
-    "mongoose": "^6.3.2"
+    "mongoose": "^6.3.2",
+    "luxon": "^2.3.0"
   },
   "peerDependencies": {},
   "scripts": {