chore: expose interfaces

Author: posva

packages/devframe/src/rpc/types.ts

@@ -224,7 +224,8 @@ export interface RpcDumpStore<T = any> {
   _functions?: T
 }
 
-interface RpcFunctionDefinitionWithoutSchemas<
+/** RPC function definition whose handler supplies its argument and return types. */
+export interface RpcFunctionDefinitionWithoutSchemas<
   NAME extends string,
   TYPE extends RpcFunctionType,
   ARGS extends any[],
@@ -239,7 +240,8 @@ interface RpcFunctionDefinitionWithoutSchemas<
   returns?: RS
 }
 
-interface RpcFunctionDefinitionWithSchemas<
+/** RPC function definition whose argument and return types come from schemas. */
+export interface RpcFunctionDefinitionWithSchemas<
   NAME extends string,
   TYPE extends RpcFunctionType,
   AS extends RpcArgsSchema | undefined,

tests/__snapshots__/tsnapi/devframe/recipes/common-rpc-functions.snapshot.d.ts

@@ -7,66 +7,10 @@ export type KnownEditor = 'atom' | 'subl' | 'sublime' | 'sublime_text' | 'wstorm
 
 // #region Variables
 /** @deprecated */
-export declare const commonRpcFunctions: readonly [{
-  name: "devframe:open-in-editor";
-  type?: "action" | undefined;
-  cacheable?: boolean;
-  args: readonly [SimpleSchema<string, string>, SimpleSchema<KnownEditor | undefined, KnownEditor | undefined>];
-  returns: SimpleSchema<void, void>;
-  jsonSerializable?: boolean;
-  agent?: RpcFunctionAgentOptions;
-  setup?: ((context: undefined) => Thenable<RpcFunctionSetupResult<[string, KnownEditor | undefined], Thenable<void>>>) | undefined;
-  handler?: ((args_0: string, args_1: KnownEditor | undefined) => Thenable<void>) | undefined;
-  dump?: RpcDump<[string, KnownEditor | undefined], Thenable<void>, undefined> | undefined;
-  snapshot?: boolean;
-  __cache?: WeakMap<object, Thenable<RpcFunctionSetupResult<[string, KnownEditor | undefined], Thenable<void>>>> | undefined;
-  __promise?: Thenable<RpcFunctionSetupResult<[string, KnownEditor | undefined], Thenable<void>>> | undefined;
-}, {
-  name: "devframe:open-in-finder";
-  type?: "action" | undefined;
-  cacheable?: boolean;
-  args: readonly [SimpleSchema<string, string>];
-  returns: SimpleSchema<void, void>;
-  jsonSerializable?: boolean;
-  agent?: RpcFunctionAgentOptions;
-  setup?: ((context: undefined) => Thenable<RpcFunctionSetupResult<[string], Thenable<void>>>) | undefined;
-  handler?: ((args_0: string) => Thenable<void>) | undefined;
-  dump?: RpcDump<[string], Thenable<void>, undefined> | undefined;
-  snapshot?: boolean;
-  __cache?: WeakMap<object, Thenable<RpcFunctionSetupResult<[string], Thenable<void>>>> | undefined;
-  __promise?: Thenable<RpcFunctionSetupResult<[string], Thenable<void>>> | undefined;
-}];
+export declare const commonRpcFunctions: readonly [RpcFunctionDefinitionWithSchemas<"devframe:open-in-editor", "action", readonly [SimpleSchema<string, string>, SimpleSchema<KnownEditor | undefined, KnownEditor | undefined>], SimpleSchema<void, void>, undefined>, RpcFunctionDefinitionWithSchemas<"devframe:open-in-finder", "action", readonly [SimpleSchema<string, string>], SimpleSchema<void, void>, undefined>];
 export declare const KNOWN_EDITORS: KnownEditor[];
 /** @deprecated */
-export declare const openInEditor: {
-  name: "devframe:open-in-editor";
-  type?: "action" | undefined;
-  cacheable?: boolean;
-  args: readonly [SimpleSchema<string, string>, SimpleSchema<KnownEditor | undefined, KnownEditor | undefined>];
-  returns: SimpleSchema<void, void>;
-  jsonSerializable?: boolean;
-  agent?: RpcFunctionAgentOptions;
-  setup?: ((context: undefined) => Thenable<RpcFunctionSetupResult<[string, KnownEditor | undefined], Thenable<void>>>) | undefined;
-  handler?: ((args_0: string, args_1: KnownEditor | undefined) => Thenable<void>) | undefined;
-  dump?: RpcDump<[string, KnownEditor | undefined], Thenable<void>, undefined> | undefined;
-  snapshot?: boolean;
-  __cache?: WeakMap<object, Thenable<RpcFunctionSetupResult<[string, KnownEditor | undefined], Thenable<void>>>> | undefined;
-  __promise?: Thenable<RpcFunctionSetupResult<[string, KnownEditor | undefined], Thenable<void>>> | undefined;
-};
+export declare const openInEditor: RpcFunctionDefinitionWithSchemas<"devframe:open-in-editor", "action", readonly [SimpleSchema<string, string>, SimpleSchema<KnownEditor | undefined, KnownEditor | undefined>], SimpleSchema<void, void>, undefined>;
 /** @deprecated */
-export declare const openInFinder: {
-  name: "devframe:open-in-finder";
-  type?: "action" | undefined;
-  cacheable?: boolean;
-  args: readonly [SimpleSchema<string, string>];
-  returns: SimpleSchema<void, void>;
-  jsonSerializable?: boolean;
-  agent?: RpcFunctionAgentOptions;
-  setup?: ((context: undefined) => Thenable<RpcFunctionSetupResult<[string], Thenable<void>>>) | undefined;
-  handler?: ((args_0: string) => Thenable<void>) | undefined;
-  dump?: RpcDump<[string], Thenable<void>, undefined> | undefined;
-  snapshot?: boolean;
-  __cache?: WeakMap<object, Thenable<RpcFunctionSetupResult<[string], Thenable<void>>>> | undefined;
-  __promise?: Thenable<RpcFunctionSetupResult<[string], Thenable<void>>> | undefined;
-};
+export declare const openInFinder: RpcFunctionDefinitionWithSchemas<"devframe:open-in-finder", "action", readonly [SimpleSchema<string, string>], SimpleSchema<void, void>, undefined>;
 // #endregion

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

@@ -29,6 +29,8 @@ export { RpcFunctionDefinitionAny }
 export { RpcFunctionDefinitionAnyWithContext }
 export { RpcFunctionDefinitionBase }
 export { RpcFunctionDefinitionToFunction }
+export { RpcFunctionDefinitionWithoutSchemas }
+export { RpcFunctionDefinitionWithSchemas }
 export { RpcFunctionsCollector }
 export { RpcFunctionsCollectorBase }
 export { RpcFunctionSetupResult }