@jfdevelops/react-layout 0.7.0 → 0.8.1

package/dist/create-config/create-resource-links.cjs

@@ -11,32 +11,54 @@ function createFullResourceLinkHref(href, hash) {
 	if (href.includes("#")) return href;
 	return `${href}#${normalizeResourceLinkHash(hash)}`;
 }
+function createResourceLinksFromConfig(isValidResource, config) {
+	return Object.entries(config).map(([resource, config]) => {
+		if (!isValidResource(resource)) throw new Error(`[createResourceLinks]: Invalid resource: ${resource}`);
+		if (!config) throw new Error(`[createResourceLinks]: "config" is required for the ${resource} resource.`);
+		if (typeof config !== "object") throw new Error(`[createResourceLinks]: "config" must be an object for the ${resource} resource. Received ${typeof config}`);
+		if (!("label" in config)) throw new Error(`[createResourceLinks]: "label" is required for the ${resource} resource.`);
+		if (typeof config.label !== "string") throw new Error(`[createResourceLinks]: "label" must be a string for the ${resource} resource. Received ${typeof config.label}`);
+		const linkConfig = config;
+		if ("href" in linkConfig && linkConfig.href !== void 0 && typeof linkConfig.href !== "string" && typeof linkConfig.href !== "function") throw new Error(`[createResourceLinks]: "href" must be a string or function for the ${resource} resource. Received ${typeof linkConfig.href}`);
+		if ("hash" in linkConfig && linkConfig.hash !== void 0 && typeof linkConfig.hash !== "string" && typeof linkConfig.hash !== "function") throw new Error(`[createResourceLinks]: "hash" must be a string or function for the ${resource} resource. Received ${typeof linkConfig.hash}`);
+		const givenHref = resolveResourceLinkHref(linkConfig.href, resource, "/");
+		const givenHash = resolveResourceLinkHref(linkConfig.hash, resource, resource);
+		return {
+			href: {
+				given: givenHref,
+				full: createFullResourceLinkHref(givenHref, givenHash),
+				...linkConfig.hash !== void 0 && !givenHref.includes("#") ? { hash: normalizeResourceLinkHash(givenHash) } : {}
+			},
+			label: config.label,
+			resource,
+			icon: "icon" in config ? config.icon : null
+		};
+	});
+}
+function createResourceLinksWithGroup(isValidResource, groups) {
+	if (!Array.isArray(groups)) throw new Error("[createResourceLinks.withGroup]: \"groups\" must be an array.");
+	return groups.map((group, index) => {
+		if (!group) throw new Error(`[createResourceLinks.withGroup]: group at index ${index} is required.`);
+		if (typeof group !== "object") throw new Error(`[createResourceLinks.withGroup]: group at index ${index} must be an object. Received ${typeof group}`);
+		if ("label" in group && group.label !== void 0 && typeof group.label !== "string") throw new Error(`[createResourceLinks.withGroup]: "label" must be a string for group at index ${index}. Received ${typeof group.label}`);
+		if (!("links" in group)) throw new Error(`[createResourceLinks.withGroup]: "links" is required for group at index ${index}.`);
+		if (typeof group.links !== "object" || group.links === null || Array.isArray(group.links)) throw new Error(`[createResourceLinks.withGroup]: "links" must be an object for group at index ${index}. Received ${Array.isArray(group.links) ? "array" : typeof group.links}`);
+		return {
+			label: "label" in group ? group.label ?? null : null,
+			icon: "icon" in group ? group.icon : null,
+			links: createResourceLinksFromConfig(isValidResource, group.links)
+		};
+	});
+}
 function createResourceLinksFn(resources) {
 	const isValidResource = require_resource.createIsValidResourceFn(resources);
-	return ((config) => {
-		return Object.entries(config).map(([resource, config]) => {
-			if (!isValidResource(resource)) throw new Error(`[createResourceLinks]: Invalid resource: ${resource}`);
-			if (!config) throw new Error(`[createResourceLinks]: "config" is required for the ${resource} resource.`);
-			if (typeof config !== "object") throw new Error(`[createResourceLinks]: "config" must be an object for the ${resource} resource. Received ${typeof config}`);
-			if (!("label" in config)) throw new Error(`[createResourceLinks]: "label" is required for the ${resource} resource.`);
-			if (typeof config.label !== "string") throw new Error(`[createResourceLinks]: "label" must be a string for the ${resource} resource. Received ${typeof config.label}`);
-			const linkConfig = config;
-			if ("href" in linkConfig && linkConfig.href !== void 0 && typeof linkConfig.href !== "string" && typeof linkConfig.href !== "function") throw new Error(`[createResourceLinks]: "href" must be a string or function for the ${resource} resource. Received ${typeof linkConfig.href}`);
-			if ("hash" in linkConfig && linkConfig.hash !== void 0 && typeof linkConfig.hash !== "string" && typeof linkConfig.hash !== "function") throw new Error(`[createResourceLinks]: "hash" must be a string or function for the ${resource} resource. Received ${typeof linkConfig.hash}`);
-			const givenHref = resolveResourceLinkHref(linkConfig.href, resource, "/");
-			const givenHash = resolveResourceLinkHref(linkConfig.hash, resource, resource);
-			return {
-				href: {
-					given: givenHref,
-					full: createFullResourceLinkHref(givenHref, givenHash),
-					...linkConfig.hash !== void 0 && !givenHref.includes("#") ? { hash: normalizeResourceLinkHash(givenHash) } : {}
-				},
-				label: config.label,
-				resource,
-				icon: "icon" in config ? config.icon : null
-			};
-		});
-	});
+	function createResourceLinks(config) {
+		return createResourceLinksFromConfig(isValidResource, config);
+	}
+	function withGroup(groups) {
+		return createResourceLinksWithGroup(isValidResource, groups);
+	}
+	return Object.assign(createResourceLinks, { withGroup });
 }
 
 //#endregion

package/dist/create-config/create-resource-links.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"create-resource-links.cjs","names":["createIsValidResourceFn"],"sources":["../../src/create-config/create-resource-links.ts"],"sourcesContent":["import { ReactNode } from 'react';\nimport {\n  createIsValidResourceFn,\n  type LayoutResourceKey,\n  type ResourceDefinition,\n} from '../resource';\n\nexport type ResourceAnchorLinkFn<Resource extends string> = (\n  resource: Resource,\n) => string;\n\nexport type ResourceLinkHref<Resource extends string> =\n  | string\n  | ResourceAnchorLinkFn<Resource>;\n\nexport interface CreateResourceLinkOptions<\n  Resources extends ReadonlyArray<ResourceDefinition>,\n  Resource extends LayoutResourceKey<Resources>,\n> {\n  /**\n   * The label of the link. This is the text that will be displayed in the link.\n   */\n  label: string;\n  /**\n   * An optional icon to register with the link. This is a headless approach, meaning you have full control\n   * over the icon's rendering.\n   */\n  icon?: ReactNode;\n  /**\n   * The href of the link. By default, the href will be `\"/\"`. While you **don't** need to include a hash,\n   * if you do, it will override the `hash` property (if provided).\n   */\n  href?: ResourceLinkHref<Resource>;\n  /**\n   * The hash of the link. By default, the hash will be the resource name. If you need to customize it, you can provide\n   * a string or a function that returns a string.\n   *\n   * @remarks A `\"#\"` is not required. The generated href will include it automatically.\n   */\n  hash?: ResourceLinkHref<Resource>;\n}\n\nexport type CreateResourceLinkConfig<\n  Resources extends ReadonlyArray<ResourceDefinition>,\n> = {\n  [resource in LayoutResourceKey<Resources>]?: CreateResourceLinkOptions<\n    Resources,\n    resource\n  >;\n};\n\nexport type InferHashFromResourceLinkHref<\n  Resource extends string,\n  Hash extends ResourceLinkHref<Resource>,\n> = Hash extends string\n  ? Hash\n  : Hash extends ResourceAnchorLinkFn<Resource>\n    ? ReturnType<Hash>\n    : never;\n\nexport type CreatedResourceHref = {\n  /**\n   * The full generated href with the `hash` if provided.\n   */\n  full: string;\n  /**\n   * The given href. This is the same value as the `href` property of the config.\n   */\n  given: string;\n};\n\nexport type CreatedResourceLinkBase<Resource extends string> = {\n  href: CreatedResourceHref;\n  label: string;\n  resource: Resource;\n  icon: ReactNode\n};\nexport type CreateResourceLinkWithHash<\n  Resource extends string,\n  Hash extends ResourceLinkHref<Resource>,\n> = Pick<CreatedResourceLinkBase<Resource>, 'label'> & {\n  href: CreatedResourceHref & {\n    hash: InferHashFromResourceLinkHref<Resource, Hash>;\n  };\n};\n\nexport type CreatedResourceLink<\n  Resources extends ReadonlyArray<ResourceDefinition>,\n  Config extends CreateResourceLinkConfig<Resources>,\n> = {\n  [Resource in keyof Config]: Resource extends LayoutResourceKey<Resources>\n    ? Config[Resource] extends {\n        hash: infer hash extends ResourceLinkHref<Resource>;\n      }\n      ? CreateResourceLinkWithHash<Resource, hash>\n      : CreatedResourceLinkBase<Resource>\n    : never;\n}[keyof Config];\n\nexport type CreateResourceLinksFn<\n  Resources extends ReadonlyArray<ResourceDefinition>,\n> = <const Config extends CreateResourceLinkConfig<Resources>>(\n  Config: Config,\n) => Array<CreatedResourceLink<Resources, Config>>;\n\nfunction resolveResourceLinkHref<Resource extends string>(\n  value: ResourceLinkHref<Resource> | undefined,\n  resource: Resource,\n  fallback: string,\n) {\n  return typeof value === 'function' ? value(resource) : (value ?? fallback);\n}\n\nfunction normalizeResourceLinkHash(hash: string) {\n  return hash.replace(/^#+/, '');\n}\n\nfunction createFullResourceLinkHref(href: string, hash: string) {\n  if (href.includes('#')) {\n    return href;\n  }\n\n  return `${href}#${normalizeResourceLinkHash(hash)}`;\n}\n\nexport function createResourceLinksFn<\n  const Resources extends ReadonlyArray<ResourceDefinition>,\n>(resources: Resources): CreateResourceLinksFn<Resources> {\n  const isValidResource = createIsValidResourceFn(resources);\n\n  return ((config) => {\n    return Object.entries(config).map(([resource, config]) => {\n      if (!isValidResource(resource)) {\n        throw new Error(`[createResourceLinks]: Invalid resource: ${resource}`);\n      }\n\n      if (!config) {\n        throw new Error(\n          `[createResourceLinks]: \"config\" is required for the ${resource} resource.`,\n        );\n      }\n\n      if (typeof config !== 'object') {\n        throw new Error(\n          `[createResourceLinks]: \"config\" must be an object for the ${resource} resource. Received ${typeof config}`,\n        );\n      }\n\n      if (!('label' in config)) {\n        throw new Error(\n          `[createResourceLinks]: \"label\" is required for the ${resource} resource.`,\n        );\n      }\n\n      if (typeof config.label !== 'string') {\n        throw new Error(\n          `[createResourceLinks]: \"label\" must be a string for the ${resource} resource. Received ${typeof config.label}`,\n        );\n      }\n\n      const linkConfig = config as CreateResourceLinkOptions<\n        Resources,\n        typeof resource\n      >;\n\n      if (\n        'href' in linkConfig &&\n        linkConfig.href !== undefined &&\n        typeof linkConfig.href !== 'string' &&\n        typeof linkConfig.href !== 'function'\n      ) {\n        throw new Error(\n          `[createResourceLinks]: \"href\" must be a string or function for the ${resource} resource. Received ${typeof linkConfig.href}`,\n        );\n      }\n\n      if (\n        'hash' in linkConfig &&\n        linkConfig.hash !== undefined &&\n        typeof linkConfig.hash !== 'string' &&\n        typeof linkConfig.hash !== 'function'\n      ) {\n        throw new Error(\n          `[createResourceLinks]: \"hash\" must be a string or function for the ${resource} resource. Received ${typeof linkConfig.hash}`,\n        );\n      }\n\n      const givenHref = resolveResourceLinkHref(linkConfig.href, resource, '/');\n      const givenHash = resolveResourceLinkHref(\n        linkConfig.hash,\n        resource,\n        resource,\n      );\n      const href = {\n        given: givenHref,\n        full: createFullResourceLinkHref(givenHref, givenHash),\n        ...(linkConfig.hash !== undefined && !givenHref.includes('#')\n          ? { hash: normalizeResourceLinkHash(givenHash) }\n          : {}),\n      };\n\n      return {\n        href,\n        label: config.label,\n        resource,\n        icon: 'icon' in config ? config.icon : null,\n      };\n    });\n  }) as CreateResourceLinksFn<Resources>;\n}\n"],"mappings":";;;AAyGA,SAAS,wBACP,OACA,UACA,UACA;CACA,OAAO,OAAO,UAAU,aAAa,MAAM,QAAQ,IAAK,SAAS;AACnE;AAEA,SAAS,0BAA0B,MAAc;CAC/C,OAAO,KAAK,QAAQ,OAAO,EAAE;AAC/B;AAEA,SAAS,2BAA2B,MAAc,MAAc;CAC9D,IAAI,KAAK,SAAS,GAAG,GACnB,OAAO;CAGT,OAAO,GAAG,KAAK,GAAG,0BAA0B,IAAI;AAClD;AAEA,SAAgB,sBAEd,WAAwD;CACxD,MAAM,kBAAkBA,yCAAwB,SAAS;CAEzD,SAAS,WAAW;EAClB,OAAO,OAAO,QAAQ,MAAM,EAAE,KAAK,CAAC,UAAU,YAAY;GACxD,IAAI,CAAC,gBAAgB,QAAQ,GAC3B,MAAM,IAAI,MAAM,4CAA4C,UAAU;GAGxE,IAAI,CAAC,QACH,MAAM,IAAI,MACR,uDAAuD,SAAS,WAClE;GAGF,IAAI,OAAO,WAAW,UACpB,MAAM,IAAI,MACR,6DAA6D,SAAS,sBAAsB,OAAO,QACrG;GAGF,IAAI,EAAE,WAAW,SACf,MAAM,IAAI,MACR,sDAAsD,SAAS,WACjE;GAGF,IAAI,OAAO,OAAO,UAAU,UAC1B,MAAM,IAAI,MACR,2DAA2D,SAAS,sBAAsB,OAAO,OAAO,OAC1G;GAGF,MAAM,aAAa;GAKnB,IACE,UAAU,cACV,WAAW,SAAS,UACpB,OAAO,WAAW,SAAS,YAC3B,OAAO,WAAW,SAAS,YAE3B,MAAM,IAAI,MACR,sEAAsE,SAAS,sBAAsB,OAAO,WAAW,MACzH;GAGF,IACE,UAAU,cACV,WAAW,SAAS,UACpB,OAAO,WAAW,SAAS,YAC3B,OAAO,WAAW,SAAS,YAE3B,MAAM,IAAI,MACR,sEAAsE,SAAS,sBAAsB,OAAO,WAAW,MACzH;GAGF,MAAM,YAAY,wBAAwB,WAAW,MAAM,UAAU,GAAG;GACxE,MAAM,YAAY,wBAChB,WAAW,MACX,UACA,QACF;GASA,OAAO;IACL;KARA,OAAO;KACP,MAAM,2BAA2B,WAAW,SAAS;KACrD,GAAI,WAAW,SAAS,UAAa,CAAC,UAAU,SAAS,GAAG,IACxD,EAAE,MAAM,0BAA0B,SAAS,EAAE,IAC7C,CAAC;IAIF;IACH,OAAO,OAAO;IACd;IACA,MAAM,UAAU,SAAS,OAAO,OAAO;GACzC;EACF,CAAC;CACH;AACF"}
+{"version":3,"file":"create-resource-links.cjs","names":["createIsValidResourceFn"],"sources":["../../src/create-config/create-resource-links.ts"],"sourcesContent":["import { ReactNode } from 'react';\nimport {\n  createIsValidResourceFn,\n  type LayoutResourceKey,\n  type ResourceDefinition,\n} from '../resource';\n\nexport type ResourceAnchorLinkFn<Resource extends string> = (\n  resource: Resource,\n) => string;\n\nexport type ResourceLinkHref<Resource extends string> =\n  | string\n  | ResourceAnchorLinkFn<Resource>;\n\nexport interface CreateResourceLinkOptions<\n  Resources extends ReadonlyArray<ResourceDefinition>,\n  Resource extends LayoutResourceKey<Resources>,\n> {\n  /**\n   * The label of the link. This is the text that will be displayed in the link.\n   */\n  label: string;\n  /**\n   * An optional icon to register with the link. This is a headless approach, meaning you have full control\n   * over the icon's rendering.\n   */\n  icon?: ReactNode;\n  /**\n   * The href of the link. By default, the href will be `\"/\"`. While you **don't** need to include a hash,\n   * if you do, it will override the `hash` property (if provided).\n   */\n  href?: ResourceLinkHref<Resource>;\n  /**\n   * The hash of the link. By default, the hash will be the resource name. If you need to customize it, you can provide\n   * a string or a function that returns a string.\n   *\n   * @remarks A `\"#\"` is not required. The generated href will include it automatically.\n   */\n  hash?: ResourceLinkHref<Resource>;\n}\n\nexport type CreateResourceLinkConfig<\n  Resources extends ReadonlyArray<ResourceDefinition>,\n> = {\n  [resource in LayoutResourceKey<Resources>]?: CreateResourceLinkOptions<\n    Resources,\n    resource\n  >;\n};\n\nexport type InferHashFromResourceLinkHref<\n  Resource extends string,\n  Hash extends ResourceLinkHref<Resource>,\n> = Hash extends string\n  ? Hash\n  : Hash extends ResourceAnchorLinkFn<Resource>\n    ? ReturnType<Hash>\n    : never;\n\nexport type CreatedResourceHref = {\n  /**\n   * The full generated href with the `hash` if provided.\n   */\n  full: string;\n  /**\n   * The given href. This is the same value as the `href` property of the config.\n   */\n  given: string;\n};\n\nexport type CreatedResourceLinkBase<Resource extends string> = {\n  href: CreatedResourceHref;\n  label: string;\n  resource: Resource;\n  icon: ReactNode;\n};\nexport type CreateResourceLinkWithHash<\n  Resource extends string,\n  Hash extends ResourceLinkHref<Resource>,\n> = Omit<CreatedResourceLinkBase<Resource>, 'href'> & {\n  href: CreatedResourceHref & {\n    hash: InferHashFromResourceLinkHref<Resource, Hash>;\n  };\n};\n\nexport type CreatedResourceLink<\n  Resources extends ReadonlyArray<ResourceDefinition>,\n  Config extends CreateResourceLinkConfig<Resources>,\n> = {\n  [Resource in keyof Config]: Resource extends LayoutResourceKey<Resources>\n    ? Config[Resource] extends {\n        hash: infer hash extends ResourceLinkHref<Resource>;\n      }\n      ? CreateResourceLinkWithHash<Resource, hash>\n      : CreatedResourceLinkBase<Resource>\n    : never;\n}[keyof Config];\n\nexport interface CreateResourceLinksFn<\n  Resources extends ReadonlyArray<ResourceDefinition>,\n> {\n  <const Config extends CreateResourceLinkConfig<Resources>>(\n    config: Config,\n  ): Array<CreatedResourceLink<Resources, Config>>;\n  withGroup: CreateResourceLinksWithGroupFn<Resources>;\n}\n\nexport interface CreateResourceLinkGroupOptions<\n  Resources extends ReadonlyArray<ResourceDefinition>,\n  Links extends CreateResourceLinkConfig<Resources> =\n    CreateResourceLinkConfig<Resources>,\n> {\n  /**\n   * The label of the group. This is the text that will be displayed for the group.\n   */\n  label?: string;\n  /**\n   * An optional icon to register with the group. This is a headless approach, meaning you have full control\n   * over the icon's rendering.\n   */\n  icon?: ReactNode;\n  /**\n   * The resource links in this group.\n   */\n  links: Links;\n}\n\nexport type CreateResourceLinkGroupInput<\n  Resources extends ReadonlyArray<ResourceDefinition>,\n> = CreateResourceLinkGroupOptions<\n  Resources,\n  CreateResourceLinkConfig<Resources>\n>;\n\nexport type CreateResourceLinksWithGroups<\n  Resources extends ReadonlyArray<ResourceDefinition>,\n  Links extends CreateResourceLinkConfig<Resources>,\n> = {\n  label: string | null;\n  icon: ReactNode;\n  links: Array<CreatedResourceLink<Resources, Links>>;\n};\n\nexport type CreateResourceLinksWithGroupFn<\n  Resources extends ReadonlyArray<ResourceDefinition>,\n> = <Groups extends ReadonlyArray<CreateResourceLinkGroupInput<Resources>>>(\n  groups: Groups,\n) => Array<\n  Groups[number] extends CreateResourceLinkGroupOptions<Resources, infer Links>\n    ? CreateResourceLinksWithGroups<Resources, Links>\n    : CreateResourceLinksWithGroups<\n        Resources,\n        CreateResourceLinkConfig<Resources>\n      >\n>;\n\nfunction resolveResourceLinkHref<Resource extends string>(\n  value: ResourceLinkHref<Resource> | undefined,\n  resource: Resource,\n  fallback: string,\n) {\n  return typeof value === 'function' ? value(resource) : (value ?? fallback);\n}\n\nfunction normalizeResourceLinkHash(hash: string) {\n  return hash.replace(/^#+/, '');\n}\n\nfunction createFullResourceLinkHref(href: string, hash: string) {\n  if (href.includes('#')) {\n    return href;\n  }\n\n  return `${href}#${normalizeResourceLinkHash(hash)}`;\n}\n\nfunction createResourceLinksFromConfig<\n  Resources extends ReadonlyArray<ResourceDefinition>,\n>(\n  isValidResource: ReturnType<typeof createIsValidResourceFn<Resources>>,\n  config: CreateResourceLinkConfig<Resources>,\n) {\n  return Object.entries(config).map(([resource, config]) => {\n    if (!isValidResource(resource)) {\n      throw new Error(`[createResourceLinks]: Invalid resource: ${resource}`);\n    }\n\n    if (!config) {\n      throw new Error(\n        `[createResourceLinks]: \"config\" is required for the ${resource} resource.`,\n      );\n    }\n\n    if (typeof config !== 'object') {\n      throw new Error(\n        `[createResourceLinks]: \"config\" must be an object for the ${resource} resource. Received ${typeof config}`,\n      );\n    }\n\n    if (!('label' in config)) {\n      throw new Error(\n        `[createResourceLinks]: \"label\" is required for the ${resource} resource.`,\n      );\n    }\n\n    if (typeof config.label !== 'string') {\n      throw new Error(\n        `[createResourceLinks]: \"label\" must be a string for the ${resource} resource. Received ${typeof config.label}`,\n      );\n    }\n\n    const linkConfig = config as CreateResourceLinkOptions<\n      Resources,\n      typeof resource\n    >;\n\n    if (\n      'href' in linkConfig &&\n      linkConfig.href !== undefined &&\n      typeof linkConfig.href !== 'string' &&\n      typeof linkConfig.href !== 'function'\n    ) {\n      throw new Error(\n        `[createResourceLinks]: \"href\" must be a string or function for the ${resource} resource. Received ${typeof linkConfig.href}`,\n      );\n    }\n\n    if (\n      'hash' in linkConfig &&\n      linkConfig.hash !== undefined &&\n      typeof linkConfig.hash !== 'string' &&\n      typeof linkConfig.hash !== 'function'\n    ) {\n      throw new Error(\n        `[createResourceLinks]: \"hash\" must be a string or function for the ${resource} resource. Received ${typeof linkConfig.hash}`,\n      );\n    }\n\n    const givenHref = resolveResourceLinkHref(linkConfig.href, resource, '/');\n    const givenHash = resolveResourceLinkHref(\n      linkConfig.hash,\n      resource,\n      resource,\n    );\n    const href = {\n      given: givenHref,\n      full: createFullResourceLinkHref(givenHref, givenHash),\n      ...(linkConfig.hash !== undefined && !givenHref.includes('#')\n        ? { hash: normalizeResourceLinkHash(givenHash) }\n        : {}),\n    };\n\n    return {\n      href,\n      label: config.label,\n      resource,\n      icon: 'icon' in config ? config.icon : null,\n    };\n  });\n}\n\nfunction createResourceLinksWithGroup<\n  Resources extends ReadonlyArray<ResourceDefinition>,\n>(\n  isValidResource: ReturnType<typeof createIsValidResourceFn<Resources>>,\n  groups: ReadonlyArray<CreateResourceLinkGroupInput<Resources>>,\n) {\n  if (!Array.isArray(groups)) {\n    throw new Error(\n      '[createResourceLinks.withGroup]: \"groups\" must be an array.',\n    );\n  }\n\n  return groups.map((group, index) => {\n    if (!group) {\n      throw new Error(\n        `[createResourceLinks.withGroup]: group at index ${index} is required.`,\n      );\n    }\n\n    if (typeof group !== 'object') {\n      throw new Error(\n        `[createResourceLinks.withGroup]: group at index ${index} must be an object. Received ${typeof group}`,\n      );\n    }\n\n    if (\n      'label' in group &&\n      group.label !== undefined &&\n      typeof group.label !== 'string'\n    ) {\n      throw new Error(\n        `[createResourceLinks.withGroup]: \"label\" must be a string for group at index ${index}. Received ${typeof group.label}`,\n      );\n    }\n\n    if (!('links' in group)) {\n      throw new Error(\n        `[createResourceLinks.withGroup]: \"links\" is required for group at index ${index}.`,\n      );\n    }\n\n    if (\n      typeof group.links !== 'object' ||\n      group.links === null ||\n      Array.isArray(group.links)\n    ) {\n      throw new Error(\n        `[createResourceLinks.withGroup]: \"links\" must be an object for group at index ${index}. Received ${Array.isArray(group.links) ? 'array' : typeof group.links}`,\n      );\n    }\n\n    return {\n      label: 'label' in group ? (group.label ?? null) : null,\n      icon: 'icon' in group ? group.icon : null,\n      links: createResourceLinksFromConfig(isValidResource, group.links),\n    };\n  });\n}\n\nexport function createResourceLinksFn<\n  const Resources extends ReadonlyArray<ResourceDefinition>,\n>(resources: Resources): CreateResourceLinksFn<Resources> {\n  const isValidResource = createIsValidResourceFn(resources);\n\n  function createResourceLinks<\n    const Config extends CreateResourceLinkConfig<Resources>,\n  >(config: Config) {\n    return createResourceLinksFromConfig(isValidResource, config);\n  }\n\n  function withGroup(\n    groups: ReadonlyArray<CreateResourceLinkGroupInput<Resources>>,\n  ) {\n    return createResourceLinksWithGroup(isValidResource, groups);\n  }\n\n  return Object.assign(createResourceLinks, {\n    withGroup,\n  }) as CreateResourceLinksFn<Resources>;\n}\n"],"mappings":";;;AA6JA,SAAS,wBACP,OACA,UACA,UACA;CACA,OAAO,OAAO,UAAU,aAAa,MAAM,QAAQ,IAAK,SAAS;AACnE;AAEA,SAAS,0BAA0B,MAAc;CAC/C,OAAO,KAAK,QAAQ,OAAO,EAAE;AAC/B;AAEA,SAAS,2BAA2B,MAAc,MAAc;CAC9D,IAAI,KAAK,SAAS,GAAG,GACnB,OAAO;CAGT,OAAO,GAAG,KAAK,GAAG,0BAA0B,IAAI;AAClD;AAEA,SAAS,8BAGP,iBACA,QACA;CACA,OAAO,OAAO,QAAQ,MAAM,EAAE,KAAK,CAAC,UAAU,YAAY;EACxD,IAAI,CAAC,gBAAgB,QAAQ,GAC3B,MAAM,IAAI,MAAM,4CAA4C,UAAU;EAGxE,IAAI,CAAC,QACH,MAAM,IAAI,MACR,uDAAuD,SAAS,WAClE;EAGF,IAAI,OAAO,WAAW,UACpB,MAAM,IAAI,MACR,6DAA6D,SAAS,sBAAsB,OAAO,QACrG;EAGF,IAAI,EAAE,WAAW,SACf,MAAM,IAAI,MACR,sDAAsD,SAAS,WACjE;EAGF,IAAI,OAAO,OAAO,UAAU,UAC1B,MAAM,IAAI,MACR,2DAA2D,SAAS,sBAAsB,OAAO,OAAO,OAC1G;EAGF,MAAM,aAAa;EAKnB,IACE,UAAU,cACV,WAAW,SAAS,UACpB,OAAO,WAAW,SAAS,YAC3B,OAAO,WAAW,SAAS,YAE3B,MAAM,IAAI,MACR,sEAAsE,SAAS,sBAAsB,OAAO,WAAW,MACzH;EAGF,IACE,UAAU,cACV,WAAW,SAAS,UACpB,OAAO,WAAW,SAAS,YAC3B,OAAO,WAAW,SAAS,YAE3B,MAAM,IAAI,MACR,sEAAsE,SAAS,sBAAsB,OAAO,WAAW,MACzH;EAGF,MAAM,YAAY,wBAAwB,WAAW,MAAM,UAAU,GAAG;EACxE,MAAM,YAAY,wBAChB,WAAW,MACX,UACA,QACF;EASA,OAAO;GACL;IARA,OAAO;IACP,MAAM,2BAA2B,WAAW,SAAS;IACrD,GAAI,WAAW,SAAS,UAAa,CAAC,UAAU,SAAS,GAAG,IACxD,EAAE,MAAM,0BAA0B,SAAS,EAAE,IAC7C,CAAC;GAIF;GACH,OAAO,OAAO;GACd;GACA,MAAM,UAAU,SAAS,OAAO,OAAO;EACzC;CACF,CAAC;AACH;AAEA,SAAS,6BAGP,iBACA,QACA;CACA,IAAI,CAAC,MAAM,QAAQ,MAAM,GACvB,MAAM,IAAI,MACR,+DACF;CAGF,OAAO,OAAO,KAAK,OAAO,UAAU;EAClC,IAAI,CAAC,OACH,MAAM,IAAI,MACR,mDAAmD,MAAM,cAC3D;EAGF,IAAI,OAAO,UAAU,UACnB,MAAM,IAAI,MACR,mDAAmD,MAAM,+BAA+B,OAAO,OACjG;EAGF,IACE,WAAW,SACX,MAAM,UAAU,UAChB,OAAO,MAAM,UAAU,UAEvB,MAAM,IAAI,MACR,gFAAgF,MAAM,aAAa,OAAO,MAAM,OAClH;EAGF,IAAI,EAAE,WAAW,QACf,MAAM,IAAI,MACR,2EAA2E,MAAM,EACnF;EAGF,IACE,OAAO,MAAM,UAAU,YACvB,MAAM,UAAU,QAChB,MAAM,QAAQ,MAAM,KAAK,GAEzB,MAAM,IAAI,MACR,iFAAiF,MAAM,aAAa,MAAM,QAAQ,MAAM,KAAK,IAAI,UAAU,OAAO,MAAM,OAC1J;EAGF,OAAO;GACL,OAAO,WAAW,QAAS,MAAM,SAAS,OAAQ;GAClD,MAAM,UAAU,QAAQ,MAAM,OAAO;GACrC,OAAO,8BAA8B,iBAAiB,MAAM,KAAK;EACnE;CACF,CAAC;AACH;AAEA,SAAgB,sBAEd,WAAwD;CACxD,MAAM,kBAAkBA,yCAAwB,SAAS;CAEzD,SAAS,oBAEP,QAAgB;EAChB,OAAO,8BAA8B,iBAAiB,MAAM;CAC9D;CAEA,SAAS,UACP,QACA;EACA,OAAO,6BAA6B,iBAAiB,MAAM;CAC7D;CAEA,OAAO,OAAO,OAAO,qBAAqB,EACxC,UACF,CAAC;AACH"}

package/dist/create-config/create-resource-links.d.cts

@@ -45,7 +45,7 @@ type CreatedResourceLinkBase<Resource extends string> = {
   resource: Resource;
   icon: ReactNode;
 };
-type CreateResourceLinkWithHash<Resource extends string, Hash extends ResourceLinkHref<Resource>> = Pick<CreatedResourceLinkBase<Resource>, 'label'> & {
+type CreateResourceLinkWithHash<Resource extends string, Hash extends ResourceLinkHref<Resource>> = Omit<CreatedResourceLinkBase<Resource>, 'href'> & {
   href: CreatedResourceHref & {
     hash: InferHashFromResourceLinkHref<Resource, Hash>;
   };
@@ -53,7 +53,32 @@ type CreateResourceLinkWithHash<Resource extends string, Hash extends ResourceLi
 type CreatedResourceLink<Resources extends ReadonlyArray<ResourceDefinition>, Config extends CreateResourceLinkConfig<Resources>> = { [Resource in keyof Config]: Resource extends LayoutResourceKey<Resources> ? Config[Resource] extends {
   hash: infer hash extends ResourceLinkHref<Resource>;
 } ? CreateResourceLinkWithHash<Resource, hash> : CreatedResourceLinkBase<Resource> : never }[keyof Config];
-type CreateResourceLinksFn<Resources extends ReadonlyArray<ResourceDefinition>> = <const Config extends CreateResourceLinkConfig<Resources>>(Config: Config) => Array<CreatedResourceLink<Resources, Config>>;
+interface CreateResourceLinksFn<Resources extends ReadonlyArray<ResourceDefinition>> {
+  <const Config extends CreateResourceLinkConfig<Resources>>(config: Config): Array<CreatedResourceLink<Resources, Config>>;
+  withGroup: CreateResourceLinksWithGroupFn<Resources>;
+}
+interface CreateResourceLinkGroupOptions<Resources extends ReadonlyArray<ResourceDefinition>, Links extends CreateResourceLinkConfig<Resources> = CreateResourceLinkConfig<Resources>> {
+  /**
+   * The label of the group. This is the text that will be displayed for the group.
+   */
+  label?: string;
+  /**
+   * An optional icon to register with the group. This is a headless approach, meaning you have full control
+   * over the icon's rendering.
+   */
+  icon?: ReactNode;
+  /**
+   * The resource links in this group.
+   */
+  links: Links;
+}
+type CreateResourceLinkGroupInput<Resources extends ReadonlyArray<ResourceDefinition>> = CreateResourceLinkGroupOptions<Resources, CreateResourceLinkConfig<Resources>>;
+type CreateResourceLinksWithGroups<Resources extends ReadonlyArray<ResourceDefinition>, Links extends CreateResourceLinkConfig<Resources>> = {
+  label: string | null;
+  icon: ReactNode;
+  links: Array<CreatedResourceLink<Resources, Links>>;
+};
+type CreateResourceLinksWithGroupFn<Resources extends ReadonlyArray<ResourceDefinition>> = <Groups extends ReadonlyArray<CreateResourceLinkGroupInput<Resources>>>(groups: Groups) => Array<Groups[number] extends CreateResourceLinkGroupOptions<Resources, infer Links> ? CreateResourceLinksWithGroups<Resources, Links> : CreateResourceLinksWithGroups<Resources, CreateResourceLinkConfig<Resources>>>;
 //#endregion
-export { CreateResourceLinkConfig, CreateResourceLinkOptions, CreateResourceLinksFn, CreatedResourceHref, CreatedResourceLink, CreatedResourceLinkBase, InferHashFromResourceLinkHref, ResourceAnchorLinkFn, ResourceLinkHref };
+export { CreateResourceLinkConfig, CreateResourceLinkGroupInput, CreateResourceLinkGroupOptions, CreateResourceLinkOptions, CreateResourceLinksFn, CreateResourceLinksWithGroupFn, CreateResourceLinksWithGroups, CreatedResourceHref, CreatedResourceLink, CreatedResourceLinkBase, InferHashFromResourceLinkHref, ResourceAnchorLinkFn, ResourceLinkHref };
 //# sourceMappingURL=create-resource-links.d.cts.map

package/dist/create-config/create-resource-links.d.cts.map

@@ -1 +1 @@
-{"version":3,"file":"create-resource-links.d.cts","names":[],"sources":["../../src/create-config/create-resource-links.ts"],"mappings":";;;;KAOY,oBAAA,6BACV,QAAA,EAAU,QAAQ;AAAA,KAGR,gBAAA,qCAER,oBAAoB,CAAC,QAAA;AAAA,UAER,yBAAA,mBACG,aAAA,CAAc,kBAAA,oBACf,iBAAA,CAAkB,SAAA;EAVL;;;EAe9B,KAAA;EAdU;;;AAAQ;EAmBlB,IAAA,GAAO,SAAA;EAhBmB;;;;EAqB1B,IAAA,GAAO,gBAAA,CAAiB,QAAA;EAnBD;;AAAQ;AAEjC;;;EAwBE,IAAA,GAAO,gBAAA,CAAiB,QAAA;AAAA;AAAA,KAGd,wBAAA,mBACQ,aAAA,CAAc,kBAAA,oBAEnB,iBAAA,CAAkB,SAAA,KAAc,yBAAA,CAC3C,SAAA,EACA,QAAA;AAAA,KAIQ,6BAAA,uCAEG,gBAAA,CAAiB,QAAA,KAC5B,IAAA,kBACA,IAAA,GACA,IAAA,SAAa,oBAAA,CAAqB,QAAA,IAChC,UAAA,CAAW,IAAA;AAAA,KAGL,mBAAA;EArBc;;;EAyBxB,IAAA;EAhDA;;;EAoDA,KAAK;AAAA;AAAA,KAGK,uBAAA;EACV,IAAA,EAAM,mBAAA;EACN,KAAA;EACA,QAAA,EAAU,QAAA;EACV,IAAA,EAAM,SAAA;AAAA;AAAA,KAEI,0BAAA,uCAEG,gBAAA,CAAiB,QAAA,KAC5B,IAAA,CAAK,uBAAA,CAAwB,QAAA;EAC/B,IAAA,EAAM,mBAAA;IACJ,IAAA,EAAM,6BAAA,CAA8B,QAAA,EAAU,IAAA;EAAA;AAAA;AAAA,KAItC,mBAAA,mBACQ,aAAA,CAAc,kBAAA,kBACjB,wBAAA,CAAyB,SAAA,0BAErB,MAAA,GAAS,QAAA,SAAiB,iBAAA,CAAkB,SAAA,IAC3D,MAAA,CAAO,QAAA;EACL,IAAA,qBAAyB,gBAAA,CAAiB,QAAA;AAAA,IAE1C,0BAAA,CAA2B,QAAA,EAAU,IAAA,IACrC,uBAAA,CAAwB,QAAA,kBAExB,MAAA;AAAA,KAEI,qBAAA,mBACQ,aAAA,CAAc,kBAAA,2BACR,wBAAA,CAAyB,SAAA,GACjD,MAAA,EAAQ,MAAA,KACL,KAAA,CAAM,mBAAA,CAAoB,SAAA,EAAW,MAAA"}
+{"version":3,"file":"create-resource-links.d.cts","names":[],"sources":["../../src/create-config/create-resource-links.ts"],"mappings":";;;;KAOY,oBAAA,6BACV,QAAA,EAAU,QAAQ;AAAA,KAGR,gBAAA,qCAER,oBAAoB,CAAC,QAAA;AAAA,UAER,yBAAA,mBACG,aAAA,CAAc,kBAAA,oBACf,iBAAA,CAAkB,SAAA;EAVL;;;EAe9B,KAAA;EAdU;;;AAAQ;EAmBlB,IAAA,GAAO,SAAA;EAhBmB;;;;EAqB1B,IAAA,GAAO,gBAAA,CAAiB,QAAA;EAnBD;;AAAQ;AAEjC;;;EAwBE,IAAA,GAAO,gBAAA,CAAiB,QAAA;AAAA;AAAA,KAGd,wBAAA,mBACQ,aAAA,CAAc,kBAAA,oBAEnB,iBAAA,CAAkB,SAAA,KAAc,yBAAA,CAC3C,SAAA,EACA,QAAA;AAAA,KAIQ,6BAAA,uCAEG,gBAAA,CAAiB,QAAA,KAC5B,IAAA,kBACA,IAAA,GACA,IAAA,SAAa,oBAAA,CAAqB,QAAA,IAChC,UAAA,CAAW,IAAA;AAAA,KAGL,mBAAA;EArBc;;;EAyBxB,IAAA;EAhDA;;;EAoDA,KAAK;AAAA;AAAA,KAGK,uBAAA;EACV,IAAA,EAAM,mBAAA;EACN,KAAA;EACA,QAAA,EAAU,QAAA;EACV,IAAA,EAAM,SAAA;AAAA;AAAA,KAEI,0BAAA,uCAEG,gBAAA,CAAiB,QAAA,KAC5B,IAAA,CAAK,uBAAA,CAAwB,QAAA;EAC/B,IAAA,EAAM,mBAAA;IACJ,IAAA,EAAM,6BAAA,CAA8B,QAAA,EAAU,IAAA;EAAA;AAAA;AAAA,KAItC,mBAAA,mBACQ,aAAA,CAAc,kBAAA,kBACjB,wBAAA,CAAyB,SAAA,0BAErB,MAAA,GAAS,QAAA,SAAiB,iBAAA,CAAkB,SAAA,IAC3D,MAAA,CAAO,QAAA;EACL,IAAA,qBAAyB,gBAAA,CAAiB,QAAA;AAAA,IAE1C,0BAAA,CAA2B,QAAA,EAAU,IAAA,IACrC,uBAAA,CAAwB,QAAA,kBAExB,MAAA;AAAA,UAES,qBAAA,mBACG,aAAA,CAAc,kBAAA;EAAA,sBAEV,wBAAA,CAAyB,SAAA,GAC7C,MAAA,EAAQ,MAAA,GACP,KAAA,CAAM,mBAAA,CAAoB,SAAA,EAAW,MAAA;EACxC,SAAA,EAAW,8BAAA,CAA+B,SAAA;AAAA;AAAA,UAG3B,8BAAA,mBACG,aAAA,CAAc,kBAAA,iBAClB,wBAAA,CAAyB,SAAA,IACrC,wBAAA,CAAyB,SAAA;EAlEkB;;;EAuE7C,KAAA;EAzEkB;;;;EA8ElB,IAAA,GAAO,SAAA;EA5EsC;;;EAgF7C,KAAA,EAAO,KAAA;AAAA;AAAA,KAGG,4BAAA,mBACQ,aAAA,CAAc,kBAAA,KAC9B,8BAAA,CACF,SAAA,EACA,wBAAA,CAAyB,SAAA;AAAA,KAGf,6BAAA,mBACQ,aAAA,CAAc,kBAAA,iBAClB,wBAAA,CAAyB,SAAA;EAEvC,KAAA;EACA,IAAA,EAAM,SAAA;EACN,KAAA,EAAO,KAAA,CAAM,mBAAA,CAAoB,SAAA,EAAW,KAAA;AAAA;AAAA,KAGlC,8BAAA,mBACQ,aAAA,CAAc,kBAAA,qBACd,aAAA,CAAc,4BAAA,CAA6B,SAAA,IAC7D,MAAA,EAAQ,MAAA,KACL,KAAA,CACH,MAAA,iBAAuB,8BAAA,CAA+B,SAAA,iBAClD,6BAAA,CAA8B,SAAA,EAAW,KAAA,IACzC,6BAAA,CACE,SAAA,EACA,wBAAA,CAAyB,SAAA"}

package/dist/create-config/create-resource-links.d.mts

@@ -45,7 +45,7 @@ type CreatedResourceLinkBase<Resource extends string> = {
   resource: Resource;
   icon: ReactNode;
 };
-type CreateResourceLinkWithHash<Resource extends string, Hash extends ResourceLinkHref<Resource>> = Pick<CreatedResourceLinkBase<Resource>, 'label'> & {
+type CreateResourceLinkWithHash<Resource extends string, Hash extends ResourceLinkHref<Resource>> = Omit<CreatedResourceLinkBase<Resource>, 'href'> & {
   href: CreatedResourceHref & {
     hash: InferHashFromResourceLinkHref<Resource, Hash>;
   };
@@ -53,7 +53,32 @@ type CreateResourceLinkWithHash<Resource extends string, Hash extends ResourceLi
 type CreatedResourceLink<Resources extends ReadonlyArray<ResourceDefinition>, Config extends CreateResourceLinkConfig<Resources>> = { [Resource in keyof Config]: Resource extends LayoutResourceKey<Resources> ? Config[Resource] extends {
   hash: infer hash extends ResourceLinkHref<Resource>;
 } ? CreateResourceLinkWithHash<Resource, hash> : CreatedResourceLinkBase<Resource> : never }[keyof Config];
-type CreateResourceLinksFn<Resources extends ReadonlyArray<ResourceDefinition>> = <const Config extends CreateResourceLinkConfig<Resources>>(Config: Config) => Array<CreatedResourceLink<Resources, Config>>;
+interface CreateResourceLinksFn<Resources extends ReadonlyArray<ResourceDefinition>> {
+  <const Config extends CreateResourceLinkConfig<Resources>>(config: Config): Array<CreatedResourceLink<Resources, Config>>;
+  withGroup: CreateResourceLinksWithGroupFn<Resources>;
+}
+interface CreateResourceLinkGroupOptions<Resources extends ReadonlyArray<ResourceDefinition>, Links extends CreateResourceLinkConfig<Resources> = CreateResourceLinkConfig<Resources>> {
+  /**
+   * The label of the group. This is the text that will be displayed for the group.
+   */
+  label?: string;
+  /**
+   * An optional icon to register with the group. This is a headless approach, meaning you have full control
+   * over the icon's rendering.
+   */
+  icon?: ReactNode;
+  /**
+   * The resource links in this group.
+   */
+  links: Links;
+}
+type CreateResourceLinkGroupInput<Resources extends ReadonlyArray<ResourceDefinition>> = CreateResourceLinkGroupOptions<Resources, CreateResourceLinkConfig<Resources>>;
+type CreateResourceLinksWithGroups<Resources extends ReadonlyArray<ResourceDefinition>, Links extends CreateResourceLinkConfig<Resources>> = {
+  label: string | null;
+  icon: ReactNode;
+  links: Array<CreatedResourceLink<Resources, Links>>;
+};
+type CreateResourceLinksWithGroupFn<Resources extends ReadonlyArray<ResourceDefinition>> = <Groups extends ReadonlyArray<CreateResourceLinkGroupInput<Resources>>>(groups: Groups) => Array<Groups[number] extends CreateResourceLinkGroupOptions<Resources, infer Links> ? CreateResourceLinksWithGroups<Resources, Links> : CreateResourceLinksWithGroups<Resources, CreateResourceLinkConfig<Resources>>>;
 //#endregion
-export { CreateResourceLinkConfig, CreateResourceLinkOptions, CreateResourceLinksFn, CreatedResourceHref, CreatedResourceLink, CreatedResourceLinkBase, InferHashFromResourceLinkHref, ResourceAnchorLinkFn, ResourceLinkHref };
+export { CreateResourceLinkConfig, CreateResourceLinkGroupInput, CreateResourceLinkGroupOptions, CreateResourceLinkOptions, CreateResourceLinksFn, CreateResourceLinksWithGroupFn, CreateResourceLinksWithGroups, CreatedResourceHref, CreatedResourceLink, CreatedResourceLinkBase, InferHashFromResourceLinkHref, ResourceAnchorLinkFn, ResourceLinkHref };
 //# sourceMappingURL=create-resource-links.d.mts.map

package/dist/create-config/create-resource-links.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"create-resource-links.d.mts","names":[],"sources":["../../src/create-config/create-resource-links.ts"],"mappings":";;;;KAOY,oBAAA,6BACV,QAAA,EAAU,QAAQ;AAAA,KAGR,gBAAA,qCAER,oBAAoB,CAAC,QAAA;AAAA,UAER,yBAAA,mBACG,aAAA,CAAc,kBAAA,oBACf,iBAAA,CAAkB,SAAA;EAVL;;;EAe9B,KAAA;EAdU;;;AAAQ;EAmBlB,IAAA,GAAO,SAAA;EAhBmB;;;;EAqB1B,IAAA,GAAO,gBAAA,CAAiB,QAAA;EAnBD;;AAAQ;AAEjC;;;EAwBE,IAAA,GAAO,gBAAA,CAAiB,QAAA;AAAA;AAAA,KAGd,wBAAA,mBACQ,aAAA,CAAc,kBAAA,oBAEnB,iBAAA,CAAkB,SAAA,KAAc,yBAAA,CAC3C,SAAA,EACA,QAAA;AAAA,KAIQ,6BAAA,uCAEG,gBAAA,CAAiB,QAAA,KAC5B,IAAA,kBACA,IAAA,GACA,IAAA,SAAa,oBAAA,CAAqB,QAAA,IAChC,UAAA,CAAW,IAAA;AAAA,KAGL,mBAAA;EArBc;;;EAyBxB,IAAA;EAhDA;;;EAoDA,KAAK;AAAA;AAAA,KAGK,uBAAA;EACV,IAAA,EAAM,mBAAA;EACN,KAAA;EACA,QAAA,EAAU,QAAA;EACV,IAAA,EAAM,SAAA;AAAA;AAAA,KAEI,0BAAA,uCAEG,gBAAA,CAAiB,QAAA,KAC5B,IAAA,CAAK,uBAAA,CAAwB,QAAA;EAC/B,IAAA,EAAM,mBAAA;IACJ,IAAA,EAAM,6BAAA,CAA8B,QAAA,EAAU,IAAA;EAAA;AAAA;AAAA,KAItC,mBAAA,mBACQ,aAAA,CAAc,kBAAA,kBACjB,wBAAA,CAAyB,SAAA,0BAErB,MAAA,GAAS,QAAA,SAAiB,iBAAA,CAAkB,SAAA,IAC3D,MAAA,CAAO,QAAA;EACL,IAAA,qBAAyB,gBAAA,CAAiB,QAAA;AAAA,IAE1C,0BAAA,CAA2B,QAAA,EAAU,IAAA,IACrC,uBAAA,CAAwB,QAAA,kBAExB,MAAA;AAAA,KAEI,qBAAA,mBACQ,aAAA,CAAc,kBAAA,2BACR,wBAAA,CAAyB,SAAA,GACjD,MAAA,EAAQ,MAAA,KACL,KAAA,CAAM,mBAAA,CAAoB,SAAA,EAAW,MAAA"}
+{"version":3,"file":"create-resource-links.d.mts","names":[],"sources":["../../src/create-config/create-resource-links.ts"],"mappings":";;;;KAOY,oBAAA,6BACV,QAAA,EAAU,QAAQ;AAAA,KAGR,gBAAA,qCAER,oBAAoB,CAAC,QAAA;AAAA,UAER,yBAAA,mBACG,aAAA,CAAc,kBAAA,oBACf,iBAAA,CAAkB,SAAA;EAVL;;;EAe9B,KAAA;EAdU;;;AAAQ;EAmBlB,IAAA,GAAO,SAAA;EAhBmB;;;;EAqB1B,IAAA,GAAO,gBAAA,CAAiB,QAAA;EAnBD;;AAAQ;AAEjC;;;EAwBE,IAAA,GAAO,gBAAA,CAAiB,QAAA;AAAA;AAAA,KAGd,wBAAA,mBACQ,aAAA,CAAc,kBAAA,oBAEnB,iBAAA,CAAkB,SAAA,KAAc,yBAAA,CAC3C,SAAA,EACA,QAAA;AAAA,KAIQ,6BAAA,uCAEG,gBAAA,CAAiB,QAAA,KAC5B,IAAA,kBACA,IAAA,GACA,IAAA,SAAa,oBAAA,CAAqB,QAAA,IAChC,UAAA,CAAW,IAAA;AAAA,KAGL,mBAAA;EArBc;;;EAyBxB,IAAA;EAhDA;;;EAoDA,KAAK;AAAA;AAAA,KAGK,uBAAA;EACV,IAAA,EAAM,mBAAA;EACN,KAAA;EACA,QAAA,EAAU,QAAA;EACV,IAAA,EAAM,SAAA;AAAA;AAAA,KAEI,0BAAA,uCAEG,gBAAA,CAAiB,QAAA,KAC5B,IAAA,CAAK,uBAAA,CAAwB,QAAA;EAC/B,IAAA,EAAM,mBAAA;IACJ,IAAA,EAAM,6BAAA,CAA8B,QAAA,EAAU,IAAA;EAAA;AAAA;AAAA,KAItC,mBAAA,mBACQ,aAAA,CAAc,kBAAA,kBACjB,wBAAA,CAAyB,SAAA,0BAErB,MAAA,GAAS,QAAA,SAAiB,iBAAA,CAAkB,SAAA,IAC3D,MAAA,CAAO,QAAA;EACL,IAAA,qBAAyB,gBAAA,CAAiB,QAAA;AAAA,IAE1C,0BAAA,CAA2B,QAAA,EAAU,IAAA,IACrC,uBAAA,CAAwB,QAAA,kBAExB,MAAA;AAAA,UAES,qBAAA,mBACG,aAAA,CAAc,kBAAA;EAAA,sBAEV,wBAAA,CAAyB,SAAA,GAC7C,MAAA,EAAQ,MAAA,GACP,KAAA,CAAM,mBAAA,CAAoB,SAAA,EAAW,MAAA;EACxC,SAAA,EAAW,8BAAA,CAA+B,SAAA;AAAA;AAAA,UAG3B,8BAAA,mBACG,aAAA,CAAc,kBAAA,iBAClB,wBAAA,CAAyB,SAAA,IACrC,wBAAA,CAAyB,SAAA;EAlEkB;;;EAuE7C,KAAA;EAzEkB;;;;EA8ElB,IAAA,GAAO,SAAA;EA5EsC;;;EAgF7C,KAAA,EAAO,KAAA;AAAA;AAAA,KAGG,4BAAA,mBACQ,aAAA,CAAc,kBAAA,KAC9B,8BAAA,CACF,SAAA,EACA,wBAAA,CAAyB,SAAA;AAAA,KAGf,6BAAA,mBACQ,aAAA,CAAc,kBAAA,iBAClB,wBAAA,CAAyB,SAAA;EAEvC,KAAA;EACA,IAAA,EAAM,SAAA;EACN,KAAA,EAAO,KAAA,CAAM,mBAAA,CAAoB,SAAA,EAAW,KAAA;AAAA;AAAA,KAGlC,8BAAA,mBACQ,aAAA,CAAc,kBAAA,qBACd,aAAA,CAAc,4BAAA,CAA6B,SAAA,IAC7D,MAAA,EAAQ,MAAA,KACL,KAAA,CACH,MAAA,iBAAuB,8BAAA,CAA+B,SAAA,iBAClD,6BAAA,CAA8B,SAAA,EAAW,KAAA,IACzC,6BAAA,CACE,SAAA,EACA,wBAAA,CAAyB,SAAA"}

package/dist/create-config/create-resource-links.mjs

@@ -11,32 +11,54 @@ function createFullResourceLinkHref(href, hash) {
 	if (href.includes("#")) return href;
 	return `${href}#${normalizeResourceLinkHash(hash)}`;
 }
+function createResourceLinksFromConfig(isValidResource, config) {
+	return Object.entries(config).map(([resource, config]) => {
+		if (!isValidResource(resource)) throw new Error(`[createResourceLinks]: Invalid resource: ${resource}`);
+		if (!config) throw new Error(`[createResourceLinks]: "config" is required for the ${resource} resource.`);
+		if (typeof config !== "object") throw new Error(`[createResourceLinks]: "config" must be an object for the ${resource} resource. Received ${typeof config}`);
+		if (!("label" in config)) throw new Error(`[createResourceLinks]: "label" is required for the ${resource} resource.`);
+		if (typeof config.label !== "string") throw new Error(`[createResourceLinks]: "label" must be a string for the ${resource} resource. Received ${typeof config.label}`);
+		const linkConfig = config;
+		if ("href" in linkConfig && linkConfig.href !== void 0 && typeof linkConfig.href !== "string" && typeof linkConfig.href !== "function") throw new Error(`[createResourceLinks]: "href" must be a string or function for the ${resource} resource. Received ${typeof linkConfig.href}`);
+		if ("hash" in linkConfig && linkConfig.hash !== void 0 && typeof linkConfig.hash !== "string" && typeof linkConfig.hash !== "function") throw new Error(`[createResourceLinks]: "hash" must be a string or function for the ${resource} resource. Received ${typeof linkConfig.hash}`);
+		const givenHref = resolveResourceLinkHref(linkConfig.href, resource, "/");
+		const givenHash = resolveResourceLinkHref(linkConfig.hash, resource, resource);
+		return {
+			href: {
+				given: givenHref,
+				full: createFullResourceLinkHref(givenHref, givenHash),
+				...linkConfig.hash !== void 0 && !givenHref.includes("#") ? { hash: normalizeResourceLinkHash(givenHash) } : {}
+			},
+			label: config.label,
+			resource,
+			icon: "icon" in config ? config.icon : null
+		};
+	});
+}
+function createResourceLinksWithGroup(isValidResource, groups) {
+	if (!Array.isArray(groups)) throw new Error("[createResourceLinks.withGroup]: \"groups\" must be an array.");
+	return groups.map((group, index) => {
+		if (!group) throw new Error(`[createResourceLinks.withGroup]: group at index ${index} is required.`);
+		if (typeof group !== "object") throw new Error(`[createResourceLinks.withGroup]: group at index ${index} must be an object. Received ${typeof group}`);
+		if ("label" in group && group.label !== void 0 && typeof group.label !== "string") throw new Error(`[createResourceLinks.withGroup]: "label" must be a string for group at index ${index}. Received ${typeof group.label}`);
+		if (!("links" in group)) throw new Error(`[createResourceLinks.withGroup]: "links" is required for group at index ${index}.`);
+		if (typeof group.links !== "object" || group.links === null || Array.isArray(group.links)) throw new Error(`[createResourceLinks.withGroup]: "links" must be an object for group at index ${index}. Received ${Array.isArray(group.links) ? "array" : typeof group.links}`);
+		return {
+			label: "label" in group ? group.label ?? null : null,
+			icon: "icon" in group ? group.icon : null,
+			links: createResourceLinksFromConfig(isValidResource, group.links)
+		};
+	});
+}
 function createResourceLinksFn(resources) {
 	const isValidResource = createIsValidResourceFn(resources);
-	return ((config) => {
-		return Object.entries(config).map(([resource, config]) => {
-			if (!isValidResource(resource)) throw new Error(`[createResourceLinks]: Invalid resource: ${resource}`);
-			if (!config) throw new Error(`[createResourceLinks]: "config" is required for the ${resource} resource.`);
-			if (typeof config !== "object") throw new Error(`[createResourceLinks]: "config" must be an object for the ${resource} resource. Received ${typeof config}`);
-			if (!("label" in config)) throw new Error(`[createResourceLinks]: "label" is required for the ${resource} resource.`);
-			if (typeof config.label !== "string") throw new Error(`[createResourceLinks]: "label" must be a string for the ${resource} resource. Received ${typeof config.label}`);
-			const linkConfig = config;
-			if ("href" in linkConfig && linkConfig.href !== void 0 && typeof linkConfig.href !== "string" && typeof linkConfig.href !== "function") throw new Error(`[createResourceLinks]: "href" must be a string or function for the ${resource} resource. Received ${typeof linkConfig.href}`);
-			if ("hash" in linkConfig && linkConfig.hash !== void 0 && typeof linkConfig.hash !== "string" && typeof linkConfig.hash !== "function") throw new Error(`[createResourceLinks]: "hash" must be a string or function for the ${resource} resource. Received ${typeof linkConfig.hash}`);
-			const givenHref = resolveResourceLinkHref(linkConfig.href, resource, "/");
-			const givenHash = resolveResourceLinkHref(linkConfig.hash, resource, resource);
-			return {
-				href: {
-					given: givenHref,
-					full: createFullResourceLinkHref(givenHref, givenHash),
-					...linkConfig.hash !== void 0 && !givenHref.includes("#") ? { hash: normalizeResourceLinkHash(givenHash) } : {}
-				},
-				label: config.label,
-				resource,
-				icon: "icon" in config ? config.icon : null
-			};
-		});
-	});
+	function createResourceLinks(config) {
+		return createResourceLinksFromConfig(isValidResource, config);
+	}
+	function withGroup(groups) {
+		return createResourceLinksWithGroup(isValidResource, groups);
+	}
+	return Object.assign(createResourceLinks, { withGroup });
 }
 
 //#endregion

package/dist/create-config/create-resource-links.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"create-resource-links.mjs","names":[],"sources":["../../src/create-config/create-resource-links.ts"],"sourcesContent":["import { ReactNode } from 'react';\nimport {\n  createIsValidResourceFn,\n  type LayoutResourceKey,\n  type ResourceDefinition,\n} from '../resource';\n\nexport type ResourceAnchorLinkFn<Resource extends string> = (\n  resource: Resource,\n) => string;\n\nexport type ResourceLinkHref<Resource extends string> =\n  | string\n  | ResourceAnchorLinkFn<Resource>;\n\nexport interface CreateResourceLinkOptions<\n  Resources extends ReadonlyArray<ResourceDefinition>,\n  Resource extends LayoutResourceKey<Resources>,\n> {\n  /**\n   * The label of the link. This is the text that will be displayed in the link.\n   */\n  label: string;\n  /**\n   * An optional icon to register with the link. This is a headless approach, meaning you have full control\n   * over the icon's rendering.\n   */\n  icon?: ReactNode;\n  /**\n   * The href of the link. By default, the href will be `\"/\"`. While you **don't** need to include a hash,\n   * if you do, it will override the `hash` property (if provided).\n   */\n  href?: ResourceLinkHref<Resource>;\n  /**\n   * The hash of the link. By default, the hash will be the resource name. If you need to customize it, you can provide\n   * a string or a function that returns a string.\n   *\n   * @remarks A `\"#\"` is not required. The generated href will include it automatically.\n   */\n  hash?: ResourceLinkHref<Resource>;\n}\n\nexport type CreateResourceLinkConfig<\n  Resources extends ReadonlyArray<ResourceDefinition>,\n> = {\n  [resource in LayoutResourceKey<Resources>]?: CreateResourceLinkOptions<\n    Resources,\n    resource\n  >;\n};\n\nexport type InferHashFromResourceLinkHref<\n  Resource extends string,\n  Hash extends ResourceLinkHref<Resource>,\n> = Hash extends string\n  ? Hash\n  : Hash extends ResourceAnchorLinkFn<Resource>\n    ? ReturnType<Hash>\n    : never;\n\nexport type CreatedResourceHref = {\n  /**\n   * The full generated href with the `hash` if provided.\n   */\n  full: string;\n  /**\n   * The given href. This is the same value as the `href` property of the config.\n   */\n  given: string;\n};\n\nexport type CreatedResourceLinkBase<Resource extends string> = {\n  href: CreatedResourceHref;\n  label: string;\n  resource: Resource;\n  icon: ReactNode\n};\nexport type CreateResourceLinkWithHash<\n  Resource extends string,\n  Hash extends ResourceLinkHref<Resource>,\n> = Pick<CreatedResourceLinkBase<Resource>, 'label'> & {\n  href: CreatedResourceHref & {\n    hash: InferHashFromResourceLinkHref<Resource, Hash>;\n  };\n};\n\nexport type CreatedResourceLink<\n  Resources extends ReadonlyArray<ResourceDefinition>,\n  Config extends CreateResourceLinkConfig<Resources>,\n> = {\n  [Resource in keyof Config]: Resource extends LayoutResourceKey<Resources>\n    ? Config[Resource] extends {\n        hash: infer hash extends ResourceLinkHref<Resource>;\n      }\n      ? CreateResourceLinkWithHash<Resource, hash>\n      : CreatedResourceLinkBase<Resource>\n    : never;\n}[keyof Config];\n\nexport type CreateResourceLinksFn<\n  Resources extends ReadonlyArray<ResourceDefinition>,\n> = <const Config extends CreateResourceLinkConfig<Resources>>(\n  Config: Config,\n) => Array<CreatedResourceLink<Resources, Config>>;\n\nfunction resolveResourceLinkHref<Resource extends string>(\n  value: ResourceLinkHref<Resource> | undefined,\n  resource: Resource,\n  fallback: string,\n) {\n  return typeof value === 'function' ? value(resource) : (value ?? fallback);\n}\n\nfunction normalizeResourceLinkHash(hash: string) {\n  return hash.replace(/^#+/, '');\n}\n\nfunction createFullResourceLinkHref(href: string, hash: string) {\n  if (href.includes('#')) {\n    return href;\n  }\n\n  return `${href}#${normalizeResourceLinkHash(hash)}`;\n}\n\nexport function createResourceLinksFn<\n  const Resources extends ReadonlyArray<ResourceDefinition>,\n>(resources: Resources): CreateResourceLinksFn<Resources> {\n  const isValidResource = createIsValidResourceFn(resources);\n\n  return ((config) => {\n    return Object.entries(config).map(([resource, config]) => {\n      if (!isValidResource(resource)) {\n        throw new Error(`[createResourceLinks]: Invalid resource: ${resource}`);\n      }\n\n      if (!config) {\n        throw new Error(\n          `[createResourceLinks]: \"config\" is required for the ${resource} resource.`,\n        );\n      }\n\n      if (typeof config !== 'object') {\n        throw new Error(\n          `[createResourceLinks]: \"config\" must be an object for the ${resource} resource. Received ${typeof config}`,\n        );\n      }\n\n      if (!('label' in config)) {\n        throw new Error(\n          `[createResourceLinks]: \"label\" is required for the ${resource} resource.`,\n        );\n      }\n\n      if (typeof config.label !== 'string') {\n        throw new Error(\n          `[createResourceLinks]: \"label\" must be a string for the ${resource} resource. Received ${typeof config.label}`,\n        );\n      }\n\n      const linkConfig = config as CreateResourceLinkOptions<\n        Resources,\n        typeof resource\n      >;\n\n      if (\n        'href' in linkConfig &&\n        linkConfig.href !== undefined &&\n        typeof linkConfig.href !== 'string' &&\n        typeof linkConfig.href !== 'function'\n      ) {\n        throw new Error(\n          `[createResourceLinks]: \"href\" must be a string or function for the ${resource} resource. Received ${typeof linkConfig.href}`,\n        );\n      }\n\n      if (\n        'hash' in linkConfig &&\n        linkConfig.hash !== undefined &&\n        typeof linkConfig.hash !== 'string' &&\n        typeof linkConfig.hash !== 'function'\n      ) {\n        throw new Error(\n          `[createResourceLinks]: \"hash\" must be a string or function for the ${resource} resource. Received ${typeof linkConfig.hash}`,\n        );\n      }\n\n      const givenHref = resolveResourceLinkHref(linkConfig.href, resource, '/');\n      const givenHash = resolveResourceLinkHref(\n        linkConfig.hash,\n        resource,\n        resource,\n      );\n      const href = {\n        given: givenHref,\n        full: createFullResourceLinkHref(givenHref, givenHash),\n        ...(linkConfig.hash !== undefined && !givenHref.includes('#')\n          ? { hash: normalizeResourceLinkHash(givenHash) }\n          : {}),\n      };\n\n      return {\n        href,\n        label: config.label,\n        resource,\n        icon: 'icon' in config ? config.icon : null,\n      };\n    });\n  }) as CreateResourceLinksFn<Resources>;\n}\n"],"mappings":";;;AAyGA,SAAS,wBACP,OACA,UACA,UACA;CACA,OAAO,OAAO,UAAU,aAAa,MAAM,QAAQ,IAAK,SAAS;AACnE;AAEA,SAAS,0BAA0B,MAAc;CAC/C,OAAO,KAAK,QAAQ,OAAO,EAAE;AAC/B;AAEA,SAAS,2BAA2B,MAAc,MAAc;CAC9D,IAAI,KAAK,SAAS,GAAG,GACnB,OAAO;CAGT,OAAO,GAAG,KAAK,GAAG,0BAA0B,IAAI;AAClD;AAEA,SAAgB,sBAEd,WAAwD;CACxD,MAAM,kBAAkB,wBAAwB,SAAS;CAEzD,SAAS,WAAW;EAClB,OAAO,OAAO,QAAQ,MAAM,EAAE,KAAK,CAAC,UAAU,YAAY;GACxD,IAAI,CAAC,gBAAgB,QAAQ,GAC3B,MAAM,IAAI,MAAM,4CAA4C,UAAU;GAGxE,IAAI,CAAC,QACH,MAAM,IAAI,MACR,uDAAuD,SAAS,WAClE;GAGF,IAAI,OAAO,WAAW,UACpB,MAAM,IAAI,MACR,6DAA6D,SAAS,sBAAsB,OAAO,QACrG;GAGF,IAAI,EAAE,WAAW,SACf,MAAM,IAAI,MACR,sDAAsD,SAAS,WACjE;GAGF,IAAI,OAAO,OAAO,UAAU,UAC1B,MAAM,IAAI,MACR,2DAA2D,SAAS,sBAAsB,OAAO,OAAO,OAC1G;GAGF,MAAM,aAAa;GAKnB,IACE,UAAU,cACV,WAAW,SAAS,UACpB,OAAO,WAAW,SAAS,YAC3B,OAAO,WAAW,SAAS,YAE3B,MAAM,IAAI,MACR,sEAAsE,SAAS,sBAAsB,OAAO,WAAW,MACzH;GAGF,IACE,UAAU,cACV,WAAW,SAAS,UACpB,OAAO,WAAW,SAAS,YAC3B,OAAO,WAAW,SAAS,YAE3B,MAAM,IAAI,MACR,sEAAsE,SAAS,sBAAsB,OAAO,WAAW,MACzH;GAGF,MAAM,YAAY,wBAAwB,WAAW,MAAM,UAAU,GAAG;GACxE,MAAM,YAAY,wBAChB,WAAW,MACX,UACA,QACF;GASA,OAAO;IACL;KARA,OAAO;KACP,MAAM,2BAA2B,WAAW,SAAS;KACrD,GAAI,WAAW,SAAS,UAAa,CAAC,UAAU,SAAS,GAAG,IACxD,EAAE,MAAM,0BAA0B,SAAS,EAAE,IAC7C,CAAC;IAIF;IACH,OAAO,OAAO;IACd;IACA,MAAM,UAAU,SAAS,OAAO,OAAO;GACzC;EACF,CAAC;CACH;AACF"}
+{"version":3,"file":"create-resource-links.mjs","names":[],"sources":["../../src/create-config/create-resource-links.ts"],"sourcesContent":["import { ReactNode } from 'react';\nimport {\n  createIsValidResourceFn,\n  type LayoutResourceKey,\n  type ResourceDefinition,\n} from '../resource';\n\nexport type ResourceAnchorLinkFn<Resource extends string> = (\n  resource: Resource,\n) => string;\n\nexport type ResourceLinkHref<Resource extends string> =\n  | string\n  | ResourceAnchorLinkFn<Resource>;\n\nexport interface CreateResourceLinkOptions<\n  Resources extends ReadonlyArray<ResourceDefinition>,\n  Resource extends LayoutResourceKey<Resources>,\n> {\n  /**\n   * The label of the link. This is the text that will be displayed in the link.\n   */\n  label: string;\n  /**\n   * An optional icon to register with the link. This is a headless approach, meaning you have full control\n   * over the icon's rendering.\n   */\n  icon?: ReactNode;\n  /**\n   * The href of the link. By default, the href will be `\"/\"`. While you **don't** need to include a hash,\n   * if you do, it will override the `hash` property (if provided).\n   */\n  href?: ResourceLinkHref<Resource>;\n  /**\n   * The hash of the link. By default, the hash will be the resource name. If you need to customize it, you can provide\n   * a string or a function that returns a string.\n   *\n   * @remarks A `\"#\"` is not required. The generated href will include it automatically.\n   */\n  hash?: ResourceLinkHref<Resource>;\n}\n\nexport type CreateResourceLinkConfig<\n  Resources extends ReadonlyArray<ResourceDefinition>,\n> = {\n  [resource in LayoutResourceKey<Resources>]?: CreateResourceLinkOptions<\n    Resources,\n    resource\n  >;\n};\n\nexport type InferHashFromResourceLinkHref<\n  Resource extends string,\n  Hash extends ResourceLinkHref<Resource>,\n> = Hash extends string\n  ? Hash\n  : Hash extends ResourceAnchorLinkFn<Resource>\n    ? ReturnType<Hash>\n    : never;\n\nexport type CreatedResourceHref = {\n  /**\n   * The full generated href with the `hash` if provided.\n   */\n  full: string;\n  /**\n   * The given href. This is the same value as the `href` property of the config.\n   */\n  given: string;\n};\n\nexport type CreatedResourceLinkBase<Resource extends string> = {\n  href: CreatedResourceHref;\n  label: string;\n  resource: Resource;\n  icon: ReactNode;\n};\nexport type CreateResourceLinkWithHash<\n  Resource extends string,\n  Hash extends ResourceLinkHref<Resource>,\n> = Omit<CreatedResourceLinkBase<Resource>, 'href'> & {\n  href: CreatedResourceHref & {\n    hash: InferHashFromResourceLinkHref<Resource, Hash>;\n  };\n};\n\nexport type CreatedResourceLink<\n  Resources extends ReadonlyArray<ResourceDefinition>,\n  Config extends CreateResourceLinkConfig<Resources>,\n> = {\n  [Resource in keyof Config]: Resource extends LayoutResourceKey<Resources>\n    ? Config[Resource] extends {\n        hash: infer hash extends ResourceLinkHref<Resource>;\n      }\n      ? CreateResourceLinkWithHash<Resource, hash>\n      : CreatedResourceLinkBase<Resource>\n    : never;\n}[keyof Config];\n\nexport interface CreateResourceLinksFn<\n  Resources extends ReadonlyArray<ResourceDefinition>,\n> {\n  <const Config extends CreateResourceLinkConfig<Resources>>(\n    config: Config,\n  ): Array<CreatedResourceLink<Resources, Config>>;\n  withGroup: CreateResourceLinksWithGroupFn<Resources>;\n}\n\nexport interface CreateResourceLinkGroupOptions<\n  Resources extends ReadonlyArray<ResourceDefinition>,\n  Links extends CreateResourceLinkConfig<Resources> =\n    CreateResourceLinkConfig<Resources>,\n> {\n  /**\n   * The label of the group. This is the text that will be displayed for the group.\n   */\n  label?: string;\n  /**\n   * An optional icon to register with the group. This is a headless approach, meaning you have full control\n   * over the icon's rendering.\n   */\n  icon?: ReactNode;\n  /**\n   * The resource links in this group.\n   */\n  links: Links;\n}\n\nexport type CreateResourceLinkGroupInput<\n  Resources extends ReadonlyArray<ResourceDefinition>,\n> = CreateResourceLinkGroupOptions<\n  Resources,\n  CreateResourceLinkConfig<Resources>\n>;\n\nexport type CreateResourceLinksWithGroups<\n  Resources extends ReadonlyArray<ResourceDefinition>,\n  Links extends CreateResourceLinkConfig<Resources>,\n> = {\n  label: string | null;\n  icon: ReactNode;\n  links: Array<CreatedResourceLink<Resources, Links>>;\n};\n\nexport type CreateResourceLinksWithGroupFn<\n  Resources extends ReadonlyArray<ResourceDefinition>,\n> = <Groups extends ReadonlyArray<CreateResourceLinkGroupInput<Resources>>>(\n  groups: Groups,\n) => Array<\n  Groups[number] extends CreateResourceLinkGroupOptions<Resources, infer Links>\n    ? CreateResourceLinksWithGroups<Resources, Links>\n    : CreateResourceLinksWithGroups<\n        Resources,\n        CreateResourceLinkConfig<Resources>\n      >\n>;\n\nfunction resolveResourceLinkHref<Resource extends string>(\n  value: ResourceLinkHref<Resource> | undefined,\n  resource: Resource,\n  fallback: string,\n) {\n  return typeof value === 'function' ? value(resource) : (value ?? fallback);\n}\n\nfunction normalizeResourceLinkHash(hash: string) {\n  return hash.replace(/^#+/, '');\n}\n\nfunction createFullResourceLinkHref(href: string, hash: string) {\n  if (href.includes('#')) {\n    return href;\n  }\n\n  return `${href}#${normalizeResourceLinkHash(hash)}`;\n}\n\nfunction createResourceLinksFromConfig<\n  Resources extends ReadonlyArray<ResourceDefinition>,\n>(\n  isValidResource: ReturnType<typeof createIsValidResourceFn<Resources>>,\n  config: CreateResourceLinkConfig<Resources>,\n) {\n  return Object.entries(config).map(([resource, config]) => {\n    if (!isValidResource(resource)) {\n      throw new Error(`[createResourceLinks]: Invalid resource: ${resource}`);\n    }\n\n    if (!config) {\n      throw new Error(\n        `[createResourceLinks]: \"config\" is required for the ${resource} resource.`,\n      );\n    }\n\n    if (typeof config !== 'object') {\n      throw new Error(\n        `[createResourceLinks]: \"config\" must be an object for the ${resource} resource. Received ${typeof config}`,\n      );\n    }\n\n    if (!('label' in config)) {\n      throw new Error(\n        `[createResourceLinks]: \"label\" is required for the ${resource} resource.`,\n      );\n    }\n\n    if (typeof config.label !== 'string') {\n      throw new Error(\n        `[createResourceLinks]: \"label\" must be a string for the ${resource} resource. Received ${typeof config.label}`,\n      );\n    }\n\n    const linkConfig = config as CreateResourceLinkOptions<\n      Resources,\n      typeof resource\n    >;\n\n    if (\n      'href' in linkConfig &&\n      linkConfig.href !== undefined &&\n      typeof linkConfig.href !== 'string' &&\n      typeof linkConfig.href !== 'function'\n    ) {\n      throw new Error(\n        `[createResourceLinks]: \"href\" must be a string or function for the ${resource} resource. Received ${typeof linkConfig.href}`,\n      );\n    }\n\n    if (\n      'hash' in linkConfig &&\n      linkConfig.hash !== undefined &&\n      typeof linkConfig.hash !== 'string' &&\n      typeof linkConfig.hash !== 'function'\n    ) {\n      throw new Error(\n        `[createResourceLinks]: \"hash\" must be a string or function for the ${resource} resource. Received ${typeof linkConfig.hash}`,\n      );\n    }\n\n    const givenHref = resolveResourceLinkHref(linkConfig.href, resource, '/');\n    const givenHash = resolveResourceLinkHref(\n      linkConfig.hash,\n      resource,\n      resource,\n    );\n    const href = {\n      given: givenHref,\n      full: createFullResourceLinkHref(givenHref, givenHash),\n      ...(linkConfig.hash !== undefined && !givenHref.includes('#')\n        ? { hash: normalizeResourceLinkHash(givenHash) }\n        : {}),\n    };\n\n    return {\n      href,\n      label: config.label,\n      resource,\n      icon: 'icon' in config ? config.icon : null,\n    };\n  });\n}\n\nfunction createResourceLinksWithGroup<\n  Resources extends ReadonlyArray<ResourceDefinition>,\n>(\n  isValidResource: ReturnType<typeof createIsValidResourceFn<Resources>>,\n  groups: ReadonlyArray<CreateResourceLinkGroupInput<Resources>>,\n) {\n  if (!Array.isArray(groups)) {\n    throw new Error(\n      '[createResourceLinks.withGroup]: \"groups\" must be an array.',\n    );\n  }\n\n  return groups.map((group, index) => {\n    if (!group) {\n      throw new Error(\n        `[createResourceLinks.withGroup]: group at index ${index} is required.`,\n      );\n    }\n\n    if (typeof group !== 'object') {\n      throw new Error(\n        `[createResourceLinks.withGroup]: group at index ${index} must be an object. Received ${typeof group}`,\n      );\n    }\n\n    if (\n      'label' in group &&\n      group.label !== undefined &&\n      typeof group.label !== 'string'\n    ) {\n      throw new Error(\n        `[createResourceLinks.withGroup]: \"label\" must be a string for group at index ${index}. Received ${typeof group.label}`,\n      );\n    }\n\n    if (!('links' in group)) {\n      throw new Error(\n        `[createResourceLinks.withGroup]: \"links\" is required for group at index ${index}.`,\n      );\n    }\n\n    if (\n      typeof group.links !== 'object' ||\n      group.links === null ||\n      Array.isArray(group.links)\n    ) {\n      throw new Error(\n        `[createResourceLinks.withGroup]: \"links\" must be an object for group at index ${index}. Received ${Array.isArray(group.links) ? 'array' : typeof group.links}`,\n      );\n    }\n\n    return {\n      label: 'label' in group ? (group.label ?? null) : null,\n      icon: 'icon' in group ? group.icon : null,\n      links: createResourceLinksFromConfig(isValidResource, group.links),\n    };\n  });\n}\n\nexport function createResourceLinksFn<\n  const Resources extends ReadonlyArray<ResourceDefinition>,\n>(resources: Resources): CreateResourceLinksFn<Resources> {\n  const isValidResource = createIsValidResourceFn(resources);\n\n  function createResourceLinks<\n    const Config extends CreateResourceLinkConfig<Resources>,\n  >(config: Config) {\n    return createResourceLinksFromConfig(isValidResource, config);\n  }\n\n  function withGroup(\n    groups: ReadonlyArray<CreateResourceLinkGroupInput<Resources>>,\n  ) {\n    return createResourceLinksWithGroup(isValidResource, groups);\n  }\n\n  return Object.assign(createResourceLinks, {\n    withGroup,\n  }) as CreateResourceLinksFn<Resources>;\n}\n"],"mappings":";;;AA6JA,SAAS,wBACP,OACA,UACA,UACA;CACA,OAAO,OAAO,UAAU,aAAa,MAAM,QAAQ,IAAK,SAAS;AACnE;AAEA,SAAS,0BAA0B,MAAc;CAC/C,OAAO,KAAK,QAAQ,OAAO,EAAE;AAC/B;AAEA,SAAS,2BAA2B,MAAc,MAAc;CAC9D,IAAI,KAAK,SAAS,GAAG,GACnB,OAAO;CAGT,OAAO,GAAG,KAAK,GAAG,0BAA0B,IAAI;AAClD;AAEA,SAAS,8BAGP,iBACA,QACA;CACA,OAAO,OAAO,QAAQ,MAAM,EAAE,KAAK,CAAC,UAAU,YAAY;EACxD,IAAI,CAAC,gBAAgB,QAAQ,GAC3B,MAAM,IAAI,MAAM,4CAA4C,UAAU;EAGxE,IAAI,CAAC,QACH,MAAM,IAAI,MACR,uDAAuD,SAAS,WAClE;EAGF,IAAI,OAAO,WAAW,UACpB,MAAM,IAAI,MACR,6DAA6D,SAAS,sBAAsB,OAAO,QACrG;EAGF,IAAI,EAAE,WAAW,SACf,MAAM,IAAI,MACR,sDAAsD,SAAS,WACjE;EAGF,IAAI,OAAO,OAAO,UAAU,UAC1B,MAAM,IAAI,MACR,2DAA2D,SAAS,sBAAsB,OAAO,OAAO,OAC1G;EAGF,MAAM,aAAa;EAKnB,IACE,UAAU,cACV,WAAW,SAAS,UACpB,OAAO,WAAW,SAAS,YAC3B,OAAO,WAAW,SAAS,YAE3B,MAAM,IAAI,MACR,sEAAsE,SAAS,sBAAsB,OAAO,WAAW,MACzH;EAGF,IACE,UAAU,cACV,WAAW,SAAS,UACpB,OAAO,WAAW,SAAS,YAC3B,OAAO,WAAW,SAAS,YAE3B,MAAM,IAAI,MACR,sEAAsE,SAAS,sBAAsB,OAAO,WAAW,MACzH;EAGF,MAAM,YAAY,wBAAwB,WAAW,MAAM,UAAU,GAAG;EACxE,MAAM,YAAY,wBAChB,WAAW,MACX,UACA,QACF;EASA,OAAO;GACL;IARA,OAAO;IACP,MAAM,2BAA2B,WAAW,SAAS;IACrD,GAAI,WAAW,SAAS,UAAa,CAAC,UAAU,SAAS,GAAG,IACxD,EAAE,MAAM,0BAA0B,SAAS,EAAE,IAC7C,CAAC;GAIF;GACH,OAAO,OAAO;GACd;GACA,MAAM,UAAU,SAAS,OAAO,OAAO;EACzC;CACF,CAAC;AACH;AAEA,SAAS,6BAGP,iBACA,QACA;CACA,IAAI,CAAC,MAAM,QAAQ,MAAM,GACvB,MAAM,IAAI,MACR,+DACF;CAGF,OAAO,OAAO,KAAK,OAAO,UAAU;EAClC,IAAI,CAAC,OACH,MAAM,IAAI,MACR,mDAAmD,MAAM,cAC3D;EAGF,IAAI,OAAO,UAAU,UACnB,MAAM,IAAI,MACR,mDAAmD,MAAM,+BAA+B,OAAO,OACjG;EAGF,IACE,WAAW,SACX,MAAM,UAAU,UAChB,OAAO,MAAM,UAAU,UAEvB,MAAM,IAAI,MACR,gFAAgF,MAAM,aAAa,OAAO,MAAM,OAClH;EAGF,IAAI,EAAE,WAAW,QACf,MAAM,IAAI,MACR,2EAA2E,MAAM,EACnF;EAGF,IACE,OAAO,MAAM,UAAU,YACvB,MAAM,UAAU,QAChB,MAAM,QAAQ,MAAM,KAAK,GAEzB,MAAM,IAAI,MACR,iFAAiF,MAAM,aAAa,MAAM,QAAQ,MAAM,KAAK,IAAI,UAAU,OAAO,MAAM,OAC1J;EAGF,OAAO;GACL,OAAO,WAAW,QAAS,MAAM,SAAS,OAAQ;GAClD,MAAM,UAAU,QAAQ,MAAM,OAAO;GACrC,OAAO,8BAA8B,iBAAiB,MAAM,KAAK;EACnE;CACF,CAAC;AACH;AAEA,SAAgB,sBAEd,WAAwD;CACxD,MAAM,kBAAkB,wBAAwB,SAAS;CAEzD,SAAS,oBAEP,QAAgB;EAChB,OAAO,8BAA8B,iBAAiB,MAAM;CAC9D;CAEA,SAAS,UACP,QACA;EACA,OAAO,6BAA6B,iBAAiB,MAAM;CAC7D;CAEA,OAAO,OAAO,OAAO,qBAAqB,EACxC,UACF,CAAC;AACH"}

package/dist/create-config/index.d.cts

@@ -1,4 +1,4 @@
 import { BaseResourceConfigComponents, ResourceConfig, ResourceConfigComponentKey, ResourceConfigComponents, ResourceConfigInput, ResourceConfigMap, SharedResourceConfigOptions, SubResourceConfig, SubResourceConfigComponentsFor } from "./types.cjs";
 import { CreateResourceConfigFn, CreatedResourceConfig, GetComponent, GetComponentAtBound, GetComponentForResource, GetComponentForResourceOptions, GetComponentOptions, GetComponentOptionsForResource, ResourceFromGetComponentBound, SubResourceFromGetComponentBound, ValidateForResourceBound } from "./get-component.cjs";
-import { CreateResourceLinkConfig, CreateResourceLinkOptions, CreateResourceLinksFn, CreatedResourceHref, CreatedResourceLink, CreatedResourceLinkBase, InferHashFromResourceLinkHref, ResourceAnchorLinkFn, ResourceLinkHref } from "./create-resource-links.cjs";
+import { CreateResourceLinkConfig, CreateResourceLinkGroupInput, CreateResourceLinkGroupOptions, CreateResourceLinkOptions, CreateResourceLinksFn, CreateResourceLinksWithGroupFn, CreateResourceLinksWithGroups, CreatedResourceHref, CreatedResourceLink, CreatedResourceLinkBase, InferHashFromResourceLinkHref, ResourceAnchorLinkFn, ResourceLinkHref } from "./create-resource-links.cjs";
 import { CreateResourceLayoutFn, CreateResourceLayoutMakeComposableOptions, defineResourceLayout } from "./define-layout.cjs";

package/dist/create-config/index.d.mts

@@ -1,4 +1,4 @@
 import { BaseResourceConfigComponents, ResourceConfig, ResourceConfigComponentKey, ResourceConfigComponents, ResourceConfigInput, ResourceConfigMap, SharedResourceConfigOptions, SubResourceConfig, SubResourceConfigComponentsFor } from "./types.mjs";
 import { CreateResourceConfigFn, CreatedResourceConfig, GetComponent, GetComponentAtBound, GetComponentForResource, GetComponentForResourceOptions, GetComponentOptions, GetComponentOptionsForResource, ResourceFromGetComponentBound, SubResourceFromGetComponentBound, ValidateForResourceBound } from "./get-component.mjs";
-import { CreateResourceLinkConfig, CreateResourceLinkOptions, CreateResourceLinksFn, CreatedResourceHref, CreatedResourceLink, CreatedResourceLinkBase, InferHashFromResourceLinkHref, ResourceAnchorLinkFn, ResourceLinkHref } from "./create-resource-links.mjs";
+import { CreateResourceLinkConfig, CreateResourceLinkGroupInput, CreateResourceLinkGroupOptions, CreateResourceLinkOptions, CreateResourceLinksFn, CreateResourceLinksWithGroupFn, CreateResourceLinksWithGroups, CreatedResourceHref, CreatedResourceLink, CreatedResourceLinkBase, InferHashFromResourceLinkHref, ResourceAnchorLinkFn, ResourceLinkHref } from "./create-resource-links.mjs";
 import { CreateResourceLayoutFn, CreateResourceLayoutMakeComposableOptions, defineResourceLayout } from "./define-layout.mjs";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jfdevelops/react-layout",
-  "version": "0.7.0",
+  "version": "0.8.1",
   "description": "A React library for creating layout components.",
   "repository": {
     "type": "git",