Merge pull request #2 from StefanoMarzo/use-api-hook

StefanoMarzo · web-flow · commit 8ab5039e7ca5 · 2025-05-16T00:41:46.000+02:00
adding licence
diff --git a/.gitignore b/.gitignore
@@ -1,3 +1,7 @@
+# SPDX-FileCopyrightText: 2025 CERN
+#
+# SPDX-License-Identifier: MIT
+
 .idea
 dist
 node_modules
diff --git a/.prettierrc.license b/.prettierrc.license
@@ -0,0 +1,3 @@
+SPDX-FileCopyrightText: 2025 CERN
+
+SPDX-License-Identifier: MIT
diff --git a/LICENSES/MIT.txt b/LICENSES/MIT.txt
@@ -0,0 +1,18 @@
+MIT License
+
+Copyright (c) 2025 CERN
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and
+associated documentation files (the "Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the
+following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial
+portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT
+LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO
+EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
+USE OR OTHER DEALINGS IN THE SOFTWARE.
diff --git a/README.md b/README.md
@@ -1,2 +1,8 @@
+<!--
+SPDX-FileCopyrightText: 2025 CERN
+
+SPDX-License-Identifier: MIT
+-->
+
 # React OpenApi Hook
 Please find here an example of use: https://github.com/StefanoMarzo/react-openapi-generator-hook-demo
diff --git a/eslint.config.mjs b/eslint.config.mjs
@@ -1,3 +1,7 @@
+// SPDX-FileCopyrightText: 2025 CERN
+//
+// SPDX-License-Identifier: MIT
+
 import react from 'eslint-plugin-react'
 import tsParser from '@typescript-eslint/parser'
 import path from 'node:path'
diff --git a/generated/.gitignore.license b/generated/.gitignore.license
@@ -0,0 +1,3 @@
+SPDX-FileCopyrightText: 2025 CERN
+
+SPDX-License-Identifier: MIT
diff --git a/generated/.npmignore.license b/generated/.npmignore.license
@@ -0,0 +1,3 @@
+SPDX-FileCopyrightText: 2025 CERN
+
+SPDX-License-Identifier: MIT
diff --git a/generated/.openapi-generator-ignore.license b/generated/.openapi-generator-ignore.license
@@ -0,0 +1,3 @@
+SPDX-FileCopyrightText: 2025 CERN
+
+SPDX-License-Identifier: MIT
diff --git a/generated/.openapi-generator/FILES.license b/generated/.openapi-generator/FILES.license
@@ -0,0 +1,3 @@
+SPDX-FileCopyrightText: 2025 CERN
+
+SPDX-License-Identifier: MIT
diff --git a/generated/.openapi-generator/VERSION.license b/generated/.openapi-generator/VERSION.license
@@ -0,0 +1,3 @@
+SPDX-FileCopyrightText: 2025 CERN
+
+SPDX-License-Identifier: MIT
diff --git a/generated/configuration.ts.license b/generated/configuration.ts.license
@@ -0,0 +1,3 @@
+SPDX-FileCopyrightText: 2025 CERN
+
+SPDX-License-Identifier: MIT
diff --git a/generated/git_push.sh.license b/generated/git_push.sh.license
@@ -0,0 +1,3 @@
+SPDX-FileCopyrightText: 2025 CERN
+
+SPDX-License-Identifier: MIT
diff --git a/index.ts b/index.ts
@@ -1,3 +1,7 @@
+// SPDX-FileCopyrightText: 2025 CERN
+//
+// SPDX-License-Identifier: MIT
+
 export * from './src/type/openApiConfigurationTypes'
 export { useOpenApiGenerator, OpenApiProvider } from './src/context/OpenApiContextProvider'
 export { useApi } from './src/hook/useApi'
diff --git a/openapi-specs.yaml b/openapi-specs.yaml
@@ -1,3 +1,7 @@
+# SPDX-FileCopyrightText: 2025 CERN
+#
+# SPDX-License-Identifier: MIT
+
 openapi: 3.0.0
 info:
   title: API Generation
diff --git a/openapitools.json.license b/openapitools.json.license
@@ -0,0 +1,3 @@
+SPDX-FileCopyrightText: 2025 CERN
+
+SPDX-License-Identifier: MIT
diff --git a/package-lock.json.license b/package-lock.json.license
diff --git a/package.json.license b/package.json.license
@@ -0,0 +1,3 @@
+SPDX-FileCopyrightText: 2025 CERN
+
+SPDX-License-Identifier: MIT
diff --git a/src/context/OpenApiContextProvider.tsx b/src/context/OpenApiContextProvider.tsx
@@ -1,3 +1,7 @@
+// SPDX-FileCopyrightText: 2025 CERN
+//
+// SPDX-License-Identifier: MIT
+
 import React, { createContext, useContext, useMemo } from 'react'
 import { OpenApiProviderProps, OpenApiProviderState } from '../type/openApiConfigurationTypes'
 
diff --git a/src/hook/useApi.test.ts b/src/hook/useApi.test.ts
@@ -0,0 +1,81 @@
+// SPDX-FileCopyrightText: 2025 CERN
+//
+// SPDX-License-Identifier: MIT
+
+import { useApi } from './useApi'
+import { act, renderHook, waitFor } from '@testing-library/react'
+import { vi } from 'vitest'
+
+describe('useApi', () => {
+  const apiFactory = vi.fn()
+  const methodName = 'testMethod'
+  const requestParameters = { param1: 'value1' }
+  const requestOptions = { option1: 'value1' }
+
+  it('should initialize with default values', () => {
+    apiFactory.mockReturnValue({ [methodName]: vi.fn() })
+    const { result } = renderHook(() =>
+      useApi({
+        apiFactory,
+        methodName,
+        requestParameters,
+        requestOptions,
+      })
+    )
+
+    const [state] = result.current
+    expect(state.data).toBeNull()
+    expect(state.error).toBeNull()
+    expect(state.loading).toBe(true)
+  })
+
+  it('should execute API call and update state', async () => {
+    const mockResponse = { data: { result: 'success' } }
+    const method = vi.fn().mockResolvedValue(mockResponse)
+    apiFactory.mockReturnValue({ [methodName]: method })
+
+    const { result } = renderHook(() =>
+      useApi({
+        apiFactory,
+        methodName,
+        requestParameters,
+        requestOptions,
+      })
+    )
+
+    const [, execute] = result.current
+
+    await act(async () => {
+      await execute()
+    })
+
+    await waitFor(() => {
+      const [state] = result.current
+      expect(state.loading).toBe(false)
+    })
+
+    const [state] = result.current
+    expect(state.data).toEqual(mockResponse.data)
+    expect(state.error).toBeNull()
+    expect(state.loading).toBe(false)
+  })
+
+  it('should not execute API call if manual option is true', () => {
+    const method = vi.fn()
+    apiFactory.mockReturnValue({ [methodName]: method })
+
+    renderHook(() =>
+      useApi(
+        {
+          apiFactory,
+          methodName,
+          requestParameters,
+          requestOptions,
+        },
+        { manual: true }
+      )
+    )
+
+    expect(method).not.toHaveBeenCalled()
+  })
+})
diff --git a/src/hook/useApi.ts b/src/hook/useApi.ts
@@ -1,3 +1,7 @@
+// SPDX-FileCopyrightText: 2025 CERN
+//
+// SPDX-License-Identifier: MIT
+
 import { useCallback, useEffect, useMemo, useState } from 'react'
 import { AxiosError, AxiosInstance, AxiosResponse } from 'axios'
 import { useOpenApiGenerator } from '../context/OpenApiContextProvider'
diff --git a/src/type/openApiConfigurationTypes.ts b/src/type/openApiConfigurationTypes.ts
@@ -1,3 +1,7 @@
+// SPDX-FileCopyrightText: 2025 CERN
+//
+// SPDX-License-Identifier: MIT
+
 import { AxiosInstance } from 'axios'
 import { Configuration } from '../../generated/configuration'
 import { ReactNode } from 'react'
diff --git a/tsconfig.json.license b/tsconfig.json.license
@@ -0,0 +1,3 @@
+SPDX-FileCopyrightText: 2025 CERN
+
+SPDX-License-Identifier: MIT
diff --git a/tsconfig.node.json.license b/tsconfig.node.json.license
@@ -0,0 +1,3 @@
+SPDX-FileCopyrightText: 2025 CERN
+
+SPDX-License-Identifier: MIT
diff --git a/vite.config.ts b/vite.config.ts
@@ -1,3 +1,7 @@
+// SPDX-FileCopyrightText: 2025 CERN
+//
+// SPDX-License-Identifier: MIT
+
 import { defineConfig } from 'vite'
 import react from '@vitejs/plugin-react'
 import path from 'path'

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+SPDX-FileCopyrightText: 2025 CERN`
	`2`	`+`
	`3`	`+SPDX-License-Identifier: MIT`