@opra/common 1.0.0-beta.2 → 1.0.0-beta.4

package/types/exception/http-errors/forbidden.error.d.ts

@@ -1,4 +1,4 @@
-import { HttpStatusCode } from '../../http/index.js';
+import { HttpStatusCode } from '../../enums/index.js';
 import type { ErrorIssue } from '../error-issue.js';
 import { OpraHttpError } from '../opra-http-error.js';
 /**

package/types/index.d.cts

@@ -1,8 +1,8 @@
 export * from './document/index.js';
+export * from './enums/index.js';
 export * from './exception/index.js';
 export * from './filter/index.js';
 export * from './helpers/index.js';
-export * from './http/index.js';
 export * from './i18n/index.js';
 export * from './schema/index.js';
 export * from './types.js';

package/types/index.d.ts

@@ -1,8 +1,8 @@
 export * from './document/index.js';
+export * from './enums/index.js';
 export * from './exception/index.js';
 export * from './filter/index.js';
 export * from './helpers/index.js';
-export * from './http/index.js';
 export * from './i18n/index.js';
 export * from './schema/index.js';
 export * from './types.js';

package/types/schema/api-document.interface.d.ts

@@ -1,7 +1,14 @@
 import type { SpecVersion } from './constants.js';
 import type { DataTypeContainer } from './data-type-container.interface.js';
 import type { HttpController } from './http/http-controller.interface.js';
-export type Protocol = 'http' | 'ws' | 'rpc';
+import type { RpcController } from './rpc/rpc-controller.interface.js';
+export type Transport = 
+/** HTTP **/
+'http'
+/** WebSocket*/
+ | 'ws'
+/** Remote Procedure Call (Kafka, RabbitMQ, MQTT etc) */
+ | 'rpc';
 /**
  * @interface ApiDocument
  */
@@ -11,7 +18,7 @@ export interface ApiDocument extends DataTypeContainer {
     url?: string;
     info?: DocumentInfo;
     references?: Record<string, DocumentReference>;
-    api?: HttpApi;
+    api?: HttpApi | RpcApi;
 }
 /**
  * @interface DocumentInfo
@@ -49,7 +56,7 @@ export interface DocumentReference extends Pick<ApiDocument, 'id' | 'url' | 'inf
  * @interface Api
  */
 export interface Api extends DataTypeContainer {
-    protocol: Protocol;
+    transport: Transport;
     /**
      * Name of the api. Should be a computer friendly name
      */
@@ -57,11 +64,25 @@ export interface Api extends DataTypeContainer {
     description?: string;
 }
 /**
+ * HTTP Api
  * @interface HttpApi
  */
 export interface HttpApi extends Api {
-    protocol: 'http';
+    transport: 'http';
     description?: string;
     url?: string;
     controllers: Record<string, HttpController>;
 }
+/**
+ * Message Api (Kafka, RabbitMQ, MQTT etc)
+ * @interface RpcApi
+ */
+export interface RpcApi extends Api {
+    transport: 'rpc';
+    /**
+     * Name of the platform. (Kafka, RabbitMQ, etc.)
+     */
+    platform: string;
+    description?: string;
+    controllers: Record<string, RpcController>;
+}

package/types/schema/opra-schema.d.ts

@@ -16,6 +16,9 @@ export * from './http/http-operation-response.interface.js';
 export * from './http/http-parameter.interface.js';
 export * from './http/http-request-body.interface.js';
 export * from './http/http-status-range.interface.js';
+export * from './rpc/rpc-controller.interface.js';
+export * from './rpc/rpc-header.interface.js';
+export * from './rpc/rpc-operation.interface.js';
 export * from './type-guards.js';
 export * from './types.js';
 export * from './value.interface.js';

package/types/schema/rpc/rpc-controller.interface.d.ts

@@ -0,0 +1,22 @@
+import type { DataTypeContainer } from '../data-type-container.interface.js';
+import type { RpcHeader } from './rpc-header.interface.js';
+import type { RpcOperation } from './rpc-operation.interface.js';
+/**
+ * RPC Controller
+ * @interface RpcController
+ */
+export interface RpcController extends DataTypeContainer {
+    kind: RpcController.Kind;
+    description?: string;
+    operations?: Record<string, RpcOperation>;
+    headers?: RpcHeader[];
+}
+/**
+ *
+ * @namespace RpcController
+ */
+export declare namespace RpcController {
+    type Name = string;
+    const Kind = "RpcController";
+    type Kind = 'RpcController';
+}

package/types/schema/rpc/rpc-header.interface.d.ts

@@ -0,0 +1,19 @@
+import type { Value } from '../value.interface.js';
+/**
+ *
+ * @interface RpcHeader
+ */
+export interface RpcHeader extends Value {
+    /**
+     * Name of the parameter. RegExp pattern can be used matching parameter name
+     */
+    name: string | RegExp;
+    /**
+     * Indicates if parameter value required
+     */
+    required?: boolean;
+    /**
+     * Indicates if the parameter is deprecated and can be removed in the next
+     */
+    deprecated?: boolean | string;
+}

package/types/schema/rpc/rpc-operation.interface.d.ts

@@ -0,0 +1,26 @@
+import { DataType } from '../data-type/data-type.interface.js';
+import type { DataTypeContainer } from '../data-type-container.interface.js';
+import type { RpcHeader } from './rpc-header.interface.js';
+/**
+ * @interface RpcOperation
+ */
+export interface RpcOperation extends DataTypeContainer {
+    kind: RpcOperation.Kind;
+    description?: string;
+    channel: string | RegExp | (string | RegExp)[];
+    payloadType: string | DataType;
+    keyType?: string | DataType;
+    headers?: RpcHeader[];
+    response?: RpcOperationResponse;
+}
+export interface RpcOperationResponse {
+    description?: string;
+    channel?: string | RegExp | (string | RegExp)[];
+    payloadType: string | DataType;
+    keyType?: string | DataType;
+    headers?: RpcHeader[];
+}
+export declare namespace RpcOperation {
+    const Kind = "RpcOperation";
+    type Kind = 'RpcOperation';
+}

package/cjs/http/index.js

@@ -1,7 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const tslib_1 = require("tslib");
-tslib_1.__exportStar(require("./enums/http-headers-codes.enum.js"), exports);
-tslib_1.__exportStar(require("./enums/http-status-codes.enum.js"), exports);
-tslib_1.__exportStar(require("./enums/http-status-messages.js"), exports);
-tslib_1.__exportStar(require("./enums/mime-types.enum.js"), exports);

package/esm/http/index.js

@@ -1,4 +0,0 @@
-export * from './enums/http-headers-codes.enum.js';
-export * from './enums/http-status-codes.enum.js';
-export * from './enums/http-status-messages.js';
-export * from './enums/mime-types.enum.js';

package/types/http/index.d.ts

@@ -1,4 +0,0 @@
-export * from './enums/http-headers-codes.enum.js';
-export * from './enums/http-status-codes.enum.js';
-export * from './enums/http-status-messages.js';
-export * from './enums/mime-types.enum.js';