@milaboratories/pl-model-middle-layer 1.12.7 → 1.12.9

package/dist/pframe/internal_api/http_helpers.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"http_helpers.cjs","sources":["../../../src/pframe/internal_api/http_helpers.ts"],"sourcesContent":["import type { Readable } from \"node:stream\";\nimport type { RequestListener } from \"node:http\";\nimport type { Branded, Base64Encoded } from \"@milaboratories/pl-model-common\";\nimport type { Logger } from \"./common\";\n\n/** Parquet file extension */\nexport const ParquetExtension = \".parquet\" as const;\n\n/** Parquet file name */\nexport type ParquetFileName = Branded<`${string}.parquet`, \"PFrameInternal.ParquetFileName\">;\n\nexport type FileRange = {\n  /** Start byte position (inclusive) */\n  start: number;\n  /** End byte position (inclusive) */\n  end: number;\n};\n\n/** HTTP range as of RFC 9110 <https://datatracker.ietf.org/doc/html/rfc9110#name-range> */\nexport type HttpRange =\n  | {\n      /**\n       * Get file content in the specified byte range\n       *\n       * @example\n       * ```\n       * GET /file.parquet HTTP/1.1\n       * Range: bytes=0-1023\n       * ```\n       */\n      type: \"bounded\";\n      /** Start byte position (inclusive) */\n      start: number;\n      /** End byte position (inclusive) */\n      end: number;\n    }\n  | {\n      /**\n       * Get byte range starting from the specified offset\n       *\n       * @example\n       * ```\n       * GET /file.parquet HTTP/1.1\n       * Range: bytes=1024-\n       * ```\n       */\n      type: \"offset\";\n      /** Start byte position (inclusive) */\n      offset: number;\n    }\n  | {\n      /**\n       * Get byte range starting from the specified suffix\n       *\n       * @example\n       * ```\n       * GET /file.parquet HTTP/1.1\n       * Range: bytes=-1024\n       * ```\n       */\n      type: \"suffix\";\n      /** End byte position (inclusive) */\n      suffix: number;\n    };\n\n/** HTTP method passed to object store */\nexport type HttpMethod = \"GET\" | \"HEAD\";\n\n/** HTTP response from object store */\nexport type ObjectStoreResponse =\n  | {\n      /**\n       * Will be translated to 500 Internal Server Error by the handler\n       * or 408 Request Timeout if the request was aborted\n       */\n      type: \"InternalError\";\n    }\n  | {\n      /** Will be translated to 404 Not Found by the handler */\n      type: \"NotFound\";\n    }\n  | {\n      /** Will be translated to 416 Range Not Satisfiable by the handler */\n      type: \"RangeNotSatisfiable\";\n      /** Total file size in bytes */\n      size: number;\n    }\n  | {\n      /** Will be translated to 200 OK or 206 Partial Content by the handler */\n      type: \"Ok\";\n      /** Total file size in bytes */\n      size: number;\n      /** File range translated from HTTP range */\n      range: FileRange;\n      /** Stream of file content, undefined for HEAD requests */\n      data?: Readable;\n    };\n\n/** Common options for object store creation */\nexport interface ObjectStoreOptions {\n  /** Logger instance, no logging is performed when not provided */\n  logger?: Logger;\n}\n\n/** Options for file system object store creation */\nexport interface FsStoreOptions extends ObjectStoreOptions {\n  /** Local directory to serve files from */\n  rootDir: string;\n}\n\nexport interface ObjectStore {\n  /**\n   * Proxy HTTP(S) request for parquet file to object store.\n   * Callback promise resolves when stream is closed by handler @see HttpHelpers.createRequestHandler\n   * Callback API is used so that ObjectStore can limit the number of concurrent requests.\n   */\n  request(\n    filename: ParquetFileName,\n    params: {\n      method: HttpMethod;\n      range?: HttpRange;\n      signal: AbortSignal;\n      callback: (response: ObjectStoreResponse) => Promise<void>;\n    },\n  ): void;\n}\n\n/** File system abstraction for request handler factory, @see HttpHelpers.createRequestHandler */\nexport abstract class BaseObjectStore implements ObjectStore {\n  protected readonly logger: Logger;\n\n  constructor(options: ObjectStoreOptions) {\n    this.logger = options.logger ?? (() => {});\n  }\n\n  /** Translate HTTP range to file range, @returns null if the range is not satisfiable */\n  protected translate(fileSize: number, range?: HttpRange): FileRange | null {\n    if (!range) return { start: 0, end: fileSize - 1 };\n    switch (range.type) {\n      case \"bounded\":\n        if (range.end >= fileSize) return null;\n        return { start: range.start, end: range.end };\n      case \"offset\":\n        if (range.offset >= fileSize) return null;\n        return { start: range.offset, end: fileSize - 1 };\n      case \"suffix\":\n        if (range.suffix > fileSize) return null;\n        return { start: fileSize - range.suffix, end: fileSize - 1 };\n    }\n  }\n\n  /**\n   * Proxy HTTP(S) request for parquet file to object store.\n   * Callback promise resolves when stream is closed by handler @see HttpHelpers.createRequestHandler\n   * Callback API is used so that ObjectStore can limit the number of concurrent requests.\n   */\n  abstract request(\n    filename: ParquetFileName,\n    params: {\n      method: HttpMethod;\n      range?: HttpRange;\n      signal: AbortSignal;\n      callback: (response: ObjectStoreResponse) => Promise<void>;\n    },\n  ): Promise<void>;\n}\n\n/** Object store base URL in format accepted by Apache DataFusion and DuckDB */\nexport type ObjectStoreUrl = Branded<string, \"PFrameInternal.ObjectStoreUrl\">;\n\n/** HTTP(S) request handler creation options */\nexport type RequestHandlerOptions = {\n  /** Object store to serve files from, @see HttpHelpers.createFsStore */\n  store: ObjectStore;\n  /** Here will go caching options... */\n};\n\n/** Server configuration options */\nexport type HttpServerOptions = {\n  /** HTTP(S) request handler function, @see HttpHelpers.createRequestHandler */\n  handler: RequestListener;\n  /** Port to bind to, @default 0 for auto-assignment */\n  port?: number;\n  /** Do not apply authorization middleware to @param handler */\n  noAuth?: true;\n  /** Downgrade default HTTPS server to plain HTTP, @warning use only for testing */\n  noHttps?: true;\n};\n\n/**\n * Long unique opaque string for use in Bearer authorization header\n *\n * @example\n * ```ts\n * request.setHeader('Authorization', `Bearer ${authToken}`);\n * ```\n */\nexport type HttpAuthorizationToken = Branded<string, \"PFrameInternal.HttpAuthorizationToken\">;\n\n/**\n * TLS certificate in PEM format\n *\n * @example\n * ```txt\n * -----BEGIN CERTIFICATE-----\n * MIIC2zCCAcOgAwIBAgIJaVW7...\n * ...\n * ...Yf9CRK8fgnukKM7TJ\n * -----END CERTIFICATE-----\n * ```\n */\nexport type PemCertificate = Branded<string, \"PFrameInternal.PemCertificate\">;\n\n/** HTTP(S) server connection settings, {@link HttpHelpers.createHttpServer} */\nexport type HttpServerInfo = {\n  /** URL of the HTTP(S) server formatted as `http{s}://<host>:<port>/` */\n  url: ObjectStoreUrl;\n  /** Authorization token for Bearer scheme, undefined when @see HttpServerOptions.noAuth flag is set */\n  authToken?: HttpAuthorizationToken;\n  /** Encoded CA certificate of HTTPS server, undefined when @see HttpServerOptions.noHttps flag is set */\n  encodedCaCert?: Base64Encoded<PemCertificate>;\n};\n\n/** HTTP(S) server information and controls, @see HttpHelpers.createHttpServer */\nexport interface HttpServer {\n  /** Server configuration information for initiating connections from clients */\n  get info(): HttpServerInfo;\n  /** Promise that resolves when the server is stopped */\n  get stopped(): Promise<void>;\n  /** Request server stop, returns the same promise as @see HttpServer.stopped */\n  stop(): Promise<void>;\n}\n\n/** List of HTTP(S) related helper functions exposed by PFrame module */\nexport interface HttpHelpers {\n  /**\n   * Create an object store for serving files from a local directory.\n   * Rejects if the provided path does not exist or is not a directory.\n   */\n  createFsStore(options: FsStoreOptions): Promise<ObjectStore>;\n\n  /**\n   * Create an HTTP request handler for serving files from an object store.\n   * Accepts only paths of the form `/<filename>.parquet`, returns 410 otherwise.\n   * Assumes that files are immutable (and sets cache headers accordingly).\n   */\n  createRequestHandler(options: RequestHandlerOptions): RequestListener;\n\n  /**\n   * Serve HTTP(S) requests using the provided handler on localhost port.\n   * @returns promise that resolves when the server has stopped.\n   *\n   * @example\n   * ```ts\n   * const rootDir = '/path/to/directory/with/parquet/files';\n   *\n   * let store = await HttpHelpers.createFsStore({ rootDir }).catch((err: unknown) => {\n   *   throw new Error(`Failed to create file store for ${rootDir} - ${ensureError(err)}`);\n   * });\n   *\n   * const server = await HttpHelpers.createHttpServer({\n   *   handler: HttpHelpers.createRequestHandler({ store }),\n   * }).catch((err: unknown) => {\n   *   throw new Error(`Failed to start HTTPS server - ${ensureError(err)}`);\n   * });\n   *\n   * const { url, authToken, encodedCaCert } = server.info;\n   *\n   * await server.stop();\n   * ```\n   */\n  createHttpServer(options: HttpServerOptions): Promise<HttpServer>;\n}\n"],"names":[],"mappings":";;AAKA;AACO,MAAM,gBAAgB,GAAG;AAyHhC;MACsB,eAAe,CAAA;AAChB,IAAA,MAAM;AAEzB,IAAA,WAAA,CAAY,OAA2B,EAAA;AACrC,QAAA,IAAI,CAAC,MAAM,GAAG,OAAO,CAAC,MAAM,KAAK,MAAK,EAAE,CAAC,CAAC;IAC5C;;IAGU,SAAS,CAAC,QAAgB,EAAE,KAAiB,EAAA;AACrD,QAAA,IAAI,CAAC,KAAK;YAAE,OAAO,EAAE,KAAK,EAAE,CAAC,EAAE,GAAG,EAAE,QAAQ,GAAG,CAAC,EAAE;AAClD,QAAA,QAAQ,KAAK,CAAC,IAAI;AAChB,YAAA,KAAK,SAAS;AACZ,gBAAA,IAAI,KAAK,CAAC,GAAG,IAAI,QAAQ;AAAE,oBAAA,OAAO,IAAI;AACtC,gBAAA,OAAO,EAAE,KAAK,EAAE,KAAK,CAAC,KAAK,EAAE,GAAG,EAAE,KAAK,CAAC,GAAG,EAAE;AAC/C,YAAA,KAAK,QAAQ;AACX,gBAAA,IAAI,KAAK,CAAC,MAAM,IAAI,QAAQ;AAAE,oBAAA,OAAO,IAAI;AACzC,gBAAA,OAAO,EAAE,KAAK,EAAE,KAAK,CAAC,MAAM,EAAE,GAAG,EAAE,QAAQ,GAAG,CAAC,EAAE;AACnD,YAAA,KAAK,QAAQ;AACX,gBAAA,IAAI,KAAK,CAAC,MAAM,GAAG,QAAQ;AAAE,oBAAA,OAAO,IAAI;AACxC,gBAAA,OAAO,EAAE,KAAK,EAAE,QAAQ,GAAG,KAAK,CAAC,MAAM,EAAE,GAAG,EAAE,QAAQ,GAAG,CAAC,EAAE;;IAElE;AAgBD;;;;;"}
+{"version":3,"file":"http_helpers.cjs","names":[],"sources":["../../../src/pframe/internal_api/http_helpers.ts"],"sourcesContent":["import type { Readable } from \"node:stream\";\nimport type { RequestListener } from \"node:http\";\nimport type { Branded, Base64Encoded } from \"@milaboratories/pl-model-common\";\nimport type { Logger } from \"./common\";\n\n/** Parquet file extension */\nexport const ParquetExtension = \".parquet\" as const;\n\n/** Parquet file name */\nexport type ParquetFileName = Branded<`${string}.parquet`, \"PFrameInternal.ParquetFileName\">;\n\nexport type FileRange = {\n  /** Start byte position (inclusive) */\n  start: number;\n  /** End byte position (inclusive) */\n  end: number;\n};\n\n/** HTTP range as of RFC 9110 <https://datatracker.ietf.org/doc/html/rfc9110#name-range> */\nexport type HttpRange =\n  | {\n      /**\n       * Get file content in the specified byte range\n       *\n       * @example\n       * ```\n       * GET /file.parquet HTTP/1.1\n       * Range: bytes=0-1023\n       * ```\n       */\n      type: \"bounded\";\n      /** Start byte position (inclusive) */\n      start: number;\n      /** End byte position (inclusive) */\n      end: number;\n    }\n  | {\n      /**\n       * Get byte range starting from the specified offset\n       *\n       * @example\n       * ```\n       * GET /file.parquet HTTP/1.1\n       * Range: bytes=1024-\n       * ```\n       */\n      type: \"offset\";\n      /** Start byte position (inclusive) */\n      offset: number;\n    }\n  | {\n      /**\n       * Get byte range starting from the specified suffix\n       *\n       * @example\n       * ```\n       * GET /file.parquet HTTP/1.1\n       * Range: bytes=-1024\n       * ```\n       */\n      type: \"suffix\";\n      /** End byte position (inclusive) */\n      suffix: number;\n    };\n\n/** HTTP method passed to object store */\nexport type HttpMethod = \"GET\" | \"HEAD\";\n\n/** HTTP response from object store */\nexport type ObjectStoreResponse =\n  | {\n      /**\n       * Will be translated to 500 Internal Server Error by the handler\n       * or 408 Request Timeout if the request was aborted\n       */\n      type: \"InternalError\";\n    }\n  | {\n      /** Will be translated to 404 Not Found by the handler */\n      type: \"NotFound\";\n    }\n  | {\n      /** Will be translated to 416 Range Not Satisfiable by the handler */\n      type: \"RangeNotSatisfiable\";\n      /** Total file size in bytes */\n      size: number;\n    }\n  | {\n      /** Will be translated to 200 OK or 206 Partial Content by the handler */\n      type: \"Ok\";\n      /** Total file size in bytes */\n      size: number;\n      /** File range translated from HTTP range */\n      range: FileRange;\n      /** Stream of file content, undefined for HEAD requests */\n      data?: Readable;\n    };\n\n/** Common options for object store creation */\nexport interface ObjectStoreOptions {\n  /** Logger instance, no logging is performed when not provided */\n  logger?: Logger;\n}\n\n/** Options for file system object store creation */\nexport interface FsStoreOptions extends ObjectStoreOptions {\n  /** Local directory to serve files from */\n  rootDir: string;\n}\n\nexport interface ObjectStore {\n  /**\n   * Proxy HTTP(S) request for parquet file to object store.\n   * Callback promise resolves when stream is closed by handler @see HttpHelpers.createRequestHandler\n   * Callback API is used so that ObjectStore can limit the number of concurrent requests.\n   */\n  request(\n    filename: ParquetFileName,\n    params: {\n      method: HttpMethod;\n      range?: HttpRange;\n      signal: AbortSignal;\n      callback: (response: ObjectStoreResponse) => Promise<void>;\n    },\n  ): void;\n}\n\n/** File system abstraction for request handler factory, @see HttpHelpers.createRequestHandler */\nexport abstract class BaseObjectStore implements ObjectStore {\n  protected readonly logger: Logger;\n\n  constructor(options: ObjectStoreOptions) {\n    this.logger = options.logger ?? (() => {});\n  }\n\n  /** Translate HTTP range to file range, @returns null if the range is not satisfiable */\n  protected translate(fileSize: number, range?: HttpRange): FileRange | null {\n    if (!range) return { start: 0, end: fileSize - 1 };\n    switch (range.type) {\n      case \"bounded\":\n        if (range.end >= fileSize) return null;\n        return { start: range.start, end: range.end };\n      case \"offset\":\n        if (range.offset >= fileSize) return null;\n        return { start: range.offset, end: fileSize - 1 };\n      case \"suffix\":\n        if (range.suffix > fileSize) return null;\n        return { start: fileSize - range.suffix, end: fileSize - 1 };\n    }\n  }\n\n  /**\n   * Proxy HTTP(S) request for parquet file to object store.\n   * Callback promise resolves when stream is closed by handler @see HttpHelpers.createRequestHandler\n   * Callback API is used so that ObjectStore can limit the number of concurrent requests.\n   */\n  abstract request(\n    filename: ParquetFileName,\n    params: {\n      method: HttpMethod;\n      range?: HttpRange;\n      signal: AbortSignal;\n      callback: (response: ObjectStoreResponse) => Promise<void>;\n    },\n  ): Promise<void>;\n}\n\n/** Object store base URL in format accepted by Apache DataFusion and DuckDB */\nexport type ObjectStoreUrl = Branded<string, \"PFrameInternal.ObjectStoreUrl\">;\n\n/** HTTP(S) request handler creation options */\nexport type RequestHandlerOptions = {\n  /** Object store to serve files from, @see HttpHelpers.createFsStore */\n  store: ObjectStore;\n  /** Here will go caching options... */\n};\n\n/** Server configuration options */\nexport type HttpServerOptions = {\n  /** HTTP(S) request handler function, @see HttpHelpers.createRequestHandler */\n  handler: RequestListener;\n  /** Port to bind to, @default 0 for auto-assignment */\n  port?: number;\n  /** Do not apply authorization middleware to @param handler */\n  noAuth?: true;\n  /** Downgrade default HTTPS server to plain HTTP, @warning use only for testing */\n  noHttps?: true;\n};\n\n/**\n * Long unique opaque string for use in Bearer authorization header\n *\n * @example\n * ```ts\n * request.setHeader('Authorization', `Bearer ${authToken}`);\n * ```\n */\nexport type HttpAuthorizationToken = Branded<string, \"PFrameInternal.HttpAuthorizationToken\">;\n\n/**\n * TLS certificate in PEM format\n *\n * @example\n * ```txt\n * -----BEGIN CERTIFICATE-----\n * MIIC2zCCAcOgAwIBAgIJaVW7...\n * ...\n * ...Yf9CRK8fgnukKM7TJ\n * -----END CERTIFICATE-----\n * ```\n */\nexport type PemCertificate = Branded<string, \"PFrameInternal.PemCertificate\">;\n\n/** HTTP(S) server connection settings, {@link HttpHelpers.createHttpServer} */\nexport type HttpServerInfo = {\n  /** URL of the HTTP(S) server formatted as `http{s}://<host>:<port>/` */\n  url: ObjectStoreUrl;\n  /** Authorization token for Bearer scheme, undefined when @see HttpServerOptions.noAuth flag is set */\n  authToken?: HttpAuthorizationToken;\n  /** Encoded CA certificate of HTTPS server, undefined when @see HttpServerOptions.noHttps flag is set */\n  encodedCaCert?: Base64Encoded<PemCertificate>;\n};\n\n/** HTTP(S) server information and controls, @see HttpHelpers.createHttpServer */\nexport interface HttpServer {\n  /** Server configuration information for initiating connections from clients */\n  get info(): HttpServerInfo;\n  /** Promise that resolves when the server is stopped */\n  get stopped(): Promise<void>;\n  /** Request server stop, returns the same promise as @see HttpServer.stopped */\n  stop(): Promise<void>;\n}\n\n/** List of HTTP(S) related helper functions exposed by PFrame module */\nexport interface HttpHelpers {\n  /**\n   * Create an object store for serving files from a local directory.\n   * Rejects if the provided path does not exist or is not a directory.\n   */\n  createFsStore(options: FsStoreOptions): Promise<ObjectStore>;\n\n  /**\n   * Create an HTTP request handler for serving files from an object store.\n   * Accepts only paths of the form `/<filename>.parquet`, returns 410 otherwise.\n   * Assumes that files are immutable (and sets cache headers accordingly).\n   */\n  createRequestHandler(options: RequestHandlerOptions): RequestListener;\n\n  /**\n   * Serve HTTP(S) requests using the provided handler on localhost port.\n   * @returns promise that resolves when the server has stopped.\n   *\n   * @example\n   * ```ts\n   * const rootDir = '/path/to/directory/with/parquet/files';\n   *\n   * let store = await HttpHelpers.createFsStore({ rootDir }).catch((err: unknown) => {\n   *   throw new Error(`Failed to create file store for ${rootDir} - ${ensureError(err)}`);\n   * });\n   *\n   * const server = await HttpHelpers.createHttpServer({\n   *   handler: HttpHelpers.createRequestHandler({ store }),\n   * }).catch((err: unknown) => {\n   *   throw new Error(`Failed to start HTTPS server - ${ensureError(err)}`);\n   * });\n   *\n   * const { url, authToken, encodedCaCert } = server.info;\n   *\n   * await server.stop();\n   * ```\n   */\n  createHttpServer(options: HttpServerOptions): Promise<HttpServer>;\n}\n"],"mappings":";;;AAMA,MAAa,mBAAmB;;AA0HhC,IAAsB,kBAAtB,MAA6D;CAC3D,AAAmB;CAEnB,YAAY,SAA6B;AACvC,OAAK,SAAS,QAAQ,iBAAiB;;;CAIzC,AAAU,UAAU,UAAkB,OAAqC;AACzE,MAAI,CAAC,MAAO,QAAO;GAAE,OAAO;GAAG,KAAK,WAAW;GAAG;AAClD,UAAQ,MAAM,MAAd;GACE,KAAK;AACH,QAAI,MAAM,OAAO,SAAU,QAAO;AAClC,WAAO;KAAE,OAAO,MAAM;KAAO,KAAK,MAAM;KAAK;GAC/C,KAAK;AACH,QAAI,MAAM,UAAU,SAAU,QAAO;AACrC,WAAO;KAAE,OAAO,MAAM;KAAQ,KAAK,WAAW;KAAG;GACnD,KAAK;AACH,QAAI,MAAM,SAAS,SAAU,QAAO;AACpC,WAAO;KAAE,OAAO,WAAW,MAAM;KAAQ,KAAK,WAAW;KAAG"}

package/dist/pframe/internal_api/http_helpers.d.ts

@@ -1,145 +1,129 @@
-import type { Readable } from "node:stream";
-import type { RequestListener } from "node:http";
-import type { Branded, Base64Encoded } from "@milaboratories/pl-model-common";
-import type { Logger } from "./common";
+import { Logger } from "./common.js";
+import { Base64Encoded, Branded } from "@milaboratories/pl-model-common";
+import { Readable } from "node:stream";
+import { RequestListener } from "node:http";
+
+//#region src/pframe/internal_api/http_helpers.d.ts
 /** Parquet file extension */
-export declare const ParquetExtension: ".parquet";
+declare const ParquetExtension: ".parquet";
 /** Parquet file name */
-export type ParquetFileName = Branded<`${string}.parquet`, "PFrameInternal.ParquetFileName">;
-export type FileRange = {
-    /** Start byte position (inclusive) */
-    start: number;
-    /** End byte position (inclusive) */
-    end: number;
+type ParquetFileName = Branded<`${string}.parquet`, "PFrameInternal.ParquetFileName">;
+type FileRange = {
+  /** Start byte position (inclusive) */start: number; /** End byte position (inclusive) */
+  end: number;
 };
 /** HTTP range as of RFC 9110 <https://datatracker.ietf.org/doc/html/rfc9110#name-range> */
-export type HttpRange = {
-    /**
-     * Get file content in the specified byte range
-     *
-     * @example
-     * ```
-     * GET /file.parquet HTTP/1.1
-     * Range: bytes=0-1023
-     * ```
-     */
-    type: "bounded";
-    /** Start byte position (inclusive) */
-    start: number;
-    /** End byte position (inclusive) */
-    end: number;
+type HttpRange = {
+  /**
+   * Get file content in the specified byte range
+   *
+   * @example
+   * ```
+   * GET /file.parquet HTTP/1.1
+   * Range: bytes=0-1023
+   * ```
+   */
+  type: "bounded"; /** Start byte position (inclusive) */
+  start: number; /** End byte position (inclusive) */
+  end: number;
 } | {
-    /**
-     * Get byte range starting from the specified offset
-     *
-     * @example
-     * ```
-     * GET /file.parquet HTTP/1.1
-     * Range: bytes=1024-
-     * ```
-     */
-    type: "offset";
-    /** Start byte position (inclusive) */
-    offset: number;
+  /**
+   * Get byte range starting from the specified offset
+   *
+   * @example
+   * ```
+   * GET /file.parquet HTTP/1.1
+   * Range: bytes=1024-
+   * ```
+   */
+  type: "offset"; /** Start byte position (inclusive) */
+  offset: number;
 } | {
-    /**
-     * Get byte range starting from the specified suffix
-     *
-     * @example
-     * ```
-     * GET /file.parquet HTTP/1.1
-     * Range: bytes=-1024
-     * ```
-     */
-    type: "suffix";
-    /** End byte position (inclusive) */
-    suffix: number;
+  /**
+   * Get byte range starting from the specified suffix
+   *
+   * @example
+   * ```
+   * GET /file.parquet HTTP/1.1
+   * Range: bytes=-1024
+   * ```
+   */
+  type: "suffix"; /** End byte position (inclusive) */
+  suffix: number;
 };
 /** HTTP method passed to object store */
-export type HttpMethod = "GET" | "HEAD";
+type HttpMethod = "GET" | "HEAD";
 /** HTTP response from object store */
-export type ObjectStoreResponse = {
-    /**
-     * Will be translated to 500 Internal Server Error by the handler
-     * or 408 Request Timeout if the request was aborted
-     */
-    type: "InternalError";
+type ObjectStoreResponse = {
+  /**
+   * Will be translated to 500 Internal Server Error by the handler
+   * or 408 Request Timeout if the request was aborted
+   */
+  type: "InternalError";
 } | {
-    /** Will be translated to 404 Not Found by the handler */
-    type: "NotFound";
+  /** Will be translated to 404 Not Found by the handler */type: "NotFound";
 } | {
-    /** Will be translated to 416 Range Not Satisfiable by the handler */
-    type: "RangeNotSatisfiable";
-    /** Total file size in bytes */
-    size: number;
+  /** Will be translated to 416 Range Not Satisfiable by the handler */type: "RangeNotSatisfiable"; /** Total file size in bytes */
+  size: number;
 } | {
-    /** Will be translated to 200 OK or 206 Partial Content by the handler */
-    type: "Ok";
-    /** Total file size in bytes */
-    size: number;
-    /** File range translated from HTTP range */
-    range: FileRange;
-    /** Stream of file content, undefined for HEAD requests */
-    data?: Readable;
+  /** Will be translated to 200 OK or 206 Partial Content by the handler */type: "Ok"; /** Total file size in bytes */
+  size: number; /** File range translated from HTTP range */
+  range: FileRange; /** Stream of file content, undefined for HEAD requests */
+  data?: Readable;
 };
 /** Common options for object store creation */
-export interface ObjectStoreOptions {
-    /** Logger instance, no logging is performed when not provided */
-    logger?: Logger;
+interface ObjectStoreOptions {
+  /** Logger instance, no logging is performed when not provided */
+  logger?: Logger;
 }
 /** Options for file system object store creation */
-export interface FsStoreOptions extends ObjectStoreOptions {
-    /** Local directory to serve files from */
-    rootDir: string;
+interface FsStoreOptions extends ObjectStoreOptions {
+  /** Local directory to serve files from */
+  rootDir: string;
 }
-export interface ObjectStore {
-    /**
-     * Proxy HTTP(S) request for parquet file to object store.
-     * Callback promise resolves when stream is closed by handler @see HttpHelpers.createRequestHandler
-     * Callback API is used so that ObjectStore can limit the number of concurrent requests.
-     */
-    request(filename: ParquetFileName, params: {
-        method: HttpMethod;
-        range?: HttpRange;
-        signal: AbortSignal;
-        callback: (response: ObjectStoreResponse) => Promise<void>;
-    }): void;
+interface ObjectStore {
+  /**
+   * Proxy HTTP(S) request for parquet file to object store.
+   * Callback promise resolves when stream is closed by handler @see HttpHelpers.createRequestHandler
+   * Callback API is used so that ObjectStore can limit the number of concurrent requests.
+   */
+  request(filename: ParquetFileName, params: {
+    method: HttpMethod;
+    range?: HttpRange;
+    signal: AbortSignal;
+    callback: (response: ObjectStoreResponse) => Promise<void>;
+  }): void;
 }
 /** File system abstraction for request handler factory, @see HttpHelpers.createRequestHandler */
-export declare abstract class BaseObjectStore implements ObjectStore {
-    protected readonly logger: Logger;
-    constructor(options: ObjectStoreOptions);
-    /** Translate HTTP range to file range, @returns null if the range is not satisfiable */
-    protected translate(fileSize: number, range?: HttpRange): FileRange | null;
-    /**
-     * Proxy HTTP(S) request for parquet file to object store.
-     * Callback promise resolves when stream is closed by handler @see HttpHelpers.createRequestHandler
-     * Callback API is used so that ObjectStore can limit the number of concurrent requests.
-     */
-    abstract request(filename: ParquetFileName, params: {
-        method: HttpMethod;
-        range?: HttpRange;
-        signal: AbortSignal;
-        callback: (response: ObjectStoreResponse) => Promise<void>;
-    }): Promise<void>;
+declare abstract class BaseObjectStore implements ObjectStore {
+  protected readonly logger: Logger;
+  constructor(options: ObjectStoreOptions);
+  /** Translate HTTP range to file range, @returns null if the range is not satisfiable */
+  protected translate(fileSize: number, range?: HttpRange): FileRange | null;
+  /**
+   * Proxy HTTP(S) request for parquet file to object store.
+   * Callback promise resolves when stream is closed by handler @see HttpHelpers.createRequestHandler
+   * Callback API is used so that ObjectStore can limit the number of concurrent requests.
+   */
+  abstract request(filename: ParquetFileName, params: {
+    method: HttpMethod;
+    range?: HttpRange;
+    signal: AbortSignal;
+    callback: (response: ObjectStoreResponse) => Promise<void>;
+  }): Promise<void>;
 }
 /** Object store base URL in format accepted by Apache DataFusion and DuckDB */
-export type ObjectStoreUrl = Branded<string, "PFrameInternal.ObjectStoreUrl">;
+type ObjectStoreUrl = Branded<string, "PFrameInternal.ObjectStoreUrl">;
 /** HTTP(S) request handler creation options */
-export type RequestHandlerOptions = {
-    /** Object store to serve files from, @see HttpHelpers.createFsStore */
-    store: ObjectStore;
+type RequestHandlerOptions = {
+  /** Object store to serve files from, @see HttpHelpers.createFsStore */store: ObjectStore;
 };
 /** Server configuration options */
-export type HttpServerOptions = {
-    /** HTTP(S) request handler function, @see HttpHelpers.createRequestHandler */
-    handler: RequestListener;
-    /** Port to bind to, @default 0 for auto-assignment */
-    port?: number;
-    /** Do not apply authorization middleware to @param handler */
-    noAuth?: true;
-    /** Downgrade default HTTPS server to plain HTTP, @warning use only for testing */
-    noHttps?: true;
+type HttpServerOptions = {
+  /** HTTP(S) request handler function, @see HttpHelpers.createRequestHandler */handler: RequestListener; /** Port to bind to, @default 0 for auto-assignment */
+  port?: number; /** Do not apply authorization middleware to @param handler */
+  noAuth?: true; /** Downgrade default HTTPS server to plain HTTP, @warning use only for testing */
+  noHttps?: true;
 };
 /**
  * Long unique opaque string for use in Bearer authorization header
@@ -149,7 +133,7 @@ export type HttpServerOptions = {
  * request.setHeader('Authorization', `Bearer ${authToken}`);
  * ```
  */
-export type HttpAuthorizationToken = Branded<string, "PFrameInternal.HttpAuthorizationToken">;
+type HttpAuthorizationToken = Branded<string, "PFrameInternal.HttpAuthorizationToken">;
 /**
  * TLS certificate in PEM format
  *
@@ -162,61 +146,60 @@ export type HttpAuthorizationToken = Branded<string, "PFrameInternal.HttpAuthori
  * -----END CERTIFICATE-----
  * ```
  */
-export type PemCertificate = Branded<string, "PFrameInternal.PemCertificate">;
+type PemCertificate = Branded<string, "PFrameInternal.PemCertificate">;
 /** HTTP(S) server connection settings, {@link HttpHelpers.createHttpServer} */
-export type HttpServerInfo = {
-    /** URL of the HTTP(S) server formatted as `http{s}://<host>:<port>/` */
-    url: ObjectStoreUrl;
-    /** Authorization token for Bearer scheme, undefined when @see HttpServerOptions.noAuth flag is set */
-    authToken?: HttpAuthorizationToken;
-    /** Encoded CA certificate of HTTPS server, undefined when @see HttpServerOptions.noHttps flag is set */
-    encodedCaCert?: Base64Encoded<PemCertificate>;
+type HttpServerInfo = {
+  /** URL of the HTTP(S) server formatted as `http{s}://<host>:<port>/` */url: ObjectStoreUrl; /** Authorization token for Bearer scheme, undefined when @see HttpServerOptions.noAuth flag is set */
+  authToken?: HttpAuthorizationToken; /** Encoded CA certificate of HTTPS server, undefined when @see HttpServerOptions.noHttps flag is set */
+  encodedCaCert?: Base64Encoded<PemCertificate>;
 };
 /** HTTP(S) server information and controls, @see HttpHelpers.createHttpServer */
-export interface HttpServer {
-    /** Server configuration information for initiating connections from clients */
-    get info(): HttpServerInfo;
-    /** Promise that resolves when the server is stopped */
-    get stopped(): Promise<void>;
-    /** Request server stop, returns the same promise as @see HttpServer.stopped */
-    stop(): Promise<void>;
+interface HttpServer {
+  /** Server configuration information for initiating connections from clients */
+  get info(): HttpServerInfo;
+  /** Promise that resolves when the server is stopped */
+  get stopped(): Promise<void>;
+  /** Request server stop, returns the same promise as @see HttpServer.stopped */
+  stop(): Promise<void>;
 }
 /** List of HTTP(S) related helper functions exposed by PFrame module */
-export interface HttpHelpers {
-    /**
-     * Create an object store for serving files from a local directory.
-     * Rejects if the provided path does not exist or is not a directory.
-     */
-    createFsStore(options: FsStoreOptions): Promise<ObjectStore>;
-    /**
-     * Create an HTTP request handler for serving files from an object store.
-     * Accepts only paths of the form `/<filename>.parquet`, returns 410 otherwise.
-     * Assumes that files are immutable (and sets cache headers accordingly).
-     */
-    createRequestHandler(options: RequestHandlerOptions): RequestListener;
-    /**
-     * Serve HTTP(S) requests using the provided handler on localhost port.
-     * @returns promise that resolves when the server has stopped.
-     *
-     * @example
-     * ```ts
-     * const rootDir = '/path/to/directory/with/parquet/files';
-     *
-     * let store = await HttpHelpers.createFsStore({ rootDir }).catch((err: unknown) => {
-     *   throw new Error(`Failed to create file store for ${rootDir} - ${ensureError(err)}`);
-     * });
-     *
-     * const server = await HttpHelpers.createHttpServer({
-     *   handler: HttpHelpers.createRequestHandler({ store }),
-     * }).catch((err: unknown) => {
-     *   throw new Error(`Failed to start HTTPS server - ${ensureError(err)}`);
-     * });
-     *
-     * const { url, authToken, encodedCaCert } = server.info;
-     *
-     * await server.stop();
-     * ```
-     */
-    createHttpServer(options: HttpServerOptions): Promise<HttpServer>;
+interface HttpHelpers {
+  /**
+   * Create an object store for serving files from a local directory.
+   * Rejects if the provided path does not exist or is not a directory.
+   */
+  createFsStore(options: FsStoreOptions): Promise<ObjectStore>;
+  /**
+   * Create an HTTP request handler for serving files from an object store.
+   * Accepts only paths of the form `/<filename>.parquet`, returns 410 otherwise.
+   * Assumes that files are immutable (and sets cache headers accordingly).
+   */
+  createRequestHandler(options: RequestHandlerOptions): RequestListener;
+  /**
+   * Serve HTTP(S) requests using the provided handler on localhost port.
+   * @returns promise that resolves when the server has stopped.
+   *
+   * @example
+   * ```ts
+   * const rootDir = '/path/to/directory/with/parquet/files';
+   *
+   * let store = await HttpHelpers.createFsStore({ rootDir }).catch((err: unknown) => {
+   *   throw new Error(`Failed to create file store for ${rootDir} - ${ensureError(err)}`);
+   * });
+   *
+   * const server = await HttpHelpers.createHttpServer({
+   *   handler: HttpHelpers.createRequestHandler({ store }),
+   * }).catch((err: unknown) => {
+   *   throw new Error(`Failed to start HTTPS server - ${ensureError(err)}`);
+   * });
+   *
+   * const { url, authToken, encodedCaCert } = server.info;
+   *
+   * await server.stop();
+   * ```
+   */
+  createHttpServer(options: HttpServerOptions): Promise<HttpServer>;
 }
+//#endregion
+export { BaseObjectStore, FileRange, FsStoreOptions, HttpAuthorizationToken, HttpHelpers, HttpMethod, HttpRange, HttpServer, HttpServerInfo, HttpServerOptions, ObjectStore, ObjectStoreOptions, ObjectStoreResponse, ObjectStoreUrl, ParquetExtension, ParquetFileName, PemCertificate, RequestHandlerOptions };
 //# sourceMappingURL=http_helpers.d.ts.map

package/dist/pframe/internal_api/http_helpers.js

@@ -1,31 +1,41 @@
+//#region src/pframe/internal_api/http_helpers.ts
 /** Parquet file extension */
 const ParquetExtension = ".parquet";
 /** File system abstraction for request handler factory, @see HttpHelpers.createRequestHandler */
-class BaseObjectStore {
-    logger;
-    constructor(options) {
-        this.logger = options.logger ?? (() => { });
-    }
-    /** Translate HTTP range to file range, @returns null if the range is not satisfiable */
-    translate(fileSize, range) {
-        if (!range)
-            return { start: 0, end: fileSize - 1 };
-        switch (range.type) {
-            case "bounded":
-                if (range.end >= fileSize)
-                    return null;
-                return { start: range.start, end: range.end };
-            case "offset":
-                if (range.offset >= fileSize)
-                    return null;
-                return { start: range.offset, end: fileSize - 1 };
-            case "suffix":
-                if (range.suffix > fileSize)
-                    return null;
-                return { start: fileSize - range.suffix, end: fileSize - 1 };
-        }
-    }
-}
+var BaseObjectStore = class {
+	logger;
+	constructor(options) {
+		this.logger = options.logger ?? (() => {});
+	}
+	/** Translate HTTP range to file range, @returns null if the range is not satisfiable */
+	translate(fileSize, range) {
+		if (!range) return {
+			start: 0,
+			end: fileSize - 1
+		};
+		switch (range.type) {
+			case "bounded":
+				if (range.end >= fileSize) return null;
+				return {
+					start: range.start,
+					end: range.end
+				};
+			case "offset":
+				if (range.offset >= fileSize) return null;
+				return {
+					start: range.offset,
+					end: fileSize - 1
+				};
+			case "suffix":
+				if (range.suffix > fileSize) return null;
+				return {
+					start: fileSize - range.suffix,
+					end: fileSize - 1
+				};
+		}
+	}
+};
 
+//#endregion
 export { BaseObjectStore, ParquetExtension };
-//# sourceMappingURL=http_helpers.js.map
+//# sourceMappingURL=http_helpers.js.map

package/dist/pframe/internal_api/http_helpers.js.map

@@ -1 +1 @@
-{"version":3,"file":"http_helpers.js","sources":["../../../src/pframe/internal_api/http_helpers.ts"],"sourcesContent":["import type { Readable } from \"node:stream\";\nimport type { RequestListener } from \"node:http\";\nimport type { Branded, Base64Encoded } from \"@milaboratories/pl-model-common\";\nimport type { Logger } from \"./common\";\n\n/** Parquet file extension */\nexport const ParquetExtension = \".parquet\" as const;\n\n/** Parquet file name */\nexport type ParquetFileName = Branded<`${string}.parquet`, \"PFrameInternal.ParquetFileName\">;\n\nexport type FileRange = {\n  /** Start byte position (inclusive) */\n  start: number;\n  /** End byte position (inclusive) */\n  end: number;\n};\n\n/** HTTP range as of RFC 9110 <https://datatracker.ietf.org/doc/html/rfc9110#name-range> */\nexport type HttpRange =\n  | {\n      /**\n       * Get file content in the specified byte range\n       *\n       * @example\n       * ```\n       * GET /file.parquet HTTP/1.1\n       * Range: bytes=0-1023\n       * ```\n       */\n      type: \"bounded\";\n      /** Start byte position (inclusive) */\n      start: number;\n      /** End byte position (inclusive) */\n      end: number;\n    }\n  | {\n      /**\n       * Get byte range starting from the specified offset\n       *\n       * @example\n       * ```\n       * GET /file.parquet HTTP/1.1\n       * Range: bytes=1024-\n       * ```\n       */\n      type: \"offset\";\n      /** Start byte position (inclusive) */\n      offset: number;\n    }\n  | {\n      /**\n       * Get byte range starting from the specified suffix\n       *\n       * @example\n       * ```\n       * GET /file.parquet HTTP/1.1\n       * Range: bytes=-1024\n       * ```\n       */\n      type: \"suffix\";\n      /** End byte position (inclusive) */\n      suffix: number;\n    };\n\n/** HTTP method passed to object store */\nexport type HttpMethod = \"GET\" | \"HEAD\";\n\n/** HTTP response from object store */\nexport type ObjectStoreResponse =\n  | {\n      /**\n       * Will be translated to 500 Internal Server Error by the handler\n       * or 408 Request Timeout if the request was aborted\n       */\n      type: \"InternalError\";\n    }\n  | {\n      /** Will be translated to 404 Not Found by the handler */\n      type: \"NotFound\";\n    }\n  | {\n      /** Will be translated to 416 Range Not Satisfiable by the handler */\n      type: \"RangeNotSatisfiable\";\n      /** Total file size in bytes */\n      size: number;\n    }\n  | {\n      /** Will be translated to 200 OK or 206 Partial Content by the handler */\n      type: \"Ok\";\n      /** Total file size in bytes */\n      size: number;\n      /** File range translated from HTTP range */\n      range: FileRange;\n      /** Stream of file content, undefined for HEAD requests */\n      data?: Readable;\n    };\n\n/** Common options for object store creation */\nexport interface ObjectStoreOptions {\n  /** Logger instance, no logging is performed when not provided */\n  logger?: Logger;\n}\n\n/** Options for file system object store creation */\nexport interface FsStoreOptions extends ObjectStoreOptions {\n  /** Local directory to serve files from */\n  rootDir: string;\n}\n\nexport interface ObjectStore {\n  /**\n   * Proxy HTTP(S) request for parquet file to object store.\n   * Callback promise resolves when stream is closed by handler @see HttpHelpers.createRequestHandler\n   * Callback API is used so that ObjectStore can limit the number of concurrent requests.\n   */\n  request(\n    filename: ParquetFileName,\n    params: {\n      method: HttpMethod;\n      range?: HttpRange;\n      signal: AbortSignal;\n      callback: (response: ObjectStoreResponse) => Promise<void>;\n    },\n  ): void;\n}\n\n/** File system abstraction for request handler factory, @see HttpHelpers.createRequestHandler */\nexport abstract class BaseObjectStore implements ObjectStore {\n  protected readonly logger: Logger;\n\n  constructor(options: ObjectStoreOptions) {\n    this.logger = options.logger ?? (() => {});\n  }\n\n  /** Translate HTTP range to file range, @returns null if the range is not satisfiable */\n  protected translate(fileSize: number, range?: HttpRange): FileRange | null {\n    if (!range) return { start: 0, end: fileSize - 1 };\n    switch (range.type) {\n      case \"bounded\":\n        if (range.end >= fileSize) return null;\n        return { start: range.start, end: range.end };\n      case \"offset\":\n        if (range.offset >= fileSize) return null;\n        return { start: range.offset, end: fileSize - 1 };\n      case \"suffix\":\n        if (range.suffix > fileSize) return null;\n        return { start: fileSize - range.suffix, end: fileSize - 1 };\n    }\n  }\n\n  /**\n   * Proxy HTTP(S) request for parquet file to object store.\n   * Callback promise resolves when stream is closed by handler @see HttpHelpers.createRequestHandler\n   * Callback API is used so that ObjectStore can limit the number of concurrent requests.\n   */\n  abstract request(\n    filename: ParquetFileName,\n    params: {\n      method: HttpMethod;\n      range?: HttpRange;\n      signal: AbortSignal;\n      callback: (response: ObjectStoreResponse) => Promise<void>;\n    },\n  ): Promise<void>;\n}\n\n/** Object store base URL in format accepted by Apache DataFusion and DuckDB */\nexport type ObjectStoreUrl = Branded<string, \"PFrameInternal.ObjectStoreUrl\">;\n\n/** HTTP(S) request handler creation options */\nexport type RequestHandlerOptions = {\n  /** Object store to serve files from, @see HttpHelpers.createFsStore */\n  store: ObjectStore;\n  /** Here will go caching options... */\n};\n\n/** Server configuration options */\nexport type HttpServerOptions = {\n  /** HTTP(S) request handler function, @see HttpHelpers.createRequestHandler */\n  handler: RequestListener;\n  /** Port to bind to, @default 0 for auto-assignment */\n  port?: number;\n  /** Do not apply authorization middleware to @param handler */\n  noAuth?: true;\n  /** Downgrade default HTTPS server to plain HTTP, @warning use only for testing */\n  noHttps?: true;\n};\n\n/**\n * Long unique opaque string for use in Bearer authorization header\n *\n * @example\n * ```ts\n * request.setHeader('Authorization', `Bearer ${authToken}`);\n * ```\n */\nexport type HttpAuthorizationToken = Branded<string, \"PFrameInternal.HttpAuthorizationToken\">;\n\n/**\n * TLS certificate in PEM format\n *\n * @example\n * ```txt\n * -----BEGIN CERTIFICATE-----\n * MIIC2zCCAcOgAwIBAgIJaVW7...\n * ...\n * ...Yf9CRK8fgnukKM7TJ\n * -----END CERTIFICATE-----\n * ```\n */\nexport type PemCertificate = Branded<string, \"PFrameInternal.PemCertificate\">;\n\n/** HTTP(S) server connection settings, {@link HttpHelpers.createHttpServer} */\nexport type HttpServerInfo = {\n  /** URL of the HTTP(S) server formatted as `http{s}://<host>:<port>/` */\n  url: ObjectStoreUrl;\n  /** Authorization token for Bearer scheme, undefined when @see HttpServerOptions.noAuth flag is set */\n  authToken?: HttpAuthorizationToken;\n  /** Encoded CA certificate of HTTPS server, undefined when @see HttpServerOptions.noHttps flag is set */\n  encodedCaCert?: Base64Encoded<PemCertificate>;\n};\n\n/** HTTP(S) server information and controls, @see HttpHelpers.createHttpServer */\nexport interface HttpServer {\n  /** Server configuration information for initiating connections from clients */\n  get info(): HttpServerInfo;\n  /** Promise that resolves when the server is stopped */\n  get stopped(): Promise<void>;\n  /** Request server stop, returns the same promise as @see HttpServer.stopped */\n  stop(): Promise<void>;\n}\n\n/** List of HTTP(S) related helper functions exposed by PFrame module */\nexport interface HttpHelpers {\n  /**\n   * Create an object store for serving files from a local directory.\n   * Rejects if the provided path does not exist or is not a directory.\n   */\n  createFsStore(options: FsStoreOptions): Promise<ObjectStore>;\n\n  /**\n   * Create an HTTP request handler for serving files from an object store.\n   * Accepts only paths of the form `/<filename>.parquet`, returns 410 otherwise.\n   * Assumes that files are immutable (and sets cache headers accordingly).\n   */\n  createRequestHandler(options: RequestHandlerOptions): RequestListener;\n\n  /**\n   * Serve HTTP(S) requests using the provided handler on localhost port.\n   * @returns promise that resolves when the server has stopped.\n   *\n   * @example\n   * ```ts\n   * const rootDir = '/path/to/directory/with/parquet/files';\n   *\n   * let store = await HttpHelpers.createFsStore({ rootDir }).catch((err: unknown) => {\n   *   throw new Error(`Failed to create file store for ${rootDir} - ${ensureError(err)}`);\n   * });\n   *\n   * const server = await HttpHelpers.createHttpServer({\n   *   handler: HttpHelpers.createRequestHandler({ store }),\n   * }).catch((err: unknown) => {\n   *   throw new Error(`Failed to start HTTPS server - ${ensureError(err)}`);\n   * });\n   *\n   * const { url, authToken, encodedCaCert } = server.info;\n   *\n   * await server.stop();\n   * ```\n   */\n  createHttpServer(options: HttpServerOptions): Promise<HttpServer>;\n}\n"],"names":[],"mappings":"AAKA;AACO,MAAM,gBAAgB,GAAG;AAyHhC;MACsB,eAAe,CAAA;AAChB,IAAA,MAAM;AAEzB,IAAA,WAAA,CAAY,OAA2B,EAAA;AACrC,QAAA,IAAI,CAAC,MAAM,GAAG,OAAO,CAAC,MAAM,KAAK,MAAK,EAAE,CAAC,CAAC;IAC5C;;IAGU,SAAS,CAAC,QAAgB,EAAE,KAAiB,EAAA;AACrD,QAAA,IAAI,CAAC,KAAK;YAAE,OAAO,EAAE,KAAK,EAAE,CAAC,EAAE,GAAG,EAAE,QAAQ,GAAG,CAAC,EAAE;AAClD,QAAA,QAAQ,KAAK,CAAC,IAAI;AAChB,YAAA,KAAK,SAAS;AACZ,gBAAA,IAAI,KAAK,CAAC,GAAG,IAAI,QAAQ;AAAE,oBAAA,OAAO,IAAI;AACtC,gBAAA,OAAO,EAAE,KAAK,EAAE,KAAK,CAAC,KAAK,EAAE,GAAG,EAAE,KAAK,CAAC,GAAG,EAAE;AAC/C,YAAA,KAAK,QAAQ;AACX,gBAAA,IAAI,KAAK,CAAC,MAAM,IAAI,QAAQ;AAAE,oBAAA,OAAO,IAAI;AACzC,gBAAA,OAAO,EAAE,KAAK,EAAE,KAAK,CAAC,MAAM,EAAE,GAAG,EAAE,QAAQ,GAAG,CAAC,EAAE;AACnD,YAAA,KAAK,QAAQ;AACX,gBAAA,IAAI,KAAK,CAAC,MAAM,GAAG,QAAQ;AAAE,oBAAA,OAAO,IAAI;AACxC,gBAAA,OAAO,EAAE,KAAK,EAAE,QAAQ,GAAG,KAAK,CAAC,MAAM,EAAE,GAAG,EAAE,QAAQ,GAAG,CAAC,EAAE;;IAElE;AAgBD;;;;"}
+{"version":3,"file":"http_helpers.js","names":[],"sources":["../../../src/pframe/internal_api/http_helpers.ts"],"sourcesContent":["import type { Readable } from \"node:stream\";\nimport type { RequestListener } from \"node:http\";\nimport type { Branded, Base64Encoded } from \"@milaboratories/pl-model-common\";\nimport type { Logger } from \"./common\";\n\n/** Parquet file extension */\nexport const ParquetExtension = \".parquet\" as const;\n\n/** Parquet file name */\nexport type ParquetFileName = Branded<`${string}.parquet`, \"PFrameInternal.ParquetFileName\">;\n\nexport type FileRange = {\n  /** Start byte position (inclusive) */\n  start: number;\n  /** End byte position (inclusive) */\n  end: number;\n};\n\n/** HTTP range as of RFC 9110 <https://datatracker.ietf.org/doc/html/rfc9110#name-range> */\nexport type HttpRange =\n  | {\n      /**\n       * Get file content in the specified byte range\n       *\n       * @example\n       * ```\n       * GET /file.parquet HTTP/1.1\n       * Range: bytes=0-1023\n       * ```\n       */\n      type: \"bounded\";\n      /** Start byte position (inclusive) */\n      start: number;\n      /** End byte position (inclusive) */\n      end: number;\n    }\n  | {\n      /**\n       * Get byte range starting from the specified offset\n       *\n       * @example\n       * ```\n       * GET /file.parquet HTTP/1.1\n       * Range: bytes=1024-\n       * ```\n       */\n      type: \"offset\";\n      /** Start byte position (inclusive) */\n      offset: number;\n    }\n  | {\n      /**\n       * Get byte range starting from the specified suffix\n       *\n       * @example\n       * ```\n       * GET /file.parquet HTTP/1.1\n       * Range: bytes=-1024\n       * ```\n       */\n      type: \"suffix\";\n      /** End byte position (inclusive) */\n      suffix: number;\n    };\n\n/** HTTP method passed to object store */\nexport type HttpMethod = \"GET\" | \"HEAD\";\n\n/** HTTP response from object store */\nexport type ObjectStoreResponse =\n  | {\n      /**\n       * Will be translated to 500 Internal Server Error by the handler\n       * or 408 Request Timeout if the request was aborted\n       */\n      type: \"InternalError\";\n    }\n  | {\n      /** Will be translated to 404 Not Found by the handler */\n      type: \"NotFound\";\n    }\n  | {\n      /** Will be translated to 416 Range Not Satisfiable by the handler */\n      type: \"RangeNotSatisfiable\";\n      /** Total file size in bytes */\n      size: number;\n    }\n  | {\n      /** Will be translated to 200 OK or 206 Partial Content by the handler */\n      type: \"Ok\";\n      /** Total file size in bytes */\n      size: number;\n      /** File range translated from HTTP range */\n      range: FileRange;\n      /** Stream of file content, undefined for HEAD requests */\n      data?: Readable;\n    };\n\n/** Common options for object store creation */\nexport interface ObjectStoreOptions {\n  /** Logger instance, no logging is performed when not provided */\n  logger?: Logger;\n}\n\n/** Options for file system object store creation */\nexport interface FsStoreOptions extends ObjectStoreOptions {\n  /** Local directory to serve files from */\n  rootDir: string;\n}\n\nexport interface ObjectStore {\n  /**\n   * Proxy HTTP(S) request for parquet file to object store.\n   * Callback promise resolves when stream is closed by handler @see HttpHelpers.createRequestHandler\n   * Callback API is used so that ObjectStore can limit the number of concurrent requests.\n   */\n  request(\n    filename: ParquetFileName,\n    params: {\n      method: HttpMethod;\n      range?: HttpRange;\n      signal: AbortSignal;\n      callback: (response: ObjectStoreResponse) => Promise<void>;\n    },\n  ): void;\n}\n\n/** File system abstraction for request handler factory, @see HttpHelpers.createRequestHandler */\nexport abstract class BaseObjectStore implements ObjectStore {\n  protected readonly logger: Logger;\n\n  constructor(options: ObjectStoreOptions) {\n    this.logger = options.logger ?? (() => {});\n  }\n\n  /** Translate HTTP range to file range, @returns null if the range is not satisfiable */\n  protected translate(fileSize: number, range?: HttpRange): FileRange | null {\n    if (!range) return { start: 0, end: fileSize - 1 };\n    switch (range.type) {\n      case \"bounded\":\n        if (range.end >= fileSize) return null;\n        return { start: range.start, end: range.end };\n      case \"offset\":\n        if (range.offset >= fileSize) return null;\n        return { start: range.offset, end: fileSize - 1 };\n      case \"suffix\":\n        if (range.suffix > fileSize) return null;\n        return { start: fileSize - range.suffix, end: fileSize - 1 };\n    }\n  }\n\n  /**\n   * Proxy HTTP(S) request for parquet file to object store.\n   * Callback promise resolves when stream is closed by handler @see HttpHelpers.createRequestHandler\n   * Callback API is used so that ObjectStore can limit the number of concurrent requests.\n   */\n  abstract request(\n    filename: ParquetFileName,\n    params: {\n      method: HttpMethod;\n      range?: HttpRange;\n      signal: AbortSignal;\n      callback: (response: ObjectStoreResponse) => Promise<void>;\n    },\n  ): Promise<void>;\n}\n\n/** Object store base URL in format accepted by Apache DataFusion and DuckDB */\nexport type ObjectStoreUrl = Branded<string, \"PFrameInternal.ObjectStoreUrl\">;\n\n/** HTTP(S) request handler creation options */\nexport type RequestHandlerOptions = {\n  /** Object store to serve files from, @see HttpHelpers.createFsStore */\n  store: ObjectStore;\n  /** Here will go caching options... */\n};\n\n/** Server configuration options */\nexport type HttpServerOptions = {\n  /** HTTP(S) request handler function, @see HttpHelpers.createRequestHandler */\n  handler: RequestListener;\n  /** Port to bind to, @default 0 for auto-assignment */\n  port?: number;\n  /** Do not apply authorization middleware to @param handler */\n  noAuth?: true;\n  /** Downgrade default HTTPS server to plain HTTP, @warning use only for testing */\n  noHttps?: true;\n};\n\n/**\n * Long unique opaque string for use in Bearer authorization header\n *\n * @example\n * ```ts\n * request.setHeader('Authorization', `Bearer ${authToken}`);\n * ```\n */\nexport type HttpAuthorizationToken = Branded<string, \"PFrameInternal.HttpAuthorizationToken\">;\n\n/**\n * TLS certificate in PEM format\n *\n * @example\n * ```txt\n * -----BEGIN CERTIFICATE-----\n * MIIC2zCCAcOgAwIBAgIJaVW7...\n * ...\n * ...Yf9CRK8fgnukKM7TJ\n * -----END CERTIFICATE-----\n * ```\n */\nexport type PemCertificate = Branded<string, \"PFrameInternal.PemCertificate\">;\n\n/** HTTP(S) server connection settings, {@link HttpHelpers.createHttpServer} */\nexport type HttpServerInfo = {\n  /** URL of the HTTP(S) server formatted as `http{s}://<host>:<port>/` */\n  url: ObjectStoreUrl;\n  /** Authorization token for Bearer scheme, undefined when @see HttpServerOptions.noAuth flag is set */\n  authToken?: HttpAuthorizationToken;\n  /** Encoded CA certificate of HTTPS server, undefined when @see HttpServerOptions.noHttps flag is set */\n  encodedCaCert?: Base64Encoded<PemCertificate>;\n};\n\n/** HTTP(S) server information and controls, @see HttpHelpers.createHttpServer */\nexport interface HttpServer {\n  /** Server configuration information for initiating connections from clients */\n  get info(): HttpServerInfo;\n  /** Promise that resolves when the server is stopped */\n  get stopped(): Promise<void>;\n  /** Request server stop, returns the same promise as @see HttpServer.stopped */\n  stop(): Promise<void>;\n}\n\n/** List of HTTP(S) related helper functions exposed by PFrame module */\nexport interface HttpHelpers {\n  /**\n   * Create an object store for serving files from a local directory.\n   * Rejects if the provided path does not exist or is not a directory.\n   */\n  createFsStore(options: FsStoreOptions): Promise<ObjectStore>;\n\n  /**\n   * Create an HTTP request handler for serving files from an object store.\n   * Accepts only paths of the form `/<filename>.parquet`, returns 410 otherwise.\n   * Assumes that files are immutable (and sets cache headers accordingly).\n   */\n  createRequestHandler(options: RequestHandlerOptions): RequestListener;\n\n  /**\n   * Serve HTTP(S) requests using the provided handler on localhost port.\n   * @returns promise that resolves when the server has stopped.\n   *\n   * @example\n   * ```ts\n   * const rootDir = '/path/to/directory/with/parquet/files';\n   *\n   * let store = await HttpHelpers.createFsStore({ rootDir }).catch((err: unknown) => {\n   *   throw new Error(`Failed to create file store for ${rootDir} - ${ensureError(err)}`);\n   * });\n   *\n   * const server = await HttpHelpers.createHttpServer({\n   *   handler: HttpHelpers.createRequestHandler({ store }),\n   * }).catch((err: unknown) => {\n   *   throw new Error(`Failed to start HTTPS server - ${ensureError(err)}`);\n   * });\n   *\n   * const { url, authToken, encodedCaCert } = server.info;\n   *\n   * await server.stop();\n   * ```\n   */\n  createHttpServer(options: HttpServerOptions): Promise<HttpServer>;\n}\n"],"mappings":";;AAMA,MAAa,mBAAmB;;AA0HhC,IAAsB,kBAAtB,MAA6D;CAC3D,AAAmB;CAEnB,YAAY,SAA6B;AACvC,OAAK,SAAS,QAAQ,iBAAiB;;;CAIzC,AAAU,UAAU,UAAkB,OAAqC;AACzE,MAAI,CAAC,MAAO,QAAO;GAAE,OAAO;GAAG,KAAK,WAAW;GAAG;AAClD,UAAQ,MAAM,MAAd;GACE,KAAK;AACH,QAAI,MAAM,OAAO,SAAU,QAAO;AAClC,WAAO;KAAE,OAAO,MAAM;KAAO,KAAK,MAAM;KAAK;GAC/C,KAAK;AACH,QAAI,MAAM,UAAU,SAAU,QAAO;AACrC,WAAO;KAAE,OAAO,MAAM;KAAQ,KAAK,WAAW;KAAG;GACnD,KAAK;AACH,QAAI,MAAM,SAAS,SAAU,QAAO;AACpC,WAAO;KAAE,OAAO,WAAW,MAAM;KAAQ,KAAK,WAAW;KAAG"}

package/dist/pframe/internal_api/index.cjs

@@ -1,12 +1,20 @@
-'use strict';
+const require_runtime = require('../../_virtual/_rolldown/runtime.cjs');
+const require_api_factory = require('./api_factory.cjs');
+const require_http_helpers = require('./http_helpers.cjs');
 
-var api_factory = require('./api_factory.cjs');
-var http_helpers = require('./http_helpers.cjs');
+//#region src/pframe/internal_api/index.ts
+var internal_api_exports = /* @__PURE__ */ require_runtime.__exportAll({
+	BaseObjectStore: () => require_http_helpers.BaseObjectStore,
+	DataInfoExtension: () => require_api_factory.DataInfoExtension,
+	ParquetExtension: () => require_http_helpers.ParquetExtension,
+	SpecExtension: () => require_api_factory.SpecExtension
+});
 
-
-
-exports.DataInfoExtension = api_factory.DataInfoExtension;
-exports.SpecExtension = api_factory.SpecExtension;
-exports.BaseObjectStore = http_helpers.BaseObjectStore;
-exports.ParquetExtension = http_helpers.ParquetExtension;
-//# sourceMappingURL=index.cjs.map
+//#endregion
+Object.defineProperty(exports, 'internal_api_exports', {
+  enumerable: true,
+  get: function () {
+    return internal_api_exports;
+  }
+});
+//# sourceMappingURL=index.cjs.map

package/dist/pframe/internal_api/index.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"index.cjs","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;;"}
+{"version":3,"file":"index.cjs","names":[],"sources":["../../../src/pframe/internal_api/index.ts"],"sourcesContent":["export * from \"./api_read\";\nexport * from \"./api_factory\";\nexport * from \"./api_wasm\";\nexport * from \"./common\";\nexport * from \"./create_table\";\nexport * from \"./delete_column\";\nexport * from \"./find_columns\";\nexport * from \"./table\";\n\nexport * from \"./pframe\";\nexport * from \"./http_helpers\";\n\nexport type { SingleAxisSelector } from \"@milaboratories/pl-model-common\";\n"],"mappings":""}

package/dist/pframe/internal_api/index.d.ts

@@ -1,12 +1,19 @@
-export * from "./api_read";
-export * from "./api_factory";
-export * from "./api_wasm";
-export * from "./common";
-export * from "./create_table";
-export * from "./delete_column";
-export * from "./find_columns";
-export * from "./table";
-export * from "./pframe";
-export * from "./http_helpers";
-export type { SingleAxisSelector } from "@milaboratories/pl-model-common";
+import { AxisQualification, ColumnAxesWithQualifications, ConstantAxisFilter, Logger, PFrameId, PTableId } from "./common.js";
+import { FindColumnResponseQualifications, FindColumnsMappingVariant, FindColumnsRequest, FindColumnsResponse, FindColumnsResponseHit } from "./find_columns.js";
+import { DeleteColumnFromColumnsRequest, DeleteColumnFromColumnsResponse } from "./delete_column.js";
+import { ArtificialColumnJoinEntry, ColumnJoinEntry, CreateTableRequestV4, FullJoinV4, InlineColumnJoinEntry, InnerJoinV4, JoinEntryV4, OuterJoinV4, SlicedColumnJoinEntry } from "./create_table.js";
+import { PTableV8 } from "./table.js";
+import { PFrameReadAPIV11 } from "./api_read.js";
+import { BaseObjectStore, FileRange, FsStoreOptions, HttpAuthorizationToken, HttpHelpers, HttpMethod, HttpRange, HttpServer, HttpServerInfo, HttpServerOptions, ObjectStore, ObjectStoreOptions, ObjectStoreResponse, ObjectStoreUrl, ParquetExtension, ParquetFileName, PemCertificate, RequestHandlerOptions } from "./http_helpers.js";
+import { DataInfo, DataInfoExtension, FilePath, PFrameBlobId, PFrameDataSourceV2, PFrameFactoryAPIV4, SpecExtension } from "./api_factory.js";
+import { EvaluateQueryResponse, LegacyQuery, PFrameWasm, PFrameWasmAPI } from "./api_wasm.js";
+import { PFrameFactoryV4, PFrameOptionsV2, PFrameV13 } from "./pframe.js";
+import { SingleAxisSelector as SingleAxisSelector$1 } from "@milaboratories/pl-model-common";
+
+//#region src/pframe/internal_api/index.d.ts
+declare namespace index_d_exports {
+  export { ArtificialColumnJoinEntry, AxisQualification, BaseObjectStore, ColumnAxesWithQualifications, ColumnJoinEntry, ConstantAxisFilter, CreateTableRequestV4, DataInfo, DataInfoExtension, DeleteColumnFromColumnsRequest, DeleteColumnFromColumnsResponse, EvaluateQueryResponse, FilePath, FileRange, FindColumnResponseQualifications, FindColumnsMappingVariant, FindColumnsRequest, FindColumnsResponse, FindColumnsResponseHit, FsStoreOptions, FullJoinV4, HttpAuthorizationToken, HttpHelpers, HttpMethod, HttpRange, HttpServer, HttpServerInfo, HttpServerOptions, InlineColumnJoinEntry, InnerJoinV4, JoinEntryV4, LegacyQuery, Logger, ObjectStore, ObjectStoreOptions, ObjectStoreResponse, ObjectStoreUrl, OuterJoinV4, PFrameBlobId, PFrameDataSourceV2, PFrameFactoryAPIV4, PFrameFactoryV4, PFrameId, PFrameOptionsV2, PFrameReadAPIV11, PFrameV13, PFrameWasm, PFrameWasmAPI, PTableId, PTableV8, ParquetExtension, ParquetFileName, PemCertificate, RequestHandlerOptions, SingleAxisSelector$1 as SingleAxisSelector, SlicedColumnJoinEntry, SpecExtension };
+}
+//#endregion
+export { index_d_exports };
 //# sourceMappingURL=index.d.ts.map