@modular-component/default 0.1.7 → 0.2.1

package/CHANGELOG.md

@@ -1,5 +1,28 @@
 # @modular-component/default
 
+## 0.2.1
+
+### Patch Changes
+
+- 09b9673: Update readmes
+- Updated dependencies [09b9673]
+  - @modular-component/core@0.2.1
+  - @modular-component/with-default-props@0.2.1
+  - @modular-component/with-lifecycle@0.2.1
+
+## 0.2.0
+
+### Minor Changes
+
+- 83d453f: Rework API for better TypeScript performance and improved DX
+
+### Patch Changes
+
+- Updated dependencies [83d453f]
+  - @modular-component/core@0.2.0
+  - @modular-component/with-default-props@0.2.0
+  - @modular-component/with-lifecycle@0.2.0
+
 ## 0.1.7
 
 ### Patch Changes

package/README.md

@@ -1,48 +1,35 @@
-# `@modular-component/with-default`
+# @modular-component/default
 
-Sensible set of default extensions for the `ModularComponent` system.
+Set of sensible defaults for using `ModularComponent`.
 
-Provides two stages:
-`withLifecycle` for adding a lifecycle hook, and `withDefaultProps` for
-providing default values for props.
+Provides two stages: `with(lifecycle)` for adding a lifecycle hook, and `with(defaultProps)` for
+providing default values for props. It also re-exports `with(render)` from `@modular-component/props` for convenience.
 
-It's also possible to import each of them individually through `@modular-component/with-lifecycle`
-and `@modular-component/with-default-props` respectively.
+It's also possible to import each of them individually through [`@modular-component/with-lifecycle`](./with-lifecycle.md)
+and <br /> [`@modular-component/with-default-props`](./with-default-props.md) respectively.
 
-## Installation and usage
-
-```bash
-yarn add @modular-component/core @modular-component/default
-```
+## Usage
 
 ```tsx
-import { modularFactory } from '@modular-component/core'
-import { WithDefaultStages } from '@modular-component/default'
-
-const ModularComponent = modularFactory.extend(WithDefaultStages).build()
-
-const MyModularComponent = ModularComponent<{
-  someFlag?: boolean
-  someLabel: string
-  someValue: number
-}>()
-  .withDefaultProps({ someFlag: false })
-  .withLifecycle(({ props }) => {
-    const [someState, setSomeState] = useState(0)
-
-    return { someState }
-  })
-  .withRender(({ props, lifecycle }) => (
-    <>
-      <h2>
-        {props.someLabel}: {props.someValue}
-      </h2>
-      <p>Value from state: {lifecycle.someState}</p>
-      <p>Flag from props: {props.someFlag ? 'true' : 'false'}</p>
-    </>
-  ))
+import { ModularComponent } from '@modular-component/core'
+import { defaultProps, lifecycle, render } from '@modular-component/default'
+
+const MyComponent = ModularComponent()
+  .with(defaultProps({
+    // Define default props here
+  }))
+  .with(lifecycle(() => {
+    // Write component state & logic here
+  }))
+  .with(render(({ props, lifecycle }) => (
+    // Use generated props and lifecycle in the render phase
+  )))
 ```
 
-## Learn more
+## Implementation
+
+`@modular-component/default` simply merge together the records from two other packages. To see the implementation
+details, refer to the individual packages:
 
-Read the [`ModularComponent` ReadMe](https://github.com/jvdsande/modular-component/blob/master/README.md) for more information about the `ModularComponent` system.
+* [`@modular-component/with-default-props`](https://npmjs.com/package/@modular-component/with-default-props): powerful default props capabilities
+* [`@modular-component/with-lifecycle`](https://npmjs.com/package/@modular-component/with-lifecycle): isolate component logic in a dedicated hook

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import { WithDefaultProps } from '@modular-component/with-default-props';
-import { WithLifecycle } from '@modular-component/with-lifecycle';
-export declare const WithDefaultStages: typeof WithDefaultProps & typeof WithLifecycle;
+export { render } from '@modular-component/core';
+export { defaultProps } from '@modular-component/with-default-props';
+export { lifecycle } from '@modular-component/with-lifecycle';
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,uCAAuC,CAAA;AACxE,OAAO,EAAE,aAAa,EAAE,MAAM,mCAAmC,CAAA;AAEjE,eAAO,MAAM,iBAAiB,EAAE,OAAO,gBAAgB,GAAG,OAAO,aAI9D,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,yBAAyB,CAAA;AAChD,OAAO,EAAE,YAAY,EAAE,MAAM,uCAAuC,CAAA;AACpE,OAAO,EAAE,SAAS,EAAE,MAAM,mCAAmC,CAAA"}

package/dist/index.js

@@ -1,7 +1,4 @@
-import { WithDefaultProps } from '@modular-component/with-default-props';
-import { WithLifecycle } from '@modular-component/with-lifecycle';
-export const WithDefaultStages = {
-    ...WithDefaultProps,
-    ...WithLifecycle,
-};
+export { render } from '@modular-component/core';
+export { defaultProps } from '@modular-component/with-default-props';
+export { lifecycle } from '@modular-component/with-lifecycle';
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,uCAAuC,CAAA;AACxE,OAAO,EAAE,aAAa,EAAE,MAAM,mCAAmC,CAAA;AAEjE,MAAM,CAAC,MAAM,iBAAiB,GAC5B;IACE,GAAG,gBAAgB;IACnB,GAAG,aAAa;CACjB,CAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,yBAAyB,CAAA;AAChD,OAAO,EAAE,YAAY,EAAE,MAAM,uCAAuC,CAAA;AACpE,OAAO,EAAE,SAAS,EAAE,MAAM,mCAAmC,CAAA"}

package/package.json

@@ -8,7 +8,7 @@
     "Default",
     "Lifecycle"
   ],
-  "version": "0.1.7",
+  "version": "0.2.1",
   "type": "module",
   "license": "MIT",
   "publishConfig": {
@@ -27,11 +27,12 @@
     "license": "cp ../../LICENSE ./LICENSE"
   },
   "dependencies": {
-    "@modular-component/with-default-props": "0.1.7",
-    "@modular-component/with-lifecycle": "0.1.7"
+    "@modular-component/core": "0.2.1",
+    "@modular-component/with-default-props": "0.2.1",
+    "@modular-component/with-lifecycle": "0.2.1"
   },
   "devDependencies": {
-    "typescript": "^4.6.4"
+    "typescript": "^5.2.2"
   },
   "main": "dist/index.js",
   "types": "dist/index.d.ts"

package/src/index.ts

@@ -1,8 +1,3 @@
-import { WithDefaultProps } from '@modular-component/with-default-props'
-import { WithLifecycle } from '@modular-component/with-lifecycle'
-
-export const WithDefaultStages: typeof WithDefaultProps & typeof WithLifecycle =
-  {
-    ...WithDefaultProps,
-    ...WithLifecycle,
-  }
+export { render } from '@modular-component/core'
+export { defaultProps } from '@modular-component/with-default-props'
+export { lifecycle } from '@modular-component/with-lifecycle'