@milaboratories/pframes-rs-node 1.0.57 → 1.0.61

package/README.md

@@ -1,35 +1,46 @@
 # PFrames Node.js native addon
+
 ## Usage
+>
 > [!TIP]
-> Install using `npm install @milaboratory/pframes-rs-node` command.
+> Install using `pnpm install @milaboratories/pframes-rs-node` command.
 > Check [tests](tests/pframes.test.ts) for usage examples.
+>
 ## Build instructions
+
 ### Build steps
+
 ```sh
-npm run build
+pnpm run build
 ```
 
 ### Artifacts
+
 NodeJS Native Addon is places in `dist` folder.
-Use `npm run pack` to prepare an archive (last output line is its path) and upload it to AWS S3.
+Use `pnpm run pack` to prepare an archive (last output line is its path) and upload it to AWS S3.
 
 Export wrapper is placed in `export_dist` folder.
-Use `npm publish` to publish NodeJS package.
+Use `pnpm publish` to publish NodeJS package.
 
 ## Debugging
+
 ### Prerequisites
+
 Debugging is only supported using VSCode with the following extencions installed (check `@recommended` section in VScode for more suggestions):
+
 - [C/C++](vscode:extension/ms-vscode.cpptools)
 - [CodeLLDB](vscode:extension/vadimcn.vscode-lldb)
 - [rust-analyzer](vscode:extension/rust-lang.rust-analyzer)
 
 ### Launching debug session
+
 1. Clone and build the latest `platforma-desktop-v2` (`git clean -dffx && npm i && npm run build`)
 2. Set the correct RELATIVE path to `platforma-desktop-v2` in `.vscode/settings.json` variable `platformaDesktopPath` (default is `../platforma-desktop-v2`)
-3. Build this package by following the build steps from above (for faster build use `npm run dev-build`)
+3. Build this package by following the build steps from above (for faster build use `pnpm run dev-build`)
 4. Use VSCode launch configuration for your platform to start debug session ([VSCode debugging guide](https://code.visualstudio.com/docs/debugtest/debugging))
 
 ### Performance profiling
+
 1. Clone and build the latest `platforma-desktop-v2`
 2. Set the correct RELATIVE path to `platforma-desktop-v2` in `.vscode/settings.json` variable `platformaDesktopPath`
 3. Build this package by following the build steps from above
@@ -39,5 +50,6 @@ Debugging is only supported using VSCode with the following extencions installed
     (Warning! Firefox profiler does not work in Safari and with AdBlock enabled)
 
 ### Dump pframes requests
+
 1. Run `platforma-desktop-v2` with `MI_DUMP_PFRAMES_RS=/absolute/path/to/dump/requests npm run dev`
 2. Archive the `/absolute/path/to/dump/requests` folder and pass to the developer

package/export/addon-def.ts

@@ -1,5 +1,4 @@
 import {
-  DataInfo,
   PColumnInfo,
   PColumnSpec,
   PObjectId,

package/export/dump.ts

@@ -1,7 +1,8 @@
 import { createHash } from 'node:crypto';
-import fs from 'node:fs';
+import { createWriteStream, promises as fs } from 'node:fs';
 import path from 'node:path';
-import { Readable, Writable } from 'node:stream';
+import { Readable } from 'node:stream';
+import { pipeline } from 'node:stream/promises';
 import type { PFrameInternal } from '@milaboratories/pl-model-middle-layer';
 import {
   PObjectId,
@@ -11,18 +12,16 @@ import {
   UniqueValuesRequest
 } from '@milaboratories/pl-model-common';
 
-async function fileExists(path: string): Promise<boolean> {
-  try {
-    await fs.promises.access(path);
-    return true;
-  } catch {
-    return false;
-  }
+function fileExists(path: string): Promise<boolean> {
+  return fs
+    .access(path)
+    .then(() => true)
+    .catch(() => false);
 }
 
 async function ensureDirExists(fileOrDir: string): Promise<void> {
   if (!(await fileExists(fileOrDir))) {
-    await fs.promises.mkdir(fileOrDir, { recursive: true });
+    await fs.mkdir(fileOrDir, { recursive: true });
   }
 }
 
@@ -32,15 +31,15 @@ async function writeFile(
 ): Promise<void> {
   const tempPath = `${filePath}.tmp`;
   if (await fileExists(tempPath)) {
-    await fs.promises.rm(tempPath, { recursive: true });
+    await fs.rm(tempPath, { recursive: true });
   }
 
   const buffer = typeof data === 'string' ? Buffer.from(data, 'utf8') : data;
   const source = Readable.from(buffer);
-  const destination = fs.createWriteStream(tempPath, { flags: 'wx' });
-  await Readable.toWeb(source).pipeTo(Writable.toWeb(destination));
+  const destination = createWriteStream(tempPath, { flags: 'wx' });
+  await pipeline(source, destination);
 
-  await fs.promises.rename(tempPath, filePath);
+  await fs.rename(tempPath, filePath);
 }
 
 export function hashColumnId(columnId: PObjectId): PObjectId {

package/export/export.ts

@@ -1,13 +1,13 @@
 import type { PFrameInternal } from '@milaboratories/pl-model-middle-layer';
-import { PFrame as PFrameImpl } from './wrapper';
+import { PFrame, pprofDump } from './wrapper';
 
-export type PFrame = {
-  new (
-    spillPath: string,
-    logger?: PFrameInternal.Logger
-  ): PFrameInternal.PFrameV9;
-
-  pprofDump: () => Promise<Uint8Array>;
+export const PFrameFactory: PFrameInternal.PFrameFactory = {
+  createPFrame: (
+    options: PFrameInternal.PFrameOptions
+  ): PFrameInternal.PFrameV10 => {
+    return new PFrame(options);
+  },
+  pprofDump: async (): Promise<Uint8Array> => {
+    return await pprofDump();
+  }
 };
-
-export const PFrame: PFrame = PFrameImpl;

package/export/index.ts

@@ -1 +1,2 @@
-export { PFrame } from './export';
+export { PFrameFactory } from './export';
+export { HttpHelpers } from '@milaboratories/pframes-rs-serv';