@argus-labs/proto/isc/v1/query_pb.ts

Generated TypeScript protobuf definitions for Argus Labs World Engine

// @generated by protoc-gen-es v2.2.3 with parameter "target=ts"
// @generated from file isc/v1/query.proto (package isc.v1, syntax proto3)
/* eslint-disable */

import type { GenEnum, GenFile, GenMessage } from "@bufbuild/protobuf/codegenv1";
import { enumDesc, fileDesc, messageDesc } from "@bufbuild/protobuf/codegenv1";
import { file_buf_validate_validate } from "../../buf/validate/validate_pb";
import { file_google_protobuf_struct } from "@bufbuild/protobuf/wkt";
import type { JsonObject, Message } from "@bufbuild/protobuf";

/**
 * Describes the file isc/v1/query.proto.
 */
export const file_isc_v1_query: GenFile = /*@__PURE__*/
  fileDesc("ChJpc2MvdjEvcXVlcnkucHJvdG8SBmlzYy52MSK8AQoFUXVlcnkSLwoEZmluZBgBIAMoCUIhukgekgEbIhlyFxABGIABMhBeW2EtekEtWjAtOV8tXSskEi4KBW1hdGNoGAIgASgOMhMuaXNjLnYxLlF1ZXJ5Lk1hdGNoQgq6SAeCAQQQASAAEg0KBXdoZXJlGAMgASgJIkMKBU1hdGNoEhUKEU1BVENIX1VOU1BFQ0lGSUVEEAASDwoLTUFUQ0hfRVhBQ1QQARISCg5NQVRDSF9DT05UQUlOUxACIjgKC1F1ZXJ5UmVzdWx0EikKCGVudGl0aWVzGAEgAygLMhcuZ29vZ2xlLnByb3RvYnVmLlN0cnVjdEI4WjZnaXRodWIuY29tL2FyZ3VzLWxhYnMvZ28tZWNzL3Byb3RvL2dlbi9nby9pc2MvdjE7aXNjdjFiBnByb3RvMw", [file_buf_validate_validate, file_google_protobuf_struct]);

/**
 * Query represents a request to search for entities in Cardinal.
 * This type should correspond to cardinal.Query.
 *
 * @generated from message isc.v1.Query
 */
export type Query = Message<"isc.v1.Query"> & {
  /**
   * List of component names to search for.
   *
   * @generated from field: repeated string find = 1;
   */
  find: string[];

  /**
   * match determines how the components should be matched against entities.
   *
   * @generated from field: isc.v1.Query.Match match = 2;
   */
  match: Query_Match;

  /**
   * Optional filter expression using the expr language.
   *
   * @generated from field: string where = 3;
   */
  where: string;
};

/**
 * Describes the message isc.v1.Query.
 * Use `create(QuerySchema)` to create a new message.
 */
export const QuerySchema: GenMessage<Query> = /*@__PURE__*/
  messageDesc(file_isc_v1_query, 0);

/**
 * Match specifies how component names should be matched against entities.
 *
 * @generated from enum isc.v1.Query.Match
 */
export enum Query_Match {
  /**
   * MATCH_UNSPECIFIED is an invalid state and should not be used.
   *
   * @generated from enum value: MATCH_UNSPECIFIED = 0;
   */
  UNSPECIFIED = 0,

  /**
   * MATCH_EXACT requires entities to have exactly the specified components.
   *
   * @generated from enum value: MATCH_EXACT = 1;
   */
  EXACT = 1,

  /**
   * MATCH_CONTAINS requires entities to have at least the specified components, but may contain
   * additional components.
   *
   * @generated from enum value: MATCH_CONTAINS = 2;
   */
  CONTAINS = 2,
}

/**
 * Describes the enum isc.v1.Query.Match.
 */
export const Query_MatchSchema: GenEnum<Query_Match> = /*@__PURE__*/
  enumDesc(file_isc_v1_query, 0, 0);

/**
 * QueryResult contains results of the query.
 *
 * @generated from message isc.v1.QueryResult
 */
export type QueryResult = Message<"isc.v1.QueryResult"> & {
  /**
   * List of entities that match the query. Each entity is a map of component names to their values
   * as well as a "_ID" field containing the entity ID.
   *
   * @generated from field: repeated google.protobuf.Struct entities = 1;
   */
  entities: JsonObject[];
};

/**
 * Describes the message isc.v1.QueryResult.
 * Use `create(QueryResultSchema)` to create a new message.
 */
export const QueryResultSchema: GenMessage<QueryResult> = /*@__PURE__*/
  messageDesc(file_isc_v1_query, 1);