chore(js): update dependencies, fix linter (#787)

.github/dependabot.yml

@@ -17,7 +17,12 @@ updates:
     schedule:
       interval: "weekly"
   - package-ecosystem: "npm"
-    directory: "./js"
+    directory: "/"
     schedule:
       interval: "weekly"
     versioning-strategy: "increase"
+    groups:
+      development:
+        dependency-type: "development"
+      production:
+        dependency-type: "production"

.github/workflows/js-ci.yml

@@ -28,12 +28,12 @@ jobs:
       - name: 'Install: dependencies'
         run: yarn install
 
-      - name: 'Prepare: build all'
-        run: yarn build
-
-      - name: 'Prepare: fmt'
+      - name: 'Check lint'
         run: yarn lint
 
+      - name: 'Build'
+        run: yarn build
+
       - name: 'Prepare: download Gear node'
         run: |
           wget -O ./gear https://github.com/gear-tech/gear/releases/download/build/gear

.yarnrc.yml

@@ -1,2 +1,2 @@
-yarnPath: .yarn/releases/yarn-4.4.1.cjs
 nodeLinker: node-modules
+yarnPath: .yarn/releases/yarn-4.6.0.cjs

eslint.config.mjs

@@ -1,17 +1,46 @@
-import globals from 'globals';
-import pluginJs from '@eslint/js';
+import eslint from '@eslint/js';
 import tseslint from 'typescript-eslint';
+import eslintPluginUnicorn from 'eslint-plugin-unicorn';
+import globals from 'globals';
+
+const files = ['js/**/src/**/*.ts', 'js/test/*.ts'];
 
 export default [
-  { files: ['js/**/src/**/*.{ts}'] },
-  { languageOptions: { globals: { ...globals.browser, ...globals.node } } },
-  pluginJs.configs.recommended,
-  ...tseslint.configs.recommended,
   {
+    ignores: ['js/cli/build/**', '.yarn/**', '**/lib/**', 'js/test/demo/**'],
+  },
+  ...[eslint.configs.recommended, ...tseslint.configs.recommended, eslintPluginUnicorn.configs['flat/recommended']].map(
+    (config) => ({
+      ...config,
+      files,
+    }),
+  ),
+  {
+    files,
     rules: {
+      '@typescript-eslint/no-unused-vars': [
+        'error',
+        {
+          args: 'all',
+          argsIgnorePattern: '^_',
+          varsIgnorePattern: '^_',
+          caughtErrorsIgnorePattern: '^_',
+          destructuredArrayIgnorePattern: '^_',
+          ignoreRestSiblings: true,
+        },
+      ],
       '@typescript-eslint/no-explicit-any': 'off',
-      '@typescript-eslint/no-this-alias': 'off',
-      'no-unexpected-multiline': 'off',
+      '@typescript-eslint/no-empty-object-type': ['error', { allowInterfaces: 'with-single-extends' }],
+      'prefer-rest-params': 'off',
+      'unicorn/prevent-abbreviations': 'off',
+      'unicorn/no-null': 'off',
+    },
+    languageOptions: {
+      globals: {
+        ...globals.browser,
+        ...globals.es2020,
+        ...globals.node,
+      },
     },
   },
 ];

js/CHANGELOG.md

@@ -1,5 +1,13 @@
 # CHANGELOG
 
+## 0.3.2
+
+### Compatibility
+- Sails-RS v0.7.1
+
+### Changes
+- Ability to get `gasInfo` in `TransactionBuilder` in https://github.com/gear-tech/sails/pull/745
+
 ## 0.3.1
 
 ### Compatibility

js/cli/package.json

@@ -1,5 +1,6 @@
 {
   "name": "sails-js-cli",
+  "description": "CLI allowing to generate Typescript library based on Sails IDL files",
   "version": "0.3.1",
   "preferGlobal": true,
   "type": "module",
@@ -11,7 +12,8 @@
   "homepage": "https://github.com/gear-tech/sails/tree/master/js#readme",
   "repository": {
     "type": "git",
-    "url": "git+https://githib.com/gear-tech/sails.git"
+    "url": "git+https://githib.com/gear-tech/sails.git",
+    "directory": "js/cli"
   },
   "keywords": [
     "gear",
@@ -21,15 +23,16 @@
     "sails-js": "./build/app.js"
   },
   "devDependencies": {
-    "@inquirer/prompts": "^7.1.0",
-    "commander": "^12.1.0",
-    "inquirer": "^12.1.0",
+    "@inquirer/prompts": "^7.2.3",
+    "commander": "^13.1.0",
+    "inquirer": "^12.3.2",
     "sails-js": "workspace:*",
     "sails-js-parser": "workspace:*",
     "sails-js-util": "workspace:^"
   },
   "scripts": {
-    "build": "npx rollup --config rollup.config.js"
+    "build": "npx rollup --config rollup.config.js",
+    "clean": "rm -rf build"
   },
   "files": [
     "build"

js/cli/rollup.config.js

@@ -1,4 +1,4 @@
-import { readFileSync, rmSync, writeFileSync } from 'fs';
+import { readFileSync, rmSync, writeFileSync } from 'node:fs';
 import commonjs from '@rollup/plugin-commonjs';
 import nodeResolve from '@rollup/plugin-node-resolve';
 import typescript from 'rollup-plugin-typescript2';
@@ -17,14 +17,14 @@ function updateConfigVersions() {
   return {
     name: 'update-config-versions',
     buildStart() {
-      const sailsJs = JSON.parse(readFileSync('../package.json', 'utf-8'));
-      const rootPkgJson = JSON.parse(readFileSync('../../package.json', 'utf-8'));
-      const config = JSON.parse(readFileSync('src/config.json', 'utf-8'));
+      const sailsJs = JSON.parse(readFileSync('../package.json', 'utf8'));
+      const rootPackageJson = JSON.parse(readFileSync('../../package.json', 'utf8'));
+      const config = JSON.parse(readFileSync('src/config.json', 'utf8'));
 
       config.versions['gear-js'] = sailsJs.peerDependencies['@gear-js/api'];
       config.versions['polkadot-api'] = sailsJs.peerDependencies['@polkadot/api'];
       config.versions['sails-js'] = sailsJs.version;
-      config.versions['typescript'] = rootPkgJson.devDependencies.typescript;
+      config.versions['typescript'] = rootPackageJson.devDependencies.typescript;
 
       writeFileSync('src/config.json', JSON.stringify(config, null, 2));
     },

js/cli/src/config.json

@@ -15,9 +15,9 @@
     ]
   },
   "versions": {
-    "gear-js": "0.38.3",
-    "polkadot-api": "13.2.1",
+    "gear-js": "0.40.0",
+    "polkadot-api": "15.4.1",
     "sails-js": "0.3.1",
-    "typescript": "^5.7.2"
+    "typescript": "^5.7.3"
   }
 }

js/cli/src/generate/index.ts

@@ -1,11 +1,10 @@
+import { existsSync, mkdirSync, readFileSync, writeFileSync } from 'node:fs';
+import { confirm } from '@inquirer/prompts';
 import { Sails } from 'sails-js';
-
+import path from 'node:path';
 import { ServiceGenerator } from './service-gen.js';
 import { TypesGenerator } from './types-gen.js';
 import { Output } from './output.js';
-import { existsSync, mkdirSync, readFileSync, writeFileSync } from 'fs';
-import path from 'path';
-import { confirm } from '@inquirer/prompts';
 import * as config from '../config.json';
 
 export class ProjectBuilder {
@@ -50,14 +49,14 @@ export class ProjectBuilder {
   }
 
   setIdlPath(path: string) {
-    const idl = readFileSync(path, 'utf-8');
+    const idl = readFileSync(path, 'utf8');
     this.sails.parseIdl(idl);
 
     return this;
   }
 
   setRootPath(path: string) {
-    this.projectPath[0] = path ? path : '.';
+    this.projectPath[0] = path ?? '.';
 
     return this;
   }
@@ -89,15 +88,15 @@ export class ProjectBuilder {
     if (await this.canCreateFile(libFile)) {
       writeFileSync(libFile, libCode);
     } else {
-      process.exit(0);
+      throw new Error(`Failed to write file ${libFile}`);
     }
 
     const typesCode = this.generateTypes();
     const typesFile = path.join(libPath, 'global.d.ts');
     if (await this.canCreateFile(typesFile)) {
       writeFileSync(typesFile, typesCode);
     } else {
-      process.exit(0);
+      throw new Error(`Failed to write file ${typesFile}`);
     }
 
     if (!this.isProject) {

js/cli/src/generate/output.ts

@@ -41,14 +41,14 @@ export class Output {
   }
 
   lines(data: string[], semicolon = true) {
-    data.forEach((line) => this.line(line, semicolon));
+    for (const line of data) this.line(line, semicolon);
     return this;
   }
 
   block(beginning: string, content?: () => void, bracket: '{' | '[' | '(' = '{') {
     const openBracket = bracket;
-    const closeBracket = openBracket === '{' ? '}' : openBracket === '[' ? '];' : ');';
-    this._rows.push(`${this._indent}${beginning} ${openBracket}${!content ? ' ' + closeBracket : ''}`);
+    const closeBracket = openBracket === '{' ? '}' : (openBracket === '[' ? '];' : ');');
+    this._rows.push(`${this._indent}${beginning} ${openBracket}${content ? '' : ' ' + closeBracket}`);
     if (content) {
       this.increaseIndent();
       content();
@@ -64,14 +64,14 @@ export class Output {
   }
 
   reduceIndent() {
-    this._indent = this._indent.substring(2);
+    this._indent = this._indent.slice(2);
     return this;
   }
 
   finalize() {
     const result = [];
-    const imports = Array.from(this._imports).map(
-      ([module_, imports_]) => `import { ${Array.from(imports_).join(', ')} } from '${module_}';`,
+    const imports = [...this._imports].map(
+      ([module_, imports_]) => `import { ${[...imports_].join(', ')} } from '${module_}';`,
     );
     if (imports.length > 0) result.push(imports.join('\n'));
 

js/cli/src/generate/service-gen.ts

@@ -1,6 +1,5 @@
 import { getPayloadMethod, getScaleCodecDef, PayloadMethod, toLowerCaseFirst } from 'sails-js-util';
 import { ISailsFuncParam, ISailsProgram, ISailsService } from 'sails-js-types';
-
 import { Output } from './output.js';
 import { BaseGenerator } from './base.js';
 import { formatDocs } from './format.js';
@@ -14,13 +13,11 @@ const getFuncName = (name: string) => {
 };
 
 const createPayload = (serviceName: string, fnName: string, params: ISailsFuncParam[]) => {
-  if (params.length === 0) {
-    return `const payload = this._program.registry.createType('(String, String)', ['${serviceName}', '${fnName}']).toHex()`;
-  } else {
-    return `const payload = this._program.registry.createType('(String, String, ${params
-      .map(({ def }) => getScaleCodecDef(def))
-      .join(', ')})', ['${serviceName}', '${fnName}', ${params.map(({ name }) => name).join(', ')}]).toHex()`;
-  }
+  return params.length === 0
+    ? `const payload = this._program.registry.createType('(String, String)', ['${serviceName}', '${fnName}']).toHex()`
+    : `const payload = this._program.registry.createType('(String, String, ${params
+        .map(({ def }) => getScaleCodecDef(def))
+        .join(', ')})', ['${serviceName}', '${fnName}', ${params.map(({ name }) => name).join(', ')}]).toHex()`;
 };
 
 export class ServiceGenerator extends BaseGenerator {
@@ -90,7 +87,7 @@ export class ServiceGenerator extends BaseGenerator {
       $.lines(ctorDocs, false)
         .block(
           `${getFuncName(name)}CtorFromCode(code: Uint8Array | Buffer${
-            args !== null ? ', ' + args : ''
+            args === null ? '' : ', ' + args
           }): TransactionBuilder<null>`,
           () => {
             $.line(`const builder = new TransactionBuilder<null>(`, false)
@@ -120,7 +117,7 @@ export class ServiceGenerator extends BaseGenerator {
         .line()
         .lines(ctorDocs, false)
         .block(
-          `${getFuncName(name)}CtorFromCodeId(codeId: ${HEX_STRING_TYPE}${args !== null ? ', ' + args : ''})`,
+          `${getFuncName(name)}CtorFromCodeId(codeId: ${HEX_STRING_TYPE}${args === null ? '' : ', ' + args})`,
           () => {
             $.line(`const builder = new TransactionBuilder<null>(`, false)
               .increaseIndent()

js/cli/src/generate/types-gen.ts

@@ -62,10 +62,6 @@ export class TypesGenerator extends BaseGenerator {
   }
 
   private getEnumFieldString(f: ISailsEnumVariant) {
-    if (!f.def) {
-      return `{ ${toLowerCaseFirst(f.name)}: null }`;
-    } else {
-      return `{ ${toLowerCaseFirst(f.name)}: ${this.getType(f.def)} }`;
-    }
+    return f.def ? `{ ${toLowerCaseFirst(f.name)}: ${this.getType(f.def)} }` : `{ ${toLowerCaseFirst(f.name)}: null }`;
   }
 }

js/config.json

@@ -1,3 +1,3 @@
 {
-  "sails-rs": "0.7.0"
+  "sails-rs": "0.7.1"
 }

js/example/package.json

@@ -3,14 +3,15 @@
   "private": true,
   "type": "module",
   "dependencies": {
-    "@gear-js/api": "0.40.0",
-    "@polkadot/api": "15.0.1",
-    "sails-js": "0.3.0"
+    "@gear-js/api": "0.41.0",
+    "@polkadot/api": "15.4.1",
+    "sails-js": "0.3.1"
   },
   "devDependencies": {
-    "typescript": "^5.7.2"
+    "typescript": "^5.7.3"
   },
   "scripts": {
-    "build": "tsc"
+    "build": "tsc",
+    "clean": "rm -rf lib"
   }
 }

js/example/src/main.ts

@@ -1,7 +1,7 @@
 import { GearApi } from '@gear-js/api';
 import { Keyring } from '@polkadot/api';
 import { Program } from './lib.js';
-import { readFileSync } from 'fs';
+import { readFileSync } from 'node:fs';
 
 const main = async () => {
   const api = await GearApi.create();
@@ -34,9 +34,4 @@ const main = async () => {
   console.log(`\nProgram replied: \n\t${JSON.stringify(reply)}`);
 };
 
-main()
-  .then(() => process.exit(0))
-  .catch((error) => {
-    console.log(error);
-    process.exit(1);
-  });
+await main();