@gtsc/api-auth-entity-storage-service - npm Package Compare versions

Comparing version 0.0.5-next.1 to 0.0.5-next.2

dist/types/processors/authCookieProcessor.d.ts

@@ -24,7 +24,7 @@ import { type IHttpResponse, type IHttpRestRouteProcessor, type IHttpServerRequest, type IRestRoute } from "@gtsc/api-models";
      * The service needs to be started when the application is initialized.
-     * @param systemRequestContext The system request context.
+     * @param systemIdentity The identity of the system.
      * @param systemLoggingConnectorType The system logging connector type, defaults to "system-logging".
      * @returns Nothing.
      */
-    start(systemRequestContext: IServiceRequestContext, systemLoggingConnectorType?: string): Promise<void>;
+    start(systemIdentity: string, systemLoggingConnectorType?: string): Promise<void>;
     /**
@@ -31,0 +31,0 @@ * Pre process the REST request for the specified route.

dist/types/routes/entityStorageAuthenticationRoutes.d.ts

@@ -16,3 +16,3 @@ import type { ILoginRequest, ILoginResponse, ILogoutRequest, IRefreshTokenRequest, IRefreshTokenResponse } from "@gtsc/api-auth-entity-storage-models";
  * Login to the server.
- * @param requestContext The request context for the API.
+ * @param httpRequestContext The request context for the API.
  * @param factoryServiceName The name of the service to use in the routes.
@@ -22,6 +22,6 @@ * @param request The request.
  */
-export declare function authenticationLogin(requestContext: IHttpRequestContext, factoryServiceName: string, request: ILoginRequest): Promise<ILoginResponse & IRestRouteResponseOptions>;
+export declare function authenticationLogin(httpRequestContext: IHttpRequestContext, factoryServiceName: string, request: ILoginRequest): Promise<ILoginResponse & IRestRouteResponseOptions>;
 /**
  * Logout from the server.
- * @param requestContext The request context for the API.
+ * @param httpRequestContext The request context for the API.
  * @param factoryServiceName The name of the service to use in the routes.
@@ -31,6 +31,6 @@ * @param request The request.
  */
-export declare function authenticationLogout(requestContext: IHttpRequestContext, factoryServiceName: string, request: ILogoutRequest): Promise<INoContentResponse & IRestRouteResponseOptions>;
+export declare function authenticationLogout(httpRequestContext: IHttpRequestContext, factoryServiceName: string, request: ILogoutRequest): Promise<INoContentResponse & IRestRouteResponseOptions>;
 /**
  * Refresh the login token.
- * @param requestContext The request context for the API.
+ * @param httpRequestContext The request context for the API.
  * @param factoryServiceName The name of the service to use in the routes.
@@ -40,2 +40,2 @@ * @param request The request.
  */
-export declare function authenticationRefreshToken(requestContext: IHttpRequestContext, factoryServiceName: string, request: IRefreshTokenRequest): Promise<IRefreshTokenResponse & IRestRouteResponseOptions>;
+export declare function authenticationRefreshToken(httpRequestContext: IHttpRequestContext, factoryServiceName: string, request: IRefreshTokenRequest): Promise<IRefreshTokenResponse & IRestRouteResponseOptions>;

dist/types/services/entityStorageAuthenticationService.d.ts

 import type { IAuthentication } from "@gtsc/api-auth-entity-storage-models";
-import type { IServiceRequestContext } from "@gtsc/services";
 import type { IEntityStorageAuthenticationServiceConfig } from "../models/IEntityStorageAuthenticationServiceConfig";
@@ -30,7 +29,7 @@ /**
      * The service needs to be started when the application is initialized.
-     * @param systemRequestContext The system request context.
+     * @param systemIdentity The identity of the system.
      * @param systemLoggingConnectorType The system logging connector type, defaults to "system-logging".
      * @returns Nothing.
      */
-    start(systemRequestContext: IServiceRequestContext, systemLoggingConnectorType?: string): Promise<void>;
+    start(systemIdentity: string, systemLoggingConnectorType?: string): Promise<void>;
     /**
@@ -40,6 +39,5 @@ * Perform a login for the user.
      * @param password The password for the user.
-     * @param requestContext The context for the request.
      * @returns The authentication token for the user, if it uses a mechanism with public access.
      */
-    login(email: string, password: string, requestContext?: IServiceRequestContext): Promise<{
+    login(email: string, password: string): Promise<{
         token?: string;
@@ -51,13 +49,11 @@ expiry: number;
      * @param token The token to logout, if it uses a mechanism with public access.
-     * @param requestContext The context for the request.
      * @returns Nothing.
      */
-    logout(token?: string, requestContext?: IServiceRequestContext): Promise<void>;
+    logout(token?: string): Promise<void>;
     /**
      * Refresh the token.
      * @param token The token to refresh, if it uses a mechanism with public access.
-     * @param requestContext The context for the request.
      * @returns The refreshed token, if it uses a mechanism with public access.
      */
-    refresh(token?: string, requestContext?: IServiceRequestContext): Promise<{
+    refresh(token?: string): Promise<{
         token: string;
@@ -64,0 +60,0 @@ expiry: number;

docs/reference/classes/AuthCookieProcessor.md

@@ -51,3 +51,3 @@ # Class: AuthCookieProcessor
 
-> **start**(`systemRequestContext`, `systemLoggingConnectorType`?): `Promise`\<`void`\>
+> **start**(`systemIdentity`, `systemLoggingConnectorType`?): `Promise`\<`void`\>
 
@@ -58,5 +58,5 @@ The service needs to be started when the application is initialized.
 
-• **systemRequestContext**: `IServiceRequestContext`
+• **systemIdentity**: `string`
 
-The system request context.
+The identity of the system.
 
@@ -63,0 +63,0 @@ • **systemLoggingConnectorType?**: `string`

docs/reference/classes/EntityStorageAuthenticationService.md

@@ -63,3 +63,3 @@ # Class: EntityStorageAuthenticationService
 
-> **start**(`systemRequestContext`, `systemLoggingConnectorType`?): `Promise`\<`void`\>
+> **start**(`systemIdentity`, `systemLoggingConnectorType`?): `Promise`\<`void`\>
 
@@ -70,5 +70,5 @@ The service needs to be started when the application is initialized.
 
-• **systemRequestContext**: `IServiceRequestContext`
+• **systemIdentity**: `string`
 
-The system request context.
+The identity of the system.
 
@@ -93,3 +93,3 @@ • **systemLoggingConnectorType?**: `string`
 
-> **login**(`email`, `password`, `requestContext`?): `Promise`\<`object`\>
+> **login**(`email`, `password`): `Promise`\<`object`\>
 
@@ -108,6 +108,2 @@ Perform a login for the user.
 
-• **requestContext?**: `IServiceRequestContext`
-
-The context for the request.
-
 #### Returns
@@ -135,3 +131,3 @@
 
-> **logout**(`token`?, `requestContext`?): `Promise`\<`void`\>
+> **logout**(`token`?): `Promise`\<`void`\>
 
@@ -146,6 +142,2 @@ Logout the current user.
 
-• **requestContext?**: `IServiceRequestContext`
-
-The context for the request.
-
 #### Returns
@@ -165,3 +157,3 @@
 
-> **refresh**(`token`?, `requestContext`?): `Promise`\<`object`\>
+> **refresh**(`token`?): `Promise`\<`object`\>
 
@@ -176,6 +168,2 @@ Refresh the token.
 
-• **requestContext?**: `IServiceRequestContext`
-
-The context for the request.
-
 #### Returns
@@ -182,0 +170,0 @@

docs/reference/functions/authenticationLogin.md

 # Function: authenticationLogin()
 
-> **authenticationLogin**(`requestContext`, `factoryServiceName`, `request`): `Promise`\<`ILoginResponse` & `IRestRouteResponseOptions`\>
+> **authenticationLogin**(`httpRequestContext`, `factoryServiceName`, `request`): `Promise`\<`ILoginResponse` & `IRestRouteResponseOptions`\>
 
@@ -9,3 +9,3 @@ Login to the server.
 
-• **requestContext**: `IHttpRequestContext`
+• **httpRequestContext**: `IHttpRequestContext`
 
@@ -12,0 +12,0 @@ The request context for the API.

docs/reference/functions/authenticationLogout.md

 # Function: authenticationLogout()
 
-> **authenticationLogout**(`requestContext`, `factoryServiceName`, `request`): `Promise`\<`INoContentResponse` & `IRestRouteResponseOptions`\>
+> **authenticationLogout**(`httpRequestContext`, `factoryServiceName`, `request`): `Promise`\<`INoContentResponse` & `IRestRouteResponseOptions`\>
 
@@ -9,3 +9,3 @@ Logout from the server.
 
-• **requestContext**: `IHttpRequestContext`
+• **httpRequestContext**: `IHttpRequestContext`
 
@@ -12,0 +12,0 @@ The request context for the API.

docs/reference/functions/authenticationRefreshToken.md

 # Function: authenticationRefreshToken()
 
-> **authenticationRefreshToken**(`requestContext`, `factoryServiceName`, `request`): `Promise`\<`IRefreshTokenResponse` & `IRestRouteResponseOptions`\>
+> **authenticationRefreshToken**(`httpRequestContext`, `factoryServiceName`, `request`): `Promise`\<`IRefreshTokenResponse` & `IRestRouteResponseOptions`\>
 
@@ -9,3 +9,3 @@ Refresh the login token.
 
-• **requestContext**: `IHttpRequestContext`
+• **httpRequestContext**: `IHttpRequestContext`
 
@@ -12,0 +12,0 @@ The request context for the API.

package.json

 {
 	"name": "@gtsc/api-auth-entity-storage-service",
-	"version": "0.0.5-next.1",
+	"version": "0.0.5-next.2",
 	"description": "Auth Entity Storage contract implementation and REST endpoint definitions",
@@ -17,5 +17,5 @@ "repository": {
 	"dependencies": {
-		"@gtsc/api-auth-entity-storage-models": "0.0.5-next.1",
-		"@gtsc/api-core": "0.0.5-next.1",
-		"@gtsc/api-models": "0.0.5-next.1",
+		"@gtsc/api-auth-entity-storage-models": "0.0.5-next.2",
+		"@gtsc/api-core": "0.0.5-next.2",
+		"@gtsc/api-models": "0.0.5-next.2",
 		"@gtsc/core": "next",
@@ -22,0 +22,0 @@ "@gtsc/crypto": "next",

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Worsened metrics

Total package byte prevSize

86117

decreased by-1.1%

Lines of code

1512

decreased by-0.4%

Dependency changes

• + Added@gtsc/api-auth-entity-storage-models@0.0.5-next.2(transitive)

• + Added@gtsc/api-core@0.0.5-next.2(transitive)

• + Added@gtsc/api-models@0.0.5-next.2(transitive)

• - Removed@gtsc/api-auth-entity-storage-models@0.0.5-next.1(transitive)

• - Removed@gtsc/api-core@0.0.5-next.1(transitive)

• - Removed@gtsc/api-models@0.0.5-next.1(transitive)

• Updated@gtsc/api-auth-entity-storage-models@0.0.5-next.2

• Updated@gtsc/api-core@0.0.5-next.2

• Updated@gtsc/api-models@0.0.5-next.2