Product
Introducing SSO
Streamline your login process and enhance security by enabling Single Sign-On (SSO) on the Socket platform, now available for all customers on the Enterprise plan, supporting 20+ identity providers.
@ark7/model-mongoose
Advanced tools
Readme
@ark7/model-mongoose is a mongodb adaptor for @ark7/model.
Install the dependencies package:
$ npm install @ark7/model-mongoose
Add transform plugin to tsconfig.json:
// tsconfig.json
{
...
"plugins": [{
"transform": "@ark7/model/transformer"
}],
}
// models/names.ts
import { A7Model, StrictModel } from '@ark7/model';
import { Validate } from '@ark7/model-mongoose';
@A7Model({})
export class Name extends StrictModel {
@Validate({ minlength: 5 })
first: string;
middle?: string;
last: string;
get fullname(): string {
return this.first + ' ' + this.last;
}
greeting(): string {
return `Hello, ${this.fullname}`;
}
}
// models/users.ts
import { A7Model, Model, Ref } from '@ark7/model';
import { Name } from './names';
import { Post } from './posts';
@A7Model({})
export class User extends Model {
name: Name;
posts: Ref<Post>[];
}
// models/posts.ts
import { A7Model, Model, Ref } from '@ark7/model';
import { User } from './users';
@A7Model({})
export class Post extends Model {
topic: string;
author: Ref<User>;
}
// db.ts
import { mongooseManager } from '@ark7/model-mongoose';
import * as models from './models';
export namespace db {
export const User = mongooseManager.register(models.User);
export type User = models.User;
export const Post = mongooseManager.register(models.Post);
export type Post = models.Post;
}
Set mongoose configurations like
collection name
, capped
, etc.
// db.ts
import { mongooseManager } from '@ark7/model-mongoose';
import * as models from './models';
export const User = mongooseManager.register(models.User, {
collection: 'users',
});
export type User = models.User;
const x = await db.User.create({
name: {
first: 'fff',
last: 'wang',
},
posts: [],
});
x.name.fullname.should.be.equals('fff wang');
const y = await db.User.findById(x._id);
y.name.fullname.should.be.equals('fff wang');
@A7Model({})
export class BasicDefaultModel {
@Default('foo') foo?: string;
}
@A7Model({})
export class User {
@Unique()
email: string;
// Sometimes the field is optional.
@Unique({ sparse: true })
token: string;
// If the field is not unique.
@Index()
name: string;
}
@A7Model({})
@CompoundIndex({ user: 1, date: 1 }, { unique: true })
export class Order {
user: Ref<User>;
date: Date;
}
// models/base.ts
class BaseModel {
createdAt?: Date;
lastUpdateTime?: Date;
}
// models/users.ts
@A7Model({})
export class User extends BaseModel {
name: Name;
}
// db.ts
import { mongooseManager } from '@ark7/model-mongoose';
import {
createdAtPlugin,
lastUpdateTimePlugin,
} from '@ark7/model-mongoose/plugins/timestamps';
import { User as _User } from './models';
mongooseManager.plugin(MongoosePluginPeriod.BEFORE_REGISTER, createdAtPlugin());
mongooseManager.plugin(
MongoosePluginPeriod.BEFORE_REGISTER,
lastUpdateTimePlugin(),
);
export namespace db {
export const User = mongooseManager.register<_User>(_User);
export type User = _User;
}
@ark7/model
supports to have multi-tenancies living in the same database. For
example, separating production, staging, and sandbox, environment.
import { mongooseManager } from '@ark7/model-mongoose';
mongooseManager.set('multiTenancy', {
enabled: true,
tenants: ['test', 'staging', 'sandbox'],
tenancyFn: getTenancy,
uris: 'mongodb://localhost:27017',
defaultCollectionNamespace: 'public',
});
FAQs
Type-script friendly, object-oriented, database modeling framework
The npm package @ark7/model-mongoose receives a total of 97 weekly downloads. As such, @ark7/model-mongoose popularity was classified as not popular.
We found that @ark7/model-mongoose demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Product
Streamline your login process and enhance security by enabling Single Sign-On (SSO) on the Socket platform, now available for all customers on the Enterprise plan, supporting 20+ identity providers.
Security News
Tea.xyz, a crypto project aimed at rewarding open source contributions, is once again facing backlash due to an influx of spam packages flooding public package registries.
Security News
As cyber threats become more autonomous, AI-powered defenses are crucial for businesses to stay ahead of attackers who can exploit software vulnerabilities at scale.