106 lines
3.5 KiB
Markdown
106 lines
3.5 KiB
Markdown
# @signature.digital/tools
|
||
|
||
The main package for the signature.digital contract management system. 🚀
|
||
|
||
This is the **recommended entry point** – it re-exports all interfaces from `@signature.digital/interfaces` for convenient access.
|
||
|
||
## Install
|
||
|
||
```bash
|
||
pnpm add @signature.digital/tools
|
||
```
|
||
|
||
## Usage
|
||
|
||
```typescript
|
||
import {
|
||
// Contract creation
|
||
createEmptyContract,
|
||
createRole,
|
||
createInvolvedParty,
|
||
createParagraph,
|
||
|
||
// Types
|
||
type IPortableContract,
|
||
type IRole,
|
||
type IInvolvedParty,
|
||
type IParagraph,
|
||
type TContractStatus,
|
||
|
||
// All other interfaces and types
|
||
} from '@signature.digital/tools';
|
||
```
|
||
|
||
## Why This Package?
|
||
|
||
This is the **umbrella package** that provides a single import for:
|
||
|
||
- All **interfaces** from `@signature.digital/interfaces`
|
||
- All **factory functions** for creating contract objects
|
||
- All **type aliases** for contract classification
|
||
|
||
If you only need the types/interfaces without runtime code, you can use `@signature.digital/interfaces` directly.
|
||
|
||
## Quick Start
|
||
|
||
```typescript
|
||
import {
|
||
createEmptyContract,
|
||
createRole,
|
||
createParagraph,
|
||
} from '@signature.digital/tools';
|
||
|
||
// Create a new contract
|
||
const contract = createEmptyContract(
|
||
'Service Agreement',
|
||
'service',
|
||
'service_professional',
|
||
'user-123'
|
||
);
|
||
|
||
// Add roles
|
||
contract.availableRoles.push(
|
||
createRole('provider', 'Service Provider', 'The party providing services'),
|
||
createRole('client', 'Client', 'The party receiving services')
|
||
);
|
||
|
||
// Add content
|
||
contract.paragraphs.push(
|
||
createParagraph('Scope of Services', 'Provider shall deliver...', 'clause', 1),
|
||
createParagraph('Payment Terms', 'Client shall pay...', 'clause', 2)
|
||
);
|
||
```
|
||
|
||
## Package Ecosystem
|
||
|
||
| Package | Purpose |
|
||
|---------|---------|
|
||
| `@signature.digital/tools` | Main entry point (this package) |
|
||
| `@signature.digital/interfaces` | Core TypeScript interfaces |
|
||
| `@signature.digital/demodata` | Demo contracts for testing |
|
||
|
||
## Dependencies
|
||
|
||
- `@signature.digital/interfaces` – Core interface definitions
|
||
|
||
## License and Legal Information
|
||
|
||
This repository contains open-source code licensed under the MIT License. A copy of the license can be found in the [LICENSE](../LICENSE) file.
|
||
|
||
**Please note:** The MIT License does not grant permission to use the trade names, trademarks, service marks, or product names of the project, except as required for reasonable and customary use in describing the origin of the work and reproducing the content of the NOTICE file.
|
||
|
||
### Trademarks
|
||
|
||
This project is owned and maintained by Task Venture Capital GmbH. The names and logos associated with Task Venture Capital GmbH and any related products or services are trademarks of Task Venture Capital GmbH or third parties, and are not included within the scope of the MIT license granted herein.
|
||
|
||
Use of these trademarks must comply with Task Venture Capital GmbH's Trademark Guidelines or the guidelines of the respective third-party owners, and any usage must be approved in writing. Third-party trademarks used herein are the property of their respective owners and used only in a descriptive manner, e.g. for an implementation of an API or similar.
|
||
|
||
### Company Information
|
||
|
||
Task Venture Capital GmbH
|
||
Registered at District Court Bremen HRB 35230 HB, Germany
|
||
|
||
For any legal inquiries or further information, please contact us via email at hello@task.vc.
|
||
|
||
By using this repository, you acknowledge that you have read this section, agree to comply with its terms, and understand that the licensing of the code does not imply endorsement by Task Venture Capital GmbH of any derivative works.
|