@graphprotocol/graph-cli 0.37.3-alpha-20230112182505-4508b8d → 0.37.3-alpha-20230112190020-19838fd

package/CHANGELOG.md

@@ -1,6 +1,6 @@
 # @graphprotocol/graph-cli
 
-## 0.37.3-alpha-20230112182505-4508b8d
+## 0.37.3-alpha-20230112190020-19838fd
 
 ### Patch Changes
 

package/dist/command-helpers/gluegun.js

@@ -1,6 +1,4 @@
 "use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.fixParameters = void 0;
 // Workaround for https://github.com/infinitered/gluegun/pull/464.
 //
 // There is currently no way in Gluegun to define command-line options
@@ -26,7 +24,8 @@ exports.fixParameters = void 0;
 // The `fixParameters` function checks if any of the provided boolean
 // options has a string value; if so, it pushes it to the front of the
 // parameters array and returns the result of that.
-//
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.fixParameters = void 0;
 const fixParameters = (parameters, booleanOptions) => {
     let unexpectedStringOptions = Object.keys(booleanOptions)
         .filter(key => typeof booleanOptions[key] === 'string')

package/dist/command-helpers/jsonrpc.js

@@ -6,7 +6,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.createJsonRpcClient = void 0;
 const jayson_1 = __importDefault(require("jayson"));
 const gluegun_1 = require("gluegun");
-const createJsonRpcClient = (url) => {
+function createJsonRpcClient(url) {
     const params = {
         host: url.hostname,
         port: url.port,
@@ -25,5 +25,5 @@ const createJsonRpcClient = (url) => {
         gluegun_1.print.error('The Graph Node URL must be of the following format: http(s)://host[:port]/[path]');
         return null;
     }
-};
+}
 exports.createJsonRpcClient = createJsonRpcClient;

package/dist/commands/add.js

@@ -27,7 +27,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 const chalk_1 = __importDefault(require("chalk"));
-const toolbox = __importStar(require("gluegun/toolbox"));
+const toolbox = __importStar(require("gluegun"));
 const immutable_1 = __importDefault(require("immutable"));
 const spinner_1 = require("../command-helpers/spinner");
 const subgraph_1 = __importDefault(require("../subgraph"));
@@ -55,7 +55,7 @@ exports.default = {
         // Obtain tools
         let { print, system } = toolbox;
         // Read CLI parameters
-        let { abi, contractName, h, help, mergeEntities, networkFile } = toolbox.parameters.options;
+        let { abi, contractName, h, help, mergeEntities, networkFile, } = toolbox.parameters.options;
         contractName = contractName || 'Contract';
         try {
             (0, gluegun_1.fixParameters)(toolbox.parameters, {
@@ -69,8 +69,8 @@ exports.default = {
             process.exitCode = 1;
             return;
         }
-        let address = toolbox.parameters.first || toolbox.parameters.array[0];
-        let manifestPath = toolbox.parameters.second || toolbox.parameters.array[1] || './subgraph.yaml';
+        let address = toolbox.parameters.first || toolbox.parameters.array?.[0];
+        let manifestPath = toolbox.parameters.second || toolbox.parameters.array?.[1] || './subgraph.yaml';
         // Show help text if requested
         if (help || h) {
             print.info(HELP);
@@ -85,7 +85,7 @@ exports.default = {
         const dataSourcesAndTemplates = await DataSourcesExtractor.fromFilePath(manifestPath);
         let protocol = protocols_1.default.fromDataSources(dataSourcesAndTemplates);
         let manifest = await subgraph_1.default.load(manifestPath, { protocol });
-        let network = manifest.result.get('dataSources').get(0).get('network');
+        let network = manifest.result.getIn(['dataSources', 0, 'network']);
         let result = manifest.result.asMutable();
         let entities = getEntities(manifest);
         let contractNames = getContractNames(manifest);
@@ -130,30 +130,30 @@ exports.default = {
         const networksFile = networkFile || './networks.json';
         await (0, network_1.updateNetworksFile)(toolbox, network, contractName, address, networksFile);
         // Detect Yarn and/or NPM
-        let yarn = await system.which('yarn');
-        let npm = await system.which('npm');
+        let yarn = system.which('yarn');
+        let npm = system.which('npm');
         if (!yarn && !npm) {
             print.error(`Neither Yarn nor NPM were found on your system. Please install one of them.`);
             process.exitCode = 1;
             return;
         }
-        await (0, spinner_1.withSpinner)('Running codegen', 'Failed to run codegen', 'Warning during codegen', async (spinner) => {
+        await (0, spinner_1.withSpinner)('Running codegen', 'Failed to run codegen', 'Warning during codegen', async () => {
             await system.run(yarn ? 'yarn codegen' : 'npm run codegen');
         });
     },
 };
-const getEntities = manifest => {
+const getEntities = (manifest) => {
     let dataSources = manifest.result.get('dataSources', immutable_1.default.List());
     let templates = manifest.result.get('templates', immutable_1.default.List());
     return dataSources
         .concat(templates)
-        .map(dataSource => dataSource.getIn(['mapping', 'entities']))
+        .map((dataSource) => dataSource.getIn(['mapping', 'entities']))
         .flatten();
 };
-const getContractNames = manifest => {
+const getContractNames = (manifest) => {
     let dataSources = manifest.result.get('dataSources', immutable_1.default.List());
     let templates = manifest.result.get('templates', immutable_1.default.List());
-    return dataSources.concat(templates).map(dataSource => dataSource.get('name'));
+    return dataSources.concat(templates).map((dataSource) => dataSource.get('name'));
 };
 const updateEventNamesOnCollision = (ethabi, entities, contractName, mergeEntities) => {
     let abiData = ethabi.data;
@@ -168,7 +168,7 @@ const updateEventNamesOnCollision = (ethabi, entities, contractName, mergeEntiti
                     print.error(`Contract name ('${contractName}')
             + event name ('${dataRow.get('name')}') entity already exists.`);
                     process.exitCode = 1;
-                    return;
+                    break;
                 }
                 if (mergeEntities) {
                     collisionEntities.push(dataRow.get('name'));

package/dist/commands/auth.js

@@ -48,9 +48,9 @@ exports.default = {
     description: 'Sets the deploy key to use when deploying to a Graph node',
     run: async (toolbox) => {
         // Obtain tools
-        let { filesystem, print, system } = toolbox;
+        const { print } = toolbox;
         // Read CLI parameters
-        let { product, studio, h, help } = toolbox.parameters.options;
+        const { product, studio, h, help } = toolbox.parameters.options;
         // Show help text if requested
         if (help || h) {
             print.info(HELP);

package/dist/commands/create.js

@@ -21,7 +21,7 @@ exports.default = {
     description: 'Registers a subgraph name',
     run: async (toolbox) => {
         // Obtain tools
-        let { filesystem, print, system } = toolbox;
+        const { print } = toolbox;
         // Read CLI parameters
         let { accessToken, g, h, help, node } = toolbox.parameters.options;
         let subgraphName = toolbox.parameters.first;
@@ -65,10 +65,15 @@ exports.default = {
         // Use the access token, if one is set
         accessToken = await (0, auth_1.identifyDeployKey)(node, accessToken);
         if (accessToken !== undefined && accessToken !== null) {
+            // @ts-expect-error options property seems to exist
             client.options.headers = { Authorization: `Bearer ${accessToken}` };
         }
         let spinner = print.spin(`Creating subgraph in Graph node: ${requestUrl}`);
-        client.request('subgraph_create', { name: subgraphName }, function (requestError, jsonRpcError, res) {
+        client.request('subgraph_create', { name: subgraphName }, function (
+        // @ts-expect-error TODO: why are the arguments not typed?
+        requestError, 
+        // @ts-expect-error TODO: why are the arguments not typed?
+        jsonRpcError) {
             if (jsonRpcError) {
                 spinner.fail(`Error creating the subgraph: ${jsonRpcError.message}`);
                 process.exitCode = 1;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@graphprotocol/graph-cli",
-  "version": "0.37.3-alpha-20230112182505-4508b8d",
+  "version": "0.37.3-alpha-20230112190020-19838fd",
   "license": "(Apache-2.0 OR MIT)",
   "description": "CLI for building for and deploying to The Graph",
   "main": "dist/cli.js",

package/src/command-helpers/gluegun.ts

@@ -23,8 +23,13 @@
 // The `fixParameters` function checks if any of the provided boolean
 // options has a string value; if so, it pushes it to the front of the
 // parameters array and returns the result of that.
-//
-export const fixParameters = (parameters: any, booleanOptions: any) => {
+
+import { GluegunParameters } from 'gluegun'
+
+export const fixParameters = (
+  parameters: GluegunParameters,
+  booleanOptions: Record<string, string>,
+) => {
   let unexpectedStringOptions = Object.keys(booleanOptions)
     .filter(key => typeof booleanOptions[key] === 'string')
     .map(key => ({ key, value: booleanOptions[key] }))
@@ -39,9 +44,9 @@ export const fixParameters = (parameters: any, booleanOptions: any) => {
     )
   } else if (unexpectedStringOptions.length == 1) {
     let params = parameters.array
-    params.unshift(unexpectedStringOptions[0].value)
-    return params
+    params!.unshift(unexpectedStringOptions[0].value)
+    return params!
   } else {
-    return parameters.array
+    return parameters.array!
   }
 }

package/src/command-helpers/jsonrpc.ts

@@ -1,7 +1,7 @@
 import jayson from 'jayson'
 import { print } from 'gluegun'
 
-const createJsonRpcClient = (url: URL) => {
+export function createJsonRpcClient(url: URL): jayson.Client | null {
   const params = {
     host: url.hostname,
     port: url.port,
@@ -24,5 +24,3 @@ const createJsonRpcClient = (url: URL) => {
     return null
   }
 }
-
-export { createJsonRpcClient }

package/src/command-helpers/node.ts

@@ -16,8 +16,8 @@ export function chooseNodeUrl({
 }: {
   product: string
   studio: string
-  node: string
-  allowSimpleName: boolean
+  node?: string
+  allowSimpleName?: boolean
 }) {
   if (node) {
     try {

package/src/commands/{add.js → add.ts}

@@ -1,5 +1,5 @@
 import chalk from 'chalk'
-import * as toolbox from 'gluegun/toolbox'
+import * as toolbox from 'gluegun'
 import immutable from 'immutable'
 import { withSpinner } from '../command-helpers/spinner'
 import Subgraph from '../subgraph'
@@ -29,15 +29,29 @@ ${chalk.dim('Options:')}
   -h, --help                    Show usage information
 `
 
+export interface AddOptions {
+  abi?: string
+  contractName?: string
+  mergeEntities?: boolean
+  networkFile?: string
+  help?: boolean
+}
+
 export default {
   description: 'Adds a new datasource to a subgraph',
-  run: async toolbox => {
+  run: async (toolbox: toolbox.GluegunToolbox) => {
     // Obtain tools
     let { print, system } = toolbox
 
     // Read CLI parameters
-    let { abi, contractName, h, help, mergeEntities, networkFile } =
-      toolbox.parameters.options
+    let {
+      abi,
+      contractName,
+      h,
+      help,
+      mergeEntities,
+      networkFile,
+    } = toolbox.parameters.options
 
     contractName = contractName || 'Contract'
 
@@ -53,9 +67,9 @@ export default {
       return
     }
 
-    let address = toolbox.parameters.first || toolbox.parameters.array[0]
+    let address = toolbox.parameters.first || toolbox.parameters.array?.[0]
     let manifestPath =
-      toolbox.parameters.second || toolbox.parameters.array[1] || './subgraph.yaml'
+      toolbox.parameters.second || toolbox.parameters.array?.[1] || './subgraph.yaml'
 
     // Show help text if requested
     if (help || h) {
@@ -73,7 +87,7 @@ export default {
     const dataSourcesAndTemplates = await DataSourcesExtractor.fromFilePath(manifestPath)
     let protocol = Protocol.fromDataSources(dataSourcesAndTemplates)
     let manifest = await Subgraph.load(manifestPath, { protocol })
-    let network = manifest.result.get('dataSources').get(0).get('network')
+    let network = manifest.result.getIn(['dataSources', 0, 'network']) as any
     let result = manifest.result.asMutable()
 
     let entities = getEntities(manifest)
@@ -109,7 +123,7 @@ export default {
     await writeSchema(
       ethabi,
       protocol,
-      result.getIn(['schema', 'file']),
+      result.getIn(['schema', 'file']) as any,
       collisionEntities,
     )
     await writeMapping(ethabi, protocol, contractName, collisionEntities)
@@ -127,7 +141,7 @@ export default {
     // Handle the collisions edge case by copying another data source yaml data
     if (mergeEntities && onlyCollisions) {
       let firstDataSource = dataSources.get(0)
-      let source = dataSource.get('source')
+      let source = dataSource.get('source') as any
       let mapping = firstDataSource.get('mapping').asMutable()
 
       // Save the address of the new data source
@@ -146,8 +160,8 @@ export default {
     await updateNetworksFile(toolbox, network, contractName, address, networksFile)
 
     // Detect Yarn and/or NPM
-    let yarn = await system.which('yarn')
-    let npm = await system.which('npm')
+    let yarn = system.which('yarn')
+    let npm = system.which('npm')
     if (!yarn && !npm) {
       print.error(
         `Neither Yarn nor NPM were found on your system. Please install one of them.`,
@@ -160,31 +174,36 @@ export default {
       'Running codegen',
       'Failed to run codegen',
       'Warning during codegen',
-      async spinner => {
+      async () => {
         await system.run(yarn ? 'yarn codegen' : 'npm run codegen')
       },
     )
   },
 }
 
-const getEntities = manifest => {
+const getEntities = (manifest: any) => {
   let dataSources = manifest.result.get('dataSources', immutable.List())
   let templates = manifest.result.get('templates', immutable.List())
 
   return dataSources
     .concat(templates)
-    .map(dataSource => dataSource.getIn(['mapping', 'entities']))
+    .map((dataSource: any) => dataSource.getIn(['mapping', 'entities']))
     .flatten()
 }
 
-const getContractNames = manifest => {
+const getContractNames = (manifest: any) => {
   let dataSources = manifest.result.get('dataSources', immutable.List())
   let templates = manifest.result.get('templates', immutable.List())
 
-  return dataSources.concat(templates).map(dataSource => dataSource.get('name'))
+  return dataSources.concat(templates).map((dataSource: any) => dataSource.get('name'))
 }
 
-const updateEventNamesOnCollision = (ethabi, entities, contractName, mergeEntities) => {
+const updateEventNamesOnCollision = (
+  ethabi: any,
+  entities: any,
+  contractName: string,
+  mergeEntities: boolean,
+) => {
   let abiData = ethabi.data
   let { print } = toolbox
   let collisionEntities = []
@@ -199,7 +218,7 @@ const updateEventNamesOnCollision = (ethabi, entities, contractName, mergeEntiti
           print.error(`Contract name ('${contractName}')
             + event name ('${dataRow.get('name')}') entity already exists.`)
           process.exitCode = 1
-          return
+          break
         }
 
         if (mergeEntities) {

package/src/commands/{auth.js → auth.ts}

@@ -1,4 +1,5 @@
 import chalk from 'chalk'
+import { GluegunToolbox } from 'gluegun'
 import { saveDeployKey } from '../command-helpers/auth'
 import { chooseNodeUrl } from '../command-helpers/node'
 import { fixParameters } from '../command-helpers/gluegun'
@@ -16,7 +17,19 @@ ${chalk.dim('Options:')}
   -h, --help                    Show usage information
 `
 
-const processForm = async (toolbox, { product, studio, node, deployKey }) => {
+export interface AuthOptions {
+  product?: 'subgraph-studio' | 'hosted-service'
+  studio?: string
+  help?: boolean
+  // not a cli arg
+  node?: string
+  deployKey?: string
+}
+
+const processForm = async (
+  toolbox: GluegunToolbox,
+  { product, studio, node, deployKey }: AuthOptions,
+) => {
   const questions = [
     {
       type: 'select',
@@ -47,12 +60,12 @@ const processForm = async (toolbox, { product, studio, node, deployKey }) => {
 
 export default {
   description: 'Sets the deploy key to use when deploying to a Graph node',
-  run: async toolbox => {
+  run: async (toolbox: GluegunToolbox) => {
     // Obtain tools
-    let { filesystem, print, system } = toolbox
+    const { print } = toolbox
 
     // Read CLI parameters
-    let { product, studio, h, help } = toolbox.parameters.options
+    const { product, studio, h, help } = toolbox.parameters.options
 
     // Show help text if requested
     if (help || h) {
@@ -60,7 +73,7 @@ export default {
       return
     }
 
-    let firstParam, secondParam
+    let firstParam: string, secondParam: string
     try {
       ;[firstParam, secondParam] = fixParameters(toolbox.parameters, {
         h,
@@ -74,7 +87,7 @@ export default {
     }
 
     // if user specifies --product or --studio then deployKey is the first parameter
-    let node
+    let node: string | undefined
     let deployKey
     if (product || studio) {
       ;({ node } = chooseNodeUrl({ product, studio, node }))
@@ -119,7 +132,7 @@ export default {
     }
 
     try {
-      await saveDeployKey(node, deployKey)
+      await saveDeployKey(node!, deployKey)
       print.success(`Deploy key set for ${node}`)
     } catch (e) {
       print.error(e)

package/src/commands/{create.js → create.ts}

@@ -1,5 +1,6 @@
 import { URL } from 'url'
 import chalk from 'chalk'
+import * as toolbox from 'gluegun'
 import { validateNodeUrl } from '../command-helpers/node'
 import { identifyDeployKey as identifyAccessToken } from '../command-helpers/auth'
 import { createJsonRpcClient } from '../command-helpers/jsonrpc'
@@ -14,11 +15,17 @@ ${chalk.dim('Options:')}
   -g, --node <url>              Graph node to create the subgraph in
 `
 
+export interface AddOptions {
+  accessToken?: string
+  help?: boolean
+  node?: string
+}
+
 export default {
   description: 'Registers a subgraph name',
-  run: async toolbox => {
+  run: async (toolbox: toolbox.GluegunToolbox) => {
     // Obtain tools
-    let { filesystem, print, system } = toolbox
+    const { print } = toolbox
 
     // Read CLI parameters
     let { accessToken, g, h, help, node } = toolbox.parameters.options
@@ -69,25 +76,27 @@ export default {
     // Use the access token, if one is set
     accessToken = await identifyAccessToken(node, accessToken)
     if (accessToken !== undefined && accessToken !== null) {
+      // @ts-expect-error options property seems to exist
       client.options.headers = { Authorization: `Bearer ${accessToken}` }
     }
 
     let spinner = print.spin(`Creating subgraph in Graph node: ${requestUrl}`)
-    client.request(
-      'subgraph_create',
-      { name: subgraphName },
-      function (requestError, jsonRpcError, res) {
-        if (jsonRpcError) {
-          spinner.fail(`Error creating the subgraph: ${jsonRpcError.message}`)
-          process.exitCode = 1
-        } else if (requestError) {
-          spinner.fail(`HTTP error creating the subgraph: ${requestError.code}`)
-          process.exitCode = 1
-        } else {
-          spinner.stop()
-          print.success(`Created subgraph: ${subgraphName}`)
-        }
-      },
-    )
+    client.request('subgraph_create', { name: subgraphName }, function(
+      // @ts-expect-error TODO: why are the arguments not typed?
+      requestError,
+      // @ts-expect-error TODO: why are the arguments not typed?
+      jsonRpcError,
+    ) {
+      if (jsonRpcError) {
+        spinner.fail(`Error creating the subgraph: ${jsonRpcError.message}`)
+        process.exitCode = 1
+      } else if (requestError) {
+        spinner.fail(`HTTP error creating the subgraph: ${requestError.code}`)
+        process.exitCode = 1
+      } else {
+        spinner.stop()
+        print.success(`Created subgraph: ${subgraphName}`)
+      }
+    })
   },
 }

package/src/subgraph.ts

@@ -275,7 +275,7 @@ More than one template named '${name}', template names must be unique.`,
       }
     }
 
-    let manifest = immutable.fromJS(data)
+    let manifest = immutable.fromJS(data) as immutable.Map<any, any>
 
     // Validate the schema
     Subgraph.validateSchema(manifest, { resolveFile })