@breautek/storm 4.1.0 → 4.2.0

package/src/Handler.ts

@@ -14,7 +14,6 @@
    limitations under the License.
 */
 
-import {StatusCode} from './StatusCode';
 import {Application} from './Application';
 import {getInstance} from './instance';
 import {Request} from './Request';
@@ -27,6 +26,8 @@ import { IRequestResponse } from './IRequestResponse';
 import { Logger } from '@arashi/logger';
 import { ResponseData } from './ResponseData';
 import { ReadStream } from 'fs';
+import { NotImplementedError } from './NotImplementedError';
+import { HTTPMethod } from './HTTPMethod';
 // import { Stream } from 'stream';
 
 const TAG: string = 'Handler';
@@ -199,19 +200,19 @@ export class Handler<
         }
     }
 
-    protected async _get(request: Request<TGetRequest>): Promise<TGetResponse | IHandlerResponse> {
-        return new ResponseData(StatusCode.INTERNAL_NOT_IMPLEMENTED);
+    protected async _get(request: Request<TGetRequest>): Promise<TGetResponse> {
+        throw new NotImplementedError(HTTPMethod.GET);
     }
 
-    protected async _post(request: Request<TPostRequest>): Promise<TPostResponse| IHandlerResponse> {
-        return new ResponseData(StatusCode.INTERNAL_NOT_IMPLEMENTED);
+    protected async _post(request: Request<TPostRequest>): Promise<TPostResponse> {
+        throw new NotImplementedError(HTTPMethod.POST);
     }
 
-    protected async _put(request: Request<TPutRequest>): Promise<TPutResponse | IHandlerResponse> {
-        return new ResponseData(StatusCode.INTERNAL_NOT_IMPLEMENTED);
+    protected async _put(request: Request<TPutRequest>): Promise<TPutResponse> {
+        throw new NotImplementedError(HTTPMethod.PUT);
     }
 
-    protected async _delete(request: Request<TDeleteRequest>): Promise<TDeleteResponse | IHandlerResponse> {
-        return new ResponseData(StatusCode.INTERNAL_NOT_IMPLEMENTED);
+    protected async _delete(request: Request<TDeleteRequest>): Promise<TDeleteResponse> {
+        throw new NotImplementedError(HTTPMethod.DELETE);
     }
 }

package/src/NotImplementedError.ts

@@ -0,0 +1,45 @@
+/*
+   Copyright 2017-2021 Norman Breau
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+*/
+
+import {StormError} from './StormError';
+import {ErrorCode} from './ErrorCode';
+import {StatusCode} from './StatusCode';
+import {HTTPMethod} from './HTTPMethod';
+
+interface INotImplementedErrorOptions {
+    method: string;
+}
+
+export class NotImplementedError extends StormError<INotImplementedErrorOptions> {
+    public constructor(method: HTTPMethod) {
+        super({
+            method
+        });
+    }
+
+    public getMessage(): string {
+        let details: INotImplementedErrorOptions = this.getPrivateDetails();
+        return `Handler does not implement "${details.method}".`;
+    }
+
+    public getCode(): ErrorCode {
+        return ErrorCode.INTERNAL;
+    }
+
+    public getHTTPCode(): StatusCode {
+        return StatusCode.INTERNAL_NOT_IMPLEMENTED;
+    }
+}

package/src/Query.ts

@@ -23,10 +23,18 @@ export abstract class Query<TQueryParameters = any, TQueryResultSet = any, TQuer
         this.$params = parameters;
     }
 
+    /**
+     * @returns parameters that was passed into the constructor.
+     */
     public getParameters(): TQueryParameters {
         return this.$params;
     }
 
+    /**
+     * Query implementations may override this API to augment the parameters.
+     * 
+     * @returns parameters that will be used when this query is ran.
+     */
     public getParametersForQuery(): Record<any, any> {
         return this.$params;
     }

package/src/RawError.ts

@@ -0,0 +1,39 @@
+/*
+   Copyright 2017-2022 Norman Breau
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+*/
+
+import { StormError } from './StormError';
+
+/**
+ * A concrete error that accepts any arbitrary message string and optionally a code.
+ * It's not recommended to use this class as it will be hard to differentiate errors by
+ * tag name.
+ */
+export class RawError extends StormError<{message: string, code?: number}> {
+    public constructor(message: string, code?: number) {
+        super({
+            message,
+            code: code || 0
+        });
+    }
+
+    public getCode(): number {
+        return this.getPrivateDetails().code;
+    }
+
+    public getMessage(): string {
+        return this.getPrivateDetails().message;
+    }
+}

package/src/api.ts

@@ -38,6 +38,7 @@ export {SetSessionVariableQuery, ISetSessionVariableQueryInput} from './SetSessi
 
 // Errors
 export {ErrorCode} from './ErrorCode';
+export {RawError} from './RawError';
 export {
     StormError,
     IErrorResponse,
@@ -55,6 +56,7 @@ export {DiskSpaceError} from './DiskSpaceError';
 export {DuplicateEntryError} from './DuplicateEntryError';
 export {MissingConfigError} from './MissingConfigError';
 export {DatabaseQueryError} from './DatabaseQueryError';
+export {NotImplementedError} from './NotImplementedError';
 
 // HTTP
 export {StatusCode} from './StatusCode';

package/tsconfig.json

@@ -5,7 +5,6 @@
         "declaration": true,
         "sourceMap": true,
         "outDir": "./lib/",
-        "removeComments": true,
         "importHelpers": true,
         "noImplicitAny": true,
         "noImplicitThis": true,