@modular-component/with-default-props 0.1.0

package/CHANGELOG.md

@@ -0,0 +1,12 @@
+# @modular-component/with-default-props
+
+## 0.1.0
+
+### Minor Changes
+
+- be1b38e: Initial release of the ModularComponent system
+
+### Patch Changes
+
+- Updated dependencies [be1b38e]
+  - @modular-component/core@0.1.0

package/LICENSE

@@ -0,0 +1,13 @@
+Copyright © Jérémie van der Sande
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
+documentation files (the “Software”), to deal in the Software without restriction, including without limitation the
+rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit
+persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+The Software is provided “as is”, without warranty of any kind, express or implied, including but not limited to the
+warranties of merchantability, fitness for a particular purpose and noninfringement. In no event shall the authors or
+copyright holders be liable for any claim, damages or other liability, whether in an action of contract, tort or otherwise,
+arising from, out of or in connection with the software or the use or other dealings in the Software.

package/README.md

@@ -0,0 +1,42 @@
+# `@modular-component/with-default-props`
+
+Provides a `withDefaultProps` stage providing default values for props.
+
+Correctly updates typing of `props` argument to mark props with default
+values as non-nullable.
+
+## Installation and usage
+
+```bash
+yarn add @modular-component/core @modular-component/with-default-props
+```
+
+```tsx
+import { modularFactory } from '@modular-component/core'
+import { WithDefaultProps } from '@modular-component/with-default-props'
+
+const ModularComponent = modularFactory.extend(WithDefaultProps).build()
+
+const MyModularComponent = ModularComponent<{
+  content?: {
+    title: string
+    subtitle: string
+  }
+}>()
+  .withDefaultProps({
+    content: {
+      title: 'Default title',
+      subtitle: 'Default subtitle',
+    },
+  })
+  .withRender(({ props }) => (
+    <>
+      <h1>{props.content.title}</h1>
+      <h2>{props.content.subtitle}</h2>
+    </>
+  ))
+```
+
+## Learn more
+
+Read the [`ModularComponent` ReadMe](https://github.com/jvdsande/modular-component/blob/master/README.md) for more information about the `ModularComponent` system.

package/dist/index.d.ts

@@ -0,0 +1,10 @@
+export declare const WithDefaultProps: {
+    readonly withDefaultProps: {
+        readonly field: "props";
+        readonly transform: <A extends {
+            props: {};
+        }, P>(args: A, props: P) => any;
+        readonly restrict: Record<string, unknown>;
+    };
+};
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAEA,eAAO,MAAM,gBAAgB;;;;mBAGM,EAAE;;;;CAM1B,CAAA"}

package/dist/index.js

@@ -0,0 +1,12 @@
+import { createMethodRecord } from '@modular-component/core';
+export const WithDefaultProps = createMethodRecord({
+    withDefaultProps: {
+        field: 'props',
+        transform: (args, props) => ({
+            ...(typeof props == 'function' ? props(args) : props),
+            ...args.props,
+        }),
+        restrict: {},
+    },
+});
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,MAAM,yBAAyB,CAAA;AAE5D,MAAM,CAAC,MAAM,gBAAgB,GAAG,kBAAkB,CAAC;IACjD,gBAAgB,EAAE;QAChB,KAAK,EAAE,OAAO;QACd,SAAS,EAAE,CAA6B,IAAO,EAAE,KAAQ,EAAE,EAAE,CAAC,CAAC;YAC7D,GAAG,CAAC,OAAO,KAAK,IAAI,UAAU,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC;YACrD,GAAG,IAAI,CAAC,KAAK;SACd,CAAC;QACF,QAAQ,EAAE,EAA6B;KACxC;CACO,CAAC,CAAA"}

package/package.json

@@ -0,0 +1,36 @@
+{
+  "name": "@modular-component/with-default-props",
+  "description": "ModularComponent stage for handling default props. Part of the @modular-component/default package.",
+  "keywords": [
+    "React",
+    "Modular",
+    "Factory",
+    "Default",
+    "Conditional"
+  ],
+  "version": "0.1.0",
+  "type": "module",
+  "license": "MIT",
+  "publishConfig": {
+    "access": "public"
+  },
+  "files": [
+    "src",
+    "dist",
+    "CHANGELOG.md"
+  ],
+  "scripts": {
+    "build": "yarn build:core && yarn build:self",
+    "build:core": "yarn workspace @modular-component/core build",
+    "build:self": "tsc -p tsconfig.build.json",
+    "license": "cp ../../LICENSE ./LICENSE"
+  },
+  "dependencies": {
+    "@modular-component/core": "0.1.0"
+  },
+  "devDependencies": {
+    "typescript": "^4.6.4"
+  },
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts"
+}

package/src/index.ts

@@ -0,0 +1,12 @@
+import { createMethodRecord } from '@modular-component/core'
+
+export const WithDefaultProps = createMethodRecord({
+  withDefaultProps: {
+    field: 'props',
+    transform: <A extends { props: {} }, P>(args: A, props: P) => ({
+      ...(typeof props == 'function' ? props(args) : props),
+      ...args.props,
+    }),
+    restrict: {} as Record<string, unknown>,
+  },
+} as const)