@tsed/schema 6.75.9 → 6.76.0

package/lib/decorators/class/children.d.ts

@@ -0,0 +1,11 @@
+import { Type } from "@tsed/core";
+/**
+ * Add Children class to compose routes
+ *
+ * @decorator
+ * @swagger
+ * @schema
+ * @classDecorator
+ * @param children
+ */
+export declare function Children(...children: Type<any>[]): ClassDecorator;

package/lib/decorators/index.d.ts

@@ -1,3 +1,4 @@
+export * from "./class/children";
 export * from "./collections/collectionContains";
 export * from "./collections/collectionOf";
 export * from "./collections/maxItems";

package/lib/domain/JsonEntityStore.d.ts

@@ -12,32 +12,30 @@ export declare class JsonEntityStore extends Entity implements JsonEntityStoreOp
      * List of children JsonEntityStore (properties or methods or params)
      */
     readonly children: Map<string | number, JsonEntityStore>;
-    /**
-     * Path used to generate open spec.
-     */
-    path: string;
-    constructor(options: JsonEntityStoreOptions);
     /**
      * Ref to JsonSchema
      */
     protected _schema: JsonSchema;
     /**
-     * Return the JsonSchema
+     * Ref to JsonOperation when the decorated object is a method.
      */
-    get schema(): JsonSchema;
+    protected _operation: JsonOperation;
+    /**
+     * Ref to JsonParameter when the decorated object is a parameter.
+     */
+    protected _parameter: JsonParameter;
     [key: string]: any;
+    constructor(options: JsonEntityStoreOptions);
+    get path(): string;
+    set path(path: string);
     /**
-     * Ref to JsonOperation when the decorated object is a method.
+     * Return the JsonSchema
      */
-    protected _operation: JsonOperation;
+    get schema(): JsonSchema;
     /**
      * Return the JsonOperation
      */
     get operation(): JsonOperation | undefined;
-    /**
-     * Ref to JsonParameter when the decorated object is a parameter.
-     */
-    protected _parameter: JsonParameter;
     /**
      * Return the JsonParameter
      */
@@ -79,6 +77,7 @@ export declare class JsonEntityStore extends Entity implements JsonEntityStoreOp
      */
     static from<T extends JsonEntityStore = JsonEntityStore>(...args: any[]): NonNullable<T>;
     static fromMethod(target: any, propertyKey: string | symbol): JsonEntityStore;
+    get<T = any>(key: string, defaultValue?: any): T;
     getResponseOptions(status: number, contentType?: string): undefined | any;
     /**
      * Check precondition between value, required and allowedRequiredValues to know if the entity is required.

package/lib/domain/JsonOperation.d.ts

@@ -7,6 +7,7 @@ import { JsonSchema } from "./JsonSchema";
 export interface JsonMethodPath {
     path: string | RegExp;
     method: string;
+    isFinal?: boolean;
     [key: string]: any;
 }
 export interface JsonOperationOptions extends OS3Operation<JsonSchema, JsonParameter, JsonMap<JsonResponse>> {

package/lib/domain/JsonOperationPathsMap.d.ts

@@ -0,0 +1,7 @@
+import { JsonMethodPath } from "./JsonOperation";
+export declare class JsonOperationPathsMap extends Map<string, JsonMethodPath> {
+    setOperationPath(operationPath: JsonMethodPath): void;
+    protected getKey: (method: string, path: any) => string;
+    protected updateFinalRouteState(key: string): void;
+    protected setFinalRoute(key: string, operationPath: JsonMethodPath): void;
+}

package/lib/domain/JsonOperationRoute.d.ts

@@ -0,0 +1,16 @@
+import { Type } from "@tsed/core";
+import { JsonMethodPath } from "./JsonOperation";
+import { JsonEntityStore } from "./JsonEntityStore";
+export declare class JsonOperationRoute<Entity extends JsonEntityStore = JsonEntityStore> {
+    readonly token: Type<any>;
+    readonly endpoint: Entity;
+    readonly operationPath?: JsonMethodPath;
+    readonly basePath?: string;
+    constructor(options: Partial<JsonOperationRoute>);
+    get path(): string | RegExp | undefined;
+    get fullPath(): string;
+    get method(): string;
+    get isFinal(): boolean;
+    get propertyKey(): string | symbol;
+    get store(): import("@tsed/core").Store;
+}

package/lib/domain/index.d.ts

@@ -7,5 +7,6 @@ export * from "./JsonSchema";
 export * from "./JsonFormatTypes";
 export * from "./SpecTypes";
 export * from "./JsonEntityStore";
+export * from "./JsonOperationRoute";
 export * from "./JsonParameterTypes";
 export * from "./JsonLazyRef";

package/lib/index.d.ts

@@ -4,12 +4,14 @@ export * from "./utils/getJsonSchema";
 export * from "./utils/getJsonType";
 export * from "./utils/getPropertiesStores";
 export * from "./utils/getOperationsStores";
+export * from "./utils/getOperationsRoutes";
 export * from "./utils/getSpec";
 export * from "./utils/mergeSpec";
 export * from "./utils/generics";
 export * from "./utils/mapHeaders";
 export * from "./utils/isSuccessStatus";
 export * from "./utils/from";
+export * from "./utils/concatPath";
 export * from "./utils/defineStatusModel";
 export * from "./domain";
 export * from "./hooks/alterIgnore";

package/lib/index.js

@@ -2015,11 +2015,6 @@ class JsonEntityStore extends core.Entity {
      */
 
     this.children = new Map();
-    /**
-     * Path used to generate open spec.
-     */
-
-    this.path = "/";
     this.store = options.store;
     /* istanbul ignore next */
 
@@ -2029,6 +2024,14 @@ class JsonEntityStore extends core.Entity {
 
     this.build();
   }
+
+  get path() {
+    return this.store.get("path", "/");
+  }
+
+  set path(path) {
+    this.store.set("path", path);
+  }
   /**
    * Return the JsonSchema
    */
@@ -2187,6 +2190,10 @@ class JsonEntityStore extends core.Entity {
     return this.from(target, propertyKey, core.descriptorOf(target, propertyKey));
   }
 
+  get(key, defaultValue) {
+    return this.store.get(key, defaultValue);
+  }
+
   getResponseOptions(status, contentType = "application/json") {
     var _this$operation, _this$operation$getRe;
 
@@ -2930,6 +2937,35 @@ function getProperties(target, options = {}) {
   return map;
 }
 
+class JsonOperationPathsMap extends Map {
+  constructor() {
+    super(...arguments);
+
+    this.getKey = (method, path) => `${method}-${path}`;
+  }
+
+  setOperationPath(operationPath) {
+    if (operationPath.method !== exports.OperationMethods.CUSTOM) {
+      const key = this.getKey(operationPath.method, operationPath.path);
+      this.updateFinalRouteState(key);
+      this.updateFinalRouteState(this.getKey(exports.OperationMethods.ALL, operationPath.path));
+      this.setFinalRoute(key, operationPath);
+    }
+  }
+
+  updateFinalRouteState(key) {
+    if (this.has(key)) {
+      this.get(key).isFinal = false;
+    }
+  }
+
+  setFinalRoute(key, operationPath) {
+    this.set(key, operationPath);
+    operationPath.isFinal = true;
+  }
+
+}
+
 /**
  * @ignore
  */
@@ -2939,6 +2975,7 @@ function getOperationsStores(target) {
 
   if (!store.$operations) {
     const stores = getInheritedStores(store);
+    const operationPaths = new JsonOperationPathsMap();
     store.$operations = new Map();
     stores.forEach(currentStore => {
       currentStore.children.forEach(propStore => {
@@ -2947,11 +2984,94 @@ function getOperationsStores(target) {
         }
       });
     });
+    store.$operations.forEach(store => {
+      var _store$operation;
+
+      (_store$operation = store.operation) == null ? void 0 : _store$operation.operationPaths.forEach(operationPath => {
+        operationPaths.setOperationPath(operationPath);
+      });
+    });
+    operationPaths.clear();
   }
 
   return store.$operations;
 }
 
+function concatPath(basePath, path) {
+  return ((basePath || "") + (path || "")).replace(/\/\//gi, "/");
+}
+
+class JsonOperationRoute {
+  constructor(options) {
+    Object.assign(this, options);
+  }
+
+  get path() {
+    var _this$operationPath;
+
+    return (_this$operationPath = this.operationPath) == null ? void 0 : _this$operationPath.path;
+  }
+
+  get fullPath() {
+    return concatPath(this.basePath, this.path);
+  }
+
+  get method() {
+    var _this$operationPath2;
+
+    return ((_this$operationPath2 = this.operationPath) == null ? void 0 : _this$operationPath2.method) || "USE";
+  }
+
+  get isFinal() {
+    var _this$operationPath3;
+
+    return !!((_this$operationPath3 = this.operationPath) != null && _this$operationPath3.isFinal);
+  }
+
+  get propertyKey() {
+    return this.endpoint.propertyKey;
+  }
+
+  get store() {
+    return this.endpoint.store;
+  }
+
+}
+
+function getOperationsRoutes(token, options = {}) {
+  const store = token.isStore ? token : getJsonEntityStore(token);
+  const basePath = ((options.basePath || "") + (store.path || "")).replace(/\/\//gi, "/");
+  let operationsRoutes = [];
+
+  if (options.withChildren) {
+    const children = store.get("childrenControllers", []);
+    operationsRoutes = children.reduce((operationsRoutes, token) => {
+      return operationsRoutes.concat(getOperationsRoutes(token, _extends({}, options, {
+        basePath
+      })));
+    }, operationsRoutes);
+  }
+
+  return [...getOperationsStores(token).values()].reduce((routes, endpoint) => {
+    const {
+      operation
+    } = endpoint;
+
+    if (operation) {
+      operation.operationPaths.forEach(operationPath => {
+        routes.push(new JsonOperationRoute({
+          basePath,
+          token,
+          endpoint,
+          operationPath
+        }));
+      });
+    }
+
+    return routes;
+  }, operationsRoutes);
+}
+
 /**
  * Return a sanitized path
  * @param path
@@ -3592,6 +3712,54 @@ function getStatusModel(status) {
   return statusesModel.get(status);
 }
 
+/**
+ * Decorator util to compose another decorator. See @@Description@@ decorator implementation for more details.
+ *
+ * ## Usage
+ *
+ * ```typescript
+ * export function Description(description: any) {
+ *   return JsonEntityFn((entity: JsonEntityStore, args: DecoratorParameters) => {
+ *       entity.itemSchema.description(description)
+ *   });
+ * }
+ * ```
+ *
+ * @param fn
+ * @decorator
+ * @utils
+ * @model
+ */
+
+function JsonEntityFn(fn) {
+  return (...parameters) => {
+    const result = fn(getJsonEntityStore(...parameters), parameters);
+
+    if (typeof result === "function") {
+      result(...parameters);
+    }
+  };
+}
+
+/**
+ * Add Children class to compose routes
+ *
+ * @decorator
+ * @swagger
+ * @schema
+ * @classDecorator
+ * @param children
+ */
+
+function Children(...children) {
+  return JsonEntityFn(store => {
+    store.store.set("childrenControllers", children);
+    children.forEach(childToken => {
+      core.Store.from(childToken).set("parentController", store.token);
+    });
+  });
+}
+
 /**
  * Set the type of the item collection. The possible value is String, Boolean, Number, Date, Object, Class, etc...
  *
@@ -3726,35 +3894,6 @@ function CollectionContains(type) {
   return CollectionOf(type).Contains();
 }
 
-/**
- * Decorator util to compose another decorator. See @@Description@@ decorator implementation for more details.
- *
- * ## Usage
- *
- * ```typescript
- * export function Description(description: any) {
- *   return JsonEntityFn((entity: JsonEntityStore, args: DecoratorParameters) => {
- *       entity.itemSchema.description(description)
- *   });
- * }
- * ```
- *
- * @param fn
- * @decorator
- * @utils
- * @model
- */
-
-function JsonEntityFn(fn) {
-  return (...parameters) => {
-    const result = fn(getJsonEntityStore(...parameters), parameters);
-
-    if (typeof result === "function") {
-      result(...parameters);
-    }
-  };
-}
-
 /**
  * The value `maxItems` MUST be a non-negative integer.
  *
@@ -7788,6 +7927,7 @@ exports.Allow = Allow;
 exports.Any = Any;
 exports.AnyOf = AnyOf;
 exports.ArrayOf = ArrayOf;
+exports.Children = Children;
 exports.CollectionContains = CollectionContains;
 exports.CollectionOf = CollectionOf;
 exports.Const = Const;
@@ -7830,6 +7970,7 @@ exports.JsonLazyRef = JsonLazyRef;
 exports.JsonMap = JsonMap;
 exports.JsonMedia = JsonMedia;
 exports.JsonOperation = JsonOperation;
+exports.JsonOperationRoute = JsonOperationRoute;
 exports.JsonParameter = JsonParameter;
 exports.JsonRequestBody = JsonRequestBody;
 exports.JsonResponse = JsonResponse;
@@ -7885,6 +8026,7 @@ exports.any = any;
 exports.anyOf = anyOf;
 exports.array = array;
 exports.boolean = boolean;
+exports.concatPath = concatPath;
 exports.date = date;
 exports.datetime = datetime;
 exports.defineStatusModel = defineStatusModel;
@@ -7894,6 +8036,7 @@ exports.from = from;
 exports.getGenericsMap = getGenericsMap;
 exports.getJsonSchema = getJsonSchema;
 exports.getJsonType = getJsonType;
+exports.getOperationsRoutes = getOperationsRoutes;
 exports.getOperationsStores = getOperationsStores;
 exports.getProperties = getProperties;
 exports.getPropertiesStores = getPropertiesStores;