import {z} from 'zod' export type CustomerId = {id: string, entityType: 'CUSTOMER'}; export type ApiUsageStateFilter = {type: string, customerId?: CustomerId | undefined}; export type AliasEntityId = {aliasEntityType?: ('CURRENT_CUSTOMER' | 'CURRENT_TENANT' | 'CURRENT_USER' | 'CURRENT_USER_OWNER') | undefined, id: string, entityType: 'TENANT' | 'CUSTOMER' | 'USER' | 'DASHBOARD' | 'ASSET' | 'DEVICE' | 'ALARM' | 'RULE_CHAIN' | 'RULE_NODE' | 'ENTITY_VIEW' | 'WIDGETS_BUNDLE' | 'WIDGET_TYPE' | 'TENANT_PROFILE' | 'DEVICE_PROFILE' | 'ASSET_PROFILE' | 'API_USAGE_STATE' | 'TB_RESOURCE' | 'OTA_PACKAGE' | 'EDGE' | 'RPC' | 'QUEUE' | 'NOTIFICATION_TARGET' | 'NOTIFICATION_TEMPLATE' | 'NOTIFICATION_REQUEST' | 'NOTIFICATION' | 'NOTIFICATION_RULE' | 'QUEUE_STATS' | 'OAUTH2_CLIENT' | 'DOMAIN' | 'MOBILE_APP' | 'MOBILE_APP_BUNDLE' | 'CALCULATED_FIELD' | 'JOB' | 'ADMIN_SETTINGS' | 'AI_MODEL' | 'API_KEY'}; export type AssetSearchQueryFilter = {type: string, rootEntity?: AliasEntityId | undefined, relationType?: string | undefined, direction?: ('FROM' | 'TO') | undefined, maxLevel?: number | undefined, fetchLastLevelOnly?: boolean | undefined, rootStateEntity?: boolean | undefined, defaultStateEntity?: AliasEntityId | undefined, assetTypes?: Array | undefined}; export type AssetTypeFilter = {type: string, assetType?: string | undefined, assetTypes?: Array | undefined, assetNameFilter?: string | undefined}; export type DeviceSearchQueryFilter = {type: string, rootEntity?: AliasEntityId | undefined, relationType?: string | undefined, direction?: ('FROM' | 'TO') | undefined, maxLevel?: number | undefined, fetchLastLevelOnly?: boolean | undefined, rootStateEntity?: boolean | undefined, defaultStateEntity?: AliasEntityId | undefined, deviceTypes?: Array | undefined}; export type DeviceTypeFilter = {type: string, deviceType?: string | undefined, deviceTypes?: Array | undefined, deviceNameFilter?: string | undefined}; export type EdgeSearchQueryFilter = {type: string, rootEntity?: AliasEntityId | undefined, relationType?: string | undefined, direction?: ('FROM' | 'TO') | undefined, maxLevel?: number | undefined, fetchLastLevelOnly?: boolean | undefined, rootStateEntity?: boolean | undefined, defaultStateEntity?: AliasEntityId | undefined, edgeTypes?: Array | undefined}; export type EdgeTypeFilter = {type: string, edgeType?: string | undefined, edgeTypes?: Array | undefined, edgeNameFilter?: string | undefined}; export type EntityListFilter = {type: string, entityType?: ('TENANT' | 'CUSTOMER' | 'USER' | 'DASHBOARD' | 'ASSET' | 'DEVICE' | 'ALARM' | 'RULE_CHAIN' | 'RULE_NODE' | 'ENTITY_VIEW' | 'WIDGETS_BUNDLE' | 'WIDGET_TYPE' | 'TENANT_PROFILE' | 'DEVICE_PROFILE' | 'ASSET_PROFILE' | 'API_USAGE_STATE' | 'TB_RESOURCE' | 'OTA_PACKAGE' | 'EDGE' | 'RPC' | 'QUEUE' | 'NOTIFICATION_TARGET' | 'NOTIFICATION_TEMPLATE' | 'NOTIFICATION_REQUEST' | 'NOTIFICATION' | 'NOTIFICATION_RULE' | 'QUEUE_STATS' | 'OAUTH2_CLIENT' | 'DOMAIN' | 'MOBILE_APP' | 'MOBILE_APP_BUNDLE' | 'CALCULATED_FIELD' | 'JOB' | 'ADMIN_SETTINGS' | 'AI_MODEL' | 'API_KEY') | undefined, entityList?: Array | undefined}; export type EntityNameFilter = {type: string, entityType?: ('TENANT' | 'CUSTOMER' | 'USER' | 'DASHBOARD' | 'ASSET' | 'DEVICE' | 'ALARM' | 'RULE_CHAIN' | 'RULE_NODE' | 'ENTITY_VIEW' | 'WIDGETS_BUNDLE' | 'WIDGET_TYPE' | 'TENANT_PROFILE' | 'DEVICE_PROFILE' | 'ASSET_PROFILE' | 'API_USAGE_STATE' | 'TB_RESOURCE' | 'OTA_PACKAGE' | 'EDGE' | 'RPC' | 'QUEUE' | 'NOTIFICATION_TARGET' | 'NOTIFICATION_TEMPLATE' | 'NOTIFICATION_REQUEST' | 'NOTIFICATION' | 'NOTIFICATION_RULE' | 'QUEUE_STATS' | 'OAUTH2_CLIENT' | 'DOMAIN' | 'MOBILE_APP' | 'MOBILE_APP_BUNDLE' | 'CALCULATED_FIELD' | 'JOB' | 'ADMIN_SETTINGS' | 'AI_MODEL' | 'API_KEY') | undefined, entityNameFilter?: string | undefined}; export type EntityTypeFilter = {type: string, entityType?: ('TENANT' | 'CUSTOMER' | 'USER' | 'DASHBOARD' | 'ASSET' | 'DEVICE' | 'ALARM' | 'RULE_CHAIN' | 'RULE_NODE' | 'ENTITY_VIEW' | 'WIDGETS_BUNDLE' | 'WIDGET_TYPE' | 'TENANT_PROFILE' | 'DEVICE_PROFILE' | 'ASSET_PROFILE' | 'API_USAGE_STATE' | 'TB_RESOURCE' | 'OTA_PACKAGE' | 'EDGE' | 'RPC' | 'QUEUE' | 'NOTIFICATION_TARGET' | 'NOTIFICATION_TEMPLATE' | 'NOTIFICATION_REQUEST' | 'NOTIFICATION' | 'NOTIFICATION_RULE' | 'QUEUE_STATS' | 'OAUTH2_CLIENT' | 'DOMAIN' | 'MOBILE_APP' | 'MOBILE_APP_BUNDLE' | 'CALCULATED_FIELD' | 'JOB' | 'ADMIN_SETTINGS' | 'AI_MODEL' | 'API_KEY') | undefined}; export type EntityViewSearchQueryFilter = {type: string, rootEntity?: AliasEntityId | undefined, relationType?: string | undefined, direction?: ('FROM' | 'TO') | undefined, maxLevel?: number | undefined, fetchLastLevelOnly?: boolean | undefined, rootStateEntity?: boolean | undefined, defaultStateEntity?: AliasEntityId | undefined, entityViewTypes?: Array | undefined}; export type EntityViewTypeFilter = {type: string, entityViewType?: string | undefined, entityViewTypes?: Array | undefined, entityViewNameFilter?: string | undefined}; export type RelationEntityTypeFilter = {relationType?: string | undefined, entityTypes?: (Array<'TENANT' | 'CUSTOMER' | 'USER' | 'DASHBOARD' | 'ASSET' | 'DEVICE' | 'ALARM' | 'RULE_CHAIN' | 'RULE_NODE' | 'ENTITY_VIEW' | 'WIDGETS_BUNDLE' | 'WIDGET_TYPE' | 'TENANT_PROFILE' | 'DEVICE_PROFILE' | 'ASSET_PROFILE' | 'API_USAGE_STATE' | 'TB_RESOURCE' | 'OTA_PACKAGE' | 'EDGE' | 'RPC' | 'QUEUE' | 'NOTIFICATION_TARGET' | 'NOTIFICATION_TEMPLATE' | 'NOTIFICATION_REQUEST' | 'NOTIFICATION' | 'NOTIFICATION_RULE' | 'QUEUE_STATS' | 'OAUTH2_CLIENT' | 'DOMAIN' | 'MOBILE_APP' | 'MOBILE_APP_BUNDLE' | 'CALCULATED_FIELD' | 'JOB' | 'ADMIN_SETTINGS' | 'AI_MODEL' | 'API_KEY'>) | undefined, negate?: boolean | undefined}; export type RelationsQueryFilter = {type: string, rootEntity?: AliasEntityId | undefined, multiRootEntitiesType?: ('TENANT' | 'CUSTOMER' | 'USER' | 'DASHBOARD' | 'ASSET' | 'DEVICE' | 'ALARM' | 'RULE_CHAIN' | 'RULE_NODE' | 'ENTITY_VIEW' | 'WIDGETS_BUNDLE' | 'WIDGET_TYPE' | 'TENANT_PROFILE' | 'DEVICE_PROFILE' | 'ASSET_PROFILE' | 'API_USAGE_STATE' | 'TB_RESOURCE' | 'OTA_PACKAGE' | 'EDGE' | 'RPC' | 'QUEUE' | 'NOTIFICATION_TARGET' | 'NOTIFICATION_TEMPLATE' | 'NOTIFICATION_REQUEST' | 'NOTIFICATION' | 'NOTIFICATION_RULE' | 'QUEUE_STATS' | 'OAUTH2_CLIENT' | 'DOMAIN' | 'MOBILE_APP' | 'MOBILE_APP_BUNDLE' | 'CALCULATED_FIELD' | 'JOB' | 'ADMIN_SETTINGS' | 'AI_MODEL' | 'API_KEY') | undefined, multiRootEntityIds?: Array | undefined, direction?: ('FROM' | 'TO') | undefined, filters?: Array | undefined, maxLevel?: number | undefined, fetchLastLevelOnly?: boolean | undefined, negate?: boolean | undefined, rootStateEntity?: boolean | undefined, defaultStateEntity?: AliasEntityId | undefined, multiRoot?: boolean | undefined}; export type SingleEntityFilter = {type: string, singleEntity?: AliasEntityId | undefined}; export type EntityKey = {type?: ('ATTRIBUTE' | 'CLIENT_ATTRIBUTE' | 'SHARED_ATTRIBUTE' | 'SERVER_ATTRIBUTE' | 'TIME_SERIES' | 'ENTITY_FIELD' | 'ALARM_FIELD') | undefined, key?: string | undefined}; export type DynamicValueBoolean = {sourceType?: ('CURRENT_TENANT' | 'CURRENT_CUSTOMER' | 'CURRENT_USER' | 'CURRENT_DEVICE') | undefined, sourceAttribute?: string | undefined, inherit?: boolean | undefined, resolvedValue?: boolean | undefined}; export type FilterPredicateValueBoolean = {defaultValue?: boolean | undefined, userValue?: boolean | undefined, dynamicValue?: DynamicValueBoolean | undefined}; export type BooleanFilterPredicate = {type: string, operation?: ('EQUAL' | 'NOT_EQUAL') | undefined, value?: FilterPredicateValueBoolean | undefined}; export type DynamicValueDouble = {sourceType?: ('CURRENT_TENANT' | 'CURRENT_CUSTOMER' | 'CURRENT_USER' | 'CURRENT_DEVICE') | undefined, sourceAttribute?: string | undefined, inherit?: boolean | undefined, resolvedValue?: number | undefined}; export type FilterPredicateValueDouble = {defaultValue?: number | undefined, userValue?: number | undefined, dynamicValue?: DynamicValueDouble | undefined}; export type NumericFilterPredicate = {type: string, operation?: ('EQUAL' | 'NOT_EQUAL' | 'GREATER' | 'LESS' | 'GREATER_OR_EQUAL' | 'LESS_OR_EQUAL') | undefined, value?: FilterPredicateValueDouble | undefined}; export type DynamicValueString = {sourceType?: ('CURRENT_TENANT' | 'CURRENT_CUSTOMER' | 'CURRENT_USER' | 'CURRENT_DEVICE') | undefined, sourceAttribute?: string | undefined, inherit?: boolean | undefined, resolvedValue?: string | undefined}; export type FilterPredicateValueString = {defaultValue?: string | undefined, userValue?: string | undefined, dynamicValue?: DynamicValueString | undefined}; export type StringFilterPredicate = {type: string, operation?: ('EQUAL' | 'NOT_EQUAL' | 'STARTS_WITH' | 'ENDS_WITH' | 'CONTAINS' | 'NOT_CONTAINS' | 'IN' | 'NOT_IN') | undefined, value?: FilterPredicateValueString | undefined, ignoreCase?: boolean | undefined}; export type ComplexFilterPredicate = {type: string, operation?: ('AND' | 'OR') | undefined, predicates?: (Array) | undefined}; export type KeyFilter = {key?: EntityKey | undefined, valueType?: ('STRING' | 'NUMERIC' | 'BOOLEAN' | 'DATE_TIME') | undefined, predicate?: (BooleanFilterPredicate | ComplexFilterPredicate | NumericFilterPredicate | StringFilterPredicate) | undefined}; export type EntityDataSortOrder = {key?: EntityKey | undefined, direction?: ('ASC' | 'DESC') | undefined}; export type EntityDataPageLink = {pageSize?: number | undefined, page?: number | undefined, textSearch?: string | undefined, sortOrder?: EntityDataSortOrder | undefined, dynamic?: boolean | undefined}; export type EntityDataQuery = {entityFilter?: (ApiUsageStateFilter | AssetSearchQueryFilter | AssetTypeFilter | DeviceSearchQueryFilter | DeviceTypeFilter | EdgeSearchQueryFilter | EdgeTypeFilter | EntityListFilter | EntityNameFilter | EntityTypeFilter | EntityViewSearchQueryFilter | EntityViewTypeFilter | RelationsQueryFilter | SingleEntityFilter) | undefined, keyFilters?: Array | undefined, pageLink?: EntityDataPageLink | undefined, entityFields?: Array | undefined, latestValues?: Array | undefined}; export type CreateApiApiEntitiesQueryFindKeysArgs = {timeseries: boolean, attributes: boolean, scope?: ('SERVER_SCOPE' | 'SHARED_SCOPE' | 'CLIENT_SCOPE') | undefined, body: EntityDataQuery}; export type CreateApiApiEntitiesQueryFindKeysOptions = {baseUrl?: string | undefined, fetch?: typeof fetch | undefined}; export const availableEntityKeys = z.object({entityTypes: z.array(z.enum(["TENANT", "CUSTOMER", "USER", "DASHBOARD", "ASSET", "DEVICE", "ALARM", "RULE_CHAIN", "RULE_NODE", "ENTITY_VIEW", "WIDGETS_BUNDLE", "WIDGET_TYPE", "TENANT_PROFILE", "DEVICE_PROFILE", "ASSET_PROFILE", "API_USAGE_STATE", "TB_RESOURCE", "OTA_PACKAGE", "EDGE", "RPC", "QUEUE", "NOTIFICATION_TARGET", "NOTIFICATION_TEMPLATE", "NOTIFICATION_REQUEST", "NOTIFICATION", "NOTIFICATION_RULE", "QUEUE_STATS", "OAUTH2_CLIENT", "DOMAIN", "MOBILE_APP", "MOBILE_APP_BUNDLE", "CALCULATED_FIELD", "JOB", "ADMIN_SETTINGS", "AI_MODEL", "API_KEY"])), timeseries: z.array(z.string()), attribute: z.array(z.string())}); export const validateResponse = async ( schema: { readonly '~standard': { readonly validate: (value: unknown) => ({ readonly value: Output; readonly issues?: undefined } | { readonly issues: ReadonlyArray<{ readonly message: string; readonly path?: ReadonlyArray | undefined }> }) | Promise<{ readonly value: Output; readonly issues?: undefined } | { readonly issues: ReadonlyArray<{ readonly message: string; readonly path?: ReadonlyArray | undefined }> }> } }, value: unknown ): Promise => { const result = await schema['~standard'].validate(value) if (result.issues !== undefined) { const detail = result.issues .map(({ message, path }) => path?.length ? `${path.map((segment) => String(typeof segment === 'object' ? segment.key : segment)).join('.')}: ${message}` : message ) .join('; ') throw new Error(`Response does not match the schema: ${detail}`, { cause: { issues: result.issues } }) } return result.value }; /** * Find Available Entity Keys by Query * * POST /api/entitiesQuery/find/keys */ export const createApiApiEntitiesQueryFindKeys = async (args: CreateApiApiEntitiesQueryFindKeysArgs, options?: CreateApiApiEntitiesQueryFindKeysOptions) => { const {baseUrl = "https://demo.thingsboard.io", fetch: fetchFn = fetch} = options ?? {} const query = new URLSearchParams() const headers = new Headers() headers.set('content-type', "application/json") headers.set('accept', "application/json") if (args.timeseries != null) query.append("timeseries", String(args.timeseries)) if (args.attributes != null) query.append("attributes", String(args.attributes)) if (args.scope != null) query.append("scope", String(args.scope)) const url = `${baseUrl.replace(/\/+$/, '')}/api/entitiesQuery/find/keys${query.size > 0 ? `?${query}` : ''}` const res = await fetchFn(url, {method: "POST", headers, body: JSON.stringify(args.body)}) if (!res.ok) throw new Error(`Request failed with status ${res.status}`, {cause: {status: res.status, body: await res.text()}}) return validateResponse(availableEntityKeys, await res.json()) };