@graphprotocol/graph-cli 0.49.0-alpha-20230505152117-ef48fdf → 0.49.0-alpha-20230508062634-72ffd3d

package/CHANGELOG.md

@@ -1,6 +1,6 @@
 # @graphprotocol/graph-cli
 
-## 0.49.0-alpha-20230505152117-ef48fdf
+## 0.49.0-alpha-20230508062634-72ffd3d
 
 ### Minor Changes
 
@@ -9,29 +9,16 @@
   Thanks [@saihaj](https://github.com/saihaj)! - do not generate types, instead show a message to
   user to use substreams CLI for codegen.
 
+- [#1340](https://github.com/graphprotocol/graph-tooling/pull/1340)
+  [`72ffd3d`](https://github.com/graphprotocol/graph-tooling/commit/72ffd3def132ccf4d50a18e0e6fd1b377da6cd48)
+  Thanks [@incrypto32](https://github.com/incrypto32)! - Add support for codegen for derived field
+  loaders, This adds getters for derived fields defined in the schema for entities.
+
 - [#1306](https://github.com/graphprotocol/graph-tooling/pull/1306)
   [`f5e4b58`](https://github.com/graphprotocol/graph-tooling/commit/f5e4b58989edc5f3bb8211f1b912449e77832de8)
   Thanks [@saihaj](https://github.com/saihaj)! - Add loadInBlock function for entities as part of
   codegen
 
-- [#1339](https://github.com/graphprotocol/graph-tooling/pull/1339)
-  [`214cd71`](https://github.com/graphprotocol/graph-tooling/commit/214cd7153aabd427b52c87f5f3643212cb615913)
-  Thanks [@saihaj](https://github.com/saihaj)! - allow deploy optimism and optimism-goerli on studio
-
-### Patch Changes
-
-- [#1328](https://github.com/graphprotocol/graph-tooling/pull/1328)
-  [`4963215`](https://github.com/graphprotocol/graph-tooling/commit/4963215564797393424c563ea0b51aabbfd8e33e)
-  Thanks [@renovate](https://github.com/apps/renovate)! - dependencies updates:
-
-  - Updated dependency [`@oclif/core@2.8.4` ↗︎](https://www.npmjs.com/package/@oclif/core/v/2.8.4)
-    (from `2.8.2`, in `dependencies`)
-
-- [#1331](https://github.com/graphprotocol/graph-tooling/pull/1331)
-  [`b2c8dec`](https://github.com/graphprotocol/graph-tooling/commit/b2c8decb7806d25df6ca4e07f6dfdf7941516435)
-  Thanks [@saihaj](https://github.com/saihaj)! - only allow mainnet for substreams in network
-  selection for init
-
 ## 0.48.0
 
 ### Minor Changes

package/dist/codegen/schema.d.ts

@@ -21,13 +21,20 @@ export default class SchemaCodeGenerator {
     constructor(schema: Schema);
     generateModuleImports(): tsCodegen.ModuleImports[];
     generateTypes(): Array<tsCodegen.Class>;
+    generateDerivedLoaders(): any[];
     _isEntityTypeDefinition(def: DefinitionNode): def is ObjectTypeDefinitionNode;
+    _isDerivedField(field: any): boolean;
     _isInterfaceDefinition(def: DefinitionNode): def is InterfaceTypeDefinitionNode;
     _generateEntityType(def: ObjectTypeDefinitionNode): tsCodegen.Class;
+    _generateDerivedLoader(typeName: string): any;
+    _getTypeNameForField(gqlType: TypeNode): string;
     _generateConstructor(_entityName: string, fields: readonly FieldDefinitionNode[] | undefined): tsCodegen.Method;
     _generateStoreMethods(entityName: string, idField: IdField): Array<tsCodegen.Method | tsCodegen.StaticMethod>;
     _generateEntityFieldMethods(entityDef: ObjectTypeDefinitionNode, fieldDef: FieldDefinitionNode): Array<tsCodegen.Method>;
     _generateEntityFieldGetter(_entityDef: ObjectTypeDefinitionNode, fieldDef: FieldDefinitionNode): tsCodegen.Method;
+    _generateDerivedFieldGetter(entityDef: any, fieldDef: FieldDefinitionNode): tsCodegen.Method;
+    _returnTypeForDervied(gqlType: any): any;
+    _generatedEntityDerivedFieldGetter(_entityDef: any, fieldDef: FieldDefinitionNode): tsCodegen.Method;
     _generateEntityFieldSetter(_entityDef: ObjectTypeDefinitionNode, fieldDef: FieldDefinitionNode): tsCodegen.Method | null;
     _resolveFieldType(gqlType: NamedTypeNode): string;
     /** Return the type that values for this field must have. For scalar

package/dist/codegen/schema.js

@@ -22,7 +22,12 @@ var __importStar = (this && this.__importStar) || function (mod) {
     __setModuleDefault(result, mod);
     return result;
 };
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
+/* eslint-disable unicorn/no-array-for-each */
+const debug_1 = __importDefault(require("debug"));
 const typesCodegen = __importStar(require("./types"));
 const tsCodegen = __importStar(require("./typescript"));
 class IdField {
@@ -98,10 +103,23 @@ class SchemaCodeGenerator {
         })
             .filter(Boolean);
     }
+    generateDerivedLoaders() {
+        const fields = this.schema.ast.definitions.filter(def => this._isEntityTypeDefinition(def))
+            .flatMap((def) => def.fields)
+            .filter(def => this._isDerivedField(def))
+            .filter(def => def?.type !== undefined).map(def => this._getTypeNameForField(def.type));
+        return [...new Set(fields)].map(typeName => {
+            return this._generateDerivedLoader(typeName);
+        });
+    }
     _isEntityTypeDefinition(def) {
         return (def.kind === 'ObjectTypeDefinition' &&
             def.directives?.find(directive => directive.name.value === 'entity') !== undefined);
     }
+    _isDerivedField(field) {
+        return (field.directives?.find((directive) => directive.name.value === 'derivedFrom') !==
+            undefined);
+    }
     _isInterfaceDefinition(def) {
         return def.kind === 'InterfaceTypeDefinition';
     }
@@ -120,6 +138,42 @@ class SchemaCodeGenerator {
             .forEach((method) => klass.addMethod(method));
         return klass;
     }
+    _generateDerivedLoader(typeName) {
+        // <field>Loader
+        const klass = tsCodegen.klass(`${typeName}Loader`, { export: true, extends: 'Entity' });
+        klass.addMember(tsCodegen.klassMember('_entity', 'string'));
+        klass.addMember(tsCodegen.klassMember('_field', 'string'));
+        klass.addMember(tsCodegen.klassMember('_id', 'string'));
+        // Generate and add a constructor
+        klass.addMethod(tsCodegen.method('constructor', [
+            tsCodegen.param('entity', 'string'),
+            tsCodegen.param('id', 'string'),
+            tsCodegen.param('field', 'string'),
+        ], undefined, `
+      super();
+      this._entity = entity;
+      this._id = id;
+      this._field = field;
+`));
+        // Generate load() method for the Loader
+        klass.addMethod(tsCodegen.method('load', [], `${typeName}[]`, `
+  let value = store.loadRelated(this._entity, this._id, this._field);
+  return changetype<${typeName}[]>(value);
+  `));
+        return klass;
+    }
+    _getTypeNameForField(gqlType) {
+        if (gqlType.kind === 'NonNullType') {
+            return this._getTypeNameForField(gqlType.type);
+        }
+        if (gqlType.kind === 'ListType') {
+            return this._getTypeNameForField(gqlType.type);
+        }
+        if (gqlType.kind === 'NamedType') {
+            return gqlType.name.value;
+        }
+        throw new Error(`Unknown type kind: ${gqlType}`);
+    }
     _generateConstructor(_entityName, fields) {
         const idField = IdField.fromFields(fields);
         return tsCodegen.method('constructor', [tsCodegen.param('id', idField.tsNamedType())], undefined, `
@@ -156,6 +210,12 @@ class SchemaCodeGenerator {
             .filter(Boolean);
     }
     _generateEntityFieldGetter(_entityDef, fieldDef) {
+        const isDerivedField = this._isDerivedField(fieldDef);
+        const codegenDebug = (0, debug_1.default)('codegen');
+        if (isDerivedField) {
+            codegenDebug(`Generating derived field getter for ${fieldDef.name.value}`);
+            return this._generateDerivedFieldGetter(_entityDef, fieldDef);
+        }
         const name = fieldDef.name.value;
         const gqlType = fieldDef.type;
         const fieldValueType = this._valueTypeFromGraphQl(gqlType);
@@ -179,6 +239,42 @@ class SchemaCodeGenerator {
        ${isNullable ? getNullable : getNonNullable}
       `);
     }
+    _generateDerivedFieldGetter(entityDef, fieldDef) {
+        const entityName = entityDef.name.value;
+        const name = fieldDef.name.value;
+        const gqlType = fieldDef.type;
+        const returnType = this._returnTypeForDervied(gqlType);
+        return tsCodegen.method(`get ${name}`, [], returnType, `
+        return new ${returnType}('${entityName}', this.get('id')!.toString(), '${name}')
+      `);
+    }
+    _returnTypeForDervied(gqlType) {
+        if (gqlType.kind === 'NonNullType') {
+            return this._returnTypeForDervied(gqlType.type);
+        }
+        if (gqlType.kind === 'ListType') {
+            return this._returnTypeForDervied(gqlType.type);
+        }
+        const type = tsCodegen.namedType(gqlType.name.value + 'Loader');
+        return type;
+    }
+    _generatedEntityDerivedFieldGetter(_entityDef, fieldDef) {
+        const name = fieldDef.name.value;
+        const gqlType = fieldDef.type;
+        const fieldValueType = this._valueTypeFromGraphQl(gqlType);
+        const returnType = this._typeFromGraphQl(gqlType);
+        const isNullable = returnType instanceof tsCodegen.NullableType;
+        const getNonNullable = `return ${typesCodegen.valueToAsc('value!', fieldValueType)}`;
+        const getNullable = `if (!value || value.kind == ValueKind.NULL) {
+                          return null
+                        } else {
+                          return ${typesCodegen.valueToAsc('value', fieldValueType)}
+                        }`;
+        return tsCodegen.method(`get ${name}`, [], returnType, `
+       let value = this.get('${name}')
+       ${isNullable ? getNullable : getNonNullable}
+      `);
+    }
     _generateEntityFieldSetter(_entityDef, fieldDef) {
         const name = fieldDef.name.value;
         const isDerivedField = !!fieldDef.directives?.find(directive => directive.name.value === 'derivedFrom');

package/dist/codegen/schema.test.js

@@ -276,14 +276,9 @@ describe('Schema code generator', () => {
                     {
                         name: 'get wallets',
                         params: [],
-                        returnType: new typescript_1.NullableType(new typescript_1.ArrayType(new typescript_1.NamedType('string'))),
+                        returnType: new typescript_1.NamedType('WalletLoader'),
                         body: `
-              let value = this.get('wallets')
-              if (!value || value.kind == ValueKind.NULL) {
-                return null
-              } else {
-                return value.toStringArray()
-              }
+              return new WalletLoader("Account", this.get('id')!.toString(), "wallets") 
             `,
                     },
                 ],

package/dist/command-helpers/studio.d.ts

@@ -1,4 +1,4 @@
-export declare const allowedStudioNetworks: readonly ["mainnet", "rinkeby", "goerli", "gnosis", "chapel", "optimism-goerli", "clover", "fantom", "matic", "fantom-testnet", "arbitrum-goerli", "fuji", "celo-alfajores", "mumbai", "aurora-testnet", "near-testnet", "optimism", "optimism-goerli", "theta-testnet-001", "osmo-test-4", "base-testnet", "celo", "arbitrum-one", "avalanche", "zksync-era", "sepolia", "polygon-zkevm-testnet", "polygon-zkevm"];
+export declare const allowedStudioNetworks: readonly ["mainnet", "rinkeby", "goerli", "gnosis", "chapel", "optimism-goerli", "clover", "fantom", "matic", "fantom-testnet", "arbitrum-goerli", "fuji", "celo-alfajores", "mumbai", "aurora-testnet", "near-testnet", "theta-testnet-001", "osmo-test-4", "base-testnet", "celo", "arbitrum-one", "avalanche", "zksync-era", "sepolia", "polygon-zkevm-testnet", "polygon-zkevm"];
 export declare const validateStudioNetwork: ({ studio, product, network, }: {
     studio?: string | boolean | undefined;
     product?: string | undefined;

package/dist/command-helpers/studio.js

@@ -18,8 +18,6 @@ exports.allowedStudioNetworks = [
     'mumbai',
     'aurora-testnet',
     'near-testnet',
-    'optimism',
-    'optimism-goerli',
     'theta-testnet-001',
     'osmo-test-4',
     'base-testnet',

package/dist/protocols/index.js

@@ -88,7 +88,7 @@ class Protocol {
         });
     }
     static availableNetworks() {
-        return immutable_1.default.fromJS({
+        let networks = immutable_1.default.fromJS({
             arweave: ['arweave-mainnet'],
             ethereum: [
                 'mainnet',
@@ -135,6 +135,13 @@ class Protocol {
             ],
             substreams: ['mainnet'],
         });
+        const allNetworks = [];
+        // eslint-disable-next-line unicorn/no-array-for-each
+        networks.forEach(value => {
+            allNetworks.push(...value);
+        });
+        networks = networks.set('substreams', immutable_1.default.List(allNetworks));
+        return networks;
     }
     static normalizeName(name) {
         return Protocol.availableProtocols().findKey(possibleNames => {

package/dist/type-generator.js

@@ -130,6 +130,7 @@ class TypeGenerator {
                 typescript_1.GENERATED_FILE_NOTE,
                 ...codeGenerator.generateModuleImports(),
                 ...codeGenerator.generateTypes(),
+                ...codeGenerator.generateDerivedLoaders(),
             ].join('\n'), {
                 parser: 'typescript',
             });

package/oclif.manifest.json

@@ -1,5 +1,5 @@
 {
-  "version": "0.49.0-alpha-20230505152117-ef48fdf",
+  "version": "0.49.0-alpha-20230508062634-72ffd3d",
   "commands": {
     "add": {
       "id": "add",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@graphprotocol/graph-cli",
-  "version": "0.49.0-alpha-20230505152117-ef48fdf",
+  "version": "0.49.0-alpha-20230508062634-72ffd3d",
   "description": "CLI for building for and deploying to The Graph",
   "license": "(Apache-2.0 OR MIT)",
   "engines": {
@@ -20,7 +20,7 @@
   ],
   "dependencies": {
     "@float-capital/float-subgraph-uncrashable": "^0.0.0-alpha.4",
-    "@oclif/core": "2.8.4",
+    "@oclif/core": "2.8.2",
     "@whatwg-node/fetch": "^0.8.4",
     "assemblyscript": "0.19.23",
     "binary-install-raw": "0.0.13",