@justeattakeaway/pie-webc-core 0.23.0 → 0.24.1

package/.turbo/turbo-build.log

@@ -1,7 +1,7 @@
-vite v4.5.3 building for production...
+vite v5.3.6 building for production...
 transforming...
 ✓ 16 modules transformed.
 rendering chunks...
 computing gzip size...
-dist/index.js  2.66 kB │ gzip: 1.20 kB
-✓ built in 196ms
+dist/index.js  2.69 kB │ gzip: 1.23 kB
+✓ built in 108ms

package/CHANGELOG.md

@@ -1,5 +1,20 @@
 # Changelog
 
+## 0.24.1
+
+### Patch Changes
+
+- [Changed] - Suggested package updates for security ([#1953](https://github.com/justeattakeaway/pie/pull/1953)) by [@xander-marjoram](https://github.com/xander-marjoram)
+
+## 0.24.0
+
+### Minor Changes
+
+- [Changed] - Update default props generic helper type to include all props by default ([#1582](https://github.com/justeattakeaway/pie/pull/1582)) by [@xander-marjoram](https://github.com/xander-marjoram)
+
+  [Changed] - Naming of generic type
+  [Added] - JSDoc comment
+
 ## 0.23.0
 
 ### Minor Changes

package/dist/index.js

@@ -1,27 +1,27 @@
-import { isServer as c } from "lit";
-const a = (t, e, r) => function(s, n) {
-  const o = `#${n}`;
-  Object.defineProperty(s, n, {
+import { isServer as u } from "lit";
+const d = (t, e, n) => function(s, r) {
+  const o = `#${r}`;
+  Object.defineProperty(s, r, {
     get() {
       return this[o];
     },
-    set(u) {
-      e.includes(u) ? this[o] = u : (console.error(
-        `<${t}> Invalid value "${u}" provided for property "${n}".`,
+    set(c) {
+      e.includes(c) ? this[o] = c : (console.error(
+        `<${t}> Invalid value "${c}" provided for property "${r}".`,
         `Must be one of: ${e.join(" | ")}.`,
-        `Falling back to default value: "${r}"`
-      ), this[o] = r);
+        `Falling back to default value: "${n}"`
+      ), this[o] = n);
     },
     configurable: !0
   });
-}, d = (t) => function(r, i) {
+}, l = (t) => function(n, i) {
   const s = `#${i}`;
-  Object.defineProperty(r, i, {
+  Object.defineProperty(n, i, {
     get() {
       return this[s];
     },
-    set(n) {
-      (n == null || typeof n == "string" && n.trim() === "") && console.error(`<${t}> Missing required attribute "${i}"`), this[s] = n;
+    set(r) {
+      (r == null || typeof r == "string" && r.trim() === "") && console.error(`<${t}> Missing required attribute "${i}"`), this[s] = r;
     },
     configurable: !0
   });
@@ -29,7 +29,7 @@ const a = (t, e, r) => function(s, n) {
 function f(t, e) {
   customElements.get(t) ? console.warn(`PIE Web Component: "${t}" has already been defined. Please ensure the component is only being defined once in your application.`) : customElements.define(t, e);
 }
-function m(t) {
+function b(t) {
   return new CustomEvent(t.type, {
     detail: {
       sourceEvent: t
@@ -38,16 +38,16 @@ function m(t) {
     cancelable: t.cancelable
   });
 }
-function b(t, e, r) {
+function h(t, e, n) {
   e.startsWith("pie-") || console.warn("A custom event name should start with `pie-`");
   const i = new CustomEvent(e, {
     bubbles: !0,
     composed: !0,
-    detail: r
+    detail: n
   });
   t.dispatchEvent(i);
 }
-const h = (t) => {
+const m = (t) => {
   class e extends t {
     /**
      * A getter to determine whether the text direction is right-to-left (RTL).
@@ -59,28 +59,30 @@ const h = (t) => {
      * @returns {boolean} - Returns `true` if the text direction is RTL, otherwise `false`.
      */
     get isRTL() {
-      return this.dir ? this.dir === "rtl" : !c && !this.dir ? document.documentElement.getAttribute("dir") === "rtl" : !1;
+      return this.dir ? this.dir === "rtl" : !u && !this.dir ? document.documentElement.getAttribute("dir") === "rtl" : !1;
     }
   }
   return e;
 }, p = (t) => {
-  class e extends t {
-    // eslint-disable-next-line @typescript-eslint/no-explicit-any
-    constructor(...i) {
-      super(...i), this._internals = this.attachInternals();
-    }
+  const n = class n extends t {
     get form() {
       return this._internals.form;
     }
-  }
-  return e.formAssociated = !0, e;
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    constructor(...s) {
+      super(...s), this._internals = this.attachInternals();
+    }
+  };
+  n.formAssociated = !0;
+  let e = n;
+  return e;
 };
 export {
   p as FormControlMixin,
-  h as RtlMixin,
+  m as RtlMixin,
   f as defineCustomElement,
-  b as dispatchCustomEvent,
-  d as requiredProperty,
-  a as validPropertyValues,
-  m as wrapNativeEvent
+  h as dispatchCustomEvent,
+  l as requiredProperty,
+  d as validPropertyValues,
+  b as wrapNativeEvent
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@justeattakeaway/pie-webc-core",
-  "version": "0.23.0",
+  "version": "0.24.1",
   "description": "PIE design system base classes, mixins and utilities for web components",
   "type": "module",
   "main": "dist/index.js",
@@ -18,10 +18,10 @@
     "test:watch": "run -T vitest"
   },
   "dependencies": {
-    "lit": "3.1.3"
+    "lit": "3.2.0"
   },
   "devDependencies": {
-    "@justeattakeaway/pie-components-config": "0.16.0"
+    "@justeattakeaway/pie-components-config": "0.18.0"
   },
   "volta": {
     "extends": "../../../package.json"

package/src/mixins/rtl/rtlMixin.ts

@@ -41,16 +41,16 @@ export interface RTLInterface {
  *
  * class MyStyledElement extends RtlMixin(LitElement) {
  *   render() {
- *     return html`<div class="foo" ?isRTL=${this.isRTL}>Content</div>`;
+ *     return html`<div class="foo" ?data-is-rtl=${this.isRTL}>Content</div>`;
  *   }
  * }
  *
  * customElements.define('my-styled-element', MyStyledElement);
  * ```
  *
- * The corresponding SCSS to leverage the `isRTL` attribute:
+ * The corresponding SCSS to leverage the `data-is-rtl` attribute:
  * ```scss
- * .foo[isRTL] {
+ * .foo[data-is-rtl] {
  *   background-color: red;
  *   text-align: right;
  * }

package/src/types/component-default-props-generic.ts

@@ -1 +1,31 @@
-export type ComponentDefaultPropsGeneric<T, K extends keyof T> = Readonly<Required<Pick<T, K>>>;
+/**
+ * This type should be used when defining the default props for a component.
+ * It is a generic type that takes two type parameters:
+ * - `T` is the type of the props object that the default props are being defined for.
+ * - `K` is the type of the keys in `T` that should be required in the default props.
+ * By default, `K` is set to be all the keys in `T`. This means that all the keys in `T` will be required in the default props.
+ * You can override this by specifying a subset of the keys in `T` that should be required in the default props.
+ *
+ * @example ```tsx
+ * interface MyComponentProps {
+ *   a: string;
+ *   b?: number;
+ *   c: boolean;
+ * }
+ * const allProps: ComponentDefaultProps<MyComponentProps> = {
+ *   a: 'default value',
+ *   b: 42,
+ *   c: true,
+ * };
+ *
+ * const pickProps: ComponentDefaultProps<MyComponentProps, 'a'> = {
+ *   a: 'default value',
+ * };
+ *
+ * const omitProps: ComponentDefaultProps<MyComponentProps, keyof Omit<MyComponentProps, 'a'>> = {
+ *   b: 42,
+ *   c: true,
+ * };
+ * ```
+ */
+export type ComponentDefaultProps<T, K extends keyof T = keyof T> = Readonly<Required<Pick<T, K>>>;