@formdef/core 0.1.0 → 0.1.2

package/README.md

@@ -1,10 +1,34 @@
+<a href="https://formdef.mauricereim.de"><img src="https://formdef.mauricereim.de/brand/banner-light.png" alt="formdef. Describe a form once. Render it as a React component." width="100%" /></a>
+
 # @formdef/core
 
 Describe a form once as a typed object, render it as a React component — with the compiler
-checking that every widget fits the value it receives.
+checking that every widget fits the value it receives. Built on
+[TanStack Form](https://tanstack.com/form).
+
+`createForm` comes from the registry that names your widgets, which
+[Getting started](https://formdef.mauricereim.de/getting-started) sets up:
+
+```tsx
+export const SignIn = createForm({
+  schema: z.object({ email: z.email(), remember: z.boolean() }),
+  defaultValues: { email: '', remember: false },
+  fields: {
+    email: { widget: 'text', props: { label: 'Email' } },
+    remember: { widget: 'checkbox', props: { label: 'Remember me' } },
+  },
+})
+```
+
+## Installation
 
-Built on [TanStack Form](https://tanstack.com/form). Not released yet; see the
-[repository](https://github.com/maurice-rm/formdef) for the current state.
+```bash
+npm install @formdef/core @tanstack/react-form zod
+```
+
+Zod stands for any schema library that implements [Standard Schema](https://standardschema.dev).
+The widgets for shadcn/ui come from formdef's shadcn registry; the
+[installation guide](https://formdef.mauricereim.de/installation) shows how to add it.
 
 ## Requirements
 
@@ -13,6 +37,11 @@ Built on [TanStack Form](https://tanstack.com/form). Not released yet; see the
 - TypeScript 5.4 or later
 - Node 22 or later
 
+## Documentation
+
+[formdef.mauricereim.de](https://formdef.mauricereim.de), starting with
+[Getting started](https://formdef.mauricereim.de/getting-started).
+
 ## License
 
 [MIT](https://github.com/maurice-rm/formdef/blob/main/LICENSE)

package/dist/index.d.cts

@@ -338,15 +338,16 @@ type ConfigParts = {
   formComponents: object;
   handle: unknown;
 };
-type NamesIn<TEntry> = TEntry extends string ? TEntry : TEntry extends {
+type NamesInEntries<TEntries, TSeen> = [TEntries] extends [TSeen] ? never : NamesIn<TEntries, TSeen | TEntries>;
+type NamesIn<TEntry, TSeen> = TEntry extends string ? TEntry : TEntry extends {
   layout: readonly (infer TNested)[];
-} ? NamesIn<TNested> : TEntry extends {
+} ? NamesInEntries<TNested, TSeen> : TEntry extends {
   row: readonly (infer TNested)[];
-} ? NamesIn<TNested> : never;
+} ? NamesInEntries<TNested, TSeen> : never;
 type UndescribedNames<TConfig> = TConfig extends {
   layout: readonly (infer TEntry)[];
   fields: infer TFields;
-} ? Exclude<NamesIn<TEntry>, keyof TFields> : never;
+} ? Exclude<NamesInEntries<TEntry, never>, keyof TFields> : never;
 type UndescribedName<TName extends string> = `formdef: the layout names "${TName}", which fields does not describe`;
 /**
  * Checks the root `layout` of a config written as `TConfig`, sections and rows included: a name
@@ -636,7 +637,7 @@ type FieldsForm = {
 };
 type ValuesOf<TForm extends FieldsForm> = TForm["state"]["values"];
 type FieldsParts<TWidgets, TFormComponents, TStructure, TForm> = OwnParts<TWidgets, TFormComponents, TStructure> & {
-  handle: TForm;
+  handle: NoInfer<TForm>;
 };
 /**
  * What {@link createRegistry} returns: TanStack's form hook for the registered widgets and form

package/dist/index.d.ts

@@ -338,15 +338,16 @@ type ConfigParts = {
   formComponents: object;
   handle: unknown;
 };
-type NamesIn<TEntry> = TEntry extends string ? TEntry : TEntry extends {
+type NamesInEntries<TEntries, TSeen> = [TEntries] extends [TSeen] ? never : NamesIn<TEntries, TSeen | TEntries>;
+type NamesIn<TEntry, TSeen> = TEntry extends string ? TEntry : TEntry extends {
   layout: readonly (infer TNested)[];
-} ? NamesIn<TNested> : TEntry extends {
+} ? NamesInEntries<TNested, TSeen> : TEntry extends {
   row: readonly (infer TNested)[];
-} ? NamesIn<TNested> : never;
+} ? NamesInEntries<TNested, TSeen> : never;
 type UndescribedNames<TConfig> = TConfig extends {
   layout: readonly (infer TEntry)[];
   fields: infer TFields;
-} ? Exclude<NamesIn<TEntry>, keyof TFields> : never;
+} ? Exclude<NamesInEntries<TEntry, never>, keyof TFields> : never;
 type UndescribedName<TName extends string> = `formdef: the layout names "${TName}", which fields does not describe`;
 /**
  * Checks the root `layout` of a config written as `TConfig`, sections and rows included: a name
@@ -636,7 +637,7 @@ type FieldsForm = {
 };
 type ValuesOf<TForm extends FieldsForm> = TForm["state"]["values"];
 type FieldsParts<TWidgets, TFormComponents, TStructure, TForm> = OwnParts<TWidgets, TFormComponents, TStructure> & {
-  handle: TForm;
+  handle: NoInfer<TForm>;
 };
 /**
  * What {@link createRegistry} returns: TanStack's form hook for the registered widgets and form

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@formdef/core",
-  "version": "0.1.0",
+  "version": "0.1.2",
   "description": "Describe a form once as a typed object, render it as a React component, with the compiler checking that every widget fits its value. Built on TanStack Form.",
   "keywords": [
     "react",
@@ -14,7 +14,7 @@
   ],
   "license": "MIT",
   "author": "Maurice Reim",
-  "homepage": "https://github.com/maurice-rm/formdef#readme",
+  "homepage": "https://formdef.mauricereim.de",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/maurice-rm/formdef.git",