feat: unify react-query query keys

2024-04-12 10:07:51 +01:00
parent 897c96361f
commit a36d10870b
46 changed files with 56 additions and 54 deletions
--- a/packages/web/src/hooks/useActionSubsteps.js
+++ b/packages/web/src/hooks/useActionSubsteps.js
@@ -4,7 +4,7 @@ import api from 'helpers/api';

 export default function useActionSubsteps({ appKey, actionKey }) {
  const query = useQuery({
-    queryKey: ['actionSubsteps', appKey, actionKey],
+    queryKey: ['apps', appKey, 'actions', actionKey, 'substeps'],
    queryFn: async ({ signal }) => {
      const { data } = await api.get(
        `/v1/apps/${appKey}/actions/${actionKey}/substeps`,
--- a/packages/web/src/hooks/useActions.js
+++ b/packages/web/src/hooks/useActions.js
@@ -4,7 +4,7 @@ import api from 'helpers/api';

 export default function useActions(appKey) {
  const query = useQuery({
-    queryKey: ['actions', appKey],
+    queryKey: ['apps', appKey, 'actions'],
    queryFn: async ({ signal }) => {
      const { data } = await api.get(`/v1/apps/${appKey}/actions`, {
        signal,
--- a/packages/web/src/hooks/useAdminAppAuthClient.ee.js
+++ b/packages/web/src/hooks/useAdminAppAuthClient.ee.js
@@ -4,7 +4,7 @@ import api from 'helpers/api';

 export default function useAdminAppAuthClient(id) {
  const query = useQuery({
-    queryKey: ['adminAppAuthClient', id],
+    queryKey: ['admin', 'appAuthClients', id],
    queryFn: async ({ signal }) => {
      const { data } = await api.get(`/v1/admin/app-auth-clients/${id}`, {
        signal,
--- a/packages/web/src/hooks/useAdminSamlAuthProviderRoleMappings.js
+++ b/packages/web/src/hooks/useAdminSamlAuthProviderRoleMappings.js
@@ -3,13 +3,13 @@ import { useQuery } from '@tanstack/react-query';
 import api from 'helpers/api';

 export default function useAdminSamlAuthProviderRoleMappings({
-  adminSamlAuthProviderId,
+  adminSamlAuthProviderId: providerId,
 }) {
  const query = useQuery({
-    queryKey: ['adminSamlAuthProviderRoleMappings', adminSamlAuthProviderId],
+    queryKey: ['admin', 'samlAuthProviders', providerId, 'roleMappings'],
    queryFn: async ({ signal }) => {
      const { data } = await api.get(
-        `/v1/admin/saml-auth-providers/${adminSamlAuthProviderId}/role-mappings`,
+        `/v1/admin/saml-auth-providers/${providerId}/role-mappings`,
        {
          signal,
        },
@@ -17,7 +17,7 @@ export default function useAdminSamlAuthProviderRoleMappings({

      return data;
    },
-    enabled: !!adminSamlAuthProviderId,
+    enabled: !!providerId,
  });

  return query;
--- a/packages/web/src/hooks/useAdminSamlAuthProviders.ee.js
+++ b/packages/web/src/hooks/useAdminSamlAuthProviders.ee.js
@@ -4,7 +4,7 @@ import api from 'helpers/api';

 export default function useAdminSamlAuthProviders() {
  const query = useQuery({
-    queryKey: ['adminSamlAuthProviders'],
+    queryKey: ['admin', 'samlAuthProviders'],
    queryFn: async ({ signal }) => {
      const { data } = await api.get('/v1/admin/saml-auth-providers', {
        signal,
--- a/packages/web/src/hooks/useAdminUser.js
+++ b/packages/web/src/hooks/useAdminUser.js
@@ -3,7 +3,7 @@ import api from 'helpers/api';

 export default function useAdminUser({ userId }) {
  const query = useQuery({
-    queryKey: ['admin', 'user', userId],
+    queryKey: ['admin', 'users', userId],
    queryFn: async ({ signal }) => {
      const { data } = await api.get(`/v1/admin/users/${userId}`, {
        signal,
--- a/packages/web/src/hooks/useAdminUsers.js
+++ b/packages/web/src/hooks/useAdminUsers.js
@@ -3,7 +3,7 @@ import api from 'helpers/api';

 export default function useAdminUsers(page) {
  const query = useQuery({
-    queryKey: ['admin', 'users', page],
+    queryKey: ['admin', 'users', { page }],
    queryFn: async ({ signal }) => {
      const { data } = await api.get(`/v1/admin/users`, {
        signal,
--- a/packages/web/src/hooks/useApp.js
+++ b/packages/web/src/hooks/useApp.js
@@ -4,7 +4,7 @@ import api from 'helpers/api';

 export default function useApp(appKey) {
  const query = useQuery({
-    queryKey: ['app', appKey],
+    queryKey: ['apps', appKey],
    queryFn: async ({ signal }) => {
      const { data } = await api.get(`/v1/apps/${appKey}`, {
        signal,
--- a/packages/web/src/hooks/useAppAuth.js
+++ b/packages/web/src/hooks/useAppAuth.js
@@ -4,7 +4,7 @@ import api from 'helpers/api';

 export default function useAppAuth(appKey) {
  const query = useQuery({
-    queryKey: ['appAuth', appKey],
+    queryKey: ['apps', appKey, 'auth'],
    queryFn: async ({ signal }) => {
      const { data } = await api.get(`/v1/apps/${appKey}/auth`, {
        signal,
--- a/packages/web/src/hooks/useAppConfig.ee.js
+++ b/packages/web/src/hooks/useAppConfig.ee.js
@@ -3,7 +3,7 @@ import api from 'helpers/api';

 export default function useAppConfig(appKey) {
  const query = useQuery({
-    queryKey: ['appConfig', appKey],
+    queryKey: ['apps', appKey, 'config'],
    queryFn: async ({ signal }) => {
      const { data } = await api.get(`/v1/apps/${appKey}/config`, {
        signal,
--- a/packages/web/src/hooks/useAppConnections.js
+++ b/packages/web/src/hooks/useAppConnections.js
@@ -4,7 +4,7 @@ import api from 'helpers/api';

 export default function useAppConnections(appKey) {
  const query = useQuery({
-    queryKey: ['appConnections', appKey],
+    queryKey: ['apps', appKey, 'connections'],
    queryFn: async ({ signal }) => {
      const { data } = await api.get(`/v1/apps/${appKey}/connections`, {
        signal,
--- a/packages/web/src/hooks/useAppFlows.js
+++ b/packages/web/src/hooks/useAppFlows.js
@@ -4,7 +4,7 @@ import api from 'helpers/api';

 export default function useAppFlows({ appKey, page }, { enabled }) {
  const query = useQuery({
-    queryKey: ['appFlows', appKey, page],
+    queryKey: ['apps', appKey, 'flows', { page }],
    queryFn: async ({ signal }) => {
      const { data } = await api.get(`/v1/apps/${appKey}/flows`, {
        params: {
--- a/packages/web/src/hooks/useAutomatischInfo.js
+++ b/packages/web/src/hooks/useAutomatischInfo.js
@@ -8,7 +8,7 @@ export default function useAutomatischInfo() {
     * So we can set the `staleTime` to Infinity
     **/
    staleTime: Infinity,
-    queryKey: ['automatischInfo'],
+    queryKey: ['automatisch', 'info'],
    queryFn: async (payload, signal) => {
      const { data } = await api.get('/v1/automatisch/info', { signal });

--- a/packages/web/src/hooks/useConnectionFlows.js
+++ b/packages/web/src/hooks/useConnectionFlows.js
@@ -7,7 +7,7 @@ export default function useConnectionFlows(
  { enabled } = {},
 ) {
  const query = useQuery({
-    queryKey: ['connectionFlows', connectionId, page],
+    queryKey: ['connections', connectionId, 'flows', { page }],
    queryFn: async ({ signal }) => {
      const { data } = await api.get(`/v1/connections/${connectionId}/flows`, {
        params: {
--- a/packages/web/src/hooks/useCurrentUser.js
+++ b/packages/web/src/hooks/useCurrentUser.js
@@ -4,7 +4,7 @@ import api from 'helpers/api';

 export default function useCurrentUser() {
  const query = useQuery({
-    queryKey: ['currentUser'],
+    queryKey: ['users', 'me'],
    queryFn: async ({ signal }) => {
      const { data } = await api.get(`/v1/users/me`, {
        signal,
--- a/packages/web/src/hooks/useDynamicFields.js
+++ b/packages/web/src/hooks/useDynamicFields.js
@@ -74,7 +74,7 @@ function useDynamicFields(stepId, schema) {
  }, [schema, formValues, getValues]);

  const query = useQuery({
-    queryKey: ['dynamicFields', stepId, computedVariables],
+    queryKey: ['steps', stepId, 'dynamicFields', computedVariables],
    queryFn: async ({ signal }) => {
      const { data } = await api.post(
        `/v1/steps/${stepId}/dynamic-fields`,
--- a/packages/web/src/hooks/useExecution.js
+++ b/packages/web/src/hooks/useExecution.js
@@ -4,7 +4,7 @@ import api from 'helpers/api';

 export default function useExecution({ executionId }) {
  const query = useQuery({
-    queryKey: ['execution', executionId],
+    queryKey: ['executions', executionId],
    queryFn: async ({ signal }) => {
      const { data } = await api.get(`/v1/executions/${executionId}`, {
        signal,
--- a/packages/web/src/hooks/useExecutionSteps.js
+++ b/packages/web/src/hooks/useExecutionSteps.js
@@ -4,7 +4,7 @@ import api from 'helpers/api';

 export default function useExecutionSteps({ executionId }) {
  const query = useInfiniteQuery({
-    queryKey: ['executionSteps', executionId],
+    queryKey: ['executions', executionId, 'executionSteps'],
    queryFn: async ({ pageParam = 1, signal }) => {
      const { data } = await api.get(
        `/v1/executions/${executionId}/execution-steps`,
--- a/packages/web/src/hooks/useExecutions.js
+++ b/packages/web/src/hooks/useExecutions.js
@@ -4,7 +4,7 @@ import api from 'helpers/api';

 export default function useExecutions({ page }, { refetchInterval } = {}) {
  const query = useQuery({
-    queryKey: ['executions', page],
+    queryKey: ['executions', { page }],
    queryFn: async ({ signal }) => {
      const { data } = await api.get(`/v1/executions`, {
        params: {
--- a/packages/web/src/hooks/useFlow.js
+++ b/packages/web/src/hooks/useFlow.js
@@ -4,7 +4,7 @@ import api from 'helpers/api';

 export default function useFlow(flowId) {
  const query = useQuery({
-    queryKey: ['flow', flowId],
+    queryKey: ['flows', flowId],
    queryFn: async ({ signal }) => {
      const { data } = await api.get(`/v1/flows/${flowId}`, {
        signal,
--- a/packages/web/src/hooks/useInvoices.ee.js
+++ b/packages/web/src/hooks/useInvoices.ee.js
@@ -4,7 +4,7 @@ import api from 'helpers/api';

 export default function useInvoices() {
  const query = useQuery({
-    queryKey: ['invoices'],
+    queryKey: ['users', 'invoices'],
    queryFn: async ({ signal }) => {
      const { data } = await api.get('/v1/users/invoices', {
        signal,
--- a/packages/web/src/hooks/usePaddleInfo.ee.js
+++ b/packages/web/src/hooks/usePaddleInfo.ee.js
@@ -3,7 +3,7 @@ import api from 'helpers/api';

 export default function usePaddleInfo() {
  const query = useQuery({
-    queryKey: ['paddleInfo'],
+    queryKey: ['payment', 'paddleInfo'],
    queryFn: async ({ signal }) => {
      const { data } = await api.get('/v1/payment/paddle-info', {
        signal,
--- a/packages/web/src/hooks/usePaymentPlans.ee.js
+++ b/packages/web/src/hooks/usePaymentPlans.ee.js
@@ -4,7 +4,7 @@ import api from 'helpers/api';

 export default function usePaymentPlans() {
  const query = useQuery({
-    queryKey: ['paymentPlans'],
+    queryKey: ['payment', 'plans'],
    queryFn: async ({ signal }) => {
      const { data } = await api.get('/v1/payment/plans', {
        signal,
--- a/packages/web/src/hooks/usePermissionCatalog.ee.js
+++ b/packages/web/src/hooks/usePermissionCatalog.ee.js
@@ -4,7 +4,7 @@ import api from 'helpers/api';

 export default function usePermissionCatalog() {
  const query = useQuery({
-    queryKey: ['permissionCatalog'],
+    queryKey: ['admin', 'permissions', 'catalog'],
    queryFn: async ({ signal }) => {
      const { data } = await api.get('/v1/admin/permissions/catalog', {
        signal,
--- a/packages/web/src/hooks/usePlanAndUsage.js
+++ b/packages/web/src/hooks/usePlanAndUsage.js
@@ -4,7 +4,7 @@ import api from 'helpers/api';

 export default function usePlanAndUsage(userId) {
  const query = useQuery({
-    queryKey: ['planAndUsage', userId],
+    queryKey: ['users', userId, 'planAndUsage'],
    queryFn: async ({ signal }) => {
      const { data } = await api.get(`/v1/users/${userId}/plan-and-usage`, {
        signal,
--- a/packages/web/src/hooks/useRole.ee.js
+++ b/packages/web/src/hooks/useRole.ee.js
@@ -4,7 +4,7 @@ import api from 'helpers/api';

 export default function useRole({ roleId }) {
  const query = useQuery({
-    queryKey: ['role', roleId],
+    queryKey: ['admin', 'roles', roleId],
    queryFn: async ({ signal }) => {
      const { data } = await api.get(`/v1/admin/roles/${roleId}`, {
        signal,
--- a/packages/web/src/hooks/useRoles.ee.js
+++ b/packages/web/src/hooks/useRoles.ee.js
@@ -4,7 +4,7 @@ import api from 'helpers/api';
 export default function useRoles() {
  const query = useQuery({
    staleTime: 0,
-    queryKey: ['roles'],
+    queryKey: ['admin', 'roles'],
    queryFn: async ({ signal }) => {
      const { data } = await api.get('/v1/admin/roles', {
        signal,
--- a/packages/web/src/hooks/useSamlAuthProvider.js
+++ b/packages/web/src/hooks/useSamlAuthProvider.js
@@ -4,7 +4,7 @@ import api from 'helpers/api';

 export default function useSamlAuthProvider({ samlAuthProviderId } = {}) {
  const query = useQuery({
-    queryKey: ['samlAuthProvider', samlAuthProviderId],
+    queryKey: ['samlAuthProviders', samlAuthProviderId],
    queryFn: async ({ signal }) => {
      const { data } = await api.get(
        `/v1/admin/saml-auth-providers/${samlAuthProviderId}`,
--- a/packages/web/src/hooks/useStepConnection.js
+++ b/packages/web/src/hooks/useStepConnection.js
@@ -4,7 +4,7 @@ import api from 'helpers/api';

 export default function useStepConnection(stepId) {
  const query = useQuery({
-    queryKey: ['stepConnection', stepId],
+    queryKey: ['steps', stepId, 'connection'],
    queryFn: async ({ signal }) => {
      const { data } = await api.get(`/v1/steps/${stepId}/connection`, {
        signal,
--- a/packages/web/src/hooks/useStepWithTestExecutions.js
+++ b/packages/web/src/hooks/useStepWithTestExecutions.js
@@ -4,7 +4,7 @@ import api from 'helpers/api';

 export default function useStepWithTestExecutions(stepId) {
  const query = useQuery({
-    queryKey: ['stepWithTestExecutions', stepId],
+    queryKey: ['steps', stepId, 'previousSteps'],
    queryFn: async ({ signal }) => {
      const { data } = await api.get(`/v1/steps/${stepId}/previous-steps`, {
        signal,
--- a/packages/web/src/hooks/useSubscription.ee.js
+++ b/packages/web/src/hooks/useSubscription.ee.js
@@ -25,7 +25,7 @@ export default function useSubscription() {
  const [isPolling, setIsPolling] = React.useState(false);

  const { data } = useQuery({
-    queryKey: ['subscription'],
+    queryKey: ['users', 'me', 'subscription'],
    queryFn: async ({ signal }) => {
      const { data } = await api.get(`/v1/users/me/subscription`, {
        signal,
--- a/packages/web/src/hooks/useTriggerSubsteps.js
+++ b/packages/web/src/hooks/useTriggerSubsteps.js
@@ -4,7 +4,7 @@ import api from 'helpers/api';

 export default function useTriggerSubsteps({ appKey, triggerKey }) {
  const query = useQuery({
-    queryKey: ['triggerSubsteps', appKey, triggerKey],
+    queryKey: ['apps', appKey, 'triggers', triggerKey, 'substeps'],
    queryFn: async ({ signal }) => {
      const { data } = await api.get(
        `/v1/apps/${appKey}/triggers/${triggerKey}/substeps`,
--- a/packages/web/src/hooks/useTriggers.js
+++ b/packages/web/src/hooks/useTriggers.js
@@ -4,7 +4,7 @@ import api from 'helpers/api';

 export default function useTriggers(appKey) {
  const query = useQuery({
-    queryKey: ['triggers', appKey],
+    queryKey: ['apps', appKey, 'triggers'],
    queryFn: async ({ signal }) => {
      const { data } = await api.get(`/v1/apps/${appKey}/triggers`, {
        signal,
--- a/packages/web/src/hooks/useUserTrial.ee.js
+++ b/packages/web/src/hooks/useUserTrial.ee.js
@@ -42,7 +42,7 @@ export default function useUserTrial() {
  const formatMessage = useFormatMessage();

  const { data } = useQuery({
-    queryKey: ['userTrial'],
+    queryKey: ['users', 'me', 'trial'],
    queryFn: async ({ signal }) => {
      const { data } = await api.get('/v1/users/me/trial', {
        signal,
--- a/packages/web/src/hooks/useVersion.js
+++ b/packages/web/src/hooks/useVersion.js
@@ -7,7 +7,7 @@ import api from 'helpers/api';
 export default function useVersion() {
  const { data: notificationsData } = useAutomatischNotifications();
  const { data } = useQuery({
-    queryKey: ['automatischVersion'],
+    queryKey: ['automatisch', 'version'],
    queryFn: async ({ signal }) => {
      const { data } = await api.get('/v1/automatisch/version', {
        signal,