Skip to content

Commit 8ee0d04

Browse files
antfuantfu
committed
feat(devframe): expose devframe/rpc/dump sub-export
Lift dump helpers (`dumpFunctions`, `createClientFromDump`, `collectStaticRpcDump`, `serializeDumpError`, `reviveDumpError`, the `StaticRpcDump*` types, …) into a dedicated `devframe/rpc/dump` entry. The same symbols stay re-exported from `devframe/rpc` and are now flagged `@deprecated` so consumers see the migration hint in their editor; the deprecation JSDoc is re-declared per symbol so it survives tsdown's dts bundling.
1 parent 1ce81d8 commit 8ee0d04

6 files changed

Lines changed: 84 additions & 3 deletions

File tree

‎packages/devframe/package.json‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,7 @@
3434
"./recipes/open-helpers": "./dist/recipes/open-helpers.mjs",
3535
"./rpc": "./dist/rpc/index.mjs",
3636
"./rpc/client": "./dist/rpc/client.mjs",
37+
"./rpc/dump": "./dist/rpc/dump.mjs",
3738
"./rpc/server": "./dist/rpc/server.mjs",
3839
"./rpc/transports/ws-client": "./dist/rpc/transports/ws-client.mjs",
3940
"./rpc/transports/ws-server": "./dist/rpc/transports/ws-server.mjs",

‎packages/devframe/src/rpc/dump/index.ts‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,9 @@ import { logger } from '../diagnostics'
1313
import { validateDefinitions } from '../validation'
1414
import { reviveDumpError, serializeDumpError } from './error'
1515

16+
export * from './error'
17+
export * from './static'
18+
1619
function getDumpRecordKey(functionName: string, args: any[]): string {
1720
const argsHash = hash(args)
1821
return `${functionName}---${argsHash}`

‎packages/devframe/src/rpc/index.ts‎

Lines changed: 50 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,57 @@
1+
import type {
2+
StaticRpcDumpCollection as _StaticRpcDumpCollection,
3+
StaticRpcDumpFile as _StaticRpcDumpFile,
4+
StaticRpcDumpManifest as _StaticRpcDumpManifest,
5+
StaticRpcDumpManifestQueryEntry as _StaticRpcDumpManifestQueryEntry,
6+
StaticRpcDumpManifestStaticEntry as _StaticRpcDumpManifestStaticEntry,
7+
StaticRpcDumpManifestValue as _StaticRpcDumpManifestValue,
8+
StaticRpcDumpSerialization as _StaticRpcDumpSerialization,
9+
} from './dump/static'
10+
import {
11+
createClientFromDump as _createClientFromDump,
12+
dumpFunctions as _dumpFunctions,
13+
getDefinitionsWithDumps as _getDefinitionsWithDumps,
14+
} from './dump'
15+
import {
16+
reviveDumpError as _reviveDumpError,
17+
serializeDumpError as _serializeDumpError,
18+
} from './dump/error'
19+
import {
20+
collectStaticRpcDump as _collectStaticRpcDump,
21+
} from './dump/static'
22+
123
export * from './cache'
224
export * from './collector'
325
export * from './define'
4-
export * from './dump'
5-
export * from './dump/error'
6-
export * from './dump/static'
726
export * from './handler'
827
export * from './serialization'
928
export * from './types'
1029
export * from './validation'
30+
31+
/** @deprecated Import from `devframe/rpc/dump` instead. */
32+
export const collectStaticRpcDump = _collectStaticRpcDump
33+
/** @deprecated Import from `devframe/rpc/dump` instead. */
34+
export const createClientFromDump = _createClientFromDump
35+
/** @deprecated Import from `devframe/rpc/dump` instead. */
36+
export const dumpFunctions = _dumpFunctions
37+
/** @deprecated Import from `devframe/rpc/dump` instead. */
38+
export const getDefinitionsWithDumps = _getDefinitionsWithDumps
39+
/** @deprecated Import from `devframe/rpc/dump` instead. */
40+
export const reviveDumpError = _reviveDumpError
41+
/** @deprecated Import from `devframe/rpc/dump` instead. */
42+
export const serializeDumpError = _serializeDumpError
43+
44+
/** @deprecated Import from `devframe/rpc/dump` instead. */
45+
export type StaticRpcDumpCollection = _StaticRpcDumpCollection
46+
/** @deprecated Import from `devframe/rpc/dump` instead. */
47+
export type StaticRpcDumpFile = _StaticRpcDumpFile
48+
/** @deprecated Import from `devframe/rpc/dump` instead. */
49+
export type StaticRpcDumpManifest = _StaticRpcDumpManifest
50+
/** @deprecated Import from `devframe/rpc/dump` instead. */
51+
export type StaticRpcDumpManifestQueryEntry = _StaticRpcDumpManifestQueryEntry
52+
/** @deprecated Import from `devframe/rpc/dump` instead. */
53+
export type StaticRpcDumpManifestStaticEntry = _StaticRpcDumpManifestStaticEntry
54+
/** @deprecated Import from `devframe/rpc/dump` instead. */
55+
export type StaticRpcDumpManifestValue = _StaticRpcDumpManifestValue
56+
/** @deprecated Import from `devframe/rpc/dump` instead. */
57+
export type StaticRpcDumpSerialization = _StaticRpcDumpSerialization

‎packages/devframe/tsdown.config.ts‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@ export default defineConfig({
1818
'index': 'src/index.ts',
1919
'rpc/index': 'src/rpc/index.ts',
2020
'rpc/client': 'src/rpc/client.ts',
21+
'rpc/dump': 'src/rpc/dump/index.ts',
2122
'rpc/server': 'src/rpc/server.ts',
2223
'rpc/transports/ws-client': 'src/rpc/transports/ws-client.ts',
2324
'rpc/transports/ws-server': 'src/rpc/transports/ws-server.ts',

‎tests/__snapshots__/tsnapi/devframe/rpc/dump.snapshot.d.ts‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
/**
2+
* Generated by tsnapi — public API snapshot of `devframe/rpc/dump`
3+
*/
4+
// #region Other
5+
export { collectStaticRpcDump }
6+
export { createClientFromDump }
7+
export { dumpFunctions }
8+
export { getDefinitionsWithDumps }
9+
export { reviveDumpError }
10+
export { serializeDumpError }
11+
export { StaticRpcDumpCollection }
12+
export { StaticRpcDumpFile }
13+
export { StaticRpcDumpManifest }
14+
export { StaticRpcDumpManifestQueryEntry }
15+
export { StaticRpcDumpManifestStaticEntry }
16+
export { StaticRpcDumpManifestValue }
17+
export { StaticRpcDumpSerialization }
18+
// #endregion

‎tests/__snapshots__/tsnapi/devframe/rpc/dump.snapshot.js‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
/**
2+
* Generated by tsnapi — public API snapshot of `devframe/rpc/dump`
3+
*/
4+
// #region Other
5+
export { collectStaticRpcDump }
6+
export { createClientFromDump }
7+
export { dumpFunctions }
8+
export { getDefinitionsWithDumps }
9+
export { reviveDumpError }
10+
export { serializeDumpError }
11+
// #endregion

0 commit comments

Comments
 (0)