@bigbinary/neeto-fields-frontend 1.0.4 → 1.0.6

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bigbinary/neeto-fields-frontend",
-  "version": "1.0.4",
+  "version": "1.0.6",
   "description": "A repo acts as the source of truth for the new nano's structure, configs, data etc.",
   "license": "UNLICENSED",
   "homepage": "https://github.com/bigbinary/neeto-fields-nano",

package/types.d.ts

@@ -1,6 +1,11 @@
 import React from "react";
 
-import { UseQueryResult, UseQueryOptions } from "react-query";
+import {
+  UseQueryResult,
+  UseMutationResult,
+  UseQueryOptions,
+  UseMutationOptions,
+} from "react-query";
 
 interface KeyValuePair {
   [key: string]: any;
@@ -9,13 +14,14 @@ interface KeyValuePair {
 interface PaneProps {
   children: React.ReactNode;
   validations?: KeyValuePair;
+  initialValues?: KeyValuePair;
+  hideRequiredSwitch?: boolean;
 }
 
 type OnDeleteClickFunction = (field: KeyValuePair) => void;
 
 type OnEditClickFunction = (field: KeyValuePair) => void;
 
-
 interface FieldsDashboardProps {
   rowData?: any[];
   showOwnersInMenu?: boolean;
@@ -42,7 +48,9 @@ interface AddFieldProps {
   resourceType: string;
   allowedKinds?: string[];
   additionalValidations?: KeyValuePair;
+  initialValues?: KeyValuePair;
   children?: React.ReactNode;
+  hideRequiredSwitch?: boolean;
 }
 
 interface EditProps {
@@ -51,6 +59,8 @@ interface EditProps {
   onClose: (values: any) => void;
   children?: React.ReactNode;
   additionalValidations?: KeyValuePair;
+  initialValues?: KeyValuePair;
+  hideRequiredSwitch?: boolean;
 }
 
 interface AddProps {
@@ -59,6 +69,8 @@ interface AddProps {
   onClose: () => void;
   children?: React.ReactNode;
   additionalValidations?: KeyValuePair;
+  initialValues?: KeyValuePair;
+  hideRequiredSwitch?: boolean;
 }
 interface FieldsPaneProps {
   allowedKinds: string[];
@@ -66,14 +78,17 @@ interface FieldsPaneProps {
   resourceType: string;
   onClose: () => void;
   additionalValidations?: KeyValuePair;
+  initialValues?: KeyValuePair;
   selectedField?: KeyValuePair;
   children?: React.ReactNode;
+  hideRequiredSwitch?: boolean;
 }
 interface FieldFormProps {
   chosenKind: string[];
   kindSelectOptions: KeyValuePair[];
   children?: React.ReactNode;
   isSystem?: boolean;
+  hideRequiredSwitch?: boolean;
 }
 
 interface FieldValuesContainerProps {
@@ -84,23 +99,62 @@ interface FieldValuesContainerProps {
   queryKeysToBeInvalidatedOnSuccess?: string[];
   customComponents?: KeyValuePair;
   className?: string;
+  showBorder?: boolean;
+  formRefs?: React.RefObject<any>
+  disabled?: boolean;
+  isRequiredColumnName?: string;
 }
 
 interface FieldInputsProps {
   fields: KeyValuePair[];
   customComponents?: KeyValuePair;
+  formRef?: React.RefObject<any>
+  disabled?: boolean;
+  isRequiredColumnName?: string;
 }
 
-export const FieldsDashboard = React.FC<FieldsDashboardProps>;
-export const AddField = React.FC<AddFieldProps>;
-export const FieldValuesContainer = React.FC<FieldValuesContainerProps>;
-export const FieldInputs = React.FC<FieldInputsProps>;
+type FieldsParams = { resourceType?: string; ownerId?: string; state?: string, prefixQueryKeys?: string[] };
+
+type Field = {
+  fields: KeyValuePair[];
+  count: number;
+  activeFieldsCount: number;
+  inactiveFieldsCount: number;
+};
+
+type UseFetchFieldsResult = UseQueryResult<Field>;
+
+export const FieldsDashboard: React.FC<FieldsDashboardProps>;
+export const AddField: React.FC<AddFieldProps>;
+export const FieldValuesContainer: React.FC<FieldValuesContainerProps>;
+export const FieldInputs: React.FC<FieldInputsProps>;
+
+export const useFetchFields: (
+  params: FieldsParams,
+  options?: UseQueryOptions
+) => UseFetchFieldsResult;
+
+export const useShowField: (
+  fieldId: string,
+  options?: UseQueryOptions
+) => UseFetchFieldsResult;
+
+export const useCreateField: (
+  options?: UseMutationOptions
+) => UseMutationResult;
+
+export const useUpdateField: (
+  options?: UseMutationOptions
+) => UseMutationResult;
+
+export const useDestroyField: (
+  options?: UseMutationOptions
+) => UseMutationResult;
 
-export const useFetchFields: (options?: UseQueryOptions) => UseQueryResult;
 export const neetoFieldsUtils: {
-  transformValues: (values: KeyValuePair) => void;
-  mergeInitialValues: (args: {
-    initialValues: KeyValuePair;
+  transformValues: (values: KeyValuePair) => KeyValuePair;
+  mergeInitialValues: <T extends object>(args: {
+    initialValues: T;
     fields: KeyValuePair[];
-  }) => KeyValuePair;
+  }) => T & KeyValuePair;
 };