tods-competition-factory 2.0.0-beta.0 → 2.0.0-beta.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +17 -14
- package/dist/index.mjs +1 -1
- package/dist/index.mjs.map +1 -1
- package/dist/tods-competition-factory.d.ts +223 -424
- package/dist/tods-competition-factory.development.cjs.js +706 -761
- package/dist/tods-competition-factory.development.cjs.js.map +1 -1
- package/dist/tods-competition-factory.production.cjs.min.js +1 -1
- package/dist/tods-competition-factory.production.cjs.min.js.map +1 -1
- package/package.json +6 -12
package/README.md
CHANGED
|
@@ -1,15 +1,21 @@
|
|
|
1
|
-
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
1
|
+
<p align="center">
|
|
2
|
+
<a href="http://courthive.com/" target="blank"><img src="./src/fixtures/images/red-ch-logo.png" width="220" alt="CourtHive Logo" /></a>
|
|
3
|
+
</p>
|
|
4
|
+
<p align="center">Competition Business Rules and Policy Management.</p>
|
|
5
|
+
<p align="center"><a href='https://courthive.github.io/tods-competition-factory/'>Onilne Documentation and Examples.</a></p>
|
|
6
|
+
<p align="center">
|
|
7
|
+
<a href="https://www.npmjs.com/~tods-competition-factory" target="_blank"><img src="https://img.shields.io/npm/v/tods-competition-factory" alt="NPM Version" /></a>
|
|
8
|
+
<a href="https://www.npmjs.com/~tods-competition-factory" target="_blank"><img src="https://img.shields.io/npm/l/tods-competition-factory" alt="Package License" /></a>
|
|
9
|
+
<a href="https://www.npmjs.com/~tods-competition-factory" target="_blank"><img src="https://img.shields.io/npm/dm/tods-competition-factory" alt="NPM Downloads" /></a>
|
|
10
|
+
</p>
|
|
11
|
+
|
|
12
|
+
## Competittion Business Rules
|
|
8
13
|
|
|
9
14
|
The **Competition Factory** is a collection of functions for transforming/mutating tournament records and is intended to ensure the integrity of Tournaments by managing all state transformations. Factory functions embody the "business rules" required by Tournament Management Solutions, and enable an entirely new way of constructing software to manage tournaments.
|
|
10
15
|
|
|
11
16
|
The rules governing the creation of draws, seeding, and participant movement can be present on a standalone client, on a server, or both.
|
|
12
17
|
An entire tournament management solution [can run in a browser](https://courthive.github.io/TMX/), or a client can communicate with a server which utilizes a database, or simply the file system.
|
|
18
|
+
|
|
13
19
|
Server deployments support highly scaleable asynchronous processing models in **Node.js**.
|
|
14
20
|
|
|
15
21
|
## Data Standards
|
|
@@ -25,15 +31,12 @@ After a tournament has been completed, a **TODS** file can be considered a "time
|
|
|
25
31
|
|
|
26
32
|
The **Competition Factory** includes synchronous and asynchronous "state engines" which provide services for managing the state of a tournament record as well as subscriptions, notifications and logging.
|
|
27
33
|
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
## Other Utilities
|
|
34
|
+
## Mocks Engine
|
|
31
35
|
|
|
32
|
-
|
|
33
|
-
It is used extensively in the ~1900 tests that are run against the factory methods before every package release.
|
|
36
|
+
The `mocksEngine` generates complete tournament objects, or tournamentRecords, as well as mock persons, participants and matchUp outcomes. It is used extensively in the ~1900 tests that are run against the factory methods before every package release.
|
|
34
37
|
|
|
35
38
|
## Installation
|
|
36
39
|
|
|
37
|
-
```
|
|
38
|
-
|
|
40
|
+
```bash
|
|
41
|
+
$ pnpm i tods-competition-factory
|
|
39
42
|
```
|