@tanstack/preact-query 0.0.1 → 5.91.0

package/build/codemods/src/v5/keep-previous-data/keep-previous-data.cjs

@@ -0,0 +1,271 @@
+const createUtilsObject = require('../../utils/index.cjs')
+const createUseQueryLikeTransformer = require('../../utils/transformers/use-query-like-transformer.cjs')
+const createQueryClientTransformer = require('../../utils/transformers/query-client-transformer.cjs')
+const AlreadyHasPlaceholderDataProperty = require('./utils/already-has-placeholder-data-property.cjs')
+
+/**
+ * @param {import('jscodeshift')} jscodeshift
+ * @param {Object} utils
+ * @param {import('jscodeshift').Collection} root
+ * @param {string} filePath
+ * @param {{keyName: "mutationKey"|"queryKey", queryClientMethods: ReadonlyArray<string>, hooks: ReadonlyArray<string>}} config
+ */
+const transformUsages = ({ jscodeshift, utils, root, filePath, config }) => {
+  /**
+   * @param {import('jscodeshift').CallExpression | import('jscodeshift').ExpressionStatement} node
+   * @returns {{start: number, end: number}}
+   */
+  const getNodeLocation = (node) => {
+    const location = utils.isCallExpression(node) ? node.callee.loc : node.loc
+    const start = location.start.line
+    const end = location.end.line
+
+    return { start, end }
+  }
+
+  /**
+   * @param {import('jscodeshift').ObjectProperty} objectProperty
+   * @returns {boolean}
+   */
+  const isKeepPreviousDataObjectProperty = (objectProperty) => {
+    return jscodeshift.match(objectProperty.key, {
+      type: jscodeshift.Identifier.name,
+      name: 'keepPreviousData',
+    })
+  }
+
+  /**
+   * @param {import('jscodeshift').ObjectProperty} objectProperty
+   * @returns {boolean}
+   */
+  const isObjectPropertyHasTrueBooleanLiteralValue = (objectProperty) => {
+    return jscodeshift.match(objectProperty.value, {
+      type: jscodeshift.BooleanLiteral.name,
+      value: true,
+    })
+  }
+
+  /**
+   * @param {import('jscodeshift').ObjectExpression} objectExpression
+   * @returns {Array<import('jscodeshift').ObjectProperty>}
+   */
+  const filterKeepPreviousDataProperty = (objectExpression) => {
+    return objectExpression.properties.filter((objectProperty) => {
+      return !isKeepPreviousDataObjectProperty(objectProperty)
+    })
+  }
+
+  const createPlaceholderDataObjectProperty = () => {
+    return jscodeshift.objectProperty(
+      jscodeshift.identifier('placeholderData'),
+      jscodeshift.identifier('keepPreviousData'),
+    )
+  }
+
+  /**
+   * @param {import('jscodeshift').ObjectExpression} objectExpression
+   * @returns {boolean}
+   */
+  const hasPlaceholderDataProperty = (objectExpression) => {
+    return (
+      objectExpression.properties.findIndex((objectProperty) => {
+        return jscodeshift.match(objectProperty.key, {
+          type: jscodeshift.Identifier.name,
+          name: 'placeholderData',
+        })
+      }) !== -1
+    )
+  }
+
+  /**
+   * @param {import('jscodeshift').ObjectExpression} objectExpression
+   * @returns {import('jscodeshift').ObjectProperty | undefined}
+   */
+  const getKeepPreviousDataProperty = (objectExpression) => {
+    return objectExpression.properties.find(isKeepPreviousDataObjectProperty)
+  }
+
+  let shouldAddKeepPreviousDataImport = false
+
+  const replacer = (path, resolveTargetArgument, transformNode) => {
+    const node = path.node
+    const { start, end } = getNodeLocation(node)
+
+    try {
+      const targetArgument = resolveTargetArgument(node)
+
+      if (targetArgument && utils.isObjectExpression(targetArgument)) {
+        const isPlaceholderDataPropertyPresent =
+          hasPlaceholderDataProperty(targetArgument)
+
+        if (hasPlaceholderDataProperty(targetArgument)) {
+          throw new AlreadyHasPlaceholderDataProperty(node, filePath)
+        }
+
+        const keepPreviousDataProperty =
+          getKeepPreviousDataProperty(targetArgument)
+
+        const keepPreviousDataPropertyHasTrueValue =
+          isObjectPropertyHasTrueBooleanLiteralValue(keepPreviousDataProperty)
+
+        if (!keepPreviousDataPropertyHasTrueValue) {
+          utils.warn(
+            `The usage in file "${filePath}" at line ${start}:${end} already contains a "keepPreviousData" property but its value is not "true". Please migrate this usage manually.`,
+          )
+
+          return node
+        }
+
+        if (keepPreviousDataPropertyHasTrueValue) {
+          // Removing the `keepPreviousData` property from the object.
+          const mutableObjectExpressionProperties =
+            filterKeepPreviousDataProperty(targetArgument)
+
+          if (!isPlaceholderDataPropertyPresent) {
+            shouldAddKeepPreviousDataImport = true
+
+            // When the `placeholderData` property is not present, the `placeholderData: keepPreviousData` property will be added.
+            mutableObjectExpressionProperties.push(
+              createPlaceholderDataObjectProperty(),
+            )
+          }
+
+          return transformNode(
+            node,
+            jscodeshift.objectExpression(mutableObjectExpressionProperties),
+          )
+        }
+      }
+
+      utils.warn(
+        `The usage in file "${filePath}" at line ${start}:${end} could not be transformed, because the first parameter is not an object expression. Please migrate this usage manually.`,
+      )
+
+      return node
+    } catch (error) {
+      utils.warn(
+        error.name === AlreadyHasPlaceholderDataProperty.name
+          ? error.message
+          : `An unknown error occurred while processing the "${filePath}" file. Please review this file, because the codemod couldn't be applied.`,
+      )
+
+      return node
+    }
+  }
+
+  createUseQueryLikeTransformer({ jscodeshift, utils, root }).execute(
+    config.hooks,
+    (path) => {
+      const resolveTargetArgument = (node) => node.arguments[0] ?? null
+      const transformNode = (node, transformedArgument) =>
+        jscodeshift.callExpression(node.original.callee, [transformedArgument])
+
+      return replacer(path, resolveTargetArgument, transformNode)
+    },
+  )
+
+  createQueryClientTransformer({ jscodeshift, utils, root }).execute(
+    config.queryClientMethods,
+    (path) => {
+      const resolveTargetArgument = (node) => node.arguments[1] ?? null
+      const transformNode = (node, transformedArgument) => {
+        return jscodeshift.callExpression(node.original.callee, [
+          node.arguments[0],
+          transformedArgument,
+          ...node.arguments.slice(2, 0),
+        ])
+      }
+
+      return replacer(path, resolveTargetArgument, transformNode)
+    },
+  )
+
+  const importIdentifierOfQueryClient = utils.getSelectorByImports(
+    utils.locateImports(['QueryClient']),
+    'QueryClient',
+  )
+
+  root
+    .find(jscodeshift.ExpressionStatement, {
+      expression: {
+        type: jscodeshift.NewExpression.name,
+        callee: {
+          type: jscodeshift.Identifier.name,
+          name: importIdentifierOfQueryClient,
+        },
+      },
+    })
+    .filter((path) => path.node.expression)
+    .replaceWith((path) => {
+      const resolveTargetArgument = (node) => {
+        const paths = jscodeshift(node)
+          .find(jscodeshift.ObjectProperty, {
+            key: {
+              type: jscodeshift.Identifier.name,
+              name: 'keepPreviousData',
+            },
+          })
+          .paths()
+
+        return paths.length > 0 ? paths[0].parent.node : null
+      }
+      const transformNode = (node, transformedArgument) => {
+        jscodeshift(node.expression)
+          .find(jscodeshift.ObjectProperty, {
+            key: {
+              type: jscodeshift.Identifier.name,
+              name: 'queries',
+            },
+          })
+          .replaceWith(({ node: mutableNode }) => {
+            mutableNode.value.properties = transformedArgument.properties
+
+            return mutableNode
+          })
+
+        return node
+      }
+
+      return replacer(path, resolveTargetArgument, transformNode)
+    })
+
+  return { shouldAddKeepPreviousDataImport }
+}
+
+module.exports = (file, api) => {
+  const jscodeshift = api.jscodeshift
+  const root = jscodeshift(file.source)
+  const utils = createUtilsObject({ root, jscodeshift })
+  const filePath = file.path
+
+  const dependencies = { jscodeshift, utils, root, filePath }
+
+  const { shouldAddKeepPreviousDataImport } = transformUsages({
+    ...dependencies,
+    config: {
+      hooks: ['useInfiniteQuery', 'useQueries', 'useQuery'],
+      queryClientMethods: ['setQueryDefaults'],
+    },
+  })
+
+  if (shouldAddKeepPreviousDataImport) {
+    root
+      .find(jscodeshift.ImportDeclaration, {
+        source: {
+          value: '@tanstack/react-query',
+        },
+      })
+      .replaceWith(({ node: mutableNode }) => {
+        mutableNode.specifiers = [
+          jscodeshift.importSpecifier(
+            jscodeshift.identifier('keepPreviousData'),
+          ),
+          ...mutableNode.specifiers,
+        ]
+
+        return mutableNode
+      })
+  }
+
+  return root.toSource({ quote: 'single', lineTerminator: '\n' })
+}

package/build/codemods/src/v5/keep-previous-data/utils/already-has-placeholder-data-property.cjs

@@ -0,0 +1,26 @@
+class AlreadyHasPlaceholderDataProperty extends Error {
+  /**
+   * @param {import('jscodeshift').CallExpression} callExpression
+   * @param {string} filePath
+   */
+  constructor(callExpression, filePath) {
+    super('')
+    this.message = this.buildMessage(callExpression, filePath)
+    this.name = 'AlreadyHasPlaceholderDataProperty'
+  }
+
+  /**
+   * @param {import('jscodeshift').CallExpression} callExpression
+   * @param {string} filePath
+   * @returns {string}
+   */
+  buildMessage(callExpression, filePath) {
+    const location = callExpression.callee.loc
+    const start = location.start.line
+    const end = location.end.line
+
+    return `The usage in file "${filePath}" at line ${start}:${end} already contains a a "placeholderData" property. Please migrate this usage manually.`
+  }
+}
+
+module.exports = AlreadyHasPlaceholderDataProperty

package/build/codemods/src/v5/remove-overloads/remove-overloads.cjs

@@ -0,0 +1,58 @@
+const createUtilsObject = require('../../utils/index.cjs')
+const transformFilterAwareUsages = require('./transformers/filter-aware-usage-transformer.cjs')
+const transformQueryFnAwareUsages = require('./transformers/query-fn-aware-usage-transformer.cjs')
+
+module.exports = (file, api) => {
+  const jscodeshift = api.jscodeshift
+  const root = jscodeshift(file.source)
+  const utils = createUtilsObject({ root, jscodeshift })
+  const filePath = file.path
+
+  const dependencies = { jscodeshift, utils, root, filePath }
+
+  transformFilterAwareUsages({
+    ...dependencies,
+    config: {
+      keyName: 'queryKey',
+      fnName: 'queryFn',
+      queryClientMethods: [
+        'cancelQueries',
+        'getQueriesData',
+        'invalidateQueries',
+        'isFetching',
+        'refetchQueries',
+        'removeQueries',
+        'resetQueries',
+        // 'setQueriesData',
+      ],
+      hooks: ['useIsFetching', 'useQuery'],
+    },
+  })
+
+  transformFilterAwareUsages({
+    ...dependencies,
+    config: {
+      keyName: 'mutationKey',
+      fnName: 'mutationFn',
+      queryClientMethods: [],
+      hooks: ['useIsMutating', 'useMutation'],
+    },
+  })
+
+  transformQueryFnAwareUsages({
+    ...dependencies,
+    config: {
+      keyName: 'queryKey',
+      queryClientMethods: [
+        'ensureQueryData',
+        'fetchQuery',
+        'prefetchQuery',
+        'fetchInfiniteQuery',
+        'prefetchInfiniteQuery',
+      ],
+      hooks: [],
+    },
+  })
+
+  return root.toSource({ quote: 'single', lineTerminator: '\n' })
+}

package/build/codemods/src/v5/remove-overloads/transformers/filter-aware-usage-transformer.cjs

@@ -0,0 +1,271 @@
+const createV5UtilsObject = require('../utils/index.cjs')
+const UnknownUsageError = require('../utils/unknown-usage-error.cjs')
+const createQueryClientTransformer = require('../../../utils/transformers/query-client-transformer.cjs')
+const createQueryCacheTransformer = require('../../../utils/transformers/query-cache-transformer.cjs')
+const createUseQueryLikeTransformer = require('../../../utils/transformers/use-query-like-transformer.cjs')
+
+/**
+ * @param {import('jscodeshift').api} jscodeshift
+ * @param {Object} utils
+ * @param {import('jscodeshift').Collection} root
+ * @param {string} filePath
+ * @param {{keyName: "mutationKey"|"queryKey", fnName: "mutationFn"|"queryFn", queryClientMethods: ReadonlyArray<string>, hooks: ReadonlyArray<string>}} config
+ */
+const transformFilterAwareUsages = ({
+  jscodeshift,
+  utils,
+  root,
+  filePath,
+  config,
+}) => {
+  const v5Utils = createV5UtilsObject({ jscodeshift, utils })
+
+  /**
+   * @param {import('jscodeshift').CallExpression} node
+   * @param {"mutationKey"|"queryKey"} keyName
+   * @param {"mutationFn"|"queryFn"} fnName
+   * @returns {boolean}
+   */
+  const canSkipReplacement = (node, keyName, fnName) => {
+    const callArguments = node.arguments
+
+    const hasKeyOrFnProperty = () =>
+      callArguments[0].properties.some(
+        (property) =>
+          utils.isObjectProperty(property) &&
+          property.key.name !== keyName &&
+          property.key.name !== fnName,
+      )
+
+    /**
+     * This call has at least one argument. If it's an object expression and contains the "queryKey" or "mutationKey"
+     * field, the transformation can be skipped, because it's already matching the expected signature.
+     */
+    return (
+      callArguments.length > 0 &&
+      utils.isObjectExpression(callArguments[0]) &&
+      hasKeyOrFnProperty()
+    )
+  }
+
+  /**
+   * This function checks whether the given object property is a spread element or a property that's not named
+   * "queryKey" or "mutationKey".
+   *
+   * @param {import('jscodeshift').ObjectProperty} property
+   * @returns {boolean}
+   */
+  const predicate = (property) => {
+    const isSpreadElement = utils.isSpreadElement(property)
+    const isObjectProperty = utils.isObjectProperty(property)
+
+    return (
+      isSpreadElement ||
+      (isObjectProperty && property.key.name !== config.keyName)
+    )
+  }
+
+  const replacer = (path) => {
+    const node = path.node
+
+    const isFunctionDefinition = (functionArgument) => {
+      if (utils.isFunctionDefinition(functionArgument)) {
+        return true
+      }
+
+      if (utils.isIdentifier(functionArgument)) {
+        const binding = v5Utils.getBindingFromScope(
+          path,
+          functionArgument.name,
+          filePath,
+        )
+
+        const isVariableDeclarator = jscodeshift.match(binding, {
+          type: jscodeshift.VariableDeclarator.name,
+        })
+
+        return isVariableDeclarator && utils.isFunctionDefinition(binding.init)
+      }
+    }
+
+    try {
+      // If the given method/function call matches certain criteria, the node doesn't need to be replaced, this step can be skipped.
+      if (canSkipReplacement(node, config.keyName, config.fnName)) {
+        return node
+      }
+
+      /**
+       * Here we attempt to determine the first parameter of the function call.
+       * If it's a function definition, we can create an object property from it (the mutation fn).
+       */
+      const firstArgument = node.arguments[0]
+      if (isFunctionDefinition(firstArgument)) {
+        const objectExpression = jscodeshift.objectExpression([
+          jscodeshift.property(
+            'init',
+            jscodeshift.identifier(config.fnName),
+            firstArgument,
+          ),
+        ])
+
+        const secondArgument = node.arguments[1]
+
+        if (secondArgument) {
+          // If it's an object expression, we can copy the properties from it to the newly created object expression.
+          if (utils.isObjectExpression(secondArgument)) {
+            v5Utils.copyPropertiesFromSource(
+              secondArgument,
+              objectExpression,
+              predicate,
+            )
+          } else {
+            // Otherwise, we simply spread the second argument in the newly created object expression.
+            objectExpression.properties.push(
+              jscodeshift.spreadElement(secondArgument),
+            )
+          }
+        }
+
+        return jscodeshift.callExpression(node.original.callee, [
+          objectExpression,
+        ])
+      }
+
+      /**
+       * If, instead, the first parameter is an array expression or an identifier that references
+       * an array expression, then we create an object property from it (the query or mutation key).
+       *
+       * @type {import('jscodeshift').Property|undefined}
+       */
+      const keyProperty = v5Utils.transformArgumentToKey(
+        path,
+        node.arguments[0],
+        config.keyName,
+        filePath,
+      )
+
+      /**
+       * The first parameter couldn't be transformed into an object property, so it's time to throw an exception,
+       * it will notify the consumers that they need to rewrite this usage manually.
+       */
+      if (!keyProperty) {
+        const secondArgument =
+          node.arguments.length > 1 ? node.arguments[1] : null
+
+        if (!secondArgument) {
+          throw new UnknownUsageError(node, filePath)
+        }
+
+        if (utils.isFunctionDefinition(secondArgument)) {
+          const originalArguments = node.arguments
+          const firstArgument = jscodeshift.objectExpression([
+            jscodeshift.property(
+              'init',
+              jscodeshift.identifier(config.keyName),
+              originalArguments[0],
+            ),
+            jscodeshift.property(
+              'init',
+              jscodeshift.identifier(config.fnName),
+              secondArgument,
+            ),
+          ])
+
+          return jscodeshift.callExpression(node.original.callee, [
+            firstArgument,
+            ...originalArguments.slice(2),
+          ])
+        }
+      }
+
+      const functionArguments = [jscodeshift.objectExpression([keyProperty])]
+      const secondParameter = node.arguments[1]
+
+      if (secondParameter) {
+        const createdObjectExpression = functionArguments[0]
+
+        if (isFunctionDefinition(secondParameter)) {
+          const objectExpression = jscodeshift.objectExpression([
+            jscodeshift.property(
+              'init',
+              jscodeshift.identifier(config.keyName),
+              node.arguments[0],
+            ),
+            jscodeshift.property(
+              'init',
+              jscodeshift.identifier(config.fnName),
+              secondParameter,
+            ),
+          ])
+
+          const thirdArgument = node.arguments[2]
+
+          if (thirdArgument) {
+            // If it's an object expression, we can copy the properties from it to the newly created object expression.
+            if (utils.isObjectExpression(thirdArgument)) {
+              v5Utils.copyPropertiesFromSource(
+                thirdArgument,
+                objectExpression,
+                predicate,
+              )
+            } else {
+              // Otherwise, we simply spread the third argument in the newly created object expression.
+              objectExpression.properties.push(
+                jscodeshift.spreadElement(thirdArgument),
+              )
+            }
+          }
+
+          return jscodeshift.callExpression(node.original.callee, [
+            objectExpression,
+          ])
+        }
+
+        /**
+         * If it has a second argument, and it's an object expression, then we get the properties from it
+         * (except the "queryKey" or "mutationKey" properties), because these arguments will also be moved to the
+         * newly created object expression.
+         */
+        if (utils.isObjectExpression(secondParameter)) {
+          v5Utils.copyPropertiesFromSource(
+            secondParameter,
+            createdObjectExpression,
+            predicate,
+          )
+        } else {
+          // Otherwise, we simply spread the second parameter in the newly created object expression.
+          createdObjectExpression.properties.push(
+            jscodeshift.spreadElement(secondParameter),
+          )
+        }
+      }
+
+      // The rest of the function arguments can be simply pushed to the function arguments object so all will be kept.
+      functionArguments.push(...node.arguments.slice(2))
+
+      return jscodeshift.callExpression(node.original.callee, functionArguments)
+    } catch (error) {
+      utils.warn(
+        error.name === UnknownUsageError.name
+          ? error.message
+          : `An unknown error occurred while processing the "${filePath}" file. Please review this file, because the codemod couldn't be applied.`,
+      )
+
+      return node
+    }
+  }
+
+  createQueryClientTransformer({ jscodeshift, utils, root }).execute(
+    config.queryClientMethods,
+    replacer,
+  )
+
+  createUseQueryLikeTransformer({ jscodeshift, utils, root }).execute(
+    config.hooks,
+    replacer,
+  )
+
+  createQueryCacheTransformer({ jscodeshift, utils, root }).execute(replacer)
+}
+
+module.exports = transformFilterAwareUsages