1.0.86

.gitlab-ci.yml

@@ -19,23 +19,35 @@ mirror:
   stage: security
   script:
     - npmci git mirror
+  only:
+    - tags
   tags:
     - lossless
     - docker
     - notpriv
 
-audit:
+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
+
+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
+    - npmci command npm audit --audit-level=high --only=dev
   tags:
-    - lossless
     - docker
-    - notpriv
+  allow_failure: true
 
 # ====================
 # test stage
@@ -50,9 +62,7 @@ testStable:
     - npmci npm test
   coverage: /\d+.?\d+?\%\s*coverage/
   tags:
-    - lossless
     - docker
-    - priv
 
 testBuild:
   stage: test
@@ -63,9 +73,7 @@ testBuild:
     - npmci command npm run build
   coverage: /\d+.?\d+?\%\s*coverage/
   tags:
-    - lossless
     - docker
-    - notpriv
 
 release:
   stage: release
@@ -85,6 +93,8 @@ release:
 codequality:
   stage: metadata
   allow_failure: true
+  only:
+    - tags
   script:
     - npmci command npm install -g tslint typescript
     - npmci npm prepare

.vscode/settings.json

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

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@designestate/dees-domtools",
-  "version": "1.0.26",
+  "version": "1.0.86",
   "private": false,
   "description": "tools to simplify complex css structures",
   "main": "dist_ts/index.js",
@@ -13,19 +13,28 @@
     "format": "(gitzone format)"
   },
   "devDependencies": {
-    "@gitzone/tsbuild": "^2.0.22",
-    "@gitzone/tsbundle": "^1.0.69",
-    "@gitzone/tstest": "^1.0.15",
-    "@pushrocks/tapbundle": "^3.0.7",
-    "@types/node": "^14.0.5",
-    "tslint": "^6.1.2",
+    "@gitzone/tsbuild": "^2.1.25",
+    "@gitzone/tsbundle": "^1.0.80",
+    "@gitzone/tstest": "^1.0.52",
+    "@pushrocks/tapbundle": "^3.2.14",
+    "@types/node": "^14.14.33",
+    "tslint": "^6.1.3",
     "tslint-config-prettier": "^1.15.0"
   },
   "dependencies": {
-    "@pushrocks/lik": "^4.0.13",
-    "@pushrocks/smartpromise": "^3.0.6",
-    "@pushrocks/smartstate": "^1.0.16",
-    "lit-element": "^2.3.1"
+    "@apiglobal/typedrequest": "^1.0.56",
+    "@designestate/dees-comms": "^1.0.9",
+    "@pushrocks/lik": "^4.0.20",
+    "@pushrocks/smartdelay": "^2.0.10",
+    "@pushrocks/smartpromise": "^3.1.3",
+    "@pushrocks/smartrouter": "^1.0.7",
+    "@pushrocks/smartrx": "^2.0.19",
+    "@pushrocks/smartstate": "^1.0.21",
+    "@pushrocks/webrequest": "^2.0.13",
+    "@pushrocks/websetup": "^3.0.15",
+    "@pushrocks/webstore": "^1.0.16",
+    "lit-element": "^2.4.0",
+    "sweet-scroll": "^4.0.0"
   },
   "files": [
     "ts/**/*",
@@ -38,5 +47,8 @@
     "cli.js",
     "npmextra.json",
     "readme.md"
+  ],
+  "browserslist": [
+    "last 1 chrome versions"
   ]
 }

readme.md

@@ -8,15 +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/)
-[![JavaScript Style Guide](https://badgen.net/bundlephobia/minzip/@material-ui/core)](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/domtools.breakpoints.ts

@@ -1,14 +1,17 @@
 import { DomTools } from './domtools.classes.domtools';
 
 export const desktop = 1240;
-export const tablet = 700;
-export const phablet = 500;
+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) {
+  if (
+    globalThis.deesDomTools &&
+    globalThis.deesDomTools.domToolsStatePart.getState().virtualViewport
+  ) {
     return globalThis.deesDomTools.domToolsStatePart.getState().virtualViewport;
   } else {
     return 'native';

ts/domtools.classes.domtools.ts

@@ -3,16 +3,28 @@ 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';
+import { WebSetup } from '@pushrocks/websetup';
+import { ThemeManager } from './domtools.classes.thememanager';
+
 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') {
@@ -30,48 +42,74 @@ export class DomTools {
     return domToolsInstance;
   }
 
-  public smartstate = new plugins.smartstate.Smartstate();
-  public domToolsStatePart = this.smartstate.getStatePart<IDomToolsState>('domtools', {
-    virtualViewport: 'native'
-  });
-
-  public 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();
+  /**
+   * if you can, use the static asysnc .setupDomTools() function instead since it is safer to use.
+   */
+  public static getGlobalDomToolsSync(): DomTools {
+    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
+    bodyElement: null,
   };
 
-  constructor() {
+  public websetup: WebSetup = new WebSetup({
+    metaObject: {
+      title: 'loading...',
+    },
+  });
 
-  }
+  public smartstate = new plugins.smartstate.Smartstate();
+  public domToolsStatePart = this.smartstate.getStatePart<IDomToolsState>('domtools', {
+    virtualViewport: 'native',
+  });
 
-  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 router = new plugins.smartrouter.SmartRouter({
+    debug: false,
+  });
+
+  public convenience = {
+    smartdelay: plugins.smartdelay,
+  };
+
+  public deesComms = new plugins.deesComms.DeesComms();
+  public scroller = new plugins.SweetScroll({
+    /* some options */
+  }); // TODO: switch to scroller class
+  public themeManager = new ThemeManager(this);
+
+  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() {}
 
   private runOnceTrackerStringMap = new Stringmap();
   private runOnceResultMap = new FastMap();
   /**
    * run a function once and always get the Promise of the first execution
-   * @param identifierArg
-   * @param funcArg
+   * @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`;
@@ -83,7 +121,7 @@ export class DomTools {
       this.runOnceTrackerStringMap.removeString(runningId);
     }
     return await this.runOnceTrackerStringMap.registerUntilTrue(
-      stringMap => {
+      (stringMap) => {
         return !stringMap.includes(runningId);
       },
       () => {
@@ -92,7 +130,30 @@ export class DomTools {
     );
   }
 
-  setVirtualViewport(environmentArg: TViewport) {
+  // 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 async setExternalCss(cssLinkArg: string) {
+    const cssTag = document.createElement('link');
+    cssTag.rel = 'stylesheet';
+    cssTag.crossOrigin = 'anonymous';
+    cssTag.href = cssLinkArg;
+    document.head.append(cssTag);
+  }
+
+  public setVirtualViewport(environmentArg: TViewport) {
     this.domToolsStatePart.dispatchAction(this.actionSetVirtualViewport, environmentArg);
   }
+
+  public async setWebsiteInfo(optionsArg: plugins.websetup.IWebSetupConstructorOptions) {
+    await this.websetup.setup(optionsArg);
+    await this.websetup.readyPromise;
+  }
 }

ts/domtools.classes.router.ts

@@ -1 +0,0 @@
-import * as plugins from './domtools.plugins';

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.classes.thememanager.ts

@@ -0,0 +1,46 @@
+import { LitElement } from 'lit-element';
+import { DomTools } from './domtools.classes.domtools';
+import * as plugins from './domtools.plugins';
+
+export class ThemeManager {
+  public domtoolsRef: DomTools;
+
+  public goBrightBoolean = false;
+  public preferredColorSchemeMediaMatch = window.matchMedia('(prefers-color-scheme: light)');
+
+  public themeObservable = new plugins.smartrx.rxjs.ReplaySubject<boolean>(1);
+
+  constructor(domtoolsRefArg: DomTools) {
+    this.domtoolsRef = domtoolsRefArg;
+
+    // lets care
+    this.goBrightBoolean = this.preferredColorSchemeMediaMatch.matches;
+    this.preferredColorSchemeMediaMatch.addEventListener('change', (eventArg) => {
+      this.goBrightBoolean = eventArg.matches;
+      this.updateAllConnectedElements();
+    });
+    this.updateAllConnectedElements();
+  }
+
+  private async updateAllConnectedElements() {
+    if (document.body && document.body.style) {
+      document.body.style.background = this.goBrightBoolean ? '#fff' : '#000';
+    }
+    this.themeObservable.next(this.goBrightBoolean);
+  }
+
+  public goBright() {
+    this.goBrightBoolean = true;
+    this.updateAllConnectedElements();
+  }
+
+  public goDark() {
+    this.goBrightBoolean = false;
+    this.updateAllConnectedElements();
+  }
+
+  public toggleDarkBright() {
+    this.goBrightBoolean = !this.goBrightBoolean;
+    this.updateAllConnectedElements();
+  }
+}

ts/domtools.css.theme.ts

@@ -0,0 +1,31 @@
+import { DomTools } from './domtools.classes.domtools';
+
+/**
+ * changes scrollbar styles to be consistent across OS borders
+ */
+export const scrollBarStyles = (() => {
+  const returnStyles =
+    navigator.userAgent.indexOf('Windows') !== -1
+      ? `
+  /* width */
+  ::-webkit-scrollbar {
+    width: 8px;
+  }
+
+  /* Track */
+  ::-webkit-scrollbar-track {
+    background: #111; 
+  }
+
+  /* Handle */
+  ::-webkit-scrollbar-thumb {
+    background: #666; 
+  }
+
+  /* Handle on hover */
+  ::-webkit-scrollbar-thumb:hover {
+    background: #777; 
+  }
+`
+      : ``;
+})();

ts/domtools.css.ts

@@ -1,8 +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}))`;
+    returnString += ` calc((100%/${amountOfColumnsArg}) - (${
+      gapSizeArg * (amountOfColumnsArg - 1)
+    }px/${amountOfColumnsArg}))`;
   }
   return returnString;
 };

ts/domtools.elementbasic.ts

@@ -1,13 +1,24 @@
 import * as plugins from './domtools.plugins';
 import { DomTools } from './domtools.classes.domtools';
+import { scrollBarStyles } from './domtools.css.theme';
 
-import { html } from 'lit-element';
+import { html, LitElement } from 'lit-element';
+
+/**
+ * styles to be included in every webcomponent
+ */
 export const styles = html`
   <style>
     * {
-      font-family: 'Roboto', sans-serif;
+      transition: background 0.1s, color 0.1s;
       box-sizing: border-box;
     }
+
+    :host {
+      font-family: 'Roboto', sans-serif;
+    }
+
+    ${scrollBarStyles}
   </style>
 `;
 
@@ -15,8 +26,14 @@ export const styles = html`
  * a basic setup for elements
  * makes sure everything is in check
  */
-export const setup = async () => {
+export const setup = async (elementArg?: LitElement): Promise<DomTools> => {
   const domTools = await DomTools.setupDomTools();
+
+  if (elementArg) {
+    // lets do something with the element
+    // not used right now
+  }
+
   domTools.runOnce('elementBasicSetup', async () => {
     // bodyStyles
     domTools.setGlobalStyles(`
@@ -39,7 +56,14 @@ export const setup = async () => {
 
     // Roboto Font
     domTools.setGlobalStyles(`
-      @import url('https://fonts.googleapis.com/css?family=Roboto');
+      @import url('https://fonts.googleapis.com/css2?family=Roboto:wght@100;300;400');
+      @import url('https://fonts.googleapis.com/css2?family=Roboto+Mono:wght@100;300;400');
+    `);
+
+    // scrollbars
+    domTools.setGlobalStyles(`
+      ${scrollBarStyles}
     `);
   });
+  return domTools;
 };

ts/domtools.plugins.ts

@@ -1,5 +1,42 @@
-// pushrocks scope
-import * as smartpromise from '@pushrocks/smartpromise';
-import * as smartstate from '@pushrocks/smartstate';
+// designestate scope
+import * as deesComms from '@designestate/dees-comms';
 
-export { smartpromise, smartstate };
+export { deesComms };
+
+// apiglobal 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 smartrx from '@pushrocks/smartrx';
+import * as smartstate from '@pushrocks/smartstate';
+import * as webrequest from '@pushrocks/webrequest';
+import * as websetup from '@pushrocks/websetup';
+import * as webstore from '@pushrocks/webstore';
+
+// subscope lik
+import { ObjectMap } from '@pushrocks/lik/dist_ts/lik.objectmap';
+const lik = {
+  ObjectMap,
+};
+
+export {
+  lik,
+  smartdelay,
+  smartpromise,
+  smartrouter,
+  smartrx,
+  smartstate,
+  webrequest,
+  websetup,
+  webstore,
+};
+
+// third party scope
+import SweetScroll from 'sweet-scroll';
+
+export { SweetScroll };

ts/index.ts

@@ -6,3 +6,11 @@ import * as css from './domtools.css';
 
 export { css, breakpoints, elementBasic };
 export { DomTools } from './domtools.classes.domtools';
+export { TypedRequest } from '@apiglobal/typedrequest';
+export { IWebSetupConstructorOptions } from '@pushrocks/websetup';
+
+import * as allPlugins from './domtools.plugins';
+
+export const plugins = {
+  smartpromise: allPlugins.smartpromise,
+};