@dedot/codegen 0.0.1-next.ce93b605.2 → 0.0.1-next.cfee875e.21

package/cjs/typink/generator/TxGen.js

@@ -0,0 +1,25 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TxGen = void 0;
+const utils_js_1 = require("../../utils.js");
+const QueryGen_js_1 = require("./QueryGen.js");
+class TxGen extends QueryGen_js_1.QueryGen {
+    generate(useSubPaths = false) {
+        this.typesGen.clearCache();
+        this.typesGen.typeImports.addKnownType('GenericSubstrateApi');
+        this.typesGen.typeImports.addContractType('GenericContractTx', 'GenericContractTxCall', 'ContractTxOptions', 'ContractSubmittableExtrinsic');
+        const { messages } = this.contractMetadata.spec;
+        const txMessages = messages.filter((one) => one.mutates);
+        const txCallsOut = this.doGenerate(txMessages, 'ContractTxOptions');
+        const importTypes = this.typesGen.typeImports.toImports({ useSubPaths });
+        const template = (0, utils_js_1.compileTemplate)('typink/templates/tx.hbs');
+        return (0, utils_js_1.beautifySourceCode)(template({ importTypes, txCallsOut }));
+    }
+    generateMethodDef(def) {
+        const { args } = def;
+        args.forEach(({ type: { type } }) => this.importType(type));
+        const paramsOut = this.generateParamsOut(args);
+        return `GenericContractTxCall<ChainApi, (${paramsOut && `${paramsOut},`} options: ContractTxOptions) => ContractSubmittableExtrinsic<ChainApi>>`;
+    }
+}
+exports.TxGen = TxGen;

package/cjs/typink/generator/TypesGen.js

@@ -0,0 +1,35 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TypesGen = void 0;
+const contracts_1 = require("@dedot/contracts");
+const index_js_1 = require("../../shared/index.js");
+const utils_js_1 = require("../../utils.js");
+const SKIP_TYPES = ['Result', 'Option'];
+class TypesGen extends index_js_1.BaseTypesGen {
+    contractMetadata;
+    constructor(contractMetadata) {
+        super((0, contracts_1.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 = (0, utils_js_1.compileTemplate)('typink/templates/types.hbs');
+        return (0, utils_js_1.beautifySourceCode)(template({ importTypes, defTypeOut }));
+    }
+    shouldGenerateTypeIn(id) {
+        const { messages } = this.contractMetadata.spec;
+        return messages.some((message) => message.returnType.type === id);
+    }
+}
+exports.TypesGen = TypesGen;

package/cjs/typink/generator/index.js

@@ -0,0 +1,22 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./IndexGen.js"), exports);
+__exportStar(require("./QueryGen.js"), exports);
+__exportStar(require("./TypesGen.js"), exports);
+__exportStar(require("./TxGen.js"), exports);
+__exportStar(require("./ConstructorTxGen.js"), exports);
+__exportStar(require("./ConstructorQueryGen.js"), exports);

package/cjs/typink/index.js

@@ -0,0 +1,37 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.generateContractTypes = void 0;
+const contracts_1 = require("@dedot/contracts");
+const fs_1 = __importDefault(require("fs"));
+const path_1 = __importDefault(require("path"));
+const index_js_1 = require("./generator/index.js");
+async function generateContractTypes(metadata, contract, outDir = '.', extension = 'd.ts', useSubPaths = false) {
+    let contractMetadata = typeof metadata === 'string' ? (0, contracts_1.parseRawMetadata)(metadata) : metadata;
+    contract = contract || contractMetadata.contract.name;
+    const dirPath = path_1.default.resolve(outDir, contract);
+    const typesFileName = path_1.default.join(dirPath, `types.${extension}`);
+    const queryTypesFileName = path_1.default.join(dirPath, `query.${extension}`);
+    const txTypesFileName = path_1.default.join(dirPath, `tx.${extension}`);
+    const constructorTxTypesFileName = path_1.default.join(dirPath, `constructor-tx.${extension}`);
+    const constructorQueryTypesFileName = path_1.default.join(dirPath, `constructor-query.${extension}`);
+    const indexTypesFileName = path_1.default.join(dirPath, `index.${extension}`);
+    if (!fs_1.default.existsSync(dirPath)) {
+        fs_1.default.mkdirSync(dirPath, { recursive: true });
+    }
+    const typesGen = new index_js_1.TypesGen(contractMetadata);
+    const queryGen = new index_js_1.QueryGen(contractMetadata, typesGen);
+    const txGen = new index_js_1.TxGen(contractMetadata, typesGen);
+    const constructorTxGen = new index_js_1.ConstructorTxGen(contractMetadata, typesGen);
+    const constructorQueryGen = new index_js_1.ConstructorQueryGen(contractMetadata, typesGen);
+    const indexGen = new index_js_1.IndexGen(contractMetadata);
+    fs_1.default.writeFileSync(typesFileName, await typesGen.generate(useSubPaths));
+    fs_1.default.writeFileSync(queryTypesFileName, await queryGen.generate(useSubPaths));
+    fs_1.default.writeFileSync(txTypesFileName, await txGen.generate(useSubPaths));
+    fs_1.default.writeFileSync(constructorQueryTypesFileName, await constructorQueryGen.generate(useSubPaths));
+    fs_1.default.writeFileSync(constructorTxTypesFileName, await constructorTxGen.generate(useSubPaths));
+    fs_1.default.writeFileSync(indexTypesFileName, await indexGen.generate(useSubPaths));
+}
+exports.generateContractTypes = generateContractTypes;

package/cjs/typink/templates/constructor-query.hbs

@@ -0,0 +1,7 @@
+// Generated by dedot cli
+
+{{{ importTypes }}}
+
+export interface ConstructorQuery<ChainApi extends GenericSubstrateApi> extends GenericConstructorQuery<ChainApi> {
+    {{{ constructorsOut }}}
+}

package/cjs/typink/templates/constructor-tx.hbs

@@ -0,0 +1,7 @@
+// Generated by dedot cli
+
+{{{ importTypes }}}
+
+export interface ConstructorTx<ChainApi extends GenericSubstrateApi> extends GenericConstructorTx<ChainApi> {
+    {{{ constructorsOut }}}
+}

package/cjs/typink/templates/index.hbs

@@ -0,0 +1,14 @@
+// Generated by dedot cli
+
+{{{importTypes}}}
+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> {
+    query: ContractQuery<ChainApi[RpcVersion]>;
+    tx: ContractTx<ChainApi[RpcVersion]>;
+    constructorQuery: ConstructorQuery<ChainApi[RpcVersion]>;
+    constructorTx: ConstructorTx<ChainApi[RpcVersion]>;
+}

package/cjs/typink/templates/query.hbs

@@ -0,0 +1,7 @@
+// Generated by dedot cli
+
+{{{ importTypes }}}
+
+export interface ContractQuery<ChainApi extends GenericSubstrateApi> extends GenericContractQuery<ChainApi> {
+    {{{ queryCallsOut }}}
+}

package/cjs/typink/templates/tx.hbs

@@ -0,0 +1,7 @@
+// Generated by dedot cli
+
+{{{ importTypes }}}
+
+export interface ContractTx<ChainApi extends GenericSubstrateApi> extends GenericContractTx<ChainApi> {
+    {{{ txCallsOut }}}
+}

package/cjs/typink/templates/types.hbs

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

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

@@ -26,7 +26,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.isReservedWord = exports.compileTemplate = exports.beautifySourceCode = exports.commentBlock = exports.TUPLE_TYPE_REGEX = exports.WRAPPER_TYPE_REGEX = void 0;
+exports.isNativeType = exports.isReservedWord = exports.compileTemplate = exports.beautifySourceCode = exports.commentBlock = exports.TUPLE_TYPE_REGEX = exports.WRAPPER_TYPE_REGEX = void 0;
 const fs = __importStar(require("fs"));
 const handlebars_1 = __importDefault(require("handlebars"));
 const path = __importStar(require("path"));
@@ -36,7 +36,7 @@ exports.WRAPPER_TYPE_REGEX = /^(\w+)<(.*)>$/;
 exports.TUPLE_TYPE_REGEX = /^\[(.*)]$/;
 const commentBlock = (...docs) => {
     const flatLines = docs.flat();
-    if (flatLines.length === 0) {
+    if (flatLines.length === 0 || !flatLines.find((o) => !!o)) {
         return '';
     }
     else {
@@ -49,12 +49,12 @@ ${flatLines.map((line) => `* ${line.replaceAll(/\s+/g, ' ').trim()}`).join('\n')
 };
 exports.commentBlock = commentBlock;
 const beautifySourceCode = async (source) => {
-    const prettierOptions = await prettier.resolveConfig(path.resolve((0, dirname_1.currentDirname)(), '../../../../.prettierrc.js'));
+    const prettierOptions = await prettier.resolveConfig(path.resolve((0, dirname_1.currentDirname)(), '../../../.prettierrc.cjs'));
     return prettier.format(source, { parser: 'babel-ts', ...prettierOptions });
 };
 exports.beautifySourceCode = beautifySourceCode;
-const compileTemplate = (templateFileName) => {
-    const templateFilePath = path.resolve((0, dirname_1.currentDirname)(), `../templates/${templateFileName}`);
+const compileTemplate = (templateFile) => {
+    const templateFilePath = path.resolve((0, dirname_1.currentDirname)(), templateFile);
     return handlebars_1.default.compile(fs.readFileSync(templateFilePath, 'utf8'));
 };
 exports.compileTemplate = compileTemplate;
@@ -66,3 +66,32 @@ const TS_RESERVED_WORDS = ['new', 'class'];
  */
 const isReservedWord = (word) => TS_RESERVED_WORDS.includes(word);
 exports.isReservedWord = isReservedWord;
+const TS_PRIMITIVE_TYPES = [
+    'void',
+    'undefined',
+    'null',
+    'number',
+    'boolean',
+    'bigint',
+    'Map',
+    'Set',
+    'string',
+    'any',
+    'Array',
+    'Record',
+];
+/**
+ * Check if a type is native JS/TS type
+ * @param type
+ */
+const isNativeType = (type) => {
+    return TS_PRIMITIVE_TYPES.some((one) => {
+        if (typeof one === 'string') {
+            return one === type;
+        }
+        else {
+            return type.match(one);
+        }
+    });
+};
+exports.isNativeType = isNativeType;

package/index.d.ts

@@ -1,4 +1,2 @@
-import { MetadataLatest } from '@dedot/codecs';
-import { NetworkInfo } from './types';
-export declare function generateTypesFromChain(network: NetworkInfo, endpoint: string, outDir: string): Promise<void>;
-export declare function generateTypes(network: NetworkInfo, metadata: MetadataLatest, rpcMethods: string[], runtimeApis: any[], outDir?: string): Promise<void>;
+export * from './chaintypes/index.js';
+export * from './typink/index.js';

package/index.js

@@ -1,48 +1,2 @@
-import { Dedot } from 'dedot';
-import * as fs from 'fs';
-import * as path from 'path';
-import { ConstsGen, ErrorsGen, EventsGen, IndexGen, QueryGen, RpcGen, RuntimeApisGen, TxGen, TypesGen, } from './generator';
-import { stringCamelCase } from '@polkadot/util';
-export async function generateTypesFromChain(network, endpoint, outDir) {
-    const api = await Dedot.create(endpoint);
-    const { methods } = await api.rpc.rpc.methods();
-    const apis = api.runtimeVersion?.apis || [];
-    if (!network.chain) {
-        network.chain = stringCamelCase(api.runtimeVersion?.specName || api.runtimeChain || 'local');
-    }
-    await generateTypes(network, api.metadataLatest, methods, apis, outDir);
-    await api.disconnect();
-}
-export async function generateTypes(network, metadata, rpcMethods, runtimeApis, outDir = '.') {
-    const dirPath = path.resolve(outDir, network.chain);
-    const defTypesFileName = path.join(dirPath, `types.d.ts`);
-    const constsTypesFileName = path.join(dirPath, `consts.d.ts`);
-    const queryTypesFileName = path.join(dirPath, `query.d.ts`);
-    const rpcCallsFileName = path.join(dirPath, `rpc.d.ts`);
-    const indexFileName = path.join(dirPath, `index.d.ts`);
-    const errorsFileName = path.join(dirPath, `errors.d.ts`);
-    const eventsFileName = path.join(dirPath, `events.d.ts`);
-    const runtimeApisFileName = path.join(dirPath, `runtime.d.ts`);
-    const txFileName = path.join(dirPath, `tx.d.ts`);
-    if (!fs.existsSync(dirPath)) {
-        fs.mkdirSync(dirPath, { recursive: true });
-    }
-    const typesGen = new TypesGen(metadata);
-    const constsGen = new ConstsGen(typesGen);
-    const queryGen = new QueryGen(typesGen);
-    const rpcGen = new RpcGen(typesGen, rpcMethods);
-    const indexGen = new IndexGen(network);
-    const errorsGen = new ErrorsGen(typesGen);
-    const eventsGen = new EventsGen(typesGen);
-    const runtimeApisGen = new RuntimeApisGen(typesGen, runtimeApis);
-    const txGen = new TxGen(typesGen);
-    fs.writeFileSync(defTypesFileName, await typesGen.generate());
-    fs.writeFileSync(errorsFileName, await errorsGen.generate());
-    fs.writeFileSync(eventsFileName, await eventsGen.generate());
-    fs.writeFileSync(rpcCallsFileName, await rpcGen.generate());
-    fs.writeFileSync(queryTypesFileName, await queryGen.generate());
-    fs.writeFileSync(constsTypesFileName, await constsGen.generate());
-    fs.writeFileSync(txFileName, await txGen.generate());
-    fs.writeFileSync(indexFileName, await indexGen.generate());
-    fs.writeFileSync(runtimeApisFileName, await runtimeApisGen.generate());
-}
+export * from './chaintypes/index.js';
+export * from './typink/index.js';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dedot/codegen",
-  "version": "0.0.1-next.ce93b605.2+ce93b60",
+  "version": "0.0.1-next.cfee875e.21+cfee875",
   "description": "Generate types",
   "author": "Thang X. Vu <thang@coongcrafts.io>",
   "homepage": "https://github.com/dedotdev/dedot/tree/main/packages/codegen",
@@ -15,36 +15,33 @@
   "scripts": {
     "build": "tsc --project tsconfig.build.json && tsc --project tsconfig.build.cjs.json && yarn copy",
     "clean": "rm -rf ./dist && rm -rf ./tsconfig.tsbuildinfo ./tsconfig.build.tsbuildinfo",
-    "copy": "cp -R ./src/templates ./dist && cp -R ./src/templates ./dist/cjs"
+    "copy": "cp -R ./src/chaintypes/templates ./dist/chaintypes && cp -R ./src/chaintypes/templates ./dist/cjs/chaintypes && cp -R ./src/typink/templates ./dist/typink && cp -R ./src/typink/templates ./dist/cjs/typink"
   },
   "dependencies": {
-    "@dedot/codecs": "0.0.1-next.ce93b605.2+ce93b60",
-    "@dedot/shape": "0.0.1-next.ce93b605.2+ce93b60",
-    "@dedot/specs": "0.0.1-next.ce93b605.2+ce93b60",
-    "@dedot/utils": "0.0.1-next.ce93b605.2+ce93b60",
-    "@polkadot/util": "^12.6.2",
-    "dedot": "0.0.1-next.ce93b605.2+ce93b60",
-    "handlebars": "^4.7.8",
-    "prettier": "^3.0.3"
+    "@dedot/api": "0.0.1-next.cfee875e.21+cfee875",
+    "@dedot/codecs": "0.0.1-next.cfee875e.21+cfee875",
+    "@dedot/providers": "0.0.1-next.cfee875e.21+cfee875",
+    "@dedot/runtime-specs": "0.0.1-next.cfee875e.21+cfee875",
+    "@dedot/shape": "0.0.1-next.cfee875e.21+cfee875",
+    "@dedot/types": "0.0.1-next.cfee875e.21+cfee875",
+    "@dedot/utils": "0.0.1-next.cfee875e.21+cfee875",
+    "handlebars": "^4.7.7",
+    "prettier": "^3.2.5"
   },
   "publishConfig": {
     "access": "public",
     "directory": "dist"
   },
   "license": "Apache-2.0",
-  "gitHead": "ce93b60580f35ca55e074f94324a8704904257c4",
+  "gitHead": "cfee875eafba07e0fbb8a72556ca549a62ddceff",
   "module": "./index.js",
   "types": "./index.d.ts",
   "exports": {
     ".": {
-      "import": {
-        "types": "./index.d.ts",
-        "default": "./index.js"
-      },
-      "require": {
-        "types": "./index.d.ts",
-        "default": "./cjs/index.js"
-      }
+      "types": "./index.d.ts",
+      "import": "./index.js",
+      "require": "./cjs/index.js",
+      "default": "./index.js"
     }
   }
 }

package/{generator/TypesGen.d.ts → shared/BaseTypesGen.d.ts}

@@ -1,6 +1,7 @@
-import { PortableRegistry, Field, MetadataLatest, PortableType, TypeId } from '@dedot/codecs';
-import { TypeImports } from './TypeImports';
-interface NamedType extends PortableType {
+import { Field, PortableType, TypeId } from '@dedot/codecs';
+import { EnumOptions } from '@dedot/shape';
+import { TypeImports } from './TypeImports.js';
+export interface NamedType extends PortableType {
     name: string;
     nameOut: string;
     skip?: boolean;
@@ -8,23 +9,23 @@ interface NamedType extends PortableType {
     suffix?: string;
 }
 export declare const BASIC_KNOWN_TYPES: string[];
-export declare class TypesGen {
+export declare abstract class BaseTypesGen {
     #private;
-    metadata: MetadataLatest;
-    /**
-     * Types will be generated its definition out.
-     */
+    types: PortableType[];
     includedTypes: Record<TypeId, NamedType>;
-    registry: PortableRegistry;
     typeImports: TypeImports;
-    constructor(metadata: MetadataLatest);
-    generate(): Promise<string>;
+    skipTypes: string[];
+    protected constructor(types: PortableType[]);
+    abstract shouldGenerateTypeIn(id: TypeId): boolean;
     typeCache: Record<string, string>;
     clearCache(): void;
+    includeTypes(): Record<TypeId, NamedType>;
     generateType(typeId: TypeId, nestedLevel?: number, typeOut?: boolean): string;
     generateObjectType(fields: Field[], nestedLevel?: number, typeOut?: boolean): string;
+    cleanPath(path: string[]): string;
     eqlCache: Map<string, boolean>;
     typeEql(idA: number, idB: number, level?: number): boolean;
+    extractDupTypeSuffix(dupTypeId: TypeId, originalTypeId: TypeId, dupCount: number): string;
     addTypeImport(typeName: string | string[]): void;
+    getEnumOptions(_typeId: TypeId): EnumOptions;
 }
-export {};