wasm-ast-types 0.13.0 → 0.15.0

package/module/react-query/react-query.js

@@ -25,12 +25,7 @@ export const createReactQueryHooks = ({
     }));
   }
 
-  body.push(createReactQueryHookGenericInterface({
-    context,
-    QueryClient,
-    genericQueryInterfaceName
-  }));
-  body.push(...getMessageProperties(queryMsg).reduce((m, schema) => {
+  const queryMsgs = getMessageProperties(queryMsg).map(schema => {
     // list_voters
     const underscoreName = Object.keys(schema.properties)[0]; // listVoters
 
@@ -44,6 +39,40 @@ export const createReactQueryHooks = ({
 
     const getterKey = camel(`${contractName}${pascal(methodName)}`);
     const jsonschema = schema.properties[underscoreName];
+    return {
+      underscoreName,
+      methodName,
+      hookParamsTypeName,
+      hookName,
+      responseType,
+      getterKey,
+      jsonschema
+    };
+  });
+  const queryFactoryName = `${camel(contractName)}Queries`;
+
+  if (options.queryFactory) {
+    body.push(createReactQueryFactory({
+      context,
+      queryFactoryName,
+      queryKeysName,
+      queryMsgs
+    }));
+  }
+
+  body.push(createReactQueryHookGenericInterface({
+    context,
+    QueryClient,
+    genericQueryInterfaceName
+  }));
+  body.push(...queryMsgs.reduce((m, {
+    methodName,
+    hookParamsTypeName,
+    hookName,
+    responseType,
+    getterKey,
+    jsonschema
+  }) => {
     return [createReactQueryHookInterface({
       context,
       hookParamsTypeName,
@@ -64,6 +93,29 @@ export const createReactQueryHooks = ({
   }, []));
   return body;
 };
+
+function buildQueryFn(methodName, jsonschema, options) {
+  const keys = Object.keys(jsonschema.properties ?? {});
+  let args = [];
+
+  if (keys.length) {
+    args = [t.objectExpression([...keys.map(prop => {
+      return t.objectProperty(t.identifier(camel(prop)), t.memberExpression(t.identifier('args'), t.identifier(camel(prop))));
+    })])];
+  }
+
+  const rejectInvalidClient = t.callExpression(t.memberExpression(t.identifier('Promise'), t.identifier('reject')), [t.newExpression(t.identifier('Error'), [t.stringLiteral('Invalid client')])]);
+  return t.arrowFunctionExpression([], optionalConditionalExpression(t.identifier('client'), t.callExpression(t.memberExpression(t.identifier('client'), t.identifier(methodName)), args), rejectInvalidClient, options.optionalClient), false);
+}
+
+const ENABLED_QUERY_OPTION = t.objectProperty(t.identifier('enabled'), t.logicalExpression('&&', t.unaryExpression('!', t.unaryExpression('!', t.identifier('client'))), t.conditionalExpression( // explicitly check for undefined
+t.binaryExpression('!=', t.optionalMemberExpression(t.identifier('options'), t.identifier('enabled'), false, true), t.identifier('undefined')), t.memberExpression(t.identifier('options'), t.identifier('enabled')), t.booleanLiteral(true))));
+
+function buildQueryOptions(options) {
+  return options.optionalClient ? t.objectExpression([t.spreadElement(t.identifier('options')), t.objectProperty(t.identifier('enabled'), t.logicalExpression('&&', t.unaryExpression('!', t.unaryExpression('!', t.identifier('client'))), t.conditionalExpression( // explicitly check for undefined
+  t.binaryExpression('!=', t.optionalMemberExpression(t.identifier('options'), t.identifier('enabled'), false, true), t.identifier('undefined')), t.memberExpression(t.identifier('options'), t.identifier('enabled')), t.booleanLiteral(true))))]) : t.identifier('options');
+}
+
 export const createReactQueryHook = ({
   context,
   hookName,
@@ -78,21 +130,13 @@ export const createReactQueryHook = ({
   context.addUtil('UseQueryOptions');
   const options = context.options.reactQuery;
   const keys = Object.keys(jsonschema.properties ?? {});
-  let args = [];
-
-  if (keys.length) {
-    args = [t.objectExpression([...keys.map(prop => {
-      return t.objectProperty(t.identifier(camel(prop)), t.memberExpression(t.identifier('args'), t.identifier(camel(prop))));
-    })])];
-  }
-
   let props = ['client', 'options'];
 
   if (keys.length) {
     props = ['client', 'args', 'options'];
   }
 
-  const selectResponseGenericTypeName = 'TData';
+  const selectResponseGenericTypeName = GENERIC_SELECT_RESPONSE_NAME;
   const queryFunctionDeclaration = t.functionDeclaration(t.identifier(hookName), [tsObjectPattern([...props.map(prop => {
     return t.objectProperty(t.identifier(prop), t.identifier(prop), false, true);
   })], t.tsTypeAnnotation(t.tsTypeReference(t.identifier(hookParamsTypeName), t.tsTypeParameterInstantiation([t.tsTypeReference(t.identifier(selectResponseGenericTypeName))]))))], t.blockStatement([t.returnStatement(callExpression(t.identifier('useQuery'), [generateUseQueryQueryKey({
@@ -101,8 +145,7 @@ export const createReactQueryHook = ({
     methodName,
     props,
     options
-  }), t.arrowFunctionExpression([], optionalConditionalExpression(t.identifier('client'), t.callExpression(t.memberExpression(t.identifier('client'), t.identifier(methodName)), args), t.callExpression(t.memberExpression(t.identifier('Promise'), t.identifier('reject')), [t.newExpression(t.identifier('Error'), [t.stringLiteral('Invalid client')])]), options.optionalClient), false), options.optionalClient ? t.objectExpression([t.spreadElement(t.identifier('options')), t.objectProperty(t.identifier('enabled'), t.logicalExpression('&&', t.unaryExpression('!', t.unaryExpression('!', t.identifier('client'))), t.conditionalExpression( // explicitly check for undefined
-  t.binaryExpression('!=', t.optionalMemberExpression(t.identifier('options'), t.identifier('enabled'), false, true), t.identifier('undefined')), t.memberExpression(t.identifier('options'), t.identifier('enabled')), t.booleanLiteral(true))))]) : t.identifier('options')], t.tsTypeParameterInstantiation([t.tsTypeReference(t.identifier(responseType)), t.tsTypeReference(t.identifier('Error')), t.tsTypeReference(t.identifier(selectResponseGenericTypeName))])))])); // Add the TData type parameters
+  }), buildQueryFn(methodName, jsonschema, options), buildQueryOptions(options)], t.tsTypeParameterInstantiation([t.tsTypeReference(t.identifier(responseType)), t.tsTypeReference(t.identifier('Error')), t.tsTypeReference(t.identifier(selectResponseGenericTypeName))])))])); // Add the TData type parameters
 
   queryFunctionDeclaration.typeParameters = t.tsTypeParameterDeclaration([t.tsTypeParameter(undefined, t.tSTypeReference(t.identifier(responseType)), selectResponseGenericTypeName)]);
   return t.exportNamedDeclaration(queryFunctionDeclaration);
@@ -250,6 +293,34 @@ function createReactQueryKeys({
   shorthandProperty('args')])]), t.tSTypeReference(t.identifier('const'))))))]))]));
 }
 
+function createReactQueryFactory({
+  context,
+  queryFactoryName,
+  queryKeysName,
+  queryMsgs
+}) {
+  const options = context.options.reactQuery;
+  return t.exportNamedDeclaration(t.variableDeclaration('const', [t.variableDeclarator(t.identifier(queryFactoryName), t.objectExpression([...queryMsgs.map(({
+    methodName,
+    hookParamsTypeName,
+    responseType,
+    jsonschema
+  }) => {
+    const hasArgs = Object.keys(jsonschema.properties ?? {}).length > 0;
+    const methodQueryOptionsFn = t.arrowFunctionExpression([tsObjectPattern([shorthandProperty('client'), ...(hasArgs ? [shorthandProperty('args')] : []), shorthandProperty('options')], t.tsTypeAnnotation(t.tsTypeReference(t.identifier(hookParamsTypeName), t.tsTypeParameterInstantiation([t.tsTypeReference(t.identifier(GENERIC_SELECT_RESPONSE_NAME))]))))], t.objectExpression([// 1: queryKey
+    t.objectProperty(t.identifier('queryKey'), t.callExpression(t.memberExpression(t.identifier(queryKeysName), t.identifier(methodName)), [t.optionalMemberExpression(t.identifier('client'), t.identifier('contractAddress'), false, true), ...(hasArgs ? [t.identifier('args')] : [])])), // 2: queryFn
+    t.objectProperty(t.identifier('queryFn'), buildQueryFn(methodName, jsonschema, options)), // 3: spread options
+    t.spreadElement(t.identifier('options')), // 4. enabled
+    ENABLED_QUERY_OPTION]));
+    methodQueryOptionsFn.typeParameters = t.tsTypeParameterDeclaration([t.tsTypeParameter(undefined, t.tsTypeReference(t.identifier(responseType)), GENERIC_SELECT_RESPONSE_NAME)]);
+    methodQueryOptionsFn.returnType = t.tsTypeAnnotation(t.tsTypeReference(t.identifier('UseQueryOptions'), t.tsTypeParameterInstantiation([t.tsTypeReference(t.identifier(responseType)), t.tsTypeReference(t.identifier('Error')), t.tsTypeReference(t.identifier(GENERIC_SELECT_RESPONSE_NAME))])));
+    return t.objectProperty( // key id is the camel method name
+    t.identifier(camel(methodName)), methodQueryOptionsFn);
+  })]))]));
+}
+
+const GENERIC_SELECT_RESPONSE_NAME = 'TData';
+
 function createReactQueryHookGenericInterface({
   context,
   QueryClient,
@@ -257,14 +328,13 @@ function createReactQueryHookGenericInterface({
 }) {
   const options = context.options.reactQuery;
   const genericResponseTypeName = 'TResponse';
-  const genericSelectResponseTypeName = 'TData';
   context.addUtil('UseQueryOptions'); // UseQueryOptions<TResponse, Error, TData>,
 
-  const typedUseQueryOptions = t.tsTypeReference(t.identifier('UseQueryOptions'), t.tsTypeParameterInstantiation([t.tsTypeReference(t.identifier(genericResponseTypeName)), t.tsTypeReference(t.identifier('Error')), t.tsTypeReference(t.identifier(genericSelectResponseTypeName))]));
+  const typedUseQueryOptions = t.tsTypeReference(t.identifier('UseQueryOptions'), t.tsTypeParameterInstantiation([t.tsTypeReference(t.identifier(genericResponseTypeName)), t.tsTypeReference(t.identifier('Error')), t.tsTypeReference(t.identifier(GENERIC_SELECT_RESPONSE_NAME))]));
   const body = [tsPropertySignature(t.identifier('client'), t.tsTypeAnnotation(options.optionalClient ? t.tsUnionType([t.tsTypeReference(t.identifier(QueryClient)), t.tsUndefinedKeyword()]) : t.tsTypeReference(t.identifier(QueryClient))), false), tsPropertySignature(t.identifier('options'), t.tsTypeAnnotation(options.version === 'v4' ? t.tSIntersectionType([omitTypeReference(typedUseQueryOptions, "'queryKey' | 'queryFn' | 'initialData'"), t.tSTypeLiteral([t.tsPropertySignature(t.identifier('initialData?'), t.tsTypeAnnotation(t.tsUndefinedKeyword()))])]) : typedUseQueryOptions), true)];
   return t.exportNamedDeclaration(t.tsInterfaceDeclaration(t.identifier(genericQueryInterfaceName), t.tsTypeParameterDeclaration([// 1: TResponse
   t.tsTypeParameter(undefined, undefined, genericResponseTypeName), // 2: TData
-  t.tsTypeParameter(undefined, t.tSTypeReference(t.identifier(genericResponseTypeName)), genericSelectResponseTypeName)]), [], t.tSInterfaceBody(body)));
+  t.tsTypeParameter(undefined, t.tSTypeReference(t.identifier(genericResponseTypeName)), GENERIC_SELECT_RESPONSE_NAME)]), [], t.tSInterfaceBody(body)));
 }
 
 export const createReactQueryHookInterface = ({
@@ -285,9 +355,9 @@ export const createReactQueryHookInterface = ({
     t.tsTypeLiteral(props))));
   }
 
-  return t.exportNamedDeclaration(t.tsInterfaceDeclaration(t.identifier(hookParamsTypeName), t.tsTypeParameterDeclaration([t.tSTypeParameter(undefined, undefined, 'TData')]), [t.tSExpressionWithTypeArguments(t.identifier(queryInterfaceName), t.tsTypeParameterInstantiation([// 1: response
+  return t.exportNamedDeclaration(t.tsInterfaceDeclaration(t.identifier(hookParamsTypeName), t.tsTypeParameterDeclaration([t.tSTypeParameter(undefined, undefined, GENERIC_SELECT_RESPONSE_NAME)]), [t.tSExpressionWithTypeArguments(t.identifier(queryInterfaceName), t.tsTypeParameterInstantiation([// 1: response
   t.tsTypeReference(t.identifier(responseType)), // 2: select generic
-  t.tSTypeReference(t.identifier('TData'))]))], t.tsInterfaceBody(body)));
+  t.tSTypeReference(t.identifier(GENERIC_SELECT_RESPONSE_NAME))]))], t.tsInterfaceBody(body)));
 };
 
 const getProps = (context, jsonschema) => {

package/module/react-query/react-query.spec.js

@@ -43,6 +43,19 @@ it('createReactQueryHooks', () => {
     contractName: 'Sg721',
     QueryClient: 'Sg721QueryClient'
   })));
+  expectCode(t.program(createReactQueryHooks({
+    context: makeContext(query_msg, {
+      reactQuery: {
+        optionalClient: true,
+        version: 'v4',
+        queryKeys: true,
+        queryFactory: true
+      }
+    }),
+    queryMsg: query_msg,
+    contractName: 'Sg721',
+    QueryClient: 'Sg721QueryClient'
+  })));
   expectCode(t.program(createReactQueryMutationHooks({
     context: execCtx,
     execMsg: execute_msg,

package/module/utils/babel.js

@@ -62,11 +62,12 @@ export const classDeclaration = (name, body, implementsExressions = [], superCla
 
   return declaration;
 };
-export const classProperty = (name, typeAnnotation = null, isReadonly = false, isStatic = false) => {
+export const classProperty = (name, typeAnnotation = null, isReadonly = false, isStatic = false, noImplicitOverride = false) => {
   const prop = t.classProperty(t.identifier(name));
   if (isReadonly) prop.readonly = true;
   if (isStatic) prop.static = true;
   if (typeAnnotation) prop.typeAnnotation = typeAnnotation;
+  if (noImplicitOverride) prop.override = true;
   return prop;
 };
 export const arrowFunctionExpression = (params, body, returnType, isAsync = false) => {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "wasm-ast-types",
-  "version": "0.13.0",
+  "version": "0.15.0",
   "description": "CosmWasm TypeScript AST generation",
   "author": "Dan Lynch <pyramation@gmail.com>",
   "homepage": "https://github.com/pyramation/cosmwasm-typescript-gen/tree/master/packages/wasm-ast-types#readme",
@@ -88,5 +88,5 @@
     "case": "1.6.3",
     "deepmerge": "4.2.2"
   },
-  "gitHead": "e46828bd476d30465a35a8021e611938abf89846"
+  "gitHead": "ef4b39134cf220c860469ae3cae49aeab91ee80d"
 }

package/src/client/client.ts

@@ -414,13 +414,15 @@ export const createExecuteClass = (
     ...bindings
   ]);
 
+  const noImplicitOverride = context.options.client.noImplicitOverride && extendsClassName && context.options.client.execExtendsQuery;
+
   return t.exportNamedDeclaration(
     classDeclaration(className,
       [
         // client
         classProperty('client', t.tsTypeAnnotation(
           t.tsTypeReference(t.identifier('SigningCosmWasmClient'))
-        )),
+        ), false, false, noImplicitOverride),
 
         // sender
         classProperty('sender', t.tsTypeAnnotation(
@@ -430,7 +432,7 @@ export const createExecuteClass = (
         // contractAddress
         classProperty('contractAddress', t.tsTypeAnnotation(
           t.tsStringKeyword()
-        )),
+        ), false, false, noImplicitOverride),
 
         // constructor
         t.classMethod('constructor',