Skip to content

Commit 4b63094

Browse files
tk-otk-o
authored
refactor(ensnode-sdk): update response data model naming convention (#1639)
1 parent 7e97ef7 commit 4b63094

31 files changed

Lines changed: 516 additions & 543 deletions

‎packages/ensnode-sdk/src/ensapi/api/config/deserialize.ts‎

Lines changed: 15 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,19 @@
1-
import { deserializeENSApiPublicConfig } from "../../config/deserialize";
2-
import type { ConfigResponse } from "./response";
3-
import type { SerializedConfigResponse } from "./serialized-response";
1+
import { deserializeEnsApiPublicConfig } from "../../config/deserialize";
2+
import type { EnsApiConfigResponse } from "./response";
3+
import type { SerializedEnsApiConfigResponse } from "./serialized-response";
44

55
/**
6-
* Deserialize a {@link ConfigResponse} object.
6+
* Deserialize a {@link EnsApiConfigResponse} object.
77
*/
8-
export function deserializeConfigResponse(
9-
serializedResponse: SerializedConfigResponse,
10-
): ConfigResponse {
11-
return deserializeENSApiPublicConfig(serializedResponse);
8+
export function deserializeEnsApiConfigResponse(
9+
serializedResponse: SerializedEnsApiConfigResponse,
10+
): EnsApiConfigResponse {
11+
return deserializeEnsApiPublicConfig(serializedResponse);
1212
}
13+
14+
/**
15+
* Deserialize a {@link EnsApiConfigResponse} object.
16+
*
17+
* @deprecated Use {@link deserializeEnsApiConfigResponse} instead.
18+
*/
19+
export const deserializeConfigResponse = deserializeEnsApiConfigResponse;

‎packages/ensnode-sdk/src/ensapi/api/config/response.ts‎

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,13 @@
1-
import type { ENSApiPublicConfig } from "../../config/types";
1+
import type { EnsApiPublicConfig } from "../../config/types";
22

33
/**
44
* ENSApi Public Config Response
55
*/
6-
export type ConfigResponse = ENSApiPublicConfig;
6+
export type EnsApiConfigResponse = EnsApiPublicConfig;
7+
8+
/**
9+
* ENSApi Config API Response
10+
*
11+
* @deprecated Use {@link EnsApiConfigResponse} instead.
12+
*/
13+
export type ConfigResponse = EnsApiConfigResponse;

‎packages/ensnode-sdk/src/ensapi/api/config/serialize.ts‎

Lines changed: 17 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,19 @@
1-
import { serializeENSApiPublicConfig } from "../../config/serialize";
2-
import type { ConfigResponse } from "./response";
3-
import type { SerializedConfigResponse } from "./serialized-response";
1+
import { serializeEnsApiPublicConfig } from "../../config/serialize";
2+
import type { EnsApiConfigResponse } from "./response";
3+
import type { SerializedEnsApiConfigResponse } from "./serialized-response";
44

5-
export function serializeConfigResponse(response: ConfigResponse): SerializedConfigResponse {
6-
return serializeENSApiPublicConfig(response);
5+
/**
6+
* Serialize ENSApi Config API Response
7+
*/
8+
export function serializeEnsApiConfigResponse(
9+
response: EnsApiConfigResponse,
10+
): SerializedEnsApiConfigResponse {
11+
return serializeEnsApiPublicConfig(response);
712
}
13+
14+
/**
15+
* Serialize ENSApi Config API Response
16+
*
17+
* @deprecated Use {@link serializeEnsApiConfigResponse} instead.
18+
*/
19+
export const serializeConfigResponse = serializeEnsApiConfigResponse;

‎packages/ensnode-sdk/src/ensapi/api/config/serialized-response.ts‎

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,12 @@
1-
import type { SerializedENSApiPublicConfig } from "../../config/serialized-types";
1+
import type { SerializedEnsApiPublicConfig } from "../../config/serialized-types";
2+
import type { EnsApiConfigResponse } from "./response";
23

3-
export type SerializedConfigResponse = SerializedENSApiPublicConfig;
4+
/**
5+
* Serialized representation of {@link EnsApiConfigResponse}
6+
*/
7+
export type SerializedEnsApiConfigResponse = SerializedEnsApiPublicConfig;
8+
9+
/**
10+
* @deprecated Use {@link SerializedEnsApiConfigResponse} instead.
11+
*/
12+
export type SerializedConfigResponse = SerializedEnsApiConfigResponse;

‎packages/ensnode-sdk/src/ensapi/api/indexing-status/deserialize.ts‎

Lines changed: 28 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -2,24 +2,24 @@ import { prettifyError } from "zod/v4";
22

33
import { buildUnvalidatedRealtimeIndexingStatusProjection } from "../../../indexing-status/deserialize/realtime-indexing-status-projection";
44
import type { Unvalidated } from "../../../shared/types";
5-
import { type IndexingStatusResponse, IndexingStatusResponseCodes } from "./response";
6-
import type { SerializedIndexingStatusResponse } from "./serialized-response";
5+
import { type EnsApiIndexingStatusResponse, EnsApiIndexingStatusResponseCodes } from "./response";
6+
import type { SerializedEnsApiIndexingStatusResponse } from "./serialized-response";
77
import {
8-
makeIndexingStatusResponseSchema,
9-
makeSerializedIndexingStatusResponseSchema,
8+
makeEnsApiIndexingStatusResponseSchema,
9+
makeSerializedEnsApiIndexingStatusResponseSchema,
1010
} from "./zod-schemas";
1111

1212
/**
13-
* Builds an unvalidated {@link IndexingStatusResponse} object to be
14-
* validated with {@link makeIndexingStatusResponseSchema}.
13+
* Builds an unvalidated {@link EnsApiIndexingStatusResponse} object to be
14+
* validated with {@link makeEnsApiIndexingStatusResponseSchema}.
1515
*
1616
* @param serializedResponse - The serialized response to build from.
17-
* @return An unvalidated {@link IndexingStatusResponse} object.
17+
* @return An unvalidated {@link EnsApiIndexingStatusResponse} object.
1818
*/
19-
function buildUnvalidatedIndexingStatusResponse(
20-
serializedResponse: SerializedIndexingStatusResponse,
21-
): Unvalidated<IndexingStatusResponse> {
22-
if (serializedResponse.responseCode !== IndexingStatusResponseCodes.Ok) {
19+
function buildUnvalidatedEnsApiIndexingStatusResponse(
20+
serializedResponse: SerializedEnsApiIndexingStatusResponse,
21+
): Unvalidated<EnsApiIndexingStatusResponse> {
22+
if (serializedResponse.responseCode !== EnsApiIndexingStatusResponseCodes.Ok) {
2323
return serializedResponse;
2424
}
2525

@@ -32,19 +32,28 @@ function buildUnvalidatedIndexingStatusResponse(
3232
}
3333

3434
/**
35-
* Deserialize a {@link IndexingStatusResponse} object.
35+
* Deserialize a {@link EnsApiIndexingStatusResponse} object.
3636
*/
37-
export function deserializeIndexingStatusResponse(
38-
maybeResponse: Unvalidated<SerializedIndexingStatusResponse>,
39-
): IndexingStatusResponse {
40-
const parsed = makeSerializedIndexingStatusResponseSchema()
41-
.transform(buildUnvalidatedIndexingStatusResponse)
42-
.pipe(makeIndexingStatusResponseSchema())
37+
export function deserializeEnsApiIndexingStatusResponse(
38+
maybeResponse: Unvalidated<SerializedEnsApiIndexingStatusResponse>,
39+
): EnsApiIndexingStatusResponse {
40+
const parsed = makeSerializedEnsApiIndexingStatusResponseSchema()
41+
.transform(buildUnvalidatedEnsApiIndexingStatusResponse)
42+
.pipe(makeEnsApiIndexingStatusResponseSchema())
4343
.safeParse(maybeResponse);
4444

4545
if (parsed.error) {
46-
throw new Error(`Cannot deserialize IndexingStatusResponse:\n${prettifyError(parsed.error)}\n`);
46+
throw new Error(
47+
`Cannot deserialize EnsApiIndexingStatusResponse:\n${prettifyError(parsed.error)}\n`,
48+
);
4749
}
4850

4951
return parsed.data;
5052
}
53+
54+
/**
55+
* Deserialize a {@link EnsApiIndexingStatusResponse} object.
56+
*
57+
* @deprecated Use {@link deserializeEnsApiIndexingStatusResponse} instead.
58+
*/
59+
export const deserializeIndexingStatusResponse = deserializeEnsApiIndexingStatusResponse;

‎packages/ensnode-sdk/src/ensapi/api/indexing-status/request.ts‎

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,11 @@
11
/**
22
* Represents a request to Indexing Status API.
33
*/
4-
export type IndexingStatusRequest = {};
4+
export type EnsApiIndexingStatusRequest = {};
5+
6+
/**
7+
* Represents a request to Indexing Status API.
8+
*
9+
* @deprecated Use {@link EnsApiIndexingStatusRequest} instead.
10+
*/
11+
export type IndexingStatusRequest = EnsApiIndexingStatusRequest;

‎packages/ensnode-sdk/src/ensapi/api/indexing-status/response.ts‎

Lines changed: 46 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ import type { RealtimeIndexingStatusProjection } from "../../../indexing-status/
33
/**
44
* A status code for indexing status responses.
55
*/
6-
export const IndexingStatusResponseCodes = {
6+
export const EnsApiIndexingStatusResponseCodes = {
77
/**
88
* Represents that the indexing status is available.
99
*/
@@ -16,30 +16,67 @@ export const IndexingStatusResponseCodes = {
1616
} as const;
1717

1818
/**
19-
* The derived string union of possible {@link IndexingStatusResponseCodes}.
19+
* A status code for indexing status responses.
20+
*
21+
* @deprecated Use {@link EnsApiIndexingStatusResponseCodes} instead.
22+
*/
23+
export const IndexingStatusResponseCodes = EnsApiIndexingStatusResponseCodes;
24+
25+
/**
26+
* The derived string union of possible {@link EnsApiIndexingStatusResponseCodes}.
27+
*/
28+
export type EnsApiIndexingStatusResponseCode =
29+
(typeof EnsApiIndexingStatusResponseCodes)[keyof typeof EnsApiIndexingStatusResponseCodes];
30+
31+
/**
32+
* The derived string union of possible {@link EnsApiIndexingStatusResponseCodes}.
33+
*
34+
* @deprecated Use {@link EnsApiIndexingStatusResponseCode} instead.
2035
*/
21-
export type IndexingStatusResponseCode =
22-
(typeof IndexingStatusResponseCodes)[keyof typeof IndexingStatusResponseCodes];
36+
export type IndexingStatusResponseCode = EnsApiIndexingStatusResponseCode;
2337

2438
/**
2539
* An indexing status response when the indexing status is available.
2640
*/
27-
export type IndexingStatusResponseOk = {
28-
responseCode: typeof IndexingStatusResponseCodes.Ok;
41+
export type EnsApiIndexingStatusResponseOk = {
42+
responseCode: typeof EnsApiIndexingStatusResponseCodes.Ok;
2943
realtimeProjection: RealtimeIndexingStatusProjection;
3044
};
3145

46+
/**
47+
* An indexing status response when the indexing status is available.
48+
*
49+
* @deprecated Use {@link EnsApiIndexingStatusResponseOk} instead.
50+
*/
51+
export type IndexingStatusResponseOk = EnsApiIndexingStatusResponseOk;
52+
3253
/**
3354
* An indexing status response when the indexing status is unavailable.
3455
*/
35-
export type IndexingStatusResponseError = {
36-
responseCode: typeof IndexingStatusResponseCodes.Error;
56+
export type EnsApiIndexingStatusResponseError = {
57+
responseCode: typeof EnsApiIndexingStatusResponseCodes.Error;
3758
};
3859

60+
/**
61+
* An indexing status response when the indexing status is unavailable.
62+
*
63+
* @deprecated Use {@link EnsApiIndexingStatusResponseError} instead.
64+
*/
65+
export type IndexingStatusResponseError = EnsApiIndexingStatusResponseError;
66+
3967
/**
4068
* Indexing status response.
4169
*
4270
* Use the `responseCode` field to determine the specific type interpretation
4371
* at runtime.
4472
*/
45-
export type IndexingStatusResponse = IndexingStatusResponseOk | IndexingStatusResponseError;
73+
export type EnsApiIndexingStatusResponse =
74+
| EnsApiIndexingStatusResponseOk
75+
| EnsApiIndexingStatusResponseError;
76+
77+
/**
78+
* Indexing status response.
79+
*
80+
* @deprecated Use {@link EnsApiIndexingStatusResponse} instead.
81+
*/
82+
export type IndexingStatusResponse = EnsApiIndexingStatusResponse;

‎packages/ensnode-sdk/src/ensapi/api/indexing-status/serialize.ts‎

Lines changed: 19 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,31 @@
11
import { serializeRealtimeIndexingStatusProjection } from "../../../indexing-status/serialize/realtime-indexing-status-projection";
2-
import { type IndexingStatusResponse, IndexingStatusResponseCodes } from "./response";
2+
import { type EnsApiIndexingStatusResponse, EnsApiIndexingStatusResponseCodes } from "./response";
33
import type {
4-
SerializedIndexingStatusResponse,
5-
SerializedIndexingStatusResponseOk,
4+
SerializedEnsApiIndexingStatusResponse,
5+
SerializedEnsApiIndexingStatusResponseOk,
66
} from "./serialized-response";
77

8-
export function serializeIndexingStatusResponse(
9-
response: IndexingStatusResponse,
10-
): SerializedIndexingStatusResponse {
8+
/**
9+
* Serialize a {@link EnsApiIndexingStatusResponse} object.
10+
*/
11+
export function serializeEnsApiIndexingStatusResponse(
12+
response: EnsApiIndexingStatusResponse,
13+
): SerializedEnsApiIndexingStatusResponse {
1114
switch (response.responseCode) {
12-
case IndexingStatusResponseCodes.Ok:
15+
case EnsApiIndexingStatusResponseCodes.Ok:
1316
return {
1417
responseCode: response.responseCode,
1518
realtimeProjection: serializeRealtimeIndexingStatusProjection(response.realtimeProjection),
16-
} satisfies SerializedIndexingStatusResponseOk;
19+
} satisfies SerializedEnsApiIndexingStatusResponseOk;
1720

18-
case IndexingStatusResponseCodes.Error:
21+
case EnsApiIndexingStatusResponseCodes.Error:
1922
return response;
2023
}
2124
}
25+
26+
/**
27+
* Serialize a {@link EnsApiIndexingStatusResponse} object.
28+
*
29+
* @deprecated Use {@link serializeEnsApiIndexingStatusResponse} instead.
30+
*/
31+
export const serializeIndexingStatusResponse = serializeEnsApiIndexingStatusResponse;

‎packages/ensnode-sdk/src/ensapi/api/indexing-status/serialized-response.ts‎

Lines changed: 35 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,47 @@
11
import type { SerializedRealtimeIndexingStatusProjection } from "../../../indexing-status/serialize/realtime-indexing-status-projection";
2-
import type { IndexingStatusResponseError, IndexingStatusResponseOk } from "./response";
2+
import type {
3+
EnsApiIndexingStatusResponse,
4+
EnsApiIndexingStatusResponseError,
5+
EnsApiIndexingStatusResponseOk,
6+
} from "./response";
37

48
/**
5-
* Serialized representation of {@link IndexingStatusResponseError}.
9+
* Serialized representation of {@link EnsApiIndexingStatusResponseError}.
610
*/
7-
export type SerializedIndexingStatusResponseError = IndexingStatusResponseError;
11+
export type SerializedEnsApiIndexingStatusResponseError = EnsApiIndexingStatusResponseError;
812

913
/**
10-
* Serialized representation of {@link IndexingStatusResponseOk}.
14+
* Serialized representation of {@link EnsApiIndexingStatusResponseError}.
15+
*
16+
* @deprecated Use {@link SerializedEnsApiIndexingStatusResponseError} instead.
1117
*/
12-
export interface SerializedIndexingStatusResponseOk
13-
extends Omit<IndexingStatusResponseOk, "realtimeProjection"> {
18+
export type SerializedIndexingStatusResponseError = SerializedEnsApiIndexingStatusResponseError;
19+
20+
/**
21+
* Serialized representation of {@link EnsApiIndexingStatusResponseOk}.
22+
*/
23+
export interface SerializedEnsApiIndexingStatusResponseOk
24+
extends Omit<EnsApiIndexingStatusResponseOk, "realtimeProjection"> {
1425
realtimeProjection: SerializedRealtimeIndexingStatusProjection;
1526
}
1627

1728
/**
18-
* Serialized representation of {@link IndexingStatusResponse}.
29+
* Serialized representation of {@link EnsApiIndexingStatusResponseOk}.
30+
*
31+
* @deprecated Use {@link SerializedEnsApiIndexingStatusResponseOk} instead.
32+
*/
33+
export type SerializedIndexingStatusResponseOk = SerializedEnsApiIndexingStatusResponseOk;
34+
35+
/**
36+
* Serialized representation of {@link EnsApiIndexingStatusResponse}.
37+
*/
38+
export type SerializedEnsApiIndexingStatusResponse =
39+
| SerializedEnsApiIndexingStatusResponseOk
40+
| SerializedEnsApiIndexingStatusResponseError;
41+
42+
/**
43+
* Serialized representation of {@link EnsApiIndexingStatusResponse}.
44+
*
45+
* @deprecated Use {@link SerializedEnsApiIndexingStatusResponse} instead.
1946
*/
20-
export type SerializedIndexingStatusResponse =
21-
| SerializedIndexingStatusResponseOk
22-
| SerializedIndexingStatusResponseError;
47+
export type SerializedIndexingStatusResponse = SerializedEnsApiIndexingStatusResponse;

0 commit comments

Comments
 (0)