#144 separate hooks types

src/Hooks/types.d.ts

@@ -0,0 +1,44 @@
+declare module 'spock-react/hooks-types' {
+    import { IFeature, ISummary } from 'spock-react-types';
+
+    export interface IMarkdown {
+        filePath: string;
+    }
+
+    export interface ISpec {
+        className: string;
+        statistics: {
+            runs: string;
+            passed: string;
+            failed: string;
+            featureFailures: string;
+            successRate: string;
+            duration: string;
+        };
+        title: string;
+        narrative: string;
+        headers: string[];
+        tags: any;
+        see: any[];
+        features: IFeature[];
+        generator: string;
+    }
+
+    export interface IGetSpec {
+        fileName: string;
+    }
+
+    export interface IGenerateSearchEntries {
+        summary?: ISummary;
+    }
+
+    export interface IActiveLink {
+        activeLink: string;
+        setActiveLink: (newLink: string) => void;
+    }
+
+    export interface IActiveAnchor {
+        activeAnchor: string;
+        setActiveAnchor: (newAnchor: string) => void;
+    }
+}

src/Hooks/useActiveAnchor.ts

@@ -1,3 +1,4 @@
+import { IActiveAnchor } from 'spock-react/hooks-types';
 import { create } from 'zustand';
 
 const getInitialState = () => {
@@ -9,10 +10,6 @@ const getInitialState = () => {
     return pageAndAnchor.length === 2 ? decodeURI(pageAndAnchor[1]) : '';
 };
 
-interface IActiveAnchor {
-    activeAnchor: string;
-    setActiveAnchor: (newAnchor: string) => void;
-}
 export const useActiveAnchor = create<IActiveAnchor>((set) => ({
     activeAnchor: getInitialState(),
     setActiveAnchor: (newAnchor: string) => {

src/Hooks/useActiveLink.ts

@@ -1,5 +1,6 @@
 import { create } from 'zustand';
 import * as config from '../../environment.json';
+import { IActiveLink } from 'spock-react/hooks-types';
 
 const getInitialState = () => {
     const pageAndAnchor = window.location.pathname.split('#');
@@ -11,10 +12,6 @@ const getInitialState = () => {
     return page;
 };
 
-interface IActiveLink {
-    activeLink: string;
-    setActiveLink: (newLink: string) => void;
-}
 export const useActiveLink = create<IActiveLink>((set) => ({
     activeLink: getInitialState(),
     setActiveLink: (newLink: string) => {

src/Hooks/useGenerateSearchEntries.ts

@@ -5,11 +5,8 @@ import {
     IMinimizedSummaryEntry,
     ISearchEntry,
 } from '../components/Search/generateSearchEntries';
-import { ISpecification, ISummary } from './useGetSummary';
-
-interface IGenerateSearchEntries {
-    summary?: ISummary;
-}
+import { ISpecification } from 'spock-react-types';
+import { IGenerateSearchEntries } from 'spock-react/hooks-types';
 
 export const useGenerateSearchEntries = (
     props: IGenerateSearchEntries

src/Hooks/useGetSpec.ts

@@ -3,55 +3,14 @@ import axios from 'axios';
 import { useQuery, UseQueryResult } from '@tanstack/react-query';
 
 import config from '../../environment.json';
-
-interface IBlock {
-    kind: string;
-    text: string;
-    code: string[];
-}
-
-export interface IFeature {
-    id: string;
-    result: string;
-    duration: string;
-    iterations: {
-        tags: any;
-        see: any[];
-        extraInfo: any[];
-    };
-    blocks: IBlock[];
-    problems: any[];
-}
-
-interface ISpec {
-    className: string;
-    statistics: {
-        runs: string;
-        passed: string;
-        failed: string;
-        featureFailures: string;
-        successRate: string;
-        duration: string;
-    };
-    title: string;
-    narrative: string;
-    headers: string[];
-    tags: any;
-    see: any[];
-    features: IFeature[];
-    generator: string;
-}
+import { IGetSpec, ISpec } from 'spock-react/hooks-types';
 
 const getSpec = async (file: string): Promise<ISpec> => {
     const data = await axios.get(`${config.specUrl}/${file}.json`);
 
     return data.data as ISpec;
 };
 
-interface IGetSpec {
-    fileName: string;
-}
-
 export const useGetSpec = (props: IGetSpec): UseQueryResult<ISpec, unknown> => {
     const { fileName } = props;
 

src/Hooks/useGetSummary.ts

@@ -3,48 +3,14 @@ import axios from 'axios';
 import { useQuery, UseQueryResult } from '@tanstack/react-query';
 
 import config from '../../environment.json';
+import { ISummary } from 'spock-react-types';
 
 const getSummary = async (): Promise<ISummary> => {
     const data = await axios.get(config.summaryUrl);
 
     return data.data as ISummary;
 };
 
-export interface IExecutedFeatures {
-    id: string;
-    extraInfo: any[];
-}
-
-export interface ISpecification {
-    className: string;
-    title: string;
-    narrative: string;
-    featureCount: string;
-    failures: string;
-    errors: string;
-    skipped: string;
-    successRate: string;
-    duration: string;
-    executedFeatures: IExecutedFeatures[];
-    ignoredFeatures: any[];
-}
-
-export interface ISummary {
-    generator: string;
-    project: string;
-    version: string;
-    created: string;
-    statistics: {
-        runs: string;
-        passed: string;
-        failed: string;
-        featureFailures: string;
-        successRate: string;
-        duration: string;
-    };
-    specifications: ISpecification[];
-}
-
 export const useGetSummary = (): UseQueryResult<ISummary, unknown> => {
     return useQuery<ISummary>({
         queryKey: ['summary'],

src/Hooks/useMarkdown.ts

@@ -1,14 +1,11 @@
 import { useQuery } from '@tanstack/react-query';
+import { IMarkdown } from 'spock-react/hooks-types';
 
 const getMarkdown = async (mdFile: string) => {
     const data = await fetch(mdFile);
     return await data.text();
 };
 
-interface IMarkdown {
-    filePath: string;
-}
-
 export const useMarkdown = (props: IMarkdown) => {
     const { filePath } = props;
 

src/components/MainNav/MainNav.tsx

@@ -10,7 +10,8 @@ import * as config from '../../../environment.json';
 import GithubLogo from '../../assets/img/github-mark-white.png';
 import { Search } from '../Search';
 import { NavLink } from '../shared';
-import { ISummary, useActiveLink } from '../../Hooks';
+import { useActiveLink } from '../../Hooks';
+import { ISummary } from 'spock-react-types';
 
 interface IMainNav {
     summary: ISummary;

src/components/Search/Search.tsx

@@ -3,11 +3,11 @@ import './styles.css';
 import { useState } from 'react';
 import { Dialog, DialogBackdrop, Separator, useDialogState } from 'reakit';
 
-import { ISummary } from '../../Hooks';
 import { SearchButton } from './SearchButton';
 import { SearchFooter } from './SearchFooter';
 import { SearchHits } from './SearchHits';
 import { SearchInput } from './SearchInput';
+import { ISummary } from 'spock-react-types';
 
 export interface ISearchHit {
     score: number;

src/components/Search/SearchHits/SearchCard/SearchCard.tsx

@@ -6,11 +6,8 @@ import { Link } from 'react-router-dom';
 import { faAngleRight } from '@fortawesome/free-solid-svg-icons';
 import { FontAwesomeIcon } from '@fortawesome/react-fontawesome';
 
-import {
-    IExecutedFeatures,
-    ISpecification,
-} from '../../../../Hooks/useGetSummary';
 import { ISearchHit } from '../../Search';
+import { IExecutedFeatures, ISpecification } from 'spock-react-types';
 
 interface ISearchCard {
     onClick: (e?: any) => void;

src/components/Search/SearchHits/SearchHits.tsx

@@ -3,9 +3,9 @@ import './styles.css';
 import { nanoid } from 'nanoid';
 import { DialogStateReturn } from 'reakit/ts';
 
-import { ISummary } from '../../../Hooks/useGetSummary';
 import { ISearchHit } from '../Search';
 import { SearchCard } from './SearchCard';
+import { ISummary } from 'spock-react-types';
 
 interface ISearchHits {
     searchHits: ISearchHit[] | null;

src/components/Search/SearchInput/SearchInput.tsx

@@ -6,9 +6,9 @@ import { faMagnifyingGlass } from '@fortawesome/free-solid-svg-icons';
 import { FontAwesomeIcon } from '@fortawesome/react-fontawesome';
 
 import { useGenerateSearchEntries } from '../../../Hooks/useGenerateSearchEntries';
-import { ISummary } from '../../../Hooks/useGetSummary';
 import { getSearchScore } from '../getSearchScore';
 import { ISearchHit } from '../Search';
+import { ISummary } from 'spock-react-types';
 
 interface ISearchInput {
     summary: ISummary;

src/components/shared/Layout/Layout.tsx

@@ -2,8 +2,8 @@ import './styles.css';
 
 import { PropsWithChildren } from 'react';
 
-import { IFeature } from '../../../Hooks';
 import { OnPageNav } from './OnPageNav';
+import { IFeature } from 'spock-react-types';
 
 interface ILayout {
     hasOnPageNav?: boolean;

src/components/shared/Layout/OnPageNav.tsx

@@ -1,7 +1,7 @@
 import { nanoid } from 'nanoid';
 
-import { IFeature } from '../../../Hooks';
 import { NavAnchor } from '..';
+import { IFeature } from '../../Feature';
 
 interface IOnPageNave {
     features: IFeature[];

src/tests/example.test.tsx

@@ -4,8 +4,9 @@ import { describe, expect, test } from 'vitest';
 import { renderHook } from '@testing-library/react-hooks';
 
 import { App } from '../App';
-import { ISummary, useGetSummary } from '../Hooks';
+import { useGetSummary } from '../Hooks';
 import { HookProvider, render } from '../test-utils';
+import { ISummary } from 'spock-react-types';
 
 describe('test', () => {
     test('component example', () => {

src/types.d.ts

@@ -0,0 +1,55 @@
+declare module 'spock-react-types' {
+    export interface IExecutedFeatures {
+        id: string;
+        extraInfo: any[];
+    }
+
+    export interface ISpecification {
+        className: string;
+        title: string;
+        narrative: string;
+        featureCount: string;
+        failures: string;
+        errors: string;
+        skipped: string;
+        successRate: string;
+        duration: string;
+        executedFeatures: IExecutedFeatures[];
+        ignoredFeatures: any[];
+    }
+
+    export interface ISummary {
+        generator: string;
+        project: string;
+        version: string;
+        created: string;
+        statistics: {
+            runs: string;
+            passed: string;
+            failed: string;
+            featureFailures: string;
+            successRate: string;
+            duration: string;
+        };
+        specifications: ISpecification[];
+    }
+
+    interface IBlock {
+        kind: string;
+        text: string;
+        code: string[];
+    }
+
+    export interface IFeature {
+        id: string;
+        result: string;
+        duration: string;
+        iterations: {
+            tags: any;
+            see: any[];
+            extraInfo: any[];
+        };
+        blocks: IBlock[];
+        problems: any[];
+    }
+}