1.0.20

.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

changelog.md

@@ -0,0 +1,104 @@
+# 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.

package.json

@@ -1,6 +1,6 @@
 {
-  "name": "@mojoio/letterxpress",
-  "version": "1.0.15",
+  "name": "@apiclient.xyz/letterxpress",
+  "version": "1.0.20",
   "private": false,
   "description": "an unofficial API package for the letterxpress API",
   "main": "dist_ts/index.js",
@@ -11,23 +11,24 @@
     "test": "(tstest test/)",
     "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": "^3.0.1",
-    "@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 +45,12 @@
   "type": "module",
   "browserslist": [
     "last 1 chrome versions"
-  ]
+  ],
+  "pnpm": {
+    "onlyBuiltDependencies": [
+      "esbuild",
+      "mongodb-memory-server",
+      "puppeteer"
+    ]
+  }
 }

test/test.nonci.ts

@@ -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);
 });
 

ts/00_commitinfo_data.ts

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

ts/letterxpress.classes.account.ts

@@ -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();
   }
 }

ts/letterxpress.plugins.ts

@@ -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';

tsconfig.json

@@ -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"
+  ]
 }