4.0.19

.gitlab-ci.yml

@@ -122,11 +122,10 @@ trigger:
 pages:
   stage: metadata
   script:
-    - npmci node install lts
-    - npmci command npm install -g @gitzone/tsdoc
+    - npmci node install stable 
     - npmci npm prepare
     - npmci npm install
-    - npmci command tsdoc
+    - npmci command npm run buildDocs
   tags:
     - lossless
     - docker

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tsclass/tsclass",
-  "version": "4.0.4",
+  "version": "4.0.19",
   "private": false,
   "description": "common classes for TypeScript",
   "main": "dist_ts/index.js",
@@ -8,7 +8,8 @@
   "type": "module",
   "scripts": {
     "test": "tstest test/",
-    "build": "(tsbuild --web)"
+    "build": "(tsbuild --web)",
+    "buildDocs": "tsdoc"
   },
   "repository": {
     "type": "git",
@@ -25,13 +26,13 @@
   },
   "homepage": "https://github.com/tsclass/tsclass#readme",
   "dependencies": {
-    "type-fest": "^2.13.0"
+    "type-fest": "^2.18.0"
   },
   "devDependencies": {
-    "@gitzone/tsbuild": "^2.1.63",
-    "@gitzone/tsrun": "^1.2.35",
-    "@gitzone/tstest": "^1.0.71",
-    "@pushrocks/tapbundle": "^5.0.3",
+    "@gitzone/tsbuild": "^2.1.65",
+    "@gitzone/tsrun": "^1.2.37",
+    "@gitzone/tstest": "^1.0.73",
+    "@pushrocks/tapbundle": "^5.0.4",
     "tslint": "^6.1.3",
     "tslint-config-prettier": "^1.18.0"
   },

ts/00_commitinfo_data.ts

@@ -3,6 +3,6 @@
  */
 export const commitinfo = {
   name: '@tsclass/tsclass',
-  version: '4.0.4',
+  version: '4.0.19',
   description: 'common classes for TypeScript'
 }

ts/business/index.ts

@@ -2,4 +2,5 @@ export * from './address.js';
 export * from './company.js';
 export * from './contact.js';
 export * from './letter.js';
+export * from './pdf.js';
 export * from './person.js';

ts/business/letter.ts

@@ -1,21 +1,26 @@
 import * as business from './index.js';
 import * as finance from '../finance/index.js';
+import * as database from '../database/index.js';
+import type { TypedArray } from 'type-fest';
 export interface ILetter {
   incidenceId: string;
   date: number;
   from: business.IContact;
   to: business.IContact;
+  legalContact: business.IContact;
   logoUrl: string;
-  accentColor: string;
   subject: string;
   text: string[];
+  accentColor?: string;
+  needsCoverSheet: boolean;
   invoiceData?: finance.IInvoice;
   contractData?: {
     id: string;
     contractDate: number;
   };
   timesheetData: string;
-  pdfAttachments: Uint8Array[];
-  legalContact: business.IContact;
+  pdf?: business.IPdf;
+  pdfAttachments: business.IPdf[];
   language: string;
+  objectActions: database.IObjectAction[];
 }

ts/business/pdf.ts

@@ -0,0 +1,8 @@
+export interface IPdf {
+  name: string;
+  id: string;
+  metadata: {
+      textExtraction: string;
+  };
+  buffer: ArrayBufferLike;
+}

ts/content/article.ts

@@ -1,5 +1,11 @@
 import { content } from '../index.js';
 
+/**
+ * a general content article:
+ * * can be news
+ * * can be a productdescription,
+ * * can be anything that has text with a title
+ */
 export interface IArticle<T = any> {
   /**
    * the main url of an article

ts/content/author.ts

@@ -1,5 +1,8 @@
 import { general, content } from '../index.js';
 
+/**
+ * answers the question "Who wrote that?"
+ */
 export interface IAuthor {
   /**
    * the first name of an author

ts/content/documentationset.ts

@@ -1,4 +1,8 @@
-import { IArticle } from "./article.js";
+import { IArticle } from './article.js';
+
+/**
+ * a set of articles that together form a body of documentation
+ */
 export interface IDocumentationSet {
   id: string;
   creationTimestamp: number;

ts/database/index.ts

@@ -1,22 +1,3 @@
-export interface IMongoDescriptor {
-  /**
-   * the URL to connect to
-   */
-  mongoDbUrl: string;
-
-  /**
-   * the db to use for the project
-   */
-  mongoDbName?: string;
-
-  /**
-   * a username to use to connect to the database
-   */
-
-  mongoDbUser?: string;
-
-  /**
-   * an optional password that will be replace <PASSWORD> in the connection string
-   */
-  mongoDbPass?: string;
-}
+export * from './mongodescriptor.js';
+export * from './objectaction.js';
+export * from './wrappeddata.js'

ts/database/mongodescriptor.ts

@@ -0,0 +1,25 @@
+/**
+ * contains the complete info for how to connect to a mongodb database.
+ */
+export interface IMongoDescriptor {
+  /**
+   * the URL to connect to
+   */
+  mongoDbUrl: string;
+
+  /**
+   * the db to use for the project
+   */
+  mongoDbName?: string;
+
+  /**
+   * a username to use to connect to the database
+   */
+
+  mongoDbUser?: string;
+
+  /**
+   * an optional password that will be replace <PASSWORD> in the connection string
+   */
+  mongoDbPass?: string;
+}

ts/database/objectaction.ts

@@ -0,0 +1,8 @@
+export interface IObjectAction {
+  timestamp: number;
+  name: string;
+  userId: string;
+  data: any;
+  message: string;
+  privateMessage: string;
+}

ts/database/wrappeddata.ts

@@ -0,0 +1,3 @@
+export interface IWrappedData<T> {
+  data: T;
+}

ts/events/contractevent.ts

@@ -1,5 +1,5 @@
 /**
- * a constract event describes any kind of sale
+ * a contract event describes any kind of sale
  */
 export interface IEvent_Contract {
   contractId: string;

ts/index.ts

@@ -25,7 +25,10 @@ import * as network from './network/index.js';
 // SaaS
 import * as saas from './saas/index.js';
 
-export { business, container, code, database, finance, content, general, network, saas };
+// Website
+import * as website from './website/index.js';
+
+export { business, container, code, database, finance, content, general, network, saas, website };
 
 import type * as typeFest from 'type-fest';
 

ts/website/index.ts

@@ -0,0 +1 @@
+export * from './menuitem.js';

ts/website/menuitem.ts

@@ -0,0 +1,4 @@
+export interface IMenuItem {
+  name: string;
+  action: <T = any>() => void | Promise<T>;
+}