Compare commits
6 Commits
679d1cf9c4
...
master
| Author | SHA1 | Date | |
|---|---|---|---|
| c52e4e873b | |||
| dcff81b4cc | |||
| 6b73313bbc | |||
| d58f21f5de | |||
| 4c13cae34d | |||
| f800d61576 |
139
.gitlab-ci.yml
139
.gitlab-ci.yml
@@ -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
118
changelog.md
Normal 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.
|
||||
@@ -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
|
||||
@@ -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": {
|
||||
|
||||
14464
package-lock.json
generated
14464
package-lock.json
generated
File diff suppressed because it is too large
Load Diff
28
package.json
28
package.json
@@ -1,12 +1,20 @@
|
||||
{
|
||||
"name": "@apiclient.xyz/letterxpress",
|
||||
"version": "1.0.19",
|
||||
"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 --allowimplicitany)",
|
||||
@@ -19,16 +27,16 @@
|
||||
"@git.zone/tstest": "^1.0.88",
|
||||
"@push.rocks/qenv": "^6.0.5",
|
||||
"@push.rocks/tapbundle": "^5.0.23",
|
||||
"@types/node": "^20.12.7"
|
||||
"@types/node": "^22.13.10"
|
||||
},
|
||||
"dependencies": {
|
||||
"@design.estate/dees-document": "^1.0.99",
|
||||
"@push.rocks/smartbuffer": "^2.0.1",
|
||||
"@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": "^4.0.54"
|
||||
"@tsclass/tsclass": "^5.0.0"
|
||||
},
|
||||
"files": [
|
||||
"ts/**/*",
|
||||
@@ -45,5 +53,13 @@
|
||||
"type": "module",
|
||||
"browserslist": [
|
||||
"last 1 chrome versions"
|
||||
]
|
||||
],
|
||||
"pnpm": {
|
||||
"onlyBuiltDependencies": [
|
||||
"esbuild",
|
||||
"mongodb-memory-server",
|
||||
"puppeteer"
|
||||
]
|
||||
},
|
||||
"packageManager": "pnpm@10.7.0+sha512.6b865ad4b62a1d9842b61d674a393903b871d9244954f652b8842c2b553c72176b278f64c463e52d40fff8aba385c235c8c9ecf5cc7de4fd78b8bb6d49633ab6"
|
||||
}
|
||||
|
||||
11830
pnpm-lock.yaml
generated
11830
pnpm-lock.yaml
generated
File diff suppressed because it is too large
Load Diff
0
readme.hints.md
Normal file
0
readme.hints.md
Normal file
39
readme.md
39
readme.md
@@ -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 | [](https://lossless.cloud)
|
||||
GitLab Pipline Test Coverage | [](https://lossless.cloud)
|
||||
npm | [](https://lossless.cloud)
|
||||
Snyk | [](https://lossless.cloud)
|
||||
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
|
||||
|
||||
@@ -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)
|
||||
|
||||
[](https://maintainedby.lossless.com)
|
||||
> MIT licensed | © Task Venture Capital GmbH
|
||||
|
||||
@@ -1,8 +1,8 @@
|
||||
/**
|
||||
* autocreated commitinfo by @pushrocks/commitinfo
|
||||
* autocreated commitinfo by @push.rocks/commitinfo
|
||||
*/
|
||||
export const commitinfo = {
|
||||
name: '@apiclient.xyz/letterxpress',
|
||||
version: '1.0.19',
|
||||
version: '1.0.22',
|
||||
description: 'an unofficial API package for the letterxpress API'
|
||||
}
|
||||
|
||||
@@ -34,7 +34,7 @@ export class LetterXpressAccount {
|
||||
* @param letterArg
|
||||
*/
|
||||
public async sendLetter(letterArg: plugins.tsclass.business.ILetter) {
|
||||
const pdfToSend = await this.deesDocumentInstance.createPdfFromLetterObject(letterArg);
|
||||
const pdfToSend = await this.deesDocumentInstance.createPdfFromLetterObject({letterData: letterArg, documentSettings: {}});
|
||||
const response = await this.request('/printjobs', 'POST', {
|
||||
letter: {
|
||||
base64_file: plugins.smartbuffer.uInt8ArrayToBase64(pdfToSend.buffer),
|
||||
|
||||
@@ -7,7 +7,7 @@ import * as smartrx from '@push.rocks/smartrx';
|
||||
export { smartbuffer, smarthash, smartpromise, smartrequest, smartrx };
|
||||
|
||||
// @design.estate scope
|
||||
import * as deesDocument from '@design.estate/dees-document/ts';
|
||||
import * as deesDocument from '@design.estate/dees-document/node';
|
||||
|
||||
export {
|
||||
deesDocument
|
||||
|
||||
Reference in New Issue
Block a user