@owlmeans/api 0.1.2 → 0.1.3

package/README.md

@@ -1,288 +1,58 @@
 # @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.
+HTTP API client service for OwlMeans client contexts — handles module-based requests with auth token injection.
 
 ## 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
+- `createApiService(alias?)` — creates an HTTP API client service
+- `appendApiClient(ctx, alias?)` — registers the API client in the context
+- `ApiClient` — the service interface; handles `GET`/`POST`/`PUT`/`DELETE` requests
+- Error classes: `ApiError`, `ApiClientError`, `ServerCrashedError`, `ServerAuthError`
 
 ## 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')
+bun add @owlmeans/api
 ```
 
-### 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.
+## Usage
 
-#### `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
+The API client is registered automatically by `@owlmeans/web-client`'s `makeContext`. Direct use is only needed for custom setups:
 
 ```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' }
-}
+appendApiClient(context)
 ```
 
-### URL Construction
-
-URLs are automatically constructed from module route definitions:
+HTTP status constants:
 
 ```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
+import { OK, CREATED, UNAUTHORIZED_ERROR, NOT_FOUND_ERROR } from '@owlmeans/api'
 ```
 
-### Response Processing
+## API
 
-The client processes various response scenarios:
+### `createApiService(alias?): ApiClient`
 
-```typescript
-// Success responses (200, 201, 202, 204)
-// Error responses (401, 403, 500, etc.)
-// Custom error marshaling from server
-// Header-based responses for empty bodies
-```
+Creates an HTTP client service. `alias` defaults to `DEFAULT_ALIAS` (`'web-client'`).
 
-## Integration with OwlMeans Ecosystem
+### `appendApiClient<C, T>(ctx, alias?): T`
 
-The `@owlmeans/api` package integrates with:
+Registers the API client in the context.
 
-- **@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
+### Error Classes
 
-## Security Considerations
+- `ApiError` — base API error
+- `ApiClientError` — client-side request error
+- `ServerCrashedError` — 5xx response
+- `ServerAuthError` — 401/403 response
 
-- 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
+### Constants
 
-## Performance Features
+`DEFAULT_ALIAS`, `OK`, `CREATED`, `UNAUTHORIZED_ERROR`, `NOT_FOUND_ERROR`, `SERVER_ERROR`
 
-- Automatic request cancellation support
-- Efficient parameter extraction and URL construction
-- Minimal overhead for authenticated requests
-- Built-in retry logic through the OwlMeans module system
+## Related Packages
 
-Fixes #32.
+- [`@owlmeans/client-module`](../client-module) — `ClientModule<T>` uses this service to make requests
+- [`@owlmeans/web-client`](../web-client) — registers this service via `makeContext`

package/build/service.js

@@ -15,7 +15,7 @@ export const createApiService = (alias = DEFAULT_ALIAS) => {
                 return;
             }
             const context = assertContext(client.ctx, location);
-            const module = context.module(request.alias);
+            const module = context.entrypoint(request.alias);
             await module.resolve();
             const route = module.route.route;
             let path = module.getPath();

package/build/service.js.map

@@ -1 +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,aAAa,EAAE,OAAO,CAAC,QAAQ,EAAE,CAAC,CAAA;YAEpH,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,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE,CACf,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,CAAC,KAAK,CAAC,KAAK,IAAI,KAAK,CAAC,KAAK,EAAE,KAAK,CAAC,OAAO,CAAQ,CAAA;QAC3D,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"}
+{"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,UAAU,CAAmB,OAAO,CAAC,KAAK,CAAC,CAAA;YAClE,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,aAAa,EAAE,OAAO,CAAC,QAAQ,EAAE,CAAC,CAAA;YAEpH,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,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE,CACf,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,CAAC,KAAK,CAAC,KAAK,IAAI,KAAK,CAAC,KAAK,EAAE,KAAK,CAAC,OAAO,CAAQ,CAAA;QAC3D,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

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

package/build/types.d.ts.map

@@ -1 +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"}
+{"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,iBAAiB,EAAE,MAAM,sBAAsB,CAAA;AAE7D,MAAM,WAAW,SAAU,SAAQ,kBAAkB;IACnD,OAAO,EAAE,iBAAiB,CAAA;CAC3B"}

package/build/utils/handler.d.ts

@@ -1,4 +1,4 @@
-import type { AbstractResponse } from '@owlmeans/module';
+import type { AbstractResponse } from '@owlmeans/entrypoint';
 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

@@ -1 +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,GAAI,UAAU,aAAa,EAAE,OAAO,gBAAgB,CAAC,GAAG,CAAC,SAyCpF,CAAA"}
+{"version":3,"file":"handler.d.ts","sourceRoot":"","sources":["../../src/utils/handler.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,sBAAsB,CAAA;AAE5D,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,OAAO,CAAA;AAK1C,eAAO,MAAM,eAAe,GAAI,UAAU,aAAa,EAAE,OAAO,gBAAgB,CAAC,GAAG,CAAC,SAyCpF,CAAA"}

package/build/utils/handler.js

@@ -1,19 +1,19 @@
-import { ModuleOutcome } from '@owlmeans/module';
+import { EntrypointOutcome } from '@owlmeans/entrypoint';
 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);
+            reply.resolve(response.data, EntrypointOutcome.Ok);
             return;
         case ACCEPTED:
-            reply.resolve(response.data, ModuleOutcome.Accepted);
+            reply.resolve(response.data, EntrypointOutcome.Accepted);
             return;
         case CREATED:
-            return processEmptyResponse(response, reply, ModuleOutcome.Created);
+            return processEmptyResponse(response, reply, EntrypointOutcome.Created);
         case FINISHED:
-            return processEmptyResponse(response, reply, ModuleOutcome.Finished);
+            return processEmptyResponse(response, reply, EntrypointOutcome.Finished);
         default:
             console.error(response.status, response.statusText);
             console.error(response.config.url, response.headers);

package/build/utils/handler.js.map

@@ -1 +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,MAAM,CAAC,GAAG,EAAE,QAAQ,CAAC,OAAO,CAAC,CAAA;YACpD,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"}
+{"version":3,"file":"handler.js","sourceRoot":"","sources":["../../src/utils/handler.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,iBAAiB,EAAE,MAAM,sBAAsB,CAAA;AAExD,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,iBAAiB,CAAC,EAAE,CAAC,CAAA;YAClD,OAAM;QACR,KAAK,QAAQ;YACX,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,IAAI,EAAE,iBAAiB,CAAC,QAAQ,CAAC,CAAA;YACxD,OAAM;QACR,KAAK,OAAO;YACV,OAAO,oBAAoB,CAAC,QAAQ,EAAE,KAAK,EAAE,iBAAiB,CAAC,OAAO,CAAC,CAAA;QACzE,KAAK,QAAQ;YACX,OAAO,oBAAoB,CAAC,QAAQ,EAAE,KAAK,EAAE,iBAAiB,CAAC,QAAQ,CAAC,CAAA;QAC1E;YAEE,OAAO,CAAC,KAAK,CAAC,QAAQ,CAAC,MAAM,EAAE,QAAQ,CAAC,UAAU,CAAC,CAAA;YACnD,OAAO,CAAC,KAAK,CAAC,QAAQ,CAAC,MAAM,CAAC,GAAG,EAAE,QAAQ,CAAC,OAAO,CAAC,CAAA;YACpD,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,OAA0B,EAAE,EAAE;IACjH,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/package.json

@@ -1,6 +1,7 @@
 {
   "name": "@owlmeans/api",
-  "version": "0.1.2",
+  "version": "0.1.3",
+  "license": "MIT",
   "type": "module",
   "scripts": {
     "build": "tsc -b",
@@ -20,22 +21,23 @@
     }
   },
   "dependencies": {
-    "@owlmeans/auth-common": "^0.1.2",
-    "@owlmeans/client-config": "^0.1.2",
-    "@owlmeans/client-route": "^0.1.2",
-    "@owlmeans/config": "^0.1.2",
-    "@owlmeans/context": "^0.1.2",
-    "@owlmeans/error": "^0.1.2",
-    "@owlmeans/module": "^0.1.2",
-    "@owlmeans/route": "^0.1.2",
+    "@owlmeans/auth-common": "^0.1.3",
+    "@owlmeans/client-config": "^0.1.3",
+    "@owlmeans/client-route": "^0.1.3",
+    "@owlmeans/config": "^0.1.3",
+    "@owlmeans/context": "^0.1.3",
+    "@owlmeans/error": "^0.1.3",
+    "@owlmeans/entrypoint": "^0.1.3",
+    "@owlmeans/route": "^0.1.3",
     "axios": "^1.7.7",
     "qs": "^6.13.0"
   },
   "devDependencies": {
+    "@owlmeans/dep-config": "workspace:*",
     "@types/qs": "^6.9.16",
     "nodemon": "^3.1.11",
     "npm-check": "^6.0.1",
-    "typescript": "^5.8.3"
+    "typescript": "^6.0.2"
   },
   "publishConfig": {
     "access": "public"

package/src/service.ts

@@ -4,7 +4,7 @@ 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 type { CommonEntrypoint } from '@owlmeans/entrypoint'
 import { DEFAULT_ALIAS } from './consts.js'
 import { processResponse } from './utils/handler.js'
 import { BasicClientConfig } from '@owlmeans/client-config'
@@ -27,7 +27,7 @@ export const createApiService = (alias: string = DEFAULT_ALIAS): ApiClient => {
         return
       }
       const context = assertContext<Config, Context>(client.ctx, location)
-      const module = context.module<CommonModule>(request.alias)
+      const module = context.entrypoint<CommonEntrypoint>(request.alias)
       await module.resolve()
       const route = module.route.route
       let path = module.getPath()

package/src/types.ts

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

package/src/utils/handler.ts

@@ -1,5 +1,5 @@
-import type { AbstractResponse } from '@owlmeans/module'
-import { ModuleOutcome } from '@owlmeans/module'
+import type { AbstractResponse } from '@owlmeans/entrypoint'
+import { EntrypointOutcome } from '@owlmeans/entrypoint'
 import type { AxiosResponse } from 'axios'
 import { ACCEPTED, CREATED, FINISHED, FORBIDDEN_ERROR, OK, SERVER_ERROR, UNAUTHORIZED_ERROR } from '../consts.js'
 import { ResilientError } from '@owlmeans/error'
@@ -8,15 +8,15 @@ import { ApiClientError, ServerAuthError, ServerCrashedError } from '../errors.j
 export const processResponse = (response: AxiosResponse, reply: AbstractResponse<any>) => {
   switch (response.status) {
     case OK:
-      reply.resolve(response.data, ModuleOutcome.Ok)
+      reply.resolve(response.data, EntrypointOutcome.Ok)
       return
     case ACCEPTED:
-      reply.resolve(response.data, ModuleOutcome.Accepted)
+      reply.resolve(response.data, EntrypointOutcome.Accepted)
       return
     case CREATED:
-      return processEmptyResponse(response, reply, ModuleOutcome.Created)
+      return processEmptyResponse(response, reply, EntrypointOutcome.Created)
     case FINISHED:
-      return processEmptyResponse(response, reply, ModuleOutcome.Finished)
+      return processEmptyResponse(response, reply, EntrypointOutcome.Finished)
     default:
 
       console.error(response.status, response.statusText)
@@ -48,7 +48,7 @@ export const processResponse = (response: AxiosResponse, reply: AbstractResponse
   }
 }
 
-const processEmptyResponse = (response: AxiosResponse, reply: AbstractResponse<any>, outcome: ModuleOutcome) => {
+const processEmptyResponse = (response: AxiosResponse, reply: AbstractResponse<any>, outcome: EntrypointOutcome) => {
   if (response.data != null && response.data != '') {
     reply.resolve(response.data, outcome)
     return

package/tsconfig.json

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