prepare the contents of the npm package (#34)

severo · web-flow · commit 0d43e36e8b87 · 2024-11-08T10:27:09.000+01:00
* prepare the contents of the npm package tsc populates the new es/ directory with transpiled files (ts/tsx -> js + d.ts) vite generates minified bundled files (es and umd) in dist/, with their source maps package.json should point to the appropriate files in the npm package. Contents of the npm package > npm publish --dry-run > @hyparam/components@0.1.0 prepublishOnly > npm run build > @hyparam/components@0.1.0 build > tsc && vite build vite v5.4.10 building for production... ✓ 42 modules transformed. dist/index.es.min.js 236.69 kB │ gzip: 123.91 kB │ map: 126.18 kB dist/index.umd.min.js 225.15 kB │ gzip: 122.52 kB │ map: 122.83 kB ✓ built in 747ms npm notice npm notice 📦 @hyparam/components@0.1.0 npm notice Tarball Contents npm notice 1.0kB LICENSE npm notice 101B README.md npm notice 408.4kB dist/assets/parquetWorker-zWrM-10F.js.map npm notice 236.7kB dist/index.es.min.js npm notice 126.2kB dist/index.es.min.js.map npm notice 225.2kB dist/index.umd.min.js npm notice 122.8kB dist/index.umd.min.js.map npm notice 72B es/components/App.d.ts npm notice 142B es/components/App.js npm notice 265B es/components/Breadcrumb.d.ts npm notice 989B es/components/Breadcrumb.js npm notice 322B es/components/Cell.d.ts npm notice 3.5kB es/components/Cell.js npm notice 242B es/components/File.d.ts npm notice 607B es/components/File.js npm notice 243B es/components/Folder.d.ts npm notice 2.3kB es/components/Folder.js npm notice 416B es/components/index.d.ts npm notice 416B es/components/index.js npm notice 824B es/components/Layout.d.ts npm notice 1.6kB es/components/Layout.js npm notice 197B es/components/Markdown.d.ts npm notice 3.7kB es/components/Markdown.js npm notice 73B es/components/Page.d.ts npm notice 873B es/components/Page.js npm notice 428B es/components/Viewer.d.ts npm notice 1.0kB es/components/Viewer.js npm notice 416B es/components/viewers/ContentHeader.d.ts npm notice 456B es/components/viewers/ContentHeader.js npm notice 321B es/components/viewers/ImageView.d.ts npm notice 2.8kB es/components/viewers/ImageView.js npm notice 290B es/components/viewers/index.d.ts npm notice 290B es/components/viewers/index.js npm notice 327B es/components/viewers/MarkdownView.d.ts npm notice 2.1kB es/components/viewers/MarkdownView.js npm notice 389B es/components/viewers/ParquetView.d.ts npm notice 3.0kB es/components/viewers/ParquetView.js npm notice 376B es/components/viewers/TextView.d.ts npm notice 2.4kB es/components/viewers/TextView.js npm notice 1.7kB es/lib/files.d.ts npm notice 2.7kB es/lib/files.js npm notice 432B es/lib/key.d.ts npm notice 698B es/lib/key.js npm notice 301B es/lib/tableProvider.d.ts npm notice 4.2kB es/lib/tableProvider.js npm notice 125B es/lib/utils.d.ts npm notice 125B es/lib/utils.js npm notice 11B es/workers/parquetWorker.d.ts npm notice 2.7kB es/workers/parquetWorker.js npm notice 641B es/workers/parquetWorkerClient.d.ts npm notice 2.8kB es/workers/parquetWorkerClient.js npm notice 1.9kB package.json npm notice Tarball Details npm notice name: @hyparam/components npm notice version: 0.1.0 npm notice filename: hyparam-components-0.1.0.tgz npm notice package size: 472.3 kB npm notice unpacked size: 1.2 MB npm notice shasum: 41eba030a842e4fc1b13f8990d5accba4d1cf431 npm notice integrity: sha512-89CuWNs2a/I8z[...]4Jk4kJmwUb8lA== npm notice total files: 52 npm notice npm warn This command requires you to be logged in to https://registry.npmjs.org/ (dry-run) npm notice Publishing to https://registry.npmjs.org/ with tag latest and default access (dry-run) + @hyparam/components@0.1.0 * remove aliases
diff --git a/packages/components/.gitignore b/packages/components/.gitignore
@@ -29,3 +29,5 @@ package-lock.json
 .vscode
 *.parquet
 /coverage/
+
+/es
diff --git a/packages/components/package.json b/packages/components/package.json
@@ -15,18 +15,23 @@
     "directory": "packages/components"
   },
   "type": "module",
-  "main": "dist/index.umd.js",
-  "module": "dist/index.es.js",
+  "main": "dist/index.umd.min.js",
+  "unpkg": "dist/index.umd.min.js",
+  "module": "dist/index.es.min.js",
+  "types": "es/components/index.d.ts",
   "exports": {
     ".": {
-      "import": "./dist/index.es.js",
-      "require": "./dist/index.umd.js",
-      "types": "./dist/components/index.d.ts"
-    }
+      "import": "./es/components/index.js",
+      "require": "./dist/index.umd.min.js",
+      "types": "./es/components/index.d.ts"
+    },
+    "./components/*": "./es/components/*.js",
+    "./lib/*": "./es/lib/*.js",
+    "./workers/*": "./es/workers/*.js"
   },
-  "types": "dist/components/index.d.ts",
   "files": [
-    "dist"
+    "dist",
+    "es"
   ],
   "scripts": {
     "build": "tsc && vite build",
@@ -61,7 +66,6 @@
     "typescript": "5.6.3",
     "typescript-eslint": "8.13.0",
     "vite": "5.4.10",
-    "vite-plugin-dts": "4.3.0",
     "vitest": "2.1.4"
   }
 }
diff --git a/packages/components/src/components/App.tsx b/packages/components/src/components/App.tsx
@@ -1,4 +1,4 @@
-import Page from './Page.tsx'
+import Page from './Page.js'
 
 export default function App() {
   return (
diff --git a/packages/components/src/components/Breadcrumb.tsx b/packages/components/src/components/Breadcrumb.tsx
@@ -1,4 +1,4 @@
-import { FileKey, UrlKey } from '../lib/key.ts'
+import { FileKey, UrlKey } from '../lib/key.js'
 
 interface BreadcrumbProps {
   parsedKey: UrlKey | FileKey
diff --git a/packages/components/src/components/Cell.tsx b/packages/components/src/components/Cell.tsx
@@ -1,10 +1,10 @@
 import { asyncRows } from 'hightable'
 import { asyncBufferFromUrl, parquetMetadataAsync } from 'hyparquet'
 import { useEffect, useState } from 'react'
-import { FileKey, UrlKey } from '../lib/key.ts'
+import { FileKey, UrlKey } from '../lib/key.js'
 import { parquetDataFrame } from '../lib/tableProvider.js'
-import Breadcrumb from './Breadcrumb.tsx'
-import Layout from './Layout.tsx'
+import Breadcrumb from './Breadcrumb.js'
+import Layout from './Layout.js'
 
 interface CellProps {
   parsedKey: FileKey | UrlKey;
diff --git a/packages/components/src/components/File.tsx b/packages/components/src/components/File.tsx
@@ -1,8 +1,8 @@
 import { useState } from 'react'
-import { FileKey, UrlKey } from '../lib/key.ts'
-import Breadcrumb from './Breadcrumb.tsx'
-import Layout from './Layout.tsx'
-import Viewer from './Viewer.tsx'
+import { FileKey, UrlKey } from '../lib/key.js'
+import Breadcrumb from './Breadcrumb.js'
+import Layout from './Layout.js'
+import Viewer from './Viewer.js'
 
 interface FileProps {
   parsedKey: UrlKey | FileKey
diff --git a/packages/components/src/components/Folder.tsx b/packages/components/src/components/Folder.tsx
@@ -1,8 +1,8 @@
 import { useCallback, useEffect, useRef, useState } from 'react'
-import { FileMetadata, getFileDate, getFileDateShort, getFileSize, listFiles } from '../lib/files.ts'
-import type { FolderKey } from '../lib/key.ts'
-import { cn } from '../lib/utils.ts'
-import Layout, { Spinner } from './Layout.tsx'
+import { FileMetadata, getFileDate, getFileDateShort, getFileSize, listFiles } from '../lib/files.js'
+import type { FolderKey } from '../lib/key.js'
+import { cn } from '../lib/utils.js'
+import Layout, { Spinner } from './Layout.js'
 
 interface FolderProps {
   folderKey: FolderKey
diff --git a/packages/components/src/components/Layout.tsx b/packages/components/src/components/Layout.tsx
@@ -1,5 +1,5 @@
 import { ReactNode, useEffect } from 'react'
-import { cn } from '../lib/utils.ts'
+import { cn } from '../lib/utils.js'
 
 interface LayoutProps {
   children: ReactNode
diff --git a/packages/components/src/components/Page.tsx b/packages/components/src/components/Page.tsx
@@ -1,7 +1,7 @@
-import { parseKey } from '../lib/key.ts'
-import Cell from './Cell.tsx'
-import File from './File.tsx'
-import Folder from './Folder.tsx'
+import { parseKey } from '../lib/key.js'
+import Cell from './Cell.js'
+import File from './File.js'
+import Folder from './Folder.js'
 
 export default function Page() {
   const search = new URLSearchParams(location.search)
diff --git a/packages/components/src/components/Viewer.tsx b/packages/components/src/components/Viewer.tsx
@@ -1,9 +1,9 @@
-import { imageTypes } from '../lib/files.ts'
-import { FileKey, UrlKey } from '../lib/key.ts'
-import ImageView from './viewers/ImageView.tsx'
-import MarkdownView from './viewers/MarkdownView.tsx'
-import TableView from './viewers/ParquetView.tsx'
-import TextView from './viewers/TextView.tsx'
+import { imageTypes } from '../lib/files.js'
+import { FileKey, UrlKey } from '../lib/key.js'
+import ImageView from './viewers/ImageView.js'
+import MarkdownView from './viewers/MarkdownView.js'
+import TableView from './viewers/ParquetView.js'
+import TextView from './viewers/TextView.js'
 
 interface ViewerProps {
   parsedKey: FileKey | UrlKey;
diff --git a/packages/components/src/components/index.ts b/packages/components/src/components/index.ts
@@ -1,11 +1,11 @@
-import App from './App.tsx'
-import Breadcrumb from './Breadcrumb.tsx'
-import Cell from './Cell.tsx'
-import File from './File.tsx'
-import Folder from './Folder.tsx'
-import Layout from './Layout.tsx'
-import Markdown from './Markdown.tsx'
-import Page from './Page.tsx'
-import Viewer from './Viewer.tsx'
-export * from './viewers/index.ts'
+import App from './App.js'
+import Breadcrumb from './Breadcrumb.js'
+import Cell from './Cell.js'
+import File from './File.js'
+import Folder from './Folder.js'
+import Layout from './Layout.js'
+import Markdown from './Markdown.js'
+import Page from './Page.js'
+import Viewer from './Viewer.js'
+export * from './viewers/index.js'
 export { App, Breadcrumb, Cell, File, Folder, Layout, Markdown, Page, Viewer }
diff --git a/packages/components/src/components/viewers/ImageView.tsx b/packages/components/src/components/viewers/ImageView.tsx
@@ -1,8 +1,8 @@
 import { useEffect, useState } from 'react'
-import { contentTypes, parseFileSize } from '../../lib/files.ts'
-import { FileKey, UrlKey } from '../../lib/key.ts'
-import { Spinner } from '../Layout.tsx'
-import ContentHeader from './ContentHeader.tsx'
+import { contentTypes, parseFileSize } from '../../lib/files.js'
+import { FileKey, UrlKey } from '../../lib/key.js'
+import { Spinner } from '../Layout.js'
+import ContentHeader from './ContentHeader.js'
 
 enum LoadingState {
   NotLoaded,
diff --git a/packages/components/src/components/viewers/MarkdownView.tsx b/packages/components/src/components/viewers/MarkdownView.tsx
@@ -1,9 +1,9 @@
 import { useEffect, useState } from 'react'
-import { parseFileSize } from '../../lib/files.ts'
-import { FileKey, UrlKey } from '../../lib/key.ts'
-import { Spinner } from '../Layout.tsx'
-import Markdown from '../Markdown.tsx'
-import ContentHeader, { TextContent } from './ContentHeader.tsx'
+import { parseFileSize } from '../../lib/files.js'
+import { FileKey, UrlKey } from '../../lib/key.js'
+import { Spinner } from '../Layout.js'
+import Markdown from '../Markdown.js'
+import ContentHeader, { TextContent } from './ContentHeader.js'
 
 enum LoadingState {
   NotLoaded,
diff --git a/packages/components/src/components/viewers/ParquetView.tsx b/packages/components/src/components/viewers/ParquetView.tsx
@@ -1,10 +1,10 @@
 import HighTable, { DataFrame, rowCache } from 'hightable'
 import { asyncBufferFromUrl, parquetMetadataAsync } from 'hyparquet'
 import React, { useCallback, useEffect, useState } from 'react'
-import { FileKey, UrlKey } from '../../lib/key.ts'
-import { parquetDataFrame } from '../../lib/tableProvider.ts'
-import { Spinner } from '../Layout.tsx'
-import ContentHeader, { ContentSize } from './ContentHeader.tsx'
+import { FileKey, UrlKey } from '../../lib/key.js'
+import { parquetDataFrame } from '../../lib/tableProvider.js'
+import { Spinner } from '../Layout.js'
+import ContentHeader, { ContentSize } from './ContentHeader.js'
 
 enum LoadingState {
   NotLoaded,
diff --git a/packages/components/src/components/viewers/TextView.tsx b/packages/components/src/components/viewers/TextView.tsx
@@ -1,8 +1,8 @@
 import { useEffect, useRef, useState } from 'react'
-import { parseFileSize } from '../../lib/files.ts'
-import { FileKey, UrlKey } from '../../lib/key.ts'
-import { Spinner } from '../Layout.tsx'
-import ContentHeader, { TextContent } from './ContentHeader.tsx'
+import { parseFileSize } from '../../lib/files.js'
+import { FileKey, UrlKey } from '../../lib/key.js'
+import { Spinner } from '../Layout.js'
+import ContentHeader, { TextContent } from './ContentHeader.js'
 
 enum LoadingState {
   NotLoaded,
diff --git a/packages/components/src/components/viewers/index.ts b/packages/components/src/components/viewers/index.ts
@@ -1,6 +1,6 @@
-import ContentHeader from './ContentHeader.tsx'
-import ImageView from './ImageView.tsx'
-import MarkdownView from './MarkdownView.tsx'
-import ParquetView from './ParquetView.tsx'
-import TextView from './TextView.tsx'
+import ContentHeader from './ContentHeader.js'
+import ImageView from './ImageView.js'
+import MarkdownView from './MarkdownView.js'
+import ParquetView from './ParquetView.js'
+import TextView from './TextView.js'
 export { ContentHeader, ImageView, MarkdownView, ParquetView, TextView }
diff --git a/packages/components/src/lib/tableProvider.ts b/packages/components/src/lib/tableProvider.ts
@@ -1,6 +1,6 @@
 import { DataFrame, ResolvablePromise, resolvablePromise } from 'hightable'
 import { FileMetaData, parquetSchema } from 'hyparquet'
-import { parquetQueryWorker, parquetSortIndexWorker } from '../workers/parquetWorkerClient.ts'
+import { parquetQueryWorker, parquetSortIndexWorker } from '../workers/parquetWorkerClient.js'
 import type { AsyncBufferFromUrl } from '../workers/types.d.ts'
 
 type ResolvableRow = Record<string, ResolvablePromise<unknown>>;
diff --git a/packages/components/src/workers/parquetWorker.ts b/packages/components/src/workers/parquetWorker.ts
@@ -1,6 +1,5 @@
 import { AsyncBuffer, ColumnData, asyncBufferFromUrl, cachedAsyncBuffer, parquetQuery } from 'hyparquet'
 import { compressors } from 'hyparquet-compressors'
-// import { asyncBufferFromUrl } from '../lib/utils.ts'
 import type {
   AsyncBufferFromUrl,
   ChunkMessage,
diff --git a/packages/components/tsconfig.json b/packages/components/tsconfig.json
@@ -4,21 +4,22 @@
     "target": "ES2020",
     "useDefineForClassFields": true,
     "lib": ["ES2020", "DOM", "DOM.Iterable"],
-    "module": "ESNext",
+    "module": "NodeNext",
     "skipLibCheck": true,
 
-    "moduleResolution": "Bundler",
-    "allowImportingTsExtensions": true,
+    "moduleResolution": "nodenext",
     "isolatedModules": true,
     "moduleDetection": "force",
-    "noEmit": true,
     "jsx": "react-jsx",
 
     "strict": true,
     "noUnusedLocals": true,
     "noUnusedParameters": true,
     "noFallthroughCasesInSwitch": true,
-    "noUncheckedSideEffectImports": true
+    "noUncheckedSideEffectImports": true,
+
+    "outDir": "./es",
+    "declaration": true,
   },
   "include": ["src"]
 }
diff --git a/packages/components/vite.config.ts b/packages/components/vite.config.ts
@@ -2,18 +2,18 @@
 import react from '@vitejs/plugin-react'
 import { resolve } from 'path'
 import { defineConfig } from 'vite'
-import dts from 'vite-plugin-dts'
 
 // https://vite.dev/config/
 export default defineConfig({
-  plugins: [react(), dts()],
+  plugins: [react()],
   build: {
+    outDir: resolve(__dirname, 'dist'),
     copyPublicDir: false,
     lib: {
       entry: resolve(__dirname, 'src/components/index.ts'),
       formats: ['es', 'umd'],
-      name: 'Components',
-      fileName: (format) => `index.${format}.js`,
+      name: 'HyparamComponents',
+      fileName: (format) => `index.${format}.min.js`,
     },
     rollupOptions: {
       external: ['react', 'react/jsx-runtime', 'react-dom'],

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-import Page from './Page.tsx'`
	`1`	`+import Page from './Page.js'`
`2`	`2`
`3`	`3`	`export default function App() {`
`4`	`4`	`return (`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-import { FileKey, UrlKey } from '../lib/key.ts'`
	`1`	`+import { FileKey, UrlKey } from '../lib/key.js'`
`2`	`2`
`3`	`3`	`interface BreadcrumbProps {`
`4`	`4`	`parsedKey: UrlKey \| FileKey`