@extrahorizon/javascript-sdk 8.5.0-dev-72-f6603f3 → 8.5.0-dev-73-2ae1c71

package/CHANGELOG.md

@@ -17,6 +17,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Added `TransitionActionTask` to the `AfterActions`
 - Added `TRANSITION_DOCUMENTS` permission to the `GlobalPermissionName` enum
 - Added `TRANSITION_DOCUMENTS` permission to the documentation of the transition document function
+- Added a `name` field to the `exh.data.documents.transition` body, allowing a transition to be triggered by its name rather then its id
 
 ### Changed
 - RQL `contains` and `excludes` now have their different variations better separated in the type definitions

package/build/index.cjs.js

@@ -5375,7 +5375,7 @@ const logsService = (httpWithAuth) => {
     };
 };
 
-const version = '8.5.0-dev-72-f6603f3';
+const version = '8.5.0-dev-73-2ae1c71';
 
 /**
  * Create ExtraHorizon client.

package/build/index.mjs

@@ -5345,7 +5345,7 @@ const logsService = (httpWithAuth) => {
     };
 };
 
-const version = '8.5.0-dev-72-f6603f3';
+const version = '8.5.0-dev-73-2ae1c71';
 
 /**
  * Create ExtraHorizon client.

package/build/types/services/data/types.d.ts

@@ -253,6 +253,15 @@ export interface Index {
     system?: boolean;
 }
 export declare type IndexInput = Pick<Index, 'fields' | 'options'>;
+export declare type TransitionDocumentInput = {
+    id: ObjectId;
+    name?: string;
+    data?: Record<string, unknown>;
+} | {
+    id?: ObjectId;
+    name: string;
+    data?: Record<string, unknown>;
+};
 export interface Document<CustomData = null, CustomStatus = null> {
     id: ObjectId;
     userIds: ObjectId[];
@@ -555,6 +564,14 @@ export interface DataDocumentsService {
      *
      * Start a transition manually for the selected document where the conditions of a manual transition are met.
      *
+     * Either the `id` or the `name` of a transition must be provided.
+     * If both are provided, they must match the same transition, otherwise a `ResourceUnknownError` will be thrown.
+     *
+     * If `name` is provided, multiple transitions could match.
+     * In this case, the first matching transition will be triggered:
+     * - The first transition with a `fromStatuses` matching the current status of the document
+     * - And all the transition its `conditions` are met
+     *
      * Permission | Scope | Effect
      * - | - | -
      * none | | Update your own documents
@@ -570,10 +587,7 @@ export interface DataDocumentsService {
      * @throws {IllegalArgumentError}
      * @throws {ResourceUnknownError}
      */
-    transition(schemaIdOrName: ObjectId | string, documentId: ObjectId, requestBody: {
-        id: ObjectId;
-        data?: Record<string, any>;
-    }, options?: OptionsWithRql): Promise<AffectedRecords>;
+    transition(schemaIdOrName: ObjectId | string, documentId: ObjectId, requestBody: TransitionDocumentInput, options?: OptionsWithRql): Promise<AffectedRecords>;
     /**
      * Link groups to a document
      *

package/build/types/version.d.ts

@@ -1 +1 @@
-export declare const version = "8.5.0-dev-72-f6603f3";
+export declare const version = "8.5.0-dev-73-2ae1c71";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@extrahorizon/javascript-sdk",
-  "version": "8.5.0-dev-72-f6603f3",
+  "version": "8.5.0-dev-73-2ae1c71",
   "description": "This package serves as a JavaScript wrapper around all Extra Horizon cloud services.",
   "main": "build/index.cjs.js",
   "types": "build/types/index.d.ts",