@kernelminds/scailo-sdk 0.1.27 → 0.1.29

package/lib/esm/src/base.scailo_pb.js

@@ -35,62 +35,66 @@ protobuf_1.proto3.util.setEnumType(SORT_ORDER, "Scailo.SORT_ORDER", [
 ]);
 /**
  *
- * Describes the standard lifecycle status of each record
+ * Describes the standard lifecycle status of each record.
+ * * Status Transitions Scenarios:
+ * 1. Happy Path: CREATE -> PREVERIFY -> VERIFIED -> STANDING -> COMPLETED
+ * 2. Revision Path: CREATE -> PREVERIFY -> REVISION -> HALTED -> DISCARDED -> PREVERIFY -> VERIFIED -> HALTED -> DISCARDED
+ * 3. Draft Path: DRAFT -> PREVERIFY -> HALTED -> DISCARDED -> PREVERIFY -> VERIFIED -> REVISION -> PREVERIFY -> VERIFIED -> STANDING -> COMPLETED
  *
  * @generated from enum Scailo.STANDARD_LIFECYCLE_STATUS
  */
 var STANDARD_LIFECYCLE_STATUS;
 (function (STANDARD_LIFECYCLE_STATUS) {
     /**
-     * Use this only in filter and search queries so as to retrieve all the records regardless of the status that they are in
+     * Use this only in filter and search queries to retrieve all records regardless of status.
      *
      * @generated from enum value: ANY_UNSPECIFIED = 0;
      */
     STANDARD_LIFECYCLE_STATUS[STANDARD_LIFECYCLE_STATUS["ANY_UNSPECIFIED"] = 0] = "ANY_UNSPECIFIED";
     /**
-     * The resource has just been created, and has been sent for verification
+     * The resource has just been created or restored and is awaiting verification.
      *
      * @generated from enum value: PREVERIFY = 1;
      */
     STANDARD_LIFECYCLE_STATUS[STANDARD_LIFECYCLE_STATUS["PREVERIFY"] = 1] = "PREVERIFY";
     /**
-     * The resource has been saved as a draft
+     * The resource has been saved as a draft and is not yet in the workflow.
      *
      * @generated from enum value: DRAFT = 2;
      */
     STANDARD_LIFECYCLE_STATUS[STANDARD_LIFECYCLE_STATUS["DRAFT"] = 2] = "DRAFT";
     /**
-     * The resource has been verified
+     * The resource has been verified and is ready for final approval.
      *
      * @generated from enum value: VERIFIED = 3;
      */
     STANDARD_LIFECYCLE_STATUS[STANDARD_LIFECYCLE_STATUS["VERIFIED"] = 3] = "VERIFIED";
     /**
-     * The resource has been approved
+     * The resource has been approved. It is now read-only.
      *
      * @generated from enum value: STANDING = 4;
      */
     STANDARD_LIFECYCLE_STATUS[STANDARD_LIFECYCLE_STATUS["STANDING"] = 4] = "STANDING";
     /**
-     * The resource has been sent for revision
+     * The resource has been sent back for corrections.
      *
      * @generated from enum value: REVISION = 5;
      */
     STANDARD_LIFECYCLE_STATUS[STANDARD_LIFECYCLE_STATUS["REVISION"] = 5] = "REVISION";
     /**
-     * The resource has been halted
+     * The resource processing has been temporarily paused.
      *
      * @generated from enum value: HALTED = 6;
      */
     STANDARD_LIFECYCLE_STATUS[STANDARD_LIFECYCLE_STATUS["HALTED"] = 6] = "HALTED";
     /**
-     * The resource has been marked as completed
+     * The resource has been finalized/processed.
      *
      * @generated from enum value: COMPLETED = 7;
      */
     STANDARD_LIFECYCLE_STATUS[STANDARD_LIFECYCLE_STATUS["COMPLETED"] = 7] = "COMPLETED";
     /**
-     * The resource has been discarded
+     * The resource has been permanently cancelled.
      *
      * @generated from enum value: DISCARDED = 8;
      */
@@ -2072,7 +2076,16 @@ class RepeatWithDeliveryDate extends protobuf_1.Message {
      */
     userComment = "";
     /**
-     * The reference ID of the repeated record
+     *
+     * @mandatory
+     *
+     * @description A unique external reference ID for the record. Must be alphanumeric (spaces allowed). Used for cross-referencing with external systems.
+     *
+     * @example "ABS-2023-001"
+     *
+     * @regex "[0-9A-Za-z ]+$"
+     *
+     * @format Alphanumeric characters and spaces only. No special symbols or punctuation allowed.
      *
      * @generated from field: string reference_id = 10;
      */
@@ -2147,19 +2160,25 @@ class Identifier extends protobuf_1.Message {
 exports.Identifier = Identifier;
 /**
  *
- * Describes the response that consists of the ID and the UUID of the record
+ * The standard response returned after a successful resource creation or lookup.
+ * * This message provides both the internal database ID and the public UUID
+ * for the newly created or identified record.
  *
  * @generated from message Scailo.IdentifierResponse
  */
 class IdentifierResponse extends protobuf_1.Message {
     /**
-     * ID of the resource
+     * [Output Only] The internal, auto-incrementing integer ID.
+     * Use this for high-performance internal database lookups or joins.
      *
      * @generated from field: uint64 id = 1;
      */
     id = protobuf_1.protoInt64.zero;
     /**
-     * UUID of the resource
+     * [Output Only] The globally unique identifier (UUID v4).
+     * **Note:** This is the preferred ID to use in public URLs or client-side
+     * API requests to prevent ID enumeration attacks.
+     * Example: "f47ac10b-58cc-4372-a567-0e02b2c3d479"
      *
      * @generated from field: string uuid = 10;
      */
@@ -3273,7 +3292,10 @@ exports.InventoryPartitionRequest = InventoryPartitionRequest;
  */
 class InventoryInteraction extends protobuf_1.Message {
     /**
-     * Stores a globally unique entity UUID. This will be set at the organization level
+     *
+     * @description The organization's globally unique identifier.
+     *
+     * @example "550e8400-e29b-41d4-a716-446655440000"
      *
      * @generated from field: string entity_uuid = 1;
      */
@@ -3394,7 +3416,10 @@ exports.InventoryInteractionsList = InventoryInteractionsList;
  */
 class AmendmentLog extends protobuf_1.Message {
     /**
-     * Stores a globally unique entity UUID. This will be set at the organization level
+     *
+     * @description The organization's globally unique identifier.
+     *
+     * @example "550e8400-e29b-41d4-a716-446655440000"
      *
      * @generated from field: string entity_uuid = 1;
      */

package/lib/esm/src/client_streams.scailo_connect.js

@@ -296,7 +296,7 @@ exports.ClientStreamsService = {
             kind: protobuf_1.MethodKind.Unary,
         },
         /**
-         * View by ID
+         * Retrieves a single record by its internal numeric ID. This operation is optimized for high-performance internal system logic and backend-to-backend communication
          *
          * @generated from rpc Scailo.ClientStreamsService.ViewByID
          */
@@ -307,7 +307,7 @@ exports.ClientStreamsService = {
             kind: protobuf_1.MethodKind.Unary,
         },
         /**
-         * View by UUID
+         * Retrieves a single record by its globally unique UUID. This is intended for public-facing interfaces, since record identifiers aren't sequential and thus cannot be predicted.
          *
          * @generated from rpc Scailo.ClientStreamsService.ViewByUUID
          */
@@ -318,7 +318,7 @@ exports.ClientStreamsService = {
             kind: protobuf_1.MethodKind.Unary,
         },
         /**
-         * View only essential components by ID (without logs)
+         * Retrieves a record by ID excluding high-volume fields like logs for performance. This operation is optimized for high-performance internal system logic and backend-to-backend communication
          *
          * @generated from rpc Scailo.ClientStreamsService.ViewEssentialByID
          */
@@ -329,7 +329,7 @@ exports.ClientStreamsService = {
             kind: protobuf_1.MethodKind.Unary,
         },
         /**
-         * View only essential components (without logs) that matches the given UUID
+         * Retrieves a record by UUID excluding high-volume fields like logs. This is intended for public-facing interfaces, since record identifiers aren't sequential and thus cannot be predicted.
          *
          * @generated from rpc Scailo.ClientStreamsService.ViewEssentialByUUID
          */
@@ -340,7 +340,7 @@ exports.ClientStreamsService = {
             kind: protobuf_1.MethodKind.Unary,
         },
         /**
-         * View all records with the given IDs
+         * Retrieves a list of records matching the provided array of internal IDs.
          *
          * @generated from rpc Scailo.ClientStreamsService.ViewFromIDs
          */
@@ -351,7 +351,7 @@ exports.ClientStreamsService = {
             kind: protobuf_1.MethodKind.Unary,
         },
         /**
-         * View all
+         * Returns all records filtered by their active status.
          *
          * @generated from rpc Scailo.ClientStreamsService.ViewAll
          */
@@ -362,7 +362,7 @@ exports.ClientStreamsService = {
             kind: protobuf_1.MethodKind.Unary,
         },
         /**
-         * View all with the given entity UUID
+         * Returns all records belonging to a specific organization/entity UUID.
          *
          * @generated from rpc Scailo.ClientStreamsService.ViewAllForEntityUUID
          */
@@ -373,7 +373,7 @@ exports.ClientStreamsService = {
             kind: protobuf_1.MethodKind.Unary,
         },
         /**
-         * View with pagination
+         * Retrieves a paginated list of records based on status, sort keys, and offsets.
          *
          * @generated from rpc Scailo.ClientStreamsService.ViewWithPagination
          */
@@ -384,7 +384,7 @@ exports.ClientStreamsService = {
             kind: protobuf_1.MethodKind.Unary,
         },
         /**
-         * View all that match the given search key
+         * Performs a free-text search across records using a search key.
          *
          * @generated from rpc Scailo.ClientStreamsService.SearchAll
          */
@@ -395,7 +395,7 @@ exports.ClientStreamsService = {
             kind: protobuf_1.MethodKind.Unary,
         },
         /**
-         * View all that match the given filter criteria
+         * Performs a high-granularity search based on multiple specific field filters.
          *
          * @generated from rpc Scailo.ClientStreamsService.Filter
          */
@@ -406,7 +406,7 @@ exports.ClientStreamsService = {
             kind: protobuf_1.MethodKind.Unary,
         },
         /**
-         * Count all that match the given criteria
+         * Returns the total count of records matching the given complex filter criteria.
          *
          * @generated from rpc Scailo.ClientStreamsService.Count
          */