@amp-labs/react 2.4.3 → 2.4.5

package/build/index.d.ts

@@ -1,8 +1,6 @@
 import { Config } from '../../generated-sources/api/src';
 import { Connection } from '../../generated-sources/api/src';
 import { default as default_2 } from 'react';
-import { HydratedIntegrationFieldExistent } from '../../generated-sources/api/src';
-import { IntegrationFieldMapping } from '../../generated-sources/api/src';
 import { JSX as JSX_2 } from 'react/jsx-runtime';
 
 export declare const AmpersandContext: default_2.Context<null>;
@@ -56,27 +54,35 @@ declare interface ConnectProviderProps {
     onDisconnectSuccess?: (connection: Connection) => void;
 }
 
-export declare function FieldMapping({ field, onSelectChange, allFields }: FieldMappingProps): JSX_2.Element;
-
-declare type FieldMapping_2 = {
-    [key: string]: Array<FieldMappingWithMappedValues>;
+/**
+ * A map of object names to FieldMappingEntry arrays, with each FieldMappingEntry representing a field.
+ */
+export declare type FieldMapping = {
+    [key: string]: Array<FieldMappingEntry>;
 };
 
-declare interface FieldMappingProps {
-    field: IntegrationFieldMapping;
-    onSelectChange: (e: React.ChangeEvent<HTMLSelectElement>) => void;
-    allFields: HydratedIntegrationFieldExistent[];
-}
-
-declare type FieldMappingWithMappedValues = IntegrationFieldMapping & {
+export declare type FieldMappingEntry = {
     /**
-     * The name of the field to map from the source
+     * The name of the field in your application.
      */
-    fieldName?: string;
+    mapToName: string;
+    /**
+     * Optional display name of the field to show the user in the mapping UI.
+     */
+    mapToDisplayName?: string;
     /**
-     * The app-specific values to map provider API values to
+     * Optional prompt to show the user in the mapping UI.
+     */
+    prompt?: string;
+    /**
+     * If you would like the user to map a set of possible values,
+     * this is the list of possible values of the field in your application.
      */
     mappedValues?: MappedValue[];
+    /**
+     * The name of the field in SaaS provider, if present, then we will not prompt the user to map the field.
+     */
+    fieldName?: string;
 };
 
 export declare function InstallIntegration({ integration, consumerRef, consumerName, groupRef, groupName, onInstallSuccess, onUpdateSuccess, onUninstallSuccess, fieldMapping, }: InstallIntegrationProps): JSX_2.Element;
@@ -106,7 +112,7 @@ declare interface InstallIntegrationProps {
      * Dynamic field mappings that need to be filled out by a consumer.
      * @experimental
      */
-    fieldMapping?: FieldMapping_2;
+    fieldMapping?: FieldMapping;
     onInstallSuccess?: (installationId: string, config: Config) => void;
     onUpdateSuccess?: (installationId: string, config: Config) => void;
     onUninstallSuccess?: (installationId: string) => void;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@amp-labs/react",
-  "version": "2.4.3",
+  "version": "2.4.5",
   "description": "Ampersand React library.",
   "author": {
     "name": "Ampersand Labs",