@accelint/design-toolkit 6.0.0 → 7.0.0

package/dist/lib/react.d.ts

@@ -1,59 +0,0 @@
-import { ReactNode, JSXElementConstructor } from 'react';
-
-type ChildrenTypes = ReactNode | ReactNode[] | ((values: any & {
-    defaultChildren: ReactNode | undefined;
-}) => ReactNode);
-type Restriction = [
-    string | JSXElementConstructor<any>,
-    {
-        min: number;
-        max?: number;
-    }
-];
-type ContainsExactChildrenProps = {
-    componentName: string;
-    children: ChildrenTypes;
-    restrictions: Restriction[];
-};
-type ContainsAnyOfExactChildrenProps = {
-    componentName: string;
-    children: ChildrenTypes;
-    restrictions: Restriction[][];
-};
-/**
- * Validates the intended composite component structure.
- *
- * @param children the children of the component
- * @param componentName the displayName of the component
- * @param restrictions the record of validation rules
- */
-declare function containsExactChildren({ children, componentName, restrictions, }: ContainsExactChildrenProps): void;
-/**
- * Validates the intended composite component structure.
- *
- * @param children the children of the component
- * @param componentName the displayName of the component
- * @param restrictions the record of validation rules
- */
-declare function containsAnyOfExactChildren({ children, componentName, restrictions, }: ContainsAnyOfExactChildrenProps): void;
-/**
- * I look for svgIcons exported from the @accelint/icons library
- * and ensure that they are wrapped in an Icon component in order
- * to get the classes and styles they need in context.
- *
- * Using isValidElement means we will filter out strings, boolean, etc.
- * that are valid nodes but not elements.
- *
- * @example
- *   expectsIconWrapper({
- *     children,
- *     componentName: Button.displayName,
- *   });
- *
- *
- * @param children the children of the calling component
- * @param componentName the displayName of the calling component
- */
-declare function expectsIconWrapper({ children, componentName, }: Omit<ContainsExactChildrenProps, 'restrictions'>): void;
-
-export { containsAnyOfExactChildren, containsExactChildren, expectsIconWrapper };

package/dist/lib/react.js

@@ -1,9 +0,0 @@
-import {jsx,Fragment}from'react/jsx-runtime';import {isValidElement,Children,Fragment as Fragment$1}from'react';class l extends Error{constructor(e){super(e),this.name="ComponentStructureError";}}function u(r){const e=Children.toArray(typeof r=="function"?r({state:{},defaultChildren:jsx(Fragment,{})}):r);let o=0;for(;o<e.length;){const n=e[o];n!=null&&typeof n=="object"&&!(n instanceof Promise)&&!(Symbol.iterator in n)&&n.type===Fragment$1&&n.props!=null&&typeof n.props=="object"&&"children"in n.props?e.splice(o,1,...Children.toArray(n.props.children)):o++;}return e}function m(r,e){const o=r.reduce((t,s)=>{const i=s.type?.name??s.type?.displayName??s.type?.render?.name;return i&&(t[i]=(t[i]||0)+1),t},{}),n=[],c=[];for(const[t,{min:s,max:i}]of e){const p=typeof t=="string"?t:t.name??t.displayName??t.render?.name,a=o[p]??0;a<s&&n.push(`${s-a} of <${p}>`),i!==void 0&&a>i&&c.push(`${a-i} of <${p}>`);}return {missingComponentsArray:n,excessComponentsArray:c}}function x({children:r,componentName:e,restrictions:o}){if(process.env.NODE_ENV==="production")return;const n=u(r);if(!n.every(isValidElement))throw new l(`<${e}> received invalid children.`);const{missingComponentsArray:c,excessComponentsArray:t}=m(n,o);if(c.length||t.length){const s=(p,a)=>a.length?`	${p}:
-		${a.join(", ")}
-`:"",i=`Invalid <${e}> structure 
-${s("Missing the following",c)}${s("Excess of the following",t)}`;throw new l(i.trim())}}function $({children:r,componentName:e,restrictions:o}){if(process.env.NODE_ENV==="production")return;const n=u(r);if(!n.every(isValidElement))throw new l(`<${e}> received invalid children.`);const c=[];for(const t of o){const{missingComponentsArray:s,excessComponentsArray:i}=m(n,t);if(s.length||i.length){const p=(a,f)=>f.length?`	${a}:
-		${f.join(", ")}`:"";c.push(`${p("Missing the following",s)}${p("Excess of the following",i)}`);}}if(c.length===o.length){const t=`Invalid <${e}> structure 
- ${c.join(`
-	OR
-`)}`;throw new l(t)}}function w({children:r,componentName:e}){if(process.env.NODE_ENV==="production")return;Children.toArray(r).forEach(n=>{if(isValidElement(n)&&n.type?.name?.startsWith("Svg"))throw new Error(`${e} is using an icon without the required Icon wrapper`)});}export{$ as containsAnyOfExactChildren,x as containsExactChildren,w as expectsIconWrapper};//# sourceMappingURL=react.js.map
-//# sourceMappingURL=react.js.map

package/dist/lib/react.js.map

@@ -1 +0,0 @@
-{"version":3,"sources":["../../src/lib/react.tsx"],"names":["ComponentStructureError","message","getChildren","children","childrenArray","Children","jsx","Fragment","index","child","validateChildren","childrenComponents","restrictions","accumulationResults","acc","name","missingComponentsArray","excessComponentsArray","component","min","max","found","containsExactChildren","componentName","isValidElement","formatList","label","items","errorMessage","containsAnyOfExactChildren","errorMessages","restriction","expectsIconWrapper"],"mappings":"gHAoBA,MAAMA,CAAAA,SAAgC,KAAM,CAC1C,WAAA,CAAYC,CAAAA,CAAiB,CAC3B,KAAA,CAAMA,CAAO,EACb,IAAA,CAAK,IAAA,CAAO,0BACd,CACF,CAYA,SAASC,CAAAA,CAAYC,CAAAA,CAAyB,CAC5C,MAAMC,CAAAA,CAAgBC,QAAAA,CAAS,OAAA,CAC7B,OAAOF,CAAAA,EAAa,UAAA,CAChBA,CAAAA,CAAS,CAAE,KAAA,CAAO,EAAC,CAAG,eAAA,CAAiBG,GAAAA,CAAAC,QAAAA,CAAA,EAAE,CAAI,CAAC,CAAA,CAC9CJ,CACN,CAAA,CACA,IAAIK,CAAAA,CAAQ,CAAA,CAEZ,KAAOA,EAAQJ,CAAAA,CAAc,MAAA,EAAQ,CACnC,MAAMK,CAAAA,CAAQL,CAAAA,CAAcI,CAAK,CAAA,CAG/BC,GAAS,IAAA,EACT,OAAOA,CAAAA,EAAU,QAAA,EACjB,EAAEA,CAAAA,YAAiB,OAAA,CAAA,EACnB,EAAE,MAAA,CAAO,QAAA,IAAYA,CAAAA,CAAAA,EACrBA,CAAAA,CAAM,IAAA,GAASF,UAAAA,EACfE,CAAAA,CAAM,KAAA,EAAS,MACf,OAAOA,CAAAA,CAAM,KAAA,EAAU,QAAA,EACvB,UAAA,GAAcA,CAAAA,CAAM,KAAA,CAEpBL,CAAAA,CAAc,OACZI,CAAAA,CACA,CAAA,CACA,GAAGH,QAAAA,CAAS,OAAA,CAAQI,CAAAA,CAAM,KAAA,CAAM,QAAmC,CACrE,CAAA,CAEAD,CAAAA,GAEJ,CAEA,OAAOJ,CACT,CAoBA,SAASM,CAAAA,CACPC,CAAAA,CACAC,CAAAA,CACA,CACA,MAAMC,CAAAA,CAAsBF,CAAAA,CAAmB,MAAA,CAC7C,CAACG,EAA6BL,CAAAA,GAAU,CACtC,MAAMM,CAAAA,CAEJN,CAAAA,CAAM,IAAA,EAAM,IAAA,EAAQA,CAAAA,CAAM,MAAM,WAAA,EAAeA,CAAAA,CAAM,IAAA,EAAM,MAAA,EAAQ,IAAA,CAErE,OAAIM,CAAAA,GACFD,CAAAA,CAAIC,CAAI,CAAA,CAAA,CAAKD,CAAAA,CAAIC,CAAI,CAAA,EAAK,CAAA,EAAK,CAAA,CAAA,CAE1BD,CACT,CAAA,CACA,EACF,CAAA,CAEME,CAAAA,CAAmC,EAAC,CACpCC,CAAAA,CAAkC,GAExC,IAAA,KAAW,CAACC,CAAAA,CAAW,CAAE,GAAA,CAAAC,CAAAA,CAAK,GAAA,CAAAC,CAAI,CAAC,CAAA,GAAKR,CAAAA,CAAc,CACpD,MAAMG,CAAAA,CACJ,OAAOG,CAAAA,EAAc,QAAA,CACjBA,EAECA,CAAAA,CAAU,IAAA,EAAQA,CAAAA,CAAU,WAAA,EAAeA,CAAAA,CAAU,MAAA,EAAQ,IAAA,CAE9DG,CAAAA,CAAQR,CAAAA,CAAoBE,CAAI,CAAA,EAAK,CAAA,CAEvCM,CAAAA,CAAQF,CAAAA,EACVH,CAAAA,CAAuB,IAAA,CAAK,GAAGG,CAAAA,CAAME,CAAK,CAAA,KAAA,EAAQN,CAAI,CAAA,CAAA,CAAG,CAAA,CAGvDK,CAAAA,GAAQ,MAAA,EAAaC,EAAQD,CAAAA,EAC/BH,CAAAA,CAAsB,IAAA,CAAK,CAAA,EAAGI,CAAAA,CAAQD,CAAG,CAAA,KAAA,EAAQL,CAAI,GAAG,EAE5D,CAEA,OAAO,CAAE,sBAAA,CAAAC,CAAAA,CAAwB,qBAAA,CAAAC,CAAsB,CACzD,CASO,SAASK,CAAAA,CAAsB,CACpC,QAAA,CAAAnB,CAAAA,CACA,aAAA,CAAAoB,EACA,YAAA,CAAAX,CACF,CAAA,CAA+B,CAC7B,GAAI,OAAA,CAAQ,GAAA,CAAI,QAAA,GAAa,aAC3B,OAGF,MAAMD,CAAAA,CAAqBT,CAAAA,CAAYC,CAAQ,CAAA,CAE/C,GAAI,CAACQ,EAAmB,KAAA,CAAMa,cAAc,CAAA,CAC1C,MAAM,IAAIxB,CAAAA,CACR,CAAA,CAAA,EAAIuB,CAAa,CAAA,4BAAA,CACnB,CAAA,CAGF,KAAM,CAAE,sBAAA,CAAAP,CAAAA,CAAwB,qBAAA,CAAAC,CAAsB,EAAIP,CAAAA,CACxDC,CAAAA,CACAC,CACF,CAAA,CAEA,GAAII,CAAAA,CAAuB,MAAA,EAAUC,CAAAA,CAAsB,OAAQ,CACjE,MAAMQ,CAAAA,CAAa,CAACC,CAAAA,CAAeC,CAAAA,GACjCA,CAAAA,CAAM,MAAA,CAAS,IAAKD,CAAK,CAAA;AAAA,EAAA,EAAUC,CAAAA,CAAM,IAAA,CAAK,IAAI,CAAC;AAAA,CAAA,CAAO,EAAA,CAEtDC,CAAAA,CACJ,CAAA,SAAA,EAAYL,CAAa,CAAA;AAAA,EACtBE,EAAW,uBAAA,CAAyBT,CAAsB,CAAC,CAAA,EAC3DS,CAAAA,CAAW,0BAA2BR,CAAqB,CAAC,CAAA,CAAA,CAEjE,MAAM,IAAIjB,CAAAA,CAAwB4B,CAAAA,CAAa,MAAM,CACvD,CACF,CASO,SAASC,CAAAA,CAA2B,CACzC,SAAA1B,CAAAA,CACA,aAAA,CAAAoB,EACA,YAAA,CAAAX,CACF,EAAoC,CAClC,GAAI,QAAQ,GAAA,CAAI,QAAA,GAAa,aAC3B,OAGF,MAAMD,EAAqBT,CAAAA,CAAYC,CAAQ,EAE/C,GAAI,CAACQ,CAAAA,CAAmB,KAAA,CAAMa,cAAc,CAAA,CAC1C,MAAM,IAAIxB,CAAAA,CACR,CAAA,CAAA,EAAIuB,CAAa,CAAA,4BAAA,CACnB,CAAA,CAGF,MAAMO,CAAAA,CAAgB,GAEtB,IAAA,MAAWC,CAAAA,IAAenB,EAAc,CACtC,KAAM,CAAE,sBAAA,CAAAI,CAAAA,CAAwB,qBAAA,CAAAC,CAAsB,EAAIP,CAAAA,CACxDC,CAAAA,CACAoB,CACF,CAAA,CAEA,GAAIf,EAAuB,MAAA,EAAUC,CAAAA,CAAsB,OAAQ,CACjE,MAAMQ,EAAa,CAACC,CAAAA,CAAeC,IACjCA,CAAAA,CAAM,MAAA,CAAS,IAAKD,CAAK,CAAA;AAAA,EAAA,EAAUC,CAAAA,CAAM,IAAA,CAAK,IAAI,CAAC,CAAA,CAAA,CAAK,EAAA,CAE1DG,CAAAA,CAAc,IAAA,CACZ,CAAA,EAAGL,CAAAA,CAAW,uBAAA,CAAyBT,CAAsB,CAAC,CAAA,EACzDS,CAAAA,CAAW,yBAAA,CAA2BR,CAAqB,CAAC,CAAA,CACnE,EACF,CACF,CAEA,GAAIa,CAAAA,CAAc,MAAA,GAAWlB,CAAAA,CAAa,MAAA,CAAQ,CAChD,MAAMgB,CAAAA,CAAe,YAAYL,CAAa,CAAA;AAAA,CAAA,EAAkBO,EAAc,IAAA,CAAK;AAAA;AAAA,CAAU,CAAC,GAE9F,MAAM,IAAI9B,EAAwB4B,CAAY,CAChD,CACF,CAoBO,SAASI,CAAAA,CAAmB,CACjC,QAAA,CAAA7B,CAAAA,CACA,cAAAoB,CACF,CAAA,CAAqD,CACnD,GAAI,OAAA,CAAQ,GAAA,CAAI,QAAA,GAAa,YAAA,CAC3B,OAGyBlB,SAAS,OAAA,CAClCF,CACF,EAEmB,OAAA,CAASM,CAAAA,EAAU,CACpC,GAAIe,cAAAA,CAAef,CAAK,CAAA,EAGlBA,CAAAA,CAAM,IAAA,EAAM,MAAM,UAAA,CAAW,KAAK,CAAA,CACpC,MAAM,IAAI,KAAA,CACR,GAAGc,CAAa,CAAA,mDAAA,CAClB,CAGN,CAAC,EACH","file":"react.js","sourcesContent":["/*\n * Copyright 2025 Hypergiant Galactic Systems Inc. All rights reserved.\n * This file is licensed to you under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License. You may obtain a copy\n * of the License at https://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software distributed under\n * the License is distributed on an \"AS IS\" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS\n * OF ANY KIND, either express or implied. See the License for the specific language\n * governing permissions and limitations under the License.\n */\n\nimport {\n  Children,\n  Fragment,\n  isValidElement,\n  type JSXElementConstructor,\n  type ReactNode,\n} from 'react';\n\nclass ComponentStructureError extends Error {\n  constructor(message: string) {\n    super(message);\n    this.name = 'ComponentStructureError';\n  }\n}\n\ntype ChildrenTypes =\n  | ReactNode\n  | ReactNode[]\n  | ((\n      // biome-ignore lint/suspicious/noExplicitAny: aria render props include a generic type\n      values: any & {\n        defaultChildren: ReactNode | undefined;\n      },\n    ) => ReactNode);\n\nfunction getChildren(children: ChildrenTypes) {\n  const childrenArray = Children.toArray(\n    typeof children === 'function'\n      ? children({ state: {}, defaultChildren: <></> })\n      : children,\n  );\n  let index = 0;\n\n  while (index < childrenArray.length) {\n    const child = childrenArray[index];\n\n    if (\n      child != null &&\n      typeof child === 'object' &&\n      !(child instanceof Promise) &&\n      !(Symbol.iterator in child) &&\n      child.type === Fragment &&\n      child.props != null &&\n      typeof child.props === 'object' &&\n      'children' in child.props\n    ) {\n      childrenArray.splice(\n        index,\n        1,\n        ...Children.toArray(child.props.children as ReactNode | ReactNode[]),\n      );\n    } else {\n      index++;\n    }\n  }\n\n  return childrenArray;\n}\n\ntype Restriction = [\n  // biome-ignore lint/suspicious/noExplicitAny: allow all props\n  string | JSXElementConstructor<any>,\n  { min: number; max?: number },\n];\n\ntype ContainsExactChildrenProps = {\n  componentName: string;\n  children: ChildrenTypes;\n  restrictions: Restriction[];\n};\n\ntype ContainsAnyOfExactChildrenProps = {\n  componentName: string;\n  children: ChildrenTypes;\n  restrictions: Restriction[][];\n};\n\nfunction validateChildren(\n  childrenComponents: ReturnType<typeof getChildren>,\n  restrictions: Restriction[],\n) {\n  const accumulationResults = childrenComponents.reduce(\n    (acc: Record<string, number>, child) => {\n      const name =\n        // @ts-expect-error Accessing undocumented / untyped properties of React components\n        child.type?.name ?? child.type?.displayName ?? child.type?.render?.name;\n\n      if (name) {\n        acc[name] = (acc[name] || 0) + 1;\n      }\n      return acc;\n    },\n    {},\n  );\n\n  const missingComponentsArray: string[] = [];\n  const excessComponentsArray: string[] = [];\n\n  for (const [component, { min, max }] of restrictions) {\n    const name =\n      typeof component === 'string'\n        ? component\n        : // @ts-expect-error Accessing undocumented / untyped properties of React components\n          (component.name ?? component.displayName ?? component.render?.name);\n\n    const found = accumulationResults[name] ?? 0;\n\n    if (found < min) {\n      missingComponentsArray.push(`${min - found} of <${name}>`);\n    }\n\n    if (max !== undefined && found > max) {\n      excessComponentsArray.push(`${found - max} of <${name}>`);\n    }\n  }\n\n  return { missingComponentsArray, excessComponentsArray };\n}\n\n/**\n * Validates the intended composite component structure.\n *\n * @param children the children of the component\n * @param componentName the displayName of the component\n * @param restrictions the record of validation rules\n */\nexport function containsExactChildren({\n  children,\n  componentName,\n  restrictions,\n}: ContainsExactChildrenProps) {\n  if (process.env.NODE_ENV === 'production') {\n    return;\n  }\n\n  const childrenComponents = getChildren(children);\n\n  if (!childrenComponents.every(isValidElement)) {\n    throw new ComponentStructureError(\n      `<${componentName}> received invalid children.`,\n    );\n  }\n\n  const { missingComponentsArray, excessComponentsArray } = validateChildren(\n    childrenComponents,\n    restrictions,\n  );\n\n  if (missingComponentsArray.length || excessComponentsArray.length) {\n    const formatList = (label: string, items: string[]) =>\n      items.length ? `\\t${label}:\\n\\t\\t${items.join(', ')}\\n` : '';\n\n    const errorMessage =\n      `Invalid <${componentName}> structure \\n` +\n      `${formatList('Missing the following', missingComponentsArray)}` +\n      `${formatList('Excess of the following', excessComponentsArray)}`;\n\n    throw new ComponentStructureError(errorMessage.trim());\n  }\n}\n\n/**\n * Validates the intended composite component structure.\n *\n * @param children the children of the component\n * @param componentName the displayName of the component\n * @param restrictions the record of validation rules\n */\nexport function containsAnyOfExactChildren({\n  children,\n  componentName,\n  restrictions,\n}: ContainsAnyOfExactChildrenProps) {\n  if (process.env.NODE_ENV === 'production') {\n    return;\n  }\n\n  const childrenComponents = getChildren(children);\n\n  if (!childrenComponents.every(isValidElement)) {\n    throw new ComponentStructureError(\n      `<${componentName}> received invalid children.`,\n    );\n  }\n\n  const errorMessages = [];\n\n  for (const restriction of restrictions) {\n    const { missingComponentsArray, excessComponentsArray } = validateChildren(\n      childrenComponents,\n      restriction,\n    );\n\n    if (missingComponentsArray.length || excessComponentsArray.length) {\n      const formatList = (label: string, items: string[]) =>\n        items.length ? `\\t${label}:\\n\\t\\t${items.join(', ')}` : '';\n\n      errorMessages.push(\n        `${formatList('Missing the following', missingComponentsArray)}` +\n          `${formatList('Excess of the following', excessComponentsArray)}`,\n      );\n    }\n  }\n\n  if (errorMessages.length === restrictions.length) {\n    const errorMessage = `Invalid <${componentName}> structure \\n ${errorMessages.join('\\n\\tOR\\n')}`;\n\n    throw new ComponentStructureError(errorMessage);\n  }\n}\n\n/**\n * I look for svgIcons exported from the @accelint/icons library\n * and ensure that they are wrapped in an Icon component in order\n * to get the classes and styles they need in context.\n *\n * Using isValidElement means we will filter out strings, boolean, etc.\n * that are valid nodes but not elements.\n *\n * @example\n *   expectsIconWrapper({\n *     children,\n *     componentName: Button.displayName,\n *   });\n *\n *\n * @param children the children of the calling component\n * @param componentName the displayName of the calling component\n */\nexport function expectsIconWrapper({\n  children,\n  componentName,\n}: Omit<ContainsExactChildrenProps, 'restrictions'>) {\n  if (process.env.NODE_ENV === 'production') {\n    return;\n  }\n\n  const childrenComponents = Children.toArray(\n    children as ReactNode | ReactNode[],\n  );\n\n  childrenComponents.forEach((child) => {\n    if (isValidElement(child)) {\n      // icons should never be a direct child of the parent\n      // @ts-expect-error Accessing undocumented / untyped properties of React components\n      if (child.type?.name?.startsWith('Svg')) {\n        throw new Error(\n          `${componentName} is using an icon without the required Icon wrapper`,\n        );\n      }\n    }\n  });\n}\n"]}