@pezkuwi/typegen 16.5.5 → 16.5.6

package/generate/lookup.d.ts

@@ -0,0 +1,4 @@
+import type { HexString } from '@pezkuwi/util/types';
+import { type TypeImports } from '../util/index.js';
+export declare function generateDefaultLookup(destDir?: string, staticData?: HexString): void;
+export declare function ignoreUnusedLookups(usedTypes: string[], imports: TypeImports): void;

package/generate/lookup.js

@@ -0,0 +1,235 @@
+import Handlebars from 'handlebars';
+import path from 'node:path';
+import * as defaultDefinitions from '@pezkuwi/types/interfaces/definitions';
+import staticAhDicle from '@pezkuwi/types-support/metadata/v15/asset-hub-dicle-hex';
+import staticAhPezkuwi from '@pezkuwi/types-support/metadata/v15/asset-hub-pezkuwi-hex';
+import staticDicle from '@pezkuwi/types-support/metadata/v15/dicle-hex';
+import staticPezkuwi from '@pezkuwi/types-support/metadata/v15/pezkuwi-hex';
+import staticBizinikiwi from '@pezkuwi/types-support/metadata/v15/bizinikiwi-hex';
+import { isString, stringify } from '@pezkuwi/util';
+import { createImports, exportInterface, initMeta, readTemplate, rebrandTypeName, writeFile } from '../util/index.js';
+import { typeEncoders } from './tsDef.js';
+function deepRebrandTypeDef(typeDef, isTopLevel = true) {
+    const rebrandedLookupName = typeDef.lookupName ? rebrandTypeName(typeDef.lookupName) : typeDef.lookupName;
+    const rebranded = {
+        ...typeDef,
+        type: rebrandTypeName(typeDef.type),
+        // For top-level types: set name from lookupName (mimics original: typeDef.name = typeDef.lookupName)
+        // For sub types (enum variants, struct fields): preserve the original name (field/variant name)
+        name: isTopLevel ? (rebrandedLookupName || typeDef.name) : typeDef.name,
+        lookupName: rebrandedLookupName,
+        lookupNameRoot: typeDef.lookupNameRoot ? rebrandTypeName(typeDef.lookupNameRoot) : typeDef.lookupNameRoot
+    };
+    // Recursively rebrand sub types (mark as not top-level)
+    if (typeDef.sub) {
+        if (Array.isArray(typeDef.sub)) {
+            rebranded.sub = typeDef.sub.map((s) => deepRebrandTypeDef(s, false));
+        }
+        else {
+            rebranded.sub = deepRebrandTypeDef(typeDef.sub, false);
+        }
+    }
+    return rebranded;
+}
+const WITH_TYPEDEF = false;
+const generateLookupDefsTmpl = Handlebars.compile(readTemplate('lookup/defs'));
+const generateLookupDefsNamedTmpl = Handlebars.compile(readTemplate('lookup/defs-named'));
+const generateLookupIndexTmpl = Handlebars.compile(readTemplate('lookup/index'));
+const generateLookupTypesTmpl = Handlebars.compile(readTemplate('lookup/types'));
+const generateRegistryTmpl = Handlebars.compile(readTemplate('interfaceRegistry'));
+function generateParamType(registry, { name, type }) {
+    if (type.isSome) {
+        const link = registry.lookup.types[type.unwrap().toNumber()];
+        if (link.type.path.length) {
+            return generateTypeDocs(registry, null, link.type.path, link.type.params);
+        }
+    }
+    return name.toString();
+}
+function generateTypeDocs(registry, id, path, params) {
+    return `${id ? `${registry.createLookupType(id)}${path.length ? ': ' : ''}` : ''}${path.map((p) => p.toString()).join('::')}${params.length ? `<${params.map((p) => generateParamType(registry, p)).join(', ')}>` : ''}`;
+}
+function formatObject(lines) {
+    const max = lines.length - 1;
+    return [
+        '{',
+        ...lines.map((l, index) => (l.endsWith(',') || l.endsWith('{') || index === max || lines[index + 1].endsWith('}') || lines[index + 1].endsWith('}'))
+            ? l
+            : `${l},`),
+        '}'
+    ];
+}
+function expandSet(parsed) {
+    return formatObject(Object.entries(parsed).reduce((all, [k, v]) => {
+        all.push(`${k}: ${v}`);
+        return all;
+    }, []));
+}
+function expandObject(parsed) {
+    if (parsed._set) {
+        return expandSet(parsed._set);
+    }
+    return formatObject(Object.entries(parsed).reduce((all, [k, v]) => {
+        const inner = isString(v)
+            ? expandType(v)
+            : Array.isArray(v)
+                ? [`[${v.map((e) => `'${e}'`).join(', ')}]`]
+                : expandObject(v);
+        inner.forEach((l, index) => {
+            all.push(`${index === 0
+                ? `${k}: ${l}`
+                : `${l}`}`);
+        });
+        return all;
+    }, []));
+}
+function expandType(encoded) {
+    if (!encoded.startsWith('{')) {
+        return [`'${rebrandTypeName(encoded)}'`];
+    }
+    return expandObject(JSON.parse(encoded));
+}
+function expandDefToString({ lookupNameRoot, type }, indent) {
+    if (lookupNameRoot) {
+        return `'${rebrandTypeName(lookupNameRoot)}'`;
+    }
+    const lines = expandType(type);
+    let inc = 0;
+    return lines.map((l, index) => {
+        let r;
+        if (l.endsWith('{')) {
+            r = index === 0
+                ? l
+                : `${' '.padStart(indent + inc)}${l}`;
+            inc += 2;
+        }
+        else {
+            if (l.endsWith('},') || l.endsWith('}')) {
+                inc -= 2;
+            }
+            r = index === 0
+                ? l
+                : `${' '.padStart(indent + inc)}${l}`;
+        }
+        return r;
+    }).join('\n');
+}
+function getFilteredTypes(lookup, exclude = []) {
+    const named = lookup.types.filter(({ id }) => !!lookup.getTypeDef(id).lookupName);
+    const names = named.map(({ id }) => lookup.getName(id));
+    return named
+        .filter((_, index) => !names.some((n, iindex) => index > iindex &&
+        n === names[index]))
+        .map((p) => [p, lookup.getTypeDef(p.id)])
+        .filter(([, typeDef]) => !exclude.includes(typeDef.lookupName || '<invalid>'));
+}
+function generateLookupDefs(registry, filtered, destDir, subPath) {
+    writeFile(path.join(destDir, `${subPath || 'definitions'}.ts`), () => {
+        const all = filtered.map(([{ id, type: { params, path } }, typeDef]) => {
+            const typeLookup = registry.createLookupType(id);
+            const def = expandDefToString(typeDef, subPath ? 2 : 4);
+            return {
+                docs: [
+                    generateTypeDocs(registry, id, path, params),
+                    WITH_TYPEDEF
+                        ? `@typeDef ${stringify(typeDef)}`
+                        : null
+                ].filter((d) => !!d),
+                type: { def, typeLookup, typeName: typeDef.lookupName ? rebrandTypeName(typeDef.lookupName) : undefined }
+            };
+        });
+        const max = all.length - 1;
+        return (subPath ? generateLookupDefsNamedTmpl : generateLookupDefsTmpl)({
+            defs: all.map(({ docs, type }, i) => {
+                const { def, typeLookup, typeName } = type;
+                return {
+                    defs: [
+                        [typeName || typeLookup, `${def}${i !== max ? ',' : ''}`]
+                    ].map(([n, t]) => `${n}: ${t}`),
+                    docs
+                };
+            }),
+            headerType: 'defs'
+        });
+    });
+}
+function generateLookupTypes(registry, filtered, destDir, subPath) {
+    const imports = {
+        ...createImports({ '@pezkuwi/types/interfaces': defaultDefinitions }, { types: {} }),
+        interfaces: []
+    };
+    const items = filtered
+        .map(([, typeDef]) => {
+        // Deep rebrand the type names (including nested sub types) before generating interfaces
+        const rebranded = deepRebrandTypeDef(typeDef);
+        return rebranded.lookupNameRoot && rebranded.lookupName
+            ? exportInterface(rebranded.lookupIndex, rebranded.lookupName, rebranded.lookupNameRoot)
+            : typeEncoders[rebranded.info](registry, imports.definitions, rebranded, imports);
+    })
+        .filter((t) => !!t)
+        .map((t) => t.replace(/\nexport /, '\n'));
+    writeFile(path.join(destDir, `types${subPath ? `-${subPath}` : ''}.ts`), () => generateLookupTypesTmpl({
+        headerType: 'defs',
+        imports,
+        items: items.map((l) => l
+            .split('\n')
+            .map((l) => l.length ? `  ${l}` : '')
+            .join('\n')),
+        types: [
+            ...Object.keys(imports.localTypes).sort().map((packagePath) => ({
+                file: packagePath,
+                types: Object.keys(imports.localTypes[packagePath])
+            }))
+        ]
+    }), true);
+    writeFile(path.join(destDir, 'index.ts'), () => generateLookupIndexTmpl({ headerType: 'defs' }), true);
+}
+function generateRegistry(_registry, filtered, destDir, subPath) {
+    writeFile(path.join(destDir, `${subPath}.ts`), () => {
+        const items = filtered
+            .map(([, { lookupName }]) => lookupName ? rebrandTypeName(lookupName) : lookupName)
+            .filter((n) => !!n)
+            .sort()
+            .reduce((all, n) => all.includes(n) ? all : all.concat(n), []);
+        const imports = createImports({}, { types: {} });
+        imports.lookupTypes = items.reduce((all, n) => ({ ...all, [n]: true }), {});
+        return generateRegistryTmpl({
+            headerType: 'defs',
+            imports,
+            items,
+            types: []
+        });
+    }, true);
+}
+function generateLookup(destDir, entries) {
+    entries.reduce((exclude, [subPath, staticMeta]) => {
+        const { lookup, registry } = initMeta(staticMeta).metadata.asLatest;
+        const filtered = getFilteredTypes(lookup, exclude);
+        generateLookupDefs(registry, filtered, destDir, subPath);
+        generateLookupTypes(registry, filtered, destDir, subPath);
+        generateRegistry(registry, filtered, destDir, subPath === 'lookup' ? 'registry' : `../registry/${subPath}`);
+        return exclude.concat(...filtered
+            .map(([, typeDef]) => typeDef.lookupName)
+            .filter((n) => !!n));
+    }, []);
+}
+export function generateDefaultLookup(destDir = 'packages/types-augment/src/lookup', staticData) {
+    generateLookup(destDir, staticData
+        ? [['lookup', staticData]]
+        : [
+            ['bizinikiwi', staticBizinikiwi],
+            ['pezkuwi', staticPezkuwi],
+            ['dicle', staticDicle],
+            ['assetHubPezkuwi', staticAhPezkuwi],
+            ['assetHubDicle', staticAhDicle]
+        ]);
+}
+export function ignoreUnusedLookups(usedTypes, imports) {
+    const usedStringified = usedTypes.toString();
+    const [lookupKey, typeDefinitions] = Object.entries(imports.localTypes).find(([typeModule, _]) => typeModule.includes('/lookup')) || ['', {}];
+    Object.keys(typeDefinitions).forEach((typeDef) => {
+        if (!(usedStringified.includes(typeDef))) {
+            delete (imports.localTypes[lookupKey])[typeDef];
+        }
+    });
+}

package/generate/query.d.ts

@@ -0,0 +1,5 @@
+import type { Definitions } from '@pezkuwi/types/types';
+import type { HexString } from '@pezkuwi/util/types';
+import { type ExtraTypes } from './types.js';
+/** @internal */
+export declare function generateDefaultQuery(dest: string, data: HexString, extraTypes?: ExtraTypes, isStrict?: boolean, customLookupDefinitions?: Definitions): void;

package/generate/query.js

@@ -0,0 +1,136 @@
+import Handlebars from 'handlebars';
+import * as defaultDefs from '@pezkuwi/types/interfaces/definitions';
+import { unwrapStorageSi } from '@pezkuwi/types/util';
+import lookupDefinitions from '@pezkuwi/types-augment/lookup/definitions';
+import { stringCamelCase } from '@pezkuwi/util';
+import { compareName, createImports, formatType, getSimilarTypes, initMeta, readTemplate, rebrandTypeName, setImports, writeFile } from '../util/index.js';
+import { ignoreUnusedLookups } from './lookup.js';
+import { getDeprecationNotice } from './types.js';
+const generateForMetaTemplate = Handlebars.compile(readTemplate('query'));
+/** @internal */
+function entrySignature(lookup, allDefs, registry, section, storageEntry, imports) {
+    try {
+        const outputType = lookup.getTypeDef(unwrapStorageSi(storageEntry.type));
+        if (storageEntry.type.isPlain) {
+            const typeDef = lookup.getTypeDef(storageEntry.type.asPlain);
+            setImports(allDefs, imports, [
+                rebrandTypeName(typeDef.lookupName || typeDef.type),
+                storageEntry.modifier.isOptional
+                    ? 'Option'
+                    : null
+            ]);
+            return [storageEntry.modifier.isOptional, '', '', formatType(registry, allDefs, outputType, imports)];
+        }
+        else if (storageEntry.type.isMap) {
+            const { hashers, key, value } = storageEntry.type.asMap;
+            const keyDefs = hashers.length === 1
+                ? [lookup.getTypeDef(key)]
+                : lookup.getSiType(key).def.asTuple.map((k) => lookup.getTypeDef(k));
+            const similarTypes = keyDefs.map((k) => getSimilarTypes(registry, allDefs, k.lookupName || k.type, imports));
+            const keyTypes = similarTypes.map((t) => t.join(' | '));
+            const defValue = lookup.getTypeDef(value);
+            setImports(allDefs, imports, [
+                ...similarTypes.reduce((all, t) => all.concat(t), []),
+                storageEntry.modifier.isOptional
+                    ? 'Option'
+                    : null,
+                rebrandTypeName(defValue.lookupName || defValue.type)
+            ]);
+            return [
+                storageEntry.modifier.isOptional,
+                keyDefs.map((k) => formatType(registry, allDefs, k.lookupName || k.type, imports)).join(', '),
+                keyTypes.map((t, i) => `arg${keyTypes.length === 1 ? '' : (i + 1)}: ${t}`).join(', '),
+                rebrandTypeName(outputType.lookupName || '') || formatType(registry, allDefs, outputType, imports)
+            ];
+        }
+        throw new Error(`Expected Plain or Map type, found ${storageEntry.type.type}`);
+    }
+    catch (error) {
+        throw new Error(`entrySignature: Cannot create signature for query ${section}.${storageEntry.name.toString()}:: ${error.message}`);
+    }
+}
+/** @internal */
+function generateForMeta(registry, meta, dest, extraTypes, isStrict, customLookupDefinitions) {
+    writeFile(dest, () => {
+        const allTypes = {
+            '@pezkuwi/types-augment': {
+                lookup: {
+                    ...lookupDefinitions,
+                    ...customLookupDefinitions
+                }
+            },
+            '@pezkuwi/types/interfaces': defaultDefs,
+            ...extraTypes
+        };
+        const imports = createImports(allTypes);
+        const allDefs = Object.entries(allTypes).reduce((defs, [path, obj]) => {
+            return Object.entries(obj).reduce((defs, [key, value]) => ({ ...defs, [`${path}/${key}`]: value }), defs);
+        }, {});
+        const { lookup, pallets } = meta.asLatest;
+        const usedTypes = new Set([]);
+        const modules = pallets
+            .filter(({ storage }) => storage.isSome)
+            .map(({ name, storage }) => {
+            const items = storage.unwrap().items
+                .map((storageEntry) => {
+                const { deprecationInfo, docs, name } = storageEntry;
+                const [isOptional, args, params, _returnType] = entrySignature(lookup, allDefs, registry, name.toString(), storageEntry, imports);
+                if (!deprecationInfo.isNotDeprecated) {
+                    const deprecationNotice = getDeprecationNotice(deprecationInfo, stringCamelCase(name));
+                    const items = docs.length
+                        ? ['', deprecationNotice]
+                        : [deprecationNotice];
+                    docs.push(...items.map((text) => registry.createType('Text', text)));
+                }
+                // Add the type and args to the list of used types
+                if (!(imports.primitiveTypes[_returnType])) {
+                    usedTypes.add(_returnType);
+                }
+                if (!(imports.primitiveTypes[args])) {
+                    usedTypes.add(args);
+                }
+                const returnType = isOptional
+                    ? `Option<${_returnType}>`
+                    : _returnType;
+                return {
+                    args,
+                    docs,
+                    entryType: 'AugmentedQuery',
+                    name: stringCamelCase(storageEntry.name),
+                    params,
+                    returnType
+                };
+            })
+                .sort(compareName);
+            return {
+                items,
+                name: stringCamelCase(name)
+            };
+        })
+            .sort(compareName);
+        imports.typesTypes['Observable'] = true;
+        // filter out the unused lookup types from imports
+        ignoreUnusedLookups([...usedTypes], imports);
+        return generateForMetaTemplate({
+            headerType: 'chain',
+            imports,
+            isStrict,
+            modules,
+            types: [
+                ...Object.keys(imports.localTypes).sort().map((packagePath) => ({
+                    file: packagePath.replace('@pezkuwi/types-augment', '@pezkuwi/types'),
+                    types: Object.keys(imports.localTypes[packagePath])
+                })),
+                {
+                    file: '@pezkuwi/api-base/types',
+                    types: ['ApiTypes', 'AugmentedQuery', 'QueryableStorageEntry']
+                }
+            ]
+        });
+    });
+}
+/** @internal */
+export function generateDefaultQuery(dest, data, extraTypes = {}, isStrict = false, customLookupDefinitions) {
+    const { metadata, registry } = initMeta(data, extraTypes);
+    return generateForMeta(registry, metadata, dest, extraTypes, isStrict, customLookupDefinitions);
+}

package/generate/rpc.d.ts

@@ -0,0 +1,6 @@
+import type { TypeRegistry } from '@pezkuwi/types/create';
+import type { Definitions } from '@pezkuwi/types/types';
+import type { ExtraTypes } from './types.js';
+/** @internal */
+export declare function generateRpcTypes(registry: TypeRegistry, importDefinitions: Record<string, Definitions>, dest: string, extraTypes: ExtraTypes): void;
+export declare function generateDefaultRpc(dest?: string, extraTypes?: ExtraTypes): void;

package/generate/rpc.js

@@ -0,0 +1,110 @@
+import Handlebars from 'handlebars';
+import * as defaultDefinitions from '@pezkuwi/types/interfaces/definitions';
+import staticBizinikiwi from '@pezkuwi/types-support/metadata/static-bizinikiwi';
+import { createImports, formatType, getSimilarTypes, initMeta, readTemplate, setImports, writeFile } from '../util/index.js';
+const StorageKeyType = 'StorageKey | string | Uint8Array | any';
+const generateRpcTypesTemplate = Handlebars.compile(readTemplate('rpc'));
+/** @internal */
+export function generateRpcTypes(registry, importDefinitions, dest, extraTypes) {
+    writeFile(dest, () => {
+        const allTypes = { '@pezkuwi/types/interfaces': importDefinitions, ...extraTypes };
+        const imports = createImports(allTypes);
+        const definitions = imports.definitions;
+        const allDefs = Object.entries(allTypes).reduce((defs, [path, obj]) => {
+            return Object.entries(obj).reduce((defs, [key, value]) => ({ ...defs, [`${path}/${key}`]: value }), defs);
+        }, {});
+        const rpcKeys = Object
+            .keys(definitions)
+            .filter((key) => Object.keys(definitions[key].rpc || {}).length !== 0)
+            .sort();
+        const additional = {};
+        const modules = rpcKeys.map((sectionFullName) => {
+            const rpc = definitions[sectionFullName].rpc || {};
+            const section = sectionFullName.split('/').pop();
+            const allMethods = Object.keys(rpc).sort().map((methodName) => {
+                const def = rpc[methodName];
+                let args;
+                let type;
+                let generic;
+                // These are too hard to type with generics, do manual overrides
+                if (section === 'state') {
+                    setImports(allDefs, imports, ['Codec', 'Hash', 'StorageKey', 'Vec']);
+                    if (methodName === 'getStorage') {
+                        generic = 'T = Codec';
+                        args = [`key: ${StorageKeyType}, block?: Hash | Uint8Array | string`];
+                        type = 'T';
+                    }
+                    else if (methodName === 'queryStorage') {
+                        generic = 'T = Codec[]';
+                        args = [`keys: Vec<StorageKey> | (${StorageKeyType})[], fromBlock?: Hash | Uint8Array | string, toBlock?: Hash | Uint8Array | string`];
+                        type = '[Hash, T][]';
+                    }
+                    else if (methodName === 'queryStorageAt') {
+                        generic = 'T = Codec[]';
+                        args = [`keys: Vec<StorageKey> | (${StorageKeyType})[], at?: Hash | Uint8Array | string`];
+                        type = 'T';
+                    }
+                    else if (methodName === 'subscribeStorage') {
+                        generic = 'T = Codec[]';
+                        args = [`keys?: Vec<StorageKey> | (${StorageKeyType})[]`];
+                        type = 'T';
+                    }
+                }
+                if (args === undefined) {
+                    setImports(allDefs, imports, [def.type]);
+                    args = def.params.map((param) => {
+                        const similarTypes = getSimilarTypes(registry, definitions, param.type, imports);
+                        setImports(allDefs, imports, [param.type, ...similarTypes]);
+                        return `${param.name}${param.isOptional ? '?' : ''}: ${similarTypes.join(' | ')}`;
+                    });
+                    type = formatType(registry, allDefs, def.type, imports);
+                    generic = '';
+                }
+                const item = {
+                    args: args.join(', '),
+                    docs: def.deprecated
+                        ? [`@deprecated ${def.deprecated}`, def.description]
+                        : [def.description],
+                    generic,
+                    name: methodName,
+                    type
+                };
+                if (def.aliasSection) {
+                    if (!additional[def.aliasSection]) {
+                        additional[def.aliasSection] = {
+                            items: [],
+                            name: def.aliasSection
+                        };
+                    }
+                    additional[def.aliasSection].items.push(item);
+                    return null;
+                }
+                return item;
+            }).filter((item) => !!item);
+            return {
+                items: allMethods,
+                name: section || 'unknown'
+            };
+        }).concat(...Object.values(additional)).sort((a, b) => a.name.localeCompare(b.name));
+        imports.typesTypes['Observable'] = true;
+        return generateRpcTypesTemplate({
+            headerType: 'chain',
+            imports,
+            modules,
+            types: [
+                ...Object.keys(imports.localTypes).sort().map((packagePath) => ({
+                    file: packagePath.replace('@pezkuwi/types-augment', '@pezkuwi/types'),
+                    types: Object.keys(imports.localTypes[packagePath])
+                })),
+                {
+                    file: '@pezkuwi/rpc-core/types',
+                    types: ['AugmentedRpc']
+                }
+            ]
+        });
+    });
+}
+export function generateDefaultRpc(dest = 'packages/rpc-augment/src/augment/jsonrpc.ts', extraTypes = {}) {
+    const { registry } = initMeta(staticBizinikiwi, extraTypes);
+    generateRpcTypes(registry, defaultDefinitions, dest, extraTypes);
+}

package/generate/runtime.d.ts

@@ -0,0 +1,7 @@
+import type { Metadata } from '@pezkuwi/types/metadata/Metadata';
+import type { Definitions, Registry } from '@pezkuwi/types/types';
+import type { HexString } from '@pezkuwi/util/types';
+import { type ExtraTypes } from './types.js';
+/** @internal */
+export declare function generateCallTypes(registry: Registry, meta: Metadata, dest: string, extraTypes: ExtraTypes, isStrict: boolean, customLookupDefinitions?: Definitions): void;
+export declare function generateDefaultRuntime(dest: string, data: HexString, extraTypes?: ExtraTypes, isStrict?: boolean, customLookupDefinitions?: Definitions): void;