@trackunit/custom-field-api 0.0.1

package/src/generated/graphql-api/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./fragment-masking";
+export * from "./gql";

package/src/generated/graphql-api/mock.d.ts

@@ -0,0 +1,8 @@
+import { DeepPartialNullable } from "@trackunit/react-core-contexts-test";
+import * as gql from "../graphql-api/graphql";
+export declare const mockForGetCustomFieldsForAssetQuery: (variables: gql.GetCustomFieldsForAssetQueryVariables, data?: DeepPartialNullable<gql.GetCustomFieldsForAssetQuery>) => import("@apollo/client/testing").MockedResponse<gql.GetCustomFieldsForAssetQuery, Record<string, any>> & {
+    data: gql.GetCustomFieldsForAssetQuery;
+};
+export declare const mockForGetCustomFieldsForSiteQuery: (variables: gql.GetCustomFieldsForSiteQueryVariables, data?: DeepPartialNullable<gql.GetCustomFieldsForSiteQuery>) => import("@apollo/client/testing").MockedResponse<gql.GetCustomFieldsForSiteQuery, Record<string, any>> & {
+    data: gql.GetCustomFieldsForSiteQuery;
+};

package/src/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./useCustomFieldsValueAndDefinition";
+export { GetCustomFieldsForAssetDocument, type GetCustomFieldsForAssetQuery, type GetCustomFieldsForAssetQueryVariables, GetCustomFieldsForSiteDocument } from "./generated/graphql-api/graphql";

package/src/useCustomFieldsValueAndDefinition.d.ts

@@ -0,0 +1,33 @@
+import { CustomFieldValueAndDefinitionFragment, CustomFieldValueAndDefinitionFragmentDoc, SystemOfMeasurement } from "./generated/graphql-api/graphql";
+import { FragmentType } from "./generated/graphql-api/fragment-masking";
+import { EntityType } from "@trackunit/iris-app-api";
+export type CustomFieldValueAndDefinition = CustomFieldValueAndDefinitionFragment;
+export type SupportedEntityTypes = Extract<EntityType, "ASSET" | "SITE">;
+type CustomFieldValueAndDefinitionNode = FragmentType<typeof CustomFieldValueAndDefinitionFragmentDoc>;
+/**
+ * A function used to get the CustomFieldValueAndDefinition from a node of CustomFieldValueAndDefinition.
+ *
+ * @param node - The node containing the CustomFieldValueAndDefinition, which may be null or undefined.
+ * @returns {CustomFieldValueAndDefinitionNode} The CustomFieldValueAndDefinition if it exists, or undefined otherwise.
+ */
+export declare const getCustomFieldValueAndDefinitionFromRelevantNode: (node?: CustomFieldValueAndDefinitionNode | null) => CustomFieldValueAndDefinitionFragment | null | undefined;
+export interface UseCustomFieldsValueAndDefinitionProps {
+    entityId?: string;
+    entityType?: SupportedEntityTypes;
+    systemOfMeasurement: SystemOfMeasurement;
+}
+export interface UseCustomFieldsValueAndDefinitionReturnValue {
+    loading: boolean;
+    fields: CustomFieldValueAndDefinition[];
+}
+/**
+ * Custom hook to fetch custom fields and definitions for a specified entity.
+ *
+ * @param {UseCustomFieldsValueAndDefinitionProps} props - The properties for the custom fields query.
+ * @param {string} [props.entityId] - The ID of the entity for which custom fields are fetched. Can be either an asset or a site.
+ * @param {SupportedEntityTypes} [props.entityType] - The type of the entity (e.g., 'ASSET' or 'SITE'). Determines which query to execute.
+ * @param {SystemOfMeasurement} props.systemOfMeasurement - The system of measurement to be used in the custom fields.
+ * @returns {UseCustomFieldsValueAndDefinitionReturnValue} An object containing a loading state and an array of custom fields and definitions.
+ */
+export declare const useCustomFieldsValueAndDefinition: ({ entityId, entityType, systemOfMeasurement }: UseCustomFieldsValueAndDefinitionProps) => UseCustomFieldsValueAndDefinitionReturnValue;
+export {};