feat(interfaces): add comprehensive TypeScript interface modules, demo data, docs, and publish metadata
This commit is contained in:
@@ -1,49 +1,612 @@
|
||||
/**
|
||||
* @file democontract.ts
|
||||
* @description Demo contract showcasing the comprehensive contract interface
|
||||
* A Minijob Employment Contract under German law
|
||||
*/
|
||||
|
||||
import * as plugins from './plugins.js';
|
||||
|
||||
/**
|
||||
* Demo Minijob Employment Contract
|
||||
* Demonstrates all major features of the IPortableContract interface
|
||||
*/
|
||||
export const demoContract: plugins.interfaces.IPortableContract = {
|
||||
"title": "Minijob Employment Contract",
|
||||
"context": "This contract is for a Minijob position under German law.",
|
||||
"availableRoles": [
|
||||
// ============================================================================
|
||||
// CORE IDENTITY
|
||||
// ============================================================================
|
||||
id: '550e8400-e29b-41d4-a716-446655440000',
|
||||
title: 'Minijob Employment Contract',
|
||||
context: 'Employment agreement for a Minijob (geringfügige Beschäftigung) position under German law, subject to § 8 SGB IV regulations.',
|
||||
|
||||
// ============================================================================
|
||||
// METADATA
|
||||
// ============================================================================
|
||||
metadata: {
|
||||
contractNumber: 'EMP-2024-001',
|
||||
category: 'employment',
|
||||
contractType: 'employment_minijob',
|
||||
language: 'de',
|
||||
additionalLanguages: ['en'],
|
||||
bindingLanguage: 'de',
|
||||
governingLaw: {
|
||||
country: 'DE',
|
||||
applicableLaws: ['BGB', 'TzBfG', 'MiLoG', 'ArbZG', 'SGB IV § 8'],
|
||||
disputeJurisdiction: 'Arbeitsgericht Bremen',
|
||||
disputeResolution: 'litigation',
|
||||
},
|
||||
tags: ['minijob', 'part-time', 'german-law'],
|
||||
relatedContractIds: [],
|
||||
confidentialityLevel: 'confidential',
|
||||
customFields: {
|
||||
department: 'Operations',
|
||||
costCenter: 'CC-100',
|
||||
},
|
||||
},
|
||||
|
||||
// ============================================================================
|
||||
// ROLES
|
||||
// ============================================================================
|
||||
availableRoles: [
|
||||
{
|
||||
"id": "employer",
|
||||
"name": "Employer",
|
||||
"description": "The party offering the Minijob position."
|
||||
id: 'employer',
|
||||
name: 'Arbeitgeber',
|
||||
description: 'The party offering the Minijob position.',
|
||||
category: 'party',
|
||||
signatureRequired: true,
|
||||
defaultSigningOrder: 1,
|
||||
legalCapacity: 'representative',
|
||||
notifyOnChanges: true,
|
||||
notifyOnComments: true,
|
||||
displayColor: '#1a73e8',
|
||||
minParties: 1,
|
||||
maxParties: 1,
|
||||
},
|
||||
{
|
||||
"id": "employee",
|
||||
"name": "Employee",
|
||||
"description": "The party accepting the Minijob position."
|
||||
}
|
||||
id: 'employee',
|
||||
name: 'Arbeitnehmer',
|
||||
description: 'The party accepting the Minijob position.',
|
||||
category: 'party',
|
||||
signatureRequired: true,
|
||||
defaultSigningOrder: 2,
|
||||
legalCapacity: 'individual',
|
||||
notifyOnChanges: true,
|
||||
notifyOnComments: true,
|
||||
displayColor: '#34a853',
|
||||
minParties: 1,
|
||||
maxParties: 1,
|
||||
},
|
||||
],
|
||||
"involvedParties": [
|
||||
|
||||
// ============================================================================
|
||||
// INVOLVED PARTIES
|
||||
// ============================================================================
|
||||
involvedParties: [
|
||||
{
|
||||
"role": "employer",
|
||||
"contact": null
|
||||
partyId: 'party-employer-001',
|
||||
roleId: 'employer',
|
||||
contact: {
|
||||
type: 'company',
|
||||
name: 'Demo GmbH',
|
||||
description: 'A demonstration company for contract examples',
|
||||
address: {
|
||||
streetName: 'Musterstraße',
|
||||
houseNumber: '123',
|
||||
postalCode: '28195',
|
||||
city: 'Bremen',
|
||||
country: 'Germany',
|
||||
},
|
||||
status: 'active',
|
||||
registrationDetails: {
|
||||
vatId: 'DE123456789',
|
||||
registrationId: 'HRB 12345',
|
||||
registrationName: 'Handelsregister Bremen',
|
||||
},
|
||||
},
|
||||
partyRole: 'signer',
|
||||
signingOrder: 1,
|
||||
signingDependency: 'none',
|
||||
dependsOnParties: [],
|
||||
signature: {
|
||||
status: 'pending',
|
||||
},
|
||||
actingAsProxy: true,
|
||||
legalProxy: {
|
||||
type: 'company_representative',
|
||||
representedEntity: {
|
||||
type: 'company',
|
||||
name: 'Demo GmbH',
|
||||
description: 'A demonstration company',
|
||||
address: {
|
||||
streetName: 'Musterstraße',
|
||||
houseNumber: '123',
|
||||
postalCode: '28195',
|
||||
city: 'Bremen',
|
||||
country: 'Germany',
|
||||
},
|
||||
status: 'active',
|
||||
registrationDetails: {
|
||||
vatId: 'DE123456789',
|
||||
registrationId: 'HRB 12345',
|
||||
registrationName: 'Handelsregister Bremen',
|
||||
},
|
||||
},
|
||||
position: 'Geschäftsführer',
|
||||
authorityScope: 'Full authority to enter into employment contracts',
|
||||
},
|
||||
deliveryEmail: 'hr@demo-gmbh.example',
|
||||
preferredLanguage: 'de',
|
||||
remindersSent: 0,
|
||||
totalViews: 0,
|
||||
metadata: {},
|
||||
},
|
||||
{
|
||||
"role": "employee",
|
||||
"contact": null
|
||||
}
|
||||
partyId: 'party-employee-001',
|
||||
roleId: 'employee',
|
||||
contact: {
|
||||
type: 'person',
|
||||
name: 'Max',
|
||||
surname: 'Mustermann',
|
||||
salutation: 'Mr',
|
||||
sex: 'male',
|
||||
description: 'Employee',
|
||||
address: {
|
||||
streetName: 'Beispielweg',
|
||||
houseNumber: '42',
|
||||
postalCode: '28199',
|
||||
city: 'Bremen',
|
||||
country: 'Germany',
|
||||
},
|
||||
email: 'max.mustermann@example.com',
|
||||
phone: '+49 421 1234567',
|
||||
},
|
||||
partyRole: 'signer',
|
||||
signingOrder: 2,
|
||||
signingDependency: 'sequential',
|
||||
dependsOnParties: ['party-employer-001'],
|
||||
signature: {
|
||||
status: 'pending',
|
||||
},
|
||||
actingAsProxy: false,
|
||||
deliveryEmail: 'max.mustermann@example.com',
|
||||
preferredLanguage: 'de',
|
||||
remindersSent: 0,
|
||||
totalViews: 0,
|
||||
metadata: {},
|
||||
},
|
||||
],
|
||||
"priorContracts": [],
|
||||
"paragraphs": [
|
||||
|
||||
// ============================================================================
|
||||
// PARAGRAPHS
|
||||
// ============================================================================
|
||||
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: 'para-preamble',
|
||||
parentId: null,
|
||||
title: 'Vertragsparteien',
|
||||
content: 'Zwischen\n\n**{{employer_name}}**\n{{employer_address}}\nvertreten durch {{employer_representative}}\n\n– nachfolgend „Arbeitgeber" genannt –\n\nund\n\n**{{employee_name}}**\n{{employee_address}}\n\n– nachfolgend „Arbeitnehmer" genannt –\n\nwird folgender Arbeitsvertrag für eine geringfügig entlohnte Beschäftigung (Minijob) geschlossen:',
|
||||
sectionType: 'preamble',
|
||||
numbering: undefined,
|
||||
order: 0,
|
||||
depth: 0,
|
||||
required: true,
|
||||
isEditable: false,
|
||||
variables: [
|
||||
{ variableId: 'employer_name', name: 'Employer Name', type: 'party_name', required: true, source: { type: 'party_field', path: 'involvedParties[0].contact.name' } },
|
||||
{ variableId: 'employer_address', name: 'Employer Address', type: 'party_address', required: true, source: { type: 'party_field', path: 'involvedParties[0].contact.address' } },
|
||||
{ variableId: 'employer_representative', name: 'Employer Representative', type: 'text', required: true },
|
||||
{ variableId: 'employee_name', name: 'Employee Name', type: 'party_name', required: true, source: { type: 'party_field', path: 'involvedParties[1].contact.name' } },
|
||||
{ variableId: 'employee_address', name: 'Employee Address', type: 'party_address', required: true, source: { type: 'party_field', path: 'involvedParties[1].contact.address' } },
|
||||
],
|
||||
conditions: [],
|
||||
legalReferences: [],
|
||||
translations: {
|
||||
en: {
|
||||
title: 'Contracting Parties',
|
||||
content: 'Between\n\n**{{employer_name}}**\n{{employer_address}}\nrepresented by {{employer_representative}}\n\n– hereinafter referred to as "Employer" –\n\nand\n\n**{{employee_name}}**\n{{employee_address}}\n\n– hereinafter referred to as "Employee" –\n\nthe following employment contract for marginal employment (Minijob) is concluded:',
|
||||
},
|
||||
},
|
||||
crossReferences: [],
|
||||
attachmentReferences: [],
|
||||
jurisdictions: ['DE'],
|
||||
tags: [],
|
||||
aiGenerated: false,
|
||||
},
|
||||
{
|
||||
"uniqueId": "2",
|
||||
"parent": null,
|
||||
"title": "Scope of Work",
|
||||
"content": "The employee will perform the following duties: [List of Duties]."
|
||||
uniqueId: 'para-1',
|
||||
parentId: null,
|
||||
title: '§ 1 Beginn und Dauer des Arbeitsverhältnisses',
|
||||
content: '(1) Das Arbeitsverhältnis beginnt am {{start_date}}.\n\n(2) Das Arbeitsverhältnis wird auf unbestimmte Zeit geschlossen.\n\n(3) Die ersten {{probation_months}} Monate gelten als Probezeit, während der das Arbeitsverhältnis von beiden Seiten mit einer Frist von zwei Wochen gekündigt werden kann.',
|
||||
sectionType: 'clause',
|
||||
numbering: '1',
|
||||
order: 1,
|
||||
depth: 0,
|
||||
required: true,
|
||||
isEditable: true,
|
||||
variables: [
|
||||
{ variableId: 'start_date', name: 'Start Date', type: 'date', required: true, format: { dateFormat: 'DD.MM.YYYY' } },
|
||||
{ variableId: 'probation_months', name: 'Probation Period (Months)', type: 'number', required: true, defaultValue: 6, validation: { min: 0, max: 6 } },
|
||||
],
|
||||
conditions: [],
|
||||
legalReferences: [
|
||||
{ type: 'statute', citation: '§ 622 BGB', jurisdiction: 'DE' },
|
||||
],
|
||||
translations: {
|
||||
en: {
|
||||
title: '§ 1 Commencement and Duration of Employment',
|
||||
content: '(1) The employment relationship begins on {{start_date}}.\n\n(2) The employment relationship is concluded for an indefinite period.\n\n(3) The first {{probation_months}} months are considered a probationary period, during which either party may terminate the employment with two weeks\' notice.',
|
||||
},
|
||||
},
|
||||
crossReferences: [],
|
||||
attachmentReferences: [],
|
||||
jurisdictions: ['DE'],
|
||||
tags: ['duration', 'probation'],
|
||||
aiGenerated: false,
|
||||
},
|
||||
{
|
||||
"uniqueId": "3",
|
||||
"parent": null,
|
||||
"title": "Compensation",
|
||||
"content": "The employee will be compensated with a monthly salary of [Salary Amount], in accordance with Minijob regulations."
|
||||
}
|
||||
]
|
||||
};
|
||||
uniqueId: 'para-2',
|
||||
parentId: null,
|
||||
title: '§ 2 Tätigkeit und Arbeitsort',
|
||||
content: '(1) Der Arbeitnehmer wird als {{job_title}} eingestellt.\n\n(2) Der Arbeitsort ist {{work_location}}.\n\n(3) Der Arbeitgeber ist berechtigt, dem Arbeitnehmer im Rahmen des Direktionsrechts auch andere zumutbare Tätigkeiten zuzuweisen.',
|
||||
sectionType: 'clause',
|
||||
numbering: '2',
|
||||
order: 2,
|
||||
depth: 0,
|
||||
required: true,
|
||||
isEditable: true,
|
||||
variables: [
|
||||
{ variableId: 'job_title', name: 'Job Title', type: 'text', required: true },
|
||||
{ variableId: 'work_location', name: 'Work Location', type: 'text', required: true },
|
||||
],
|
||||
conditions: [],
|
||||
legalReferences: [],
|
||||
translations: {
|
||||
en: {
|
||||
title: '§ 2 Duties and Place of Work',
|
||||
content: '(1) The employee is employed as {{job_title}}.\n\n(2) The place of work is {{work_location}}.\n\n(3) The employer is entitled to assign other reasonable duties to the employee within the scope of the right of direction.',
|
||||
},
|
||||
},
|
||||
crossReferences: [],
|
||||
attachmentReferences: [],
|
||||
jurisdictions: ['DE'],
|
||||
tags: ['duties', 'location'],
|
||||
aiGenerated: false,
|
||||
},
|
||||
{
|
||||
uniqueId: 'para-3',
|
||||
parentId: null,
|
||||
title: '§ 3 Arbeitszeit',
|
||||
content: '(1) Die regelmäßige wöchentliche Arbeitszeit beträgt {{weekly_hours}} Stunden.\n\n(2) Die Verteilung der Arbeitszeit wird vom Arbeitgeber nach billigem Ermessen festgelegt.\n\n(3) Der Arbeitnehmer verpflichtet sich, auf Anordnung des Arbeitgebers Mehrarbeit zu leisten, soweit dies gesetzlich zulässig ist.',
|
||||
sectionType: 'clause',
|
||||
numbering: '3',
|
||||
order: 3,
|
||||
depth: 0,
|
||||
required: true,
|
||||
isEditable: true,
|
||||
variables: [
|
||||
{ variableId: 'weekly_hours', name: 'Weekly Hours', type: 'number', required: true, defaultValue: 10, validation: { min: 1, max: 20 } },
|
||||
],
|
||||
conditions: [],
|
||||
legalReferences: [
|
||||
{ type: 'statute', citation: 'ArbZG', jurisdiction: 'DE' },
|
||||
],
|
||||
translations: {
|
||||
en: {
|
||||
title: '§ 3 Working Hours',
|
||||
content: '(1) The regular weekly working time is {{weekly_hours}} hours.\n\n(2) The distribution of working time is determined by the employer at their reasonable discretion.\n\n(3) The employee undertakes to work overtime upon instruction by the employer, insofar as this is legally permissible.',
|
||||
},
|
||||
},
|
||||
crossReferences: [],
|
||||
attachmentReferences: [],
|
||||
jurisdictions: ['DE'],
|
||||
tags: ['working-hours'],
|
||||
aiGenerated: false,
|
||||
},
|
||||
{
|
||||
uniqueId: 'para-4',
|
||||
parentId: null,
|
||||
title: '§ 4 Vergütung',
|
||||
content: '(1) Der Arbeitnehmer erhält eine monatliche Bruttovergütung von {{monthly_salary}} EUR.\n\n(2) Die Vergütung wird jeweils zum Monatsende auf das vom Arbeitnehmer angegebene Konto überwiesen.\n\n(3) Die Vergütung bleibt im Rahmen der Minijob-Verdienstgrenze (§ 8 SGB IV).',
|
||||
sectionType: 'clause',
|
||||
numbering: '4',
|
||||
order: 4,
|
||||
depth: 0,
|
||||
required: true,
|
||||
isEditable: true,
|
||||
variables: [
|
||||
{ variableId: 'monthly_salary', name: 'Monthly Salary (EUR)', type: 'currency', required: true, defaultValue: 520, validation: { max: 538 } },
|
||||
],
|
||||
conditions: [],
|
||||
legalReferences: [
|
||||
{ type: 'statute', citation: '§ 8 SGB IV', jurisdiction: 'DE' },
|
||||
{ type: 'statute', citation: 'MiLoG', jurisdiction: 'DE' },
|
||||
],
|
||||
translations: {
|
||||
en: {
|
||||
title: '§ 4 Compensation',
|
||||
content: '(1) The employee receives a gross monthly compensation of {{monthly_salary}} EUR.\n\n(2) The compensation is transferred to the account specified by the employee at the end of each month.\n\n(3) The compensation remains within the Minijob earnings limit (§ 8 SGB IV).',
|
||||
},
|
||||
},
|
||||
crossReferences: [],
|
||||
attachmentReferences: [],
|
||||
jurisdictions: ['DE'],
|
||||
tags: ['compensation', 'salary'],
|
||||
aiGenerated: false,
|
||||
},
|
||||
{
|
||||
uniqueId: 'para-5',
|
||||
parentId: null,
|
||||
title: '§ 5 Urlaub',
|
||||
content: '(1) Der Arbeitnehmer hat Anspruch auf bezahlten Erholungsurlaub entsprechend der gesetzlichen Bestimmungen.\n\n(2) Bei einer {{work_days_per_week}}-Tage-Woche beträgt der Jahresurlaubsanspruch {{vacation_days}} Arbeitstage.',
|
||||
sectionType: 'clause',
|
||||
numbering: '5',
|
||||
order: 5,
|
||||
depth: 0,
|
||||
required: true,
|
||||
isEditable: true,
|
||||
variables: [
|
||||
{ variableId: 'work_days_per_week', name: 'Work Days per Week', type: 'number', required: true, defaultValue: 2 },
|
||||
{ variableId: 'vacation_days', name: 'Vacation Days per Year', type: 'number', required: true, source: { type: 'calculated', formula: 'Math.ceil(work_days_per_week * 4)' } },
|
||||
],
|
||||
conditions: [],
|
||||
legalReferences: [
|
||||
{ type: 'statute', citation: 'BUrlG', jurisdiction: 'DE' },
|
||||
],
|
||||
translations: {
|
||||
en: {
|
||||
title: '§ 5 Vacation',
|
||||
content: '(1) The employee is entitled to paid vacation in accordance with statutory provisions.\n\n(2) For a {{work_days_per_week}}-day work week, the annual vacation entitlement is {{vacation_days}} working days.',
|
||||
},
|
||||
},
|
||||
crossReferences: [],
|
||||
attachmentReferences: [],
|
||||
jurisdictions: ['DE'],
|
||||
tags: ['vacation', 'leave'],
|
||||
aiGenerated: false,
|
||||
},
|
||||
{
|
||||
uniqueId: 'para-6',
|
||||
parentId: null,
|
||||
title: '§ 6 Kündigung',
|
||||
content: '(1) Nach Ablauf der Probezeit kann das Arbeitsverhältnis mit einer Frist von vier Wochen zum Fünfzehnten oder zum Ende eines Kalendermonats gekündigt werden.\n\n(2) Die Kündigung bedarf der Schriftform.',
|
||||
sectionType: 'clause',
|
||||
numbering: '6',
|
||||
order: 6,
|
||||
depth: 0,
|
||||
required: true,
|
||||
isEditable: true,
|
||||
variables: [],
|
||||
conditions: [],
|
||||
legalReferences: [
|
||||
{ type: 'statute', citation: '§ 622 BGB', jurisdiction: 'DE' },
|
||||
],
|
||||
translations: {
|
||||
en: {
|
||||
title: '§ 6 Termination',
|
||||
content: '(1) After the probationary period, the employment relationship may be terminated with four weeks\' notice to the 15th or the end of a calendar month.\n\n(2) Termination must be in writing.',
|
||||
},
|
||||
},
|
||||
crossReferences: ['para-1'],
|
||||
attachmentReferences: [],
|
||||
jurisdictions: ['DE'],
|
||||
tags: ['termination', 'notice'],
|
||||
aiGenerated: false,
|
||||
},
|
||||
{
|
||||
uniqueId: 'para-signature',
|
||||
parentId: null,
|
||||
title: 'Unterschriften',
|
||||
content: 'Mit ihrer Unterschrift bestätigen die Parteien, dass sie diesen Vertrag gelesen und verstanden haben und sich an dessen Bedingungen gebunden fühlen.\n\n{{signature_location}}, den {{signature_date}}',
|
||||
sectionType: 'signature_block',
|
||||
order: 7,
|
||||
depth: 0,
|
||||
required: true,
|
||||
isEditable: false,
|
||||
variables: [
|
||||
{ variableId: 'signature_location', name: 'Signature Location', type: 'text', required: true, defaultValue: 'Bremen' },
|
||||
{ variableId: 'signature_date', name: 'Signature Date', type: 'date', required: true, source: { type: 'manual' } },
|
||||
],
|
||||
conditions: [],
|
||||
legalReferences: [],
|
||||
translations: {
|
||||
en: {
|
||||
title: 'Signatures',
|
||||
content: 'By signing, the parties confirm that they have read and understood this contract and agree to be bound by its terms.\n\n{{signature_location}}, {{signature_date}}',
|
||||
},
|
||||
},
|
||||
crossReferences: [],
|
||||
attachmentReferences: [],
|
||||
jurisdictions: ['DE'],
|
||||
tags: ['signatures'],
|
||||
aiGenerated: false,
|
||||
},
|
||||
],
|
||||
|
||||
// ============================================================================
|
||||
// VARIABLES (Global)
|
||||
// ============================================================================
|
||||
variables: [],
|
||||
|
||||
// ============================================================================
|
||||
// SIGNATURE FIELDS
|
||||
// ============================================================================
|
||||
signatureFields: [],
|
||||
|
||||
// ============================================================================
|
||||
// FINANCIAL TERMS
|
||||
// ============================================================================
|
||||
financialTerms: {
|
||||
totalValue: {
|
||||
amount: 520,
|
||||
currency: 'EUR',
|
||||
includesTax: false,
|
||||
},
|
||||
paymentSchedule: [
|
||||
{
|
||||
paymentId: 'salary-monthly',
|
||||
description: 'Monthly Salary',
|
||||
amount: { amount: 520, currency: 'EUR', includesTax: false },
|
||||
dueDate: 0,
|
||||
frequency: 'monthly',
|
||||
isFinalPayment: false,
|
||||
status: 'pending',
|
||||
},
|
||||
],
|
||||
paymentMethods: ['bank_transfer'],
|
||||
paymentDueDays: 0,
|
||||
depositRefundable: false,
|
||||
billingRates: [],
|
||||
interestRates: {},
|
||||
penalties: [],
|
||||
},
|
||||
|
||||
// ============================================================================
|
||||
// TIME TERMS
|
||||
// ============================================================================
|
||||
timeTerms: {
|
||||
isIndefinite: true,
|
||||
commencementConditions: ['Signed by both parties'],
|
||||
milestones: [],
|
||||
deadlines: [],
|
||||
noticePeriods: {
|
||||
termination: {
|
||||
duration: { value: 4, unit: 'weeks' },
|
||||
effectivePoint: 'end_of_month',
|
||||
form: 'written',
|
||||
},
|
||||
},
|
||||
keyDates: [],
|
||||
},
|
||||
|
||||
// ============================================================================
|
||||
// OBLIGATION TERMS
|
||||
// ============================================================================
|
||||
obligationTerms: {
|
||||
deliverables: [],
|
||||
serviceLevels: [],
|
||||
quantities: [],
|
||||
obligations: [
|
||||
{
|
||||
obligationId: 'work-performance',
|
||||
type: 'performance',
|
||||
description: 'Employee shall perform duties as assigned by employer',
|
||||
obligorPartyId: 'party-employee-001',
|
||||
beneficiaryPartyId: 'party-employer-001',
|
||||
recurring: true,
|
||||
priority: 'high',
|
||||
status: 'pending',
|
||||
},
|
||||
{
|
||||
obligationId: 'salary-payment',
|
||||
type: 'payment',
|
||||
description: 'Employer shall pay monthly salary',
|
||||
obligorPartyId: 'party-employer-001',
|
||||
beneficiaryPartyId: 'party-employee-001',
|
||||
recurring: true,
|
||||
frequency: 'monthly',
|
||||
priority: 'high',
|
||||
status: 'pending',
|
||||
},
|
||||
],
|
||||
warranties: [],
|
||||
representations: [],
|
||||
insuranceRequirements: [],
|
||||
complianceRequirements: ['Minijob regulations (§ 8 SGB IV)', 'Minimum wage (MiLoG)'],
|
||||
},
|
||||
|
||||
// ============================================================================
|
||||
// DOCUMENTS
|
||||
// ============================================================================
|
||||
priorContracts: [],
|
||||
attachments: [],
|
||||
|
||||
// ============================================================================
|
||||
// VERSIONING
|
||||
// ============================================================================
|
||||
versionHistory: {
|
||||
contractId: '550e8400-e29b-41d4-a716-446655440000',
|
||||
currentVersionId: 'version-001',
|
||||
currentVersion: { major: 1, minor: 0, patch: 0 },
|
||||
versions: [
|
||||
{
|
||||
id: 'version-001',
|
||||
version: { major: 1, minor: 0, patch: 0 },
|
||||
versionString: '1.0.0',
|
||||
type: 'draft',
|
||||
createdAt: Date.now(),
|
||||
createdBy: 'system',
|
||||
createdByDisplayName: 'System',
|
||||
changes: [],
|
||||
contentHash: '',
|
||||
tags: ['initial'],
|
||||
isAmendment: false,
|
||||
},
|
||||
],
|
||||
branches: [
|
||||
{
|
||||
id: 'branch-main',
|
||||
name: 'main',
|
||||
createdAt: Date.now(),
|
||||
createdBy: 'system',
|
||||
baseVersionId: 'version-001',
|
||||
headVersionId: 'version-001',
|
||||
status: 'active',
|
||||
},
|
||||
],
|
||||
mainBranchId: 'branch-main',
|
||||
publishedVersions: [],
|
||||
amendmentVersions: [],
|
||||
},
|
||||
|
||||
// ============================================================================
|
||||
// COLLABORATION
|
||||
// ============================================================================
|
||||
collaborators: [],
|
||||
commentThreads: [],
|
||||
suggestions: [],
|
||||
|
||||
// ============================================================================
|
||||
// LIFECYCLE
|
||||
// ============================================================================
|
||||
lifecycle: {
|
||||
contractId: '550e8400-e29b-41d4-a716-446655440000',
|
||||
currentStatus: 'draft',
|
||||
statusHistory: [],
|
||||
createdAt: Date.now(),
|
||||
},
|
||||
|
||||
// ============================================================================
|
||||
// AUDIT LOG
|
||||
// ============================================================================
|
||||
auditLog: {
|
||||
contractId: '550e8400-e29b-41d4-a716-446655440000',
|
||||
actions: [],
|
||||
genesisHash: 'genesis-hash-placeholder',
|
||||
currentHash: 'genesis-hash-placeholder',
|
||||
chainLength: 0,
|
||||
statistics: {
|
||||
totalActions: 0,
|
||||
actionsByCategory: {} as Record<string, number>,
|
||||
uniqueUsers: [],
|
||||
dateRange: { earliest: 0, latest: 0 },
|
||||
},
|
||||
},
|
||||
|
||||
// ============================================================================
|
||||
// TIMESTAMPS
|
||||
// ============================================================================
|
||||
createdAt: Date.now(),
|
||||
createdBy: 'system',
|
||||
updatedAt: Date.now(),
|
||||
|
||||
// ============================================================================
|
||||
// ORGANIZATION
|
||||
// ============================================================================
|
||||
visibility: 'private',
|
||||
|
||||
// ============================================================================
|
||||
// INTEGRATIONS
|
||||
// ============================================================================
|
||||
integrations: {
|
||||
customIntegrations: {},
|
||||
},
|
||||
};
|
||||
|
||||
179
ts_demodata/readme.md
Normal file
179
ts_demodata/readme.md
Normal file
@@ -0,0 +1,179 @@
|
||||
# @signature.digital/demodata
|
||||
|
||||
Demo contracts and test data for the signature.digital contract management system. 🧪
|
||||
|
||||
Use these realistic sample contracts for testing, development, and demonstrating the full capabilities of the `@signature.digital/interfaces` types.
|
||||
|
||||
## Install
|
||||
|
||||
```bash
|
||||
pnpm add @signature.digital/demodata
|
||||
```
|
||||
|
||||
## Usage
|
||||
|
||||
```typescript
|
||||
import { demoContract } from '@signature.digital/demodata';
|
||||
|
||||
console.log(demoContract.title); // 'Minijob Employment Contract'
|
||||
console.log(demoContract.metadata.language); // 'de'
|
||||
console.log(demoContract.paragraphs.length); // 8
|
||||
```
|
||||
|
||||
## Available Demo Data
|
||||
|
||||
### demoContract
|
||||
|
||||
A **German Minijob Employment Contract** (geringfügige Beschäftigung) that demonstrates the full power of the `IPortableContract` interface:
|
||||
|
||||
```typescript
|
||||
import { demoContract } from '@signature.digital/demodata';
|
||||
```
|
||||
|
||||
**Contract Details:**
|
||||
- **Type**: Employment → Minijob
|
||||
- **Language**: German (with English translations)
|
||||
- **Governing Law**: Germany (BGB, TzBfG, MiLoG, ArbZG, SGB IV)
|
||||
- **Jurisdiction**: Arbeitsgericht Bremen
|
||||
|
||||
**Features Demonstrated:**
|
||||
|
||||
| Feature | Details |
|
||||
|---------|---------|
|
||||
| 🏢 **Parties** | Company employer + Individual employee |
|
||||
| 📜 **Roles** | Arbeitgeber, Arbeitnehmer with full configuration |
|
||||
| 📝 **Paragraphs** | 8 sections with proper German legal structure |
|
||||
| 🌍 **Multi-language** | DE/EN translations for all content |
|
||||
| 🔤 **Variables** | Placeholders with validation rules |
|
||||
| ⚖️ **Legal refs** | BGB, SGB IV, MiLoG, ArbZG citations |
|
||||
| 💰 **Financial** | Monthly salary payment schedule |
|
||||
| ⏱️ **Time terms** | Indefinite duration with notice periods |
|
||||
| 📋 **Obligations** | Work performance, salary payment |
|
||||
| 🔖 **Metadata** | Contract number, tags, custom fields |
|
||||
|
||||
## Contract Structure
|
||||
|
||||
The demo contract includes these sections:
|
||||
|
||||
1. **Vertragsparteien** (Contracting Parties) – Preamble with party details
|
||||
2. **§ 1 Beginn und Dauer** – Commencement, duration, probation
|
||||
3. **§ 2 Tätigkeit und Arbeitsort** – Duties and place of work
|
||||
4. **§ 3 Arbeitszeit** – Working hours configuration
|
||||
5. **§ 4 Vergütung** – Compensation within Minijob limits
|
||||
6. **§ 5 Urlaub** – Vacation entitlement (pro-rata)
|
||||
7. **§ 6 Kündigung** – Termination notice periods
|
||||
8. **Unterschriften** – Signature block
|
||||
|
||||
## Variables Example
|
||||
|
||||
The demo contract showcases various variable types:
|
||||
|
||||
```typescript
|
||||
// Party-linked variables (auto-populated)
|
||||
{ variableId: 'employer_name', type: 'party_name', source: { type: 'party_field', path: 'involvedParties[0].contact.name' } }
|
||||
|
||||
// Date variables with formatting
|
||||
{ variableId: 'start_date', type: 'date', format: { dateFormat: 'DD.MM.YYYY' } }
|
||||
|
||||
// Validated number variables
|
||||
{ variableId: 'probation_months', type: 'number', defaultValue: 6, validation: { min: 0, max: 6 } }
|
||||
|
||||
// Calculated variables
|
||||
{ variableId: 'vacation_days', type: 'number', source: { type: 'calculated', formula: 'Math.ceil(work_days_per_week * 4)' } }
|
||||
|
||||
// Currency with limits
|
||||
{ variableId: 'monthly_salary', type: 'currency', defaultValue: 520, validation: { max: 538 } }
|
||||
```
|
||||
|
||||
## Party Examples
|
||||
|
||||
The demo includes both company and individual contacts:
|
||||
|
||||
```typescript
|
||||
// Employer (Company)
|
||||
{
|
||||
type: 'company',
|
||||
name: 'Demo GmbH',
|
||||
address: { streetName: 'Musterstraße', houseNumber: '123', city: 'Bremen', country: 'Germany' },
|
||||
registrationDetails: { vatId: 'DE123456789', registrationId: 'HRB 12345' }
|
||||
}
|
||||
|
||||
// Employee (Person)
|
||||
{
|
||||
type: 'person',
|
||||
name: 'Max',
|
||||
surname: 'Mustermann',
|
||||
email: 'max.mustermann@example.com',
|
||||
phone: '+49 421 1234567'
|
||||
}
|
||||
```
|
||||
|
||||
## Use Cases
|
||||
|
||||
### Testing Contract Rendering
|
||||
|
||||
```typescript
|
||||
import { demoContract } from '@signature.digital/demodata';
|
||||
|
||||
// Test paragraph rendering
|
||||
demoContract.paragraphs.forEach(para => {
|
||||
console.log(`${para.numbering} ${para.title}`);
|
||||
console.log(para.content);
|
||||
});
|
||||
```
|
||||
|
||||
### Testing Variable Substitution
|
||||
|
||||
```typescript
|
||||
import { demoContract } from '@signature.digital/demodata';
|
||||
|
||||
function substituteVariables(content: string, variables: Record<string, unknown>): string {
|
||||
return content.replace(/\{\{(\w+)\}\}/g, (_, key) => String(variables[key] || `{{${key}}}`));
|
||||
}
|
||||
|
||||
const values = { employer_name: 'Acme Corp', start_date: '01.01.2025' };
|
||||
const rendered = substituteVariables(demoContract.paragraphs[0].content, values);
|
||||
```
|
||||
|
||||
### Testing Translation Display
|
||||
|
||||
```typescript
|
||||
import { demoContract } from '@signature.digital/demodata';
|
||||
|
||||
function getParagraphInLanguage(para: IParagraph, lang: string): { title: string; content: string } {
|
||||
if (lang === para.language || lang === 'de') {
|
||||
return { title: para.title, content: para.content };
|
||||
}
|
||||
return para.translations[lang] || { title: para.title, content: para.content };
|
||||
}
|
||||
|
||||
// Get English version
|
||||
const englishPara = getParagraphInLanguage(demoContract.paragraphs[1], 'en');
|
||||
console.log(englishPara.title); // '§ 1 Commencement and Duration of Employment'
|
||||
```
|
||||
|
||||
## Dependencies
|
||||
|
||||
- `@signature.digital/interfaces` – Contract interface definitions
|
||||
- `@tsclass/tsclass` – Business entity types
|
||||
|
||||
## 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.
|
||||
@@ -1,5 +1,9 @@
|
||||
{
|
||||
"name": "@signature.digital/demodata",
|
||||
"order": 3,
|
||||
"registries": ["useBase"]
|
||||
"registries": ["useBase"],
|
||||
"dependencies": [
|
||||
"@signature.digital/interfaces",
|
||||
"@tsclass/tsclass"
|
||||
]
|
||||
}
|
||||
Reference in New Issue
Block a user