@tstdl/base 0.88.6 → 0.89.0

package/api/index.d.ts

@@ -1,14 +1,18 @@
 /**
- * Module for creating and consuming HTTP apis with built-in support for validation and error handling.
+ * Create and consume HTTP APIs
+ *
+ * It has built-in support for validation and error handling.
  *
  * This module contains types and functions to define and register apis and error handlers.
  *
  * Consumers of these definitions are [client](api_client.html) and [server](api_server.html).
  *
- * A basic example with a working minimal api server and client can be found in `source/examples/api/basic-overview.ts`
+ * Examples can be found in `source/examples/api/`.
  *
- * @module
+ * @module API
  */
+export * from './client/index.js';
 export * from './default-error-handlers.js';
 export * from './response.js';
+export * from './server/index.js';
 export * from './types.js';

package/api/index.js

@@ -1,14 +1,18 @@
 /**
- * Module for creating and consuming HTTP apis with built-in support for validation and error handling.
+ * Create and consume HTTP APIs
+ *
+ * It has built-in support for validation and error handling.
  *
  * This module contains types and functions to define and register apis and error handlers.
  *
  * Consumers of these definitions are [client](api_client.html) and [server](api_server.html).
  *
- * A basic example with a working minimal api server and client can be found in `source/examples/api/basic-overview.ts`
+ * Examples can be found in `source/examples/api/`.
  *
- * @module
+ * @module API
  */
+export * from './client/index.js';
 export * from './default-error-handlers.js';
 export * from './response.js';
+export * from './server/index.js';
 export * from './types.js';

package/application/index.d.ts

@@ -1 +1,6 @@
+/**
+ * Start application modules and shutting down the app
+ *
+ * @module Application
+ */
 export * from './application.js';

package/application/index.js

@@ -1 +1,6 @@
+/**
+ * Start application modules and shutting down the app
+ *
+ * @module Application
+ */
 export * from './application.js';

package/authentication/client/authentication.service.d.ts

@@ -4,7 +4,7 @@ import type { AfterResolve } from '../../injector/index.js';
 import { afterResolve } from '../../injector/index.js';
 import type { Record } from '../../types.js';
 import type { SecretCheckResult, TokenPayload } from '../models/index.js';
-export declare class AuthenticationService<AdditionalTokenPayload extends Record = Record, AuthenticationData = any> implements AfterResolve, AsyncDisposable {
+export declare class AuthenticationClientService<AdditionalTokenPayload extends Record = Record, AuthenticationData = any> implements AfterResolve, AsyncDisposable {
     private readonly client;
     private readonly errorSubject;
     private readonly tokenUpdateBus;

package/authentication/client/authentication.service.js

@@ -33,7 +33,7 @@ const authenticationDataStorageKey = 'AuthenticationService:authentication-data'
 const tokenUpdateBusName = 'AuthenticationService:tokenUpdate';
 const loggedOutBusName = 'AuthenticationService:loggedOut';
 const refreshLockResource = 'AuthenticationService:refresh';
-let AuthenticationService = class AuthenticationService {
+let AuthenticationClientService = class AuthenticationClientService {
     client = inject(AUTHENTICATION_API_CLIENT);
     errorSubject = new Subject();
     tokenUpdateBus = inject((MessageBus), tokenUpdateBusName);
@@ -211,10 +211,10 @@ let AuthenticationService = class AuthenticationService {
         }
     }
 };
-AuthenticationService = __decorate([
+AuthenticationClientService = __decorate([
     Singleton(),
     __param(0, Inject(INITIAL_AUTHENTICATION_DATA)),
     __param(0, Optional()),
     __metadata("design:paramtypes", [Object])
-], AuthenticationService);
-export { AuthenticationService };
+], AuthenticationClientService);
+export { AuthenticationClientService };

package/authentication/client/http-client.middleware.d.ts

@@ -1,4 +1,4 @@
 import type { HttpClientMiddleware } from '../../http/client/middleware.js';
 import type { ValueOrAsyncProvider } from '../../utils/value-or-provider.js';
-import type { AuthenticationService } from './authentication.service.js';
-export declare function waitForAuthenticationCredentialsMiddleware(authenticationServiceOrProvider: ValueOrAsyncProvider<AuthenticationService>): HttpClientMiddleware;
+import type { AuthenticationClientService } from './authentication.service.js';
+export declare function waitForAuthenticationCredentialsMiddleware(authenticationServiceOrProvider: ValueOrAsyncProvider<AuthenticationClientService>): HttpClientMiddleware;

package/authentication/client/module.d.ts

@@ -2,9 +2,9 @@ import type { ApiClientImplementation } from '../../api/index.js';
 import { Injector } from '../../injector/injector.js';
 import type { Type } from '../../types.js';
 import type { AuthenticationApiDefinition } from '../authentication.api.js';
-export type AuthenticationModuleConfig = {
+export type AuthenticationClientModuleConfig = {
     authenticationApiClient?: Type<ApiClientImplementation<AuthenticationApiDefinition<any, any>>>;
     initialAuthenticationData?: unknown;
     registerMiddleware?: boolean;
 };
-export declare function configureAuthenticationClient(config: AuthenticationModuleConfig, injector?: Injector | null): void;
+export declare function configureAuthenticationClient(config: AuthenticationClientModuleConfig, injector?: Injector | null): void;

package/authentication/client/module.js

@@ -2,7 +2,7 @@ import { HTTP_CLIENT_MIDDLEWARE } from '../../http/client/tokens.js';
 import { getCurrentInjector } from '../../injector/inject.js';
 import { Injector } from '../../injector/injector.js';
 import { isDefined } from '../../utils/type-guards.js';
-import { AuthenticationService } from './authentication.service.js';
+import { AuthenticationClientService } from './authentication.service.js';
 import { waitForAuthenticationCredentialsMiddleware } from './http-client.middleware.js';
 import { AUTHENTICATION_API_CLIENT, INITIAL_AUTHENTICATION_DATA } from './tokens.js';
 export function configureAuthenticationClient(config, injector = getCurrentInjector()) {
@@ -15,7 +15,7 @@ export function configureAuthenticationClient(config, injector = getCurrentInjec
     if (isDefined(config.registerMiddleware)) {
         (injector ?? Injector).register(HTTP_CLIENT_MIDDLEWARE, {
             useFactory(_, context) {
-                const authenticationService = context.resolve(AuthenticationService, undefined, { forwardRef: true, forwardRefTypeHint: 'object' });
+                const authenticationService = context.resolve(AuthenticationClientService, undefined, { forwardRef: true, forwardRefTypeHint: 'object' });
                 return waitForAuthenticationCredentialsMiddleware(authenticationService);
             }
         }, { multi: true });

package/authentication/index.d.ts

@@ -1,3 +1,10 @@
+/**
+ * User Authentication
+ *
+ * @module Authentication
+ */
 export * from './authentication.api.js';
+export * from './client/index.js';
 export * from './errors/index.js';
 export * from './models/index.js';
+export * from './server/index.js';

package/authentication/index.js

@@ -1,3 +1,10 @@
+/**
+ * User Authentication
+ *
+ * @module Authentication
+ */
 export * from './authentication.api.js';
+export * from './client/index.js';
 export * from './errors/index.js';
 export * from './models/index.js';
+export * from './server/index.js';

package/browser/index.d.ts

@@ -1,3 +1,8 @@
+/**
+ * Web automation
+ *
+ * @module Browser
+ */
 export * from './browser-context-controller.js';
 export * from './browser-controller.js';
 export * from './browser.service.js';

package/browser/index.js

@@ -1,3 +1,8 @@
+/**
+ * Web automation
+ *
+ * @module Browser
+ */
 export * from './browser-context-controller.js';
 export * from './browser-controller.js';
 export * from './browser.service.js';

package/cancellation/index.d.ts

@@ -1 +1,5 @@
+/**
+ * Cancellation signaling
+ * @module Cancellation
+ */
 export * from './token.js';

package/cancellation/index.js

@@ -1 +1,5 @@
+/**
+ * Cancellation signaling
+ * @module Cancellation
+ */
 export * from './token.js';

package/collections/index.d.ts

@@ -1,3 +1,8 @@
+/**
+ * Data structures
+ *
+ * @module Collections
+ */
 export * from './collection.js';
 export * from './keyed-set.js';
 export * from './list.js';

package/collections/index.js

@@ -1,3 +1,8 @@
+/**
+ * Data structures
+ *
+ * @module Collections
+ */
 export * from './collection.js';
 export * from './keyed-set.js';
 export * from './list.js';

package/cookie/index.d.ts

@@ -1 +1,6 @@
+/**
+ * Cookie creation and parsing
+ *
+ * @module Cookie
+ */
 export * from './cookie.js';

package/cookie/index.js

@@ -1 +1,6 @@
+/**
+ * Cookie creation and parsing
+ *
+ * @module Cookie
+ */
 export * from './cookie.js';

package/data-structures/index.d.ts

@@ -1,3 +1,8 @@
+/**
+ * Data Structures
+ *
+ * @module Data Structures
+ */
 export * from './array-dictionary.js';
 export * from './array-list.js';
 export * from './cache.js';

package/data-structures/index.js

@@ -1,3 +1,8 @@
+/**
+ * Data Structures
+ *
+ * @module Data Structures
+ */
 export * from './array-dictionary.js';
 export * from './array-list.js';
 export * from './cache.js';

package/database/index.d.ts

@@ -1,3 +1,8 @@
+/**
+ * Repository abstractions
+ *
+ * @module Database
+ */
 export * from './entity-repository.js';
 export * from './entity.js';
 export * from './id.js';

package/database/index.js

@@ -1,3 +1,8 @@
+/**
+ * Repository abstractions
+ *
+ * @module Database
+ */
 export * from './entity-repository.js';
 export * from './entity.js';
 export * from './id.js';

package/database/mongo/index.d.ts

@@ -1,3 +1,8 @@
+/**
+ * MongoDB implemenation for Database module
+ *
+ * @module Database - MongoDB
+ */
 export * from './classes.js';
 export * from './model/index.js';
 export * from './module.js';

package/database/mongo/index.js

@@ -1,3 +1,8 @@
+/**
+ * MongoDB implemenation for Database module
+ *
+ * @module Database - MongoDB
+ */
 export * from './classes.js';
 export * from './model/index.js';
 export * from './module.js';

package/database/mongo/module.js

@@ -6,7 +6,7 @@ import { Collection, Database, MongoClient } from './classes.js';
 export const mongoModuleConfig = {
     defaultConnection: { url: 'mongodb://localhost:27017/test-db' },
     defaultDatabase: undefined,
-    logPrefix: 'MONGO'
+    logPrefix: 'Mongo'
 };
 export function configureMongo(config) {
     mongoModuleConfig.defaultDatabase = config.defaultDatabase ?? mongoModuleConfig.defaultDatabase;

package/decorators/index.d.ts

@@ -1 +1,6 @@
+/**
+ * Collection of decorators
+ *
+ * @module Decorators
+ */
 export * from './log.js';

package/decorators/index.js

@@ -1 +1,6 @@
+/**
+ * Collection of decorators
+ *
+ * @module Decorators
+ */
 export * from './log.js';

package/disposable/index.d.ts

@@ -1,3 +1,8 @@
+/**
+ * Dispose pattern
+ *
+ * @module Disposable
+ */
 export * from './async-disposer.js';
 export * from './disposable.js';
 export * from './using.js';

package/disposable/index.js

@@ -1,3 +1,8 @@
+/**
+ * Dispose pattern
+ *
+ * @module Disposable
+ */
 export * from './async-disposer.js';
 export * from './disposable.js';
 export * from './using.js';

package/distributed-loop/index.d.ts

@@ -1,3 +1,8 @@
+/**
+ * Distributed (clusterd) loop
+ *
+ * @module Distributed Loop
+ */
 export * from './controller.js';
 export * from './distributed-loop.js';
 export * from './provider.js';

package/distributed-loop/index.js

@@ -1,3 +1,8 @@
+/**
+ * Distributed (clusterd) loop
+ *
+ * @module Distributed Loop
+ */
 export * from './controller.js';
 export * from './distributed-loop.js';
 export * from './provider.js';

package/enumerable/index.d.ts

@@ -1,2 +1,7 @@
+/**
+ * Iteration of item iterables
+ *
+ * @module Enumerable
+ */
 export * from './async-enumerable.js';
 export * from './enumerable.js';

package/enumerable/index.js

@@ -1,2 +1,7 @@
+/**
+ * Iteration of item iterables
+ *
+ * @module Enumerable
+ */
 export * from './async-enumerable.js';
 export * from './enumerable.js';

package/error/index.d.ts

@@ -1,3 +1,8 @@
+/**
+ * Errors
+ *
+ * @module Error
+ */
 export * from './api.error.js';
 export * from './assertion.error.js';
 export * from './bad-request.error.js';

package/error/index.js

@@ -1,3 +1,8 @@
+/**
+ * Errors
+ *
+ * @module Error
+ */
 export * from './api.error.js';
 export * from './assertion.error.js';
 export * from './bad-request.error.js';

package/examples/api/authentication.js

@@ -3,7 +3,7 @@ import '../../polyfills.js';
 import { configureApiServer } from '../../api/server/index.js';
 import { Application } from '../../application/application.js';
 import { AuthenticationApiClient } from '../../authentication/client/api.client.js';
-import { AuthenticationService as AuthenticationClientService, configureAuthenticationClient } from '../../authentication/client/index.js';
+import { AuthenticationClientService, configureAuthenticationClient } from '../../authentication/client/index.js';
 import { AuthenticationApiController, AuthenticationService as AuthenticationServerService, configureAuthenticationServer } from '../../authentication/server/index.js';
 import { MongoAuthenticationCredentialsRepository, configureMongoAuthenticationCredentialsRepository } from '../../authentication/server/mongo/mongo-authentication-credentials.repository.js';
 import { MongoAuthenticationSessionRepository, configureMongoAuthenticationSessionRepository } from '../../authentication/server/mongo/mongo-authentication-session.repository.js';

package/examples/api/custom-authentication.js

@@ -11,7 +11,7 @@ var __metadata = (this && this.__metadata) || function (k, v) {
 import '../../polyfills.js';
 import { configureApiServer } from '../../api/server/index.js';
 import { Application } from '../../application/application.js';
-import { AuthenticationService as AuthenticationClientService, configureAuthenticationClient, getAuthenticationApiClient } from '../../authentication/client/index.js';
+import { AuthenticationClientService, configureAuthenticationClient, getAuthenticationApiClient } from '../../authentication/client/index.js';
 import { AuthenticationTokenPayloadProvider } from '../../authentication/server/authentication-token-payload.provider.js';
 import { AuthenticationApiController } from '../../authentication/server/authentication.api-controller.js';
 import { AuthenticationService as AuthenticationServerService } from '../../authentication/server/authentication.service.js';

package/function/index.d.ts

@@ -1 +1,6 @@
+/**
+ * Tools around functions
+ *
+ * @module Function
+ */
 export * from './log.js';

package/function/index.js

@@ -1 +1,6 @@
+/**
+ * Tools around functions
+ *
+ * @module Function
+ */
 export * from './log.js';

package/http/client/index.d.ts

@@ -1,3 +1,4 @@
+export * from './adapters/index.js';
 export * from './http-client-options.js';
 export * from './http-client-request.js';
 export * from './http-client-response.js';

package/http/client/index.js

@@ -1,3 +1,4 @@
+export * from './adapters/index.js';
 export * from './http-client-options.js';
 export * from './http-client-request.js';
 export * from './http-client-response.js';

package/http/index.d.ts

@@ -1,3 +1,8 @@
+/**
+ * HTTP Server and Client
+ *
+ * @module HTTP
+ */
 export * from './client/index.js';
 export * from './cookie-parser.js';
 export * from './http-body.js';
@@ -7,5 +12,6 @@ export * from './http-query.js';
 export * from './http-url-parameters.js';
 export * from './http-value-map.js';
 export * from './http.error.js';
+export * from './server/index.js';
 export * from './types.js';
 export * from './utils.js';

package/http/index.js

@@ -1,3 +1,8 @@
+/**
+ * HTTP Server and Client
+ *
+ * @module HTTP
+ */
 export * from './client/index.js';
 export * from './cookie-parser.js';
 export * from './http-body.js';
@@ -7,5 +12,6 @@ export * from './http-query.js';
 export * from './http-url-parameters.js';
 export * from './http-value-map.js';
 export * from './http.error.js';
+export * from './server/index.js';
 export * from './types.js';
 export * from './utils.js';

package/http/server/index.d.ts

@@ -1,3 +1,4 @@
-export * from './http-server.js';
 export * from './http-server-request.js';
 export * from './http-server-response.js';
+export * from './http-server.js';
+export * from './node/index.js';

package/http/server/index.js

@@ -1,3 +1,4 @@
-export * from './http-server.js';
 export * from './http-server-request.js';
 export * from './http-server-response.js';
+export * from './http-server.js';
+export * from './node/index.js';

package/image-service/index.d.ts

@@ -1 +1,7 @@
+/**
+ * Image provider with image manipulation
+ *
+ * @module Image Service
+ */
 export * from './image-service.js';
+export * from './imgproxy/index.js';

package/image-service/index.js

@@ -1 +1,7 @@
+/**
+ * Image provider with image manipulation
+ *
+ * @module Image Service
+ */
 export * from './image-service.js';
+export * from './imgproxy/index.js';

package/index.d.ts

@@ -1 +1,6 @@
+/**
+ * Core of tstdl
+ *
+ * @module Core
+ */
 export * from './core.js';

package/index.js

@@ -1 +1,6 @@
+/**
+ * Core of tstdl
+ *
+ * @module Core
+ */
 export * from './core.js';

package/injector/index.d.ts

@@ -1,3 +1,8 @@
+/**
+ * Dependency Injection
+ *
+ * @module Injector
+ */
 export * from './decorators.js';
 export * from './inject.js';
 export * from './injector.js';

package/injector/index.js

@@ -1,3 +1,8 @@
+/**
+ * Dependency Injection
+ *
+ * @module Injector
+ */
 export * from './decorators.js';
 export * from './inject.js';
 export * from './injector.js';

package/json-path/index.d.ts

@@ -1 +1,6 @@
+/**
+ * JSON Path encoding/decoding
+ *
+ * @module JSON Path
+ */
 export * from './json-path.js';

package/json-path/index.js

@@ -1 +1,6 @@
+/**
+ * JSON Path encoding/decoding
+ *
+ * @module JSON Path
+ */
 export * from './json-path.js';

package/key-value-store/index.d.ts

@@ -1,2 +1,8 @@
+/**
+ * Store key-value pairs
+ *
+ * @module Key-Value Store
+ */
 export * from './key-value-store.provider.js';
 export * from './key-value.store.js';
+export * from './mongo/index.js';

package/key-value-store/index.js

@@ -1,2 +1,8 @@
+/**
+ * Store key-value pairs
+ *
+ * @module Key-Value Store
+ */
 export * from './key-value-store.provider.js';
 export * from './key-value.store.js';
+export * from './mongo/index.js';

package/lock/index.d.ts

@@ -1,2 +1,9 @@
+/**
+ * Resource locking
+ *
+ * @module Lock
+ */
 export * from './lock.js';
+export * from './mongo/index.js';
 export * from './provider.js';
+export * from './web/index.js';

package/lock/index.js

@@ -1,2 +1,9 @@
+/**
+ * Resource locking
+ *
+ * @module Lock
+ */
 export * from './lock.js';
+export * from './mongo/index.js';
 export * from './provider.js';
+export * from './web/index.js';

package/lock/mongo/lock.d.ts

@@ -3,8 +3,7 @@ import { Lock } from '../../lock/index.js';
 import { Logger } from '../../logger/index.js';
 import { MongoLockRepository } from './mongo-lock-repository.js';
 export declare class MongoLock extends Lock {
-    private readonly lockRepository;
-    private readonly logger;
+    #private;
     constructor(lockRepository: MongoLockRepository, resource: string, logger: Logger);
     acquire<Throw extends boolean>(timeout: number | undefined, throwOnFail: Throw): Promise<AcquireResult<Throw>>;
     use<Throw extends boolean, R>(timeout: number | undefined, throwOnFail: Throw, func: LockedFunction<R>): Promise<UsingResult<Throw, R>>;