@dedot/codegen 0.0.1-next.f5bf4fc2.1 → 0.1.0

package/generator/RpcGen.js

@@ -1,172 +0,0 @@
-import { findAliasRpcSpec, findRpcSpec, isUnsubscribeMethod } from '@dedot/specs';
-import { isNativeType } from '@dedot/utils';
-import { ApiGen } from '../generator';
-import { beautifySourceCode, commentBlock, compileTemplate, TUPLE_TYPE_REGEX, WRAPPER_TYPE_REGEX } from './utils';
-import { findKnownCodecType } from './known-codecs';
-const HIDDEN_RPCS = [
-    // Ref: https://github.com/paritytech/polkadot-sdk/blob/43415ef58c143b985e09015cd000dbd65f6d3997/substrate/client/rpc-servers/src/lib.rs#L152C9-L158
-    'rpc_methods',
-];
-export class RpcGen extends ApiGen {
-    typesGen;
-    rpcMethods;
-    constructor(typesGen, rpcMethods) {
-        super(typesGen);
-        this.typesGen = typesGen;
-        this.rpcMethods = rpcMethods;
-        HIDDEN_RPCS.filter((one) => !rpcMethods.includes(one)).forEach((one) => rpcMethods.push(one));
-        rpcMethods.sort();
-    }
-    generate() {
-        this.typesGen.clearCache();
-        this.typesGen.typeImports.addKnownType('GenericRpcCalls', 'Unsub', 'Callback', 'GenericRpcCall');
-        const specsByModule = this.rpcMethods
-            .filter((one) => !findAliasRpcSpec(one)) // we'll ignore  alias rpc for now if defined in the specs! TODO should we generate alias rpc as well?
-            .filter((one) => !isUnsubscribeMethod(one)) // we'll ignore unsubscribe method as well
-            .map((one) => {
-            const spec = findRpcSpec(one);
-            if (spec) {
-                return spec;
-            }
-            const [module, ...methodParts] = one.split('_');
-            const method = methodParts.join('_');
-            return {
-                params: [],
-                type: 'GenericRpcCall',
-                module,
-                method,
-            };
-        })
-            .reduce((o, spec) => {
-            const { module, method } = spec;
-            // ignore if rpc name does not confront with the general convention
-            if (!module || !method) {
-                return o;
-            }
-            return {
-                ...o,
-                [module]: o[module] ? [...o[module], spec] : [spec],
-            };
-        }, {});
-        let rpcCallsOut = '';
-        Object.keys(specsByModule).forEach((module) => {
-            const specs = specsByModule[module];
-            // TODO add alias info to docs block!
-            rpcCallsOut += `${module}: {
-      ${specs.map((spec) => this.#generateMethodDef(spec)).join(',\n')},
-
-      [method: string]: GenericRpcCall,
-    },`;
-        });
-        // TODO include & define external types
-        const importTypes = this.typesGen.typeImports.toImports();
-        const template = compileTemplate('rpc.hbs');
-        return beautifySourceCode(template({ importTypes, rpcCallsOut }));
-    }
-    #generateMethodDef(spec) {
-        const { name, type, module, method, docs = [], params, pubsub, deprecated } = spec;
-        const rpcName = name || `${module}_${method}`;
-        let defaultDocs = [`@rpcname: ${rpcName}`];
-        if (deprecated) {
-            defaultDocs.push(`@deprecated: ${deprecated}`);
-        }
-        if (type === 'GenericRpcCall' && params.length === 0) {
-            return `${commentBlock(defaultDocs)}${method}: GenericRpcCall`;
-        }
-        this.addTypeImport(type, false);
-        params.forEach(({ type, isScale }) => {
-            this.addTypeImport(type, !!isScale);
-        });
-        const typedParams = params.map((param) => ({
-            ...param,
-            plainType: this.getGeneratedTypeName(param.type, !!param.isScale),
-        }));
-        const isSubscription = !!pubsub;
-        const paramsOut = typedParams.map(({ name, type, isOptional, isScale, plainType }) => `${name}${isOptional ? '?' : ''}: ${plainType}`);
-        const paramsDoc = typedParams.map(({ name, plainType }) => `@param {${plainType}} ${name}`);
-        const typeOut = this.getGeneratedTypeName(type, false);
-        if (isSubscription) {
-            defaultDocs.shift();
-            defaultDocs.unshift(`@pubsub: ${pubsub?.join(', ')}`);
-            paramsOut.push(`callback: Callback<${typeOut}>`);
-            return `${commentBlock(docs, '\n', defaultDocs, paramsDoc)}${method}: GenericRpcCall<(${paramsOut.join(', ')}) => Promise<Unsub>>`;
-        }
-        else {
-            return `${commentBlock(docs, '\n', defaultDocs, paramsDoc)}${method}: GenericRpcCall<(${paramsOut.join(', ')}) => Promise<${typeOut}>>`;
-        }
-    }
-    // TODO check typeIn, typeOut if param type, or rpc type isScale
-    addTypeImport(type, toTypeIn = true) {
-        if (Array.isArray(type)) {
-            type.forEach((one) => this.addTypeImport(one, toTypeIn));
-            return;
-        }
-        type = type.trim();
-        if (isNativeType(type)) {
-            return;
-        }
-        // Handle generic wrapper types
-        const matchArray = type.match(WRAPPER_TYPE_REGEX);
-        if (matchArray) {
-            const [_, $1, $2] = matchArray;
-            this.addTypeImport($1, toTypeIn);
-            if ($2.match(WRAPPER_TYPE_REGEX) || $2.match(TUPLE_TYPE_REGEX)) {
-                this.addTypeImport($2, toTypeIn);
-            }
-            else {
-                this.addTypeImport($2.split(','), toTypeIn);
-            }
-            return;
-        }
-        // Check tuple type
-        if (type.match(TUPLE_TYPE_REGEX)) {
-            this.addTypeImport(type.slice(1, -1).split(','), toTypeIn);
-            return;
-        }
-        if (type.includes(' | ')) {
-            this.addTypeImport(type.split(' | ').map((one) => one.trim()), toTypeIn);
-            return;
-        }
-        try {
-            const codecType = this.#getCodecType(type, toTypeIn);
-            if (isNativeType(codecType))
-                return;
-            this.typesGen.typeImports.addCodecType(codecType);
-            return;
-        }
-        catch (e) { }
-        this.typesGen.addTypeImport(type);
-    }
-    getGeneratedTypeName(type, toTypeIn = true) {
-        try {
-            const matchArray = type.match(WRAPPER_TYPE_REGEX);
-            if (matchArray) {
-                const [_, $1, $2] = matchArray;
-                const wrapperTypeName = this.#getCodecType($1, toTypeIn);
-                if ($2.match(WRAPPER_TYPE_REGEX) || $2.match(TUPLE_TYPE_REGEX)) {
-                    return `${wrapperTypeName}<${this.getGeneratedTypeName($2, toTypeIn)}>`;
-                }
-                const innerTypeNames = $2
-                    .split(',')
-                    .map((one) => this.getGeneratedTypeName(one.trim(), toTypeIn))
-                    .join(', ');
-                return `${wrapperTypeName}<${innerTypeNames}>`;
-            }
-            else if (type.match(TUPLE_TYPE_REGEX)) {
-                const innerTypeNames = type
-                    .slice(1, -1)
-                    .split(',')
-                    .map((one) => this.getGeneratedTypeName(one.trim(), toTypeIn))
-                    .join(', ');
-                return `[${innerTypeNames}]`;
-            }
-            return this.#getCodecType(type, toTypeIn);
-        }
-        catch (e) { }
-        return type;
-    }
-    #getCodecType(type, toTypeIn = true) {
-        const { typeIn, typeOut } = findKnownCodecType(type);
-        return toTypeIn ? typeIn : typeOut;
-    }
-}

package/generator/RuntimeApisGen.d.ts

@@ -1,9 +0,0 @@
-import { TypesGen } from './TypesGen';
-import { RpcGen } from './RpcGen';
-export declare class RuntimeApisGen extends RpcGen {
-    #private;
-    readonly typesGen: TypesGen;
-    readonly runtimeApis: [string, number][];
-    constructor(typesGen: TypesGen, runtimeApis: [string, number][]);
-    generate(): Promise<string>;
-}

package/generator/TxGen.d.ts

@@ -1,5 +0,0 @@
-import { ApiGen } from '../generator';
-export declare class TxGen extends ApiGen {
-    #private;
-    generate(): Promise<string>;
-}

package/generator/index.d.ts

@@ -1,10 +0,0 @@
-export * from './TypesGen';
-export * from './ApiGen';
-export * from './ConstsGen';
-export * from './QueryGen';
-export * from './RpcGen';
-export * from './IndexGen';
-export * from './ErrorsGen';
-export * from './EventsGen';
-export * from './TxGen';
-export * from './RuntimeApisGen';

package/generator/index.js

@@ -1,10 +0,0 @@
-export * from './TypesGen';
-export * from './ApiGen';
-export * from './ConstsGen';
-export * from './QueryGen';
-export * from './RpcGen';
-export * from './IndexGen';
-export * from './ErrorsGen';
-export * from './EventsGen';
-export * from './TxGen';
-export * from './RuntimeApisGen';

package/generator/known-types.d.ts

@@ -1,6 +0,0 @@
-/**
- * Known type names registered in @dedot/types
- * Since TS interfaces are trim-off when compiling,
- * So we need to register them explicitly here for RPC codegen process
- */
-export declare const knownTypes: string[];

package/generator/known-types.js

@@ -1,30 +0,0 @@
-/**
- * Known type names registered in @dedot/types
- * Since TS interfaces are trim-off when compiling,
- * So we need to register them explicitly here for RPC codegen process
- */
-export const knownTypes = [
-    'ExtrinsicOrHash',
-    'EpochAuthorship',
-    'BlockStats',
-    'Prevotes',
-    'Precommits',
-    'RoundState',
-    'ReportedRoundStates',
-    'JustificationNotification',
-    'EncodedFinalityProofs',
-    'LeavesProof',
-    'StorageKind',
-    'RpcMethods',
-    'ReadProof',
-    'StorageChangeSet',
-    'TraceBlockResponse',
-    'MigrationStatusResult',
-    'ChainType',
-    'ChainProperties',
-    'Health',
-    'SyncState',
-    'PeerInfo',
-    'NodeRole',
-    'NetworkState',
-];

package/packageInfo.d.ts

@@ -1,4 +0,0 @@
-export declare const packageInfo: {
-    name: string;
-    version: string;
-};

package/packageInfo.js

@@ -1,2 +0,0 @@
-// THIS FILE IS AUTO-GENERATED, DO NOT EDIT!
-export const packageInfo = { name: '@dedot/codegen', version: '0.0.1-alpha.27' };

package/templates/consts.hbs

@@ -1,7 +0,0 @@
-// Generated by @dedot/codegen
-
-{{{ importTypes }}}
-
-export interface ChainConsts extends GenericChainConsts {
-  {{{ defTypeOut }}}
-}

package/templates/errors.hbs

@@ -1,7 +0,0 @@
-// Generated by @dedot/codegen
-
-{{{ importTypes }}}
-
-export interface ChainErrors extends GenericChainErrors {
-  {{{ defTypeOut }}}
-}

package/templates/events.hbs

@@ -1,7 +0,0 @@
-// Generated by @dedot/codegen
-
-{{{ importTypes }}}
-
-export interface ChainEvents extends GenericChainEvents {
-  {{{ defTypeOut }}}
-}

package/templates/index.hbs

@@ -1,22 +0,0 @@
-// Generated by @dedot/codegen
-
-import { GenericSubstrateApi } from '@dedot/types';
-import { ChainConsts } from './consts';
-import { ChainStorage } from './query';
-import { RpcCalls } from './rpc';
-import { ChainErrors } from './errors';
-import { ChainEvents } from './events';
-import { RuntimeApis } from './runtime';
-import { ChainTx } from './tx';
-
-export * from './types';
-
-export interface {{{interfaceName}}}Api extends GenericSubstrateApi {
-  rpc: RpcCalls;
-  consts: ChainConsts;
-  query: ChainStorage;
-  errors: ChainErrors;
-  events: ChainEvents;
-  call: RuntimeApis;
-  tx: ChainTx;
-}

package/templates/query.hbs

@@ -1,7 +0,0 @@
-// Generated by @dedot/codegen
-
-{{{ importTypes }}}
-
-export interface ChainStorage extends GenericChainStorage {
-  {{{ defTypeOut }}}
-}

package/templates/rpc.hbs

@@ -1,7 +0,0 @@
-// Generated by @dedot/codegen
-
-{{{ importTypes }}}
-
-export interface RpcCalls extends GenericRpcCalls {
-  {{{rpcCallsOut}}}
-}

package/templates/runtime.hbs

@@ -1,8 +0,0 @@
-// Generated by @dedot/codegen
-
-{{{ importTypes }}}
-
-export interface RuntimeApis extends GenericRuntimeApis {
-{{{ runtimeCallsOut }}}
-}
-

package/templates/tx.hbs

@@ -1,9 +0,0 @@
-// Generated by @dedot/codegen
-
-{{{ importTypes }}}
-
-{{{ defTypes }}}
-
-export interface ChainTx extends GenericChainTx<TxCall> {
-  {{{ txDefsOut }}}
-}

package/types.d.ts

@@ -1,6 +0,0 @@
-export type NetworkInfo = {
-    chain: string;
-    endpoint?: string;
-    metadataHex?: string;
-    rpcMethods?: string[];
-};

package/types.js

@@ -1 +0,0 @@
-export {};