@milaboratories/pl-model-common 1.13.6 → 1.13.8

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@milaboratories/pl-model-common",
-  "version": "1.13.6",
+  "version": "1.13.8",
   "description": "Platforma SDK Model",
   "types": "./dist/index.d.ts",
   "main": "./dist/index.js",
@@ -19,15 +19,15 @@
   "dependencies": {
     "zod": "~3.23.8",
     "canonicalize": "~2.1.0",
-    "@milaboratories/pl-error-like": "1.12.0"
+    "@milaboratories/pl-error-like": "1.12.1"
   },
   "devDependencies": {
     "eslint": "^9.23.0",
     "typescript": "~5.5.4",
     "vite": "^5.4.11",
     "vitest": "^2.1.8",
-    "@platforma-sdk/eslint-config": "1.0.3",
-    "@milaboratories/platforma-build-configs": "1.0.3"
+    "@milaboratories/platforma-build-configs": "1.0.3",
+    "@platforma-sdk/eslint-config": "1.0.3"
   },
   "scripts": {
     "type-check": "tsc --noEmit --composite false",

package/src/drivers/pframe/spec/spec.ts

@@ -104,6 +104,40 @@ export interface PDataColumnSpec extends PUniversalColumnSpec {
 // @todo: change this to PUniversalColumnSpec
 export type PColumnSpec = PDataColumnSpec;
 
+/** Unique PColumnSpec identifier */
+export type PColumnSpecId = {
+  /** Defines specific type of BObject, the most generic type of unit of
+   * information in Platforma Project. */
+  readonly kind: 'PColumn';
+
+  /** Type of column values */
+  readonly valueType: ValueType;
+
+  /** Column name */
+  readonly name: string;
+
+  /** Adds auxiliary information to the axis name, type and parents to form a
+   * unique identifier */
+  readonly domain?: Record<string, string>;
+
+  /** A list of zero-based indices of parent axes from the {@link axesSpec} array. */
+  readonly parentAxes?: number[];
+
+  /** Axes id */
+  readonly axesId: AxesId;
+};
+
+export function getPColumnSpecId(spec: PColumnSpec): PColumnSpecId {
+  return {
+    kind: spec.kind,
+    valueType: spec.valueType,
+    name: spec.name,
+    domain: spec.domain,
+    parentAxes: spec.parentAxes,
+    axesId: getAxesId(spec.axesSpec),
+  };
+}
+
 export interface PColumn<Data> extends PObject<Data> {
   /** PColumn spec, allowing it to be found among other PObjects */
   readonly spec: PColumnSpec;

package/src/index.ts

@@ -9,3 +9,4 @@ export * from './common_types';
 export * from './pool';
 export * from './value_or_error';
 export * from './plid';
+export * from './json';

package/src/json.ts

@@ -0,0 +1,37 @@
+import canonicalize from 'canonicalize';
+
+type JsonPrimitive = string | number | boolean | null | undefined;
+
+type JsonValue = JsonPrimitive | JsonValue[] | {
+  [key: string]: JsonValue;
+};
+
+// eslint-disable-next-line @typescript-eslint/no-unsafe-function-type
+type NotAssignableToJson = bigint | symbol | Function;
+
+type JsonCompatible<T> = unknown extends T ? never : {
+  [P in keyof T]:
+  T[P] extends JsonValue ? T[P] :
+    T[P] extends NotAssignableToJson ? never :
+      JsonCompatible<T[P]>;
+};
+
+export type StringifiedJson<T> = JsonCompatible<T> extends never ? never : string & {
+  __json_stringified: T;
+};
+
+export function stringifyJson<T>(value: JsonCompatible<T>): StringifiedJson<T> {
+  return JSON.stringify(value)! as StringifiedJson<T>;
+}
+
+export type CanonicalizedJson<T> = JsonCompatible<T> extends never ? never : string & {
+  __json_canonicalized: T;
+};
+
+export function canonicalizeJson<T>(value: JsonCompatible<T>): CanonicalizedJson<T> {
+  return canonicalize(value)! as CanonicalizedJson<T>;
+}
+
+export function parseJson<T>(value: StringifiedJson<T> | CanonicalizedJson<T>): T {
+  return JSON.parse(value) as T;
+}