@amp-labs/react 2.8.7 → 2.9.0

package/build/index.d.ts

@@ -88,6 +88,12 @@ declare interface BaseProxyConfig {
      * @memberof BaseProxyConfig
      */
     enabled?: boolean;
+    /**
+     * Default is false. If this is set to true, the base URL for the proxy action will be the module's base URL. Otherwise, it is assumed that the base URL is the provider's root base URL.
+     * @type {boolean}
+     * @memberof BaseProxyConfig
+     */
+    useModule?: boolean;
 }
 
 /**
@@ -267,6 +273,12 @@ export declare interface ConfigContent {
      * @memberof ConfigContent
      */
     provider: string;
+    /**
+     * The SaaS module that we are integrating with.
+     * @type {string}
+     * @memberof ConfigContent
+     */
+    module?: string;
     /**
      *
      * @type {ReadConfig}
@@ -714,7 +726,7 @@ export declare type FieldMappingEntry = {
 };
 
 /**
- *
+ * Metadata about a field. Please note that different providers have different levels of support for field metadata. Please reach out to support@withampersand.com if need expanded support for a particular provider.
  * @export
  * @interface FieldMetadata
  */
@@ -955,6 +967,12 @@ declare interface HydratedIntegration {
      * @memberof HydratedIntegration
      */
     displayName?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof HydratedIntegration
+     */
+    module?: string;
     /**
      *
      * @type {string}
@@ -1143,6 +1161,12 @@ declare interface HydratedIntegrationProxy {
      * @memberof HydratedIntegrationProxy
      */
     enabled?: boolean;
+    /**
+     * Default is false. If this is set to true, the base URL for the proxy action will be the module's base URL. Otherwise, it is assumed that the base URL is the provider's root base URL.
+     * @type {boolean}
+     * @memberof HydratedIntegrationProxy
+     */
+    useModule?: boolean;
 }
 
 /**
@@ -1688,13 +1712,13 @@ declare interface ReadConfigObject {
      * @type {string}
      * @memberof ReadConfigObject
      */
-    schedule: string;
+    schedule?: string;
     /**
      * The name of the destination that the result should be sent to.
      * @type {string}
      * @memberof ReadConfigObject
      */
-    destination: string;
+    destination?: string;
     /**
      * This is a map of field names to booleans indicating whether they should be read. If a field is already included in `selectedFieldMappings`, it does not need to be included here.
      * @type {{ [key: string]: boolean; }}
@@ -1831,6 +1855,12 @@ export declare interface UpdateInstallationConfigContent {
      * @memberof UpdateInstallationConfigContent
      */
     provider?: string;
+    /**
+     * The SaaS module that we are integrating with.
+     * @type {string}
+     * @memberof UpdateInstallationConfigContent
+     */
+    module?: string;
     /**
      *
      * @type {BaseReadConfig}
@@ -1853,6 +1883,11 @@ export declare interface UpdateInstallationConfigContent {
 
 export declare function useAmpersandProviderProps(): AmpersandContextValue;
 
+/**
+ * Legacy hook for backwards compatibility (use useLocalConfig instead)
+ * @deprecated
+ * @returns
+ */
 export declare function useConfig(): {
     draft: Partial<ConfigContent>;
     get: () => Partial<ConfigContent>;
@@ -1949,297 +1984,320 @@ declare interface UseIsIntegrationInstalledResult {
 }
 
 /**
- *  useManifest retrieves data from `amp.yaml` file, plus the customer's SaaS instance.
- * @returns Manifest object
- *
- * if object is not found, returns null for the object, getRequiredFields, getOptionalFields,
- *  getCustomerFieldsForObject.
- *
- */
-export declare function useManifest(): {
-    isPending: boolean;
-    isFetching: boolean;
-    isError: boolean;
-    isSuccess: boolean;
-    error: Error | null;
-    getReadObject: (objectName: string) => {
-        object: HydratedIntegrationObject | null;
-        getRequiredFields: () => HydratedIntegrationField[] | null;
-        getOptionalFields: () => HydratedIntegrationField[] | null;
-    };
-    getWriteObject: (objectName: string) => {
-        object: HydratedIntegrationWriteObject | null;
-    };
-    getCustomerFieldsForObject: (objectName: string) => {
-        allFields: {
-            [key: string]: FieldMetadata;
-        } | null;
-        getField: (field: string) => FieldMetadata | null;
-    };
-    data: HydratedRevision | undefined;
-};
-
-/**
- * update installation hook
- * @returns {Object} An object containing:
- *   - `updateInstallation` (function): A function to update the installation.
- *   - `isIdle` (boolean): Whether the mutation is idle.
- *   - `isPending` (boolean): Whether the mutation is pending.
- *   - `error` (Error | null): The error object, if any.
- *   - `errorMsg` (string | null): The error message, if any.
- */
-export declare function useUpdateInstallation(): {
-    updateInstallation: ({ config, onSuccess, onError, onSettled, }: {
-        config: InstallationConfigContent;
-        onSuccess?: (data: Installation) => void;
-        onError?: (error: Error) => void;
-        onSettled?: () => void;
-    }) => void;
-    isIdle: boolean;
-    isPending: boolean;
-    error: Error | null;
-    errorMsg: string | null;
-};
-
-/**
- * @type ValueDefault
- *
- * @export
- */
-declare type ValueDefault = ValueDefaultBoolean | ValueDefaultInteger | ValueDefaultString;
-
-/**
- * Ampersand public API
- * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
- *
- * The version of the OpenAPI document: 1.0.0
- *
- *
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
- * https://openapi-generator.tech
- * Do not edit the class manually.
- */
-/**
- *
- * @export
- * @interface ValueDefaultBoolean
- */
-declare interface ValueDefaultBoolean {
-    /**
-     * The value to be used as a default.
-     * @type {boolean}
-     * @memberof ValueDefaultBoolean
-     */
-    value: boolean;
-    /**
-     * Whether the default value should be applied when updating a record.
-     * If set to `always`, the default value will be applied when updating a record.
-     * If set to `never`, the default value will not be applied when updating a record,
-     * only when creating a record.
-     * If unspecified, then `always` is assumed.
-     * @type {string}
-     * @memberof ValueDefaultBoolean
-     */
-    applyOnUpdate?: ValueDefaultBooleanApplyOnUpdateEnum;
-}
-
-/**
- * @export
- */
-declare const ValueDefaultBooleanApplyOnUpdateEnum: {
-    readonly Always: "always";
-    readonly Never: "never";
-};
-
-declare type ValueDefaultBooleanApplyOnUpdateEnum = typeof ValueDefaultBooleanApplyOnUpdateEnum[keyof typeof ValueDefaultBooleanApplyOnUpdateEnum];
-
-/**
- * Ampersand public API
- * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
- *
- * The version of the OpenAPI document: 1.0.0
- *
- *
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
- * https://openapi-generator.tech
- * Do not edit the class manually.
- */
-/**
- *
- * @export
- * @interface ValueDefaultInteger
- */
-declare interface ValueDefaultInteger {
-    /**
-     * The value to be used as a default.
-     * @type {number}
-     * @memberof ValueDefaultInteger
-     */
-    value: number;
-    /**
-     * Whether the default value should be applied when updating a record.
-     * If set to `always`, the default value will be applied when updating a record.
-     * If set to `never`, the default value will not be applied when updating a record,
-     * only when creating a record.
-     * If unspecified, then `always` is assumed.
-     * @type {string}
-     * @memberof ValueDefaultInteger
-     */
-    applyOnUpdate?: ValueDefaultIntegerApplyOnUpdateEnum;
-}
-
-/**
- * @export
- */
-declare const ValueDefaultIntegerApplyOnUpdateEnum: {
-    readonly Always: "always";
-    readonly Never: "never";
-};
-
-declare type ValueDefaultIntegerApplyOnUpdateEnum = typeof ValueDefaultIntegerApplyOnUpdateEnum[keyof typeof ValueDefaultIntegerApplyOnUpdateEnum];
-
-/**
- * Ampersand public API
- * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
- *
- * The version of the OpenAPI document: 1.0.0
- *
- *
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
- * https://openapi-generator.tech
- * Do not edit the class manually.
- */
-/**
- * Configuration to set default write values for object fields.
- * @export
- * @interface ValueDefaults
- */
-declare interface ValueDefaults {
-    /**
-     * If true, users can set default values for any field.
-     * @type {boolean}
-     * @memberof ValueDefaults
-     */
-    allowAnyFields?: boolean;
-}
-
-/**
- * Ampersand public API
- * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
- *
- * The version of the OpenAPI document: 1.0.0
- *
- *
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
- * https://openapi-generator.tech
- * Do not edit the class manually.
- */
-/**
- *
- * @export
- * @interface ValueDefaultString
- */
-declare interface ValueDefaultString {
-    /**
-     * The value to be used as a default.
-     * @type {string}
-     * @memberof ValueDefaultString
-     */
-    value: string;
-    /**
-     * Whether the default value should be applied when updating a record.
-     * If set to `always`, the default value will be applied when updating a record.
-     * If set to `never`, the default value will not be applied when updating a record,
-     * only when creating a record.
-     * If unspecified, then `always` is assumed.
-     * @type {string}
-     * @memberof ValueDefaultString
-     */
-    applyOnUpdate?: ValueDefaultStringApplyOnUpdateEnum;
-}
-
-/**
- * @export
- */
-declare const ValueDefaultStringApplyOnUpdateEnum: {
-    readonly Always: "always";
-    readonly Never: "never";
-};
-
-declare type ValueDefaultStringApplyOnUpdateEnum = typeof ValueDefaultStringApplyOnUpdateEnum[keyof typeof ValueDefaultStringApplyOnUpdateEnum];
-
-/**
- *
- * @export
- * @interface WriteConfig
- */
-declare interface WriteConfig {
-    /**
-     *
-     * @type {{ [key: string]: WriteConfigObject; }}
-     * @memberof WriteConfig
-     */
-    objects?: {
-        [key: string]: WriteConfigObject;
-    };
-}
-
-/**
- *
- * @export
- * @interface WriteConfigObject
- */
-declare interface WriteConfigObject {
-    /**
-     * The name of the object to write to.
-     * @type {string}
-     * @memberof WriteConfigObject
-     */
-    objectName: string;
-    /**
-     * This is a map of field names to default values. These values will be used when writing to the object.
-     * @type {{ [key: string]: ValueDefault; }}
-     * @memberof WriteConfigObject
-     * @deprecated
-     */
-    selectedValueDefaults?: {
-        [key: string]: ValueDefault;
-    };
-    /**
-     * This is a map of field names to their settings.
-     * @type {{ [key: string]: FieldSetting; }}
-     * @memberof WriteConfigObject
-     */
-    selectedFieldSettings?: {
-        [key: string]: FieldSetting;
-    };
-}
-
-export declare type WriteObjectHandlers = {
-    object: BaseWriteConfigObject | undefined;
-    setEnableWrite: () => void;
-    setDisableWrite: () => void;
-    getWriteObject: () => BaseWriteConfigObject | undefined;
-    getSelectedFieldSettings: (fieldName: string) => FieldSetting | undefined;
-    setSelectedFieldSettings: (params: {
-        fieldName: string;
-        settings: FieldSetting;
-    }) => void;
-    getDefaultValues: (fieldName: string) => FieldSettingDefault | undefined;
-    setDefaultValues: (params: {
-        fieldName: string;
-        value: FieldSettingDefault;
-    }) => void;
-    getWriteOnCreateSetting: (fieldName: string) => FieldSettingWriteOnCreateEnum | undefined;
-    setWriteOnCreateSetting: (params: {
-        fieldName: string;
-        value: FieldSettingWriteOnCreateEnum;
-    }) => void;
-    getWriteOnUpdateSetting: (fieldName: string) => FieldSettingWriteOnUpdateEnum | undefined;
-    setWriteOnUpdateSetting: (params: {
-        fieldName: string;
-        value: FieldSettingWriteOnUpdateEnum;
-    }) => void;
-};
-
-export { }
+ * useLocalConfig is used to manage a local draft state of the config
+ * It's used to manage the config state with getters, setters, and resetters.
+ * @returns {
+     *  draft: InstallationConfigContent;
+     *  get: () => InstallationConfigContent;
+     *  reset: () => void;
+     *  setDraft: (draft: InstallationConfigContent) => void;
+     *  readObject: (objectName: string) => BaseReadConfigObject | undefined;
+     *  writeObject: (objectName: string) => BaseWriteConfigObject | undefined;
+     *  proxy: () => ProxyHandlers;
+     * }
+     */
+ export declare function useLocalConfig(): {
+     draft: Partial<ConfigContent>;
+     get: () => Partial<ConfigContent>;
+     reset: () => void;
+     setDraft: Dispatch<SetStateAction<Partial<ConfigContent>>>;
+     readObject: (objectName: string) => ReadObjectHandlers;
+     writeObject: (objectName: string) => WriteObjectHandlers;
+     proxy: () => ProxyHandlers;
+ };
+
+ /**
+  *  useManifest retrieves data from `amp.yaml` file, plus the customer's SaaS instance.
+  * @returns Manifest object
+  *
+  * if object is not found, returns null for the object, getRequiredFields, getOptionalFields,
+  *  getCustomerFieldsForObject.
+  *
+  */
+ export declare function useManifest(): {
+     isPending: boolean;
+     isFetching: boolean;
+     isError: boolean;
+     isSuccess: boolean;
+     error: Error | null;
+     getReadObject: (objectName: string) => {
+         object: HydratedIntegrationObject | null;
+         getRequiredFields: () => HydratedIntegrationField[] | null;
+         getOptionalFields: () => HydratedIntegrationField[] | null;
+     };
+     getWriteObject: (objectName: string) => {
+         object: HydratedIntegrationWriteObject | null;
+     };
+     getCustomerFieldsForObject: (objectName: string) => {
+         allFields: {
+             [key: string]: FieldMetadata;
+         } | null;
+         getField: (field: string) => FieldMetadata | null;
+     };
+     data: HydratedRevision | undefined;
+ };
+
+ /**
+  * update installation hook
+  * @returns {Object} An object containing:
+  *   - `updateInstallation` (function): A function to update the installation.
+  *   - `isIdle` (boolean): Whether the mutation is idle.
+  *   - `isPending` (boolean): Whether the mutation is pending.
+  *   - `error` (Error | null): The error object, if any.
+  *   - `errorMsg` (string | null): The error message, if any.
+  */
+ export declare function useUpdateInstallation(): {
+     updateInstallation: ({ config, onSuccess, onError, onSettled, }: {
+         config: InstallationConfigContent;
+         onSuccess?: (data: Installation) => void;
+         onError?: (error: Error) => void;
+         onSettled?: () => void;
+     }) => void;
+     isIdle: boolean;
+     isPending: boolean;
+     error: Error | null;
+     errorMsg: string | null;
+ };
+
+ /**
+  * @type ValueDefault
+  *
+  * @export
+  */
+ declare type ValueDefault = ValueDefaultBoolean | ValueDefaultInteger | ValueDefaultString;
+
+ /**
+  * Ampersand public API
+  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+  *
+  * The version of the OpenAPI document: 1.0.0
+  *
+  *
+  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+  * https://openapi-generator.tech
+  * Do not edit the class manually.
+  */
+ /**
+  *
+  * @export
+  * @interface ValueDefaultBoolean
+  */
+ declare interface ValueDefaultBoolean {
+     /**
+      * The value to be used as a default.
+      * @type {boolean}
+      * @memberof ValueDefaultBoolean
+      */
+     value: boolean;
+     /**
+      * Whether the default value should be applied when updating a record.
+      * If set to `always`, the default value will be applied when updating a record.
+      * If set to `never`, the default value will not be applied when updating a record,
+      * only when creating a record.
+      * If unspecified, then `always` is assumed.
+      * @type {string}
+      * @memberof ValueDefaultBoolean
+      */
+     applyOnUpdate?: ValueDefaultBooleanApplyOnUpdateEnum;
+ }
+
+ /**
+  * @export
+  */
+ declare const ValueDefaultBooleanApplyOnUpdateEnum: {
+     readonly Always: "always";
+     readonly Never: "never";
+ };
+
+ declare type ValueDefaultBooleanApplyOnUpdateEnum = typeof ValueDefaultBooleanApplyOnUpdateEnum[keyof typeof ValueDefaultBooleanApplyOnUpdateEnum];
+
+ /**
+  * Ampersand public API
+  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+  *
+  * The version of the OpenAPI document: 1.0.0
+  *
+  *
+  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+  * https://openapi-generator.tech
+  * Do not edit the class manually.
+  */
+ /**
+  *
+  * @export
+  * @interface ValueDefaultInteger
+  */
+ declare interface ValueDefaultInteger {
+     /**
+      * The value to be used as a default.
+      * @type {number}
+      * @memberof ValueDefaultInteger
+      */
+     value: number;
+     /**
+      * Whether the default value should be applied when updating a record.
+      * If set to `always`, the default value will be applied when updating a record.
+      * If set to `never`, the default value will not be applied when updating a record,
+      * only when creating a record.
+      * If unspecified, then `always` is assumed.
+      * @type {string}
+      * @memberof ValueDefaultInteger
+      */
+     applyOnUpdate?: ValueDefaultIntegerApplyOnUpdateEnum;
+ }
+
+ /**
+  * @export
+  */
+ declare const ValueDefaultIntegerApplyOnUpdateEnum: {
+     readonly Always: "always";
+     readonly Never: "never";
+ };
+
+ declare type ValueDefaultIntegerApplyOnUpdateEnum = typeof ValueDefaultIntegerApplyOnUpdateEnum[keyof typeof ValueDefaultIntegerApplyOnUpdateEnum];
+
+ /**
+  * Ampersand public API
+  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+  *
+  * The version of the OpenAPI document: 1.0.0
+  *
+  *
+  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+  * https://openapi-generator.tech
+  * Do not edit the class manually.
+  */
+ /**
+  * Configuration to set default write values for object fields.
+  * @export
+  * @interface ValueDefaults
+  */
+ declare interface ValueDefaults {
+     /**
+      * If true, users can set default values for any field.
+      * @type {boolean}
+      * @memberof ValueDefaults
+      */
+     allowAnyFields?: boolean;
+ }
+
+ /**
+  * Ampersand public API
+  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+  *
+  * The version of the OpenAPI document: 1.0.0
+  *
+  *
+  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+  * https://openapi-generator.tech
+  * Do not edit the class manually.
+  */
+ /**
+  *
+  * @export
+  * @interface ValueDefaultString
+  */
+ declare interface ValueDefaultString {
+     /**
+      * The value to be used as a default.
+      * @type {string}
+      * @memberof ValueDefaultString
+      */
+     value: string;
+     /**
+      * Whether the default value should be applied when updating a record.
+      * If set to `always`, the default value will be applied when updating a record.
+      * If set to `never`, the default value will not be applied when updating a record,
+      * only when creating a record.
+      * If unspecified, then `always` is assumed.
+      * @type {string}
+      * @memberof ValueDefaultString
+      */
+     applyOnUpdate?: ValueDefaultStringApplyOnUpdateEnum;
+ }
+
+ /**
+  * @export
+  */
+ declare const ValueDefaultStringApplyOnUpdateEnum: {
+     readonly Always: "always";
+     readonly Never: "never";
+ };
+
+ declare type ValueDefaultStringApplyOnUpdateEnum = typeof ValueDefaultStringApplyOnUpdateEnum[keyof typeof ValueDefaultStringApplyOnUpdateEnum];
+
+ /**
+  *
+  * @export
+  * @interface WriteConfig
+  */
+ declare interface WriteConfig {
+     /**
+      *
+      * @type {{ [key: string]: WriteConfigObject; }}
+      * @memberof WriteConfig
+      */
+     objects?: {
+         [key: string]: WriteConfigObject;
+     };
+ }
+
+ /**
+  *
+  * @export
+  * @interface WriteConfigObject
+  */
+ declare interface WriteConfigObject {
+     /**
+      * The name of the object to write to.
+      * @type {string}
+      * @memberof WriteConfigObject
+      */
+     objectName: string;
+     /**
+      * This is a map of field names to default values. These values will be used when writing to the object.
+      * @type {{ [key: string]: ValueDefault; }}
+      * @memberof WriteConfigObject
+      * @deprecated
+      */
+     selectedValueDefaults?: {
+         [key: string]: ValueDefault;
+     };
+     /**
+      * This is a map of field names to their settings.
+      * @type {{ [key: string]: FieldSetting; }}
+      * @memberof WriteConfigObject
+      */
+     selectedFieldSettings?: {
+         [key: string]: FieldSetting;
+     };
+ }
+
+ export declare type WriteObjectHandlers = {
+     object: BaseWriteConfigObject | undefined;
+     setEnableWrite: () => void;
+     setDisableWrite: () => void;
+     getWriteObject: () => BaseWriteConfigObject | undefined;
+     getSelectedFieldSettings: (fieldName: string) => FieldSetting | undefined;
+     setSelectedFieldSettings: (params: {
+         fieldName: string;
+         settings: FieldSetting;
+     }) => void;
+     getDefaultValues: (fieldName: string) => FieldSettingDefault | undefined;
+     setDefaultValues: (params: {
+         fieldName: string;
+         value: FieldSettingDefault;
+     }) => void;
+     getWriteOnCreateSetting: (fieldName: string) => FieldSettingWriteOnCreateEnum | undefined;
+     setWriteOnCreateSetting: (params: {
+         fieldName: string;
+         value: FieldSettingWriteOnCreateEnum;
+     }) => void;
+     getWriteOnUpdateSetting: (fieldName: string) => FieldSettingWriteOnUpdateEnum | undefined;
+     setWriteOnUpdateSetting: (params: {
+         fieldName: string;
+         value: FieldSettingWriteOnUpdateEnum;
+     }) => void;
+ };
+
+ export { }