GV

GeezerVison

The World Wide Web, restored to 800 pixels of glory.

Home|About|Gaming cabinet|Archives|How it works|Starter sites

On this site

  • Sign in
  • ActionsCI/CD and automation
  • CodespacesCloud development environments
  • All Features
  • Documentation
  • Training
  • Certifications
  • Build with Copilot
  • Customize Copilot
  • Integrations
  • Trending repos
  • GitHub Sponsors
  • Developer articles
  • Enterprises

This view

  • Original page
  • New address

GeezerVison is showing github.com — refactor(servicenow): type the shared response boundary instead of any · simstudioai/sim@bb41f42

File tree

Expand file treeCollapse file tree
Open diff view settings
Filter options
  • apps/sim/tools/servicenow
    • get_change_next_states.ts
    • get_ci.ts
    • get_knowledge_article.ts
    • order_catalog_item.ts
    • search_knowledge.ts
    • types.ts
    • utils.ts
Expand file treeCollapse file tree
Open diff view settings
Collapse file

‎apps/sim/tools/servicenow/get_change_next_states.ts‎

Copy file name to clipboardExpand all lines: apps/sim/tools/servicenow/get_change_next_states.ts
+6-3Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ import {
88
buildServiceNowHeaders,
99
normalizeInstanceUrl,
1010
parseServiceNowResponse,
11+
toRecordObject,
1112
} from '@/tools/servicenow/utils'
1213
import type { ToolConfig } from '@/tools/types'
1314

@@ -47,13 +48,15 @@ export const getChangeNextStatesTool: ToolConfig<
4748

4849
transformResponse: async (response: Response) => {
4950
const data = await parseServiceNowResponse(response)
50-
const result = data.result ?? {}
51+
const result = toRecordObject(data.result)
5152

5253
const availableStates: string[] = Array.isArray(result.available_states)
5354
? result.available_states.map((state: unknown) => String(state))
5455
: []
55-
const stateLabels: Record<string, string> =
56-
result.state_label && typeof result.state_label === 'object' ? result.state_label : {}
56+
const stateLabels: Record<string, string> = {}
57+
for (const [state, label] of Object.entries(toRecordObject(result.state_label))) {
58+
if (typeof label === 'string') stateLabels[state] = label
59+
}
5760

5861
/**
5962
* ServiceNow groups `state_transitions` by target state, so it arrives as an
Collapse file

‎apps/sim/tools/servicenow/get_ci.ts‎

Copy file name to clipboardExpand all lines: apps/sim/tools/servicenow/get_ci.ts
+2-1Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@ import {
44
buildServiceNowHeaders,
55
normalizeInstanceUrl,
66
parseServiceNowResponse,
7+
toRecordObject,
78
} from '@/tools/servicenow/utils'
89
import type { ToolConfig } from '@/tools/types'
910

@@ -46,7 +47,7 @@ export const getCiTool: ToolConfig<ServiceNowGetCiParams, ServiceNowGetCiRespons
4647

4748
transformResponse: async (response: Response) => {
4849
const data = await parseServiceNowResponse(response)
49-
const result = data.result ?? {}
50+
const result = toRecordObject(data.result)
5051
const inboundRelations = Array.isArray(result.inbound_relations) ? result.inbound_relations : []
5152
const outboundRelations = Array.isArray(result.outbound_relations)
5253
? result.outbound_relations
Collapse file

‎apps/sim/tools/servicenow/get_knowledge_article.ts‎

Copy file name to clipboardExpand all lines: apps/sim/tools/servicenow/get_knowledge_article.ts
+7-5Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,8 @@ import {
77
buildServiceNowHeaders,
88
normalizeInstanceUrl,
99
parseServiceNowResponse,
10+
readString,
11+
toRecordObject,
1012
withQueryString,
1113
} from '@/tools/servicenow/utils'
1214
import type { ToolConfig } from '@/tools/types'
@@ -78,15 +80,15 @@ export const getKnowledgeArticleTool: ToolConfig<
7880

7981
transformResponse: async (response: Response) => {
8082
const data = await parseServiceNowResponse(response)
81-
const result = data.result ?? {}
83+
const result = toRecordObject(data.result)
8284

8385
return {
8486
success: true,
8587
output: {
86-
sysId: result.sys_id ?? null,
87-
number: result.number ?? null,
88-
title: result.short_description ?? null,
89-
content: result.content ?? null,
88+
sysId: readString(result, 'sys_id'),
89+
number: readString(result, 'number'),
90+
title: readString(result, 'short_description'),
91+
content: readString(result, 'content'),
9092
fields: result.fields ?? null,
9193
attachments: Array.isArray(result.attachments) ? result.attachments : [],
9294
},
Collapse file

‎apps/sim/tools/servicenow/order_catalog_item.ts‎

Copy file name to clipboardExpand all lines: apps/sim/tools/servicenow/order_catalog_item.ts
+8-6Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,8 @@ import {
77
buildServiceNowHeaders,
88
normalizeInstanceUrl,
99
parseServiceNowResponse,
10+
readString,
11+
toRecordObject,
1012
} from '@/tools/servicenow/utils'
1113
import type { ToolConfig } from '@/tools/types'
1214

@@ -85,16 +87,16 @@ export const orderCatalogItemTool: ToolConfig<
8587

8688
transformResponse: async (response: Response) => {
8789
const data = await parseServiceNowResponse(response)
88-
const result = data.result ?? {}
90+
const result = toRecordObject(data.result)
8991

9092
return {
9193
success: true,
9294
output: {
93-
sysId: result.sys_id ?? null,
94-
number: result.number ?? null,
95-
requestNumber: result.request_number ?? null,
96-
requestId: result.request_id ?? null,
97-
table: result.table ?? null,
95+
sysId: readString(result, 'sys_id'),
96+
number: readString(result, 'number'),
97+
requestNumber: readString(result, 'request_number'),
98+
requestId: readString(result, 'request_id'),
99+
table: readString(result, 'table'),
98100
},
99101
}
100102
},
Collapse file

‎apps/sim/tools/servicenow/search_knowledge.ts‎

Copy file name to clipboardExpand all lines: apps/sim/tools/servicenow/search_knowledge.ts
+4-2Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,8 @@ import {
88
buildServiceNowHeaders,
99
normalizeInstanceUrl,
1010
parseServiceNowResponse,
11+
readNestedNumber,
12+
toRecordObject,
1113
withQueryString,
1214
} from '@/tools/servicenow/utils'
1315
import type { ToolConfig } from '@/tools/types'
@@ -97,7 +99,7 @@ export const searchKnowledgeTool: ToolConfig<
9799

98100
transformResponse: async (response: Response) => {
99101
const data = await parseServiceNowResponse(response)
100-
const result = data.result ?? {}
102+
const result = toRecordObject(data.result)
101103
const articles: ServiceNowKnowledgeArticleSummary[] = Array.isArray(result.articles)
102104
? result.articles
103105
: []
@@ -108,7 +110,7 @@ export const searchKnowledgeTool: ToolConfig<
108110
articles,
109111
metadata: {
110112
recordCount: articles.length,
111-
totalCount: typeof result.meta?.count === 'number' ? result.meta.count : null,
113+
totalCount: readNestedNumber(result, 'meta', 'count'),
112114
},
113115
},
114116
}
Collapse file

‎apps/sim/tools/servicenow/types.ts‎

Copy file name to clipboardExpand all lines: apps/sim/tools/servicenow/types.ts
+14-3Lines changed: 14 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,18 @@ import type { ToolResponse } from '@/tools/types'
99
export interface ServiceNowRecord {
1010
sys_id?: unknown
1111
number?: unknown
12-
[key: string]: any
12+
[key: string]: unknown
13+
}
14+
15+
/**
16+
* The envelope every ServiceNow REST endpoint replies with. Success bodies
17+
* carry `result` — an object for single-record endpoints, an array for
18+
* collections; failures carry `error`. `result` stays `unknown` so each tool
19+
* narrows it deliberately rather than inheriting an unchecked shape.
20+
*/
21+
export interface ServiceNowEnvelope {
22+
result?: unknown
23+
error?: { message?: string; detail?: string } | string
1324
}
1425

1526
/** Credentials shared by every ServiceNow tool. */
@@ -273,7 +284,7 @@ export interface ServiceNowCatalogItem {
273284
picture?: string
274285
icon?: string
275286
order?: number
276-
[key: string]: any
287+
[key: string]: unknown
277288
}
278289

279290
export interface ServiceNowListCatalogItemsResponse extends ToolResponse {
@@ -521,7 +532,7 @@ export interface ServiceNowAttachment {
521532
table_name?: string
522533
table_sys_id?: string
523534
download_link?: string
524-
[key: string]: any
535+
[key: string]: unknown
525536
}
526537

527538
export interface ServiceNowListAttachmentsParams {
Collapse file

‎apps/sim/tools/servicenow/utils.ts‎

Copy file name to clipboardExpand all lines: apps/sim/tools/servicenow/utils.ts
+43-4Lines changed: 43 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@ import { filterUndefined } from '@sim/utils/object'
22
import { DEFAULT_DISPLAY_VALUE } from '@/tools/servicenow/constants'
33
import type {
44
ServiceNowAuthParams,
5+
ServiceNowEnvelope,
56
ServiceNowReadOptions,
67
ServiceNowRecord,
78
ServiceNowWriteOptions,
@@ -132,17 +133,55 @@ export function withQueryString(url: string, searchParams: URLSearchParams): str
132133
* Parses a ServiceNow JSON response, raising the instance's own error message
133134
* when the request failed. ServiceNow error bodies are `{ error: { message, detail } }`.
134135
*/
135-
export async function parseServiceNowResponse(response: Response): Promise<any> {
136-
const data = await response.json()
136+
export async function parseServiceNowResponse(response: Response): Promise<ServiceNowEnvelope> {
137+
const data = (await response.json()) as ServiceNowEnvelope
137138

138139
if (!response.ok) {
139-
const error = data?.error || data
140-
throw new Error(typeof error === 'string' ? error : error?.message || JSON.stringify(error))
140+
const error = data?.error ?? data
141+
const message =
142+
typeof error === 'string'
143+
? error
144+
: ((error as { message?: string })?.message ?? JSON.stringify(error))
145+
throw new Error(message)
141146
}
142147

143148
return data
144149
}
145150

151+
/**
152+
* Narrows an envelope `result` to a keyed record. Single-record endpoints reply
153+
* with an object; anything else (a collection, a scalar, `null`) becomes `{}` so
154+
* callers can read fields without an unchecked cast.
155+
*/
156+
export function toRecordObject(result: unknown): ServiceNowRecord {
157+
return result && typeof result === 'object' && !Array.isArray(result)
158+
? (result as ServiceNowRecord)
159+
: {}
160+
}
161+
162+
/**
163+
* Reads a string field off a ServiceNow record. Returns `null` when the field is
164+
* absent or is not a string, so a tool declaring a `string | null` output cannot
165+
* silently emit an object because the instance returned a different shape.
166+
*/
167+
export function readString(record: ServiceNowRecord, key: string): string | null {
168+
const value = record[key]
169+
return typeof value === 'string' ? value : null
170+
}
171+
172+
/**
173+
* Reads a number field off a nested object on a ServiceNow record, for example
174+
* the `meta.count` the Knowledge search API returns alongside its results.
175+
*/
176+
export function readNestedNumber(
177+
record: ServiceNowRecord,
178+
key: string,
179+
nestedKey: string
180+
): number | null {
181+
const nested = toRecordObject(record[key])[nestedKey]
182+
return typeof nested === 'number' ? nested : null
183+
}
184+
146185
/**
147186
* Normalizes the `{ result: ... }` envelope into an array of records. Collection
148187
* endpoints return an array, single-record endpoints return an object.

0 commit comments

Comments
0 (0)
You are visitor 01402520 — GeezerVison does not store the pages you look up.
Best viewed with Netscape Navigator 4.7 or Internet Explorer 6 at 800×600. No cookies required.