rename Hyparam to Hyperparam

Author: severo

.github/workflows/deploy_pages.yml

@@ -29,12 +29,12 @@ jobs:
       - name: Move the build outputs to a folder
         run: |
           mkdir -p build_outputs_folder/apps
-          echo "<h1 id="hyparam">Hyparam</h1>" > build_outputs_folder/index.html
+          echo "<h1 id="hyparam">Hyperparam</h1>" > build_outputs_folder/index.html
           echo "<ul>" >> build_outputs_folder/index.html
           echo "<li><a href="./apps/hyparquet-demo">hyparquet demo</a></li>" >> build_outputs_folder/index.html
           echo "<li><a href="./apps/hightable-demo">hightable demo</a></li>" >> build_outputs_folder/index.html
           echo "</ul>" >> build_outputs_folder/index.html
-          echo "<h1 id="hyparam">Hyparam</h1>" > build_outputs_folder/apps/index.html
+          echo "<h1 id="hyparam">Hyperparam</h1>" > build_outputs_folder/apps/index.html
           echo "<ul>" >> build_outputs_folder/apps/index.html
           echo "<li><a href="./hyparquet-demo">hyparquet demo</a></li>" >> build_outputs_folder/apps/index.html
           echo "<li><a href="./hightable-demo">hightable demo</a></li>" >> build_outputs_folder/apps/index.html

packages/components/demo/index.html

@@ -7,7 +7,7 @@
     <link rel="stylesheet" href="./HighTable.css">
     <link rel="stylesheet" href="https://fonts.googleapis.com/css2?family=Mulish:wght@400;600&display=swap"/>
     <link href="favicon.png" rel="icon" />
-    <meta name="description" content="demo for the Hyparam components" />
+    <meta name="description" content="demo for the Hyperparam components" />
     <meta name="theme-color" content="#6b00ff">
     <meta name="viewport" content="width=device-width, initial-scale=1" />
   </head>

packages/components/src/lib/filesystem.ts

@@ -115,14 +115,14 @@ export class HttpFileSystem extends FileSystem {
   }
 }
 
-export interface HyparamFileMetadata {
+export interface HyperparamFileMetadata {
   key: string
   eTag?: string
   fileSize?: number
   lastModified: string
 }
 
-export class HyparamFileSystem extends FileSystem {
+export class HyperparamFileSystem extends FileSystem {
   fsId = 'hyparam' as const
   endpoint: string
   constructor({ endpoint }: {endpoint: string}) {
@@ -164,12 +164,12 @@ export class HyparamFileSystem extends FileSystem {
       }),
     ]
   }
-  async _fetchFilesList(prefix: string): Promise<HyparamFileMetadata[]> {
+  async _fetchFilesList(prefix: string): Promise<HyperparamFileMetadata[]> {
     const url = new URL('/api/store/list', this.endpoint)
     url.searchParams.append('prefix', encodeURIComponent(prefix))
     const res = await fetch(url)
     if (res.ok) {
-      return await res.json() as HyparamFileMetadata[]
+      return await res.json() as HyperparamFileMetadata[]
     } else {
       throw new Error(await res.text())
     }
@@ -186,12 +186,3 @@ export class HyparamFileSystem extends FileSystem {
     }))
   }
 }
-
-
-
-
-// TODO
-// add tests
-// select the class by looping until one of the classes can parse the URL
-// pass the Url to the components
-

packages/components/src/lib/index.ts

@@ -1,8 +1,9 @@
-export { DirSource, FileSource, FileSystem, HttpFileSystem, HyparamFileSystem, Source } from './filesystem.js'
+export { DirSource, FileSource, FileSystem, HttpFileSystem, HyperparamFileSystem, Source } from './filesystem.js'
 export type { FileKind, FileMetadata, SourcePart } from './filesystem.js'
 export { appendSearchParams, replaceSearchParams } from './routes.js'
 export type { RoutesConfig } from './routes.js'
 export { parquetDataFrame } from './tableProvider.js'
 export { asyncBufferFrom, cn, contentTypes, formatFileSize, getFileDate, getFileDateShort, getFileName, imageTypes, parseFileSize } from './utils.js'
 export { parquetQueryWorker } from './workers/parquetWorkerClient.js'
 export type { AsyncBufferFrom, Row } from './workers/types.js'
+

packages/components/test/components/File.test.tsx

@@ -3,10 +3,10 @@ import { strict as assert } from 'assert'
 import React, { act } from 'react'
 import { describe, expect, it, vi } from 'vitest'
 import File from '../../src/components/File.js'
-import { HttpFileSystem, HyparamFileSystem } from '../../src/lib/filesystem.js'
+import { HttpFileSystem, HyperparamFileSystem } from '../../src/lib/filesystem.js'
 import { RoutesConfig } from '../../src/lib/routes.js'
 
-const hyparamFileSystem = new HyparamFileSystem({ endpoint: 'http://localhost:3000' })
+const hyparamFileSystem = new HyperparamFileSystem({ endpoint: 'http://localhost:3000' })
 const httpFileSystem = new HttpFileSystem()
 
 

packages/components/test/components/Folder.test.tsx

@@ -3,16 +3,16 @@ import { strict as assert } from 'assert'
 import React from 'react'
 import { describe, expect, it, vi } from 'vitest'
 import Folder from '../../src/components/Folder.js'
-import { HyparamFileMetadata, HyparamFileSystem } from '../../src/lib/filesystem.js'
+import { HyperparamFileMetadata, HyperparamFileSystem } from '../../src/lib/filesystem.js'
 import { RoutesConfig } from '../../src/lib/routes.js'
 
-const hyparamFileSystem = new HyparamFileSystem({ endpoint: 'http://localhost:3000' })
+const hyparamFileSystem = new HyperparamFileSystem({ endpoint: 'http://localhost:3000' })
 // hyparamFileSystem._fetchFilesList = () => Promise.resolve([
 //   { key: 'folder1/', lastModified: '2023-01-01T00:00:00Z' },
 //   { key: 'file1.txt', fileSize: 8196, lastModified: '2023-01-01T00:00:00Z' },
 // ])
 
-const mockFiles: HyparamFileMetadata[] = [
+const mockFiles: HyperparamFileMetadata[] = [
   { key: 'folder1/', lastModified: '2023-01-01T00:00:00Z' },
   { key: 'file1.txt', fileSize: 8196, lastModified: '2023-01-01T00:00:00Z' },
 ]

packages/components/test/components/viewers/ImageView.test.tsx

@@ -3,9 +3,9 @@ import { strict as assert } from 'assert'
 import React from 'react'
 import { describe, expect, it, vi } from 'vitest'
 import ImageView from '../../../src/components/viewers/ImageView.js'
-import { HyparamFileSystem } from '../../../src/lib/filesystem.js'
+import { HyperparamFileSystem } from '../../../src/lib/filesystem.js'
 
-const hyparamFileSystem = new HyparamFileSystem({ endpoint: 'http://localhost:3000' })
+const hyparamFileSystem = new HyperparamFileSystem({ endpoint: 'http://localhost:3000' })
 
 global.fetch = vi.fn()
 

packages/components/test/components/viewers/MarkdownView.test.tsx

@@ -3,9 +3,9 @@ import { strict as assert } from 'assert'
 import React from 'react'
 import { describe, expect, it, vi } from 'vitest'
 import MarkdownView from '../../../src/components/viewers/MarkdownView.js'
-import { HyparamFileSystem } from '../../../src/lib/filesystem.js'
+import { HyperparamFileSystem } from '../../../src/lib/filesystem.js'
 
-const hyparamFileSystem = new HyparamFileSystem({ endpoint: 'http://localhost:3000' })
+const hyparamFileSystem = new HyperparamFileSystem({ endpoint: 'http://localhost:3000' })
 
 global.fetch = vi.fn()
 

packages/components/test/lib/filesystem.test.ts

@@ -1,13 +1,13 @@
 import { describe, expect, it, test } from 'vitest'
-import { HttpFileSystem, HyparamFileSystem } from '../../src/lib/filesystem.js'
+import { HttpFileSystem, HyperparamFileSystem } from '../../src/lib/filesystem.js'
 
-describe('HyparamFileSystem', () => {
+describe('HyperparamFileSystem', () => {
   test.for([
     'test.txt',
     'no-extension',
     'folder/subfolder/test.txt',
   ])('recognizes a local file path', (key: string) => {
-    const source = new HyparamFileSystem({ endpoint: 'http://localhost:3000' }).getSource(key)
+    const source = new HyperparamFileSystem({ endpoint: 'http://localhost:3000' }).getSource(key)
     expect(source?.kind).toBe('file')
   })
 
@@ -16,15 +16,15 @@ describe('HyparamFileSystem', () => {
     'folder1/',
     'folder1/folder2/',
   ])('recognizes a folder', (key: string) => {
-    const source = new HyparamFileSystem({ endpoint: 'http://localhost:3000' }).getSource(key)
+    const source = new HyperparamFileSystem({ endpoint: 'http://localhost:3000' }).getSource(key)
     expect(source?.kind).toBe('directory')
   })
 
   test.for([
     '/',
     '////',
   ])('does not support a heading slash', (key: string) => {
-    const source = new HyparamFileSystem({ endpoint: 'http://localhost:3000' }).getSource(key)
+    const source = new HyperparamFileSystem({ endpoint: 'http://localhost:3000' }).getSource(key)
     expect(source?.kind).toBeUndefined()
   })
 })

packages/components/vite.config.ts

@@ -12,7 +12,7 @@ export default defineConfig({
     lib: {
       entry: resolve(__dirname, 'src/index.ts'),
       formats: ['es', 'umd'],
-      name: 'HyparamComponents',
+      name: 'HyperparamComponents',
       fileName: (format) => `index.${format}.min.js`,
     },
     rollupOptions: {