@dpkit/zip/package/save.ts

Fast TypeScript data management framework built on top of the Data Package standard and Polars DataFrames

import { createWriteStream } from "node:fs"
import { pipeline } from "node:stream/promises"
import type { Descriptor, Package } from "@dpkit/core"
import { denormalizePackage, stringifyDescriptor } from "@dpkit/core"
import {
  assertLocalPathVacant,
  getPackageBasepath,
  readFileStream,
  saveResourceFiles,
} from "@dpkit/file"
import { ZipFile } from "yazl"

export async function savePackageToZip(
  dataPackage: Package,
  options: {
    archivePath: string
    withRemote?: boolean
  },
) {
  const { archivePath, withRemote } = options
  const basepath = getPackageBasepath(dataPackage)

  await assertLocalPathVacant(archivePath)
  const zipfile = new ZipFile()

  const resourceDescriptors: Descriptor[] = []
  for (const resource of dataPackage.resources) {
    resourceDescriptors.push(
      await saveResourceFiles(resource, {
        basepath,
        withRemote,
        saveFile: async props => {
          zipfile.addReadStream(
            await readFileStream(props.normalizedPath),
            props.denormalizedPath,
          )

          return props.denormalizedPath
        },
      }),
    )
  }

  const descriptor = {
    ...denormalizePackage(dataPackage, { basepath }),
    resources: resourceDescriptors,
  }

  zipfile.addBuffer(
    Buffer.from(stringifyDescriptor({ descriptor })),
    "datapackage.json",
  )

  zipfile.end()
  await pipeline(zipfile.outputStream, createWriteStream(archivePath))
}