@trackunit/custom-field-api 0.1.12 → 0.1.14

package/package.json

@@ -1,12 +1,23 @@
 {
   "name": "@trackunit/custom-field-api",
-  "version": "0.1.12",
+  "version": "0.1.14",
   "engines": {
     "node": ">=18.x"
   },
   "repository": "https://github.com/Trackunit/manager",
   "license": "SEE LICENSE IN LICENSE.txt",
-  "dependencies": {},
+  "dependencies": {
+    "@graphql-codegen/cli": "^5.0.0",
+    "@trackunit/iris-app-build-utilities": "*",
+    "@graphql-typed-document-node/core": "^3.2.0",
+    "graphql": "^15.8.0",
+    "@trackunit/iris-app-api": "*",
+    "@apollo/client": "^3.7.10",
+    "@trackunit/react-core-contexts-test": "*",
+    "react": "^18.2.0",
+    "@trackunit/shared-utils": "*",
+    "@trackunit/react-core-hooks": "*"
+  },
   "module": "./index.esm.js",
   "main": "./index.cjs.js"
 }

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

@@ -11,7 +11,7 @@ import { TypedDocumentNode as DocumentNode } from '@graphql-typed-document-node/
  * Therefore it is highly recommended to use the babel or swc plugin for production.
  */
 declare const documents: {
-    "query GetCustomFieldsForAsset($entityId: String!, $systemOfMeasurement: SystemOfMeasurement) {\n  asset(id: $entityId) {\n    customFields(systemOfMeasurement: $systemOfMeasurement) {\n      edges {\n        node {\n          ...CustomFieldValueAndDefinition\n        }\n      }\n    }\n  }\n}\n\nquery GetCustomFieldsForSite($entityId: ID!, $systemOfMeasurement: SystemOfMeasurement) {\n  site(id: $entityId) {\n    customFields(systemOfMeasurement: $systemOfMeasurement) {\n      edges {\n        node {\n          ...CustomFieldValueAndDefinition\n        }\n      }\n    }\n  }\n}\n\nfragment CustomFieldValueAndDefinition on CustomFieldValueAndDefinition {\n  __typename\n  type\n  definition {\n    definitionId\n    owner {\n      irisAppId\n      marketplaceEntry {\n        name\n      }\n    }\n    entityType\n    title\n    description\n    uiVisible\n    uiEditable\n    key\n  }\n  ... on BooleanFieldValueAndDefinition {\n    booleanValue\n  }\n  ... on DateFieldValueAndDefinition {\n    dateValue\n  }\n  ... on DropDownFieldValueAndDefinition {\n    stringArrayValue\n    definition {\n      allValues\n      multiSelect\n    }\n  }\n  ... on EmailFieldValueAndDefinition {\n    stringValue\n  }\n  ... on JsonFieldValueAndDefinition {\n    jsonValue\n  }\n  ... on NumberFieldValueAndDefinition {\n    numberValue\n    definition {\n      minimumNumber\n      maximumNumber\n      unitSi\n      unitUs\n      isInteger\n    }\n  }\n  ... on MonetaryFieldValueAndDefinition {\n    numberValue\n    definition {\n      minimumNumber\n      maximumNumber\n      currency\n    }\n  }\n  ... on PhoneNumberFieldValueAndDefinition {\n    stringValue\n  }\n  ... on StringFieldValueAndDefinition {\n    stringValue\n    definition {\n      maximumLength\n      minimumLength\n      pattern\n    }\n  }\n  ... on WebAddressFieldValueAndDefinition {\n    stringValue\n  }\n}": DocumentNode<types.GetCustomFieldsForAssetQuery, types.Exact<{
+    "query GetCustomFieldsForAsset($entityId: String!, $systemOfMeasurement: SystemOfMeasurement) {\n  asset(id: $entityId) {\n    customFields(systemOfMeasurement: $systemOfMeasurement) {\n      edges {\n        node {\n          ...CustomFieldValueAndDefinition\n        }\n      }\n    }\n  }\n}\n\nquery GetCustomFieldsForSite($entityId: ID!, $systemOfMeasurement: SystemOfMeasurement) {\n  site(id: $entityId) {\n    customFields(systemOfMeasurement: $systemOfMeasurement) {\n      edges {\n        node {\n          ...CustomFieldValueAndDefinition\n        }\n      }\n    }\n  }\n}\n\nfragment CustomFieldValueAndDefinition on CustomFieldValueAndDefinition {\n  __typename\n  type\n  definition {\n    definitionId\n    owner {\n      irisAppId\n      marketplaceEntry {\n        name\n      }\n    }\n    entityType\n    title\n    description\n    uiVisible\n    uiEditable\n    key\n  }\n  ... on BooleanFieldValueAndDefinition {\n    booleanValue\n  }\n  ... on DateFieldValueAndDefinition {\n    dateValue\n  }\n  ... on DropDownFieldValueAndDefinition {\n    stringArrayValue\n    definition {\n      allValues\n      multiSelect\n    }\n  }\n  ... on EmailFieldValueAndDefinition {\n    stringValue\n  }\n  ... on JsonFieldValueAndDefinition {\n    jsonValue\n  }\n  ... on NumberFieldValueAndDefinition {\n    numberValue\n    definition {\n      minimumNumber\n      maximumNumber\n      unitSi\n      unitUs\n      isInteger\n    }\n  }\n  ... on MonetaryFieldValueAndDefinition {\n    numberValue\n    definition {\n      minimumNumber\n      maximumNumber\n      currency\n    }\n  }\n  ... on PhoneNumberFieldValueAndDefinition {\n    stringValue\n  }\n  ... on StringFieldValueAndDefinition {\n    stringValue\n    definition {\n      maximumLength\n      minimumLength\n      pattern\n    }\n  }\n  ... on WebAddressFieldValueAndDefinition {\n    stringValue\n  }\n}\n\nquery GetCustomFieldDefinitions($entityType: CustomFieldEntityType = ASSET) {\n  customFieldDefinitions(uiVisible: true, first: 100, entityType: $entityType) {\n    edges {\n      node {\n        ...CustomFieldDefinition\n      }\n    }\n    pageInfo {\n      count\n      endCursor\n      hasNextPage\n      hasPreviousPage\n      startCursor\n    }\n  }\n}\n\nfragment CustomFieldDefinition on CustomFieldDefinition {\n  definitionId\n  translations {\n    description\n    title\n    language\n  }\n  owner {\n    ownerType\n  }\n  type\n}": DocumentNode<types.GetCustomFieldsForAssetQuery, types.Exact<{
         entityId: string;
         systemOfMeasurement?: types.InputMaybe<types.SystemOfMeasurement> | undefined;
     }>>;
@@ -32,6 +32,6 @@ export declare function graphql(source: string): unknown;
 /**
  * The graphql function is used to parse GraphQL queries into a document that can be used by GraphQL clients.
  */
-export declare function graphql(source: "query GetCustomFieldsForAsset($entityId: String!, $systemOfMeasurement: SystemOfMeasurement) {\n  asset(id: $entityId) {\n    customFields(systemOfMeasurement: $systemOfMeasurement) {\n      edges {\n        node {\n          ...CustomFieldValueAndDefinition\n        }\n      }\n    }\n  }\n}\n\nquery GetCustomFieldsForSite($entityId: ID!, $systemOfMeasurement: SystemOfMeasurement) {\n  site(id: $entityId) {\n    customFields(systemOfMeasurement: $systemOfMeasurement) {\n      edges {\n        node {\n          ...CustomFieldValueAndDefinition\n        }\n      }\n    }\n  }\n}\n\nfragment CustomFieldValueAndDefinition on CustomFieldValueAndDefinition {\n  __typename\n  type\n  definition {\n    definitionId\n    owner {\n      irisAppId\n      marketplaceEntry {\n        name\n      }\n    }\n    entityType\n    title\n    description\n    uiVisible\n    uiEditable\n    key\n  }\n  ... on BooleanFieldValueAndDefinition {\n    booleanValue\n  }\n  ... on DateFieldValueAndDefinition {\n    dateValue\n  }\n  ... on DropDownFieldValueAndDefinition {\n    stringArrayValue\n    definition {\n      allValues\n      multiSelect\n    }\n  }\n  ... on EmailFieldValueAndDefinition {\n    stringValue\n  }\n  ... on JsonFieldValueAndDefinition {\n    jsonValue\n  }\n  ... on NumberFieldValueAndDefinition {\n    numberValue\n    definition {\n      minimumNumber\n      maximumNumber\n      unitSi\n      unitUs\n      isInteger\n    }\n  }\n  ... on MonetaryFieldValueAndDefinition {\n    numberValue\n    definition {\n      minimumNumber\n      maximumNumber\n      currency\n    }\n  }\n  ... on PhoneNumberFieldValueAndDefinition {\n    stringValue\n  }\n  ... on StringFieldValueAndDefinition {\n    stringValue\n    definition {\n      maximumLength\n      minimumLength\n      pattern\n    }\n  }\n  ... on WebAddressFieldValueAndDefinition {\n    stringValue\n  }\n}"): (typeof documents)["query GetCustomFieldsForAsset($entityId: String!, $systemOfMeasurement: SystemOfMeasurement) {\n  asset(id: $entityId) {\n    customFields(systemOfMeasurement: $systemOfMeasurement) {\n      edges {\n        node {\n          ...CustomFieldValueAndDefinition\n        }\n      }\n    }\n  }\n}\n\nquery GetCustomFieldsForSite($entityId: ID!, $systemOfMeasurement: SystemOfMeasurement) {\n  site(id: $entityId) {\n    customFields(systemOfMeasurement: $systemOfMeasurement) {\n      edges {\n        node {\n          ...CustomFieldValueAndDefinition\n        }\n      }\n    }\n  }\n}\n\nfragment CustomFieldValueAndDefinition on CustomFieldValueAndDefinition {\n  __typename\n  type\n  definition {\n    definitionId\n    owner {\n      irisAppId\n      marketplaceEntry {\n        name\n      }\n    }\n    entityType\n    title\n    description\n    uiVisible\n    uiEditable\n    key\n  }\n  ... on BooleanFieldValueAndDefinition {\n    booleanValue\n  }\n  ... on DateFieldValueAndDefinition {\n    dateValue\n  }\n  ... on DropDownFieldValueAndDefinition {\n    stringArrayValue\n    definition {\n      allValues\n      multiSelect\n    }\n  }\n  ... on EmailFieldValueAndDefinition {\n    stringValue\n  }\n  ... on JsonFieldValueAndDefinition {\n    jsonValue\n  }\n  ... on NumberFieldValueAndDefinition {\n    numberValue\n    definition {\n      minimumNumber\n      maximumNumber\n      unitSi\n      unitUs\n      isInteger\n    }\n  }\n  ... on MonetaryFieldValueAndDefinition {\n    numberValue\n    definition {\n      minimumNumber\n      maximumNumber\n      currency\n    }\n  }\n  ... on PhoneNumberFieldValueAndDefinition {\n    stringValue\n  }\n  ... on StringFieldValueAndDefinition {\n    stringValue\n    definition {\n      maximumLength\n      minimumLength\n      pattern\n    }\n  }\n  ... on WebAddressFieldValueAndDefinition {\n    stringValue\n  }\n}"];
+export declare function graphql(source: "query GetCustomFieldsForAsset($entityId: String!, $systemOfMeasurement: SystemOfMeasurement) {\n  asset(id: $entityId) {\n    customFields(systemOfMeasurement: $systemOfMeasurement) {\n      edges {\n        node {\n          ...CustomFieldValueAndDefinition\n        }\n      }\n    }\n  }\n}\n\nquery GetCustomFieldsForSite($entityId: ID!, $systemOfMeasurement: SystemOfMeasurement) {\n  site(id: $entityId) {\n    customFields(systemOfMeasurement: $systemOfMeasurement) {\n      edges {\n        node {\n          ...CustomFieldValueAndDefinition\n        }\n      }\n    }\n  }\n}\n\nfragment CustomFieldValueAndDefinition on CustomFieldValueAndDefinition {\n  __typename\n  type\n  definition {\n    definitionId\n    owner {\n      irisAppId\n      marketplaceEntry {\n        name\n      }\n    }\n    entityType\n    title\n    description\n    uiVisible\n    uiEditable\n    key\n  }\n  ... on BooleanFieldValueAndDefinition {\n    booleanValue\n  }\n  ... on DateFieldValueAndDefinition {\n    dateValue\n  }\n  ... on DropDownFieldValueAndDefinition {\n    stringArrayValue\n    definition {\n      allValues\n      multiSelect\n    }\n  }\n  ... on EmailFieldValueAndDefinition {\n    stringValue\n  }\n  ... on JsonFieldValueAndDefinition {\n    jsonValue\n  }\n  ... on NumberFieldValueAndDefinition {\n    numberValue\n    definition {\n      minimumNumber\n      maximumNumber\n      unitSi\n      unitUs\n      isInteger\n    }\n  }\n  ... on MonetaryFieldValueAndDefinition {\n    numberValue\n    definition {\n      minimumNumber\n      maximumNumber\n      currency\n    }\n  }\n  ... on PhoneNumberFieldValueAndDefinition {\n    stringValue\n  }\n  ... on StringFieldValueAndDefinition {\n    stringValue\n    definition {\n      maximumLength\n      minimumLength\n      pattern\n    }\n  }\n  ... on WebAddressFieldValueAndDefinition {\n    stringValue\n  }\n}\n\nquery GetCustomFieldDefinitions($entityType: CustomFieldEntityType = ASSET) {\n  customFieldDefinitions(uiVisible: true, first: 100, entityType: $entityType) {\n    edges {\n      node {\n        ...CustomFieldDefinition\n      }\n    }\n    pageInfo {\n      count\n      endCursor\n      hasNextPage\n      hasPreviousPage\n      startCursor\n    }\n  }\n}\n\nfragment CustomFieldDefinition on CustomFieldDefinition {\n  definitionId\n  translations {\n    description\n    title\n    language\n  }\n  owner {\n    ownerType\n  }\n  type\n}"): (typeof documents)["query GetCustomFieldsForAsset($entityId: String!, $systemOfMeasurement: SystemOfMeasurement) {\n  asset(id: $entityId) {\n    customFields(systemOfMeasurement: $systemOfMeasurement) {\n      edges {\n        node {\n          ...CustomFieldValueAndDefinition\n        }\n      }\n    }\n  }\n}\n\nquery GetCustomFieldsForSite($entityId: ID!, $systemOfMeasurement: SystemOfMeasurement) {\n  site(id: $entityId) {\n    customFields(systemOfMeasurement: $systemOfMeasurement) {\n      edges {\n        node {\n          ...CustomFieldValueAndDefinition\n        }\n      }\n    }\n  }\n}\n\nfragment CustomFieldValueAndDefinition on CustomFieldValueAndDefinition {\n  __typename\n  type\n  definition {\n    definitionId\n    owner {\n      irisAppId\n      marketplaceEntry {\n        name\n      }\n    }\n    entityType\n    title\n    description\n    uiVisible\n    uiEditable\n    key\n  }\n  ... on BooleanFieldValueAndDefinition {\n    booleanValue\n  }\n  ... on DateFieldValueAndDefinition {\n    dateValue\n  }\n  ... on DropDownFieldValueAndDefinition {\n    stringArrayValue\n    definition {\n      allValues\n      multiSelect\n    }\n  }\n  ... on EmailFieldValueAndDefinition {\n    stringValue\n  }\n  ... on JsonFieldValueAndDefinition {\n    jsonValue\n  }\n  ... on NumberFieldValueAndDefinition {\n    numberValue\n    definition {\n      minimumNumber\n      maximumNumber\n      unitSi\n      unitUs\n      isInteger\n    }\n  }\n  ... on MonetaryFieldValueAndDefinition {\n    numberValue\n    definition {\n      minimumNumber\n      maximumNumber\n      currency\n    }\n  }\n  ... on PhoneNumberFieldValueAndDefinition {\n    stringValue\n  }\n  ... on StringFieldValueAndDefinition {\n    stringValue\n    definition {\n      maximumLength\n      minimumLength\n      pattern\n    }\n  }\n  ... on WebAddressFieldValueAndDefinition {\n    stringValue\n  }\n}\n\nquery GetCustomFieldDefinitions($entityType: CustomFieldEntityType = ASSET) {\n  customFieldDefinitions(uiVisible: true, first: 100, entityType: $entityType) {\n    edges {\n      node {\n        ...CustomFieldDefinition\n      }\n    }\n    pageInfo {\n      count\n      endCursor\n      hasNextPage\n      hasPreviousPage\n      startCursor\n    }\n  }\n}\n\nfragment CustomFieldDefinition on CustomFieldDefinition {\n  definitionId\n  translations {\n    description\n    title\n    language\n  }\n  owner {\n    ownerType\n  }\n  type\n}"];
 export type DocumentType<TDocumentNode extends DocumentNode<any, any>> = TDocumentNode extends DocumentNode<infer TType, any> ? TType : never;
 export {};

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

@@ -81,6 +81,12 @@ export declare const customFieldEntityType: {
     readonly Site: "SITE";
 };
 export type CustomFieldEntityType = (typeof customFieldEntityType)[keyof typeof customFieldEntityType];
+export declare const customFieldOwnerType: {
+    readonly Account: "ACCOUNT";
+    readonly IrisApp: "IRIS_APP";
+    readonly Trackunit: "TRACKUNIT";
+};
+export type CustomFieldOwnerType = (typeof customFieldOwnerType)[keyof typeof customFieldOwnerType];
 export declare const customFieldType: {
     readonly Boolean: "BOOLEAN";
     readonly Date: "DATE";
@@ -563,7 +569,260 @@ export type CustomFieldValueAndDefinition_WebAddressFieldValueAndDefinition_Frag
     " $fragmentName"?: "CustomFieldValueAndDefinition_WebAddressFieldValueAndDefinition_Fragment";
 };
 export type CustomFieldValueAndDefinitionFragment = CustomFieldValueAndDefinition_BooleanFieldValueAndDefinition_Fragment | CustomFieldValueAndDefinition_DateFieldValueAndDefinition_Fragment | CustomFieldValueAndDefinition_DropDownFieldValueAndDefinition_Fragment | CustomFieldValueAndDefinition_EmailFieldValueAndDefinition_Fragment | CustomFieldValueAndDefinition_JsonFieldValueAndDefinition_Fragment | CustomFieldValueAndDefinition_MonetaryFieldValueAndDefinition_Fragment | CustomFieldValueAndDefinition_NumberFieldValueAndDefinition_Fragment | CustomFieldValueAndDefinition_PhoneNumberFieldValueAndDefinition_Fragment | CustomFieldValueAndDefinition_StringFieldValueAndDefinition_Fragment | CustomFieldValueAndDefinition_WebAddressFieldValueAndDefinition_Fragment;
+export type GetCustomFieldDefinitionsQueryVariables = Exact<{
+    entityType?: InputMaybe<CustomFieldEntityType>;
+}>;
+export type GetCustomFieldDefinitionsQuery = {
+    __typename?: "Query";
+    customFieldDefinitions?: {
+        __typename?: "CustomFieldDefinitionConnection";
+        edges?: Array<{
+            __typename?: "CustomFieldDefinitionEdge";
+            node?: ({
+                __typename?: "BooleanFieldDefinition";
+            } & {
+                " $fragmentRefs"?: {
+                    CustomFieldDefinition_BooleanFieldDefinition_Fragment: CustomFieldDefinition_BooleanFieldDefinition_Fragment;
+                };
+            }) | ({
+                __typename?: "DateFieldDefinition";
+            } & {
+                " $fragmentRefs"?: {
+                    CustomFieldDefinition_DateFieldDefinition_Fragment: CustomFieldDefinition_DateFieldDefinition_Fragment;
+                };
+            }) | ({
+                __typename?: "DropDownFieldDefinition";
+            } & {
+                " $fragmentRefs"?: {
+                    CustomFieldDefinition_DropDownFieldDefinition_Fragment: CustomFieldDefinition_DropDownFieldDefinition_Fragment;
+                };
+            }) | ({
+                __typename?: "EmailFieldDefinition";
+            } & {
+                " $fragmentRefs"?: {
+                    CustomFieldDefinition_EmailFieldDefinition_Fragment: CustomFieldDefinition_EmailFieldDefinition_Fragment;
+                };
+            }) | ({
+                __typename?: "JsonFieldDefinition";
+            } & {
+                " $fragmentRefs"?: {
+                    CustomFieldDefinition_JsonFieldDefinition_Fragment: CustomFieldDefinition_JsonFieldDefinition_Fragment;
+                };
+            }) | ({
+                __typename?: "MonetaryFieldDefinition";
+            } & {
+                " $fragmentRefs"?: {
+                    CustomFieldDefinition_MonetaryFieldDefinition_Fragment: CustomFieldDefinition_MonetaryFieldDefinition_Fragment;
+                };
+            }) | ({
+                __typename?: "NumberFieldDefinition";
+            } & {
+                " $fragmentRefs"?: {
+                    CustomFieldDefinition_NumberFieldDefinition_Fragment: CustomFieldDefinition_NumberFieldDefinition_Fragment;
+                };
+            }) | ({
+                __typename?: "PhoneNumberFieldDefinition";
+            } & {
+                " $fragmentRefs"?: {
+                    CustomFieldDefinition_PhoneNumberFieldDefinition_Fragment: CustomFieldDefinition_PhoneNumberFieldDefinition_Fragment;
+                };
+            }) | ({
+                __typename?: "StringFieldDefinition";
+            } & {
+                " $fragmentRefs"?: {
+                    CustomFieldDefinition_StringFieldDefinition_Fragment: CustomFieldDefinition_StringFieldDefinition_Fragment;
+                };
+            }) | ({
+                __typename?: "WebAddressFieldDefinition";
+            } & {
+                " $fragmentRefs"?: {
+                    CustomFieldDefinition_WebAddressFieldDefinition_Fragment: CustomFieldDefinition_WebAddressFieldDefinition_Fragment;
+                };
+            }) | null;
+        } | null> | null;
+        pageInfo?: {
+            __typename?: "PageInfo";
+            count?: number | null;
+            endCursor?: string | null;
+            hasNextPage: boolean;
+            hasPreviousPage: boolean;
+            startCursor?: string | null;
+        } | null;
+    } | null;
+};
+export type CustomFieldDefinition_BooleanFieldDefinition_Fragment = {
+    __typename?: "BooleanFieldDefinition";
+    definitionId: string;
+    type: CustomFieldType;
+    translations?: Array<{
+        __typename?: "CustomFieldDefinitionTranslations";
+        description?: string | null;
+        title?: string | null;
+        language?: string | null;
+    } | null> | null;
+    owner?: {
+        __typename?: "CustomFieldOwner";
+        ownerType: CustomFieldOwnerType;
+    } | null;
+} & {
+    " $fragmentName"?: "CustomFieldDefinition_BooleanFieldDefinition_Fragment";
+};
+export type CustomFieldDefinition_DateFieldDefinition_Fragment = {
+    __typename?: "DateFieldDefinition";
+    definitionId: string;
+    type: CustomFieldType;
+    translations?: Array<{
+        __typename?: "CustomFieldDefinitionTranslations";
+        description?: string | null;
+        title?: string | null;
+        language?: string | null;
+    } | null> | null;
+    owner?: {
+        __typename?: "CustomFieldOwner";
+        ownerType: CustomFieldOwnerType;
+    } | null;
+} & {
+    " $fragmentName"?: "CustomFieldDefinition_DateFieldDefinition_Fragment";
+};
+export type CustomFieldDefinition_DropDownFieldDefinition_Fragment = {
+    __typename?: "DropDownFieldDefinition";
+    definitionId: string;
+    type: CustomFieldType;
+    translations?: Array<{
+        __typename?: "CustomFieldDefinitionTranslations";
+        description?: string | null;
+        title?: string | null;
+        language?: string | null;
+    } | null> | null;
+    owner?: {
+        __typename?: "CustomFieldOwner";
+        ownerType: CustomFieldOwnerType;
+    } | null;
+} & {
+    " $fragmentName"?: "CustomFieldDefinition_DropDownFieldDefinition_Fragment";
+};
+export type CustomFieldDefinition_EmailFieldDefinition_Fragment = {
+    __typename?: "EmailFieldDefinition";
+    definitionId: string;
+    type: CustomFieldType;
+    translations?: Array<{
+        __typename?: "CustomFieldDefinitionTranslations";
+        description?: string | null;
+        title?: string | null;
+        language?: string | null;
+    } | null> | null;
+    owner?: {
+        __typename?: "CustomFieldOwner";
+        ownerType: CustomFieldOwnerType;
+    } | null;
+} & {
+    " $fragmentName"?: "CustomFieldDefinition_EmailFieldDefinition_Fragment";
+};
+export type CustomFieldDefinition_JsonFieldDefinition_Fragment = {
+    __typename?: "JsonFieldDefinition";
+    definitionId: string;
+    type: CustomFieldType;
+    translations?: Array<{
+        __typename?: "CustomFieldDefinitionTranslations";
+        description?: string | null;
+        title?: string | null;
+        language?: string | null;
+    } | null> | null;
+    owner?: {
+        __typename?: "CustomFieldOwner";
+        ownerType: CustomFieldOwnerType;
+    } | null;
+} & {
+    " $fragmentName"?: "CustomFieldDefinition_JsonFieldDefinition_Fragment";
+};
+export type CustomFieldDefinition_MonetaryFieldDefinition_Fragment = {
+    __typename?: "MonetaryFieldDefinition";
+    definitionId: string;
+    type: CustomFieldType;
+    translations?: Array<{
+        __typename?: "CustomFieldDefinitionTranslations";
+        description?: string | null;
+        title?: string | null;
+        language?: string | null;
+    } | null> | null;
+    owner?: {
+        __typename?: "CustomFieldOwner";
+        ownerType: CustomFieldOwnerType;
+    } | null;
+} & {
+    " $fragmentName"?: "CustomFieldDefinition_MonetaryFieldDefinition_Fragment";
+};
+export type CustomFieldDefinition_NumberFieldDefinition_Fragment = {
+    __typename?: "NumberFieldDefinition";
+    definitionId: string;
+    type: CustomFieldType;
+    translations?: Array<{
+        __typename?: "CustomFieldDefinitionTranslations";
+        description?: string | null;
+        title?: string | null;
+        language?: string | null;
+    } | null> | null;
+    owner?: {
+        __typename?: "CustomFieldOwner";
+        ownerType: CustomFieldOwnerType;
+    } | null;
+} & {
+    " $fragmentName"?: "CustomFieldDefinition_NumberFieldDefinition_Fragment";
+};
+export type CustomFieldDefinition_PhoneNumberFieldDefinition_Fragment = {
+    __typename?: "PhoneNumberFieldDefinition";
+    definitionId: string;
+    type: CustomFieldType;
+    translations?: Array<{
+        __typename?: "CustomFieldDefinitionTranslations";
+        description?: string | null;
+        title?: string | null;
+        language?: string | null;
+    } | null> | null;
+    owner?: {
+        __typename?: "CustomFieldOwner";
+        ownerType: CustomFieldOwnerType;
+    } | null;
+} & {
+    " $fragmentName"?: "CustomFieldDefinition_PhoneNumberFieldDefinition_Fragment";
+};
+export type CustomFieldDefinition_StringFieldDefinition_Fragment = {
+    __typename?: "StringFieldDefinition";
+    definitionId: string;
+    type: CustomFieldType;
+    translations?: Array<{
+        __typename?: "CustomFieldDefinitionTranslations";
+        description?: string | null;
+        title?: string | null;
+        language?: string | null;
+    } | null> | null;
+    owner?: {
+        __typename?: "CustomFieldOwner";
+        ownerType: CustomFieldOwnerType;
+    } | null;
+} & {
+    " $fragmentName"?: "CustomFieldDefinition_StringFieldDefinition_Fragment";
+};
+export type CustomFieldDefinition_WebAddressFieldDefinition_Fragment = {
+    __typename?: "WebAddressFieldDefinition";
+    definitionId: string;
+    type: CustomFieldType;
+    translations?: Array<{
+        __typename?: "CustomFieldDefinitionTranslations";
+        description?: string | null;
+        title?: string | null;
+        language?: string | null;
+    } | null> | null;
+    owner?: {
+        __typename?: "CustomFieldOwner";
+        ownerType: CustomFieldOwnerType;
+    } | null;
+} & {
+    " $fragmentName"?: "CustomFieldDefinition_WebAddressFieldDefinition_Fragment";
+};
+export type CustomFieldDefinitionFragment = CustomFieldDefinition_BooleanFieldDefinition_Fragment | CustomFieldDefinition_DateFieldDefinition_Fragment | CustomFieldDefinition_DropDownFieldDefinition_Fragment | CustomFieldDefinition_EmailFieldDefinition_Fragment | CustomFieldDefinition_JsonFieldDefinition_Fragment | CustomFieldDefinition_MonetaryFieldDefinition_Fragment | CustomFieldDefinition_NumberFieldDefinition_Fragment | CustomFieldDefinition_PhoneNumberFieldDefinition_Fragment | CustomFieldDefinition_StringFieldDefinition_Fragment | CustomFieldDefinition_WebAddressFieldDefinition_Fragment;
 export declare const CustomFieldValueAndDefinitionFragmentDoc: DocumentNode<CustomFieldValueAndDefinitionFragment, unknown>;
+export declare const CustomFieldDefinitionFragmentDoc: DocumentNode<CustomFieldDefinitionFragment, unknown>;
 export declare const GetCustomFieldsForAssetDocument: DocumentNode<GetCustomFieldsForAssetQuery, Exact<{
     entityId: Scalars["String"]["input"];
     systemOfMeasurement?: InputMaybe<SystemOfMeasurement> | undefined;
@@ -572,3 +831,6 @@ export declare const GetCustomFieldsForSiteDocument: DocumentNode<GetCustomField
     entityId: Scalars["ID"]["input"];
     systemOfMeasurement?: InputMaybe<SystemOfMeasurement> | undefined;
 }>>;
+export declare const GetCustomFieldDefinitionsDocument: DocumentNode<GetCustomFieldDefinitionsQuery, Exact<{
+    entityType?: InputMaybe<CustomFieldEntityType> | undefined;
+}>>;

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

@@ -6,3 +6,6 @@ export declare const mockForGetCustomFieldsForAssetQuery: (variables: gql.GetCus
 export declare const mockForGetCustomFieldsForSiteQuery: (variables: gql.GetCustomFieldsForSiteQueryVariables, data?: DeepPartialNullable<gql.GetCustomFieldsForSiteQuery>) => import("@apollo/client/testing").MockedResponse<gql.GetCustomFieldsForSiteQuery, Record<string, any>> & {
     data: gql.GetCustomFieldsForSiteQuery;
 };
+export declare const mockForGetCustomFieldDefinitionsQuery: (variables: gql.GetCustomFieldDefinitionsQueryVariables, data?: DeepPartialNullable<gql.GetCustomFieldDefinitionsQuery>) => import("@apollo/client/testing").MockedResponse<gql.GetCustomFieldDefinitionsQuery, Record<string, any>> & {
+    data: gql.GetCustomFieldDefinitionsQuery;
+};

package/src/index.d.ts

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

package/src/useCustomFieldDefinitions.d.ts

@@ -0,0 +1,27 @@
+import { EntityType } from "@trackunit/iris-app-api";
+import { CustomFieldOwnerType, CustomFieldType } from "./generated/graphql-api/graphql";
+type SupportedEntityTypes = Extract<EntityType, "ASSET" | "SITE">;
+export interface CustomFieldDefinition {
+    id: string;
+    title: string;
+    type: CustomFieldType;
+    owner?: CustomFieldOwnerType | null;
+}
+interface UseCustomFieldDefinitionsProps {
+    entityType?: SupportedEntityTypes;
+    filterQuery?: string;
+    owners?: CustomFieldOwnerType[];
+}
+interface UseCustomFieldDefinitionsReturnValue {
+    loading: boolean;
+    definitions: CustomFieldDefinition[];
+}
+/**
+ * Custom hook to fetch custom field definitions for a specified entity type.
+ *
+ * @param {UseCustomFieldDefinitionsProps} props - The properties for the custom fields query.
+ * @param {SupportedEntityTypes} [props.entityType] - The type of the entity (e.g., 'ASSET' or 'SITE').
+ * @returns {UseCustomFieldDefinitionsReturnValue} An object containing a loading state and an array of custom field definitions.
+ */
+export declare const useCustomFieldDefinitions: ({ entityType, filterQuery, owners, }: UseCustomFieldDefinitionsProps) => UseCustomFieldDefinitionsReturnValue;
+export {};