@bendyline/molen-pack/node

Molen content packs: build, open and read zip packs of models and documents from any source.

import { /* … */ } from '@bendyline/molen-pack/node';

Interfaces

BuiltPackFile

Properties

file

file: string;

File name, <id>-<first 12 hex of the file's sha256>.zip.

fileSha256

fileSha256: string;

sha256 of the file's bytes.

indexPath

indexPath: string;

Path of the updated index.json.

manifest

manifest: PackManifest;

path

path: string;

Absolute path of the written file.

size

size: number;

---

PackSource

Properties

config

config: PackSourceConfig;

dir

dir: string;

files

files: PackFile[];

Variables

PACK_INDEX_FILE

const PACK_INDEX_FILE: "index.json" = "index.json";

Index written next to built packs.

---

PACK_SOURCE_FILE

const PACK_SOURCE_FILE: "molen-pack.source.json" = "molen-pack.source.json";

Build settings file in a pack's source directory.

Functions

buildPack()

function buildPack(dir, options): Promise<BuiltPackFile>;

Build a pack source directory into outDir. The file name carries a hash of its bytes, so a host can cache it forever; index.json in outDir maps the pack id to its current file, and the previous build of the same pack is removed.

Parameters

dir

string

options

compression?

"auto" | "store"

outDir

string

solid?

boolean

Returns

Promise<BuiltPackFile>

---

extractPack()

function extractPack(pack, outDir): Promise<string[]>;

Write every file of a pack into outDir, with a molen-pack.source.json that builds it back to the same content.

Parameters

pack

Pack

outDir

string

Returns

Promise<string[]>

---

listPackSource()

function listPackSource(dir): Promise<{
  config: PackSourceConfig;
  dir: string;
  paths: string[];
}>;

List validated source settings and included paths without loading file contents.

Parameters

dir

string

Returns

Promise<{ config: PackSourceConfig; dir: string; paths: string[]; }>

---

openDirPack()

function openDirPack(dir, options?): Promise<Pack>;

Open an unbuilt pack source directory as a pack. It has the manifest the built pack would have (same entries, ids and contentHash), without zipping anything.

Parameters

dir

string

options?

Pick<OpenPackOptions, "expect">

Returns

Promise<Pack>

---

openFilePack()

function openFilePack(path, options?): Promise<Pack>;

Open a built pack file. Reads go to the file on demand; close() releases it.

Parameters

path

string

options?

OpenPackOptions

Returns

Promise<Pack>

---

openPackAt()

function openPackAt(source, options?): Promise<Pack>;

Open a pack from a URL, a built pack file, or a pack source directory.

Parameters

source

string

options?

OpenPackOptions

Returns

Promise<Pack>

---

readPackSource()

function readPackSource(dir): Promise<PackSource>;

Read a pack's source directory: its settings file and every file it includes.

Parameters

dir

string

Returns

Promise<PackSource>

---

recordInPackIndex()

function recordInPackIndex(
   outDir, 
   id, 
   entry
): Promise<string>;

List a pack file in outDir/index.json (a molen/pack-index@1 document), replacing the entry for the same pack id and deleting that entry's previous file when nothing else lists it. Returns the index path. A browser opens packs from that index (openPacksFromIndex in molen-earth).

Parameters

outDir

string

id

string

entry

PackIndexEntry

Returns

Promise<string>