@opra/common 0.23.2 → 0.24.0

package/types/schema/resource/collection.interface.d.ts

@@ -1,8 +1,7 @@
 import type { OpraFilter } from '../../filter/index.js';
 import type { DataType } from '../data-type/data-type.interface.js';
 import type { Field } from '../data-type/field.interface';
-import type { Operation } from './operation.interface';
-import type { ResourceBase } from './resource.interface.js';
+import type { Endpoint, ResourceBase } from './resource.interface.js';
 export interface Collection extends ResourceBase {
     kind: Collection.Kind;
     type: DataType.Name;
@@ -12,40 +11,40 @@ export interface Collection extends ResourceBase {
 export declare namespace Collection {
     const Kind = "Collection";
     type Kind = 'Collection';
-    type CreateOperation = Operation & _OperationInput & _OperationResponse;
-    type DeleteOperation = Operation;
-    type DeleteManyOperation = Operation & _OperationFilter;
-    type GetOperation = Operation & _OperationResponse;
-    type FindManyOperation = Operation & _OperationFilter & _OperationResponse & {
+    type CreateEndpoint = Endpoint & _EndpointInput & _EndpointResponse;
+    type DeleteEndpoint = Endpoint;
+    type DeleteManyEndpoint = Endpoint & _EndpointFilter;
+    type GetEndpoint = Endpoint & _EndpointResponse;
+    type FindManyEndpoint = Endpoint & _EndpointFilter & _EndpointResponse & {
         sortFields?: string[];
         defaultSort?: string[];
     };
-    type UpdateOperation = Operation & _OperationInput & _OperationResponse;
-    type UpdateManyOperation = Operation & _OperationInput & _OperationFilter;
+    type UpdateEndpoint = Endpoint & _EndpointInput & _EndpointResponse;
+    type UpdateManyEndpoint = Endpoint & _EndpointInput & _EndpointFilter;
     interface Operations {
-        create?: CreateOperation;
-        delete?: DeleteOperation;
-        get?: GetOperation;
-        update?: UpdateOperation;
-        deleteMany?: DeleteManyOperation;
-        findMany?: FindManyOperation;
-        updateMany?: UpdateManyOperation;
+        create?: CreateEndpoint;
+        delete?: DeleteEndpoint;
+        get?: GetEndpoint;
+        update?: UpdateEndpoint;
+        deleteMany?: DeleteManyEndpoint;
+        findMany?: FindManyEndpoint;
+        updateMany?: UpdateManyEndpoint;
     }
 }
-interface _OperationFilter {
+interface _EndpointFilter {
     filters?: {
         field: Field.QualifiedName;
         operators?: OpraFilter.ComparisonOperator[];
     }[];
 }
-interface _OperationInput {
+interface _EndpointInput {
     input?: {
         maxContentSize?: number | string;
         pick?: Field.QualifiedName[];
         omit?: Field.QualifiedName[];
     };
 }
-interface _OperationResponse {
+interface _EndpointResponse {
     response?: {
         pick?: Field.QualifiedName[];
         omit?: Field.QualifiedName[];

package/types/schema/resource/container.interface.d.ts

@@ -1,7 +1,9 @@
-import type { Resource, ResourceBase } from './resource.interface.js';
+import type { DataType } from '../data-type/data-type.interface.js';
+import type { Resource, ResourceBase } from './resource.interface';
 export interface Container extends ResourceBase {
     kind: Container.Kind;
-    resources: Resource[];
+    types?: Record<DataType.Name, DataType>;
+    resources?: Record<Resource.Name, Resource>;
 }
 export declare namespace Container {
     const Kind = "Container";

package/types/schema/resource/resource.interface.d.ts

@@ -1,3 +1,4 @@
+import type { Field } from '../data-type/field.interface.js';
 import type { Collection } from './collection.interface.js';
 import type { Container } from './container.interface.js';
 import type { Singleton } from './singleton.interface.js';
@@ -10,4 +11,17 @@ export declare namespace Resource {
 export interface ResourceBase {
     kind: string;
     description?: string;
+    actions?: Record<Action.Name, Action>;
+}
+export interface Endpoint {
+    description?: string;
+}
+export interface Action {
+    parameters?: Record<Action.ParameterName, Action.Parameter>;
+}
+export declare namespace Action {
+    type Name = string;
+    type ParameterName = string;
+    interface Parameter extends Pick<Field, 'type' | 'description' | 'isArray' | 'default' | 'required' | 'deprecated' | 'examples'> {
+    }
 }

package/types/schema/resource/singleton.interface.d.ts

@@ -9,14 +9,14 @@ export interface Singleton extends ResourceBase {
 export declare namespace Singleton {
     const Kind = "Singleton";
     type Kind = 'Singleton';
-    type CreateOperation = Collection.CreateOperation;
-    type DeleteOperation = Collection.DeleteOperation;
-    type GetOperation = Collection.GetOperation;
-    type UpdateOperation = Collection.UpdateOperation;
+    type CreateEndpoint = Collection.CreateEndpoint;
+    type DeleteEndpoint = Collection.DeleteEndpoint;
+    type GetEndpoint = Collection.GetEndpoint;
+    type UpdateEndpoint = Collection.UpdateEndpoint;
     interface Operations {
-        create?: CreateOperation;
-        delete?: DeleteOperation;
-        get?: GetOperation;
-        update?: UpdateOperation;
+        create?: CreateEndpoint;
+        delete?: DeleteEndpoint;
+        get?: GetEndpoint;
+        update?: UpdateEndpoint;
     }
 }

package/types/schema/resource/storage.interface.d.ts

@@ -1,5 +1,4 @@
-import type { Operation } from './operation.interface';
-import type { ResourceBase } from './resource.interface.js';
+import type { Endpoint, ResourceBase } from './resource.interface.js';
 export interface Storage extends ResourceBase {
     kind: Storage.Kind;
     operations: Storage.Operations;
@@ -7,9 +6,9 @@ export interface Storage extends ResourceBase {
 export declare namespace Storage {
     const Kind = "Storage";
     type Kind = 'Storage';
-    type DeleteOperation = Operation;
-    type GetOperation = Operation;
-    type PostOperation = Operation & {
+    type DeleteEndpoint = Endpoint;
+    type GetEndpoint = Endpoint;
+    type PostEndpoint = Endpoint & {
         /**
          * the minium size of uploaded file
          *
@@ -48,8 +47,8 @@ export declare namespace Storage {
         maxFieldsSize?: number | undefined;
     };
     interface Operations {
-        delete?: DeleteOperation;
-        get?: GetOperation;
-        post?: PostOperation;
+        delete?: DeleteEndpoint;
+        get?: GetEndpoint;
+        post?: PostEndpoint;
     }
 }

package/types/schema/type-guards.d.ts

@@ -14,7 +14,7 @@ export declare function isSimpleType(obj: any): obj is SimpleType;
 export declare function isUnionType(obj: any): obj is UnionType;
 export declare function isMappedType(obj: any): obj is MappedType;
 export declare function isEnumType(obj: any): obj is EnumType;
-export declare function isResource(obj: any): obj is Resource;
+export declare function isSource(obj: any): obj is Resource;
 export declare function isCollection(obj: any): obj is Collection;
 export declare function isSingleton(obj: any): obj is Singleton;
 export declare function isStorage(obj: any): obj is Singleton;

package/cjs/schema/resource/operation.interface.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/esm/schema/resource/operation.interface.js

@@ -1 +0,0 @@
-export {};

package/types/schema/resource/operation.interface.d.ts

@@ -1,3 +0,0 @@
-export interface Operation {
-    description?: string;
-}