@j2inn/resolvable-ui-elements 0.0.2-beta.5 → 0.0.2-beta.6

package/dist/index.d.ts

@@ -1,6 +1,7 @@
 export { type FunctionResult } from './resolvableElements/elements/function/FunctionElement';
 export { isSectionData, type ParametersOfSection, type ResolvedSection, } from './resolvableElements/elements/section/SectionElementMeta';
 export { type UiElementData } from './resolvableElements/elements/UiElement';
+export * from './resolvableElements/react/SectionChecker';
 export * from './resolvableElements/react/useResolverContext';
 export * from './resolvableElements/react/useResolveSection';
 export * from './useCurrentUser';

package/dist/index.js

@@ -23,6 +23,7 @@ Object.defineProperty(exports, "isSectionData", { enumerable: true, get: functio
 //////////////////////////////////////////////////////////////////////////
 // React
 //////////////////////////////////////////////////////////////////////////
+__exportStar(require("./resolvableElements/react/SectionChecker"), exports);
 __exportStar(require("./resolvableElements/react/useResolverContext"), exports);
 __exportStar(require("./resolvableElements/react/useResolveSection"), exports);
 //////////////////////////////////////////////////////////////////////////

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA;;GAEG;;;;;;;;;;;;;;;;;AAMH,+FAIiE;AAHhE,mHAAA,aAAa,OAAA;AAKd,0EAA0E;AAC1E,QAAQ;AACR,0EAA0E;AAC1E,gFAA6D;AAC7D,+EAA4D;AAC5D,0EAA0E;AAC1E,QAAQ;AACR,0EAA0E;AAC1E,mDAAgC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA;;GAEG;;;;;;;;;;;;;;;;;AAMH,+FAIiE;AAHhE,mHAAA,aAAa,OAAA;AAKd,0EAA0E;AAC1E,QAAQ;AACR,0EAA0E;AAC1E,4EAAyD;AACzD,gFAA6D;AAC7D,+EAA4D;AAC5D,0EAA0E;AAC1E,QAAQ;AACR,0EAA0E;AAC1E,mDAAgC"}

package/dist/resolvableElements/react/SectionChecker.d.ts

@@ -0,0 +1,27 @@
+import React from 'react';
+import { UiElementData } from 'resolvableElements/elements/UiElement';
+/**
+ * An utility type that allows a component to accept props with or without a 'section' property.
+ */
+export declare type OptionalSection<P> = P | (Omit<P, 'section'> & {
+    section?: undefined;
+});
+/**
+ * Higher-Order Component that takes a section based component as an argument and returns a new component
+ * that checks if the 'section' prop is defined before rendering the SectionComponent.
+ * If the 'section' prop is undefined, it returns an empty element.
+ *
+ *
+ *
+ * @template P - Props of the original SectionComponent
+ * @param {React.FC<P>} SectionComponent - The original component that will be wrapped
+ * @returns {React.FC<P | (Omit<P, 'section'> & { section?: undefined })>} - The wrapped component
+ *
+ * @example
+ * const CheckedComponent = SectionChecker(({section, ...props}) => {
+ *   return <div>{section.title}</div>
+ * })
+ */
+export declare const SectionChecker: <P extends {
+    section: UiElementData;
+}>(SectionComponent: React.FC<P>) => (props: OptionalSection<P>) => JSX.Element;

package/dist/resolvableElements/react/SectionChecker.jsx

@@ -0,0 +1,31 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SectionChecker = void 0;
+const react_1 = __importDefault(require("react"));
+/**
+ * Higher-Order Component that takes a section based component as an argument and returns a new component
+ * that checks if the 'section' prop is defined before rendering the SectionComponent.
+ * If the 'section' prop is undefined, it returns an empty element.
+ *
+ *
+ *
+ * @template P - Props of the original SectionComponent
+ * @param {React.FC<P>} SectionComponent - The original component that will be wrapped
+ * @returns {React.FC<P | (Omit<P, 'section'> & { section?: undefined })>} - The wrapped component
+ *
+ * @example
+ * const CheckedComponent = SectionChecker(({section, ...props}) => {
+ *   return <div>{section.title}</div>
+ * })
+ */
+const SectionChecker = (SectionComponent) => {
+    const CheckedSectionComponent = (props) => {
+        return !props.section ? <></> : <SectionComponent {...props}/>;
+    };
+    return CheckedSectionComponent;
+};
+exports.SectionChecker = SectionChecker;
+//# sourceMappingURL=SectionChecker.jsx.map

package/dist/resolvableElements/react/SectionChecker.jsx.map

@@ -0,0 +1 @@
+{"version":3,"file":"SectionChecker.jsx","sourceRoot":"","sources":["../../../src/resolvableElements/react/SectionChecker.tsx"],"names":[],"mappings":";;;;;;AAAA,kDAAyB;AAUzB;;;;;;;;;;;;;;;GAeG;AACI,MAAM,cAAc,GAAG,CAC7B,gBAA6B,EAC5B,EAAE;IACH,MAAM,uBAAuB,GAAG,CAAC,KAAyB,EAAE,EAAE;QAC7D,OAAO,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC,CAAC,CAAC,gBAAgB,CAAC,IAAI,KAAK,CAAC,EAAG,CAAA;IAChE,CAAC,CAAA;IAED,OAAO,uBAAuB,CAAA;AAC/B,CAAC,CAAA;AARY,QAAA,cAAc,kBAQ1B"}

package/dist_es/index.d.ts

@@ -1,6 +1,7 @@
 export { type FunctionResult } from './resolvableElements/elements/function/FunctionElement';
 export { isSectionData, type ParametersOfSection, type ResolvedSection, } from './resolvableElements/elements/section/SectionElementMeta';
 export { type UiElementData } from './resolvableElements/elements/UiElement';
+export * from './resolvableElements/react/SectionChecker';
 export * from './resolvableElements/react/useResolverContext';
 export * from './resolvableElements/react/useResolveSection';
 export * from './useCurrentUser';

package/dist_es/index.js

@@ -5,6 +5,7 @@ export { isSectionData, } from './resolvableElements/elements/section/SectionEle
 //////////////////////////////////////////////////////////////////////////
 // React
 //////////////////////////////////////////////////////////////////////////
+export * from './resolvableElements/react/SectionChecker';
 export * from './resolvableElements/react/useResolverContext';
 export * from './resolvableElements/react/useResolveSection';
 //////////////////////////////////////////////////////////////////////////

package/dist_es/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;GAEG;AAMH,OAAO,EACN,aAAa,GAGb,MAAM,0DAA0D,CAAA;AAEjE,0EAA0E;AAC1E,QAAQ;AACR,0EAA0E;AAC1E,cAAc,+CAA+C,CAAA;AAC7D,cAAc,8CAA8C,CAAA;AAC5D,0EAA0E;AAC1E,QAAQ;AACR,0EAA0E;AAC1E,cAAc,kBAAkB,CAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;GAEG;AAMH,OAAO,EACN,aAAa,GAGb,MAAM,0DAA0D,CAAA;AAEjE,0EAA0E;AAC1E,QAAQ;AACR,0EAA0E;AAC1E,cAAc,2CAA2C,CAAA;AACzD,cAAc,+CAA+C,CAAA;AAC7D,cAAc,8CAA8C,CAAA;AAC5D,0EAA0E;AAC1E,QAAQ;AACR,0EAA0E;AAC1E,cAAc,kBAAkB,CAAA"}

package/dist_es/resolvableElements/react/SectionChecker.d.ts

@@ -0,0 +1,27 @@
+import React from 'react';
+import { UiElementData } from 'resolvableElements/elements/UiElement';
+/**
+ * An utility type that allows a component to accept props with or without a 'section' property.
+ */
+export declare type OptionalSection<P> = P | (Omit<P, 'section'> & {
+    section?: undefined;
+});
+/**
+ * Higher-Order Component that takes a section based component as an argument and returns a new component
+ * that checks if the 'section' prop is defined before rendering the SectionComponent.
+ * If the 'section' prop is undefined, it returns an empty element.
+ *
+ *
+ *
+ * @template P - Props of the original SectionComponent
+ * @param {React.FC<P>} SectionComponent - The original component that will be wrapped
+ * @returns {React.FC<P | (Omit<P, 'section'> & { section?: undefined })>} - The wrapped component
+ *
+ * @example
+ * const CheckedComponent = SectionChecker(({section, ...props}) => {
+ *   return <div>{section.title}</div>
+ * })
+ */
+export declare const SectionChecker: <P extends {
+    section: UiElementData;
+}>(SectionComponent: React.FC<P>) => (props: OptionalSection<P>) => JSX.Element;

package/dist_es/resolvableElements/react/SectionChecker.jsx

@@ -0,0 +1,24 @@
+import React from 'react';
+/**
+ * Higher-Order Component that takes a section based component as an argument and returns a new component
+ * that checks if the 'section' prop is defined before rendering the SectionComponent.
+ * If the 'section' prop is undefined, it returns an empty element.
+ *
+ *
+ *
+ * @template P - Props of the original SectionComponent
+ * @param {React.FC<P>} SectionComponent - The original component that will be wrapped
+ * @returns {React.FC<P | (Omit<P, 'section'> & { section?: undefined })>} - The wrapped component
+ *
+ * @example
+ * const CheckedComponent = SectionChecker(({section, ...props}) => {
+ *   return <div>{section.title}</div>
+ * })
+ */
+export const SectionChecker = (SectionComponent) => {
+    const CheckedSectionComponent = (props) => {
+        return !props.section ? <></> : <SectionComponent {...props}/>;
+    };
+    return CheckedSectionComponent;
+};
+//# sourceMappingURL=SectionChecker.jsx.map

package/dist_es/resolvableElements/react/SectionChecker.jsx.map

@@ -0,0 +1 @@
+{"version":3,"file":"SectionChecker.jsx","sourceRoot":"","sources":["../../../src/resolvableElements/react/SectionChecker.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,OAAO,CAAA;AAUzB;;;;;;;;;;;;;;;GAeG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG,CAC7B,gBAA6B,EAC5B,EAAE;IACH,MAAM,uBAAuB,GAAG,CAAC,KAAyB,EAAE,EAAE;QAC7D,OAAO,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC,CAAC,CAAC,gBAAgB,CAAC,IAAI,KAAK,CAAC,EAAG,CAAA;IAChE,CAAC,CAAA;IAED,OAAO,uBAAuB,CAAA;AAC/B,CAAC,CAAA"}

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@j2inn/resolvable-ui-elements",
-	"version": "0.0.2-beta.5",
+	"version": "0.0.2-beta.6",
 	"description": "",
 	"main": "dist/index.js",
 	"types": "dist/index.d.ts",