1.1.0

changelog.md

@@ -0,0 +1,55 @@
+# Changelog
+
+## 2024-12-19 - 1.1.0 - feat(demodata)
+Add demo data feature for contracts
+
+- Introduced demo contract data for Minijob Employment Contract outlining details for employer and employee roles.
+- Enhanced package.json with new export entry for demodata.
+- Implemented new ts_demodata directory with sample contract representation.
+
+## 2024-12-19 - 1.0.11 - fix(interfaces)
+Fixed import path in ts_interfaces/index.ts
+
+- Corrected import path for plugins in ts_interfaces/index.ts to prevent module resolution issues.
+
+## 2024-12-18 - 1.0.10 - fix(test)
+Add initial test for portablecontract
+
+
+## 2024-12-18 - 1.0.9 - fix(ts_interfaces)
+Resolved missing exports in plugins.ts
+
+- Added export statements in ts_interfaces/plugins.ts to resolve module issues.
+
+## 2024-12-18 - 1.0.8 - fix(core)
+Fixed export paths in package configuration
+
+- Updated exports paths in package.json for proper module resolution.
+- Fixed export statement in ts/index.ts to reference the correct path for interface exports.
+
+## 2024-12-18 - 1.0.7 - fix(project)
+Corrected misalignment in file structure and package metadata.
+
+- Updated the file export path in ts/index.ts to correct interface export location.
+- Transferred the interfaces from ts/interfaces/index.ts to ts_interfaces/index.ts maintaining consistency in folder structure.
+- Synchronized package description and keywords between package.json and npmextra.json.
+- Ensured proper build script path in package.json.
+
+## 2024-12-18 - 1.0.6 - fix(core)
+No code changes detected.
+
+
+## 2024-12-18 - 1.0.5 - fix(core)
+Corrected package and npm extra configuration to ensure consistent naming.
+
+- Updated 'name' field in package.json from '@signature.digital/portablecontract' to '@signature.digital/tools'.
+- Updated 'gitrepo' in npmextra.json from 'portablecontract' to 'tools'.
+- Updated 'npmPackagename' in npmextra.json from '@signature.digital/portablecontract' to '@signature.digital/tools'.
+
+## 2023-11-22 to 2023-11-28 - 1.0.1 to 1.0.4 - core updates
+Fixes and updates in the core component.
+
+- Updated core module to enhance performance and fix minor bugs in version 1.0.1
+- Subsequent updates to core module for improved stability in version 1.0.2
+- Applied additional fixes and improvements in version 1.0.3
+- Finalized core updates in version 1.0.4

npmextra.json

@@ -4,15 +4,36 @@
     "module": {
       "githost": "gitlab.com",
       "gitscope": "signature.digital",
-      "gitrepo": "portablecontract",
+      "gitrepo": "tools",
-      "description": "a package that defines standard tools for working with contracts.",
+      "description": "A TypeScript package providing utilities for managing digital contracts with modular interfaces and business context integration.",
-      "npmPackagename": "@signature.digital/portablecontract",
+      "npmPackagename": "@signature.digital/tools",
       "license": "MIT",
-      "projectDomain": "signature.digital"
+      "projectDomain": "signature.digital",
+      "keywords": [
+        "TypeScript",
+        "digital contracts",
+        "contract management",
+        "modular design",
+        "business integration",
+        "interfaces",
+        "typescript utilities",
+        "contract structures",
+        "interfaces-driven architecture",
+        "contract modeling",
+        "business relationships",
+        "data handling",
+        "asynchronous loading",
+        "dynamic role assignment",
+        "contract validation",
+        "unit testing"
+      ]
     }
   },
   "npmci": {
     "npmGlobalTools": [],
     "npmAccessLevel": "public"
+  },
+  "tsdoc": {
+    "legal": "\n## License and Legal Information\n\nThis repository contains open-source code that is licensed under the MIT License. A copy of the MIT License can be found in the [license](license) file within this repository. \n\n**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.\n\n### Trademarks\n\nThis 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 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, and any usage must be approved in writing by Task Venture Capital GmbH.\n\n### Company Information\n\nTask Venture Capital GmbH  \nRegistered at District court Bremen HRB 35230 HB, Germany\n\nFor any legal inquiries or if you require further information, please contact us via email at hello@task.vc.\n\nBy 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.\n"
   }
 }

package.json

@@ -1,28 +1,31 @@
 {
-  "name": "@signature.digital/portablecontract",
+  "name": "@signature.digital/tools",
-  "version": "1.0.3",
+  "version": "1.1.0",
   "private": false,
-  "description": "a package that defines standard tools for working with contracts.",
+  "description": "A TypeScript package providing utilities for managing digital contracts with modular interfaces and business context integration.",
-  "main": "dist_ts/index.js",
+  "exports": {
-  "typings": "dist_ts/index.d.ts",
+    ".": "./ts/index.js",
+    "./interfaces": "./dist_ts_interfaces/index.js",
+    "./demodata": "./dist_ts_demodata/index.js"
+  },
   "type": "module",
   "author": "Task Venture Capital GmbH",
   "license": "MIT",
   "scripts": {
     "test": "(tstest test/ --web)",
-    "build": "(tsbuild --web --allowimplicitany)",
+    "build": "(tsbuild tsfolders --web --allowimplicitany)",
     "buildDocs": "(tsdoc)"
   },
   "devDependencies": {
-    "@git.zone/tsbuild": "^2.1.25",
+    "@git.zone/tsbuild": "^2.2.0",
-    "@git.zone/tsbundle": "^2.0.5",
+    "@git.zone/tsbundle": "^2.1.0",
-    "@git.zone/tsrun": "^1.2.46",
+    "@git.zone/tsrun": "^1.3.3",
-    "@git.zone/tstest": "^1.0.44",
+    "@git.zone/tstest": "^1.0.90",
-    "@push.rocks/tapbundle": "^5.0.15",
+    "@push.rocks/tapbundle": "^5.5.3",
-    "@types/node": "^20.8.7"
+    "@types/node": "^22.10.2"
   },
   "dependencies": {
-    "@tsclass/tsclass": "^4.0.46"
+    "@tsclass/tsclass": "^4.2.0"
   },
   "repository": {
     "type": "git",
@@ -46,5 +49,23 @@
     "cli.js",
     "npmextra.json",
     "readme.md"
+  ],
+  "keywords": [
+    "TypeScript",
+    "digital contracts",
+    "contract management",
+    "modular design",
+    "business integration",
+    "interfaces",
+    "typescript utilities",
+    "contract structures",
+    "interfaces-driven architecture",
+    "contract modeling",
+    "business relationships",
+    "data handling",
+    "asynchronous loading",
+    "dynamic role assignment",
+    "contract validation",
+    "unit testing"
   ]
 }

readme.md

@@ -1,31 +1,315 @@
-# @signature.digital/portablecontract
+# @signature.digital/tools
-a package that defines standard tools for working with contracts.
+A TypeScript package offering utility interfaces and classes for efficient digital contract management and business context integration with a modular design.
 
-## Availabililty and Links
+## Install
-* [npmjs.org (npm package)](https://www.npmjs.com/package/@signature.digital/portablecontract)
+To install the `@signature.digital/tools` package, use your preferred package manager. For npm, run the following command:
-* [gitlab.com (source)](https://gitlab.com/signature.digital/portablecontract)
-* [github.com (source mirror)](https://github.com/signature.digital/portablecontract)
-* [docs (typedoc)](https://signature.digital.gitlab.io/portablecontract/)
 
-## Status for master
+```bash
+npm install @signature.digital/tools
+```
 
-Status Category | Status Badge
+Alternatively, if you are using Yarn, you can add the package with:
--- | --
+
-GitLab Pipelines | [![pipeline status](https://gitlab.com/signature.digital/portablecontract/badges/master/pipeline.svg)](https://lossless.cloud)
+```bash
-GitLab Pipline Test Coverage | [![coverage report](https://gitlab.com/signature.digital/portablecontract/badges/master/coverage.svg)](https://lossless.cloud)
+yarn add @signature.digital/tools
-npm | [![npm downloads per month](https://badgen.net/npm/dy/@signature.digital/portablecontract)](https://lossless.cloud)
+```
-Snyk | [![Known Vulnerabilities](https://badgen.net/snyk/signature.digital/portablecontract)](https://lossless.cloud)
+
-TypeScript Support | [![TypeScript](https://badgen.net/badge/TypeScript/>=%203.x/blue?icon=typescript)](https://lossless.cloud)
+Ensure your development environment supports ECMAScript Modules. In your `tsconfig.json`, you should set the `"module"` option to `"ESNext"` or a compatible module type that supports ES Modules.
-node Support | [![node](https://img.shields.io/badge/node->=%2010.x.x-blue.svg)](https://nodejs.org/dist/latest-v10.x/docs/api/)
-Code Style | [![Code Style](https://badgen.net/badge/style/prettier/purple)](https://lossless.cloud)
-PackagePhobia (total standalone install weight) | [![PackagePhobia](https://badgen.net/packagephobia/install/@signature.digital/portablecontract)](https://lossless.cloud)
-PackagePhobia (package size on registry) | [![PackagePhobia](https://badgen.net/packagephobia/publish/@signature.digital/portablecontract)](https://lossless.cloud)
-BundlePhobia (total size when bundled) | [![BundlePhobia](https://badgen.net/bundlephobia/minzip/@signature.digital/portablecontract)](https://lossless.cloud)
 
 ## Usage
-Use TypeScript for best in class intellisense
-For further information read the linked docs at the top of this readme.
 
-## Legal
+This guide details the comprehensive features of the `@signature.digital/tools` package, designed to streamline digital contract management in TypeScript applications. By using this package, you can leverage the structured capabilities of TypeScript to define, manage, and operate on digital contracts effectively.
-> MIT licensed | **©** [Task Venture Capital GmbH](https://task.vc)
+
-| By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy)
+### Introduction to the Module
+
+The `@signature.digital/tools` package capitalizes on TypeScript's robust typing system to mold digital contract management paradigms. It encourages an interface-driven approach to designing contracts, promotes modularity, and integrates business context inherently within its structures. 
+
+### Key Features
+
+1. **Interface-Driven Design:**
+   Utilize TypeScript interfaces to clearly delineate data structures for contracts. This results in easily maintainable, testable, and scalable digital contract solutions.
+
+2. **Modular Architecture:**
+   Divide and conquer complex contract datasets by representing them as reusable modules.
+
+3. **Business Contextualization:**
+   Seamlessly integrate business metadata into your contracts to reflect real-world applications and business scenarios.
+
+### Usage Scenarios
+
+Below are practical examples to help you understand and leverage the full capabilities of the `@signature.digital/tools` package.
+
+#### 1. Designing Contract Components
+
+Begin by defining the core components of a contract using the provided interfaces. Start with `IRole`, `IInvolvedParty`, `IParagraph`, and `IPortableContract`:
+
+```typescript
+import { IPortableContract, IRole, IInvolvedParty, IParagraph } from '@signature.digital/tools';
+import { tsclass } from '@signature.digital/tools';
+
+const createRoles = (): IRole[] => [
+  {
+    id: 'role-001',
+    name: 'Legal Advisor',
+    description: 'Advises on legal obligations and ensures compliance.'
+  },
+  {
+    id: 'role-002',
+    name: 'Stakeholder',
+    description: 'Interest in the outcome of the contract.'
+  }
+];
+
+const createContacts = (): tsclass.business.IContact[] => [
+  {
+    email: 'advisor@legalfirm.com',
+    address: '123 Legal Firm St, Legal City'
+  },
+  {
+    email: 'stakeholder@business.com',
+    address: '456 Business Way, Industry City'
+  }
+];
+
+const createParagraphs = (): IParagraph[] => [
+  {
+    uniqueId: 'para-001',
+    parent: null,
+    title: 'Introduction',
+    content: 'Introduction to the contract, setting expectations and scope of the agreement.'
+  },
+  {
+    uniqueId: 'para-002',
+    parent: null,
+    title: 'Obligations',
+    content: 'Details the specific obligations and responsibilities of each involved party.'
+  }
+];
+
+const createPortableContract = (): IPortableContract => {
+  const roles = createRoles();
+  const contacts = createContacts();
+  const paragraphs = createParagraphs();
+
+  return {
+    title: 'Digital Service Agreement',
+    context: 'A digital service provision framework between organizations.',
+    availableRoles: roles,
+    involvedParties: [
+      { role: roles[0].name, contact: contacts[0] },
+      { role: roles[1].name, contact: contacts[1] }
+    ],
+    priorContracts: [],
+    paragraphs
+  };
+};
+
+const contract = createPortableContract();
+console.log(contract);
+```
+
+This example highlights how you can define the roles, contacts, and paragraphs that collectively represent a comprehensive digital contract model.
+
+#### 2. Expanding Contract Details
+
+Extend core contracts to encapsulate more details specific to your organizational needs. You can add dates, custom attributes, or any other relevant information:
+
+```typescript
+interface IExtendedPortableContract extends IPortableContract {
+  startDate: Date;
+  endDate: Date;
+  customAttributes?: Record<string, any>;
+}
+
+const createExtendedContract = (): IExtendedPortableContract => {
+  const baseContract = createPortableContract();
+  return {
+    ...baseContract,
+    startDate: new Date('2023-01-01'),
+    endDate: new Date('2024-01-01'),
+    customAttributes: {
+      department: 'Legal',
+      projectCode: 'DSA2023'
+    }
+  };
+};
+
+const extendedContract = createExtendedContract();
+console.log(extendedContract);
+```
+
+#### 3. Maintaining Contract History
+
+Managing contractual history provides a strategic advantage in legal and administrative processes. Employ the `priorContracts` attribute to keep track of iterations:
+
+```typescript
+const initialContractVersion: IPortableContract = {
+  title: 'Initial Service Agreement',
+  context: 'Foundation agreement before the current digital service contract.',
+  availableRoles: createRoles(),
+  involvedParties: [
+    { role: 'Legal Advisor', contact: createContacts()[0] }
+  ],
+  priorContracts: [],
+  paragraphs: []
+};
+
+const updatedContractVersion = {
+  ...initialContractVersion,
+  title: 'Revised Digital Service Agreement',
+  priorContracts: [initialContractVersion]
+};
+
+console.log(updatedContractVersion);
+```
+
+This functionality is crucial for firms that require detailed records of contractual changes over time.
+
+#### 4. Integrating Business Entities
+
+Leverage the power of `@tsclass/tsclass` to seamlessly embed business information within contracts, enhancing clarity and context:
+
+```typescript
+const businessParty = {
+  role: 'Business Analyst',
+  contact: {
+    email: 'analyst@corporation.com',
+    address: '123 Business Lane, Tech City'
+  }
+};
+
+extendedContract.involvedParties.push(businessParty);
+console.log(extendedContract.involvedParties);
+```
+
+This level of integration is perfect for incorporating stakeholders' information.
+
+#### 5. Implementing Validation Logic
+
+While the package promotes interface-based design, users must implement validation patterns to ensure contract data integrity. Below is an example of how to perform basic validations:
+
+```typescript
+function isValidContractStructure(contract: IPortableContract): boolean {
+  return (
+    contract.context !== '' &&
+    contract.availableRoles.length > 0 &&
+    contract.involvedParties.length > 0 &&
+    contract.paragraphs.every(paragraph => paragraph.content !== '')
+  );
+}
+
+if (!isValidContractStructure(extendedContract)) {
+  throw new Error('Invalid contract structure detected!');
+}
+```
+
+This sample function demonstrates a straightforward mechanism to verify that the contract structure adheres to defined rules and prevents incorrect data entries.
+
+### Advanced Usage
+
+Let's delve into more intricate capabilities and scenarios that `@signature.digital/tools` can facilitate:
+
+#### Asynchronous Loading and Initialization
+
+For scenarios where parts of contracts or their dependencies are fetched from databases or APIs, the `@signature.digital/tools` suite can interact seamlessly with asynchronous sources:
+
+```typescript
+async function fetchContractData(): Promise<IPortableContract> {
+  // Simulate API call
+  return new Promise((resolve) => {
+    setTimeout(() => resolve(createPortableContract()), 1000);
+  });
+}
+
+async function initializeAsyncContract() {
+  try {
+    const contractData = await fetchContractData();
+    console.log('Loaded contract:', contractData);
+  } catch (error) {
+    console.error('Error fetching contract data:', error);
+  }
+}
+
+initializeAsyncContract();
+```
+
+This approach is vital when integrating with remote contract stores or dynamically fetching contract components.
+
+#### Dynamic Role Assignment
+
+Business environments often require flexibility in role assignments, which can be handled dynamically within the contract configurations:
+
+```typescript
+function addDynamicRoleToContract(contract: IPortableContract, roleName: string, contactInfo: tsclass.business.IContact) {
+  const role: IRole = {
+    id: `role-${Math.random().toString(36).substr(2, 9)}`, // Random ID generator
+    name: roleName,
+    description: `Dynamic role added for ${roleName}`
+  };
+
+  contract.availableRoles.push(role);
+  contract.involvedParties.push({ role: role.name, contact: contactInfo });
+  console.log(`Added role: ${roleName}`);
+}
+
+addDynamicRoleToContract(contract, 'Compliance Officer', {
+  email: 'compliance@business.com',
+  address: 'Office 42, Compliance Street'
+});
+console.log(contract);
+```
+
+Dynamic role assignments are essential when handling expansive contracts with changing stakeholder roles.
+
+#### Comprehensive Testing
+
+You should construct extensive tests for contract components by leveraging TypeScript's compatibility with common testing frameworks. Although the test cases here are isolated, they serve as foundational templates:
+
+```typescript
+import { expect } from '@push.rocks/tapbundle';
+
+tap.test('Contract Initial Structure', async () => {
+  const contractBase = createPortableContract();
+  expect(contractBase.title).toBe('Digital Service Agreement');
+  expect(contractBase.paragraphs.length).toBeGreaterThan(0);
+});
+
+tap.test('Role Addition', async () => {
+  const testContract = createPortableContract();
+  const initialRoleCount = testContract.availableRoles.length;
+
+  const newRole: IRole = {
+    id: 'role-003',
+    name: 'Tester',
+    description: 'Ensures quality and compliance of the contract.'
+  };
+
+  testContract.availableRoles.push(newRole);
+  expect(testContract.availableRoles.length).toBe(initialRoleCount + 1);
+});
+
+tap.start();
+```
+
+These examples demonstrate basic test cases to verify the functionality and resiliency of your contract management system.
+
+By utilizing the `@signature.digital/tools` package, developers can construct robust, dynamic, and efficient digital contract management systems tailored to a wide array of business scenarios. The examples provided above only scratch the surface of the package's versatility and extendability, empowering developers to innovate and automate contract handling processes in TypeScript.
+
+## License and Legal Information
+
+This repository contains open-source code that is licensed under the MIT License. A copy of the MIT License can be found in the [license](license) file within this repository. 
+
+**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 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, and any usage must be approved in writing by Task Venture Capital GmbH.
+
+### Company Information
+
+Task Venture Capital GmbH  
+Registered at District court Bremen HRB 35230 HB, Germany
+
+For any legal inquiries or if you require 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.

ts/00_commitinfo_data.ts

@@ -1,8 +1,8 @@
 /**
- * autocreated commitinfo by @pushrocks/commitinfo
+ * autocreated commitinfo by @push.rocks/commitinfo
  */
 export const commitinfo = {
-  name: '@signature.digital/portablecontract',
+  name: '@signature.digital/tools',
-  version: '1.0.3',
+  version: '1.1.0',
-  description: 'a package that defines standard tools for working with contracts.'
+  description: 'A TypeScript package providing utilities for managing digital contracts with modular interfaces and business context integration.'
 }

ts/index.ts

@@ -1,3 +1 @@
-import * as plugins from './portablecontract.plugins.js';
+export * from '../dist_ts_interfaces/index.js';
-
-export let demoExport = 'Hi there! :) This is an exported string';

ts/tspublish.json

@@ -0,0 +1,3 @@
+{
+  "order": 2
+}

ts_demodata/democontract.ts

@@ -0,0 +1,49 @@
+import * as plugins from './plugins.js';
+
+export const demoContract: plugins.interfaces.IPortableContract = {
+  "title": "Minijob Employment Contract",
+  "context": "This contract is for a Minijob position under German law.",
+  "availableRoles": [
+    {
+      "id": "employer",
+      "name": "Employer",
+      "description": "The party offering the Minijob position."
+    },
+    {
+      "id": "employee",
+      "name": "Employee",
+      "description": "The party accepting the Minijob position."
+    }
+  ],
+  "involvedParties": [
+    {
+      "role": "employer",
+      "contact": null
+    },
+    {
+      "role": "employee",
+      "contact": null
+    }
+  ],
+  "priorContracts": [],
+  "paragraphs": [
+    {
+      "uniqueId": "1",
+      "parent": null,
+      "title": "Introduction",
+      "content": "This contract outlines the terms of employment for a Minijob position between [Employer Name] and [Employee Name]."
+    },
+    {
+      "uniqueId": "2",
+      "parent": null,
+      "title": "Scope of Work",
+      "content": "The employee will perform the following duties: [List of Duties]."
+    },
+    {
+      "uniqueId": "3",
+      "parent": null,
+      "title": "Compensation",
+      "content": "The employee will be compensated with a monthly salary of [Salary Amount], in accordance with Minijob regulations."
+    }
+  ]
+};

ts_demodata/index.ts

@@ -0,0 +1 @@
+export * from './democontract.js';

ts_demodata/plugins.ts

@@ -0,0 +1,5 @@
+import * as interfaces from '../dist_ts_interfaces/index.js';
+
+export {
+  interfaces,
+}

ts_demodata/tspublish.json

@@ -0,0 +1,3 @@
+{
+  "order": 3
+}

ts_interfaces/index.ts

@@ -1,5 +1,4 @@
-import * as plugins from '../portablecontract.plugins.js';
+import * as plugins from './plugins.js';
-
 export interface IParagraph {
   uniqueId: string;
   parent: IParagraph | null;

ts_interfaces/plugins.ts

@@ -0,0 +1,5 @@
+import * as tsclass from '@tsclass/tsclass';
+
+export {
+  tsclass
+}

ts_interfaces/tspublish.json

@@ -0,0 +1,3 @@
+{
+  "order": 1
+}