@twin.org/api-models 0.0.1-next.13 → 0.0.1-next.15

package/dist/types/index.d.ts

@@ -25,6 +25,7 @@ export * from "./models/responses/success/ICreatedResponse";
 export * from "./models/responses/success/INoContentResponse";
 export * from "./models/responses/success/IOkResponse";
 export * from "./models/routes/IBaseRoute";
+export * from "./models/routes/IBaseRouteEntryPoint";
 export * from "./models/routes/IRestRoute";
 export * from "./models/routes/IRestRouteEntryPoint";
 export * from "./models/routes/IRestRouteExample";
@@ -33,10 +34,11 @@ export * from "./models/routes/IRestRouteResponseAttachmentOptions";
 export * from "./models/routes/IRestRouteResponseExample";
 export * from "./models/routes/IRestRouteResponseOptions";
 export * from "./models/routes/ISocketRoute";
+export * from "./models/routes/ISocketRouteEntryPoint";
 export * from "./models/routes/ITag";
-export * from "./models/server/IRestRouteProcessor";
-export * from "./models/server/IMimeTypeProcessor";
 export * from "./models/server/IBaseRouteProcessor";
+export * from "./models/server/IMimeTypeProcessor";
+export * from "./models/server/IRestRouteProcessor";
 export * from "./models/server/ISocketRouteProcessor";
 export * from "./models/server/IWebServer";
 export * from "./models/server/IWebServerOptions";

package/dist/types/models/routes/IBaseRouteEntryPoint.d.ts

@@ -0,0 +1,22 @@
+import type { ITag } from "./ITag";
+/**
+ * Route entry points are used for exposing the routes from a package.
+ */
+export interface IBaseRouteEntryPoint<T> {
+    /**
+     * The name of the routes.
+     */
+    name: string;
+    /**
+     * The default base route name for the routes.
+     */
+    defaultBaseRoute: string;
+    /**
+     * The tags for the routes.
+     */
+    tags: ITag[];
+    /**
+     * The method to generate the routes.
+     */
+    generateRoutes: (baseRouteName: string, componentName: string) => T[];
+}

package/dist/types/models/routes/IRestRouteEntryPoint.d.ts

@@ -1,23 +1,6 @@
+import type { IBaseRouteEntryPoint } from "./IBaseRouteEntryPoint";
 import type { IRestRoute } from "./IRestRoute";
-import type { ITag } from "./ITag";
 /**
  * Route entry points are used for exposing the REST routes from a package.
  */
-export interface IRestRouteEntryPoint {
-    /**
-     * The name of the REST routes.
-     */
-    name: string;
-    /**
-     * The default base route name for the REST routes.
-     */
-    defaultBaseRoute: string;
-    /**
-     * The tags for the REST routes.
-     */
-    tags: ITag[];
-    /**
-     * The method to generate the REST routes.
-     */
-    generateRoutes: (baseRouteName: string, componentName: string) => IRestRoute[];
-}
+export type IRestRouteEntryPoint = IBaseRouteEntryPoint<IRestRoute>;

package/dist/types/models/routes/ISocketRoute.d.ts

@@ -21,5 +21,5 @@ export interface ISocketRoute<T extends IHttpRequest = any, U extends IHttpRespo
     /**
      * The function to emit a message.
      */
-    emit: (response: U) => Promise<void>) => void;
+    emit: (topic: string, response: U) => Promise<void>) => void;
 }

package/dist/types/models/routes/ISocketRouteEntryPoint.d.ts

@@ -0,0 +1,6 @@
+import type { IBaseRouteEntryPoint } from "./IBaseRouteEntryPoint";
+import type { ISocketRoute } from "./ISocketRoute";
+/**
+ * Route entry points are used for exposing the socket routes from a package.
+ */
+export type ISocketRouteEntryPoint = IBaseRouteEntryPoint<ISocketRoute>;

package/dist/types/models/server/ISocketRouteProcessor.d.ts

@@ -39,5 +39,5 @@ export interface ISocketRouteProcessor extends IBaseRouteProcessor<ISocketRoute>
      */
     process?(request: IHttpServerRequest, response: IHttpResponse, route: ISocketRoute | undefined, requestIdentity: IHttpRequestIdentity, processorState: {
         [id: string]: unknown;
-    }, responseEmitter: (response: IHttpResponse) => Promise<void>): Promise<void>;
+    }, responseEmitter: (topic: string, response: IHttpResponse) => Promise<void>): Promise<void>;
 }

package/docs/changelog.md

@@ -1,5 +1,5 @@
 # @twin.org/api-models - Changelog
 
-## v0.0.1-next.13
+## v0.0.1-next.15
 
 - Initial Release

package/docs/reference/index.md

@@ -32,8 +32,8 @@
 - [INoContentResponse](interfaces/INoContentResponse.md)
 - [IOkResponse](interfaces/IOkResponse.md)
 - [IBaseRoute](interfaces/IBaseRoute.md)
+- [IBaseRouteEntryPoint](interfaces/IBaseRouteEntryPoint.md)
 - [IRestRoute](interfaces/IRestRoute.md)
-- [IRestRouteEntryPoint](interfaces/IRestRouteEntryPoint.md)
 - [IRestRouteExample](interfaces/IRestRouteExample.md)
 - [IRestRouteRequestExample](interfaces/IRestRouteRequestExample.md)
 - [IRestRouteResponseAttachmentOptions](interfaces/IRestRouteResponseAttachmentOptions.md)
@@ -53,6 +53,8 @@
 
 ## Type Aliases
 
+- [IRestRouteEntryPoint](type-aliases/IRestRouteEntryPoint.md)
+- [ISocketRouteEntryPoint](type-aliases/ISocketRouteEntryPoint.md)
 - [HealthStatus](type-aliases/HealthStatus.md)
 
 ## Variables

package/docs/reference/interfaces/IBaseRouteEntryPoint.md

@@ -0,0 +1,49 @@
+# Interface: IBaseRouteEntryPoint\<T\>
+
+Route entry points are used for exposing the routes from a package.
+
+## Type Parameters
+
+• **T**
+
+## Properties
+
+### name
+
+> **name**: `string`
+
+The name of the routes.
+
+***
+
+### defaultBaseRoute
+
+> **defaultBaseRoute**: `string`
+
+The default base route name for the routes.
+
+***
+
+### tags
+
+> **tags**: [`ITag`](ITag.md)[]
+
+The tags for the routes.
+
+***
+
+### generateRoutes()
+
+> **generateRoutes**: (`baseRouteName`, `componentName`) => `T`[]
+
+The method to generate the routes.
+
+#### Parameters
+
+• **baseRouteName**: `string`
+
+• **componentName**: `string`
+
+#### Returns
+
+`T`[]

package/docs/reference/type-aliases/IRestRouteEntryPoint.md

@@ -0,0 +1,5 @@
+# Type Alias: IRestRouteEntryPoint
+
+> **IRestRouteEntryPoint**: [`IBaseRouteEntryPoint`](../interfaces/IBaseRouteEntryPoint.md)\<[`IRestRoute`](../interfaces/IRestRoute.md)\>
+
+Route entry points are used for exposing the REST routes from a package.

package/docs/reference/type-aliases/ISocketRouteEntryPoint.md

@@ -0,0 +1,5 @@
+# Type Alias: ISocketRouteEntryPoint
+
+> **ISocketRouteEntryPoint**: [`IBaseRouteEntryPoint`](../interfaces/IBaseRouteEntryPoint.md)\<[`ISocketRoute`](../interfaces/ISocketRoute.md)\>
+
+Route entry points are used for exposing the socket routes from a package.

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/api-models",
-	"version": "0.0.1-next.13",
+	"version": "0.0.1-next.15",
 	"description": "Contains models and classes for use with APIs",
 	"repository": {
 		"type": "git",

package/docs/reference/interfaces/IRestRouteEntryPoint.md

@@ -1,45 +0,0 @@
-# Interface: IRestRouteEntryPoint
-
-Route entry points are used for exposing the REST routes from a package.
-
-## Properties
-
-### name
-
-> **name**: `string`
-
-The name of the REST routes.
-
-***
-
-### defaultBaseRoute
-
-> **defaultBaseRoute**: `string`
-
-The default base route name for the REST routes.
-
-***
-
-### tags
-
-> **tags**: [`ITag`](ITag.md)[]
-
-The tags for the REST routes.
-
-***
-
-### generateRoutes()
-
-> **generateRoutes**: (`baseRouteName`, `componentName`) => [`IRestRoute`](IRestRoute.md)\<`any`, `any`\>[]
-
-The method to generate the REST routes.
-
-#### Parameters
-
-• **baseRouteName**: `string`
-
-• **componentName**: `string`
-
-#### Returns
-
-[`IRestRoute`](IRestRoute.md)\<`any`, `any`\>[]