Add Resource.js typings

types/resourcejs/index.d.ts

@@ -0,0 +1,106 @@
+// Type definitions for resourcejs 1.9
+// Project: https://github.com/travist/resourcejs
+// Definitions by: Shaun Luttin <https://github.com/shaunluttin>
+// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
+// TypeScript Version: 2.2
+
+import express = require("express");
+import mongoose = require("mongoose");
+
+export = resourcejs;
+
+declare function resourcejs(
+    app: express.Application,
+    route: string,
+    modelName: string,
+    model: mongoose.Model<mongoose.Document>): resourcejs.ResourceEndpoint;
+
+declare namespace resourcejs {
+    type HttpHandler = (req: Request, res: Response, next: express.NextFunction) => void;
+
+    type MethodBuild<T> = (options?: T) => ResourceEndpoint;
+
+    interface RestOptions extends HttpMethodOptions {
+        beforePut?: HttpHandler;
+        beforePatch?: HttpHandler;
+        beforePost?: HttpHandler;
+        beforeIndex?: HttpHandler;
+        beforeGet?: HttpHandler;
+        afterPut?: HttpHandler;
+        afterPatch?: HttpHandler;
+        afterPost?: HttpHandler;
+        afterIndex?: HttpHandler;
+        afterGet?: HttpHandler;
+    }
+
+    interface VirtualOptions extends HttpMethodOptions {
+        path?: string;
+    }
+
+    interface HttpMethodOptions {
+        before?: HttpHandler;
+        after?: HttpHandler;
+    }
+
+    /**
+     * We manually generated this interface by looking an resource like this:
+     * const resource = Resource(app, route, name, model);
+     * console.log(resource);
+     */
+    interface ResourceEndpoint {
+        model: mongoose.Model<mongoose.Document>;
+        modelName: string;
+        name: string;
+        route: string;
+        methods: string[];
+        __swagger: any;
+        register: (
+            app: express.Application,
+            method: string,
+            path: string,
+            callback: (...args: any[]) => any,
+            last: (...args: any[]) => any,
+            options: object) => any;
+
+        respond: HttpHandler;
+        setResponse: HttpHandler;
+        getMethodOptions: (method: string, options: object) => object;
+        rest: MethodBuild<RestOptions>;
+        getParamQuery: (req: Request, name: string) => any;
+        getFindQuery: (req: Request) => object;
+        index: MethodBuild<HttpMethodOptions>;
+        get: MethodBuild<HttpMethodOptions>;
+        virtual: MethodBuild<VirtualOptions>;
+        post: MethodBuild<HttpMethodOptions>;
+        put: MethodBuild<HttpMethodOptions>;
+        patch: MethodBuild<HttpMethodOptions>;
+        delete: MethodBuild<HttpMethodOptions>;
+        swagger: MethodBuild<HttpMethodOptions>;
+    }
+
+    interface Request extends express.Request {
+        skipResource: boolean;
+        noResponse: boolean;
+        query: any;
+        countQuery: any;
+        modelQuery: any;
+        skipDelete: boolean;
+    }
+
+    interface Response extends express.Response {
+        resource: Resource;
+    }
+
+    interface Resource {
+        status: number;
+        error: Error;
+        item: mongoose.Document | mongoose.Document[];
+    }
+
+    interface Error {
+        message: string;
+        path: string;
+        name: string;
+        errors: Error[];
+    }
+}

types/resourcejs/resourcejs-tests.ts

@@ -0,0 +1,19 @@
+import express = require("express");
+import resourcejs = require("resourcejs");
+import mongoose = require("mongoose");
+
+const app = express();
+const route = "the-route";
+const resourceName = "the-resource-name";
+
+const schema = new mongoose.Schema({});
+const model = mongoose.model(resourceName, schema);
+
+resourcejs(app, route, resourceName, model)
+    .get()
+    .post()
+    .delete()
+    .put()
+    .patch()
+    .index()
+    .rest();

types/resourcejs/tsconfig.json

@@ -0,0 +1,23 @@
+{
+    "compilerOptions": {
+        "module": "commonjs",
+        "lib": [
+            "es6"
+        ],
+        "noImplicitAny": true,
+        "noImplicitThis": true,
+        "strictNullChecks": true,
+        "strictFunctionTypes": true,
+        "baseUrl": "../",
+        "typeRoots": [
+            "../"
+        ],
+        "types": [],
+        "noEmit": true,
+        "forceConsistentCasingInFileNames": true
+    },
+    "files": [                         
+        "index.d.ts",                  
+        "resourcejs-tests.ts"
+    ]                           
+}

types/resourcejs/tslint.json

@@ -0,0 +1,3 @@
+{
+    "extends": "dtslint/dt.json"
+}