@amp-labs/react 2.7.13 → 2.8.0

package/build/index.d.ts

@@ -2,7 +2,6 @@ import { default as default_2 } from 'react';
 import { Dispatch } from 'react';
 import { JSX as JSX_2 } from 'react/jsx-runtime';
 import { SetStateAction } from 'react';
-import { UseQueryResult } from '@tanstack/react-query';
 
 export declare const AmpersandContext: default_2.Context<null>;
 
@@ -78,12 +77,28 @@ declare interface BaseProxyConfig {
     enabled?: boolean;
 }
 
+/**
+ *
+ * @export
+ * @interface BaseReadConfig
+ */
+declare interface BaseReadConfig {
+    /**
+     * This is a map of object names to their configuration.
+     * @type {{ [key: string]: BaseReadConfigObject; }}
+     * @memberof BaseReadConfig
+     */
+    objects?: {
+        [key: string]: BaseReadConfigObject;
+    };
+}
+
 /**
  *
  * @export
  * @interface BaseReadConfigObject
  */
-declare interface BaseReadConfigObject {
+export declare interface BaseReadConfigObject {
     /**
      * The name of the object to read from.
      * @type {string}
@@ -142,12 +157,28 @@ declare interface BaseReadConfigObject {
     backfill?: BackfillConfig;
 }
 
+/**
+ *
+ * @export
+ * @interface BaseWriteConfig
+ */
+declare interface BaseWriteConfig {
+    /**
+     * This is a map of object names to their configuration.
+     * @type {{ [key: string]: BaseWriteConfigObject; }}
+     * @memberof BaseWriteConfig
+     */
+    objects?: {
+        [key: string]: BaseWriteConfigObject;
+    };
+}
+
 /**
  *
  * @export
  * @interface BaseWriteConfigObject
  */
-declare interface BaseWriteConfigObject {
+export declare interface BaseWriteConfigObject {
     /**
      * The name of the object to write to.
      * @type {string}
@@ -216,7 +247,7 @@ export declare interface Config {
  * @export
  * @interface ConfigContent
  */
-declare interface ConfigContent {
+export declare interface ConfigContent {
     /**
      * The SaaS API that we are integrating with.
      * @type {string}
@@ -671,7 +702,7 @@ export declare type FieldMappingEntry = {
  * @export
  * @interface FieldMetadata
  */
-declare interface FieldMetadata {
+export declare interface FieldMetadata {
     /**
      * The name of the field from the provider API.
      * @type {string}
@@ -732,7 +763,7 @@ declare type FieldMetadataValueTypeEnum = typeof FieldMetadataValueTypeEnum[keyo
  * @export
  * @interface FieldSetting
  */
-declare interface FieldSetting {
+export declare interface FieldSetting {
     /**
      *
      * @type {FieldSettingDefault}
@@ -769,7 +800,7 @@ declare interface FieldSetting {
  * @export
  * @interface FieldSettingDefault
  */
-declare interface FieldSettingDefault {
+export declare interface FieldSettingDefault {
     /**
      * The default string value to apply to a field
      * @type {string}
@@ -793,22 +824,22 @@ declare interface FieldSettingDefault {
 /**
  * @export
  */
-declare const FieldSettingWriteOnCreateEnum: {
+export declare const FieldSettingWriteOnCreateEnum: {
     readonly Always: "always";
     readonly Never: "never";
 };
 
-declare type FieldSettingWriteOnCreateEnum = typeof FieldSettingWriteOnCreateEnum[keyof typeof FieldSettingWriteOnCreateEnum];
+export declare type FieldSettingWriteOnCreateEnum = typeof FieldSettingWriteOnCreateEnum[keyof typeof FieldSettingWriteOnCreateEnum];
 
 /**
  * @export
  */
-declare const FieldSettingWriteOnUpdateEnum: {
+export declare const FieldSettingWriteOnUpdateEnum: {
     readonly Always: "always";
     readonly Never: "never";
 };
 
-declare type FieldSettingWriteOnUpdateEnum = typeof FieldSettingWriteOnUpdateEnum[keyof typeof FieldSettingWriteOnUpdateEnum];
+export declare type FieldSettingWriteOnUpdateEnum = typeof FieldSettingWriteOnUpdateEnum[keyof typeof FieldSettingWriteOnUpdateEnum];
 
 /**
  * Ampersand public API
@@ -939,7 +970,7 @@ declare interface HydratedIntegration {
  *
  * @export
  */
-declare type HydratedIntegrationField = HydratedIntegrationFieldExistent | IntegrationFieldMapping;
+export declare type HydratedIntegrationField = HydratedIntegrationFieldExistent | IntegrationFieldMapping;
 
 /**
  * Ampersand public API
@@ -989,7 +1020,7 @@ declare interface HydratedIntegrationFieldExistent {
  * @export
  * @interface HydratedIntegrationObject
  */
-declare interface HydratedIntegrationObject {
+export declare interface HydratedIntegrationObject {
     /**
      * Error message if there was an issue hydrating this object.
      * @type {string}
@@ -1156,7 +1187,7 @@ declare interface HydratedIntegrationWriteObject {
  * @export
  * @interface HydratedRevision
  */
-declare interface HydratedRevision {
+export declare interface HydratedRevision {
     /**
      * The revision ID.
      * @type {string}
@@ -1188,7 +1219,7 @@ declare interface HydratedRevision {
  * @export
  * @interface Installation
  */
-declare interface Installation {
+export declare interface Installation {
     /**
      * The installation ID.
      * @type {string}
@@ -1258,7 +1289,7 @@ declare interface Installation {
  */
 export declare type InstallationConfigContent = Partial<ConfigContent>;
 
-declare interface InstallationContextValue {
+export declare interface InstallationContextValue {
     integrationNameOrId: string;
     consumerRef: string;
     consumerName?: string;
@@ -1353,6 +1384,20 @@ declare interface IntegrationFieldMapping {
     prompt?: string;
 }
 
+export declare interface Manifest {
+    getReadObject: (objectName: string) => {
+        object: HydratedIntegrationObject | null;
+        getRequiredFields: () => HydratedIntegrationField[] | null;
+        getOptionalFields: () => HydratedIntegrationField[] | null;
+    };
+    getCustomerFieldsForObject: (objectName: string) => {
+        allFields: {
+            [key: string]: FieldMetadata;
+        } | null;
+        getField: (field: string) => FieldMetadata | null;
+    };
+}
+
 declare interface MappedValue {
     mappedValue: string;
     mappedDisplayValue: string;
@@ -1663,6 +1708,20 @@ declare interface ReadConfigObject {
     backfill?: BackfillConfig;
 }
 
+export declare type ReadObjectHandlers = {
+    object: BaseReadConfigObject | undefined;
+    getSelectedField: (fieldName: string) => boolean;
+    setSelectedField: (params: {
+        fieldName: string;
+        selected: boolean;
+    }) => void;
+    getFieldMapping: (fieldName: string) => string | undefined;
+    setFieldMapping: (params: {
+        fieldName: string;
+        mapToName: string;
+    }) => void;
+};
+
 /**
  * If selectedFieldsAuto is set to all, all fields will be read.
  * @export
@@ -1733,6 +1792,38 @@ declare interface SubscribeConfigObject {
     deleteEvent?: ConfigDeleteEvent;
 }
 
+/**
+ *
+ * @export
+ * @interface UpdateInstallationConfigContent
+ */
+export declare interface UpdateInstallationConfigContent {
+    /**
+     * The SaaS API that we are integrating with.
+     * @type {string}
+     * @memberof UpdateInstallationConfigContent
+     */
+    provider?: string;
+    /**
+     *
+     * @type {BaseReadConfig}
+     * @memberof UpdateInstallationConfigContent
+     */
+    read?: BaseReadConfig;
+    /**
+     *
+     * @type {BaseWriteConfig}
+     * @memberof UpdateInstallationConfigContent
+     */
+    write?: BaseWriteConfig;
+    /**
+     *
+     * @type {BaseProxyConfig}
+     * @memberof UpdateInstallationConfigContent
+     */
+    proxy?: BaseProxyConfig;
+}
+
 export declare function useAmpersandProvider(): never;
 
 export declare function useConfig(): {
@@ -1740,45 +1831,8 @@ export declare function useConfig(): {
     get: () => Partial<ConfigContent>;
     reset: () => void;
     setDraft: Dispatch<SetStateAction<Partial<ConfigContent>>>;
-    readObject: (objectName: string) => {
-        object: BaseReadConfigObject | undefined;
-        getSelectedField: (fieldName: string) => boolean;
-        setSelectedField: (params: {
-            fieldName: string;
-            selected: boolean;
-        }) => void;
-        getFieldMapping: (fieldName: string) => string | undefined;
-        setFieldMapping: (params: {
-            fieldName: string;
-            mapToName: string;
-        }) => void;
-    };
-    writeObject: (objectName: string) => {
-        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;
-    };
+    readObject: (objectName: string) => ReadObjectHandlers;
+    writeObject: (objectName: string) => WriteObjectHandlers;
 };
 
 /**
@@ -1837,12 +1891,6 @@ export declare function useDeleteInstallation(): {
     errorMsg: string | null;
 };
 
-/**
- * gets hydrated revision using headless hooks to fill in details
- * @returns
- */
-export declare const useHydratedRevisionQuery: () => UseQueryResult<HydratedRevision, Error>;
-
 /**
  * useInstallation hook
  * @returns {Object} An object containing:
@@ -1863,8 +1911,6 @@ export declare function useInstallation(): {
     error: Error | null;
 };
 
-export declare function useInstallationProps(): InstallationContextValue;
-
 export declare const useIsIntegrationInstalled: (integration: string, groupRef: string) => UseIsIntegrationInstalledResult;
 
 declare interface UseIsIntegrationInstalledResult {
@@ -1879,7 +1925,7 @@ declare interface UseIsIntegrationInstalledResult {
  * @returns Manifest object
  *
  * if object is not found, returns null for the object, getRequiredFields, getOptionalFields,
- *  getCustomerFieldsForObject, getCustomerFieldsMetadataForObject
+ *  getCustomerFieldsForObject.
  *
  */
 export declare function useManifest(): {
@@ -1893,9 +1939,8 @@ export declare function useManifest(): {
         getRequiredFields: () => HydratedIntegrationField[] | null;
         getOptionalFields: () => HydratedIntegrationField[] | null;
     };
-    getCustomerFieldsForObject: (objectName: string) => HydratedIntegrationField[] | null;
-    getCustomerFieldsMetadataForObject: (objectName: string) => {
-        allFieldsMetaData: {
+    getCustomerFieldsForObject: (objectName: string) => {
+        allFields: {
             [key: string]: FieldMetadata;
         } | null;
         getField: (field: string) => FieldMetadata | null;
@@ -2139,4 +2184,31 @@ declare interface WriteConfigObject {
     };
 }
 
+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 { }

package/package.json

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