@xapi-js/core 1.5.0 → 1.6.0

package/dist/index.cjs

@@ -1152,7 +1152,12 @@ function encodeRoot(schema, value) {
 		const rows = value.datasets[datasetId];
 		for (const row of rows) {
 			const rowIndex = dataset.newRow();
+			dataset.rows[rowIndex].type = row.$rowType;
 			for (const id of Object.keys(datasetSchema.columns)) dataset.setColumn(rowIndex, id, row[id]);
+			if (row.$orgRow) dataset.rows[rowIndex].orgRow = Object.entries(row.$orgRow).map(([id, value]) => ({
+				id,
+				value
+			}));
 		}
 		root.addDataset(dataset);
 	}
@@ -1175,6 +1180,8 @@ function decodeRoot(schema, root) {
 		datasets[datasetId] = dataset.getRows().map((row) => {
 			const value = { ...constants };
 			for (const column of row.cols) if (column.id in datasetSchema.columns) value[column.id] = column.value;
+			if (row.type) value.$rowType = row.type;
+			if (row.orgRow) value.$orgRow = Object.fromEntries(row.orgRow.map((column) => [column.id, column.value]));
 			return value;
 		});
 	}
@@ -1184,6 +1191,130 @@ function decodeRoot(schema, root) {
 	};
 }
 //#endregion
+//#region src/codec.ts
+const rowTypes = {
+	N: void 0,
+	I: "insert",
+	U: "update",
+	D: "delete",
+	O: void 0
+};
+function sizeOf(size, type) {
+	if (size !== void 0) return Number(size);
+	return type === "STRING" ? 255 : 0;
+}
+function jsonValue(value, type) {
+	if (value === null || value === void 0) return void 0;
+	if (type === "DATE" || type === "DATETIME" || type === "TIME") return typeof value === "string" ? convertToColumnType(value, type) : value;
+	if (type === "BLOB" && typeof value === "string") return convertToColumnType(value, type);
+	return value;
+}
+function jsonWireValue(value, type) {
+	if (value === void 0) return void 0;
+	if (value instanceof Date) return dateToString(value, type);
+	if (value instanceof Uint8Array) return uint8ArrayToBase64(value);
+	return value;
+}
+function columnsToObject(columns) {
+	return Object.fromEntries(columns.map((column) => [column.id, column.value]));
+}
+function readRow(dataset, row) {
+	const rowType = rowTypes[row._RowType_ ?? "N"];
+	if (row._RowType_ === "O") {
+		const previous = dataset.rows[dataset.rows.length - 1];
+		if (previous?.type !== "update") return;
+		previous.orgRow = dataset.getColumns().filter((column) => Object.prototype.hasOwnProperty.call(row, column.id)).map((column) => ({
+			id: column.id,
+			value: jsonValue(row[column.id], column.type)
+		}));
+		return;
+	}
+	const index = dataset.newRow();
+	dataset.rows[index].type = rowType;
+	for (const column of dataset.getColumns()) if (Object.prototype.hasOwnProperty.call(row, column.id)) dataset.rows[index].cols.push({
+		id: column.id,
+		value: jsonValue(row[column.id], column.type)
+	});
+}
+function readJson(value) {
+	const root = new XapiRoot();
+	for (const parameter of value.Parameters ?? []) root.addParameter({
+		id: parameter.id,
+		type: parameter.type,
+		value: jsonValue(parameter.value, parameter.type)
+	});
+	for (const source of value.Datasets ?? []) {
+		const dataset = new Dataset(source.id);
+		for (const column of source.ColumnInfo.ConstColumn ?? []) {
+			const type = column.type ?? "STRING";
+			dataset.addConstColumn({
+				id: column.id,
+				type,
+				size: sizeOf(column.size, type),
+				value: jsonValue(column.value, type)
+			});
+		}
+		for (const column of source.ColumnInfo.Column) {
+			const type = column.type ?? "STRING";
+			dataset.addColumn({
+				id: column.id,
+				type,
+				size: sizeOf(column.size, type)
+			});
+		}
+		for (const row of source.Rows) readRow(dataset, row);
+		root.addDataset(dataset);
+	}
+	return root;
+}
+function writeJson(root) {
+	return {
+		version: "1.0",
+		...root.parameterSize() ? { Parameters: root.getParameters().map((parameter) => ({
+			id: parameter.id,
+			...parameter.type ? { type: parameter.type } : {},
+			...parameter.value !== void 0 ? { value: jsonWireValue(parameter.value, parameter.type ?? "STRING") } : {}
+		})) } : {},
+		...root.datasetSize() ? { Datasets: root.getDatasets().map((dataset) => ({
+			id: dataset.id,
+			ColumnInfo: {
+				...dataset.constColumnSize() ? { ConstColumn: dataset.getConstColumns().map((column) => ({
+					id: column.id,
+					type: column.type,
+					size: column.size,
+					value: jsonWireValue(column.value, column.type)
+				})) } : {},
+				Column: dataset.getColumns().map((column) => ({
+					id: column.id,
+					type: column.type,
+					size: column.size
+				}))
+			},
+			Rows: dataset.getRows().flatMap((row) => {
+				const current = {
+					_RowType_: row.type === "insert" ? "I" : row.type === "update" ? "U" : row.type === "delete" ? "D" : "N",
+					...columnsToObject(row.cols)
+				};
+				if (!row.orgRow) return [current];
+				return [current, {
+					_RowType_: "O",
+					...columnsToObject(row.orgRow)
+				}];
+			})
+		})) } : {}
+	};
+}
+const nexacroJsonCodec = {
+	serialize: writeJson,
+	deserialize: readJson
+};
+function parseJson(value) {
+	return nexacroJsonCodec.deserialize(JSON.parse(value));
+}
+function writeJsonString(root) {
+	return JSON.stringify(nexacroJsonCodec.serialize(root));
+}
+//#endregion
 exports.ColumnTypeError = ColumnTypeError;
 exports.Dataset = Dataset;
 exports.InvalidXmlError = InvalidXmlError;
@@ -1209,11 +1340,14 @@ exports.escapeXml = escapeXml;
 exports.initXapi = initXapi;
 exports.isXapiRoot = isXapiRoot;
 exports.makeParseEntities = makeParseEntities;
+exports.nexacroJsonCodec = nexacroJsonCodec;
 exports.parse = parse;
+exports.parseJson = parseJson;
 exports.parseXml = parseXml;
 exports.rowType = rowType;
 exports.stringToDate = stringToDate;
 exports.stringToReadableStream = stringToReadableStream;
 exports.uint8ArrayToBase64 = uint8ArrayToBase64;
 exports.write = write;
+exports.writeJsonString = writeJsonString;
 exports.xapi = xapi;

package/dist/index.d.cts

@@ -506,7 +506,15 @@ interface XapiOperation<Request extends XapiRootSchema = XapiRootSchema, Respons
 type RequiredColumnKeys<Columns extends XapiColumns> = { [Key in keyof Columns]-?: Columns[Key]["optional"] extends true ? never : Key; }[keyof Columns];
 type OptionalColumnKeys<Columns extends XapiColumns> = { [Key in keyof Columns]-?: Columns[Key]["optional"] extends true ? Key : never; }[keyof Columns];
 type InferColumns<Columns extends XapiColumns> = { [Key in RequiredColumnKeys<Columns>]: XapiTypeMap[Columns[Key]["type"]]; } & { [Key in OptionalColumnKeys<Columns>]?: XapiTypeMap[Columns[Key]["type"]]; };
-type InferDataset<Schema extends XapiDatasetSchema> = InferColumns<Schema["columns"]>[];
+/**
+ * A schema row remains assignable from the old plain object shape, while
+ * retaining the Nexacro row metadata when an operation needs it.
+ */
+type InferDatasetRow<Schema extends XapiDatasetSchema> = InferColumns<Schema["columns"]> & {
+  $rowType?: RowType;
+  $orgRow?: Partial<InferColumns<Schema["columns"]>>;
+};
+type InferDataset<Schema extends XapiDatasetSchema> = InferDatasetRow<Schema>[];
 type InferRoot<Schema extends XapiRootSchema> = {
   parameters: InferColumns<Schema["parameters"]>;
   datasets: { [Key in keyof Schema["datasets"]]: InferDataset<Schema["datasets"][Key]>; };
@@ -543,4 +551,43 @@ declare const xapi: {
 declare function encodeRoot<Schema extends XapiRootSchema>(schema: Schema, value: InferRoot<Schema>): XapiRoot;
 declare function decodeRoot<Schema extends XapiRootSchema>(schema: Schema, root: XapiRoot): InferRoot<Schema>;
 //#endregion
-export { Col, Column, ColumnInfo, ColumnType, ColumnTypeError, ConstColumn, Dataset, InferColumns, InferDataset, InferRoot, InvalidXmlError, NexaVersion, Parameter, RequestOf, ResponseOf, Row, RowType, Rows, StringWritableStream, XapiColumnSchema, XapiColumns, XapiDatasetSchema, XapiDatasets, XapiOperation, XapiOptions, XapiParameters, XapiRoot, XapiRootSchema, XapiTypeMap, XapiValueType, XapiVersion, XmlNode, XmlStringBuilder, XplatformVersion, _unescapeXml, arrayBufferToString, base64ToUint8Array, columnType, convertToColumnType, convertToString, dateToString, decodeRoot, defineDataset, defineOperation, defineRoot, encodeControlChars, encodeRoot, escapeXml, initXapi, isXapiRoot, makeParseEntities, parse, parseXml, rowType, stringToDate, stringToReadableStream, uint8ArrayToBase64, write, xapi };
+//#region src/codec.d.ts
+/** The wire representation used by Nexacro's Dataset JSON format. */
+interface NexacroJsonParameter {
+  id: string;
+  type?: ColumnType;
+  value?: string | number;
+}
+interface NexacroJsonColumn {
+  id: string;
+  type?: ColumnType;
+  size?: number | string;
+  value?: string | number;
+}
+interface NexacroJsonRow {
+  _RowType_?: "N" | "I" | "U" | "D" | "O";
+  [columnId: string]: unknown;
+}
+interface NexacroJsonDataset {
+  id: string;
+  ColumnInfo: {
+    ConstColumn?: NexacroJsonColumn[];
+    Column: NexacroJsonColumn[];
+  };
+  Rows: NexacroJsonRow[];
+}
+interface NexacroJsonRoot {
+  version: "1.0";
+  Parameters?: NexacroJsonParameter[];
+  Datasets?: NexacroJsonDataset[];
+}
+/** A serializer boundary around the X-API internal model. */
+interface XapiCodec<Serialized> {
+  serialize(root: XapiRoot): Serialized;
+  deserialize(value: Serialized): XapiRoot;
+}
+declare const nexacroJsonCodec: XapiCodec<NexacroJsonRoot>;
+declare function parseJson(value: string): XapiRoot;
+declare function writeJsonString(root: XapiRoot): string;
+//#endregion
+export { Col, Column, ColumnInfo, ColumnType, ColumnTypeError, ConstColumn, Dataset, InferColumns, InferDataset, InferDatasetRow, InferRoot, InvalidXmlError, NexaVersion, NexacroJsonColumn, NexacroJsonDataset, NexacroJsonParameter, NexacroJsonRoot, NexacroJsonRow, Parameter, RequestOf, ResponseOf, Row, RowType, Rows, StringWritableStream, XapiCodec, XapiColumnSchema, XapiColumns, XapiDatasetSchema, XapiDatasets, XapiOperation, XapiOptions, XapiParameters, XapiRoot, XapiRootSchema, XapiTypeMap, XapiValueType, XapiVersion, XmlNode, XmlStringBuilder, XplatformVersion, _unescapeXml, arrayBufferToString, base64ToUint8Array, columnType, convertToColumnType, convertToString, dateToString, decodeRoot, defineDataset, defineOperation, defineRoot, encodeControlChars, encodeRoot, escapeXml, initXapi, isXapiRoot, makeParseEntities, nexacroJsonCodec, parse, parseJson, parseXml, rowType, stringToDate, stringToReadableStream, uint8ArrayToBase64, write, writeJsonString, xapi };

package/dist/index.d.ts

@@ -506,7 +506,15 @@ interface XapiOperation<Request extends XapiRootSchema = XapiRootSchema, Respons
 type RequiredColumnKeys<Columns extends XapiColumns> = { [Key in keyof Columns]-?: Columns[Key]["optional"] extends true ? never : Key; }[keyof Columns];
 type OptionalColumnKeys<Columns extends XapiColumns> = { [Key in keyof Columns]-?: Columns[Key]["optional"] extends true ? Key : never; }[keyof Columns];
 type InferColumns<Columns extends XapiColumns> = { [Key in RequiredColumnKeys<Columns>]: XapiTypeMap[Columns[Key]["type"]]; } & { [Key in OptionalColumnKeys<Columns>]?: XapiTypeMap[Columns[Key]["type"]]; };
-type InferDataset<Schema extends XapiDatasetSchema> = InferColumns<Schema["columns"]>[];
+/**
+ * A schema row remains assignable from the old plain object shape, while
+ * retaining the Nexacro row metadata when an operation needs it.
+ */
+type InferDatasetRow<Schema extends XapiDatasetSchema> = InferColumns<Schema["columns"]> & {
+  $rowType?: RowType;
+  $orgRow?: Partial<InferColumns<Schema["columns"]>>;
+};
+type InferDataset<Schema extends XapiDatasetSchema> = InferDatasetRow<Schema>[];
 type InferRoot<Schema extends XapiRootSchema> = {
   parameters: InferColumns<Schema["parameters"]>;
   datasets: { [Key in keyof Schema["datasets"]]: InferDataset<Schema["datasets"][Key]>; };
@@ -543,4 +551,43 @@ declare const xapi: {
 declare function encodeRoot<Schema extends XapiRootSchema>(schema: Schema, value: InferRoot<Schema>): XapiRoot;
 declare function decodeRoot<Schema extends XapiRootSchema>(schema: Schema, root: XapiRoot): InferRoot<Schema>;
 //#endregion
-export { Col, Column, ColumnInfo, ColumnType, ColumnTypeError, ConstColumn, Dataset, InferColumns, InferDataset, InferRoot, InvalidXmlError, NexaVersion, Parameter, RequestOf, ResponseOf, Row, RowType, Rows, StringWritableStream, XapiColumnSchema, XapiColumns, XapiDatasetSchema, XapiDatasets, XapiOperation, XapiOptions, XapiParameters, XapiRoot, XapiRootSchema, XapiTypeMap, XapiValueType, XapiVersion, XmlNode, XmlStringBuilder, XplatformVersion, _unescapeXml, arrayBufferToString, base64ToUint8Array, columnType, convertToColumnType, convertToString, dateToString, decodeRoot, defineDataset, defineOperation, defineRoot, encodeControlChars, encodeRoot, escapeXml, initXapi, isXapiRoot, makeParseEntities, parse, parseXml, rowType, stringToDate, stringToReadableStream, uint8ArrayToBase64, write, xapi };
+//#region src/codec.d.ts
+/** The wire representation used by Nexacro's Dataset JSON format. */
+interface NexacroJsonParameter {
+  id: string;
+  type?: ColumnType;
+  value?: string | number;
+}
+interface NexacroJsonColumn {
+  id: string;
+  type?: ColumnType;
+  size?: number | string;
+  value?: string | number;
+}
+interface NexacroJsonRow {
+  _RowType_?: "N" | "I" | "U" | "D" | "O";
+  [columnId: string]: unknown;
+}
+interface NexacroJsonDataset {
+  id: string;
+  ColumnInfo: {
+    ConstColumn?: NexacroJsonColumn[];
+    Column: NexacroJsonColumn[];
+  };
+  Rows: NexacroJsonRow[];
+}
+interface NexacroJsonRoot {
+  version: "1.0";
+  Parameters?: NexacroJsonParameter[];
+  Datasets?: NexacroJsonDataset[];
+}
+/** A serializer boundary around the X-API internal model. */
+interface XapiCodec<Serialized> {
+  serialize(root: XapiRoot): Serialized;
+  deserialize(value: Serialized): XapiRoot;
+}
+declare const nexacroJsonCodec: XapiCodec<NexacroJsonRoot>;
+declare function parseJson(value: string): XapiRoot;
+declare function writeJsonString(root: XapiRoot): string;
+//#endregion
+export { Col, Column, ColumnInfo, ColumnType, ColumnTypeError, ConstColumn, Dataset, InferColumns, InferDataset, InferDatasetRow, InferRoot, InvalidXmlError, NexaVersion, NexacroJsonColumn, NexacroJsonDataset, NexacroJsonParameter, NexacroJsonRoot, NexacroJsonRow, Parameter, RequestOf, ResponseOf, Row, RowType, Rows, StringWritableStream, XapiCodec, XapiColumnSchema, XapiColumns, XapiDatasetSchema, XapiDatasets, XapiOperation, XapiOptions, XapiParameters, XapiRoot, XapiRootSchema, XapiTypeMap, XapiValueType, XapiVersion, XmlNode, XmlStringBuilder, XplatformVersion, _unescapeXml, arrayBufferToString, base64ToUint8Array, columnType, convertToColumnType, convertToString, dateToString, decodeRoot, defineDataset, defineOperation, defineRoot, encodeControlChars, encodeRoot, escapeXml, initXapi, isXapiRoot, makeParseEntities, nexacroJsonCodec, parse, parseJson, parseXml, rowType, stringToDate, stringToReadableStream, uint8ArrayToBase64, write, writeJsonString, xapi };

package/dist/index.js

@@ -1151,7 +1151,12 @@ function encodeRoot(schema, value) {
 		const rows = value.datasets[datasetId];
 		for (const row of rows) {
 			const rowIndex = dataset.newRow();
+			dataset.rows[rowIndex].type = row.$rowType;
 			for (const id of Object.keys(datasetSchema.columns)) dataset.setColumn(rowIndex, id, row[id]);
+			if (row.$orgRow) dataset.rows[rowIndex].orgRow = Object.entries(row.$orgRow).map(([id, value]) => ({
+				id,
+				value
+			}));
 		}
 		root.addDataset(dataset);
 	}
@@ -1174,6 +1179,8 @@ function decodeRoot(schema, root) {
 		datasets[datasetId] = dataset.getRows().map((row) => {
 			const value = { ...constants };
 			for (const column of row.cols) if (column.id in datasetSchema.columns) value[column.id] = column.value;
+			if (row.type) value.$rowType = row.type;
+			if (row.orgRow) value.$orgRow = Object.fromEntries(row.orgRow.map((column) => [column.id, column.value]));
 			return value;
 		});
 	}
@@ -1183,4 +1190,128 @@ function decodeRoot(schema, root) {
 	};
 }
 //#endregion
-export { ColumnTypeError, Dataset, InvalidXmlError, NexaVersion, StringWritableStream, XapiRoot, XmlStringBuilder, XplatformVersion, _unescapeXml, arrayBufferToString, base64ToUint8Array, columnType, convertToColumnType, convertToString, dateToString, decodeRoot, defineDataset, defineOperation, defineRoot, encodeControlChars, encodeRoot, escapeXml, initXapi, isXapiRoot, makeParseEntities, parse, parseXml, rowType, stringToDate, stringToReadableStream, uint8ArrayToBase64, write, xapi };
+//#region src/codec.ts
+const rowTypes = {
+	N: void 0,
+	I: "insert",
+	U: "update",
+	D: "delete",
+	O: void 0
+};
+function sizeOf(size, type) {
+	if (size !== void 0) return Number(size);
+	return type === "STRING" ? 255 : 0;
+}
+function jsonValue(value, type) {
+	if (value === null || value === void 0) return void 0;
+	if (type === "DATE" || type === "DATETIME" || type === "TIME") return typeof value === "string" ? convertToColumnType(value, type) : value;
+	if (type === "BLOB" && typeof value === "string") return convertToColumnType(value, type);
+	return value;
+}
+function jsonWireValue(value, type) {
+	if (value === void 0) return void 0;
+	if (value instanceof Date) return dateToString(value, type);
+	if (value instanceof Uint8Array) return uint8ArrayToBase64(value);
+	return value;
+}
+function columnsToObject(columns) {
+	return Object.fromEntries(columns.map((column) => [column.id, column.value]));
+}
+function readRow(dataset, row) {
+	const rowType = rowTypes[row._RowType_ ?? "N"];
+	if (row._RowType_ === "O") {
+		const previous = dataset.rows[dataset.rows.length - 1];
+		if (previous?.type !== "update") return;
+		previous.orgRow = dataset.getColumns().filter((column) => Object.prototype.hasOwnProperty.call(row, column.id)).map((column) => ({
+			id: column.id,
+			value: jsonValue(row[column.id], column.type)
+		}));
+		return;
+	}
+	const index = dataset.newRow();
+	dataset.rows[index].type = rowType;
+	for (const column of dataset.getColumns()) if (Object.prototype.hasOwnProperty.call(row, column.id)) dataset.rows[index].cols.push({
+		id: column.id,
+		value: jsonValue(row[column.id], column.type)
+	});
+}
+function readJson(value) {
+	const root = new XapiRoot();
+	for (const parameter of value.Parameters ?? []) root.addParameter({
+		id: parameter.id,
+		type: parameter.type,
+		value: jsonValue(parameter.value, parameter.type)
+	});
+	for (const source of value.Datasets ?? []) {
+		const dataset = new Dataset(source.id);
+		for (const column of source.ColumnInfo.ConstColumn ?? []) {
+			const type = column.type ?? "STRING";
+			dataset.addConstColumn({
+				id: column.id,
+				type,
+				size: sizeOf(column.size, type),
+				value: jsonValue(column.value, type)
+			});
+		}
+		for (const column of source.ColumnInfo.Column) {
+			const type = column.type ?? "STRING";
+			dataset.addColumn({
+				id: column.id,
+				type,
+				size: sizeOf(column.size, type)
+			});
+		}
+		for (const row of source.Rows) readRow(dataset, row);
+		root.addDataset(dataset);
+	}
+	return root;
+}
+function writeJson(root) {
+	return {
+		version: "1.0",
+		...root.parameterSize() ? { Parameters: root.getParameters().map((parameter) => ({
+			id: parameter.id,
+			...parameter.type ? { type: parameter.type } : {},
+			...parameter.value !== void 0 ? { value: jsonWireValue(parameter.value, parameter.type ?? "STRING") } : {}
+		})) } : {},
+		...root.datasetSize() ? { Datasets: root.getDatasets().map((dataset) => ({
+			id: dataset.id,
+			ColumnInfo: {
+				...dataset.constColumnSize() ? { ConstColumn: dataset.getConstColumns().map((column) => ({
+					id: column.id,
+					type: column.type,
+					size: column.size,
+					value: jsonWireValue(column.value, column.type)
+				})) } : {},
+				Column: dataset.getColumns().map((column) => ({
+					id: column.id,
+					type: column.type,
+					size: column.size
+				}))
+			},
+			Rows: dataset.getRows().flatMap((row) => {
+				const current = {
+					_RowType_: row.type === "insert" ? "I" : row.type === "update" ? "U" : row.type === "delete" ? "D" : "N",
+					...columnsToObject(row.cols)
+				};
+				if (!row.orgRow) return [current];
+				return [current, {
+					_RowType_: "O",
+					...columnsToObject(row.orgRow)
+				}];
+			})
+		})) } : {}
+	};
+}
+const nexacroJsonCodec = {
+	serialize: writeJson,
+	deserialize: readJson
+};
+function parseJson(value) {
+	return nexacroJsonCodec.deserialize(JSON.parse(value));
+}
+function writeJsonString(root) {
+	return JSON.stringify(nexacroJsonCodec.serialize(root));
+}
+//#endregion
+export { ColumnTypeError, Dataset, InvalidXmlError, NexaVersion, StringWritableStream, XapiRoot, XmlStringBuilder, XplatformVersion, _unescapeXml, arrayBufferToString, base64ToUint8Array, columnType, convertToColumnType, convertToString, dateToString, decodeRoot, defineDataset, defineOperation, defineRoot, encodeControlChars, encodeRoot, escapeXml, initXapi, isXapiRoot, makeParseEntities, nexacroJsonCodec, parse, parseJson, parseXml, rowType, stringToDate, stringToReadableStream, uint8ArrayToBase64, write, writeJsonString, xapi };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@xapi-js/core",
   "type": "module",
-  "version": "1.5.0",
+  "version": "1.6.0",
   "main": "./dist/index.cjs",
   "module": "./dist/index.js",
   "types": "./dist/index.d.ts",