New architecture for libraries 📖

[onmax]

Motivation

From Alastria we want to facilitate the use of the libraries to the partners and for this we have to facilitate both the architecture of the project and offer the possibility to download the library from a package manager such as npm and yarn. This issue aims to suggest a possible solution by creating a new architecture that simplifies the current architecture of the project and that follows the library patterns of npm and yarn.

Objective

The intention is to have a single repository that contains all the libraries. Three libraries will be published (npm / yarn) with the following names:

• alastria-id-tokens-factory
• alastria-id-tx-factory
• alastria-id-tx-signer

Implications

If this change is made, it will have several consequences:

1. Simplification of the library and therefore, greater maintainability and readability. It will divide the library into three; dividing each library into: types, src and tests.
2. It will offer the possibility for developers to use ST types and interfaces. This will help in the future if we decide to create a library called '@types/alastria' with the types and interfaces of everything as many of the popular libraries do: '@types/moment' or '@types/angular' as an example. This suggestion, is discarded for the moment, but it would be interesting to study it in the future, once we have the libraries ready.
3. This change will break everything and we will have to warn the library users if they don't want to update their current implementation. Also, users will not need to git clone to make use of the library and npm install or yarn install will be used. The example repository will also need to be changed.

Architecture

│   ├── tx-signer
│   │   ├── src
│   │   │    │── ....
│   │   │    └──
│   │   ├── test
│   │   │    │── ....
│   │   │    └──
│   │   ├── types
│   │   │    │── ....
│   │   │    └──
│   │   ├── dist
│   │   │    │── ....
│   │   │    └──
│   │   ├── LICENSE
│   │   ├── package.json
│   │   ├── package-lock.json
│   │   ├── README.md
│   │   └── tsconfig.json
│   ├── tokens-factory
│   │   ├── src
│   │   │    │── ....
│   │   │    └──
│   │   ├── test
│   │   │    │── ....
│   │   │    └──
│   │   ├── types
│   │   │    │── ....
│   │   │    └──
│   │   ├── dist
│   │   │    │── ....
│   │   │    └──
│   │   ├── LICENSE
│   │   ├── package.json
│   │   ├── package-lock.json
│   │   ├── README.md
│   │   └── tsconfig.json
│   └── tx-factory
│   │   ├── src
│   │   │    │── ....
│   │   │    └──
│   │   ├── test
│   │   │    │── ....
│   │   │    └──
│   │   ├── types
│   │   │    │── ....
│   │   │    └──
│   │   ├── dist
│   │   │    │── ....
│   │   │    └──
│   │   ├── LICENSE
│   │   ├── package.json
│   │   ├── package-lock.json
│   │   ├── README.md
│   │   └── tsconfig.json
└── README.md

Explanation:

• .github and .gitignore: It will be a single configuration for the whole project. The /dist folders will not be uploaded to Github.
• libs: Folder with three subfolders. Each subfolder will be one of the libraries (tokens-factory, tx-factory and id-tx-signer (old UserIdentity)). The content of these folders will be the one that will be published in three different libraries in npm and yarn. They will always have the same files and the same folders in the first level:
  • LICENSE: Library license
  • package.json: Scripts and library information.
  • package-lock.json: Dependencies
  • tsconfig.json: TS Transponder Configuration
  • dist: they will only be in npm and yarn because it is the build that the user will work with. This folder will be automatically created from the configuration in tsconfig.json. This folder will NOT be in GitHub.
  • src: Implementing the Library
  • test
  • types: Types and interfaces

🐱

[msalitu]

¡Por mi parte adelante! Excelente trabajo @onmax y @VictorNS69

[DrankoLQ]

Tiene muy buena pinta chicos, ¡muy buen trabajo! 🙂

[JuanLuisGozaloFdez]

por mi parte adelante.
Please, remind that...
All the information must be written in English to allow wider disemination of the Alastria Open Source Code repositories.

[DrankoLQ]

That's right Juan Luis.

By the way, as far as I know, there's no need to create a @types/alastria module to support TypeScript, we just need to add a index.d.ts file in each library to have types

[onmax]

Please, remind that...
All the information must be written in English to allow wider disemination of the Alastria Open Source Code repositories.

Done!