# @wizzi/factory

> The Wizzi Factory.

Latest version **0.8.46** (published 2025-01-21) · 0 weekly downloads

## Install

```sh
npm install @wizzi/factory
pnpm add @wizzi/factory
yarn add @wizzi/factory
bun add @wizzi/factory
```

## Health

**Score 30/100 (F)** — status: maintenance-mode.

Positive: has types; no vulnerabilities.

Warnings: low downloads; no esm support; pre 1.0.

Negative: stale; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.8.46 |
| Published | 2025-01-21 |
| First published | 2023-04-05 |
| Weekly downloads | 0 |
| TypeScript types | bundled |
| Module format | CommonJS |
| Node | >=0.10.28 |
| Dependencies | 10 |
| Unpacked size | 2.8 MB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Stefano Bassoli |
| Maintainers | stfn.bssl |

## Links

- npm: https://www.npmjs.com/package/@wizzi/factory
- Repository: https://github.com/stfnbssl/wizzi
- Homepage: https://github.com/stfnbssl/wizzi#readme
- Issues: https://github.com/stfnbssl/wizzi/issues
- npm.io page: https://npm.io/package/@wizzi/factory

## Dependencies (10)

- [async](https://npm.io/package/async.md) ^3.2.0
- [chalk](https://npm.io/package/chalk.md) ^4.1.0
- [lodash](https://npm.io/package/lodash.md) ^4.17.20
- [json-diff](https://npm.io/package/json-diff.md) latest
- [extsprintf](https://npm.io/package/extsprintf.md) ^1.2.0
- [iconv-lite](https://npm.io/package/iconv-lite.md) ^0.6.2
- [@wizzi/repo](https://npm.io/package/@wizzi/repo.md) 0.8.24
- [@wizzi/mtree](https://npm.io/package/@wizzi/mtree.md) 0.8.32
- [@wizzi/utils](https://npm.io/package/@wizzi/utils.md) 0.8.25
- [json-stringify-safe](https://npm.io/package/json-stringify-safe.md) ^5.0.1

## Recent versions

- 0.8.46 (latest) — 2025-01-21
- 0.8.45 — 2025-01-20
- 0.8.44 — 2025-01-02
- 0.8.43 — 2025-01-02
- 0.8.42 — 2024-08-31
- 0.8.41 — 2024-08-06
- 0.8.40 — 2024-07-30
- 0.8.39 — 2024-07-23
- 0.8.38 — 2024-07-03
- 0.8.37 — 2024-05-09
- 0.8.36 — 2024-05-06
- 0.8.35 — 2024-04-19
- 0.8.34 — 2024-04-18
- 0.8.33 — 2024-04-12
- 0.8.32 — 2024-04-06
- … 31 more at https://npm.io/package/@wizzi/factory/versions

## README

# @wizzi/factory

The Wizzi Factory.



## Work still in progress

Availability of features will be announced
on [Twitter](https://twitter.com/wizziteam) and [Facebook](https://www.facebook.com/wizzifactory)

## Features
Exposes the main wizzi factory service components:
* WizziFactory class 
* PluginsManager class 
* RunnerServer class 
## The WizziFactory class
Is the main access point to wizzi factory services. Can beused to
* Execute [wizzi model types generations](#).
* Execute artifact generations 
* Execute [wizzi jobs](#).
### Instance creation
```javascript
wizzi.createFactory(
userid,
role,
options,
callback
);
```
### Methods
```javascript
wizziFactoryInstance.generateModelDoms(
);
wizziFactoryInstance.generateMTree(
);
wizziFactoryInstance.generateWizziModel(
);
wizziFactoryInstance.generateArtifact(
);
wizziFactoryInstance.executeWizziJob(
);
```
## The PluginsManager class
### The RunnerServer class
## Default factory (quick starter)
### Loads a wizzi magical tree (mTree)
```javascript
var wizzi = require('wizzi');
var ittfSourcePath = '...';
var context = {
...
};
var options = {
...
};
wizzi.mtree(
    ittfSourcePath,
    context,
    options,
    function(err, mTree) {
    ...
    });
```
### Loads a wizzi model
```javascript
var wizzi = require('wizzi');
var ittfSourcePath = '...';
var context = {
...
};
var options = {
...
};
wizzi.model(
    ittfSourcePath,
    context,
    options,
    function(err, wizziModel) {
    ...
    });
```
### Generates an artifact
```javascript
var wizzi = require('wizzi');
var ittfSourcePath = '...';
var artifactName = '...';
var modelContext = {
...
};
var artifactContext = {
...
};
var options = {
...
};
wizzi.model(
    ittfSourcePath,
    artifactName,
    context,
    options,
    function(err, artifactText) {
    ...
    });
```


## Wizzi

One machinery, many productions.


[Project page](https://stfnbssl.github.io/wizzi)
## Built With
* [Nodejs](https://nodejs.org)
* [Wizzi](https://github.com/stfnbssl/wizzi)

## License
This project is licensed under the MIT License - see the [license.txt](license.txt) for details.

---
_Source: https://npm.io/package/@wizzi/factory · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._