@design.estate/dees-wcctools 1.0.77

package/license

@@ -0,0 +1,19 @@
+Copyright (c) 2020 Lossless GmbH (hello@lossless.com)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/npmextra.json

@@ -0,0 +1,18 @@
+{
+  "gitzone": {
+    "projectType": "wcc",
+    "module": {
+      "githost": "gitlab.com",
+      "gitscope": "designestate",
+      "gitrepo": "dees-wcctools",
+      "description": "wcc tools for creating element catalogues",
+      "npmPackagename": "@designestate/dees-wcctools",
+      "license": "MIT",
+      "projectDomain": "design.estate"
+    }
+  },
+  "npmci": {
+    "npmGlobalTools": [],
+    "npmAccessLevel": "public"
+  }
+}

package/package.json

@@ -0,0 +1,46 @@
+{
+  "name": "@design.estate/dees-wcctools",
+  "version": "1.0.77",
+  "private": false,
+  "description": "wcc tools for creating element catalogues",
+  "main": "dist_ts_web/index.js",
+  "typings": "dist_ts_web/index.d.ts",
+  "type": "module",
+  "scripts": {
+    "test": "(npm run build)",
+    "build": "(tsbuild element --web --allowimplicitany && tsbundle element)",
+    "watch": "tswatch element",
+    "buildDocs": "tsdoc"
+  },
+  "author": "Lossless GmbH",
+  "license": "UNLICENSED",
+  "dependencies": {
+    "@design.estate/dees-domtools": "^2.0.6",
+    "@design.estate/dees-element": "^2.0.6",
+    "@gitzone/tsrun": "^1.2.44",
+    "@push.rocks/smartdelay": "^3.0.5",
+    "lit": "^2.8.0"
+  },
+  "devDependencies": {
+    "@api.global/typedserver": "^3.0.4",
+    "@gitzone/tsbuild": "^2.1.66",
+    "@gitzone/tsbundle": "^2.0.8",
+    "@gitzone/tswatch": "^2.0.7",
+    "@push.rocks/projectinfo": "^5.0.1"
+  },
+  "files": [
+    "ts/**/*",
+    "ts_web/**/*",
+    "dist/**/*",
+    "dist_*/**/*",
+    "dist_ts/**/*",
+    "dist_ts_web/**/*",
+    "assets/**/*",
+    "cli.js",
+    "npmextra.json",
+    "readme.md"
+  ],
+  "browserslist": [
+    "last 1 Chrome versions"
+  ]
+}

package/readme.md

@@ -0,0 +1,39 @@
+# @designestate/dees-wcctools
+wcc tools for creating element catalogues
+
+## Availabililty and Links
+* [npmjs.org (npm package)](https://www.npmjs.com/package/@designestate/dees-wcctools)
+* [gitlab.com (source)](https://gitlab.com/designestate/dees-wcctools)
+* [github.com (source mirror)](https://github.com/designestate/dees-wcctools)
+* [docs (typedoc)](https://designestate.gitlab.io/dees-wcctools/)
+
+## Status for master
+
+Status Category | Status Badge
+-- | --
+GitLab Pipelines | [![pipeline status](https://gitlab.com/designestate/dees-wcctools/badges/master/pipeline.svg)](https://lossless.cloud)
+GitLab Pipline Test Coverage | [![coverage report](https://gitlab.com/designestate/dees-wcctools/badges/master/coverage.svg)](https://lossless.cloud)
+npm | [![npm downloads per month](https://badgen.net/npm/dy/@designestate/dees-wcctools)](https://lossless.cloud)
+Snyk | [![Known Vulnerabilities](https://badgen.net/snyk/designestate/dees-wcctools)](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-wcctools)](https://lossless.cloud)
+PackagePhobia (package size on registry) | [![PackagePhobia](https://badgen.net/packagephobia/publish/@designestate/dees-wcctools)](https://lossless.cloud)
+BundlePhobia (total size when bundled) | [![BundlePhobia](https://badgen.net/bundlephobia/minzip/@designestate/dees-wcctools)](https://lossless.cloud)
+
+## Usage
+
+## Contribution
+
+We are always happy for code contributions. If you are not the code contributing type that is ok. Still, maintaining Open Source repositories takes considerable time and thought. If you like the quality of what we do and our modules are useful to you we would appreciate a little monthly contribution: You can [contribute one time](https://lossless.link/contribute-onetime) or [contribute monthly](https://lossless.link/contribute). :)
+
+## Contribution
+
+We are always happy for code contributions. If you are not the code contributing type that is ok. Still, maintaining Open Source repositories takes considerable time and thought. If you like the quality of what we do and our modules are useful to you we would appreciate a little monthly contribution: You can [contribute one time](https://lossless.link/contribute-onetime) or [contribute monthly](https://lossless.link/contribute). :)
+
+For further information read the linked docs at the top of this readme.
+
+## 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)

package/ts_web/00_commitinfo_data.ts

@@ -0,0 +1,8 @@
+/**
+ * autocreated commitinfo by @pushrocks/commitinfo
+ */
+export const commitinfo = {
+  name: '@design.estate/dees-wcctools',
+  version: '1.0.77',
+  description: 'wcc tools for creating element catalogues'
+}

package/ts_web/elements/wcc-dashboard.ts

@@ -0,0 +1,177 @@
+import { DeesElement, property, html, customElement, type TemplateResult, queryAsync, render, domtools } from '@design.estate/dees-element';
+
+import * as plugins from '../wcctools.plugins.js';
+
+// wcc tools
+import './wcc-frame.js';
+import './wcc-sidebar.js';
+import './wcc-properties.js';
+import { type TTheme } from './wcc-properties.js';
+import { type TElementType } from './wcc-sidebar.js';
+import { breakpoints } from '@design.estate/dees-domtools';
+import { WccFrame } from './wcc-frame.js';
+
+@customElement('wcc-dashboard')
+export class WccDashboard extends DeesElement {
+
+  @property()
+  public selectedType: TElementType;
+
+  @property()
+  public selectedItemName: string;
+
+  @property()
+  public selectedItem: (() => TemplateResult) | DeesElement;
+
+  @property()
+  public selectedViewport: plugins.deesDomtools.breakpoints.TViewport = 'desktop';
+
+  @property()
+  public selectedTheme: TTheme = 'dark';
+
+  @property()
+  public pages: { [key: string]: () => TemplateResult } = {};
+
+  @property()
+  public elements: { [key: string]: DeesElement } = {};
+
+  @property()
+  public warning: string = null;
+  
+  @queryAsync('wcc-frame')
+  public wccFrame: Promise<WccFrame>;
+
+  constructor(
+    elementsArg?: { [key: string]: DeesElement },
+    pagesArg?: { [key: string]: () => TemplateResult }
+  ) {
+    super();
+    if (elementsArg) {
+      this.elements = elementsArg;
+      console.log('got elements:');
+      console.log(this.elements);
+    }
+
+    if (pagesArg) {
+      this.pages = pagesArg;
+    }
+  }
+
+  public render(): TemplateResult {
+    return html`
+      <style>
+        :host {
+          font-family: 'Roboto', sans-serif;
+          background: #fcfcfc;
+          display: block;
+          box-sizing: border-box;
+        }
+        :host([hidden]) {
+          display: none;
+        }
+      </style>
+      <wcc-sidebar
+        .dashboardRef=${this}
+        .selectedItem=${this.selectedItem}
+        @selectedType=${(eventArg) => {
+          this.selectedType = eventArg.detail;
+        }}
+        @selectedItemName=${(eventArg) => {
+          this.selectedItemName = eventArg.detail;
+        }}
+        @selectedItem=${(eventArg) => {
+          this.selectedItem = eventArg.detail;
+        }}
+      ></wcc-sidebar>
+      <wcc-properties
+        .dashboardRef=${this}
+        .warning="${this.warning}"
+        .selectedItem=${this.selectedItem}
+        .selectedViewport=${this.selectedViewport}
+        .selectedTheme=${this.selectedTheme}
+        @selectedViewport=${(eventArg) => {
+          this.selectedViewport = eventArg.detail;
+          this.scheduleUpdate();
+        }}
+        @selectedTheme=${(eventArg) => {
+          this.selectedTheme = eventArg.detail;
+        }}
+      ></wcc-properties>
+      <wcc-frame id="wccFrame" viewport=${this.selectedViewport}>
+      </wcc-frame>
+    `;
+  }
+
+  public setWarning(warningTextArg: string) {
+    if (this.warning !== warningTextArg) {
+      console.log(warningTextArg);
+      this.warning = warningTextArg;
+      setTimeout(() => {
+        this.scheduleUpdate();
+      }, 0);
+    }
+  }
+
+  public async firstUpdated() {
+    this.domtools = await plugins.deesDomtools.DomTools.setupDomTools();
+    this.domtools.router.on(
+      '/wcctools-route/:itemType/:itemName/:viewport/:theme',
+      async (routeInfo) => {
+        this.selectedType = routeInfo.params.itemType as TElementType;
+        this.selectedItemName = routeInfo.params.itemName;
+        this.selectedViewport = routeInfo.params.viewport as breakpoints.TViewport;
+        this.selectedTheme = routeInfo.params.theme as TTheme;
+        if (routeInfo.params.itemType === 'element') {
+          this.selectedItem = this.elements[routeInfo.params.itemName];
+        } else if (routeInfo.params.itemType === 'page') {
+          this.selectedItem = this.pages[routeInfo.params.itemName];
+        }
+        const domtoolsInstance = await plugins.deesDomtools.elementBasic.setup();
+        this.selectedTheme === 'bright'
+          ? domtoolsInstance.themeManager.goBright()
+          : domtoolsInstance.themeManager.goDark();
+      }
+    );
+  }
+
+  public async updated() {
+    this.domtools = await plugins.deesDomtools.DomTools.setupDomTools();
+    await this.domtools.router._handleRouteState();
+    const storeElement = this.selectedItem;
+    const wccFrame: WccFrame = this.shadowRoot.querySelector('wcc-frame');
+
+    if (this.selectedType === 'page' && this.selectedItem) {
+      if (typeof this.selectedItem === 'function') {
+        console.log('slotting page.');
+        const viewport = await wccFrame.getViewportElement();
+        render(this.selectedItem(), viewport);
+        console.log('rendered page.');
+      } else {
+        console.error('The selected item looks strange:');
+        console.log(this.selectedItem);
+      }
+    } else if (this.selectedType === 'element' && this.selectedItem) {
+      console.log('slotting element.');
+      const anonItem: any = this.selectedItem;
+      if (!anonItem.demo) {
+        this.setWarning(`component ${anonItem.name} does not expose a demo property.`);
+        return;
+      }
+      if (!(typeof anonItem.demo === 'function')) {
+        this.setWarning(
+          `component ${anonItem.name} has demo property, but it is not of type function`
+        );
+        return;
+      }
+      this.setWarning(null);
+      const viewport = await wccFrame.getViewportElement();
+      render(anonItem.demo(), viewport);;
+    }
+  }
+
+  public buildUrl() {
+    this.domtools.router.pushUrl(
+      `/wcctools-route/${this.selectedType}/${this.selectedItemName}/${this.selectedViewport}/${this.selectedTheme}`
+    );
+  }
+}

package/ts_web/elements/wcc-frame.ts

@@ -0,0 +1,115 @@
+import { DeesElement, property, html, customElement, type TemplateResult, css, cssManager } from '@design.estate/dees-element';
+
+import * as domtools from '@design.estate/dees-domtools';
+
+declare global {
+  interface HTMLElementTagNameMap {
+    'wcc-frame': WccFrame;
+  }
+}
+
+@customElement('wcc-frame')
+export class WccFrame extends DeesElement {
+  @property()
+  public viewport: string;
+
+  public static styles = [
+    css`
+      :host {
+        border: 10px solid #ffaeaf;
+        position: absolute;
+        background: ${cssManager.bdTheme('#333', '#000')};
+        left: 200px;
+        right: 0px;
+        top: 0px;
+        bottom: 100px;
+        overflow-y: auto;
+        overflow-x: auto;
+      }
+
+      .viewport {
+        container-type: inline-size;
+        container-name: wccToolsViewport;
+        position: relative;
+        min-height: 100%;
+      }
+    `,
+  ]
+
+  public render(): TemplateResult {
+    return html`
+      <style>
+        :host {
+          ${(() => {
+          switch (this.viewport) {
+            case 'desktop':
+              return `
+                  padding: 0px 0px;
+                `;
+            case 'tablet':
+              return `
+                  padding: 0px ${
+                    (document.body.clientWidth - 200 - domtools.breakpoints.tablet) / 2
+                  }px;
+                `;
+            case 'phablet':
+              return `
+                  padding: 0px ${
+                    (document.body.clientWidth - 200 - domtools.breakpoints.phablet) / 2
+                  }px;
+                `;
+            case 'phone':
+              return `
+                  padding: 0px ${
+                    (document.body.clientWidth - 200 - domtools.breakpoints.phone) / 2
+                  }px;
+                `;
+          }
+          })()}
+        }
+
+        .viewport {
+          ${this.viewport !== 'desktop'
+            ? html` border-right: 1px dotted #444; border-left: 1px dotted #444; `
+            : html``
+          }
+          background:
+          ${
+            this.goBright ? `
+              radial-gradient(#CCCCCC 3px, transparent 4px),
+              radial-gradient(#CCCCCC 3px, transparent 4px),
+              linear-gradient(#eeeeee 4px, transparent 0),
+              linear-gradient(45deg, transparent 74px, transparent 75px, #CCCCCC 75px, #CCCCCC 76px, transparent 77px, transparent 109px),
+              linear-gradient(-45deg, transparent 75px, transparent 76px, #CCCCCC 76px, #CCCCCC 77px, transparent 78px, transparent 109px),
+              #eeeeee;
+              background-size: 109px 109px, 109px 109px,100% 6px, 109px 109px, 109px 109px;
+              background-position: 54px 55px, 0px 0px, 0px 0px, 0px 0px, 0px 0px;
+            ` : `
+              radial-gradient(#444444 3px, transparent 4px),
+              radial-gradient(#444444 3px, transparent 4px),
+              linear-gradient(#222222 4px, transparent 0),
+              linear-gradient(45deg, transparent 74px, transparent 75px, #444444 75px, #444444 76px, transparent 77px, transparent 109px),
+              linear-gradient(-45deg, transparent 75px, transparent 76px, #444444 76px, #444444 77px, transparent 78px, transparent 109px),
+              #222222;
+              background-size: 109px 109px, 109px 109px,100% 6px, 109px 109px, 109px 109px;
+              background-position: 54px 55px, 0px 0px, 0px 0px, 0px 0px, 0px 0px;
+            `
+          }
+        }
+      </style>
+      <div class="viewport">
+        
+      </div>
+    `;
+  }
+
+  public async getDisplayedInstance() {
+    await this.updateComplete;
+    const slottedContent = this.children;
+    console.log(slottedContent);
+  }
+
+  public async getViewportElement(): Promise<HTMLElement> {
+    return this.shadowRoot.querySelector('.viewport') as HTMLElement;
+  }
+}