@rocicorp/zero 1.4.0-canary.1 → 1.4.0-canary.2

package/out/zql/src/query/query-internals.js.map

@@ -1 +1 @@
-{"version":3,"file":"query-internals.js","names":[],"sources":["../../../../../zql/src/query/query-internals.ts"],"sourcesContent":["import {assert} from '../../../shared/src/asserts.ts';\nimport type {ReadonlyJSONValue} from '../../../shared/src/json.ts';\nimport type {AST} from '../../../zero-protocol/src/ast.ts';\nimport type {Schema as ZeroSchema} from '../../../zero-types/src/schema.ts';\nimport type {Format} from '../ivm/view.ts';\nimport type {CustomQueryID} from './named.ts';\nimport type {Query} from './query.ts';\n\nexport const queryInternalsTag = Symbol();\n\n/**\n * Internal interface for query implementation details.\n * This is not part of the public API and should only be accessed via\n * the {@linkcode asQueryInternals} function.\n *\n * @typeParam TSchema The database schema type extending ZeroSchema\n * @typeParam TTable The name of the table being queried, must be a key of TSchema['tables']\n * @typeParam TReturn The return type of the query, defaults to PullRow<TTable, TSchema>\n */\nexport interface QueryInternals<\n  TTable extends keyof TSchema['tables'] & string,\n  TSchema extends ZeroSchema,\n  TReturn,\n> {\n  readonly [queryInternalsTag]: true;\n\n  /**\n   * Format is used to specify the shape of the query results. This is used by\n   * {@linkcode one} and it also describes the shape when using\n   * {@linkcode related}.\n   */\n  readonly format: Format;\n\n  /**\n   * A string that uniquely identifies this query. This can be used to determine\n   * if two queries are the same.\n   *\n   * The hash of a custom query, on the client, is the hash of its AST.\n   * The hash of a custom query, on the server, is the hash of its name and args.\n   *\n   * The first allows many client-side queries to be pinned to the same backend query.\n   * The second ensures we do not invoke a named query on the backend more than once for the same `name:arg` pairing.\n   *\n   * If the query.hash was of `name:args` then `useQuery` would de-dupe\n   * queries with divergent ASTs.\n   *\n   * QueryManager will hash based on `name:args` since it is speaking with\n   * the server which tracks queries by `name:args`.\n   */\n  hash(): string;\n\n  /**\n   * The completed AST for this query, with any missing primary keys added to\n   * orderBy and start.\n   */\n  readonly ast: AST;\n\n  readonly customQueryID: CustomQueryID | undefined;\n\n  /**\n   * Associates a name and arguments with this query for custom query tracking.\n   * This is used internally to track named queries on the server.\n   *\n   * @internal\n   */\n  nameAndArgs(\n    name: string,\n    args: ReadonlyArray<ReadonlyJSONValue>,\n  ): Query<TTable, TSchema, TReturn>;\n}\n\n/**\n * Helper function to cast a Query to QueryInternals.\n * This is used in tests and internal code to access query implementation details.\n * The function asserts that the query has the queryInternalsTag to ensure it\n * properly implements the QueryInternals interface.\n *\n * @internal\n */\nexport function asQueryInternals<\n  TTable extends keyof TSchema['tables'] & string,\n  TSchema extends ZeroSchema,\n  TReturn,\n>(\n  query: Query<TTable, TSchema, TReturn>,\n): QueryInternals<TTable, TSchema, TReturn> {\n  assert(queryInternalsTag in query, 'Query does not implement QueryInternals');\n  return query as unknown as QueryInternals<TTable, TSchema, TReturn>;\n}\n\nexport function isQueryInternals<\n  TTable extends keyof TSchema['tables'] & string,\n  TSchema extends ZeroSchema,\n  TReturn,\n>(obj: unknown): obj is QueryInternals<TTable, TSchema, TReturn> {\n  return typeof obj === 'object' && obj !== null && queryInternalsTag in obj;\n}\n\nexport function asQuery<\n  TTable extends keyof TSchema['tables'] & string,\n  TSchema extends ZeroSchema,\n  TReturn,\n>(\n  queryInternals: QueryInternals<TTable, TSchema, TReturn>,\n): Query<TTable, TSchema, TReturn> {\n  assert(queryInternalsTag in queryInternals, 'Expected query internals tag');\n  return queryInternals as unknown as Query<TTable, TSchema, TReturn>;\n}\n\n// oxlint-disable-next-line no-explicit-any\nexport type AnyQueryInternals = QueryInternals<string, ZeroSchema, any>;\n"],"mappings":";;AAQA,IAAa,oBAAoB,QAAQ;;;;;;;;;AAuEzC,SAAgB,iBAKd,OAC0C;AAC1C,QAAO,qBAAqB,OAAO,0CAA0C;AAC7E,QAAO"}
+{"version":3,"file":"query-internals.js","names":[],"sources":["../../../../../zql/src/query/query-internals.ts"],"sourcesContent":["import {assert} from '../../../shared/src/asserts.ts';\nimport type {ReadonlyJSONValue} from '../../../shared/src/json.ts';\nimport type {AST} from '../../../zero-protocol/src/ast.ts';\nimport type {Schema as ZeroSchema} from '../../../zero-types/src/schema.ts';\nimport type {Format} from '../ivm/view.ts';\nimport type {CustomQueryID} from './named.ts';\nimport type {Query} from './query.ts';\n\nexport const queryInternalsTag = Symbol();\n\n/**\n * Internal interface for query implementation details.\n * This is not part of the public API and should only be accessed via\n * the {@linkcode asQueryInternals} function.\n *\n * @typeParam TSchema The database schema type extending ZeroSchema\n * @typeParam TTable The name of the table being queried, must be a key of TSchema['tables']\n * @typeParam TReturn The return type of the query, defaults to PullRow<TTable, TSchema>\n */\nexport interface QueryInternals<\n  TTable extends keyof TSchema['tables'] & string,\n  TSchema extends ZeroSchema,\n  TReturn,\n> {\n  readonly [queryInternalsTag]: true;\n\n  /**\n   * Format is used to specify the shape of the query results. This is used by\n   * {@linkcode one} and it also describes the shape when using\n   * {@linkcode related}.\n   */\n  readonly format: Format;\n\n  /**\n   * A string that uniquely identifies this query. This can be used to determine\n   * if two queries are the same.\n   *\n   * The hash of a custom query, on the client, is the hash of its AST.\n   * The hash of a custom query, on the server, is the hash of its name and args.\n   *\n   * The first allows many client-side queries to be pinned to the same backend query.\n   * The second ensures we do not invoke a named query on the backend more than once for the same `name:arg` pairing.\n   *\n   * If the query.hash was of `name:args` then `useQuery` would de-dupe\n   * queries with divergent ASTs.\n   *\n   * QueryManager will hash based on `name:args` since it is speaking with\n   * the server which tracks queries by `name:args`.\n   */\n  hash(): string;\n\n  /**\n   * The completed AST for this query, with any missing primary keys added to\n   * orderBy and start.\n   */\n  readonly ast: AST;\n\n  readonly customQueryID: CustomQueryID | undefined;\n\n  /**\n   * Associates a name and arguments with this query for custom query tracking.\n   * This is used internally to track named queries on the server.\n   *\n   * @internal\n   */\n  nameAndArgs(\n    name: string,\n    args: ReadonlyArray<ReadonlyJSONValue>,\n  ): Query<TTable, TSchema, TReturn>;\n}\n\n/**\n * Helper function to cast a Query to QueryInternals.\n * This is used in tests and internal code to access query implementation details.\n * The function asserts that the query has the queryInternalsTag to ensure it\n * properly implements the QueryInternals interface.\n *\n * @internal\n */\nexport function asQueryInternals<\n  TTable extends keyof TSchema['tables'] & string,\n  TSchema extends ZeroSchema,\n  TReturn,\n>(\n  query: Query<TTable, TSchema, TReturn>,\n): QueryInternals<TTable, TSchema, TReturn> {\n  assert(\n    queryInternalsTag in query,\n    'Query does not implement QueryInternals. This likely means there are two copies of Zero in your runtime.',\n  );\n  return query as unknown as QueryInternals<TTable, TSchema, TReturn>;\n}\n\nexport function isQueryInternals<\n  TTable extends keyof TSchema['tables'] & string,\n  TSchema extends ZeroSchema,\n  TReturn,\n>(obj: unknown): obj is QueryInternals<TTable, TSchema, TReturn> {\n  return typeof obj === 'object' && obj !== null && queryInternalsTag in obj;\n}\n\nexport function asQuery<\n  TTable extends keyof TSchema['tables'] & string,\n  TSchema extends ZeroSchema,\n  TReturn,\n>(\n  queryInternals: QueryInternals<TTable, TSchema, TReturn>,\n): Query<TTable, TSchema, TReturn> {\n  assert(queryInternalsTag in queryInternals, 'Expected query internals tag');\n  return queryInternals as unknown as Query<TTable, TSchema, TReturn>;\n}\n\n// oxlint-disable-next-line no-explicit-any\nexport type AnyQueryInternals = QueryInternals<string, ZeroSchema, any>;\n"],"mappings":";;AAQA,IAAa,oBAAoB,QAAQ;;;;;;;;;AAuEzC,SAAgB,iBAKd,OAC0C;AAC1C,QACE,qBAAqB,OACrB,2GACD;AACD,QAAO"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rocicorp/zero",
-  "version": "1.4.0-canary.1",
+  "version": "1.4.0-canary.2",
   "description": "Zero is a web framework for serverless web development.",
   "homepage": "https://zero.rocicorp.dev",
   "bugs": {