functions & schema

package.json

@@ -6,7 +6,7 @@
   "types": "dist/index.d.ts",
   "repository": "https://github.com/akgurjar/express-api.git",
   "author": "Ashish Gurjar <[email protected]>",
-  "license": "GNU",
+  "license": "GPL-3.0",
   "private": false,
   "scripts": {
     "start": "webpack-dev-server",

src/helpers/parser.ts

@@ -0,0 +1,16 @@
+
+/**
+ * @name parse
+ */
+export function parse() {
+	// TO DO
+	return '';
+}
+
+/**
+ * @name stringify
+ */
+export function stringify(): string {
+	// TO DO
+	return '';
+}

src/index.ts

@@ -1,2 +1,3 @@
 
-export * from './lib/index';
+// export * from './lib/index';
+import { body } from './lib/index';

src/lib/functions/index.ts

@@ -0,0 +1,27 @@
+import {
+	BodyLocation,
+	QueryLocation,
+	ParamLocation,
+	HeaderLocation,
+	CookieLocation,
+	MethodLocation,
+} from '../locations/index';
+
+export function body(field: string) {
+	return new BodyLocation(field);
+}
+export function query(field: string) {
+	return new QueryLocation(field);
+}
+export function param(field: string) {
+	return new ParamLocation(field);
+}
+export function header(field: string) {
+	return new HeaderLocation(field);
+}
+export function cookie(field: string) {
+	return new CookieLocation(field);
+}
+export function method(field: string) {
+	return new MethodLocation(field);
+}

src/lib/index.ts

@@ -1,3 +1,4 @@
 
-// import { body } from './impl/index';
-
+export * from './types/index';
+export * from './locations/index';
+export * from './functions/index';

src/lib/locations/base.location.ts

@@ -0,0 +1,45 @@
+import { AnyType } from '../types/any.type';
+import { StringType } from '../types/string.type';
+import { NumberType } from '../types/number.type';
+import { ArrayType } from '../types/array.type';
+import { ObjectType } from '../types/object.type';
+
+export class BaseLocation extends AnyType<any> {
+	constructor(location: string, fieldNames: string[]) {
+		super();
+		// Push field names in schema
+		this._schema.fieldNames.splice(0, 0, ...fieldNames);
+		// set location in schema
+		if (location) {
+			this._schema.locations.push(location);
+		}
+	}
+	/**
+	 * @type StringType
+	 * @description StringType
+	 */
+	string(): StringType {
+		return new StringType();
+	}
+	/**
+	 * @type NumberType
+	 * @description NumberType
+	 */
+	number(): NumberType {
+		return new NumberType();
+	}
+	/**
+	 * @type ArrayType
+	 * @description ArrayType
+	 */
+	array(): ArrayType {
+		return new ArrayType();
+	}
+	/**
+	 * @type ObjectType
+	 * @description ObjectType
+	 */
+	object(): ObjectType {
+		return new ObjectType();
+	}
+}

src/lib/schema/locations/body.location.ts → src/lib/locations/body.location.ts

@@ -1,7 +1,7 @@
 import { BaseLocation } from './base.location';
 
 export class BodyLocation extends BaseLocation {
-	constructor(fieldName: string) {
-		super('body', fieldName);
+	constructor(...fieldNames: string[]) {
+		super('body', fieldNames);
 	}
 }

src/lib/schema/locations/cookie.location.ts → src/lib/locations/cookie.location.ts

@@ -1,7 +1,7 @@
 import { BaseLocation } from './base.location';
 
 export class CookieLocation extends BaseLocation {
-	constructor(fieldName: string) {
-		super('cookie', fieldName);
+	constructor(...fieldNames: string[]) {
+		super('cookie', fieldNames);
 	}
 }

src/lib/schema/locations/header.location.ts → src/lib/locations/header.location.ts

@@ -1,7 +1,7 @@
 import { BaseLocation } from './base.location';
 
 export class HeaderLocation extends BaseLocation {
-	constructor(fieldName: string) {
-		super('header', fieldName);
+	constructor(...fieldNames: string[]) {
+		super('header', fieldNames);
 	}
 }

src/lib/schema/locations/index.ts → src/lib/locations/index.ts

@@ -4,3 +4,4 @@ export * from './query.location';
 export * from './param.location';
 export * from './header.location';
 export * from './cookie.location';
+export * from './method.location';

src/lib/locations/method.location.ts

@@ -0,0 +1,47 @@
+/**
+ * @name MethodLocation
+ */
+
+import { BaseLocation } from './base.location';
+import { BodyLocation } from './body.location';
+import { QueryLocation } from './query.location';
+import { ParamLocation } from './param.location';
+import { HeaderLocation } from './header.location';
+import { CookieLocation } from './cookie.location';
+
+export class MethodLocation extends BaseLocation {
+	constructor(...methods: string[]) {
+		super(null, []);
+		this._schema.methods.splice(0, 0, ...methods);
+	}
+	/**
+	 * @param fieldNames All field names
+	 */
+	body(...fieldNames: string[]): BodyLocation {
+		return new BodyLocation(...fieldNames);
+	}
+	/**
+	 * @param fieldNames All field names
+	 */
+	query(...fieldNames: string[]): QueryLocation {
+		return new QueryLocation(...fieldNames);
+	}
+	/**
+	 * @param fieldNames All field names
+	 */
+	param(...fieldNames: string[]): ParamLocation {
+		return new ParamLocation(...fieldNames);
+	}
+	/**
+	 * @param fieldNames All field names
+	 */
+	header(...fieldNames: string[]): HeaderLocation {
+		return new HeaderLocation(...fieldNames);
+	}
+	/**
+	 * @param fieldNames All field names
+	 */
+	cookie(...fieldNames: string[]): CookieLocation {
+		return new CookieLocation(...fieldNames);
+	}
+}

src/lib/schema/locations/param.location.ts → src/lib/locations/param.location.ts

@@ -1,7 +1,7 @@
 import { BaseLocation } from './base.location';
 
 export class ParamLocation extends BaseLocation {
-	constructor(fieldName: string) {
-		super('param', fieldName);
+	constructor(...fieldNames: string[]) {
+		super('param', fieldNames);
 	}
 }

src/lib/schema/locations/query.location.ts → src/lib/locations/query.location.ts

@@ -1,7 +1,7 @@
 import { BaseLocation } from './base.location';
 
 export class QueryLocation extends BaseLocation {
-	constructor(fieldName: string) {
-		super('query', fieldName);
+	constructor(...fieldNames: string[]) {
+		super('query', fieldNames);
 	}
 }

src/lib/schema.ts

@@ -0,0 +1,12 @@
+
+/**
+ * @name Schema
+ * @description A schema which can be validated, stringify, parsed easily transferred over internet.
+ */
+
+export class EpiSchema {
+	readonly methods: string[] = [];
+	readonly locations: string[] = [];
+	readonly fieldNames: string[] = [];
+	readonly flags: string[] = [];
+}

src/lib/schema/types/base.type.ts → src/lib/types/any.type.ts

@@ -1,14 +1,13 @@
 /**
- * @name BaseType
- * @type Generic
- * @description BaseType
+ * @name AnyType
+ * @type Any
+ * @description AnyType
  */
 
-export abstract class BaseType<T> {
-	protected abstract _location: string;
-	protected abstract _fieldName: string;
-	protected abstract _metaData: any;
-	protected abstract _schema: string[];
+import { EpiSchema } from '../schema';
+
+export abstract class AnyType<T> {
+	protected _schema: EpiSchema = new EpiSchema();
 	/**
 	 * @type Filter
 	 * @description This allow the given argument values to be truthy for filter.
@@ -109,4 +108,13 @@ export abstract class BaseType<T> {
 		// TO DO
 		return this;
 	}
+	/**
+	 * @type Filter
+	 * @description bla bla bla
+	 */
+	validate() {
+		return (req: any, res: any, next: any) => {
+			next();
+		};
+	}
 }

src/lib/types/array.type.ts

@@ -0,0 +1,11 @@
+/**
+ * @name ArrayType
+ * @type Array
+ * @description ArrayType
+ */
+
+import { AnyType } from './any.type';
+
+export class ArrayType extends AnyType<string> {
+
+}

src/lib/schema/types/index.ts → src/lib/types/index.ts

@@ -1,5 +1,6 @@
 
-export * from './base.type';
 export * from './any.type';
 export * from './string.type';
 export * from './number.type';
+export * from './array.type';
+export * from './object.type';

src/lib/schema/types/number.type.ts → src/lib/types/number.type.ts

@@ -4,17 +4,9 @@
  * @description NumberType
  */
 
-import { BaseType } from './base.type';
+import { AnyType } from './any.type';
 
-export class NumberType extends BaseType<number> {
-	protected _metaData: any;
-	protected _schema: string[];
-	constructor(
-		protected _location: string,
-		protected _fieldName: string,
-	) {
-		super();
-	}
+export class NumberType extends AnyType<number> {
 	integer(convert: boolean = false): this {
 		// TO DO
 		return this;

src/lib/types/object.type.ts

@@ -0,0 +1,11 @@
+/**
+ * @name ObjectType
+ * @type Object
+ * @description ObjectType
+ */
+
+import { AnyType } from './any.type';
+
+export class ObjectType extends AnyType<string> {
+
+}