@milaboratories/pl-model-middle-layer 1.8.37 → 1.8.39

package/dist/index.cjs

@@ -13,6 +13,7 @@ var block_pack_spec = require('./block_registry/block_pack_spec.cjs');
 var overview = require('./block_registry/overview.cjs');
 var registry_spec = require('./block_registry/registry_spec.cjs');
 var index = require('./pframe/internal_api/index.cjs');
+var json = require('./json.cjs');
 
 
 
@@ -93,4 +94,7 @@ exports.RegistrySpec = registry_spec.RegistrySpec;
 exports.RemoteRegistryV1Spec = registry_spec.RemoteRegistryV1Spec;
 exports.RemoteRegistryV2Spec = registry_spec.RemoteRegistryV2Spec;
 exports.PFrameInternal = index;
+exports.hashJson = json.hashJson;
+exports.readJson = json.readJson;
+exports.readJsonSync = json.readJsonSync;
 //# sourceMappingURL=index.cjs.map

package/dist/index.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"index.cjs","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;"}
+{"version":3,"file":"index.cjs","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;"}

package/dist/index.d.ts

@@ -8,4 +8,5 @@ export * from './update_info';
 export * from './block_meta';
 export * from './block_registry';
 export * from './pframe';
+export * from './json';
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,iBAAiB,CAAC;AAChC,cAAc,kBAAkB,CAAC;AACjC,cAAc,eAAe,CAAC;AAC9B,cAAc,WAAW,CAAC;AAC1B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,oBAAoB,CAAC;AACnC,cAAc,eAAe,CAAC;AAE9B,cAAc,cAAc,CAAC;AAC7B,cAAc,kBAAkB,CAAC;AACjC,cAAc,UAAU,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,iBAAiB,CAAC;AAChC,cAAc,kBAAkB,CAAC;AACjC,cAAc,eAAe,CAAC;AAC9B,cAAc,WAAW,CAAC;AAC1B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,oBAAoB,CAAC;AACnC,cAAc,eAAe,CAAC;AAE9B,cAAc,cAAc,CAAC;AAC7B,cAAc,kBAAkB,CAAC;AACjC,cAAc,UAAU,CAAC;AACzB,cAAc,QAAQ,CAAC"}

package/dist/index.js

@@ -12,4 +12,5 @@ export { AnyChannel, BlockPackListing, BlockPackOverview, BlockPackOverviewLegac
 export { LocalDevFolder, RegistryEntry, RegistryList, RegistrySpec, RemoteRegistryV1Spec, RemoteRegistryV2Spec } from './block_registry/registry_spec.js';
 import * as index from './pframe/internal_api/index.js';
 export { index as PFrameInternal };
+export { hashJson, readJson, readJsonSync } from './json.js';
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;;;;;"}
+{"version":3,"file":"index.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;;;;;;"}

package/dist/json.cjs

@@ -0,0 +1,24 @@
+'use strict';
+
+var plModelCommon = require('@milaboratories/pl-model-common');
+var node_crypto = require('node:crypto');
+var fs = require('node:fs');
+
+function hashJson(value) {
+    const hash = node_crypto.createHash('sha256');
+    hash.update(plModelCommon.canonicalizeJson(value));
+    return hash.digest().toString('hex');
+}
+async function readJson(filePath, signal) {
+    const content = await fs.promises.readFile(filePath, { encoding: 'utf8', signal });
+    return plModelCommon.parseJson(content);
+}
+function readJsonSync(filePath) {
+    const content = fs.readFileSync(filePath, { encoding: 'utf8' });
+    return plModelCommon.parseJson(content);
+}
+
+exports.hashJson = hashJson;
+exports.readJson = readJson;
+exports.readJsonSync = readJsonSync;
+//# sourceMappingURL=json.cjs.map

package/dist/json.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"json.cjs","sources":["../src/json.ts"],"sourcesContent":["import {\n  canonicalizeJson,\n  parseJson,\n  type JsonCompatible,\n  type JsonSerializable,\n  type StringifiedJson,\n} from '@milaboratories/pl-model-common';\nimport { createHash } from 'node:crypto';\nimport fs from 'node:fs';\n\nexport type HashedJson<T = unknown> = JsonCompatible<T> extends never ? never : string & {\n  __json_hashed: T;\n};\n\nexport function hashJson<T>(value: JsonCompatible<T>): HashedJson<T>;\nexport function hashJson<T extends JsonSerializable>(value: T): string;\nexport function hashJson(value: unknown): string {\n  const hash = createHash('sha256');\n  hash.update(canonicalizeJson(value));\n  return hash.digest().toString('hex');\n}\n\nexport async function readJson<T extends JsonSerializable>(filePath: string, signal?: AbortSignal): Promise<T> {\n  const content = await fs.promises.readFile(filePath, { encoding: 'utf8', signal });\n  return parseJson(content as StringifiedJson<T>);\n}\n\nexport function readJsonSync<T extends JsonSerializable>(filePath: string): T {\n  const content = fs.readFileSync(filePath, { encoding: 'utf8' });\n  return parseJson(content as StringifiedJson<T>);\n}\n"],"names":["createHash","canonicalizeJson","parseJson"],"mappings":";;;;;;AAgBM,SAAU,QAAQ,CAAC,KAAc,EAAA;AACrC,IAAA,MAAM,IAAI,GAAGA,sBAAU,CAAC,QAAQ,CAAC;IACjC,IAAI,CAAC,MAAM,CAACC,8BAAgB,CAAC,KAAK,CAAC,CAAC;IACpC,OAAO,IAAI,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,KAAK,CAAC;AACtC;AAEO,eAAe,QAAQ,CAA6B,QAAgB,EAAE,MAAoB,EAAA;AAC/F,IAAA,MAAM,OAAO,GAAG,MAAM,EAAE,CAAC,QAAQ,CAAC,QAAQ,CAAC,QAAQ,EAAE,EAAE,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,CAAC;AAClF,IAAA,OAAOC,uBAAS,CAAC,OAA6B,CAAC;AACjD;AAEM,SAAU,YAAY,CAA6B,QAAgB,EAAA;AACvE,IAAA,MAAM,OAAO,GAAG,EAAE,CAAC,YAAY,CAAC,QAAQ,EAAE,EAAE,QAAQ,EAAE,MAAM,EAAE,CAAC;AAC/D,IAAA,OAAOA,uBAAS,CAAC,OAA6B,CAAC;AACjD;;;;;;"}

package/dist/json.d.ts

@@ -0,0 +1,9 @@
+import { type JsonCompatible, type JsonSerializable } from '@milaboratories/pl-model-common';
+export type HashedJson<T = unknown> = JsonCompatible<T> extends never ? never : string & {
+    __json_hashed: T;
+};
+export declare function hashJson<T>(value: JsonCompatible<T>): HashedJson<T>;
+export declare function hashJson<T extends JsonSerializable>(value: T): string;
+export declare function readJson<T extends JsonSerializable>(filePath: string, signal?: AbortSignal): Promise<T>;
+export declare function readJsonSync<T extends JsonSerializable>(filePath: string): T;
+//# sourceMappingURL=json.d.ts.map

package/dist/json.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"json.d.ts","sourceRoot":"","sources":["../src/json.ts"],"names":[],"mappings":"AAAA,OAAO,EAGL,KAAK,cAAc,EACnB,KAAK,gBAAgB,EAEtB,MAAM,iCAAiC,CAAC;AAIzC,MAAM,MAAM,UAAU,CAAC,CAAC,GAAG,OAAO,IAAI,cAAc,CAAC,CAAC,CAAC,SAAS,KAAK,GAAG,KAAK,GAAG,MAAM,GAAG;IACvF,aAAa,EAAE,CAAC,CAAC;CAClB,CAAC;AAEF,wBAAgB,QAAQ,CAAC,CAAC,EAAE,KAAK,EAAE,cAAc,CAAC,CAAC,CAAC,GAAG,UAAU,CAAC,CAAC,CAAC,CAAC;AACrE,wBAAgB,QAAQ,CAAC,CAAC,SAAS,gBAAgB,EAAE,KAAK,EAAE,CAAC,GAAG,MAAM,CAAC;AAOvE,wBAAsB,QAAQ,CAAC,CAAC,SAAS,gBAAgB,EAAE,QAAQ,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,CAAC,CAAC,CAG7G;AAED,wBAAgB,YAAY,CAAC,CAAC,SAAS,gBAAgB,EAAE,QAAQ,EAAE,MAAM,GAAG,CAAC,CAG5E"}

package/dist/json.js

@@ -0,0 +1,20 @@
+import { canonicalizeJson, parseJson } from '@milaboratories/pl-model-common';
+import { createHash } from 'node:crypto';
+import fs from 'node:fs';
+
+function hashJson(value) {
+    const hash = createHash('sha256');
+    hash.update(canonicalizeJson(value));
+    return hash.digest().toString('hex');
+}
+async function readJson(filePath, signal) {
+    const content = await fs.promises.readFile(filePath, { encoding: 'utf8', signal });
+    return parseJson(content);
+}
+function readJsonSync(filePath) {
+    const content = fs.readFileSync(filePath, { encoding: 'utf8' });
+    return parseJson(content);
+}
+
+export { hashJson, readJson, readJsonSync };
+//# sourceMappingURL=json.js.map

package/dist/json.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"json.js","sources":["../src/json.ts"],"sourcesContent":["import {\n  canonicalizeJson,\n  parseJson,\n  type JsonCompatible,\n  type JsonSerializable,\n  type StringifiedJson,\n} from '@milaboratories/pl-model-common';\nimport { createHash } from 'node:crypto';\nimport fs from 'node:fs';\n\nexport type HashedJson<T = unknown> = JsonCompatible<T> extends never ? never : string & {\n  __json_hashed: T;\n};\n\nexport function hashJson<T>(value: JsonCompatible<T>): HashedJson<T>;\nexport function hashJson<T extends JsonSerializable>(value: T): string;\nexport function hashJson(value: unknown): string {\n  const hash = createHash('sha256');\n  hash.update(canonicalizeJson(value));\n  return hash.digest().toString('hex');\n}\n\nexport async function readJson<T extends JsonSerializable>(filePath: string, signal?: AbortSignal): Promise<T> {\n  const content = await fs.promises.readFile(filePath, { encoding: 'utf8', signal });\n  return parseJson(content as StringifiedJson<T>);\n}\n\nexport function readJsonSync<T extends JsonSerializable>(filePath: string): T {\n  const content = fs.readFileSync(filePath, { encoding: 'utf8' });\n  return parseJson(content as StringifiedJson<T>);\n}\n"],"names":[],"mappings":";;;;AAgBM,SAAU,QAAQ,CAAC,KAAc,EAAA;AACrC,IAAA,MAAM,IAAI,GAAG,UAAU,CAAC,QAAQ,CAAC;IACjC,IAAI,CAAC,MAAM,CAAC,gBAAgB,CAAC,KAAK,CAAC,CAAC;IACpC,OAAO,IAAI,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,KAAK,CAAC;AACtC;AAEO,eAAe,QAAQ,CAA6B,QAAgB,EAAE,MAAoB,EAAA;AAC/F,IAAA,MAAM,OAAO,GAAG,MAAM,EAAE,CAAC,QAAQ,CAAC,QAAQ,CAAC,QAAQ,EAAE,EAAE,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,CAAC;AAClF,IAAA,OAAO,SAAS,CAAC,OAA6B,CAAC;AACjD;AAEM,SAAU,YAAY,CAA6B,QAAgB,EAAA;AACvE,IAAA,MAAM,OAAO,GAAG,EAAE,CAAC,YAAY,CAAC,QAAQ,EAAE,EAAE,QAAQ,EAAE,MAAM,EAAE,CAAC;AAC/D,IAAA,OAAO,SAAS,CAAC,OAA6B,CAAC;AACjD;;;;"}

package/dist/pframe/internal_api/api_factory.cjs

@@ -0,0 +1,10 @@
+'use strict';
+
+/** PColumn spec file extension */
+const SpecExtension = '.spec';
+/** PColumn data info file extension */
+const DataInfoExtension = '.datainfo';
+
+exports.DataInfoExtension = DataInfoExtension;
+exports.SpecExtension = SpecExtension;
+//# sourceMappingURL=api_factory.cjs.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"api_factory.cjs","sources":["../../../src/pframe/internal_api/api_factory.ts"],"sourcesContent":["import {\n  BinaryPartitionedDataInfo,\n  Branded,\n  JsonDataInfo,\n  JsonPartitionedDataInfo,\n  ParquetChunk,\n  ParquetPartitionedDataInfo,\n  PColumnSpec,\n  PObjectId,\n} from '@milaboratories/pl-model-common';\nimport {\n  HttpHelpers,\n  HttpServerInfo,\n} from './http_helpers';\n\n/** PColumn spec file extension */\nexport const SpecExtension = '.spec' as const;\n\n/** PColumn data info file extension */\nexport const DataInfoExtension = '.datainfo' as const;\n\n/** Abstract identifier of a data blob that can be requested from the storage backend */\nexport type PFrameBlobId = Branded<string, 'PFrameInternal.PFrameBlobId'>;\n\n/** Path of the file containing requested data (blob). This path is returned by\n * {@link BlobPathResolver} as soon as blob materialized in the file system. */\nexport type FilePath = string;\n\n/** Data source allows PFrame to retrieve the data blobs for columns with assigned data info. */\nexport interface PFrameDataSourceV2 {\n  /**\n   * PFrame may notify storage backend about its plans to use particular blobs in the future.\n   * Storage backend will do its best to preload specified blob so the subsequent\n   * {@link resolveBlob} will quickly return preloaded file path.\n   */\n  preloadBlob(blobIds: PFrameBlobId[]): Promise<void>;\n\n  /** Returns raw blob data given the blob id from {@link DataInfo}. */\n  resolveBlobContent(blobId: PFrameBlobId): Promise<Uint8Array>;\n\n  /**\n   * Parquet HTTP(S) server connection settings, {@link HttpHelpers.createHttpServer}\n   * When not provided, parquet BlobIds would be treated as local file paths.\n   */\n  parquetServer?: HttpServerInfo;\n}\n\n/**\n * Union type representing all possible data storage formats for PColumn data.\n * The specific format used depends on data size, access patterns, and performance requirements.\n *\n * @template Blob - Type parameter representing the storage reference type (could be ResourceInfo, PFrameBlobId, etc.)\n */\nexport type DataInfo<Blob> =\n  | JsonDataInfo\n  | JsonPartitionedDataInfo<Blob>\n  | BinaryPartitionedDataInfo<Blob>\n  | ParquetPartitionedDataInfo<ParquetChunk<Blob>>;\n\n/** API exposed by PFrames library allowing to create and provide data for\n * PFrame objects */\nexport interface PFrameFactoryAPIV4 extends Disposable {\n  /** Associates data source with this PFrame */\n  setDataSource(dataSource: PFrameDataSourceV2): void;\n\n  /** Adds PColumn without data info */\n  addColumnSpec(columnId: PObjectId, columnSpec: PColumnSpec): void;\n\n  /**\n   * Assign data info to the specified PColumn.\n   * For parquet data info, schema resolution via network is performed during this call.\n   */\n  setColumnData(\n    columnId: PObjectId,\n    dataInfo: DataInfo<PFrameBlobId>,\n    options?: {\n      signal?: AbortSignal,\n    }\n  ): Promise<void>;\n\n  /** Releases all the data previously added to PFrame using methods above,\n   * any interactions with disposed PFrame will result in exception */\n  dispose(): void;\n}\n"],"names":[],"mappings":";;AAeA;AACO,MAAM,aAAa,GAAG;AAE7B;AACO,MAAM,iBAAiB,GAAG;;;;;"}

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

@@ -1,7 +1,11 @@
-import { BinaryPartitionedDataInfo, JsonDataInfo, JsonPartitionedDataInfo, ParquetChunk, ParquetPartitionedDataInfo, PColumnSpec, PObjectId } from '@milaboratories/pl-model-common';
+import { BinaryPartitionedDataInfo, Branded, JsonDataInfo, JsonPartitionedDataInfo, ParquetChunk, ParquetPartitionedDataInfo, PColumnSpec, PObjectId } from '@milaboratories/pl-model-common';
 import { HttpServerInfo } from './http_helpers';
+/** PColumn spec file extension */
+export declare const SpecExtension: ".spec";
+/** PColumn data info file extension */
+export declare const DataInfoExtension: ".datainfo";
 /** Abstract identifier of a data blob that can be requested from the storage backend */
-export type PFrameBlobId = string;
+export type PFrameBlobId = Branded<string, 'PFrameInternal.PFrameBlobId'>;
 /** Path of the file containing requested data (blob). This path is returned by
  * {@link BlobPathResolver} as soon as blob materialized in the file system. */
 export type FilePath = string;

package/dist/pframe/internal_api/api_factory.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"api_factory.d.ts","sourceRoot":"","sources":["../../../src/pframe/internal_api/api_factory.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,yBAAyB,EACzB,YAAY,EACZ,uBAAuB,EACvB,YAAY,EACZ,0BAA0B,EAC1B,WAAW,EACX,SAAS,EACV,MAAM,iCAAiC,CAAC;AACzC,OAAO,EAEL,cAAc,EACf,MAAM,gBAAgB,CAAC;AAExB,wFAAwF;AACxF,MAAM,MAAM,YAAY,GAAG,MAAM,CAAC;AAGlC;+EAC+E;AAC/E,MAAM,MAAM,QAAQ,GAAG,MAAM,CAAC;AAE9B,gGAAgG;AAChG,MAAM,WAAW,kBAAkB;IACjC;;;;OAIG;IACH,WAAW,CAAC,OAAO,EAAE,YAAY,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEpD,qEAAqE;IACrE,kBAAkB,CAAC,MAAM,EAAE,YAAY,GAAG,OAAO,CAAC,UAAU,CAAC,CAAC;IAE9D;;;OAGG;IACH,aAAa,CAAC,EAAE,cAAc,CAAC;CAChC;AAED;;;;;GAKG;AACH,MAAM,MAAM,QAAQ,CAAC,IAAI,IACrB,YAAY,GACZ,uBAAuB,CAAC,IAAI,CAAC,GAC7B,yBAAyB,CAAC,IAAI,CAAC,GAC/B,0BAA0B,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC,CAAC;AAEnD;oBACoB;AACpB,MAAM,WAAW,kBAAmB,SAAQ,UAAU;IACpD,8CAA8C;IAC9C,aAAa,CAAC,UAAU,EAAE,kBAAkB,GAAG,IAAI,CAAC;IAEpD,qCAAqC;IACrC,aAAa,CAAC,QAAQ,EAAE,SAAS,EAAE,UAAU,EAAE,WAAW,GAAG,IAAI,CAAC;IAElE;;;OAGG;IACH,aAAa,CACX,QAAQ,EAAE,SAAS,EACnB,QAAQ,EAAE,QAAQ,CAAC,YAAY,CAAC,EAChC,OAAO,CAAC,EAAE;QACR,MAAM,CAAC,EAAE,WAAW,CAAC;KACtB,GACA,OAAO,CAAC,IAAI,CAAC,CAAC;IAEjB;wEACoE;IACpE,OAAO,IAAI,IAAI,CAAC;CACjB"}
+{"version":3,"file":"api_factory.d.ts","sourceRoot":"","sources":["../../../src/pframe/internal_api/api_factory.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,yBAAyB,EACzB,OAAO,EACP,YAAY,EACZ,uBAAuB,EACvB,YAAY,EACZ,0BAA0B,EAC1B,WAAW,EACX,SAAS,EACV,MAAM,iCAAiC,CAAC;AACzC,OAAO,EAEL,cAAc,EACf,MAAM,gBAAgB,CAAC;AAExB,kCAAkC;AAClC,eAAO,MAAM,aAAa,SAAmB,CAAC;AAE9C,uCAAuC;AACvC,eAAO,MAAM,iBAAiB,aAAuB,CAAC;AAEtD,wFAAwF;AACxF,MAAM,MAAM,YAAY,GAAG,OAAO,CAAC,MAAM,EAAE,6BAA6B,CAAC,CAAC;AAE1E;+EAC+E;AAC/E,MAAM,MAAM,QAAQ,GAAG,MAAM,CAAC;AAE9B,gGAAgG;AAChG,MAAM,WAAW,kBAAkB;IACjC;;;;OAIG;IACH,WAAW,CAAC,OAAO,EAAE,YAAY,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEpD,qEAAqE;IACrE,kBAAkB,CAAC,MAAM,EAAE,YAAY,GAAG,OAAO,CAAC,UAAU,CAAC,CAAC;IAE9D;;;OAGG;IACH,aAAa,CAAC,EAAE,cAAc,CAAC;CAChC;AAED;;;;;GAKG;AACH,MAAM,MAAM,QAAQ,CAAC,IAAI,IACrB,YAAY,GACZ,uBAAuB,CAAC,IAAI,CAAC,GAC7B,yBAAyB,CAAC,IAAI,CAAC,GAC/B,0BAA0B,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC,CAAC;AAEnD;oBACoB;AACpB,MAAM,WAAW,kBAAmB,SAAQ,UAAU;IACpD,8CAA8C;IAC9C,aAAa,CAAC,UAAU,EAAE,kBAAkB,GAAG,IAAI,CAAC;IAEpD,qCAAqC;IACrC,aAAa,CAAC,QAAQ,EAAE,SAAS,EAAE,UAAU,EAAE,WAAW,GAAG,IAAI,CAAC;IAElE;;;OAGG;IACH,aAAa,CACX,QAAQ,EAAE,SAAS,EACnB,QAAQ,EAAE,QAAQ,CAAC,YAAY,CAAC,EAChC,OAAO,CAAC,EAAE;QACR,MAAM,CAAC,EAAE,WAAW,CAAC;KACtB,GACA,OAAO,CAAC,IAAI,CAAC,CAAC;IAEjB;wEACoE;IACpE,OAAO,IAAI,IAAI,CAAC;CACjB"}

package/dist/pframe/internal_api/api_factory.js

@@ -0,0 +1,7 @@
+/** PColumn spec file extension */
+const SpecExtension = '.spec';
+/** PColumn data info file extension */
+const DataInfoExtension = '.datainfo';
+
+export { DataInfoExtension, SpecExtension };
+//# sourceMappingURL=api_factory.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"api_factory.js","sources":["../../../src/pframe/internal_api/api_factory.ts"],"sourcesContent":["import {\n  BinaryPartitionedDataInfo,\n  Branded,\n  JsonDataInfo,\n  JsonPartitionedDataInfo,\n  ParquetChunk,\n  ParquetPartitionedDataInfo,\n  PColumnSpec,\n  PObjectId,\n} from '@milaboratories/pl-model-common';\nimport {\n  HttpHelpers,\n  HttpServerInfo,\n} from './http_helpers';\n\n/** PColumn spec file extension */\nexport const SpecExtension = '.spec' as const;\n\n/** PColumn data info file extension */\nexport const DataInfoExtension = '.datainfo' as const;\n\n/** Abstract identifier of a data blob that can be requested from the storage backend */\nexport type PFrameBlobId = Branded<string, 'PFrameInternal.PFrameBlobId'>;\n\n/** Path of the file containing requested data (blob). This path is returned by\n * {@link BlobPathResolver} as soon as blob materialized in the file system. */\nexport type FilePath = string;\n\n/** Data source allows PFrame to retrieve the data blobs for columns with assigned data info. */\nexport interface PFrameDataSourceV2 {\n  /**\n   * PFrame may notify storage backend about its plans to use particular blobs in the future.\n   * Storage backend will do its best to preload specified blob so the subsequent\n   * {@link resolveBlob} will quickly return preloaded file path.\n   */\n  preloadBlob(blobIds: PFrameBlobId[]): Promise<void>;\n\n  /** Returns raw blob data given the blob id from {@link DataInfo}. */\n  resolveBlobContent(blobId: PFrameBlobId): Promise<Uint8Array>;\n\n  /**\n   * Parquet HTTP(S) server connection settings, {@link HttpHelpers.createHttpServer}\n   * When not provided, parquet BlobIds would be treated as local file paths.\n   */\n  parquetServer?: HttpServerInfo;\n}\n\n/**\n * Union type representing all possible data storage formats for PColumn data.\n * The specific format used depends on data size, access patterns, and performance requirements.\n *\n * @template Blob - Type parameter representing the storage reference type (could be ResourceInfo, PFrameBlobId, etc.)\n */\nexport type DataInfo<Blob> =\n  | JsonDataInfo\n  | JsonPartitionedDataInfo<Blob>\n  | BinaryPartitionedDataInfo<Blob>\n  | ParquetPartitionedDataInfo<ParquetChunk<Blob>>;\n\n/** API exposed by PFrames library allowing to create and provide data for\n * PFrame objects */\nexport interface PFrameFactoryAPIV4 extends Disposable {\n  /** Associates data source with this PFrame */\n  setDataSource(dataSource: PFrameDataSourceV2): void;\n\n  /** Adds PColumn without data info */\n  addColumnSpec(columnId: PObjectId, columnSpec: PColumnSpec): void;\n\n  /**\n   * Assign data info to the specified PColumn.\n   * For parquet data info, schema resolution via network is performed during this call.\n   */\n  setColumnData(\n    columnId: PObjectId,\n    dataInfo: DataInfo<PFrameBlobId>,\n    options?: {\n      signal?: AbortSignal,\n    }\n  ): Promise<void>;\n\n  /** Releases all the data previously added to PFrame using methods above,\n   * any interactions with disposed PFrame will result in exception */\n  dispose(): void;\n}\n"],"names":[],"mappings":"AAeA;AACO,MAAM,aAAa,GAAG;AAE7B;AACO,MAAM,iBAAiB,GAAG;;;;"}

package/dist/pframe/internal_api/index.cjs

@@ -1,9 +1,12 @@
 'use strict';
 
+var api_factory = require('./api_factory.cjs');
 var http_helpers = require('./http_helpers.cjs');
 
 
 
+exports.DataInfoExtension = api_factory.DataInfoExtension;
+exports.SpecExtension = api_factory.SpecExtension;
 exports.BaseObjectStore = http_helpers.BaseObjectStore;
 exports.ParquetExtension = http_helpers.ParquetExtension;
 //# 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","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;;"}

package/dist/pframe/internal_api/index.js

@@ -1,2 +1,3 @@
+export { DataInfoExtension, SpecExtension } from './api_factory.js';
 export { BaseObjectStore, ParquetExtension } from './http_helpers.js';
 //# sourceMappingURL=index.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"index.js","sources":[],"sourcesContent":[],"names":[],"mappings":""}
+{"version":3,"file":"index.js","sources":[],"sourcesContent":[],"names":[],"mappings":";"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@milaboratories/pl-model-middle-layer",
-  "version": "1.8.37",
+  "version": "1.8.39",
   "description": "Common model between middle layer and non-block UI code",
   "type": "module",
   "types": "./dist/index.d.ts",
@@ -24,9 +24,10 @@
   },
   "devDependencies": {
     "typescript": "~5.6.3",
+    "@types/node": "~24.5.2",
+    "@milaboratories/build-configs": "1.0.8",
     "@milaboratories/ts-builder": "1.0.5",
-    "@milaboratories/ts-configs": "1.0.6",
-    "@milaboratories/build-configs": "1.0.8"
+    "@milaboratories/ts-configs": "1.0.6"
   },
   "scripts": {
     "type-check": "ts-builder types --target node",

package/src/index.ts

@@ -9,3 +9,4 @@ export * from './update_info';
 export * from './block_meta';
 export * from './block_registry';
 export * from './pframe';
+export * from './json';

package/src/json.ts

@@ -0,0 +1,31 @@
+import {
+  canonicalizeJson,
+  parseJson,
+  type JsonCompatible,
+  type JsonSerializable,
+  type StringifiedJson,
+} from '@milaboratories/pl-model-common';
+import { createHash } from 'node:crypto';
+import fs from 'node:fs';
+
+export type HashedJson<T = unknown> = JsonCompatible<T> extends never ? never : string & {
+  __json_hashed: T;
+};
+
+export function hashJson<T>(value: JsonCompatible<T>): HashedJson<T>;
+export function hashJson<T extends JsonSerializable>(value: T): string;
+export function hashJson(value: unknown): string {
+  const hash = createHash('sha256');
+  hash.update(canonicalizeJson(value));
+  return hash.digest().toString('hex');
+}
+
+export async function readJson<T extends JsonSerializable>(filePath: string, signal?: AbortSignal): Promise<T> {
+  const content = await fs.promises.readFile(filePath, { encoding: 'utf8', signal });
+  return parseJson(content as StringifiedJson<T>);
+}
+
+export function readJsonSync<T extends JsonSerializable>(filePath: string): T {
+  const content = fs.readFileSync(filePath, { encoding: 'utf8' });
+  return parseJson(content as StringifiedJson<T>);
+}

package/src/pframe/internal_api/api_factory.ts

@@ -1,5 +1,6 @@
 import {
   BinaryPartitionedDataInfo,
+  Branded,
   JsonDataInfo,
   JsonPartitionedDataInfo,
   ParquetChunk,
@@ -12,9 +13,14 @@ import {
   HttpServerInfo,
 } from './http_helpers';
 
-/** Abstract identifier of a data blob that can be requested from the storage backend */
-export type PFrameBlobId = string;
+/** PColumn spec file extension */
+export const SpecExtension = '.spec' as const;
+
+/** PColumn data info file extension */
+export const DataInfoExtension = '.datainfo' as const;
 
+/** Abstract identifier of a data blob that can be requested from the storage backend */
+export type PFrameBlobId = Branded<string, 'PFrameInternal.PFrameBlobId'>;
 
 /** Path of the file containing requested data (blob). This path is returned by
  * {@link BlobPathResolver} as soon as blob materialized in the file system. */