@justeattakeaway/pie-webc-core 0.22.0 → 0.24.0

package/.turbo/turbo-build.log

@@ -1,7 +1,7 @@
 vite v4.5.3 building for production...
 transforming...
-✓ 14 modules transformed.
+✓ 16 modules transformed.
 rendering chunks...
 computing gzip size...
 dist/index.js  2.66 kB │ gzip: 1.20 kB
-✓ built in 148ms
+✓ built in 205ms

package/CHANGELOG.md

@@ -1,5 +1,20 @@
 # Changelog
 
+## 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
+
+- [Added] - Generic type for components default props ([#1451](https://github.com/justeattakeaway/pie/pull/1451)) by [@fernandofranca](https://github.com/fernandofranca)
+
 ## 0.22.0
 
 ### Minor Changes

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@justeattakeaway/pie-webc-core",
-  "version": "0.22.0",
+  "version": "0.24.0",
   "description": "PIE design system base classes, mixins and utilities for web components",
   "type": "module",
   "main": "dist/index.js",

package/src/index.ts

@@ -1,4 +1,5 @@
 export * from './decorators';
 export * from './functions';
 export * from './interfaces';
+export * from './types';
 export * from './mixins';

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

@@ -0,0 +1,31 @@
+/**
+ * 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>>>;

package/src/types/index.ts

@@ -0,0 +1 @@
+export * from './component-default-props-generic';