@ez4/gateway 0.35.1 → 0.37.0

package/README.md

@@ -1,15 +1,133 @@
 # EZ4: Gateway
 
-It uses the power of [reflection](../reflection/) to provide an API which determines how to build and connect gateway components.
+It uses the power of [reflection](../../foundation/reflection/) to provide a contract that determines how to build and connect gateway components.
 
 ## Getting started
 
 #### Install
 
 ```sh
-npm install @ez4/gateway -D
+npm install @ez4/gateway @ez4/local-gateway @ez4/aws-gateway -D
 ```
 
+#### Create gateway
+
+```ts
+// file: server.ts
+import type { Environment, Service } from '@ez4/common';
+import type { Http } from '@ez4/gateway';
+
+// MyServer declaration
+export declare class MyServer extends Http.Service {
+  routes: [
+    Http.UseRoute<{
+      path: 'POST /post-route';
+      handler: typeof routeHandler;
+    }>
+  ];
+}
+
+// MyServer route request
+declare class MyRouteRequest implements Http.Request {
+  body: {
+    foo: string;
+    bar: number;
+  };
+}
+
+// MyServer route response
+declare class MyRouteResponse implements Http.Response {
+  status: 201;
+  body: {
+    baz: string;
+  };
+}
+
+// MyServer route provider
+interface MyRouteProvider extends Http.Provider {
+  variables: {
+    myVariable: Environment.Variable<'MY_VARIABLE'>;
+  };
+
+  services: {
+    otherService: Environment.Service<OtherService>;
+    variables: Environment.ServiceVariables;
+  };
+}
+
+// MyServer route handler
+export function routeHandler(request: Http.Incoming<MyRouteRequest>, context: Service.Context<MyRouteProvider>): MyRouteResponse {
+  const { otherService, variables } = context;
+  const { body } = request;
+
+  // Access body contents
+  body.foo;
+
+  // Access injected services
+  otherService.call();
+
+  // Access injected variables
+  variables.myVariable;
+
+  return {
+    status: 201,
+    body: {
+      baz: 'baz'
+    }
+  };
+}
+```
+
+## Gateway properties
+
+#### Service
+
+| Name      | Type               | Description                                     |
+| --------- | ------------------ | ----------------------------------------------- |
+| routes    | Http.UseRoute<>    | All routes associated to the gateway.           |
+| defaults  | Http.UseDefaults<> | Default gateway parameters.                     |
+| cors      | Http.UseCors<>     | CORS configuration for all routes.              |
+| cache     | Http.UseCache<>    | Cache configuration for authorizers.            |
+| access    | Http.UseAccess<>   | Access configuration for logs.                  |
+| name      | string             | Display name for the service.                   |
+| variables | object             | Environment variables associated to all routes. |
+| services  | object             | Injected services associated to all routes.     |
+
+> Use type helpers for `routes`, `defaults`, `cors`, `cache` and `access` properties.
+
+#### Routes
+
+| Name         | Type     | Description                                              |
+| ------------ | -------- | -------------------------------------------------------- |
+| name         | string   | Route operation name.                                    |
+| path         | string   | Route path including the HTTP verb.                      |
+| listener     | function | Life-cycle listener function for the route.              |
+| handler      | function | Entry-point handler function for the route.              |
+| authorizer   | function | Authorizer function for the route.                       |
+| httpErrors   | object   | Map status codes and errors for all known exceptions.    |
+| variables    | object   | Environment variables associated to the route.           |
+| logRetention | integer  | Log retention (in days) for the handler.                 |
+| memory       | integer  | Memory available (in megabytes) for the handler.         |
+| timeout      | integer  | Max execution time (in seconds) for the route.           |
+| disabled     | boolean  | Determines whether or not the route is disabled.         |
+| cors         | boolean  | Determines whether or not CORS is enabled for the route. |
+
+## Examples
+
+- [Get started with API gateway](../../examples/hello-aws-gateway)
+- [API Gateway authorizer](../../examples/aws-gateway-authorizer)
+- [API Gateway websocket](../../examples/aws-gateway-websocket)
+- [Importing gateway](../../examples/aws-import-gateway)
+- [Aurora RDS CRUDL](../../examples/aws-aurora-crudl)
+- [DynamoDB CRUDL](../../examples/aws-dynamodb-crudl)
+- [Schedule manager](../../examples/aws-schedule-manager)
+- [Storage manager](../../examples/aws-storage-manager)
+
+## Providers
+
+- [Local provider](../../providers/local/local-gateway)
+- [AWS provider](../../providers/aws/aws-gateway)
+
 ## License
 
 MIT License

package/dist/client/authorization.d.ts

@@ -1,4 +1,4 @@
-import type { HttpImport } from '../types/import';
+import type { HttpImport } from '../metadata/http/types';
 export type ClientAuthorization = {
     header: string;
     value: string;

package/dist/client/operations.d.ts

@@ -1,6 +1,5 @@
 import type { ArraySchema, NamingStyle, ObjectSchema, ScalarSchema, UnionSchema } from '@ez4/schema';
-import type { HttpService } from '../types/service';
-import type { HttpImport } from '../types/import';
+import type { HttpImport, HttpService } from '../metadata/http/types';
 export type ClientOperation = {
     namingStyle?: NamingStyle;
     bodySchema?: ObjectSchema | UnionSchema | ArraySchema | ScalarSchema;

package/dist/errors/auth/authorizer.d.ts

@@ -0,0 +1,4 @@
+import { IncompleteTypeError } from '@ez4/common/library';
+export declare class IncompleteAuthorizerHandlerError extends IncompleteTypeError {
+    constructor(properties: string[], fileName?: string);
+}

package/dist/errors/{identity.d.ts → auth/identity.d.ts}

@@ -1,8 +1,10 @@
 import { IncorrectTypeError, InvalidTypeError } from '@ez4/common/library';
 export declare class InvalidIdentityTypeError extends InvalidTypeError {
-    constructor(fileName?: string);
+    baseType: string;
+    constructor(baseType: string, fileName?: string);
 }
 export declare class IncorrectIdentityTypeError extends IncorrectTypeError {
     identityType: string;
-    constructor(identityType: string, fileName?: string);
+    baseType: string;
+    constructor(identityType: string, baseType: string, fileName?: string);
 }

package/dist/errors/body.d.ts

@@ -1,8 +1,10 @@
 import { IncorrectTypeError, InvalidTypeError } from '@ez4/common/library';
 export declare class InvalidBodyTypeError extends InvalidTypeError {
-    constructor(fileName?: string);
+    baseType: string;
+    constructor(baseType: string, fileName?: string);
 }
 export declare class IncorrectBodyTypeError extends IncorrectTypeError {
     bodyType: string;
-    constructor(bodyType: string, fileName?: string);
+    baseType: string;
+    constructor(bodyType: string, baseType: string, fileName?: string);
 }

package/dist/errors/defaults.d.ts

@@ -1,8 +1,10 @@
 import { IncorrectTypeError, InvalidTypeError } from '@ez4/common/library';
 export declare class InvalidDefaultsTypeError extends InvalidTypeError {
-    constructor(fileName?: string);
+    baseType: string;
+    constructor(baseType: string, fileName?: string);
 }
 export declare class IncorrectDefaultsTypeError extends IncorrectTypeError {
     defaultsType: string;
-    constructor(defaultsType: string, fileName?: string);
+    baseType: string;
+    constructor(defaultsType: string, baseType: string, fileName?: string);
 }

package/dist/errors/headers.d.ts

@@ -1,8 +1,10 @@
 import { IncorrectTypeError, InvalidTypeError } from '@ez4/common/library';
 export declare class InvalidHeadersTypeError extends InvalidTypeError {
-    constructor(fileName?: string);
+    baseType: string;
+    constructor(baseType: string, fileName?: string);
 }
 export declare class IncorrectHeadersTypeError extends IncorrectTypeError {
     headersType: string;
-    constructor(headersType: string, fileName?: string);
+    baseType: string;
+    constructor(headersType: string, baseType: string, fileName?: string);
 }

package/dist/errors/{authorization.d.ts → http/authorization.d.ts}

@@ -3,9 +3,11 @@ export declare class IncompleteAuthorizationError extends IncompleteTypeError {
     constructor(properties: string[], fileName?: string);
 }
 export declare class InvalidAuthorizationTypeError extends InvalidTypeError {
-    constructor(fileName?: string);
+    baseType: string;
+    constructor(baseType: string, fileName?: string);
 }
 export declare class IncorrectAuthorizationTypeError extends IncorrectTypeError {
     authorizationType: string;
-    constructor(authorizationType: string, fileName?: string);
+    baseType: string;
+    constructor(authorizationType: string, baseType: string, fileName?: string);
 }

package/dist/errors/{cache.d.ts → http/cache.d.ts}

@@ -3,9 +3,11 @@ export declare class IncompleteCacheError extends IncompleteTypeError {
     constructor(properties: string[], fileName?: string);
 }
 export declare class InvalidCacheTypeError extends InvalidTypeError {
-    constructor(fileName?: string);
+    baseType: string;
+    constructor(baseType: string, fileName?: string);
 }
 export declare class IncorrectCacheTypeError extends IncorrectTypeError {
     cacheType: string;
-    constructor(cacheType: string, fileName?: string);
+    baseType: string;
+    constructor(cacheType: string, baseType: string, fileName?: string);
 }

package/dist/errors/{cors.d.ts → http/cors.d.ts}

@@ -3,9 +3,11 @@ export declare class IncompleteCorsError extends IncompleteTypeError {
     constructor(properties: string[], fileName?: string);
 }
 export declare class InvalidCorsTypeError extends InvalidTypeError {
-    constructor(fileName?: string);
+    baseType: string;
+    constructor(baseType: string, fileName?: string);
 }
 export declare class IncorrectCorsTypeError extends IncorrectTypeError {
-    fallbackType: string;
-    constructor(fallbackType: string, fileName?: string);
+    corsType: string;
+    baseType: string;
+    constructor(corsType: string, baseType: string, fileName?: string);
 }

package/dist/errors/parameters.d.ts

@@ -1,8 +1,14 @@
-import { IncorrectTypeError, InvalidTypeError } from '@ez4/common/library';
+import { IncorrectTypeError, InvalidTypeError, TypeError } from '@ez4/common/library';
 export declare class InvalidParameterTypeError extends InvalidTypeError {
-    constructor(fileName?: string);
+    baseType: string;
+    constructor(baseType: string, fileName?: string);
 }
 export declare class IncorrectParameterTypeError extends IncorrectTypeError {
     parametersType: string;
-    constructor(parametersType: string, fileName?: string);
+    baseType: string;
+    constructor(parametersType: string, baseType: string, fileName?: string);
+}
+export declare class MismatchParametersTypeError extends TypeError {
+    parameterNames: string[];
+    constructor(parameterNames: string[], fileName?: string);
 }

package/dist/errors/preferences.d.ts

@@ -1,8 +1,10 @@
 import { IncorrectTypeError, InvalidTypeError } from '@ez4/common/library';
 export declare class InvalidPreferencesTypeError extends InvalidTypeError {
-    constructor(fileName?: string);
+    baseType: string;
+    constructor(baseType: string, fileName?: string);
 }
 export declare class IncorrectPreferencesTypeError extends IncorrectTypeError {
     preferencesType: string;
-    constructor(preferencesType: string, fileName?: string);
+    baseType: string;
+    constructor(preferencesType: string, baseType: string, fileName?: string);
 }

package/dist/errors/query.d.ts

@@ -1,8 +1,10 @@
 import { IncorrectTypeError, InvalidTypeError } from '@ez4/common/library';
 export declare class InvalidQueryTypeError extends InvalidTypeError {
-    constructor(fileName?: string);
+    baseType: string;
+    constructor(baseType: string, fileName?: string);
 }
 export declare class IncorrectQueryTypeError extends IncorrectTypeError {
     queryType: string;
-    constructor(queryType: string, fileName?: string);
+    baseType: string;
+    constructor(queryType: string, baseType: string, fileName?: string);
 }

package/dist/errors/ws/event.d.ts

@@ -0,0 +1,10 @@
+import { IncorrectTypeError, InvalidTypeError } from '@ez4/common/library';
+export declare class InvalidEventTypeError extends InvalidTypeError {
+    baseType: string;
+    constructor(baseType: string, fileName?: string);
+}
+export declare class IncorrectEventTypeError extends IncorrectTypeError {
+    eventType: string;
+    baseType: string;
+    constructor(eventType: string, baseType: string, fileName?: string);
+}

package/dist/errors/{authorizer.d.ts → ws/target.d.ts}

@@ -1,4 +1,4 @@
 import { IncompleteTypeError } from '@ez4/common/library';
-export declare class IncompleteAuthorizerError extends IncompleteTypeError {
+export declare class IncompleteTargetError extends IncompleteTypeError {
     constructor(properties: string[], fileName?: string);
 }