@jfdevelops/react-layout 1.4.1 → 1.5.0

package/dist/props.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"props.cjs","names":[],"sources":["../src/props.ts"],"sourcesContent":["import type {\n  ComposableComponents,\n  MergePresetProps,\n} from '@jfdevelops/react-layout-composables';\nimport type { InPropsObject } from '@jfdevelops/react-layout-composables';\nimport {\n  EnumWrappedProp,\n  LiteralWrappedProp,\n  ResolveLayoutProps,\n  ResolveLayoutPropsAsDefined,\n  ResolveProps,\n} from '@jfdevelops/react-layout-validator';\nimport { ResourceDefinition, ResourceEnum } from './resource';\nimport { Show } from './utils';\n\nexport type { InPropsObject };\n\n/**\n * Two-argument `render(props, context)` used by createComponent and scoped\n * resource components. `Context` is sibling components (scoped) or the\n * resource render context (top-level).\n */\nexport type PropsContextRender<RenderProps, Context, Result = unknown> = (\n  props: RenderProps,\n  context: Context\n) => Result;\n\n/**\n * Shared `{ props?, render }` shape used by createComponent, scoped\n * components, and anywhere else a value declares props and a two-arg render.\n *\n * @typeParam Props - Declared on the entry (`props`). Often an\n *   {@link InPropsObject}, or a layout include/custom bag.\n * @typeParam RenderProps - First argument to `render` (defaults to\n *   {@link ResolveProps}<Props> when Props is an {@link InPropsObject})\n * @typeParam Result - `render` return type\n * @typeParam Context - Second argument to `render`\n */\nexport interface PropsRenderDefinition<\n  Props = InPropsObject,\n  RenderProps = Props extends InPropsObject ? ResolveProps<Props> : unknown,\n  Result = unknown,\n  Context = unknown\n> {\n  props?: Props;\n  render: PropsContextRender<RenderProps, Context, Result>;\n}\n\nexport type InPropsOptions<\n  Resources extends ReadonlyArray<ResourceDefinition>,\n  Name extends string\n> = {\n  name: LiteralWrappedProp<Name, 'string', 'required'>;\n  resource: EnumWrappedProp<ResourceEnum<Resources>, 'string', 'required'>;\n};\nexport type InPropsFunction<\n  Resources extends ReadonlyArray<ResourceDefinition>\n> = <Name extends string>(\n  props: Show<InPropsOptions<Resources, Name>>\n) => InPropsObject;\nexport type InPropsDefinition<\n  Resources extends ReadonlyArray<ResourceDefinition>\n> = InPropsObject | InPropsFunction<Resources>;\nexport type InferredInProps<\n  Resources extends ReadonlyArray<ResourceDefinition>,\n  Options extends InPropsDefinition<Resources>\n> = Options extends InPropsFunction<Resources> ? ReturnType<Options> : Options;\nexport type MergedLayoutInProps<\n  Resources extends ReadonlyArray<ResourceDefinition>,\n  Options extends InPropsDefinition<Resources>,\n  Composables extends ComposableComponents\n> = InferredInProps<Resources, Options> extends InPropsObject\n  ? InferredInProps<Resources, Options> & MergePresetProps<Composables>\n  : never;\nexport type RequiredVariant = true | 'required';\n/**\n * @typeParam RequiredVariant How the required props are selected. In application code,\n * it will always be `true`, but internally we need to support `'required'` as well.\n */\ntype PropsType<Variant extends RequiredVariant = true> = Variant | 'optional';\ntype InternalPropsType = PropsType<'required'>;\ntype IncludedPropSource = 'component' | 'config';\ntype IncludedPropRequirement =\n  | {\n      /**\n       * Whether the prop must be supplied. When both names are present,\n       * `required` takes precedence over the deprecated `visibility` setting.\n       */\n      required: boolean;\n    }\n  | {\n      /**\n       * Whether the prop must be supplied (`'required'`) or may be omitted\n       * (`'optional'`). The `required` setting takes precedence when both are present.\n       *\n       * @deprecated Use `required: true` instead of `visibility: 'required'`, or\n       * `required: false` instead of `visibility: 'optional'`.\n       * This property will be removed in the next major version.\n       */\n      visibility: 'optional' | 'required';\n    };\ntype IncludedPropSupply =\n  | {\n      /**\n       * Where the prop is supplied: at component render time (`'component'`)\n       * or through layout creation options (`'config'`). Optional component props\n       * also accept configuration-time defaults. This setting takes precedence\n       * over the deprecated `passthrough` setting.\n       */\n      suppliedVia: IncludedPropSource;\n    }\n  | {\n      /**\n       * Where the prop is supplied: at component render time (`'component'`)\n       * or through layout creation options (`'config'`). Optional component props\n       * also accept configuration-time defaults. The `suppliedVia` setting takes\n       * precedence when both names are present.\n       *\n       * @deprecated Use `suppliedVia: 'component'` instead of\n       * `passthrough: 'component'`, or `suppliedVia: 'config'` instead of\n       * `passthrough: 'config'`. This property will be removed in the next major version.\n       */\n      passthrough: IncludedPropSource;\n    };\n\n/**\n * Controls where an included layout prop is supplied and whether it is required there.\n */\nexport type IncludedPropBehavior = IncludedPropRequirement & IncludedPropSupply;\n\ntype IncludedPropType = PropsType | IncludedPropBehavior;\n/**\n * A map of props to include in the layout.\n */\nexport type IncludedProps<T extends object> = {\n  [K in keyof T & string]?: IncludedPropType;\n};\n\ntype PropsKeys<Props extends InPropsObject, T> = T & keyof Props;\nexport type IncludedPropVisibility<Value> = Value extends { required: boolean }\n  ? Value['required'] extends true\n    ? 'required'\n    : 'optional'\n  : Value extends { visibility: 'required' | 'optional' }\n  ? Value['visibility']\n  : Value extends true | 'required'\n  ? 'required'\n  : Value extends 'optional'\n  ? 'optional'\n  : never;\nexport type IncludedPropSupplySource<Value> = Value extends {\n  suppliedVia: IncludedPropSource;\n}\n  ? Value['suppliedVia']\n  : Value extends { passthrough: IncludedPropSource }\n  ? Value['passthrough']\n  : never;\n/**\n * Canonical shape used internally for either spelling of an include behavior.\n */\nexport type NormalizedIncludedPropBehavior<Value> = Value extends\n  | { required: boolean }\n  | { suppliedVia: IncludedPropSource }\n  ? {\n      visibility: IncludedPropVisibility<Value>;\n      passthrough: IncludedPropSupplySource<Value>;\n    }\n  : Value;\n\nexport type IncludedPropPassthrough<Value> = Value extends\n  | { required: boolean }\n  | { suppliedVia: IncludedPropSource }\n  ? IncludedPropSupplySource<Value> extends 'component'\n    ? IncludedPropVisibility<Value> extends 'optional'\n      ? 'component' | 'config'\n      : 'component'\n    : IncludedPropSupplySource<Value>\n  : Value extends {\n      visibility: 'required' | 'optional';\n      passthrough: IncludedPropSource;\n    }\n  ? Value['passthrough'] extends 'component'\n    ? Value['visibility'] extends 'optional'\n      ? 'component' | 'config'\n      : 'component'\n    : Value['passthrough']\n  : Value extends true | 'required'\n  ? 'config'\n  : Value extends 'optional'\n  ? 'component' | 'config'\n  : never;\n\ntype GetPropsKey<\n  IncludeProps extends object,\n  Visibility extends InternalPropsType,\n  Passthrough extends IncludedPropSource | 'render' = 'render'\n> = {\n  [Key in keyof IncludeProps]: IncludedPropVisibility<\n    IncludeProps[Key]\n  > extends Visibility\n    ? Passthrough extends 'render'\n      ? Key\n      : Passthrough extends IncludedPropPassthrough<IncludeProps[Key]>\n      ? Key\n      : never\n    : never;\n}[keyof IncludeProps];\ntype SelectedIncludedProps<\n  Props extends InPropsObject,\n  IncludeProps extends IncludedProps<Props>,\n  Visibility extends InternalPropsType,\n  Passthrough extends IncludedPropSource | 'render' = 'render'\n> = Pick<\n  Props,\n  PropsKeys<Props, GetPropsKey<IncludeProps, Visibility, Passthrough>>\n>;\n\ntype OptionalPropDefinition<Definition> = Definition extends {\n  optional(): infer OptionalDefinition;\n}\n  ? OptionalDefinition\n  : Definition;\n\n/** Raw validator definitions accepted by a generated component call. */\nexport type IncludedComponentPropDefinitions<\n  Props extends InPropsObject,\n  IncludeProps extends IncludedProps<Props>\n> = SelectedIncludedProps<Props, IncludeProps, 'required', 'component'> & {\n  [Key in keyof SelectedIncludedProps<\n    Props,\n    IncludeProps,\n    'optional',\n    'component'\n  >]: OptionalPropDefinition<\n    SelectedIncludedProps<Props, IncludeProps, 'optional', 'component'>[Key]\n  >;\n};\n\nexport type ResolvedIncludedProps<\n  Props extends InPropsObject,\n  IncludeProps extends IncludedProps<Props>\n> = ResolveLayoutProps<SelectedIncludedProps<Props, IncludeProps, 'required'>> &\n  Partial<\n    ResolveLayoutProps<SelectedIncludedProps<Props, IncludeProps, 'optional'>>\n  >;\n\nexport type ResolvedIncludedConfigProps<\n  Props extends InPropsObject,\n  IncludeProps extends IncludedProps<Props>\n> = ResolveLayoutProps<\n  SelectedIncludedProps<Props, IncludeProps, 'required', 'config'>\n> &\n  Partial<\n    ResolveLayoutProps<\n      SelectedIncludedProps<Props, IncludeProps, 'optional', 'config'>\n    >\n  >;\n\nexport type ResolvedIncludedComponentProps<\n  Props extends InPropsObject,\n  IncludeProps extends IncludedProps<Props>\n> = ResolveLayoutProps<\n  SelectedIncludedProps<Props, IncludeProps, 'required', 'component'>\n> &\n  Partial<\n    ResolveLayoutProps<\n      SelectedIncludedProps<Props, IncludeProps, 'optional', 'component'>\n    >\n  >;\n\n/**\n * Like {@link ResolvedIncludedProps}, but keeps included prop keys exactly as\n * declared (no `JSX.Element` capitalization).\n */\nexport type ResolvedIncludedPropsAsDefined<\n  Props extends InPropsObject,\n  IncludeProps extends IncludedProps<Props>\n> = ResolveLayoutPropsAsDefined<\n  SelectedIncludedProps<Props, IncludeProps, 'required'>\n> &\n  Partial<\n    ResolveLayoutPropsAsDefined<\n      SelectedIncludedProps<Props, IncludeProps, 'optional'>\n    >\n  >;\nexport type LayoutRenderProps<\n  Resources extends ReadonlyArray<ResourceDefinition>,\n  Options extends InPropsDefinition<Resources>,\n  Composables extends ComposableComponents = {},\n  IncludeProps extends IncludedProps<\n    MergedLayoutInProps<Resources, Options, Composables>\n  > = {},\n  CustomProps extends InPropsObject = {}\n> = Show<\n  ResolveProps<CustomProps> &\n    ResolvedIncludedProps<\n      MergedLayoutInProps<Resources, Options, Composables>,\n      IncludeProps\n    >\n>;\n\nexport function getIncludedPropBehavior(value: unknown): {\n  visibility: 'required' | 'optional';\n  passthrough: 'component' | 'config';\n} | null {\n  if (value === null || typeof value !== 'object') {\n    return null;\n  }\n\n  const required =\n    'required' in value && typeof value.required === 'boolean'\n      ? value.required\n      : 'visibility' in value\n      ? value.visibility === 'required'\n      : undefined;\n  const suppliedVia =\n    'suppliedVia' in value\n      ? value.suppliedVia\n      : 'passthrough' in value\n      ? value.passthrough\n      : undefined;\n\n  if (\n    required === undefined ||\n    (suppliedVia !== 'component' && suppliedVia !== 'config')\n  ) {\n    return null;\n  }\n\n  return {\n    visibility: required ? 'required' : 'optional',\n    passthrough: suppliedVia,\n  };\n}\n"],"mappings":";;AA6SA,SAAgB,wBAAwB,OAG/B;CACP,IAAI,UAAU,QAAQ,OAAO,UAAU,UACrC,OAAO;CAGT,MAAM,WACJ,cAAc,SAAS,OAAO,MAAM,aAAa,YAC7C,MAAM,WACN,gBAAgB,QAChB,MAAM,eAAe,aACrB;CACN,MAAM,cACJ,iBAAiB,QACb,MAAM,cACN,iBAAiB,QACjB,MAAM,cACN;CAEN,IACE,aAAa,UACZ,gBAAgB,eAAe,gBAAgB,UAEhD,OAAO;CAGT,OAAO;EACL,YAAY,WAAW,aAAa;EACpC,aAAa;CACf;AACF"}

package/dist/props.d.cts

@@ -40,21 +40,86 @@ type RequiredVariant = true | 'required';
  */
 type PropsType<Variant extends RequiredVariant = true> = Variant | 'optional';
 type InternalPropsType = PropsType<'required'>;
-/** Controls where an included layout prop is supplied and whether it is required there. */
-type IncludedPropBehavior = {
+type IncludedPropSource = 'component' | 'config';
+type IncludedPropRequirement = {
+  /**
+   * Whether the prop must be supplied. When both names are present,
+   * `required` takes precedence over the deprecated `visibility` setting.
+   */
+  required: boolean;
+} | {
+  /**
+   * Whether the prop must be supplied (`'required'`) or may be omitted
+   * (`'optional'`). The `required` setting takes precedence when both are present.
+   *
+   * @deprecated Use `required: true` instead of `visibility: 'required'`, or
+   * `required: false` instead of `visibility: 'optional'`.
+   * This property will be removed in the next major version.
+   */
   visibility: 'optional' | 'required';
-  passthrough: 'component' | 'config';
 };
+type IncludedPropSupply = {
+  /**
+   * Where the prop is supplied: at component render time (`'component'`)
+   * or through layout creation options (`'config'`). Optional component props
+   * also accept configuration-time defaults. This setting takes precedence
+   * over the deprecated `passthrough` setting.
+   */
+  suppliedVia: IncludedPropSource;
+} | {
+  /**
+   * Where the prop is supplied: at component render time (`'component'`)
+   * or through layout creation options (`'config'`). Optional component props
+   * also accept configuration-time defaults. The `suppliedVia` setting takes
+   * precedence when both names are present.
+   *
+   * @deprecated Use `suppliedVia: 'component'` instead of
+   * `passthrough: 'component'`, or `suppliedVia: 'config'` instead of
+   * `passthrough: 'config'`. This property will be removed in the next major version.
+   */
+  passthrough: IncludedPropSource;
+};
+/**
+ * Controls where an included layout prop is supplied and whether it is required there.
+ */
+type IncludedPropBehavior = IncludedPropRequirement & IncludedPropSupply;
 type IncludedPropType = PropsType | IncludedPropBehavior;
 /**
  * A map of props to include in the layout.
  */
 type IncludedProps<T extends object> = { [K in keyof T & string]?: IncludedPropType };
 type PropsKeys<Props extends InPropsObject, T> = T & keyof Props;
-type IncludedPropVisibility<Value> = Value extends IncludedPropBehavior ? Value['visibility'] : Value extends true | 'required' ? 'required' : Value extends 'optional' ? 'optional' : never;
-type IncludedPropPassthrough<Value> = Value extends IncludedPropBehavior ? Value['passthrough'] extends 'component' ? Value['visibility'] extends 'optional' ? 'component' | 'config' : 'component' : Value['passthrough'] : Value extends true | 'required' ? 'config' : Value extends 'optional' ? 'component' | 'config' : never;
-type GetPropsKey<IncludeProps extends object, Visibility extends InternalPropsType, Passthrough extends IncludedPropBehavior['passthrough'] | 'render' = 'render'> = { [Key in keyof IncludeProps]: IncludedPropVisibility<IncludeProps[Key]> extends Visibility ? Passthrough extends 'render' ? Key : Passthrough extends IncludedPropPassthrough<IncludeProps[Key]> ? Key : never : never }[keyof IncludeProps];
-type SelectedIncludedProps<Props extends InPropsObject, IncludeProps extends IncludedProps<Props>, Visibility extends InternalPropsType, Passthrough extends IncludedPropBehavior['passthrough'] | 'render' = 'render'> = Pick<Props, PropsKeys<Props, GetPropsKey<IncludeProps, Visibility, Passthrough>>>;
+type IncludedPropVisibility<Value> = Value extends {
+  required: boolean;
+} ? Value['required'] extends true ? 'required' : 'optional' : Value extends {
+  visibility: 'required' | 'optional';
+} ? Value['visibility'] : Value extends true | 'required' ? 'required' : Value extends 'optional' ? 'optional' : never;
+type IncludedPropSupplySource<Value> = Value extends {
+  suppliedVia: IncludedPropSource;
+} ? Value['suppliedVia'] : Value extends {
+  passthrough: IncludedPropSource;
+} ? Value['passthrough'] : never;
+/**
+ * Canonical shape used internally for either spelling of an include behavior.
+ */
+type NormalizedIncludedPropBehavior<Value> = Value extends {
+  required: boolean;
+} | {
+  suppliedVia: IncludedPropSource;
+} ? {
+  visibility: IncludedPropVisibility<Value>;
+  passthrough: IncludedPropSupplySource<Value>;
+} : Value;
+type IncludedPropPassthrough<Value> = Value extends {
+  required: boolean;
+} | {
+  suppliedVia: IncludedPropSource;
+} ? IncludedPropSupplySource<Value> extends 'component' ? IncludedPropVisibility<Value> extends 'optional' ? 'component' | 'config' : 'component' : IncludedPropSupplySource<Value> : Value extends {
+  visibility: 'required' | 'optional';
+  passthrough: IncludedPropSource;
+} ? Value['passthrough'] extends 'component' ? Value['visibility'] extends 'optional' ? 'component' | 'config' : 'component' : Value['passthrough'] : Value extends true | 'required' ? 'config' : Value extends 'optional' ? 'component' | 'config' : never;
+type GetPropsKey<IncludeProps extends object, Visibility extends InternalPropsType, Passthrough extends IncludedPropSource | 'render' = 'render'> = { [Key in keyof IncludeProps]: IncludedPropVisibility<IncludeProps[Key]> extends Visibility ? Passthrough extends 'render' ? Key : Passthrough extends IncludedPropPassthrough<IncludeProps[Key]> ? Key : never : never }[keyof IncludeProps];
+type SelectedIncludedProps<Props extends InPropsObject, IncludeProps extends IncludedProps<Props>, Visibility extends InternalPropsType, Passthrough extends IncludedPropSource | 'render' = 'render'> = Pick<Props, PropsKeys<Props, GetPropsKey<IncludeProps, Visibility, Passthrough>>>;
 type OptionalPropDefinition<Definition> = Definition extends {
   optional(): infer OptionalDefinition;
 } ? OptionalDefinition : Definition;
@@ -70,5 +135,5 @@ type ResolvedIncludedComponentProps<Props extends InPropsObject, IncludeProps ex
 type ResolvedIncludedPropsAsDefined<Props extends InPropsObject, IncludeProps extends IncludedProps<Props>> = ResolveLayoutPropsAsDefined<SelectedIncludedProps<Props, IncludeProps, 'required'>> & Partial<ResolveLayoutPropsAsDefined<SelectedIncludedProps<Props, IncludeProps, 'optional'>>>;
 type LayoutRenderProps<Resources extends ReadonlyArray<ResourceDefinition>, Options extends InPropsDefinition<Resources>, Composables extends ComposableComponents = {}, IncludeProps extends IncludedProps<MergedLayoutInProps<Resources, Options, Composables>> = {}, CustomProps extends InPropsObject = {}> = Show<ResolveProps<CustomProps> & ResolvedIncludedProps<MergedLayoutInProps<Resources, Options, Composables>, IncludeProps>>;
 //#endregion
-export { InPropsDefinition, InPropsFunction, type InPropsObject, InPropsOptions, IncludedComponentPropDefinitions, IncludedPropBehavior, IncludedProps, InferredInProps, LayoutRenderProps, MergedLayoutInProps, PropsContextRender, PropsRenderDefinition, ResolvedIncludedComponentProps, ResolvedIncludedConfigProps, ResolvedIncludedProps, ResolvedIncludedPropsAsDefined };
+export { InPropsDefinition, InPropsFunction, type InPropsObject, InPropsOptions, IncludedComponentPropDefinitions, IncludedPropBehavior, IncludedProps, InferredInProps, LayoutRenderProps, MergedLayoutInProps, NormalizedIncludedPropBehavior, PropsContextRender, PropsRenderDefinition, ResolvedIncludedComponentProps, ResolvedIncludedConfigProps, ResolvedIncludedProps, ResolvedIncludedPropsAsDefined };
 //# sourceMappingURL=props.d.cts.map

package/dist/props.d.cts.map

@@ -1 +1 @@
-{"version":3,"file":"props.d.cts","names":[],"sources":["../src/props.ts"],"mappings":";;;;;;AAsBA;;;;;AAAA,KAAY,kBAAA,4CACV,KAAA,EAAO,WAAA,EACP,OAAA,EAAS,OAAA,KACN,MAAA;;;;;;;;;;;;UAaY,qBAAA,SACP,aAAA,iBACM,KAAA,SAAc,aAAA,GAAgB,YAAA,CAAa,KAAA;EAIzD,KAAA,GAAQ,KAAA;EACR,MAAA,EAAQ,kBAAA,CAAmB,WAAA,EAAa,OAAA,EAAS,MAAA;AAAA;AAAA,KAGvC,cAAA,mBACQ,aAAA,CAAc,kBAAA;EAGhC,IAAA,EAAM,kBAAA,CAAmB,IAAA;EACzB,QAAA,EAAU,eAAA,CAAgB,YAAA,CAAa,SAAA;AAAA;AAAA,KAE7B,eAAA,mBACQ,aAAA,CAAc,kBAAA,2BAEhC,KAAA,EAAO,IAAA,CAAK,cAAA,CAAe,SAAA,EAAW,IAAA,OACnC,aAAA;AAAA,KACO,iBAAA,mBACQ,aAAA,CAAc,kBAAA,KAC9B,aAAA,GAAgB,eAAA,CAAgB,SAAA;AAAA,KACxB,eAAA,mBACQ,aAAA,CAAc,kBAAA,mBAChB,iBAAA,CAAkB,SAAA,KAChC,OAAA,SAAgB,eAAA,CAAgB,SAAA,IAAa,UAAA,CAAW,OAAA,IAAW,OAAA;AAAA,KAC3D,mBAAA,mBACQ,aAAA,CAAc,kBAAA,mBAChB,iBAAA,CAAkB,SAAA,uBACd,oBAAA,IAEpB,eAAA,CAAgB,SAAA,EAAW,OAAA,UAAiB,aAAA,GACxC,eAAA,CAAgB,SAAA,EAAW,OAAA,IAAW,gBAAA,CAAiB,WAAA;AAAA,KAEjD,eAAA;;;;;KAKP,SAAA,iBAA0B,eAAA,WAA0B,OAAO;AAAA,KAC3D,iBAAA,GAAoB,SAAS;;KAEtB,oBAAA;EACV,UAAA;EACA,WAAW;AAAA;AAAA,KAGR,gBAAA,GAAmB,SAAA,GAAY,oBAAoB;;;;KAI5C,aAAA,mCACE,CAAA,aAAc,gBAAgB;AAAA,KAGvC,SAAA,eAAwB,aAAA,OAAoB,CAAA,SAAU,KAAA;AAAA,KACtD,sBAAA,UAAgC,KAAA,SAAc,oBAAA,GAC/C,KAAA,iBACA,KAAA,0CAEE,KAAA;AAAA,KAGD,uBAAA,UAAiC,KAAA,SAAc,oBAAA,GAChD,KAAA,sCACE,KAAA,2EAGA,KAAA,kBACF,KAAA,wCAEE,KAAA;AAAA,KAGD,WAAA,iDAEgB,iBAAA,sBACC,oBAAA,yDAEN,YAAA,GAAe,sBAAA,CAC3B,YAAA,CAAa,GAAA,WACL,UAAA,GACN,WAAA,oBACE,GAAA,GACA,WAAA,SAAoB,uBAAA,CAAwB,YAAA,CAAa,GAAA,KACvD,GAAA,yBAGF,YAAA;AAAA,KACH,qBAAA,eACW,aAAA,uBACO,aAAA,CAAc,KAAA,sBAChB,iBAAA,sBACC,oBAAA,yCAClB,IAAA,CACF,KAAA,EACA,SAAA,CAAU,KAAA,EAAO,WAAA,CAAY,YAAA,EAAc,UAAA,EAAY,WAAA;AAAA,KAGpD,sBAAA,eAAqC,UAAA;EACxC,QAAA;AAAA,IAEE,kBAAA,GACA,UAAU;;KAGF,gCAAA,eACI,aAAA,uBACO,aAAA,CAAc,KAAA,KACjC,qBAAA,CAAsB,KAAA,EAAO,YAAA,6CACjB,qBAAA,CACZ,KAAA,EACA,YAAA,6BAGE,sBAAA,CACF,qBAAA,CACE,KAAA,EACA,YAAA,2BAGA,GAAA;AAAA,KAIM,qBAAA,eACI,aAAA,uBACO,aAAA,CAAc,KAAA,KACjC,kBAAA,CAAmB,qBAAA,CAAsB,KAAA,EAAO,YAAA,iBAClD,OAAA,CACE,kBAAA,CAAmB,qBAAA,CAAsB,KAAA,EAAO,YAAA;AAAA,KAGxC,2BAAA,eACI,aAAA,uBACO,aAAA,CAAc,KAAA,KACjC,kBAAA,CACF,qBAAA,CAAsB,KAAA,EAAO,YAAA,2BAE7B,OAAA,CACE,kBAAA,CACE,qBAAA,CAAsB,KAAA,EAAO,YAAA;AAAA,KAIvB,8BAAA,eACI,aAAA,uBACO,aAAA,CAAc,KAAA,KACjC,kBAAA,CACF,qBAAA,CAAsB,KAAA,EAAO,YAAA,8BAE7B,OAAA,CACE,kBAAA,CACE,qBAAA,CAAsB,KAAA,EAAO,YAAA;;;;;KAQvB,8BAAA,eACI,aAAA,uBACO,aAAA,CAAc,KAAA,KACjC,2BAAA,CACF,qBAAA,CAAsB,KAAA,EAAO,YAAA,iBAE7B,OAAA,CACE,2BAAA,CACE,qBAAA,CAAsB,KAAA,EAAO,YAAA;AAAA,KAGvB,iBAAA,mBACQ,aAAA,CAAc,kBAAA,mBAChB,iBAAA,CAAkB,SAAA,uBACd,oBAAA,4BACC,aAAA,CACnB,mBAAA,CAAoB,SAAA,EAAW,OAAA,EAAS,WAAA,6BAEtB,aAAA,SAClB,IAAA,CACF,YAAA,CAAa,WAAA,IACX,qBAAA,CACE,mBAAA,CAAoB,SAAA,EAAW,OAAA,EAAS,WAAA,GACxC,YAAA"}
+{"version":3,"file":"props.d.cts","names":[],"sources":["../src/props.ts"],"mappings":";;;;;;AAsBA;;;;;AAAA,KAAY,kBAAA,4CACV,KAAA,EAAO,WAAA,EACP,OAAA,EAAS,OAAA,KACN,MAAA;;;;;;;;;;;;UAaY,qBAAA,SACP,aAAA,iBACM,KAAA,SAAc,aAAA,GAAgB,YAAA,CAAa,KAAA;EAIzD,KAAA,GAAQ,KAAA;EACR,MAAA,EAAQ,kBAAA,CAAmB,WAAA,EAAa,OAAA,EAAS,MAAA;AAAA;AAAA,KAGvC,cAAA,mBACQ,aAAA,CAAc,kBAAA;EAGhC,IAAA,EAAM,kBAAA,CAAmB,IAAA;EACzB,QAAA,EAAU,eAAA,CAAgB,YAAA,CAAa,SAAA;AAAA;AAAA,KAE7B,eAAA,mBACQ,aAAA,CAAc,kBAAA,2BAEhC,KAAA,EAAO,IAAA,CAAK,cAAA,CAAe,SAAA,EAAW,IAAA,OACnC,aAAA;AAAA,KACO,iBAAA,mBACQ,aAAA,CAAc,kBAAA,KAC9B,aAAA,GAAgB,eAAA,CAAgB,SAAA;AAAA,KACxB,eAAA,mBACQ,aAAA,CAAc,kBAAA,mBAChB,iBAAA,CAAkB,SAAA,KAChC,OAAA,SAAgB,eAAA,CAAgB,SAAA,IAAa,UAAA,CAAW,OAAA,IAAW,OAAA;AAAA,KAC3D,mBAAA,mBACQ,aAAA,CAAc,kBAAA,mBAChB,iBAAA,CAAkB,SAAA,uBACd,oBAAA,IAClB,eAAA,CAAgB,SAAA,EAAW,OAAA,UAAiB,aAAA,GAC5C,eAAA,CAAgB,SAAA,EAAW,OAAA,IAAW,gBAAA,CAAiB,WAAA;AAAA,KAE/C,eAAA;;;;;KAKP,SAAA,iBAA0B,eAAA,WAA0B,OAAO;AAAA,KAC3D,iBAAA,GAAoB,SAAS;AAAA,KAC7B,kBAAA;AAAA,KACA,uBAAA;EA1CyC;;;;EAgDxC,QAAA;AAAA;EA3CJ;;;;;;AAAuD;AAGzD;EAmDM,UAAU;AAAA;AAAA,KAEX,kBAAA;EApDe;;;;;;EA4Dd,WAAA,EAAa,kBAAA;AAAA;EA5DjB;;;;;;;;;;EAyEI,WAAA,EAAa,kBAAkB;AAAA;AArEa;AAElD;;AAFkD,KA2EtC,oBAAA,GAAuB,uBAAA,GAA0B,kBAAkB;AAAA,KAE1E,gBAAA,GAAmB,SAAA,GAAY,oBAAoB;;;;KAI5C,aAAA,mCACE,CAAA,aAAc,gBAAgB;AAAA,KAGvC,SAAA,eAAwB,aAAA,OAAoB,CAAA,SAAU,KAAA;AAAA,KAC/C,sBAAA,UAAgC,KAAA;EAAgB,QAAA;AAAA,IACxD,KAAA,sDAGA,KAAA;EAAgB,UAAA;AAAA,IAChB,KAAA,iBACA,KAAA,0CAEA,KAAA;AAAA,KAGQ,wBAAA,UAAkC,KAAA;EAC5C,WAAA,EAAa,kBAAA;AAAA,IAEX,KAAA,kBACA,KAAA;EAAgB,WAAA,EAAa,kBAAA;AAAA,IAC7B,KAAA;;;AAhGc;KAqGN,8BAAA,UAAwC,KAAA;EAC9C,QAAA;AAAA;EACA,WAAA,EAAa,kBAAA;AAAA;EAEb,UAAA,EAAY,sBAAA,CAAuB,KAAA;EACnC,WAAA,EAAa,wBAAA,CAAyB,KAAA;AAAA,IAExC,KAAA;AAAA,KAEQ,uBAAA,UAAiC,KAAA;EACvC,QAAA;AAAA;EACA,WAAA,EAAa,kBAAA;AAAA,IACf,wBAAA,CAAyB,KAAA,wBACvB,sBAAA,CAAuB,KAAA,8DAGvB,wBAAA,CAAyB,KAAA,IAC3B,KAAA;EACE,UAAA;EACA,WAAA,EAAa,kBAAA;AAAA,IAEf,KAAA,sCACE,KAAA,2EAGA,KAAA,kBACF,KAAA,wCAEA,KAAA;AAAA,KAIC,WAAA,iDAEgB,iBAAA,sBACC,kBAAA,0CAEN,YAAA,GAAe,sBAAA,CAC3B,YAAA,CAAa,GAAA,WACL,UAAA,GACN,WAAA,oBACE,GAAA,GACA,WAAA,SAAoB,uBAAA,CAAwB,YAAA,CAAa,GAAA,KACzD,GAAA,yBAGA,YAAA;AAAA,KACH,qBAAA,eACW,aAAA,uBACO,aAAA,CAAc,KAAA,sBAChB,iBAAA,sBACC,kBAAA,0BAClB,IAAA,CACF,KAAA,EACA,SAAA,CAAU,KAAA,EAAO,WAAA,CAAY,YAAA,EAAc,UAAA,EAAY,WAAA;AAAA,KAGpD,sBAAA,eAAqC,UAAA;EACxC,QAAA;AAAA,IAEE,kBAAA,GACA,UAAU;;KAGF,gCAAA,eACI,aAAA,uBACO,aAAA,CAAc,KAAA,KACjC,qBAAA,CAAsB,KAAA,EAAO,YAAA,6CACjB,qBAAA,CACZ,KAAA,EACA,YAAA,6BAGE,sBAAA,CACF,qBAAA,CAAsB,KAAA,EAAO,YAAA,2BAAuC,GAAA;AAAA,KAI5D,qBAAA,eACI,aAAA,uBACO,aAAA,CAAc,KAAA,KACjC,kBAAA,CAAmB,qBAAA,CAAsB,KAAA,EAAO,YAAA,iBAClD,OAAA,CACE,kBAAA,CAAmB,qBAAA,CAAsB,KAAA,EAAO,YAAA;AAAA,KAGxC,2BAAA,eACI,aAAA,uBACO,aAAA,CAAc,KAAA,KACjC,kBAAA,CACF,qBAAA,CAAsB,KAAA,EAAO,YAAA,2BAE7B,OAAA,CACE,kBAAA,CACE,qBAAA,CAAsB,KAAA,EAAO,YAAA;AAAA,KAIvB,8BAAA,eACI,aAAA,uBACO,aAAA,CAAc,KAAA,KACjC,kBAAA,CACF,qBAAA,CAAsB,KAAA,EAAO,YAAA,8BAE7B,OAAA,CACE,kBAAA,CACE,qBAAA,CAAsB,KAAA,EAAO,YAAA;;;;;KAQvB,8BAAA,eACI,aAAA,uBACO,aAAA,CAAc,KAAA,KACjC,2BAAA,CACF,qBAAA,CAAsB,KAAA,EAAO,YAAA,iBAE7B,OAAA,CACE,2BAAA,CACE,qBAAA,CAAsB,KAAA,EAAO,YAAA;AAAA,KAGvB,iBAAA,mBACQ,aAAA,CAAc,kBAAA,mBAChB,iBAAA,CAAkB,SAAA,uBACd,oBAAA,4BACC,aAAA,CACnB,mBAAA,CAAoB,SAAA,EAAW,OAAA,EAAS,WAAA,6BAEtB,aAAA,SAClB,IAAA,CACF,YAAA,CAAa,WAAA,IACX,qBAAA,CACE,mBAAA,CAAoB,SAAA,EAAW,OAAA,EAAS,WAAA,GACxC,YAAA"}

package/dist/props.d.mts

@@ -40,21 +40,86 @@ type RequiredVariant = true | 'required';
  */
 type PropsType<Variant extends RequiredVariant = true> = Variant | 'optional';
 type InternalPropsType = PropsType<'required'>;
-/** Controls where an included layout prop is supplied and whether it is required there. */
-type IncludedPropBehavior = {
+type IncludedPropSource = 'component' | 'config';
+type IncludedPropRequirement = {
+  /**
+   * Whether the prop must be supplied. When both names are present,
+   * `required` takes precedence over the deprecated `visibility` setting.
+   */
+  required: boolean;
+} | {
+  /**
+   * Whether the prop must be supplied (`'required'`) or may be omitted
+   * (`'optional'`). The `required` setting takes precedence when both are present.
+   *
+   * @deprecated Use `required: true` instead of `visibility: 'required'`, or
+   * `required: false` instead of `visibility: 'optional'`.
+   * This property will be removed in the next major version.
+   */
   visibility: 'optional' | 'required';
-  passthrough: 'component' | 'config';
 };
+type IncludedPropSupply = {
+  /**
+   * Where the prop is supplied: at component render time (`'component'`)
+   * or through layout creation options (`'config'`). Optional component props
+   * also accept configuration-time defaults. This setting takes precedence
+   * over the deprecated `passthrough` setting.
+   */
+  suppliedVia: IncludedPropSource;
+} | {
+  /**
+   * Where the prop is supplied: at component render time (`'component'`)
+   * or through layout creation options (`'config'`). Optional component props
+   * also accept configuration-time defaults. The `suppliedVia` setting takes
+   * precedence when both names are present.
+   *
+   * @deprecated Use `suppliedVia: 'component'` instead of
+   * `passthrough: 'component'`, or `suppliedVia: 'config'` instead of
+   * `passthrough: 'config'`. This property will be removed in the next major version.
+   */
+  passthrough: IncludedPropSource;
+};
+/**
+ * Controls where an included layout prop is supplied and whether it is required there.
+ */
+type IncludedPropBehavior = IncludedPropRequirement & IncludedPropSupply;
 type IncludedPropType = PropsType | IncludedPropBehavior;
 /**
  * A map of props to include in the layout.
  */
 type IncludedProps<T extends object> = { [K in keyof T & string]?: IncludedPropType };
 type PropsKeys<Props extends InPropsObject, T> = T & keyof Props;
-type IncludedPropVisibility<Value> = Value extends IncludedPropBehavior ? Value['visibility'] : Value extends true | 'required' ? 'required' : Value extends 'optional' ? 'optional' : never;
-type IncludedPropPassthrough<Value> = Value extends IncludedPropBehavior ? Value['passthrough'] extends 'component' ? Value['visibility'] extends 'optional' ? 'component' | 'config' : 'component' : Value['passthrough'] : Value extends true | 'required' ? 'config' : Value extends 'optional' ? 'component' | 'config' : never;
-type GetPropsKey<IncludeProps extends object, Visibility extends InternalPropsType, Passthrough extends IncludedPropBehavior['passthrough'] | 'render' = 'render'> = { [Key in keyof IncludeProps]: IncludedPropVisibility<IncludeProps[Key]> extends Visibility ? Passthrough extends 'render' ? Key : Passthrough extends IncludedPropPassthrough<IncludeProps[Key]> ? Key : never : never }[keyof IncludeProps];
-type SelectedIncludedProps<Props extends InPropsObject, IncludeProps extends IncludedProps<Props>, Visibility extends InternalPropsType, Passthrough extends IncludedPropBehavior['passthrough'] | 'render' = 'render'> = Pick<Props, PropsKeys<Props, GetPropsKey<IncludeProps, Visibility, Passthrough>>>;
+type IncludedPropVisibility<Value> = Value extends {
+  required: boolean;
+} ? Value['required'] extends true ? 'required' : 'optional' : Value extends {
+  visibility: 'required' | 'optional';
+} ? Value['visibility'] : Value extends true | 'required' ? 'required' : Value extends 'optional' ? 'optional' : never;
+type IncludedPropSupplySource<Value> = Value extends {
+  suppliedVia: IncludedPropSource;
+} ? Value['suppliedVia'] : Value extends {
+  passthrough: IncludedPropSource;
+} ? Value['passthrough'] : never;
+/**
+ * Canonical shape used internally for either spelling of an include behavior.
+ */
+type NormalizedIncludedPropBehavior<Value> = Value extends {
+  required: boolean;
+} | {
+  suppliedVia: IncludedPropSource;
+} ? {
+  visibility: IncludedPropVisibility<Value>;
+  passthrough: IncludedPropSupplySource<Value>;
+} : Value;
+type IncludedPropPassthrough<Value> = Value extends {
+  required: boolean;
+} | {
+  suppliedVia: IncludedPropSource;
+} ? IncludedPropSupplySource<Value> extends 'component' ? IncludedPropVisibility<Value> extends 'optional' ? 'component' | 'config' : 'component' : IncludedPropSupplySource<Value> : Value extends {
+  visibility: 'required' | 'optional';
+  passthrough: IncludedPropSource;
+} ? Value['passthrough'] extends 'component' ? Value['visibility'] extends 'optional' ? 'component' | 'config' : 'component' : Value['passthrough'] : Value extends true | 'required' ? 'config' : Value extends 'optional' ? 'component' | 'config' : never;
+type GetPropsKey<IncludeProps extends object, Visibility extends InternalPropsType, Passthrough extends IncludedPropSource | 'render' = 'render'> = { [Key in keyof IncludeProps]: IncludedPropVisibility<IncludeProps[Key]> extends Visibility ? Passthrough extends 'render' ? Key : Passthrough extends IncludedPropPassthrough<IncludeProps[Key]> ? Key : never : never }[keyof IncludeProps];
+type SelectedIncludedProps<Props extends InPropsObject, IncludeProps extends IncludedProps<Props>, Visibility extends InternalPropsType, Passthrough extends IncludedPropSource | 'render' = 'render'> = Pick<Props, PropsKeys<Props, GetPropsKey<IncludeProps, Visibility, Passthrough>>>;
 type OptionalPropDefinition<Definition> = Definition extends {
   optional(): infer OptionalDefinition;
 } ? OptionalDefinition : Definition;
@@ -70,5 +135,5 @@ type ResolvedIncludedComponentProps<Props extends InPropsObject, IncludeProps ex
 type ResolvedIncludedPropsAsDefined<Props extends InPropsObject, IncludeProps extends IncludedProps<Props>> = ResolveLayoutPropsAsDefined<SelectedIncludedProps<Props, IncludeProps, 'required'>> & Partial<ResolveLayoutPropsAsDefined<SelectedIncludedProps<Props, IncludeProps, 'optional'>>>;
 type LayoutRenderProps<Resources extends ReadonlyArray<ResourceDefinition>, Options extends InPropsDefinition<Resources>, Composables extends ComposableComponents = {}, IncludeProps extends IncludedProps<MergedLayoutInProps<Resources, Options, Composables>> = {}, CustomProps extends InPropsObject = {}> = Show<ResolveProps<CustomProps> & ResolvedIncludedProps<MergedLayoutInProps<Resources, Options, Composables>, IncludeProps>>;
 //#endregion
-export { InPropsDefinition, InPropsFunction, type InPropsObject, InPropsOptions, IncludedComponentPropDefinitions, IncludedPropBehavior, IncludedProps, InferredInProps, LayoutRenderProps, MergedLayoutInProps, PropsContextRender, PropsRenderDefinition, ResolvedIncludedComponentProps, ResolvedIncludedConfigProps, ResolvedIncludedProps, ResolvedIncludedPropsAsDefined };
+export { InPropsDefinition, InPropsFunction, type InPropsObject, InPropsOptions, IncludedComponentPropDefinitions, IncludedPropBehavior, IncludedProps, InferredInProps, LayoutRenderProps, MergedLayoutInProps, NormalizedIncludedPropBehavior, PropsContextRender, PropsRenderDefinition, ResolvedIncludedComponentProps, ResolvedIncludedConfigProps, ResolvedIncludedProps, ResolvedIncludedPropsAsDefined };
 //# sourceMappingURL=props.d.mts.map

package/dist/props.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"props.d.mts","names":[],"sources":["../src/props.ts"],"mappings":";;;;;;AAsBA;;;;;AAAA,KAAY,kBAAA,4CACV,KAAA,EAAO,WAAA,EACP,OAAA,EAAS,OAAA,KACN,MAAA;;;;;;;;;;;;UAaY,qBAAA,SACP,aAAA,iBACM,KAAA,SAAc,aAAA,GAAgB,YAAA,CAAa,KAAA;EAIzD,KAAA,GAAQ,KAAA;EACR,MAAA,EAAQ,kBAAA,CAAmB,WAAA,EAAa,OAAA,EAAS,MAAA;AAAA;AAAA,KAGvC,cAAA,mBACQ,aAAA,CAAc,kBAAA;EAGhC,IAAA,EAAM,kBAAA,CAAmB,IAAA;EACzB,QAAA,EAAU,eAAA,CAAgB,YAAA,CAAa,SAAA;AAAA;AAAA,KAE7B,eAAA,mBACQ,aAAA,CAAc,kBAAA,2BAEhC,KAAA,EAAO,IAAA,CAAK,cAAA,CAAe,SAAA,EAAW,IAAA,OACnC,aAAA;AAAA,KACO,iBAAA,mBACQ,aAAA,CAAc,kBAAA,KAC9B,aAAA,GAAgB,eAAA,CAAgB,SAAA;AAAA,KACxB,eAAA,mBACQ,aAAA,CAAc,kBAAA,mBAChB,iBAAA,CAAkB,SAAA,KAChC,OAAA,SAAgB,eAAA,CAAgB,SAAA,IAAa,UAAA,CAAW,OAAA,IAAW,OAAA;AAAA,KAC3D,mBAAA,mBACQ,aAAA,CAAc,kBAAA,mBAChB,iBAAA,CAAkB,SAAA,uBACd,oBAAA,IAEpB,eAAA,CAAgB,SAAA,EAAW,OAAA,UAAiB,aAAA,GACxC,eAAA,CAAgB,SAAA,EAAW,OAAA,IAAW,gBAAA,CAAiB,WAAA;AAAA,KAEjD,eAAA;;;;;KAKP,SAAA,iBAA0B,eAAA,WAA0B,OAAO;AAAA,KAC3D,iBAAA,GAAoB,SAAS;;KAEtB,oBAAA;EACV,UAAA;EACA,WAAW;AAAA;AAAA,KAGR,gBAAA,GAAmB,SAAA,GAAY,oBAAoB;;;;KAI5C,aAAA,mCACE,CAAA,aAAc,gBAAgB;AAAA,KAGvC,SAAA,eAAwB,aAAA,OAAoB,CAAA,SAAU,KAAA;AAAA,KACtD,sBAAA,UAAgC,KAAA,SAAc,oBAAA,GAC/C,KAAA,iBACA,KAAA,0CAEE,KAAA;AAAA,KAGD,uBAAA,UAAiC,KAAA,SAAc,oBAAA,GAChD,KAAA,sCACE,KAAA,2EAGA,KAAA,kBACF,KAAA,wCAEE,KAAA;AAAA,KAGD,WAAA,iDAEgB,iBAAA,sBACC,oBAAA,yDAEN,YAAA,GAAe,sBAAA,CAC3B,YAAA,CAAa,GAAA,WACL,UAAA,GACN,WAAA,oBACE,GAAA,GACA,WAAA,SAAoB,uBAAA,CAAwB,YAAA,CAAa,GAAA,KACvD,GAAA,yBAGF,YAAA;AAAA,KACH,qBAAA,eACW,aAAA,uBACO,aAAA,CAAc,KAAA,sBAChB,iBAAA,sBACC,oBAAA,yCAClB,IAAA,CACF,KAAA,EACA,SAAA,CAAU,KAAA,EAAO,WAAA,CAAY,YAAA,EAAc,UAAA,EAAY,WAAA;AAAA,KAGpD,sBAAA,eAAqC,UAAA;EACxC,QAAA;AAAA,IAEE,kBAAA,GACA,UAAU;;KAGF,gCAAA,eACI,aAAA,uBACO,aAAA,CAAc,KAAA,KACjC,qBAAA,CAAsB,KAAA,EAAO,YAAA,6CACjB,qBAAA,CACZ,KAAA,EACA,YAAA,6BAGE,sBAAA,CACF,qBAAA,CACE,KAAA,EACA,YAAA,2BAGA,GAAA;AAAA,KAIM,qBAAA,eACI,aAAA,uBACO,aAAA,CAAc,KAAA,KACjC,kBAAA,CAAmB,qBAAA,CAAsB,KAAA,EAAO,YAAA,iBAClD,OAAA,CACE,kBAAA,CAAmB,qBAAA,CAAsB,KAAA,EAAO,YAAA;AAAA,KAGxC,2BAAA,eACI,aAAA,uBACO,aAAA,CAAc,KAAA,KACjC,kBAAA,CACF,qBAAA,CAAsB,KAAA,EAAO,YAAA,2BAE7B,OAAA,CACE,kBAAA,CACE,qBAAA,CAAsB,KAAA,EAAO,YAAA;AAAA,KAIvB,8BAAA,eACI,aAAA,uBACO,aAAA,CAAc,KAAA,KACjC,kBAAA,CACF,qBAAA,CAAsB,KAAA,EAAO,YAAA,8BAE7B,OAAA,CACE,kBAAA,CACE,qBAAA,CAAsB,KAAA,EAAO,YAAA;;;;;KAQvB,8BAAA,eACI,aAAA,uBACO,aAAA,CAAc,KAAA,KACjC,2BAAA,CACF,qBAAA,CAAsB,KAAA,EAAO,YAAA,iBAE7B,OAAA,CACE,2BAAA,CACE,qBAAA,CAAsB,KAAA,EAAO,YAAA;AAAA,KAGvB,iBAAA,mBACQ,aAAA,CAAc,kBAAA,mBAChB,iBAAA,CAAkB,SAAA,uBACd,oBAAA,4BACC,aAAA,CACnB,mBAAA,CAAoB,SAAA,EAAW,OAAA,EAAS,WAAA,6BAEtB,aAAA,SAClB,IAAA,CACF,YAAA,CAAa,WAAA,IACX,qBAAA,CACE,mBAAA,CAAoB,SAAA,EAAW,OAAA,EAAS,WAAA,GACxC,YAAA"}
+{"version":3,"file":"props.d.mts","names":[],"sources":["../src/props.ts"],"mappings":";;;;;;AAsBA;;;;;AAAA,KAAY,kBAAA,4CACV,KAAA,EAAO,WAAA,EACP,OAAA,EAAS,OAAA,KACN,MAAA;;;;;;;;;;;;UAaY,qBAAA,SACP,aAAA,iBACM,KAAA,SAAc,aAAA,GAAgB,YAAA,CAAa,KAAA;EAIzD,KAAA,GAAQ,KAAA;EACR,MAAA,EAAQ,kBAAA,CAAmB,WAAA,EAAa,OAAA,EAAS,MAAA;AAAA;AAAA,KAGvC,cAAA,mBACQ,aAAA,CAAc,kBAAA;EAGhC,IAAA,EAAM,kBAAA,CAAmB,IAAA;EACzB,QAAA,EAAU,eAAA,CAAgB,YAAA,CAAa,SAAA;AAAA;AAAA,KAE7B,eAAA,mBACQ,aAAA,CAAc,kBAAA,2BAEhC,KAAA,EAAO,IAAA,CAAK,cAAA,CAAe,SAAA,EAAW,IAAA,OACnC,aAAA;AAAA,KACO,iBAAA,mBACQ,aAAA,CAAc,kBAAA,KAC9B,aAAA,GAAgB,eAAA,CAAgB,SAAA;AAAA,KACxB,eAAA,mBACQ,aAAA,CAAc,kBAAA,mBAChB,iBAAA,CAAkB,SAAA,KAChC,OAAA,SAAgB,eAAA,CAAgB,SAAA,IAAa,UAAA,CAAW,OAAA,IAAW,OAAA;AAAA,KAC3D,mBAAA,mBACQ,aAAA,CAAc,kBAAA,mBAChB,iBAAA,CAAkB,SAAA,uBACd,oBAAA,IAClB,eAAA,CAAgB,SAAA,EAAW,OAAA,UAAiB,aAAA,GAC5C,eAAA,CAAgB,SAAA,EAAW,OAAA,IAAW,gBAAA,CAAiB,WAAA;AAAA,KAE/C,eAAA;;;;;KAKP,SAAA,iBAA0B,eAAA,WAA0B,OAAO;AAAA,KAC3D,iBAAA,GAAoB,SAAS;AAAA,KAC7B,kBAAA;AAAA,KACA,uBAAA;EA1CyC;;;;EAgDxC,QAAA;AAAA;EA3CJ;;;;;;AAAuD;AAGzD;EAmDM,UAAU;AAAA;AAAA,KAEX,kBAAA;EApDe;;;;;;EA4Dd,WAAA,EAAa,kBAAA;AAAA;EA5DjB;;;;;;;;;;EAyEI,WAAA,EAAa,kBAAkB;AAAA;AArEa;AAElD;;AAFkD,KA2EtC,oBAAA,GAAuB,uBAAA,GAA0B,kBAAkB;AAAA,KAE1E,gBAAA,GAAmB,SAAA,GAAY,oBAAoB;;;;KAI5C,aAAA,mCACE,CAAA,aAAc,gBAAgB;AAAA,KAGvC,SAAA,eAAwB,aAAA,OAAoB,CAAA,SAAU,KAAA;AAAA,KAC/C,sBAAA,UAAgC,KAAA;EAAgB,QAAA;AAAA,IACxD,KAAA,sDAGA,KAAA;EAAgB,UAAA;AAAA,IAChB,KAAA,iBACA,KAAA,0CAEA,KAAA;AAAA,KAGQ,wBAAA,UAAkC,KAAA;EAC5C,WAAA,EAAa,kBAAA;AAAA,IAEX,KAAA,kBACA,KAAA;EAAgB,WAAA,EAAa,kBAAA;AAAA,IAC7B,KAAA;;;AAhGc;KAqGN,8BAAA,UAAwC,KAAA;EAC9C,QAAA;AAAA;EACA,WAAA,EAAa,kBAAA;AAAA;EAEb,UAAA,EAAY,sBAAA,CAAuB,KAAA;EACnC,WAAA,EAAa,wBAAA,CAAyB,KAAA;AAAA,IAExC,KAAA;AAAA,KAEQ,uBAAA,UAAiC,KAAA;EACvC,QAAA;AAAA;EACA,WAAA,EAAa,kBAAA;AAAA,IACf,wBAAA,CAAyB,KAAA,wBACvB,sBAAA,CAAuB,KAAA,8DAGvB,wBAAA,CAAyB,KAAA,IAC3B,KAAA;EACE,UAAA;EACA,WAAA,EAAa,kBAAA;AAAA,IAEf,KAAA,sCACE,KAAA,2EAGA,KAAA,kBACF,KAAA,wCAEA,KAAA;AAAA,KAIC,WAAA,iDAEgB,iBAAA,sBACC,kBAAA,0CAEN,YAAA,GAAe,sBAAA,CAC3B,YAAA,CAAa,GAAA,WACL,UAAA,GACN,WAAA,oBACE,GAAA,GACA,WAAA,SAAoB,uBAAA,CAAwB,YAAA,CAAa,GAAA,KACzD,GAAA,yBAGA,YAAA;AAAA,KACH,qBAAA,eACW,aAAA,uBACO,aAAA,CAAc,KAAA,sBAChB,iBAAA,sBACC,kBAAA,0BAClB,IAAA,CACF,KAAA,EACA,SAAA,CAAU,KAAA,EAAO,WAAA,CAAY,YAAA,EAAc,UAAA,EAAY,WAAA;AAAA,KAGpD,sBAAA,eAAqC,UAAA;EACxC,QAAA;AAAA,IAEE,kBAAA,GACA,UAAU;;KAGF,gCAAA,eACI,aAAA,uBACO,aAAA,CAAc,KAAA,KACjC,qBAAA,CAAsB,KAAA,EAAO,YAAA,6CACjB,qBAAA,CACZ,KAAA,EACA,YAAA,6BAGE,sBAAA,CACF,qBAAA,CAAsB,KAAA,EAAO,YAAA,2BAAuC,GAAA;AAAA,KAI5D,qBAAA,eACI,aAAA,uBACO,aAAA,CAAc,KAAA,KACjC,kBAAA,CAAmB,qBAAA,CAAsB,KAAA,EAAO,YAAA,iBAClD,OAAA,CACE,kBAAA,CAAmB,qBAAA,CAAsB,KAAA,EAAO,YAAA;AAAA,KAGxC,2BAAA,eACI,aAAA,uBACO,aAAA,CAAc,KAAA,KACjC,kBAAA,CACF,qBAAA,CAAsB,KAAA,EAAO,YAAA,2BAE7B,OAAA,CACE,kBAAA,CACE,qBAAA,CAAsB,KAAA,EAAO,YAAA;AAAA,KAIvB,8BAAA,eACI,aAAA,uBACO,aAAA,CAAc,KAAA,KACjC,kBAAA,CACF,qBAAA,CAAsB,KAAA,EAAO,YAAA,8BAE7B,OAAA,CACE,kBAAA,CACE,qBAAA,CAAsB,KAAA,EAAO,YAAA;;;;;KAQvB,8BAAA,eACI,aAAA,uBACO,aAAA,CAAc,KAAA,KACjC,2BAAA,CACF,qBAAA,CAAsB,KAAA,EAAO,YAAA,iBAE7B,OAAA,CACE,2BAAA,CACE,qBAAA,CAAsB,KAAA,EAAO,YAAA;AAAA,KAGvB,iBAAA,mBACQ,aAAA,CAAc,kBAAA,mBAChB,iBAAA,CAAkB,SAAA,uBACd,oBAAA,4BACC,aAAA,CACnB,mBAAA,CAAoB,SAAA,EAAW,OAAA,EAAS,WAAA,6BAEtB,aAAA,SAClB,IAAA,CACF,YAAA,CAAa,WAAA,IACX,qBAAA,CACE,mBAAA,CAAoB,SAAA,EAAW,OAAA,EAAS,WAAA,GACxC,YAAA"}

package/dist/props.mjs

@@ -0,0 +1,15 @@
+//#region src/props.ts
+function getIncludedPropBehavior(value) {
+	if (value === null || typeof value !== "object") return null;
+	const required = "required" in value && typeof value.required === "boolean" ? value.required : "visibility" in value ? value.visibility === "required" : void 0;
+	const suppliedVia = "suppliedVia" in value ? value.suppliedVia : "passthrough" in value ? value.passthrough : void 0;
+	if (required === void 0 || suppliedVia !== "component" && suppliedVia !== "config") return null;
+	return {
+		visibility: required ? "required" : "optional",
+		passthrough: suppliedVia
+	};
+}
+
+//#endregion
+export { getIncludedPropBehavior };
+//# sourceMappingURL=props.mjs.map

package/dist/props.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"props.mjs","names":[],"sources":["../src/props.ts"],"sourcesContent":["import type {\n  ComposableComponents,\n  MergePresetProps,\n} from '@jfdevelops/react-layout-composables';\nimport type { InPropsObject } from '@jfdevelops/react-layout-composables';\nimport {\n  EnumWrappedProp,\n  LiteralWrappedProp,\n  ResolveLayoutProps,\n  ResolveLayoutPropsAsDefined,\n  ResolveProps,\n} from '@jfdevelops/react-layout-validator';\nimport { ResourceDefinition, ResourceEnum } from './resource';\nimport { Show } from './utils';\n\nexport type { InPropsObject };\n\n/**\n * Two-argument `render(props, context)` used by createComponent and scoped\n * resource components. `Context` is sibling components (scoped) or the\n * resource render context (top-level).\n */\nexport type PropsContextRender<RenderProps, Context, Result = unknown> = (\n  props: RenderProps,\n  context: Context\n) => Result;\n\n/**\n * Shared `{ props?, render }` shape used by createComponent, scoped\n * components, and anywhere else a value declares props and a two-arg render.\n *\n * @typeParam Props - Declared on the entry (`props`). Often an\n *   {@link InPropsObject}, or a layout include/custom bag.\n * @typeParam RenderProps - First argument to `render` (defaults to\n *   {@link ResolveProps}<Props> when Props is an {@link InPropsObject})\n * @typeParam Result - `render` return type\n * @typeParam Context - Second argument to `render`\n */\nexport interface PropsRenderDefinition<\n  Props = InPropsObject,\n  RenderProps = Props extends InPropsObject ? ResolveProps<Props> : unknown,\n  Result = unknown,\n  Context = unknown\n> {\n  props?: Props;\n  render: PropsContextRender<RenderProps, Context, Result>;\n}\n\nexport type InPropsOptions<\n  Resources extends ReadonlyArray<ResourceDefinition>,\n  Name extends string\n> = {\n  name: LiteralWrappedProp<Name, 'string', 'required'>;\n  resource: EnumWrappedProp<ResourceEnum<Resources>, 'string', 'required'>;\n};\nexport type InPropsFunction<\n  Resources extends ReadonlyArray<ResourceDefinition>\n> = <Name extends string>(\n  props: Show<InPropsOptions<Resources, Name>>\n) => InPropsObject;\nexport type InPropsDefinition<\n  Resources extends ReadonlyArray<ResourceDefinition>\n> = InPropsObject | InPropsFunction<Resources>;\nexport type InferredInProps<\n  Resources extends ReadonlyArray<ResourceDefinition>,\n  Options extends InPropsDefinition<Resources>\n> = Options extends InPropsFunction<Resources> ? ReturnType<Options> : Options;\nexport type MergedLayoutInProps<\n  Resources extends ReadonlyArray<ResourceDefinition>,\n  Options extends InPropsDefinition<Resources>,\n  Composables extends ComposableComponents\n> = InferredInProps<Resources, Options> extends InPropsObject\n  ? InferredInProps<Resources, Options> & MergePresetProps<Composables>\n  : never;\nexport type RequiredVariant = true | 'required';\n/**\n * @typeParam RequiredVariant How the required props are selected. In application code,\n * it will always be `true`, but internally we need to support `'required'` as well.\n */\ntype PropsType<Variant extends RequiredVariant = true> = Variant | 'optional';\ntype InternalPropsType = PropsType<'required'>;\ntype IncludedPropSource = 'component' | 'config';\ntype IncludedPropRequirement =\n  | {\n      /**\n       * Whether the prop must be supplied. When both names are present,\n       * `required` takes precedence over the deprecated `visibility` setting.\n       */\n      required: boolean;\n    }\n  | {\n      /**\n       * Whether the prop must be supplied (`'required'`) or may be omitted\n       * (`'optional'`). The `required` setting takes precedence when both are present.\n       *\n       * @deprecated Use `required: true` instead of `visibility: 'required'`, or\n       * `required: false` instead of `visibility: 'optional'`.\n       * This property will be removed in the next major version.\n       */\n      visibility: 'optional' | 'required';\n    };\ntype IncludedPropSupply =\n  | {\n      /**\n       * Where the prop is supplied: at component render time (`'component'`)\n       * or through layout creation options (`'config'`). Optional component props\n       * also accept configuration-time defaults. This setting takes precedence\n       * over the deprecated `passthrough` setting.\n       */\n      suppliedVia: IncludedPropSource;\n    }\n  | {\n      /**\n       * Where the prop is supplied: at component render time (`'component'`)\n       * or through layout creation options (`'config'`). Optional component props\n       * also accept configuration-time defaults. The `suppliedVia` setting takes\n       * precedence when both names are present.\n       *\n       * @deprecated Use `suppliedVia: 'component'` instead of\n       * `passthrough: 'component'`, or `suppliedVia: 'config'` instead of\n       * `passthrough: 'config'`. This property will be removed in the next major version.\n       */\n      passthrough: IncludedPropSource;\n    };\n\n/**\n * Controls where an included layout prop is supplied and whether it is required there.\n */\nexport type IncludedPropBehavior = IncludedPropRequirement & IncludedPropSupply;\n\ntype IncludedPropType = PropsType | IncludedPropBehavior;\n/**\n * A map of props to include in the layout.\n */\nexport type IncludedProps<T extends object> = {\n  [K in keyof T & string]?: IncludedPropType;\n};\n\ntype PropsKeys<Props extends InPropsObject, T> = T & keyof Props;\nexport type IncludedPropVisibility<Value> = Value extends { required: boolean }\n  ? Value['required'] extends true\n    ? 'required'\n    : 'optional'\n  : Value extends { visibility: 'required' | 'optional' }\n  ? Value['visibility']\n  : Value extends true | 'required'\n  ? 'required'\n  : Value extends 'optional'\n  ? 'optional'\n  : never;\nexport type IncludedPropSupplySource<Value> = Value extends {\n  suppliedVia: IncludedPropSource;\n}\n  ? Value['suppliedVia']\n  : Value extends { passthrough: IncludedPropSource }\n  ? Value['passthrough']\n  : never;\n/**\n * Canonical shape used internally for either spelling of an include behavior.\n */\nexport type NormalizedIncludedPropBehavior<Value> = Value extends\n  | { required: boolean }\n  | { suppliedVia: IncludedPropSource }\n  ? {\n      visibility: IncludedPropVisibility<Value>;\n      passthrough: IncludedPropSupplySource<Value>;\n    }\n  : Value;\n\nexport type IncludedPropPassthrough<Value> = Value extends\n  | { required: boolean }\n  | { suppliedVia: IncludedPropSource }\n  ? IncludedPropSupplySource<Value> extends 'component'\n    ? IncludedPropVisibility<Value> extends 'optional'\n      ? 'component' | 'config'\n      : 'component'\n    : IncludedPropSupplySource<Value>\n  : Value extends {\n      visibility: 'required' | 'optional';\n      passthrough: IncludedPropSource;\n    }\n  ? Value['passthrough'] extends 'component'\n    ? Value['visibility'] extends 'optional'\n      ? 'component' | 'config'\n      : 'component'\n    : Value['passthrough']\n  : Value extends true | 'required'\n  ? 'config'\n  : Value extends 'optional'\n  ? 'component' | 'config'\n  : never;\n\ntype GetPropsKey<\n  IncludeProps extends object,\n  Visibility extends InternalPropsType,\n  Passthrough extends IncludedPropSource | 'render' = 'render'\n> = {\n  [Key in keyof IncludeProps]: IncludedPropVisibility<\n    IncludeProps[Key]\n  > extends Visibility\n    ? Passthrough extends 'render'\n      ? Key\n      : Passthrough extends IncludedPropPassthrough<IncludeProps[Key]>\n      ? Key\n      : never\n    : never;\n}[keyof IncludeProps];\ntype SelectedIncludedProps<\n  Props extends InPropsObject,\n  IncludeProps extends IncludedProps<Props>,\n  Visibility extends InternalPropsType,\n  Passthrough extends IncludedPropSource | 'render' = 'render'\n> = Pick<\n  Props,\n  PropsKeys<Props, GetPropsKey<IncludeProps, Visibility, Passthrough>>\n>;\n\ntype OptionalPropDefinition<Definition> = Definition extends {\n  optional(): infer OptionalDefinition;\n}\n  ? OptionalDefinition\n  : Definition;\n\n/** Raw validator definitions accepted by a generated component call. */\nexport type IncludedComponentPropDefinitions<\n  Props extends InPropsObject,\n  IncludeProps extends IncludedProps<Props>\n> = SelectedIncludedProps<Props, IncludeProps, 'required', 'component'> & {\n  [Key in keyof SelectedIncludedProps<\n    Props,\n    IncludeProps,\n    'optional',\n    'component'\n  >]: OptionalPropDefinition<\n    SelectedIncludedProps<Props, IncludeProps, 'optional', 'component'>[Key]\n  >;\n};\n\nexport type ResolvedIncludedProps<\n  Props extends InPropsObject,\n  IncludeProps extends IncludedProps<Props>\n> = ResolveLayoutProps<SelectedIncludedProps<Props, IncludeProps, 'required'>> &\n  Partial<\n    ResolveLayoutProps<SelectedIncludedProps<Props, IncludeProps, 'optional'>>\n  >;\n\nexport type ResolvedIncludedConfigProps<\n  Props extends InPropsObject,\n  IncludeProps extends IncludedProps<Props>\n> = ResolveLayoutProps<\n  SelectedIncludedProps<Props, IncludeProps, 'required', 'config'>\n> &\n  Partial<\n    ResolveLayoutProps<\n      SelectedIncludedProps<Props, IncludeProps, 'optional', 'config'>\n    >\n  >;\n\nexport type ResolvedIncludedComponentProps<\n  Props extends InPropsObject,\n  IncludeProps extends IncludedProps<Props>\n> = ResolveLayoutProps<\n  SelectedIncludedProps<Props, IncludeProps, 'required', 'component'>\n> &\n  Partial<\n    ResolveLayoutProps<\n      SelectedIncludedProps<Props, IncludeProps, 'optional', 'component'>\n    >\n  >;\n\n/**\n * Like {@link ResolvedIncludedProps}, but keeps included prop keys exactly as\n * declared (no `JSX.Element` capitalization).\n */\nexport type ResolvedIncludedPropsAsDefined<\n  Props extends InPropsObject,\n  IncludeProps extends IncludedProps<Props>\n> = ResolveLayoutPropsAsDefined<\n  SelectedIncludedProps<Props, IncludeProps, 'required'>\n> &\n  Partial<\n    ResolveLayoutPropsAsDefined<\n      SelectedIncludedProps<Props, IncludeProps, 'optional'>\n    >\n  >;\nexport type LayoutRenderProps<\n  Resources extends ReadonlyArray<ResourceDefinition>,\n  Options extends InPropsDefinition<Resources>,\n  Composables extends ComposableComponents = {},\n  IncludeProps extends IncludedProps<\n    MergedLayoutInProps<Resources, Options, Composables>\n  > = {},\n  CustomProps extends InPropsObject = {}\n> = Show<\n  ResolveProps<CustomProps> &\n    ResolvedIncludedProps<\n      MergedLayoutInProps<Resources, Options, Composables>,\n      IncludeProps\n    >\n>;\n\nexport function getIncludedPropBehavior(value: unknown): {\n  visibility: 'required' | 'optional';\n  passthrough: 'component' | 'config';\n} | null {\n  if (value === null || typeof value !== 'object') {\n    return null;\n  }\n\n  const required =\n    'required' in value && typeof value.required === 'boolean'\n      ? value.required\n      : 'visibility' in value\n      ? value.visibility === 'required'\n      : undefined;\n  const suppliedVia =\n    'suppliedVia' in value\n      ? value.suppliedVia\n      : 'passthrough' in value\n      ? value.passthrough\n      : undefined;\n\n  if (\n    required === undefined ||\n    (suppliedVia !== 'component' && suppliedVia !== 'config')\n  ) {\n    return null;\n  }\n\n  return {\n    visibility: required ? 'required' : 'optional',\n    passthrough: suppliedVia,\n  };\n}\n"],"mappings":";AA6SA,SAAgB,wBAAwB,OAG/B;CACP,IAAI,UAAU,QAAQ,OAAO,UAAU,UACrC,OAAO;CAGT,MAAM,WACJ,cAAc,SAAS,OAAO,MAAM,aAAa,YAC7C,MAAM,WACN,gBAAgB,QAChB,MAAM,eAAe,aACrB;CACN,MAAM,cACJ,iBAAiB,QACb,MAAM,cACN,iBAAiB,QACjB,MAAM,cACN;CAEN,IACE,aAAa,UACZ,gBAAgB,eAAe,gBAAgB,UAEhD,OAAO;CAGT,OAAO;EACL,YAAY,WAAW,aAAa;EACpC,aAAa;CACf;AACF"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jfdevelops/react-layout",
-  "version": "1.4.1",
+  "version": "1.5.0",
   "description": "A React library for creating layout components.",
   "repository": {
     "type": "git",
@@ -29,8 +29,8 @@
   "dependencies": {
     "@jfdevelops/create-error": "0.2.0",
     "arktype": "2.2.8",
-    "@jfdevelops/react-layout-validator": "0.3.0",
-    "@jfdevelops/react-layout-composables": "0.3.0",
+    "@jfdevelops/react-layout-composables": "0.3.1",
+    "@jfdevelops/react-layout-validator": "0.3.1",
     "@jfdevelops/react-layout-devtools-core": "0.2.0"
   },
   "peerDependencies": {
@@ -57,7 +57,8 @@
     "typescript": "6.0.3",
     "unrun": "0.3.0",
     "vite": "8.0.10",
-    "vitest": "4.1.5"
+    "vitest": "4.1.5",
+    "@jfdevelops/react-layout-composable-breadcrumb": "0.2.10"
   },
   "scripts": {
     "dev": "portless react-layout vite",