@rocicorp/zero 1.10.0-canary.24 → 1.10.0-canary.26

package/out/zero-protocol/src/ast.js.map

@@ -1 +1 @@
-{"version":3,"file":"ast.js","names":[],"sources":["../../../../zero-protocol/src/ast.ts"],"sourcesContent":["/**\n * Wire-format representation of the zql AST interface.\n *\n * `v.Type<...>` types are explicitly declared to facilitate Typescript verification\n * that the schemas satisfy the zql type definitions. (Incidentally, explicit types\n * are also required for recursive schema definitions.)\n */\n\nimport {compareUTF8} from 'compare-utf8';\nimport {assert} from '../../shared/src/asserts.ts';\nimport {getOrInsertComputed} from '../../shared/src/map.ts';\nimport {must} from '../../shared/src/must.ts';\nimport * as v from '../../shared/src/valita.ts';\nimport type {NameMapper} from '../../zero-types/src/name-mapper.ts';\nimport {rowSchema, type Row} from './data.ts';\n\nexport const SUBQ_PREFIX = 'zsubq_';\n\nexport const selectorSchema = v.string();\nexport const toStaticParam = Symbol();\nexport const planIdSymbol = Symbol('planId');\n\nconst orderingElementSchema = v.readonly(\n  v.tuple([selectorSchema, v.literalUnion('asc', 'desc')]),\n);\n\nexport const orderingSchema = v.readonlyArray(orderingElementSchema);\nexport type System = 'permissions' | 'client' | 'test';\n\nexport const primitiveSchema = v.union(\n  v.string(),\n  v.number(),\n  v.boolean(),\n  v.null(),\n);\n\nexport const equalityOpsSchema = v.literalUnion('=', '!=', 'IS', 'IS NOT');\n\nexport const orderOpsSchema = v.literalUnion('<', '>', '<=', '>=');\n\nexport const likeOpsSchema = v.literalUnion(\n  'LIKE',\n  'NOT LIKE',\n  'ILIKE',\n  'NOT ILIKE',\n);\n\nexport const inOpsSchema = v.literalUnion('IN', 'NOT IN');\n\nexport const simpleOperatorSchema = v.union(\n  equalityOpsSchema,\n  orderOpsSchema,\n  likeOpsSchema,\n  inOpsSchema,\n);\n\nconst literalReferenceSchema: v.Type<LiteralReference> = v.readonlyObject({\n  type: v.literal('literal'),\n  value: v.union(\n    v.string(),\n    v.number(),\n    v.boolean(),\n    v.null(),\n    v.readonlyArray(v.union(v.string(), v.number(), v.boolean())),\n  ),\n});\nconst columnReferenceSchema: v.Type<ColumnReference> = v.readonlyObject({\n  type: v.literal('column'),\n  name: v.string(),\n});\n\n/**\n * A parameter is a value that is not known at the time the query is written\n * and is resolved at runtime.\n *\n * Static parameters refer to something provided by the caller.\n * Static parameters are injected when the query pipeline is built from the AST\n * and do not change for the life of that pipeline.\n *\n * An example static parameter is the current authentication data.\n * When a user is authenticated, queries on the server have access\n * to the user's authentication data in order to evaluate authorization rules.\n * Authentication data doesn't change over the life of a query as a change\n * in auth data would represent a log-in / log-out of the user.\n *\n * AncestorParameters refer to rows encountered while running the query.\n * They are used by subqueries to refer to rows emitted by parent queries.\n */\nconst parameterReferenceSchema = v.readonlyObject({\n  type: v.literal('static'),\n  // The \"namespace\" of the injected parameter.\n  // Write authorization will send the value of a row\n  // prior to the mutation being run (preMutationRow).\n  // Read and write authorization will both send the\n  // current authentication data (authData).\n  anchor: v.literalUnion('authData', 'preMutationRow'),\n  field: v.union(v.string(), v.array(v.string())),\n});\n\nconst conditionValueSchema = v.union(\n  literalReferenceSchema,\n  columnReferenceSchema,\n  parameterReferenceSchema,\n);\n\nexport type Parameter = v.Infer<typeof parameterReferenceSchema>;\n\nexport const simpleConditionSchema: v.Type<SimpleCondition> = v.readonlyObject({\n  type: v.literal('simple'),\n  op: simpleOperatorSchema,\n  left: conditionValueSchema,\n  right: v.union(parameterReferenceSchema, literalReferenceSchema),\n});\n\ntype ConditionValue = v.Infer<typeof conditionValueSchema>;\n\nexport const correlatedSubqueryConditionOperatorSchema: v.Type<CorrelatedSubqueryConditionOperator> =\n  v.literalUnion('EXISTS', 'NOT EXISTS');\n\nexport const correlatedSubqueryConditionSchema: v.Type<CorrelatedSubqueryCondition> =\n  v.readonlyObject({\n    type: v.literal('correlatedSubquery'),\n    related: v.lazy(() => correlatedSubquerySchema),\n    op: correlatedSubqueryConditionOperatorSchema,\n    flip: v.boolean().optional(),\n    scalar: v.boolean().optional(),\n  });\n\nexport const conditionSchema: v.Type<Condition> = v.union(\n  simpleConditionSchema,\n  v.lazy(() => conjunctionSchema),\n  v.lazy(() => disjunctionSchema),\n  correlatedSubqueryConditionSchema,\n);\n\nconst conjunctionSchema: v.Type<Conjunction> = v.readonlyObject({\n  type: v.literal('and'),\n  conditions: v.readonlyArray(conditionSchema),\n});\n\nconst disjunctionSchema: v.Type<Disjunction> = v.readonlyObject({\n  type: v.literal('or'),\n  conditions: v.readonlyArray(conditionSchema),\n});\n\nexport type CompoundKey = readonly [string, ...string[]];\n\nfunction mustCompoundKey(field: readonly string[]): CompoundKey {\n  assert(\n    Array.isArray(field) && field.length >= 1,\n    'Expected non-empty array for compound key',\n  );\n  return field as unknown as CompoundKey;\n}\n\nexport const compoundKeySchema: v.Type<CompoundKey> = v.readonly(\n  // oxlint-disable-next-line e18e/prefer-spread-syntax\n  v.tuple([v.string()]).concat(v.array(v.string())),\n);\n\nconst correlationSchema = v.readonlyObject({\n  parentField: compoundKeySchema,\n  childField: compoundKeySchema,\n});\n\n// Split out so that its inferred type can be checked against\n// Omit<CorrelatedSubquery, 'correlation'> in ast-type-test.ts.\n// The mutually-recursive reference of the 'other' field to astSchema\n// is the only thing added in v.lazy.  The v.lazy is necessary due to the\n// mutually-recursive types, but v.lazy prevents inference of the resulting\n// type.\nexport const correlatedSubquerySchemaOmitSubquery = v.readonlyObject({\n  correlation: correlationSchema,\n  hidden: v.boolean().optional(),\n  system: v.literalUnion('permissions', 'client', 'test').optional(),\n});\n\nexport const correlatedSubquerySchema: v.Type<CorrelatedSubquery> =\n  correlatedSubquerySchemaOmitSubquery.extend({\n    subquery: v.lazy(() => astSchema),\n  });\n\nexport const astSchema: v.Type<AST> = v.readonlyObject({\n  schema: v.string().optional(),\n  table: v.string(),\n  alias: v.string().optional(),\n  where: conditionSchema.optional(),\n  related: v.readonlyArray(correlatedSubquerySchema).optional(),\n  limit: v.number().optional(),\n  orderBy: orderingSchema.optional(),\n  start: v\n    .object({\n      row: rowSchema,\n      exclusive: v.boolean(),\n    })\n    .optional(),\n});\n\nexport type Bound = {\n  row: Row;\n  exclusive: boolean;\n};\n\n/**\n * As in SQL you can have multiple orderings. We don't currently\n * support ordering on anything other than the root query.\n */\nexport type OrderPart = readonly [field: string, direction: 'asc' | 'desc'];\nexport type Ordering = readonly OrderPart[];\n\nexport type SimpleOperator = EqualityOps | OrderOps | LikeOps | InOps;\nexport type EqualityOps = '=' | '!=' | 'IS' | 'IS NOT';\nexport type OrderOps = '<' | '>' | '<=' | '>=';\nexport type LikeOps = 'LIKE' | 'NOT LIKE' | 'ILIKE' | 'NOT ILIKE';\nexport type InOps = 'IN' | 'NOT IN';\n\nexport type AST = {\n  readonly schema?: string | undefined;\n  readonly table: string;\n\n  // A query would be aliased if the AST is a subquery.\n  // e.g., when two subqueries select from the same table\n  // they need an alias to differentiate them.\n  // `SELECT\n  //   [SELECT * FROM issue WHERE issue.id = outer.parentId] AS parent\n  //   [SELECT * FROM issue WHERE issue.parentId = outer.id] AS children\n  //  FROM issue as outer`\n  readonly alias?: string | undefined;\n\n  // `select` is missing given we return all columns for now.\n\n  // The PipelineBuilder will pick what to use to correlate\n  // a subquery with a parent query. It can choose something from the\n  // where conditions or choose the _first_ `related` entry.\n  // Choosing the first `related` entry is almost always the best choice if\n  // one exists.\n  readonly where?: Condition | undefined;\n\n  readonly related?: readonly CorrelatedSubquery[] | undefined;\n  readonly start?: Bound | undefined;\n  readonly limit?: number | undefined;\n  readonly orderBy?: Ordering | undefined;\n};\n\nexport type Correlation = {\n  readonly parentField: CompoundKey;\n  readonly childField: CompoundKey;\n};\n\nexport type CorrelatedSubquery = {\n  /**\n   * Only equality correlation are supported for now.\n   * E.g., direct foreign key relationships.\n   */\n  readonly correlation: Correlation;\n  readonly subquery: AST;\n  readonly system?: System | undefined;\n  // If a hop in the subquery chain should be hidden from the output view.\n  // A common example is junction edges. The query API provides the illusion\n  // that they don't exist: `issue.related('labels')` instead of `issue.related('issue_labels').related('labels')`.\n  // To maintain this illusion, the junction edge should be hidden.\n  // When `hidden` is set to true, this hop will not be included in the output view\n  // but its children will be.\n  readonly hidden?: boolean | undefined;\n};\n\nexport type ValuePosition = LiteralReference | Parameter | ColumnReference;\n\nexport type ColumnReference = {\n  readonly type: 'column';\n  /**\n   * Not a path yet as we're currently not allowing\n   * comparisons across tables. This will need to\n   * be a path through the tree in the near future.\n   */\n  readonly name: string;\n};\n\nexport type LiteralReference = {\n  readonly type: 'literal';\n  readonly value: LiteralValue;\n};\n\nexport type LiteralValue =\n  | string\n  | number\n  | boolean\n  | null\n  | ReadonlyArray<string | number | boolean>;\n\n/**\n * Starting only with SimpleCondition for now.\n * ivm1 supports Conjunctions and Disjunctions.\n * We'll support them in the future.\n */\nexport type Condition =\n  | SimpleCondition\n  | Conjunction\n  | Disjunction\n  | CorrelatedSubqueryCondition;\n\nexport type SimpleCondition = {\n  readonly type: 'simple';\n  readonly op: SimpleOperator;\n  readonly left: ValuePosition;\n\n  /**\n   * `null` is absent since we do not have an `IS` or `IS NOT`\n   * operator defined and `null != null` in SQL.\n   */\n  readonly right: Exclude<ValuePosition, ColumnReference>;\n};\n\nexport type Conjunction = {\n  type: 'and';\n  conditions: readonly Condition[];\n};\n\nexport type Disjunction = {\n  type: 'or';\n  conditions: readonly Condition[];\n};\n\nexport type CorrelatedSubqueryCondition = {\n  type: 'correlatedSubquery';\n  related: CorrelatedSubquery;\n  op: CorrelatedSubqueryConditionOperator;\n  flip?: boolean | undefined;\n  scalar?: boolean | undefined;\n  [planIdSymbol]?: number | undefined;\n};\n\nexport type CorrelatedSubqueryConditionOperator = 'EXISTS' | 'NOT EXISTS';\n\ninterface ASTTransform {\n  tableName(orig: string): string;\n  columnName(origTable: string, origColumn: string): string;\n}\n\nfunction transformAST(ast: AST, transform: ASTTransform): Required<AST> {\n  // Name mapping functions (e.g. to server names)\n  const {tableName, columnName} = transform;\n  const colName = (c: string) => columnName(ast.table, c);\n  const key = (table: string, k: CompoundKey) => {\n    const serverKey = k.map(col => columnName(table, col));\n    return mustCompoundKey(serverKey);\n  };\n\n  const transformed = {\n    schema: ast.schema,\n    table: tableName(ast.table),\n    alias: ast.alias,\n    where: ast.where\n      ? transformWhere(ast.where, ast.table, transform)\n      : undefined,\n    related: ast.related?.map(\n      r =>\n        ({\n          correlation: {\n            parentField: key(ast.table, r.correlation.parentField),\n            childField: key(r.subquery.table, r.correlation.childField),\n          },\n          hidden: r.hidden,\n          subquery: transformAST(r.subquery, transform),\n          system: r.system,\n        }) satisfies Required<CorrelatedSubquery>,\n    ),\n    start: ast.start\n      ? {\n          ...ast.start,\n          row: Object.fromEntries(\n            Object.entries(ast.start.row).map(([col, val]) => [\n              colName(col),\n              val,\n            ]),\n          ),\n        }\n      : undefined,\n    limit: ast.limit,\n    orderBy: ast.orderBy?.map(([col, dir]) => [colName(col), dir] as const),\n  };\n\n  return transformed;\n}\n\nfunction transformWhere(\n  where: Condition,\n  table: string,\n  transform: ASTTransform,\n): Condition {\n  // Name mapping functions (e.g. to server names)\n  const {columnName} = transform;\n  const condValue = (c: ConditionValue) =>\n    c.type !== 'column' ? c : {...c, name: columnName(table, c.name)};\n  const key = (table: string, k: CompoundKey) => {\n    const serverKey = k.map(col => columnName(table, col));\n    return mustCompoundKey(serverKey);\n  };\n\n  if (where.type === 'simple') {\n    return {...where, left: condValue(where.left)};\n  } else if (where.type === 'correlatedSubquery') {\n    const {correlation, subquery} = where.related;\n    return {\n      ...where,\n      related: {\n        ...where.related,\n        correlation: {\n          parentField: key(table, correlation.parentField),\n          childField: key(subquery.table, correlation.childField),\n        },\n        subquery: transformAST(subquery, transform),\n      },\n    };\n  }\n\n  return {\n    type: where.type,\n    conditions: where.conditions.map(c => transformWhere(c, table, transform)),\n  };\n}\n\ndeclare const normalizedTag: unique symbol;\n\n/**\n * An {@link AST} in its normalized form: `related` is sorted, `where` is\n * flattened and sorted, and every field is present, in a fixed order. Two ASTs\n * that describe the same query have the same JSON encoding, and thus the same\n * hash, once normalized.\n *\n * The tag only exists in the type, so the only way to get one is from\n * {@link normalizeAST}, {@link normalizedAST} or {@link tableAST}. Spreading\n * one keeps the tag, which is what lets a query builder derive a normalized\n * AST from another one by replacing a field it knows to be safe.\n */\nexport type NormalizedAST = Required<AST> & {readonly [normalizedTag]: true};\n\nfunction asNormalized(ast: Required<AST>): NormalizedAST {\n  return ast as NormalizedAST;\n}\n\nconst normalizeCache = new WeakMap<AST, NormalizedAST>();\n\nexport function normalizeAST(ast: AST): NormalizedAST {\n  return getOrInsertComputed(normalizeCache, ast, normalizeASTUncached);\n}\n\nfunction normalizeASTUncached(ast: AST): NormalizedAST {\n  // normalizedAST() normalizes a single level, so normalize the subqueries\n  // first.\n  const {where, related} = ast;\n  return normalizedAST({\n    ...ast,\n    where: where && normalizeSubqueries(where),\n    related: related?.map(r =>\n      normalizedRelated({...r, subquery: normalizeAST(r.subquery)}),\n    ),\n  });\n}\n\n/**\n * Normalizes the ASTs of the correlated subqueries of `cond`. The condition\n * itself is normalized by {@link normalizeCondition}.\n */\nfunction normalizeSubqueries(cond: Condition): Condition {\n  switch (cond.type) {\n    case 'simple':\n      return cond;\n    case 'correlatedSubquery':\n      return {\n        ...cond,\n        related: {\n          ...cond.related,\n          subquery: normalizeAST(cond.related.subquery),\n        },\n      };\n    default:\n      return {\n        type: cond.type,\n        conditions: cond.conditions.map(normalizeSubqueries),\n      };\n  }\n}\n\n/**\n * Normalizes a single level of an AST, assuming that the ASTs of its\n * subqueries (i.e. those in `related` and in correlated subquery conditions)\n * are already normalized and that the `related` entries have the shape that\n * {@link normalizedRelated} gives them.\n *\n * This lets a query builder keep its AST normalized as it builds it up\n * instead of normalizing the whole tree afterwards. A builder that knows\n * which of the rules a step can break at all is better off applying just\n * those (see {@link tableAST}, {@link insertRelated} and\n * {@link normalizeCondition}).\n */\nexport function normalizedAST(ast: AST): NormalizedAST {\n  const {schema, table, alias, where, related, start, limit, orderBy} = ast;\n  // Every field is written, in the same order, so that all normalized ASTs\n  // have the same shape (one hidden class) and the same JSON encoding (and\n  // thus the same hash) no matter how they were put together. The fields that\n  // are undefined are dropped by JSON.stringify() anyway.\n  return asNormalized({\n    schema,\n    table,\n    alias,\n    where: where === undefined ? undefined : normalizeCondition(where),\n    related: related === undefined ? undefined : normalizeRelated(related),\n    start,\n    limit,\n    orderBy,\n  });\n}\n\n/**\n * The normalized AST that selects a whole table. Spreading it (or any other\n * normalized AST) and replacing a field keeps the field order, since a\n * normalized AST has every field.\n */\nexport function tableAST(\n  table: string,\n  alias?: string | undefined,\n): NormalizedAST {\n  return asNormalized({\n    schema: undefined,\n    table,\n    alias,\n    where: undefined,\n    related: undefined,\n    start: undefined,\n    limit: undefined,\n    orderBy: undefined,\n  });\n}\n\n/**\n * Adds `subquery` to the `related` of a normalized AST, at the position that\n * keeps it sorted.\n */\nexport function insertRelated(\n  related: readonly CorrelatedSubquery[] | undefined,\n  subquery: CorrelatedSubquery,\n): readonly CorrelatedSubquery[] {\n  const normalized = normalizedRelated(subquery);\n  if (related === undefined) {\n    return [normalized];\n  }\n  // Sorting is stable, so an entry goes after the ones it compares equal to.\n  let i = related.length;\n  while (i > 0 && cmpRelated(related[i - 1], normalized) > 0) {\n    i--;\n  }\n  return related.toSpliced(i, 0, normalized);\n}\n\n// Conjunctions and disjunctions that are known to be normalized. The query\n// builder rebuilds its AST for every step, so this keeps the conditions that\n// did not change from being normalized over and over again.\nconst normalizedConditions = new WeakSet<Condition>();\n\nfunction normalizeRelated(\n  related: readonly CorrelatedSubquery[],\n): readonly CorrelatedSubquery[] {\n  for (let i = 1; i < related.length; i++) {\n    if (cmpRelated(related[i - 1], related[i]) > 0) {\n      return related.toSorted(cmpRelated);\n    }\n  }\n  return related;\n}\n\n/**\n * Gives a correlated subquery the shape that a normalized AST has: every\n * field, in a fixed order (see {@link normalizedAST}). Its `subquery` must\n * already be normalized.\n */\nexport function normalizedRelated(\n  related: CorrelatedSubquery,\n): Required<CorrelatedSubquery> {\n  const {correlation, hidden, subquery, system} = related;\n  return {\n    correlation: {\n      parentField: correlation.parentField,\n      childField: correlation.childField,\n    },\n    hidden,\n    subquery,\n    system,\n  };\n}\n\nfunction normalizeValuePosition<T extends ValuePosition>(v: T): T {\n  switch (v.type) {\n    case 'literal':\n      return {type: 'literal', value: v.value} as T;\n    case 'column':\n      return {type: 'column', name: v.name} as T;\n    default:\n      return {type: 'static', anchor: v.anchor, field: v.field} as T;\n  }\n}\n\n/**\n * Normalizes a condition, assuming that the ASTs of any correlated subqueries\n * it contains are already normalized.\n *\n * Like {@link normalizedAST}, this rebuilds every node with its fields in a\n * fixed order, so that structurally equal conditions have the same JSON\n * encoding (and thus the same hash) no matter how they were put together.\n * That includes a round trip through Postgres, whose jsonb type reorders\n * object keys: without the rebuild, every query record reloaded from the CVR\n * re-hashed to a different transformationHash than was stored, making it look\n * changed and re-execute on every view-syncer restart.\n */\nexport function normalizeCondition(cond: Condition): Condition {\n  if (normalizedConditions.has(cond)) {\n    return cond;\n  }\n  if (cond.type === 'simple') {\n    const normalized: Condition = {\n      type: 'simple',\n      op: cond.op,\n      left: normalizeValuePosition(cond.left),\n      right: normalizeValuePosition(cond.right),\n    };\n    normalizedConditions.add(normalized);\n    return normalized;\n  }\n  if (cond.type === 'correlatedSubquery') {\n    const normalized: Condition = {\n      type: 'correlatedSubquery',\n      related: normalizedRelated(cond.related),\n      op: cond.op,\n      flip: cond.flip,\n      scalar: cond.scalar,\n    };\n    normalizedConditions.add(normalized);\n    return normalized;\n  }\n\n  // Flatten the conditions of nested conjunctions of the same type and sort\n  // them. The nested conditions are normalized (and thus flattened and sorted)\n  // first.\n  const conditions: Condition[] = [];\n  for (const c of cond.conditions) {\n    const n = normalizeCondition(c);\n    if (n.type === cond.type) {\n      conditions.push(...n.conditions);\n    } else {\n      conditions.push(n);\n    }\n  }\n\n  // A singleton conjunction is the same as the condition itself. Empty\n  // conjunctions, on the other hand, are meaningful: an empty 'and' is always\n  // true and an empty 'or' is always false.\n  if (conditions.length === 1) {\n    return conditions[0];\n  }\n  conditions.sort(cmpCondition);\n  const normalized: Condition = {type: cond.type, conditions};\n  normalizedConditions.add(normalized);\n  return normalized;\n}\n\n/**\n * Maps the table and column names of `ast`. The result is not a\n * {@link NormalizedAST} even if `ast` was normalized: the names it sorts by\n * are the ones that changed.\n */\nexport function mapAST(ast: AST, mapper: NameMapper) {\n  return transformAST(ast, {\n    tableName: table => mapper.tableName(table),\n    columnName: (table, col) => mapper.columnName(table, col),\n  });\n}\n\nexport function mapCondition(\n  cond: Condition,\n  table: string,\n  mapper: NameMapper,\n) {\n  return transformWhere(cond, table, {\n    tableName: table => mapper.tableName(table),\n    columnName: (table, col) => mapper.columnName(table, col),\n  });\n}\n\nfunction cmpCondition(a: Condition, b: Condition): number {\n  if (a.type === 'simple') {\n    if (b.type !== 'simple') {\n      return -1; // Order SimpleConditions first\n    }\n\n    return (\n      compareValuePosition(a.left, b.left) ||\n      compareUTF8MaybeNull(a.op, b.op) ||\n      compareValuePosition(a.right, b.right)\n    );\n  }\n\n  if (b.type === 'simple') {\n    return 1; // Order SimpleConditions first\n  }\n\n  if (a.type === 'correlatedSubquery') {\n    if (b.type !== 'correlatedSubquery') {\n      return -1; // Order subquery before conjuctions/disjuctions\n    }\n    return (\n      cmpRelated(a.related, b.related) ||\n      compareUTF8MaybeNull(a.op, b.op) ||\n      cmpOptionalBool(a.flip, b.flip) ||\n      cmpOptionalBool(a.scalar, b.scalar)\n    );\n  }\n  if (b.type === 'correlatedSubquery') {\n    return -1; // Order correlatedSubquery before conjuctions/disjuctions\n  }\n\n  const val = compareUTF8MaybeNull(a.type, b.type);\n  if (val !== 0) {\n    return val;\n  }\n  for (\n    let l = 0, r = 0;\n    l < a.conditions.length && r < b.conditions.length;\n    l++, r++\n  ) {\n    const val = cmpCondition(a.conditions[l], b.conditions[r]);\n    if (val !== 0) {\n      return val;\n    }\n  }\n  // prefixes first\n  return a.conditions.length - b.conditions.length;\n}\n\nfunction compareValuePosition(a: ValuePosition, b: ValuePosition): number {\n  if (a.type !== b.type) {\n    return compareUTF8(a.type, b.type);\n  }\n  switch (a.type) {\n    case 'literal':\n      assert(b.type === 'literal', 'Expected literal type for comparison');\n      return cmpLiteralValue(a.value, b.value);\n    case 'column':\n      assert(b.type === 'column', 'Expected column type for comparison');\n      return compareUTF8(a.name, b.name);\n    case 'static':\n      assert(b.type === 'static', 'Expected static type for comparison');\n      // A field is a string or a path of strings, which cmpLiteralValue()\n      // tells apart.\n      return (\n        compareUTF8(a.anchor, b.anchor) || cmpLiteralValue(a.field, b.field)\n      );\n  }\n}\n\n// null < boolean < number < string < array. Ordering values of different\n// types by their string form would make distinct values compare equal (['a',\n// 'b'] and 'a,b', or 1 and '1'), which would leave their order up to the\n// order they were written in, and with it the hash of the query.\nconst LITERAL_VALUE_TYPES = ['object', 'boolean', 'number', 'string'];\n\nfunction literalValueType(value: LiteralValue): number {\n  return Array.isArray(value)\n    ? LITERAL_VALUE_TYPES.length\n    : LITERAL_VALUE_TYPES.indexOf(typeof value);\n}\n\nfunction cmpLiteralValue(a: LiteralValue, b: LiteralValue): number {\n  const type = literalValueType(a) - literalValueType(b);\n  if (type !== 0) {\n    return type;\n  }\n\n  if (Array.isArray(a)) {\n    assert(Array.isArray(b), 'Expected array for comparison');\n    for (let i = 0; i < a.length && i < b.length; i++) {\n      const val = cmpLiteralValue(a[i], b[i]);\n      if (val !== 0) {\n        return val;\n      }\n    }\n    // prefixes first\n    return a.length - b.length;\n  }\n\n  switch (typeof a) {\n    case 'string':\n      assert(typeof b === 'string', 'Expected string for comparison');\n      return compareUTF8(a, b);\n    case 'number':\n      assert(typeof b === 'number', 'Expected number for comparison');\n      return a < b ? -1 : a > b ? 1 : 0;\n    case 'boolean':\n      assert(typeof b === 'boolean', 'Expected boolean for comparison');\n      return Number(a) - Number(b);\n    default:\n      return 0; // null\n  }\n}\n\nfunction cmpRelated(a: CorrelatedSubquery, b: CorrelatedSubquery): number {\n  return compareUTF8(must(a.subquery.alias), must(b.subquery.alias));\n}\n\nfunction compareUTF8MaybeNull(a: string | null, b: string | null): number {\n  if (a !== null && b !== null) {\n    return compareUTF8(a, b);\n  }\n  if (b !== null) {\n    return -1;\n  }\n  if (a !== null) {\n    return 1;\n  }\n  return 0;\n}\n\nfunction cmpOptionalBool(\n  a: boolean | undefined,\n  b: boolean | undefined,\n): number {\n  // undefined < false < true\n  const toNum = (v: boolean | undefined) => (v === undefined ? 0 : v ? 2 : 1);\n  return toNum(a) - toNum(b);\n}\n"],"mappings":";;;;;;;;;;;;;;AAgBA,IAAa,cAAc;AAE3B,IAAa,iBAAiB,eAAE,OAAO;AACvC,IAAa,gBAAgB,OAAO;AACpC,IAAa,eAAe,OAAO,QAAQ;AAM3C,IAAa,iBAAiB,cAJA,SAC5B,eAAE,MAAM,CAAC,gBAAgB,aAAe,OAAO,MAAM,CAAC,CAAC,CAGX,CAAqB;AAGpC,eAAE,MAC/B,eAAE,OAAO,GACT,eAAE,OAAO,GACT,eAAE,QAAQ,GACV,eAAE,KAAK,CACT;AAEA,IAAa,oBAAoB,aAAe,KAAK,MAAM,MAAM,QAAQ;AAEzE,IAAa,iBAAiB,aAAe,KAAK,KAAK,MAAM,IAAI;AAEjE,IAAa,gBAAgB,aAC3B,QACA,YACA,SACA,WACF;AAEA,IAAa,cAAc,aAAe,MAAM,QAAQ;AAExD,IAAa,uBAAuB,eAAE,MACpC,mBACA,gBACA,eACA,WACF;AAEA,IAAM,yBAAmD,eAAiB;CACxE,MAAM,eAAE,QAAQ,SAAS;CACzB,OAAO,eAAE,MACP,eAAE,OAAO,GACT,eAAE,OAAO,GACT,eAAE,QAAQ,GACV,eAAE,KAAK,GACP,cAAgB,eAAE,MAAM,eAAE,OAAO,GAAG,eAAE,OAAO,GAAG,eAAE,QAAQ,CAAC,CAAC,CAC9D;AACF,CAAC;AACD,IAAM,wBAAiD,eAAiB;CACtE,MAAM,eAAE,QAAQ,QAAQ;CACxB,MAAM,eAAE,OAAO;AACjB,CAAC;;;;;;;;;;;;;;;;;;AAmBD,IAAM,2BAA2B,eAAiB;CAChD,MAAM,eAAE,QAAQ,QAAQ;CAMxB,QAAQ,aAAe,YAAY,gBAAgB;CACnD,OAAO,eAAE,MAAM,eAAE,OAAO,GAAG,eAAE,MAAM,eAAE,OAAO,CAAC,CAAC;AAChD,CAAC;AAED,IAAM,uBAAuB,eAAE,MAC7B,wBACA,uBACA,wBACF;AAIA,IAAa,wBAAiD,eAAiB;CAC7E,MAAM,eAAE,QAAQ,QAAQ;CACxB,IAAI;CACJ,MAAM;CACN,OAAO,eAAE,MAAM,0BAA0B,sBAAsB;AACjE,CAAC;AAID,IAAa,4CACX,aAAe,UAAU,YAAY;AAEvC,IAAa,oCACX,eAAiB;CACf,MAAM,eAAE,QAAQ,oBAAoB;CACpC,SAAS,eAAE,WAAW,wBAAwB;CAC9C,IAAI;CACJ,MAAM,eAAE,QAAQ,EAAE,SAAS;CAC3B,QAAQ,eAAE,QAAQ,EAAE,SAAS;AAC/B,CAAC;AAEH,IAAa,kBAAqC,eAAE,MAClD,uBACA,eAAE,WAAW,iBAAiB,GAC9B,eAAE,WAAW,iBAAiB,GAC9B,iCACF;AAEA,IAAM,oBAAyC,eAAiB;CAC9D,MAAM,eAAE,QAAQ,KAAK;CACrB,YAAY,cAAgB,eAAe;AAC7C,CAAC;AAED,IAAM,oBAAyC,eAAiB;CAC9D,MAAM,eAAE,QAAQ,IAAI;CACpB,YAAY,cAAgB,eAAe;AAC7C,CAAC;AAID,SAAS,gBAAgB,OAAuC;CAC9D,OACE,MAAM,QAAQ,KAAK,KAAK,MAAM,UAAU,GACxC,2CACF;CACA,OAAO;AACT;AAEA,IAAa,oBAAyC,SAEpD,eAAE,MAAM,CAAC,eAAE,OAAO,CAAC,CAAC,EAAE,OAAO,eAAE,MAAM,eAAE,OAAO,CAAC,CAAC,CAClD;AAmBA,IAAa,2BANuC,eAAiB;CACnE,aAZwB,eAAiB;EACzC,aAAa;EACb,YAAY;CACd,CASe;CACb,QAAQ,eAAE,QAAQ,EAAE,SAAS;CAC7B,QAAQ,aAAe,eAAe,UAAU,MAAM,EAAE,SAAS;AACnE,CAGE,EAAqC,OAAO,EAC1C,UAAU,eAAE,WAAW,SAAS,EAClC,CAAC;AAEH,IAAa,YAAyB,eAAiB;CACrD,QAAQ,eAAE,OAAO,EAAE,SAAS;CAC5B,OAAO,eAAE,OAAO;CAChB,OAAO,eAAE,OAAO,EAAE,SAAS;CAC3B,OAAO,gBAAgB,SAAS;CAChC,SAAS,cAAgB,wBAAwB,EAAE,SAAS;CAC5D,OAAO,eAAE,OAAO,EAAE,SAAS;CAC3B,SAAS,eAAe,SAAS;CACjC,OAAO,eACJ,OAAO;EACN,KAAK;EACL,WAAW,eAAE,QAAQ;CACvB,CAAC,EACA,SAAS;AACd,CAAC;AA+ID,SAAS,aAAa,KAAU,WAAwC;CAEtE,MAAM,EAAC,WAAW,eAAc;CAChC,MAAM,WAAW,MAAc,WAAW,IAAI,OAAO,CAAC;CACtD,MAAM,OAAO,OAAe,MAAmB;EAE7C,OAAO,gBADW,EAAE,KAAI,QAAO,WAAW,OAAO,GAAG,CAC7B,CAAS;CAClC;CAoCA,OAAO;EAjCL,QAAQ,IAAI;EACZ,OAAO,UAAU,IAAI,KAAK;EAC1B,OAAO,IAAI;EACX,OAAO,IAAI,QACP,eAAe,IAAI,OAAO,IAAI,OAAO,SAAS,IAC9C,KAAA;EACJ,SAAS,IAAI,SAAS,KACpB,OACG;GACC,aAAa;IACX,aAAa,IAAI,IAAI,OAAO,EAAE,YAAY,WAAW;IACrD,YAAY,IAAI,EAAE,SAAS,OAAO,EAAE,YAAY,UAAU;GAC5D;GACA,QAAQ,EAAE;GACV,UAAU,aAAa,EAAE,UAAU,SAAS;GAC5C,QAAQ,EAAE;EACZ,EACJ;EACA,OAAO,IAAI,QACP;GACE,GAAG,IAAI;GACP,KAAK,OAAO,YACV,OAAO,QAAQ,IAAI,MAAM,GAAG,EAAE,KAAK,CAAC,KAAK,SAAS,CAChD,QAAQ,GAAG,GACX,GACF,CAAC,CACH;EACF,IACA,KAAA;EACJ,OAAO,IAAI;EACX,SAAS,IAAI,SAAS,KAAK,CAAC,KAAK,SAAS,CAAC,QAAQ,GAAG,GAAG,GAAG,CAAU;CAGjE;AACT;AAEA,SAAS,eACP,OACA,OACA,WACW;CAEX,MAAM,EAAC,eAAc;CACrB,MAAM,aAAa,MACjB,EAAE,SAAS,WAAW,IAAI;EAAC,GAAG;EAAG,MAAM,WAAW,OAAO,EAAE,IAAI;CAAC;CAClE,MAAM,OAAO,OAAe,MAAmB;EAE7C,OAAO,gBADW,EAAE,KAAI,QAAO,WAAW,OAAO,GAAG,CAC7B,CAAS;CAClC;CAEA,IAAI,MAAM,SAAS,UACjB,OAAO;EAAC,GAAG;EAAO,MAAM,UAAU,MAAM,IAAI;CAAC;MACxC,IAAI,MAAM,SAAS,sBAAsB;EAC9C,MAAM,EAAC,aAAa,aAAY,MAAM;EACtC,OAAO;GACL,GAAG;GACH,SAAS;IACP,GAAG,MAAM;IACT,aAAa;KACX,aAAa,IAAI,OAAO,YAAY,WAAW;KAC/C,YAAY,IAAI,SAAS,OAAO,YAAY,UAAU;IACxD;IACA,UAAU,aAAa,UAAU,SAAS;GAC5C;EACF;CACF;CAEA,OAAO;EACL,MAAM,MAAM;EACZ,YAAY,MAAM,WAAW,KAAI,MAAK,eAAe,GAAG,OAAO,SAAS,CAAC;CAC3E;AACF;AAiBA,SAAS,aAAa,KAAmC;CACvD,OAAO;AACT;AAEA,IAAM,iCAAiB,IAAI,QAA4B;AAEvD,SAAgB,aAAa,KAAyB;CACpD,OAAO,oBAAoB,gBAAgB,KAAK,oBAAoB;AACtE;AAEA,SAAS,qBAAqB,KAAyB;CAGrD,MAAM,EAAC,OAAO,YAAW;CACzB,OAAO,cAAc;EACnB,GAAG;EACH,OAAO,SAAS,oBAAoB,KAAK;EACzC,SAAS,SAAS,KAAI,MACpB,kBAAkB;GAAC,GAAG;GAAG,UAAU,aAAa,EAAE,QAAQ;EAAC,CAAC,CAC9D;CACF,CAAC;AACH;;;;;AAMA,SAAS,oBAAoB,MAA4B;CACvD,QAAQ,KAAK,MAAb;EACE,KAAK,UACH,OAAO;EACT,KAAK,sBACH,OAAO;GACL,GAAG;GACH,SAAS;IACP,GAAG,KAAK;IACR,UAAU,aAAa,KAAK,QAAQ,QAAQ;GAC9C;EACF;EACF,SACE,OAAO;GACL,MAAM,KAAK;GACX,YAAY,KAAK,WAAW,IAAI,mBAAmB;EACrD;CACJ;AACF;;;;;;;;;;;;;AAcA,SAAgB,cAAc,KAAyB;CACrD,MAAM,EAAC,QAAQ,OAAO,OAAO,OAAO,SAAS,OAAO,OAAO,YAAW;CAKtE,OAAO,aAAa;EAClB;EACA;EACA;EACA,OAAO,UAAU,KAAA,IAAY,KAAA,IAAY,mBAAmB,KAAK;EACjE,SAAS,YAAY,KAAA,IAAY,KAAA,IAAY,iBAAiB,OAAO;EACrE;EACA;EACA;CACF,CAAC;AACH;;;;;;AAOA,SAAgB,SACd,OACA,OACe;CACf,OAAO,aAAa;EAClB,QAAQ,KAAA;EACR;EACA;EACA,OAAO,KAAA;EACP,SAAS,KAAA;EACT,OAAO,KAAA;EACP,OAAO,KAAA;EACP,SAAS,KAAA;CACX,CAAC;AACH;;;;;AAMA,SAAgB,cACd,SACA,UAC+B;CAC/B,MAAM,aAAa,kBAAkB,QAAQ;CAC7C,IAAI,YAAY,KAAA,GACd,OAAO,CAAC,UAAU;CAGpB,IAAI,IAAI,QAAQ;CAChB,OAAO,IAAI,KAAK,WAAW,QAAQ,IAAI,IAAI,UAAU,IAAI,GACvD;CAEF,OAAO,QAAQ,UAAU,GAAG,GAAG,UAAU;AAC3C;AAKA,IAAM,uCAAuB,IAAI,QAAmB;AAEpD,SAAS,iBACP,SAC+B;CAC/B,KAAK,IAAI,IAAI,GAAG,IAAI,QAAQ,QAAQ,KAClC,IAAI,WAAW,QAAQ,IAAI,IAAI,QAAQ,EAAE,IAAI,GAC3C,OAAO,QAAQ,SAAS,UAAU;CAGtC,OAAO;AACT;;;;;;AAOA,SAAgB,kBACd,SAC8B;CAC9B,MAAM,EAAC,aAAa,QAAQ,UAAU,WAAU;CAChD,OAAO;EACL,aAAa;GACX,aAAa,YAAY;GACzB,YAAY,YAAY;EAC1B;EACA;EACA;EACA;CACF;AACF;AAEA,SAAS,uBAAgD,GAAS;CAChE,QAAQ,EAAE,MAAV;EACE,KAAK,WACH,OAAO;GAAC,MAAM;GAAW,OAAO,EAAE;EAAK;EACzC,KAAK,UACH,OAAO;GAAC,MAAM;GAAU,MAAM,EAAE;EAAI;EACtC,SACE,OAAO;GAAC,MAAM;GAAU,QAAQ,EAAE;GAAQ,OAAO,EAAE;EAAK;CAC5D;AACF;;;;;;;;;;;;;AAcA,SAAgB,mBAAmB,MAA4B;CAC7D,IAAI,qBAAqB,IAAI,IAAI,GAC/B,OAAO;CAET,IAAI,KAAK,SAAS,UAAU;EAC1B,MAAM,aAAwB;GAC5B,MAAM;GACN,IAAI,KAAK;GACT,MAAM,uBAAuB,KAAK,IAAI;GACtC,OAAO,uBAAuB,KAAK,KAAK;EAC1C;EACA,qBAAqB,IAAI,UAAU;EACnC,OAAO;CACT;CACA,IAAI,KAAK,SAAS,sBAAsB;EACtC,MAAM,aAAwB;GAC5B,MAAM;GACN,SAAS,kBAAkB,KAAK,OAAO;GACvC,IAAI,KAAK;GACT,MAAM,KAAK;GACX,QAAQ,KAAK;EACf;EACA,qBAAqB,IAAI,UAAU;EACnC,OAAO;CACT;CAKA,MAAM,aAA0B,CAAC;CACjC,KAAK,MAAM,KAAK,KAAK,YAAY;EAC/B,MAAM,IAAI,mBAAmB,CAAC;EAC9B,IAAI,EAAE,SAAS,KAAK,MAClB,WAAW,KAAK,GAAG,EAAE,UAAU;OAE/B,WAAW,KAAK,CAAC;CAErB;CAKA,IAAI,WAAW,WAAW,GACxB,OAAO,WAAW;CAEpB,WAAW,KAAK,YAAY;CAC5B,MAAM,aAAwB;EAAC,MAAM,KAAK;EAAM;CAAU;CAC1D,qBAAqB,IAAI,UAAU;CACnC,OAAO;AACT;;;;;;AAOA,SAAgB,OAAO,KAAU,QAAoB;CACnD,OAAO,aAAa,KAAK;EACvB,YAAW,UAAS,OAAO,UAAU,KAAK;EAC1C,aAAa,OAAO,QAAQ,OAAO,WAAW,OAAO,GAAG;CAC1D,CAAC;AACH;AAEA,SAAgB,aACd,MACA,OACA,QACA;CACA,OAAO,eAAe,MAAM,OAAO;EACjC,YAAW,UAAS,OAAO,UAAU,KAAK;EAC1C,aAAa,OAAO,QAAQ,OAAO,WAAW,OAAO,GAAG;CAC1D,CAAC;AACH;AAEA,SAAS,aAAa,GAAc,GAAsB;CACxD,IAAI,EAAE,SAAS,UAAU;EACvB,IAAI,EAAE,SAAS,UACb,OAAO;EAGT,OACE,qBAAqB,EAAE,MAAM,EAAE,IAAI,KACnC,qBAAqB,EAAE,IAAI,EAAE,EAAE,KAC/B,qBAAqB,EAAE,OAAO,EAAE,KAAK;CAEzC;CAEA,IAAI,EAAE,SAAS,UACb,OAAO;CAGT,IAAI,EAAE,SAAS,sBAAsB;EACnC,IAAI,EAAE,SAAS,sBACb,OAAO;EAET,OACE,WAAW,EAAE,SAAS,EAAE,OAAO,KAC/B,qBAAqB,EAAE,IAAI,EAAE,EAAE,KAC/B,gBAAgB,EAAE,MAAM,EAAE,IAAI,KAC9B,gBAAgB,EAAE,QAAQ,EAAE,MAAM;CAEtC;CACA,IAAI,EAAE,SAAS,sBACb,OAAO;CAGT,MAAM,MAAM,qBAAqB,EAAE,MAAM,EAAE,IAAI;CAC/C,IAAI,QAAQ,GACV,OAAO;CAET,KACE,IAAI,IAAI,GAAG,IAAI,GACf,IAAI,EAAE,WAAW,UAAU,IAAI,EAAE,WAAW,QAC5C,KAAK,KACL;EACA,MAAM,MAAM,aAAa,EAAE,WAAW,IAAI,EAAE,WAAW,EAAE;EACzD,IAAI,QAAQ,GACV,OAAO;CAEX;CAEA,OAAO,EAAE,WAAW,SAAS,EAAE,WAAW;AAC5C;AAEA,SAAS,qBAAqB,GAAkB,GAA0B;CACxE,IAAI,EAAE,SAAS,EAAE,MACf,OAAO,YAAY,EAAE,MAAM,EAAE,IAAI;CAEnC,QAAQ,EAAE,MAAV;EACE,KAAK;GACH,OAAO,EAAE,SAAS,WAAW,sCAAsC;GACnE,OAAO,gBAAgB,EAAE,OAAO,EAAE,KAAK;EACzC,KAAK;GACH,OAAO,EAAE,SAAS,UAAU,qCAAqC;GACjE,OAAO,YAAY,EAAE,MAAM,EAAE,IAAI;EACnC,KAAK;GACH,OAAO,EAAE,SAAS,UAAU,qCAAqC;GAGjE,OACE,YAAY,EAAE,QAAQ,EAAE,MAAM,KAAK,gBAAgB,EAAE,OAAO,EAAE,KAAK;CAEzE;AACF;AAMA,IAAM,sBAAsB;CAAC;CAAU;CAAW;CAAU;AAAQ;AAEpE,SAAS,iBAAiB,OAA6B;CACrD,OAAO,MAAM,QAAQ,KAAK,IACtB,oBAAoB,SACpB,oBAAoB,QAAQ,OAAO,KAAK;AAC9C;AAEA,SAAS,gBAAgB,GAAiB,GAAyB;CACjE,MAAM,OAAO,iBAAiB,CAAC,IAAI,iBAAiB,CAAC;CACrD,IAAI,SAAS,GACX,OAAO;CAGT,IAAI,MAAM,QAAQ,CAAC,GAAG;EACpB,OAAO,MAAM,QAAQ,CAAC,GAAG,+BAA+B;EACxD,KAAK,IAAI,IAAI,GAAG,IAAI,EAAE,UAAU,IAAI,EAAE,QAAQ,KAAK;GACjD,MAAM,MAAM,gBAAgB,EAAE,IAAI,EAAE,EAAE;GACtC,IAAI,QAAQ,GACV,OAAO;EAEX;EAEA,OAAO,EAAE,SAAS,EAAE;CACtB;CAEA,QAAQ,OAAO,GAAf;EACE,KAAK;GACH,OAAO,OAAO,MAAM,UAAU,gCAAgC;GAC9D,OAAO,YAAY,GAAG,CAAC;EACzB,KAAK;GACH,OAAO,OAAO,MAAM,UAAU,gCAAgC;GAC9D,OAAO,IAAI,IAAI,KAAK,IAAI,IAAI,IAAI;EAClC,KAAK;GACH,OAAO,OAAO,MAAM,WAAW,iCAAiC;GAChE,OAAO,OAAO,CAAC,IAAI,OAAO,CAAC;EAC7B,SACE,OAAO;CACX;AACF;AAEA,SAAS,WAAW,GAAuB,GAA+B;CACxE,OAAO,YAAY,KAAK,EAAE,SAAS,KAAK,GAAG,KAAK,EAAE,SAAS,KAAK,CAAC;AACnE;AAEA,SAAS,qBAAqB,GAAkB,GAA0B;CACxE,IAAI,MAAM,QAAQ,MAAM,MACtB,OAAO,YAAY,GAAG,CAAC;CAEzB,IAAI,MAAM,MACR,OAAO;CAET,IAAI,MAAM,MACR,OAAO;CAET,OAAO;AACT;AAEA,SAAS,gBACP,GACA,GACQ;CAER,MAAM,SAAS,MAA4B,MAAM,KAAA,IAAY,IAAI,IAAI,IAAI;CACzE,OAAO,MAAM,CAAC,IAAI,MAAM,CAAC;AAC3B"}
+{"version":3,"file":"ast.js","names":[],"sources":["../../../../zero-protocol/src/ast.ts"],"sourcesContent":["/**\n * Wire-format representation of the zql AST interface.\n *\n * `v.Type<...>` types are explicitly declared to facilitate Typescript verification\n * that the schemas satisfy the zql type definitions. (Incidentally, explicit types\n * are also required for recursive schema definitions.)\n */\n\nimport {compareUTF8} from 'compare-utf8';\nimport {defined} from '../../shared/src/arrays.ts';\nimport {assert} from '../../shared/src/asserts.ts';\nimport {must} from '../../shared/src/must.ts';\nimport * as v from '../../shared/src/valita.ts';\nimport type {NameMapper} from '../../zero-types/src/name-mapper.ts';\nimport {rowSchema, type Row} from './data.ts';\n\nexport const SUBQ_PREFIX = 'zsubq_';\n\nexport const selectorSchema = v.string();\nexport const toStaticParam = Symbol();\nexport const planIdSymbol = Symbol('planId');\n\nconst orderingElementSchema = v.readonly(\n  v.tuple([selectorSchema, v.literalUnion('asc', 'desc')]),\n);\n\nexport const orderingSchema = v.readonlyArray(orderingElementSchema);\nexport type System = 'permissions' | 'client' | 'test';\n\nexport const primitiveSchema = v.union(\n  v.string(),\n  v.number(),\n  v.boolean(),\n  v.null(),\n);\n\nexport const equalityOpsSchema = v.literalUnion('=', '!=', 'IS', 'IS NOT');\n\nexport const orderOpsSchema = v.literalUnion('<', '>', '<=', '>=');\n\nexport const likeOpsSchema = v.literalUnion(\n  'LIKE',\n  'NOT LIKE',\n  'ILIKE',\n  'NOT ILIKE',\n);\n\nexport const inOpsSchema = v.literalUnion('IN', 'NOT IN');\n\nexport const simpleOperatorSchema = v.union(\n  equalityOpsSchema,\n  orderOpsSchema,\n  likeOpsSchema,\n  inOpsSchema,\n);\n\nconst literalReferenceSchema: v.Type<LiteralReference> = v.readonlyObject({\n  type: v.literal('literal'),\n  value: v.union(\n    v.string(),\n    v.number(),\n    v.boolean(),\n    v.null(),\n    v.readonlyArray(v.union(v.string(), v.number(), v.boolean())),\n  ),\n});\nconst columnReferenceSchema: v.Type<ColumnReference> = v.readonlyObject({\n  type: v.literal('column'),\n  name: v.string(),\n});\n\n/**\n * A parameter is a value that is not known at the time the query is written\n * and is resolved at runtime.\n *\n * Static parameters refer to something provided by the caller.\n * Static parameters are injected when the query pipeline is built from the AST\n * and do not change for the life of that pipeline.\n *\n * An example static parameter is the current authentication data.\n * When a user is authenticated, queries on the server have access\n * to the user's authentication data in order to evaluate authorization rules.\n * Authentication data doesn't change over the life of a query as a change\n * in auth data would represent a log-in / log-out of the user.\n *\n * AncestorParameters refer to rows encountered while running the query.\n * They are used by subqueries to refer to rows emitted by parent queries.\n */\nconst parameterReferenceSchema = v.readonlyObject({\n  type: v.literal('static'),\n  // The \"namespace\" of the injected parameter.\n  // Write authorization will send the value of a row\n  // prior to the mutation being run (preMutationRow).\n  // Read and write authorization will both send the\n  // current authentication data (authData).\n  anchor: v.literalUnion('authData', 'preMutationRow'),\n  field: v.union(v.string(), v.array(v.string())),\n});\n\nconst conditionValueSchema = v.union(\n  literalReferenceSchema,\n  columnReferenceSchema,\n  parameterReferenceSchema,\n);\n\nexport type Parameter = v.Infer<typeof parameterReferenceSchema>;\n\nexport const simpleConditionSchema: v.Type<SimpleCondition> = v.readonlyObject({\n  type: v.literal('simple'),\n  op: simpleOperatorSchema,\n  left: conditionValueSchema,\n  right: v.union(parameterReferenceSchema, literalReferenceSchema),\n});\n\ntype ConditionValue = v.Infer<typeof conditionValueSchema>;\n\nexport const correlatedSubqueryConditionOperatorSchema: v.Type<CorrelatedSubqueryConditionOperator> =\n  v.literalUnion('EXISTS', 'NOT EXISTS');\n\nexport const correlatedSubqueryConditionSchema: v.Type<CorrelatedSubqueryCondition> =\n  v.readonlyObject({\n    type: v.literal('correlatedSubquery'),\n    related: v.lazy(() => correlatedSubquerySchema),\n    op: correlatedSubqueryConditionOperatorSchema,\n    flip: v.boolean().optional(),\n    scalar: v.boolean().optional(),\n  });\n\nexport const conditionSchema: v.Type<Condition> = v.union(\n  simpleConditionSchema,\n  v.lazy(() => conjunctionSchema),\n  v.lazy(() => disjunctionSchema),\n  correlatedSubqueryConditionSchema,\n);\n\nconst conjunctionSchema: v.Type<Conjunction> = v.readonlyObject({\n  type: v.literal('and'),\n  conditions: v.readonlyArray(conditionSchema),\n});\n\nconst disjunctionSchema: v.Type<Disjunction> = v.readonlyObject({\n  type: v.literal('or'),\n  conditions: v.readonlyArray(conditionSchema),\n});\n\nexport type CompoundKey = readonly [string, ...string[]];\n\nfunction mustCompoundKey(field: readonly string[]): CompoundKey {\n  assert(\n    Array.isArray(field) && field.length >= 1,\n    'Expected non-empty array for compound key',\n  );\n  return field as unknown as CompoundKey;\n}\n\nexport const compoundKeySchema: v.Type<CompoundKey> = v.readonly(\n  // oxlint-disable-next-line e18e/prefer-spread-syntax\n  v.tuple([v.string()]).concat(v.array(v.string())),\n);\n\nconst correlationSchema = v.readonlyObject({\n  parentField: compoundKeySchema,\n  childField: compoundKeySchema,\n});\n\n// Split out so that its inferred type can be checked against\n// Omit<CorrelatedSubquery, 'correlation'> in ast-type-test.ts.\n// The mutually-recursive reference of the 'other' field to astSchema\n// is the only thing added in v.lazy.  The v.lazy is necessary due to the\n// mutually-recursive types, but v.lazy prevents inference of the resulting\n// type.\nexport const correlatedSubquerySchemaOmitSubquery = v.readonlyObject({\n  correlation: correlationSchema,\n  hidden: v.boolean().optional(),\n  system: v.literalUnion('permissions', 'client', 'test').optional(),\n});\n\nexport const correlatedSubquerySchema: v.Type<CorrelatedSubquery> =\n  correlatedSubquerySchemaOmitSubquery.extend({\n    subquery: v.lazy(() => astSchema),\n  });\n\nexport const astSchema: v.Type<AST> = v.readonlyObject({\n  schema: v.string().optional(),\n  table: v.string(),\n  alias: v.string().optional(),\n  where: conditionSchema.optional(),\n  related: v.readonlyArray(correlatedSubquerySchema).optional(),\n  limit: v.number().optional(),\n  orderBy: orderingSchema.optional(),\n  start: v\n    .object({\n      row: rowSchema,\n      exclusive: v.boolean(),\n    })\n    .optional(),\n});\n\nexport type Bound = {\n  row: Row;\n  exclusive: boolean;\n};\n\n/**\n * As in SQL you can have multiple orderings. We don't currently\n * support ordering on anything other than the root query.\n */\nexport type OrderPart = readonly [field: string, direction: 'asc' | 'desc'];\nexport type Ordering = readonly OrderPart[];\n\nexport type SimpleOperator = EqualityOps | OrderOps | LikeOps | InOps;\nexport type EqualityOps = '=' | '!=' | 'IS' | 'IS NOT';\nexport type OrderOps = '<' | '>' | '<=' | '>=';\nexport type LikeOps = 'LIKE' | 'NOT LIKE' | 'ILIKE' | 'NOT ILIKE';\nexport type InOps = 'IN' | 'NOT IN';\n\nexport type AST = {\n  readonly schema?: string | undefined;\n  readonly table: string;\n\n  // A query would be aliased if the AST is a subquery.\n  // e.g., when two subqueries select from the same table\n  // they need an alias to differentiate them.\n  // `SELECT\n  //   [SELECT * FROM issue WHERE issue.id = outer.parentId] AS parent\n  //   [SELECT * FROM issue WHERE issue.parentId = outer.id] AS children\n  //  FROM issue as outer`\n  readonly alias?: string | undefined;\n\n  // `select` is missing given we return all columns for now.\n\n  // The PipelineBuilder will pick what to use to correlate\n  // a subquery with a parent query. It can choose something from the\n  // where conditions or choose the _first_ `related` entry.\n  // Choosing the first `related` entry is almost always the best choice if\n  // one exists.\n  readonly where?: Condition | undefined;\n\n  readonly related?: readonly CorrelatedSubquery[] | undefined;\n  readonly start?: Bound | undefined;\n  readonly limit?: number | undefined;\n  readonly orderBy?: Ordering | undefined;\n};\n\nexport type Correlation = {\n  readonly parentField: CompoundKey;\n  readonly childField: CompoundKey;\n};\n\nexport type CorrelatedSubquery = {\n  /**\n   * Only equality correlation are supported for now.\n   * E.g., direct foreign key relationships.\n   */\n  readonly correlation: Correlation;\n  readonly subquery: AST;\n  readonly system?: System | undefined;\n  // If a hop in the subquery chain should be hidden from the output view.\n  // A common example is junction edges. The query API provides the illusion\n  // that they don't exist: `issue.related('labels')` instead of `issue.related('issue_labels').related('labels')`.\n  // To maintain this illusion, the junction edge should be hidden.\n  // When `hidden` is set to true, this hop will not be included in the output view\n  // but its children will be.\n  readonly hidden?: boolean | undefined;\n};\n\nexport type ValuePosition = LiteralReference | Parameter | ColumnReference;\n\nexport type ColumnReference = {\n  readonly type: 'column';\n  /**\n   * Not a path yet as we're currently not allowing\n   * comparisons across tables. This will need to\n   * be a path through the tree in the near future.\n   */\n  readonly name: string;\n};\n\nexport type LiteralReference = {\n  readonly type: 'literal';\n  readonly value: LiteralValue;\n};\n\nexport type LiteralValue =\n  | string\n  | number\n  | boolean\n  | null\n  | ReadonlyArray<string | number | boolean>;\n\n/**\n * Starting only with SimpleCondition for now.\n * ivm1 supports Conjunctions and Disjunctions.\n * We'll support them in the future.\n */\nexport type Condition =\n  | SimpleCondition\n  | Conjunction\n  | Disjunction\n  | CorrelatedSubqueryCondition;\n\nexport type SimpleCondition = {\n  readonly type: 'simple';\n  readonly op: SimpleOperator;\n  readonly left: ValuePosition;\n\n  /**\n   * `null` is absent since we do not have an `IS` or `IS NOT`\n   * operator defined and `null != null` in SQL.\n   */\n  readonly right: Exclude<ValuePosition, ColumnReference>;\n};\n\nexport type Conjunction = {\n  type: 'and';\n  conditions: readonly Condition[];\n};\n\nexport type Disjunction = {\n  type: 'or';\n  conditions: readonly Condition[];\n};\n\nexport type CorrelatedSubqueryCondition = {\n  type: 'correlatedSubquery';\n  related: CorrelatedSubquery;\n  op: CorrelatedSubqueryConditionOperator;\n  flip?: boolean | undefined;\n  scalar?: boolean | undefined;\n  [planIdSymbol]?: number | undefined;\n};\n\nexport type CorrelatedSubqueryConditionOperator = 'EXISTS' | 'NOT EXISTS';\n\ninterface ASTTransform {\n  tableName(orig: string): string;\n  columnName(origTable: string, origColumn: string): string;\n  related(subqueries: CorrelatedSubquery[]): readonly CorrelatedSubquery[];\n  where(cond: Condition): Condition | undefined;\n  // conjunction or disjunction, called when traversing the return value of where()\n  conditions(conds: Condition[]): readonly Condition[];\n}\n\nfunction transformAST(ast: AST, transform: ASTTransform): Required<AST> {\n  // Name mapping functions (e.g. to server names)\n  const {tableName, columnName} = transform;\n  const colName = (c: string) => columnName(ast.table, c);\n  const key = (table: string, k: CompoundKey) => {\n    const serverKey = k.map(col => columnName(table, col));\n    return mustCompoundKey(serverKey);\n  };\n\n  const where = ast.where ? transform.where(ast.where) : undefined;\n  const transformed = {\n    schema: ast.schema,\n    table: tableName(ast.table),\n    alias: ast.alias,\n    where: where ? transformWhere(where, ast.table, transform) : undefined,\n    related: ast.related\n      ? transform.related(\n          ast.related.map(\n            r =>\n              ({\n                correlation: {\n                  parentField: key(ast.table, r.correlation.parentField),\n                  childField: key(r.subquery.table, r.correlation.childField),\n                },\n                hidden: r.hidden,\n                subquery: transformAST(r.subquery, transform),\n                system: r.system,\n              }) satisfies Required<CorrelatedSubquery>,\n          ),\n        )\n      : undefined,\n    start: ast.start\n      ? {\n          ...ast.start,\n          row: Object.fromEntries(\n            Object.entries(ast.start.row).map(([col, val]) => [\n              colName(col),\n              val,\n            ]),\n          ),\n        }\n      : undefined,\n    limit: ast.limit,\n    orderBy: ast.orderBy?.map(([col, dir]) => [colName(col), dir] as const),\n  };\n\n  return transformed;\n}\n\nfunction transformWhere(\n  where: Condition,\n  table: string,\n  transform: ASTTransform,\n): Condition {\n  // Name mapping functions (e.g. to server names)\n  const {columnName} = transform;\n  const condValue = (c: ConditionValue) =>\n    c.type !== 'column' ? c : {...c, name: columnName(table, c.name)};\n  const key = (table: string, k: CompoundKey) => {\n    const serverKey = k.map(col => columnName(table, col));\n    return mustCompoundKey(serverKey);\n  };\n\n  if (where.type === 'simple') {\n    return {...where, left: condValue(where.left)};\n  } else if (where.type === 'correlatedSubquery') {\n    const {correlation, subquery} = where.related;\n    return {\n      ...where,\n      related: {\n        ...where.related,\n        correlation: {\n          parentField: key(table, correlation.parentField),\n          childField: key(subquery.table, correlation.childField),\n        },\n        subquery: transformAST(subquery, transform),\n      },\n    };\n  }\n\n  return {\n    type: where.type,\n    conditions: transform.conditions(\n      where.conditions.map(c => transformWhere(c, table, transform)),\n    ),\n  };\n}\n\nconst normalizeCache = new WeakMap<AST, Required<AST>>();\n\nconst NORMALIZE_TRANSFORM: ASTTransform = {\n  tableName: t => t,\n  columnName: (_, c) => c,\n  related: sortedRelated,\n  where: flattened,\n  conditions: c => c.sort(cmpCondition),\n};\n\nexport function normalizeAST(ast: AST): Required<AST> {\n  let normalized = normalizeCache.get(ast);\n  if (!normalized) {\n    normalized = transformAST(ast, NORMALIZE_TRANSFORM);\n    normalizeCache.set(ast, normalized);\n  }\n  return normalized;\n}\n\nexport function mapAST(ast: AST, mapper: NameMapper) {\n  return transformAST(ast, {\n    tableName: table => mapper.tableName(table),\n    columnName: (table, col) => mapper.columnName(table, col),\n    related: r => r,\n    where: w => w,\n    conditions: c => c,\n  });\n}\n\nexport function mapCondition(\n  cond: Condition,\n  table: string,\n  mapper: NameMapper,\n) {\n  return transformWhere(cond, table, {\n    tableName: table => mapper.tableName(table),\n    columnName: (table, col) => mapper.columnName(table, col),\n    related: r => r,\n    where: w => w,\n    conditions: c => c,\n  });\n}\n\nfunction sortedRelated(\n  related: CorrelatedSubquery[],\n): readonly CorrelatedSubquery[] {\n  return related.sort(cmpRelated);\n}\n\nfunction cmpCondition(a: Condition, b: Condition): number {\n  if (a.type === 'simple') {\n    if (b.type !== 'simple') {\n      return -1; // Order SimpleConditions first\n    }\n\n    return (\n      compareValuePosition(a.left, b.left) ||\n      compareUTF8MaybeNull(a.op, b.op) ||\n      compareValuePosition(a.right, b.right)\n    );\n  }\n\n  if (b.type === 'simple') {\n    return 1; // Order SimpleConditions first\n  }\n\n  if (a.type === 'correlatedSubquery') {\n    if (b.type !== 'correlatedSubquery') {\n      return -1; // Order subquery before conjuctions/disjuctions\n    }\n    return (\n      cmpRelated(a.related, b.related) ||\n      compareUTF8MaybeNull(a.op, b.op) ||\n      cmpOptionalBool(a.flip, b.flip) ||\n      cmpOptionalBool(a.scalar, b.scalar)\n    );\n  }\n  if (b.type === 'correlatedSubquery') {\n    return -1; // Order correlatedSubquery before conjuctions/disjuctions\n  }\n\n  const val = compareUTF8MaybeNull(a.type, b.type);\n  if (val !== 0) {\n    return val;\n  }\n  for (\n    let l = 0, r = 0;\n    l < a.conditions.length && r < b.conditions.length;\n    l++, r++\n  ) {\n    const val = cmpCondition(a.conditions[l], b.conditions[r]);\n    if (val !== 0) {\n      return val;\n    }\n  }\n  // prefixes first\n  return a.conditions.length - b.conditions.length;\n}\n\nfunction compareValuePosition(a: ValuePosition, b: ValuePosition): number {\n  if (a.type !== b.type) {\n    return compareUTF8(a.type, b.type);\n  }\n  switch (a.type) {\n    case 'literal':\n      assert(b.type === 'literal', 'Expected literal type for comparison');\n      return compareUTF8(String(a.value), String(b.value));\n    case 'column':\n      assert(b.type === 'column', 'Expected column type for comparison');\n      return compareUTF8(a.name, b.name);\n    case 'static':\n      throw new Error(\n        'Static parameters should be resolved before normalization',\n      );\n  }\n}\n\nfunction cmpRelated(a: CorrelatedSubquery, b: CorrelatedSubquery): number {\n  return compareUTF8(must(a.subquery.alias), must(b.subquery.alias));\n}\n\n/**\n * Returns a flattened version of the Conditions in which nested Conjunctions with\n * the same operation ('AND' or 'OR') are flattened to the same level. e.g.\n *\n * ```\n * ((a AND b) AND (c AND (d OR (e OR f)))) -> (a AND b AND c AND (d OR e OR f))\n * ```\n *\n * Also flattens singleton Conjunctions regardless of operator, and removes\n * empty Conjunctions.\n */\nfunction flattened(cond: Condition): Condition | undefined {\n  if (cond.type === 'simple' || cond.type === 'correlatedSubquery') {\n    return cond;\n  }\n  const conditions = defined(\n    cond.conditions.flatMap(c =>\n      c.type === cond.type ? c.conditions.map(c => flattened(c)) : flattened(c),\n    ),\n  );\n\n  switch (conditions.length) {\n    case 0:\n      return undefined;\n    case 1:\n      return conditions[0];\n    default:\n      return {\n        type: cond.type,\n        conditions,\n      };\n  }\n}\n\nfunction compareUTF8MaybeNull(a: string | null, b: string | null): number {\n  if (a !== null && b !== null) {\n    return compareUTF8(a, b);\n  }\n  if (b !== null) {\n    return -1;\n  }\n  if (a !== null) {\n    return 1;\n  }\n  return 0;\n}\n\nfunction cmpOptionalBool(\n  a: boolean | undefined,\n  b: boolean | undefined,\n): number {\n  // undefined < false < true\n  const toNum = (v: boolean | undefined) => (v === undefined ? 0 : v ? 2 : 1);\n  return toNum(a) - toNum(b);\n}\n"],"mappings":";;;;;;;;;;;;;;AAgBA,IAAa,cAAc;AAE3B,IAAa,iBAAiB,eAAE,OAAO;AACvC,IAAa,gBAAgB,OAAO;AACpC,IAAa,eAAe,OAAO,QAAQ;AAM3C,IAAa,iBAAiB,cAJA,SAC5B,eAAE,MAAM,CAAC,gBAAgB,aAAe,OAAO,MAAM,CAAC,CAAC,CAGX,CAAqB;AAGpC,eAAE,MAC/B,eAAE,OAAO,GACT,eAAE,OAAO,GACT,eAAE,QAAQ,GACV,eAAE,KAAK,CACT;AAEA,IAAa,oBAAoB,aAAe,KAAK,MAAM,MAAM,QAAQ;AAEzE,IAAa,iBAAiB,aAAe,KAAK,KAAK,MAAM,IAAI;AAEjE,IAAa,gBAAgB,aAC3B,QACA,YACA,SACA,WACF;AAEA,IAAa,cAAc,aAAe,MAAM,QAAQ;AAExD,IAAa,uBAAuB,eAAE,MACpC,mBACA,gBACA,eACA,WACF;AAEA,IAAM,yBAAmD,eAAiB;CACxE,MAAM,eAAE,QAAQ,SAAS;CACzB,OAAO,eAAE,MACP,eAAE,OAAO,GACT,eAAE,OAAO,GACT,eAAE,QAAQ,GACV,eAAE,KAAK,GACP,cAAgB,eAAE,MAAM,eAAE,OAAO,GAAG,eAAE,OAAO,GAAG,eAAE,QAAQ,CAAC,CAAC,CAC9D;AACF,CAAC;AACD,IAAM,wBAAiD,eAAiB;CACtE,MAAM,eAAE,QAAQ,QAAQ;CACxB,MAAM,eAAE,OAAO;AACjB,CAAC;;;;;;;;;;;;;;;;;;AAmBD,IAAM,2BAA2B,eAAiB;CAChD,MAAM,eAAE,QAAQ,QAAQ;CAMxB,QAAQ,aAAe,YAAY,gBAAgB;CACnD,OAAO,eAAE,MAAM,eAAE,OAAO,GAAG,eAAE,MAAM,eAAE,OAAO,CAAC,CAAC;AAChD,CAAC;AAED,IAAM,uBAAuB,eAAE,MAC7B,wBACA,uBACA,wBACF;AAIA,IAAa,wBAAiD,eAAiB;CAC7E,MAAM,eAAE,QAAQ,QAAQ;CACxB,IAAI;CACJ,MAAM;CACN,OAAO,eAAE,MAAM,0BAA0B,sBAAsB;AACjE,CAAC;AAID,IAAa,4CACX,aAAe,UAAU,YAAY;AAEvC,IAAa,oCACX,eAAiB;CACf,MAAM,eAAE,QAAQ,oBAAoB;CACpC,SAAS,eAAE,WAAW,wBAAwB;CAC9C,IAAI;CACJ,MAAM,eAAE,QAAQ,EAAE,SAAS;CAC3B,QAAQ,eAAE,QAAQ,EAAE,SAAS;AAC/B,CAAC;AAEH,IAAa,kBAAqC,eAAE,MAClD,uBACA,eAAE,WAAW,iBAAiB,GAC9B,eAAE,WAAW,iBAAiB,GAC9B,iCACF;AAEA,IAAM,oBAAyC,eAAiB;CAC9D,MAAM,eAAE,QAAQ,KAAK;CACrB,YAAY,cAAgB,eAAe;AAC7C,CAAC;AAED,IAAM,oBAAyC,eAAiB;CAC9D,MAAM,eAAE,QAAQ,IAAI;CACpB,YAAY,cAAgB,eAAe;AAC7C,CAAC;AAID,SAAS,gBAAgB,OAAuC;CAC9D,OACE,MAAM,QAAQ,KAAK,KAAK,MAAM,UAAU,GACxC,2CACF;CACA,OAAO;AACT;AAEA,IAAa,oBAAyC,SAEpD,eAAE,MAAM,CAAC,eAAE,OAAO,CAAC,CAAC,EAAE,OAAO,eAAE,MAAM,eAAE,OAAO,CAAC,CAAC,CAClD;AAmBA,IAAa,2BANuC,eAAiB;CACnE,aAZwB,eAAiB;EACzC,aAAa;EACb,YAAY;CACd,CASe;CACb,QAAQ,eAAE,QAAQ,EAAE,SAAS;CAC7B,QAAQ,aAAe,eAAe,UAAU,MAAM,EAAE,SAAS;AACnE,CAGE,EAAqC,OAAO,EAC1C,UAAU,eAAE,WAAW,SAAS,EAClC,CAAC;AAEH,IAAa,YAAyB,eAAiB;CACrD,QAAQ,eAAE,OAAO,EAAE,SAAS;CAC5B,OAAO,eAAE,OAAO;CAChB,OAAO,eAAE,OAAO,EAAE,SAAS;CAC3B,OAAO,gBAAgB,SAAS;CAChC,SAAS,cAAgB,wBAAwB,EAAE,SAAS;CAC5D,OAAO,eAAE,OAAO,EAAE,SAAS;CAC3B,SAAS,eAAe,SAAS;CACjC,OAAO,eACJ,OAAO;EACN,KAAK;EACL,WAAW,eAAE,QAAQ;CACvB,CAAC,EACA,SAAS;AACd,CAAC;AAmJD,SAAS,aAAa,KAAU,WAAwC;CAEtE,MAAM,EAAC,WAAW,eAAc;CAChC,MAAM,WAAW,MAAc,WAAW,IAAI,OAAO,CAAC;CACtD,MAAM,OAAO,OAAe,MAAmB;EAE7C,OAAO,gBADW,EAAE,KAAI,QAAO,WAAW,OAAO,GAAG,CAC7B,CAAS;CAClC;CAEA,MAAM,QAAQ,IAAI,QAAQ,UAAU,MAAM,IAAI,KAAK,IAAI,KAAA;CAqCvD,OAAO;EAnCL,QAAQ,IAAI;EACZ,OAAO,UAAU,IAAI,KAAK;EAC1B,OAAO,IAAI;EACX,OAAO,QAAQ,eAAe,OAAO,IAAI,OAAO,SAAS,IAAI,KAAA;EAC7D,SAAS,IAAI,UACT,UAAU,QACR,IAAI,QAAQ,KACV,OACG;GACC,aAAa;IACX,aAAa,IAAI,IAAI,OAAO,EAAE,YAAY,WAAW;IACrD,YAAY,IAAI,EAAE,SAAS,OAAO,EAAE,YAAY,UAAU;GAC5D;GACA,QAAQ,EAAE;GACV,UAAU,aAAa,EAAE,UAAU,SAAS;GAC5C,QAAQ,EAAE;EACZ,EACJ,CACF,IACA,KAAA;EACJ,OAAO,IAAI,QACP;GACE,GAAG,IAAI;GACP,KAAK,OAAO,YACV,OAAO,QAAQ,IAAI,MAAM,GAAG,EAAE,KAAK,CAAC,KAAK,SAAS,CAChD,QAAQ,GAAG,GACX,GACF,CAAC,CACH;EACF,IACA,KAAA;EACJ,OAAO,IAAI;EACX,SAAS,IAAI,SAAS,KAAK,CAAC,KAAK,SAAS,CAAC,QAAQ,GAAG,GAAG,GAAG,CAAU;CAGjE;AACT;AAEA,SAAS,eACP,OACA,OACA,WACW;CAEX,MAAM,EAAC,eAAc;CACrB,MAAM,aAAa,MACjB,EAAE,SAAS,WAAW,IAAI;EAAC,GAAG;EAAG,MAAM,WAAW,OAAO,EAAE,IAAI;CAAC;CAClE,MAAM,OAAO,OAAe,MAAmB;EAE7C,OAAO,gBADW,EAAE,KAAI,QAAO,WAAW,OAAO,GAAG,CAC7B,CAAS;CAClC;CAEA,IAAI,MAAM,SAAS,UACjB,OAAO;EAAC,GAAG;EAAO,MAAM,UAAU,MAAM,IAAI;CAAC;MACxC,IAAI,MAAM,SAAS,sBAAsB;EAC9C,MAAM,EAAC,aAAa,aAAY,MAAM;EACtC,OAAO;GACL,GAAG;GACH,SAAS;IACP,GAAG,MAAM;IACT,aAAa;KACX,aAAa,IAAI,OAAO,YAAY,WAAW;KAC/C,YAAY,IAAI,SAAS,OAAO,YAAY,UAAU;IACxD;IACA,UAAU,aAAa,UAAU,SAAS;GAC5C;EACF;CACF;CAEA,OAAO;EACL,MAAM,MAAM;EACZ,YAAY,UAAU,WACpB,MAAM,WAAW,KAAI,MAAK,eAAe,GAAG,OAAO,SAAS,CAAC,CAC/D;CACF;AACF;AAEA,IAAM,iCAAiB,IAAI,QAA4B;AAEvD,IAAM,sBAAoC;CACxC,YAAW,MAAK;CAChB,aAAa,GAAG,MAAM;CACtB,SAAS;CACT,OAAO;CACP,aAAY,MAAK,EAAE,KAAK,YAAY;AACtC;AAEA,SAAgB,aAAa,KAAyB;CACpD,IAAI,aAAa,eAAe,IAAI,GAAG;CACvC,IAAI,CAAC,YAAY;EACf,aAAa,aAAa,KAAK,mBAAmB;EAClD,eAAe,IAAI,KAAK,UAAU;CACpC;CACA,OAAO;AACT;AAEA,SAAgB,OAAO,KAAU,QAAoB;CACnD,OAAO,aAAa,KAAK;EACvB,YAAW,UAAS,OAAO,UAAU,KAAK;EAC1C,aAAa,OAAO,QAAQ,OAAO,WAAW,OAAO,GAAG;EACxD,UAAS,MAAK;EACd,QAAO,MAAK;EACZ,aAAY,MAAK;CACnB,CAAC;AACH;AAEA,SAAgB,aACd,MACA,OACA,QACA;CACA,OAAO,eAAe,MAAM,OAAO;EACjC,YAAW,UAAS,OAAO,UAAU,KAAK;EAC1C,aAAa,OAAO,QAAQ,OAAO,WAAW,OAAO,GAAG;EACxD,UAAS,MAAK;EACd,QAAO,MAAK;EACZ,aAAY,MAAK;CACnB,CAAC;AACH;AAEA,SAAS,cACP,SAC+B;CAC/B,OAAO,QAAQ,KAAK,UAAU;AAChC;AAEA,SAAS,aAAa,GAAc,GAAsB;CACxD,IAAI,EAAE,SAAS,UAAU;EACvB,IAAI,EAAE,SAAS,UACb,OAAO;EAGT,OACE,qBAAqB,EAAE,MAAM,EAAE,IAAI,KACnC,qBAAqB,EAAE,IAAI,EAAE,EAAE,KAC/B,qBAAqB,EAAE,OAAO,EAAE,KAAK;CAEzC;CAEA,IAAI,EAAE,SAAS,UACb,OAAO;CAGT,IAAI,EAAE,SAAS,sBAAsB;EACnC,IAAI,EAAE,SAAS,sBACb,OAAO;EAET,OACE,WAAW,EAAE,SAAS,EAAE,OAAO,KAC/B,qBAAqB,EAAE,IAAI,EAAE,EAAE,KAC/B,gBAAgB,EAAE,MAAM,EAAE,IAAI,KAC9B,gBAAgB,EAAE,QAAQ,EAAE,MAAM;CAEtC;CACA,IAAI,EAAE,SAAS,sBACb,OAAO;CAGT,MAAM,MAAM,qBAAqB,EAAE,MAAM,EAAE,IAAI;CAC/C,IAAI,QAAQ,GACV,OAAO;CAET,KACE,IAAI,IAAI,GAAG,IAAI,GACf,IAAI,EAAE,WAAW,UAAU,IAAI,EAAE,WAAW,QAC5C,KAAK,KACL;EACA,MAAM,MAAM,aAAa,EAAE,WAAW,IAAI,EAAE,WAAW,EAAE;EACzD,IAAI,QAAQ,GACV,OAAO;CAEX;CAEA,OAAO,EAAE,WAAW,SAAS,EAAE,WAAW;AAC5C;AAEA,SAAS,qBAAqB,GAAkB,GAA0B;CACxE,IAAI,EAAE,SAAS,EAAE,MACf,OAAO,YAAY,EAAE,MAAM,EAAE,IAAI;CAEnC,QAAQ,EAAE,MAAV;EACE,KAAK;GACH,OAAO,EAAE,SAAS,WAAW,sCAAsC;GACnE,OAAO,YAAY,OAAO,EAAE,KAAK,GAAG,OAAO,EAAE,KAAK,CAAC;EACrD,KAAK;GACH,OAAO,EAAE,SAAS,UAAU,qCAAqC;GACjE,OAAO,YAAY,EAAE,MAAM,EAAE,IAAI;EACnC,KAAK,UACH,MAAM,IAAI,MACR,2DACF;CACJ;AACF;AAEA,SAAS,WAAW,GAAuB,GAA+B;CACxE,OAAO,YAAY,KAAK,EAAE,SAAS,KAAK,GAAG,KAAK,EAAE,SAAS,KAAK,CAAC;AACnE;;;;;;;;;;;;AAaA,SAAS,UAAU,MAAwC;CACzD,IAAI,KAAK,SAAS,YAAY,KAAK,SAAS,sBAC1C,OAAO;CAET,MAAM,aAAa,QACjB,KAAK,WAAW,SAAQ,MACtB,EAAE,SAAS,KAAK,OAAO,EAAE,WAAW,KAAI,MAAK,UAAU,CAAC,CAAC,IAAI,UAAU,CAAC,CAC1E,CACF;CAEA,QAAQ,WAAW,QAAnB;EACE,KAAK,GACH;EACF,KAAK,GACH,OAAO,WAAW;EACpB,SACE,OAAO;GACL,MAAM,KAAK;GACX;EACF;CACJ;AACF;AAEA,SAAS,qBAAqB,GAAkB,GAA0B;CACxE,IAAI,MAAM,QAAQ,MAAM,MACtB,OAAO,YAAY,GAAG,CAAC;CAEzB,IAAI,MAAM,MACR,OAAO;CAET,IAAI,MAAM,MACR,OAAO;CAET,OAAO;AACT;AAEA,SAAS,gBACP,GACA,GACQ;CAER,MAAM,SAAS,MAA4B,MAAM,KAAA,IAAY,IAAI,IAAI,IAAI;CACzE,OAAO,MAAM,CAAC,IAAI,MAAM,CAAC;AAC3B"}

package/out/zero-protocol/src/connect.d.ts

@@ -1,4 +1,5 @@
 import * as v from '../../shared/src/valita.ts';
+import { ProtocolFlags } from './protocol-flag.ts';
 /**
  * After opening a websocket the client waits for a `connected` message
  * from the server.  It then sends an `initConnection` message to the
@@ -100,6 +101,18 @@ export type ConnectedBody = v.Infer<typeof connectedBodySchema>;
 export type ConnectedMessage = v.Infer<typeof connectedMessageSchema>;
 export type InitConnectionBody = v.Infer<typeof initConnectionBodySchema>;
 export type InitConnectionMessage = v.Infer<typeof initConnectionMessageSchema>;
+/**
+ * Adds the client's protocol flags to the connect URL: every flag this client
+ * knows.
+ */
+export declare function setProtocolFlags(params: URLSearchParams): void;
+/**
+ * Reads the protocol flags a client sent in the connect URL. A flag it didn't
+ * send means the server's default. Flags this server doesn't know are dropped,
+ * and a malformed value counts as no flags, so newer clients can always
+ * connect.
+ */
+export declare function getProtocolFlags(params: URLSearchParams): ProtocolFlags;
 export declare function encodeSecProtocols(initConnectionMessage: InitConnectionMessage | undefined, authToken: string | undefined): string;
 export declare function decodeSecProtocols(secProtocol: string): {
     initConnectionMessage: InitConnectionMessage | undefined;

package/out/zero-protocol/src/connect.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"connect.d.ts","sourceRoot":"","sources":["../../../../zero-protocol/src/connect.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,4BAA4B,CAAC;AAKhD;;;;;;GAMG;AAEH,eAAO,MAAM,mBAAmB;;;aAG9B,CAAC;AAEH,eAAO,MAAM,sBAAsB;;;eAGjC,CAAC;AAEH,QAAA,MAAM,wBAAwB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IAe5B;;;;;OAKG;;IAEH,sDAAsD;;aAEtD,CAAC;AAEH,eAAO,MAAM,2BAA2B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IAXtC;;;;;OAKG;;IAEH,sDAAsD;;eAOtD,CAAC;AAEH,MAAM,MAAM,aAAa,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,mBAAmB,CAAC,CAAC;AAChE,MAAM,MAAM,gBAAgB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,sBAAsB,CAAC,CAAC;AACtE,MAAM,MAAM,kBAAkB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,wBAAwB,CAAC,CAAC;AAC1E,MAAM,MAAM,qBAAqB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,2BAA2B,CAAC,CAAC;AAEhF,wBAAgB,kBAAkB,CAChC,qBAAqB,EAAE,qBAAqB,GAAG,SAAS,EACxD,SAAS,EAAE,MAAM,GAAG,SAAS,GAC5B,MAAM,CAgBR;AAED,wBAAgB,kBAAkB,CAAC,WAAW,EAAE,MAAM,GAAG;IACvD,qBAAqB,EAAE,qBAAqB,GAAG,SAAS,CAAC;IACzD,SAAS,EAAE,MAAM,GAAG,SAAS,CAAC;CAC/B,CAIA"}
+{"version":3,"file":"connect.d.ts","sourceRoot":"","sources":["../../../../zero-protocol/src/connect.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,CAAC,MAAM,4BAA4B,CAAC;AAGhD,OAAO,EAAe,aAAa,EAAC,MAAM,oBAAoB,CAAC;AAG/D;;;;;;GAMG;AAEH,eAAO,MAAM,mBAAmB;;;aAG9B,CAAC;AAEH,eAAO,MAAM,sBAAsB;;;eAGjC,CAAC;AAEH,QAAA,MAAM,wBAAwB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IAe5B;;;;;OAKG;;IAEH,sDAAsD;;aAEtD,CAAC;AAEH,eAAO,MAAM,2BAA2B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IAXtC;;;;;OAKG;;IAEH,sDAAsD;;eAOtD,CAAC;AAEH,MAAM,MAAM,aAAa,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,mBAAmB,CAAC,CAAC;AAChE,MAAM,MAAM,gBAAgB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,sBAAsB,CAAC,CAAC;AACtE,MAAM,MAAM,kBAAkB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,wBAAwB,CAAC,CAAC;AAC1E,MAAM,MAAM,qBAAqB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,2BAA2B,CAAC,CAAC;AAMhF;;;GAGG;AACH,wBAAgB,gBAAgB,CAAC,MAAM,EAAE,eAAe,GAAG,IAAI,CAO9D;AAED;;;;;GAKG;AACH,wBAAgB,gBAAgB,CAAC,MAAM,EAAE,eAAe,GAAG,aAAa,CAYvE;AAED,wBAAgB,kBAAkB,CAChC,qBAAqB,EAAE,qBAAqB,GAAG,SAAS,EACxD,SAAS,EAAE,MAAM,GAAG,SAAS,GAC5B,MAAM,CAgBR;AAED,wBAAgB,kBAAkB,CAAC,WAAW,EAAE,MAAM,GAAG;IACvD,qBAAqB,EAAE,qBAAqB,GAAG,SAAS,CAAC;IACzD,SAAS,EAAE,MAAM,GAAG,SAAS,CAAC;CAC/B,CAIA"}

package/out/zero-protocol/src/connect.js

@@ -1,6 +1,9 @@
 import { valita_exports } from "../../shared/src/valita.js";
 import { clientSchemaSchema } from "./client-schema.js";
+import { fromBase64url, toBase64url } from "../../shared/src/base64.js";
 import { deleteClientsBodySchema } from "./delete-clients.js";
+import { protocol_flag_enum_exports } from "./protocol-flag-enum.js";
+import { ProtocolFlags } from "./protocol-flag.js";
 import { upQueriesPatchSchema } from "./queries-patch.js";
 //#region ../zero-protocol/src/connect.ts
 /**
@@ -34,6 +37,32 @@ var initConnectionBodySchema = valita_exports.object({
 	traceparent: valita_exports.string().optional()
 });
 var initConnectionMessageSchema = valita_exports.tuple([valita_exports.literal("initConnection"), initConnectionBodySchema]);
+var PROTOCOL_FLAGS_PARAM = "f";
+/**
+* Adds the client's protocol flags to the connect URL: every flag this client
+* knows.
+*/
+function setProtocolFlags(params) {
+	const flags = Object.values(protocol_flag_enum_exports);
+	const bytes = new Uint8Array((Math.max(...flags) >> 3) + 1);
+	for (const flag of flags) bytes[flag >> 3] |= 1 << (flag & 7);
+	params.set(PROTOCOL_FLAGS_PARAM, toBase64url(bytes));
+}
+/**
+* Reads the protocol flags a client sent in the connect URL. A flag it didn't
+* send means the server's default. Flags this server doesn't know are dropped,
+* and a malformed value counts as no flags, so newer clients can always
+* connect.
+*/
+function getProtocolFlags(params) {
+	let bytes;
+	try {
+		bytes = fromBase64url(params.get(PROTOCOL_FLAGS_PARAM) ?? "");
+	} catch {
+		return new ProtocolFlags();
+	}
+	return new ProtocolFlags(Object.values(protocol_flag_enum_exports).filter((flag) => ((bytes[flag >> 3] ?? 0) >> (flag & 7) & 1) !== 0));
+}
 function encodeSecProtocols(initConnectionMessage, authToken) {
 	const protocols = {
 		initConnectionMessage,
@@ -49,6 +78,6 @@ function decodeSecProtocols(secProtocol) {
 	return JSON.parse(new TextDecoder().decode(bytes));
 }
 //#endregion
-export { connectedMessageSchema, decodeSecProtocols, encodeSecProtocols, initConnectionMessageSchema };
+export { connectedMessageSchema, decodeSecProtocols, encodeSecProtocols, getProtocolFlags, initConnectionMessageSchema, setProtocolFlags };
 
 //# sourceMappingURL=connect.js.map

package/out/zero-protocol/src/connect.js.map

@@ -1 +1 @@
-{"version":3,"file":"connect.js","names":[],"sources":["../../../../zero-protocol/src/connect.ts"],"sourcesContent":["import * as v from '../../shared/src/valita.ts';\nimport {clientSchemaSchema} from './client-schema.ts';\nimport {deleteClientsBodySchema} from './delete-clients.ts';\nimport {upQueriesPatchSchema} from './queries-patch.ts';\n\n/**\n * After opening a websocket the client waits for a `connected` message\n * from the server.  It then sends an `initConnection` message to the\n * server.  The server waits for the `initConnection` message before\n * beginning to send pokes to the newly connected client, so as to avoid\n * syncing lots of queries which are no longer desired by the client.\n */\n\nexport const connectedBodySchema = v.object({\n  wsid: v.string(),\n  timestamp: v.number().optional(),\n});\n\nexport const connectedMessageSchema = v.tuple([\n  v.literal('connected'),\n  connectedBodySchema,\n]);\n\nconst initConnectionBodySchema = v.object({\n  desiredQueriesPatch: upQueriesPatchSchema,\n  // As the schema can be large, client only sends when it does not have a\n  // server snapshot (i.e. a snapshot with a cookie).  Once it has a server\n  // snapshot it will assume the zero-cache already has the schema for this\n  // client's client group in the CVR store.\n  clientSchema: clientSchemaSchema.optional(),\n  deleted: deleteClientsBodySchema.optional(),\n  // parameters to configure the mutate endpoint\n  userPushURL: v.string().optional(),\n  userPushHeaders: v.record(v.string()).optional(),\n  // parameters to configure the query endpoint\n  userQueryURL: v.string().optional(),\n  userQueryHeaders: v.record(v.string()).optional(),\n\n  /**\n   * `activeClients` is an optional array of client IDs that are currently active\n   * in the client group. This is used to inform the server about the clients\n   * that are currently active (aka running, aka alive), so it can inactive\n   * queries from inactive clients.\n   */\n  activeClients: v.array(v.string()).optional(),\n  /** W3C traceparent header for distributed tracing. */\n  traceparent: v.string().optional(),\n});\n\nexport const initConnectionMessageSchema = v.tuple([\n  v.literal('initConnection'),\n  initConnectionBodySchema,\n]);\n\nexport type ConnectedBody = v.Infer<typeof connectedBodySchema>;\nexport type ConnectedMessage = v.Infer<typeof connectedMessageSchema>;\nexport type InitConnectionBody = v.Infer<typeof initConnectionBodySchema>;\nexport type InitConnectionMessage = v.Infer<typeof initConnectionMessageSchema>;\n\nexport function encodeSecProtocols(\n  initConnectionMessage: InitConnectionMessage | undefined,\n  authToken: string | undefined,\n): string {\n  const protocols = {\n    initConnectionMessage,\n    authToken,\n  };\n  // WS sec protocols needs to be URI encoded. To save space, we base64 encode\n  // the JSON before URI encoding it. But InitConnectionMessage can contain\n  // arbitrary unicode strings, so we need to encode the JSON as UTF-8 first.\n  // Phew!\n  const bytes = new TextEncoder().encode(JSON.stringify(protocols));\n\n  // Convert bytes to string without spreading all bytes as arguments\n  // to avoid \"Maximum call stack size exceeded\" error with large data\n  const s = Array.from(bytes, byte => String.fromCharCode(byte)).join('');\n\n  return encodeURIComponent(btoa(s));\n}\n\nexport function decodeSecProtocols(secProtocol: string): {\n  initConnectionMessage: InitConnectionMessage | undefined;\n  authToken: string | undefined;\n} {\n  const binString = atob(decodeURIComponent(secProtocol));\n  const bytes = Uint8Array.from(binString, c => c.charCodeAt(0));\n  return JSON.parse(new TextDecoder().decode(bytes));\n}\n"],"mappings":";;;;;;;;;;;;AAaA,IAAa,sBAAsB,eAAE,OAAO;CAC1C,MAAM,eAAE,OAAO;CACf,WAAW,eAAE,OAAO,EAAE,SAAS;AACjC,CAAC;AAED,IAAa,yBAAyB,eAAE,MAAM,CAC5C,eAAE,QAAQ,WAAW,GACrB,mBACF,CAAC;AAED,IAAM,2BAA2B,eAAE,OAAO;CACxC,qBAAqB;CAKrB,cAAc,mBAAmB,SAAS;CAC1C,SAAS,wBAAwB,SAAS;CAE1C,aAAa,eAAE,OAAO,EAAE,SAAS;CACjC,iBAAiB,eAAE,OAAO,eAAE,OAAO,CAAC,EAAE,SAAS;CAE/C,cAAc,eAAE,OAAO,EAAE,SAAS;CAClC,kBAAkB,eAAE,OAAO,eAAE,OAAO,CAAC,EAAE,SAAS;;;;;;;CAQhD,eAAe,eAAE,MAAM,eAAE,OAAO,CAAC,EAAE,SAAS;;CAE5C,aAAa,eAAE,OAAO,EAAE,SAAS;AACnC,CAAC;AAED,IAAa,8BAA8B,eAAE,MAAM,CACjD,eAAE,QAAQ,gBAAgB,GAC1B,wBACF,CAAC;AAOD,SAAgB,mBACd,uBACA,WACQ;CACR,MAAM,YAAY;EAChB;EACA;CACF;CAKA,MAAM,QAAQ,IAAI,YAAY,EAAE,OAAO,KAAK,UAAU,SAAS,CAAC;CAIhE,MAAM,IAAI,MAAM,KAAK,QAAO,SAAQ,OAAO,aAAa,IAAI,CAAC,EAAE,KAAK,EAAE;CAEtE,OAAO,mBAAmB,KAAK,CAAC,CAAC;AACnC;AAEA,SAAgB,mBAAmB,aAGjC;CACA,MAAM,YAAY,KAAK,mBAAmB,WAAW,CAAC;CACtD,MAAM,QAAQ,WAAW,KAAK,YAAW,MAAK,EAAE,WAAW,CAAC,CAAC;CAC7D,OAAO,KAAK,MAAM,IAAI,YAAY,EAAE,OAAO,KAAK,CAAC;AACnD"}
+{"version":3,"file":"connect.js","names":[],"sources":["../../../../zero-protocol/src/connect.ts"],"sourcesContent":["import {fromBase64url, toBase64url} from '../../shared/src/base64.ts';\nimport * as v from '../../shared/src/valita.ts';\nimport {clientSchemaSchema} from './client-schema.ts';\nimport {deleteClientsBodySchema} from './delete-clients.ts';\nimport {ProtocolFlag, ProtocolFlags} from './protocol-flag.ts';\nimport {upQueriesPatchSchema} from './queries-patch.ts';\n\n/**\n * After opening a websocket the client waits for a `connected` message\n * from the server.  It then sends an `initConnection` message to the\n * server.  The server waits for the `initConnection` message before\n * beginning to send pokes to the newly connected client, so as to avoid\n * syncing lots of queries which are no longer desired by the client.\n */\n\nexport const connectedBodySchema = v.object({\n  wsid: v.string(),\n  timestamp: v.number().optional(),\n});\n\nexport const connectedMessageSchema = v.tuple([\n  v.literal('connected'),\n  connectedBodySchema,\n]);\n\nconst initConnectionBodySchema = v.object({\n  desiredQueriesPatch: upQueriesPatchSchema,\n  // As the schema can be large, client only sends when it does not have a\n  // server snapshot (i.e. a snapshot with a cookie).  Once it has a server\n  // snapshot it will assume the zero-cache already has the schema for this\n  // client's client group in the CVR store.\n  clientSchema: clientSchemaSchema.optional(),\n  deleted: deleteClientsBodySchema.optional(),\n  // parameters to configure the mutate endpoint\n  userPushURL: v.string().optional(),\n  userPushHeaders: v.record(v.string()).optional(),\n  // parameters to configure the query endpoint\n  userQueryURL: v.string().optional(),\n  userQueryHeaders: v.record(v.string()).optional(),\n\n  /**\n   * `activeClients` is an optional array of client IDs that are currently active\n   * in the client group. This is used to inform the server about the clients\n   * that are currently active (aka running, aka alive), so it can inactive\n   * queries from inactive clients.\n   */\n  activeClients: v.array(v.string()).optional(),\n  /** W3C traceparent header for distributed tracing. */\n  traceparent: v.string().optional(),\n});\n\nexport const initConnectionMessageSchema = v.tuple([\n  v.literal('initConnection'),\n  initConnectionBodySchema,\n]);\n\nexport type ConnectedBody = v.Infer<typeof connectedBodySchema>;\nexport type ConnectedMessage = v.Infer<typeof connectedMessageSchema>;\nexport type InitConnectionBody = v.Infer<typeof initConnectionBodySchema>;\nexport type InitConnectionMessage = v.Infer<typeof initConnectionMessageSchema>;\n\n// The connect URL parameter that carries the protocol flags: a bit set with\n// flag n at bit n % 8 of byte floor(n / 8), in unpadded base64url.\nconst PROTOCOL_FLAGS_PARAM = 'f';\n\n/**\n * Adds the client's protocol flags to the connect URL: every flag this client\n * knows.\n */\nexport function setProtocolFlags(params: URLSearchParams): void {\n  const flags = Object.values(ProtocolFlag);\n  const bytes = new Uint8Array((Math.max(...flags) >> 3) + 1);\n  for (const flag of flags) {\n    bytes[flag >> 3] |= 1 << (flag & 7);\n  }\n  params.set(PROTOCOL_FLAGS_PARAM, toBase64url(bytes));\n}\n\n/**\n * Reads the protocol flags a client sent in the connect URL. A flag it didn't\n * send means the server's default. Flags this server doesn't know are dropped,\n * and a malformed value counts as no flags, so newer clients can always\n * connect.\n */\nexport function getProtocolFlags(params: URLSearchParams): ProtocolFlags {\n  let bytes: Uint8Array;\n  try {\n    bytes = fromBase64url(params.get(PROTOCOL_FLAGS_PARAM) ?? '');\n  } catch {\n    return new ProtocolFlags();\n  }\n  return new ProtocolFlags(\n    Object.values(ProtocolFlag).filter(\n      flag => (((bytes[flag >> 3] ?? 0) >> (flag & 7)) & 1) !== 0,\n    ),\n  );\n}\n\nexport function encodeSecProtocols(\n  initConnectionMessage: InitConnectionMessage | undefined,\n  authToken: string | undefined,\n): string {\n  const protocols = {\n    initConnectionMessage,\n    authToken,\n  };\n  // WS sec protocols needs to be URI encoded. To save space, we base64 encode\n  // the JSON before URI encoding it. But InitConnectionMessage can contain\n  // arbitrary unicode strings, so we need to encode the JSON as UTF-8 first.\n  // Phew!\n  const bytes = new TextEncoder().encode(JSON.stringify(protocols));\n\n  // Convert bytes to string without spreading all bytes as arguments\n  // to avoid \"Maximum call stack size exceeded\" error with large data\n  const s = Array.from(bytes, byte => String.fromCharCode(byte)).join('');\n\n  return encodeURIComponent(btoa(s));\n}\n\nexport function decodeSecProtocols(secProtocol: string): {\n  initConnectionMessage: InitConnectionMessage | undefined;\n  authToken: string | undefined;\n} {\n  const binString = atob(decodeURIComponent(secProtocol));\n  const bytes = Uint8Array.from(binString, c => c.charCodeAt(0));\n  return JSON.parse(new TextDecoder().decode(bytes));\n}\n"],"mappings":";;;;;;;;;;;;;;;AAeA,IAAa,sBAAsB,eAAE,OAAO;CAC1C,MAAM,eAAE,OAAO;CACf,WAAW,eAAE,OAAO,EAAE,SAAS;AACjC,CAAC;AAED,IAAa,yBAAyB,eAAE,MAAM,CAC5C,eAAE,QAAQ,WAAW,GACrB,mBACF,CAAC;AAED,IAAM,2BAA2B,eAAE,OAAO;CACxC,qBAAqB;CAKrB,cAAc,mBAAmB,SAAS;CAC1C,SAAS,wBAAwB,SAAS;CAE1C,aAAa,eAAE,OAAO,EAAE,SAAS;CACjC,iBAAiB,eAAE,OAAO,eAAE,OAAO,CAAC,EAAE,SAAS;CAE/C,cAAc,eAAE,OAAO,EAAE,SAAS;CAClC,kBAAkB,eAAE,OAAO,eAAE,OAAO,CAAC,EAAE,SAAS;;;;;;;CAQhD,eAAe,eAAE,MAAM,eAAE,OAAO,CAAC,EAAE,SAAS;;CAE5C,aAAa,eAAE,OAAO,EAAE,SAAS;AACnC,CAAC;AAED,IAAa,8BAA8B,eAAE,MAAM,CACjD,eAAE,QAAQ,gBAAgB,GAC1B,wBACF,CAAC;AASD,IAAM,uBAAuB;;;;;AAM7B,SAAgB,iBAAiB,QAA+B;CAC9D,MAAM,QAAQ,OAAO,OAAO,0BAAY;CACxC,MAAM,QAAQ,IAAI,YAAY,KAAK,IAAI,GAAG,KAAK,KAAK,KAAK,CAAC;CAC1D,KAAK,MAAM,QAAQ,OACjB,MAAM,QAAQ,MAAM,MAAM,OAAO;CAEnC,OAAO,IAAI,sBAAsB,YAAY,KAAK,CAAC;AACrD;;;;;;;AAQA,SAAgB,iBAAiB,QAAwC;CACvE,IAAI;CACJ,IAAI;EACF,QAAQ,cAAc,OAAO,IAAI,oBAAoB,KAAK,EAAE;CAC9D,QAAQ;EACN,OAAO,IAAI,cAAc;CAC3B;CACA,OAAO,IAAI,cACT,OAAO,OAAO,0BAAY,EAAE,QAC1B,WAAW,MAAM,QAAQ,MAAM,OAAO,OAAO,KAAM,OAAO,CAC5D,CACF;AACF;AAEA,SAAgB,mBACd,uBACA,WACQ;CACR,MAAM,YAAY;EAChB;EACA;CACF;CAKA,MAAM,QAAQ,IAAI,YAAY,EAAE,OAAO,KAAK,UAAU,SAAS,CAAC;CAIhE,MAAM,IAAI,MAAM,KAAK,QAAO,SAAQ,OAAO,aAAa,IAAI,CAAC,EAAE,KAAK,EAAE;CAEtE,OAAO,mBAAmB,KAAK,CAAC,CAAC;AACnC;AAEA,SAAgB,mBAAmB,aAGjC;CACA,MAAM,YAAY,KAAK,mBAAmB,WAAW,CAAC;CACtD,MAAM,QAAQ,WAAW,KAAK,YAAW,MAAK,EAAE,WAAW,CAAC,CAAC;CAC7D,OAAO,KAAK,MAAM,IAAI,YAAY,EAAE,OAAO,KAAK,CAAC;AACnD"}

package/out/zero-protocol/src/down.d.ts

@@ -265,7 +265,7 @@ export declare const downstreamSchema: v.UnionType<[v.TupleType<[v.Type<"connect
             ordering?: readonly (readonly [string, "desc" | "asc"])[] | undefined;
             joinType?: "semi" | "flipped" | "unflippable" | undefined;
             type: "node-cost";
-            nodeType: "join" | "filter" | "connection" | "fan-out" | "fan-in" | "terminus";
+            nodeType: "join" | "connection" | "fan-out" | "fan-in" | "terminus";
             node: string;
             branchPattern: number[];
             downstreamChildSelectivity: number;
@@ -281,7 +281,7 @@ export declare const downstreamSchema: v.UnionType<[v.TupleType<[v.Type<"connect
             attemptNumber?: number | undefined;
             constraint?: Record<string, unknown> | null | undefined;
             type: "node-constraint";
-            nodeType: "join" | "filter" | "connection" | "fan-out" | "fan-in" | "terminus";
+            nodeType: "join" | "connection" | "fan-out" | "fan-in" | "terminus";
             node: string;
             branchPattern: number[];
             from: string;

package/out/zero-protocol/src/error.d.ts

@@ -94,7 +94,7 @@ export declare const transformFailedBodySchema: v.UnionType<[v.ObjectType<Omit<{
     reason: v.Type<"parse" | "timeout" | "internal">;
 }, undefined>]>;
 export declare const errorBodySchema: v.UnionType<[v.ObjectType<{
-    kind: v.Type<"Unauthorized" | "AuthInvalidated" | "ClientNotFound" | "InvalidConnectionRequest" | "InvalidConnectionRequestBaseCookie" | "InvalidConnectionRequestLastMutationID" | "InvalidConnectionRequestClientDeleted" | "InvalidMessage" | "InvalidPush" | "MutationFailed" | "MutationRateLimited" | "VersionNotSupported" | "SchemaVersionNotSupported" | "Internal">;
+    kind: v.Type<"AuthInvalidated" | "ClientNotFound" | "InvalidConnectionRequest" | "InvalidConnectionRequestBaseCookie" | "InvalidConnectionRequestLastMutationID" | "InvalidConnectionRequestClientDeleted" | "InvalidMessage" | "InvalidPush" | "MutationFailed" | "MutationRateLimited" | "Unauthorized" | "VersionNotSupported" | "SchemaVersionNotSupported" | "Internal">;
     message: v.Type<string>;
     origin: v.Optional<"server" | "zeroCache">;
 }, undefined>, v.ObjectType<{

package/out/zero-protocol/src/inspect-down.d.ts

@@ -174,7 +174,7 @@ export declare const inspectAnalyzeQueryDownSchema: v.ObjectType<Omit<{
             ordering?: readonly (readonly [string, "desc" | "asc"])[] | undefined;
             joinType?: "semi" | "flipped" | "unflippable" | undefined;
             type: "node-cost";
-            nodeType: "join" | "filter" | "connection" | "fan-out" | "fan-in" | "terminus";
+            nodeType: "join" | "connection" | "fan-out" | "fan-in" | "terminus";
             node: string;
             branchPattern: number[];
             downstreamChildSelectivity: number;
@@ -190,7 +190,7 @@ export declare const inspectAnalyzeQueryDownSchema: v.ObjectType<Omit<{
             attemptNumber?: number | undefined;
             constraint?: Record<string, unknown> | null | undefined;
             type: "node-constraint";
-            nodeType: "join" | "filter" | "connection" | "fan-out" | "fan-in" | "terminus";
+            nodeType: "join" | "connection" | "fan-out" | "fan-in" | "terminus";
             node: string;
             branchPattern: number[];
             from: string;
@@ -340,7 +340,7 @@ export declare const inspectDownBodySchema: v.UnionType<[v.ObjectType<Omit<{
             ordering?: readonly (readonly [string, "desc" | "asc"])[] | undefined;
             joinType?: "semi" | "flipped" | "unflippable" | undefined;
             type: "node-cost";
-            nodeType: "join" | "filter" | "connection" | "fan-out" | "fan-in" | "terminus";
+            nodeType: "join" | "connection" | "fan-out" | "fan-in" | "terminus";
             node: string;
             branchPattern: number[];
             downstreamChildSelectivity: number;
@@ -356,7 +356,7 @@ export declare const inspectDownBodySchema: v.UnionType<[v.ObjectType<Omit<{
             attemptNumber?: number | undefined;
             constraint?: Record<string, unknown> | null | undefined;
             type: "node-constraint";
-            nodeType: "join" | "filter" | "connection" | "fan-out" | "fan-in" | "terminus";
+            nodeType: "join" | "connection" | "fan-out" | "fan-in" | "terminus";
             node: string;
             branchPattern: number[];
             from: string;
@@ -503,7 +503,7 @@ export declare const inspectDownMessageSchema: v.TupleType<[v.Type<"inspect">, v
             ordering?: readonly (readonly [string, "desc" | "asc"])[] | undefined;
             joinType?: "semi" | "flipped" | "unflippable" | undefined;
             type: "node-cost";
-            nodeType: "join" | "filter" | "connection" | "fan-out" | "fan-in" | "terminus";
+            nodeType: "join" | "connection" | "fan-out" | "fan-in" | "terminus";
             node: string;
             branchPattern: number[];
             downstreamChildSelectivity: number;
@@ -519,7 +519,7 @@ export declare const inspectDownMessageSchema: v.TupleType<[v.Type<"inspect">, v
             attemptNumber?: number | undefined;
             constraint?: Record<string, unknown> | null | undefined;
             type: "node-constraint";
-            nodeType: "join" | "filter" | "connection" | "fan-out" | "fan-in" | "terminus";
+            nodeType: "join" | "connection" | "fan-out" | "fan-in" | "terminus";
             node: string;
             branchPattern: number[];
             from: string;

package/out/zero-protocol/src/poke.d.ts

@@ -12,8 +12,9 @@ import * as v from '../../shared/src/valita.ts';
  * the poke is updating from and the `cookie` the poke is updating to.
  *
  * Through protocol version 51, the poke continues with zero to many
- * `poke-part` JSON messages. Starting in version 52, it continues with zero to
- * many binary `pokeChunk` messages. Each binary message starts with a message
+ * `poke-part` JSON messages. Starting in version 52, or when the client sends
+ * the `PokeChunk` protocol flag, it continues with zero to many binary
+ * `pokeChunk` messages instead. Each binary message starts with a message
  * type byte. Concatenating and decoding the payload after that byte produces a
  * PokePartBody array. pokeChunk boundaries have no semantic meaning.
  *
@@ -270,9 +271,15 @@ export type PokeParts = v.Infer<typeof pokePartsSchema>;
 export type PokeEndBody = v.Infer<typeof pokeEndBodySchema>;
 /** The first byte identifying a binary WebSocket message as a poke chunk. */
 export declare const POKE_CHUNK_MESSAGE_TYPE = 0;
-/** The first protocol version that receives binary poke chunks. */
+/**
+ * The first protocol version that receives binary poke chunks without the
+ * `PokeChunk` protocol flag.
+ */
 export declare const POKE_CHUNK_PROTOCOL_VERSION = 52;
-/** The last protocol version that receives JSON pokePart messages. */
+/**
+ * The last protocol version that receives JSON pokePart messages unless the
+ * client sends the `PokeChunk` protocol flag.
+ */
 export declare const LAST_POKE_PART_PROTOCOL_VERSION = 51;
 /** A tagged binary poke chunk WebSocket message. */
 export type PokeChunk = Uint8Array;

package/out/zero-protocol/src/poke.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"poke.d.ts","sourceRoot":"","sources":["../../../../zero-protocol/src/poke.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,4BAA4B,CAAC;AAMhD;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AAEH,eAAO,MAAM,mBAAmB;;;IAM9B;;;OAGG;;;;;;aAQH,CAAC;AAEH,eAAO,MAAM,kBAAkB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;aAa7B,CAAC;AAEH;;;;GAIG;AACH,eAAO,MAAM,eAAe;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;cAA8B,CAAC;AAE3D,eAAO,MAAM,iBAAiB;;;;aAO5B,CAAC;AAEH,eAAO,MAAM,sBAAsB;;;IA5CjC;;;OAGG;;;;;;eA4CH,CAAC;AACH,eAAO,MAAM,qBAAqB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;eAGhC,CAAC;AACH,eAAO,MAAM,oBAAoB;;;;eAG/B,CAAC;AAEH,MAAM,MAAM,aAAa,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,mBAAmB,CAAC,CAAC;AAChE,MAAM,MAAM,YAAY,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,kBAAkB,CAAC,CAAC;AAC9D,MAAM,MAAM,SAAS,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,eAAe,CAAC,CAAC;AACxD,MAAM,MAAM,WAAW,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,iBAAiB,CAAC,CAAC;AAE5D,6EAA6E;AAC7E,eAAO,MAAM,uBAAuB,IAAO,CAAC;AAE5C,mEAAmE;AACnE,eAAO,MAAM,2BAA2B,KAAK,CAAC;AAE9C,sEAAsE;AACtE,eAAO,MAAM,+BAA+B,KAAK,CAAC;AAElD,oDAAoD;AACpD,MAAM,MAAM,SAAS,GAAG,UAAU,CAAC;AAEnC,MAAM,MAAM,gBAAgB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,sBAAsB,CAAC,CAAC;AACtE,MAAM,MAAM,eAAe,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,qBAAqB,CAAC,CAAC;AACpE,MAAM,MAAM,cAAc,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,oBAAoB,CAAC,CAAC"}
+{"version":3,"file":"poke.d.ts","sourceRoot":"","sources":["../../../../zero-protocol/src/poke.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,4BAA4B,CAAC;AAMhD;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AAEH,eAAO,MAAM,mBAAmB;;;IAM9B;;;OAGG;;;;;;aAQH,CAAC;AAEH,eAAO,MAAM,kBAAkB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;aAa7B,CAAC;AAEH;;;;GAIG;AACH,eAAO,MAAM,eAAe;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;cAA8B,CAAC;AAE3D,eAAO,MAAM,iBAAiB;;;;aAO5B,CAAC;AAEH,eAAO,MAAM,sBAAsB;;;IA5CjC;;;OAGG;;;;;;eA4CH,CAAC;AACH,eAAO,MAAM,qBAAqB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;eAGhC,CAAC;AACH,eAAO,MAAM,oBAAoB;;;;eAG/B,CAAC;AAEH,MAAM,MAAM,aAAa,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,mBAAmB,CAAC,CAAC;AAChE,MAAM,MAAM,YAAY,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,kBAAkB,CAAC,CAAC;AAC9D,MAAM,MAAM,SAAS,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,eAAe,CAAC,CAAC;AACxD,MAAM,MAAM,WAAW,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,iBAAiB,CAAC,CAAC;AAE5D,6EAA6E;AAC7E,eAAO,MAAM,uBAAuB,IAAO,CAAC;AAE5C;;;GAGG;AACH,eAAO,MAAM,2BAA2B,KAAK,CAAC;AAE9C;;;GAGG;AACH,eAAO,MAAM,+BAA+B,KAAK,CAAC;AAElD,oDAAoD;AACpD,MAAM,MAAM,SAAS,GAAG,UAAU,CAAC;AAEnC,MAAM,MAAM,gBAAgB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,sBAAsB,CAAC,CAAC;AACtE,MAAM,MAAM,eAAe,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,qBAAqB,CAAC,CAAC;AACpE,MAAM,MAAM,cAAc,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,oBAAoB,CAAC,CAAC"}

package/out/zero-protocol/src/poke.js

@@ -17,8 +17,9 @@ import { nullableVersionSchema, versionSchema } from "./version.js";
 * the poke is updating from and the `cookie` the poke is updating to.
 *
 * Through protocol version 51, the poke continues with zero to many
-* `poke-part` JSON messages. Starting in version 52, it continues with zero to
-* many binary `pokeChunk` messages. Each binary message starts with a message
+* `poke-part` JSON messages. Starting in version 52, or when the client sends
+* the `PokeChunk` protocol flag, it continues with zero to many binary
+* `pokeChunk` messages instead. Each binary message starts with a message
 * type byte. Concatenating and decoding the payload after that byte produces a
 * PokePartBody array. pokeChunk boundaries have no semantic meaning.
 *

package/out/zero-protocol/src/poke.js.map

@@ -1 +1 @@
-{"version":3,"file":"poke.js","names":[],"sources":["../../../../zero-protocol/src/poke.ts"],"sourcesContent":["import * as v from '../../shared/src/valita.ts';\nimport {mutationsPatchSchema} from './mutations-patch.ts';\nimport {queriesPatchSchema} from './queries-patch.ts';\nimport {rowsPatchSchema} from './row-patch.ts';\nimport {nullableVersionSchema, versionSchema} from './version.ts';\n\n/**\n * Pokes use a multi-part format. Pokes send entity data to the client and can\n * be multiple mega-bytes in size. Using a multi-part format allows the server\n * to avoid having to have the full poke in memory at one time.\n *\n * Each poke is assigned a `pokeID`, a unique id (within the context of the\n * connection) for identifying the poke.  All messages for a poke will have the\n * same `pokeID`.\n *\n * A poke begins with a `poke-start` message which contains the `baseCookie`\n * the poke is updating from and the `cookie` the poke is updating to.\n *\n * Through protocol version 51, the poke continues with zero to many\n * `poke-part` JSON messages. Starting in version 52, it continues with zero to\n * many binary `pokeChunk` messages. Each binary message starts with a message\n * type byte. Concatenating and decoding the payload after that byte produces a\n * PokePartBody array. pokeChunk boundaries have no semantic meaning.\n *\n * Finally, the poke ends with a `poke-end` message. The decoded patches can\n * now be applied as a whole to update from `baseCookie` to `cookie`.\n *\n * Poke messages can be intermingled with other `down` messages, but cannot be\n * intermingled with poke messages for a different `pokeID`. If this is\n * observed it is an unexpected error; the client should ignore both pokes,\n * disconnect, and reconnect.\n */\n\nexport const pokeStartBodySchema = v.object({\n  pokeID: v.string(),\n  // We always specify a Version as our cookie, but Replicache starts clients\n  // with initial cookie `null`, before the first request. So we have to be\n  // able to send a base cookie with value `null` to match that state.\n  baseCookie: nullableVersionSchema,\n  /**\n   * This field is always set if the poke contains a `rowsPatch`.\n   * It may be absent for patches that only update clients and queries.\n   */\n  schemaVersions: v\n    .object({\n      minSupportedVersion: v.number(),\n      maxSupportedVersion: v.number(),\n    })\n    .optional(),\n  timestamp: v.number().optional(),\n});\n\nexport const pokePartBodySchema = v.object({\n  // Changes to last mutation id by client id.\n  lastMutationIDChanges: v.record(v.number()).optional(),\n  // Patches to the desired query sets by client id.\n  desiredQueriesPatches: v.record(queriesPatchSchema).optional(),\n  // Patches to the set of queries for which entities are sync'd in\n  // rowsPatch.\n  gotQueriesPatch: queriesPatchSchema.optional(),\n  // Patches to the rows set.\n  rowsPatch: rowsPatchSchema.optional(),\n  // Mutation results patch\n  mutationsPatch: mutationsPatchSchema.optional(),\n  pokeID: v.string(),\n});\n\n/**\n * The logical payload carried by binary poke chunks. Chunk boundaries are\n * arbitrary; concatenating and decoding all chunks for a poke produces this\n * array.\n */\nexport const pokePartsSchema = v.array(pokePartBodySchema);\n\nexport const pokeEndBodySchema = v.object({\n  pokeID: v.string(),\n  // Note: This should be ignored (and may be empty) if cancel === `true`.\n  cookie: versionSchema,\n  // If `true`, the poke with id `pokeID` should be discarded without\n  // applying it.\n  cancel: v.boolean().optional(),\n});\n\nexport const pokeStartMessageSchema = v.tuple([\n  v.literal('pokeStart'),\n  pokeStartBodySchema,\n]);\nexport const pokePartMessageSchema = v.tuple([\n  v.literal('pokePart'),\n  pokePartBodySchema,\n]);\nexport const pokeEndMessageSchema = v.tuple([\n  v.literal('pokeEnd'),\n  pokeEndBodySchema,\n]);\n\nexport type PokeStartBody = v.Infer<typeof pokeStartBodySchema>;\nexport type PokePartBody = v.Infer<typeof pokePartBodySchema>;\nexport type PokeParts = v.Infer<typeof pokePartsSchema>;\nexport type PokeEndBody = v.Infer<typeof pokeEndBodySchema>;\n\n/** The first byte identifying a binary WebSocket message as a poke chunk. */\nexport const POKE_CHUNK_MESSAGE_TYPE = 0x00;\n\n/** The first protocol version that receives binary poke chunks. */\nexport const POKE_CHUNK_PROTOCOL_VERSION = 52;\n\n/** The last protocol version that receives JSON pokePart messages. */\nexport const LAST_POKE_PART_PROTOCOL_VERSION = 51;\n\n/** A tagged binary poke chunk WebSocket message. */\nexport type PokeChunk = Uint8Array;\n\nexport type PokeStartMessage = v.Infer<typeof pokeStartMessageSchema>;\nexport type PokePartMessage = v.Infer<typeof pokePartMessageSchema>;\nexport type PokeEndMessage = v.Infer<typeof pokeEndMessageSchema>;\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAiCA,IAAa,sBAAsB,eAAE,OAAO;CAC1C,QAAQ,eAAE,OAAO;CAIjB,YAAY;;;;;CAKZ,gBAAgB,eACb,OAAO;EACN,qBAAqB,eAAE,OAAO;EAC9B,qBAAqB,eAAE,OAAO;CAChC,CAAC,EACA,SAAS;CACZ,WAAW,eAAE,OAAO,EAAE,SAAS;AACjC,CAAC;AAED,IAAa,qBAAqB,eAAE,OAAO;CAEzC,uBAAuB,eAAE,OAAO,eAAE,OAAO,CAAC,EAAE,SAAS;CAErD,uBAAuB,eAAE,OAAO,kBAAkB,EAAE,SAAS;CAG7D,iBAAiB,mBAAmB,SAAS;CAE7C,WAAW,gBAAgB,SAAS;CAEpC,gBAAgB,qBAAqB,SAAS;CAC9C,QAAQ,eAAE,OAAO;AACnB,CAAC;;;;;;AAOD,IAAa,kBAAkB,eAAE,MAAM,kBAAkB;AAEzD,IAAa,oBAAoB,eAAE,OAAO;CACxC,QAAQ,eAAE,OAAO;CAEjB,QAAQ;CAGR,QAAQ,eAAE,QAAQ,EAAE,SAAS;AAC/B,CAAC;AAED,IAAa,yBAAyB,eAAE,MAAM,CAC5C,eAAE,QAAQ,WAAW,GACrB,mBACF,CAAC;AACD,IAAa,wBAAwB,eAAE,MAAM,CAC3C,eAAE,QAAQ,UAAU,GACpB,kBACF,CAAC;AACD,IAAa,uBAAuB,eAAE,MAAM,CAC1C,eAAE,QAAQ,SAAS,GACnB,iBACF,CAAC"}
+{"version":3,"file":"poke.js","names":[],"sources":["../../../../zero-protocol/src/poke.ts"],"sourcesContent":["import * as v from '../../shared/src/valita.ts';\nimport {mutationsPatchSchema} from './mutations-patch.ts';\nimport {queriesPatchSchema} from './queries-patch.ts';\nimport {rowsPatchSchema} from './row-patch.ts';\nimport {nullableVersionSchema, versionSchema} from './version.ts';\n\n/**\n * Pokes use a multi-part format. Pokes send entity data to the client and can\n * be multiple mega-bytes in size. Using a multi-part format allows the server\n * to avoid having to have the full poke in memory at one time.\n *\n * Each poke is assigned a `pokeID`, a unique id (within the context of the\n * connection) for identifying the poke.  All messages for a poke will have the\n * same `pokeID`.\n *\n * A poke begins with a `poke-start` message which contains the `baseCookie`\n * the poke is updating from and the `cookie` the poke is updating to.\n *\n * Through protocol version 51, the poke continues with zero to many\n * `poke-part` JSON messages. Starting in version 52, or when the client sends\n * the `PokeChunk` protocol flag, it continues with zero to many binary\n * `pokeChunk` messages instead. Each binary message starts with a message\n * type byte. Concatenating and decoding the payload after that byte produces a\n * PokePartBody array. pokeChunk boundaries have no semantic meaning.\n *\n * Finally, the poke ends with a `poke-end` message. The decoded patches can\n * now be applied as a whole to update from `baseCookie` to `cookie`.\n *\n * Poke messages can be intermingled with other `down` messages, but cannot be\n * intermingled with poke messages for a different `pokeID`. If this is\n * observed it is an unexpected error; the client should ignore both pokes,\n * disconnect, and reconnect.\n */\n\nexport const pokeStartBodySchema = v.object({\n  pokeID: v.string(),\n  // We always specify a Version as our cookie, but Replicache starts clients\n  // with initial cookie `null`, before the first request. So we have to be\n  // able to send a base cookie with value `null` to match that state.\n  baseCookie: nullableVersionSchema,\n  /**\n   * This field is always set if the poke contains a `rowsPatch`.\n   * It may be absent for patches that only update clients and queries.\n   */\n  schemaVersions: v\n    .object({\n      minSupportedVersion: v.number(),\n      maxSupportedVersion: v.number(),\n    })\n    .optional(),\n  timestamp: v.number().optional(),\n});\n\nexport const pokePartBodySchema = v.object({\n  // Changes to last mutation id by client id.\n  lastMutationIDChanges: v.record(v.number()).optional(),\n  // Patches to the desired query sets by client id.\n  desiredQueriesPatches: v.record(queriesPatchSchema).optional(),\n  // Patches to the set of queries for which entities are sync'd in\n  // rowsPatch.\n  gotQueriesPatch: queriesPatchSchema.optional(),\n  // Patches to the rows set.\n  rowsPatch: rowsPatchSchema.optional(),\n  // Mutation results patch\n  mutationsPatch: mutationsPatchSchema.optional(),\n  pokeID: v.string(),\n});\n\n/**\n * The logical payload carried by binary poke chunks. Chunk boundaries are\n * arbitrary; concatenating and decoding all chunks for a poke produces this\n * array.\n */\nexport const pokePartsSchema = v.array(pokePartBodySchema);\n\nexport const pokeEndBodySchema = v.object({\n  pokeID: v.string(),\n  // Note: This should be ignored (and may be empty) if cancel === `true`.\n  cookie: versionSchema,\n  // If `true`, the poke with id `pokeID` should be discarded without\n  // applying it.\n  cancel: v.boolean().optional(),\n});\n\nexport const pokeStartMessageSchema = v.tuple([\n  v.literal('pokeStart'),\n  pokeStartBodySchema,\n]);\nexport const pokePartMessageSchema = v.tuple([\n  v.literal('pokePart'),\n  pokePartBodySchema,\n]);\nexport const pokeEndMessageSchema = v.tuple([\n  v.literal('pokeEnd'),\n  pokeEndBodySchema,\n]);\n\nexport type PokeStartBody = v.Infer<typeof pokeStartBodySchema>;\nexport type PokePartBody = v.Infer<typeof pokePartBodySchema>;\nexport type PokeParts = v.Infer<typeof pokePartsSchema>;\nexport type PokeEndBody = v.Infer<typeof pokeEndBodySchema>;\n\n/** The first byte identifying a binary WebSocket message as a poke chunk. */\nexport const POKE_CHUNK_MESSAGE_TYPE = 0x00;\n\n/**\n * The first protocol version that receives binary poke chunks without the\n * `PokeChunk` protocol flag.\n */\nexport const POKE_CHUNK_PROTOCOL_VERSION = 52;\n\n/**\n * The last protocol version that receives JSON pokePart messages unless the\n * client sends the `PokeChunk` protocol flag.\n */\nexport const LAST_POKE_PART_PROTOCOL_VERSION = 51;\n\n/** A tagged binary poke chunk WebSocket message. */\nexport type PokeChunk = Uint8Array;\n\nexport type PokeStartMessage = v.Infer<typeof pokeStartMessageSchema>;\nexport type PokePartMessage = v.Infer<typeof pokePartMessageSchema>;\nexport type PokeEndMessage = v.Infer<typeof pokeEndMessageSchema>;\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAkCA,IAAa,sBAAsB,eAAE,OAAO;CAC1C,QAAQ,eAAE,OAAO;CAIjB,YAAY;;;;;CAKZ,gBAAgB,eACb,OAAO;EACN,qBAAqB,eAAE,OAAO;EAC9B,qBAAqB,eAAE,OAAO;CAChC,CAAC,EACA,SAAS;CACZ,WAAW,eAAE,OAAO,EAAE,SAAS;AACjC,CAAC;AAED,IAAa,qBAAqB,eAAE,OAAO;CAEzC,uBAAuB,eAAE,OAAO,eAAE,OAAO,CAAC,EAAE,SAAS;CAErD,uBAAuB,eAAE,OAAO,kBAAkB,EAAE,SAAS;CAG7D,iBAAiB,mBAAmB,SAAS;CAE7C,WAAW,gBAAgB,SAAS;CAEpC,gBAAgB,qBAAqB,SAAS;CAC9C,QAAQ,eAAE,OAAO;AACnB,CAAC;;;;;;AAOD,IAAa,kBAAkB,eAAE,MAAM,kBAAkB;AAEzD,IAAa,oBAAoB,eAAE,OAAO;CACxC,QAAQ,eAAE,OAAO;CAEjB,QAAQ;CAGR,QAAQ,eAAE,QAAQ,EAAE,SAAS;AAC/B,CAAC;AAED,IAAa,yBAAyB,eAAE,MAAM,CAC5C,eAAE,QAAQ,WAAW,GACrB,mBACF,CAAC;AACD,IAAa,wBAAwB,eAAE,MAAM,CAC3C,eAAE,QAAQ,UAAU,GACpB,kBACF,CAAC;AACD,IAAa,uBAAuB,eAAE,MAAM,CAC1C,eAAE,QAAQ,SAAS,GACnB,iBACF,CAAC"}

package/out/zero-protocol/src/protocol-flag-enum.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Binary poke chunks instead of JSON `pokePart` messages. Defaults to on for
+ * clients at protocol version 52 or above.
+ */
+export declare const PokeChunk = 0;
+export type PokeChunk = typeof PokeChunk;
+//# sourceMappingURL=protocol-flag-enum.d.ts.map

package/out/zero-protocol/src/protocol-flag-enum.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"protocol-flag-enum.d.ts","sourceRoot":"","sources":["../../../../zero-protocol/src/protocol-flag-enum.ts"],"names":[],"mappings":"AAaA;;;GAGG;AACH,eAAO,MAAM,SAAS,IAAI,CAAC;AAE3B,MAAM,MAAM,SAAS,GAAG,OAAO,SAAS,CAAC"}

package/out/zero-protocol/src/protocol-flag-enum.js

@@ -0,0 +1,7 @@
+import { __exportAll } from "../../_virtual/_rolldown/runtime.js";
+//#region ../zero-protocol/src/protocol-flag-enum.ts
+var protocol_flag_enum_exports = /* @__PURE__ */ __exportAll({ PokeChunk: () => 0 });
+//#endregion
+export { protocol_flag_enum_exports };
+
+//# sourceMappingURL=protocol-flag-enum.js.map

package/out/zero-protocol/src/protocol-flag-enum.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"protocol-flag-enum.js","names":[],"sources":["../../../../zero-protocol/src/protocol-flag-enum.ts"],"sourcesContent":["// Protocol flags let a client ask for behavior that an older server can\n// ignore, without raising CLIENT_PROTOCOL_VERSION (see protocol-version.ts).\n//\n// The client sends its flags in one connect URL parameter (setProtocolFlags in\n// connect.ts). A flag the client doesn't send means the server's default. A\n// server ignores flags it doesn't know, so the client must keep supporting the\n// old behavior. A client can't turn off a feature that is on by default; to let\n// it, add a flag that turns the feature off.\n//\n// The numbers are part of the wire protocol: they are bit positions in that\n// parameter. Never change a flag's number, and never reuse the number of a\n// retired flag.\n\n/**\n * Binary poke chunks instead of JSON `pokePart` messages. Defaults to on for\n * clients at protocol version 52 or above.\n */\nexport const PokeChunk = 0;\n\nexport type PokeChunk = typeof PokeChunk;\n"],"mappings":""}

package/out/zero-protocol/src/protocol-flag.d.ts

@@ -0,0 +1,14 @@
+import type { Enum } from '../../shared/src/enum.ts';
+import * as ProtocolFlagEnum from './protocol-flag-enum.ts';
+export { ProtocolFlagEnum as ProtocolFlag };
+export type ProtocolFlag = Enum<typeof ProtocolFlagEnum>;
+/** A set of protocol flags. */
+export type ProtocolFlags = ReadonlySet<Enum<typeof ProtocolFlagEnum>>;
+/** `Set`, typed so that `new ProtocolFlags()` needs no type argument. */
+export declare const ProtocolFlags: {
+    new (values?: readonly 0[] | null | undefined): Set<0>;
+    new (iterable?: Iterable<0> | null | undefined): Set<0>;
+    readonly prototype: Set<any>;
+    readonly [Symbol.species]: SetConstructor;
+};
+//# sourceMappingURL=protocol-flag.d.ts.map

package/out/zero-protocol/src/protocol-flag.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"protocol-flag.d.ts","sourceRoot":"","sources":["../../../../zero-protocol/src/protocol-flag.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAC,IAAI,EAAC,MAAM,0BAA0B,CAAC;AACnD,OAAO,KAAK,gBAAgB,MAAM,yBAAyB,CAAC;AAE5D,OAAO,EAAC,gBAAgB,IAAI,YAAY,EAAC,CAAC;AAC1C,MAAM,MAAM,YAAY,GAAG,IAAI,CAAC,OAAO,gBAAgB,CAAC,CAAC;AAKzD,+BAA+B;AAC/B,MAAM,MAAM,aAAa,GAAG,WAAW,CAAC,IAAI,CAAC,OAAO,gBAAgB,CAAC,CAAC,CAAC;AAEvE,yEAAyE;AACzE,eAAO,MAAM,aAAa;;;;;CAAqC,CAAC"}

package/out/zero-protocol/src/protocol-flag.js

@@ -0,0 +1,8 @@
+import "./protocol-flag-enum.js";
+//#region ../zero-protocol/src/protocol-flag.ts
+/** `Set`, typed so that `new ProtocolFlags()` needs no type argument. */
+var ProtocolFlags = Set;
+//#endregion
+export { ProtocolFlags };
+
+//# sourceMappingURL=protocol-flag.js.map

package/out/zero-protocol/src/protocol-flag.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"protocol-flag.js","names":[],"sources":["../../../../zero-protocol/src/protocol-flag.ts"],"sourcesContent":["import type {Enum} from '../../shared/src/enum.ts';\nimport * as ProtocolFlagEnum from './protocol-flag-enum.ts';\n\nexport {ProtocolFlagEnum as ProtocolFlag};\nexport type ProtocolFlag = Enum<typeof ProtocolFlagEnum>;\n\n// Spelled out instead of using ProtocolFlag: TypeScript 6 can't emit\n// declarations that refer to a name this file both re-exports and declares.\n\n/** A set of protocol flags. */\nexport type ProtocolFlags = ReadonlySet<Enum<typeof ProtocolFlagEnum>>;\n\n/** `Set`, typed so that `new ProtocolFlags()` needs no type argument. */\nexport const ProtocolFlags = Set<Enum<typeof ProtocolFlagEnum>>;\n"],"mappings":";;;AAaA,IAAa,gBAAgB"}

package/out/zero-protocol/src/protocol-version.d.ts

@@ -1,16 +1,40 @@
 /**
- * The current `PROTOCOL_VERSION` of the code.
+ * The highest sync protocol version `zero-cache` accepts (i.e. the version
+ * declared in the "/sync/v{#}/connect" URL). Clients send
+ * {@link CLIENT_PROTOCOL_VERSION}.
  *
- * The `PROTOCOL_VERSION` encompasses both the wire-protocol of the `/sync/...`
+ * The protocol encompasses both the wire-protocol of the `/sync/...`
  * connection between the browser and `zero-cache`, as well as the format of
  * the `AST` objects stored in both components (i.e. IDB and CVR).
  *
- * A change in the `AST` schema (e.g. new functionality added) must be
- * accompanied by an increment of the `PROTOCOL_VERSION` and a new major
- * release. The server (`zero-cache`) must be deployed before clients start
- * running the new code.
+ * A client one release ahead of the server must still be able to connect, so
+ * that clients and `zero-cache` can be updated and rolled back in either
+ * order. Two rules keep that working:
+ *
+ * 1. A change an old server can ignore goes behind a protocol flag (see
+ *    `protocol-flag-enum.ts`) and the client keeps sending the same
+ *    {@link CLIENT_PROTOCOL_VERSION}. Old servers ignore flags they don't
+ *    know, so the client must keep supporting the old behavior.
+ * 2. A change an old server can't ignore (e.g. new `AST` functionality)
+ *    increments `PROTOCOL_VERSION` one release before clients start sending
+ *    it in {@link CLIENT_PROTOCOL_VERSION}.
  */
 export declare const PROTOCOL_VERSION = 52;
+/**
+ * The sync protocol version clients send in the "/sync/v{#}/connect" URL.
+ *
+ * Kept below {@link PROTOCOL_VERSION} so that clients can connect to servers
+ * from earlier releases: 1.9 servers accept versions up to 51. Clients ask for
+ * newer behavior with protocol flags instead (rule 1 above). Only increase it
+ * to a version that every supported server already accepts (rule 2 above).
+ *
+ * This number is also part of the client's local database name (Replicache
+ * `schemaVersion`). Changing it opens a fresh local database, which drops
+ * unsent mutations because Zero disables mutation recovery. Canary clients
+ * already used 52 and 53 in their database names, so if the name changes it
+ * must move above 53; reusing 52 or 53 would open a stale canary database.
+ */
+export declare const CLIENT_PROTOCOL_VERSION = 51;
 /**
  * The minimum server-supported sync protocol version (i.e. the version
  * declared in the "/sync/v{#}/connect" URL).

package/out/zero-protocol/src/protocol-version.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"protocol-version.d.ts","sourceRoot":"","sources":["../../../../zero-protocol/src/protocol-version.ts"],"names":[],"mappings":"AAEA;;;;;;;;;;;GAWG;AAoDH,eAAO,MAAM,gBAAgB,KAAK,CAAC;AAEnC;;;;;;;;;;;;;;GAcG;AACH,eAAO,MAAM,kCAAkC,KAAK,CAAC"}
+{"version":3,"file":"protocol-version.d.ts","sourceRoot":"","sources":["../../../../zero-protocol/src/protocol-version.ts"],"names":[],"mappings":"AAEA;;;;;;;;;;;;;;;;;;;;GAoBG;AAiDH,eAAO,MAAM,gBAAgB,KAAK,CAAC;AAEnC;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,uBAAuB,KAAK,CAAC;AAE1C;;;;;;;;;;;;;;GAcG;AACH,eAAO,MAAM,kCAAkC,KAAK,CAAC"}

package/out/zero-protocol/src/protocol-version.js

@@ -1,5 +1,5 @@
 import { assert } from "../../shared/src/asserts.js";
-assert(true, "MIN_SERVER_SUPPORTED_SYNC_PROTOCOL must be less than PROTOCOL_VERSION");
+assert(true, "CLIENT_PROTOCOL_VERSION must be between MIN_SERVER_SUPPORTED_SYNC_PROTOCOL and PROTOCOL_VERSION");
 //#endregion
 export {};
 

package/out/zero-protocol/src/protocol-version.js.map

@@ -1 +1 @@
-{"version":3,"file":"protocol-version.js","names":[],"sources":["../../../../zero-protocol/src/protocol-version.ts"],"sourcesContent":["import {assert} from '../../shared/src/asserts.ts';\n\n/**\n * The current `PROTOCOL_VERSION` of the code.\n *\n * The `PROTOCOL_VERSION` encompasses both the wire-protocol of the `/sync/...`\n * connection between the browser and `zero-cache`, as well as the format of\n * the `AST` objects stored in both components (i.e. IDB and CVR).\n *\n * A change in the `AST` schema (e.g. new functionality added) must be\n * accompanied by an increment of the `PROTOCOL_VERSION` and a new major\n * release. The server (`zero-cache`) must be deployed before clients start\n * running the new code.\n */\n// History:\n// -- Version 5 adds support for `pokeEnd.cookie`. (0.14)\n// -- Version 6 makes `pokeStart.cookie` optional. (0.16)\n// -- Version 7 introduces the initConnection.clientSchema field. (0.17)\n// -- Version 8 drops support for Version 5 (0.18).\n// -- Version 11 adds inspect queries. (0.18)\n// -- Version 12 adds 'timestamp' and 'date' types to the ClientSchema ValueType. (not shipped, reversed by version 14)\n// -- Version 14 removes 'timestamp' and 'date' types from the ClientSchema ValueType. (0.18)\n// -- Version 15 adds a `userPushParams` field to `initConnection` (0.19)\n// -- Version 16 adds a new error type (alreadyProcessed) to mutation responses (0.19)\n// -- Version 17 deprecates `AST` in downstream query puts. It was never used anyway. (0.21)\n// -- Version 18 adds `name` and `args` to the `queries-patch` protocol (0.21)\n// -- Version 19 adds `activeClients` to the `initConnection` protocol (0.22)\n// -- Version 20 changes inspector down message (0.22)\n// -- Version 21 removes `AST` in downstream query puts which was deprecated in Version 17, removes support for versions < 18 (0.22)\n// -- Version 22 adds an optional 'userQueryParams' field to `initConnection` (0.22)\n// -- Version 23 add `mutationResults` to poke (0.22)\n// -- Version 24 adds `ackMutationResults` to upstream (0.22).\n// -- version 25 modifies `mutationsResults` to include `del` patches (0.22)\n// -- version 26 adds inspect/metrics and adds metrics to inspect/query (0.23)\n// -- version 27 adds inspect/version (0.23)\n// -- version 28 adds more inspect/metrics (0.23)\n// -- version 29 adds error responses for custom queries (0.23)\n// -- version 30 adds an optional primaryKey to the ClientSchema (0.24)\n// -- version 31 adds admin password authentication to inspector RPC calls (0.24)\n// -- version 32 adds analyze-query to the inspector RPC calls (0.24)\n// -- version 33 adds `flip` to CorrelatedSubquery (0.25)\n// -- version 34 moves `flip` from CorrelatedSubquery to CorrelatedSubqueryCondition (0.25)\n// -- version 35 adds `readRows`, `readRowCountsByQuery` and `readRowCount` to analyze-query result (0.25)\n// -- version 36 changes inspector analyze-query and adds error response to RPC (0.25)\n// -- version 37 adds `elapsed` to AnalyzeQueryResult (0.25)\n// -- version 38 adds structured push/transform error responses (0.25)\n// -- version 39 removes per-transform error types and adds `message` to app error (0.25)\n// -- version 40 adds `dbRowScansByQuery` to AnalyzeQueryResult (0.25)\n// -- version 41 makes ClientSchema.primaryKey required (0.25)\n// -- version 42 adds planner events to AnalyzeQueryResult (0.25)\n// -- version 43 renames `plans` to `sqlitePlans`, `plannerEvents` to `joinPlans`, and `plannerDebug` option to `joinPlans` (0.25)\n// -- version 44 adds profileID to connection URL (0.25)\n// -- version 45 adds userPushHeaders and userQueryHeaders to initConnection (0.25)\n// -- version 46 adds scalarSubquery condition type to AST\n// -- version 47 adds optional auth token to push body\n// -- version 48 adds updateAuth\n// -- version 49 adds `scalar` to CorrelatedSubqueryCondition, removes scalarSubquery\n// -- version 50 adds OTEL headers to push and query messages\n// -- version 51 changes inspector metrics fields\n// -- version 52 replaces JSON pokePart messages with binary poke chunks for\n//    clients using protocol version 52 or newer. Older clients retain pokePart.\n// -- version 53 adds 'filter' node type to AnalyzeQueryResult\n//    (bump deferred on the 1.10 maintenance branch: clients and servers built\n//    from this branch share the schema, and staying at 52 keeps a server\n//    rollback to the previous 1.10 build safe for clients built from it)\nexport const PROTOCOL_VERSION = 52;\n\n/**\n * The minimum server-supported sync protocol version (i.e. the version\n * declared in the \"/sync/v{#}/connect\" URL).\n *\n * CloudZero can serve applications running old client releases indefinitely.\n * Consequently, this value must never be increased: `zero-cache` must continue\n * to support every sync protocol from this version through `PROTOCOL_VERSION`.\n * A wire change that an old client cannot ignore must branch on the client's\n * protocol version and retain the old behavior. Keep each compatibility fork\n * isolated at the boundary that owns the changed behavior and test both sides\n * of its version cutoff.\n *\n * Client connections from protocol versions before this historical floor are\n * closed with a `VersionNotSupported` error.\n */\nexport const MIN_SERVER_SUPPORTED_SYNC_PROTOCOL = 30;\n\nassert(\n  MIN_SERVER_SUPPORTED_SYNC_PROTOCOL < PROTOCOL_VERSION,\n  'MIN_SERVER_SUPPORTED_SYNC_PROTOCOL must be less than PROTOCOL_VERSION',\n);\n"],"mappings":";AAoFA,OAAA,MAEE,uEACF"}
+{"version":3,"file":"protocol-version.js","names":[],"sources":["../../../../zero-protocol/src/protocol-version.ts"],"sourcesContent":["import {assert} from '../../shared/src/asserts.ts';\n\n/**\n * The highest sync protocol version `zero-cache` accepts (i.e. the version\n * declared in the \"/sync/v{#}/connect\" URL). Clients send\n * {@link CLIENT_PROTOCOL_VERSION}.\n *\n * The protocol encompasses both the wire-protocol of the `/sync/...`\n * connection between the browser and `zero-cache`, as well as the format of\n * the `AST` objects stored in both components (i.e. IDB and CVR).\n *\n * A client one release ahead of the server must still be able to connect, so\n * that clients and `zero-cache` can be updated and rolled back in either\n * order. Two rules keep that working:\n *\n * 1. A change an old server can ignore goes behind a protocol flag (see\n *    `protocol-flag-enum.ts`) and the client keeps sending the same\n *    {@link CLIENT_PROTOCOL_VERSION}. Old servers ignore flags they don't\n *    know, so the client must keep supporting the old behavior.\n * 2. A change an old server can't ignore (e.g. new `AST` functionality)\n *    increments `PROTOCOL_VERSION` one release before clients start sending\n *    it in {@link CLIENT_PROTOCOL_VERSION}.\n */\n// History:\n// -- Version 5 adds support for `pokeEnd.cookie`. (0.14)\n// -- Version 6 makes `pokeStart.cookie` optional. (0.16)\n// -- Version 7 introduces the initConnection.clientSchema field. (0.17)\n// -- Version 8 drops support for Version 5 (0.18).\n// -- Version 11 adds inspect queries. (0.18)\n// -- Version 12 adds 'timestamp' and 'date' types to the ClientSchema ValueType. (not shipped, reversed by version 14)\n// -- Version 14 removes 'timestamp' and 'date' types from the ClientSchema ValueType. (0.18)\n// -- Version 15 adds a `userPushParams` field to `initConnection` (0.19)\n// -- Version 16 adds a new error type (alreadyProcessed) to mutation responses (0.19)\n// -- Version 17 deprecates `AST` in downstream query puts. It was never used anyway. (0.21)\n// -- Version 18 adds `name` and `args` to the `queries-patch` protocol (0.21)\n// -- Version 19 adds `activeClients` to the `initConnection` protocol (0.22)\n// -- Version 20 changes inspector down message (0.22)\n// -- Version 21 removes `AST` in downstream query puts which was deprecated in Version 17, removes support for versions < 18 (0.22)\n// -- Version 22 adds an optional 'userQueryParams' field to `initConnection` (0.22)\n// -- Version 23 add `mutationResults` to poke (0.22)\n// -- Version 24 adds `ackMutationResults` to upstream (0.22).\n// -- version 25 modifies `mutationsResults` to include `del` patches (0.22)\n// -- version 26 adds inspect/metrics and adds metrics to inspect/query (0.23)\n// -- version 27 adds inspect/version (0.23)\n// -- version 28 adds more inspect/metrics (0.23)\n// -- version 29 adds error responses for custom queries (0.23)\n// -- version 30 adds an optional primaryKey to the ClientSchema (0.24)\n// -- version 31 adds admin password authentication to inspector RPC calls (0.24)\n// -- version 32 adds analyze-query to the inspector RPC calls (0.24)\n// -- version 33 adds `flip` to CorrelatedSubquery (0.25)\n// -- version 34 moves `flip` from CorrelatedSubquery to CorrelatedSubqueryCondition (0.25)\n// -- version 35 adds `readRows`, `readRowCountsByQuery` and `readRowCount` to analyze-query result (0.25)\n// -- version 36 changes inspector analyze-query and adds error response to RPC (0.25)\n// -- version 37 adds `elapsed` to AnalyzeQueryResult (0.25)\n// -- version 38 adds structured push/transform error responses (0.25)\n// -- version 39 removes per-transform error types and adds `message` to app error (0.25)\n// -- version 40 adds `dbRowScansByQuery` to AnalyzeQueryResult (0.25)\n// -- version 41 makes ClientSchema.primaryKey required (0.25)\n// -- version 42 adds planner events to AnalyzeQueryResult (0.25)\n// -- version 43 renames `plans` to `sqlitePlans`, `plannerEvents` to `joinPlans`, and `plannerDebug` option to `joinPlans` (0.25)\n// -- version 44 adds profileID to connection URL (0.25)\n// -- version 45 adds userPushHeaders and userQueryHeaders to initConnection (0.25)\n// -- version 46 adds scalarSubquery condition type to AST\n// -- version 47 adds optional auth token to push body\n// -- version 48 adds updateAuth\n// -- version 49 adds `scalar` to CorrelatedSubqueryCondition, removes scalarSubquery\n// -- version 50 adds OTEL headers to push and query messages\n// -- version 51 changes inspector metrics fields\n// -- version 52 replaces JSON pokePart messages with binary poke chunks for\n//    clients using protocol version 52 or newer. Older clients retain pokePart\n//    unless they send the `PokeChunk` protocol flag. (1.10 canaries)\nexport const PROTOCOL_VERSION = 52;\n\n/**\n * The sync protocol version clients send in the \"/sync/v{#}/connect\" URL.\n *\n * Kept below {@link PROTOCOL_VERSION} so that clients can connect to servers\n * from earlier releases: 1.9 servers accept versions up to 51. Clients ask for\n * newer behavior with protocol flags instead (rule 1 above). Only increase it\n * to a version that every supported server already accepts (rule 2 above).\n *\n * This number is also part of the client's local database name (Replicache\n * `schemaVersion`). Changing it opens a fresh local database, which drops\n * unsent mutations because Zero disables mutation recovery. Canary clients\n * already used 52 and 53 in their database names, so if the name changes it\n * must move above 53; reusing 52 or 53 would open a stale canary database.\n */\nexport const CLIENT_PROTOCOL_VERSION = 51;\n\n/**\n * The minimum server-supported sync protocol version (i.e. the version\n * declared in the \"/sync/v{#}/connect\" URL).\n *\n * CloudZero can serve applications running old client releases indefinitely.\n * Consequently, this value must never be increased: `zero-cache` must continue\n * to support every sync protocol from this version through `PROTOCOL_VERSION`.\n * A wire change that an old client cannot ignore must branch on the client's\n * protocol version and retain the old behavior. Keep each compatibility fork\n * isolated at the boundary that owns the changed behavior and test both sides\n * of its version cutoff.\n *\n * Client connections from protocol versions before this historical floor are\n * closed with a `VersionNotSupported` error.\n */\nexport const MIN_SERVER_SUPPORTED_SYNC_PROTOCOL = 30;\n\nassert(\n  MIN_SERVER_SUPPORTED_SYNC_PROTOCOL <= CLIENT_PROTOCOL_VERSION &&\n    CLIENT_PROTOCOL_VERSION <= PROTOCOL_VERSION,\n  'CLIENT_PROTOCOL_VERSION must be between MIN_SERVER_SUPPORTED_SYNC_PROTOCOL and PROTOCOL_VERSION',\n);\n"],"mappings":";AA0GA,OAAA,MAGE,iGACF"}