feat(schema): customise typename for root and

hit objects
searchkit · Dec 31, 2020 · fdd8ab0 · fdd8ab0
1 parent 2e0677c
commit fdd8ab0
Show file tree

Hide file tree

Showing 7 changed files with 19 additions and 17 deletions.
diff --git a/packages/searchkit-schema/src/schema.ts b/packages/searchkit-schema/src/schema.ts
@@ -128,6 +128,7 @@ const baseSearchkitTypeDefs = gql`
 
 export interface SearchkitSchemaConfig {
   typeName: string
+  hitTypeName: string
   config: SearchkitConfig
   addToQueryType?: boolean
 }
@@ -138,7 +139,7 @@ export default (schemaConfigs: SearchkitSchemaConfig | Array<SearchkitSchemaConf
     : [schemaConfigs]
   ).reduce(
     (sum, schemaConfig) => {
-      const typeName = `${schemaConfig.typeName}Set`
+      const typeName = schemaConfig.typeName
 
       const extendQuery = schemaConfig.addToQueryType
         ? `
@@ -187,7 +188,7 @@ export default (schemaConfigs: SearchkitSchemaConfig | Array<SearchkitSchemaConf
             },
             hitTypeMappings: {
               ...sum.context.searchkit.hitTypeMappings,
-              [typeName]: `${schemaConfig.typeName}Hit`
+              [typeName]: schemaConfig.hitTypeName
             }
           }
         }

diff --git a/packages/searchkit-schema/tests/Customisations.test.ts b/packages/searchkit-schema/tests/Customisations.test.ts
@@ -69,8 +69,8 @@ describe('customisations', () => {
     }
 
     setupTestServer([
-      { typeName: 'Result', config: moviesSearchConfig, addToQueryType: true },
-      { typeName: 'UserResult', config: userSearchConfig }
+      { typeName: 'ResultSet', hitTypeName: "ResultHit", config: moviesSearchConfig, addToQueryType: true },
+      { typeName: 'UserResultSet', hitTypeName: "UserResultHit", config: userSearchConfig }
     ])
 
     const scope = nock('http://localhost:9200')

diff --git a/packages/searchkit-schema/tests/FacetResolver.test.ts b/packages/searchkit-schema/tests/FacetResolver.test.ts
@@ -30,7 +30,7 @@ describe('Facet Resolver', () => {
     }
 
     it('should return correct Results', async () => {
-      setupTestServer({ config, addToQueryType: true, typeName: 'Result' })
+      setupTestServer({ config, addToQueryType: true, typeName: 'ResultSet', hitTypeName: "ResultHit" })
 
       const gql = `
         {
@@ -90,7 +90,7 @@ describe('Facet Resolver', () => {
     })
 
     it('Adjust size at query time', async () => {
-      setupTestServer({ config, addToQueryType: true, typeName: 'Result' })
+      setupTestServer({ config, addToQueryType: true, typeName: 'ResultSet', hitTypeName: "ResultHit" })
 
       const gql = `
         {
@@ -135,7 +135,8 @@ describe('Facet Resolver', () => {
             })
           ]
         },
-        typeName: 'Result',
+        typeName: 'ResultSet',
+        hitTypeName: "ResultHit",
         addToQueryType: true
       })
 

diff --git a/packages/searchkit-schema/tests/FacetsResolver.test.ts b/packages/searchkit-schema/tests/FacetsResolver.test.ts
@@ -34,7 +34,7 @@ describe('Facets Resolver', () => {
     }
 
     it('should return correct Results', async () => {
-      setupTestServer({ config, addToQueryType: true, typeName: 'Result' })
+      setupTestServer({ config, addToQueryType: true, typeName: 'ResultSet', hitTypeName: "ResultHit" })
 
       const gql = `
         {
@@ -122,7 +122,7 @@ describe('Facets Resolver', () => {
     })
 
     it('should return correct results with one filter', async () => {
-      setupTestServer({ config, addToQueryType: true, typeName: 'Result' })
+      setupTestServer({ config, addToQueryType: true, typeName: 'ResultSet', hitTypeName: "ResultHit" })
 
       const gql = `
         {

diff --git a/packages/searchkit-schema/tests/HitsResolver.test.ts b/packages/searchkit-schema/tests/HitsResolver.test.ts
@@ -41,7 +41,7 @@ describe('Hits Resolver', () => {
         query: new MultiMatchQuery({ fields: ['actors', 'writers', 'title^4', 'plot'] })
       }
 
-      setupTestServer({ config, addToQueryType: true, typeName: 'Result' })
+      setupTestServer({ config, addToQueryType: true, typeName: 'ResultSet', hitTypeName: "ResultHit" })
 
       const scope = nock('http://localhost:9200')
         .post('/movies/_search')
@@ -81,7 +81,7 @@ describe('Hits Resolver', () => {
         query: new MultiMatchQuery({ fields: ['actors', 'writers', 'title^4', 'plot'] })
       }
 
-      setupTestServer({ config, addToQueryType: true, typeName: 'Result' })
+      setupTestServer({ config, addToQueryType: true, typeName: 'ResultSet', hitTypeName: "ResultHit" })
 
       const scope = nock('https://localhost:9200')
         .post('/movies/_search')
@@ -143,7 +143,7 @@ describe('Hits Resolver', () => {
           return [200, HitsMock]
         })
 
-      setupTestServer({ config, addToQueryType: true, typeName: 'Result' })
+      setupTestServer({ config, addToQueryType: true, typeName: 'ResultSet', hitTypeName: "ResultHit" })
 
       const response = await runQuery('', { size: 10, from: 10 })
       expect(response.body.data).toMatchSnapshot()
@@ -164,7 +164,7 @@ describe('Hits Resolver', () => {
         query: new MultiMatchQuery({ fields: ['actors', 'writers', 'title^4', 'plot'] })
       }
 
-      setupTestServer({ config, addToQueryType: true, typeName: 'Result' })
+      setupTestServer({ config, addToQueryType: true, typeName: 'ResultSet', hitTypeName: "ResultHit" })
 
       const scope = nock('http://localhost:9200')
         .post('/movies/_search')

diff --git a/packages/searchkit-schema/tests/Pagination.test.ts b/packages/searchkit-schema/tests/Pagination.test.ts
@@ -44,7 +44,7 @@ describe('Pagination', () => {
     }
 
     it('Pagination results', async () => {
-      setupTestServer({ config, addToQueryType: true, typeName: 'Result' })
+      setupTestServer({ config, addToQueryType: true, typeName: 'ResultSet', hitTypeName: "ResultHit" })
 
       const scope = nock('http://localhost:9200')
         .post('/movies/_search')
@@ -81,7 +81,7 @@ describe('Pagination', () => {
     })
 
     it('No Results es7', async () => {
-      setupTestServer({ config, addToQueryType: true, typeName: 'Result' })
+      setupTestServer({ config, addToQueryType: true, typeName: 'ResultSet', hitTypeName: "ResultHit" })
 
       const scope = nock('http://localhost:9200')
         .post('/movies/_search')
@@ -103,7 +103,7 @@ describe('Pagination', () => {
     })
 
     it('No Results es6', async () => {
-      setupTestServer({ config, addToQueryType: true, typeName: 'Result' })
+      setupTestServer({ config, addToQueryType: true, typeName: 'ResultSet', hitTypeName: "ResultHit" })
 
       const scope = nock('http://localhost:9200')
         .post('/movies/_search')

diff --git a/packages/searchkit-schema/tests/SummaryResolver.test.ts b/packages/searchkit-schema/tests/SummaryResolver.test.ts
@@ -50,7 +50,7 @@ describe('Summary Resolver', () => {
     }
 
     it('should return correct summary', async () => {
-      setupTestServer({ config, addToQueryType: true, typeName: 'Result' })
+      setupTestServer({ config, addToQueryType: true, typeName: 'ResultSet', hitTypeName: "ResultHit" })
 
       const gql = `
         {