@owlmeans/api 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 OwlMeans Common — Fullstack typescript framework
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,288 @@
+# @owlmeans/api
+
+A comprehensive HTTP API client library for OwlMeans Common applications. This package provides a sophisticated API service that integrates with the OwlMeans module system, handles authentication automatically, and provides robust error handling for fullstack applications.
+
+## Overview
+
+The `@owlmeans/api` package is a core networking library in the OwlMeans Common ecosystem that enables seamless communication between client and server components. It provides:
+
+- **Module Integration**: Deep integration with OwlMeans Common Module system for type-safe API calls
+- **Automatic Authentication**: Built-in authentication token management and refresh
+- **Error Handling**: Comprehensive error handling with resilient error types
+- **URL Management**: Automatic URL construction from route definitions
+- **Request/Response Processing**: Advanced request transformation and response processing
+- **Security Features**: Integrated security helpers and header management
+
+## Installation
+
+```bash
+npm install @owlmeans/api
+```
+
+## Core Concepts
+
+### API Client Service
+
+The API client is implemented as an OwlMeans service that can be registered with the context system. It provides a `handler` function that processes module requests and returns appropriate responses.
+
+### Module-Based Requests
+
+Instead of making direct HTTP calls, the API client works with OwlMeans Common Modules, which define:
+- Route structure and methods
+- Request/response types
+- Parameter validation
+- URL patterns
+
+### Automatic Authentication
+
+The client automatically handles authentication tokens:
+- Retrieves tokens from the authentication service
+- Includes tokens in request headers
+- Processes token updates from server responses
+- Integrates with the OwlMeans authentication subsystem
+
+## API Reference
+
+### Types
+
+#### `ApiClient`
+The main API client service interface.
+
+```typescript
+interface ApiClient extends InitializedService {
+  handler: ModuleHandler
+}
+```
+
+### Factory Functions
+
+#### `createApiService(alias?: string): ApiClient`
+Creates a new API client service.
+
+**Parameters:**
+- `alias` (optional): Service alias for registration (defaults to `'web-client'`)
+
+**Returns:** Configured ApiClient instance
+
+**Example:**
+```typescript
+import { createApiService } from '@owlmeans/api'
+
+const apiClient = createApiService('my-api-client')
+```
+
+#### `appendApiClient<C, T>(ctx: T, alias?: string): T`
+Appends an API client service to an existing context.
+
+**Parameters:**
+- `ctx`: OwlMeans context instance
+- `alias` (optional): Service alias (defaults to `'web-client'`)
+
+**Returns:** The context with the API client registered
+
+**Example:**
+```typescript
+import { appendApiClient } from '@owlmeans/api'
+import { createBasicContext } from '@owlmeans/context'
+
+const context = createBasicContext()
+appendApiClient(context, 'api-service')
+```
+
+### Constants
+
+#### HTTP Status Codes
+```typescript
+const OK = 200
+const CREATED = 201
+const ACCEPTED = 202
+const FINISHED = 204
+const UNAUTHORIZED_ERROR = 401
+const FORBIDDEN_ERROR = 403
+const SERVER_ERROR = 500
+```
+
+#### Default Configuration
+```typescript
+const DEFAULT_ALIAS = 'web-client'
+const protocols = ['http', 'https', 'wss', 'ws']
+```
+
+### Error Types
+
+The package provides a comprehensive error hierarchy for API-related failures:
+
+#### `ApiError`
+Base error class for all API-related errors.
+
+#### `ApiClientError`
+General client-side API errors.
+
+#### `ServerCrashedError`
+Error indicating server-side crashes (500 errors).
+
+#### `ServerAuthError`
+Error for authentication failures (401 errors).
+
+## Usage Examples
+
+### Basic Setup
+
+```typescript
+import { createBasicContext } from '@owlmeans/context'
+import { appendApiClient } from '@owlmeans/api'
+
+// Create context and add API client
+const context = createBasicContext({
+  webService: 'api-client'
+})
+appendApiClient(context, 'api-client')
+
+// Initialize the context
+await context.init()
+```
+
+### Making API Calls through Modules
+
+```typescript
+import { createApiService } from '@owlmeans/api'
+
+// Get the API client from context
+const apiClient = context.service('api-client')
+
+// Use with a module - the handler processes the request
+const request = {
+  alias: 'user-profile',
+  params: { userId: '123' },
+  query: { include: 'permissions' },
+  headers: { 'Accept': 'application/json' }
+}
+
+const [result, outcome] = await apiClient.handler(request, responseHandler)
+```
+
+### Error Handling
+
+```typescript
+import { ApiError, ServerCrashedError, ServerAuthError } from '@owlmeans/api'
+
+try {
+  const [result, outcome] = await apiClient.handler(request, response)
+  console.log('API call successful:', result)
+} catch (error) {
+  if (error instanceof ServerCrashedError) {
+    console.error('Server crashed:', error.message)
+  } else if (error instanceof ServerAuthError) {
+    console.error('Authentication failed:', error.message)
+    // Redirect to login
+  } else if (error instanceof ApiError) {
+    console.error('API error:', error.message)
+  }
+}
+```
+
+### Custom Configuration
+
+```typescript
+import { createApiService } from '@owlmeans/api'
+import { createBasicContext } from '@owlmeans/context'
+
+const context = createBasicContext({
+  webService: 'custom-api',
+  // Configure base URLs, security settings, etc.
+})
+
+const apiClient = createApiService('custom-api')
+context.registerService(apiClient)
+```
+
+## Advanced Features
+
+### Automatic Token Refresh
+
+The API client automatically handles authentication token updates:
+
+```typescript
+// When server responds with TOKEN_UPDATE header,
+// the client automatically updates the auth service
+const response = await apiClient.handler(request, reply)
+// Token is updated in background if provided by server
+```
+
+### Request Transformation
+
+The client handles various content types and request transformations:
+
+```typescript
+// Automatic form encoding for application/x-www-form-urlencoded
+const request = {
+  alias: 'form-submit',
+  body: { name: 'John', email: 'john@example.com' },
+  headers: { 'content-type': 'application/x-www-form-urlencoded' }
+}
+
+// Automatic JSON handling
+const jsonRequest = {
+  alias: 'api-call',
+  body: JSON.stringify({ data: 'value' }),
+  headers: { 'content-type': 'application/json' }
+}
+```
+
+### URL Construction
+
+URLs are automatically constructed from module route definitions:
+
+```typescript
+// Module defines: /users/:userId/profile
+// Request provides: { userId: '123' }
+// Result: /users/123/profile
+
+const request = {
+  alias: 'user-profile',
+  params: { userId: '123' },
+  host: 'api.example.com',
+  base: '/v1'
+}
+// Final URL: https://api.example.com/v1/users/123/profile
+```
+
+### Response Processing
+
+The client processes various response scenarios:
+
+```typescript
+// Success responses (200, 201, 202, 204)
+// Error responses (401, 403, 500, etc.)
+// Custom error marshaling from server
+// Header-based responses for empty bodies
+```
+
+## Integration with OwlMeans Ecosystem
+
+The `@owlmeans/api` package integrates with:
+
+- **@owlmeans/context**: Service registration and dependency injection
+- **@owlmeans/module**: Module-based request/response handling
+- **@owlmeans/client-route**: URL parameter extraction and route processing
+- **@owlmeans/auth-common**: Automatic authentication integration
+- **@owlmeans/config**: Security helpers and URL construction
+- **@owlmeans/error**: Resilient error handling and marshaling
+- **@owlmeans/client-config**: Configuration management
+
+## Security Considerations
+
+- All API calls should use HTTPS in production
+- Authentication tokens are automatically managed
+- Request/response data should be validated
+- Error responses may contain sensitive information and should be handled appropriately
+- CORS and CSP headers should be configured properly on the server side
+
+## Performance Features
+
+- Automatic request cancellation support
+- Efficient parameter extraction and URL construction
+- Minimal overhead for authenticated requests
+- Built-in retry logic through the OwlMeans module system
+
+Fixes #32.

package/build/consts.d.ts

@@ -0,0 +1,10 @@
+export declare const SERVER_ERROR = 500;
+export declare const UNAUTHORIZED_ERROR = 401;
+export declare const FORBIDDEN_ERROR = 403;
+export declare const OK = 200;
+export declare const CREATED = 201;
+export declare const ACCEPTED = 202;
+export declare const FINISHED = 204;
+export declare const DEFAULT_ALIAS = "web-client";
+export declare const protocols: string[];
+//# sourceMappingURL=consts.d.ts.map

package/build/consts.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"consts.d.ts","sourceRoot":"","sources":["../src/consts.ts"],"names":[],"mappings":"AACA,eAAO,MAAM,YAAY,MAAM,CAAA;AAE/B,eAAO,MAAM,kBAAkB,MAAM,CAAA;AAErC,eAAO,MAAM,eAAe,MAAM,CAAA;AAElC,eAAO,MAAM,EAAE,MAAM,CAAA;AAErB,eAAO,MAAM,OAAO,MAAM,CAAA;AAE1B,eAAO,MAAM,QAAQ,MAAM,CAAA;AAE3B,eAAO,MAAM,QAAQ,MAAM,CAAA;AAE3B,eAAO,MAAM,aAAa,eAAe,CAAA;AAEzC,eAAO,MAAM,SAAS,UAAiC,CAAA"}

package/build/consts.js

@@ -0,0 +1,10 @@
+export const SERVER_ERROR = 500;
+export const UNAUTHORIZED_ERROR = 401;
+export const FORBIDDEN_ERROR = 403;
+export const OK = 200;
+export const CREATED = 201;
+export const ACCEPTED = 202;
+export const FINISHED = 204;
+export const DEFAULT_ALIAS = 'web-client';
+export const protocols = ['http', 'https', 'wss', 'ws'];
+//# sourceMappingURL=consts.js.map

package/build/consts.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"consts.js","sourceRoot":"","sources":["../src/consts.ts"],"names":[],"mappings":"AACA,MAAM,CAAC,MAAM,YAAY,GAAG,GAAG,CAAA;AAE/B,MAAM,CAAC,MAAM,kBAAkB,GAAG,GAAG,CAAA;AAErC,MAAM,CAAC,MAAM,eAAe,GAAG,GAAG,CAAA;AAElC,MAAM,CAAC,MAAM,EAAE,GAAG,GAAG,CAAA;AAErB,MAAM,CAAC,MAAM,OAAO,GAAG,GAAG,CAAA;AAE1B,MAAM,CAAC,MAAM,QAAQ,GAAG,GAAG,CAAA;AAE3B,MAAM,CAAC,MAAM,QAAQ,GAAG,GAAG,CAAA;AAE3B,MAAM,CAAC,MAAM,aAAa,GAAG,YAAY,CAAA;AAEzC,MAAM,CAAC,MAAM,SAAS,GAAG,CAAC,MAAM,EAAE,OAAO,EAAE,KAAK,EAAE,IAAI,CAAC,CAAA"}

package/build/errors.d.ts

@@ -0,0 +1,18 @@
+import { ResilientError } from '@owlmeans/error';
+export declare class ApiError extends ResilientError {
+    static typeName: string;
+    constructor(message?: string);
+}
+export declare class ApiClientError extends ApiError {
+    static typeName: string;
+    constructor(message?: string);
+}
+export declare class ServerCrashedError extends ApiClientError {
+    static typeName: string;
+    constructor(message?: string);
+}
+export declare class ServerAuthError extends ApiClientError {
+    static typeName: string;
+    constructor(message?: string);
+}
+//# sourceMappingURL=errors.d.ts.map

package/build/errors.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"errors.d.ts","sourceRoot":"","sources":["../src/errors.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,iBAAiB,CAAA;AAEhD,qBAAa,QAAS,SAAQ,cAAc;IAC1C,OAAuB,QAAQ,SAAa;gBAEhC,OAAO,GAAE,MAAgB;CAGtC;AAED,qBAAa,cAAe,SAAQ,QAAQ;IAC1C,OAAuB,QAAQ,SAAmB;gBAEtC,OAAO,GAAE,MAAgB;CAItC;AAED,qBAAa,kBAAmB,SAAQ,cAAc;IACpD,OAAuB,QAAQ,SAA4C;gBAE/D,OAAO,GAAE,MAAgB;CAItC;AAED,qBAAa,eAAgB,SAAQ,cAAc;IACjD,OAAuB,QAAQ,SAAyC;gBAE5D,OAAO,GAAE,MAAgB;CAItC"}

package/build/errors.js

@@ -0,0 +1,33 @@
+import { ResilientError } from '@owlmeans/error';
+export class ApiError extends ResilientError {
+    static typeName = 'ApiError';
+    constructor(message = 'error') {
+        super(ApiError.typeName, `api:${message}`);
+    }
+}
+export class ApiClientError extends ApiError {
+    static typeName = 'ApiClientError';
+    constructor(message = 'error') {
+        super(`client:${message}`);
+        this.type = ApiClientError.typeName;
+    }
+}
+export class ServerCrashedError extends ApiClientError {
+    static typeName = `${ApiClientError.typeName}ServerCrashed`;
+    constructor(message = 'error') {
+        super(`crashed:${message}`);
+        this.type = ServerCrashedError.typeName;
+    }
+}
+export class ServerAuthError extends ApiClientError {
+    static typeName = `${ApiClientError.typeName}ServerAuth`;
+    constructor(message = 'error') {
+        super(`auth:${message}`);
+        this.type = ServerAuthError.typeName;
+    }
+}
+ResilientError.registerErrorClass(ApiError);
+ResilientError.registerErrorClass(ApiClientError);
+ResilientError.registerErrorClass(ServerCrashedError);
+ResilientError.registerErrorClass(ServerAuthError);
+//# sourceMappingURL=errors.js.map

package/build/errors.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"errors.js","sourceRoot":"","sources":["../src/errors.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,iBAAiB,CAAA;AAEhD,MAAM,OAAO,QAAS,SAAQ,cAAc;IACnC,MAAM,CAAU,QAAQ,GAAG,UAAU,CAAA;IAE5C,YAAY,UAAkB,OAAO;QACnC,KAAK,CAAC,QAAQ,CAAC,QAAQ,EAAE,OAAO,OAAO,EAAE,CAAC,CAAA;IAC5C,CAAC;;AAGH,MAAM,OAAO,cAAe,SAAQ,QAAQ;IACnC,MAAM,CAAU,QAAQ,GAAG,gBAAgB,CAAA;IAElD,YAAY,UAAkB,OAAO;QACnC,KAAK,CAAC,UAAU,OAAO,EAAE,CAAC,CAAA;QAC1B,IAAI,CAAC,IAAI,GAAG,cAAc,CAAC,QAAQ,CAAA;IACrC,CAAC;;AAGH,MAAM,OAAO,kBAAmB,SAAQ,cAAc;IAC7C,MAAM,CAAU,QAAQ,GAAG,GAAG,cAAc,CAAC,QAAQ,eAAe,CAAA;IAE3E,YAAY,UAAkB,OAAO;QACnC,KAAK,CAAC,WAAW,OAAO,EAAE,CAAC,CAAA;QAC3B,IAAI,CAAC,IAAI,GAAG,kBAAkB,CAAC,QAAQ,CAAA;IACzC,CAAC;;AAGH,MAAM,OAAO,eAAgB,SAAQ,cAAc;IAC1C,MAAM,CAAU,QAAQ,GAAG,GAAG,cAAc,CAAC,QAAQ,YAAY,CAAA;IAExE,YAAY,UAAkB,OAAO;QACnC,KAAK,CAAC,QAAQ,OAAO,EAAE,CAAC,CAAA;QACxB,IAAI,CAAC,IAAI,GAAG,eAAe,CAAC,QAAQ,CAAA;IACtC,CAAC;;AAGH,cAAc,CAAC,kBAAkB,CAAC,QAAQ,CAAC,CAAA;AAC3C,cAAc,CAAC,kBAAkB,CAAC,cAAc,CAAC,CAAA;AACjD,cAAc,CAAC,kBAAkB,CAAC,kBAAkB,CAAC,CAAA;AACrD,cAAc,CAAC,kBAAkB,CAAC,eAAe,CAAC,CAAA"}

package/build/index.d.ts

@@ -0,0 +1,5 @@
+export * from './errors.js';
+export * from './consts.js';
+export * from './service.js';
+export type * from './types.js';
+//# sourceMappingURL=index.d.ts.map

package/build/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA,cAAc,aAAa,CAAA;AAC3B,cAAc,aAAa,CAAA;AAC3B,cAAc,cAAc,CAAA;AAC5B,mBAAmB,YAAY,CAAA"}

package/build/index.js

@@ -0,0 +1,4 @@
+export * from './errors.js';
+export * from './consts.js';
+export * from './service.js';
+//# sourceMappingURL=index.js.map

package/build/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA,cAAc,aAAa,CAAA;AAC3B,cAAc,aAAa,CAAA;AAC3B,cAAc,cAAc,CAAA"}

package/build/service.d.ts

@@ -0,0 +1,10 @@
+import type { BasicContext } from '@owlmeans/context';
+import type { ApiClient } from './types.js';
+import { BasicClientConfig } from '@owlmeans/client-config';
+type Config = BasicClientConfig;
+interface Context<C extends Config = Config> extends BasicContext<C> {
+}
+export declare const createApiService: (alias?: string) => ApiClient;
+export declare const appendApiClient: <C extends Config, T extends Context<C>>(ctx: T, alias?: string) => T;
+export {};
+//# sourceMappingURL=service.d.ts.map

package/build/service.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"service.d.ts","sourceRoot":"","sources":["../src/service.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAA;AAErD,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,YAAY,CAAA;AAM3C,OAAO,EAAE,iBAAiB,EAAE,MAAM,yBAAyB,CAAA;AAO3D,KAAK,MAAM,GAAG,iBAAiB,CAAA;AAE/B,UAAU,OAAO,CAAC,CAAC,SAAS,MAAM,GAAG,MAAM,CAAE,SAAQ,YAAY,CAAC,CAAC,CAAC;CACnE;AAED,eAAO,MAAM,gBAAgB,WAAW,MAAM,KAAmB,SAuEhE,CAAA;AAED,eAAO,MAAM,eAAe,GAAI,CAAC,SAAS,MAAM,EAAE,CAAC,SAAS,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC,UAAS,MAAM,KAAmB,CAU/G,CAAA"}

package/build/service.js

@@ -0,0 +1,76 @@
+import { assertContext, createService } from '@owlmeans/context';
+import { extractParams } from '@owlmeans/client-route';
+import axios from 'axios';
+import { DEFAULT_ALIAS } from './consts.js';
+import { processResponse } from './utils/handler.js';
+import qs from 'qs';
+import { makeSecurityHelper } from '@owlmeans/config';
+import { RouteMethod } from '@owlmeans/route';
+import { DEF_AUTH_SRV, TOKEN_UPDATE } from '@owlmeans/auth-common';
+export const createApiService = (alias = DEFAULT_ALIAS) => {
+    const location = `api.service:${alias}`;
+    const client = createService(alias, {
+        handler: async (request, reply) => {
+            if (request.canceled === true) {
+                return;
+            }
+            const context = assertContext(client.ctx, location);
+            const module = context.module(request.alias);
+            await module.resolve();
+            const route = module.route.route;
+            let path = module.getPath();
+            const params = extractParams(path);
+            path = params.reduce((path, param) => {
+                if (request.params[param] == null) {
+                    throw new SyntaxError(`No value for param ${param}`);
+                }
+                return path.replace(`:${param}`, `${request.params[param]}`);
+            }, path);
+            if (route.host == null && request.host == null) {
+                throw new SyntaxError(`No host provided in ${module.alias} route`);
+            }
+            const helper = makeSecurityHelper(context);
+            const url = helper.makeUrl(route, path, { host: request.host, base: request.base });
+            let transformer = undefined;
+            let body = request.body != null && Object.entries((request.headers ?? {})).find(([key, value]) => key.toLowerCase() === 'content-type' && value?.includes('application/x-www-form-urlencoded')) ? qs.stringify(request.body) : request.body;
+            // @TODO Probably this hack needs to be made a little bit less dirty
+            if (typeof body === 'string' && route.method === RouteMethod.POST) {
+                if (Object.keys(request.headers).every(key => key.toLowerCase() !== 'content-type')) {
+                    request.headers['content-type'] = 'application/json';
+                    // It fixes the case when final rest api under application/json can't
+                    // properly accept canonized jsoned string value (put into quotes)
+                    transformer = data => data;
+                }
+            }
+            const response = await axios.request({
+                url, method: route.method,
+                params: request.query,
+                data: body,
+                headers: request.headers,
+                transformRequest: transformer,
+                validateStatus: () => true,
+            });
+            // @TODO Move somewhere else - desirably into auth package via some middleware
+            const headers = response.headers;
+            if (headers.has(TOKEN_UPDATE) && context.hasService(DEF_AUTH_SRV)) {
+                const auth = context.service(DEF_AUTH_SRV);
+                const update = headers.get(TOKEN_UPDATE);
+                await auth.update(update == null || update === '' ? undefined : update);
+            }
+            processResponse(response, reply);
+            return [reply.error ?? reply.value, reply.outcome];
+        }
+    }, service => async () => {
+        service.initialized = true;
+    });
+    return client;
+};
+export const appendApiClient = (ctx, alias = DEFAULT_ALIAS) => {
+    const service = createApiService(alias);
+    ctx.registerService(service);
+    if (ctx.cfg.webService == null) {
+        ctx.cfg.webService = alias;
+    }
+    return ctx;
+};
+//# sourceMappingURL=service.js.map

package/build/service.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"service.js","sourceRoot":"","sources":["../src/service.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAA;AAEhE,OAAO,EAAE,aAAa,EAAE,MAAM,wBAAwB,CAAA;AAEtD,OAAO,KAAuB,MAAM,OAAO,CAAA;AAG3C,OAAO,EAAE,aAAa,EAAE,MAAM,aAAa,CAAA;AAC3C,OAAO,EAAE,eAAe,EAAE,MAAM,oBAAoB,CAAA;AAEpD,OAAO,EAAE,MAAM,IAAI,CAAA;AACnB,OAAO,EAAE,kBAAkB,EAAE,MAAM,kBAAkB,CAAA;AACrD,OAAO,EAAE,WAAW,EAAE,MAAM,iBAAiB,CAAA;AAC7C,OAAO,EAAE,YAAY,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAA;AAQlE,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC,QAAgB,aAAa,EAAa,EAAE;IAC3E,MAAM,QAAQ,GAAG,eAAe,KAAK,EAAE,CAAA;IACvC,MAAM,MAAM,GAAc,aAAa,CAAY,KAAK,EAAE;QACxD,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE,KAAK,EAAE,EAAE;YAChC,IAAI,OAAO,CAAC,QAAQ,KAAK,IAAI,EAAE,CAAC;gBAC9B,OAAM;YACR,CAAC;YACD,MAAM,OAAO,GAAG,aAAa,CAAkB,MAAM,CAAC,GAAG,EAAE,QAAQ,CAAC,CAAA;YACpE,MAAM,MAAM,GAAG,OAAO,CAAC,MAAM,CAAe,OAAO,CAAC,KAAK,CAAC,CAAA;YAC1D,MAAM,MAAM,CAAC,OAAO,EAAE,CAAA;YACtB,MAAM,KAAK,GAAG,MAAM,CAAC,KAAK,CAAC,KAAK,CAAA;YAChC,IAAI,IAAI,GAAG,MAAM,CAAC,OAAO,EAAE,CAAA;YAC3B,MAAM,MAAM,GAAG,aAAa,CAAC,IAAI,CAAC,CAAA;YAClC,IAAI,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE;gBAEnC,IAAI,OAAO,CAAC,MAAM,CAAC,KAAY,CAAC,IAAI,IAAI,EAAE,CAAC;oBACzC,MAAM,IAAI,WAAW,CAAC,sBAAsB,KAAK,EAAE,CAAC,CAAA;gBACtD,CAAC;gBACD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,KAAK,EAAE,EAAE,GAAG,OAAO,CAAC,MAAM,CAAC,KAAY,CAAC,EAAE,CAAC,CAAA;YACrE,CAAC,EAAE,IAAI,CAAC,CAAA;YACR,IAAI,KAAK,CAAC,IAAI,IAAI,IAAI,IAAI,OAAO,CAAC,IAAI,IAAI,IAAI,EAAE,CAAC;gBAC/C,MAAM,IAAI,WAAW,CAAC,uBAAuB,MAAM,CAAC,KAAK,QAAQ,CAAC,CAAA;YACpE,CAAC;YAED,MAAM,MAAM,GAAG,kBAAkB,CAAC,OAAO,CAAC,CAAA;YAE1C,MAAM,GAAG,GAAG,MAAM,CAAC,OAAO,CAAC,KAAK,EAAE,IAAI,EAAE,EAAE,IAAI,EAAE,OAAO,CAAC,IAAI,EAAE,IAAI,EAAE,OAAO,CAAC,IAAI,EAAE,CAAC,CAAA;YAEnF,IAAI,WAAW,GAAwC,SAAS,CAAA;YAEhE,IAAI,IAAI,GAAG,OAAO,CAAC,IAAI,IAAI,IAAI,IAAI,MAAM,CAAC,OAAO,CAAC,CAAC,OAAO,CAAC,OAAO,IAAI,EAAE,CAAC,CAAC,CAAC,IAAI,CAC7E,CAAC,CAAE,GAAG,EAAE,KAAK,CAAE,EAAE,EAAE,CACjB,GAAG,CAAC,WAAW,EAAE,KAAK,cAAc,IAAI,KAAK,EAAE,QAAQ,CAAC,mCAAmC,CAAC,CAC/F,CAAC,CAAC,CAAC,EAAE,CAAC,SAAS,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,CAAA;YAE7C,oEAAoE;YACpE,IAAI,OAAO,IAAI,KAAK,QAAQ,IAAI,KAAK,CAAC,MAAM,KAAK,WAAW,CAAC,IAAI,EAAE,CAAC;gBAClE,IAAI,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,WAAW,EAAE,KAAK,cAAc,CAAC,EAAE,CAAC;oBACpF,OAAO,CAAC,OAAO,CAAC,cAAc,CAAC,GAAG,kBAAkB,CAAA;oBACpD,qEAAqE;oBACrE,kEAAkE;oBAClE,WAAW,GAAG,IAAI,CAAC,EAAE,CAAC,IAAI,CAAA;gBAC5B,CAAC;YACH,CAAC;YAED,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,OAAO,CAAC;gBACnC,GAAG,EAAE,MAAM,EAAE,KAAK,CAAC,MAAM;gBACzB,MAAM,EAAE,OAAO,CAAC,KAAK;gBACrB,IAAI,EAAE,IAAI;gBACV,OAAO,EAAE,OAAO,CAAC,OAAO;gBACxB,gBAAgB,EAAE,WAAW;gBAC7B,cAAc,EAAE,GAAG,EAAE,CAAC,IAAI;aAC3B,CAAC,CAAA;YAEF,8EAA8E;YAC9E,MAAM,OAAO,GAAG,QAAQ,CAAC,OAAuB,CAAA;YAChD,IAAI,OAAO,CAAC,GAAG,CAAC,YAAY,CAAC,IAAI,OAAO,CAAC,UAAU,CAAC,YAAY,CAAC,EAAE,CAAC;gBAClE,MAAM,IAAI,GAAG,OAAO,CAAC,OAAO,CAAc,YAAY,CAAC,CAAA;gBACvD,MAAM,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,YAAY,CAAW,CAAA;gBAClD,MAAM,IAAI,CAAC,MAAM,CAAC,MAAM,IAAI,IAAI,IAAI,MAAM,KAAK,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,MAAM,CAAC,CAAA;YACzE,CAAC;YAED,eAAe,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAA;YAEhC,OAAO,CAAE,KAAK,CAAC,KAAK,IAAI,KAAK,CAAC,KAAK,EAAE,KAAK,CAAC,OAAO,CAAS,CAAA;QAC7D,CAAC;KACF,EAAE,OAAO,CAAC,EAAE,CAAC,KAAK,IAAI,EAAE;QACvB,OAAO,CAAC,WAAW,GAAG,IAAI,CAAA;IAC5B,CAAC,CAAC,CAAA;IAEF,OAAO,MAAM,CAAA;AACf,CAAC,CAAA;AAED,MAAM,CAAC,MAAM,eAAe,GAAG,CAAyC,GAAM,EAAE,QAAgB,aAAa,EAAK,EAAE;IAClH,MAAM,OAAO,GAAG,gBAAgB,CAAC,KAAK,CAAC,CAAA;IAEvC,GAAG,CAAC,eAAe,CAAC,OAAO,CAAC,CAAA;IAE5B,IAAI,GAAG,CAAC,GAAG,CAAC,UAAU,IAAI,IAAI,EAAE,CAAC;QAC/B,GAAG,CAAC,GAAG,CAAC,UAAU,GAAG,KAAK,CAAA;IAC5B,CAAC;IAED,OAAO,GAAG,CAAA;AACZ,CAAC,CAAA"}

package/build/types.d.ts

@@ -0,0 +1,6 @@
+import type { InitializedService } from '@owlmeans/context';
+import type { ModuleHandler } from '@owlmeans/module';
+export interface ApiClient extends InitializedService {
+    handler: ModuleHandler;
+}
+//# sourceMappingURL=types.d.ts.map

package/build/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,mBAAmB,CAAA;AAC3D,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAA;AAErD,MAAM,WAAW,SAAU,SAAQ,kBAAkB;IACnD,OAAO,EAAE,aAAa,CAAA;CACvB"}

package/build/types.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=types.js.map

package/build/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":""}

package/build/utils/handler.d.ts

@@ -0,0 +1,4 @@
+import type { AbstractResponse } from '@owlmeans/module';
+import type { AxiosResponse } from 'axios';
+export declare const processResponse: (response: AxiosResponse, reply: AbstractResponse<any>) => void;
+//# sourceMappingURL=handler.d.ts.map

package/build/utils/handler.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"handler.d.ts","sourceRoot":"","sources":["../../src/utils/handler.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,kBAAkB,CAAA;AAExD,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,OAAO,CAAA;AAK1C,eAAO,MAAM,eAAe,aAAc,aAAa,SAAS,gBAAgB,CAAC,GAAG,CAAC,SAyCpF,CAAA"}

package/build/utils/handler.js

@@ -0,0 +1,57 @@
+import { ModuleOutcome } from '@owlmeans/module';
+import { ACCEPTED, CREATED, FINISHED, FORBIDDEN_ERROR, OK, SERVER_ERROR, UNAUTHORIZED_ERROR } from '../consts.js';
+import { ResilientError } from '@owlmeans/error';
+import { ApiClientError, ServerAuthError, ServerCrashedError } from '../errors.js';
+export const processResponse = (response, reply) => {
+    switch (response.status) {
+        case OK:
+            reply.resolve(response.data, ModuleOutcome.Ok);
+            return;
+        case ACCEPTED:
+            reply.resolve(response.data, ModuleOutcome.Accepted);
+            return;
+        case CREATED:
+            return processEmptyResponse(response, reply, ModuleOutcome.Created);
+        case FINISHED:
+            return processEmptyResponse(response, reply, ModuleOutcome.Finished);
+        default:
+            console.error(response.status, response.statusText);
+            console.error(response.headers);
+            console.error(response.data);
+            try {
+                if (typeof response.data === 'string') {
+                    reply.reject(ResilientError.ensure(response.data, true));
+                    return;
+                }
+            }
+            catch {
+                console.error(`Server returned an unrecognizable text error: ${response.status} ${response.data}`);
+            }
+            switch (response.status) {
+                case SERVER_ERROR:
+                    reply.reject(new ServerCrashedError());
+                    return;
+                case UNAUTHORIZED_ERROR:
+                    reply.reject(new ServerAuthError());
+                    return;
+                case FORBIDDEN_ERROR:
+                    reply.reject(new ApiClientError('forbidden'));
+                    return;
+                default:
+                    reply.reject(new ApiClientError(`${response.status}`));
+                    return;
+            }
+    }
+};
+const processEmptyResponse = (response, reply, outcome) => {
+    if (response.data != null && response.data != '') {
+        reply.resolve(response.data, outcome);
+        return;
+    }
+    if (response.headers.toJSON != null && typeof response.headers.toJSON === 'function') {
+        reply.resolve(response.headers.toJSON(), outcome);
+        return;
+    }
+    reply.resolve(response.headers, outcome);
+};
+//# sourceMappingURL=handler.js.map

package/build/utils/handler.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"handler.js","sourceRoot":"","sources":["../../src/utils/handler.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAA;AAEhD,OAAO,EAAE,QAAQ,EAAE,OAAO,EAAE,QAAQ,EAAE,eAAe,EAAE,EAAE,EAAE,YAAY,EAAE,kBAAkB,EAAE,MAAM,cAAc,CAAA;AACjH,OAAO,EAAE,cAAc,EAAE,MAAM,iBAAiB,CAAA;AAChD,OAAO,EAAE,cAAc,EAAE,eAAe,EAAE,kBAAkB,EAAE,MAAM,cAAc,CAAA;AAElF,MAAM,CAAC,MAAM,eAAe,GAAG,CAAC,QAAuB,EAAE,KAA4B,EAAE,EAAE;IACvF,QAAQ,QAAQ,CAAC,MAAM,EAAE,CAAC;QACxB,KAAK,EAAE;YACL,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,IAAI,EAAE,aAAa,CAAC,EAAE,CAAC,CAAA;YAC9C,OAAM;QACR,KAAK,QAAQ;YACX,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,IAAI,EAAE,aAAa,CAAC,QAAQ,CAAC,CAAA;YACpD,OAAM;QACR,KAAK,OAAO;YACV,OAAO,oBAAoB,CAAC,QAAQ,EAAE,KAAK,EAAE,aAAa,CAAC,OAAO,CAAC,CAAA;QACrE,KAAK,QAAQ;YACX,OAAO,oBAAoB,CAAC,QAAQ,EAAE,KAAK,EAAE,aAAa,CAAC,QAAQ,CAAC,CAAA;QACtE;YAEE,OAAO,CAAC,KAAK,CAAC,QAAQ,CAAC,MAAM,EAAE,QAAQ,CAAC,UAAU,CAAC,CAAA;YACnD,OAAO,CAAC,KAAK,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAA;YAC/B,OAAO,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAA;YAE5B,IAAI,CAAC;gBACH,IAAI,OAAO,QAAQ,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;oBACtC,KAAK,CAAC,MAAM,CAAC,cAAc,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC,CAAA;oBACxD,OAAM;gBACR,CAAC;YACH,CAAC;YAAC,MAAM,CAAC;gBACP,OAAO,CAAC,KAAK,CAAC,iDAAiD,QAAQ,CAAC,MAAM,IAAI,QAAQ,CAAC,IAAI,EAAE,CAAC,CAAA;YACpG,CAAC;YACD,QAAQ,QAAQ,CAAC,MAAM,EAAE,CAAC;gBACxB,KAAK,YAAY;oBACf,KAAK,CAAC,MAAM,CAAC,IAAI,kBAAkB,EAAE,CAAC,CAAA;oBACtC,OAAM;gBACR,KAAK,kBAAkB;oBACrB,KAAK,CAAC,MAAM,CAAC,IAAI,eAAe,EAAE,CAAC,CAAA;oBACnC,OAAM;gBACR,KAAK,eAAe;oBAClB,KAAK,CAAC,MAAM,CAAC,IAAI,cAAc,CAAC,WAAW,CAAC,CAAC,CAAA;oBAC7C,OAAM;gBACR;oBACE,KAAK,CAAC,MAAM,CAAC,IAAI,cAAc,CAAC,GAAG,QAAQ,CAAC,MAAM,EAAE,CAAC,CAAC,CAAA;oBACtD,OAAM;YACV,CAAC;IACL,CAAC;AACH,CAAC,CAAA;AAED,MAAM,oBAAoB,GAAG,CAAC,QAAuB,EAAE,KAA4B,EAAE,OAAsB,EAAE,EAAE;IAC7G,IAAI,QAAQ,CAAC,IAAI,IAAI,IAAI,IAAI,QAAQ,CAAC,IAAI,IAAI,EAAE,EAAE,CAAC;QACjD,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,IAAI,EAAE,OAAO,CAAC,CAAA;QACrC,OAAM;IACR,CAAC;IACD,IAAI,QAAQ,CAAC,OAAO,CAAC,MAAM,IAAI,IAAI,IAAI,OAAO,QAAQ,CAAC,OAAO,CAAC,MAAM,KAAK,UAAU,EAAE,CAAC;QACrF,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,OAAO,CAAC,CAAA;QACjD,OAAM;IACR,CAAC;IACD,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC,CAAA;AAC1C,CAAC,CAAA"}

package/build/utils/index.d.ts

@@ -0,0 +1,2 @@
+export * from './handler.js';
+//# sourceMappingURL=index.d.ts.map

package/build/utils/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/utils/index.ts"],"names":[],"mappings":"AACA,cAAc,cAAc,CAAA"}

package/build/utils/index.js

@@ -0,0 +1,2 @@
+export * from './handler.js';
+//# sourceMappingURL=index.js.map

package/build/utils/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/utils/index.ts"],"names":[],"mappings":"AACA,cAAc,cAAc,CAAA"}

package/package.json

@@ -0,0 +1,44 @@
+{
+  "name": "@owlmeans/api",
+  "version": "0.1.0",
+  "type": "module",
+  "scripts": {
+    "build": "tsc -b",
+    "dev": "sleep 0 && nodemon -e ts,tsx,json --watch src --exec \"tsc -p ./tsconfig.json\"",
+    "watch": "tsc -b -w --preserveWatchOutput --pretty"
+  },
+  "main": "build/index.js",
+  "module": "build/index.js",
+  "types": "build/index.d.ts",
+  "exports": {
+    ".": {
+      "import": "./build/index.js",
+      "require": "./build/index.js",
+      "default": "./build/index.js",
+      "module": "./build/index.js",
+      "types": "./build/index.d.ts"
+    }
+  },
+  "dependencies": {
+    "@owlmeans/auth-common": "^0.1.0",
+    "@owlmeans/client-config": "^0.1.0",
+    "@owlmeans/client-route": "^0.1.0",
+    "@owlmeans/config": "^0.1.0",
+    "@owlmeans/context": "^0.1.0",
+    "@owlmeans/error": "^0.1.0",
+    "@owlmeans/module": "^0.1.0",
+    "@owlmeans/route": "^0.1.0",
+    "axios": "^1.7.7",
+    "qs": "^6.13.0"
+  },
+  "devDependencies": {
+    "@types/qs": "^6.9.16",
+    "nodemon": "^3.1.7",
+    "npm-check": "^6.0.1",
+    "typescript": "^5.6.3"
+  },
+  "private": false,
+  "publishConfig": {
+    "access": "public"
+  }
+}

package/src/consts.ts

@@ -0,0 +1,18 @@
+
+export const SERVER_ERROR = 500
+
+export const UNAUTHORIZED_ERROR = 401
+
+export const FORBIDDEN_ERROR = 403
+
+export const OK = 200
+
+export const CREATED = 201
+
+export const ACCEPTED = 202
+
+export const FINISHED = 204
+
+export const DEFAULT_ALIAS = 'web-client'
+
+export const protocols = ['http', 'https', 'wss', 'ws']

package/src/errors.ts

@@ -0,0 +1,41 @@
+import { ResilientError } from '@owlmeans/error'
+
+export class ApiError extends ResilientError {
+  public static override typeName = 'ApiError'
+
+  constructor(message: string = 'error') {
+    super(ApiError.typeName, `api:${message}`)
+  }
+}
+
+export class ApiClientError extends ApiError {
+  public static override typeName = 'ApiClientError'
+
+  constructor(message: string = 'error') {
+    super(`client:${message}`)
+    this.type = ApiClientError.typeName
+  }
+}
+
+export class ServerCrashedError extends ApiClientError {
+  public static override typeName = `${ApiClientError.typeName}ServerCrashed`
+
+  constructor(message: string = 'error') {
+    super(`crashed:${message}`)
+    this.type = ServerCrashedError.typeName
+  }
+}
+
+export class ServerAuthError extends ApiClientError {
+  public static override typeName = `${ApiClientError.typeName}ServerAuth`
+
+  constructor(message: string = 'error') {
+    super(`auth:${message}`)
+    this.type = ServerAuthError.typeName
+  }
+}
+
+ResilientError.registerErrorClass(ApiError)
+ResilientError.registerErrorClass(ApiClientError)
+ResilientError.registerErrorClass(ServerCrashedError)
+ResilientError.registerErrorClass(ServerAuthError)

package/src/index.ts

@@ -0,0 +1,5 @@
+
+export * from './errors.js'
+export * from './consts.js'
+export * from './service.js'
+export type * from './types.js'

package/src/service.ts

@@ -0,0 +1,105 @@
+import { assertContext, createService } from '@owlmeans/context'
+import type { BasicContext } from '@owlmeans/context'
+import { extractParams } from '@owlmeans/client-route'
+import type { ApiClient } from './types.js'
+import axios, { AxiosHeaders } from 'axios'
+import type { AxiosRequestTransformer } from 'axios'
+import type { CommonModule } from '@owlmeans/module'
+import { DEFAULT_ALIAS } from './consts.js'
+import { processResponse } from './utils/handler.js'
+import { BasicClientConfig } from '@owlmeans/client-config'
+import qs from 'qs'
+import { makeSecurityHelper } from '@owlmeans/config'
+import { RouteMethod } from '@owlmeans/route'
+import { DEF_AUTH_SRV, TOKEN_UPDATE } from '@owlmeans/auth-common'
+import type { AuthService } from '@owlmeans/auth-common'
+
+type Config = BasicClientConfig
+
+interface Context<C extends Config = Config> extends BasicContext<C> {
+}
+
+export const createApiService = (alias: string = DEFAULT_ALIAS): ApiClient => {
+  const location = `api.service:${alias}`
+  const client: ApiClient = createService<ApiClient>(alias, {
+    handler: async (request, reply) => {
+      if (request.canceled === true) {
+        return
+      }
+      const context = assertContext<Config, Context>(client.ctx, location)
+      const module = context.module<CommonModule>(request.alias)
+      await module.resolve()
+      const route = module.route.route
+      let path = module.getPath()
+      const params = extractParams(path)
+      path = params.reduce((path, param) => {
+        type Key = keyof typeof request.params
+        if (request.params[param as Key] == null) {
+          throw new SyntaxError(`No value for param ${param}`)
+        }
+        return path.replace(`:${param}`, `${request.params[param as Key]}`)
+      }, path)
+      if (route.host == null && request.host == null) {
+        throw new SyntaxError(`No host provided in ${module.alias} route`)
+      }
+
+      const helper = makeSecurityHelper(context)
+
+      const url = helper.makeUrl(route, path, { host: request.host, base: request.base })
+
+      let transformer: AxiosRequestTransformer | undefined = undefined
+
+      let body = request.body != null && Object.entries((request.headers ?? {})).find(
+        ([ key, value ]) =>
+          key.toLowerCase() === 'content-type' && value?.includes('application/x-www-form-urlencoded')
+      ) ? qs.stringify(request.body) : request.body
+
+      // @TODO Probably this hack needs to be made a little bit less dirty
+      if (typeof body === 'string' && route.method === RouteMethod.POST) {
+        if (Object.keys(request.headers).every(key => key.toLowerCase() !== 'content-type')) {
+          request.headers['content-type'] = 'application/json'
+          // It fixes the case when final rest api under application/json can't
+          // properly accept canonized jsoned string value (put into quotes)
+          transformer = data => data
+        }
+      }
+
+      const response = await axios.request({
+        url, method: route.method,
+        params: request.query,
+        data: body,
+        headers: request.headers,
+        transformRequest: transformer,
+        validateStatus: () => true,
+      })
+
+      // @TODO Move somewhere else - desirably into auth package via some middleware
+      const headers = response.headers as AxiosHeaders
+      if (headers.has(TOKEN_UPDATE) && context.hasService(DEF_AUTH_SRV)) {
+        const auth = context.service<AuthService>(DEF_AUTH_SRV)
+        const update = headers.get(TOKEN_UPDATE) as string
+        await auth.update(update == null || update === '' ? undefined : update)
+      }
+
+      processResponse(response, reply)
+
+      return [ reply.error ?? reply.value, reply.outcome ] as any
+    }
+  }, service => async () => {
+    service.initialized = true
+  })
+
+  return client
+}
+
+export const appendApiClient = <C extends Config, T extends Context<C>>(ctx: T, alias: string = DEFAULT_ALIAS): T => {
+  const service = createApiService(alias)
+
+  ctx.registerService(service)
+
+  if (ctx.cfg.webService == null) {
+    ctx.cfg.webService = alias
+  }
+
+  return ctx
+}

package/src/types.ts

@@ -0,0 +1,6 @@
+import type { InitializedService } from '@owlmeans/context'
+import type { ModuleHandler } from '@owlmeans/module'
+
+export interface ApiClient extends InitializedService {
+  handler: ModuleHandler
+}

package/src/utils/handler.ts

@@ -0,0 +1,61 @@
+import type { AbstractResponse } from '@owlmeans/module'
+import { ModuleOutcome } from '@owlmeans/module'
+import type { AxiosResponse } from 'axios'
+import { ACCEPTED, CREATED, FINISHED, FORBIDDEN_ERROR, OK, SERVER_ERROR, UNAUTHORIZED_ERROR } from '../consts.js'
+import { ResilientError } from '@owlmeans/error'
+import { ApiClientError, ServerAuthError, ServerCrashedError } from '../errors.js'
+
+export const processResponse = (response: AxiosResponse, reply: AbstractResponse<any>) => {
+  switch (response.status) {
+    case OK:
+      reply.resolve(response.data, ModuleOutcome.Ok)
+      return
+    case ACCEPTED:
+      reply.resolve(response.data, ModuleOutcome.Accepted)
+      return
+    case CREATED:
+      return processEmptyResponse(response, reply, ModuleOutcome.Created)
+    case FINISHED:
+      return processEmptyResponse(response, reply, ModuleOutcome.Finished)
+    default:
+
+      console.error(response.status, response.statusText)
+      console.error(response.headers)
+      console.error(response.data)
+
+      try {
+        if (typeof response.data === 'string') {
+          reply.reject(ResilientError.ensure(response.data, true))
+          return
+        }
+      } catch {
+        console.error(`Server returned an unrecognizable text error: ${response.status} ${response.data}`)
+      }
+      switch (response.status) {
+        case SERVER_ERROR:
+          reply.reject(new ServerCrashedError())
+          return
+        case UNAUTHORIZED_ERROR:
+          reply.reject(new ServerAuthError())
+          return
+        case FORBIDDEN_ERROR:
+          reply.reject(new ApiClientError('forbidden'))
+          return
+        default:
+          reply.reject(new ApiClientError(`${response.status}`))
+          return
+      }
+  }
+}
+
+const processEmptyResponse = (response: AxiosResponse, reply: AbstractResponse<any>, outcome: ModuleOutcome) => {
+  if (response.data != null && response.data != '') {
+    reply.resolve(response.data, outcome)
+    return
+  }
+  if (response.headers.toJSON != null && typeof response.headers.toJSON === 'function') {
+    reply.resolve(response.headers.toJSON(), outcome)
+    return
+  }
+  reply.resolve(response.headers, outcome)
+}

package/src/utils/index.ts

@@ -0,0 +1,2 @@
+
+export * from './handler.js'

package/tsconfig.json

@@ -0,0 +1,14 @@
+{
+  "extends": [
+    "../tsconfig.default.json",
+  ],
+  "compilerOptions": {
+    "rootDir": "./src/", /* Specify the root folder within your source files. */
+    "outDir": "./build/", /* Specify an output folder for all emitted files. */
+  },
+  "exclude": [
+    "./dist/**/*",
+    "./build/**/*",
+    "./*.ts"
+  ]
+}

package/tsconfig.tsbuildinfo

@@ -0,0 +1 @@
+{"root":["./src/consts.ts","./src/errors.ts","./src/index.ts","./src/service.ts","./src/types.ts","./src/utils/handler.ts","./src/utils/index.ts"],"version":"5.6.3"}