@dedot/codegen 0.0.1-next.8f4b2c24.6 → 0.0.1-next.9c1d51fe.10

package/typink/generator/TypesGen.js

@@ -0,0 +1,31 @@
+import { extractContractTypes } from '@dedot/contracts';
+import { BaseTypesGen } from '../../shared/index.js';
+import { beautifySourceCode, compileTemplate } from '../../utils.js';
+const SKIP_TYPES = ['Result', 'Option'];
+export class TypesGen extends BaseTypesGen {
+    contractMetadata;
+    constructor(contractMetadata) {
+        super(extractContractTypes(contractMetadata));
+        this.contractMetadata = contractMetadata;
+        this.skipTypes = SKIP_TYPES;
+        this.includedTypes = this.includeTypes();
+    }
+    generate(useSubPaths = false) {
+        let defTypeOut = '';
+        Object.values(this.includedTypes)
+            .filter(({ skip, knownType }) => !(skip || knownType))
+            .forEach(({ name, nameOut, id }) => {
+            defTypeOut += `export type ${nameOut} = ${this.generateType(id, 0, true)};\n\n`;
+            if (this.shouldGenerateTypeIn(id)) {
+                defTypeOut += `export type ${name} = ${this.generateType(id)};\n\n`;
+            }
+        });
+        const importTypes = this.typeImports.toImports({ excludeModules: ['./types'], useSubPaths });
+        const template = compileTemplate('typink/templates/types.hbs');
+        return beautifySourceCode(template({ importTypes, defTypeOut }));
+    }
+    shouldGenerateTypeIn(id) {
+        const { messages } = this.contractMetadata.spec;
+        return messages.some((message) => message.returnType.type === id);
+    }
+}

package/typink/generator/index.d.ts

@@ -0,0 +1,6 @@
+export * from './IndexGen.js';
+export * from './QueryGen.js';
+export * from './TypesGen.js';
+export * from './TxGen.js';
+export * from './ConstructorTxGen.js';
+export * from './ConstructorQueryGen.js';

package/typink/generator/index.js

@@ -0,0 +1,6 @@
+export * from './IndexGen.js';
+export * from './QueryGen.js';
+export * from './TypesGen.js';
+export * from './TxGen.js';
+export * from './ConstructorTxGen.js';
+export * from './ConstructorQueryGen.js';

package/typink/index.d.ts

@@ -0,0 +1,2 @@
+import { ContractMetadata } from '@dedot/contracts';
+export declare function generateContractTypesFromMetadata(metadata: ContractMetadata | string, contract?: string, outDir?: string, extension?: string, useSubPaths?: boolean): Promise<void>;

package/typink/index.js

@@ -0,0 +1,30 @@
+import { parseRawMetadata } from '@dedot/contracts';
+import fs from 'fs';
+import path from 'path';
+import { IndexGen, QueryGen, TxGen, TypesGen, ConstructorTxGen, ConstructorQueryGen } from './generator/index.js';
+export async function generateContractTypesFromMetadata(metadata, contract, outDir = '.', extension = 'd.ts', useSubPaths = false) {
+    let contractMetadata = typeof metadata === 'string' ? parseRawMetadata(metadata) : metadata;
+    contract = contract || contractMetadata.contract.name;
+    const dirPath = path.resolve(outDir, contract);
+    const typesFileName = path.join(dirPath, `types.${extension}`);
+    const queryTypesFileName = path.join(dirPath, `query.${extension}`);
+    const txTypesFileName = path.join(dirPath, `tx.${extension}`);
+    const constructorTxTypesFileName = path.join(dirPath, `constructor-tx.${extension}`);
+    const constructorQueryTypesFileName = path.join(dirPath, `constructor-query.${extension}`);
+    const indexTypesFileName = path.join(dirPath, `index.${extension}`);
+    if (!fs.existsSync(dirPath)) {
+        fs.mkdirSync(dirPath, { recursive: true });
+    }
+    const typesGen = new TypesGen(contractMetadata);
+    const queryGen = new QueryGen(contractMetadata, typesGen);
+    const txGen = new TxGen(contractMetadata, typesGen);
+    const constructorTxGen = new ConstructorTxGen(contractMetadata, typesGen);
+    const constructorQueryGen = new ConstructorQueryGen(contractMetadata, typesGen);
+    const indexGen = new IndexGen(contractMetadata);
+    fs.writeFileSync(typesFileName, await typesGen.generate(useSubPaths));
+    fs.writeFileSync(queryTypesFileName, await queryGen.generate(useSubPaths));
+    fs.writeFileSync(txTypesFileName, await txGen.generate(useSubPaths));
+    fs.writeFileSync(constructorQueryTypesFileName, await constructorQueryGen.generate(useSubPaths));
+    fs.writeFileSync(constructorTxTypesFileName, await constructorTxGen.generate(useSubPaths));
+    fs.writeFileSync(indexTypesFileName, await indexGen.generate(useSubPaths));
+}

package/typink/templates/constructor-query.hbs

@@ -0,0 +1,8 @@
+// Generated by @dedot/codegen
+
+import { GenericSubstrateApi } from '@dedot/types';
+{{{ importTypes }}}
+
+export interface ConstructorQuery<ChainApi extends GenericSubstrateApi> extends GenericConstructorQuery<ChainApi> {
+    {{{ constructorsOut }}}
+}

package/typink/templates/constructor-tx.hbs

@@ -0,0 +1,8 @@
+// Generated by @dedot/codegen
+
+import { GenericSubstrateApi } from '@dedot/types';
+{{{ importTypes }}}
+
+export interface ConstructorTx<ChainApi extends GenericSubstrateApi> extends GenericConstructorTx<ChainApi> {
+    {{{ constructorsOut }}}
+}

package/typink/templates/index.hbs

@@ -0,0 +1,15 @@
+// Generated by @dedot/codegen
+
+{{{importTypes}}}
+import { SubstrateApi } from 'dedot/chaintypes';
+import { ContractQuery } from './query';
+import { ContractTx } from './tx';
+import { ConstructorQuery } from './constructor-query';
+import { ConstructorTx } from './constructor-tx';
+
+export interface {{{contractName}}}<ChainApi extends VersionedGenericSubstrateApi = SubstrateApi> extends GenericContractApi<ChainApi[RpcVersion]> {
+    query: ContractQuery<ChainApi[RpcVersion]>;
+    tx: ContractTx<ChainApi[RpcVersion]>;
+    constructorQuery: ConstructorQuery<ChainApi[RpcVersion]>;
+    constructorTx: ConstructorTx<ChainApi[RpcVersion]>;
+}

package/typink/templates/query.hbs

@@ -0,0 +1,8 @@
+// Generated by @dedot/codegen
+
+import { GenericSubstrateApi } from '@dedot/types';
+{{{ importTypes }}}
+
+export interface ContractQuery<ChainApi extends GenericSubstrateApi> extends GenericContractQuery<ChainApi> {
+    {{{ queryCallsOut }}}
+}

package/typink/templates/tx.hbs

@@ -0,0 +1,8 @@
+// Generated by @dedot/codegen
+
+import { GenericSubstrateApi } from '@dedot/types';
+{{{ importTypes }}}
+
+export interface ContractTx<ChainApi extends GenericSubstrateApi> extends GenericContractTx<ChainApi> {
+    {{{ txCallsOut }}}
+}

package/typink/templates/types.hbs

@@ -0,0 +1,5 @@
+// Generated by @dedot/codegen
+
+{{{ importTypes }}}
+
+{{{ defTypeOut }}}

package/{generator/utils.d.ts → utils.d.ts}

@@ -2,7 +2,7 @@ export declare const WRAPPER_TYPE_REGEX: RegExp;
 export declare const TUPLE_TYPE_REGEX: RegExp;
 export declare const commentBlock: (...docs: (string | string[])[]) => string;
 export declare const beautifySourceCode: (source: string) => Promise<string>;
-export declare const compileTemplate: (templateFileName: string) => HandlebarsTemplateDelegate<any>;
+export declare const compileTemplate: (templateFile: string) => HandlebarsTemplateDelegate<any>;
 /**
  * Check if a word is TypeScript/JavaScript reserved
  * @param word

package/{generator/utils.js → utils.js}

@@ -7,7 +7,7 @@ export const WRAPPER_TYPE_REGEX = /^(\w+)<(.*)>$/;
 export const TUPLE_TYPE_REGEX = /^\[(.*)]$/;
 export const commentBlock = (...docs) => {
     const flatLines = docs.flat();
-    if (flatLines.length === 0) {
+    if (flatLines.length === 0 || !flatLines.find((o) => !!o)) {
         return '';
     }
     else {
@@ -22,8 +22,8 @@ export const beautifySourceCode = async (source) => {
     const prettierOptions = await prettier.resolveConfig(path.resolve(currentDirname(), '../../../../.prettierrc.js'));
     return prettier.format(source, { parser: 'babel-ts', ...prettierOptions });
 };
-export const compileTemplate = (templateFileName) => {
-    const templateFilePath = path.resolve(currentDirname(), `../templates/${templateFileName}`);
+export const compileTemplate = (templateFile) => {
+    const templateFilePath = path.resolve(currentDirname(), templateFile);
     return handlebars.compile(fs.readFileSync(templateFilePath, 'utf8'));
 };
 // TODO add more reserved words

package/cjs/generator/IndexGen.js

@@ -1,17 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.IndexGen = void 0;
-const utils_js_1 = require("./utils.js");
-const utils_1 = require("@dedot/utils");
-class IndexGen {
-    chain;
-    constructor(chain) {
-        this.chain = chain;
-    }
-    async generate() {
-        const interfaceName = (0, utils_1.stringPascalCase)(this.chain);
-        const template = (0, utils_js_1.compileTemplate)('index.hbs');
-        return (0, utils_js_1.beautifySourceCode)(template({ interfaceName }));
-    }
-}
-exports.IndexGen = IndexGen;

package/cjs/templates/consts.hbs

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

package/cjs/templates/errors.hbs

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

package/cjs/templates/events.hbs

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

package/cjs/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 { ChainJsonRpcApis } from './json-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: ChainJsonRpcApis;
-  consts: ChainConsts;
-  query: ChainStorage;
-  errors: ChainErrors;
-  events: ChainEvents;
-  call: RuntimeApis;
-  tx: ChainTx;
-}

package/cjs/templates/json-rpc.hbs

@@ -1,5 +0,0 @@
-// Generated by @dedot/codegen
-
-{{{ importTypes }}}
-
-export type ChainJsonRpcApis = Pick<JsonRpcApis, {{{jsonRpcMethods}}}> & GenericJsonRpcApis;

package/cjs/templates/query.hbs

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

package/cjs/templates/runtime.hbs

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

package/generator/IndexGen.js

@@ -1,13 +0,0 @@
-import { beautifySourceCode, compileTemplate } from './utils.js';
-import { stringPascalCase } from '@dedot/utils';
-export class IndexGen {
-    chain;
-    constructor(chain) {
-        this.chain = chain;
-    }
-    async generate() {
-        const interfaceName = stringPascalCase(this.chain);
-        const template = compileTemplate('index.hbs');
-        return beautifySourceCode(template({ interfaceName }));
-    }
-}

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 { ChainJsonRpcApis } from './json-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: ChainJsonRpcApis;
-  consts: ChainConsts;
-  query: ChainStorage;
-  errors: ChainErrors;
-  events: ChainEvents;
-  call: RuntimeApis;
-  tx: ChainTx;
-}

package/templates/json-rpc.hbs

@@ -1,5 +0,0 @@
-// Generated by @dedot/codegen
-
-{{{ importTypes }}}
-
-export type ChainJsonRpcApis = Pick<JsonRpcApis, {{{jsonRpcMethods}}}> & GenericJsonRpcApis;

package/templates/query.hbs

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

package/templates/runtime.hbs

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