18 Commits

Author SHA1 Message Date
c52e4e873b 1.0.22 2025-04-28 10:27:15 +00:00
dcff81b4cc fix(package.json): Add explicit packageManager field for consistent dependency resolution 2025-04-28 10:27:15 +00:00
6b73313bbc 1.0.21 2025-04-28 08:58:38 +00:00
d58f21f5de fix(metadata): Update repository, package, and branding details to reflect new project ownership and naming 2025-04-28 08:58:37 +00:00
4c13cae34d 1.0.20 2025-03-15 15:10:42 +00:00
f800d61576 fix(letterxpress): Update dependencies, adjust PDF generation parameters, and remove obsolete CI configuration 2025-03-15 15:10:42 +00:00
679d1cf9c4 1.0.19 2024-04-17 19:47:23 +02:00
ce060f0cf9 fix(core): update 2024-04-17 19:47:23 +02:00
4d4d46ef7c 1.0.18 2024-02-19 01:35:47 +01:00
696d56067c fix(core): update 2024-02-19 01:35:46 +01:00
fa3f4b4ccf 1.0.17 2024-02-17 02:34:32 +01:00
5b823b09ac fix(core): update 2024-02-17 02:34:31 +01:00
ebd50b0bed 1.0.16 2024-02-16 20:27:15 +01:00
9f70eba74a fix(core): update 2024-02-16 20:27:14 +01:00
1cf81f86ff 1.0.15 2022-06-29 08:26:31 +02:00
b28200e1fc fix(core): update 2022-06-29 08:26:31 +02:00
afa0a769f6 1.0.14 2022-06-16 15:36:15 +02:00
f5842147be fix(core): update 2022-06-16 15:36:14 +02:00
14 changed files with 10289 additions and 14513 deletions

View File

@@ -1,139 +0,0 @@
# gitzone ci_default
image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
cache:
paths:
- .npmci_cache/
key: '$CI_BUILD_STAGE'
stages:
- security
- test
- release
- metadata
before_script:
- npm install -g @shipzone/npmci
# ====================
# security stage
# ====================
mirror:
stage: security
script:
- npmci git mirror
only:
- tags
tags:
- lossless
- docker
- notpriv
auditProductionDependencies:
image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
stage: security
script:
- npmci npm prepare
- npmci command npm install --production --ignore-scripts
- npmci command npm config set registry https://registry.npmjs.org
- npmci command npm audit --audit-level=high --only=prod --production
tags:
- docker
allow_failure: true
auditDevDependencies:
image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
stage: security
script:
- npmci npm prepare
- npmci command npm install --ignore-scripts
- npmci command npm config set registry https://registry.npmjs.org
- npmci command npm audit --audit-level=high --only=dev
tags:
- docker
allow_failure: true
# ====================
# test stage
# ====================
testStable:
stage: test
script:
- npmci npm prepare
- npmci node install stable
- npmci npm install
- npmci npm test
coverage: /\d+.?\d+?\%\s*coverage/
tags:
- docker
testBuild:
stage: test
script:
- npmci npm prepare
- npmci node install stable
- npmci npm install
- npmci command npm run build
coverage: /\d+.?\d+?\%\s*coverage/
tags:
- docker
release:
stage: release
script:
- npmci node install stable
- npmci npm publish
only:
- tags
tags:
- lossless
- docker
- notpriv
# ====================
# metadata stage
# ====================
codequality:
stage: metadata
allow_failure: true
only:
- tags
script:
- npmci command npm install -g typescript
- npmci npm prepare
- npmci npm install
tags:
- lossless
- docker
- priv
trigger:
stage: metadata
script:
- npmci trigger
only:
- tags
tags:
- lossless
- docker
- notpriv
pages:
stage: metadata
script:
- npmci node install stable
- npmci npm prepare
- npmci npm install
- npmci command npm run buildDocs
tags:
- lossless
- docker
- notpriv
only:
- tags
artifacts:
expire_in: 1 week
paths:
- public
allow_failure: true

118
changelog.md Normal file
View File

@@ -0,0 +1,118 @@
# Changelog
## 2025-04-28 - 1.0.22 - fix(package.json)
Add explicit packageManager field for consistent dependency resolution
- Include packageManager field to ensure correct pnpm version is used
## 2025-04-28 - 1.0.21 - fix(metadata)
Update repository, package, and branding details to reflect new project ownership and naming
- Changed author in package.json from 'Lossless GmbH' to 'Task Venture Capital GmbH'
- Updated repository URL, issues URL, and homepage in package.json
- Revised npmextra.json with updated githost, gitscope, npmPackagename, and projectDomain
- Updated readme.md to replace '@mojoio/letterxpress' with '@apiclient.xyz/letterxpress' and adjust corresponding links
- Replaced old license file with new license.md reflecting updated copyright information
## 2025-03-15 - 1.0.20 - fix(letterxpress)
Update dependencies, adjust PDF generation parameters, and remove obsolete CI configuration
- Updated @push.rocks/smartbuffer from ^2.0.1 to ^3.0.4
- Updated @tsclass/tsclass from ^4.0.54 to ^5.0.0
- Updated @types/node from ^20.12.7 to ^22.13.10
- Changed dees-document import path to use the 'node' entry point
- Modified sendLetter to pass an object with letterData and documentSettings to createPdfFromLetterObject
- Removed obsolete .gitlab-ci.yml file
## 2024-04-17 - 1.0.18 - core
fix(core): update
- Core module updated.
## 2024-02-19 - 1.0.17 - core
fix(core): update
- Core module updated.
## 2024-02-17 - 1.0.16 - core
fix(core): update
- Core module updated.
## 2024-02-16 - 1.0.15 - core
fix(core): update
- Core module updated.
## 2022-06-29 - 1.0.14 - core
fix(core): update
- Core module update applied.
## 2022-06-16 - 1.0.13 - core
fix(core): update
- Core module update applied.
## 2022-06-16 - 1.0.12 - core
fix(core): update
- Core module update applied.
## 2022-06-16 - 1.0.11 - core
fix(core): update
- Core module update applied.
## 2019-11-22 - 1.0.10 - build
fix(build): now including all necessary types
- Included all necessary type definitions in the build process.
## 2019-11-22 - 1.0.09 - security
fix(security): update snyk
- Updated snyk for improved security.
## 2019-11-22 - 1.0.08 - core
fix(core): update
- Core module updated.
## 2019-11-21 - 1.0.07 - core
fix(core): update
- Core module updated.
## 2019-11-18 - 1.0.06 - readme
fix(readme): show how to instantiate account
- Updated documentation to show how to instantiate an account.
## 2019-11-18 - 1.0.05 - readme
fix(readme): add links to documentation
- Added links to documentation in the readme.
## 2019-11-18 - 1.0.04 - test
fix(test): add first account test
- Added the first account test.
## 2019-11-18 - 1.0.03 - core
fix(core): update
- Core module updated.
## 2019-11-16 - 1.0.02 - core
fix(core): update
- Core module updated.
## 2019-11-13 - 1.0.01 - core
fix(core): update
- Core module updated.
## Other versions (omitted)
The following version(s) included only version bump commits without additional changes: 1.0.19.

View File

@@ -1,4 +1,4 @@
Copyright (c) 2019 Lossless GmbH (hello@lossless.com)
Copyright (c) 2019 Task Venture Capital GmbH (hello@task.vc)
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal

View File

@@ -2,13 +2,13 @@
"gitzone": {
"projectType": "npm",
"module": {
"githost": "gitlab.com",
"gitscope": "mojoio",
"githost": "code.foss.global",
"gitscope": "apiclient.xyz",
"gitrepo": "letterxpress",
"description": "an unofficial API package for the letterxpress API",
"npmPackagename": "@mojoio/letterxpress",
"npmPackagename": "@apiclient.xyz/letterxpress",
"license": "MIT",
"projectDomain": "mojo.io"
"projectDomain": "apiclient.xyz"
}
},
"npmci": {

14268
package-lock.json generated

File diff suppressed because it is too large Load Diff

View File

@@ -1,33 +1,42 @@
{
"name": "@mojoio/letterxpress",
"version": "1.0.13",
"name": "@apiclient.xyz/letterxpress",
"version": "1.0.22",
"private": false,
"description": "an unofficial API package for the letterxpress API",
"main": "dist_ts/index.js",
"typings": "dist_ts/index.d.ts",
"author": "Lossless GmbH",
"author": "Task Venture Capital GmbH",
"license": "MIT",
"repository": {
"type": "git",
"url": "git+https://code.foss.global/apiclient.xyz/letterxpress.git"
},
"bugs": {
"url": "https://code.foss.global/apiclient.xyz/letterxpress/issues"
},
"homepage": "https://code.foss.global/apiclient.xyz/letterxpress#readme",
"scripts": {
"test": "(tstest test/)",
"build": "(tsbuild --web)",
"build": "(tsbuild --web --allowimplicitany)",
"format": "(gitzone format)",
"buildDocs": "tsdoc"
"localPublish": "gitzone commit && pnpm run build && pnpm publish && pnpm publish --access public --registry=\"https://registry.npmjs.org\""
},
"devDependencies": {
"@gitzone/tsbuild": "^2.1.63",
"@gitzone/tstest": "^1.0.71",
"@pushrocks/qenv": "^4.0.10",
"@pushrocks/tapbundle": "^5.0.3",
"@types/node": "^18.0.0"
"@git.zone/tsbuild": "^2.1.63",
"@git.zone/tsrun": "^1.2.46",
"@git.zone/tstest": "^1.0.88",
"@push.rocks/qenv": "^6.0.5",
"@push.rocks/tapbundle": "^5.0.23",
"@types/node": "^22.13.10"
},
"dependencies": {
"@pushrocks/smartbuffer": "^1.0.3",
"@pushrocks/smarthash": "^2.1.10",
"@pushrocks/smartletter": "^2.0.13",
"@pushrocks/smartpromise": "^3.1.7",
"@pushrocks/smartrequest": "^1.1.56",
"@pushrocks/smartrx": "^2.0.25",
"@tsclass/tsclass": "^4.0.17"
"@design.estate/dees-document": "^1.0.99",
"@push.rocks/smartbuffer": "^3.0.4",
"@push.rocks/smarthash": "^3.0.1",
"@push.rocks/smartpromise": "^4.0.3",
"@push.rocks/smartrequest": "^2.0.22",
"@push.rocks/smartrx": "^3.0.7",
"@tsclass/tsclass": "^5.0.0"
},
"files": [
"ts/**/*",
@@ -44,5 +53,13 @@
"type": "module",
"browserslist": [
"last 1 chrome versions"
]
],
"pnpm": {
"onlyBuiltDependencies": [
"esbuild",
"mongodb-memory-server",
"puppeteer"
]
},
"packageManager": "pnpm@10.7.0+sha512.6b865ad4b62a1d9842b61d674a393903b871d9244954f652b8842c2b553c72176b278f64c463e52d40fff8aba385c235c8c9ecf5cc7de4fd78b8bb6d49633ab6"
}

10054
pnpm-lock.yaml generated Normal file

File diff suppressed because it is too large Load Diff

0
readme.hints.md Normal file
View File

View File

@@ -1,27 +1,11 @@
# @mojoio/letterxpress
# @apiclient.xyz/letterxpress
an unofficial API package for the letterxpress API
## Availabililty and Links
* [npmjs.org (npm package)](https://www.npmjs.com/package/@mojoio/letterxpress)
* [gitlab.com (source)](https://gitlab.com/mojoio/letterxpress)
* [github.com (source mirror)](https://github.com/mojoio/letterxpress)
* [docs (typedoc)](https://mojoio.gitlab.io/letterxpress/)
## Availability and Links
* [npm package](https://www.npmjs.com/package/@apiclient.xyz/letterxpress)
* [Source code (Code.Foss.Global)](https://code.foss.global/apiclient.xyz/letterxpress)
* [Issue tracker](https://code.foss.global/apiclient.xyz/letterxpress/issues)
## Status for master
Status Category | Status Badge
-- | --
GitLab Pipelines | [![pipeline status](https://gitlab.com/mojoio/letterxpress/badges/master/pipeline.svg)](https://lossless.cloud)
GitLab Pipline Test Coverage | [![coverage report](https://gitlab.com/mojoio/letterxpress/badges/master/coverage.svg)](https://lossless.cloud)
npm | [![npm downloads per month](https://badgen.net/npm/dy/@mojoio/letterxpress)](https://lossless.cloud)
Snyk | [![Known Vulnerabilities](https://badgen.net/snyk/mojoio/letterxpress)](https://lossless.cloud)
TypeScript Support | [![TypeScript](https://badgen.net/badge/TypeScript/>=%203.x/blue?icon=typescript)](https://lossless.cloud)
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/@mojoio/letterxpress)](https://lossless.cloud)
PackagePhobia (package size on registry) | [![PackagePhobia](https://badgen.net/packagephobia/publish/@mojoio/letterxpress)](https://lossless.cloud)
BundlePhobia (total size when bundled) | [![BundlePhobia](https://badgen.net/bundlephobia/minzip/@mojoio/letterxpress)](https://lossless.cloud)
Platform support | [![Supports Windows 10](https://badgen.net/badge/supports%20Windows%2010/yes/green?icon=windows)](https://lossless.cloud) [![Supports Mac OS X](https://badgen.net/badge/supports%20Mac%20OS%20X/yes/green?icon=apple)](https://lossless.cloud)
## Usage
@@ -30,7 +14,7 @@ Use TypeScript for best in class intellisense.
letterxpress implements the LXP API documented here: [LXP API Documentation](https://www.letterxpress.de/briefe-uebertragen/api)
```typescript
import * as letterxpress from '@mojoio/letterxpress';
import * as letterxpress from '@apiclient.xyz/letterxpress';
const account = new letterxpress.LetterXpressAccount({
email: 'myemail@example.com',
@@ -38,13 +22,8 @@ const account = new letterxpress.LetterXpressAccount({
});
```
## Contribution
## Contributing
We are always happy for code contributions. If you are not the code contributing type that is ok. Still, maintaining Open Source repositories takes considerable time and thought. If you like the quality of what we do and our modules are useful to you we would appreciate a little monthly contribution: You can [contribute one time](https://lossless.link/contribute-onetime) or [contribute monthly](https://lossless.link/contribute). :)
Contributions, bug reports, and feature requests are welcome! Please open an issue or submit a pull request at [Code.Foss.Global](https://code.foss.global/apiclient.xyz/letterxpress/issues).
For further information read the linked docs at the top of this readme.
> MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh)
| By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy)
[![repo-footer](https://lossless.gitlab.io/publicrelations/repofooter.svg)](https://maintainedby.lossless.com)
> MIT licensed | © Task Venture Capital GmbH

View File

@@ -1,17 +1,17 @@
import { expect, tap } from '@pushrocks/tapbundle';
import { expect, tap } from '@push.rocks/tapbundle';
import * as letterxpress from '../ts/index.js';
import * as tsclass from '@tsclass/tsclass';
import { Qenv } from '@pushrocks/qenv';
import { Qenv } from '@push.rocks/qenv';
let testQenv = new Qenv('./', './.nogit/');
let testAccount: letterxpress.LetterXpressAccount;
let testLetter: tsclass.business.ILetter;
tap.test('should create a valid account', async () => {
testAccount = await letterxpress.LetterXpressAccount.createAndInit({
apiKey: testQenv.getEnvVarOnDemand('API_TOKEN'),
username: testQenv.getEnvVarOnDemand('API_USERNAME'),
testAccount = await letterxpress.LetterXpressAccount.createAndStart({
apiKey: await testQenv.getEnvVarOnDemand('API_TOKEN'),
username: await testQenv.getEnvVarOnDemand('API_USERNAME'),
});
expect(testAccount).toBeInstanceOf(letterxpress.LetterXpressAccount);
});
@@ -75,31 +75,36 @@ tap.test('should send an actual letter', async () => {
vatId: 'DE293580420',
},
subject: 'General Terms - Update',
text: [
`
To whome it may concern,
**this is a testmessage.** we write to inform you about a change in our General Terms.
As of December 1st 2019 we will start storing IPs that connect to our app for a period of 3 month.
Regards
Lossless GmbH - Legal Department
`,
],
content: {
textData: [`
To whome it may concern,
**this is a testmessage.** we write to inform you about a change in our General Terms.
As of December 1st 2019 we will start storing IPs that connect to our app for a period of 3 month.
Regards
Lossless GmbH - Legal Department
`],
timesheetData: null,
},
date: Date.now(),
language: 'DE',
logoUrl: '',
needsCoverSheet: true,
objectActions: [],
pdfAttachments: [],
timesheetData: null,
type: 'notice',
versionInfo: {
type: 'final',
version: '1.0.0',
}
};
await testAccount.sendLetter(testLetter);
const result = await testAccount.sendLetter(testLetter);
});
tap.test('should be able to delete the sending job', async (toolsArg) => {
await toolsArg.delayFor(3000);
await toolsArg.delayFor(5000);
await testAccount.cancelLetter(testLetter);
});

View File

@@ -1,8 +1,8 @@
/**
* autocreated commitinfo by @pushrocks/commitinfo
* autocreated commitinfo by @push.rocks/commitinfo
*/
export const commitinfo = {
name: '@mojoio/letterxpress',
version: '1.0.13',
name: '@apiclient.xyz/letterxpress',
version: '1.0.22',
description: 'an unofficial API package for the letterxpress API'
}

View File

@@ -1,5 +1,3 @@
import { IObjectAction } from '@tsclass/tsclass/dist_ts/database/objectaction.js';
import * as plugins from './letterxpress.plugins.js';
export interface ILetterXpressConstructorOptions {
@@ -9,16 +7,16 @@ export interface ILetterXpressConstructorOptions {
export class LetterXpressAccount {
// STATIC
public static async createAndInit(optionsArg: ConstructorParameters<typeof LetterXpressAccount>[0]) {
public static async createAndStart(optionsArg: ConstructorParameters<typeof LetterXpressAccount>[0]) {
const letterXpressInstance = new LetterXpressAccount(optionsArg);
await letterXpressInstance.init();
await letterXpressInstance.start();
return letterXpressInstance;
}
// INSTANCE
public baseApiUrl = 'https://api.letterxpress.de/v1';
public baseApiUrl = 'https://api.letterxpress.de/v2';
public options: ILetterXpressConstructorOptions;
public smartletterInstance: plugins.smartletter.Smartletter;
public deesDocumentInstance: plugins.deesDocument.PdfService;
public letterSentObservable = new plugins.smartrx.rxjs.Subject<plugins.tsclass.business.ILetter>();
@@ -27,8 +25,8 @@ export class LetterXpressAccount {
this.options = optionsArg;
}
public async init() {
this.smartletterInstance = await plugins.smartletter.Smartletter.createAndInit();
public async start() {
this.deesDocumentInstance = await plugins.deesDocument.PdfService.createAndStart({});
}
/**
@@ -36,18 +34,17 @@ export class LetterXpressAccount {
* @param letterArg
*/
public async sendLetter(letterArg: plugins.tsclass.business.ILetter) {
const letter = await this.smartletterInstance.createLetterFromData(letterArg);
const pdfToSend = await letter.getCombinedPdf();
const response = await this.request('/setJob', 'POST', {
const pdfToSend = await this.deesDocumentInstance.createPdfFromLetterObject({letterData: letterArg, documentSettings: {}});
const response = await this.request('/printjobs', 'POST', {
letter: {
base64_file: plugins.smartbuffer.arrayBufferToBase64(pdfToSend.buffer),
base64_checksum: await plugins.smarthash.md5FromString(
plugins.smartbuffer.arrayBufferToBase64(pdfToSend.buffer)
base64_file: plugins.smartbuffer.uInt8ArrayToBase64(pdfToSend.buffer),
base64_file_checksum: await plugins.smarthash.md5FromString(
plugins.smartbuffer.uInt8ArrayToBase64(pdfToSend.buffer)
),
specification: {
color: '4',
mode: 'simplex',
ship: letterArg.to.address.country === 'Germany' ? 'national' : 'international',
shipping: letterArg.to.address.country === 'Germany' ? 'national' : 'international',
},
},
});
@@ -55,7 +52,7 @@ export class LetterXpressAccount {
name: 'letterxpress-sent',
message: 'requested letterxpress to send the letter',
privateMessage: null,
data: response.body.letter.job_id,
data: response.body.data.id,
timestamp: Date.now(),
userId: null
})
@@ -74,9 +71,7 @@ export class LetterXpressAccount {
}
public async cancelLetterByProcessingId(processingId: string) {
const response = await this.request(`/deleteJob/${processingId}`, 'DELETE', {
letter: {}
});
const response = await this.request(`/printjobs/${processingId}`, 'DELETE', {});
return response;
}
@@ -88,23 +83,27 @@ export class LetterXpressAccount {
console.log(requestUrl);
const requestData = {
auth: {
mode: "live",
username: this.options.username,
apikey: this.options.apiKey,
},
...payload,
};
// console.log(methodArg);
// console.log(requestData);
const response = await plugins.smartrequest.request(requestUrl, {
method: methodArg,
headers: {
'Content-Type': 'application/json',
},
requestBody: JSON.stringify(requestData),
keepAlive: false,
});
console.log(response.body);
return response;
}
public async stop() {
await this.smartletterInstance.stop();
await this.deesDocumentInstance.stop();
}
}

View File

@@ -1,11 +1,17 @@
import * as smartbuffer from '@pushrocks/smartbuffer';
import * as smarthash from '@pushrocks/smarthash';
import * as smartletter from '@pushrocks/smartletter';
import * as smartpromise from '@pushrocks/smartpromise';
import * as smartrequest from '@pushrocks/smartrequest';
import * as smartrx from '@pushrocks/smartrx';
import * as smartbuffer from '@push.rocks/smartbuffer';
import * as smarthash from '@push.rocks/smarthash';
import * as smartpromise from '@push.rocks/smartpromise';
import * as smartrequest from '@push.rocks/smartrequest';
import * as smartrx from '@push.rocks/smartrx';
export { smartbuffer, smarthash, smartletter, smartpromise, smartrequest, smartrx };
export { smartbuffer, smarthash, smartpromise, smartrequest, smartrx };
// @design.estate scope
import * as deesDocument from '@design.estate/dees-document/node';
export {
deesDocument
}
// tsclass scope
import * as tsclass from '@tsclass/tsclass';

View File

@@ -3,7 +3,12 @@
"experimentalDecorators": true,
"useDefineForClassFields": false,
"target": "ES2022",
"module": "ES2022",
"moduleResolution": "nodenext"
}
"module": "NodeNext",
"moduleResolution": "NodeNext",
"esModuleInterop": true,
"verbatimModuleSyntax": true
},
"exclude": [
"dist_*/**/*.d.ts"
]
}