3.0.19

.gitignore

@@ -15,8 +15,6 @@ node_modules/
 
 # builds
 dist/
-dist_web/
+dist_*/
-dist_serve/
-dist_ts_web/
 
 # custom

.gitlab-ci.yml

@@ -12,29 +12,38 @@ stages:
   - release
   - metadata
 
+before_script:
+  - pnpm install -g pnpm
+  - pnpm install -g @shipzone/npmci
+  - npmci npm prepare
+
 # ====================
 # security stage
 # ====================
-mirror:
+# ====================
+# security stage
+# ====================
+auditProductionDependencies:
+  image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
   stage: security
   script:
-    - npmci git mirror
+     - npmci command npm config set registry https://registry.npmjs.org
+     - npmci command pnpm audit --audit-level=high --prod
   tags:
     - lossless
     - docker
-    - notpriv
+  allow_failure: true
 
-snyk:
+auditDevDependencies:
-  image: registry.gitlab.com/hosttoday/ht-docker-node:snyk
+  image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
   stage: security
   script:
-    - npmci npm prepare
+    - npmci command npm config set registry https://registry.npmjs.org
-    - npmci command npm install --ignore-scripts
+    - npmci command pnpm audit --audit-level=high --dev
-    - npmci command snyk test
   tags:
     - lossless
     - docker
-    - notpriv
+  allow_failure: true
 
 # ====================
 # test stage
@@ -43,28 +52,22 @@ snyk:
 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
+    - npmci npm build
   coverage: /\d+.?\d+?\%\s*coverage/
   tags:
-    - lossless
     - docker
-    - notpriv
 
 release:
   stage: release
@@ -84,11 +87,12 @@ release:
 codequality:
   stage: metadata
   allow_failure: true
+  only:
+    - tags
   script:
-    - npmci command npm install -g tslint typescript
+    - npmci command npm install -g typescript
     - npmci npm prepare
     - npmci npm install
-    - npmci command "tslint -c tslint.json ./ts/**/*.ts"
   tags:
     - lossless
     - docker
@@ -108,11 +112,9 @@ trigger:
 pages:
   stage: metadata
   script:
-    - npmci node install lts
+    - npmci node install stable
-    - npmci command npm install -g @gitzone/tsdoc
-    - npmci npm prepare
     - npmci npm install
-    - npmci command tsdoc
+    - npmci command npm run buildDocs
   tags:
     - lossless
     - docker

.vscode/launch.json

@@ -2,28 +2,10 @@
   "version": "0.2.0",
   "configurations": [
     {
-      "name": "current file",
+      "command": "npm test",
-      "type": "node",
+      "name": "Run npm test",
       "request": "launch",
-      "args": [
+      "type": "node-terminal"
-        "${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"
     }
   ]
 }

.vscode/settings.json

@@ -15,7 +15,7 @@
             "properties": {
               "projectType": {
                 "type": "string",
-                "enum": ["website", "element", "service", "npm"]
+                "enum": ["website", "element", "service", "npm", "wcc"]
               }
             }
           }

npmextra.json

@@ -9,7 +9,7 @@
       "githost": "gitlab.com",
       "gitscope": "pushrocks",
       "gitrepo": "websetup",
-      "shortDescription": "setup basic page properties",
+      "description": "setup basic page properties",
       "npmPackagename": "@pushrocks/websetup",
       "license": "MIT"
     }

package.json

@@ -1,40 +1,46 @@
 {
   "name": "@pushrocks/websetup",
-  "version": "2.0.7",
+  "version": "3.0.19",
   "private": false,
   "description": "setup basic page properties",
-  "main": "dist/index.js",
+  "main": "dist_ts/index.js",
-  "typings": "dist/index.d.ts",
+  "typings": "dist_ts/index.d.ts",
   "author": "Lossless GmbH",
   "license": "MIT",
   "scripts": {
     "test": "(tstest test/)",
-    "build": "(tsbuild --web)",
+    "build": "(tsbuild --web --allowimplicitany && tsbundle npm)",
-    "format": "(gitzone format)"
+    "buildDocs": "tsdoc"
   },
   "keywords": [
     "lossless",
     "websafe"
   ],
   "devDependencies": {
-    "@gitzone/tsbuild": "^2.1.17",
+    "@gitzone/tsbuild": "^2.1.65",
-    "@gitzone/tstest": "^1.0.28",
+    "@gitzone/tsbundle": "^2.0.7",
-    "@pushrocks/tapbundle": "^3.2.0",
+    "@gitzone/tstest": "^1.0.74",
-    "tslint": "^6.0.0",
+    "@pushrocks/tapbundle": "^5.0.4"
-    "tslint-config-prettier": "^1.15.0"
   },
   "dependencies": {
-    "@tsclass/tsclass": "^3.0.12"
+    "@pushrocks/smartdelay": "^3.0.1",
+    "@pushrocks/smartpromise": "^4.0.2",
+    "@tsclass/tsclass": "^4.0.41"
   },
   "files": [
     "ts/**/*",
     "ts_web/**/*",
     "dist/**/*",
-    "dist_web/**/*",
+    "dist_*/**/*",
+    "dist_ts/**/*",
     "dist_ts_web/**/*",
     "assets/**/*",
     "cli.js",
     "npmextra.json",
     "readme.md"
-  ]
+  ],
+  "browserslist": [
+    "last 1 chrome versions"
+  ],
+  "type": "module"
 }

readme.md

@@ -8,16 +8,23 @@ setup basic page properties
 * [docs (typedoc)](https://pushrocks.gitlab.io/websetup/)
 
 ## Status for master
-[![pipeline status](https://gitlab.com/pushrocks/websetup/badges/master/pipeline.svg)](https://gitlab.com/pushrocks/websetup/commits/master)
+
-[![coverage report](https://gitlab.com/pushrocks/websetup/badges/master/coverage.svg)](https://gitlab.com/pushrocks/websetup/commits/master)
+Status Category | Status Badge
-[![npm downloads per month](https://img.shields.io/npm/dm/@pushrocks/websetup.svg)](https://www.npmjs.com/package/@pushrocks/websetup)
+-- | --
-[![Known Vulnerabilities](https://snyk.io/test/npm/@pushrocks/websetup/badge.svg)](https://snyk.io/test/npm/@pushrocks/websetup)
+GitLab Pipelines | [![pipeline status](https://gitlab.com/pushrocks/websetup/badges/master/pipeline.svg)](https://lossless.cloud)
-[![TypeScript](https://img.shields.io/badge/TypeScript->=%203.x-blue.svg)](https://nodejs.org/dist/latest-v10.x/docs/api/)
+GitLab Pipline Test Coverage | [![coverage report](https://gitlab.com/pushrocks/websetup/badges/master/coverage.svg)](https://lossless.cloud)
-[![node](https://img.shields.io/badge/node->=%2010.x.x-blue.svg)](https://nodejs.org/dist/latest-v10.x/docs/api/)
+npm | [![npm downloads per month](https://badgen.net/npm/dy/@pushrocks/websetup)](https://lossless.cloud)
-[![JavaScript Style Guide](https://img.shields.io/badge/code%20style-prettier-ff69b4.svg)](https://prettier.io/)
+Snyk | [![Known Vulnerabilities](https://badgen.net/snyk/pushrocks/websetup)](https://lossless.cloud)
+TypeScript Support | [![TypeScript](https://badgen.net/badge/TypeScript/>=%203.x/blue?icon=typescript)](https://lossless.cloud)
+node Support | [![node](https://img.shields.io/badge/node->=%2010.x.x-blue.svg)](https://nodejs.org/dist/latest-v10.x/docs/api/)
+Code Style | [![Code Style](https://badgen.net/badge/style/prettier/purple)](https://lossless.cloud)
+PackagePhobia (total standalone install weight) | [![PackagePhobia](https://badgen.net/packagephobia/install/@pushrocks/websetup)](https://lossless.cloud)
+PackagePhobia (package size on registry) | [![PackagePhobia](https://badgen.net/packagephobia/publish/@pushrocks/websetup)](https://lossless.cloud)
+BundlePhobia (total size when bundled) | [![BundlePhobia](https://badgen.net/bundlephobia/minzip/@pushrocks/websetup)](https://lossless.cloud)
 
 ## Usage
 
+Use TypeScript for best in class intellisense.
 
 ## Contribution
 
@@ -25,7 +32,6 @@ We are always happy for code contributions. If you are not the code contributing
 
 For further information read the linked docs at the top of this readme.
 
-> MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh)
+## Legal
+> MIT licensed | **©** [Task Venture Capital GmbH](https://task.vc)
 | By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy)
-
-[![repo-footer](https://lossless.gitlab.io/publicrelations/repofooter.svg)](https://maintainedby.lossless.com)

test/test.browser.ts

@@ -0,0 +1,18 @@
+import { expect, tap, webhelpers } from '@pushrocks/tapbundle';
+webhelpers.enable();
+
+import * as websetup from '../ts/index.js';
+
+tap.test('first test', async () => {
+  const websetupInstance = new websetup.WebSetup({
+    metaObject: {
+      description: 'A awesome description',
+      title: 'mytitle',
+      canonicalDomain: 'lossless.com',
+    },
+  });
+  await websetupInstance.readyPromise;
+  expect(document.title).toEqual('mytitle');
+});
+
+tap.start();

test/test.ts

@@ -1,8 +0,0 @@
-import { expect, tap } from '@pushrocks/tapbundle';
-import * as websetup from '../ts/index';
-
-tap.test('first test', async () => {
-  console.log('Waiting for proper puppeteer support here');
-});
-
-tap.start();

ts/00_commitinfo_data.ts

@@ -0,0 +1,8 @@
+/**
+ * autocreated commitinfo by @pushrocks/commitinfo
+ */
+export const commitinfo = {
+  name: '@pushrocks/websetup',
+  version: '3.0.19',
+  description: 'setup basic page properties'
+}

ts/index.ts

@@ -1,33 +1,5 @@
-import * as plugins from './websetup.plugins';
+export * from './websetup.classes.websetup.js';
-
+export * from './websetup.classes.tag.metatag.js';
-import { setupGoogleAnalytics } from './tools/ganalytics';
+export * from './websetup.classes.tag.opengraphtag.js';
-import { setupFullStory } from './tools/fullstory';
+export * from './websetup.classes.tag.jsonldtag.js';
-import { IMetaObject, setupMetaInformation } from './meta';
+export * from './websetup.classes.title.js';
-
-export interface IWebSetupConstructorOptions {
-  googleAnalyticsCode?: string;
-  fsCode?: string;
-  metaObject: IMetaObject;
-}
-
-/**
- * the main WebSetup class
- */
-export class WebSetup {
-  public options: IWebSetupConstructorOptions;
-  constructor(optionsArg: IWebSetupConstructorOptions) {
-    this.options = optionsArg;
-  }
-
-  public async setup() {
-    await setupMetaInformation(this.options.metaObject);
-
-    if (this.options.googleAnalyticsCode) {
-      await setupGoogleAnalytics(this.options.googleAnalyticsCode);
-    }
-
-    if (this.options.fsCode) {
-      await setupFullStory(this.options.fsCode);
-    }
-  }
-}

ts/interfaces/index.ts

@@ -0,0 +1,19 @@
+import * as plugins from '../websetup.plugins.js';
+export interface IMetaObject {
+  title: string;
+  description?: string;
+  canonicalDomain?: string;
+  ldCompany?: plugins.tsclass.business.ICompany;
+  ldProduct?: plugins.tsclass.saas.IProduct;
+
+  // handles
+  twitterHandle?: string;
+  facebookHandle?: string;
+
+  // links
+  companyWebsiteLink?: string;
+  googleNewsLink?: string;
+  mediumLink?: string;
+  slackLink?: string;
+  airmeetLink?: string;
+}

ts/meta/index.ts

@@ -1,105 +0,0 @@
-import * as plugins from '../websetup.plugins';
-
-export interface IMetaObject {
-  title: string;
-  description: string;
-  canonicalDomain?: string;
-  ldCompany?: plugins.tsclass.business.ICompany;
-  ldProduct?: any;
-}
-
-export const setupMetaInformation = async (metaObjectArg: IMetaObject) => {
-  document.title = metaObjectArg.title;
-  addMetaTag('description', metaObjectArg.description);
-  addMetaTag('google', 'notranslate');
-  addMetaTag('revisit-after', '1 days');
-  metaObjectArg.canonicalDomain ? addLinkTag('canonical', metaObjectArg.canonicalDomain) : null;
-
-  if (metaObjectArg.ldCompany) {
-    addCompanyInfo(metaObjectArg.ldCompany);
-  }
-};
-
-const addMetaTag = async (metaNameArg: string, contentArg: string) => {
-  const metaElement = document.createElement('meta');
-  metaElement.name = metaNameArg;
-  metaElement.content = contentArg;
-  document.getElementsByTagName('head')[0].appendChild(metaElement);
-};
-
-const addLinkTag = async (relArg, hrefArg): Promise<Element> => {
-  const link = !!document.querySelector("link[rel='canonical']")
-    ? document.querySelector("link[rel='canonical']")
-    : document.createElement('link');
-  link.setAttribute('rel', relArg);
-  link.setAttribute('href', hrefArg);
-  document.head.appendChild(link);
-  return link;
-};
-
-const addOpenGraphProperty = async (
-  propertyNameArg: string,
-  contentArg: string
-): Promise<Element> => {
-  const openGraphElement = document.createElement('meta');
-  openGraphElement.name = propertyNameArg;
-  openGraphElement.content = contentArg;
-  document.getElementsByTagName('head')[0].appendChild(openGraphElement);
-  return openGraphElement;
-};
-
-const addCompanyInfo = async (
-  companyDataArg: plugins.tsclass.business.ICompany
-): Promise<Element[]> => {
-  const returnElementArray: Element[] = [];
-
-  // lets care about linked data
-  const companyLd = {
-    '@context': 'https://schema.org',
-    '@type': 'Corporation',
-    name: companyDataArg.name,
-    alternateName: companyDataArg.name.replace(' GmbH', ''),
-    url: companyDataArg.contact.website,
-    logo: companyDataArg.contact.logoUrl,
-    contactPoint: {
-      '@type': 'ContactPoint',
-      telephone: companyDataArg.contact.phone,
-      contactType: 'customer service',
-      areaServed: 'DE',
-      availableLanguage: ['en', 'German']
-    },
-    sameAs: []
-  };
-
-  if (companyDataArg.contact.facebookUrl) {
-    companyLd.sameAs.push(companyDataArg.contact.facebookUrl);
-  }
-
-  if (companyDataArg.contact.twitterUrl) {
-    companyLd.sameAs.push(companyDataArg.contact.twitterUrl);
-  }
-
-  const jsonLdElement = document.createElement('script');
-  jsonLdElement.type = 'application/ld+json';
-  jsonLdElement.text = JSON.stringify(companyLd);
-  document.querySelector('head').appendChild(jsonLdElement);
-  returnElementArray.push(jsonLdElement);
-
-  // lets care about open graph
-  returnElementArray.push(await addOpenGraphProperty('og:type', 'business.business'));
-  returnElementArray.push(await addOpenGraphProperty('og:title', companyDataArg.name));
-  returnElementArray.push(await addOpenGraphProperty('og:url', companyDataArg.contact.website));
-  returnElementArray.push(await addOpenGraphProperty('og:imge', companyDataArg.contact.logoUrl));
-  returnElementArray.push(
-    await addOpenGraphProperty(
-      'business:contact_data:street_address',
-      `${companyDataArg.contact.address.streetName} ${companyDataArg.contact.address.houseNumber}`
-    )
-  );
-  returnElementArray.push(await addOpenGraphProperty('business:contact_data:locality', companyDataArg.contact.address.postalCode));
-  returnElementArray.push(await addOpenGraphProperty('business:contact_data:region', companyDataArg.contact.address.city));
-  returnElementArray.push(await addOpenGraphProperty('business:contact_data:postal_code', companyDataArg.contact.address.postalCode));
-  returnElementArray.push(await addOpenGraphProperty('business:contact_data:country_name', companyDataArg.contact.address.country));
-
-  return returnElementArray;
-};

ts/tools/fullstory.ts

@@ -1,70 +0,0 @@
-declare global {
-  // tslint:disable-next-line: interface-name
-  interface Window {
-    _fs_debug: boolean;
-    _fs_host: any;
-    _fs_org: string;
-    _fs_namespace: string;
-  }
-}
-export const setupFullStory = async (fsCodeArg: string) => {
-  // tslint:disable-next-line: no-string-literal
-  window['_fs_debug'] = false;
-  // tslint:disable-next-line: no-string-literal
-  window['_fs_host'] = 'fullstory.com';
-  // tslint:disable-next-line: no-string-literal
-  window['_fs_org'] = fsCodeArg;
-  // tslint:disable-next-line: no-string-literal
-  window['_fs_namespace'] = 'FS';
-  ((m, n, e, t, l, o, g, y) => {
-    if (e in m) {
-      if (m.console && m.console.log) {
-        m.console.log('FullStory namespace conflict. Please set window["_fs_namespace"].');
-      }
-      return;
-    }
-    // tslint:disable-next-line: only-arrow-functions
-    g = m[e] = function(a, b, s) {
-      g.q ? g.q.push([a, b, s]) : g._api(a, b, s);
-    };
-    g.q = [];
-    o = n.createElement(t);
-    o.async = 1;
-    o.src = 'https://' + window._fs_host + '/s/fs.js';
-    o.crossorigin = 'anonymous';
-    y = n.getElementsByTagName(t)[0];
-    y.parentNode.insertBefore(o, y);
-    // tslint:disable-next-line: only-arrow-functions
-    g.identify = function(i, v, s) {
-      g(l, { uid: i }, s);
-      if (v) g(l, v, s);
-    };
-    g.setUserVars = function(v, s) {
-      g(l, v, s);
-    };
-    g.event = function(i, v, s) {
-      g('event', { n: i, p: v }, s);
-    };
-    // tslint:disable-next-line: only-arrow-functions
-    g.shutdown = function() {
-      g('rec', !1);
-    };
-    g.restart = function() {
-      g('rec', !0);
-    };
-    // tslint:disable-next-line: only-arrow-functions
-    g.consent = function(a) {
-      g('consent', !arguments.length || a);
-    };
-    // tslint:disable-next-line: only-arrow-functions
-    g.identifyAccount = function(i, v) {
-      o = 'account';
-      v = v || {};
-      v.acctId = i;
-      g(o, v);
-    };
-    // tslint:disable-next-line: only-arrow-functions
-    g.clearUserCookie = function() {};
-    // tslint:disable-next-line: no-string-literal
-  })(window, document, window['_fs_namespace'], 'script', 'user');
-};

ts/tools/ganalytics.ts

@@ -1,32 +0,0 @@
-declare global {
-  // tslint:disable-next-line: interface-name
-  interface Window {
-    analytics: any;
-  }
-}
-
-export const setupGoogleAnalytics = async (gaCode: string) => {
-  // tslint:disable-next-line: only-arrow-functions
-  (function(i, s, o, g, r, a, m) {
-    // tslint:disable-next-line: no-string-literal
-    i['GoogleAnalyticsObject'] = r;
-    // tslint:disable-next-line: ban-comma-operator
-    (i[r] =
-      i[r] ||
-      // tslint:disable-next-line: only-arrow-functions
-      function() {
-        (i[r].q = i[r].q || []).push(arguments);
-      }),
-      (i[r].l = new Date().getTime());
-    // tslint:disable-next-line: ban-comma-operator
-    (a = s.createElement(o)), (m = s.getElementsByTagName(o)[0]);
-    a.async = 1;
-    a.src = g;
-    a.crossorigin = 'anonymous';
-    m.parentNode.insertBefore(a, m);
-  })(window, document, 'script', '//www.google-analytics.com/analytics.js', 'analytics');
-
-  window.analytics('create', gaCode, 'auto');
-  window.analytics('send', 'pageview');
-  console.log('Loaded Google Analytics. You may view our privacy policy at https://lossless.gmbh');
-};

ts/websetup.classes.tag.jsonldtag.ts

@@ -0,0 +1,106 @@
+import * as plugins from './websetup.plugins.js';
+import * as interfaces from './interfaces/index.js';
+
+import { Tag } from './websetup.classes.tag.js';
+
+export class JsonLdTag extends Tag {
+  public static createCompanyJsonLd(companyDataArg: plugins.tsclass.business.ICompany) {
+    // STATIC
+    // lets care about linked data
+    const companyLd = {
+      '@context': 'https://schema.org',
+      '@type': 'Corporation',
+      name: companyDataArg.name,
+      alternateName: companyDataArg.name.replace(' GmbH', ''),
+      url: companyDataArg.contact.website,
+      logo: companyDataArg.contact.logoUrl,
+      contactPoint: {
+        '@type': 'ContactPoint',
+        telephone: companyDataArg.contact.phone,
+        contactType: 'customer service',
+        areaServed: 'DE',
+        availableLanguage: ['en', 'German'],
+      },
+      sameAs: [],
+    };
+
+    if (companyDataArg.contact.facebookUrl) {
+      companyLd.sameAs.push(companyDataArg.contact.facebookUrl);
+    }
+
+    if (companyDataArg.contact.twitterUrl) {
+      companyLd.sameAs.push(companyDataArg.contact.twitterUrl);
+    }
+
+    const ldTag = new JsonLdTag(companyLd);
+    return ldTag;
+  }
+
+  public static createNewsArticleJsonLd(newsArticleArg: plugins.tsclass.content.IArticle) {
+    const newsArticleLd = {
+      '@context': 'https://schema.org',
+      '@type': 'NewsArticle',
+      mainEntityOfPage: {
+        '@type': 'WebPage',
+        '@id': window.location.href,
+      },
+      headline: 'Article headline',
+      image: [newsArticleArg.featuredImageUrl],
+      datePublished: new Date(newsArticleArg.timestamp).toISOString(),
+      dateModified: new Date(newsArticleArg.timestamp).toISOString(),
+      author: {
+        '@type': 'Person',
+        name: `${newsArticleArg.author.firstName} ${newsArticleArg.author.surName}`,
+      },
+      publisher: {
+        '@type': 'Organization',
+        name: newsArticleArg.author.surName, // TODO
+        logo: {
+          '@type': 'ImageObject',
+          url: newsArticleArg.author.surName, // TODO
+        },
+      },
+      description: newsArticleArg.author.firstName,
+    };
+    const ldTag = new JsonLdTag(newsArticleLd);
+    return ldTag;
+  }
+  public static createProductJsonLd(
+    productArg: plugins.tsclass.saas.IProduct,
+    publisherArg: plugins.tsclass.business.ICompany
+  ) {
+    const productLd = {
+      '@context': 'https://schema.org',
+      '@type': 'SoftwareApplication',
+      name: productArg.name,
+      description: productArg.description,
+      operatingSystem: productArg.os,
+      applicationCategory: productArg.category,
+      offers: {
+        '@type': 'Offer',
+        name: 'User-based Plan',
+        priceSpecification: {
+          '@type': 'PropertyValueSpecification',
+          valueName: 'Number of Users',
+          valueRequired: true,
+          price: '4.99',
+          priceCurrency: 'EUR',
+        },
+      },
+      publisher: this.createCompanyJsonLd(publisherArg).elementRef.textContent,
+      screenshot: 'https://www.social.io/screenshot.png',
+      url: 'https://www.social.io/',
+    };
+    const ldTag = new JsonLdTag(productLd);
+    return ldTag;
+  }
+
+  // INSTANCE
+  constructor(ldObjectArg: any) {
+    super();
+    const jsonLdElement = document.createElement('script');
+    jsonLdElement.type = 'application/ld+json';
+    jsonLdElement.text = JSON.stringify(ldObjectArg);
+    this.elementRef = jsonLdElement;
+  }
+}

ts/websetup.classes.tag.linktag.ts

@@ -0,0 +1,13 @@
+import { Tag } from './websetup.classes.tag.js';
+
+export class LinkTag extends Tag {
+  constructor(relArg: string, hrefArg: string) {
+    super();
+    const linkElement = !!document.querySelector("link[rel='canonical']")
+      ? document.querySelector("link[rel='canonical']")
+      : document.createElement('link');
+    linkElement.setAttribute('rel', relArg);
+    linkElement.setAttribute('href', hrefArg);
+    this.elementRef = linkElement;
+  }
+}

ts/websetup.classes.tag.metatag.ts

@@ -0,0 +1,11 @@
+import { Tag } from './websetup.classes.tag.js';
+
+export class MetaTag extends Tag {
+  constructor(metaNameArg: string, contentArg: string) {
+    super();
+    const metaElement = document.createElement('meta');
+    metaElement.name = metaNameArg;
+    metaElement.content = contentArg;
+    this.elementRef = metaElement;
+  }
+}

ts/websetup.classes.tag.opengraphtag.ts

@@ -0,0 +1,31 @@
+import * as plugins from './websetup.plugins.js';
+import { Tag } from './websetup.classes.tag.js';
+
+export class OpengraphTag extends Tag {
+  public static createNewsArticleOgTags(newsArticleArg: plugins.tsclass.content.IArticle) {
+    const tagArray: OpengraphTag[] = [];
+    tagArray.push(new OpengraphTag('og:url', newsArticleArg.url));
+    tagArray.push(new OpengraphTag('og:title', newsArticleArg.title));
+    tagArray.push(new OpengraphTag('og:description', newsArticleArg.content));
+    tagArray.push(new OpengraphTag('og:image', newsArticleArg.featuredImageUrl));
+    return tagArray;
+  }
+
+  public static createProductOgTags(productArg: plugins.tsclass.saas.IProduct) {
+    const tagArray: OpengraphTag[] = [];
+    tagArray.push(new OpengraphTag('og:url', globalThis.location.href));
+    tagArray.push(new OpengraphTag('og:title', `${productArg.name} - ${productArg.slogan}`));
+    tagArray.push(new OpengraphTag('og:site_name', productArg.name))
+    tagArray.push(new OpengraphTag('og:description', productArg.description));
+    tagArray.push(new OpengraphTag('og:image', productArg.logoLink));
+    return tagArray;
+  }
+
+  constructor(propertyNameArg: string, contentArg: string) {
+    super();
+    const openGraphElement = document.createElement('meta');
+    openGraphElement.setAttribute('property', propertyNameArg);
+    openGraphElement.content = contentArg;
+    this.elementRef = openGraphElement;
+  }
+}

ts/websetup.classes.tag.ts

@@ -0,0 +1,21 @@
+import * as plugins from './websetup.plugins.js';
+
+export class Tag {
+  public elementRef: Element;
+
+  public tagLevel: 'global' | 'levelbound';
+
+  public appendToDom() {
+    if (!this.elementRef.parentElement && !this.elementRef.parentNode) {
+      document.getElementsByTagName('head')[0].appendChild(this.elementRef);
+    }
+  }
+
+  public removeFromDom() {
+    if (this.elementRef.parentElement) {
+      this.elementRef.parentElement.removeChild(this.elementRef);
+    } else if (this.elementRef.parentNode) {
+      this.elementRef.parentNode.removeChild(this.elementRef);
+    }
+  }
+}

ts/websetup.classes.taglevel.ts

@@ -0,0 +1,104 @@
+import { Tag } from './websetup.classes.tag.js';
+import { JsonLdTag } from './websetup.classes.tag.jsonldtag.js';
+import { OpengraphTag } from './websetup.classes.tag.opengraphtag.js';
+import { TagManager } from './websetup.classes.tagmanager.js';
+import * as plugins from './websetup.plugins.js';
+
+export type TBaseLevelType = 'global' | 'base' | 'subpage';
+
+export type TLevelState = 'enabled' | 'disabled';
+
+export class TagLevel {
+  public tagManagerRef: TagManager;
+
+  private titleStore: string;
+  public set title(titleArg: string) {
+    this.titleStore = titleArg;
+    if (this.state === 'enabled') {
+      document.title = this.titleStore;
+    }
+  }
+  public get title() {
+    return this.titleStore;
+  }
+
+  public type: TBaseLevelType;
+  public tags: Tag[] = [];
+
+  public state: TLevelState = 'disabled';
+
+  constructor(tagManagerRefArg: TagManager, levelType: TBaseLevelType) {
+    this.tagManagerRef = tagManagerRefArg;
+  }
+
+  public addTag(tagArg: Tag | Tag[]) {
+    if (tagArg instanceof Array) {
+      for (const tagArg2 of tagArg) {
+        this.addTag(tagArg2);
+      }
+    } else {
+      this.tags.push(tagArg);
+      if (this.state === 'enabled') {
+        tagArg.appendToDom();
+      }
+    }
+  }
+
+  public async addCompanyInfo(companyDataArg: plugins.tsclass.business.ICompany) {
+    this.addTag(JsonLdTag.createCompanyJsonLd(companyDataArg));
+
+    // lets care about open graph
+    this.addTag(new OpengraphTag('og:type', 'business.business'));
+    this.addTag(new OpengraphTag('og:title', companyDataArg.name));
+    this.addTag(new OpengraphTag('og:url', companyDataArg.contact.website));
+    this.addTag(new OpengraphTag('og:image', companyDataArg.contact.logoUrl));
+    this.addTag(
+      new OpengraphTag(
+        'business:contact_data:street_address',
+        `${companyDataArg.contact.address.streetName} ${companyDataArg.contact.address.houseNumber}`
+      )
+    );
+    this.addTag(
+      new OpengraphTag('business:contact_data:locality', companyDataArg.contact.address.postalCode)
+    );
+    this.addTag(
+      new OpengraphTag('business:contact_data:region', companyDataArg.contact.address.city)
+    );
+    this.addTag(
+      new OpengraphTag(
+        'business:contact_data:postal_code',
+        companyDataArg.contact.address.postalCode
+      )
+    );
+    this.addTag(
+      new OpengraphTag('business:contact_data:country_name', companyDataArg.contact.address.country)
+    );
+  }
+
+  public addNewsArticleInfo(articleArg: plugins.tsclass.content.IArticle) {
+    this.addTag(JsonLdTag.createNewsArticleJsonLd(articleArg));
+    this.addTag(OpengraphTag.createNewsArticleOgTags(articleArg));
+  }
+
+  public addProductInfo(productArg: plugins.tsclass.saas.IProduct, companyArg: plugins.tsclass.business.ICompany) {
+    this.addTag(JsonLdTag.createProductJsonLd(productArg, companyArg));
+    this.addTag(OpengraphTag.createProductOgTags(productArg));
+  }
+
+  public async enable() {
+    if (this.title) {
+      document.title = this.title;
+    }
+    for (const tagArg of this.tags) {
+      tagArg.appendToDom();
+    }
+    this.state = 'enabled';
+  }
+
+  public async disable() {
+    for (const tagArg of this.tags) {
+      tagArg.removeFromDom();
+    }
+    this.state = 'disabled';
+  }
+}

ts/websetup.classes.tagmanager.ts

@@ -0,0 +1,71 @@
+import { TagLevel } from './websetup.classes.taglevel.js';
+import * as plugins from './websetup.plugins.js';
+import * as interfaces from './interfaces/index.js';
+import { MetaTag } from './websetup.classes.tag.metatag.js';
+import { JsonLdTag } from './websetup.classes.tag.jsonldtag.js';
+import { OpengraphTag } from './websetup.classes.tag.opengraphtag.js';
+
+export class TagManager {
+  public globalLevel: TagLevel = new TagLevel(this, 'global');
+
+  public baseLevel: TagLevel = new TagLevel(this, 'base');
+
+  public activeLevel: TagLevel;
+
+  public async setup(metaObjectArg: interfaces.IMetaObject) {
+    // global tag level
+    this.globalLevel.addTag(new MetaTag('google', 'notranslate'));
+    this.globalLevel.addTag(new MetaTag('revisit-after', '1 days'));
+
+    if (metaObjectArg.twitterHandle) {
+      this.globalLevel.addTag(new MetaTag('twitter:card', 'summary_large_image'));
+      this.globalLevel.addTag(new MetaTag('twitter:site', metaObjectArg.twitterHandle));
+      this.globalLevel.addTag(new MetaTag('twitter:creator', metaObjectArg.twitterHandle));
+    }
+
+    // base tag level
+    this.baseLevel.title = metaObjectArg.title;
+    if (metaObjectArg.description) {
+      this.baseLevel.addTag(new MetaTag('description', metaObjectArg.description));
+    }
+
+    if (metaObjectArg.canonicalDomain) {
+      this.baseLevel.addTag(new MetaTag('canonical', metaObjectArg.canonicalDomain));
+    }
+
+
+    // json ld
+    switch (true) {
+      case metaObjectArg.ldCompany && !metaObjectArg.ldProduct:
+        this.baseLevel.addCompanyInfo(metaObjectArg.ldCompany);
+        break;
+      case !!metaObjectArg.ldProduct:
+        this.baseLevel.addProductInfo(metaObjectArg.ldProduct, metaObjectArg.ldCompany);
+        break;
+    }
+
+    await this.globalLevel.enable();
+    this.activeLevel = this.baseLevel;
+    await this.activeLevel.enable();
+  }
+
+  public async setSubPageLevel(metaObjectArg: interfaces.IMetaObject) {
+    const subPageLevel = new TagLevel(this, 'subpage');
+    subPageLevel.title = metaObjectArg.title;
+    if (metaObjectArg.description) {
+      subPageLevel.addTag(new MetaTag('description', metaObjectArg.description));
+    }
+    await this.activeLevel.disable();
+    this.activeLevel = subPageLevel;
+    await this.activeLevel.enable();
+    return subPageLevel;
+  }
+
+  public async revertToBaseLevel() {
+    if (this.activeLevel !== this.baseLevel) {
+      await this.activeLevel.disable();
+      this.activeLevel = this.baseLevel;
+      await this.activeLevel.enable();
+    }
+  }
+}

ts/websetup.classes.title.ts

@@ -0,0 +1,7 @@
+import * as plugins from './websetup.plugins.js';
+
+/**
+ * a title proxy class
+ * --> to be used in the future when flashing titles is supported
+ */
+export class Title {}

ts/websetup.classes.websetup.ts

@@ -0,0 +1,78 @@
+import * as plugins from './websetup.plugins.js';
+import * as interfaces from './interfaces/index.js';
+import { TagManager } from './websetup.classes.tagmanager.js';
+import { TagLevel } from './websetup.classes.taglevel.js';
+
+export interface IWebSetupConstructorOptions {
+  metaObject: interfaces.IMetaObject;
+  smartssrWaitForReadySignal?: boolean;
+}
+
+/**
+ * the main WebSetup class
+ */
+export class WebSetup {
+  public tagManager: TagManager = new TagManager();
+  public options: IWebSetupConstructorOptions;
+
+  // private deferreds
+  private readyDeferred = plugins.smartpromise.defer();
+  private readyForSmartssrDeferred = plugins.smartpromise.defer();
+
+  // public promises
+  public readyPromise = this.readyDeferred.promise;
+  public readyForSmartssrPromise = this.readyForSmartssrDeferred.promise;
+  constructor(optionsArg: IWebSetupConstructorOptions) {
+    this.options = optionsArg;
+    this.setup().then(() => {
+      this.readyDeferred.resolve();
+      if (!this.options.smartssrWaitForReadySignal) {
+        this.readyForSmartssrDeferred.resolve();
+      }
+    });
+  }
+
+  /**
+   * an async setup called by the constructor
+   */
+  public async setup(optionsArg?: IWebSetupConstructorOptions) {
+    if (optionsArg) {
+      this.options = optionsArg;
+    }
+    await this.tagManager.setup(this.options.metaObject);
+  }
+
+  /**
+   * reverts the active level and returns to the base level
+   */
+  public revertToBaseLevel() {
+    this.tagManager.revertToBaseLevel();
+  }
+
+  /**
+   * sets a subpage
+   * @param metaObjectArg
+   */
+  public async setSubLevel(metaObjectArg: interfaces.IMetaObject) {
+    const subLevel = await this.tagManager.setSubPageLevel(metaObjectArg);
+    return subLevel;
+  }
+
+  /**
+   * flashes the title with the given text
+   * @param flashTextArg
+   */
+  public flashTitle(flashTextArg: string) {}
+
+  /**
+   * informs smartssr that the page is ready to be rendered
+   */
+  public informReadyForSmartssr() {
+    if (!this.options.smartssrWaitForReadySignal) {
+      console.error(
+        `You have not indicated that you inform smartssr by a dedicated signal! Please consider doing so!`
+      );
+    }
+    this.readyForSmartssrDeferred.resolve();
+  }
+}

ts/websetup.plugins.ts

@@ -1,5 +1,10 @@
+// pushrocks scope
+import * as smartdelay from '@pushrocks/smartdelay';
+import * as smartpromise from '@pushrocks/smartpromise';
+
+export { smartdelay, smartpromise };
+
+// tsclass scope
 import * as tsclass from '@tsclass/tsclass';
 
-export {
+export { tsclass };
-  tsclass
-};

tsconfig.json

@@ -0,0 +1,10 @@
+{
+  "compilerOptions": {
+    "experimentalDecorators": true,
+    "useDefineForClassFields": false,
+    "target": "ES2022",
+    "module": "ES2022",
+    "moduleResolution": "nodenext",
+    "esModuleInterop": true
+  }
+}

tslint.json

@@ -1,17 +0,0 @@
-{
-  "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"
-}