From c404aa6f7bb825b5385b554b66a3e2c861bd7175 Mon Sep 17 00:00:00 2001
From: linusbrolin <linus.b@gmail.com>
Date: Wed, 14 Sep 2016 14:46:59 +0200
Subject: [PATCH] Added typings for the mongoose-sequence plugin (#11201)

---
 mongoose-sequence/mongoose-sequence-tests.ts | 52 ++++++++++++++++++++
 mongoose-sequence/mongoose-sequence.d.ts     | 36 ++++++++++++++
 2 files changed, 88 insertions(+)
 create mode 100644 mongoose-sequence/mongoose-sequence-tests.ts
 create mode 100644 mongoose-sequence/mongoose-sequence.d.ts

diff --git a/mongoose-sequence/mongoose-sequence-tests.ts b/mongoose-sequence/mongoose-sequence-tests.ts
new file mode 100644
index 0000000000..7962afeeb4
--- /dev/null
+++ b/mongoose-sequence/mongoose-sequence-tests.ts
@@ -0,0 +1,52 @@
+/// <reference path="./mongoose-sequence.d.ts" />
+/// <reference path="../mongoose/mongoose.d.ts" />
+/// <reference path="../express/express.d.ts" />
+
+/**
+ * Based on the examples on: https://github.com/ramiel/mongoose-sequence
+ * Created by Linus Brolin <https://github.com/linusbrolin/>.
+ */
+
+import { SequenceDocument, SequenceOptions, SequenceSchema, Document, Schema, Model, model } from 'mongoose';
+import * as mongooseSequence from 'mongoose-sequence';
+
+//#region Test Models
+interface User extends SequenceDocument {
+    name: string;
+    country: string;
+    city: string;
+    inhabitant_number: number;
+}
+
+const UserSchema: SequenceSchema = new Schema({
+    name: String,
+    country: String,
+    city: String,
+    inhabitant_number: Number
+});
+
+let seqOpts: SequenceOptions = { id: 'inhabitant_seq', inc_field: 'inhabitant_number', reference_fields: ['country', 'city'] };
+UserSchema.plugin(mongooseSequence, seqOpts);
+
+let UserModel: Model<User> = model<User>('User', UserSchema);
+//#endregion
+
+//#region Test Sequence
+let user: User = new UserModel({
+    name: 'Patrice',
+    country: 'France',
+    city: 'Paris'
+});
+user.save();
+console.log(user.inhabitant_number);
+
+user.setNext('inhabitant_seq', function(err: any, user: User) {
+    if (err) {
+        console.log(err);
+        return;
+    }
+    if (user) {
+        console.log(user.inhabitant_number);
+    }
+});
+//#endregion
diff --git a/mongoose-sequence/mongoose-sequence.d.ts b/mongoose-sequence/mongoose-sequence.d.ts
new file mode 100644
index 0000000000..b0dec033bd
--- /dev/null
+++ b/mongoose-sequence/mongoose-sequence.d.ts
@@ -0,0 +1,36 @@
+// Type definitions for mongoose-sequence 3.0.2
+// Project: https://github.com/ramiel/mongoose-sequence
+// Definitions by: Linus Brolin <https://github.com/linusbrolin/>
+// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
+
+/// <reference path="../mongoose/mongoose.d.ts" />
+
+declare module 'mongoose' {
+  export interface SequenceOptions {
+    inc_field: string;                  // The name of the field to increment. Mandatory, default is _id
+    id?: string;                        // Id of the sequence. Is mandatory only for scoped sequences but its use is strongly encouraged.
+    reference_fields?: Array<string>;   // The field to reference for a scoped counter. Optional
+    disable_hooks?: boolean;            // If true, the counter will not be incremented on saving a new document. Default to false
+    collection_name?: string;           // By default the collection name to mantain the status of the counters is counters. You can override it using this option
+  }
+
+  export interface SequenceDocument extends Document {
+    setNext(sequenceId: string, callback: (err: any, res: SequenceDocument) => void): void;
+  }
+
+  export interface SequenceSchema extends Schema {
+    plugin(
+      plugin: (schema: SequenceSchema, options: SequenceOptions) => void,
+      options: SequenceOptions
+    ): this;
+
+    // overload for the default mongoose plugin function
+    plugin(plugin: (schema: Schema, options?: Object) => void, opts?: Object): this;
+  }
+}
+
+declare module 'mongoose-sequence' {
+  import mongoose = require('mongoose');
+  var _: (schema: mongoose.Schema, options?: Object) => void;
+  export = _;
+}