Reorganize files in the repo.

Move avro into nested folder. Add index.js. Rename avroData to avroRead.

Author: platypii

example.js

@@ -1,6 +1,6 @@
-import { icebergRead } from './src/iceberg.js'
+import { icebergRead } from './src/index.js'
 
-const tableUrl = 'https://s3.amazonaws.com/hyperparam-iceberg/warehouse/bunnies'
+const tableUrl = 'https://s3.amazonaws.com/hyperparam-iceberg/spark/bunnies'
 const metadataFileName = 'v3.metadata.json'
 
 /**

package.json

@@ -24,11 +24,11 @@
     "types"
   ],
   "type": "module",
-  "types": "types/iceberg.d.ts",
+  "types": "types/index.d.ts",
   "exports": {
     ".": {
-      "types": "./types/iceberg.d.ts",
-      "import": "./src/iceberg.js"
+      "types": "./types/index.d.ts",
+      "import": "./src/index.js"
     },
     "./src/*.js": {
       "types": "./types/*.d.ts",

src/avro.metadata.js renamed to src/avro/avro.metadata.js

@@ -12,7 +12,7 @@ import { parseDecimal } from 'hyparquet/src/convert.js'
  * @param {Uint8Array} options.syncMarker
  * @returns {Record<string, any>[]}
  */
-export function avroData({ reader, metadata, syncMarker }) {
+export function avroRead({ reader, metadata, syncMarker }) {
   const blocks = []
   while (reader.offset < reader.view.byteLength) {
     let recordCount = readZigZag(reader)
@@ -63,7 +63,7 @@ export function avroData({ reader, metadata, syncMarker }) {
 
 /**
  * @import {DataReader} from 'hyparquet/src/types.js'
- * @import {AvroType} from '../src/types.js'
+ * @import {AvroType} from '../../src/types.js'
  * @param {DataReader} reader
  * @param {AvroType} type
  * @returns {any}

src/avro.data.js renamed to src/avro/avro.read.js

@@ -48,7 +48,7 @@ export function avroWrite({ writer, schema, records, blockSize = 512 }) {
 
 /**
  * @import {Writer} from 'hyparquet-writer/src/types.js'
- * @import {AvroRecord, AvroType} from '../src/types.js'
+ * @import {AvroRecord, AvroType} from '../../src/types.js'
  * @param {Writer} writer
  * @param {AvroType} schema
  * @param {*} value

src/avro.write.js renamed to src/avro/avro.write.js

@@ -1,7 +1,7 @@
 import { asyncBufferFromUrl, cachedAsyncBuffer, parquetReadObjects } from 'hyparquet'
 import { compressors } from 'hyparquet-compressors'
-import { avroData } from './avro.data.js'
-import { avroMetadata } from './avro.metadata.js'
+import { avroRead } from './avro/avro.read.js'
+import { avroMetadata } from './avro/avro.metadata.js'
 
 /**
  * Translates an S3A URL to an HTTPS URL for direct access to the object.
@@ -92,5 +92,5 @@ export async function fetchAvroRecords(manifestUrl, requestInit) {
   const buffer = await fetch(safeUrl, requestInit).then(res => res.arrayBuffer())
   const reader = { view: new DataView(buffer), offset: 0 }
   const { metadata, syncMarker } = await avroMetadata(reader)
-  return await avroData({ reader, metadata, syncMarker })
+  return await avroRead({ reader, metadata, syncMarker })
 }

src/iceberg.fetch.js renamed to src/fetch.js

@@ -0,0 +1,6 @@
+export { icebergRead } from './read.js'
+export { icebergLatestVersion, icebergListVersions, icebergMetadata } from './metadata.js'
+export { icebergManifests } from './manifest.js'
+export { avroMetadata } from './avro/avro.metadata.js'
+export { avroRead } from './avro/avro.read.js'
+export { avroWrite } from './avro/avro.write.js'

src/index.js

@@ -1,4 +1,4 @@
-import { fetchAvroRecords } from './iceberg.fetch.js'
+import { fetchAvroRecords } from './fetch.js'
 
 /**
  * Returns manifest entries for the current snapshot.

src/iceberg.manifest.js renamed to src/manifest.js

@@ -1,4 +1,4 @@
-import { translateS3Url } from './iceberg.fetch.js'
+import { translateS3Url } from './fetch.js'
 
 /**
  * Fetches the iceberg metadata version using the version hint file.

src/iceberg.metadata.js renamed to src/metadata.js

@@ -1,14 +1,10 @@
 import { asyncBufferFromUrl, cachedAsyncBuffer, parquetMetadataAsync, parquetReadObjects } from 'hyparquet'
 import { compressors } from 'hyparquet-compressors'
-import { fetchDeleteMaps, translateS3Url } from './iceberg.fetch.js'
-import { icebergLatestVersion, icebergListVersions, icebergMetadata } from './iceberg.metadata.js'
-import { icebergManifests, splitManifestEntries } from './iceberg.manifest.js'
+import { fetchDeleteMaps, translateS3Url } from './fetch.js'
+import { icebergMetadata } from './metadata.js'
+import { icebergManifests, splitManifestEntries } from './manifest.js'
 import { equalityMatch, sanitize } from './utils.js'
 
-export { icebergMetadata, icebergManifests, icebergLatestVersion, icebergListVersions }
-export { avroMetadata } from './avro.metadata.js'
-export { avroData } from './avro.data.js'
-
 /**
  * Reads data from the Iceberg table with optional row-level delete processing.
  * Row indices are zero-based and rowEnd is exclusive.

src/iceberg.js renamed to src/read.js

@@ -1,6 +1,6 @@
 import fs from 'fs'
 import { describe, expect, it } from 'vitest'
-import { avroMetadata } from '../src/avro.metadata.js'
+import { avroMetadata } from '../src/avro/avro.metadata.js'
 import { asyncBufferFromFile, toJson } from 'hyparquet'
 import { fileToJson } from './helpers.js'
 

test/avro.metadata.test.js

@@ -1,11 +1,11 @@
 import fs from 'fs'
 import { describe, expect, it } from 'vitest'
-import { avroData } from '../src/avro.data.js'
-import { avroMetadata } from '../src/avro.metadata.js'
+import { avroRead } from '../src/avro/avro.read.js'
+import { avroMetadata } from '../src/avro/avro.metadata.js'
 import { asyncBufferFromFile, toJson } from 'hyparquet'
 import { fileToJson } from './helpers.js'
 
-describe('avroData from test files', () => {
+describe('avroRead from test files', () => {
   const files = fs.readdirSync('test/files').filter(f => f.endsWith('.avro'))
 
   files.forEach(filename => {
@@ -14,7 +14,7 @@ describe('avroData from test files', () => {
       const buffer = await file.slice(0)
       const reader = { view: new DataView(buffer), offset: 0 }
       const { metadata, syncMarker } = await avroMetadata(reader)
-      const data = await avroData({ reader, metadata, syncMarker })
+      const data = await avroRead({ reader, metadata, syncMarker })
 
       const base = filename.replace('.avro', '')
       const expected = fileToJson(`test/files/${base}.json`)

test/avro.data.test.js renamed to test/avro.read.test.js

@@ -1,7 +1,6 @@
 import { describe, expect, it } from 'vitest'
 import { ByteWriter } from 'hyparquet-writer'
-import { avroWrite } from '../src/avro.write.js'
-import { avroData, avroMetadata } from '../src/iceberg.js'
+import { avroMetadata, avroRead, avroWrite } from '../src/index.js'
 
 /**
  * @import {AvroType} from '../src/types.js'
@@ -33,7 +32,7 @@ describe('Avro round-trip', () => {
 
     const reader = { view: new DataView(writer.getBuffer()), offset: 0 }
     const { metadata, syncMarker } = avroMetadata(reader)
-    const rows = avroData({ reader, metadata, syncMarker })
+    const rows = avroRead({ reader, metadata, syncMarker })
 
     expect(rows).toEqual(records)
   })
@@ -58,7 +57,7 @@ describe('Avro round-trip', () => {
 
     const reader = { view: new DataView(writer.getBuffer()), offset: 0 }
     const { metadata, syncMarker } = avroMetadata(reader)
-    const got = avroData({ reader, metadata, syncMarker })
+    const got = avroRead({ reader, metadata, syncMarker })
 
     expect(got).toEqual(recs)
   })
@@ -84,7 +83,7 @@ describe('Avro round-trip', () => {
 
     const reader = { view: new DataView(writer.getBuffer()), offset: 0 }
     const { metadata, syncMarker } = avroMetadata(reader)
-    const round = avroData({ reader, metadata, syncMarker })
+    const round = avroRead({ reader, metadata, syncMarker })
 
     expect(round[0].ts.getTime()).toBe(original[0].ts.getTime())
   })
@@ -114,7 +113,7 @@ describe('Avro round-trip', () => {
 
     const reader = { view: new DataView(writer.getBuffer()), offset: 0 }
     const { metadata, syncMarker } = avroMetadata(reader)
-    const got = avroData({ reader, metadata, syncMarker })
+    const got = avroRead({ reader, metadata, syncMarker })
 
     expect(got).toEqual(recs)
   })

test/avro.roundtrip.test.js

@@ -1,6 +1,6 @@
 import { describe, expect, it } from 'vitest'
-import { icebergManifests } from '../src/iceberg.manifest.js'
-import { icebergMetadata } from '../src/iceberg.metadata.js'
+import { icebergManifests } from '../src/manifest.js'
+import { icebergMetadata } from '../src/metadata.js'
 
 describe('Iceberg Manifests', () => {
   const tableUrl = 'https://s3.amazonaws.com/hyperparam-iceberg/spark/bunnies'

test/iceberg.manifest.test.js renamed to test/manifest.test.js

@@ -1,5 +1,5 @@
 import { describe, expect, it, vi } from 'vitest'
-import { icebergLatestVersion, icebergListVersions, icebergMetadata } from '../src/iceberg.metadata.js'
+import { icebergLatestVersion, icebergListVersions, icebergMetadata } from '../src/metadata.js'
 
 describe.concurrent('Iceberg Metadata', () => {
   const tableUrl = 'https://s3.amazonaws.com/hyperparam-iceberg/spark/bunnies'

test/iceberg.metadata.test.js renamed to test/metadata.test.js

@@ -1,5 +1,5 @@
 import { describe, expect, it } from 'vitest'
-import { icebergLatestVersion, icebergListVersions, icebergMetadata, icebergRead } from '../src/iceberg.js'
+import { icebergLatestVersion, icebergListVersions, icebergMetadata, icebergRead } from '../src/index.js'
 
 describe.concurrent('icebergRead from athena table', () => {
   const tableUrl = 'https://s3.amazonaws.com/hyperparam-iceberg/athena/example'

test/iceberg.athena.test.js renamed to test/read.athena.test.js

@@ -1,5 +1,5 @@
 import { describe, expect, it } from 'vitest'
-import { icebergRead } from '../src/iceberg.js'
+import { icebergRead } from '../src/read.js'
 
 describe.concurrent('icebergRead from table with renamed column', () => {
   const tableUrl = 'https://s3.amazonaws.com/hyperparam-iceberg/spark/rename_column'

test/iceberg.column.rename.test.js renamed to test/read.column.rename.test.js

@@ -1,5 +1,5 @@
 import { describe, expect, it, vi } from 'vitest'
-import { icebergRead } from '../src/iceberg.js'
+import { icebergRead } from '../src/read.js'
 
 describe.concurrent('icebergRead from java iceberg table', () => {
   const tableUrl = 'https://s3.amazonaws.com/hyperparam-iceberg/java/bunnies'

test/iceberg.java.test.js renamed to test/read.java.test.js

@@ -1,5 +1,5 @@
 import { describe, expect, it } from 'vitest'
-import { icebergRead } from '../src/iceberg.js'
+import { icebergRead } from '../src/read.js'
 
 describe.concurrent('icebergRead from spark iceberg table', () => {
   const tableUrl = 'https://s3.amazonaws.com/hyperparam-iceberg/spark/bunnies'

test/iceberg.spark.test.js renamed to test/read.spark.test.js

@@ -1,5 +1,5 @@
 import { describe, expect, it } from 'vitest'
-import { icebergRead } from '../src/iceberg.js'
+import { icebergRead } from '../src/read.js'
 
 describe.concurrent('icebergRead', () => {
   it('throws for missing tableUrl', async () => {