@opra/core 0.23.1 → 0.24.0

package/types/adapter/http/request-handlers/storage-request-handler.d.ts

@@ -1,5 +1,5 @@
+import { EndpointContext } from '../../endpoint-context.js';
 import type { ExecutionContext } from '../../execution-context';
-import { OperationContext } from '../../operation-context.js';
 import { Request } from '../../request.js';
 import type { HttpAdapterBase } from '../http-adapter-base.js';
 import { HttpServerRequest } from '../http-server-request.js';
@@ -18,6 +18,6 @@ export declare class StorageRequestHandler extends RequestHandlerBase {
     constructor(adapter: HttpAdapterBase, options?: StorageRequestHandler.Options);
     processRequest(executionContext: ExecutionContext): Promise<void>;
     parseRequest(executionContext: ExecutionContext, incoming: HttpServerRequest): Promise<Request | undefined>;
-    executeOperation(context: OperationContext): Promise<void>;
-    sendResponse(context: OperationContext): Promise<void>;
+    callEndpoint(context: EndpointContext): Promise<void>;
+    sendResponse(context: EndpointContext): Promise<void>;
 }

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

@@ -1,7 +1,7 @@
 import { FallbackLng, I18n, LanguageResource } from '@opra/common';
+import { EndpointContext } from './endpoint-context.js';
 import { ILogger } from './interfaces/logger.interface.js';
 import { RequestHandler } from './interfaces/request-handler.interface.js';
-import { OperationContext } from './operation-context.js';
 export type Protocol = 'http' | 'ws' | 'rpc';
 export interface PlatformAdapter extends RequestHandler {
     readonly protocol: Protocol;
@@ -20,7 +20,7 @@ export declare namespace PlatformAdapter {
         i18n?: I18n | I18nOptions | (() => Promise<I18n>);
         logger?: ILogger;
         on?: {
-            request?: (ctx: OperationContext) => void | Promise<void>;
+            request?: (ctx: EndpointContext) => void | Promise<void>;
         };
     }
     interface I18nOptions {

package/types/adapter/request.d.ts

@@ -2,7 +2,7 @@ import { Resource } from '@opra/common';
 import { HttpServerRequest } from './http/http-server-request.js';
 export interface Request {
     resource: Resource;
-    operation: string;
+    endpoint: string;
     contentId?: string;
     params?: Record<string, any>;
     switchToHttp(): HttpServerRequest;

package/types/adapter/response.d.ts

@@ -13,7 +13,7 @@ export interface Response {
      */
     continueOnError?: boolean;
     /**
-     * Total count of matched entities. (Used in "search" operation with "count" option
+     * Total count of matched entities. (Used in "search" endpoint with "count" option
      */
     count?: number;
     switchToHttp(): HttpServerResponse;

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

@@ -1,11 +1,16 @@
 import type { PartialOutput } from '@opra/common';
-import type { OperationContext } from '../adapter/operation-context.js';
+import type { EndpointContext } from '../adapter/endpoint-context.js';
 import type { Request as _Request } from '../adapter/request.js';
 declare module "@opra/common" {
     namespace Collection {
+        namespace Action {
+            interface Context extends Resource.Context {
+                key?: any;
+            }
+        }
         namespace Create {
             interface Request extends _Request {
-                operation: 'create';
+                endpoint: 'create';
                 data: any;
                 params: {
                     pick?: string[];
@@ -13,33 +18,33 @@ declare module "@opra/common" {
                     include?: string[];
                 };
             }
-            interface Context extends OperationContext {
+            interface Context extends EndpointContext {
                 request: Request;
             }
         }
         namespace Delete {
             interface Request extends _Request {
-                operation: 'delete';
+                endpoint: 'delete';
                 key: any;
             }
-            interface Context extends OperationContext {
+            interface Context extends EndpointContext {
                 request: Request;
             }
         }
         namespace DeleteMany {
             interface Request extends _Request {
-                operation: 'deleteMany';
+                endpoint: 'deleteMany';
                 params: {
                     filter?: any;
                 };
             }
-            interface Context extends OperationContext {
+            interface Context extends EndpointContext {
                 request: Request;
             }
         }
         namespace FindMany {
             interface Request extends _Request {
-                operation: 'findMany';
+                endpoint: 'findMany';
                 params: {
                     filter?: any;
                     pick?: string[];
@@ -52,13 +57,13 @@ declare module "@opra/common" {
                     count?: boolean;
                 };
             }
-            interface Context extends OperationContext {
+            interface Context extends EndpointContext {
                 request: Request;
             }
         }
         namespace Get {
             interface Request extends _Request {
-                operation: 'get';
+                endpoint: 'get';
                 key: any;
                 params: {
                     pick?: string[];
@@ -66,13 +71,13 @@ declare module "@opra/common" {
                     include?: string[];
                 };
             }
-            interface Context extends OperationContext {
+            interface Context extends EndpointContext {
                 request: Request;
             }
         }
         namespace Update {
             interface Request extends _Request {
-                operation: 'update';
+                endpoint: 'update';
                 key: any;
                 data: any;
                 params: {
@@ -81,24 +86,24 @@ declare module "@opra/common" {
                     include?: string[];
                 };
             }
-            interface Context extends OperationContext {
+            interface Context extends EndpointContext {
                 request: Request;
             }
         }
         namespace UpdateMany {
             interface Request extends _Request {
-                operation: 'updateMany';
+                endpoint: 'updateMany';
                 data: any;
                 params: {
                     filter?: any;
                 };
             }
-            interface Context extends OperationContext {
+            interface Context extends EndpointContext {
                 request: Request;
             }
         }
     }
-    interface CollectionResource<T> {
+    interface ICollection<T> {
         create?(context: Collection.Create.Context): Promise<PartialOutput<T>>;
         delete?(context: Collection.Delete.Context): Promise<number> | undefined;
         deleteMany?(context: Collection.DeleteMany.Context): Promise<number> | undefined;

package/types/augmentation/resource.augmentation.d.ts

@@ -1,3 +1,4 @@
+import { EndpointContext } from '../adapter/endpoint-context.js';
 declare module "@opra/common" {
     interface CollectionConstructor {
         OnInit(): any;
@@ -7,6 +8,11 @@ declare module "@opra/common" {
         OnInit(): any;
         OnShutdown(): any;
     }
+    namespace Resource {
+        interface Context extends EndpointContext {
+            params: Record<string, any>;
+        }
+    }
     interface Resource {
         onInit?: (resource: Resource) => void | Promise<void>;
         onShutdown?: (resource: Resource) => void | Promise<void>;
@@ -30,4 +36,3 @@ declare module "@opra/common" {
         }
     }
 }
-export {};

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

@@ -1,11 +1,15 @@
 import type { PartialOutput } from '@opra/common';
-import type { OperationContext } from '../adapter/operation-context.js';
+import type { EndpointContext } from '../adapter/endpoint-context.js';
 import type { Request as _Request } from '../adapter/request.js';
 declare module "@opra/common" {
     namespace Singleton {
+        namespace Action {
+            interface Context extends Resource.Context {
+            }
+        }
         namespace Create {
             interface Request extends _Request {
-                operation: 'create';
+                endpoint: 'create';
                 data: any;
                 params: {
                     pick?: string[];
@@ -13,34 +17,34 @@ declare module "@opra/common" {
                     include?: string[];
                 };
             }
-            interface Context extends OperationContext {
+            interface Context extends EndpointContext {
                 request: Request;
             }
         }
         namespace Delete {
             interface Request extends _Request {
-                operation: 'delete';
+                endpoint: 'delete';
             }
-            interface Context extends OperationContext {
+            interface Context extends EndpointContext {
                 request: Request;
             }
         }
         namespace Get {
             interface Request extends _Request {
-                operation: 'get';
+                endpoint: 'get';
                 params: {
                     pick?: string[];
                     omit?: string[];
                     include?: string[];
                 };
             }
-            interface Context extends OperationContext {
+            interface Context extends EndpointContext {
                 request: Request;
             }
         }
         namespace Update {
             interface Request extends _Request {
-                operation: 'update';
+                endpoint: 'update';
                 data: any;
                 params: {
                     pick?: string[];
@@ -48,12 +52,12 @@ declare module "@opra/common" {
                     include?: string[];
                 };
             }
-            interface Context extends OperationContext {
+            interface Context extends EndpointContext {
                 request: Request;
             }
         }
     }
-    interface SingletonResource<T> {
+    interface ISingleton<T> {
         create?(context: Singleton.Create.Context): Promise<PartialOutput<T>>;
         delete?(context: Singleton.Delete.Context): Promise<number> | undefined;
         get?(context: Singleton.Get.Context): Promise<PartialOutput<T> | undefined>;

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

@@ -1,22 +1,26 @@
 /// <reference types="node" />
 /// <reference types="node" />
 import type { Readable } from 'stream';
+import type { EndpointContext } from '../adapter/endpoint-context';
 import type { MultipartIterator } from '../adapter/http/helpers/multipart-helper';
-import type { OperationContext } from '../adapter/operation-context.js';
 import type { Request as _Request } from '../adapter/request.js';
 declare module "@opra/common" {
     namespace Storage {
+        namespace Action {
+            interface Context extends Resource.Context {
+            }
+        }
         namespace Delete {
             interface Request extends _Request {
             }
-            interface Context extends OperationContext {
+            interface Context extends EndpointContext {
                 request: Request;
             }
         }
         namespace Get {
             interface Request extends _Request {
             }
-            interface Context extends OperationContext {
+            interface Context extends EndpointContext {
                 request: Request;
             }
         }
@@ -24,12 +28,12 @@ declare module "@opra/common" {
             interface Request extends _Request {
                 parts: MultipartIterator;
             }
-            interface Context extends OperationContext {
+            interface Context extends EndpointContext {
                 request: Request;
             }
         }
     }
-    interface StorageResource {
+    interface IStorage {
         delete?(context: Storage.Delete.Context): Promise<number | undefined>;
         get?(context: Storage.Get.Context): Promise<Buffer | Readable | undefined>;
         post?(context: Storage.Post.Context): Promise<void>;

package/types/index.d.ts

@@ -5,7 +5,7 @@ import './augmentation/singleton.augmentation.js';
 import './augmentation/storage.augmentation.js';
 export * from './types.js';
 export * from './adapter/execution-context.js';
-export * from './adapter/operation-context.js';
+export * from './adapter/endpoint-context.js';
 export * from './adapter/platform-adapter.js';
 export * from './adapter/request.js';
 export * from './adapter/response.js';