@osdk/react-components 0.44.0 → 0.44.1-main-fd00f48adf2cf8cfc916d9ecb942bd3795ef7931

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @osdk/react-components
 
+## 0.44.1-main-fd00f48adf2cf8cfc916d9ecb942bd3795ef7931
+
+### Patch Changes
+
+- 5d63ff0: Add an `ActionFormOverview.md` one-pager (usage, an `ActionFormProps` props reference, a `Style API` token summary, and an Advanced section covering `BaseForm`) rendered by the Storybook ActionForm Docs page.
+
 ## 0.44.0
 
 ### Minor Changes

package/build/browser/action-form/ActionFormApi.js.map

@@ -1 +1 @@
-{"version":3,"file":"ActionFormApi.js","names":[],"sources":["ActionFormApi.ts"],"sourcesContent":["/*\n * Copyright 2025 Palantir Technologies, Inc. All rights reserved.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport type {\n  ActionDefinition,\n  ActionEditResponse,\n  ActionValidationResponse,\n} from \"@osdk/api\";\nimport type { ActionValidationError } from \"@osdk/client\";\n\nimport type {\n  ActionParameters,\n  FieldKey,\n  FieldValueType,\n  FormFieldDefinition,\n  RendererFieldDefinition,\n} from \"./FormFieldApi.js\";\n\n/**\n * Props for the ActionForm component.\n *\n * A discriminated union ensures that controlled mode (formState provided)\n * always requires onFormStateChange, and uncontrolled mode makes `onFormStateChange` optional\n */\nexport type ActionFormProps<Q extends ActionDefinition<unknown>> =\n  | (ActionFormConfigProps<Q> & {\n      /**\n       * Current form values (controlled mode). Provide together with\n       * `onFormStateChange`; omit both for uncontrolled mode.\n       */\n      formState: FormState<Q>;\n      /**\n       * Called with a state updater whenever a field value changes. Required\n       * in controlled mode.\n       */\n      onFormStateChange: (\n        updater: (prevState: FormState<Q>) => FormState<Q>,\n      ) => void;\n    })\n  | (ActionFormConfigProps<Q> & {\n      formState?: undefined;\n      onFormStateChange?: (\n        updater: (prevState: FormState<Q>) => FormState<Q>,\n      ) => void;\n    });\n\ninterface ActionFormConfigProps<\n  Q extends ActionDefinition<unknown>,\n> extends Pick<BaseFormProps, \"formTitle\" | \"isSubmitDisabled\"> {\n  actionDefinition: Q;\n\n  /**\n   * Whether to show the form title.\n   *\n   * @default false\n   */\n  showFormTitle?: boolean;\n\n  /**\n   * If not supplied, field definitions are constructed from `ActionParameters`.\n   */\n  formFieldDefinitions?: ReadonlyArray<FormFieldDefinition<Q>>;\n\n  /**\n   * If supplied, this will override the default submit action.\n   * By default, the action's applyAction will be called.\n   *\n   * @param formState all field values when onSubmit is called\n   * @param applyAction the function to execute the action\n   * @returns a promise of the submission response\n   */\n  onSubmit?: (\n    formState: FormState<Q>,\n    applyAction: (\n      args: ActionParameters<Q>,\n    ) => Promise<ActionEditResponse | undefined>,\n  ) => Promise<unknown> | void;\n\n  /**\n   * Called when the validation response is returned from a validateOnly submission\n   *\n   * @param results the validation response\n   */\n  onValidationResponse?: (results: ActionValidationResponse) => void;\n\n  /**\n   * Called when the action is successfully executed from a non-validateOnly submission\n   *\n   * @param results the submission response\n   */\n  onSuccess?: (results: ActionEditResponse | undefined) => void;\n\n  /**\n   * Called when there is an error in form submission\n   *\n   * @param error the error that occurred\n   */\n  onError?: (error: FormError) => void;\n}\n\n/**\n * Form values mapping parameter names to their values\n */\nexport type FormState<Q extends ActionDefinition<unknown>> = {\n  [K in FieldKey<Q>]?: FieldValueType<Q, K>;\n};\n\n/**\n * Form error discriminated union\n */\nexport type FormError =\n  | { type: \"validation\"; error: ActionValidationError }\n  | { type: \"submission\"; error: unknown }\n  | { type: \"unknown\"; error: unknown };\n\n/**\n * A single item in the form content array — either a standalone field\n * or a section that groups multiple fields.\n */\nexport type FormContentItem =\n  | { type: \"field\"; definition: RendererFieldDefinition }\n  | { type: \"section\"; key: string; definition: FormSectionDefinition };\n\n/**\n * Configuration for a form section — a visual group of fields with\n * optional title bar, collapse behavior, and multi-column layout.\n */\nexport interface FormSectionDefinition {\n  title: string;\n  description?: string;\n  fields: ReadonlyArray<RendererFieldDefinition>;\n  /** Whether the section starts collapsed. Default `false`. */\n  collapsedByDefault?: boolean;\n  /** Whether to show the title bar. Default `true`. */\n  showTitleBar?: boolean;\n  /** Number of columns for fields. Default `1`. */\n  columnCount?: 1 | 2;\n  /** Visual style. `\"box\"` = bordered card, `\"minimal\"` = heading only. Default `\"box\"`. */\n  style?: \"box\" | \"minimal\";\n}\n\n/**\n * Props for the `BaseForm` component, which renders a form without\n * OSDK data fetching.\n *\n * Uses a discriminated union so that controlled mode (`formState` provided)\n * always requires `onFieldValueChange`, and uncontrolled mode omits both.\n * `onSubmit` receives the current form state so callers can access values\n * even in uncontrolled mode.\n */\nexport type BaseFormProps = BaseFormCommonProps &\n  (\n    | {\n        formState: Record<string, unknown>;\n        onFieldValueChange: (fieldKey: string, value: unknown) => void;\n      }\n    | {\n        formState?: undefined;\n        onFieldValueChange?: (fieldKey: string, value: unknown) => void;\n      }\n  );\n\ninterface BaseFormCommonProps {\n  formTitle?: string;\n  formContent: ReadonlyArray<FormContentItem>;\n  onSubmit: (formState: Record<string, unknown>) => Promise<void> | void;\n  isSubmitDisabled?: boolean;\n  isPending?: boolean;\n  isLoading?: boolean;\n  className?: string;\n  /** Label for the submit button. Default `\"Submit\"`. */\n  submitButtonText?: string;\n  /** Visual variant of the submit button. Default `\"primary\"`. */\n  submitButtonVariant?: \"primary\" | \"secondary\";\n}\n"],"mappings":"","ignoreList":[]}
+{"version":3,"file":"ActionFormApi.js","names":[],"sources":["ActionFormApi.ts"],"sourcesContent":["/*\n * Copyright 2025 Palantir Technologies, Inc. All rights reserved.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport type {\n  ActionDefinition,\n  ActionEditResponse,\n  ActionValidationResponse,\n} from \"@osdk/api\";\nimport type { ActionValidationError } from \"@osdk/client\";\n\nimport type {\n  ActionParameters,\n  FieldKey,\n  FieldValueType,\n  FormFieldDefinition,\n  RendererFieldDefinition,\n} from \"./FormFieldApi.js\";\n\n/**\n * Props for the ActionForm component.\n *\n * A discriminated union ensures that controlled mode (formState provided)\n * always requires onFormStateChange, and uncontrolled mode makes `onFormStateChange` optional\n */\nexport type ActionFormProps<Q extends ActionDefinition<unknown>> =\n  | (ActionFormConfigProps<Q> & {\n      /**\n       * The current form values.\n       * If provided, the form state is controlled.\n       */\n      formState: FormState<Q>;\n      /**\n       * Called when a field value changes, with a state updater.\n       * Required when the form state is controlled; also fires in\n       * uncontrolled mode so callers can observe changes.\n       */\n      onFormStateChange: (\n        updater: (prevState: FormState<Q>) => FormState<Q>,\n      ) => void;\n    })\n  | (ActionFormConfigProps<Q> & {\n      formState?: undefined;\n      onFormStateChange?: (\n        updater: (prevState: FormState<Q>) => FormState<Q>,\n      ) => void;\n    });\n\ninterface ActionFormConfigProps<\n  Q extends ActionDefinition<unknown>,\n> extends Pick<BaseFormProps, \"formTitle\" | \"isSubmitDisabled\"> {\n  /**\n   * The OSDK action definition. Its parameters drive the rendered fields\n   * and the submission.\n   */\n  actionDefinition: Q;\n\n  /**\n   * Whether to show the form title.\n   *\n   * @default false\n   */\n  showFormTitle?: boolean;\n\n  /**\n   * If not supplied, field definitions are constructed from `ActionParameters`.\n   */\n  formFieldDefinitions?: ReadonlyArray<FormFieldDefinition<Q>>;\n\n  /**\n   * If supplied, this will override the default submit action.\n   * By default, the action's applyAction will be called.\n   *\n   * @param formState all field values when onSubmit is called\n   * @param applyAction the function to execute the action\n   * @returns a promise of the submission response\n   */\n  onSubmit?: (\n    formState: FormState<Q>,\n    applyAction: (\n      args: ActionParameters<Q>,\n    ) => Promise<ActionEditResponse | undefined>,\n  ) => Promise<unknown> | void;\n\n  /**\n   * Called when the validation response is returned from a validateOnly submission\n   *\n   * @param results the validation response\n   */\n  onValidationResponse?: (results: ActionValidationResponse) => void;\n\n  /**\n   * Called when the action is successfully executed from a non-validateOnly submission\n   *\n   * @param results the submission response\n   */\n  onSuccess?: (results: ActionEditResponse | undefined) => void;\n\n  /**\n   * Called when there is an error in form submission\n   *\n   * @param error the error that occurred\n   */\n  onError?: (error: FormError) => void;\n}\n\n/**\n * Form values mapping parameter names to their values\n */\nexport type FormState<Q extends ActionDefinition<unknown>> = {\n  [K in FieldKey<Q>]?: FieldValueType<Q, K>;\n};\n\n/**\n * Form error discriminated union\n */\nexport type FormError =\n  | { type: \"validation\"; error: ActionValidationError }\n  | { type: \"submission\"; error: unknown }\n  | { type: \"unknown\"; error: unknown };\n\n/**\n * A single item in the form content array — either a standalone field\n * or a section that groups multiple fields.\n */\nexport type FormContentItem =\n  | { type: \"field\"; definition: RendererFieldDefinition }\n  | { type: \"section\"; key: string; definition: FormSectionDefinition };\n\n/**\n * Configuration for a form section — a visual group of fields with\n * optional title bar, collapse behavior, and multi-column layout.\n */\nexport interface FormSectionDefinition {\n  title: string;\n  description?: string;\n  fields: ReadonlyArray<RendererFieldDefinition>;\n  /** Whether the section starts collapsed. Default `false`. */\n  collapsedByDefault?: boolean;\n  /** Whether to show the title bar. Default `true`. */\n  showTitleBar?: boolean;\n  /** Number of columns for fields. Default `1`. */\n  columnCount?: 1 | 2;\n  /** Visual style. `\"box\"` = bordered card, `\"minimal\"` = heading only. Default `\"box\"`. */\n  style?: \"box\" | \"minimal\";\n}\n\n/**\n * Props for the `BaseForm` component, which renders a form without\n * OSDK data fetching.\n *\n * Uses a discriminated union so that controlled mode (`formState` provided)\n * always requires `onFieldValueChange`; uncontrolled mode omits `formState`\n * (`onFieldValueChange` stays optional).\n * `onSubmit` receives the current form state so callers can access values\n * even in uncontrolled mode.\n */\nexport type BaseFormProps = BaseFormCommonProps &\n  (\n    | {\n        /**\n         * The current field values keyed by field key.\n         * If provided, the form state is controlled.\n         */\n        formState: Record<string, unknown>;\n        /**\n         * Called when a field value changes.\n         * Required when the form state is controlled; also fires in\n         * uncontrolled mode so callers can observe changes.\n         */\n        onFieldValueChange: (fieldKey: string, value: unknown) => void;\n      }\n    | {\n        formState?: undefined;\n        onFieldValueChange?: (fieldKey: string, value: unknown) => void;\n      }\n  );\n\ninterface BaseFormCommonProps {\n  /** Title shown in the form header. Omit to hide the header. */\n  formTitle?: string;\n  /** The fields and sections to render, in order. */\n  formContent: ReadonlyArray<FormContentItem>;\n  /** Called when the form is submitted with valid values. Receives the current form state. */\n  onSubmit: (formState: Record<string, unknown>) => Promise<void> | void;\n  /** Whether the submit button is disabled. Default `false`. */\n  isSubmitDisabled?: boolean;\n  /** Whether a submission is in progress. Shows the submit button in a pending state. Default `false`. */\n  isPending?: boolean;\n  /** Whether the form is loading its fields. Shows a skeleton placeholder. Default `false`. */\n  isLoading?: boolean;\n  /** Additional CSS class name for the root element. */\n  className?: string;\n  /** Label for the submit button. Default `\"Submit\"`. */\n  submitButtonText?: string;\n  /** Visual variant of the submit button. Default `\"primary\"`. */\n  submitButtonVariant?: \"primary\" | \"secondary\";\n}\n"],"mappings":"","ignoreList":[]}

package/build/browser/util/UserAgent.js

@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-const PACKAGE_USER_AGENT = `osdk-react-components/${"0.44.0"}`;
+const PACKAGE_USER_AGENT = `osdk-react-components/${"0.44.1-main-fd00f48adf2cf8cfc916d9ecb942bd3795ef7931"}`;
 export function componentUserAgent(componentName) {
   return `${PACKAGE_USER_AGENT}/${componentName}`;
 }

package/build/browser/util/UserAgent.js.map

@@ -1 +1 @@
-{"version":3,"file":"UserAgent.js","names":["PACKAGE_USER_AGENT","componentUserAgent","componentName"],"sources":["UserAgent.ts"],"sourcesContent":["/*\n * Copyright 2025 Palantir Technologies, Inc. All rights reserved.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nconst PACKAGE_USER_AGENT = `osdk-react-components/${process.env.PACKAGE_VERSION}`;\n\nexport function componentUserAgent(componentName: string): string {\n  return `${PACKAGE_USER_AGENT}/${componentName}`;\n}\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAEA,MAAMA,kBAAkB,GAAG,mCAAsD;AAEjF,OAAO,SAASC,kBAAkBA,CAACC,aAAqB,EAAU;EAChE,OAAO,GAAGF,kBAAkB,IAAIE,aAAa,EAAE;AACjD","ignoreList":[]}
+{"version":3,"file":"UserAgent.js","names":["PACKAGE_USER_AGENT","componentUserAgent","componentName"],"sources":["UserAgent.ts"],"sourcesContent":["/*\n * Copyright 2025 Palantir Technologies, Inc. All rights reserved.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nconst PACKAGE_USER_AGENT = `osdk-react-components/${process.env.PACKAGE_VERSION}`;\n\nexport function componentUserAgent(componentName: string): string {\n  return `${PACKAGE_USER_AGENT}/${componentName}`;\n}\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAEA,MAAMA,kBAAkB,GAAG,iFAAsD;AAEjF,OAAO,SAASC,kBAAkBA,CAACC,aAAqB,EAAU;EAChE,OAAO,GAAGF,kBAAkB,IAAIE,aAAa,EAAE;AACjD","ignoreList":[]}

package/build/cjs/chunk-4T5AHE5X.cjs

@@ -0,0 +1,11 @@
+'use strict';
+
+var chunkRVZE7LPI_cjs = require('./chunk-RVZE7LPI.cjs');
+var chunkXNLGPGCH_cjs = require('./chunk-XNLGPGCH.cjs');
+
+// src/public/experimental/xml-viewer.ts
+var XmlViewer2 = chunkXNLGPGCH_cjs.withOsdkMetrics(chunkRVZE7LPI_cjs.XmlViewer, "XmlViewer");
+
+exports.XmlViewer = XmlViewer2;
+//# sourceMappingURL=chunk-4T5AHE5X.cjs.map
+//# sourceMappingURL=chunk-4T5AHE5X.cjs.map

package/build/cjs/{chunk-YLXJJD54.cjs.map → chunk-4T5AHE5X.cjs.map}

@@ -1 +1 @@
-{"version":3,"sources":["../../src/public/experimental/xml-viewer.ts"],"names":["XmlViewer","withOsdkMetrics"],"mappings":";;;;;;AAqBO,IAAMA,UAAAA,GAAYC,iCAAA,CAAgBD,2BAAA,EAAY,WAAW","file":"chunk-YLXJJD54.cjs","sourcesContent":["/*\n * Copyright 2026 Palantir Technologies, Inc. All rights reserved.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\n// BaseXmlViewer\nexport { BaseXmlViewer } from \"../../xml-viewer/BaseXmlViewer.js\";\n// XmlViewer (Media wrapper)\nimport { withOsdkMetrics } from \"../../util/withOsdkMetrics.js\";\nimport { XmlViewer as _XmlViewer } from \"../../xml-viewer/XmlViewer.js\";\nexport const XmlViewer = withOsdkMetrics(_XmlViewer, \"XmlViewer\");"]}
+{"version":3,"sources":["../../src/public/experimental/xml-viewer.ts"],"names":["XmlViewer","withOsdkMetrics"],"mappings":";;;;;;AAqBO,IAAMA,UAAAA,GAAYC,iCAAA,CAAgBD,2BAAA,EAAY,WAAW","file":"chunk-4T5AHE5X.cjs","sourcesContent":["/*\n * Copyright 2026 Palantir Technologies, Inc. All rights reserved.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\n// BaseXmlViewer\nexport { BaseXmlViewer } from \"../../xml-viewer/BaseXmlViewer.js\";\n// XmlViewer (Media wrapper)\nimport { withOsdkMetrics } from \"../../util/withOsdkMetrics.js\";\nimport { XmlViewer as _XmlViewer } from \"../../xml-viewer/XmlViewer.js\";\nexport const XmlViewer = withOsdkMetrics(_XmlViewer, \"XmlViewer\");"]}

package/build/cjs/{chunk-D7BAQUGI.cjs → chunk-524WG5UI.cjs}

@@ -6,7 +6,7 @@ var chunk3KMJ6NKF_cjs = require('./chunk-3KMJ6NKF.cjs');
 var chunkYE4F6HIR_cjs = require('./chunk-YE4F6HIR.cjs');
 var chunk7LXS66DW_cjs = require('./chunk-7LXS66DW.cjs');
 var chunkUCTQICPR_cjs = require('./chunk-UCTQICPR.cjs');
-var chunkN45BQ26H_cjs = require('./chunk-N45BQ26H.cjs');
+var chunkXNLGPGCH_cjs = require('./chunk-XNLGPGCH.cjs');
 var button = require('@base-ui/react/button');
 var classnames3 = require('classnames');
 var React15 = require('react');
@@ -5577,7 +5577,7 @@ function summarizeFilterValue(definition, state) {
 }
 
 // src/public/experimental/filter-list.ts
-var FilterList2 = chunkN45BQ26H_cjs.withOsdkMetrics(FilterList, "FilterList");
+var FilterList2 = chunkXNLGPGCH_cjs.withOsdkMetrics(FilterList, "FilterList");
 
 exports.BaseFilterList = BaseFilterList;
 exports.FilterInput = FilterInput;
@@ -5592,5 +5592,5 @@ exports.narrowObjectSet = narrowObjectSet;
 exports.serializeFilterStates = serializeFilterStates;
 exports.summarizeFilterValue = summarizeFilterValue;
 exports.useFilterListState = useFilterListState;
-//# sourceMappingURL=chunk-D7BAQUGI.cjs.map
-//# sourceMappingURL=chunk-D7BAQUGI.cjs.map
+//# sourceMappingURL=chunk-524WG5UI.cjs.map
+//# sourceMappingURL=chunk-524WG5UI.cjs.map