@dxos/react-ui-form 0.12.0-next-73daef452f1464b62efdbca75fb0067c1066f264 → 0.13.0

package/dist/lib/annotations.mjs

@@ -1,16 +1,18 @@
 import { createAnnotationHelper } from "@dxos/echo/internal";
+import { HueAnnotationId, StepAnnotationId } from "@dxos/ui-types";
 //#region src/annotations.ts
 var OptionsLookupAnnotationId = "@dxos/schema/annotation/OptionsLookup";
 var OptionsLookupAnnotation = createAnnotationHelper(OptionsLookupAnnotationId);
 /**
 * Builds an {@link OptionsLookup} typed against a schema's value type `Values`: `deps` is checked
 * against its field names, and `load` receives only those fields, narrowed. Pass `{ combobox: true }` to
-* render an editable combobox.
+* render an editable combobox, and `eager: true` to list the loaded options before anything is typed.
 */
 var optionsLookup = () => (deps, load, options) => ({
 	deps,
 	load,
-	combobox: options?.combobox
+	combobox: options?.combobox,
+	eager: options?.eager
 });
 var AutofillAnnotationId = "@dxos/schema/annotation/Autofill";
 var AutofillAnnotation = createAnnotationHelper(AutofillAnnotationId);
@@ -19,7 +21,14 @@ var autofill = () => (deps, derive) => ({
 	deps,
 	derive
 });
+/** Marks a field whose value is one of the theme's hues; the form renders the hue picker for it. */
+var HueAnnotation = createAnnotationHelper(HueAnnotationId);
+/**
+* Increment for a number field's stepper buttons and arrow keys. Without it an integer field steps by 1 and
+* any other by 0.1 or 0.01, by the size of its current value.
+*/
+var StepAnnotation = createAnnotationHelper(StepAnnotationId);
 //#endregion
-export { AutofillAnnotation, AutofillAnnotationId, OptionsLookupAnnotation, OptionsLookupAnnotationId, autofill, optionsLookup };
+export { AutofillAnnotation, AutofillAnnotationId, HueAnnotation, OptionsLookupAnnotation, OptionsLookupAnnotationId, StepAnnotation, autofill, optionsLookup };
 
 //# sourceMappingURL=annotations.mjs.map

package/dist/lib/annotations.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"annotations.mjs","names":[],"sources":["../../src/annotations.ts"],"sourcesContent":["//\n// Copyright 2025 DXOS.org\n//\n\nimport type * as Effect from 'effect/Effect';\n\nimport { createAnnotationHelper } from '@dxos/echo/internal';\n\n/** One selectable option produced by an {@link OptionsLookup}. */\nexport type OptionsLookupEntry = { value: string; label?: string; secondaryLabel?: string; icon?: string };\n\n/**\n * Loads a select field's options dynamically from a declared subset of the form values, so a select can\n * depend on a sibling field (e.g. publications for a typed handle). `deps` are the field names the loader\n * reads; the form re-runs it only when one of those values changes. The returned Effect must be\n * self-contained (`R = never`): it provides its own dependencies (network layer, etc.) in the closure.\n * Construct via {@link optionsLookup} for typed `deps`/`values`. Pass `{ combobox: true }` to render\n * an editable combobox (type-to-search) instead of a constrained select.\n */\nexport type OptionsLookup = {\n  readonly deps: readonly string[];\n  readonly load: (values: any) => Effect.Effect<readonly OptionsLookupEntry[], unknown>;\n  readonly combobox?: boolean;\n};\n\nexport const OptionsLookupAnnotationId = '@dxos/schema/annotation/OptionsLookup';\nexport const OptionsLookupAnnotation = createAnnotationHelper<OptionsLookup>(OptionsLookupAnnotationId);\n\n/**\n * Builds an {@link OptionsLookup} typed against a schema's value type `Values`: `deps` is checked\n * against its field names, and `load` receives only those fields, narrowed. Pass `{ combobox: true }` to\n * render an editable combobox.\n */\nexport const optionsLookup =\n  <Values>() =>\n  <const Deps extends readonly (keyof Values & string)[]>(\n    deps: Deps,\n    load: (values: Pick<Values, Deps[number]>) => Effect.Effect<readonly OptionsLookupEntry[], unknown>,\n    options?: { combobox?: boolean },\n  ): OptionsLookup => ({ deps, load, combobox: options?.combobox });\n\n/**\n * Derives a (text) field's value from a declared subset of the form values, so a field can be pre-filled\n * from a sibling (e.g. a feed name fetched from a typed URL). `deps` are the field names the derivation\n * reads; the form re-runs it only when one of those changes. The returned Effect must be self-contained\n * (`R = never`); `undefined` means \"no value to fill\". The form pre-fills only while the user has not\n * typed their own value, so a manual edit is never clobbered. Construct via {@link autofill}.\n */\nexport type Autofill = {\n  readonly deps: readonly string[];\n  readonly derive: (values: any) => Effect.Effect<string | undefined, unknown>;\n};\n\nexport const AutofillAnnotationId = '@dxos/schema/annotation/Autofill';\nexport const AutofillAnnotation = createAnnotationHelper<Autofill>(AutofillAnnotationId);\n\n/** Builds an {@link Autofill} typed against a schema's value type `Values` (see {@link optionsLookup}). */\nexport const autofill =\n  <Values>() =>\n  <const Deps extends readonly (keyof Values & string)[]>(\n    deps: Deps,\n    derive: (values: Pick<Values, Deps[number]>) => Effect.Effect<string | undefined, unknown>,\n  ): Autofill => ({ deps, derive });\n"],"mappings":";;AAyBA,IAAa,4BAA4B;AACzC,IAAa,0BAA0B,uBAAsC,yBAAyB;;;;;;AAOtG,IAAa,uBAGT,MACA,MACA,aACmB;CAAE;CAAM;CAAM,UAAU,SAAS;AAAS;AAcjE,IAAa,uBAAuB;AACpC,IAAa,qBAAqB,uBAAiC,oBAAoB;;AAGvF,IAAa,kBAGT,MACA,YACc;CAAE;CAAM;AAAO"}
+{"version":3,"file":"annotations.mjs","names":[],"sources":["../../src/annotations.ts"],"sourcesContent":["//\n// Copyright 2025 DXOS.org\n//\n\nimport type * as Effect from 'effect/Effect';\n\nimport { createAnnotationHelper } from '@dxos/echo/internal';\nimport { HueAnnotationId, StepAnnotationId } from '@dxos/ui-types';\n\n/** One selectable option produced by an {@link OptionsLookup}. */\nexport type OptionsLookupEntry = { value: string; label?: string; secondaryLabel?: string; icon?: string };\n\n/**\n * Loads a select field's options dynamically from a declared subset of the form values, so a select can\n * depend on a sibling field (e.g. publications for a typed handle). `deps` are the field names the loader\n * reads; the form re-runs it only when one of those values changes. The returned Effect must be\n * self-contained (`R = never`): it provides its own dependencies (network layer, etc.) in the closure.\n * Construct via {@link optionsLookup} for typed `deps`/`values`. Pass `{ combobox: true }` to render\n * an editable combobox (type-to-search) instead of a constrained select.\n */\nexport type OptionsLookup = {\n  readonly deps: readonly string[];\n  readonly load: (values: any) => Effect.Effect<readonly OptionsLookupEntry[], unknown>;\n  readonly combobox?: boolean;\n  /**\n   * List every loaded option before anything is typed (a combobox over a small, known catalogue —\n   * models, voices), rather than only once the query narrows a remote search.\n   */\n  readonly eager?: boolean;\n};\n\nexport const OptionsLookupAnnotationId = '@dxos/schema/annotation/OptionsLookup';\nexport const OptionsLookupAnnotation = createAnnotationHelper<OptionsLookup>(OptionsLookupAnnotationId);\n\n/**\n * Builds an {@link OptionsLookup} typed against a schema's value type `Values`: `deps` is checked\n * against its field names, and `load` receives only those fields, narrowed. Pass `{ combobox: true }` to\n * render an editable combobox, and `eager: true` to list the loaded options before anything is typed.\n */\nexport const optionsLookup =\n  <Values>() =>\n  <const Deps extends readonly (keyof Values & string)[]>(\n    deps: Deps,\n    load: (values: Pick<Values, Deps[number]>) => Effect.Effect<readonly OptionsLookupEntry[], unknown>,\n    options?: { combobox?: boolean; eager?: boolean },\n  ): OptionsLookup => ({ deps, load, combobox: options?.combobox, eager: options?.eager });\n\n/**\n * Derives a (text) field's value from a declared subset of the form values, so a field can be pre-filled\n * from a sibling (e.g. a feed name fetched from a typed URL). `deps` are the field names the derivation\n * reads; the form re-runs it only when one of those changes. The returned Effect must be self-contained\n * (`R = never`); `undefined` means \"no value to fill\". The form pre-fills only while the user has not\n * typed their own value, so a manual edit is never clobbered. Construct via {@link autofill}.\n */\nexport type Autofill = {\n  readonly deps: readonly string[];\n  readonly derive: (values: any) => Effect.Effect<string | undefined, unknown>;\n};\n\nexport const AutofillAnnotationId = '@dxos/schema/annotation/Autofill';\nexport const AutofillAnnotation = createAnnotationHelper<Autofill>(AutofillAnnotationId);\n\n/** Builds an {@link Autofill} typed against a schema's value type `Values` (see {@link optionsLookup}). */\nexport const autofill =\n  <Values>() =>\n  <const Deps extends readonly (keyof Values & string)[]>(\n    deps: Deps,\n    derive: (values: Pick<Values, Deps[number]>) => Effect.Effect<string | undefined, unknown>,\n  ): Autofill => ({ deps, derive });\n\n/** Marks a field whose value is one of the theme's hues; the form renders the hue picker for it. */\nexport const HueAnnotation = createAnnotationHelper<boolean>(HueAnnotationId);\n\n/**\n * Increment for a number field's stepper buttons and arrow keys. Without it an integer field steps by 1 and\n * any other by 0.1 or 0.01, by the size of its current value.\n */\nexport const StepAnnotation = createAnnotationHelper<number>(StepAnnotationId);\n"],"mappings":";;;AA+BA,IAAa,4BAA4B;AACzC,IAAa,0BAA0B,uBAAsC,yBAAyB;;;;;;AAOtG,IAAa,uBAGT,MACA,MACA,aACmB;CAAE;CAAM;CAAM,UAAU,SAAS;CAAU,OAAO,SAAS;AAAM;AAcxF,IAAa,uBAAuB;AACpC,IAAa,qBAAqB,uBAAiC,oBAAoB;;AAGvF,IAAa,kBAGT,MACA,YACc;CAAE;CAAM;AAAO;;AAGjC,IAAa,gBAAgB,uBAAgC,eAAe;;;;;AAM5E,IAAa,iBAAiB,uBAA+B,gBAAgB"}