Compare commits
No commits in common. "master" and "v1.0.8" have entirely different histories.
4
.gitignore
vendored
4
.gitignore
vendored
@ -15,6 +15,8 @@ node_modules/
|
|||||||
|
|
||||||
# builds
|
# builds
|
||||||
dist/
|
dist/
|
||||||
dist_*/
|
dist_web/
|
||||||
|
dist_serve/
|
||||||
|
dist_ts_web/
|
||||||
|
|
||||||
# custom
|
# custom
|
||||||
126
.gitlab-ci.yml
Normal file
126
.gitlab-ci.yml
Normal file
@ -0,0 +1,126 @@
|
|||||||
|
# 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
|
||||||
|
|
||||||
|
# ====================
|
||||||
|
# security stage
|
||||||
|
# ====================
|
||||||
|
mirror:
|
||||||
|
stage: security
|
||||||
|
script:
|
||||||
|
- npmci git mirror
|
||||||
|
tags:
|
||||||
|
- lossless
|
||||||
|
- docker
|
||||||
|
- notpriv
|
||||||
|
|
||||||
|
snyk:
|
||||||
|
stage: security
|
||||||
|
script:
|
||||||
|
- npmci npm prepare
|
||||||
|
- npmci command npm install -g snyk
|
||||||
|
- npmci command npm install --ignore-scripts
|
||||||
|
- npmci command snyk test
|
||||||
|
tags:
|
||||||
|
- lossless
|
||||||
|
- docker
|
||||||
|
- notpriv
|
||||||
|
|
||||||
|
# ====================
|
||||||
|
# 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:
|
||||||
|
- lossless
|
||||||
|
- docker
|
||||||
|
- priv
|
||||||
|
|
||||||
|
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:
|
||||||
|
- lossless
|
||||||
|
- docker
|
||||||
|
- notpriv
|
||||||
|
|
||||||
|
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
|
||||||
|
script:
|
||||||
|
- npmci command npm install -g tslint typescript
|
||||||
|
- npmci npm prepare
|
||||||
|
- npmci npm install
|
||||||
|
- npmci command "tslint -c tslint.json ./ts/**/*.ts"
|
||||||
|
tags:
|
||||||
|
- lossless
|
||||||
|
- docker
|
||||||
|
- priv
|
||||||
|
|
||||||
|
trigger:
|
||||||
|
stage: metadata
|
||||||
|
script:
|
||||||
|
- npmci trigger
|
||||||
|
only:
|
||||||
|
- tags
|
||||||
|
tags:
|
||||||
|
- lossless
|
||||||
|
- docker
|
||||||
|
- notpriv
|
||||||
|
|
||||||
|
pages:
|
||||||
|
stage: metadata
|
||||||
|
script:
|
||||||
|
- npmci node install lts
|
||||||
|
- npmci command npm install -g @gitzone/tsdoc
|
||||||
|
- npmci npm prepare
|
||||||
|
- npmci npm install
|
||||||
|
- npmci command tsdoc
|
||||||
|
tags:
|
||||||
|
- lossless
|
||||||
|
- docker
|
||||||
|
- notpriv
|
||||||
|
only:
|
||||||
|
- tags
|
||||||
|
artifacts:
|
||||||
|
expire_in: 1 week
|
||||||
|
paths:
|
||||||
|
- public
|
||||||
|
allow_failure: true
|
||||||
24
.vscode/launch.json
vendored
24
.vscode/launch.json
vendored
@ -2,10 +2,28 @@
|
|||||||
"version": "0.2.0",
|
"version": "0.2.0",
|
||||||
"configurations": [
|
"configurations": [
|
||||||
{
|
{
|
||||||
"command": "npm test",
|
"name": "current file",
|
||||||
"name": "Run npm test",
|
"type": "node",
|
||||||
"request": "launch",
|
"request": "launch",
|
||||||
"type": "node-terminal"
|
"args": [
|
||||||
|
"${relativeFile}"
|
||||||
|
],
|
||||||
|
"runtimeArgs": ["-r", "@gitzone/tsrun"],
|
||||||
|
"cwd": "${workspaceRoot}",
|
||||||
|
"protocol": "inspector",
|
||||||
|
"internalConsoleOptions": "openOnSessionStart"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"name": "test.ts",
|
||||||
|
"type": "node",
|
||||||
|
"request": "launch",
|
||||||
|
"args": [
|
||||||
|
"test/test.ts"
|
||||||
|
],
|
||||||
|
"runtimeArgs": ["-r", "@gitzone/tsrun"],
|
||||||
|
"cwd": "${workspaceRoot}",
|
||||||
|
"protocol": "inspector",
|
||||||
|
"internalConsoleOptions": "openOnSessionStart"
|
||||||
}
|
}
|
||||||
]
|
]
|
||||||
}
|
}
|
||||||
|
|||||||
8
.vscode/settings.json
vendored
8
.vscode/settings.json
vendored
@ -11,13 +11,7 @@
|
|||||||
},
|
},
|
||||||
"gitzone": {
|
"gitzone": {
|
||||||
"type": "object",
|
"type": "object",
|
||||||
"description": "settings for gitzone",
|
"description": "settings for gitzone"
|
||||||
"properties": {
|
|
||||||
"projectType": {
|
|
||||||
"type": "string",
|
|
||||||
"enum": ["website", "element", "service", "npm", "wcc"]
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
104
changelog.md
104
changelog.md
@ -1,104 +0,0 @@
|
|||||||
# Changelog
|
|
||||||
|
|
||||||
## 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.
|
|
||||||
@ -1,11 +1,10 @@
|
|||||||
{
|
{
|
||||||
"gitzone": {
|
"gitzone": {
|
||||||
"projectType": "npm",
|
|
||||||
"module": {
|
"module": {
|
||||||
"githost": "gitlab.com",
|
"githost": "gitlab.com",
|
||||||
"gitscope": "mojoio",
|
"gitscope": "mojoio",
|
||||||
"gitrepo": "letterxpress",
|
"gitrepo": "letterxpress",
|
||||||
"description": "an unofficial API package for the letterxpress API",
|
"shortDescription": "an unofficial API package for the letterxpress API",
|
||||||
"npmPackagename": "@mojoio/letterxpress",
|
"npmPackagename": "@mojoio/letterxpress",
|
||||||
"license": "MIT",
|
"license": "MIT",
|
||||||
"projectDomain": "mojo.io"
|
"projectDomain": "mojo.io"
|
||||||
|
|||||||
3405
package-lock.json
generated
Normal file
3405
package-lock.json
generated
Normal file
File diff suppressed because it is too large
Load Diff
52
package.json
52
package.json
@ -1,56 +1,40 @@
|
|||||||
{
|
{
|
||||||
"name": "@apiclient.xyz/letterxpress",
|
"name": "@mojoio/letterxpress",
|
||||||
"version": "1.0.20",
|
"version": "1.0.8",
|
||||||
"private": false,
|
"private": false,
|
||||||
"description": "an unofficial API package for the letterxpress API",
|
"description": "an unofficial API package for the letterxpress API",
|
||||||
"main": "dist_ts/index.js",
|
"main": "dist/index.js",
|
||||||
"typings": "dist_ts/index.d.ts",
|
"typings": "dist/index.d.ts",
|
||||||
"author": "Lossless GmbH",
|
"author": "Lossless GmbH",
|
||||||
"license": "MIT",
|
"license": "MIT",
|
||||||
"scripts": {
|
"scripts": {
|
||||||
"test": "(tstest test/)",
|
"test": "(tstest test/)",
|
||||||
"build": "(tsbuild --web --allowimplicitany)",
|
"build": "(tsbuild)",
|
||||||
"format": "(gitzone format)",
|
"format": "(gitzone format)"
|
||||||
"localPublish": "gitzone commit && pnpm run build && pnpm publish && pnpm publish --access public --registry=\"https://registry.npmjs.org\""
|
|
||||||
},
|
},
|
||||||
"devDependencies": {
|
"devDependencies": {
|
||||||
"@git.zone/tsbuild": "^2.1.63",
|
"@gitzone/tsbuild": "^2.0.22",
|
||||||
"@git.zone/tsrun": "^1.2.46",
|
"@gitzone/tstest": "^1.0.15",
|
||||||
"@git.zone/tstest": "^1.0.88",
|
"@pushrocks/qenv": "^4.0.6",
|
||||||
"@push.rocks/qenv": "^6.0.5",
|
"@pushrocks/tapbundle": "^3.2.0",
|
||||||
"@push.rocks/tapbundle": "^5.0.23",
|
"@types/node": "^12.12.11",
|
||||||
"@types/node": "^22.13.10"
|
"tslint": "^5.11.0",
|
||||||
|
"tslint-config-prettier": "^1.15.0"
|
||||||
},
|
},
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"@design.estate/dees-document": "^1.0.99",
|
"@pushrocks/smartletter": "^1.0.15",
|
||||||
"@push.rocks/smartbuffer": "^3.0.4",
|
"@pushrocks/smartrequest": "^1.1.42",
|
||||||
"@push.rocks/smarthash": "^3.0.1",
|
"@pushrocks/smartrx": "^2.0.5"
|
||||||
"@push.rocks/smartpromise": "^4.0.3",
|
|
||||||
"@push.rocks/smartrequest": "^2.0.22",
|
|
||||||
"@push.rocks/smartrx": "^3.0.7",
|
|
||||||
"@tsclass/tsclass": "^5.0.0"
|
|
||||||
},
|
},
|
||||||
"files": [
|
"files": [
|
||||||
"ts/**/*",
|
"ts/**/*",
|
||||||
"ts_web/**/*",
|
"ts_web/**/*",
|
||||||
"dist/**/*",
|
"dist/**/*",
|
||||||
"dist_*/**/*",
|
"dist_web/**/*",
|
||||||
"dist_ts/**/*",
|
|
||||||
"dist_ts_web/**/*",
|
"dist_ts_web/**/*",
|
||||||
"assets/**/*",
|
"assets/**/*",
|
||||||
"cli.js",
|
"cli.js",
|
||||||
"npmextra.json",
|
"npmextra.json",
|
||||||
"readme.md"
|
"readme.md"
|
||||||
],
|
]
|
||||||
"type": "module",
|
|
||||||
"browserslist": [
|
|
||||||
"last 1 chrome versions"
|
|
||||||
],
|
|
||||||
"pnpm": {
|
|
||||||
"onlyBuiltDependencies": [
|
|
||||||
"esbuild",
|
|
||||||
"mongodb-memory-server",
|
|
||||||
"puppeteer"
|
|
||||||
]
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|||||||
10054
pnpm-lock.yaml
generated
10054
pnpm-lock.yaml
generated
File diff suppressed because it is too large
Load Diff
2
qenv.yml
2
qenv.yml
@ -1,3 +1,3 @@
|
|||||||
required:
|
required:
|
||||||
- API_USERNAME
|
- API_EMAIL
|
||||||
- API_TOKEN
|
- API_TOKEN
|
||||||
|
|||||||
27
readme.md
27
readme.md
@ -8,20 +8,13 @@ an unofficial API package for the letterxpress API
|
|||||||
* [docs (typedoc)](https://mojoio.gitlab.io/letterxpress/)
|
* [docs (typedoc)](https://mojoio.gitlab.io/letterxpress/)
|
||||||
|
|
||||||
## Status for master
|
## Status for master
|
||||||
|
[](https://gitlab.com/mojoio/letterxpress/commits/master)
|
||||||
Status Category | Status Badge
|
[](https://gitlab.com/mojoio/letterxpress/commits/master)
|
||||||
-- | --
|
[](https://www.npmjs.com/package/@mojoio/letterxpress)
|
||||||
GitLab Pipelines | [](https://lossless.cloud)
|
[](https://snyk.io/test/npm/@mojoio/letterxpress)
|
||||||
GitLab Pipline Test Coverage | [](https://lossless.cloud)
|
[](https://nodejs.org/dist/latest-v10.x/docs/api/)
|
||||||
npm | [](https://lossless.cloud)
|
[](https://nodejs.org/dist/latest-v10.x/docs/api/)
|
||||||
Snyk | [](https://lossless.cloud)
|
[](https://prettier.io/)
|
||||||
TypeScript Support | [](https://lossless.cloud)
|
|
||||||
node Support | [](https://nodejs.org/dist/latest-v10.x/docs/api/)
|
|
||||||
Code Style | [](https://lossless.cloud)
|
|
||||||
PackagePhobia (total standalone install weight) | [](https://lossless.cloud)
|
|
||||||
PackagePhobia (package size on registry) | [](https://lossless.cloud)
|
|
||||||
BundlePhobia (total size when bundled) | [](https://lossless.cloud)
|
|
||||||
Platform support | [](https://lossless.cloud) [](https://lossless.cloud)
|
|
||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
|
|
||||||
@ -30,12 +23,12 @@ Use TypeScript for best in class intellisense.
|
|||||||
letterxpress implements the LXP API documented here: [LXP API Documentation](https://www.letterxpress.de/briefe-uebertragen/api)
|
letterxpress implements the LXP API documented here: [LXP API Documentation](https://www.letterxpress.de/briefe-uebertragen/api)
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
import * as letterxpress from '@mojoio/letterxpress';
|
import * as letterxpress from '@mojoio/letterxpress'
|
||||||
|
|
||||||
const account = new letterxpress.LetterXpressAccount({
|
const account = new letterxpress.LetterXpressAccount({
|
||||||
email: 'myemail@example.com',
|
email: 'myemail@example.com',
|
||||||
apiToken: 'abcdefghijklmnop1234567890',
|
apiToken: 'abcdefghijklmnop1234567890'
|
||||||
});
|
})
|
||||||
```
|
```
|
||||||
|
|
||||||
## Contribution
|
## Contribution
|
||||||
|
|||||||
@ -1,116 +0,0 @@
|
|||||||
import { expect, tap } from '@push.rocks/tapbundle';
|
|
||||||
import * as letterxpress from '../ts/index.js';
|
|
||||||
import * as tsclass from '@tsclass/tsclass';
|
|
||||||
|
|
||||||
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.createAndStart({
|
|
||||||
apiKey: await testQenv.getEnvVarOnDemand('API_TOKEN'),
|
|
||||||
username: await testQenv.getEnvVarOnDemand('API_USERNAME'),
|
|
||||||
});
|
|
||||||
expect(testAccount).toBeInstanceOf(letterxpress.LetterXpressAccount);
|
|
||||||
});
|
|
||||||
|
|
||||||
tap.test('should send an actual letter', async () => {
|
|
||||||
testLetter = {
|
|
||||||
from: {
|
|
||||||
name: 'Lossless GmbH',
|
|
||||||
type: 'company',
|
|
||||||
description: 'a company',
|
|
||||||
sepaConnection: {
|
|
||||||
iban: 'NL83 BUNQ 2035 5639 41',
|
|
||||||
bic: 'BUNQNL2AXXX',
|
|
||||||
},
|
|
||||||
address: {
|
|
||||||
name: 'default',
|
|
||||||
city: 'Bremen',
|
|
||||||
country: 'Germany',
|
|
||||||
postalCode: '28359',
|
|
||||||
houseNumber: '5',
|
|
||||||
streetName: 'Karl-Ferdinand-Braun-Str.',
|
|
||||||
},
|
|
||||||
},
|
|
||||||
to: {
|
|
||||||
name: 'Lossless GmbH',
|
|
||||||
type: 'company',
|
|
||||||
description: 'a company',
|
|
||||||
address: {
|
|
||||||
city: 'Bremen',
|
|
||||||
country: 'Germany',
|
|
||||||
postalCode: '28359',
|
|
||||||
streetName: 'Karl-Ferdinand-Braun-Str.',
|
|
||||||
houseNumber: '5',
|
|
||||||
},
|
|
||||||
},
|
|
||||||
incidenceId: 'abc123',
|
|
||||||
legalContact: {
|
|
||||||
type: 'company',
|
|
||||||
salutation: null,
|
|
||||||
surname: null,
|
|
||||||
title: null,
|
|
||||||
address: {
|
|
||||||
city: 'Bremen',
|
|
||||||
country: 'Germany',
|
|
||||||
name: 'Lossless GmbH',
|
|
||||||
postalCode: '28359',
|
|
||||||
streetName: 'Karl-Ferdinand-Braun-Str.',
|
|
||||||
houseNumber: '5',
|
|
||||||
},
|
|
||||||
sepaConnection: {
|
|
||||||
iban: 'NL83 BUNQ 2035 5639 41',
|
|
||||||
bic: 'BUNQNL2AXXX',
|
|
||||||
},
|
|
||||||
customerNumber: null,
|
|
||||||
description: null,
|
|
||||||
email: 'hello@lossless.com',
|
|
||||||
fax: '+49 421 408951 46',
|
|
||||||
phone: '+49 421 16767 548',
|
|
||||||
legalEntity: 'Lossless GmbH',
|
|
||||||
name: 'Lossless GmbH',
|
|
||||||
vatId: 'DE293580420',
|
|
||||||
},
|
|
||||||
subject: 'General Terms - Update',
|
|
||||||
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: [],
|
|
||||||
type: 'notice',
|
|
||||||
versionInfo: {
|
|
||||||
type: 'final',
|
|
||||||
version: '1.0.0',
|
|
||||||
}
|
|
||||||
};
|
|
||||||
const result = await testAccount.sendLetter(testLetter);
|
|
||||||
});
|
|
||||||
|
|
||||||
tap.test('should be able to delete the sending job', async (toolsArg) => {
|
|
||||||
await toolsArg.delayFor(5000);
|
|
||||||
await testAccount.cancelLetter(testLetter);
|
|
||||||
});
|
|
||||||
|
|
||||||
tap.test('should wrap things up', async () => {
|
|
||||||
await testAccount.stop();
|
|
||||||
console.log(testLetter);
|
|
||||||
});
|
|
||||||
|
|
||||||
tap.start();
|
|
||||||
17
test/test.ts
Normal file
17
test/test.ts
Normal file
@ -0,0 +1,17 @@
|
|||||||
|
import { expect, tap } from '@pushrocks/tapbundle';
|
||||||
|
import * as letterxpress from '../ts/index';
|
||||||
|
|
||||||
|
import { Qenv } from '@pushrocks/qenv';
|
||||||
|
let testQenv = new Qenv('./', './.nogit/');
|
||||||
|
|
||||||
|
let testAccount: letterxpress.LetterXpressAccount;
|
||||||
|
|
||||||
|
tap.test('should create a valid account', async () => {
|
||||||
|
testAccount = new letterxpress.LetterXpressAccount({
|
||||||
|
apiKey: testQenv.getEnvVarOnDemand('API_TOKEN'),
|
||||||
|
email: testQenv.getEnvVarOnDemand('API_EMAIL')
|
||||||
|
});
|
||||||
|
expect(testAccount).to.be.instanceOf(letterxpress.LetterXpressAccount);
|
||||||
|
});
|
||||||
|
|
||||||
|
tap.start();
|
||||||
@ -1,8 +0,0 @@
|
|||||||
/**
|
|
||||||
* autocreated commitinfo by @push.rocks/commitinfo
|
|
||||||
*/
|
|
||||||
export const commitinfo = {
|
|
||||||
name: '@apiclient.xyz/letterxpress',
|
|
||||||
version: '1.0.20',
|
|
||||||
description: 'an unofficial API package for the letterxpress API'
|
|
||||||
}
|
|
||||||
@ -1 +1 @@
|
|||||||
export * from './letterxpress.classes.account.js';
|
export * from './letterxpress.classes.account';
|
||||||
|
|||||||
@ -1,109 +1,47 @@
|
|||||||
import * as plugins from './letterxpress.plugins.js';
|
import * as plugins from './letterxpress.plugins';
|
||||||
|
|
||||||
export interface ILetterXpressConstructorOptions {
|
export interface ILetterXpressConstructorOptions {
|
||||||
username: string;
|
email: string;
|
||||||
apiKey: string;
|
apiKey: string;
|
||||||
}
|
}
|
||||||
|
|
||||||
export class LetterXpressAccount {
|
export class LetterXpressAccount {
|
||||||
// STATIC
|
public baseApiUrl = 'https://api.letterxpress.de/v1/';
|
||||||
public static async createAndStart(optionsArg: ConstructorParameters<typeof LetterXpressAccount>[0]) {
|
|
||||||
const letterXpressInstance = new LetterXpressAccount(optionsArg);
|
|
||||||
await letterXpressInstance.start();
|
|
||||||
return letterXpressInstance;
|
|
||||||
}
|
|
||||||
|
|
||||||
// INSTANCE
|
|
||||||
public baseApiUrl = 'https://api.letterxpress.de/v2';
|
|
||||||
public options: ILetterXpressConstructorOptions;
|
public options: ILetterXpressConstructorOptions;
|
||||||
public deesDocumentInstance: plugins.deesDocument.PdfService;
|
|
||||||
|
|
||||||
public letterSentObservable = new plugins.smartrx.rxjs.Subject<plugins.tsclass.business.ILetter>();
|
public letterSentObservable = new plugins.smartrx.rxjs.Subject<plugins.smartletter.Letter>();
|
||||||
|
|
||||||
constructor(optionsArg: ILetterXpressConstructorOptions) {
|
constructor(optionsArg: ILetterXpressConstructorOptions) {
|
||||||
const done = plugins.smartpromise.defer();
|
|
||||||
this.options = optionsArg;
|
this.options = optionsArg;
|
||||||
}
|
}
|
||||||
|
|
||||||
public async start() {
|
|
||||||
this.deesDocumentInstance = await plugins.deesDocument.PdfService.createAndStart({});
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* sends a letter
|
* sends a letter
|
||||||
* @param letterArg
|
* @param letterArg
|
||||||
*/
|
*/
|
||||||
public async sendLetter(letterArg: plugins.tsclass.business.ILetter) {
|
public async sendLetter(letterArg: plugins.smartletter.Letter) {
|
||||||
const pdfToSend = await this.deesDocumentInstance.createPdfFromLetterObject({letterData: letterArg, documentSettings: {}});
|
const letterPdfResult = await letterArg.getPdfResult();
|
||||||
const response = await this.request('/printjobs', 'POST', {
|
const response = await this.request('/setJob', 'POST', {});
|
||||||
letter: {
|
|
||||||
base64_file: plugins.smartbuffer.uInt8ArrayToBase64(pdfToSend.buffer),
|
|
||||||
base64_file_checksum: await plugins.smarthash.md5FromString(
|
|
||||||
plugins.smartbuffer.uInt8ArrayToBase64(pdfToSend.buffer)
|
|
||||||
),
|
|
||||||
specification: {
|
|
||||||
color: '4',
|
|
||||||
mode: 'simplex',
|
|
||||||
shipping: letterArg.to.address.country === 'Germany' ? 'national' : 'international',
|
|
||||||
},
|
|
||||||
},
|
|
||||||
});
|
|
||||||
letterArg.objectActions.push({
|
|
||||||
name: 'letterxpress-sent',
|
|
||||||
message: 'requested letterxpress to send the letter',
|
|
||||||
privateMessage: null,
|
|
||||||
data: response.body.data.id,
|
|
||||||
timestamp: Date.now(),
|
|
||||||
userId: null
|
|
||||||
})
|
|
||||||
return letterArg;
|
|
||||||
}
|
|
||||||
|
|
||||||
public async cancelLetter(letterArg: plugins.tsclass.business.ILetter) {
|
|
||||||
const processingId = letterArg.objectActions.reduce<string>((previousVal, currentVal) => {
|
|
||||||
if (currentVal.name === 'letterxpress-sent') {
|
|
||||||
return currentVal.data
|
|
||||||
} else {
|
|
||||||
return previousVal;
|
|
||||||
}
|
|
||||||
}, null);
|
|
||||||
return await this.cancelLetterByProcessingId(processingId);
|
|
||||||
}
|
|
||||||
|
|
||||||
public async cancelLetterByProcessingId(processingId: string) {
|
|
||||||
const response = await this.request(`/printjobs/${processingId}`, 'DELETE', {});
|
|
||||||
return response;
|
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* fires the request
|
* fires the request
|
||||||
*/
|
*/
|
||||||
private async request(routeArg: string, methodArg: 'GET' | 'POST' | 'DELETE', payload: any) {
|
private async request(routeArg: string, methodArg: 'GET' | 'POST', payload?: any) {
|
||||||
const requestUrl = `${this.baseApiUrl}${routeArg}`;
|
const requestUrl = `${this.baseApiUrl}`;
|
||||||
console.log(requestUrl);
|
|
||||||
const requestData = {
|
const requestData = {
|
||||||
auth: {
|
auth: {
|
||||||
mode: "live",
|
username: this.options.email,
|
||||||
username: this.options.username,
|
apikey: this.options.apiKey
|
||||||
apikey: this.options.apiKey,
|
|
||||||
},
|
},
|
||||||
...payload,
|
...payload
|
||||||
};
|
};
|
||||||
// console.log(methodArg);
|
const response = await plugins.smartrequest.request(routeArg, {
|
||||||
// console.log(requestData);
|
|
||||||
const response = await plugins.smartrequest.request(requestUrl, {
|
|
||||||
method: methodArg,
|
method: methodArg,
|
||||||
headers: {
|
headers: {
|
||||||
'Content-Type': 'application/json',
|
'Content-Type': 'application/json'
|
||||||
},
|
},
|
||||||
requestBody: JSON.stringify(requestData),
|
requestBody: JSON.stringify(requestData)
|
||||||
keepAlive: false,
|
|
||||||
});
|
});
|
||||||
console.log(response.body);
|
|
||||||
return response;
|
|
||||||
}
|
|
||||||
|
|
||||||
public async stop() {
|
|
||||||
await this.deesDocumentInstance.stop();
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@ -1,21 +1,5 @@
|
|||||||
import * as smartbuffer from '@push.rocks/smartbuffer';
|
import * as smartletter from '@pushrocks/smartletter';
|
||||||
import * as smarthash from '@push.rocks/smarthash';
|
import * as smartrequest from '@pushrocks/smartrequest';
|
||||||
import * as smartpromise from '@push.rocks/smartpromise';
|
import * as smartrx from '@pushrocks/smartrx';
|
||||||
import * as smartrequest from '@push.rocks/smartrequest';
|
|
||||||
import * as smartrx from '@push.rocks/smartrx';
|
|
||||||
|
|
||||||
export { smartbuffer, smarthash, smartpromise, smartrequest, smartrx };
|
export { smartletter, smartrequest, smartrx };
|
||||||
|
|
||||||
// @design.estate scope
|
|
||||||
import * as deesDocument from '@design.estate/dees-document/node';
|
|
||||||
|
|
||||||
export {
|
|
||||||
deesDocument
|
|
||||||
}
|
|
||||||
|
|
||||||
// tsclass scope
|
|
||||||
import * as tsclass from '@tsclass/tsclass';
|
|
||||||
|
|
||||||
export {
|
|
||||||
tsclass
|
|
||||||
}
|
|
||||||
|
|||||||
@ -1,14 +0,0 @@
|
|||||||
{
|
|
||||||
"compilerOptions": {
|
|
||||||
"experimentalDecorators": true,
|
|
||||||
"useDefineForClassFields": false,
|
|
||||||
"target": "ES2022",
|
|
||||||
"module": "NodeNext",
|
|
||||||
"moduleResolution": "NodeNext",
|
|
||||||
"esModuleInterop": true,
|
|
||||||
"verbatimModuleSyntax": true
|
|
||||||
},
|
|
||||||
"exclude": [
|
|
||||||
"dist_*/**/*.d.ts"
|
|
||||||
]
|
|
||||||
}
|
|
||||||
17
tslint.json
Normal file
17
tslint.json
Normal file
@ -0,0 +1,17 @@
|
|||||||
|
{
|
||||||
|
"extends": ["tslint:latest", "tslint-config-prettier"],
|
||||||
|
"rules": {
|
||||||
|
"semicolon": [true, "always"],
|
||||||
|
"no-console": false,
|
||||||
|
"ordered-imports": false,
|
||||||
|
"object-literal-sort-keys": false,
|
||||||
|
"member-ordering": {
|
||||||
|
"options":{
|
||||||
|
"order": [
|
||||||
|
"static-method"
|
||||||
|
]
|
||||||
|
}
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"defaultSeverity": "warning"
|
||||||
|
}
|
||||||
Loading…
x
Reference in New Issue
Block a user