@milaboratories/pl-client 2.18.5 → 3.1.0

package/src/core/transaction.ts

@@ -366,6 +366,7 @@ export class PlTransaction {
           id: localId,
           data: Buffer.from(name),
           errorIfExists,
+          colorProof: new Uint8Array(0),
         },
       },
       (r) => r.resourceCreateSingleton.resourceId as ResourceId,
@@ -429,6 +430,7 @@ export class PlTransaction {
           id: localId,
           data:
             data === undefined ? undefined : typeof data === "string" ? Buffer.from(data) : data,
+          colorProof: new Uint8Array(0),
         },
       }),
       (r) => r.resourceCreateStruct.resourceId,
@@ -447,6 +449,7 @@ export class PlTransaction {
           id: localId,
           data:
             data === undefined ? undefined : typeof data === "string" ? Buffer.from(data) : data,
+          colorProof: new Uint8Array(0),
         },
       }),
       (r) => r.resourceCreateEphemeral.resourceId,
@@ -469,6 +472,7 @@ export class PlTransaction {
           id: localId,
           data: typeof data === "string" ? Buffer.from(data) : data,
           errorIfExists,
+          colorProof: new Uint8Array(0),
         },
       }),
       (r) => r.resourceCreateValue.resourceId,
@@ -518,12 +522,18 @@ export class PlTransaction {
   }
 
   public removeResource(rId: ResourceId): void {
-    this.sendVoidAsync({ oneofKind: "resourceRemove", resourceRemove: { id: rId } });
+    this.sendVoidAsync({
+      oneofKind: "resourceRemove",
+      resourceRemove: { resourceId: rId },
+    });
   }
 
   public resourceExists(rId: ResourceId): Promise<boolean> {
     return this.sendSingleAndParse(
-      { oneofKind: "resourceExists", resourceExists: { resourceId: rId } },
+      {
+        oneofKind: "resourceExists",
+        resourceExists: { resourceId: rId },
+      },
       (r) => r.resourceExists.exists,
     );
   }
@@ -581,7 +591,10 @@ export class PlTransaction {
       const result = await this.sendSingleAndParse(
         {
           oneofKind: "resourceGet",
-          resourceGet: { resourceId: toResourceId(rId), loadFields: loadFields },
+          resourceGet: {
+            resourceId: toResourceId(rId),
+            loadFields: loadFields,
+          },
         },
         (r) => protoToResource(notEmpty(r.resourceGet.resource)),
       );
@@ -665,7 +678,7 @@ export class PlTransaction {
     this._stat.inputsLocked++;
     this.sendVoidAsync({
       oneofKind: "resourceLockInputs",
-      resourceLockInputs: { resourceId: toResourceId(rId) },
+      resourceLockInputs: { resourceId: toResourceId(rId), resourceSignature: new Uint8Array(0) },
     });
   }
 
@@ -677,7 +690,7 @@ export class PlTransaction {
     this._stat.outputsLocked++;
     this.sendVoidAsync({
       oneofKind: "resourceLockOutputs",
-      resourceLockOutputs: { resourceId: toResourceId(rId) },
+      resourceLockOutputs: { resourceId: toResourceId(rId), resourceSignature: new Uint8Array(0) },
     });
   }
 
@@ -689,7 +702,10 @@ export class PlTransaction {
   public setResourceError(rId: AnyResourceRef, ref: AnyResourceRef): void {
     this.sendVoidAsync({
       oneofKind: "resourceSetError",
-      resourceSetError: { resourceId: toResourceId(rId), errorResourceId: toResourceId(ref) },
+      resourceSetError: {
+        resourceId: toResourceId(rId),
+        errorResourceId: toResourceId(ref),
+      },
     });
   }
 
@@ -743,7 +759,10 @@ export class PlTransaction {
     this._stat.fieldsSet++;
     this.sendVoidAsync({
       oneofKind: "fieldSetError",
-      fieldSetError: { field: toFieldId(fId), errResourceId: toResourceId(ref) },
+      fieldSetError: {
+        field: toFieldId(fId),
+        errorResourceId: toResourceId(ref),
+      },
     });
   }
 
@@ -776,7 +795,11 @@ export class PlTransaction {
       const result = await this.sendMultiAndParse(
         {
           oneofKind: "resourceKeyValueList",
-          resourceKeyValueList: { resourceId: toResourceId(rId), startFrom: "", limit: 0 },
+          resourceKeyValueList: {
+            resourceId: toResourceId(rId),
+            startFrom: "",
+            limit: 0,
+          },
         },
         (r) => r.map((e) => e.resourceKeyValueList.record!),
       );
@@ -815,6 +838,7 @@ export class PlTransaction {
       oneofKind: "resourceKeyValueSet",
       resourceKeyValueSet: {
         resourceId: toResourceId(rId),
+        resourceSignature: new Uint8Array(0),
         key,
         value: toBytes(value),
       },
@@ -826,6 +850,7 @@ export class PlTransaction {
       oneofKind: "resourceKeyValueDelete",
       resourceKeyValueDelete: {
         resourceId: toResourceId(rId),
+        resourceSignature: new Uint8Array(0),
         key,
       },
     });
@@ -836,7 +861,10 @@ export class PlTransaction {
       const result = await this.sendSingleAndParse(
         {
           oneofKind: "resourceKeyValueGet",
-          resourceKeyValueGet: { resourceId: toResourceId(rId), key },
+          resourceKeyValueGet: {
+            resourceId: toResourceId(rId),
+            key,
+          },
         },
         (r) => r.resourceKeyValueGet.value,
       );
@@ -864,7 +892,10 @@ export class PlTransaction {
       const result = await this.sendSingleAndParse(
         {
           oneofKind: "resourceKeyValueGetIfExists",
-          resourceKeyValueGetIfExists: { resourceId: toResourceId(rId), key },
+          resourceKeyValueGetIfExists: {
+            resourceId: toResourceId(rId),
+            key,
+          },
         },
         (r) =>
           r.resourceKeyValueGetIfExists.exists ? r.resourceKeyValueGetIfExists.value : undefined,

package/src/core/type_conversion.ts

@@ -30,7 +30,7 @@ function resourceIsDeleted(proto: Resource): boolean {
 export function protoToResource(proto: Resource): ResourceData {
   if (resourceIsDeleted(proto)) throwPlNotFoundError("resource deleted");
   return {
-    id: proto.id as ResourceId,
+    id: proto.resourceId as ResourceId,
     originalResourceId: proto.originalResourceId as OptionalResourceId,
     type: notEmpty(proto.type),
     data: proto.data,

package/src/proto-grpc/github.com/milaboratory/pl/plapi/plapiproto/api.client.ts

@@ -10,6 +10,15 @@ import type { MaintenanceAPI_Ping_Response } from "./api";
 import type { MaintenanceAPI_Ping_Request } from "./api";
 import type { MiscAPI_ListResourceTypes_Response } from "./api";
 import type { MiscAPI_ListResourceTypes_Request } from "./api";
+import type { AuthAPI_ListUserResources_Response } from "./api";
+import type { AuthAPI_ListUserResources_Request } from "./api";
+import type { AuthAPI_ListGrants_Response } from "./api";
+import type { AuthAPI_ListGrants_Request } from "./api";
+import type { ServerStreamingCall } from "@protobuf-ts/runtime-rpc";
+import type { AuthAPI_RevokeGrant_Response } from "./api";
+import type { AuthAPI_RevokeGrant_Request } from "./api";
+import type { AuthAPI_GrantAccess_Response } from "./api";
+import type { AuthAPI_GrantAccess_Request } from "./api";
 import type { AuthAPI_GetJWTToken_Response } from "./api";
 import type { AuthAPI_GetJWTToken_Request } from "./api";
 import type { AuthAPI_ListMethods_Response } from "./api";
@@ -20,6 +29,8 @@ import type { LocksAPI_Lease_Update_Response } from "./api";
 import type { LocksAPI_Lease_Update_Request } from "./api";
 import type { LocksAPI_Lease_Create_Response } from "./api";
 import type { LocksAPI_Lease_Create_Request } from "./api";
+import type { LocksAPI_LockFieldValues_Create_Response } from "./api";
+import type { LocksAPI_LockFieldValues_Create_Request } from "./api";
 import type { ControllerAPI_ClearFeatures_Response } from "./api";
 import type { ControllerAPI_ClearFeatures_Request } from "./api";
 import type { ControllerAPI_SetFeatures_Response } from "./api";
@@ -148,10 +159,33 @@ export interface IPlatformClient {
      * @generated from protobuf rpc: ControllerClearFeatures
      */
     controllerClearFeatures(input: ControllerAPI_ClearFeatures_Request, options?: RpcOptions): UnaryCall<ControllerAPI_ClearFeatures_Request, ControllerAPI_ClearFeatures_Response>;
-    /**
-     *
-     * Locks
-     *
+    // 
+    // Locks
+    // 
+
+    /**
+     * LockFieldValues gets the resource and obtains a lock on all resolved values of listed fields:
+     *   - get the resource that will take the lock ('FOR' resource) (lock cannot be obtained 'FOR' or 'ON' deleted resource)
+     *   - list resource's fields, take fields with names set in request
+     *   - get resolved values of listed fields (IDs of 'ON' resources).
+     *   - acquire lock on all 'ON' resources, marking 'FOR' resource as an owner.
+     *
+     * Lock logic constraints:
+     *   - Locking is optimistic: if two processes try to obtain a lock on the same resource, one of them
+     *     succeeds, while the other fails with an error (no long waiting)
+     *   - Only resolved reference can be locked: to obtain a lock for a particular field's value, the backend needs to know
+     *     the resource ID this field points to. Unless all listed field references are resolved to a final ID, the lock will fail.
+     *   - Only an original resource can be locked: if a resource is 'pure' (supports deduplication), it has to pass deduplication before
+     *     being lockable. An attempt to lock a resource that has not become original will fail.
+     *   - Locking is a one-way operation: it cannot be 'released' or 'revoked'.
+     *
+     * @generated from protobuf rpc: LockFieldValues
+     */
+    lockFieldValues(input: LocksAPI_LockFieldValues_Create_Request, options?: RpcOptions): UnaryCall<LocksAPI_LockFieldValues_Create_Request, LocksAPI_LockFieldValues_Create_Response>;
+    /**
+     * LeaseResource creates a lease for a resource. A lease is a temporary lock that needs periodic renewal to stay valid.
+     * Leases are a separate mechanism from locks: leases are focused on 'clients', while locks are focused on 'resources'.
+     * To keep the lease active, the client needs the lease ID that is generated when a lease is created and used for lease updates.
      *
      * @generated from protobuf rpc: LeaseResource
      */
@@ -176,6 +210,22 @@ export interface IPlatformClient {
      * @generated from protobuf rpc: GetJWTToken
      */
     getJWTToken(input: AuthAPI_GetJWTToken_Request, options?: RpcOptions): UnaryCall<AuthAPI_GetJWTToken_Request, AuthAPI_GetJWTToken_Response>;
+    /**
+     * @generated from protobuf rpc: GrantAccess
+     */
+    grantAccess(input: AuthAPI_GrantAccess_Request, options?: RpcOptions): UnaryCall<AuthAPI_GrantAccess_Request, AuthAPI_GrantAccess_Response>;
+    /**
+     * @generated from protobuf rpc: RevokeGrant
+     */
+    revokeGrant(input: AuthAPI_RevokeGrant_Request, options?: RpcOptions): UnaryCall<AuthAPI_RevokeGrant_Request, AuthAPI_RevokeGrant_Response>;
+    /**
+     * @generated from protobuf rpc: ListGrants
+     */
+    listGrants(input: AuthAPI_ListGrants_Request, options?: RpcOptions): ServerStreamingCall<AuthAPI_ListGrants_Request, AuthAPI_ListGrants_Response>;
+    /**
+     * @generated from protobuf rpc: ListUserResources
+     */
+    listUserResources(input: AuthAPI_ListUserResources_Request, options?: RpcOptions): ServerStreamingCall<AuthAPI_ListUserResources_Request, AuthAPI_ListUserResources_Response>;
     /**
      *
      * Other stuff
@@ -344,29 +394,55 @@ export class PlatformClient implements IPlatformClient, ServiceInfo {
         const method = this.methods[17], opt = this._transport.mergeOptions(options);
         return stackIntercept<ControllerAPI_ClearFeatures_Request, ControllerAPI_ClearFeatures_Response>("unary", this._transport, method, opt, input);
     }
+    // 
+    // Locks
+    // 
+
+    /**
+     * LockFieldValues gets the resource and obtains a lock on all resolved values of listed fields:
+     *   - get the resource that will take the lock ('FOR' resource) (lock cannot be obtained 'FOR' or 'ON' deleted resource)
+     *   - list resource's fields, take fields with names set in request
+     *   - get resolved values of listed fields (IDs of 'ON' resources).
+     *   - acquire lock on all 'ON' resources, marking 'FOR' resource as an owner.
+     *
+     * Lock logic constraints:
+     *   - Locking is optimistic: if two processes try to obtain a lock on the same resource, one of them
+     *     succeeds, while the other fails with an error (no long waiting)
+     *   - Only resolved reference can be locked: to obtain a lock for a particular field's value, the backend needs to know
+     *     the resource ID this field points to. Unless all listed field references are resolved to a final ID, the lock will fail.
+     *   - Only an original resource can be locked: if a resource is 'pure' (supports deduplication), it has to pass deduplication before
+     *     being lockable. An attempt to lock a resource that has not become original will fail.
+     *   - Locking is a one-way operation: it cannot be 'released' or 'revoked'.
+     *
+     * @generated from protobuf rpc: LockFieldValues
+     */
+    lockFieldValues(input: LocksAPI_LockFieldValues_Create_Request, options?: RpcOptions): UnaryCall<LocksAPI_LockFieldValues_Create_Request, LocksAPI_LockFieldValues_Create_Response> {
+        const method = this.methods[18], opt = this._transport.mergeOptions(options);
+        return stackIntercept<LocksAPI_LockFieldValues_Create_Request, LocksAPI_LockFieldValues_Create_Response>("unary", this._transport, method, opt, input);
+    }
     /**
-     *
-     * Locks
-     *
+     * LeaseResource creates a lease for a resource. A lease is a temporary lock that needs periodic renewal to stay valid.
+     * Leases are a separate mechanism from locks: leases are focused on 'clients', while locks are focused on 'resources'.
+     * To keep the lease active, the client needs the lease ID that is generated when a lease is created and used for lease updates.
      *
      * @generated from protobuf rpc: LeaseResource
      */
     leaseResource(input: LocksAPI_Lease_Create_Request, options?: RpcOptions): UnaryCall<LocksAPI_Lease_Create_Request, LocksAPI_Lease_Create_Response> {
-        const method = this.methods[18], opt = this._transport.mergeOptions(options);
+        const method = this.methods[19], opt = this._transport.mergeOptions(options);
         return stackIntercept<LocksAPI_Lease_Create_Request, LocksAPI_Lease_Create_Response>("unary", this._transport, method, opt, input);
     }
     /**
      * @generated from protobuf rpc: UpdateLease
      */
     updateLease(input: LocksAPI_Lease_Update_Request, options?: RpcOptions): UnaryCall<LocksAPI_Lease_Update_Request, LocksAPI_Lease_Update_Response> {
-        const method = this.methods[19], opt = this._transport.mergeOptions(options);
+        const method = this.methods[20], opt = this._transport.mergeOptions(options);
         return stackIntercept<LocksAPI_Lease_Update_Request, LocksAPI_Lease_Update_Response>("unary", this._transport, method, opt, input);
     }
     /**
      * @generated from protobuf rpc: ReleaseLease
      */
     releaseLease(input: LocksAPI_Lease_Release_Request, options?: RpcOptions): UnaryCall<LocksAPI_Lease_Release_Request, LocksAPI_Lease_Release_Response> {
-        const method = this.methods[20], opt = this._transport.mergeOptions(options);
+        const method = this.methods[21], opt = this._transport.mergeOptions(options);
         return stackIntercept<LocksAPI_Lease_Release_Request, LocksAPI_Lease_Release_Response>("unary", this._transport, method, opt, input);
     }
     /**
@@ -377,16 +453,44 @@ export class PlatformClient implements IPlatformClient, ServiceInfo {
      * @generated from protobuf rpc: AuthMethods
      */
     authMethods(input: AuthAPI_ListMethods_Request, options?: RpcOptions): UnaryCall<AuthAPI_ListMethods_Request, AuthAPI_ListMethods_Response> {
-        const method = this.methods[21], opt = this._transport.mergeOptions(options);
+        const method = this.methods[22], opt = this._transport.mergeOptions(options);
         return stackIntercept<AuthAPI_ListMethods_Request, AuthAPI_ListMethods_Response>("unary", this._transport, method, opt, input);
     }
     /**
      * @generated from protobuf rpc: GetJWTToken
      */
     getJWTToken(input: AuthAPI_GetJWTToken_Request, options?: RpcOptions): UnaryCall<AuthAPI_GetJWTToken_Request, AuthAPI_GetJWTToken_Response> {
-        const method = this.methods[22], opt = this._transport.mergeOptions(options);
+        const method = this.methods[23], opt = this._transport.mergeOptions(options);
         return stackIntercept<AuthAPI_GetJWTToken_Request, AuthAPI_GetJWTToken_Response>("unary", this._transport, method, opt, input);
     }
+    /**
+     * @generated from protobuf rpc: GrantAccess
+     */
+    grantAccess(input: AuthAPI_GrantAccess_Request, options?: RpcOptions): UnaryCall<AuthAPI_GrantAccess_Request, AuthAPI_GrantAccess_Response> {
+        const method = this.methods[24], opt = this._transport.mergeOptions(options);
+        return stackIntercept<AuthAPI_GrantAccess_Request, AuthAPI_GrantAccess_Response>("unary", this._transport, method, opt, input);
+    }
+    /**
+     * @generated from protobuf rpc: RevokeGrant
+     */
+    revokeGrant(input: AuthAPI_RevokeGrant_Request, options?: RpcOptions): UnaryCall<AuthAPI_RevokeGrant_Request, AuthAPI_RevokeGrant_Response> {
+        const method = this.methods[25], opt = this._transport.mergeOptions(options);
+        return stackIntercept<AuthAPI_RevokeGrant_Request, AuthAPI_RevokeGrant_Response>("unary", this._transport, method, opt, input);
+    }
+    /**
+     * @generated from protobuf rpc: ListGrants
+     */
+    listGrants(input: AuthAPI_ListGrants_Request, options?: RpcOptions): ServerStreamingCall<AuthAPI_ListGrants_Request, AuthAPI_ListGrants_Response> {
+        const method = this.methods[26], opt = this._transport.mergeOptions(options);
+        return stackIntercept<AuthAPI_ListGrants_Request, AuthAPI_ListGrants_Response>("serverStreaming", this._transport, method, opt, input);
+    }
+    /**
+     * @generated from protobuf rpc: ListUserResources
+     */
+    listUserResources(input: AuthAPI_ListUserResources_Request, options?: RpcOptions): ServerStreamingCall<AuthAPI_ListUserResources_Request, AuthAPI_ListUserResources_Response> {
+        const method = this.methods[27], opt = this._transport.mergeOptions(options);
+        return stackIntercept<AuthAPI_ListUserResources_Request, AuthAPI_ListUserResources_Response>("serverStreaming", this._transport, method, opt, input);
+    }
     /**
      *
      * Other stuff
@@ -395,7 +499,7 @@ export class PlatformClient implements IPlatformClient, ServiceInfo {
      * @generated from protobuf rpc: ListResourceTypes
      */
     listResourceTypes(input: MiscAPI_ListResourceTypes_Request, options?: RpcOptions): UnaryCall<MiscAPI_ListResourceTypes_Request, MiscAPI_ListResourceTypes_Response> {
-        const method = this.methods[23], opt = this._transport.mergeOptions(options);
+        const method = this.methods[28], opt = this._transport.mergeOptions(options);
         return stackIntercept<MiscAPI_ListResourceTypes_Request, MiscAPI_ListResourceTypes_Response>("unary", this._transport, method, opt, input);
     }
     /**
@@ -406,14 +510,14 @@ export class PlatformClient implements IPlatformClient, ServiceInfo {
      * @generated from protobuf rpc: Ping
      */
     ping(input: MaintenanceAPI_Ping_Request, options?: RpcOptions): UnaryCall<MaintenanceAPI_Ping_Request, MaintenanceAPI_Ping_Response> {
-        const method = this.methods[24], opt = this._transport.mergeOptions(options);
+        const method = this.methods[29], opt = this._transport.mergeOptions(options);
         return stackIntercept<MaintenanceAPI_Ping_Request, MaintenanceAPI_Ping_Response>("unary", this._transport, method, opt, input);
     }
     /**
      * @generated from protobuf rpc: License
      */
     license(input: MaintenanceAPI_License_Request, options?: RpcOptions): UnaryCall<MaintenanceAPI_License_Request, MaintenanceAPI_License_Response> {
-        const method = this.methods[25], opt = this._transport.mergeOptions(options);
+        const method = this.methods[30], opt = this._transport.mergeOptions(options);
         return stackIntercept<MaintenanceAPI_License_Request, MaintenanceAPI_License_Response>("unary", this._transport, method, opt, input);
     }
 }