Skip to content

Commit fe5836d

Browse files
NorOldBurdenNorOldBurden
committed
Tree shakable hooks generation update
1 parent 8ab635c commit fe5836d

File tree

344 files changed

+25338
-3541
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

344 files changed

+25338
-3541
lines changed

‎README.md‎

Lines changed: 19 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -457,20 +457,20 @@ See [RPC Clients](#rpc-clients) for more info.
457457

458458
| Option | Description | Defaults |
459459
| --------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------- |
460-
| `helperFuncCreators.enabled` | Enable the generation of helper function files `.func.ts` | `false` |
461-
| `helperFuncCreators.genCustomHooks` | Generates React hooks alongside helper functions | `false` |
462-
| `helperFuncCreators.include.serviceTypes`| Specifies which types of services to include (`Query`, `Msg`). `undefined` includes all types. | `undefined` |
463-
| `helperFuncCreators.include.patterns` | Array of glob patterns patterns (e.g., `"**"`, `"cosmos.bank.v1beta1.bala*"`, etc.) to match specific proto services. | `undefined` |
464-
| `helperFuncCreators.nameMappers` | Configuration object for customizing function names and prefixes | `{}` |
465-
| `helperFuncCreators.nameMappers.All.funcBody` | Maps method names to a new name for all services. | `"unchanged"` |
466-
| `helperFuncCreators.nameMappers.All.creatorPrefix` | Prefix for the function creator. | `"create"` |
467-
| `helperFuncCreators.nameMappers.All.hookPrefix` | Prefix for the hooks. | `"use"` |
468-
| `helperFuncCreators.nameMappers.Query.funcBody` | Maps method names to a new name for `Query` services. | `"get"` |
469-
| `helperFuncCreators.nameMappers.Query.creatorPrefix`| Prefix for the function creator for `Query` services. | `"create"` |
470-
| `helperFuncCreators.nameMappers.Query.hookPrefix` | Prefix for the hooks for `Query` services. | `"use"` |
471-
| `helperFuncCreators.nameMappers.Msg.funcBody` | Maps method names to a new name for `Msg` services. | `"unchanged"` |
472-
| `helperFuncCreators.nameMappers.Msg.creatorPrefix`| Prefix for the function creator for `Msg` services. | `"create"` |
473-
| `helperFuncCreators.nameMappers.Msg.hookPrefix` | Prefix for the hooks for `Msg` services. | `"use"` |
460+
| `helperFunctions.enabled` | Enable the generation of helper function files `.func.ts` | `false` |
461+
| `helperFunctions.hooks` | Generates hooks selected alongside helper functions | `{ react: false, vue: false }` |
462+
| `helperFunctions.include.serviceTypes`| Specifies which types of services to include (`Query`, `Msg`). `undefined` includes all types. | `undefined` |
463+
| `helperFunctions.include.patterns` | Array of glob patterns patterns (e.g., `"**"`, `"cosmos.bank.v1beta1.bala*"`, etc.) to match specific proto services. | `undefined` |
464+
| `helperFunctions.nameMappers` | Configuration object for customizing function names and prefixes | `{}` |
465+
| `helperFunctions.nameMappers.All.funcBody` | Maps method names to a new name for all services. | `"unchanged"` |
466+
| `helperFunctions.nameMappers.All.creatorPrefix` | Prefix for the function creator. | `"create"` |
467+
| `helperFunctions.nameMappers.All.hookPrefix` | Prefix for the hooks. | `"use"` |
468+
| `helperFunctions.nameMappers.Query.funcBody` | Maps method names to a new name for `Query` services. | `"get"` |
469+
| `helperFunctions.nameMappers.Query.creatorPrefix`| Prefix for the function creator for `Query` services. | `"create"` |
470+
| `helperFunctions.nameMappers.Query.hookPrefix` | Prefix for the hooks for `Query` services. | `"use"` |
471+
| `helperFunctions.nameMappers.Msg.funcBody` | Maps method names to a new name for `Msg` services. | `"unchanged"` |
472+
| `helperFunctions.nameMappers.Msg.creatorPrefix`| Prefix for the function creator for `Msg` services. | `"create"` |
473+
| `helperFunctions.nameMappers.Msg.hookPrefix` | Prefix for the hooks for `Msg` services. | `"use"` |
474474

475475
See [Helper Functions Configuration](#helper-functions-configuration) for more info.
476476

@@ -1258,9 +1258,12 @@ The nameMappers object supports three service types: All, Query, and Msg. Each p
12581258
12591259
```js
12601260
const options: TelescopeOptions = {
1261-
helperFuncCreators: {
1261+
helperFunctions: {
12621262
enabled: true,
1263-
genCustomHooks: true,
1263+
genCustomHooks: {
1264+
react: true,
1265+
vue: true
1266+
},
12641267
include: {
12651268
patterns: ["cosmos.gov.v1beta1.**", "cosmos.bank.v1beta1.*Send*"],
12661269
},

‎__fixtures__/v-next/outputhelperfunc/akash/bundle.ts‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -88,9 +88,9 @@ import * as _349 from "./market/v1beta2/service.rpc.msg";
8888
import * as _350 from "./provider/v1beta1/provider.rpc.msg";
8989
import * as _351 from "./provider/v1beta2/provider.rpc.msg";
9090
import * as _352 from "./cert/v1beta2/query.pinia.store";
91-
import * as _539 from "./lcd";
92-
import * as _540 from "./rpc.query";
93-
import * as _541 from "./rpc.tx";
91+
import * as _542 from "./lcd";
92+
import * as _543 from "./rpc.query";
93+
import * as _544 from "./rpc.tx";
9494
export namespace akash {
9595
export namespace audit {
9696
export const v1beta1 = {
@@ -225,8 +225,8 @@ export namespace akash {
225225
};
226226
}
227227
export const ClientFactory = {
228-
..._539,
229-
..._540,
230-
..._541
228+
..._542,
229+
..._543,
230+
..._544
231231
};
232232
}

‎__fixtures__/v-next/outputhelperfunc/cosmos/bank/v1beta1/query.rpc.func.ts‎

Lines changed: 79 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,79 @@
1+
import { PageRequest, PageRequestSDKType, PageResponse, PageResponseSDKType } from "../../base/query/v1beta1/pagination";
2+
import { Coin, CoinSDKType } from "../../base/v1beta1/coin";
3+
import { Params, ParamsSDKType, Metadata, MetadataSDKType } from "./bank";
4+
import { RpcResolver, buildQuery } from "../../../helper-func-types";
5+
import { buildUseQuery } from "../../../react-query";
6+
import { buildUseVueQuery } from "../../../vue-query";
7+
import { QueryBalanceRequest, QueryBalanceRequestSDKType, QueryBalanceResponse, QueryBalanceResponseSDKType, QueryAllBalancesRequest, QueryAllBalancesRequestSDKType, QueryAllBalancesResponse, QueryAllBalancesResponseSDKType, QuerySpendableBalancesRequest, QuerySpendableBalancesRequestSDKType, QuerySpendableBalancesResponse, QuerySpendableBalancesResponseSDKType, QueryTotalSupplyRequest, QueryTotalSupplyRequestSDKType, QueryTotalSupplyResponse, QueryTotalSupplyResponseSDKType, QuerySupplyOfRequest, QuerySupplyOfRequestSDKType, QuerySupplyOfResponse, QuerySupplyOfResponseSDKType, QueryParamsRequest, QueryParamsRequestSDKType, QueryParamsResponse, QueryParamsResponseSDKType, QueryDenomMetadataRequest, QueryDenomMetadataRequestSDKType, QueryDenomMetadataResponse, QueryDenomMetadataResponseSDKType, QueryDenomsMetadataRequest, QueryDenomsMetadataRequestSDKType, QueryDenomsMetadataResponse, QueryDenomsMetadataResponseSDKType, QueryDenomOwnersRequest, QueryDenomOwnersRequestSDKType, QueryDenomOwnersResponse, QueryDenomOwnersResponseSDKType } from "./query";
8+
export const createGetBalance = (clientResolver?: RpcResolver) => buildQuery<QueryBalanceRequest, QueryBalanceResponse>({
9+
encode: QueryBalanceRequest.encode,
10+
decode: QueryBalanceResponse.decode,
11+
service: "cosmos.bank.v1beta1.Query",
12+
method: "Balance",
13+
clientResolver,
14+
deps: [QueryBalanceRequest, QueryBalanceResponse]
15+
});
16+
export const createGetAllBalances = (clientResolver?: RpcResolver) => buildQuery<QueryAllBalancesRequest, QueryAllBalancesResponse>({
17+
encode: QueryAllBalancesRequest.encode,
18+
decode: QueryAllBalancesResponse.decode,
19+
service: "cosmos.bank.v1beta1.Query",
20+
method: "AllBalances",
21+
clientResolver,
22+
deps: [QueryAllBalancesRequest, QueryAllBalancesResponse]
23+
});
24+
export const createGetSpendableBalances = (clientResolver?: RpcResolver) => buildQuery<QuerySpendableBalancesRequest, QuerySpendableBalancesResponse>({
25+
encode: QuerySpendableBalancesRequest.encode,
26+
decode: QuerySpendableBalancesResponse.decode,
27+
service: "cosmos.bank.v1beta1.Query",
28+
method: "SpendableBalances",
29+
clientResolver,
30+
deps: [QuerySpendableBalancesRequest, QuerySpendableBalancesResponse]
31+
});
32+
export const createGetTotalSupply = (clientResolver?: RpcResolver) => buildQuery<QueryTotalSupplyRequest, QueryTotalSupplyResponse>({
33+
encode: QueryTotalSupplyRequest.encode,
34+
decode: QueryTotalSupplyResponse.decode,
35+
service: "cosmos.bank.v1beta1.Query",
36+
method: "TotalSupply",
37+
clientResolver,
38+
deps: [QueryTotalSupplyRequest, QueryTotalSupplyResponse]
39+
});
40+
export const createGetSupplyOf = (clientResolver?: RpcResolver) => buildQuery<QuerySupplyOfRequest, QuerySupplyOfResponse>({
41+
encode: QuerySupplyOfRequest.encode,
42+
decode: QuerySupplyOfResponse.decode,
43+
service: "cosmos.bank.v1beta1.Query",
44+
method: "SupplyOf",
45+
clientResolver,
46+
deps: [QuerySupplyOfRequest, QuerySupplyOfResponse]
47+
});
48+
export const createGetParams = (clientResolver?: RpcResolver) => buildQuery<QueryParamsRequest, QueryParamsResponse>({
49+
encode: QueryParamsRequest.encode,
50+
decode: QueryParamsResponse.decode,
51+
service: "cosmos.bank.v1beta1.Query",
52+
method: "Params",
53+
clientResolver,
54+
deps: [QueryParamsRequest, QueryParamsResponse]
55+
});
56+
export const createGetDenomMetadata = (clientResolver?: RpcResolver) => buildQuery<QueryDenomMetadataRequest, QueryDenomMetadataResponse>({
57+
encode: QueryDenomMetadataRequest.encode,
58+
decode: QueryDenomMetadataResponse.decode,
59+
service: "cosmos.bank.v1beta1.Query",
60+
method: "DenomMetadata",
61+
clientResolver,
62+
deps: [QueryDenomMetadataRequest, QueryDenomMetadataResponse]
63+
});
64+
export const createGetDenomsMetadata = (clientResolver?: RpcResolver) => buildQuery<QueryDenomsMetadataRequest, QueryDenomsMetadataResponse>({
65+
encode: QueryDenomsMetadataRequest.encode,
66+
decode: QueryDenomsMetadataResponse.decode,
67+
service: "cosmos.bank.v1beta1.Query",
68+
method: "DenomsMetadata",
69+
clientResolver,
70+
deps: [QueryDenomsMetadataRequest, QueryDenomsMetadataResponse]
71+
});
72+
export const createGetDenomOwners = (clientResolver?: RpcResolver) => buildQuery<QueryDenomOwnersRequest, QueryDenomOwnersResponse>({
73+
encode: QueryDenomOwnersRequest.encode,
74+
decode: QueryDenomOwnersResponse.decode,
75+
service: "cosmos.bank.v1beta1.Query",
76+
method: "DenomOwners",
77+
clientResolver,
78+
deps: [QueryDenomOwnersRequest, QueryDenomOwnersResponse]
79+
});

‎__fixtures__/v-next/outputhelperfunc/cosmos/bank/v1beta1/query.rpc.react.ts‎

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
import { PageRequest, PageRequestSDKType, PageResponse, PageResponseSDKType } from "../../base/query/v1beta1/pagination";
2+
import { Coin, CoinSDKType } from "../../base/v1beta1/coin";
3+
import { Params, ParamsSDKType, Metadata, MetadataSDKType } from "./bank";
4+
import { RpcResolver, buildQuery } from "../../../helper-func-types";
5+
import { buildUseQuery } from "../../../react-query";
6+
import { buildUseVueQuery } from "../../../vue-query";
7+
import { QueryBalanceRequest, QueryBalanceRequestSDKType, QueryBalanceResponse, QueryBalanceResponseSDKType, QueryAllBalancesRequest, QueryAllBalancesRequestSDKType, QueryAllBalancesResponse, QueryAllBalancesResponseSDKType, QuerySpendableBalancesRequest, QuerySpendableBalancesRequestSDKType, QuerySpendableBalancesResponse, QuerySpendableBalancesResponseSDKType, QueryTotalSupplyRequest, QueryTotalSupplyRequestSDKType, QueryTotalSupplyResponse, QueryTotalSupplyResponseSDKType, QuerySupplyOfRequest, QuerySupplyOfRequestSDKType, QuerySupplyOfResponse, QuerySupplyOfResponseSDKType, QueryParamsRequest, QueryParamsRequestSDKType, QueryParamsResponse, QueryParamsResponseSDKType, QueryDenomMetadataRequest, QueryDenomMetadataRequestSDKType, QueryDenomMetadataResponse, QueryDenomMetadataResponseSDKType, QueryDenomsMetadataRequest, QueryDenomsMetadataRequestSDKType, QueryDenomsMetadataResponse, QueryDenomsMetadataResponseSDKType, QueryDenomOwnersRequest, QueryDenomOwnersRequestSDKType, QueryDenomOwnersResponse, QueryDenomOwnersResponseSDKType } from "./query";
8+
import { createGetBalance, createGetAllBalances, createGetSpendableBalances, createGetTotalSupply, createGetSupplyOf, createGetParams, createGetDenomMetadata, createGetDenomsMetadata, createGetDenomOwners } from "./query.rpc.func.ts";
9+
export const useGetBalance = buildUseQuery<QueryBalanceRequest, QueryBalanceResponse>({
10+
builderQueryFn: createGetBalance,
11+
queryKeyPrefix: "BalanceQuery"
12+
});
13+
export const useGetAllBalances = buildUseQuery<QueryAllBalancesRequest, QueryAllBalancesResponse>({
14+
builderQueryFn: createGetAllBalances,
15+
queryKeyPrefix: "AllBalancesQuery"
16+
});
17+
export const useGetSpendableBalances = buildUseQuery<QuerySpendableBalancesRequest, QuerySpendableBalancesResponse>({
18+
builderQueryFn: createGetSpendableBalances,
19+
queryKeyPrefix: "SpendableBalancesQuery"
20+
});
21+
export const useGetTotalSupply = buildUseQuery<QueryTotalSupplyRequest, QueryTotalSupplyResponse>({
22+
builderQueryFn: createGetTotalSupply,
23+
queryKeyPrefix: "TotalSupplyQuery"
24+
});
25+
export const useGetSupplyOf = buildUseQuery<QuerySupplyOfRequest, QuerySupplyOfResponse>({
26+
builderQueryFn: createGetSupplyOf,
27+
queryKeyPrefix: "SupplyOfQuery"
28+
});
29+
export const useGetParams = buildUseQuery<QueryParamsRequest, QueryParamsResponse>({
30+
builderQueryFn: createGetParams,
31+
queryKeyPrefix: "ParamsQuery"
32+
});
33+
export const useGetDenomMetadata = buildUseQuery<QueryDenomMetadataRequest, QueryDenomMetadataResponse>({
34+
builderQueryFn: createGetDenomMetadata,
35+
queryKeyPrefix: "DenomMetadataQuery"
36+
});
37+
export const useGetDenomsMetadata = buildUseQuery<QueryDenomsMetadataRequest, QueryDenomsMetadataResponse>({
38+
builderQueryFn: createGetDenomsMetadata,
39+
queryKeyPrefix: "DenomsMetadataQuery"
40+
});
41+
export const useGetDenomOwners = buildUseQuery<QueryDenomOwnersRequest, QueryDenomOwnersResponse>({
42+
builderQueryFn: createGetDenomOwners,
43+
queryKeyPrefix: "DenomOwnersQuery"
44+
});

‎__fixtures__/v-next/outputhelperfunc/cosmos/bank/v1beta1/query.rpc.vue.ts‎

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
import { PageRequest, PageRequestSDKType, PageResponse, PageResponseSDKType } from "../../base/query/v1beta1/pagination";
2+
import { Coin, CoinSDKType } from "../../base/v1beta1/coin";
3+
import { Params, ParamsSDKType, Metadata, MetadataSDKType } from "./bank";
4+
import { RpcResolver, buildQuery } from "../../../helper-func-types";
5+
import { buildUseQuery } from "../../../react-query";
6+
import { buildUseVueQuery } from "../../../vue-query";
7+
import { QueryBalanceRequest, QueryBalanceRequestSDKType, QueryBalanceResponse, QueryBalanceResponseSDKType, QueryAllBalancesRequest, QueryAllBalancesRequestSDKType, QueryAllBalancesResponse, QueryAllBalancesResponseSDKType, QuerySpendableBalancesRequest, QuerySpendableBalancesRequestSDKType, QuerySpendableBalancesResponse, QuerySpendableBalancesResponseSDKType, QueryTotalSupplyRequest, QueryTotalSupplyRequestSDKType, QueryTotalSupplyResponse, QueryTotalSupplyResponseSDKType, QuerySupplyOfRequest, QuerySupplyOfRequestSDKType, QuerySupplyOfResponse, QuerySupplyOfResponseSDKType, QueryParamsRequest, QueryParamsRequestSDKType, QueryParamsResponse, QueryParamsResponseSDKType, QueryDenomMetadataRequest, QueryDenomMetadataRequestSDKType, QueryDenomMetadataResponse, QueryDenomMetadataResponseSDKType, QueryDenomsMetadataRequest, QueryDenomsMetadataRequestSDKType, QueryDenomsMetadataResponse, QueryDenomsMetadataResponseSDKType, QueryDenomOwnersRequest, QueryDenomOwnersRequestSDKType, QueryDenomOwnersResponse, QueryDenomOwnersResponseSDKType } from "./query";
8+
import { createGetBalance, createGetAllBalances, createGetSpendableBalances, createGetTotalSupply, createGetSupplyOf, createGetParams, createGetDenomMetadata, createGetDenomsMetadata, createGetDenomOwners } from "./query.rpc.func.ts";
9+
export const useGetBalance = buildUseVueQuery<QueryBalanceRequest, QueryBalanceResponse>({
10+
builderQueryFn: createGetBalance,
11+
queryKeyPrefix: "BalanceQuery"
12+
});
13+
export const useGetAllBalances = buildUseVueQuery<QueryAllBalancesRequest, QueryAllBalancesResponse>({
14+
builderQueryFn: createGetAllBalances,
15+
queryKeyPrefix: "AllBalancesQuery"
16+
});
17+
export const useGetSpendableBalances = buildUseVueQuery<QuerySpendableBalancesRequest, QuerySpendableBalancesResponse>({
18+
builderQueryFn: createGetSpendableBalances,
19+
queryKeyPrefix: "SpendableBalancesQuery"
20+
});
21+
export const useGetTotalSupply = buildUseVueQuery<QueryTotalSupplyRequest, QueryTotalSupplyResponse>({
22+
builderQueryFn: createGetTotalSupply,
23+
queryKeyPrefix: "TotalSupplyQuery"
24+
});
25+
export const useGetSupplyOf = buildUseVueQuery<QuerySupplyOfRequest, QuerySupplyOfResponse>({
26+
builderQueryFn: createGetSupplyOf,
27+
queryKeyPrefix: "SupplyOfQuery"
28+
});
29+
export const useGetParams = buildUseVueQuery<QueryParamsRequest, QueryParamsResponse>({
30+
builderQueryFn: createGetParams,
31+
queryKeyPrefix: "ParamsQuery"
32+
});
33+
export const useGetDenomMetadata = buildUseVueQuery<QueryDenomMetadataRequest, QueryDenomMetadataResponse>({
34+
builderQueryFn: createGetDenomMetadata,
35+
queryKeyPrefix: "DenomMetadataQuery"
36+
});
37+
export const useGetDenomsMetadata = buildUseVueQuery<QueryDenomsMetadataRequest, QueryDenomsMetadataResponse>({
38+
builderQueryFn: createGetDenomsMetadata,
39+
queryKeyPrefix: "DenomsMetadataQuery"
40+
});
41+
export const useGetDenomOwners = buildUseVueQuery<QueryDenomOwnersRequest, QueryDenomOwnersResponse>({
42+
builderQueryFn: createGetDenomOwners,
43+
queryKeyPrefix: "DenomOwnersQuery"
44+
});

‎__fixtures__/v-next/outputhelperfunc/cosmos/bank/v1beta1/tx.rpc.func.ts‎

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@ import { Input, InputSDKType, Output, OutputSDKType } from "./bank";
33
import { buildTx, ISigningClient, SigningClientResolver } from "../../../helper-func-types";
44
import { toEncoders, toConverters } from "@interchainjs/cosmos/utils";
55
import { buildUseMutation } from "../../../react-query";
6+
import { buildUseVueMutation } from "../../../vue-query";
67
import { MsgSend, MsgSendSDKType, MsgSendResponse, MsgSendResponseSDKType, MsgMultiSend, MsgMultiSendSDKType, MsgMultiSendResponse, MsgMultiSendResponseSDKType } from "./tx";
78
export const createSend = (clientResolver?: SigningClientResolver) => buildTx<MsgSend>({
89
clientResolver,
@@ -11,16 +12,10 @@ export const createSend = (clientResolver?: SigningClientResolver) => buildTx<Ms
1112
converters: toConverters(MsgSend),
1213
deps: [MsgSend]
1314
});
14-
export const useSend = buildUseMutation<MsgSend, Error>({
15-
builderMutationFn: createSend
16-
});
1715
export const createMultiSend = (clientResolver?: SigningClientResolver) => buildTx<MsgMultiSend>({
1816
clientResolver,
1917
typeUrl: MsgMultiSend.typeUrl,
2018
encoders: toEncoders(MsgMultiSend),
2119
converters: toConverters(MsgMultiSend),
2220
deps: [MsgMultiSend]
23-
});
24-
export const useMultiSend = buildUseMutation<MsgMultiSend, Error>({
25-
builderMutationFn: createMultiSend
2621
});

0 commit comments

Comments
 (0)