@gaganref/confect-test 10.3.1-fork.91 → 10.3.1-fork.92

package/dist/internal/KernelQuery.js.map

@@ -1 +1 @@
-{"version":3,"file":"KernelQuery.js","names":["KernelRefusal.requiresBinary","ReadSet.keyOf"],"sources":["../../src/internal/KernelQuery.ts"],"sourcesContent":["// Derived from convex-test 0.0.65 (index.ts, `DatabaseFake`), Copyright Convex,\n// Inc., licensed under the Apache License, Version 2.0\n// (https://www.apache.org/licenses/LICENSE-2.0). The ordering, index range and\n// pagination rules are convex-test's. They read a table through the attempt\n// that runs the query instead of convex-test's database, and record the\n// interval each query examined.\n\nimport type {\n  GenericDocument,\n  GenericSchema,\n  SchemaDefinition,\n} from \"convex/server\";\nimport {\n  compareValues,\n  convexToJson,\n  getDocumentSize,\n  jsonToConvex,\n} from \"convex/values\";\nimport * as KernelRefusal from \"./KernelRefusal.js\";\nimport * as ReadSet from \"./ReadSet.js\";\nimport type {\n  FilterJson,\n  Index,\n  SerializedQuery,\n  SerializedRangeExpression,\n  StoredDocument,\n  ValidatorJSON,\n} from \"./KernelValues.js\";\nimport {\n  evaluateFieldPath,\n  evaluateFilter,\n  evaluateRangeFilter,\n  isValidIdentifier,\n  resolvePendingValues,\n  validateFieldNames,\n  validateIndexRangeExpression,\n  validateValidator,\n} from \"./KernelValues.js\";\n\n/**\n * A component's tables as its schema declares them.\n */\nexport interface KernelSchema {\n  readonly schemaValidation: boolean;\n  readonly tables: ReadonlyMap<\n    string,\n    {\n      readonly indexes: ReadonlyArray<Index>;\n      readonly documentType: ValidatorJSON;\n    }\n  >;\n}\n\nexport const exportSchema = (\n  schema: SchemaDefinition<GenericSchema, boolean> | null | undefined,\n): KernelSchema | null => {\n  if (schema === null || schema === undefined) return null;\n  const exported: KernelSchema = {\n    schemaValidation: (schema as unknown as { schemaValidation: boolean })\n      .schemaValidation,\n    tables: new Map(\n      Object.entries(schema.tables).map(([name, table]) => [\n        name,\n        (table as unknown as { export: () => any }).export(),\n      ]),\n    ),\n  };\n  exported.tables.forEach((table, tableName) => {\n    if (!isValidIdentifier(tableName)) {\n      throw new Error(\n        `Table names must be valid identifiers, got \"${tableName}\"`,\n      );\n    }\n    validateFieldNames(table.documentType);\n    table.indexes.forEach(({ indexDescriptor }) => {\n      if (!isValidIdentifier(indexDescriptor)) {\n        throw new Error(\n          `Index names must be valid identifiers, got \"${indexDescriptor}\"`,\n        );\n      }\n    });\n  });\n  return exported;\n};\n\n/**\n * Check a document against its table's declared type, as the backend does\n * before a write.\n */\nexport const validateDocument = (\n  schema: KernelSchema | null,\n  tableName: string,\n  doc: Record<string, unknown>,\n) => {\n  if (schema === null || !schema.schemaValidation) return;\n  const validator = schema.tables.get(tableName)?.documentType;\n  if (validator === undefined) return;\n  validateValidator(validator, resolvePendingValues(doc as GenericDocument));\n};\n\n/**\n * An interval a query reads, before it says where it starts and how far it got.\n */\nexport type Interval = Omit<\n  ReadSet.IntervalRead,\n  \"componentPath\" | \"after\" | \"through\"\n>;\n\n/**\n * What a query reads: one table of one component, as the running attempt sees\n * it. `read` records an interval in the attempt's read set and returns how to\n * advance it.\n */\nexport interface TableView {\n  readonly schema: KernelSchema | null;\n  readonly scan: (tableName: string) => ReadonlyArray<StoredDocument>;\n  readonly read: (\n    interval: Interval,\n    after: ReadSet.Key | null,\n  ) => (through: ReadSet.Key | \"end\") => void;\n}\n\ninterface ResolvedSource {\n  readonly sortedDocs: ReadonlyArray<GenericDocument>;\n  readonly filterFn: (doc: GenericDocument) => boolean;\n  readonly limit: number | null;\n  readonly order: \"asc\" | \"desc\";\n  readonly interval: Interval;\n}\n\nconst resolveSource = (\n  view: TableView,\n  query: SerializedQuery,\n): ResolvedSource => {\n  const source = query.source;\n  let docs: Array<GenericDocument>;\n  let fieldPathsToSortBy: Array<string>;\n  let order: \"asc\" | \"desc\";\n  let table: string;\n  let range: ReadonlyArray<SerializedRangeExpression> = [];\n  switch (source.type) {\n    case \"FullTableScan\": {\n      table = source.tableName;\n      docs = [...view.scan(source.tableName)];\n      order = source.order ?? \"asc\";\n      fieldPathsToSortBy = [\"_creationTime\"];\n      break;\n    }\n    case \"IndexRange\": {\n      const [tableName, indexName] = source.indexName.split(\".\") as [\n        string,\n        string,\n      ];\n      table = tableName;\n      range = source.range;\n      order = source.order ?? \"asc\";\n      let fields: Array<string>;\n      if (indexName === \"by_creation_time\") {\n        fields = [\"_creationTime\", \"_id\"];\n      } else if (indexName === \"by_id\") {\n        fields = [\"_id\"];\n      } else {\n        const index = view.schema?.tables\n          .get(tableName)\n          ?.indexes.find(\n            ({ indexDescriptor }) => indexDescriptor === indexName,\n          );\n        if (index === undefined) {\n          throw new Error(\n            `Cannot use index \"${indexName}\" for table \"${tableName}\" because ` +\n              `it is not declared in the schema.`,\n          );\n        }\n        fields = index.fields.concat([\"_creationTime\", \"_id\"]);\n      }\n      fieldPathsToSortBy = fields;\n      validateIndexRangeExpression(source, fields);\n      docs = view\n        .scan(tableName)\n        .filter((doc) =>\n          source.range.every((filter) => evaluateRangeFilter(doc, filter)),\n        );\n      break;\n    }\n    case \"Search\": {\n      throw KernelRefusal.requiresBinary(\"textSearch\");\n    }\n  }\n\n  const filters = query.operators\n    .filter(\n      (operator): operator is { filter: FilterJson } => \"filter\" in operator,\n    )\n    .map((operator) => operator.filter);\n  const limit =\n    query.operators.find(\n      (operator): operator is { limit: number } => \"limit\" in operator,\n    ) ?? null;\n\n  const orderMultiplier = order === \"asc\" ? 1 : -1;\n  docs.sort((a, b) => {\n    for (const fp of fieldPathsToSortBy) {\n      const v = compareValues(\n        evaluateFieldPath(fp, a),\n        evaluateFieldPath(fp, b),\n      );\n      if (v !== 0) return v * orderMultiplier;\n    }\n    return 0;\n  });\n\n  return {\n    sortedDocs: docs,\n    filterFn: (doc) => filters.every((f) => evaluateFilter(doc, f)),\n    limit: limit?.limit ?? null,\n    order,\n    interval: {\n      kind: \"interval\",\n      table,\n      fields: fieldPathsToSortBy.includes(\"_id\")\n        ? fieldPathsToSortBy\n        : [...fieldPathsToSortBy, \"_id\"],\n      order,\n      range,\n    },\n  };\n};\n\n/**\n * A query's documents in order. The source is read when the query starts, as a\n * snapshot, and consumed lazily. The read set holds the prefix the stream has\n * examined, filtered documents included, or the whole range once it ends.\n */\nexport const stream = (\n  view: TableView,\n  query: SerializedQuery,\n): Iterator<GenericDocument> => {\n  const { sortedDocs, filterFn, limit, interval } = resolveSource(view, query);\n  const examined = view.read(interval, null);\n  return (function* () {\n    let returned = 0;\n    for (const doc of sortedDocs) {\n      if (limit !== null && returned >= limit) return;\n      examined(ReadSet.keyOf(interval.fields, doc as StoredDocument));\n      if (filterFn(doc)) {\n        returned++;\n        yield doc;\n      }\n    }\n    examined(\"end\");\n  })();\n};\n\nconst encodeCursor = (\n  doc: GenericDocument,\n  fieldPaths: ReadonlyArray<string>,\n): string =>\n  JSON.stringify(\n    fieldPaths.map((fp) => {\n      const k = evaluateFieldPath(fp, doc);\n      return k === undefined ? null : JSON.stringify(convexToJson(k));\n    }),\n  );\n\nconst parseCursor = (c: string | null | undefined) =>\n  c\n    ? (JSON.parse(c) as Array<string | null>).map((k) =>\n        k === null ? undefined : jsonToConvex(JSON.parse(k)),\n      )\n    : null;\n\nconst compareToCursor = (\n  doc: GenericDocument,\n  cursorKeys: ReadonlyArray<unknown>,\n  fieldPaths: ReadonlyArray<string>,\n  order: \"asc\" | \"desc\",\n): number => {\n  const orderMultiplier = order === \"asc\" ? 1 : -1;\n  for (let i = 0; i < fieldPaths.length; i++) {\n    const cmp = compareValues(\n      evaluateFieldPath(fieldPaths[i]!, doc),\n      cursorKeys[i] as any,\n    );\n    if (cmp !== 0) return cmp * orderMultiplier;\n  }\n  return 0;\n};\n\nexport interface PageRequest {\n  readonly query: SerializedQuery;\n  readonly cursor: string | null;\n  readonly endCursor?: string | null;\n  readonly pageSize: number;\n  readonly maximumRowsRead?: number | null;\n  readonly maximumBytesRead?: number | null;\n}\n\nexport const paginate = (\n  view: TableView,\n  {\n    query,\n    cursor,\n    endCursor,\n    pageSize,\n    maximumRowsRead,\n    maximumBytesRead,\n  }: PageRequest,\n) => {\n  const { sortedDocs, filterFn, order, interval } = resolveSource(view, query);\n  // A page from the terminal cursor reads the empty interval past the end, so\n  // it depends on nothing.\n  if (cursor === \"_end_cursor\") {\n    return {\n      page: [],\n      isDone: true,\n      continueCursor: \"_end_cursor\",\n      splitCursor: null,\n      pageStatus: null,\n    };\n  }\n  const cursorFields = interval.fields;\n  const cursorKeys = parseCursor(cursor);\n  const hasEndBoundary = !!endCursor && endCursor !== \"_end_cursor\";\n  const endCursorKeys = hasEndBoundary ? parseCursor(endCursor) : null;\n  const examined = view.read(interval, cursorKeys);\n  let reachedEnd = true;\n\n  const page: Array<GenericDocument> = [];\n  let isInPage = cursor === null;\n  let continueCursor = \"_end_cursor\";\n  let splitCursor: string | null = null;\n  let pageStatus: \"SplitRecommended\" | \"SplitRequired\" | null = null;\n  let rowsRead = 0;\n  let bytesRead = 0;\n  const readDocCursors: Array<string> = [];\n\n  for (let i = 0; i < sortedDocs.length; i++) {\n    const doc = sortedDocs[i]!;\n    const isLastDoc = i === sortedDocs.length - 1;\n    if (!isInPage) {\n      if (cursorKeys) {\n        if (compareToCursor(doc, cursorKeys, cursorFields, order) > 0) {\n          isInPage = true;\n        } else {\n          continue;\n        }\n      }\n    }\n    if (hasEndBoundary && endCursorKeys) {\n      const cmp = compareToCursor(doc, endCursorKeys, cursorFields, order);\n      if (cmp >= 0) {\n        reachedEnd = false;\n        examined(endCursorKeys);\n        if (cmp === 0) {\n          rowsRead += 1;\n          bytesRead += getDocumentSize(doc);\n          readDocCursors.push(encodeCursor(doc, cursorFields));\n          if (filterFn(doc)) page.push(doc);\n          continueCursor = encodeCursor(doc, cursorFields);\n        }\n        break;\n      }\n    }\n    rowsRead += 1;\n    bytesRead += getDocumentSize(doc);\n    readDocCursors.push(encodeCursor(doc, cursorFields));\n    examined(ReadSet.keyOf(cursorFields, doc as StoredDocument));\n    const hitLimit =\n      (!!maximumRowsRead && rowsRead >= maximumRowsRead) ||\n      (!!maximumBytesRead && bytesRead >= maximumBytesRead);\n    if (filterFn(doc)) page.push(doc);\n    if (hitLimit) {\n      reachedEnd = false;\n      pageStatus = \"SplitRequired\";\n      continueCursor = encodeCursor(doc, cursorFields);\n      break;\n    }\n    if (!endCursor && page.length >= pageSize) {\n      reachedEnd = isLastDoc;\n      if (!isLastDoc) continueCursor = encodeCursor(doc, cursorFields);\n      break;\n    }\n  }\n  // A page bounded by an end cursor examined the range only up to it.\n  if (reachedEnd) examined(endCursorKeys ?? \"end\");\n\n  if (pageStatus === \"SplitRequired\" && readDocCursors.length >= 2) {\n    splitCursor = readDocCursors[Math.floor((readDocCursors.length - 1) / 2)]!;\n  } else if (\n    pageStatus === null &&\n    rowsRead > pageSize + 1 &&\n    readDocCursors.length >= 2\n  ) {\n    pageStatus = \"SplitRecommended\";\n    splitCursor = readDocCursors[Math.floor((readDocCursors.length - 1) / 2)]!;\n  }\n\n  return {\n    page,\n    isDone: continueCursor === \"_end_cursor\",\n    continueCursor,\n    splitCursor,\n    pageStatus,\n  };\n};\n"],"mappings":";;;;;AAqDA,MAAa,gBACX,WACwB;CACxB,IAAI,WAAW,QAAQ,WAAW,KAAA,GAAW,OAAO;CACpD,MAAM,WAAyB;EAC7B,kBAAmB,OAChB;EACH,QAAQ,IAAI,IACV,OAAO,QAAQ,OAAO,MAAM,CAAC,CAAC,KAAK,CAAC,MAAM,WAAW,CACnD,MACC,MAA2C,OAAO,CACrD,CAAC,CACH;CACF;CACA,SAAS,OAAO,SAAS,OAAO,cAAc;EAC5C,IAAI,CAAC,kBAAkB,SAAS,GAC9B,MAAM,IAAI,MACR,+CAA+C,UAAU,EAC3D;EAEF,mBAAmB,MAAM,YAAY;EACrC,MAAM,QAAQ,SAAS,EAAE,sBAAsB;GAC7C,IAAI,CAAC,kBAAkB,eAAe,GACpC,MAAM,IAAI,MACR,+CAA+C,gBAAgB,EACjE;EAEJ,CAAC;CACH,CAAC;CACD,OAAO;AACT;;;;;AAMA,MAAa,oBACX,QACA,WACA,QACG;CACH,IAAI,WAAW,QAAQ,CAAC,OAAO,kBAAkB;CACjD,MAAM,YAAY,OAAO,OAAO,IAAI,SAAS,CAAC,EAAE;CAChD,IAAI,cAAc,KAAA,GAAW;CAC7B,kBAAkB,WAAW,qBAAqB,GAAsB,CAAC;AAC3E;AAgCA,MAAM,iBACJ,MACA,UACmB;CACnB,MAAM,SAAS,MAAM;CACrB,IAAI;CACJ,IAAI;CACJ,IAAI;CACJ,IAAI;CACJ,IAAI,QAAkD,CAAC;CACvD,QAAQ,OAAO,MAAf;EACE,KAAK;GACH,QAAQ,OAAO;GACf,OAAO,CAAC,GAAG,KAAK,KAAK,OAAO,SAAS,CAAC;GACtC,QAAQ,OAAO,SAAS;GACxB,qBAAqB,CAAC,eAAe;GACrC;EAEF,KAAK,cAAc;GACjB,MAAM,CAAC,WAAW,aAAa,OAAO,UAAU,MAAM,GAAG;GAIzD,QAAQ;GACR,QAAQ,OAAO;GACf,QAAQ,OAAO,SAAS;GACxB,IAAI;GACJ,IAAI,cAAc,oBAChB,SAAS,CAAC,iBAAiB,KAAK;QAC3B,IAAI,cAAc,SACvB,SAAS,CAAC,KAAK;QACV;IACL,MAAM,QAAQ,KAAK,QAAQ,OACxB,IAAI,SAAS,CAAC,EACb,QAAQ,MACP,EAAE,sBAAsB,oBAAoB,SAC/C;IACF,IAAI,UAAU,KAAA,GACZ,MAAM,IAAI,MACR,qBAAqB,UAAU,eAAe,UAAU,4CAE1D;IAEF,SAAS,MAAM,OAAO,OAAO,CAAC,iBAAiB,KAAK,CAAC;GACvD;GACA,qBAAqB;GACrB,6BAA6B,QAAQ,MAAM;GAC3C,OAAO,KACJ,KAAK,SAAS,CAAC,CACf,QAAQ,QACP,OAAO,MAAM,OAAO,WAAW,oBAAoB,KAAK,MAAM,CAAC,CACjE;GACF;EACF;EACA,KAAK,UACH,MAAMA,eAA6B,YAAY;CAEnD;CAEA,MAAM,UAAU,MAAM,UACnB,QACE,aAAiD,YAAY,QAChE,CAAC,CACA,KAAK,aAAa,SAAS,MAAM;CACpC,MAAM,QACJ,MAAM,UAAU,MACb,aAA4C,WAAW,QAC1D,KAAK;CAEP,MAAM,kBAAkB,UAAU,QAAQ,IAAI;CAC9C,KAAK,MAAM,GAAG,MAAM;EAClB,KAAK,MAAM,MAAM,oBAAoB;GACnC,MAAM,IAAI,cACR,kBAAkB,IAAI,CAAC,GACvB,kBAAkB,IAAI,CAAC,CACzB;GACA,IAAI,MAAM,GAAG,OAAO,IAAI;EAC1B;EACA,OAAO;CACT,CAAC;CAED,OAAO;EACL,YAAY;EACZ,WAAW,QAAQ,QAAQ,OAAO,MAAM,eAAe,KAAK,CAAC,CAAC;EAC9D,OAAO,OAAO,SAAS;EACvB;EACA,UAAU;GACR,MAAM;GACN;GACA,QAAQ,mBAAmB,SAAS,KAAK,IACrC,qBACA,CAAC,GAAG,oBAAoB,KAAK;GACjC;GACA;EACF;CACF;AACF;;;;;;AAOA,MAAa,UACX,MACA,UAC8B;CAC9B,MAAM,EAAE,YAAY,UAAU,OAAO,aAAa,cAAc,MAAM,KAAK;CAC3E,MAAM,WAAW,KAAK,KAAK,UAAU,IAAI;CACzC,QAAQ,aAAa;EACnB,IAAI,WAAW;EACf,KAAK,MAAM,OAAO,YAAY;GAC5B,IAAI,UAAU,QAAQ,YAAY,OAAO;GACzC,SAASC,MAAc,SAAS,QAAQ,GAAqB,CAAC;GAC9D,IAAI,SAAS,GAAG,GAAG;IACjB;IACA,MAAM;GACR;EACF;EACA,SAAS,KAAK;CAChB,EAAA,CAAG;AACL;AAEA,MAAM,gBACJ,KACA,eAEA,KAAK,UACH,WAAW,KAAK,OAAO;CACrB,MAAM,IAAI,kBAAkB,IAAI,GAAG;CACnC,OAAO,MAAM,KAAA,IAAY,OAAO,KAAK,UAAU,aAAa,CAAC,CAAC;AAChE,CAAC,CACH;AAEF,MAAM,eAAe,MACnB,IACK,KAAK,MAAM,CAAC,CAAC,CAA0B,KAAK,MAC3C,MAAM,OAAO,KAAA,IAAY,aAAa,KAAK,MAAM,CAAC,CAAC,CACrD,IACA;AAEN,MAAM,mBACJ,KACA,YACA,YACA,UACW;CACX,MAAM,kBAAkB,UAAU,QAAQ,IAAI;CAC9C,KAAK,IAAI,IAAI,GAAG,IAAI,WAAW,QAAQ,KAAK;EAC1C,MAAM,MAAM,cACV,kBAAkB,WAAW,IAAK,GAAG,GACrC,WAAW,EACb;EACA,IAAI,QAAQ,GAAG,OAAO,MAAM;CAC9B;CACA,OAAO;AACT;AAWA,MAAa,YACX,MACA,EACE,OACA,QACA,WACA,UACA,iBACA,uBAEC;CACH,MAAM,EAAE,YAAY,UAAU,OAAO,aAAa,cAAc,MAAM,KAAK;CAG3E,IAAI,WAAW,eACb,OAAO;EACL,MAAM,CAAC;EACP,QAAQ;EACR,gBAAgB;EAChB,aAAa;EACb,YAAY;CACd;CAEF,MAAM,eAAe,SAAS;CAC9B,MAAM,aAAa,YAAY,MAAM;CACrC,MAAM,iBAAiB,CAAC,CAAC,aAAa,cAAc;CACpD,MAAM,gBAAgB,iBAAiB,YAAY,SAAS,IAAI;CAChE,MAAM,WAAW,KAAK,KAAK,UAAU,UAAU;CAC/C,IAAI,aAAa;CAEjB,MAAM,OAA+B,CAAC;CACtC,IAAI,WAAW,WAAW;CAC1B,IAAI,iBAAiB;CACrB,IAAI,cAA6B;CACjC,IAAI,aAA0D;CAC9D,IAAI,WAAW;CACf,IAAI,YAAY;CAChB,MAAM,iBAAgC,CAAC;CAEvC,KAAK,IAAI,IAAI,GAAG,IAAI,WAAW,QAAQ,KAAK;EAC1C,MAAM,MAAM,WAAW;EACvB,MAAM,YAAY,MAAM,WAAW,SAAS;EAC5C,IAAI,CAAC,UACC;OAAA,YAAY;IACd,IAAI,gBAAgB,KAAK,YAAY,cAAc,KAAK,IAAI,GAC1D,WAAW;SAEX;GAEJ;;EAEF,IAAI,kBAAkB,eAAe;GACnC,MAAM,MAAM,gBAAgB,KAAK,eAAe,cAAc,KAAK;GACnE,IAAI,OAAO,GAAG;IACZ,aAAa;IACb,SAAS,aAAa;IACtB,IAAI,QAAQ,GAAG;KACb,YAAY;KACZ,aAAa,gBAAgB,GAAG;KAChC,eAAe,KAAK,aAAa,KAAK,YAAY,CAAC;KACnD,IAAI,SAAS,GAAG,GAAG,KAAK,KAAK,GAAG;KAChC,iBAAiB,aAAa,KAAK,YAAY;IACjD;IACA;GACF;EACF;EACA,YAAY;EACZ,aAAa,gBAAgB,GAAG;EAChC,eAAe,KAAK,aAAa,KAAK,YAAY,CAAC;EACnD,SAASA,MAAc,cAAc,GAAqB,CAAC;EAC3D,MAAM,WACH,CAAC,CAAC,mBAAmB,YAAY,mBACjC,CAAC,CAAC,oBAAoB,aAAa;EACtC,IAAI,SAAS,GAAG,GAAG,KAAK,KAAK,GAAG;EAChC,IAAI,UAAU;GACZ,aAAa;GACb,aAAa;GACb,iBAAiB,aAAa,KAAK,YAAY;GAC/C;EACF;EACA,IAAI,CAAC,aAAa,KAAK,UAAU,UAAU;GACzC,aAAa;GACb,IAAI,CAAC,WAAW,iBAAiB,aAAa,KAAK,YAAY;GAC/D;EACF;CACF;CAEA,IAAI,YAAY,SAAS,iBAAiB,KAAK;CAE/C,IAAI,eAAe,mBAAmB,eAAe,UAAU,GAC7D,cAAc,eAAe,KAAK,OAAO,eAAe,SAAS,KAAK,CAAC;MAClE,IACL,eAAe,QACf,WAAW,WAAW,KACtB,eAAe,UAAU,GACzB;EACA,aAAa;EACb,cAAc,eAAe,KAAK,OAAO,eAAe,SAAS,KAAK,CAAC;CACzE;CAEA,OAAO;EACL;EACA,QAAQ,mBAAmB;EAC3B;EACA;EACA;CACF;AACF"}
+{"version":3,"file":"KernelQuery.js","names":["KernelRefusal.requiresBinary","ReadSet.keyOf"],"sources":["../../src/internal/KernelQuery.ts"],"sourcesContent":["// Derived from convex-test 0.0.65 (index.ts, `DatabaseFake`), Copyright Convex,\n// Inc., licensed under the Apache License, Version 2.0\n// (https://www.apache.org/licenses/LICENSE-2.0). The ordering, index range and\n// pagination rules are convex-test's. They read a table through the attempt\n// that runs the query instead of convex-test's database, and record the\n// interval each query examined.\n\nimport type {\n  GenericDocument,\n  GenericSchema,\n  SchemaDefinition,\n} from \"convex/server\";\nimport {\n  compareValues,\n  convexToJson,\n  getDocumentSize,\n  jsonToConvex,\n} from \"convex/values\";\nimport * as KernelRefusal from \"./KernelRefusal.js\";\nimport * as ReadSet from \"./ReadSet.js\";\nimport type {\n  FilterJson,\n  Index,\n  SerializedQuery,\n  SerializedRangeExpression,\n  StoredDocument,\n  ValidatorJSON,\n} from \"./KernelValues.js\";\nimport {\n  evaluateFieldPath,\n  evaluateFilter,\n  evaluateRangeFilter,\n  isValidIdentifier,\n  resolvePendingValues,\n  validateFieldNames,\n  validateIndexRangeExpression,\n  validateValidator,\n} from \"./KernelValues.js\";\n\n/**\n * A component's tables as its schema declares them.\n */\nexport interface KernelSchema {\n  readonly schemaValidation: boolean;\n  readonly tables: ReadonlyMap<\n    string,\n    {\n      readonly indexes: ReadonlyArray<Index>;\n      readonly documentType: ValidatorJSON;\n    }\n  >;\n}\n\nexport const exportSchema = (\n  schema: SchemaDefinition<GenericSchema, boolean> | null | undefined,\n): KernelSchema | null => {\n  if (schema === null || schema === undefined) return null;\n  const exported: KernelSchema = {\n    schemaValidation: (schema as unknown as { schemaValidation: boolean })\n      .schemaValidation,\n    tables: new Map(\n      Object.entries(schema.tables).map(([name, table]) => [\n        name,\n        (table as unknown as { export: () => any }).export(),\n      ]),\n    ),\n  };\n  exported.tables.forEach((table, tableName) => {\n    if (!isValidIdentifier(tableName)) {\n      throw new Error(\n        `Table names must be valid identifiers, got \"${tableName}\"`,\n      );\n    }\n    validateFieldNames(table.documentType);\n    table.indexes.forEach(({ indexDescriptor }) => {\n      if (!isValidIdentifier(indexDescriptor)) {\n        throw new Error(\n          `Index names must be valid identifiers, got \"${indexDescriptor}\"`,\n        );\n      }\n    });\n  });\n  return exported;\n};\n\n/**\n * Check a document against its table's declared type, as the backend does\n * before a write.\n */\nexport const validateDocument = (\n  schema: KernelSchema | null,\n  tableName: string,\n  doc: Record<string, unknown>,\n) => {\n  if (schema === null || !schema.schemaValidation) return;\n  const validator = schema.tables.get(tableName)?.documentType;\n  if (validator === undefined) return;\n  validateValidator(validator, resolvePendingValues(doc as GenericDocument));\n};\n\n/**\n * An interval a query reads, before it says where it starts and how far it got,\n * and the index it reads it from.\n */\nexport type Interval = Omit<\n  ReadSet.IntervalRead,\n  \"componentPath\" | \"after\" | \"through\"\n> & { readonly index: string };\n\n/**\n * What a query reads: one table of one component, as the running attempt sees\n * it. `read` records an interval in the attempt's read set and returns how to\n * advance it. `examine` charges one document the query examined, before the\n * query's filters see it.\n */\nexport interface TableView {\n  readonly schema: KernelSchema | null;\n  readonly scan: (tableName: string) => ReadonlyArray<StoredDocument>;\n  readonly read: (\n    interval: Interval,\n    after: ReadSet.Key | null,\n  ) => (through: ReadSet.Key | \"end\") => void;\n  readonly examine: (table: string, doc: GenericDocument) => void;\n}\n\ninterface ResolvedSource {\n  readonly sortedDocs: ReadonlyArray<GenericDocument>;\n  readonly filterFn: (doc: GenericDocument) => boolean;\n  readonly limit: number | null;\n  readonly order: \"asc\" | \"desc\";\n  readonly interval: Interval;\n}\n\nconst resolveSource = (\n  view: TableView,\n  query: SerializedQuery,\n): ResolvedSource => {\n  const source = query.source;\n  let docs: Array<GenericDocument>;\n  let fieldPathsToSortBy: Array<string>;\n  let order: \"asc\" | \"desc\";\n  let table: string;\n  let range: ReadonlyArray<SerializedRangeExpression> = [];\n  let index: string;\n  switch (source.type) {\n    case \"FullTableScan\": {\n      table = source.tableName;\n      // The binary scans a whole table through its creation-time index.\n      index = \"by_creation_time\";\n      docs = [...view.scan(source.tableName)];\n      order = source.order ?? \"asc\";\n      fieldPathsToSortBy = [\"_creationTime\"];\n      break;\n    }\n    case \"IndexRange\": {\n      const [tableName, indexName] = source.indexName.split(\".\") as [\n        string,\n        string,\n      ];\n      table = tableName;\n      index = indexName;\n      range = source.range;\n      order = source.order ?? \"asc\";\n      let fields: Array<string>;\n      if (indexName === \"by_creation_time\") {\n        fields = [\"_creationTime\", \"_id\"];\n      } else if (indexName === \"by_id\") {\n        fields = [\"_id\"];\n      } else {\n        const declared = view.schema?.tables\n          .get(tableName)\n          ?.indexes.find(\n            ({ indexDescriptor }) => indexDescriptor === indexName,\n          );\n        if (declared === undefined) {\n          throw new Error(\n            `Cannot use index \"${indexName}\" for table \"${tableName}\" because ` +\n              `it is not declared in the schema.`,\n          );\n        }\n        fields = declared.fields.concat([\"_creationTime\", \"_id\"]);\n      }\n      fieldPathsToSortBy = fields;\n      validateIndexRangeExpression(source, fields);\n      docs = view\n        .scan(tableName)\n        .filter((doc) =>\n          source.range.every((filter) => evaluateRangeFilter(doc, filter)),\n        );\n      break;\n    }\n    case \"Search\": {\n      throw KernelRefusal.requiresBinary(\"textSearch\");\n    }\n  }\n\n  const filters = query.operators\n    .filter(\n      (operator): operator is { filter: FilterJson } => \"filter\" in operator,\n    )\n    .map((operator) => operator.filter);\n  const limit =\n    query.operators.find(\n      (operator): operator is { limit: number } => \"limit\" in operator,\n    ) ?? null;\n\n  const orderMultiplier = order === \"asc\" ? 1 : -1;\n  docs.sort((a, b) => {\n    for (const fp of fieldPathsToSortBy) {\n      const v = compareValues(\n        evaluateFieldPath(fp, a),\n        evaluateFieldPath(fp, b),\n      );\n      if (v !== 0) return v * orderMultiplier;\n    }\n    return 0;\n  });\n\n  return {\n    sortedDocs: docs,\n    filterFn: (doc) => filters.every((f) => evaluateFilter(doc, f)),\n    limit: limit?.limit ?? null,\n    order,\n    interval: {\n      kind: \"interval\",\n      index,\n      table,\n      fields: fieldPathsToSortBy.includes(\"_id\")\n        ? fieldPathsToSortBy\n        : [...fieldPathsToSortBy, \"_id\"],\n      order,\n      range,\n    },\n  };\n};\n\n/**\n * A query's documents in order. The source is read when the query starts, as a\n * snapshot, and consumed lazily. The read set holds the prefix the stream has\n * examined, filtered documents included, or the whole range once it ends.\n */\nexport const stream = (\n  view: TableView,\n  query: SerializedQuery,\n): Iterator<GenericDocument> => {\n  const { sortedDocs, filterFn, limit, interval } = resolveSource(view, query);\n  const examined = view.read(interval, null);\n  return (function* () {\n    let returned = 0;\n    for (const doc of sortedDocs) {\n      if (limit !== null && returned >= limit) return;\n      view.examine(interval.table, doc);\n      examined(ReadSet.keyOf(interval.fields, doc as StoredDocument));\n      if (filterFn(doc)) {\n        returned++;\n        yield doc;\n      }\n    }\n    examined(\"end\");\n  })();\n};\n\nconst encodeCursor = (\n  doc: GenericDocument,\n  fieldPaths: ReadonlyArray<string>,\n): string =>\n  JSON.stringify(\n    fieldPaths.map((fp) => {\n      const k = evaluateFieldPath(fp, doc);\n      return k === undefined ? null : JSON.stringify(convexToJson(k));\n    }),\n  );\n\nconst parseCursor = (c: string | null | undefined) =>\n  c\n    ? (JSON.parse(c) as Array<string | null>).map((k) =>\n        k === null ? undefined : jsonToConvex(JSON.parse(k)),\n      )\n    : null;\n\nconst compareToCursor = (\n  doc: GenericDocument,\n  cursorKeys: ReadonlyArray<unknown>,\n  fieldPaths: ReadonlyArray<string>,\n  order: \"asc\" | \"desc\",\n): number => {\n  const orderMultiplier = order === \"asc\" ? 1 : -1;\n  for (let i = 0; i < fieldPaths.length; i++) {\n    const cmp = compareValues(\n      evaluateFieldPath(fieldPaths[i]!, doc),\n      cursorKeys[i] as any,\n    );\n    if (cmp !== 0) return cmp * orderMultiplier;\n  }\n  return 0;\n};\n\nexport interface PageRequest {\n  readonly query: SerializedQuery;\n  readonly cursor: string | null;\n  readonly endCursor?: string | null;\n  readonly pageSize: number;\n  readonly maximumRowsRead?: number | null;\n  readonly maximumBytesRead?: number | null;\n}\n\nexport const paginate = (\n  view: TableView,\n  {\n    query,\n    cursor,\n    endCursor,\n    pageSize,\n    maximumRowsRead,\n    maximumBytesRead,\n  }: PageRequest,\n) => {\n  const { sortedDocs, filterFn, order, interval } = resolveSource(view, query);\n  // A page from the terminal cursor reads the empty interval past the end, so\n  // it depends on nothing.\n  if (cursor === \"_end_cursor\") {\n    return {\n      page: [],\n      isDone: true,\n      continueCursor: \"_end_cursor\",\n      splitCursor: null,\n      pageStatus: null,\n    };\n  }\n  const cursorFields = interval.fields;\n  const cursorKeys = parseCursor(cursor);\n  const hasEndBoundary = !!endCursor && endCursor !== \"_end_cursor\";\n  const endCursorKeys = hasEndBoundary ? parseCursor(endCursor) : null;\n  const examined = view.read(interval, cursorKeys);\n  let reachedEnd = true;\n\n  const page: Array<GenericDocument> = [];\n  let isInPage = cursor === null;\n  let continueCursor = \"_end_cursor\";\n  let splitCursor: string | null = null;\n  let pageStatus: \"SplitRecommended\" | \"SplitRequired\" | null = null;\n  let rowsRead = 0;\n  let bytesRead = 0;\n  const readDocCursors: Array<string> = [];\n\n  for (let i = 0; i < sortedDocs.length; i++) {\n    const doc = sortedDocs[i]!;\n    const isLastDoc = i === sortedDocs.length - 1;\n    if (!isInPage) {\n      if (cursorKeys) {\n        if (compareToCursor(doc, cursorKeys, cursorFields, order) > 0) {\n          isInPage = true;\n        } else {\n          continue;\n        }\n      }\n    }\n    if (hasEndBoundary && endCursorKeys) {\n      const cmp = compareToCursor(doc, endCursorKeys, cursorFields, order);\n      if (cmp >= 0) {\n        reachedEnd = false;\n        examined(endCursorKeys);\n        if (cmp === 0) {\n          view.examine(interval.table, doc);\n          rowsRead += 1;\n          bytesRead += getDocumentSize(doc);\n          readDocCursors.push(encodeCursor(doc, cursorFields));\n          if (filterFn(doc)) page.push(doc);\n          continueCursor = encodeCursor(doc, cursorFields);\n        }\n        break;\n      }\n    }\n    view.examine(interval.table, doc);\n    rowsRead += 1;\n    bytesRead += getDocumentSize(doc);\n    readDocCursors.push(encodeCursor(doc, cursorFields));\n    examined(ReadSet.keyOf(cursorFields, doc as StoredDocument));\n    const hitLimit =\n      (!!maximumRowsRead && rowsRead >= maximumRowsRead) ||\n      (!!maximumBytesRead && bytesRead >= maximumBytesRead);\n    if (filterFn(doc)) page.push(doc);\n    if (hitLimit) {\n      reachedEnd = false;\n      pageStatus = \"SplitRequired\";\n      continueCursor = encodeCursor(doc, cursorFields);\n      break;\n    }\n    if (!endCursor && page.length >= pageSize) {\n      reachedEnd = isLastDoc;\n      if (!isLastDoc) continueCursor = encodeCursor(doc, cursorFields);\n      break;\n    }\n  }\n  // A page bounded by an end cursor examined the range only up to it.\n  if (reachedEnd) examined(endCursorKeys ?? \"end\");\n\n  if (pageStatus === \"SplitRequired\" && readDocCursors.length >= 2) {\n    splitCursor = readDocCursors[Math.floor((readDocCursors.length - 1) / 2)]!;\n  } else if (\n    pageStatus === null &&\n    rowsRead > pageSize + 1 &&\n    readDocCursors.length >= 2\n  ) {\n    pageStatus = \"SplitRecommended\";\n    splitCursor = readDocCursors[Math.floor((readDocCursors.length - 1) / 2)]!;\n  }\n\n  return {\n    page,\n    isDone: continueCursor === \"_end_cursor\",\n    continueCursor,\n    splitCursor,\n    pageStatus,\n  };\n};\n"],"mappings":";;;;;AAqDA,MAAa,gBACX,WACwB;CACxB,IAAI,WAAW,QAAQ,WAAW,KAAA,GAAW,OAAO;CACpD,MAAM,WAAyB;EAC7B,kBAAmB,OAChB;EACH,QAAQ,IAAI,IACV,OAAO,QAAQ,OAAO,MAAM,CAAC,CAAC,KAAK,CAAC,MAAM,WAAW,CACnD,MACC,MAA2C,OAAO,CACrD,CAAC,CACH;CACF;CACA,SAAS,OAAO,SAAS,OAAO,cAAc;EAC5C,IAAI,CAAC,kBAAkB,SAAS,GAC9B,MAAM,IAAI,MACR,+CAA+C,UAAU,EAC3D;EAEF,mBAAmB,MAAM,YAAY;EACrC,MAAM,QAAQ,SAAS,EAAE,sBAAsB;GAC7C,IAAI,CAAC,kBAAkB,eAAe,GACpC,MAAM,IAAI,MACR,+CAA+C,gBAAgB,EACjE;EAEJ,CAAC;CACH,CAAC;CACD,OAAO;AACT;;;;;AAMA,MAAa,oBACX,QACA,WACA,QACG;CACH,IAAI,WAAW,QAAQ,CAAC,OAAO,kBAAkB;CACjD,MAAM,YAAY,OAAO,OAAO,IAAI,SAAS,CAAC,EAAE;CAChD,IAAI,cAAc,KAAA,GAAW;CAC7B,kBAAkB,WAAW,qBAAqB,GAAsB,CAAC;AAC3E;AAmCA,MAAM,iBACJ,MACA,UACmB;CACnB,MAAM,SAAS,MAAM;CACrB,IAAI;CACJ,IAAI;CACJ,IAAI;CACJ,IAAI;CACJ,IAAI,QAAkD,CAAC;CACvD,IAAI;CACJ,QAAQ,OAAO,MAAf;EACE,KAAK;GACH,QAAQ,OAAO;GAEf,QAAQ;GACR,OAAO,CAAC,GAAG,KAAK,KAAK,OAAO,SAAS,CAAC;GACtC,QAAQ,OAAO,SAAS;GACxB,qBAAqB,CAAC,eAAe;GACrC;EAEF,KAAK,cAAc;GACjB,MAAM,CAAC,WAAW,aAAa,OAAO,UAAU,MAAM,GAAG;GAIzD,QAAQ;GACR,QAAQ;GACR,QAAQ,OAAO;GACf,QAAQ,OAAO,SAAS;GACxB,IAAI;GACJ,IAAI,cAAc,oBAChB,SAAS,CAAC,iBAAiB,KAAK;QAC3B,IAAI,cAAc,SACvB,SAAS,CAAC,KAAK;QACV;IACL,MAAM,WAAW,KAAK,QAAQ,OAC3B,IAAI,SAAS,CAAC,EACb,QAAQ,MACP,EAAE,sBAAsB,oBAAoB,SAC/C;IACF,IAAI,aAAa,KAAA,GACf,MAAM,IAAI,MACR,qBAAqB,UAAU,eAAe,UAAU,4CAE1D;IAEF,SAAS,SAAS,OAAO,OAAO,CAAC,iBAAiB,KAAK,CAAC;GAC1D;GACA,qBAAqB;GACrB,6BAA6B,QAAQ,MAAM;GAC3C,OAAO,KACJ,KAAK,SAAS,CAAC,CACf,QAAQ,QACP,OAAO,MAAM,OAAO,WAAW,oBAAoB,KAAK,MAAM,CAAC,CACjE;GACF;EACF;EACA,KAAK,UACH,MAAMA,eAA6B,YAAY;CAEnD;CAEA,MAAM,UAAU,MAAM,UACnB,QACE,aAAiD,YAAY,QAChE,CAAC,CACA,KAAK,aAAa,SAAS,MAAM;CACpC,MAAM,QACJ,MAAM,UAAU,MACb,aAA4C,WAAW,QAC1D,KAAK;CAEP,MAAM,kBAAkB,UAAU,QAAQ,IAAI;CAC9C,KAAK,MAAM,GAAG,MAAM;EAClB,KAAK,MAAM,MAAM,oBAAoB;GACnC,MAAM,IAAI,cACR,kBAAkB,IAAI,CAAC,GACvB,kBAAkB,IAAI,CAAC,CACzB;GACA,IAAI,MAAM,GAAG,OAAO,IAAI;EAC1B;EACA,OAAO;CACT,CAAC;CAED,OAAO;EACL,YAAY;EACZ,WAAW,QAAQ,QAAQ,OAAO,MAAM,eAAe,KAAK,CAAC,CAAC;EAC9D,OAAO,OAAO,SAAS;EACvB;EACA,UAAU;GACR,MAAM;GACN;GACA;GACA,QAAQ,mBAAmB,SAAS,KAAK,IACrC,qBACA,CAAC,GAAG,oBAAoB,KAAK;GACjC;GACA;EACF;CACF;AACF;;;;;;AAOA,MAAa,UACX,MACA,UAC8B;CAC9B,MAAM,EAAE,YAAY,UAAU,OAAO,aAAa,cAAc,MAAM,KAAK;CAC3E,MAAM,WAAW,KAAK,KAAK,UAAU,IAAI;CACzC,QAAQ,aAAa;EACnB,IAAI,WAAW;EACf,KAAK,MAAM,OAAO,YAAY;GAC5B,IAAI,UAAU,QAAQ,YAAY,OAAO;GACzC,KAAK,QAAQ,SAAS,OAAO,GAAG;GAChC,SAASC,MAAc,SAAS,QAAQ,GAAqB,CAAC;GAC9D,IAAI,SAAS,GAAG,GAAG;IACjB;IACA,MAAM;GACR;EACF;EACA,SAAS,KAAK;CAChB,EAAA,CAAG;AACL;AAEA,MAAM,gBACJ,KACA,eAEA,KAAK,UACH,WAAW,KAAK,OAAO;CACrB,MAAM,IAAI,kBAAkB,IAAI,GAAG;CACnC,OAAO,MAAM,KAAA,IAAY,OAAO,KAAK,UAAU,aAAa,CAAC,CAAC;AAChE,CAAC,CACH;AAEF,MAAM,eAAe,MACnB,IACK,KAAK,MAAM,CAAC,CAAC,CAA0B,KAAK,MAC3C,MAAM,OAAO,KAAA,IAAY,aAAa,KAAK,MAAM,CAAC,CAAC,CACrD,IACA;AAEN,MAAM,mBACJ,KACA,YACA,YACA,UACW;CACX,MAAM,kBAAkB,UAAU,QAAQ,IAAI;CAC9C,KAAK,IAAI,IAAI,GAAG,IAAI,WAAW,QAAQ,KAAK;EAC1C,MAAM,MAAM,cACV,kBAAkB,WAAW,IAAK,GAAG,GACrC,WAAW,EACb;EACA,IAAI,QAAQ,GAAG,OAAO,MAAM;CAC9B;CACA,OAAO;AACT;AAWA,MAAa,YACX,MACA,EACE,OACA,QACA,WACA,UACA,iBACA,uBAEC;CACH,MAAM,EAAE,YAAY,UAAU,OAAO,aAAa,cAAc,MAAM,KAAK;CAG3E,IAAI,WAAW,eACb,OAAO;EACL,MAAM,CAAC;EACP,QAAQ;EACR,gBAAgB;EAChB,aAAa;EACb,YAAY;CACd;CAEF,MAAM,eAAe,SAAS;CAC9B,MAAM,aAAa,YAAY,MAAM;CACrC,MAAM,iBAAiB,CAAC,CAAC,aAAa,cAAc;CACpD,MAAM,gBAAgB,iBAAiB,YAAY,SAAS,IAAI;CAChE,MAAM,WAAW,KAAK,KAAK,UAAU,UAAU;CAC/C,IAAI,aAAa;CAEjB,MAAM,OAA+B,CAAC;CACtC,IAAI,WAAW,WAAW;CAC1B,IAAI,iBAAiB;CACrB,IAAI,cAA6B;CACjC,IAAI,aAA0D;CAC9D,IAAI,WAAW;CACf,IAAI,YAAY;CAChB,MAAM,iBAAgC,CAAC;CAEvC,KAAK,IAAI,IAAI,GAAG,IAAI,WAAW,QAAQ,KAAK;EAC1C,MAAM,MAAM,WAAW;EACvB,MAAM,YAAY,MAAM,WAAW,SAAS;EAC5C,IAAI,CAAC,UACC;OAAA,YAAY;IACd,IAAI,gBAAgB,KAAK,YAAY,cAAc,KAAK,IAAI,GAC1D,WAAW;SAEX;GAEJ;;EAEF,IAAI,kBAAkB,eAAe;GACnC,MAAM,MAAM,gBAAgB,KAAK,eAAe,cAAc,KAAK;GACnE,IAAI,OAAO,GAAG;IACZ,aAAa;IACb,SAAS,aAAa;IACtB,IAAI,QAAQ,GAAG;KACb,KAAK,QAAQ,SAAS,OAAO,GAAG;KAChC,YAAY;KACZ,aAAa,gBAAgB,GAAG;KAChC,eAAe,KAAK,aAAa,KAAK,YAAY,CAAC;KACnD,IAAI,SAAS,GAAG,GAAG,KAAK,KAAK,GAAG;KAChC,iBAAiB,aAAa,KAAK,YAAY;IACjD;IACA;GACF;EACF;EACA,KAAK,QAAQ,SAAS,OAAO,GAAG;EAChC,YAAY;EACZ,aAAa,gBAAgB,GAAG;EAChC,eAAe,KAAK,aAAa,KAAK,YAAY,CAAC;EACnD,SAASA,MAAc,cAAc,GAAqB,CAAC;EAC3D,MAAM,WACH,CAAC,CAAC,mBAAmB,YAAY,mBACjC,CAAC,CAAC,oBAAoB,aAAa;EACtC,IAAI,SAAS,GAAG,GAAG,KAAK,KAAK,GAAG;EAChC,IAAI,UAAU;GACZ,aAAa;GACb,aAAa;GACb,iBAAiB,aAAa,KAAK,YAAY;GAC/C;EACF;EACA,IAAI,CAAC,aAAa,KAAK,UAAU,UAAU;GACzC,aAAa;GACb,IAAI,CAAC,WAAW,iBAAiB,aAAa,KAAK,YAAY;GAC/D;EACF;CACF;CAEA,IAAI,YAAY,SAAS,iBAAiB,KAAK;CAE/C,IAAI,eAAe,mBAAmB,eAAe,UAAU,GAC7D,cAAc,eAAe,KAAK,OAAO,eAAe,SAAS,KAAK,CAAC;MAClE,IACL,eAAe,QACf,WAAW,WAAW,KACtB,eAAe,UAAU,GACzB;EACA,aAAa;EACb,cAAc,eAAe,KAAK,OAAO,eAAe,SAAS,KAAK,CAAC;CACzE;CAEA,OAAO;EACL;EACA,QAAQ,mBAAmB;EAC3B;EACA;EACA;CACF;AACF"}

package/dist/internal/Metering.d.ts

@@ -0,0 +1,186 @@
+import type { TransactionMetrics } from "convex/server";
+import { type Value } from "convex/values";
+import * as Schema from "effect/Schema";
+import type { SerializedRangeExpression } from "./KernelValues.js";
+/**
+ * The ceilings one function execution runs under, the binary's
+ * `TransactionLimits` (`crates/database/src/execution_size.rs:62-95`).
+ */
+export type Limits = {
+    readonly [K in keyof TransactionMetrics]: number;
+};
+/**
+ * The binary's default ceilings (`crates/common/src/knobs.rs`).
+ */
+export declare const defaults: Limits;
+/**
+ * What a nested call may use on top of what its transaction has used, as
+ * `ctx.runQuery` and `ctx.runMutation` take it in `transactionLimits`.
+ */
+export type Budget = Partial<Limits>;
+/**
+ * A nested call's ceilings: each one what the transaction has used plus the
+ * call's budget, never above the caller's (`TransactionLimits::from_budget`,
+ * execution_size.rs:97-160). An unset field leaves the caller's ceiling.
+ */
+export declare const fromBudget: (budget: Budget, used: Limits, ceiling: Limits) => Limits;
+declare const TransactionLimitExceeded_base: Schema.Class<TransactionLimitExceeded, Schema.TaggedStruct<"TransactionLimitExceeded", {
+    readonly code: Schema.Literals<readonly ["TooManyReads", "TooManyDocumentsRead", "TooManyBytesRead", "TooManyWrites", "TooManyBytesWritten", "TooManyFunctionsScheduled", "ScheduledFunctionsArgumentsTooLarge"]>;
+    readonly limit: Schema.Int;
+    readonly message: Schema.String;
+}>, import("effect/Cause").YieldableError>;
+/**
+ * A function execution crossed one of its ceilings. `code` is the binary's
+ * short message and `message` its text, which the function receives as a
+ * catchable error.
+ */
+export declare class TransactionLimitExceeded extends TransactionLimitExceeded_base {
+}
+/**
+ * `common::fmt::format_bytes` (`crates/common/src/fmt.rs:29-47`).
+ */
+export declare const formatBytes: (n: number) => string;
+/**
+ * A position in an index's key space: just before, or just after, every key
+ * that starts with `key`.
+ */
+interface Bound {
+    readonly key: ReadonlyArray<Value | undefined>;
+    readonly side: -1 | 1;
+}
+/**
+ * The keys from `start` up to `end`.
+ */
+export interface KeyInterval {
+    readonly start: Bound;
+    readonly end: Bound;
+}
+/**
+ * The one key `key`, as a read or write of a document by ID records it.
+ */
+export declare const point: (key: ReadonlyArray<Value | undefined>) => KeyInterval;
+/**
+ * Every key of an index.
+ */
+export declare const everything: KeyInterval;
+/**
+ * The part of an index range a query has examined: from where it starts, past
+ * the cursor `after`, through `through` in its order. `null` when it has
+ * examined nothing.
+ */
+export declare const examined: (range: ReadonlyArray<SerializedRangeExpression>, order: "asc" | "desc", after: ReadonlyArray<Value | undefined> | null, through: ReadonlyArray<Value | undefined> | "end") => KeyInterval | null;
+/**
+ * The intervals read from one index, overlapping and adjacent ones merged
+ * (`IntervalSet::add`, `crates/common/src/interval/interval_set.rs:150-230`).
+ * They stay sorted and disjoint, so an add touches only its neighbours.
+ */
+declare class IntervalSet {
+    private readonly intervals;
+    get size(): number;
+    add(interval: KeyInterval): void;
+}
+/**
+ * The counters every frame of one attempt shares: reads and schedules stay when
+ * a nested mutation fails, as the binary keeps them outside its subtransaction
+ * token (`crates/database/src/transaction.rs:418-454`).
+ */
+declare class Shared {
+    readonly indexes: Map<string, IntervalSet>;
+    intervals: number;
+    documentsRead: number;
+    bytesRead: number;
+    functionsScheduled: number;
+    scheduledFunctionArgsBytes: number;
+    readonly filesRead = 0;
+    readonly fileReadBytes = 0;
+    /**
+     * A stale-snapshot query's counters: the scheduling and file-read counters
+     * carried over, reads and intervals from zero (`clone_for_snapshot_query`,
+     * `crates/database/src/transaction.rs:1460-1485`).
+     */
+    forStaleSnapshot(): Shared;
+}
+/**
+ * One frame's share of an attempt's accounting. The outermost frame belongs to
+ * the top-level function and each nested mutation gets a child. A child's
+ * writes count toward its caller's once it merges and are forgotten when it
+ * fails, as the binary's nested write set rolls its sizes back
+ * (`crates/database/src/writes.rs:96-136`).
+ */
+export declare class Meter {
+    private readonly shared;
+    private readonly parent?;
+    private documentsWritten;
+    private bytesWritten;
+    private readonly filesWritten;
+    private readonly fileWriteBytes;
+    constructor(shared?: Shared, parent?: Meter | undefined);
+    child(): Meter;
+    /**
+     * The meter of a query run on a stale snapshot. The binary runs it on a clone
+     * of the transaction that keeps the scheduling counters and starts reads and
+     * writes from zero, then drops the clone, so nothing it counts reaches this
+     * meter (`clone_for_snapshot_query`,
+     * `crates/database/src/transaction.rs:1460-1485`; `run_udf`,
+     * `crates/isolate/src/environment/udf/async_syscall.rs:695-776`).
+     */
+    forStaleSnapshot(): Meter;
+    /**
+     * The child's writes become its caller's.
+     */
+    merge(): void;
+    private chain;
+    /**
+     * How much of each limit the execution has used.
+     */
+    used(): Limits;
+    /**
+     * What `getTransactionMetrics` answers (`tx_metrics`,
+     * `crates/isolate/src/environment/udf/async_syscall.rs:947-993`).
+     */
+    metrics(limits: Limits): TransactionMetrics;
+    private set;
+    /**
+     * A read the function made of `interval` in `index`, counted as the binary
+     * counts it: the total drops by the index's interval count before the read,
+     * saturating at zero, and rises by its count after
+     * (`record_indexed_directly`, `crates/database/src/reads.rs:447-480`). The
+     * index's count includes the intervals of IDs this execution inserted, which
+     * joined it without counting (`deriveInterval`), so a read that covers them
+     * can move the total by more than the read itself. The binary starts the
+     * total at the system-table intervals it reads to run the function, which the
+     * kernel does not simulate. While neither total saturates they differ by
+     * exactly that share. A read that saturates only the kernel's lower total
+     * narrows the gap, and it never widens or turns negative (see the
+     * `SystemTableReadIntervals` boundary).
+     */
+    readInterval(index: string, interval: KeyInterval, limits: Limits): TransactionLimitExceeded | undefined;
+    /**
+     * A read the binary takes for a write rather than for the function: a new
+     * document's ID (`register_new_id`, writes.rs:426-441). It joins the index's
+     * intervals and leaves the total as it was (`record_indexed_derived` calls
+     * `_record_indexed` and ignores its counts, reads.rs:333-344), so a later
+     * read of that index starts from a count that includes it.
+     */
+    deriveInterval(index: string, interval: KeyInterval): void;
+    /**
+     * A document the function read. A system table's document counts toward no
+     * limit (`record_read_document`, reads.rs:365-445).
+     */
+    readDocument(document: Value, system: boolean, limits: Limits): TransactionLimitExceeded | undefined;
+    /**
+     * A write to a user table: the new document, or `null` for a delete. Each
+     * write counts, even to a document this execution already wrote
+     * (`Writes::update`, writes.rs:241-310).
+     */
+    write(document: Value | null, limits: Limits): TransactionLimitExceeded | undefined;
+    /**
+     * A function scheduled with `args`. The binary checks before it counts, so a
+     * refused schedule counts nothing (`check_scheduling_limits`,
+     * `crates/model/src/scheduled_jobs/mod.rs:162-196`). Its arguments are sized
+     * as the one-element array the scheduler stores.
+     */
+    schedule(args: Value, limits: Limits): TransactionLimitExceeded | undefined;
+}
+export {};
+//# sourceMappingURL=Metering.d.ts.map

package/dist/internal/Metering.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Metering.d.ts","sourceRoot":"","sources":["../../src/internal/Metering.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,eAAe,CAAC;AACxD,OAAO,EAAgC,KAAK,KAAK,EAAE,MAAM,eAAe,CAAC;AACzE,OAAO,KAAK,MAAM,MAAM,eAAe,CAAC;AACxC,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,mBAAmB,CAAC;AAGnE;;;GAGG;AACH,MAAM,MAAM,MAAM,GAAG;IAAE,QAAQ,EAAE,CAAC,IAAI,MAAM,kBAAkB,GAAG,MAAM;CAAE,CAAC;AAE1E;;GAEG;AACH,eAAO,MAAM,QAAQ,EAAE,MAuBtB,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;AAErC;;;;GAIG;AACH,eAAO,MAAM,UAAU,WACb,MAAM,QACR,MAAM,WACH,MAAM,KACd,MASqB,CAAC;;;;;;AAKzB;;;;GAIG;AACH,qBAAa,wBAAyB,SAAQ,6BAe7C;CAAG;AAWJ;;GAEG;AACH,eAAO,MAAM,WAAW,MAAO,MAAM,KAAG,MAUvC,CAAC;AAEF;;;GAGG;AACH,UAAU,KAAK;IACb,QAAQ,CAAC,GAAG,EAAE,aAAa,CAAC,KAAK,GAAG,SAAS,CAAC,CAAC;IAC/C,QAAQ,CAAC,IAAI,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC;CACvB;AAED;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B,QAAQ,CAAC,KAAK,EAAE,KAAK,CAAC;IACtB,QAAQ,CAAC,GAAG,EAAE,KAAK,CAAC;CACrB;AAeD;;GAEG;AACH,eAAO,MAAM,KAAK,QAAS,aAAa,CAAC,KAAK,GAAG,SAAS,CAAC,KAAG,WAG5D,CAAC;AAEH;;GAEG;AACH,eAAO,MAAM,UAAU,EAAE,WAAuB,CAAC;AAEjD;;;;GAIG;AACH,eAAO,MAAM,QAAQ,UACZ,aAAa,CAAC,yBAAyB,CAAC,SACxC,KAAK,GAAG,MAAM,SACd,aAAa,CAAC,KAAK,GAAG,SAAS,CAAC,GAAG,IAAI,WACrC,aAAa,CAAC,KAAK,GAAG,SAAS,CAAC,GAAG,KAAK,KAChD,WAAW,GAAG,IAqChB,CAAC;AAEF;;;;GAIG;AACH,cAAM,WAAW;IACf,OAAO,CAAC,QAAQ,CAAC,SAAS,CAA0B;IAEpD,IAAI,IAAI,IAAI,MAAM,CAEjB;IAED,GAAG,CAAC,QAAQ,EAAE,WAAW,QA2BxB;CACF;AAED;;;;GAIG;AACH,cAAM,MAAM;IACV,QAAQ,CAAC,OAAO,2BAAkC;IAClD,SAAS,SAAK;IACd,aAAa,SAAK;IAClB,SAAS,SAAK;IACd,kBAAkB,SAAK;IACvB,0BAA0B,SAAK;IAE/B,QAAQ,CAAC,SAAS,KAAK;IACvB,QAAQ,CAAC,aAAa,KAAK;IAE3B;;;;OAIG;IACH,gBAAgB,IAAI,MAAM,CAKzB;CACF;AAOD;;;;;;GAMG;AACH,qBAAa,KAAK;IAQd,OAAO,CAAC,QAAQ,CAAC,MAAM;IACvB,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAC;IAR1B,OAAO,CAAC,gBAAgB,CAAK;IAC7B,OAAO,CAAC,YAAY,CAAK;IAEzB,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAK;IAClC,OAAO,CAAC,QAAQ,CAAC,cAAc,CAAK;IAEpC,YACmB,MAAM,GAAE,MAAqB,EAC7B,MAAM,CAAC,EAAE,KAAK,YAAA,EAC7B;IAEJ,KAAK,IAAI,KAAK,CAEb;IAED;;;;;;;OAOG;IACH,gBAAgB,IAAI,KAAK,CAExB;IAED;;OAEG;IACH,KAAK,SAMJ;IAED,OAAO,CAAC,KAAK;IAIb;;OAEG;IACH,IAAI,IAAI,MAAM,CAkBb;IAED;;;OAGG;IACH,OAAO,CAAC,MAAM,EAAE,MAAM,GAAG,kBAAkB,CAQ1C;IAED,OAAO,CAAC,GAAG;IAMX;;;;;;;;;;;;;OAaG;IACH,YAAY,CACV,KAAK,EAAE,MAAM,EACb,QAAQ,EAAE,WAAW,EACrB,MAAM,EAAE,MAAM,GACb,wBAAwB,GAAG,SAAS,CAmBtC;IAED;;;;;;OAMG;IACH,cAAc,CAAC,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,WAAW,QAElD;IAED;;;OAGG;IACH,YAAY,CACV,QAAQ,EAAE,KAAK,EACf,MAAM,EAAE,OAAO,EACf,MAAM,EAAE,MAAM,GACb,wBAAwB,GAAG,SAAS,CAoBtC;IAED;;;;OAIG;IACH,KAAK,CACH,QAAQ,EAAE,KAAK,GAAG,IAAI,EACtB,MAAM,EAAE,MAAM,GACb,wBAAwB,GAAG,SAAS,CAmBtC;IAED;;;;;OAKG;IACH,QAAQ,CAAC,IAAI,EAAE,KAAK,EAAE,MAAM,EAAE,MAAM,GAAG,wBAAwB,GAAG,SAAS,CAuB1E;CACF"}

package/dist/internal/Metering.js

@@ -0,0 +1,401 @@
+import { evaluateQueryValue } from "./KernelValues.js";
+import * as Schema from "effect/Schema";
+import { compareValues, getConvexSize } from "convex/values";
+//#region src/internal/Metering.ts
+/**
+* The binary's default ceilings (`crates/common/src/knobs.rs`).
+*/
+const defaults = {
+	bytesRead: 1 << 24,
+	documentsRead: 32e3,
+	databaseQueries: 4096,
+	documentsWritten: 16e3,
+	bytesWritten: 1 << 24,
+	functionsScheduled: 1e3,
+	scheduledFunctionArgsBytes: 1 << 24,
+	filesWritten: 10,
+	fileWriteBytes: 1 << 24,
+	filesRead: 10,
+	fileReadBytes: 1 << 24
+};
+/**
+* A nested call's ceilings: each one what the transaction has used plus the
+* call's budget, never above the caller's (`TransactionLimits::from_budget`,
+* execution_size.rs:97-160). An unset field leaves the caller's ceiling.
+*/
+const fromBudget = (budget, used, ceiling) => Object.fromEntries(Object.keys(ceiling).map((metric) => [metric, Math.min(used[metric] + (budget[metric] ?? ceiling[metric]), ceiling[metric])]));
+const overLimitHelp = "Consider using smaller limits in your queries, paginating your queries, or using indexed queries with a selective index range expressions.";
+/**
+* A function execution crossed one of its ceilings. `code` is the binary's
+* short message and `message` its text, which the function receives as a
+* catchable error.
+*/
+var TransactionLimitExceeded = class extends Schema.TaggedError()("TransactionLimitExceeded", {
+	code: Schema.Literals([
+		"TooManyReads",
+		"TooManyDocumentsRead",
+		"TooManyBytesRead",
+		"TooManyWrites",
+		"TooManyBytesWritten",
+		"TooManyFunctionsScheduled",
+		"ScheduledFunctionsArgumentsTooLarge"
+	]),
+	limit: Schema.Int,
+	message: Schema.String
+}) {};
+const byteUnits = [
+	[2 ** 30, "GiB"],
+	[1e9, "GB"],
+	[2 ** 20, "MiB"],
+	[1e6, "MB"],
+	[1024, "KiB"],
+	[1e3, "KB"]
+];
+/**
+* `common::fmt::format_bytes` (`crates/common/src/fmt.rs:29-47`).
+*/
+const formatBytes = (n) => {
+	if (n === 0) return "0 bytes";
+	for (const [unit, name] of byteUnits) {
+		if (n < unit) continue;
+		if (n % unit === 0) return `${n / unit} ${name}`;
+		if (n * 10 % unit === 0) return `${Math.floor(n / unit)}.${Math.floor(n * 10 / unit) % 10} ${name}`;
+	}
+	return `${n} bytes`;
+};
+const compareBounds = (a, b) => {
+	const shared = Math.min(a.key.length, b.key.length);
+	for (let i = 0; i < shared; i++) {
+		const cmp = compareValues(a.key[i], b.key[i]);
+		if (cmp !== 0) return cmp;
+	}
+	if (a.key.length === b.key.length) return a.side - b.side;
+	return a.key.length < b.key.length ? a.side : -b.side;
+};
+const maxBound = (a, b) => compareBounds(a, b) >= 0 ? a : b;
+const minBound = (a, b) => compareBounds(a, b) <= 0 ? a : b;
+/**
+* The one key `key`, as a read or write of a document by ID records it.
+*/
+const point = (key) => ({
+	start: {
+		key,
+		side: -1
+	},
+	end: {
+		key,
+		side: 1
+	}
+});
+/**
+* Every key of an index.
+*/
+const everything = point([]);
+/**
+* The part of an index range a query has examined: from where it starts, past
+* the cursor `after`, through `through` in its order. `null` when it has
+* examined nothing.
+*/
+const examined = (range, order, after, through) => {
+	const equal = [];
+	let start;
+	let end;
+	for (const expression of range) {
+		const value = evaluateQueryValue(expression.value);
+		switch (expression.type) {
+			case "Eq":
+				equal.push(value);
+				break;
+			case "Gt":
+			case "Gte":
+				start = {
+					key: [...equal, value],
+					side: expression.type === "Gt" ? 1 : -1
+				};
+				break;
+			case "Lt":
+			case "Lte": end = {
+				key: [...equal, value],
+				side: expression.type === "Lt" ? -1 : 1
+			};
+		}
+	}
+	start ??= {
+		key: equal,
+		side: -1
+	};
+	end ??= {
+		key: equal,
+		side: 1
+	};
+	if (after !== null) {
+		if (order === "asc") start = maxBound(start, {
+			key: after,
+			side: 1
+		});
+		else end = minBound(end, {
+			key: after,
+			side: -1
+		});
+	}
+	if (through !== "end") {
+		if (order === "asc") end = minBound(end, {
+			key: through,
+			side: 1
+		});
+		else start = maxBound(start, {
+			key: through,
+			side: -1
+		});
+	}
+	return compareBounds(start, end) < 0 ? {
+		start,
+		end
+	} : null;
+};
+/**
+* The intervals read from one index, overlapping and adjacent ones merged
+* (`IntervalSet::add`, `crates/common/src/interval/interval_set.rs:150-230`).
+* They stay sorted and disjoint, so an add touches only its neighbours.
+*/
+var IntervalSet = class {
+	intervals = [];
+	get size() {
+		return this.intervals.length;
+	}
+	add(interval) {
+		const intervals = this.intervals;
+		let low = 0;
+		let high = intervals.length;
+		while (low < high) {
+			const middle = low + high >> 1;
+			if (compareBounds(intervals[middle].end, interval.start) < 0) low = middle + 1;
+			else high = middle;
+		}
+		let last = low;
+		let merged = interval;
+		while (last < intervals.length && compareBounds(intervals[last].start, interval.end) <= 0) {
+			const other = intervals[last];
+			merged = {
+				start: minBound(merged.start, other.start),
+				end: maxBound(merged.end, other.end)
+			};
+			last++;
+		}
+		intervals.splice(low, last - low, merged);
+	}
+};
+/**
+* The counters every frame of one attempt shares: reads and schedules stay when
+* a nested mutation fails, as the binary keeps them outside its subtransaction
+* token (`crates/database/src/transaction.rs:418-454`).
+*/
+var Shared = class Shared {
+	indexes = /* @__PURE__ */ new Map();
+	intervals = 0;
+	documentsRead = 0;
+	bytesRead = 0;
+	functionsScheduled = 0;
+	scheduledFunctionArgsBytes = 0;
+	filesRead = 0;
+	fileReadBytes = 0;
+	/**
+	* A stale-snapshot query's counters: the scheduling and file-read counters
+	* carried over, reads and intervals from zero (`clone_for_snapshot_query`,
+	* `crates/database/src/transaction.rs:1460-1485`).
+	*/
+	forStaleSnapshot() {
+		const copy = new Shared();
+		copy.functionsScheduled = this.functionsScheduled;
+		copy.scheduledFunctionArgsBytes = this.scheduledFunctionArgsBytes;
+		return copy;
+	}
+};
+/**
+* `a - b`, or 0 when `b` is larger: Rust's `usize::saturating_sub`.
+*/
+const saturatingSub = (a, b) => a > b ? a - b : 0;
+/**
+* One frame's share of an attempt's accounting. The outermost frame belongs to
+* the top-level function and each nested mutation gets a child. A child's
+* writes count toward its caller's once it merges and are forgotten when it
+* fails, as the binary's nested write set rolls its sizes back
+* (`crates/database/src/writes.rs:96-136`).
+*/
+var Meter = class Meter {
+	shared;
+	parent;
+	documentsWritten = 0;
+	bytesWritten = 0;
+	filesWritten = 0;
+	fileWriteBytes = 0;
+	constructor(shared = new Shared(), parent) {
+		this.shared = shared;
+		this.parent = parent;
+	}
+	child() {
+		return new Meter(this.shared, this);
+	}
+	/**
+	* The meter of a query run on a stale snapshot. The binary runs it on a clone
+	* of the transaction that keeps the scheduling counters and starts reads and
+	* writes from zero, then drops the clone, so nothing it counts reaches this
+	* meter (`clone_for_snapshot_query`,
+	* `crates/database/src/transaction.rs:1460-1485`; `run_udf`,
+	* `crates/isolate/src/environment/udf/async_syscall.rs:695-776`).
+	*/
+	forStaleSnapshot() {
+		return new Meter(this.shared.forStaleSnapshot());
+	}
+	/**
+	* The child's writes become its caller's.
+	*/
+	merge() {
+		if (this.parent === void 0) throw new Error("The outermost meter of an attempt has no caller.");
+		this.parent.documentsWritten += this.documentsWritten;
+		this.parent.bytesWritten += this.bytesWritten;
+	}
+	chain() {
+		return this.parent === void 0 ? [this] : [...this.parent.chain(), this];
+	}
+	/**
+	* How much of each limit the execution has used.
+	*/
+	used() {
+		const frames = this.chain();
+		const sum = (of) => frames.reduce((total, meter) => total + of(meter), 0);
+		const shared = this.shared;
+		return {
+			bytesRead: shared.bytesRead,
+			documentsRead: shared.documentsRead,
+			databaseQueries: shared.intervals,
+			documentsWritten: sum((meter) => meter.documentsWritten),
+			bytesWritten: sum((meter) => meter.bytesWritten),
+			functionsScheduled: shared.functionsScheduled,
+			scheduledFunctionArgsBytes: shared.scheduledFunctionArgsBytes,
+			filesWritten: sum((meter) => meter.filesWritten),
+			fileWriteBytes: sum((meter) => meter.fileWriteBytes),
+			filesRead: shared.filesRead,
+			fileReadBytes: shared.fileReadBytes
+		};
+	}
+	/**
+	* What `getTransactionMetrics` answers (`tx_metrics`,
+	* `crates/isolate/src/environment/udf/async_syscall.rs:947-993`).
+	*/
+	metrics(limits) {
+		const used = this.used();
+		return Object.fromEntries(Object.keys(limits).map((metric) => [metric, {
+			used: used[metric],
+			remaining: limits[metric] - used[metric]
+		}]));
+	}
+	set(index) {
+		const set = this.shared.indexes.get(index) ?? new IntervalSet();
+		this.shared.indexes.set(index, set);
+		return set;
+	}
+	/**
+	* A read the function made of `interval` in `index`, counted as the binary
+	* counts it: the total drops by the index's interval count before the read,
+	* saturating at zero, and rises by its count after
+	* (`record_indexed_directly`, `crates/database/src/reads.rs:447-480`). The
+	* index's count includes the intervals of IDs this execution inserted, which
+	* joined it without counting (`deriveInterval`), so a read that covers them
+	* can move the total by more than the read itself. The binary starts the
+	* total at the system-table intervals it reads to run the function, which the
+	* kernel does not simulate. While neither total saturates they differ by
+	* exactly that share. A read that saturates only the kernel's lower total
+	* narrows the gap, and it never widens or turns negative (see the
+	* `SystemTableReadIntervals` boundary).
+	*/
+	readInterval(index, interval, limits) {
+		const set = this.set(index);
+		const before = set.size;
+		set.add(interval);
+		const shared = this.shared;
+		shared.intervals = saturatingSub(shared.intervals, before) + set.size;
+		if (!Number.isSafeInteger(shared.intervals) || shared.intervals < 0) throw new Error(`The kernel counted ${shared.intervals} intervals read, which is no count.`);
+		return shared.intervals > limits.databaseQueries ? new TransactionLimitExceeded({
+			code: "TooManyReads",
+			limit: limits.databaseQueries,
+			message: `Too many reads in a single function execution (limit: ${limits.databaseQueries}). ${overLimitHelp}`
+		}) : void 0;
+	}
+	/**
+	* A read the binary takes for a write rather than for the function: a new
+	* document's ID (`register_new_id`, writes.rs:426-441). It joins the index's
+	* intervals and leaves the total as it was (`record_indexed_derived` calls
+	* `_record_indexed` and ignores its counts, reads.rs:333-344), so a later
+	* read of that index starts from a count that includes it.
+	*/
+	deriveInterval(index, interval) {
+		this.set(index).add(interval);
+	}
+	/**
+	* A document the function read. A system table's document counts toward no
+	* limit (`record_read_document`, reads.rs:365-445).
+	*/
+	readDocument(document, system, limits) {
+		if (system) return void 0;
+		const shared = this.shared;
+		shared.documentsRead += 1;
+		shared.bytesRead += getConvexSize(document);
+		if (shared.documentsRead > limits.documentsRead) return new TransactionLimitExceeded({
+			code: "TooManyDocumentsRead",
+			limit: limits.documentsRead,
+			message: `Too many documents read in a single function execution (limit: ${limits.documentsRead}). ${overLimitHelp}`
+		});
+		if (shared.bytesRead > limits.bytesRead) return new TransactionLimitExceeded({
+			code: "TooManyBytesRead",
+			limit: limits.bytesRead,
+			message: `Too many bytes read in a single function execution (limit: ${limits.bytesRead} bytes). ${overLimitHelp}`
+		});
+	}
+	/**
+	* A write to a user table: the new document, or `null` for a delete. Each
+	* write counts, even to a document this execution already wrote
+	* (`Writes::update`, writes.rs:241-310).
+	*/
+	write(document, limits) {
+		this.documentsWritten += 1;
+		this.bytesWritten += document === null ? 0 : getConvexSize(document);
+		const used = this.used();
+		if (used.documentsWritten > limits.documentsWritten) return new TransactionLimitExceeded({
+			code: "TooManyWrites",
+			limit: limits.documentsWritten,
+			message: `Too many writes in a single function execution (limit: ${limits.documentsWritten})`
+		});
+		if (used.bytesWritten > limits.bytesWritten) return new TransactionLimitExceeded({
+			code: "TooManyBytesWritten",
+			limit: limits.bytesWritten,
+			message: `Too many bytes written in a single function execution (limit: ${formatBytes(limits.bytesWritten)})`
+		});
+	}
+	/**
+	* A function scheduled with `args`. The binary checks before it counts, so a
+	* refused schedule counts nothing (`check_scheduling_limits`,
+	* `crates/model/src/scheduled_jobs/mod.rs:162-196`). Its arguments are sized
+	* as the one-element array the scheduler stores.
+	*/
+	schedule(args, limits) {
+		const shared = this.shared;
+		const size = getConvexSize([args]);
+		if (shared.functionsScheduled >= limits.functionsScheduled) return new TransactionLimitExceeded({
+			code: "TooManyFunctionsScheduled",
+			limit: limits.functionsScheduled,
+			message: `Too many functions scheduled by this mutation (limit: ${limits.functionsScheduled})`
+		});
+		if (shared.scheduledFunctionArgsBytes + size > limits.scheduledFunctionArgsBytes) return new TransactionLimitExceeded({
+			code: "ScheduledFunctionsArgumentsTooLarge",
+			limit: limits.scheduledFunctionArgsBytes,
+			message: `Too large total size of the arguments of scheduled functions from this mutation (limit: ${limits.scheduledFunctionArgsBytes} bytes)`
+		});
+		shared.functionsScheduled += 1;
+		shared.scheduledFunctionArgsBytes += size;
+	}
+};
+//#endregion
+export { Meter, TransactionLimitExceeded, defaults, everything, examined, formatBytes, fromBudget, point };
+
+//# sourceMappingURL=Metering.js.map