Function form

packages/forms/signals/src/api/structure.ts:225–263

(...args: any[])

): FieldTree<TModel>;

export function form<TModel>(...args: any[]): FieldTree<TModel> {
  const [model, schema, options] = normalizeFormArgs<TModel>(args);
  const injector = options?.injector ?? inject(Injector);
  const pathNode = runInInjectionContext(injector, () => SchemaImpl.rootCompile(schema));
  const fieldManager = new FormFieldManager(
    injector,
    options?.name,
    options?.submission as FormSubmitOptions<unknown, unknown> | undefined,
  );
  const adapter = options?.adapter ?? new BasicFieldAdapter();
  const fieldRoot = FieldNode.newRoot(fieldManager, model, pathNode, adapter);
  fieldManager.createFieldManagementEffect(fieldRoot.structure);

  // Register a WebMCP tool for the form if configured.
  const {experimentalWebMcpTool} = options ?? {};
  if (experimentalWebMcpTool) {
    const registerWebMcpForm = runInInjectionContext(injector, () =>
      inject(REGISTER_WEBMCP_FORM, {optional: true}),
    );
    if (registerWebMcpForm) {
      runInInjectionContext(injector, () =>
        registerWebMcpForm(fieldRoot.fieldTree, {
          name: experimentalWebMcpTool.name,
          description: experimentalWebMcpTool.description,
          annotations: experimentalWebMcpTool.annotations,
        }),
      );
    } else {
      if (typeof ngDevMode !== 'undefined' && ngDevMode) {
        throw new Error(
          `Cannot register form "${experimentalWebMcpTool.name}" as a WebMCP tool. ` +
            `Make sure to use \`provideExperimentalWebMcpForms()\` in your application bootstrap configuration.`,
        );
      }
    }
  }

  return fieldRoot.fieldTree as FieldTree<TModel>;
}

/**
 * Applies a schema to each item of an array.