@opra/core 0.26.4 → 0.27.0

package/esm/platform-adapter.host.js

@@ -1,7 +1,7 @@
 import path from 'path';
 import { pascalCase } from 'putil-varhelpers';
 import { AsyncEventEmitter } from 'strict-typed-events';
-import { Container, CrudResource, ForbiddenError, getStackFileName, I18n, Resource, translate } from '@opra/common';
+import { BadRequestError, Container, CrudResource, ForbiddenError, getStackFileName, I18n, Resource, translate } from '@opra/common';
 import { Logger } from './services/logger.js';
 const resourceInitialized = Symbol.for('opra.resource.initialized');
 /**
@@ -98,20 +98,36 @@ export class PlatformAdapterHost extends AsyncEventEmitter {
         }
         return controller;
     }
-    async getOperationHandler(resource, operationOrAction) {
+    async getActionHandler(resource, name) {
         resource = typeof resource === 'object' && resource instanceof Resource
             ? resource
             : this.api.getResource(resource);
         const controller = await this.getController(resource);
-        const endpoint = (resource instanceof CrudResource && resource.operations.get(operationOrAction)) ||
-            resource.actions.get(operationOrAction);
+        const endpoint = resource.actions.get(name);
+        if (endpoint) {
+            const handler = typeof controller[endpoint.name] === 'function' ? controller[endpoint.name] : undefined;
+            if (handler)
+                return { controller, endpoint, handler };
+        }
+        throw new BadRequestError({
+            message: translate('ACTION_NOT_FOUND', { resource: resource.name, action: name }, `The {{resource}} resource doesn't have an action named '{{action}}'`),
+            severity: 'error',
+            code: 'ACTION_NOT_FOUND'
+        });
+    }
+    async getOperationHandler(resource, name) {
+        resource = typeof resource === 'object' && resource instanceof Resource
+            ? resource
+            : this.api.getResource(resource);
+        const controller = await this.getController(resource);
+        const endpoint = resource instanceof CrudResource && resource.operations.get(name);
         if (endpoint) {
             const handler = typeof controller[endpoint.name] === 'function' ? controller[endpoint.name] : undefined;
             if (handler)
                 return { controller, endpoint, handler };
         }
         throw new ForbiddenError({
-            message: translate('OPERATION_FORBIDDEN', { resource: resource.name, endpoint: operationOrAction }, `'{{resource}}' does not accept '{{endpoint}}' operations`),
+            message: translate('OPERATION_FORBIDDEN', { resource: resource.name, operation: name }, `'The {{resource}} resource does not accept '{{operation}}' operations`),
             severity: 'error',
             code: 'OPERATION_FORBIDDEN'
         });

package/esm/request-context.js

@@ -3,7 +3,7 @@ export var RequestContext;
     function from(executionContext, request, response) {
         const out = {
             request,
-            response,
+            response
         };
         Object.setPrototypeOf(out, executionContext);
         return out;

package/i18n/en/error.json

@@ -12,7 +12,8 @@
   "RESPONSE_VALIDATION": "Response validation failed",
   "RESOURCE_NOT_FOUND": "Resource not found",
   "RESOURCE_CONFLICT": "There is already an other {{resource}} resource with same field values ({{fields}})",
-  "OPERATION_FORBIDDEN": "The {{resource}} endpoint does not accept '{{endpoint}}' operations",
+  "OPERATION_FORBIDDEN": "The {{resource}} resource does not accept '{{operation}}' operations",
+  "ACTION_NOT_FOUND": "The {{resource}} resource doesn't have an action named '{{action}}'",
   "UNKNOWN_FIELD": "Unknown field '{{field}}'",
   "UNACCEPTED_SORT_FIELD": "Field '{{field}}' is not available for sort operation",
   "UNACCEPTED_FILTER_FIELD": "Field '{{field}}' is not available for filter operation",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@opra/core",
-  "version": "0.26.4",
+  "version": "0.27.0",
   "description": "Opra schema package",
   "author": "Panates",
   "license": "MIT",
@@ -27,14 +27,14 @@
     "clean:cover": "rimraf ../../coverage/core"
   },
   "dependencies": {
-    "@opra/common": "^0.26.4",
+    "@opra/common": "^0.27.0",
     "accepts": "^1.3.8",
     "content-disposition": "^0.5.4",
     "content-type": "^1.0.5",
     "cookie": "^0.5.0",
     "cookie-signature": "^1.2.1",
     "encodeurl": "^1.0.2",
-    "formidable": "^3.5.0",
+    "formidable": "^3.5.1",
     "fresh": "^0.5.2",
     "mime-types": "^2.1.35",
     "power-tasks": "^1.7.2",
@@ -56,7 +56,7 @@
     "@types/cookie": "^0.5.2",
     "@types/cookie-signature": "^1.1.0",
     "@types/encodeurl": "^1.0.0",
-    "@types/express": "^4.17.18",
+    "@types/express": "^4.17.19",
     "@types/formidable": "^3.4.3",
     "@types/fresh": "^0.5.0",
     "@types/mime-types": "^2.1.2",

package/types/augmentation/collection.augmentation.d.ts

@@ -1,19 +1,21 @@
-import type { PartialOutput } from '@opra/common';
+import { StrictOmit } from 'ts-gems';
+import type { Action as _Action, Operation as _Operation, PartialOutput } from '@opra/common';
 import type { Request as _Request } from '../request.js';
 import type { RequestContext } from '../request-context';
 declare module "@opra/common" {
     namespace Collection {
         namespace Action {
-            interface Request extends _Request {
-                operation: 'action';
-                action: string;
+            interface Request extends StrictOmit<_Request, 'endpoint'> {
+                endpoint: _Action;
             }
             interface Context extends Resource.Context {
             }
         }
         namespace Create {
-            interface Request extends _Request {
-                operation: 'create';
+            interface Request extends StrictOmit<_Request, 'endpoint'> {
+                endpoint: _Operation & {
+                    name: 'create';
+                };
                 data: any;
                 params: {
                     pick?: string[];
@@ -27,8 +29,10 @@ declare module "@opra/common" {
             }
         }
         namespace Delete {
-            interface Request extends _Request {
-                operation: 'delete';
+            interface Request extends StrictOmit<_Request, 'endpoint'> {
+                endpoint: _Operation & {
+                    name: 'delete';
+                };
                 key: any;
             }
             interface Context extends RequestContext {
@@ -36,8 +40,10 @@ declare module "@opra/common" {
             }
         }
         namespace DeleteMany {
-            interface Request extends _Request {
-                operation: 'deleteMany';
+            interface Request extends StrictOmit<_Request, 'endpoint'> {
+                endpoint: _Operation & {
+                    name: 'deleteMany';
+                };
                 params: {
                     filter?: any;
                     [key: string]: any;
@@ -48,8 +54,10 @@ declare module "@opra/common" {
             }
         }
         namespace FindMany {
-            interface Request extends _Request {
-                operation: 'findMany';
+            interface Request extends StrictOmit<_Request, 'endpoint'> {
+                endpoint: _Operation & {
+                    name: 'findMany';
+                };
                 params: {
                     filter?: any;
                     pick?: string[];
@@ -68,8 +76,10 @@ declare module "@opra/common" {
             }
         }
         namespace Get {
-            interface Request extends _Request {
-                operation: 'get';
+            interface Request extends StrictOmit<_Request, 'endpoint'> {
+                endpoint: _Operation & {
+                    name: 'get';
+                };
                 key: any;
                 params: {
                     pick?: string[];
@@ -83,8 +93,10 @@ declare module "@opra/common" {
             }
         }
         namespace Update {
-            interface Request extends _Request {
-                operation: 'update';
+            interface Request extends StrictOmit<_Request, 'endpoint'> {
+                endpoint: _Operation & {
+                    name: 'update';
+                };
                 key: any;
                 data: any;
                 params: {
@@ -99,8 +111,10 @@ declare module "@opra/common" {
             }
         }
         namespace UpdateMany {
-            interface Request extends _Request {
-                operation: 'updateMany';
+            interface Request extends StrictOmit<_Request, 'endpoint'> {
+                endpoint: _Operation & {
+                    name: 'updateMany';
+                };
                 data: any;
                 params: {
                     filter?: any;

package/types/augmentation/container.augmentation.d.ts

@@ -1,10 +1,11 @@
+import { StrictOmit } from 'ts-gems';
+import { Action as _Action } from '@opra/common';
 import type { Request as _Request } from '../request.js';
 declare module "@opra/common" {
     namespace Container {
         namespace Action {
-            interface Request extends _Request {
-                operation: 'action';
-                action: string;
+            interface Request extends StrictOmit<_Request, 'endpoint'> {
+                endpoint: _Action;
             }
             interface Context extends Resource.Context {
             }

package/types/augmentation/singleton.augmentation.d.ts

@@ -1,19 +1,21 @@
-import type { PartialOutput } from '@opra/common';
+import { StrictOmit } from 'ts-gems';
+import type { Action as _Action, Operation as _Operation, PartialOutput } from '@opra/common';
 import type { Request as _Request } from '../request.js';
 import type { RequestContext } from '../request-context.js';
 declare module "@opra/common" {
     namespace Singleton {
         namespace Action {
-            interface Request extends _Request {
-                operation: 'action';
-                action: string;
+            interface Request extends StrictOmit<_Request, 'endpoint'> {
+                endpoint: _Action;
             }
             interface Context extends Resource.Context {
             }
         }
         namespace Create {
-            interface Request extends _Request {
-                operation: 'create';
+            interface Request extends StrictOmit<_Request, 'endpoint'> {
+                endpoint: _Operation & {
+                    name: 'create';
+                };
                 data: any;
                 params: {
                     pick?: string[];
@@ -26,16 +28,20 @@ declare module "@opra/common" {
             }
         }
         namespace Delete {
-            interface Request extends _Request {
-                operation: 'delete';
+            interface Request extends StrictOmit<_Request, 'endpoint'> {
+                endpoint: _Operation & {
+                    name: 'delete';
+                };
             }
             interface Context extends RequestContext {
                 request: Request;
             }
         }
         namespace Get {
-            interface Request extends _Request {
-                operation: 'get';
+            interface Request extends StrictOmit<_Request, 'endpoint'> {
+                endpoint: _Operation & {
+                    name: 'get';
+                };
                 params: {
                     pick?: string[];
                     omit?: string[];
@@ -47,8 +53,10 @@ declare module "@opra/common" {
             }
         }
         namespace Update {
-            interface Request extends _Request {
-                operation: 'update';
+            interface Request extends StrictOmit<_Request, 'endpoint'> {
+                endpoint: _Operation & {
+                    name: 'update';
+                };
                 data: any;
                 params: {
                     pick?: string[];

package/types/augmentation/storage.augmentation.d.ts

@@ -1,19 +1,22 @@
+import { StrictOmit } from 'ts-gems';
+import type { Action as _Action, Operation as _Operation } from '@opra/common';
 import type { MultipartIterator } from '../http/helpers/multipart-helper';
 import type { Request as _Request } from '../request.js';
 import type { RequestContext } from '../request-context.js';
 declare module "@opra/common" {
     namespace Storage {
         namespace Action {
-            interface Request extends _Request {
-                operation: 'action';
-                action: string;
+            interface Request extends StrictOmit<_Request, 'endpoint'> {
+                endpoint: _Action;
             }
             interface Context extends Resource.Context {
             }
         }
         namespace Delete {
-            interface Request extends _Request {
-                operation: 'delete';
+            interface Request extends StrictOmit<_Request, 'endpoint'> {
+                endpoint: _Operation & {
+                    name: 'delete';
+                };
                 path?: string;
             }
             interface Context extends RequestContext {
@@ -21,8 +24,10 @@ declare module "@opra/common" {
             }
         }
         namespace Get {
-            interface Request extends _Request {
-                operation: 'get';
+            interface Request extends StrictOmit<_Request, 'endpoint'> {
+                endpoint: _Operation & {
+                    name: 'get';
+                };
                 path?: string;
             }
             interface Context extends RequestContext {
@@ -30,8 +35,10 @@ declare module "@opra/common" {
             }
         }
         namespace Post {
-            interface Request extends _Request {
-                operation: 'post';
+            interface Request extends StrictOmit<_Request, 'endpoint'> {
+                endpoint: _Operation & {
+                    name: 'post';
+                };
                 path?: string;
                 parts: MultipartIterator;
             }

package/types/execution-context.d.ts

@@ -4,7 +4,6 @@ import type { Protocol } from './platform-adapter.js';
 export interface ExecutionContext {
     readonly protocol: Protocol;
     readonly platform: string;
-    errors: Error[];
     switchToHttp(): HttpMessageContext;
     switchToWs(): WsMessageContext;
     switchToRpc(): RpcMessageContext;

package/types/execution-context.host.d.ts

@@ -11,7 +11,6 @@ export declare class ExecutionContextHost extends AsyncEventEmitter implements E
     readonly http?: HttpMessageContext;
     readonly ws?: WsMessageContext;
     readonly rpc?: RpcMessageContext;
-    errors: Error[];
     constructor(api: ApiDocument, platform: string, protocol: {
         http?: {
             incoming: HttpServerRequest;

package/types/http/http-adapter-host.d.ts

@@ -1,4 +1,4 @@
-import { Collection, OpraURLPath, OpraURLPathComponent, Parameter, Resource, Singleton, Storage } from '@opra/common';
+import { Collection, OpraURLPath, Parameter, Resource, Singleton, Storage } from '@opra/common';
 import { ExecutionContext } from '../execution-context.js';
 import { PlatformAdapterHost } from '../platform-adapter.host.js';
 import type { Protocol } from '../platform-adapter.js';
@@ -26,9 +26,9 @@ export declare abstract class HttpAdapterHost extends PlatformAdapterHost {
     protected _parseRequestAction(executionContext: ExecutionContext, resource: Resource, urlPath: OpraURLPath, searchParams: URLSearchParams): Promise<RequestHost>;
     protected _parseRequestCollection(executionContext: ExecutionContext, resource: Collection, urlPath: OpraURLPath, searchParams: URLSearchParams): Promise<RequestHost>;
     protected _parseRequestSingleton(executionContext: ExecutionContext, resource: Singleton, urlPath: OpraURLPath, searchParams?: URLSearchParams): Promise<RequestHost>;
-    protected _parseRequestStorage(executionContext: ExecutionContext, resource: Storage, urlPath: OpraURLPath, searchParams: URLSearchParams): Promise<RequestHost>;
-    protected parseParameters(paramDefs: Map<string, Parameter>, pathComponent: OpraURLPathComponent, searchParams?: URLSearchParams): Record<string, any>;
+    protected _parseRequestStorage(executionContext: ExecutionContext, resource: Storage, searchParams: URLSearchParams): Promise<RequestHost>;
+    protected parseParameters(paramDefs: Map<string, Parameter>, searchParams?: URLSearchParams): Record<string, any>;
     protected executeRequest(context: RequestContext): Promise<void>;
     sendResponse(context: RequestContext): Promise<void>;
-    protected handleError(context: ExecutionContext): Promise<void>;
+    protected sendErrorResponse(context: ExecutionContext, errors: any[]): Promise<void>;
 }

package/types/platform-adapter.host.d.ts

@@ -1,5 +1,5 @@
 import { AsyncEventEmitter } from 'strict-typed-events';
-import { ApiDocument, Endpoint, I18n, Resource } from '@opra/common';
+import { Action, ApiDocument, I18n, Operation, Resource } from '@opra/common';
 import { ExecutionContext } from './execution-context.js';
 import { Interceptor } from './interfaces/interceptor.interface.js';
 import type { PlatformAdapter, Protocol } from './platform-adapter.js';
@@ -27,8 +27,13 @@ export declare abstract class PlatformAdapterHost extends AsyncEventEmitter impl
      */
     protected init(api: ApiDocument, options?: PlatformAdapter.Options): Promise<void>;
     getController(resource: Resource | string): Promise<any>;
-    getOperationHandler(resource: Resource | string, operationOrAction: string): Promise<{
-        endpoint: Endpoint;
+    getActionHandler(resource: Resource | string, name: string): Promise<{
+        endpoint: Action;
+        controller: any;
+        handler: Function;
+    }>;
+    getOperationHandler(resource: Resource | string, name: string): Promise<{
+        endpoint: Operation;
         controller: any;
         handler: Function;
     }>;

package/types/request.d.ts

@@ -1,11 +1,9 @@
-import { Endpoint, Resource } from '@opra/common';
+import { Action, Operation, Resource } from '@opra/common';
 import { HttpServerRequest } from './http/http-server-request.js';
 export interface Request {
     resource: Resource;
-    endpoint: Endpoint;
-    operation: string;
+    endpoint: Action | Operation;
     key?: any;
-    action?: string;
     controller: Object;
     handler: Function;
     contentId?: string;

package/types/request.host.d.ts

@@ -1,5 +1,6 @@
 import type { PartialSome, StrictOmit } from 'ts-gems';
 import type { Resource } from '@opra/common';
+import { Action, Operation } from '@opra/common';
 import type { HttpServerRequest } from './http/http-server-request.js';
 import type { Request } from './request.js';
 export declare namespace RequestHost {
@@ -14,6 +15,7 @@ export interface RequestHost extends Request {
 }
 export declare class RequestHost implements Request {
     controller: any;
+    endpoint: Action | Operation;
     http?: HttpServerRequest;
     key?: any;
     params: Record<string, any>;

package/types/response.d.ts

@@ -15,7 +15,7 @@ export interface Response {
     /**
      * Total count of matched entities. (Used in "search" endpoint with "count" option
      */
-    count?: number;
+    totalMatches?: number;
     switchToHttp(): HttpServerResponse;
     switchToWs(): never;
     switchToRpc(): never;