@clairejs/server 3.23.6 → 3.24.0

package/README.md

@@ -1,5 +1,9 @@
 ## Change Log
 
+#### 3.24.0
+
+-   add ApiInfo class and @PublicAccess, @TfaRequired decorators
+
 #### 3.23.6
 
 -   fix execCount not being calculated correctly

package/dist/common/request/endpoint-metadata.d.ts

@@ -1,5 +1,6 @@
-import { type ApiInfo, type Constructor, type ObjectFieldMetadata } from "@clairejs/core";
+import { type Constructor, type ObjectFieldMetadata } from "@clairejs/core";
 import { type RequestDataSource } from "./types";
+import { ApiInfo } from "../../http/common/dto";
 export interface EndpointMetadata extends ApiInfo, ObjectFieldMetadata {
     controller: any;
     params?: {

package/dist/http/common/dto.d.ts

@@ -0,0 +1,21 @@
+import { HttpMethod, SocketMethod, DtoMetadata } from "@clairejs/core";
+export declare class ApiInfo {
+    id: string;
+    apiGroup?: string;
+    description?: string;
+    displayName: string;
+    readOnly: boolean;
+    method: HttpMethod | SocketMethod;
+    mount: string;
+    paramDto?: DtoMetadata;
+    queryDto?: DtoMetadata;
+    bodyDto?: DtoMetadata;
+    responseDto?: DtoMetadata;
+    upstreamMessageDtos?: DtoMetadata[];
+    downstreamMessageDtos?: DtoMetadata[];
+    publicAccess?: boolean;
+    tfaRequired?: boolean;
+}
+export declare class ApiInfoResponse {
+    apis: ApiInfo[];
+}

package/dist/http/common/dto.js

@@ -0,0 +1,143 @@
+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);
+};
+import { Data, Field, HttpMethod, Enum, getObjectMetadata, DataType } from "@clairejs/core";
+let ApiInfo = class ApiInfo {
+    id;
+    apiGroup;
+    description;
+    displayName;
+    readOnly;
+    method;
+    mount;
+    paramDto;
+    queryDto;
+    bodyDto;
+    responseDto;
+    upstreamMessageDtos;
+    downstreamMessageDtos;
+    publicAccess;
+    tfaRequired;
+};
+__decorate([
+    Field({
+        description: "Unique id of the API within the service",
+        isRequired: true,
+    }),
+    __metadata("design:type", String)
+], ApiInfo.prototype, "id", void 0);
+__decorate([
+    Field({
+        description: "Name of the api group",
+    }),
+    __metadata("design:type", String)
+], ApiInfo.prototype, "apiGroup", void 0);
+__decorate([
+    Field({
+        description: "Description of the API",
+    }),
+    __metadata("design:type", String)
+], ApiInfo.prototype, "description", void 0);
+__decorate([
+    Field({
+        description: "Display name of the API",
+        isRequired: true,
+    }),
+    __metadata("design:type", String)
+], ApiInfo.prototype, "displayName", void 0);
+__decorate([
+    Field({
+        description: "Whether this API does not allow data modification",
+        isRequired: true,
+    }),
+    __metadata("design:type", Boolean)
+], ApiInfo.prototype, "readOnly", void 0);
+__decorate([
+    Field({
+        description: "Http method used to call the API",
+        isRequired: true,
+        ...Enum(HttpMethod),
+    }),
+    __metadata("design:type", String)
+], ApiInfo.prototype, "method", void 0);
+__decorate([
+    Field({
+        description: "Http mount point of the API",
+        isRequired: true,
+    }),
+    __metadata("design:type", String)
+], ApiInfo.prototype, "mount", void 0);
+__decorate([
+    Field({
+        description: "Validation dto of request param",
+    }),
+    __metadata("design:type", Object)
+], ApiInfo.prototype, "paramDto", void 0);
+__decorate([
+    Field({
+        description: "Validation dto of request queries",
+    }),
+    __metadata("design:type", Object)
+], ApiInfo.prototype, "queryDto", void 0);
+__decorate([
+    Field({
+        description: "Validation dto of request body",
+    }),
+    __metadata("design:type", Object)
+], ApiInfo.prototype, "bodyDto", void 0);
+__decorate([
+    Field({
+        description: "Validation dto of response body",
+    }),
+    __metadata("design:type", Object)
+], ApiInfo.prototype, "responseDto", void 0);
+__decorate([
+    Field({
+        description: "Messages send from client to server for socket",
+    }),
+    __metadata("design:type", Array)
+], ApiInfo.prototype, "upstreamMessageDtos", void 0);
+__decorate([
+    Field({
+        description: "Messages send from server to client for socket",
+    }),
+    __metadata("design:type", Array)
+], ApiInfo.prototype, "downstreamMessageDtos", void 0);
+__decorate([
+    Field({
+        description: "Allow public access and bypass authorization",
+    }),
+    __metadata("design:type", Boolean)
+], ApiInfo.prototype, "publicAccess", void 0);
+__decorate([
+    Field({
+        description: "Upgraded tfa session is required to access this API",
+    }),
+    __metadata("design:type", Boolean)
+], ApiInfo.prototype, "tfaRequired", void 0);
+ApiInfo = __decorate([
+    Data()
+], ApiInfo);
+export { ApiInfo };
+let ApiInfoResponse = class ApiInfoResponse {
+    apis;
+};
+__decorate([
+    Field({
+        description: "All APIs of the service",
+        isRequired: true,
+        elementDto: getObjectMetadata(ApiInfo),
+        vectorProps: { elementDataType: DataType.OBJECT },
+    }),
+    __metadata("design:type", Array)
+], ApiInfoResponse.prototype, "apis", void 0);
+ApiInfoResponse = __decorate([
+    Data()
+], ApiInfoResponse);
+export { ApiInfoResponse };

package/dist/http/security/decorators.d.ts

@@ -0,0 +1,3 @@
+import { AbstractHttpController } from "../controller/AbstractHttpController";
+export declare const PublicAccess: () => (prototype: AbstractHttpController, propertyKey: string) => void;
+export declare const TfaRequired: () => (prototype: AbstractHttpController, propertyKey: string) => void;

package/dist/http/security/decorators.js

@@ -0,0 +1,9 @@
+import { initFieldMetadata } from "@clairejs/core";
+export const PublicAccess = () => (prototype, propertyKey) => {
+    const endpointMetadata = initFieldMetadata(prototype, propertyKey);
+    endpointMetadata.publicAccess = true;
+};
+export const TfaRequired = () => (prototype, propertyKey) => {
+    const endpointMetadata = initFieldMetadata(prototype, propertyKey);
+    endpointMetadata.tfaRequired = true;
+};

package/dist/index.d.ts

@@ -14,6 +14,7 @@ export * from "./http/controller/CrudHttpController";
 export * from "./http/controller/AbstractHttpRequestHandler";
 export * from "./http/controller/AbstractHttpMiddleware";
 export * from "./http/security/cors";
+export * from "./http/security/decorators";
 export * from "./http/auth/AbstractHttpAuthorizer";
 export * from "./http/repository/ModelRepository";
 export * from "./http/repository/DtoRepository";

package/dist/index.js

@@ -16,6 +16,7 @@ export * from "./http/controller/CrudHttpController";
 export * from "./http/controller/AbstractHttpRequestHandler";
 export * from "./http/controller/AbstractHttpMiddleware";
 export * from "./http/security/cors";
+export * from "./http/security/decorators";
 export * from "./http/auth/AbstractHttpAuthorizer";
 export * from "./http/repository/ModelRepository";
 export * from "./http/repository/DtoRepository";

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@clairejs/server",
-    "version": "3.23.6",
+    "version": "3.24.0",
     "description": "Claire server NodeJs framework written in Typescript.",
     "types": "dist/index.d.ts",
     "main": "dist/index.js",