@genesislcap/foundation-react-utils 14.354.2-FUI-2341-3.1

package/dist/foundation-react-utils.api.json

@@ -0,0 +1,446 @@
+{
+  "metadata": {
+    "toolPackage": "@microsoft/api-extractor",
+    "toolVersion": "7.52.10",
+    "schemaVersion": 1011,
+    "oldestForwardsCompatibleVersion": 1001,
+    "tsdocConfig": {
+      "$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json",
+      "noStandardTags": true,
+      "tagDefinitions": [
+        {
+          "tagName": "@alpha",
+          "syntaxKind": "modifier"
+        },
+        {
+          "tagName": "@beta",
+          "syntaxKind": "modifier"
+        },
+        {
+          "tagName": "@defaultValue",
+          "syntaxKind": "block"
+        },
+        {
+          "tagName": "@decorator",
+          "syntaxKind": "block",
+          "allowMultiple": true
+        },
+        {
+          "tagName": "@deprecated",
+          "syntaxKind": "block"
+        },
+        {
+          "tagName": "@eventProperty",
+          "syntaxKind": "modifier"
+        },
+        {
+          "tagName": "@example",
+          "syntaxKind": "block",
+          "allowMultiple": true
+        },
+        {
+          "tagName": "@experimental",
+          "syntaxKind": "modifier"
+        },
+        {
+          "tagName": "@inheritDoc",
+          "syntaxKind": "inline"
+        },
+        {
+          "tagName": "@internal",
+          "syntaxKind": "modifier"
+        },
+        {
+          "tagName": "@label",
+          "syntaxKind": "inline"
+        },
+        {
+          "tagName": "@link",
+          "syntaxKind": "inline",
+          "allowMultiple": true
+        },
+        {
+          "tagName": "@override",
+          "syntaxKind": "modifier"
+        },
+        {
+          "tagName": "@packageDocumentation",
+          "syntaxKind": "modifier"
+        },
+        {
+          "tagName": "@param",
+          "syntaxKind": "block",
+          "allowMultiple": true
+        },
+        {
+          "tagName": "@privateRemarks",
+          "syntaxKind": "block"
+        },
+        {
+          "tagName": "@public",
+          "syntaxKind": "modifier"
+        },
+        {
+          "tagName": "@readonly",
+          "syntaxKind": "modifier"
+        },
+        {
+          "tagName": "@remarks",
+          "syntaxKind": "block"
+        },
+        {
+          "tagName": "@returns",
+          "syntaxKind": "block"
+        },
+        {
+          "tagName": "@sealed",
+          "syntaxKind": "modifier"
+        },
+        {
+          "tagName": "@see",
+          "syntaxKind": "block"
+        },
+        {
+          "tagName": "@throws",
+          "syntaxKind": "block",
+          "allowMultiple": true
+        },
+        {
+          "tagName": "@typeParam",
+          "syntaxKind": "block",
+          "allowMultiple": true
+        },
+        {
+          "tagName": "@virtual",
+          "syntaxKind": "modifier"
+        },
+        {
+          "tagName": "@betaDocumentation",
+          "syntaxKind": "modifier"
+        },
+        {
+          "tagName": "@internalRemarks",
+          "syntaxKind": "block"
+        },
+        {
+          "tagName": "@preapproved",
+          "syntaxKind": "modifier"
+        }
+      ],
+      "supportForTags": {
+        "@alpha": true,
+        "@beta": true,
+        "@defaultValue": true,
+        "@decorator": true,
+        "@deprecated": true,
+        "@eventProperty": true,
+        "@example": true,
+        "@experimental": true,
+        "@inheritDoc": true,
+        "@internal": true,
+        "@label": true,
+        "@link": true,
+        "@override": true,
+        "@packageDocumentation": true,
+        "@param": true,
+        "@privateRemarks": true,
+        "@public": true,
+        "@readonly": true,
+        "@remarks": true,
+        "@returns": true,
+        "@sealed": true,
+        "@see": true,
+        "@throws": true,
+        "@typeParam": true,
+        "@virtual": true,
+        "@betaDocumentation": true,
+        "@internalRemarks": true,
+        "@preapproved": true
+      },
+      "reportUnsupportedHtmlElements": false
+    }
+  },
+  "kind": "Package",
+  "canonicalReference": "@genesislcap/foundation-react-utils!",
+  "docComment": "",
+  "name": "@genesislcap/foundation-react-utils",
+  "preserveMemberOrder": false,
+  "members": [
+    {
+      "kind": "EntryPoint",
+      "canonicalReference": "@genesislcap/foundation-react-utils!",
+      "name": "",
+      "preserveMemberOrder": false,
+      "members": [
+        {
+          "kind": "Function",
+          "canonicalReference": "@genesislcap/foundation-react-utils!reactFactory:function(1)",
+          "docComment": "/**\n * Creates a factory function for rendering React components in layout items.\n *\n * @param Component - React component to render\n *\n * @param props - Optional props to pass to the component\n *\n * @returns ComponentFactory compatible with foundation-layout\n *\n * @example\n * ```tsx\n * <foundation-layout-item\n *   registration=\"my-component\"\n *   title=\"My Component\"\n *   factory={reactFactory(MyComponent, { someProp: 'value' })}\n * />\n * ```\n *\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export declare function reactFactory<P = "
+            },
+            {
+              "kind": "Content",
+              "text": "{}"
+            },
+            {
+              "kind": "Content",
+              "text": ">(Component: "
+            },
+            {
+              "kind": "Reference",
+              "text": "React.ComponentType",
+              "canonicalReference": "@types/react!React.ComponentType:type"
+            },
+            {
+              "kind": "Content",
+              "text": "<P>"
+            },
+            {
+              "kind": "Content",
+              "text": ", props?: "
+            },
+            {
+              "kind": "Content",
+              "text": "P"
+            },
+            {
+              "kind": "Content",
+              "text": "): "
+            },
+            {
+              "kind": "Reference",
+              "text": "ComponentFactory",
+              "canonicalReference": "@genesislcap/foundation-layout!ComponentFactory:type"
+            },
+            {
+              "kind": "Content",
+              "text": ";"
+            }
+          ],
+          "fileUrlPath": "src/react-layout-factory.tsx",
+          "returnTypeTokenRange": {
+            "startIndex": 8,
+            "endIndex": 9
+          },
+          "releaseTag": "Public",
+          "overloadIndex": 1,
+          "parameters": [
+            {
+              "parameterName": "Component",
+              "parameterTypeTokenRange": {
+                "startIndex": 3,
+                "endIndex": 5
+              },
+              "isOptional": false
+            },
+            {
+              "parameterName": "props",
+              "parameterTypeTokenRange": {
+                "startIndex": 6,
+                "endIndex": 7
+              },
+              "isOptional": true
+            }
+          ],
+          "typeParameters": [
+            {
+              "typeParameterName": "P",
+              "constraintTokenRange": {
+                "startIndex": 0,
+                "endIndex": 0
+              },
+              "defaultTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              }
+            }
+          ],
+          "name": "reactFactory"
+        },
+        {
+          "kind": "Function",
+          "canonicalReference": "@genesislcap/foundation-react-utils!reactFactoryWithProvider:function(1)",
+          "docComment": "/**\n * Creates a factory function that wraps a React component with a provider (e.g., Redux Provider, Context Provider).\n *\n * @param Component - React component to render\n *\n * @param Wrapper - Wrapper component (e.g., Redux Provider, Context Provider)\n *\n * @param wrapperProps - Props for the wrapper component\n *\n * @param componentProps - Optional props for the component\n *\n * @returns ComponentFactory compatible with foundation-layout\n *\n * @example\n * ```tsx\n * import { Provider } from 'react-redux';\n * import { store } from './store';\n *\n * <foundation-layout-item\n *   registration=\"my-component\"\n *   title=\"My Component\"\n *   factory={reactFactoryWithProvider(\n *     MyComponent,\n *     Provider,\n *     { store },\n *     { someProp: 'value' }\n *   )}\n * />\n * ```\n *\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export declare function reactFactoryWithProvider<CP = "
+            },
+            {
+              "kind": "Content",
+              "text": "{}"
+            },
+            {
+              "kind": "Content",
+              "text": ", WP = "
+            },
+            {
+              "kind": "Content",
+              "text": "{}"
+            },
+            {
+              "kind": "Content",
+              "text": ">(Component: "
+            },
+            {
+              "kind": "Reference",
+              "text": "React.ComponentType",
+              "canonicalReference": "@types/react!React.ComponentType:type"
+            },
+            {
+              "kind": "Content",
+              "text": "<CP>"
+            },
+            {
+              "kind": "Content",
+              "text": ", Wrapper: "
+            },
+            {
+              "kind": "Reference",
+              "text": "React.ComponentType",
+              "canonicalReference": "@types/react!React.ComponentType:type"
+            },
+            {
+              "kind": "Content",
+              "text": "<WP & {\n    children: "
+            },
+            {
+              "kind": "Reference",
+              "text": "React.ReactNode",
+              "canonicalReference": "@types/react!React.ReactNode:type"
+            },
+            {
+              "kind": "Content",
+              "text": ";\n}>"
+            },
+            {
+              "kind": "Content",
+              "text": ", wrapperProps: "
+            },
+            {
+              "kind": "Content",
+              "text": "WP"
+            },
+            {
+              "kind": "Content",
+              "text": ", componentProps?: "
+            },
+            {
+              "kind": "Content",
+              "text": "CP"
+            },
+            {
+              "kind": "Content",
+              "text": "): "
+            },
+            {
+              "kind": "Reference",
+              "text": "ComponentFactory",
+              "canonicalReference": "@genesislcap/foundation-layout!ComponentFactory:type"
+            },
+            {
+              "kind": "Content",
+              "text": ";"
+            }
+          ],
+          "fileUrlPath": "src/react-layout-factory.tsx",
+          "returnTypeTokenRange": {
+            "startIndex": 17,
+            "endIndex": 18
+          },
+          "releaseTag": "Public",
+          "overloadIndex": 1,
+          "parameters": [
+            {
+              "parameterName": "Component",
+              "parameterTypeTokenRange": {
+                "startIndex": 5,
+                "endIndex": 7
+              },
+              "isOptional": false
+            },
+            {
+              "parameterName": "Wrapper",
+              "parameterTypeTokenRange": {
+                "startIndex": 8,
+                "endIndex": 12
+              },
+              "isOptional": false
+            },
+            {
+              "parameterName": "wrapperProps",
+              "parameterTypeTokenRange": {
+                "startIndex": 13,
+                "endIndex": 14
+              },
+              "isOptional": false
+            },
+            {
+              "parameterName": "componentProps",
+              "parameterTypeTokenRange": {
+                "startIndex": 15,
+                "endIndex": 16
+              },
+              "isOptional": true
+            }
+          ],
+          "typeParameters": [
+            {
+              "typeParameterName": "CP",
+              "constraintTokenRange": {
+                "startIndex": 0,
+                "endIndex": 0
+              },
+              "defaultTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              }
+            },
+            {
+              "typeParameterName": "WP",
+              "constraintTokenRange": {
+                "startIndex": 0,
+                "endIndex": 0
+              },
+              "defaultTypeTokenRange": {
+                "startIndex": 3,
+                "endIndex": 4
+              }
+            }
+          ],
+          "name": "reactFactoryWithProvider"
+        },
+        {
+          "kind": "Variable",
+          "canonicalReference": "@genesislcap/foundation-react-utils!VERSION:var",
+          "docComment": "/**\n * Package version\n *\n * @public\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "VERSION = "
+            },
+            {
+              "kind": "Content",
+              "text": "\"14.354.2\""
+            }
+          ],
+          "fileUrlPath": "src/index.ts",
+          "initializerTokenRange": {
+            "startIndex": 1,
+            "endIndex": 2
+          },
+          "isReadonly": true,
+          "releaseTag": "Public",
+          "name": "VERSION",
+          "variableTypeTokenRange": {
+            "startIndex": 0,
+            "endIndex": 0
+          }
+        }
+      ]
+    }
+  ]
+}

package/dist/foundation-react-utils.d.ts

@@ -0,0 +1,58 @@
+import { ComponentFactory } from '@genesislcap/foundation-layout';
+import * as React_2 from 'react';
+
+/**
+ * Creates a factory function for rendering React components in layout items.
+ *
+ * @param Component - React component to render
+ * @param props - Optional props to pass to the component
+ * @returns ComponentFactory compatible with foundation-layout
+ *
+ * @example
+ * ```tsx
+ * <foundation-layout-item
+ *   registration="my-component"
+ *   title="My Component"
+ *   factory={reactFactory(MyComponent, { someProp: 'value' })}
+ * />
+ * ```
+ */
+export declare function reactFactory<P = {}>(Component: React_2.ComponentType<P>, props?: P): ComponentFactory;
+
+/**
+ * Creates a factory function that wraps a React component with a provider (e.g., Redux Provider, Context Provider).
+ *
+ * @param Component - React component to render
+ * @param Wrapper - Wrapper component (e.g., Redux Provider, Context Provider)
+ * @param wrapperProps - Props for the wrapper component
+ * @param componentProps - Optional props for the component
+ * @returns ComponentFactory compatible with foundation-layout
+ *
+ * @example
+ * ```tsx
+ * import { Provider } from 'react-redux';
+ * import { store } from './store';
+ *
+ * <foundation-layout-item
+ *   registration="my-component"
+ *   title="My Component"
+ *   factory={reactFactoryWithProvider(
+ *     MyComponent,
+ *     Provider,
+ *     { store },
+ *     { someProp: 'value' }
+ *   )}
+ * />
+ * ```
+ */
+export declare function reactFactoryWithProvider<CP = {}, WP = {}>(Component: React_2.ComponentType<CP>, Wrapper: React_2.ComponentType<WP & {
+    children: React_2.ReactNode;
+}>, wrapperProps: WP, componentProps?: CP): ComponentFactory;
+
+/**
+ * Package version
+ * @public
+ */
+export declare const VERSION = "14.354.2";
+
+export { }

package/dist/tsconfig.tsbuildinfo

@@ -0,0 +1 @@
+{"root":["../src/index.ts","../src/react-layout-factory.tsx"],"version":"5.9.2"}

package/docs/api/foundation-react-utils.md

@@ -0,0 +1,69 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-react-utils](./foundation-react-utils.md)
+
+## foundation-react-utils package
+
+## Functions
+
+<table><thead><tr><th>
+
+Function
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[reactFactory(Component, props)](./foundation-react-utils.reactfactory.md)
+
+
+</td><td>
+
+Creates a factory function for rendering React components in layout items.
+
+
+</td></tr>
+<tr><td>
+
+[reactFactoryWithProvider(Component, Wrapper, wrapperProps, componentProps)](./foundation-react-utils.reactfactorywithprovider.md)
+
+
+</td><td>
+
+Creates a factory function that wraps a React component with a provider (e.g., Redux Provider, Context Provider).
+
+
+</td></tr>
+</tbody></table>
+
+## Variables
+
+<table><thead><tr><th>
+
+Variable
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[VERSION](./foundation-react-utils.version.md)
+
+
+</td><td>
+
+Package version
+
+
+</td></tr>
+</tbody></table>
+

package/docs/api/foundation-react-utils.reactfactory.md

@@ -0,0 +1,83 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-react-utils](./foundation-react-utils.md) &gt; [reactFactory](./foundation-react-utils.reactfactory.md)
+
+## reactFactory() function
+
+Creates a factory function for rendering React components in layout items.
+
+**Signature:**
+
+```typescript
+export declare function reactFactory<P = {}>(Component: React.ComponentType<P>, props?: P): ComponentFactory;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+Component
+
+
+</td><td>
+
+React.ComponentType&lt;P&gt;
+
+
+</td><td>
+
+React component to render
+
+
+</td></tr>
+<tr><td>
+
+props
+
+
+</td><td>
+
+P
+
+
+</td><td>
+
+_(Optional)_ Optional props to pass to the component
+
+
+</td></tr>
+</tbody></table>
+
+**Returns:**
+
+ComponentFactory
+
+ComponentFactory compatible with foundation-layout
+
+## Example
+
+
+```tsx
+<foundation-layout-item
+  registration="my-component"
+  title="My Component"
+  factory={reactFactory(MyComponent, { someProp: 'value' })}
+/>
+```
+