1.0.41

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@designestate/dees-domtools",
-  "version": "1.0.8",
+  "version": "1.0.41",
   "private": false,
   "description": "tools to simplify complex css structures",
   "main": "dist_ts/index.js",
@@ -9,20 +9,29 @@
   "license": "MIT",
   "scripts": {
     "test": "(tstest test/ --web)",
-    "build": "(tsbuild --web)",
+    "build": "(tsbuild --web && tsbundle npm)",
     "format": "(gitzone format)"
   },
   "devDependencies": {
     "@gitzone/tsbuild": "^2.0.22",
-    "@gitzone/tstest": "^1.0.15",
-    "@pushrocks/tapbundle": "^3.0.7",
-    "@types/node": "^10.11.7",
-    "tslint": "^5.11.0",
+    "@gitzone/tsbundle": "^1.0.72",
+    "@gitzone/tstest": "^1.0.43",
+    "@pushrocks/tapbundle": "^3.2.9",
+    "@types/node": "^14.0.26",
+    "tslint": "^6.1.2",
     "tslint-config-prettier": "^1.15.0"
   },
   "dependencies": {
+    "@apiglobal/typedrequest": "^1.0.41",
+    "@pushrocks/lik": "^4.0.17",
+    "@pushrocks/smartdelay": "^2.0.10",
     "@pushrocks/smartpromise": "^3.0.6",
-    "lit-element": "^2.3.1"
+    "@pushrocks/smartrouter": "^1.0.4",
+    "@pushrocks/smartstate": "^1.0.17",
+    "@pushrocks/webrequest": "^2.0.10",
+    "@pushrocks/websetup": "^2.0.18",
+    "lit-element": "^2.3.1",
+    "sweet-scroll": "^4.0.0"
   },
   "files": [
     "ts/**/*",
@@ -35,5 +44,8 @@
     "cli.js",
     "npmextra.json",
     "readme.md"
+  ],
+  "browserslist": [
+    "last 1 chrome versions"
   ]
 }

readme.md

@@ -8,13 +8,20 @@ tools to simplify complex css structures
 * [docs (typedoc)](https://designestate.gitlab.io/dees-domtools/)
 
 ## Status for master
-[![pipeline status](https://gitlab.com/designestate/dees-domtools/badges/master/pipeline.svg)](https://gitlab.com/designestate/dees-domtools/commits/master)
-[![coverage report](https://gitlab.com/designestate/dees-domtools/badges/master/coverage.svg)](https://gitlab.com/designestate/dees-domtools/commits/master)
-[![npm downloads per month](https://img.shields.io/npm/dm/@designestate/dees-domtools.svg)](https://www.npmjs.com/package/@designestate/dees-domtools)
-[![Known Vulnerabilities](https://snyk.io/test/npm/@designestate/dees-domtools/badge.svg)](https://snyk.io/test/npm/@designestate/dees-domtools)
-[![TypeScript](https://img.shields.io/badge/TypeScript->=%203.x-blue.svg)](https://nodejs.org/dist/latest-v10.x/docs/api/)
-[![node](https://img.shields.io/badge/node->=%2010.x.x-blue.svg)](https://nodejs.org/dist/latest-v10.x/docs/api/)
-[![JavaScript Style Guide](https://img.shields.io/badge/code%20style-prettier-ff69b4.svg)](https://prettier.io/)
+
+Status Category | Status Badge
+-- | --
+GitLab Pipelines | [![pipeline status](https://gitlab.com/designestate/dees-domtools/badges/master/pipeline.svg)](https://lossless.cloud)
+GitLab Pipline Test Coverage | [![coverage report](https://gitlab.com/designestate/dees-domtools/badges/master/coverage.svg)](https://lossless.cloud)
+npm | [![npm downloads per month](https://badgen.net/npm/dy/@designestate/dees-domtools)](https://lossless.cloud)
+Snyk | [![Known Vulnerabilities](https://badgen.net/snyk/designestate/dees-domtools)](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/@designestate/dees-domtools)](https://lossless.cloud)
+PackagePhobia (package size on registry) | [![PackagePhobia](https://badgen.net/packagephobia/publish/@designestate/dees-domtools)](https://lossless.cloud)
+BundlePhobia (total size when bundled) | [![BundlePhobia](https://badgen.net/bundlephobia/minzip/@designestate/dees-domtools)](https://lossless.cloud)
+Platform support | [![Supports Windows 10](https://badgen.net/badge/supports%20Windows%2010/yes/green?icon=windows)](https://lossless.cloud) [![Supports Mac OS X](https://badgen.net/badge/supports%20Mac%20OS%20X/yes/green?icon=apple)](https://lossless.cloud)
 
 ## Usage
 

test/test.browser.ts

@@ -0,0 +1,9 @@
+import { expect, tap } from '@pushrocks/tapbundle';
+import * as domtools from '../ts/index';
+
+tap.test('first test', async () => {
+  const domtoolsInstance = await domtools.DomTools.setupDomTools();
+  expect(domtoolsInstance).to.be.instanceof(domtools.DomTools);
+});
+
+tap.start();

test/test.ts

@@ -1,8 +0,0 @@
-import { expect, tap } from '@pushrocks/tapbundle';
-import * as deesCsstools from '../ts/index';
-
-tap.test('first test', async () => {
-  console.log('hi');
-});
-
-tap.start();

ts/csstools.breakpoints.ts

@@ -1,60 +0,0 @@
-export const desktop = 1240;
-export const tablet = 700;
-export const phablet = 500;
-export const phone = 340;
-
-export type TEnvironment = 'native' | 'desktop' | 'tablet' | 'phablet' | 'phone';
-
-let environment: TEnvironment = 'native';
-
-export const setEnvironment = envArg => {
-  environment = envArg;
-};
-
-export const cssForTablet = (contentArg) => {
-  if (environment === 'native' || environment === 'desktop') {
-    return `
-      @media (max-width: ${tablet}px) {
-        ${contentArg}
-      }
-    `;
-  } else if (environment === 'tablet' || environment === 'phablet' || environment === 'phone') {
-    return `
-      @media (min-width: 0px) {
-        ${contentArg}
-      }
-    `;
-  }
-};
-
-export const cssForPhablet = (contentArg) => {
-  if (environment === 'native' || environment === 'desktop') {
-    return `
-      @media (max-width: ${phablet}px) {
-        ${contentArg}
-      }
-    `;
-  } else if (environment === 'phablet' || environment === 'phone') {
-    return `
-      @media (min-width: 0px) {
-        ${contentArg}
-      }
-    `;
-  }
-};
-
-export const cssForPhone = (contentArg) => {
-  if (environment === 'native' || environment === 'desktop') {
-    return `
-      @media (max-width: ${phone}px) {
-        ${contentArg}
-      }
-    `;
-  } else if (environment === 'phone') {
-    return `
-      @media (min-width: 0px) {
-        ${contentArg}
-      }
-    `;
-  }
-};

ts/csstools.elementbasicsetup.ts

@@ -1,49 +0,0 @@
-import { defer } from '@pushrocks/smartpromise';
-
-/**
- * a basic setup for elements
- * makes sure everything is in check
- */
-export const elementBasicSetup = async () => {
-  if (globalThis.deesCssToolsReady) {
-    await globalThis.deesCssToolsReady.promise;
-  } else {
-    // lets prevent double execution
-    globalThis.deesCssToolsReady = defer();
-
-    // lets make sure the dom is ready
-    const documentReady = defer();
-    document.onreadystatechange = () => {
-      if (document.readyState === 'interactive' || document.readyState === 'complete') {
-        console.log('elementBasicSetup: element basic setup complete')
-        documentReady.resolve();
-      } else {
-        console.log('elementBasicSetup: document not yet ready');
-      }
-    };
-    console.log('elementBasicSetup: waiting for document to be ready');
-    await documentReady.promise;
-    console.log('elementBasicSetup: document ready!');
-
-    // lets get started
-    const head = document.querySelector('head');
-    const body = document.querySelector('body');
-
-    // material font
-    const materialFontCss = `
-      @font-face {
-        font-family: 'Material Icons';
-        font-style: normal;
-        font-weight: 400;
-        src: url(https://fonts.gstatic.com/s/materialicons/v42/flUhRq6tzZclQEJ-Vdg-IuiaDsNcIhQ8tQ.woff2) format('woff2');
-      }
-    `;
-    const styleElement = document.createElement('style');
-    styleElement.type = 'text/css';
-    styleElement.appendChild(document.createTextNode(materialFontCss));
-    head.appendChild(styleElement);
-
-
-    globalThis.deesCssToolsReady.resolve();
-  }
-};

ts/csstools.elementbasicstyles.ts

@@ -1,9 +0,0 @@
-import { html } from 'lit-element';
-export const elementBasicStyles = html`
-  <style>
-    * {
-      font-family: 'Roboto', sans-serif;
-      box-sizing: border-box;
-    }
-  </style>
-`;

ts/domtools.breakpoints.ts

@@ -0,0 +1,71 @@
+import { DomTools } from './domtools.classes.domtools';
+
+export const desktop = 1240;
+export const tablet = 1024;
+export const phablet = 600;
+export const phone = 400;
+
+export type TViewport = 'native' | 'desktop' | 'tablet' | 'phablet' | 'phone';
+
+export const getEnvironment = (): TViewport => {
+  if (
+    globalThis.deesDomTools &&
+    globalThis.deesDomTools.domToolsStatePart.getState().virtualViewport
+  ) {
+    return globalThis.deesDomTools.domToolsStatePart.getState().virtualViewport;
+  } else {
+    return 'native';
+  }
+};
+
+export const cssForTablet = (contentArg) => {
+  if (getEnvironment() === 'native' || getEnvironment() === 'desktop') {
+    return `
+      @media (max-width: ${tablet}px) {
+        ${contentArg}
+      }
+    `;
+  } else if (
+    getEnvironment() === 'tablet' ||
+    getEnvironment() === 'phablet' ||
+    getEnvironment() === 'phone'
+  ) {
+    return `
+      @media (min-width: 0px) {
+        ${contentArg}
+      }
+    `;
+  }
+};
+
+export const cssForPhablet = (contentArg) => {
+  if (getEnvironment() === 'native' || getEnvironment() === 'desktop') {
+    return `
+      @media (max-width: ${phablet}px) {
+        ${contentArg}
+      }
+    `;
+  } else if (getEnvironment() === 'phablet' || getEnvironment() === 'phone') {
+    return `
+      @media (min-width: 0px) {
+        ${contentArg}
+      }
+    `;
+  }
+};
+
+export const cssForPhone = (contentArg) => {
+  if (getEnvironment() === 'native' || getEnvironment() === 'desktop') {
+    return `
+      @media (max-width: ${phone}px) {
+        ${contentArg}
+      }
+    `;
+  } else if (getEnvironment() === 'phone') {
+    return `
+      @media (min-width: 0px) {
+        ${contentArg}
+      }
+    `;
+  }
+};

ts/domtools.classes.domtools.ts

@@ -0,0 +1,145 @@
+import * as plugins from './domtools.plugins';
+import { Stringmap } from '@pushrocks/lik/dist_ts/lik.stringmap';
+import { FastMap } from '@pushrocks/lik/dist_ts/lik.fastmap';
+import { TViewport } from './domtools.breakpoints';
+
+import { Scroller } from './domtools.classes.scroller';
+import { delayForRandom } from '@pushrocks/smartdelay';
+
+export interface IDomToolsState {
+  virtualViewport: TViewport;
+}
+
+export class DomTools {
+  // ======
+  // STATIC
+  // ======
+  /**
+   * setups domtools
+   */
+  public static async setupDomTools() {
+    let domToolsInstance: DomTools;
+    if (!globalThis.deesDomTools) {
+      globalThis.deesDomTools = new DomTools();
+      domToolsInstance = globalThis.deesDomTools;
+      // lets make sure the dom is ready
+      const readyStateChangedFunc = () => {
+        if (document.readyState === 'interactive' || document.readyState === 'complete') {
+          domToolsInstance.elements.headElement = document.querySelector('head');
+          domToolsInstance.elements.bodyElement = document.querySelector('body');
+          domToolsInstance.domReady.resolve();
+        }
+      };
+      document.addEventListener('readystatechange', readyStateChangedFunc);
+      domToolsInstance.domToolsReady.resolve();
+    } else {
+      domToolsInstance = globalThis.deesDomTools;
+    }
+    await domToolsInstance.domToolsReady.promise;
+    return domToolsInstance;
+  }
+
+  /**
+   * if you can, use the static asysnc .setupDomTools() function instead since it is safer to use.
+   */
+  public static getGlobalDomToolsSync() {
+    const globalDomTools: DomTools = globalThis.deesDomTools;
+    if (!globalDomTools) {
+      throw new Error('You tried to access domtools synchronously too early');
+    }
+    return globalThis.deesDomTools;
+  }
+
+  // ========
+  // INSTANCE
+  // ========
+  // elements
+  public elements: {
+    headElement: HTMLElement;
+    bodyElement: HTMLElement;
+  } = {
+    headElement: null,
+    bodyElement: null,
+  };
+
+  public smartstate = new plugins.smartstate.Smartstate();
+  public domToolsStatePart = this.smartstate.getStatePart<IDomToolsState>('domtools', {
+    virtualViewport: 'native',
+  });
+
+  public router = new plugins.smartrouter.SmartRouter({
+    debug: false,
+  });
+
+  public convenience = {
+    smartdelay: plugins.smartdelay
+  };
+
+  public scroller: plugins.SweetScroll;
+
+  private actionSetVirtualViewport = this.domToolsStatePart.createAction<TViewport>(
+    async (statePart, payload) => {
+      const currentState = statePart.getState();
+      currentState.virtualViewport = payload;
+      return currentState;
+    }
+  );
+
+  public domToolsReady = plugins.smartpromise.defer();
+  public domReady = plugins.smartpromise.defer();
+  public globalStylesReady = plugins.smartpromise.defer();
+
+  constructor() {
+    // lets care about third party stuff
+    this.domToolsReady.promise.then(() => {
+      this.scroller = new plugins.SweetScroll({
+        /* some options */
+      });
+    });
+  }
+
+  private runOnceTrackerStringMap = new Stringmap();
+  private runOnceResultMap = new FastMap();
+  /**
+   * run a function once and always get the Promise of the first execution
+   * @param identifierArg the indentifier arg identifies functions. functions with the same identifier are considered equal
+   * @param funcArg the actual func arg to run
+   */
+  public async runOnce<T>(identifierArg: string, funcArg: () => Promise<T>) {
+    const runningId = `${identifierArg}+runningCheck`;
+    if (!this.runOnceTrackerStringMap.checkString(identifierArg)) {
+      this.runOnceTrackerStringMap.addString(identifierArg);
+      this.runOnceTrackerStringMap.addString(runningId);
+      const result = await funcArg();
+      this.runOnceResultMap.addToMap(identifierArg, result);
+      this.runOnceTrackerStringMap.removeString(runningId);
+    }
+    return await this.runOnceTrackerStringMap.registerUntilTrue(
+      (stringMap) => {
+        return !stringMap.includes(runningId);
+      },
+      () => {
+        return this.runOnceResultMap.getByKey(identifierArg);
+      }
+    );
+  }
+
+  // setStuff
+
+  public async setGlobalStyles(stylesText: string) {
+    await this.domReady.promise;
+    const styleElement = document.createElement('style');
+    styleElement.type = 'text/css';
+    styleElement.appendChild(document.createTextNode(stylesText));
+    this.elements.headElement.appendChild(styleElement);
+  }
+
+  public setVirtualViewport(environmentArg: TViewport) {
+    this.domToolsStatePart.dispatchAction(this.actionSetVirtualViewport, environmentArg);
+  }
+
+  public async setWebsiteInfo(optionsArg: plugins.websetup.IWebSetupConstructorOptions) {
+    const websetup = new plugins.websetup.WebSetup(optionsArg);
+    await websetup.setup();
+  }
+}

ts/domtools.classes.scroller.ts

@@ -0,0 +1,5 @@
+import * as plugins from './domtools.plugins';
+
+export class Scroller {
+  // TODO: move sweet scroll over to here;
+}

ts/domtools.colors.ts

@@ -0,0 +1,6 @@
+export interface IDeesColorSet {
+  primaryAccent: string;
+  secondaryAccent: string;
+  primaryBackground: string;
+  secondaryBackground: string;
+}

ts/domtools.css.ts

@@ -0,0 +1,9 @@
+export const cssGridColumns = (amountOfColumnsArg: number, gapSizeArg: number) => {
+  let returnString = ``;
+  for (let i = 0; i < amountOfColumnsArg; i++) {
+    returnString += ` calc((100%/${amountOfColumnsArg}) - (${
+      gapSizeArg * (amountOfColumnsArg - 1)
+    }px/${amountOfColumnsArg}))`;
+  }
+  return returnString;
+};

ts/domtools.elementbasic.ts

@@ -0,0 +1,45 @@
+import * as plugins from './domtools.plugins';
+import { DomTools } from './domtools.classes.domtools';
+
+import { html } from 'lit-element';
+export const styles = html`
+  <style>
+    * {
+      font-family: 'Roboto', sans-serif;
+      box-sizing: border-box;
+    }
+  </style>
+`;
+
+/**
+ * a basic setup for elements
+ * makes sure everything is in check
+ */
+export const setup = async () => {
+  const domTools = await DomTools.setupDomTools();
+  domTools.runOnce('elementBasicSetup', async () => {
+    // bodyStyles
+    domTools.setGlobalStyles(`
+      body {
+        margin: 0px;
+        font-family: 'Roboto', sans-serif;
+        box-sizing: border-box;
+      }
+    `);
+
+    // material font
+    domTools.setGlobalStyles(`
+      @font-face {
+        font-family: 'Material Icons';
+        font-style: normal;
+        font-weight: 400;
+        src: url(https://fonts.gstatic.com/s/materialicons/v42/flUhRq6tzZclQEJ-Vdg-IuiaDsNcIhQ8tQ.woff2) format('woff2');
+      }
+    `);
+
+    // Roboto Font
+    domTools.setGlobalStyles(`
+      @import url('https://fonts.googleapis.com/css?family=Roboto');
+    `);
+  });
+};

ts/domtools.plugins.ts

@@ -0,0 +1,19 @@
+// api glbal scope
+import * as typedrequest from '@apiglobal/typedrequest';
+
+export { typedrequest };
+
+// pushrocks scope
+import * as smartdelay from '@pushrocks/smartdelay';
+import * as smartpromise from '@pushrocks/smartpromise';
+import * as smartrouter from '@pushrocks/smartrouter';
+import * as smartstate from '@pushrocks/smartstate';
+import * as webrequest from '@pushrocks/webrequest';
+import * as websetup from '@pushrocks/websetup';
+
+export { smartdelay, smartpromise, smartrouter, smartstate, webrequest, websetup };
+
+// third party scope
+import SweetScroll from 'sweet-scroll';
+
+export { SweetScroll };

ts/index.ts

@@ -1,8 +1,15 @@
-export * from './csstools.elementbasicsetup';
-export * from './csstools.elementbasicstyles';
+export * from './domtools.colors';
 
-import * as breakpoints from './csstools.breakpoints';
+import * as elementBasic from './domtools.elementbasic';
+import * as breakpoints from './domtools.breakpoints';
+import * as css from './domtools.css';
 
-export {
-  breakpoints
+export { css, breakpoints, elementBasic };
+export { DomTools } from './domtools.classes.domtools';
+export { TypedRequest } from '@apiglobal/typedrequest';
+
+import * as allPlugins from './domtools.plugins';
+
+export const plugins = {
+  smartpromise: allPlugins.smartpromise,
 };