@jfdevelops/react-layout-composables 1.0.0 → 1.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1 +1 @@
1
- {"version":3,"file":"errors.mjs","names":[],"sources":["../src/errors.ts"],"sourcesContent":["import { createError } from '@jfdevelops/create-error';\nimport { type } from 'arktype';\n\nconst composableErrorFactory = createError({\n definition: type({\n code: 'string',\n }),\n data: {\n property: 'context',\n resolve: ({ input }) => input,\n },\n message: ({ data, implementation }) => implementation(data),\n properties: ({ definition }) => ({\n code: definition.code,\n }),\n});\n\n/** Thrown when the composable component map is not an object. */\nexport class InvalidComponentsError extends composableErrorFactory({\n code: 'invalidComponents',\n})\n .defineContext(type('string'))\n .implement((message) => message) {}\n\n/** Thrown when no composable components were provided. */\nexport class EmptyComponentsError extends composableErrorFactory({\n code: 'emptyComponents',\n})\n .defineContext(type('string'))\n .implement((message) => message) {}\n"],"mappings":";;;;AAGA,MAAM,yBAAyB,YAAY;CACzC,YAAY,KAAK,EACf,MAAM,SACR,CAAC;CACD,MAAM;EACJ,UAAU;EACV,UAAU,EAAE,YAAY;CAC1B;CACA,UAAU,EAAE,MAAM,qBAAqB,eAAe,IAAI;CAC1D,aAAa,EAAE,kBAAkB,EAC/B,MAAM,WAAW,KACnB;AACF,CAAC;;AAGD,IAAa,yBAAb,cAA4C,uBAAuB,EACjE,MAAM,oBACR,CAAC,EACE,cAAc,KAAK,QAAQ,CAAC,EAC5B,WAAW,YAAY,OAAO,EAAE,CAAC;;AAGpC,IAAa,uBAAb,cAA0C,uBAAuB,EAC/D,MAAM,kBACR,CAAC,EACE,cAAc,KAAK,QAAQ,CAAC,EAC5B,WAAW,YAAY,OAAO,EAAE,CAAC"}
1
+ {"version":3,"file":"errors.mjs","names":[],"sources":["../src/errors.ts"],"sourcesContent":["import { createError } from '@jfdevelops/create-error';\nimport {\n builtIn,\n type StandardSchemaV1,\n} from '@jfdevelops/react-layout-validator';\n\nconst composableErrorFactory = createError({\n definition: builtIn.object({\n code: builtIn.string,\n }),\n data: {\n property: 'context',\n resolve: ({ input }) => input,\n },\n message: ({ data, implementation }) => implementation(data),\n properties: ({ definition }) => ({\n code: definition.code,\n }),\n});\n\n/** Thrown when the composable component map is not an object. */\nexport class InvalidComponentsError extends composableErrorFactory({\n code: 'invalidComponents',\n})\n .defineContext(builtIn.string)\n .implement((message) => message) {}\n\n/** Thrown when no composable components were provided. */\nexport class EmptyComponentsError extends composableErrorFactory({\n code: 'emptyComponents',\n})\n .defineContext(builtIn.string)\n .implement((message) => message) {}\n\n/** Thrown when a defined composable's props are declared incorrectly. */\nexport class InvalidComposablePropsError extends composableErrorFactory({\n code: 'invalidComposableProps',\n})\n .defineContext(builtIn.string)\n .implement((message) => message) {}\n\nconst propRenameContext = builtIn.object({\n composable: builtIn.string,\n prop: builtIn.string,\n name: builtIn.string,\n reason: builtIn.literal('reserved', 'duplicate', 'unknown'),\n});\n\nexport type InvalidPropRenameContext = StandardSchemaV1.InferOutput<\n typeof propRenameContext\n>;\n\nconst propRenameReasons = {\n reserved: 'is reserved',\n duplicate: 'is already used by another prop',\n unknown: 'cannot be applied because the prop is not defined',\n} satisfies Record<InvalidPropRenameContext['reason'], string>;\n\n/** Thrown when a defined composable's prop cannot take its new name. */\nexport class InvalidPropRenameError extends composableErrorFactory({\n code: 'invalidPropRename',\n})\n .defineContext(propRenameContext)\n .implement(\n ({ composable, prop, name, reason }) =>\n `Composable \"${composable}\" cannot rename prop \"${prop}\" to \"${name}\": the name ${propRenameReasons[reason]}.`,\n ) {}\n\nconst presetPropConflictContext = builtIn.object({\n prop: builtIn.string,\n composables: builtIn.tuple(builtIn.string, builtIn.string),\n});\n\nexport type ConflictingPresetPropContext = StandardSchemaV1.InferOutput<\n typeof presetPropConflictContext\n>;\n\n/** Thrown when two preset composables declare one prop with different definitions. */\nexport class ConflictingPresetPropError extends composableErrorFactory({\n code: 'conflictingPresetProp',\n})\n .defineContext(presetPropConflictContext)\n .implement(\n ({ prop, composables: [first, second] }) =>\n `Composables \"${first}\" and \"${second}\" both declare prop \"${prop}\" with different definitions. Rename the prop on one of them, or share one definition.`,\n ) {}\n"],"mappings":";;;;AAMA,MAAM,yBAAyB,YAAY;CACzC,YAAY,QAAQ,OAAO,EACzB,MAAM,QAAQ,OAChB,CAAC;CACD,MAAM;EACJ,UAAU;EACV,UAAU,EAAE,YAAY;CAC1B;CACA,UAAU,EAAE,MAAM,qBAAqB,eAAe,IAAI;CAC1D,aAAa,EAAE,kBAAkB,EAC/B,MAAM,WAAW,KACnB;AACF,CAAC;;AAGD,IAAa,yBAAb,cAA4C,uBAAuB,EACjE,MAAM,oBACR,CAAC,EACE,cAAc,QAAQ,MAAM,EAC5B,WAAW,YAAY,OAAO,EAAE,CAAC;;AAGpC,IAAa,uBAAb,cAA0C,uBAAuB,EAC/D,MAAM,kBACR,CAAC,EACE,cAAc,QAAQ,MAAM,EAC5B,WAAW,YAAY,OAAO,EAAE,CAAC;;AAGpC,IAAa,8BAAb,cAAiD,uBAAuB,EACtE,MAAM,yBACR,CAAC,EACE,cAAc,QAAQ,MAAM,EAC5B,WAAW,YAAY,OAAO,EAAE,CAAC;AAEpC,MAAM,oBAAoB,QAAQ,OAAO;CACvC,YAAY,QAAQ;CACpB,MAAM,QAAQ;CACd,MAAM,QAAQ;CACd,QAAQ,QAAQ,QAAQ,YAAY,aAAa,SAAS;AAC5D,CAAC;AAMD,MAAM,oBAAoB;CACxB,UAAU;CACV,WAAW;CACX,SAAS;AACX;;AAGA,IAAa,yBAAb,cAA4C,uBAAuB,EACjE,MAAM,oBACR,CAAC,EACE,cAAc,iBAAiB,EAC/B,WACE,EAAE,YAAY,MAAM,MAAM,aACzB,eAAe,WAAW,wBAAwB,KAAK,QAAQ,KAAK,cAAc,kBAAkB,QAAQ,EAChH,EAAE,CAAC;AAEL,MAAM,4BAA4B,QAAQ,OAAO;CAC/C,MAAM,QAAQ;CACd,aAAa,QAAQ,MAAM,QAAQ,QAAQ,QAAQ,MAAM;AAC3D,CAAC;;AAOD,IAAa,6BAAb,cAAgD,uBAAuB,EACrE,MAAM,wBACR,CAAC,EACE,cAAc,yBAAyB,EACvC,WACE,EAAE,MAAM,aAAa,CAAC,OAAO,cAC5B,gBAAgB,MAAM,SAAS,OAAO,uBAAuB,KAAK,uFACtE,EAAE,CAAC"}
package/dist/index.cjs CHANGED
@@ -1,14 +1,36 @@
1
1
  Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
2
2
  const require_errors = require('./errors.cjs');
3
3
  const require_composable = require('./composable.cjs');
4
+ let _jfdevelops_react_layout_validator = require("@jfdevelops/react-layout-validator");
4
5
 
6
+ exports.ConflictingPresetPropError = require_errors.ConflictingPresetPropError;
5
7
  exports.EmptyComponentsError = require_errors.EmptyComponentsError;
6
8
  exports.InvalidComponentsError = require_errors.InvalidComponentsError;
9
+ exports.InvalidComposablePropsError = require_errors.InvalidComposablePropsError;
10
+ exports.InvalidPropRenameError = require_errors.InvalidPropRenameError;
7
11
  exports.LayoutComposablePresetProvider = require_composable.LayoutComposablePresetProvider;
12
+ Object.defineProperty(exports, 'PropValidatorError', {
13
+ enumerable: true,
14
+ get: function () {
15
+ return _jfdevelops_react_layout_validator.PropValidatorError;
16
+ }
17
+ });
18
+ Object.defineProperty(exports, 'builtIn', {
19
+ enumerable: true,
20
+ get: function () {
21
+ return _jfdevelops_react_layout_validator.builtIn;
22
+ }
23
+ });
8
24
  exports.collectComposablePresetEntries = require_composable.collectComposablePresetEntries;
9
25
  exports.composablePresetMetaKey = require_composable.composablePresetMetaKey;
10
26
  exports.createComposableComponent = require_composable.createComposableComponent;
11
27
  exports.createLayoutComposableFactory = require_composable.createLayoutComposableFactory;
28
+ Object.defineProperty(exports, 'createPropValidator', {
29
+ enumerable: true,
30
+ get: function () {
31
+ return _jfdevelops_react_layout_validator.createPropValidator;
32
+ }
33
+ });
12
34
  exports.defineComposableComponent = require_composable.defineComposableComponent;
13
35
  exports.makeComposable = require_composable.makeComposable;
14
36
  exports.resolveComposablePresetProps = require_composable.resolveComposablePresetProps;
package/dist/index.d.cts CHANGED
@@ -1,5 +1,7 @@
1
+ import { ChildrenRequirement, ComposablePropDefinition, ComposableProps, ComposablePropsInput, CustomPropsInput, CustomPropsObject, NormalizeComposableProps, RequiredChildren } from "./custom-props.cjs";
1
2
  import { InPropsObject, WithChildren } from "./types.cjs";
2
3
  import { BaseComponent, Show, ShowCallable, UnionToIntersection } from "./packages/internals/src/types.cjs";
3
- import { AnyComposableComponent, ComposableComponent, ComposableComponentCallable, ComposableComponents, ComposableNameContext, ComposablePresetComponent, ComposablePresetComponentCallProps, ComposablePresetMeta, ComposablePresetProps, ComposableResourceLayout, CreateLayoutComposable, DefinedComposableComponentRecord, LayoutComposablePresetProvider, LayoutComposablesFactory, MakeComposable, MakeComposableOptions, MergePresetProps, PresetPropsFromComposable, RequiredPresetLayoutProps, RequiredPresetRenderProps, ResolveLayoutComposables, collectComposablePresetEntries, composablePresetMetaKey, createComposableComponent, createLayoutComposableFactory, defineComposableComponent, makeComposable, resolveComposablePresetProps, resolveLayoutComposables } from "./composable.cjs";
4
- import { EmptyComponentsError, InvalidComponentsError } from "./errors.cjs";
5
- export { type AnyComposableComponent, type BaseComponent, type ComposableComponent, type ComposableComponentCallable, type ComposableComponents, type ComposableNameContext, type ComposablePresetComponent, type ComposablePresetComponentCallProps, type ComposablePresetMeta, type ComposablePresetProps, type ComposableResourceLayout, type CreateLayoutComposable, type DefinedComposableComponentRecord, EmptyComponentsError, type InPropsObject, InvalidComponentsError, LayoutComposablePresetProvider, type LayoutComposablesFactory, type MakeComposable, type MakeComposableOptions, type MergePresetProps, type PresetPropsFromComposable, type RequiredPresetLayoutProps, type RequiredPresetRenderProps, type ResolveLayoutComposables, type Show, type ShowCallable, type UnionToIntersection, type WithChildren, collectComposablePresetEntries, composablePresetMetaKey, createComposableComponent, createLayoutComposableFactory, defineComposableComponent, makeComposable, resolveComposablePresetProps, resolveLayoutComposables };
4
+ import { AnyComposableComponent, ComposableComponent, ComposableComponentCallable, ComposableComponents, ComposableContextEntry, ComposableContextOptions, ComposableContextValues, ComposableNameContext, ComposablePresetComponent, ComposablePresetComponentCallProps, ComposablePresetMeta, ComposablePresetProps, ComposableResourceLayout, CreateLayoutComposable, DefinedComposableComponentFactory, DefinedComposableComponentRecord, LayoutComposablePresetProvider, LayoutComposablesFactory, MakeComposable, MakeComposableOptions, MergePresetProps, PresetPropsFromComposable, PropRename, PropRenames, RenameProps, RequiredPresetLayoutProps, RequiredPresetRenderProps, ResolveLayoutComposables, collectComposablePresetEntries, composablePresetMetaKey, createComposableComponent, createLayoutComposableFactory, defineComposableComponent, makeComposable, resolveComposablePresetProps, resolveLayoutComposables } from "./composable.cjs";
5
+ import { ConflictingPresetPropContext, ConflictingPresetPropError, EmptyComponentsError, InvalidComponentsError, InvalidComposablePropsError, InvalidPropRenameContext, InvalidPropRenameError } from "./errors.cjs";
6
+ import { PropValidator, PropValidatorContext, PropValidatorError, PropValidatorErrorHelper, PropValidatorSchema, builtIn, createPropValidator } from "@jfdevelops/react-layout-validator";
7
+ export { type AnyComposableComponent, type BaseComponent, type ChildrenRequirement, type ComposableComponent, type ComposableComponentCallable, type ComposableComponents, type ComposableContextEntry, type ComposableContextOptions, type ComposableContextValues, type ComposableNameContext, type ComposablePresetComponent, type ComposablePresetComponentCallProps, type ComposablePresetMeta, type ComposablePresetProps, type ComposablePropDefinition, type ComposableProps, type ComposablePropsInput, type ComposableResourceLayout, type ConflictingPresetPropContext, ConflictingPresetPropError, type CreateLayoutComposable, type CustomPropsInput, type CustomPropsObject, type DefinedComposableComponentFactory, type DefinedComposableComponentRecord, EmptyComponentsError, type InPropsObject, InvalidComponentsError, InvalidComposablePropsError, type InvalidPropRenameContext, InvalidPropRenameError, LayoutComposablePresetProvider, type LayoutComposablesFactory, type MakeComposable, type MakeComposableOptions, type MergePresetProps, type NormalizeComposableProps, type PresetPropsFromComposable, type PropRename, type PropRenames, type PropValidator, type PropValidatorContext, PropValidatorError, type PropValidatorErrorHelper, type PropValidatorSchema, type RenameProps, type RequiredChildren, type RequiredPresetLayoutProps, type RequiredPresetRenderProps, type ResolveLayoutComposables, type Show, type ShowCallable, type UnionToIntersection, type WithChildren, builtIn, collectComposablePresetEntries, composablePresetMetaKey, createComposableComponent, createLayoutComposableFactory, createPropValidator, defineComposableComponent, makeComposable, resolveComposablePresetProps, resolveLayoutComposables };
package/dist/index.d.mts CHANGED
@@ -1,5 +1,7 @@
1
+ import { ChildrenRequirement, ComposablePropDefinition, ComposableProps, ComposablePropsInput, CustomPropsInput, CustomPropsObject, NormalizeComposableProps, RequiredChildren } from "./custom-props.mjs";
1
2
  import { InPropsObject, WithChildren } from "./types.mjs";
2
3
  import { BaseComponent, Show, ShowCallable, UnionToIntersection } from "./packages/internals/src/types.mjs";
3
- import { AnyComposableComponent, ComposableComponent, ComposableComponentCallable, ComposableComponents, ComposableNameContext, ComposablePresetComponent, ComposablePresetComponentCallProps, ComposablePresetMeta, ComposablePresetProps, ComposableResourceLayout, CreateLayoutComposable, DefinedComposableComponentRecord, LayoutComposablePresetProvider, LayoutComposablesFactory, MakeComposable, MakeComposableOptions, MergePresetProps, PresetPropsFromComposable, RequiredPresetLayoutProps, RequiredPresetRenderProps, ResolveLayoutComposables, collectComposablePresetEntries, composablePresetMetaKey, createComposableComponent, createLayoutComposableFactory, defineComposableComponent, makeComposable, resolveComposablePresetProps, resolveLayoutComposables } from "./composable.mjs";
4
- import { EmptyComponentsError, InvalidComponentsError } from "./errors.mjs";
5
- export { type AnyComposableComponent, type BaseComponent, type ComposableComponent, type ComposableComponentCallable, type ComposableComponents, type ComposableNameContext, type ComposablePresetComponent, type ComposablePresetComponentCallProps, type ComposablePresetMeta, type ComposablePresetProps, type ComposableResourceLayout, type CreateLayoutComposable, type DefinedComposableComponentRecord, EmptyComponentsError, type InPropsObject, InvalidComponentsError, LayoutComposablePresetProvider, type LayoutComposablesFactory, type MakeComposable, type MakeComposableOptions, type MergePresetProps, type PresetPropsFromComposable, type RequiredPresetLayoutProps, type RequiredPresetRenderProps, type ResolveLayoutComposables, type Show, type ShowCallable, type UnionToIntersection, type WithChildren, collectComposablePresetEntries, composablePresetMetaKey, createComposableComponent, createLayoutComposableFactory, defineComposableComponent, makeComposable, resolveComposablePresetProps, resolveLayoutComposables };
4
+ import { AnyComposableComponent, ComposableComponent, ComposableComponentCallable, ComposableComponents, ComposableContextEntry, ComposableContextOptions, ComposableContextValues, ComposableNameContext, ComposablePresetComponent, ComposablePresetComponentCallProps, ComposablePresetMeta, ComposablePresetProps, ComposableResourceLayout, CreateLayoutComposable, DefinedComposableComponentFactory, DefinedComposableComponentRecord, LayoutComposablePresetProvider, LayoutComposablesFactory, MakeComposable, MakeComposableOptions, MergePresetProps, PresetPropsFromComposable, PropRename, PropRenames, RenameProps, RequiredPresetLayoutProps, RequiredPresetRenderProps, ResolveLayoutComposables, collectComposablePresetEntries, composablePresetMetaKey, createComposableComponent, createLayoutComposableFactory, defineComposableComponent, makeComposable, resolveComposablePresetProps, resolveLayoutComposables } from "./composable.mjs";
5
+ import { ConflictingPresetPropContext, ConflictingPresetPropError, EmptyComponentsError, InvalidComponentsError, InvalidComposablePropsError, InvalidPropRenameContext, InvalidPropRenameError } from "./errors.mjs";
6
+ import { PropValidator, PropValidatorContext, PropValidatorError, PropValidatorErrorHelper, PropValidatorSchema, builtIn, createPropValidator } from "@jfdevelops/react-layout-validator";
7
+ export { type AnyComposableComponent, type BaseComponent, type ChildrenRequirement, type ComposableComponent, type ComposableComponentCallable, type ComposableComponents, type ComposableContextEntry, type ComposableContextOptions, type ComposableContextValues, type ComposableNameContext, type ComposablePresetComponent, type ComposablePresetComponentCallProps, type ComposablePresetMeta, type ComposablePresetProps, type ComposablePropDefinition, type ComposableProps, type ComposablePropsInput, type ComposableResourceLayout, type ConflictingPresetPropContext, ConflictingPresetPropError, type CreateLayoutComposable, type CustomPropsInput, type CustomPropsObject, type DefinedComposableComponentFactory, type DefinedComposableComponentRecord, EmptyComponentsError, type InPropsObject, InvalidComponentsError, InvalidComposablePropsError, type InvalidPropRenameContext, InvalidPropRenameError, LayoutComposablePresetProvider, type LayoutComposablesFactory, type MakeComposable, type MakeComposableOptions, type MergePresetProps, type NormalizeComposableProps, type PresetPropsFromComposable, type PropRename, type PropRenames, type PropValidator, type PropValidatorContext, PropValidatorError, type PropValidatorErrorHelper, type PropValidatorSchema, type RenameProps, type RequiredChildren, type RequiredPresetLayoutProps, type RequiredPresetRenderProps, type ResolveLayoutComposables, type Show, type ShowCallable, type UnionToIntersection, type WithChildren, builtIn, collectComposablePresetEntries, composablePresetMetaKey, createComposableComponent, createLayoutComposableFactory, createPropValidator, defineComposableComponent, makeComposable, resolveComposablePresetProps, resolveLayoutComposables };
package/dist/index.mjs CHANGED
@@ -1,4 +1,5 @@
1
- import { EmptyComponentsError, InvalidComponentsError } from "./errors.mjs";
1
+ import { ConflictingPresetPropError, EmptyComponentsError, InvalidComponentsError, InvalidComposablePropsError, InvalidPropRenameError } from "./errors.mjs";
2
2
  import { LayoutComposablePresetProvider, collectComposablePresetEntries, composablePresetMetaKey, createComposableComponent, createLayoutComposableFactory, defineComposableComponent, makeComposable, resolveComposablePresetProps, resolveLayoutComposables } from "./composable.mjs";
3
+ import { PropValidatorError, builtIn, createPropValidator } from "@jfdevelops/react-layout-validator";
3
4
 
4
- export { EmptyComponentsError, InvalidComponentsError, LayoutComposablePresetProvider, collectComposablePresetEntries, composablePresetMetaKey, createComposableComponent, createLayoutComposableFactory, defineComposableComponent, makeComposable, resolveComposablePresetProps, resolveLayoutComposables };
5
+ export { ConflictingPresetPropError, EmptyComponentsError, InvalidComponentsError, InvalidComposablePropsError, InvalidPropRenameError, LayoutComposablePresetProvider, PropValidatorError, builtIn, collectComposablePresetEntries, composablePresetMetaKey, createComposableComponent, createLayoutComposableFactory, createPropValidator, defineComposableComponent, makeComposable, resolveComposablePresetProps, resolveLayoutComposables };
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@jfdevelops/react-layout-composables",
3
- "version": "1.0.0",
3
+ "version": "1.1.0",
4
4
  "description": "Composable components for react-layout.",
5
5
  "repository": {
6
6
  "type": "git",
@@ -29,8 +29,7 @@
29
29
  },
30
30
  "dependencies": {
31
31
  "@jfdevelops/create-error": "0.2.1",
32
- "arktype": "2.2.8",
33
- "@jfdevelops/react-layout-validator": "1.0.0"
32
+ "@jfdevelops/react-layout-validator": "1.1.0"
34
33
  },
35
34
  "devDependencies": {
36
35
  "@testing-library/jest-dom": "6.9.1",