tods-competition-factory 2.3.7 → 2.3.8
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 +4 -5
- package/dist/index.mjs +2 -2
- package/dist/tods-competition-factory.d.ts +4 -3
- package/dist/tods-competition-factory.development.cjs.js +3 -3
- 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 +3 -3
package/README.md
CHANGED
|
@@ -11,17 +11,16 @@
|
|
|
11
11
|
|
|
12
12
|
## Competittion Business Rules
|
|
13
13
|
|
|
14
|
-
The **Competition Factory** is a collection of functions for transforming/mutating tournament records and is intended to ensure the integrity of
|
|
14
|
+
The **Competition Factory** is a collection of functions for transforming/mutating tournament records and is intended to ensure the integrity of Competitions by managing all state transformations. Factory functions embody the "business rules" required by Competition Management Solutions, and enable an entirely new way of constructing software to manage tournaments.
|
|
15
15
|
|
|
16
16
|
The rules governing the creation of draws, seeding, and participant movement can be present on a standalone client, on a server, or both.
|
|
17
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
18
|
|
|
19
19
|
Server deployments support highly scaleable asynchronous processing models in **Node.js**.
|
|
20
20
|
|
|
21
|
-
## Data Standards
|
|
21
|
+
## Data => Standards
|
|
22
22
|
|
|
23
|
-
The Competition Factory
|
|
24
|
-
which provide a document-based representation of all of the elements of a tournament or a league including participants, events, draws, matchUps, contacts, and references to online resources. Although the data standard is emerging in the sport of Tennis, **_the data structures apply to tournaments in many sports_**.
|
|
23
|
+
The Competition Factory generates and processes / mutates JSON objects, and was built during the development of the **[Tennis Open Data Standards](https://itftennis.atlassian.net/wiki/spaces/TODS/overview)**, **(TODS)**, a document-based representation of all of the elements of a tournament or a league including participants, events, draws, matchUps, contacts, and references to online resources. Although the data standard began to emerge in the sport of Tennis, **_the data structures apply to competitions in many sports_**, and the factory continues to evolve to support competition more broadly.
|
|
25
24
|
|
|
26
25
|
## Time Capsule
|
|
27
26
|
|
|
@@ -33,7 +32,7 @@ The **Competition Factory** includes synchronous and asynchronous "state engines
|
|
|
33
32
|
|
|
34
33
|
## Mocks Engine
|
|
35
34
|
|
|
36
|
-
The `mocksEngine` generates complete tournament objects, or tournamentRecords, as well as mock persons, participants and matchUp outcomes. It is used extensively in the
|
|
35
|
+
The `mocksEngine` generates complete tournament objects, or tournamentRecords, as well as mock persons, participants and matchUp outcomes. It is used extensively in the 2600+ tests that are run against the factory methods before every package release.
|
|
37
36
|
|
|
38
37
|
## Installation
|
|
39
38
|
|