@milaboratories/pl-client 3.4.1 → 3.5.0

package/dist/proto-grpc/github.com/milaboratory/pl/plapi/plapiproto/api.d.ts

@@ -1437,6 +1437,242 @@ interface ResourceAPI_Tree_Request {
    * @generated from protobuf field: optional uint32 max_depth = 2
    */
   maxDepth?: number;
+  /**
+   * Optional per-(resource, field) filter. Unset / nil means
+   * "keep all fields" (current Tree behavior). Servers advertise
+   * support via "treeFilter:v1" in
+   * MaintenanceAPI.Ping.Response.capabilities; old servers ignore this
+   * field.
+   *
+   * If a field matches the predicate, the traversal does not descend
+   * into that field's value.
+   *
+   * Only one filter is accepted. Compose multiple rules into a single
+   * predicate via AND/OR/NOT groups.
+   *
+   * @generated from protobuf field: optional MiLaboratories.PL.API.ResourceAPI.Tree.Filter field_filter = 5
+   */
+  fieldFilter?: ResourceAPI_Tree_Filter;
+  /**
+   * If true, the response carries per-resource key-values alongside
+   * each visited resource. Defaults to false. Old servers ignore this
+   * field and never populate Response.kv.
+   *
+   * @generated from protobuf field: bool include_kv = 6
+   */
+  includeKv: boolean;
+  /**
+   * Optional predicate evaluated at the resource (not field) level.
+   * When set, the traversal does not descend into child resources that do not
+   * satisfy the predicate but resource still returns in the response.
+   *
+   * Each Tree.Response carries traverse_was_stopped=true if this
+   * resource satisfies the predicate.
+   *
+   * Available properties: resource_type (string), is_final (bool),
+   * resource_ready (bool), has_errors (bool), inputs_locked (bool),
+   * outputs_locked (bool). Old servers ignore this field and never
+   * set traverse_was_stopped.
+   *
+   * @generated from protobuf field: optional MiLaboratories.PL.API.ResourceAPI.Tree.Filter traverse_stop_rules = 7
+   */
+  traverseStopRules?: ResourceAPI_Tree_Filter;
+  /**
+   * Optional alternative entry points for multi-root traversal.
+   * When non-empty, the traversal starts from each listed seed instead
+   * of resource_id. Servers advertise support via "treeSeeds:v1" in
+   * MaintenanceAPI.Ping.Response.capabilities; old servers ignore this
+   * field. resource_id is used as the sole root when seeds is empty.
+   *
+   * @generated from protobuf field: repeated MiLaboratories.PL.API.ResourceAPI.Tree.SeedResource seeds = 8
+   */
+  seeds: ResourceAPI_Tree_SeedResource[];
+}
+/**
+ * A single entry point for multi-root tree traversal.
+ *
+ * @generated from protobuf message MiLaboratories.PL.API.ResourceAPI.Tree.SeedResource
+ */
+interface ResourceAPI_Tree_SeedResource {
+  /**
+   * @generated from protobuf field: uint64 resource_id = 1
+   */
+  resourceId: bigint;
+  /**
+   * @generated from protobuf field: bytes resource_signature = 2
+   */
+  resourceSignature: Uint8Array;
+}
+/**
+ * Filter applied to each visited resource's fields during the walk.
+ * The filter is evaluated per (resource, field) pair. If the property
+ * specified by `key` matches the `value` according to the `operator`,
+ * the field is kept; otherwise, it is dropped. A dropped field is not
+ * descended into. Resources are always emitted; when all of a resource's
+ * fields are dropped, descent stops naturally.
+ * Filter evaluated per (resource, field) pair.
+ *
+ * Leaf filter (EQUAL/NOT_EQUAL/MATCH/NOT_MATCH): key is required and
+ * selects which property to test; value carries the expected scalar.
+ *
+ * Composite filter (OR/AND/NOT): key is absent, filters_value carries
+ * sub-filters combined with the chosen operator. OR/AND/NOT may be nested
+ * arbitrarily. Top-level filters (in Tree.Request.filters) are AND-combined.
+ * NOT requires exactly one sub-filter. Dropped fields are not descended into.
+ *
+ * @generated from protobuf message MiLaboratories.PL.API.ResourceAPI.Tree.Filter
+ */
+interface ResourceAPI_Tree_Filter {
+  /**
+   * Required for leaf operators (EQUAL/MATCH).
+   * Absent when operator == OR, AND, or NOT.
+   *
+   * @generated from protobuf field: optional MiLaboratories.PL.API.ResourceAPI.Tree.Filter.Property key = 1
+   */
+  key?: ResourceAPI_Tree_Filter_Property;
+  /**
+   * @generated from protobuf field: MiLaboratories.PL.API.ResourceAPI.Tree.Filter.OperatorType operator = 2
+   */
+  operator: ResourceAPI_Tree_Filter_OperatorType;
+  /**
+   * @generated from protobuf oneof: value
+   */
+  value: {
+    oneofKind: "boolValue";
+    /**
+     * @generated from protobuf field: bool bool_value = 3
+     */
+    boolValue: boolean;
+  } | {
+    oneofKind: "stringValue";
+    /**
+     * @generated from protobuf field: string string_value = 4
+     */
+    stringValue: string;
+  } | {
+    oneofKind: "filtersValue";
+    /**
+     * Used when operator == OR, AND, or NOT.
+     *
+     * @generated from protobuf field: MiLaboratories.PL.API.ResourceAPI.Tree.Filter.FilterGroup filters_value = 5
+     */
+    filtersValue: ResourceAPI_Tree_Filter_FilterGroup;
+  } | {
+    oneofKind: undefined;
+  };
+}
+/**
+ * Wrapper for repeated Filter (oneof cannot contain repeated fields directly).
+ *
+ * @generated from protobuf message MiLaboratories.PL.API.ResourceAPI.Tree.Filter.FilterGroup
+ */
+interface ResourceAPI_Tree_Filter_FilterGroup {
+  /**
+   * @generated from protobuf field: repeated MiLaboratories.PL.API.ResourceAPI.Tree.Filter filters = 1
+   */
+  filters: ResourceAPI_Tree_Filter[];
+}
+/**
+ * @generated from protobuf enum MiLaboratories.PL.API.ResourceAPI.Tree.Filter.OperatorType
+ */
+declare enum ResourceAPI_Tree_Filter_OperatorType {
+  /**
+   * @generated from protobuf enum value: UNSPECIFIED = 0;
+   */
+  UNSPECIFIED = 0,
+  /**
+   * @generated from protobuf enum value: EQUAL = 1;
+   */
+  EQUAL = 1,
+  /**
+   * @generated from protobuf enum value: MATCH = 2;
+   */
+  MATCH = 2,
+  /**
+   * @generated from protobuf enum value: OR = 3;
+   */
+  OR = 3,
+  /**
+   * @generated from protobuf enum value: AND = 4;
+   */
+  AND = 4,
+  /**
+   * @generated from protobuf enum value: NOT = 5;
+   */
+  NOT = 5
+}
+/**
+ * @generated from protobuf enum MiLaboratories.PL.API.ResourceAPI.Tree.Filter.Property
+ */
+declare enum ResourceAPI_Tree_Filter_Property {
+  /**
+   * @generated from protobuf enum value: FIELD_NAME = 0;
+   */
+  FIELD_NAME = 0,
+  /**
+   * @generated from protobuf enum value: RESOURCE_TYPE = 1;
+   */
+  RESOURCE_TYPE = 1,
+  /**
+   * Status().IsFinal(): true when status is Original, Duplicate, or Error.
+   * Does NOT require AllInputsFinal — a resource with unresolved input fields
+   * can still report IS_FINAL=true if its own status is terminal. Use
+   * RESOURCE_READY_FOR_CALCULATION + IS_DUPLICATE + HAS_ERRORS to mirror the
+   * client-side readyOrDuplicateOrError predicate precisely.
+   *
+   * @generated from protobuf enum value: IS_FINAL = 2;
+   */
+  IS_FINAL = 2,
+  /**
+   * Evaluated per resource node (traverse_stop_rules only). True when every non-error
+   * output field has a final value. Matches the TypeScript readyAndHasAllOutputsFilled check.
+   *
+   * @generated from protobuf enum value: ALL_OUTPUTS_FINAL = 3;
+   */
+  ALL_OUTPUTS_FINAL = 3,
+  /**
+   * IsReadyForCalculation(): Status==Original AND AllInputsFinal AND no input errors AND IO feature.
+   * Mirrors the client-side r.resourceReady property used in readyOrDuplicateOrError.
+   *
+   * @generated from protobuf enum value: RESOURCE_READY_FOR_CALCULATION = 4;
+   */
+  RESOURCE_READY_FOR_CALCULATION = 4,
+  /**
+   * True when status is Duplicate (original_resource_id != 0). Mirrors the
+   * isNotNullSignedResourceId(r.originalResourceId) branch of readyOrDuplicateOrError.
+   *
+   * @generated from protobuf enum value: IS_DUPLICATE = 5;
+   */
+  IS_DUPLICATE = 5,
+  /**
+   * True when the resource has at least one field carrying an error
+   * (aggregated has-error flag). Mirrors the isNotNullSignedResourceId(r.error)
+   * branch of readyOrDuplicateOrError. Note: this can be true even when the
+   * resource's own status is not Error (e.g., an Original resource with a
+   * failed input field).
+   *
+   * @generated from protobuf enum value: HAS_ERRORS = 6;
+   */
+  HAS_ERRORS = 6,
+  /**
+   * True when no further output fields can be added to the resource.
+   *
+   * @generated from protobuf enum value: OUTPUTS_LOCKED = 7;
+   */
+  OUTPUTS_LOCKED = 7
+}
+/**
+ * @generated from protobuf message MiLaboratories.PL.API.ResourceAPI.Tree.KV
+ */
+interface ResourceAPI_Tree_KV {
+  /**
+   * @generated from protobuf field: string key = 1
+   */
+  key: string;
+  /**
+   * @generated from protobuf field: bytes value = 2
+   */
+  value: Uint8Array;
 }
 /**
  * Multi-message
@@ -1445,9 +1681,44 @@ interface ResourceAPI_Tree_Request {
  */
 interface ResourceAPI_Tree_Response {
   /**
-   * @generated from protobuf field: MiLaboratories.PL.API.Resource resource = 1
+   * Full resource payload. Absent on stop-marker frames (when the server
+   * advertises `treeStopMarker:v1` and traverse_was_stopped is true).
+   * Always populated on normal frames.
+   *
+   * @generated from protobuf field: optional MiLaboratories.PL.API.Resource resource = 1
    */
   resource?: Resource;
+  /**
+   * Populated only when include_kv=true in the request.
+   *
+   * @generated from protobuf field: repeated MiLaboratories.PL.API.ResourceAPI.Tree.KV kv = 2
+   */
+  kv: ResourceAPI_Tree_KV[];
+  /**
+   * True when the request specified a traverse_stop_rules and this resource
+   * satisfied it. Always false when traverse_stop_rules was absent.
+   *
+   * When the server advertises `treeStopMarker:v1`, a stop-marker frame has
+   * traverse_was_stopped=true with resource unset; resource_id and
+   * resource_signature carry the identity of the stopped node instead.
+   * On normal frames (traverse_was_stopped=false or server without the
+   * capability) resource is always populated and resource_id/resource_signature
+   * are zero/empty.
+   *
+   * @generated from protobuf field: bool traverse_was_stopped = 3
+   */
+  traverseWasStopped: boolean;
+  /**
+   * Populated only on stop-marker frames (resource is unset).
+   * Zero / empty on normal frames; use resource.resource_id instead.
+   *
+   * @generated from protobuf field: uint64 resource_id = 4
+   */
+  resourceId: bigint;
+  /**
+   * @generated from protobuf field: bytes resource_signature = 5
+   */
+  resourceSignature: Uint8Array;
 }
 /**
  * @generated from protobuf message MiLaboratories.PL.API.ResourceAPI.TreeSize.Request
@@ -2997,6 +3268,21 @@ interface MaintenanceAPI_Ping_Response {
    * @generated from protobuf field: string arch = 8
    */
   arch: string;
+  /**
+   * Opt-in capabilities advertised by this server instance, used by
+   * clients to pick between fast and fallback code paths without waiting
+   * for a failed RPC.
+   *
+   * Each entry is an opaque token "<feature>:<version>" (e.g.
+   * "loadSubtree:v1"). Unrecognized tokens are ignored by the client.
+   * The field is unset on servers predating this mechanism, which the
+   * client treats as "no optional capabilities advertised".
+   *
+   * All list see pl/platform/api/plapiserver/server_capabilities.go
+   *
+   * @generated from protobuf field: repeated string capabilities = 9
+   */
+  capabilities: string[];
 }
 /**
  * @generated from protobuf enum MiLaboratories.PL.API.MaintenanceAPI.Ping.Response.Compression
@@ -3578,6 +3864,46 @@ declare class ResourceAPI_Tree_Request$Type extends MessageType<ResourceAPI_Tree
  * @generated MessageType for protobuf message MiLaboratories.PL.API.ResourceAPI.Tree.Request
  */
 declare const ResourceAPI_Tree_Request: ResourceAPI_Tree_Request$Type;
+declare class ResourceAPI_Tree_SeedResource$Type extends MessageType<ResourceAPI_Tree_SeedResource> {
+  constructor();
+  create(value?: PartialMessage<ResourceAPI_Tree_SeedResource>): ResourceAPI_Tree_SeedResource;
+  internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: ResourceAPI_Tree_SeedResource): ResourceAPI_Tree_SeedResource;
+  internalBinaryWrite(message: ResourceAPI_Tree_SeedResource, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter;
+}
+/**
+ * @generated MessageType for protobuf message MiLaboratories.PL.API.ResourceAPI.Tree.SeedResource
+ */
+declare const ResourceAPI_Tree_SeedResource: ResourceAPI_Tree_SeedResource$Type;
+declare class ResourceAPI_Tree_Filter$Type extends MessageType<ResourceAPI_Tree_Filter> {
+  constructor();
+  create(value?: PartialMessage<ResourceAPI_Tree_Filter>): ResourceAPI_Tree_Filter;
+  internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: ResourceAPI_Tree_Filter): ResourceAPI_Tree_Filter;
+  internalBinaryWrite(message: ResourceAPI_Tree_Filter, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter;
+}
+/**
+ * @generated MessageType for protobuf message MiLaboratories.PL.API.ResourceAPI.Tree.Filter
+ */
+declare const ResourceAPI_Tree_Filter: ResourceAPI_Tree_Filter$Type;
+declare class ResourceAPI_Tree_Filter_FilterGroup$Type extends MessageType<ResourceAPI_Tree_Filter_FilterGroup> {
+  constructor();
+  create(value?: PartialMessage<ResourceAPI_Tree_Filter_FilterGroup>): ResourceAPI_Tree_Filter_FilterGroup;
+  internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: ResourceAPI_Tree_Filter_FilterGroup): ResourceAPI_Tree_Filter_FilterGroup;
+  internalBinaryWrite(message: ResourceAPI_Tree_Filter_FilterGroup, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter;
+}
+/**
+ * @generated MessageType for protobuf message MiLaboratories.PL.API.ResourceAPI.Tree.Filter.FilterGroup
+ */
+declare const ResourceAPI_Tree_Filter_FilterGroup: ResourceAPI_Tree_Filter_FilterGroup$Type;
+declare class ResourceAPI_Tree_KV$Type extends MessageType<ResourceAPI_Tree_KV> {
+  constructor();
+  create(value?: PartialMessage<ResourceAPI_Tree_KV>): ResourceAPI_Tree_KV;
+  internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: ResourceAPI_Tree_KV): ResourceAPI_Tree_KV;
+  internalBinaryWrite(message: ResourceAPI_Tree_KV, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter;
+}
+/**
+ * @generated MessageType for protobuf message MiLaboratories.PL.API.ResourceAPI.Tree.KV
+ */
+declare const ResourceAPI_Tree_KV: ResourceAPI_Tree_KV$Type;
 declare class ResourceAPI_Tree_Response$Type extends MessageType<ResourceAPI_Tree_Response> {
   constructor();
   create(value?: PartialMessage<ResourceAPI_Tree_Response>): ResourceAPI_Tree_Response;
@@ -4853,5 +5179,5 @@ declare class Util_Deprecated$Type extends MessageType<Util_Deprecated> {
  */
 declare const Util_Deprecated: Util_Deprecated$Type;
 //#endregion
-export { AuthAPI_GetJWTToken_Request, AuthAPI_GetJWTToken_Response, AuthAPI_GetSessionInfo_Request, AuthAPI_GetSessionInfo_Response, AuthAPI_GetUserRoot_Request, AuthAPI_GetUserRoot_Response, AuthAPI_GrantAccess_Request, AuthAPI_GrantAccess_Response, AuthAPI_ListGrants_Request, AuthAPI_ListGrants_Response, AuthAPI_ListMethods_Request, AuthAPI_ListMethods_Response, AuthAPI_ListUserResources_Request, AuthAPI_ListUserResources_Response, AuthAPI_MintSignature_Request, AuthAPI_MintSignature_Response, AuthAPI_RevokeAccess_Request, AuthAPI_RevokeAccess_Response, AuthAPI_Role, ControllerAPI_AttachSubscription_Request, ControllerAPI_AttachSubscription_Response, ControllerAPI_ClearFeatures_Request, ControllerAPI_ClearFeatures_Response, ControllerAPI_Create_Request, ControllerAPI_Create_Response, ControllerAPI_Deregister_Request, ControllerAPI_Deregister_Response, ControllerAPI_Exists_Request, ControllerAPI_Exists_Response, ControllerAPI_GetNotifications_Request, ControllerAPI_GetNotifications_Response, ControllerAPI_GetUrl_Request, ControllerAPI_GetUrl_Response, ControllerAPI_Get_Request, ControllerAPI_Get_Response, ControllerAPI_Register_Request, ControllerAPI_Register_Response, ControllerAPI_RemoveAliasesAndUrls_Request, ControllerAPI_RemoveAliasesAndUrls_Response, ControllerAPI_SetFeatures_Request, ControllerAPI_SetFeatures_Response, ControllerAPI_Update_Request, ControllerAPI_Update_Response, ControllerAPI_WriteAliasesAndUrls_Request, ControllerAPI_WriteAliasesAndUrls_Response, LocksAPI_Lease_Create_Request, LocksAPI_Lease_Create_Response, LocksAPI_Lease_Release_Request, LocksAPI_Lease_Release_Response, LocksAPI_Lease_Update_Request, LocksAPI_Lease_Update_Response, LocksAPI_LockFieldValues_Create_Request, LocksAPI_LockFieldValues_Create_Response, MaintenanceAPI_License_Request, MaintenanceAPI_License_Response, MaintenanceAPI_Ping_Request, MaintenanceAPI_Ping_Response, MiscAPI_ListResourceTypes_Request, MiscAPI_ListResourceTypes_Response, NotificationAPI_Get_Request, NotificationAPI_Get_Response, SubscriptionAPI_AttachFilter_Request, SubscriptionAPI_AttachFilter_Response, SubscriptionAPI_DetachFilter_Request, SubscriptionAPI_DetachFilter_Response, TxAPI_ClientMessage, TxAPI_ServerMessage, TxAPI_Sync_Request, TxAPI_Sync_Response };
+export { AuthAPI_GetJWTToken_Request, AuthAPI_GetJWTToken_Response, AuthAPI_GetSessionInfo_Request, AuthAPI_GetSessionInfo_Response, AuthAPI_GetUserRoot_Request, AuthAPI_GetUserRoot_Response, AuthAPI_GrantAccess_Request, AuthAPI_GrantAccess_Response, AuthAPI_ListGrants_Request, AuthAPI_ListGrants_Response, AuthAPI_ListMethods_Request, AuthAPI_ListMethods_Response, AuthAPI_ListUserResources_Request, AuthAPI_ListUserResources_Response, AuthAPI_MintSignature_Request, AuthAPI_MintSignature_Response, AuthAPI_RevokeAccess_Request, AuthAPI_RevokeAccess_Response, AuthAPI_Role, ControllerAPI_AttachSubscription_Request, ControllerAPI_AttachSubscription_Response, ControllerAPI_ClearFeatures_Request, ControllerAPI_ClearFeatures_Response, ControllerAPI_Create_Request, ControllerAPI_Create_Response, ControllerAPI_Deregister_Request, ControllerAPI_Deregister_Response, ControllerAPI_Exists_Request, ControllerAPI_Exists_Response, ControllerAPI_GetNotifications_Request, ControllerAPI_GetNotifications_Response, ControllerAPI_GetUrl_Request, ControllerAPI_GetUrl_Response, ControllerAPI_Get_Request, ControllerAPI_Get_Response, ControllerAPI_Register_Request, ControllerAPI_Register_Response, ControllerAPI_RemoveAliasesAndUrls_Request, ControllerAPI_RemoveAliasesAndUrls_Response, ControllerAPI_SetFeatures_Request, ControllerAPI_SetFeatures_Response, ControllerAPI_Update_Request, ControllerAPI_Update_Response, ControllerAPI_WriteAliasesAndUrls_Request, ControllerAPI_WriteAliasesAndUrls_Response, LocksAPI_Lease_Create_Request, LocksAPI_Lease_Create_Response, LocksAPI_Lease_Release_Request, LocksAPI_Lease_Release_Response, LocksAPI_Lease_Update_Request, LocksAPI_Lease_Update_Response, LocksAPI_LockFieldValues_Create_Request, LocksAPI_LockFieldValues_Create_Response, MaintenanceAPI_License_Request, MaintenanceAPI_License_Response, MaintenanceAPI_Ping_Request, MaintenanceAPI_Ping_Response, MiscAPI_ListResourceTypes_Request, MiscAPI_ListResourceTypes_Response, NotificationAPI_Get_Request, NotificationAPI_Get_Response, ResourceAPI_Tree_Filter, ResourceAPI_Tree_Filter_OperatorType, ResourceAPI_Tree_Filter_Property, SubscriptionAPI_AttachFilter_Request, SubscriptionAPI_AttachFilter_Response, SubscriptionAPI_DetachFilter_Request, SubscriptionAPI_DetachFilter_Response, TxAPI_ClientMessage, TxAPI_ServerMessage, TxAPI_Sync_Request, TxAPI_Sync_Response };
 //# sourceMappingURL=api.d.ts.map