.gitlab-ci.yml

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

@@ -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.

package.json

@@ -1,6 +1,6 @@
 {
-  "name": "@apiclient.xyz/letterxpress",
+  "name": "@mojoio/letterxpress",
-  "version": "1.0.20",
+  "version": "1.0.12",
   "private": false,
   "description": "an unofficial API package for the letterxpress API",
   "main": "dist_ts/index.js",
@@ -9,26 +9,25 @@
   "license": "MIT",
   "scripts": {
     "test": "(tstest test/)",
-    "build": "(tsbuild --web --allowimplicitany)",
+    "build": "(tsbuild --web)",
     "format": "(gitzone format)",
-    "localPublish": "gitzone commit && pnpm run build && pnpm publish && pnpm publish --access public --registry=\"https://registry.npmjs.org\""
+    "buildDocs": "tsdoc"
   },
   "devDependencies": {
-    "@git.zone/tsbuild": "^2.1.63",
+    "@gitzone/tsbuild": "^2.1.63",
-    "@git.zone/tsrun": "^1.2.46",
+    "@gitzone/tstest": "^1.0.71",
-    "@git.zone/tstest": "^1.0.88",
+    "@pushrocks/qenv": "^4.0.10",
-    "@push.rocks/qenv": "^6.0.5",
+    "@pushrocks/tapbundle": "^5.0.3",
-    "@push.rocks/tapbundle": "^5.0.23",
+    "@types/node": "^18.0.0"
-    "@types/node": "^22.13.10"
   },
   "dependencies": {
-    "@design.estate/dees-document": "^1.0.99",
+    "@pushrocks/smartbuffer": "^1.0.3",
-    "@push.rocks/smartbuffer": "^3.0.4",
+    "@pushrocks/smarthash": "^2.1.10",
-    "@push.rocks/smarthash": "^3.0.1",
+    "@pushrocks/smartletter": "^2.0.12",
-    "@push.rocks/smartpromise": "^4.0.3",
+    "@pushrocks/smartpromise": "^3.1.7",
-    "@push.rocks/smartrequest": "^2.0.22",
+    "@pushrocks/smartrequest": "^1.1.56",
-    "@push.rocks/smartrx": "^3.0.7",
+    "@pushrocks/smartrx": "^2.0.25",
-    "@tsclass/tsclass": "^5.0.0"
+    "@tsclass/tsclass": "^4.0.16"
   },
   "files": [
     "ts/**/*",
@@ -45,12 +44,5 @@
   "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 '@push.rocks/tapbundle';
+import { expect, tap } from '@pushrocks/tapbundle';
 import * as letterxpress from '../ts/index.js';
 import * as tsclass from '@tsclass/tsclass';
 
-import { Qenv } from '@push.rocks/qenv';
+import { Qenv } from '@pushrocks/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({
+  testAccount = await letterxpress.LetterXpressAccount.createAndInit({
-    apiKey: await testQenv.getEnvVarOnDemand('API_TOKEN'),
+    apiKey: testQenv.getEnvVarOnDemand('API_TOKEN'),
-    username: await testQenv.getEnvVarOnDemand('API_USERNAME'),
+    username: testQenv.getEnvVarOnDemand('API_USERNAME'),
   });
   expect(testAccount).toBeInstanceOf(letterxpress.LetterXpressAccount);
 });
@@ -75,36 +75,31 @@ tap.test('should send an actual letter', async () => {
       vatId: 'DE293580420',
     },
     subject: 'General Terms - Update',
-    content: {
+    text: [
-      textData: [`
+      `
-      To whome it may concern, 
+To whome it may concern, 
            
-      **this is a testmessage.** we write to inform you about a change in our General Terms.
+**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.
+As of December 1st 2019 we will start storing IPs that connect to our app for a period of 3 month.
 
-      Regards  
+Regards  
-      Lossless GmbH - Legal Department
+Lossless GmbH - Legal Department
 
-      `],
+`,
-      timesheetData: null,
+    ],
-    },
     date: Date.now(),
     language: 'DE',
     logoUrl: '',
     needsCoverSheet: true,
     objectActions: [],
     pdfAttachments: [],
-    type: 'notice',
+    timesheetData: null,
-    versionInfo: {
-      type: 'final',
-      version: '1.0.0',
-    }
   };
-  const result = await testAccount.sendLetter(testLetter);
+  await testAccount.sendLetter(testLetter);
 });
 
 tap.test('should be able to delete the sending job', async (toolsArg) => {
-  await toolsArg.delayFor(5000);
+  await toolsArg.delayFor(3000);
   await testAccount.cancelLetter(testLetter);
 });
 

ts/00_commitinfo_data.ts

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

ts/letterxpress.classes.account.ts

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

ts/letterxpress.plugins.ts

@@ -1,17 +1,11 @@
-import * as smartbuffer from '@push.rocks/smartbuffer';
+import * as smartbuffer from '@pushrocks/smartbuffer';
-import * as smarthash from '@push.rocks/smarthash';
+import * as smarthash from '@pushrocks/smarthash';
-import * as smartpromise from '@push.rocks/smartpromise';
+import * as smartletter from '@pushrocks/smartletter';
-import * as smartrequest from '@push.rocks/smartrequest';
+import * as smartpromise from '@pushrocks/smartpromise';
-import * as smartrx from '@push.rocks/smartrx';
+import * as smartrequest from '@pushrocks/smartrequest';
+import * as smartrx from '@pushrocks/smartrx';
 
-export { smartbuffer, smarthash, smartpromise, smartrequest, smartrx };
+export { smartbuffer, smarthash, smartletter, 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,12 +3,7 @@
     "experimentalDecorators": true,
     "useDefineForClassFields": false,
     "target": "ES2022",
-    "module": "NodeNext",
+    "module": "ES2022",
-    "moduleResolution": "NodeNext",
+    "moduleResolution": "nodenext"
-    "esModuleInterop": true,
+  }
-    "verbatimModuleSyntax": true
-  },
-  "exclude": [
-    "dist_*/**/*.d.ts"
-  ]
 }