@modular-component/default 0.2.3 → 0.3.0

package/CHANGELOG.md

@@ -1,5 +1,18 @@
 # @modular-component/default
 
+## 0.3.0
+
+### Minor Changes
+
+- 1784a2b: Add a clean way to extend the ModularComponent API with new dedicated stage functions
+
+### Patch Changes
+
+- Updated dependencies [1784a2b]
+  - @modular-component/core@0.3.0
+  - @modular-component/with-default-props@0.3.0
+  - @modular-component/with-lifecycle@0.3.0
+
 ## 0.2.3
 
 ### Patch Changes

package/README.md

@@ -2,34 +2,52 @@
 
 Set of sensible defaults for using `ModularComponent`.
 
-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.
+Provides two stages: `lifecycle()` for adding a lifecycle hook, and `defaultProps()` for
+providing default values for props. It also re-exports `render()` from `@modular-component/props` for convenience.
 
 It's also possible to import each of them individually through [`@modular-component/with-lifecycle`](https://npmjs.com/package/@modular-component/with-lifecycle)
 and <br /> [`@modular-component/with-default-props`](https://npmjs.com/package/@modular-component/with-default-props) respectively.
 
 ## Usage
 
+**Stage function imports**
+
 ```tsx
 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
-  )))
+  .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
+    }),
+  )
 ```
 
-## Implementation
+**Stage registration**
 
-`@modular-component/default` simply merge together the records from two other packages. To see the implementation
-details, refer to the individual packages:
+```tsx
+import { ModularComponent } from '@modular-component/core'
+import '@modular-component/default/register'
 
-- [`@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
+const MyComponent = ModularComponent()
+  .withDefaultProps({
+    // Define default props here
+  })
+  .withLifecycle(() => {
+    // Write component state & logic here
+  })
+  .withRender(({ props, lifecycle }) => {
+    // Use generated props and lifecycle in the render phase
+  })
+```

package/index.d.ts

@@ -0,0 +1,3 @@
+export * from '@modular-component/core'
+export * from '@modular-component/with-lifecycle'
+export * from '@modular-component/with-default-props'

package/index.js

@@ -0,0 +1,3 @@
+export * from '@modular-component/core'
+export * from '@modular-component/with-lifecycle'
+export * from '@modular-component/with-default-props'

package/package.json

@@ -8,32 +8,37 @@
     "Default",
     "Lifecycle"
   ],
-  "version": "0.2.3",
+  "version": "0.3.0",
   "type": "module",
   "license": "MIT",
   "publishConfig": {
     "access": "public"
   },
   "files": [
-    "src",
-    "dist",
+    "index.js",
+    "index.d.ts",
+    "register.js",
+    "register.d.ts",
     "CHANGELOG.md"
   ],
   "scripts": {
-    "build": "yarn build:with-default-props && yarn build:with-lifecycle && yarn build:self",
+    "build": "yarn build:with-default-props && yarn build:with-lifecycle",
+    "build:self": "tsc --noEmit index register",
     "build:with-default-props": "yarn workspace @modular-component/with-default-props build",
     "build:with-lifecycle": "yarn workspace @modular-component/with-lifecycle build",
-    "build:self": "tsc",
     "license": "cp ../../LICENSE ./LICENSE"
   },
   "dependencies": {
-    "@modular-component/core": "0.2.3",
-    "@modular-component/with-default-props": "0.2.3",
-    "@modular-component/with-lifecycle": "0.2.3"
+    "@modular-component/with-default-props": "0.3.0",
+    "@modular-component/with-lifecycle": "0.3.0"
+  },
+  "peerDependencies": {
+    "@modular-component/core": "0.3.0"
   },
   "devDependencies": {
-    "typescript": "^5.2.2"
+    "@modular-component/core": "*",
+    "typescript": "^5.9.3"
   },
-  "main": "dist/index.js",
-  "types": "dist/index.d.ts"
+  "main": "index.js",
+  "types": "index.d.ts"
 }

package/register.d.ts

@@ -0,0 +1,3 @@
+import '@modular-component/core/register'
+import '@modular-component/with-lifecycle/register'
+import '@modular-component/with-default-props/register'

package/register.js

@@ -0,0 +1,3 @@
+import '@modular-component/core/register.js'
+import '@modular-component/with-lifecycle/register.js'
+import '@modular-component/with-default-props/register.js'

package/dist/index.d.ts

@@ -1,4 +0,0 @@
-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 +0,0 @@
-{"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,4 +0,0 @@
-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 +0,0 @@
-{"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/src/index.ts

@@ -1,3 +0,0 @@
-export { render } from '@modular-component/core'
-export { defaultProps } from '@modular-component/with-default-props'
-export { lifecycle } from '@modular-component/with-lifecycle'