@pezkuwi/typegen 16.5.16 → 16.5.18

package/build/templates/errors.hbs

@@ -0,0 +1,28 @@
+{{> header }}
+
+// import type lookup before we augment - in some environments
+// this is required to allow for ambient/previous definitions
+import '@pezkuwi/api-base/types/errors';
+
+{{{ importsAll }}}
+
+export type __AugmentedError<ApiType extends ApiTypes> = AugmentedError<ApiType>;
+
+declare module '@pezkuwi/api-base/types/errors' {
+  interface AugmentedErrors<ApiType extends ApiTypes> {
+    {{#each modules}}
+    {{{name}}}: {
+      {{#each items}}
+      {{> docs}}
+      {{{name}}}: AugmentedError<ApiType>;
+      {{/each}}
+      {{#unless @root.isStrict}}
+      /**
+       * Generic error
+       **/
+      [key: string]: AugmentedError<ApiType>;
+      {{/unless}}
+    };
+    {{/each}}
+  } // AugmentedErrors
+} // declare module

package/build/templates/events.hbs

@@ -0,0 +1,28 @@
+{{> header }}
+
+// import type lookup before we augment - in some environments
+// this is required to allow for ambient/previous definitions
+import '@pezkuwi/api-base/types/events';
+
+{{{ importsAll }}}
+
+export type __AugmentedEvent<ApiType extends ApiTypes> = AugmentedEvent<ApiType>;
+
+declare module '@pezkuwi/api-base/types/events' {
+  interface AugmentedEvents<ApiType extends ApiTypes> {
+    {{#each modules}}
+    {{{name}}}: {
+      {{#each items}}
+      {{> docs}}
+      {{{name}}}: AugmentedEvent<ApiType, {{{type}}}>;
+      {{/each}}
+      {{#unless @root.isStrict}}
+      /**
+       * Generic event
+       **/
+      [key: string]: AugmentedEvent<ApiType>;
+      {{/unless}}
+    };
+    {{/each}}
+  } // AugmentedEvents
+} // declare module

package/build/templates/header.hbs

@@ -0,0 +1,2 @@
+// Auto-generated via `yarn polkadot-types-from-{{headerType}}`, do not edit
+/* eslint-disable */

package/build/templates/interfaceRegistry.hbs

@@ -0,0 +1,15 @@
+{{> header }}
+
+// import type lookup before we augment - in some environments
+// this is required to allow for ambient/previous definitions
+import '@pezkuwi/types/types/registry';
+
+{{{ importsAll }}}
+
+declare module '@pezkuwi/types/types/registry' {
+  interface InterfaceTypes {
+    {{#each items}}
+    {{{this}}}: {{{this}}};
+    {{/each}}
+  } // InterfaceTypes
+} // declare module

package/build/templates/lookup/defs-named.hbs

@@ -0,0 +1,12 @@
+{{> header }}
+
+/* eslint-disable sort-keys */
+
+export default {
+  {{#each defs}}
+  {{> docs}}
+  {{#each defs}}
+  {{{this}}}
+  {{/each}}
+  {{/each}}
+};

package/build/templates/lookup/defs.hbs

@@ -0,0 +1,15 @@
+{{> header }}
+
+/* eslint-disable sort-keys */
+
+export default {
+  rpc: {},
+  types: {
+    {{#each defs}}
+    {{> docs}}
+    {{#each defs}}
+    {{{this}}}
+    {{/each}}
+    {{/each}}
+  }
+};

package/build/templates/lookup/index.hbs

@@ -0,0 +1,3 @@
+{{> header }}
+
+export * from './types.js';

package/build/templates/lookup/types.hbs

@@ -0,0 +1,14 @@
+{{> header }}
+
+// import type lookup before we augment - in some environments
+// this is required to allow for ambient/previous definitions
+import '@pezkuwi/types/lookup';
+
+{{{ importsAll }}}
+
+declare module '@pezkuwi/types/lookup' {
+  {{#each items}}
+{{{this}}}
+
+  {{/each}}
+} // declare module

package/build/templates/query.hbs

@@ -0,0 +1,29 @@
+{{> header }}
+
+// import type lookup before we augment - in some environments
+// this is required to allow for ambient/previous definitions
+import '@pezkuwi/api-base/types/storage';
+
+{{{ importsAll }}}
+
+export type __AugmentedQuery<ApiType extends ApiTypes> = AugmentedQuery<ApiType, () => unknown>;
+export type __QueryableStorageEntry<ApiType extends ApiTypes> = QueryableStorageEntry<ApiType>;
+
+declare module '@pezkuwi/api-base/types/storage' {
+  interface AugmentedQueries<ApiType extends ApiTypes> {
+    {{#each modules}}
+    {{{name}}}: {
+      {{#each items}}
+      {{> docs}}
+      {{{name}}}: {{{entryType}}}<ApiType, ({{{params}}}) => Observable<{{{returnType}}}>, [{{{args}}}]>{{#unless @root.isStrict}} & QueryableStorageEntry<ApiType, [{{{args}}}]>{{/unless}};
+      {{/each}}
+      {{#unless @root.isStrict}}
+      /**
+       * Generic query
+       **/
+      [key: string]: QueryableStorageEntry<ApiType>;
+      {{/unless}}
+    };
+    {{/each}}
+  } // AugmentedQueries
+} // declare module

package/build/templates/rpc.hbs

@@ -0,0 +1,22 @@
+{{> header }}
+
+// import type lookup before we augment - in some environments
+// this is required to allow for ambient/previous definitions
+import '@pezkuwi/rpc-core/types/jsonrpc';
+
+{{{ importsAll }}}
+
+export type __AugmentedRpc = AugmentedRpc<() => unknown>;
+
+declare module '@pezkuwi/rpc-core/types/jsonrpc' {
+  interface RpcInterface {
+    {{#each modules}}
+    {{{name}}}: {
+      {{#each items}}
+      {{> docs}}
+      {{{name}}}: AugmentedRpc<{{#if generic}}<{{{generic}}}>{{/if}}({{{args}}}) => Observable<{{{type}}}>>;
+      {{/each}}
+    };
+    {{/each}}
+  } // RpcInterface
+} // declare module

package/build/templates/tsDef/index.hbs

@@ -0,0 +1,3 @@
+{{> header }}
+
+export * from './types.js';

package/build/templates/tsDef/moduleTypes.hbs

@@ -0,0 +1,10 @@
+{{> header }}
+
+{{{ importsAll }}}
+
+{{#each items}}
+{{{this}}}
+
+{{/each}}
+
+export type PHANTOM_{{#upper}}{{{name}}}{{/upper}} = '{{{name}}}';

package/build/templates/tsDef/types.hbs

@@ -0,0 +1,7 @@
+{{> header }}
+
+{{#each items}}
+export * from './{{{this}}}/types.js';
+{{/each}}
+
+export type PHANTOM_GENERATED = 'generated';

package/build/templates/tx.hbs

@@ -0,0 +1,30 @@
+{{> header }}
+
+// import type lookup before we augment - in some environments
+// this is required to allow for ambient/previous definitions
+import '@pezkuwi/api-base/types/submittable';
+
+{{{ importsAll }}}
+
+export type __AugmentedSubmittable = AugmentedSubmittable<() => unknown>;
+export type __SubmittableExtrinsic<ApiType extends ApiTypes> = SubmittableExtrinsic<ApiType>;
+export type __SubmittableExtrinsicFunction<ApiType extends ApiTypes> = SubmittableExtrinsicFunction<ApiType>;
+
+declare module '@pezkuwi/api-base/types/submittable' {
+  interface AugmentedSubmittables<ApiType extends ApiTypes> {
+    {{#each modules}}
+    {{{name}}}: {
+      {{#each items}}
+      {{> docs}}
+      {{{name}}}: AugmentedSubmittable<({{{params}}}) => SubmittableExtrinsic<ApiType>, [{{{args}}}]>;
+      {{/each}}
+      {{#unless @root.isStrict}}
+      /**
+       * Generic tx
+       **/
+      [key: string]: SubmittableExtrinsicFunction<ApiType>;
+      {{/unless}}
+    };
+    {{/each}}
+  } // AugmentedSubmittables
+} // declare module

package/build/util/assert.d.ts

@@ -0,0 +1,2 @@
+export declare function assertDir(path: string): string;
+export declare function assertFile(path: string): string;

package/build/util/assert.js

@@ -0,0 +1,10 @@
+import fs from 'node:fs';
+import { assert } from '@pezkuwi/util';
+export function assertDir(path) {
+    assert(fs.existsSync(path) && fs.lstatSync(path).isDirectory(), `${path} is not a directory`);
+    return path;
+}
+export function assertFile(path) {
+    assert(fs.existsSync(path) && fs.lstatSync(path).isFile(), `${path} is not a file`);
+    return path;
+}

package/build/util/derived.d.ts

@@ -0,0 +1,4 @@
+import type { Registry } from '@pezkuwi/types/types';
+import type { ModuleTypes, TypeImports } from './imports.js';
+/** @internal */
+export declare function getSimilarTypes(registry: Registry, definitions: Record<string, ModuleTypes>, _type: string, imports: TypeImports): string[];

package/build/util/derived.js

@@ -0,0 +1,125 @@
+import { GenericAccountId, GenericCall, GenericLookupSource, GenericVote } from '@pezkuwi/types/generic';
+import { AllConvictions } from '@pezkuwi/types/interfaces/democracy/definitions';
+import { AbstractInt, bool, Compact, Enum, Null, Option, Struct, Tuple, Vec, WrapperKeepOpaque, WrapperOpaque } from '@pezkuwi/types-codec';
+import { getTypeDef, TypeDefInfo } from '@pezkuwi/types-create';
+import { isChildClass, stringify } from '@pezkuwi/util';
+import { formatType } from './formatting.js';
+import { setImports } from './imports.js';
+function arrayToStrType(arr) {
+    return `${arr.map((c) => `'${c}'`).join(' | ')}`;
+}
+const voteConvictions = arrayToStrType(AllConvictions);
+/** @internal */
+export function getSimilarTypes(registry, definitions, _type, imports) {
+    const typeParts = _type.split('::');
+    const type = typeParts[typeParts.length - 1];
+    const possibleTypes = [formatType(registry, definitions, type, imports)];
+    if (type === 'Extrinsic') {
+        setImports(definitions, imports, ['IExtrinsic']);
+        return ['Extrinsic', 'IExtrinsic', 'string', 'Uint8Array'];
+    }
+    else if (type === 'Keys') {
+        // This one is weird... surely it should popup as a Tuple? (but either way better as defined hex)
+        return ['Keys', 'string', 'Uint8Array'];
+    }
+    else if (type === 'StorageKey') {
+        // TODO We can do better
+        return ['StorageKey', 'string', 'Uint8Array', 'any'];
+    }
+    else if (type === '()') {
+        return ['null'];
+    }
+    const Clazz = registry.createClass(type);
+    if (isChildClass(Vec, Clazz)) {
+        const vecDef = getTypeDef(type);
+        const subDef = (vecDef.sub);
+        // this could be that we define a Vec type and refer to it by name
+        if (subDef) {
+            if (subDef.info === TypeDefInfo.Plain) {
+                possibleTypes.push(`(${getSimilarTypes(registry, definitions, subDef.type, imports).join(' | ')})[]`);
+            }
+            else if (subDef.info === TypeDefInfo.Tuple) {
+                const subs = subDef.sub.map(({ type }) => getSimilarTypes(registry, definitions, type, imports).join(' | '));
+                possibleTypes.push(`([${subs.join(', ')}])[]`);
+            }
+            else if (subDef.info === TypeDefInfo.Option || subDef.info === TypeDefInfo.Vec || subDef.info === TypeDefInfo.VecFixed) {
+                // TODO: Add possibleTypes so imports work
+            }
+            else if (subDef.info === TypeDefInfo.Struct) {
+                // TODO: Add possibleTypes so imports work
+            }
+            else {
+                throw new Error(`Unhandled subtype in Vec, ${stringify(subDef)}`);
+            }
+        }
+    }
+    else if (isChildClass(Enum, Clazz)) {
+        const { defKeys, isBasic } = new Clazz(registry);
+        const keys = defKeys.filter((v) => !v.startsWith('__Unused'));
+        if (isBasic) {
+            possibleTypes.push(arrayToStrType(keys), 'number');
+        }
+        else {
+            // TODO We don't really want any here, these should be expanded
+            possibleTypes.push(...keys.map((k) => `{ ${k}: any }`), 'string');
+        }
+        possibleTypes.push('Uint8Array');
+    }
+    else if (isChildClass(AbstractInt, Clazz) || isChildClass(Compact, Clazz)) {
+        possibleTypes.push('AnyNumber', 'Uint8Array');
+    }
+    else if (isChildClass(GenericLookupSource, Clazz)) {
+        possibleTypes.push('Address', 'AccountId', 'AccountIndex', 'LookupSource', 'string', 'Uint8Array');
+    }
+    else if (isChildClass(GenericAccountId, Clazz)) {
+        possibleTypes.push('string', 'Uint8Array');
+    }
+    else if (isChildClass(GenericCall, Clazz)) {
+        possibleTypes.push('IMethod', 'string', 'Uint8Array');
+    }
+    else if (isChildClass(bool, Clazz)) {
+        possibleTypes.push('boolean', 'Uint8Array');
+    }
+    else if (isChildClass(Null, Clazz)) {
+        possibleTypes.push('null');
+    }
+    else if (isChildClass(Struct, Clazz)) {
+        const s = new Clazz(registry);
+        const obj = s.defKeys.map((key) => `${key}?: any`).join('; ');
+        possibleTypes.push(`{ ${obj} }`, 'string', 'Uint8Array');
+    }
+    else if (isChildClass(Option, Clazz)) {
+        possibleTypes.push('null', 'Uint8Array');
+        const optDef = getTypeDef(type);
+        const subDef = (optDef.sub);
+        if (subDef) {
+            possibleTypes.push(...getSimilarTypes(registry, definitions, subDef.type, imports));
+        }
+        else {
+            possibleTypes.push('object', 'string');
+        }
+    }
+    else if (isChildClass(GenericVote, Clazz)) {
+        possibleTypes.push(`{ aye: boolean; conviction?: ${voteConvictions} | number }`, 'boolean', 'string', 'Uint8Array');
+    }
+    else if (isChildClass(WrapperKeepOpaque, Clazz) || isChildClass(WrapperOpaque, Clazz)) {
+        // TODO inspect container
+        possibleTypes.push('object', 'string', 'Uint8Array');
+    }
+    else if (isChildClass(Uint8Array, Clazz)) {
+        possibleTypes.push('string', 'Uint8Array');
+    }
+    else if (isChildClass(String, Clazz)) {
+        possibleTypes.push('string');
+    }
+    else if (isChildClass(Tuple, Clazz)) {
+        const tupDef = getTypeDef(type);
+        const subDef = tupDef.sub;
+        // this could be that we define a Tuple type and refer to it by name
+        if (Array.isArray(subDef)) {
+            const subs = subDef.map(({ type }) => getSimilarTypes(registry, definitions, type, imports).join(' | '));
+            possibleTypes.push(`[${subs.join(', ')}]`);
+        }
+    }
+    return [...new Set(possibleTypes)];
+}

package/build/util/docs.d.ts

@@ -0,0 +1 @@
+export declare const __TYPEGEN_DUMMY_DOCS = "DUMMY_DOCS";

package/build/util/docs.js

@@ -0,0 +1,6 @@
+import Handlebars from 'handlebars';
+import { readTemplate } from './file.js';
+Handlebars.registerPartial({
+    docs: Handlebars.compile(readTemplate('docs'))
+});
+export const __TYPEGEN_DUMMY_DOCS = 'DUMMY_DOCS';

package/build/util/file.d.ts

@@ -0,0 +1,2 @@
+export declare function writeFile(dest: string, generator: () => string, noLog?: boolean): void;
+export declare function readTemplate(template: string): string;

package/build/util/file.js

@@ -0,0 +1,28 @@
+import fs from 'node:fs';
+import path from 'node:path';
+import process from 'node:process';
+import { packageInfo } from '../packageInfo.js';
+export function writeFile(dest, generator, noLog) {
+    !noLog && console.log(`${dest}\n\tGenerating`);
+    let generated = generator();
+    while (generated.includes('\n\n\n')) {
+        generated = generated.replace(/\n\n\n/g, '\n\n');
+    }
+    !noLog && console.log('\tWriting');
+    fs.writeFileSync(dest, generated, { flag: 'w' });
+    !noLog && console.log('');
+}
+export function readTemplate(template) {
+    // Inside the api repo itself, it will be 'auto'
+    const rootDir = packageInfo.path === 'auto'
+        ? path.join(process.cwd(), 'packages/typegen/src')
+        : packageInfo.path;
+    // NOTE With cjs in a subdir, search one lower as well
+    const file = ['./templates', '../templates']
+        .map((p) => path.join(rootDir, p, `${template}.hbs`))
+        .find((p) => fs.existsSync(p));
+    if (!file) {
+        throw new Error(`Unable to locate ${template}.hbs from ${rootDir}`);
+    }
+    return fs.readFileSync(file).toString();
+}

package/build/util/formatting.d.ts

@@ -0,0 +1,11 @@
+import type { AnyString, Registry } from '@pezkuwi/types/types';
+import type { TypeDef } from '@pezkuwi/types-create/types';
+import type { ModuleTypes, TypeImports } from './imports.js';
+export declare const HEADER: (type: "chain" | "defs") => string;
+/** @internal */
+export declare function exportInterface(lookupIndex: number | undefined, name: string | undefined, base: string, body?: string, withShortcut?: boolean): string;
+/**
+ * Correctly format a given type
+ */
+/** @internal */
+export declare function formatType(registry: Registry, definitions: Record<string, ModuleTypes>, type: AnyString | TypeDef, imports: TypeImports, withShortcut?: boolean): string;