@justeattakeaway/pie-button 0.10.1 → 0.10.2

package/.turbo/turbo-build.log

@@ -0,0 +1,11 @@
+vite v4.2.1 building for production...
+transforming...
+✓ 4 modules transformed.
+rendering chunks...
+computing gzip size...
+dist/index.js  3.85 kB │ gzip: 1.61 kB
+
+[vite:dts] Start generate declaration files...
+✓ built in 8.24s
+[vite:dts] Declaration files built in 7676ms.
+

package/CHANGELOG.md

@@ -1,10 +1,16 @@
 # Changelog
 
+## 0.10.2
+
+### Patch Changes
+
+- [Added] Declare global statement back in. ([#393](https://github.com/justeattakeaway/pie/pull/393)) by [@kevinrodrigues](https://github.com/kevinrodrigues)
+
 ## 0.10.1
 
 ### Patch Changes
 
-- [Fixed] - Added module entry for component
+- [Fixed] - Added module entry for component ([#378](https://github.com/justeattakeaway/pie/pull/378)) by [@ashleynolan](https://github.com/ashleynolan)
 
 ## 0.10.0
 

package/dist/index.js

@@ -1,51 +1,51 @@
 import { unsafeCSS as f, LitElement as h, html as g } from "lit";
 import { classMap as m } from "lit/directives/class-map.js";
-import { property as u, customElement as v } from "lit/decorators.js";
+import { property as b, customElement as v } from "lit/decorators.js";
 const x = `.o-btn{border-radius:50rem;border:none;font-family:JetSansDigital;font-weight:700;cursor:pointer;user-select:none;outline:none}.o-btn:focus-visible{outline:2px solid #4996fd}.o-btn--xsmall{padding:6px 8px;min-height:32px;font-size:14px;line-height:20px}.o-btn--small{padding:8px 16px;min-height:40px;font-size:19px;line-height:28px}.o-btn--medium{padding:10px 24px;min-height:48px;font-size:20px;line-height:28px}.o-btn--large{padding:14px 24px;min-height:56px;font-size:20px;line-height:28px}.o-btn--primary{background-color:#f36805;color:#fff}.o-btn--primary:hover{background-color:#df5f05}.o-btn--primary:active{background-color:#b74e04}.o-btn--secondary{background-color:#f5f3f1;color:#242e30}.o-btn--secondary:hover{background-color:#ede9e5}.o-btn--secondary:active{background-color:#dcd4cd}.o-btn--outline{outline:1px solid #dbd9d7;background-color:#fff;color:#303d3f}.o-btn--outline:hover{background-color:#f5f5f5}.o-btn--outline:active{background-color:#e0e0e0}.o-btn--ghost{background-color:#fff;color:#242e30}.o-btn--ghost:hover{background-color:#f5f5f5}.o-btn--ghost:active{background-color:#e0e0e0}.o-btn.o-btn--is-disabled{background-color:#efedea;color:#8c999b;outline:1px solid #efedea;cursor:default}.o-btn.o-btn--is-disabled.o-btn--ghost{background-color:#fff;outline:none}
-`, p = (o, n) => function(i, t) {
-  const e = `#${t}`;
+`, p = (e, n) => function(i, t) {
+  const o = `#${t}`;
   Object.defineProperty(i, t, {
     get() {
-      return this[e];
+      return this[o];
     },
     set(r) {
-      const s = this[e];
-      o.includes(r) ? this[e] = r : (console.error(
+      const s = this[o];
+      e.includes(r) ? this[o] = r : (console.error(
         `[pie-button] Invalid value "${r}" provided for property "${t}".`,
-        `Must be one of: ${o.join(" | ")}.`,
+        `Must be one of: ${e.join(" | ")}.`,
         `Falling back to default value: "${n}"`
-      ), this[e] = n), this.requestUpdate(t, s);
+      ), this[o] = n), this.requestUpdate(t, s);
     }
   });
 };
-var a = /* @__PURE__ */ ((o) => (o.XSMALL = "xsmall", o.SMALL = "small", o.MEDIUM = "medium", o.LARGE = "large", o))(a || {}), d = /* @__PURE__ */ ((o) => (o.SUBMIT = "submit", o.BUTTON = "button", o.RESET = "reset", o.MENU = "menu", o))(d || {}), b = /* @__PURE__ */ ((o) => (o.PRIMARY = "primary", o.SECONDARY = "secondary", o.OUTLINE = "outline", o.GHOST = "ghost", o))(b || {}), y = Object.defineProperty, M = Object.getOwnPropertyDescriptor, c = (o, n, i, t) => {
-  for (var e = t > 1 ? void 0 : t ? M(n, i) : n, r = o.length - 1, s; r >= 0; r--)
-    (s = o[r]) && (e = (t ? s(n, i, e) : s(e)) || e);
-  return t && e && y(n, i, e), e;
+var a = /* @__PURE__ */ ((e) => (e.XSMALL = "xsmall", e.SMALL = "small", e.MEDIUM = "medium", e.LARGE = "large", e))(a || {}), d = /* @__PURE__ */ ((e) => (e.SUBMIT = "submit", e.BUTTON = "button", e.RESET = "reset", e.MENU = "menu", e))(d || {}), u = /* @__PURE__ */ ((e) => (e.PRIMARY = "primary", e.SECONDARY = "secondary", e.OUTLINE = "outline", e.GHOST = "ghost", e))(u || {}), y = Object.defineProperty, M = Object.getOwnPropertyDescriptor, c = (e, n, i, t) => {
+  for (var o = t > 1 ? void 0 : t ? M(n, i) : n, r = e.length - 1, s; r >= 0; r--)
+    (s = e[r]) && (o = (t ? s(n, i, o) : s(o)) || o);
+  return t && o && y(n, i, o), o;
 };
-function k(o) {
+function k(e) {
   return (n) => {
-    if (!customElements.get(o))
-      return v(o)(n);
+    if (!customElements.get(e))
+      return v(e)(n);
   };
 }
 let l = class extends h {
   constructor() {
-    super(...arguments), this.size = a.MEDIUM, this.type = d.SUBMIT, this.variant = b.PRIMARY, this.disabled = !1;
+    super(...arguments), this.size = a.MEDIUM, this.type = d.SUBMIT, this.variant = u.PRIMARY, this.disabled = !1;
   }
   render() {
-    const { size: o, type: n, variant: i, disabled: t } = this, e = {
+    const { size: e, type: n, variant: i, disabled: t } = this, o = {
       "o-btn": !0,
-      [`o-btn--${o}`]: o,
+      [`o-btn--${e}`]: e,
       [`o-btn--${i}`]: i,
       "o-btn--is-disabled": t
     }, r = () => {
-      const s = new Event("CustomEvent");
+      const s = new CustomEvent("CustomEvent", { detail: "WC event dispatched" });
       console.info("WC event dispatched"), this.dispatchEvent(s);
     };
     return g`
             <button
-                class=${m(e)}
+                class=${m(o)}
                 type=${n}
                 ?disabled=${t}
                 @click="${r}">
@@ -55,19 +55,19 @@ let l = class extends h {
 };
 l.styles = f(x);
 c([
-  u(),
+  b(),
   p(Object.values(a), a.MEDIUM)
 ], l.prototype, "size", 2);
 c([
-  u(),
+  b(),
   p(Object.values(d), d.SUBMIT)
 ], l.prototype, "type", 2);
 c([
-  u(),
-  p(Object.values(b), b.PRIMARY)
+  b(),
+  p(Object.values(u), u.PRIMARY)
 ], l.prototype, "variant", 2);
 c([
-  u({ type: Boolean, reflect: !0 })
+  b({ type: Boolean, reflect: !0 })
 ], l.prototype, "disabled", 2);
 l = c([
   k("pie-button")
@@ -75,6 +75,6 @@ l = c([
 export {
   a as BUTTON_SIZE,
   d as BUTTON_TYPE,
-  b as BUTTON_VARIANT,
+  u as BUTTON_VARIANT,
   l as PieButton
 };

package/dist/types/src/index.d.ts

@@ -9,4 +9,9 @@ export declare class PieButton extends LitElement {
     render(): import("lit-html").TemplateResult<1>;
     static styles: import("lit").CSSResult;
 }
+declare global {
+    interface HTMLElementTagNameMap {
+        'pie-button': PieButton;
+    }
+}
 //# sourceMappingURL=index.d.ts.map

package/dist/types/src/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAmB,MAAM,KAAK,CAAC;AAMlD,OAAO,EAAE,WAAW,EAAE,WAAW,EAAE,cAAc,EAAE,MAAM,QAAQ,CAAC;AAGlE,OAAO,EAAE,WAAW,EAAE,WAAW,EAAE,cAAc,EAAE,CAAC;AAWpD,qBACa,SAAU,SAAQ,UAAU;IAGrC,IAAI,EAAG,WAAW,CAAsB;IAIxC,IAAI,EAAG,WAAW,CAAsB;IAIxC,OAAO,EAAG,cAAc,CAA0B;IAGlD,QAAQ,EAAG,OAAO,CAAS;IAE3B,MAAM;IA2BN,MAAM,CAAC,MAAM,0BAAqB;CACrC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAmB,MAAM,KAAK,CAAC;AAMlD,OAAO,EAAE,WAAW,EAAE,WAAW,EAAE,cAAc,EAAE,MAAM,QAAQ,CAAC;AAGlE,OAAO,EAAE,WAAW,EAAE,WAAW,EAAE,cAAc,EAAE,CAAC;AAWpD,qBACa,SAAU,SAAQ,UAAU;IAGrC,IAAI,EAAG,WAAW,CAAsB;IAIxC,IAAI,EAAG,WAAW,CAAsB;IAIxC,OAAO,EAAG,cAAc,CAA0B;IAGlD,QAAQ,EAAG,OAAO,CAAS;IAE3B,MAAM;IA2BN,MAAM,CAAC,MAAM,0BAAqB;CACrC;AAED,OAAO,CAAC,MAAM,CAAC;IACX,UAAU,qBAAqB;QAC3B,YAAY,EAAE,SAAS,CAAC;KAC3B;CACJ"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@justeattakeaway/pie-button",
-  "version": "0.10.1",
+  "version": "0.10.2",
   "description": "PIE design system button built using web components",
   "type": "module",
   "main": "dist/index.js",
@@ -10,7 +10,11 @@
     "build": "run -T vite build",
     "watch": "run -T vite build --watch",
     "dev": "run -T vite",
-    "test": "echo \"Error: no test specified\" && exit 0"
+    "test": "echo \"Error: no test specified\" && exit 0",
+    "test:browsers": "npx playwright test -c ./playwright-lit.config.ts",
+    "test:browsers:ci": "yarn test:browsers",
+    "test:visual": "run -T cross-env-shell PERCY_TOKEN=${PERCY_TOKEN_PIE_BUTTON} percy exec --allowed-hostname cloudfront.net -- npx playwright test -c ./playwright-lit-visual.config.ts",
+    "test:visual:ci": "yarn test:visual"
   },
   "author": "JustEatTakeaway - Design System Web Team",
   "license": "Apache-2.0",

package/playwright/index.html

@@ -0,0 +1,41 @@
+<!DOCTYPE html>
+<html lang="en">
+  <head>
+    <meta charset="UTF-8" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+    <link rel="preload" href="https://d30v2pzvrfyzpo.cloudfront.net/fonts/JETSansDigital-Regular-optimised.woff2" as="font" type="font/woff2" crossorigin>
+    <link rel="preload" href="https://d30v2pzvrfyzpo.cloudfront.net/fonts/JETSansDigital-Bold-optimised.woff2" as="font" type="font/woff2" crossorigin>
+    <link rel="preload" href="https://d30v2pzvrfyzpo.cloudfront.net/fonts/JETSansDigital-ExtraBold-optimised.woff2" as="font" type="font/woff2" crossorigin>
+<style>
+    @font-face {
+        font-family: JETSansDigital;
+        src: url('https://d30v2pzvrfyzpo.cloudfront.net/fonts/JETSansDigital-Regular-optimised.woff2') format("woff2"),
+        url('https://d30v2pzvrfyzpo.cloudfront.net/fonts/JETSansDigital-Regular-optimised.woff') format("woff");
+        font-weight: 400;
+        font-display: swap;
+    }
+    @font-face {
+        font-family: JETSansDigital;
+        src: url('https://d30v2pzvrfyzpo.cloudfront.net/fonts/JETSansDigital-Bold-optimised.woff2') format("woff2"),
+        url('https://d30v2pzvrfyzpo.cloudfront.net/fonts/JETSansDigital-Bold-optimised.woff') format("woff");
+        font-weight: 700;
+        font-display: swap;
+    }
+    @font-face {
+        font-family: JETSansDigital;
+        src: url('https://d30v2pzvrfyzpo.cloudfront.net/fonts/JETSansDigital-ExtraBold-optimised.woff2') format("woff2"),
+        url('https://d30v2pzvrfyzpo.cloudfront.net/fonts/JETSansDigital-ExtraBold-optimised.woff') format("woff");
+        font-weight: 800;
+        font-display: swap;
+    }
+    body {
+        font-feature-settings: "tnum"; /* Enable tabular numbers */
+    }
+</style>
+    <title>Testing Page</title>
+  </head>
+  <body>
+    <div id="root"></div>
+    <script type="module" src="./index.ts"></script>
+  </body>
+</html>

package/playwright/index.ts

@@ -0,0 +1 @@
+//Import common styles here

package/playwright-lit-visual.config.ts

@@ -0,0 +1,43 @@
+import { defineConfig, devices } from '@sand4rt/experimental-ct-web';
+import { resolve } from 'path';
+
+/**
+ * See https://playwright.dev/docs/test-configuration.
+ */
+export default defineConfig({
+  /* Maximum time one test can run for. */
+  timeout: 10 * 1000,
+  /* Run tests in files in parallel */
+  fullyParallel: true,
+  /* Fail the build on CI if you accidentally left test.only in the source code. */
+  forbidOnly: !!process.env.CI,
+  /* Retry on CI only */
+  retries: process.env.CI ? 2 : 0,
+  /* Opt out of parallel tests on CI. */
+  workers: '50%',
+  /* Reporter to use. See https://playwright.dev/docs/test-reporters */
+  reporter: [['html', { outputFolder: 'lit-visual-report' }]],
+  /* Shared settings for all the projects below. See https://playwright.dev/docs/api/class-testoptions. */
+  use: {
+    ctViteConfig: {
+      resolve: {
+        alias: {
+          '@': resolve('./src'),
+        },
+      },
+    },
+    /* Collect trace when retrying the failed test. See https://playwright.dev/docs/trace-viewer */
+    trace: 'on',
+  },
+
+  /* Configure projects for major browsers */
+  projects: [
+    {
+      name: 'component:chrome',
+      use: {
+        ...devices['Desktop Chrome'],
+      },
+      testMatch: ['**/test/visual/*.spec.ts']
+    }
+  ],
+});

package/playwright-lit.config.ts

@@ -0,0 +1,52 @@
+import { defineConfig, devices } from '@sand4rt/experimental-ct-web';
+import { resolve } from 'path';
+
+/**
+ * See https://playwright.dev/docs/test-configuration.
+ */
+export default defineConfig({
+  /* The base directory, relative to the config file, for snapshot files created with toMatchSnapshot and toHaveScreenshot. */
+  snapshotDir: './__snapshots__',
+  /* Maximum time one test can run for. */
+  timeout: 10 * 1000,
+  /* Run tests in files in parallel */
+  fullyParallel: true,
+  /* Fail the build on CI if you accidentally left test.only in the source code. */
+  forbidOnly: !!process.env.CI,
+  /* Retry on CI only */
+  retries: process.env.CI ? 2 : 0,
+  /* Opt out of parallel tests on CI. */
+  workers: '50%',
+  /* Reporter to use. See https://playwright.dev/docs/test-reporters */
+  reporter: [['html', { outputFolder: 'lit-browsers-report' }]],
+  /* Shared settings for all the projects below. See https://playwright.dev/docs/api/class-testoptions. */
+  use: {
+    ctViteConfig: {
+      resolve: {
+        alias: {
+          '@': resolve('./src'),
+        },
+      },
+    },
+    /* Collect trace when retrying the failed test. See https://playwright.dev/docs/trace-viewer */
+    trace: 'on',
+  },
+
+  /* Configure projects for major browsers */
+  projects: [
+    {
+      name: 'component:chrome',
+      use: {
+        ...devices['Desktop Chrome'],
+      },
+      testMatch: ['**/test/component/*.spec.ts']
+    },
+    {
+      name: 'a11y:chrome',
+      use: {
+        ...devices['Desktop Chrome'],
+      },
+      testMatch: ['**/test/accessibility/*.spec.ts']
+    },
+  ],
+});

package/src/index.ts

@@ -46,7 +46,7 @@ export class PieButton extends LitElement {
         };
 
         const raiseWCEvent = () => {
-            const event = new Event('CustomEvent')
+            const event = new CustomEvent('CustomEvent', { detail: 'WC event dispatched' })
             console.info('WC event dispatched')
             this.dispatchEvent(event)
         }
@@ -64,3 +64,9 @@ export class PieButton extends LitElement {
     // Renders a `CSSResult` generated from SCSS by Vite
     static styles = unsafeCSS(styles);
 }
+
+declare global {
+    interface HTMLElementTagNameMap {
+        'pie-button': PieButton;
+    }
+}

package/test/accessibility/pie-button.spec.ts

@@ -0,0 +1,36 @@
+import { test, expect } from '@sand4rt/experimental-ct-web';
+import { PieButton } from '@/index';
+import { BUTTON_SIZE, BUTTON_VARIANT } from '@/defs';
+import AxeBuilder from '@axe-core/playwright';
+
+const sizes = Object.values(BUTTON_SIZE);
+const variants = Object.values(BUTTON_VARIANT);
+const disabledStates = [true, false];
+
+variants.forEach(variant => {
+  test(`should render - ${variant}`, async ({ mount, page }) => {
+
+    for (const size of sizes) {
+      for (const isDisabled of disabledStates) {
+        const component = await mount(PieButton,
+          {
+            props: {
+              size,
+              variant,
+              disabled: isDisabled
+            },
+            slots: {
+              default: `Hello, ${size} ${variant} Button!`
+            },
+          });
+      }
+    }
+
+    const results = await new AxeBuilder.default({ page })
+    .withTags(['wcag21a', 'wcag21aa', 'wcag143', 'cat.color', 'cat.aria'])
+    .disableRules(['color-contrast', 'color-contrast-enhanced'])
+    .analyze();
+
+    expect(results.violations).toEqual([]);
+  });
+})

package/test/component/pie-button.spec.ts

@@ -0,0 +1,51 @@
+import { test, expect } from '@sand4rt/experimental-ct-web';
+import { PieButton } from '@/index';
+import { BUTTON_SIZE, BUTTON_VARIANT } from '@/defs';
+
+const sizes = Object.values(BUTTON_SIZE);
+const variants = Object.values(BUTTON_VARIANT);
+const disabledStates = [true, false];
+
+variants.forEach(variant => {
+  test(`should render - ${variant}`, async ({ mount }) => {
+
+    for (const size of sizes) {
+      for (const isDisabled of disabledStates) {
+        const component = await mount(PieButton,
+          {
+            props: {
+              size,
+              variant,
+              disabled: isDisabled
+            },
+            slots: {
+              default: `Hello, ${size} ${variant} Button!`
+            },
+          });
+
+        await expect(component).toContainText(`Hello, ${size} ${variant} Button!`);
+      }
+    }
+  });
+})
+
+test('should emit an event when clicked', async ({ mount }) => {
+  const messages: string[] = [];
+  const component = await mount(PieButton,
+    {
+      props: {
+        size: BUTTON_SIZE.LARGE,
+        variant: BUTTON_VARIANT.PRIMARY
+      },
+      slots: {
+        default: 'Click me!'
+      },
+      on: {
+        CustomEvent: (data: string) => messages.push(data),
+      },
+    });
+
+  await component.click();
+
+  expect(messages).toEqual(['WC event dispatched'])
+});

package/test/visual/pie-button.spec.ts

@@ -0,0 +1,31 @@
+import { test } from '@sand4rt/experimental-ct-web';
+import { PieButton } from '@/index';
+import percySnapshot from '@percy/playwright'
+import { BUTTON_SIZE, BUTTON_TYPE, BUTTON_VARIANT } from '@/defs';
+
+const sizes = Object.values(BUTTON_SIZE);
+const variants = Object.values(BUTTON_VARIANT);
+const disabledStates = [true, false];
+
+variants.forEach(variant => {
+  test(`should render - ${variant}`, async ({ page, mount }) => {
+
+    for (const size of sizes) {
+      for (const isDisabled of disabledStates) {
+        await mount(PieButton,
+          {
+            props: {
+              type: BUTTON_TYPE.BUTTON,
+              size,
+              variant,
+              disabled: isDisabled
+            },
+            slots: {
+              default: `Hello, ${size} ${variant} Button!`
+            },
+          });
+      }
+    }
+    await percySnapshot(page, `PIE Button - ${variant}`);
+  });
+})

package/tsconfig.json

@@ -1,26 +1,30 @@
 {
-    "compilerOptions": {
-        "target": "ES6",
-        "module": "ES2022",
-        "lib": ["es2020", "DOM", "DOM.Iterable"],
-        "declaration": true,
-        "declarationMap": true,
-        "sourceMap": true,
-        "inlineSources": true,
-        "outDir": "./compiled",
-        "rootDir": "./src",
-        "strict": true,
-        "noUnusedLocals": true,
-        "noUnusedParameters": true,
-        "noImplicitReturns": true,
-        "noFallthroughCasesInSwitch": true,
-        "noImplicitAny": true,
-        "noImplicitThis": true,
-        "moduleResolution": "node",
-        "allowSyntheticDefaultImports": true,
-        "experimentalDecorators": true,
-        "forceConsistentCasingInFileNames": true
-    },
-    "include": ["src/**/*.ts","./declaration.d.ts"],
-    "exclude": []
-  }
+  "compilerOptions": {
+      "target": "ES6",
+      "module": "ES2022",
+      "lib": ["es2020", "DOM", "DOM.Iterable"],
+      "declaration": true,
+      "declarationMap": true,
+      "sourceMap": true,
+      "inlineSources": true,
+      "outDir": "./compiled",
+      "baseUrl": ".",
+      "paths": {
+        "@/*": ["./src/*"]
+      },
+      "rootDir": ".",
+      "strict": true,
+      "noUnusedLocals": true,
+      "noUnusedParameters": true,
+      "noImplicitReturns": true,
+      "noFallthroughCasesInSwitch": true,
+      "noImplicitAny": true,
+      "noImplicitThis": true,
+      "moduleResolution": "node",
+      "allowSyntheticDefaultImports": true,
+      "experimentalDecorators": true,
+      "forceConsistentCasingInFileNames": true
+  },
+  "include": ["src/**/*.ts","./declaration.d.ts", "test/**/*.ts"],
+  "exclude": []
+}