@miradorlabs/web-grpc 2.28.0 → 2.29.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@miradorlabs/web-grpc",
-  "version": "2.28.0",
+  "version": "2.29.0",
   "description": "Generated gRPC (grpc-js) client stubs for the Mirador web gateway.",
   "main": "index.js",
   "types": "index.d.ts",

package/proto/gateway/web/v1/account_gateway.ts

@@ -426,6 +426,23 @@ export interface ListProjectsResponse {
   projects: Project[];
 }
 
+export interface AddDemoProjectRequest {
+  organizationId: string;
+}
+
+export interface AddDemoProjectResponse {
+  status: ResponseStatus | undefined;
+  project: Project | undefined;
+}
+
+export interface RemoveDemoProjectRequest {
+  organizationId: string;
+}
+
+export interface RemoveDemoProjectResponse {
+  status: ResponseStatus | undefined;
+}
+
 export interface Project {
   projectId: string;
   organizationId: string;
@@ -438,6 +455,11 @@ export interface Project {
     | undefined;
   /** user_id (UUID) who created the project */
   createdBy: string;
+  /**
+   * demo marks the shared demo project: read-only, and owned by the demo
+   * organization named in organization_id rather than by the caller's.
+   */
+  demo: boolean;
 }
 
 export interface CreateWebApiKeyRequest {
@@ -1720,6 +1742,274 @@ export const ListProjectsResponse: MessageFns<ListProjectsResponse> = {
   },
 };
 
+function createBaseAddDemoProjectRequest(): AddDemoProjectRequest {
+  return { organizationId: "" };
+}
+
+export const AddDemoProjectRequest: MessageFns<AddDemoProjectRequest> = {
+  encode(message: AddDemoProjectRequest, writer: BinaryWriter = new BinaryWriter()): BinaryWriter {
+    if (message.organizationId !== "") {
+      writer.uint32(10).string(message.organizationId);
+    }
+    return writer;
+  },
+
+  decode(input: BinaryReader | Uint8Array, length?: number): AddDemoProjectRequest {
+    const reader = input instanceof BinaryReader ? input : new BinaryReader(input);
+    const end = length === undefined ? reader.len : reader.pos + length;
+    const message = createBaseAddDemoProjectRequest();
+    while (reader.pos < end) {
+      const tag = reader.uint32();
+      switch (tag >>> 3) {
+        case 1: {
+          if (tag !== 10) {
+            break;
+          }
+
+          message.organizationId = reader.string();
+          continue;
+        }
+      }
+      if ((tag & 7) === 4 || tag === 0) {
+        break;
+      }
+      reader.skip(tag & 7);
+    }
+    return message;
+  },
+
+  fromJSON(object: any): AddDemoProjectRequest {
+    return {
+      organizationId: isSet(object.organizationId)
+        ? globalThis.String(object.organizationId)
+        : isSet(object.organization_id)
+        ? globalThis.String(object.organization_id)
+        : "",
+    };
+  },
+
+  toJSON(message: AddDemoProjectRequest): unknown {
+    const obj: any = {};
+    if (message.organizationId !== "") {
+      obj.organizationId = message.organizationId;
+    }
+    return obj;
+  },
+
+  create<I extends Exact<DeepPartial<AddDemoProjectRequest>, I>>(base?: I): AddDemoProjectRequest {
+    return AddDemoProjectRequest.fromPartial(base ?? ({} as any));
+  },
+  fromPartial<I extends Exact<DeepPartial<AddDemoProjectRequest>, I>>(object: I): AddDemoProjectRequest {
+    const message = createBaseAddDemoProjectRequest();
+    message.organizationId = object.organizationId ?? "";
+    return message;
+  },
+};
+
+function createBaseAddDemoProjectResponse(): AddDemoProjectResponse {
+  return { status: undefined, project: undefined };
+}
+
+export const AddDemoProjectResponse: MessageFns<AddDemoProjectResponse> = {
+  encode(message: AddDemoProjectResponse, writer: BinaryWriter = new BinaryWriter()): BinaryWriter {
+    if (message.status !== undefined) {
+      ResponseStatus.encode(message.status, writer.uint32(10).fork()).join();
+    }
+    if (message.project !== undefined) {
+      Project.encode(message.project, writer.uint32(18).fork()).join();
+    }
+    return writer;
+  },
+
+  decode(input: BinaryReader | Uint8Array, length?: number): AddDemoProjectResponse {
+    const reader = input instanceof BinaryReader ? input : new BinaryReader(input);
+    const end = length === undefined ? reader.len : reader.pos + length;
+    const message = createBaseAddDemoProjectResponse();
+    while (reader.pos < end) {
+      const tag = reader.uint32();
+      switch (tag >>> 3) {
+        case 1: {
+          if (tag !== 10) {
+            break;
+          }
+
+          message.status = ResponseStatus.decode(reader, reader.uint32());
+          continue;
+        }
+        case 2: {
+          if (tag !== 18) {
+            break;
+          }
+
+          message.project = Project.decode(reader, reader.uint32());
+          continue;
+        }
+      }
+      if ((tag & 7) === 4 || tag === 0) {
+        break;
+      }
+      reader.skip(tag & 7);
+    }
+    return message;
+  },
+
+  fromJSON(object: any): AddDemoProjectResponse {
+    return {
+      status: isSet(object.status) ? ResponseStatus.fromJSON(object.status) : undefined,
+      project: isSet(object.project) ? Project.fromJSON(object.project) : undefined,
+    };
+  },
+
+  toJSON(message: AddDemoProjectResponse): unknown {
+    const obj: any = {};
+    if (message.status !== undefined) {
+      obj.status = ResponseStatus.toJSON(message.status);
+    }
+    if (message.project !== undefined) {
+      obj.project = Project.toJSON(message.project);
+    }
+    return obj;
+  },
+
+  create<I extends Exact<DeepPartial<AddDemoProjectResponse>, I>>(base?: I): AddDemoProjectResponse {
+    return AddDemoProjectResponse.fromPartial(base ?? ({} as any));
+  },
+  fromPartial<I extends Exact<DeepPartial<AddDemoProjectResponse>, I>>(object: I): AddDemoProjectResponse {
+    const message = createBaseAddDemoProjectResponse();
+    message.status = (object.status !== undefined && object.status !== null)
+      ? ResponseStatus.fromPartial(object.status)
+      : undefined;
+    message.project = (object.project !== undefined && object.project !== null)
+      ? Project.fromPartial(object.project)
+      : undefined;
+    return message;
+  },
+};
+
+function createBaseRemoveDemoProjectRequest(): RemoveDemoProjectRequest {
+  return { organizationId: "" };
+}
+
+export const RemoveDemoProjectRequest: MessageFns<RemoveDemoProjectRequest> = {
+  encode(message: RemoveDemoProjectRequest, writer: BinaryWriter = new BinaryWriter()): BinaryWriter {
+    if (message.organizationId !== "") {
+      writer.uint32(10).string(message.organizationId);
+    }
+    return writer;
+  },
+
+  decode(input: BinaryReader | Uint8Array, length?: number): RemoveDemoProjectRequest {
+    const reader = input instanceof BinaryReader ? input : new BinaryReader(input);
+    const end = length === undefined ? reader.len : reader.pos + length;
+    const message = createBaseRemoveDemoProjectRequest();
+    while (reader.pos < end) {
+      const tag = reader.uint32();
+      switch (tag >>> 3) {
+        case 1: {
+          if (tag !== 10) {
+            break;
+          }
+
+          message.organizationId = reader.string();
+          continue;
+        }
+      }
+      if ((tag & 7) === 4 || tag === 0) {
+        break;
+      }
+      reader.skip(tag & 7);
+    }
+    return message;
+  },
+
+  fromJSON(object: any): RemoveDemoProjectRequest {
+    return {
+      organizationId: isSet(object.organizationId)
+        ? globalThis.String(object.organizationId)
+        : isSet(object.organization_id)
+        ? globalThis.String(object.organization_id)
+        : "",
+    };
+  },
+
+  toJSON(message: RemoveDemoProjectRequest): unknown {
+    const obj: any = {};
+    if (message.organizationId !== "") {
+      obj.organizationId = message.organizationId;
+    }
+    return obj;
+  },
+
+  create<I extends Exact<DeepPartial<RemoveDemoProjectRequest>, I>>(base?: I): RemoveDemoProjectRequest {
+    return RemoveDemoProjectRequest.fromPartial(base ?? ({} as any));
+  },
+  fromPartial<I extends Exact<DeepPartial<RemoveDemoProjectRequest>, I>>(object: I): RemoveDemoProjectRequest {
+    const message = createBaseRemoveDemoProjectRequest();
+    message.organizationId = object.organizationId ?? "";
+    return message;
+  },
+};
+
+function createBaseRemoveDemoProjectResponse(): RemoveDemoProjectResponse {
+  return { status: undefined };
+}
+
+export const RemoveDemoProjectResponse: MessageFns<RemoveDemoProjectResponse> = {
+  encode(message: RemoveDemoProjectResponse, writer: BinaryWriter = new BinaryWriter()): BinaryWriter {
+    if (message.status !== undefined) {
+      ResponseStatus.encode(message.status, writer.uint32(10).fork()).join();
+    }
+    return writer;
+  },
+
+  decode(input: BinaryReader | Uint8Array, length?: number): RemoveDemoProjectResponse {
+    const reader = input instanceof BinaryReader ? input : new BinaryReader(input);
+    const end = length === undefined ? reader.len : reader.pos + length;
+    const message = createBaseRemoveDemoProjectResponse();
+    while (reader.pos < end) {
+      const tag = reader.uint32();
+      switch (tag >>> 3) {
+        case 1: {
+          if (tag !== 10) {
+            break;
+          }
+
+          message.status = ResponseStatus.decode(reader, reader.uint32());
+          continue;
+        }
+      }
+      if ((tag & 7) === 4 || tag === 0) {
+        break;
+      }
+      reader.skip(tag & 7);
+    }
+    return message;
+  },
+
+  fromJSON(object: any): RemoveDemoProjectResponse {
+    return { status: isSet(object.status) ? ResponseStatus.fromJSON(object.status) : undefined };
+  },
+
+  toJSON(message: RemoveDemoProjectResponse): unknown {
+    const obj: any = {};
+    if (message.status !== undefined) {
+      obj.status = ResponseStatus.toJSON(message.status);
+    }
+    return obj;
+  },
+
+  create<I extends Exact<DeepPartial<RemoveDemoProjectResponse>, I>>(base?: I): RemoveDemoProjectResponse {
+    return RemoveDemoProjectResponse.fromPartial(base ?? ({} as any));
+  },
+  fromPartial<I extends Exact<DeepPartial<RemoveDemoProjectResponse>, I>>(object: I): RemoveDemoProjectResponse {
+    const message = createBaseRemoveDemoProjectResponse();
+    message.status = (object.status !== undefined && object.status !== null)
+      ? ResponseStatus.fromPartial(object.status)
+      : undefined;
+    return message;
+  },
+};
+
 function createBaseProject(): Project {
   return {
     projectId: "",
@@ -1730,6 +2020,7 @@ function createBaseProject(): Project {
     createdAt: undefined,
     updatedAt: undefined,
     createdBy: "",
+    demo: false,
   };
 }
 
@@ -1759,6 +2050,9 @@ export const Project: MessageFns<Project> = {
     if (message.createdBy !== "") {
       writer.uint32(66).string(message.createdBy);
     }
+    if (message.demo !== false) {
+      writer.uint32(72).bool(message.demo);
+    }
     return writer;
   },
 
@@ -1833,6 +2127,14 @@ export const Project: MessageFns<Project> = {
           message.createdBy = reader.string();
           continue;
         }
+        case 9: {
+          if (tag !== 72) {
+            break;
+          }
+
+          message.demo = reader.bool();
+          continue;
+        }
       }
       if ((tag & 7) === 4 || tag === 0) {
         break;
@@ -1872,6 +2174,7 @@ export const Project: MessageFns<Project> = {
         : isSet(object.created_by)
         ? globalThis.String(object.created_by)
         : "",
+      demo: isSet(object.demo) ? globalThis.Boolean(object.demo) : false,
     };
   },
 
@@ -1901,6 +2204,9 @@ export const Project: MessageFns<Project> = {
     if (message.createdBy !== "") {
       obj.createdBy = message.createdBy;
     }
+    if (message.demo !== false) {
+      obj.demo = message.demo;
+    }
     return obj;
   },
 
@@ -1917,6 +2223,7 @@ export const Project: MessageFns<Project> = {
     message.createdAt = object.createdAt ?? undefined;
     message.updatedAt = object.updatedAt ?? undefined;
     message.createdBy = object.createdBy ?? "";
+    message.demo = object.demo ?? false;
     return message;
   },
 };
@@ -6906,6 +7213,9 @@ export interface AccountGatewayService {
   ListProjects(request: ListProjectsRequest, metadata?: Metadata): Promise<ListProjectsResponse>;
   UpdateProject(request: UpdateProjectRequest, metadata?: Metadata): Promise<UpdateProjectResponse>;
   DeleteProject(request: DeleteProjectRequest, metadata?: Metadata): Promise<DeleteProjectResponse>;
+  /** Demo project: self-service add/remove of the shared, read-only demo project */
+  AddDemoProject(request: AddDemoProjectRequest, metadata?: Metadata): Promise<AddDemoProjectResponse>;
+  RemoveDemoProject(request: RemoveDemoProjectRequest, metadata?: Metadata): Promise<RemoveDemoProjectResponse>;
   /** Web API Key operations */
   CreateWebApiKey(request: CreateWebApiKeyRequest, metadata?: Metadata): Promise<CreateWebApiKeyResponse>;
   ListWebApiKeys(request: ListWebApiKeysRequest, metadata?: Metadata): Promise<ListWebApiKeysResponse>;
@@ -6952,6 +7262,8 @@ export class AccountGatewayServiceClientImpl implements AccountGatewayService {
     this.ListProjects = this.ListProjects.bind(this);
     this.UpdateProject = this.UpdateProject.bind(this);
     this.DeleteProject = this.DeleteProject.bind(this);
+    this.AddDemoProject = this.AddDemoProject.bind(this);
+    this.RemoveDemoProject = this.RemoveDemoProject.bind(this);
     this.CreateWebApiKey = this.CreateWebApiKey.bind(this);
     this.ListWebApiKeys = this.ListWebApiKeys.bind(this);
     this.UpdateWebApiKeyStatus = this.UpdateWebApiKeyStatus.bind(this);
@@ -7003,6 +7315,18 @@ export class AccountGatewayServiceClientImpl implements AccountGatewayService {
     return promise.then((data) => DeleteProjectResponse.decode(new BinaryReader(data)));
   }
 
+  AddDemoProject(request: AddDemoProjectRequest, metadata?: Metadata): Promise<AddDemoProjectResponse> {
+    const data = AddDemoProjectRequest.encode(request).finish();
+    const promise = this.rpc.request(this.service, "AddDemoProject", data, metadata);
+    return promise.then((data) => AddDemoProjectResponse.decode(new BinaryReader(data)));
+  }
+
+  RemoveDemoProject(request: RemoveDemoProjectRequest, metadata?: Metadata): Promise<RemoveDemoProjectResponse> {
+    const data = RemoveDemoProjectRequest.encode(request).finish();
+    const promise = this.rpc.request(this.service, "RemoveDemoProject", data, metadata);
+    return promise.then((data) => RemoveDemoProjectResponse.decode(new BinaryReader(data)));
+  }
+
   CreateWebApiKey(request: CreateWebApiKeyRequest, metadata?: Metadata): Promise<CreateWebApiKeyResponse> {
     const data = CreateWebApiKeyRequest.encode(request).finish();
     const promise = this.rpc.request(this.service, "CreateWebApiKey", data, metadata);

package/proto/gateway/web/v1/account_gateway_grpc_pb.js

@@ -6,6 +6,28 @@ var proto_gateway_web_v1_account_gateway_pb = require('../../../../proto/gateway
 var google_protobuf_timestamp_pb = require('google-protobuf/google/protobuf/timestamp_pb.js');
 var proto_gateway_common_v1_status_pb = require('../../../../proto/gateway/common/v1/status_pb.js');
 
+function serialize_gateway_web_v1_AddDemoProjectRequest(arg) {
+  if (!(arg instanceof proto_gateway_web_v1_account_gateway_pb.AddDemoProjectRequest)) {
+    throw new Error('Expected argument of type gateway.web.v1.AddDemoProjectRequest');
+  }
+  return Buffer.from(arg.serializeBinary());
+}
+
+function deserialize_gateway_web_v1_AddDemoProjectRequest(buffer_arg) {
+  return proto_gateway_web_v1_account_gateway_pb.AddDemoProjectRequest.deserializeBinary(new Uint8Array(buffer_arg));
+}
+
+function serialize_gateway_web_v1_AddDemoProjectResponse(arg) {
+  if (!(arg instanceof proto_gateway_web_v1_account_gateway_pb.AddDemoProjectResponse)) {
+    throw new Error('Expected argument of type gateway.web.v1.AddDemoProjectResponse');
+  }
+  return Buffer.from(arg.serializeBinary());
+}
+
+function deserialize_gateway_web_v1_AddDemoProjectResponse(buffer_arg) {
+  return proto_gateway_web_v1_account_gateway_pb.AddDemoProjectResponse.deserializeBinary(new Uint8Array(buffer_arg));
+}
+
 function serialize_gateway_web_v1_CreateOrganizationRequest(arg) {
   if (!(arg instanceof proto_gateway_web_v1_account_gateway_pb.CreateOrganizationRequest)) {
     throw new Error('Expected argument of type gateway.web.v1.CreateOrganizationRequest');
@@ -325,6 +347,28 @@ function deserialize_gateway_web_v1_ProjectsStatsEnvelope(buffer_arg) {
   return proto_gateway_web_v1_account_gateway_pb.ProjectsStatsEnvelope.deserializeBinary(new Uint8Array(buffer_arg));
 }
 
+function serialize_gateway_web_v1_RemoveDemoProjectRequest(arg) {
+  if (!(arg instanceof proto_gateway_web_v1_account_gateway_pb.RemoveDemoProjectRequest)) {
+    throw new Error('Expected argument of type gateway.web.v1.RemoveDemoProjectRequest');
+  }
+  return Buffer.from(arg.serializeBinary());
+}
+
+function deserialize_gateway_web_v1_RemoveDemoProjectRequest(buffer_arg) {
+  return proto_gateway_web_v1_account_gateway_pb.RemoveDemoProjectRequest.deserializeBinary(new Uint8Array(buffer_arg));
+}
+
+function serialize_gateway_web_v1_RemoveDemoProjectResponse(arg) {
+  if (!(arg instanceof proto_gateway_web_v1_account_gateway_pb.RemoveDemoProjectResponse)) {
+    throw new Error('Expected argument of type gateway.web.v1.RemoveDemoProjectResponse');
+  }
+  return Buffer.from(arg.serializeBinary());
+}
+
+function deserialize_gateway_web_v1_RemoveDemoProjectResponse(buffer_arg) {
+  return proto_gateway_web_v1_account_gateway_pb.RemoveDemoProjectResponse.deserializeBinary(new Uint8Array(buffer_arg));
+}
+
 function serialize_gateway_web_v1_RemoveUserRequest(arg) {
   if (!(arg instanceof proto_gateway_web_v1_account_gateway_pb.RemoveUserRequest)) {
     throw new Error('Expected argument of type gateway.web.v1.RemoveUserRequest');
@@ -615,6 +659,29 @@ createProject: {
     responseSerialize: serialize_gateway_web_v1_DeleteProjectResponse,
     responseDeserialize: deserialize_gateway_web_v1_DeleteProjectResponse,
   },
+  // Demo project: self-service add/remove of the shared, read-only demo project
+addDemoProject: {
+    path: '/gateway.web.v1.AccountGatewayService/AddDemoProject',
+    requestStream: false,
+    responseStream: false,
+    requestType: proto_gateway_web_v1_account_gateway_pb.AddDemoProjectRequest,
+    responseType: proto_gateway_web_v1_account_gateway_pb.AddDemoProjectResponse,
+    requestSerialize: serialize_gateway_web_v1_AddDemoProjectRequest,
+    requestDeserialize: deserialize_gateway_web_v1_AddDemoProjectRequest,
+    responseSerialize: serialize_gateway_web_v1_AddDemoProjectResponse,
+    responseDeserialize: deserialize_gateway_web_v1_AddDemoProjectResponse,
+  },
+  removeDemoProject: {
+    path: '/gateway.web.v1.AccountGatewayService/RemoveDemoProject',
+    requestStream: false,
+    responseStream: false,
+    requestType: proto_gateway_web_v1_account_gateway_pb.RemoveDemoProjectRequest,
+    responseType: proto_gateway_web_v1_account_gateway_pb.RemoveDemoProjectResponse,
+    requestSerialize: serialize_gateway_web_v1_RemoveDemoProjectRequest,
+    requestDeserialize: deserialize_gateway_web_v1_RemoveDemoProjectRequest,
+    responseSerialize: serialize_gateway_web_v1_RemoveDemoProjectResponse,
+    responseDeserialize: deserialize_gateway_web_v1_RemoveDemoProjectResponse,
+  },
   // Web API Key operations
 createWebApiKey: {
     path: '/gateway.web.v1.AccountGatewayService/CreateWebApiKey',