@webda/core 2.4.1 → 3.0.0

package/lib/application.d.ts

@@ -1,13 +1,38 @@
 import { WorkerLogLevel, WorkerOutput } from "@webda/workout";
 import { JSONSchema7 } from "json-schema";
 import { OpenAPIV3 } from "openapi-types";
-import { Constructor, Context, Core, CoreModel, CoreModelDefinition, Service } from "./index.js";
+import { Constructor, Core, CoreModel, CoreModelDefinition, Service } from "./index.js";
 export type PackageDescriptorAuthor = string | {
     name?: string;
     email?: string;
     url?: string;
 };
 export type Modda = ServiceConstructor<Service>;
+/**
+ * Defined relationship for one model
+ */
+export type ModelGraph = {
+    parent?: Omit<ModelRelation, "type">;
+    links?: ModelRelation[];
+    queries?: {
+        attribute: string;
+        model: string;
+        targetAttribute: string;
+    }[];
+    maps?: any[];
+    children?: string[];
+    binaries?: {
+        attribute: string;
+        cardinality: "ONE" | "MANY";
+        metadata?: string;
+    }[];
+};
+/**
+ * Defined relationship for all models
+ */
+export type ModelsGraph = {
+    [key: string]: ModelGraph;
+};
 /**
  * Some package exists but seems pretty big for this
  * https://classic.yarnpkg.com/en/docs/package-json
@@ -74,7 +99,13 @@ export interface PackageDescriptor {
 export type ModelRelation = {
     attribute: string;
     model: string;
-    type: "";
+    type: "LINK" | "LINKS_MAP" | "LINKS_ARRAY" | "LINKS_SIMPLE_ARRAY";
+};
+/**
+ * Define the model hierarchy
+ */
+export type ModelsTree = {
+    [key: string]: ModelsTree;
 };
 /**
  * A Webda module is a NPM package
@@ -91,22 +122,49 @@ export interface Module {
     /**
      * Models provided by the module
      */
-    models?: {
-        [key: string]: string;
-    };
-    /**
-     * Models graph
-     */
-    modelsGraph?: {
-        [key: string]: {
-            parent?: Omit<ModelRelation, "type">;
-            links?: ModelRelation[];
-            queries?: {
-                attribute: string;
-                model: string;
-                targetAttribute: string;
+    models: {
+        /**
+         * Models provided by the module
+         */
+        list: {
+            [key: string]: string;
+        };
+        /**
+         * Models hierarchy tree
+         *
+         * Models Graph establish the relationship between models
+         * Models Tree establish the hierarchy between models classes
+         */
+        tree: ModelsTree;
+        /**
+         * Models graph
+         *
+         * Typescript does not have reflection, we therefore deduct the
+         * relations on compilation time and inject in the module
+         *
+         * The parent is define by a ModelParent type on the model
+         * The links are attribute of types ModelLink
+         */
+        graph: ModelsGraph;
+        /**
+         * Specific plurals for a model
+         */
+        plurals: {
+            [key: string]: string;
+        };
+        /**
+         * Contains the shortcut id for the models
+         */
+        shortIds: {
+            [key: string]: string;
+        };
+        /**
+         * Store the model attributes types
+         */
+        reflections: {
+            [key: string]: {
+                [key: string]: string;
             };
-            maps?: any[];
         };
     };
     /**
@@ -187,12 +245,6 @@ export type UnpackedConfiguration = {
          * Define the api url
          */
         apiUrl?: string;
-        /**
-         * Define the model to use for Context
-         *
-         * @default Context
-         */
-        contextModel?: string;
         /**
          * Will not try to parse request bigger than this
          *
@@ -310,7 +362,6 @@ export interface ServiceConstructor<T extends Service> {
 export declare enum SectionEnum {
     Moddas = "moddas",
     Deployers = "deployers",
-    Models = "models",
     Beans = "beans"
 }
 /**
@@ -429,7 +480,17 @@ export declare class Application {
      * Models type registry
      */
     protected models: {
-        [key: string]: any;
+        [key: string]: CoreModelDefinition;
+    };
+    /**
+     * Models graph
+     */
+    protected graph: ModelsGraph;
+    /**
+     * Models specific plurals
+     */
+    protected plurals: {
+        [key: string]: string;
     };
     /**
      * Class Logger
@@ -443,6 +504,12 @@ export declare class Application {
      * When the application got initiated
      */
     protected initTime: number;
+    /**
+     * Direct parent of a model
+     */
+    protected flatHierarchy: {
+        [key: string]: string;
+    };
     /**
      * Configuration file
      */
@@ -485,6 +552,21 @@ export declare class Application {
      * @returns
      */
     getSchema(type: string): JSONSchema7;
+    /**
+     * Check if a schema exists
+     * @param type
+     * @returns schema name if it exists
+     */
+    hasSchema(type: string): boolean;
+    /**
+     * Get model graph
+     */
+    getRelations(model: string | Constructor<CoreModel> | CoreModel): ModelGraph;
+    /**
+     * Get the all graph
+     * @returns
+     */
+    getGraph(): ModelsGraph;
     /**
      * Check if application has cached modules
      *
@@ -527,13 +609,32 @@ export declare class Application {
      * @param service
      */
     addService(name: string, service: Modda): this;
+    /**
+     * Register a new schema in the application
+     * @param name
+     * @param schema
+     */
+    registerSchema(name: string, schema: JSONSchema7): void;
+    /**
+     * Get plural of an Id
+     * @param name
+     * @returns
+     */
+    getModelPlural(name: string): string;
+    /**
+     *
+     * @param section
+     * @param name
+     * @param caseSensitive
+     */
+    hasWebdaObject(section: Section, name: string, caseSensitive?: boolean): boolean;
     /**
      *
      * @param section
      * @param name
      * @returns
      */
-    getWebdaObject(section: Section, name: string): any;
+    getWebdaObject(section: Section, name: string, caseSensitive?: boolean): any;
     /**
      * Get a service based on name
      *
@@ -557,13 +658,24 @@ export declare class Application {
      *
      * @param name model to retrieve
      */
-    getModel<T extends CoreModelDefinition | Constructor<any> = CoreModelDefinition>(name: string): T;
+    getModel<T extends CoreModel = CoreModel>(name: string): CoreModelDefinition<T>;
     /**
      * Get all models definitions
      */
     getModels(): {
-        [key: string]: Constructor<Context> | CoreModelDefinition;
+        [key: string]: CoreModelDefinition;
     };
+    /**
+     * Return models that do not have parents
+     * @returns
+     */
+    getRootModels(): string[];
+    /**
+     * Return models that do not have parents and are exposed
+     * Or specifically set as root via the Expose.root parameter
+     * @returns
+     */
+    getRootExposedModels(): string[];
     /**
      * Return the model name for a object
      * @param object
@@ -574,6 +686,27 @@ export declare class Application {
      * @param object
      */
     getModelFromConstructor(model: Constructor<CoreModel>): string | undefined;
+    /**
+     * Get the model name from a model or a constructor
+     *
+     * @param model
+     * @returns longId for a model
+     */
+    getModelName(model: CoreModel | Constructor<CoreModel>): string | undefined;
+    /**
+     * Get the model hierarchy
+     * @param model
+     */
+    getModelHierarchy(model: CoreModel | Constructor<CoreModel> | string): {
+        ancestors: string[];
+        children: ModelsTree;
+    };
+    /**
+     * Get all model types with the hierarchy
+     * @param model
+     * @returns
+     */
+    getModelTypes(model: CoreModel): string[];
     /**
      * Return all deployers
      */
@@ -586,7 +719,7 @@ export declare class Application {
      * @param name
      * @param model
      */
-    addModel(name: string, model: any): this;
+    addModel(name: string, model: any, dynamic?: boolean): this;
     /**
      * Add a new deployer
      *
@@ -708,10 +841,14 @@ export declare class Application {
      */
     completeNamespace(name?: string): string;
     /**
-     * Check if object extends a class
-     *
-     * @param obj
-     * @param className
+     * Return current namespace
+     * @returns
+     */
+    getNamespace(): string;
+    /**
+     * Get short id for a name
+     * @param name if name is shortId return longId else return shortId
+     * @returns
      */
-    extends(obj: any, className: any): boolean;
+    getShortId(name: string): string;
 }