@lakutata/entrypoint 3.0.0-beta.0

package/dist/cjs/exports/CTRLDecorators.d.ts

@@ -0,0 +1,13 @@
+export { CLIAction } from '../decorators/CLIAction.js';
+export { HTTPAction } from '../decorators/HTTPAction.js';
+export { DELETE } from '../decorators/http/DELETE.js';
+export { GET } from '../decorators/http/GET.js';
+export { HEAD } from '../decorators/http/HEAD.js';
+export { OPTIONS } from '../decorators/http/OPTIONS.js';
+export { PATCH } from '../decorators/http/PATCH.js';
+export { POST } from '../decorators/http/POST.js';
+export { PUT } from '../decorators/http/PUT.js';
+export { ServiceAction } from '../decorators/ServiceAction.js';
+export { UseMiddlewares } from '../decorators/UseMiddlewares.js';
+export { Prefix } from '../decorators/Prefix.js';
+export { Schedule, type ScheduleOptions } from '../decorators/Schedule.js';

package/dist/cjs/exports/CTRLDecorators.js

@@ -0,0 +1,38 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Schedule = exports.Prefix = exports.UseMiddlewares = exports.ServiceAction = exports.PUT = exports.POST = exports.PATCH = exports.OPTIONS = exports.HEAD = exports.GET = exports.DELETE = exports.HTTPAction = exports.CLIAction = void 0;
+//CLI actions
+var CLIAction_js_1 = require("../decorators/CLIAction.js");
+Object.defineProperty(exports, "CLIAction", { enumerable: true, get: function () { return CLIAction_js_1.CLIAction; } });
+//HTTP actions
+var HTTPAction_js_1 = require("../decorators/HTTPAction.js");
+Object.defineProperty(exports, "HTTPAction", { enumerable: true, get: function () { return HTTPAction_js_1.HTTPAction; } });
+var DELETE_js_1 = require("../decorators/http/DELETE.js");
+Object.defineProperty(exports, "DELETE", { enumerable: true, get: function () { return DELETE_js_1.DELETE; } });
+var GET_js_1 = require("../decorators/http/GET.js");
+Object.defineProperty(exports, "GET", { enumerable: true, get: function () { return GET_js_1.GET; } });
+var HEAD_js_1 = require("../decorators/http/HEAD.js");
+Object.defineProperty(exports, "HEAD", { enumerable: true, get: function () { return HEAD_js_1.HEAD; } });
+var OPTIONS_js_1 = require("../decorators/http/OPTIONS.js");
+Object.defineProperty(exports, "OPTIONS", { enumerable: true, get: function () { return OPTIONS_js_1.OPTIONS; } });
+var PATCH_js_1 = require("../decorators/http/PATCH.js");
+Object.defineProperty(exports, "PATCH", { enumerable: true, get: function () { return PATCH_js_1.PATCH; } });
+var POST_js_1 = require("../decorators/http/POST.js");
+Object.defineProperty(exports, "POST", { enumerable: true, get: function () { return POST_js_1.POST; } });
+var PUT_js_1 = require("../decorators/http/PUT.js");
+Object.defineProperty(exports, "PUT", { enumerable: true, get: function () { return PUT_js_1.PUT; } });
+//Service actions
+var ServiceAction_js_1 = require("../decorators/ServiceAction.js");
+Object.defineProperty(exports, "ServiceAction", { enumerable: true, get: function () { return ServiceAction_js_1.ServiceAction; } });
+//Middlewares
+var UseMiddlewares_js_1 = require("../decorators/UseMiddlewares.js");
+Object.defineProperty(exports, "UseMiddlewares", { enumerable: true, get: function () { return UseMiddlewares_js_1.UseMiddlewares; } });
+//Controller prefixes
+var Prefix_js_1 = require("../decorators/Prefix.js");
+Object.defineProperty(exports, "Prefix", { enumerable: true, get: function () { return Prefix_js_1.Prefix; } });
+//Scheduled actions
+var Schedule_js_1 = require("../decorators/Schedule.js");
+Object.defineProperty(exports, "Schedule", { enumerable: true, get: function () { return Schedule_js_1.Schedule; } });
+
+//The default of the entry: the entry itself (scripts/package-build/cjs-package.mjs)
+if (!Object.prototype.hasOwnProperty.call(exports, 'default')) Object.defineProperty(exports, 'default', {value: exports})

package/dist/cjs/exports/Channel.d.ts

@@ -0,0 +1,14 @@
+/**
+ * The API of the packages providing a channel or an adapter
+ */
+export { defineChannel, getChannel, hasChannel, getChannelByContextType } from '../channel/Channel.js';
+export type { ChannelDefinition, ChannelKind, ChannelEntry, ChannelMatch, ChannelMatcher } from '../channel/Channel.js';
+export { isEntrypointAdapter, commandMap } from '../channel/EntrypointAdapter.js';
+export type { EntrypointAdapter, ChannelRuntime, ChannelActionInfo, DispatchOptions } from '../channel/EntrypointAdapter.js';
+export { registerControllerAction } from '../lib/ControllerEntrypoint.js';
+export type { ActionDetails, ActionInfo } from '../lib/ControllerEntrypoint.js';
+export { getActionDTOAndOptions } from '../lib/GetActionDTOAndOptions.js';
+export { ActionOptions } from '../lib/ActionOptions.js';
+export { HTTPChannel, CLIChannel, ServiceChannel, ScheduleChannel } from '../channel/BuiltinChannels.js';
+export { ServiceResponseCodec, type ServiceResponse } from '../lib/ServiceResponseCodec.js';
+export { getPrefix, setPrefix } from '../lib/Prefix.js';

package/dist/cjs/exports/Channel.js

@@ -0,0 +1,33 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.setPrefix = exports.getPrefix = exports.ServiceResponseCodec = exports.ScheduleChannel = exports.ServiceChannel = exports.CLIChannel = exports.HTTPChannel = exports.ActionOptions = exports.getActionDTOAndOptions = exports.registerControllerAction = exports.commandMap = exports.isEntrypointAdapter = exports.getChannelByContextType = exports.hasChannel = exports.getChannel = exports.defineChannel = void 0;
+/**
+ * The API of the packages providing a channel or an adapter
+ */
+var Channel_js_1 = require("../channel/Channel.js");
+Object.defineProperty(exports, "defineChannel", { enumerable: true, get: function () { return Channel_js_1.defineChannel; } });
+Object.defineProperty(exports, "getChannel", { enumerable: true, get: function () { return Channel_js_1.getChannel; } });
+Object.defineProperty(exports, "hasChannel", { enumerable: true, get: function () { return Channel_js_1.hasChannel; } });
+Object.defineProperty(exports, "getChannelByContextType", { enumerable: true, get: function () { return Channel_js_1.getChannelByContextType; } });
+var EntrypointAdapter_js_1 = require("../channel/EntrypointAdapter.js");
+Object.defineProperty(exports, "isEntrypointAdapter", { enumerable: true, get: function () { return EntrypointAdapter_js_1.isEntrypointAdapter; } });
+Object.defineProperty(exports, "commandMap", { enumerable: true, get: function () { return EntrypointAdapter_js_1.commandMap; } });
+var ControllerEntrypoint_js_1 = require("../lib/ControllerEntrypoint.js");
+Object.defineProperty(exports, "registerControllerAction", { enumerable: true, get: function () { return ControllerEntrypoint_js_1.registerControllerAction; } });
+var GetActionDTOAndOptions_js_1 = require("../lib/GetActionDTOAndOptions.js");
+Object.defineProperty(exports, "getActionDTOAndOptions", { enumerable: true, get: function () { return GetActionDTOAndOptions_js_1.getActionDTOAndOptions; } });
+var ActionOptions_js_1 = require("../lib/ActionOptions.js");
+Object.defineProperty(exports, "ActionOptions", { enumerable: true, get: function () { return ActionOptions_js_1.ActionOptions; } });
+var BuiltinChannels_js_1 = require("../channel/BuiltinChannels.js");
+Object.defineProperty(exports, "HTTPChannel", { enumerable: true, get: function () { return BuiltinChannels_js_1.HTTPChannel; } });
+Object.defineProperty(exports, "CLIChannel", { enumerable: true, get: function () { return BuiltinChannels_js_1.CLIChannel; } });
+Object.defineProperty(exports, "ServiceChannel", { enumerable: true, get: function () { return BuiltinChannels_js_1.ServiceChannel; } });
+Object.defineProperty(exports, "ScheduleChannel", { enumerable: true, get: function () { return BuiltinChannels_js_1.ScheduleChannel; } });
+var ServiceResponseCodec_js_1 = require("../lib/ServiceResponseCodec.js");
+Object.defineProperty(exports, "ServiceResponseCodec", { enumerable: true, get: function () { return ServiceResponseCodec_js_1.ServiceResponseCodec; } });
+var Prefix_js_1 = require("../lib/Prefix.js");
+Object.defineProperty(exports, "getPrefix", { enumerable: true, get: function () { return Prefix_js_1.getPrefix; } });
+Object.defineProperty(exports, "setPrefix", { enumerable: true, get: function () { return Prefix_js_1.setPrefix; } });
+
+//The default of the entry: the entry itself (scripts/package-build/cjs-package.mjs)
+if (!Object.prototype.hasOwnProperty.call(exports, 'default')) Object.defineProperty(exports, 'default', {value: exports})

package/dist/cjs/exports/CommanderAdapter.d.ts

@@ -0,0 +1 @@
+export { commanderCLIEntrypoint, type CommanderCLIEntrypointOptions, type CLIText, type CLITranslate } from '../adapter/commander/CommanderCLIEntrypoint.js';

package/dist/cjs/exports/CommanderAdapter.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.commanderCLIEntrypoint = void 0;
+var CommanderCLIEntrypoint_js_1 = require("../adapter/commander/CommanderCLIEntrypoint.js");
+Object.defineProperty(exports, "commanderCLIEntrypoint", { enumerable: true, get: function () { return CommanderCLIEntrypoint_js_1.commanderCLIEntrypoint; } });
+
+//The default of the entry: the entry itself (scripts/package-build/cjs-package.mjs)
+if (!Object.prototype.hasOwnProperty.call(exports, 'default')) Object.defineProperty(exports, 'default', {value: exports})

package/dist/cjs/exports/ElectronAdapter.d.ts

@@ -0,0 +1 @@
+export { electronIPCServiceEntrypoint, ipcEventOfContext, type ElectronIPCServiceEntrypointOptions, type IPCMain, type IPCInvokeEvent, type IPCSender } from '../adapter/electron/ElectronIPCServiceEntrypoint.js';

package/dist/cjs/exports/ElectronAdapter.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ipcEventOfContext = exports.electronIPCServiceEntrypoint = void 0;
+var ElectronIPCServiceEntrypoint_js_1 = require("../adapter/electron/ElectronIPCServiceEntrypoint.js");
+Object.defineProperty(exports, "electronIPCServiceEntrypoint", { enumerable: true, get: function () { return ElectronIPCServiceEntrypoint_js_1.electronIPCServiceEntrypoint; } });
+Object.defineProperty(exports, "ipcEventOfContext", { enumerable: true, get: function () { return ElectronIPCServiceEntrypoint_js_1.ipcEventOfContext; } });
+
+//The default of the entry: the entry itself (scripts/package-build/cjs-package.mjs)
+if (!Object.prototype.hasOwnProperty.call(exports, 'default')) Object.defineProperty(exports, 'default', {value: exports})

package/dist/cjs/exports/Entrypoint.d.ts

@@ -0,0 +1,24 @@
+export * from '../Entrypoint.js';
+export * from '../lib/Controller.js';
+export * from '../lib/AccessControlRule.js';
+export * from '../exceptions/AccessDeniedException.js';
+export * from '../exceptions/DuplicateActionNameException.js';
+export * from '../exceptions/ControllerActionNotFoundException.js';
+export { AccessControl } from '../lib/AccessControl.js';
+export { Middleware, type ActionInvocation, type Next, type MiddlewareHandler, type MiddlewareDefinition } from '../lib/Middleware.js';
+export * from '../exceptions/InvalidMiddlewareException.js';
+export * from '../exceptions/MiddlewareNextCalledException.js';
+export { PrefixOptions } from '../lib/Prefix.js';
+export * from '../exceptions/InvalidPrefixException.js';
+export { ActionResult } from '../lib/ActionResult.js';
+export type { ActionInfo } from '../lib/ControllerEntrypoint.js';
+export type { EntrypointAdapter, ChannelRuntime, ChannelActionInfo, DispatchOptions } from '../channel/EntrypointAdapter.js';
+export * from '../exceptions/InvalidChannelException.js';
+export * from '../exceptions/InvalidEntrypointAdapterException.js';
+export { Result, StatusResult, FileResult, EventsResult, type FileResultOptions, type SendEvent, type EventsProducer } from '../lib/Result.js';
+export * from '../exceptions/RouteNotFoundException.js';
+export * from '../exceptions/EntrypointStoppedException.js';
+export * from '../exceptions/ServiceInvokeException.js';
+export { scheduleEntrypoint, type ScheduleEntrypointOptions } from '../adapter/schedule/ScheduleEntrypoint.js';
+export { httpServiceEntrypoint, httpRequestOfContext, type HTTPServiceEntrypointOptions } from '../adapter/http/HTTPServiceEntrypoint.js';
+export { Cron, parseDuration } from '../lib/schedule/Cron.js';

package/dist/cjs/exports/Entrypoint.js

@@ -0,0 +1,55 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.parseDuration = exports.Cron = exports.httpRequestOfContext = exports.httpServiceEntrypoint = exports.scheduleEntrypoint = exports.EventsResult = exports.FileResult = exports.StatusResult = exports.Result = exports.ActionResult = exports.PrefixOptions = exports.Middleware = exports.AccessControl = void 0;
+__exportStar(require("../Entrypoint.js"), exports);
+__exportStar(require("../lib/Controller.js"), exports);
+__exportStar(require("../lib/AccessControlRule.js"), exports);
+__exportStar(require("../exceptions/AccessDeniedException.js"), exports);
+__exportStar(require("../exceptions/DuplicateActionNameException.js"), exports);
+__exportStar(require("../exceptions/ControllerActionNotFoundException.js"), exports);
+var AccessControl_js_1 = require("../lib/AccessControl.js");
+Object.defineProperty(exports, "AccessControl", { enumerable: true, get: function () { return AccessControl_js_1.AccessControl; } });
+var Middleware_js_1 = require("../lib/Middleware.js");
+Object.defineProperty(exports, "Middleware", { enumerable: true, get: function () { return Middleware_js_1.Middleware; } });
+__exportStar(require("../exceptions/InvalidMiddlewareException.js"), exports);
+__exportStar(require("../exceptions/MiddlewareNextCalledException.js"), exports);
+var Prefix_js_1 = require("../lib/Prefix.js");
+Object.defineProperty(exports, "PrefixOptions", { enumerable: true, get: function () { return Prefix_js_1.PrefixOptions; } });
+__exportStar(require("../exceptions/InvalidPrefixException.js"), exports);
+var ActionResult_js_1 = require("../lib/ActionResult.js");
+Object.defineProperty(exports, "ActionResult", { enumerable: true, get: function () { return ActionResult_js_1.ActionResult; } });
+__exportStar(require("../exceptions/InvalidChannelException.js"), exports);
+__exportStar(require("../exceptions/InvalidEntrypointAdapterException.js"), exports);
+var Result_js_1 = require("../lib/Result.js");
+Object.defineProperty(exports, "Result", { enumerable: true, get: function () { return Result_js_1.Result; } });
+Object.defineProperty(exports, "StatusResult", { enumerable: true, get: function () { return Result_js_1.StatusResult; } });
+Object.defineProperty(exports, "FileResult", { enumerable: true, get: function () { return Result_js_1.FileResult; } });
+Object.defineProperty(exports, "EventsResult", { enumerable: true, get: function () { return Result_js_1.EventsResult; } });
+__exportStar(require("../exceptions/RouteNotFoundException.js"), exports);
+__exportStar(require("../exceptions/EntrypointStoppedException.js"), exports);
+__exportStar(require("../exceptions/ServiceInvokeException.js"), exports);
+var ScheduleEntrypoint_js_1 = require("../adapter/schedule/ScheduleEntrypoint.js");
+Object.defineProperty(exports, "scheduleEntrypoint", { enumerable: true, get: function () { return ScheduleEntrypoint_js_1.scheduleEntrypoint; } });
+var HTTPServiceEntrypoint_js_1 = require("../adapter/http/HTTPServiceEntrypoint.js");
+Object.defineProperty(exports, "httpServiceEntrypoint", { enumerable: true, get: function () { return HTTPServiceEntrypoint_js_1.httpServiceEntrypoint; } });
+Object.defineProperty(exports, "httpRequestOfContext", { enumerable: true, get: function () { return HTTPServiceEntrypoint_js_1.httpRequestOfContext; } });
+var Cron_js_1 = require("../lib/schedule/Cron.js");
+Object.defineProperty(exports, "Cron", { enumerable: true, get: function () { return Cron_js_1.Cron; } });
+Object.defineProperty(exports, "parseDuration", { enumerable: true, get: function () { return Cron_js_1.parseDuration; } });
+
+//The default of the entry: the entry itself (scripts/package-build/cjs-package.mjs)
+if (!Object.prototype.hasOwnProperty.call(exports, 'default')) Object.defineProperty(exports, 'default', {value: exports})

package/dist/cjs/exports/ExpressAdapter.d.ts

@@ -0,0 +1,4 @@
+export { expressHTTPEntrypoint, type ExpressHTTPEntrypointOptions, type ExpressHookContext } from '../adapter/express/ExpressHTTPEntrypoint.js';
+export { JSONResponder, jsonEnvelope, statusOfError, describeError, type ExpressResponder, type HTTPErrorOrigin, type JSONEnvelopeOptions } from '../adapter/express/Responders.js';
+export { staticUI, type StaticUIOptions } from '../adapter/express/StaticUI.js';
+export { type ErrorDescription } from '../types/ErrorDescription.js';

package/dist/cjs/exports/ExpressAdapter.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.staticUI = exports.describeError = exports.statusOfError = exports.jsonEnvelope = exports.JSONResponder = exports.expressHTTPEntrypoint = void 0;
+var ExpressHTTPEntrypoint_js_1 = require("../adapter/express/ExpressHTTPEntrypoint.js");
+Object.defineProperty(exports, "expressHTTPEntrypoint", { enumerable: true, get: function () { return ExpressHTTPEntrypoint_js_1.expressHTTPEntrypoint; } });
+var Responders_js_1 = require("../adapter/express/Responders.js");
+Object.defineProperty(exports, "JSONResponder", { enumerable: true, get: function () { return Responders_js_1.JSONResponder; } });
+Object.defineProperty(exports, "jsonEnvelope", { enumerable: true, get: function () { return Responders_js_1.jsonEnvelope; } });
+Object.defineProperty(exports, "statusOfError", { enumerable: true, get: function () { return Responders_js_1.statusOfError; } });
+Object.defineProperty(exports, "describeError", { enumerable: true, get: function () { return Responders_js_1.describeError; } });
+var StaticUI_js_1 = require("../adapter/express/StaticUI.js");
+Object.defineProperty(exports, "staticUI", { enumerable: true, get: function () { return StaticUI_js_1.staticUI; } });
+
+//The default of the entry: the entry itself (scripts/package-build/cjs-package.mjs)
+if (!Object.prototype.hasOwnProperty.call(exports, 'default')) Object.defineProperty(exports, 'default', {value: exports})

package/dist/cjs/exports/FastifyAdapter.d.ts

@@ -0,0 +1,4 @@
+export { fastifyHTTPEntrypoint, type FastifyHTTPEntrypointOptions, type FastifyHookContext } from '../adapter/fastify/FastifyHTTPEntrypoint.js';
+export { FastifyJSONResponder, fastifyJSONEnvelope, type FastifyResponder, type FastifyJSONEnvelopeOptions } from '../adapter/fastify/Responders.js';
+export { statusOfError, describeError, type HTTPErrorOrigin } from '../lib/HTTPErrors.js';
+export { type ErrorDescription } from '../types/ErrorDescription.js';

package/dist/cjs/exports/FastifyAdapter.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.describeError = exports.statusOfError = exports.fastifyJSONEnvelope = exports.FastifyJSONResponder = exports.fastifyHTTPEntrypoint = void 0;
+var FastifyHTTPEntrypoint_js_1 = require("../adapter/fastify/FastifyHTTPEntrypoint.js");
+Object.defineProperty(exports, "fastifyHTTPEntrypoint", { enumerable: true, get: function () { return FastifyHTTPEntrypoint_js_1.fastifyHTTPEntrypoint; } });
+var Responders_js_1 = require("../adapter/fastify/Responders.js");
+Object.defineProperty(exports, "FastifyJSONResponder", { enumerable: true, get: function () { return Responders_js_1.FastifyJSONResponder; } });
+Object.defineProperty(exports, "fastifyJSONEnvelope", { enumerable: true, get: function () { return Responders_js_1.fastifyJSONEnvelope; } });
+var HTTPErrors_js_1 = require("../lib/HTTPErrors.js");
+Object.defineProperty(exports, "statusOfError", { enumerable: true, get: function () { return HTTPErrors_js_1.statusOfError; } });
+Object.defineProperty(exports, "describeError", { enumerable: true, get: function () { return HTTPErrors_js_1.describeError; } });
+
+//The default of the entry: the entry itself (scripts/package-build/cjs-package.mjs)
+if (!Object.prototype.hasOwnProperty.call(exports, 'default')) Object.defineProperty(exports, 'default', {value: exports})

package/dist/cjs/exports/JSONRPCAdapter.d.ts

@@ -0,0 +1,2 @@
+export { jsonRPCServiceEntrypoint, type JSONRPCServiceEntrypointOptions } from '../adapter/jsonrpc/JSONRPCServiceEntrypoint.js';
+export { JSONRPCErrorCode, jsonRPCRequestOfContext, type JSONRPCMappingOptions, type JSONRPCRequest, type JSONRPCRequestInfo, type JSONRPCResponse } from '../adapter/jsonrpc/JSONRPCProtocol.js';

package/dist/cjs/exports/JSONRPCAdapter.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.jsonRPCRequestOfContext = exports.JSONRPCErrorCode = exports.jsonRPCServiceEntrypoint = void 0;
+var JSONRPCServiceEntrypoint_js_1 = require("../adapter/jsonrpc/JSONRPCServiceEntrypoint.js");
+Object.defineProperty(exports, "jsonRPCServiceEntrypoint", { enumerable: true, get: function () { return JSONRPCServiceEntrypoint_js_1.jsonRPCServiceEntrypoint; } });
+var JSONRPCProtocol_js_1 = require("../adapter/jsonrpc/JSONRPCProtocol.js");
+Object.defineProperty(exports, "JSONRPCErrorCode", { enumerable: true, get: function () { return JSONRPCProtocol_js_1.JSONRPCErrorCode; } });
+Object.defineProperty(exports, "jsonRPCRequestOfContext", { enumerable: true, get: function () { return JSONRPCProtocol_js_1.jsonRPCRequestOfContext; } });
+
+//The default of the entry: the entry itself (scripts/package-build/cjs-package.mjs)
+if (!Object.prototype.hasOwnProperty.call(exports, 'default')) Object.defineProperty(exports, 'default', {value: exports})

package/dist/cjs/exports/SocketIOAdapter.d.ts

@@ -0,0 +1 @@
+export { socketIOServiceEntrypoint, socketOfContext, type SocketIOServiceEntrypointOptions } from '../adapter/socket.io/SocketIOServiceEntrypoint.js';

package/dist/cjs/exports/SocketIOAdapter.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.socketOfContext = exports.socketIOServiceEntrypoint = void 0;
+var SocketIOServiceEntrypoint_js_1 = require("../adapter/socket.io/SocketIOServiceEntrypoint.js");
+Object.defineProperty(exports, "socketIOServiceEntrypoint", { enumerable: true, get: function () { return SocketIOServiceEntrypoint_js_1.socketIOServiceEntrypoint; } });
+Object.defineProperty(exports, "socketOfContext", { enumerable: true, get: function () { return SocketIOServiceEntrypoint_js_1.socketOfContext; } });
+
+//The default of the entry: the entry itself (scripts/package-build/cjs-package.mjs)
+if (!Object.prototype.hasOwnProperty.call(exports, 'default')) Object.defineProperty(exports, 'default', {value: exports})

package/dist/cjs/lib/AccessControl.d.ts

@@ -0,0 +1,118 @@
+import { BaseObject, Exception, Container, IBaseObjectConstructor, FunctionSchema } from '@lakutata/core';
+import { BaseActionInfo, CLIActionInfo, CLIContext, ContextType, HTTPActionInfo, HTTPContext, ServiceActionInfo, ServiceContext } from '../Entrypoint.js';
+import { ActionDetails, type ActionInfo } from './ControllerEntrypoint.js';
+import { AccessControlRule, AccessControlRuleHandler } from './AccessControlRule.js';
+/**
+ * The access control of the entrypoint's actions: it checks a request to an action declared with `acl: true` against
+ * the entrypoint's rules and the action's own `rule`, or against the action's `rule` alone when `acl` is off. The
+ * entrypoint calls {@link AccessControl.run} for each request, after the input validation and before the action; a
+ * subclass of the entrypoint may replace it with a subclass (its protected `accessControl` property), for example to
+ * audit the decisions.
+ * @example
+ * ```typescript
+ * import {Application} from 'lakutata'
+ * import {AccessControl, Controller, Entrypoint} from 'lakutata/com/entrypoint'
+ * import {GET} from 'lakutata/decorator/ctrl'
+ *
+ * //Log every access decision
+ * class AuditedAccessControl extends AccessControl {
+ *     protected async match(): Promise<boolean> {
+ *         const allowed: boolean = await super.match()
+ *         console.log(`${this.target.name}: ${allowed ? 'allowed' : 'denied'}`)
+ *         return allowed
+ *     }
+ * }
+ *
+ * class AuditedEntrypoint extends Entrypoint {
+ *     protected readonly accessControl: typeof AccessControl = AuditedAccessControl
+ * }
+ *
+ * class ReportController extends Controller {
+ *     @GET('/reports', {acl: true, rule: async (): Promise<boolean> => true})
+ *     public async list(): Promise<string[]> {
+ *         return []
+ *     }
+ * }
+ *
+ * Application.run(() => ({
+ *     id: 'report.app',
+ *     name: 'Report',
+ *     components: {
+ *         entrypoint: {class: AuditedEntrypoint, controllers: [ReportController]}
+ *     }
+ * }))
+ * ```
+ */
+export declare class AccessControl extends BaseObject {
+    /**
+     * The request's container, where the rules are created.
+     * @protected
+     */
+    protected readonly runtimeContainer: Container;
+    /**
+     * The descriptions of every action of the request's channel.
+     * @protected
+     */
+    protected readonly actions: HTTPActionInfo[] | ServiceActionInfo[] | CLIActionInfo[];
+    /**
+     * The requested action: its identity and options (without the channel's fields).
+     * @protected
+     */
+    protected readonly target: ActionInfo;
+    /**
+     * The request's context.
+     * @protected
+     */
+    protected readonly context: CLIContext | HTTPContext | ServiceContext;
+    /**
+     * The action's validated input.
+     * @protected
+     */
+    protected readonly input: Record<string, any>;
+    /**
+     * Called when the rules allow the request.
+     * @protected
+     */
+    protected readonly allowCallback: () => void;
+    /**
+     * Called when a rule denies the request, with the error a rule threw (none when a rule resolved `false`).
+     * @protected
+     */
+    protected readonly denyCallback: (error?: Error | Exception) => void;
+    /**
+     * The rules to check, in order: rule classes and rule functions.
+     * @protected
+     */
+    protected readonly rules: (IBaseObjectConstructor<AccessControlRule> | AccessControlRuleHandler<any>)[];
+    /**
+     * Schema of access control rule constructors, built only when it is used
+     * @protected
+     */
+    protected get accessControlRuleConstructorDTO(): FunctionSchema<typeof AccessControlRule>;
+    /**
+     * Check the rules and call the allow or deny callback.
+     * @protected
+     */
+    protected init(): Promise<void>;
+    /**
+     * Check the rules in order: a rule class is created in the request's container and checked when it supports the
+     * request's context type, a rule function is called with the context and the input.
+     * @returns `false` as soon as a rule resolves `false`, `true` when none does (no rule included).
+     * @throws {Error} The error a rule throws (the request is then denied with it).
+     * @protected
+     */
+    protected match(): Promise<boolean>;
+    /**
+     * Check the access to an action: with `acl: true`, against the rules then the action's own `rule`; with `acl`
+     * off, against the action's `rule` alone; without either, the request is allowed without check.
+     * @param rules The entrypoint's rule classes.
+     * @param runtimeContainer The request's container, where the access control and the rules are created.
+     * @param context The request's context.
+     * @param input The action's validated input.
+     * @param details The requested action.
+     * @param getActionsCallback Returns the descriptions of the actions of a context type's channel.
+     * @returns Whether the request is allowed, and when it is not, the error to fail it with: the error a rule
+     * threw, or an `AccessDeniedException`.
+     */
+    static run(rules: IBaseObjectConstructor<AccessControlRule>[], runtimeContainer: Container, context: CLIContext | HTTPContext | ServiceContext, input: Record<string, any>, details: ActionDetails, getActionsCallback: (type: ContextType | string) => BaseActionInfo[]): Promise<[boolean, Error | Exception | undefined]>;
+}

package/dist/cjs/lib/AccessControl.js

@@ -0,0 +1,208 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AccessControl = void 0;
+const core_1 = require("@lakutata/core");
+const di_1 = require("@lakutata/core/decorator/di");
+const AccessDeniedException_js_1 = require("../exceptions/AccessDeniedException.js");
+const AccessControlRule_js_1 = require("./AccessControlRule.js");
+const utils_1 = require("@lakutata/utils");
+/**
+ * The access control of the entrypoint's actions: it checks a request to an action declared with `acl: true` against
+ * the entrypoint's rules and the action's own `rule`, or against the action's `rule` alone when `acl` is off. The
+ * entrypoint calls {@link AccessControl.run} for each request, after the input validation and before the action; a
+ * subclass of the entrypoint may replace it with a subclass (its protected `accessControl` property), for example to
+ * audit the decisions.
+ * @example
+ * ```typescript
+ * import {Application} from 'lakutata'
+ * import {AccessControl, Controller, Entrypoint} from 'lakutata/com/entrypoint'
+ * import {GET} from 'lakutata/decorator/ctrl'
+ *
+ * //Log every access decision
+ * class AuditedAccessControl extends AccessControl {
+ *     protected async match(): Promise<boolean> {
+ *         const allowed: boolean = await super.match()
+ *         console.log(`${this.target.name}: ${allowed ? 'allowed' : 'denied'}`)
+ *         return allowed
+ *     }
+ * }
+ *
+ * class AuditedEntrypoint extends Entrypoint {
+ *     protected readonly accessControl: typeof AccessControl = AuditedAccessControl
+ * }
+ *
+ * class ReportController extends Controller {
+ *     @GET('/reports', {acl: true, rule: async (): Promise<boolean> => true})
+ *     public async list(): Promise<string[]> {
+ *         return []
+ *     }
+ * }
+ *
+ * Application.run(() => ({
+ *     id: 'report.app',
+ *     name: 'Report',
+ *     components: {
+ *         entrypoint: {class: AuditedEntrypoint, controllers: [ReportController]}
+ *     }
+ * }))
+ * ```
+ */
+class AccessControl extends core_1.BaseObject {
+    /**
+     * Schema of access control rule constructors, built only when it is used
+     * @protected
+     */
+    get accessControlRuleConstructorDTO() {
+        return core_1.DTO.Class(AccessControlRule_js_1.AccessControlRule);
+    }
+    /**
+     * Check the rules and call the allow or deny callback.
+     * @protected
+     */
+    async init() {
+        try {
+            const matchResult = await this.match();
+            if (matchResult)
+                return this.allowCallback();
+            return this.denyCallback();
+        }
+        catch (e) {
+            return this.denyCallback(e);
+        }
+    }
+    /**
+     * Check the rules in order: a rule class is created in the request's container and checked when it supports the
+     * request's context type, a rule function is called with the context and the input.
+     * @returns `false` as soon as a rule resolves `false`, `true` when none does (no rule included).
+     * @throws {Error} The error a rule throws (the request is then denied with it).
+     * @protected
+     */
+    async match() {
+        for (const rule of this.rules) {
+            if ((0, utils_1.isSubclassOf)(rule, AccessControlRule_js_1.AccessControlRule)) {
+                const RuleObjectConstructor = (0, utils_1.As)(rule);
+                const ruleObjectInstance = await this.runtimeContainer.build(RuleObjectConstructor, {
+                    actions: this.actions,
+                    targetAction: this.target,
+                    context: this.context,
+                    input: this.input
+                });
+                if (!ruleObjectInstance.supportContextTypes.includes(this.context.type))
+                    continue;
+                if (!(await ruleObjectInstance.rule()))
+                    return false;
+            }
+            else {
+                const handler = (0, utils_1.As)(rule);
+                if (!(await handler(this.context, this.input)))
+                    return false;
+            }
+        }
+        return true;
+    }
+    /**
+     * Check the access to an action: with `acl: true`, against the rules then the action's own `rule`; with `acl`
+     * off, against the action's `rule` alone; without either, the request is allowed without check.
+     * @param rules The entrypoint's rule classes.
+     * @param runtimeContainer The request's container, where the access control and the rules are created.
+     * @param context The request's context.
+     * @param input The action's validated input.
+     * @param details The requested action.
+     * @param getActionsCallback Returns the descriptions of the actions of a context type's channel.
+     * @returns Whether the request is allowed, and when it is not, the error to fail it with: the error a rule
+     * threw, or an `AccessDeniedException`.
+     */
+    static async run(rules, runtimeContainer, context, input, details, getActionsCallback) {
+        const actions = getActionsCallback(context.type);
+        let allowed = !details.acl;
+        //The exception is created only when access is denied (building it captures a stack trace)
+        let exception;
+        if (!allowed) {
+            await runtimeContainer.set(this, {
+                // await runtimeContainer.build(this, {
+                rules: [...rules, details.rule].filter((rule) => !!rule),
+                runtimeContainer: runtimeContainer,
+                actions: actions,
+                context: context,
+                input: input,
+                target: details.getActionInfo(),
+                allowCallback: () => {
+                    allowed = true;
+                },
+                denyCallback: (error) => {
+                    allowed = false;
+                    exception = error ? error : exception;
+                }
+            });
+        }
+        else if (details.rule) {
+            await runtimeContainer.set(this, {
+                // await runtimeContainer.build(this, {
+                rules: [details.rule],
+                runtimeContainer: runtimeContainer,
+                actions: actions,
+                context: context,
+                input: input,
+                target: details.getActionInfo(),
+                allowCallback: () => {
+                    allowed = true;
+                },
+                denyCallback: (error) => {
+                    allowed = false;
+                    exception = error ? error : exception;
+                }
+            });
+        }
+        return [
+            allowed,
+            allowed ? undefined : (exception ? exception : new AccessDeniedException_js_1.AccessDeniedException())
+        ];
+    }
+}
+exports.AccessControl = AccessControl;
+__decorate([
+    (0, di_1.Configurable)(),
+    __metadata("design:type", core_1.Container
+    /**
+     * The descriptions of every action of the request's channel.
+     * @protected
+     */
+    )
+], AccessControl.prototype, "runtimeContainer", void 0);
+__decorate([
+    (0, di_1.Configurable)(),
+    __metadata("design:type", Array)
+], AccessControl.prototype, "actions", void 0);
+__decorate([
+    (0, di_1.Configurable)(),
+    __metadata("design:type", Object)
+], AccessControl.prototype, "target", void 0);
+__decorate([
+    (0, di_1.Configurable)(),
+    __metadata("design:type", Object)
+], AccessControl.prototype, "context", void 0);
+__decorate([
+    (0, di_1.Configurable)(),
+    __metadata("design:type", Object)
+], AccessControl.prototype, "input", void 0);
+__decorate([
+    (0, di_1.Configurable)(),
+    __metadata("design:type", Function)
+], AccessControl.prototype, "allowCallback", void 0);
+__decorate([
+    (0, di_1.Configurable)(),
+    __metadata("design:type", Function)
+], AccessControl.prototype, "denyCallback", void 0);
+__decorate([
+    (0, di_1.Configurable)(),
+    __metadata("design:type", Array)
+], AccessControl.prototype, "rules", void 0);