Merge pull request #157 from hemedani/main

create projection fn
MiaadTeam · Apr 30, 2024 · cd79da1 · cd79da1
2 parents 8b6bf90 + f24ed64
commit cd79da1
Show file tree

Hide file tree

Showing 140 changed files with 320 additions and 170 deletions.
diff --git a/docs/404.html b/docs/404.html
diff --git a/docs/CSR_SSR_or_SSG_content.html b/docs/CSR_SSR_or_SSG_content.html
diff --git a/docs/Dynamic_structure.html b/docs/Dynamic_structure.html
diff --git a/docs/Lesan's_Solution_For_How_To_Communicate_Between_The_Server_And_The_Client.html b/docs/Lesan's_Solution_For_How_To_Communicate_Between_The_Server_And_The_Client.html
diff --git a/docs/Lesan_solution.html b/docs/Lesan_solution.html
diff --git a/docs/Microservice.html b/docs/Microservice.html
diff --git a/docs/Penetration_Into_Depths.html b/docs/Penetration_Into_Depths.html
diff --git a/docs/Previous_methods_and_the_main_challenge.html b/docs/Previous_methods_and_the_main_challenge.html
diff --git a/docs/Pure_Structure_In_Schema.html b/docs/Pure_Structure_In_Schema.html
diff --git a/docs/Queuing_data_changes.html b/docs/Queuing_data_changes.html
diff --git a/docs/Receiving_Data.html b/docs/Receiving_Data.html
diff --git a/docs/Request_processing.html b/docs/Request_processing.html
diff --git a/docs/Schemas.html b/docs/Schemas.html
diff --git a/docs/Static_structure.html b/docs/Static_structure.html
diff --git a/docs/The_InRelation_Structure_In_Schema.html b/docs/The_InRelation_Structure_In_Schema.html
diff --git a/docs/The_structure_of_OutRelation_in_the_schema.html b/docs/The_structure_of_OutRelation_in_the_schema.html
diff --git a/docs/The_structure_of_Struct_in_the_schema.html b/docs/The_structure_of_Struct_in_the_schema.html
diff --git a/docs/The_structure_of_embed_in_the_schema.html b/docs/The_structure_of_embed_in_the_schema.html
diff --git a/docs/Why_NoSQL.html b/docs/Why_NoSQL.html
diff --git a/docs/add_more_relation.html b/docs/add_more_relation.html
diff --git a/docs/add_relation.html b/docs/add_relation.html
diff --git a/docs/add_relation_fn.html b/docs/add_relation_fn.html
diff --git a/docs/advanced_general_description.html b/docs/advanced_general_description.html
diff --git a/docs/advanced_nx_config.html b/docs/advanced_nx_config.html
diff --git a/docs/aggregation_fn.html b/docs/aggregation_fn.html
diff --git a/docs/all_advantages_of_lesan.html b/docs/all_advantages_of_lesan.html
diff --git a/docs/an_advanced_project.html b/docs/an_advanced_project.html
diff --git a/docs/api/acts/acts_fn.html b/docs/api/acts/acts_fn.html
diff --git a/docs/api/acts/getAct/getAct_Fns.html b/docs/api/acts/getAct/getAct_Fns.html
diff --git a/docs/api/acts/getActKeys/getActKeys_Fns.html b/docs/api/acts/getActKeys/getActKeys_Fns.html
diff --git a/docs/api/acts/getActs/getActs_Fns.html b/docs/api/acts/getActs/getActs_Fns.html
diff --git a/docs/api/acts/getActsKeys/getActsKeys_Fns.html b/docs/api/acts/getActsKeys/getActsKeys_Fns.html
diff --git a/docs/api/acts/getAtcsWithServices/getAtcsWithServices_Fns.html b/docs/api/acts/getAtcsWithServices/getAtcsWithServices_Fns.html
diff --git a/docs/api/acts/getMainAct/getMainAct_Fns.html b/docs/api/acts/getMainAct/getMainAct_Fns.html
diff --git a/docs/api/acts/getMainActs/getMainActs_Fns.html b/docs/api/acts/getMainActs/getMainActs_Fns.html
diff --git a/docs/api/acts/getService/getService_Fns.html b/docs/api/acts/getService/getService_Fns.html
diff --git a/docs/api/acts/getServiceKeys/getServiceKeys_Fns.html b/docs/api/acts/getServiceKeys/getServiceKeys_Fns.html
diff --git a/docs/api/acts/setAct/setAct_Fns.html b/docs/api/acts/setAct/setAct_Fns.html
diff --git a/docs/api/acts/setService/setService_Fns.html b/docs/api/acts/setService/setService_Fns.html
diff --git a/docs/api/context/contextFns_fn.html b/docs/api/context/contextFns_fn.html
diff --git a/docs/api/context/getContextModel/addBodyToContext_Fns.html b/docs/api/context/getContextModel/addBodyToContext_Fns.html
diff --git a/docs/api/context/getContextModel/addContext_Fns.html b/docs/api/context/getContextModel/addContext_Fns.html
diff --git a/docs/api/context/getContextModel/addContexts_Fns.html b/docs/api/context/getContextModel/addContexts_Fns.html
diff --git a/docs/api/context/getContextModel/addHeaderToContext_Fns.html b/docs/api/context/getContextModel/addHeaderToContext_Fns.html
diff --git a/docs/api/context/getContextModel/addReqToContext_Fns.html b/docs/api/context/getContextModel/addReqToContext_Fns.html
diff --git a/docs/api/context/getContextModel/getContextModel_Fns.html b/docs/api/context/getContextModel/getContextModel_Fns.html
diff --git a/docs/api/context/setContext/setContext_Fns.html b/docs/api/context/setContext/setContext_Fns.html
diff --git a/docs/api/generateSchema/generateSchemTypes_fn.html b/docs/api/generateSchema/generateSchemTypes_fn.html
diff --git a/docs/api/lesan_fn.html b/docs/api/lesan_fn.html
diff --git a/docs/api/odm/getCollection/getCollection_Fns.html b/docs/api/odm/getCollection/getCollection_Fns.html
diff --git a/docs/api/odm/newModel/addRelation_Fns.html b/docs/api/odm/newModel/addRelation_Fns.html
diff --git a/docs/api/odm/newModel/aggregation_Fns.html b/docs/api/odm/newModel/aggregation_Fns.html
diff --git a/docs/api/odm/newModel/deleteOne_Fns.html b/docs/api/odm/newModel/deleteOne_Fns.html
diff --git a/docs/api/odm/newModel/findOneAndUpdate_Fns.html b/docs/api/odm/newModel/findOneAndUpdate_Fns.html
diff --git a/docs/api/odm/newModel/findOne_Fns.html b/docs/api/odm/newModel/findOne_Fns.html
diff --git a/docs/api/odm/newModel/find_Fns.html b/docs/api/odm/newModel/find_Fns.html
diff --git a/docs/api/odm/newModel/insertMany_Fns.html b/docs/api/odm/newModel/insertMany_Fns.html
diff --git a/docs/api/odm/newModel/insertOne_Fns.html b/docs/api/odm/newModel/insertOne_Fns.html
diff --git a/docs/api/odm/newModel/newModel_Fns.html b/docs/api/odm/newModel/newModel_Fns.html
diff --git a/docs/api/odm/newModel/removeRelation_Fns.html b/docs/api/odm/newModel/removeRelation_Fns.html
diff --git a/docs/api/odm/odm_fn.html b/docs/api/odm/odm_fn.html
diff --git a/docs/api/odm/setDb/setDb_Fns.html b/docs/api/odm/setDb/setDb_Fns.html
diff --git a/docs/api/runServer/runServer_fn.html b/docs/api/runServer/runServer_fn.html
diff --git a/docs/api/schemas/mainRelationsFns/getMainRelations_fn.html b/docs/api/schemas/mainRelationsFns/getMainRelations_fn.html
diff --git a/docs/api/schemas/mainRelationsFns/mainRelations_Fns.html b/docs/api/schemas/mainRelationsFns/mainRelations_Fns.html
diff --git a/docs/api/schemas/pureFns/addPureModel_Fns.html b/docs/api/schemas/pureFns/addPureModel_Fns.html
diff --git a/docs/api/schemas/pureFns/getPureModelByNameAndKey_Fns.html b/docs/api/schemas/pureFns/getPureModelByNameAndKey_Fns.html
diff --git a/docs/api/schemas/pureFns/getPureModel_Fns.html b/docs/api/schemas/pureFns/getPureModel_Fns.html
diff --git a/docs/api/schemas/pureFns/pure_Fns.html b/docs/api/schemas/pureFns/pure_Fns.html
diff --git a/docs/api/schemas/relatedRelationFns/getRelatedRelations_fn.html b/docs/api/schemas/relatedRelationFns/getRelatedRelations_fn.html
diff --git a/docs/api/schemas/relatedRelationFns/relatedRelation_Fns.html b/docs/api/schemas/relatedRelationFns/relatedRelation_Fns.html
diff --git a/docs/api/schemas/relationFns/getRelation_Fns.html b/docs/api/schemas/relationFns/getRelation_Fns.html
diff --git a/docs/api/schemas/relationFns/relation_Fns.html b/docs/api/schemas/relationFns/relation_Fns.html
diff --git a/docs/api/schemas/schemaFns/createEmbedded_fn.html b/docs/api/schemas/schemaFns/createEmbedded_fn.html
diff --git a/docs/api/schemas/schemaFns/createStruct_fn.html b/docs/api/schemas/schemaFns/createStruct_fn.html
diff --git a/docs/api/schemas/schemaFns/getPureFromMainRelations_fn.html b/docs/api/schemas/schemaFns/getPureFromMainRelations_fn.html
diff --git a/docs/api/schemas/schemaFns/getPureFromRelatedRelations_fn.html b/docs/api/schemas/schemaFns/getPureFromRelatedRelations_fn.html
diff --git a/docs/api/schemas/schemaFns/getPureOfMainRelations_fn.html b/docs/api/schemas/schemaFns/getPureOfMainRelations_fn.html
diff --git a/docs/api/schemas/schemaFns/getPureSchema_fn.html b/docs/api/schemas/schemaFns/getPureSchema_fn.html
diff --git a/docs/api/schemas/schemaFns/getSchema_fn.html b/docs/api/schemas/schemaFns/getSchema_fn.html
diff --git a/docs/api/schemas/schemaFns/getSchemasKeys_fn.html b/docs/api/schemas/schemaFns/getSchemasKeys_fn.html
diff --git a/docs/api/schemas/schemaFns/getSchemas_fn.html b/docs/api/schemas/schemaFns/getSchemas_fn.html
diff --git a/docs/api/schemas/schemaFns/schemaFns_fn.html b/docs/api/schemas/schemaFns/schemaFns_fn.html
diff --git a/docs/api/schemas/schemas_fn.html b/docs/api/schemas/schemas_fn.html
diff --git a/docs/api/schemas/selectStructFns/checkRelation_Fn.html b/docs/api/schemas/selectStructFns/checkRelation_Fn.html
diff --git a/docs/api/schemas/selectStructFns/decreaseIterate_Fn.html b/docs/api/schemas/selectStructFns/decreaseIterate_Fn.html
diff --git a/docs/api/schemas/selectStructFns/fieldType_Fn.html b/docs/api/schemas/selectStructFns/fieldType_Fn.html
diff --git a/docs/api/schemas/selectStructFns/selectStructFns_Fns.html b/docs/api/schemas/selectStructFns/selectStructFns_Fns.html
diff --git a/docs/api/schemas/selectStructFns/selectStruct_Fn.html b/docs/api/schemas/selectStructFns/selectStruct_Fn.html
diff --git a/docs/api/types/Services/ActInp.html b/docs/api/types/Services/ActInp.html
diff --git a/docs/api/types/Services/Acts.html b/docs/api/types/Services/Acts.html
diff --git a/docs/api/types/Services/Acts/Act.html b/docs/api/types/Services/Acts/Act.html
diff --git a/docs/api/types/Services/Acts/Act/ActFn.html b/docs/api/types/Services/Acts/Act/ActFn.html
diff --git a/docs/api/types/Services/Acts/Act/ActFn/TLesanBody.html b/docs/api/types/Services/Acts/Act/ActFn/TLesanBody.html
diff --git a/docs/api/types/Services/Acts/Act/ActFn/TLesanBody/Details.html b/docs/api/types/Services/Acts/Act/ActFn/TLesanBody/Details.html
diff --git a/docs/api/types/Services/Services.html b/docs/api/types/Services/Services.html
diff --git a/docs/api/types/TInsertRelations.html b/docs/api/types/TInsertRelations.html
diff --git a/docs/api/types/TInsertRelations/IRelationsFileds.html b/docs/api/types/TInsertRelations/IRelationsFileds.html
diff --git a/docs/api/types/aggregation/projection/projection.html b/docs/api/types/aggregation/projection/projection.html
diff --git a/docs/api/types/context.html b/docs/api/types/context.html
diff --git a/docs/api/types/context/LesanContenxt.html b/docs/api/types/context/LesanContenxt.html
diff --git a/docs/api/types/odm.html b/docs/api/types/odm.html
diff --git a/docs/api/types/schema/CheckRelation.html b/docs/api/types/schema/CheckRelation.html
diff --git a/docs/api/types/schema/IModel.html b/docs/api/types/schema/IModel.html
diff --git a/docs/api/types/schema/IPureFields.html b/docs/api/types/schema/IPureFields.html
diff --git a/docs/api/types/schema/Iterate.html b/docs/api/types/schema/Iterate.html
diff --git a/docs/api/types/schema/RelationType.html b/docs/api/types/schema/RelationType.html
diff --git a/docs/api/types/schema/Tschemas.html b/docs/api/types/schema/Tschemas.html
diff --git a/docs/api/types/schema/model/IMainRelation.html b/docs/api/types/schema/model/IMainRelation.html
diff --git a/docs/api/types/schema/model/IRelatedRelation.html b/docs/api/types/schema/model/IRelatedRelation.html
diff --git a/docs/api/types/schema/model/TRelation.html b/docs/api/types/schema/model/TRelation.html
diff --git a/docs/api/types/schema/model/TRelation/RelationDataType.html b/docs/api/types/schema/model/TRelation/RelationDataType.html
diff --git a/docs/api/types/schema/model/TRelation/RelationSortOrderType.html b/docs/api/types/schema/model/TRelation/RelationSortOrderType.html
diff --git a/docs/api/types/schema/model/TRelation/TRelatedRelation.html b/docs/api/types/schema/model/TRelation/TRelatedRelation.html
diff --git a/docs/api/types/types.html b/docs/api/types/types.html
diff --git a/docs/delete_one_fn.html b/docs/delete_one_fn.html
diff --git a/docs/findOne_and_find_fn.html b/docs/findOne_and_find_fn.html
diff --git a/docs/find_one_and_update_functions.html b/docs/find_one_and_update_functions.html
diff --git a/docs/folder_structure.html b/docs/folder_structure.html
diff --git a/docs/getting_start.html → docs/getting_started.html b/docs/getting_start.html → docs/getting_started.html
diff --git a/docs/index.html b/docs/index.html
diff --git a/docs/insert_many_fn.html b/docs/insert_many_fn.html
diff --git a/docs/installation.html b/docs/installation.html
diff --git a/docs/introduction.html b/docs/introduction.html
diff --git a/docs/leasan_vs_graphql.html b/docs/leasan_vs_graphql.html
diff --git a/docs/manage_replica.html b/docs/manage_replica.html
diff --git a/docs/mannage_relations.html b/docs/mannage_relations.html
diff --git a/docs/microservice-monolithic.html b/docs/microservice-monolithic.html
diff --git a/docs/playground.html b/docs/playground.html
diff --git a/docs/print.html b/docs/print.html
diff --git a/docs/remove_relation_fn.html b/docs/remove_relation_fn.html
diff --git a/docs/request_flow.html b/docs/request_flow.html
diff --git a/docs/runServer_(web_server_structure).html b/docs/runServer_(web_server_structure).html
diff --git a/docs/searchindex.js b/docs/searchindex.js
diff --git a/docs/searchindex.json b/docs/searchindex.json
diff --git a/docs/what_is_the_relationship.html b/docs/what_is_the_relationship.html
diff --git a/pages/src/SUMMARY.md b/pages/src/SUMMARY.md
@@ -5,7 +5,7 @@
 # User Guide
 
 - [Installation](./installation.md)
-- [Getting start](./getting_start.md)
+- [Getting started](./getting_started.md)
 - [Add relation](./add_relation.md)
 - [Add more relation](./add_more_relation.md)
 - [Mannage relations](./mannage_relations.md)

diff --git a/pages/src/getting_start.md → pages/src/getting_started.md b/pages/src/getting_start.md → pages/src/getting_started.md
@@ -1,4 +1,4 @@
-# Getting start
+# Getting started
 
 I copy this simple example from [installation](./installation.md) page. We will keep this file as `mod.ts` and continue to add various models and functions to it.
 
@@ -199,7 +199,7 @@ const addCountry: ActFn = async (body) => {
 ```
 
 This function receives an input called `body`, the `body` of the `request` sent from the client side is passed to it when this function is called, as a result, we have access to the information sent by users.
-The request body sent from the client side should be a json like this:
+The request body sent from the client side should be a `JSON` like this:
 
 ```JSON
 {
@@ -222,12 +222,11 @@ The request body sent from the client side should be a json like this:
 }
 ```
 
-- The `service` key is used to select one of the microservices set on the application. You can read more about this here.
-- The `model` key is used to select one of the models added to the application.
-- The `act` key is used to select one of the acts added to the application.
-- The `act` key is used to select one of the acts added to the application.
+- The `service` key is used to select one of the `microservices` set on the application. You can read more about this here.
+- The `model` key is used to select one of the `Models` added to the application.
+- The `act` key is used to select one of the `Acts` added to the application.
 - The `details` key is used to receive data to be sent from the client side along with data to be delivered to users. This key has two internal keys called `get` and `set`, we talked a little about it before.
-  - `set`: It contains the information we need in the main function. For this reason, we can extract `name`, `population`, and `abb` from within `body.details.set`.
+  - `set`: It contains the information we need in the `Act` function. For this reason, we can extract `name`, `population`, and `abb` from within `body.details.set`.
   - `get`: Contains selected information that the user needs to be returned. Therefore, we can pass this object directly to Mongo `projection`.
 
 As you can see, we have used the `insertOne` function, which was exported from the `countries` model, to add a new document. This function accepts an object as input, which has the following keys:

diff --git a/pages/src/request_flow.md b/pages/src/request_flow.md
@@ -35,6 +35,58 @@ In order to access the `playground`, you must set the `playground` entry in the
 
 ### POST Requests:
 We accept two models of `POST` requests:
-- Requests sent to `upload` a document.
 - Requests sent to `receive data` from the `server` (in fact, these requests are the main requests sent to **Lesan**).
+- Requests sent to `upload` a document.
+
+#### Receive data
+To `receive data` from the **Lesan** server, you must send a `POST` request to the final address of **Lesan**.
+In the `body` of this request, must be an `object` in `JSON` format with the following keys:
+
+- The `service` key is used to select one of the `microservices` set on the application. This key is optional and by default the value of `main` is placed in it.
+- The `model` key is used to select one of the `Models` added to the application.
+- The `act` key is used to select one of the `Acts` added to the application.
+- The `details` key is used to receive data to be sent from the client side along with data to be delivered to users. This key has two internal keys called `get` and `set`, we talked a little about it before.
+  - `set`: It contains the information we need in the `Act` function. 
+  - `get`: Contains selected information that the user needs to be returned. This selection is based on `zero` or `one`. Therefore, we can pass this object directly to MongoDB `projection`.
+
+An example of this `JSON` object is as follows:
+```JSON
+{
+  "service": "main",
+  "model": "country",
+  "act": "addCountry",
+  "details": {
+    "set": {
+      "name": "Iran",
+      "population": 85000000,
+      "abb": "IR"
+    },
+    "get": {
+      "_id": 1,
+      "name": 1,
+      "population": 1,
+      "cities": {
+         "name": 1,
+         "population": 1,
+      }
+    }
+  }
+}
+```
+
+This request finally reaches the function we specified for `Act` to extract the necessary information from it and return the information requested by the user.  
+If you remember, we set up each `Act` as follows:
+```ts
+coreApp.acts.setAct({
+  schema: "user",
+  actName: "addUser",
+  validator: addUserValidator(),
+  fn: addUser,
+  preValidation: [setUser, checkLevel],
+  preAct: [justAdmin],
+  validationRunType: "create",
+});
+```
 
+#### Upload documents
+For uploading a document you should send a `POST` request to **Lesan** endpoint.
diff --git a/src/models/mod.ts b/src/models/mod.ts
@@ -1,3 +1,4 @@
+import { createProjection, TProjectionType } from "./createProjection.ts";
 import { mainRelationsFns } from "./mainRelations/mod.ts";
 import { pureFns } from "./pure/mod.ts";
 import { relatedRelationFns } from "./relatedRelations/mod.ts";
@@ -18,6 +19,8 @@ export const schemas = (schemas: TSchemas) => {
     ...pureFns(schemas),
     ...relationFns(schemas),
     ...selectStructFns(schemas),
+    createProjection: (schemaName: string, projectionType: TProjectionType) =>
+      createProjection(schemas, schemaName, projectionType),
   };
 };