@contrail/documents 1.12.0 → 1.13.0-alpha.740323e

package/CHANGELOG.md

@@ -5,6 +5,14 @@ All notable changes to `@contrail/documents` are documented here.
 Format follows [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 Versioning follows [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [1.13.0] - 2026-07-27
+
+### Added
+
+- `SortOrderErrorCode.SORT_MODE_MISMATCH` / `SortOrderErrorMessage.SORT_MODE_MISMATCH` — returned when an ordering write targets a representation the document isn't using (a `sortIndex` write to an `array`-mode document, or a sort-order-array write to an `elementIndexing` document). The response's `currentSortMode` says which representation the document is on, so a client can switch and retry.
+- `SortOrderErrorCode.SORT_INDEX_NOT_USABLE` / `SortOrderErrorMessage.SORT_INDEX_NOT_USABLE` — returned when a `sortIndex` write to an `elementIndexing` document carries a value that is not a non-empty string. Such a value would leave the document claiming `elementIndexing` while the read path silently fell back to sort-order-array order.
+- `DOCUMENT_SORT_MODES` — the sort modes as a runtime array, for validators that need to check a value against the same source as the `DocumentSortMode` type.
+
 ## [1.12.0] - 2026-07-21
 
 ### Added

package/lib/sort-order-errors.d.ts

@@ -1,6 +1,10 @@
 export declare enum SortOrderErrorCode {
-    SORT_MIGRATION_IN_PROGRESS = "SORT_MIGRATION_IN_PROGRESS"
+    SORT_MIGRATION_IN_PROGRESS = "SORT_MIGRATION_IN_PROGRESS",
+    SORT_MODE_MISMATCH = "SORT_MODE_MISMATCH",
+    SORT_INDEX_NOT_USABLE = "SORT_INDEX_NOT_USABLE"
 }
 export declare enum SortOrderErrorMessage {
-    SORT_MIGRATION_IN_PROGRESS = "Sort order is being migrated for this document; editing is briefly locked"
+    SORT_MIGRATION_IN_PROGRESS = "Sort order is being migrated for this document; editing is briefly locked",
+    SORT_MODE_MISMATCH = "Ordering write does not match the document's sort mode",
+    SORT_INDEX_NOT_USABLE = "sortIndex must be a non-empty string"
 }

package/lib/sort-order-errors.js

@@ -4,8 +4,12 @@ exports.SortOrderErrorMessage = exports.SortOrderErrorCode = void 0;
 var SortOrderErrorCode;
 (function (SortOrderErrorCode) {
     SortOrderErrorCode["SORT_MIGRATION_IN_PROGRESS"] = "SORT_MIGRATION_IN_PROGRESS";
+    SortOrderErrorCode["SORT_MODE_MISMATCH"] = "SORT_MODE_MISMATCH";
+    SortOrderErrorCode["SORT_INDEX_NOT_USABLE"] = "SORT_INDEX_NOT_USABLE";
 })(SortOrderErrorCode || (exports.SortOrderErrorCode = SortOrderErrorCode = {}));
 var SortOrderErrorMessage;
 (function (SortOrderErrorMessage) {
     SortOrderErrorMessage["SORT_MIGRATION_IN_PROGRESS"] = "Sort order is being migrated for this document; editing is briefly locked";
+    SortOrderErrorMessage["SORT_MODE_MISMATCH"] = "Ordering write does not match the document's sort mode";
+    SortOrderErrorMessage["SORT_INDEX_NOT_USABLE"] = "sortIndex must be a non-empty string";
 })(SortOrderErrorMessage || (exports.SortOrderErrorMessage = SortOrderErrorMessage = {}));

package/lib/types/document.d.ts

@@ -5,7 +5,8 @@ export interface ImportReferenceDetail {
     importedFileReference?: string;
 }
 export type DocumentWriteMode = 'transactional' | 'legacy';
-export type DocumentSortMode = 'array' | 'elementIndexing' | 'migrating';
+export declare const DOCUMENT_SORT_MODES: readonly ["array", "elementIndexing", "migrating"];
+export type DocumentSortMode = (typeof DOCUMENT_SORT_MODES)[number];
 export interface Document {
     id?: string;
     name?: string;

package/lib/types/document.js

@@ -1,2 +1,4 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.DOCUMENT_SORT_MODES = void 0;
+exports.DOCUMENT_SORT_MODES = ['array', 'elementIndexing', 'migrating'];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@contrail/documents",
-  "version": "1.12.0",
+  "version": "1.13.0-alpha.740323e",
   "description": "Documents library for contrail platform",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",