@query-graph/core 1.1.5 → 1.1.7

package/dsl.d.ts

@@ -27,6 +27,9 @@ export type {
   LikeExpression,
   InExpression,
   InParameterExpression,
+  GroupKeyExpression,
+  InGroupValuesExpression,
+  AllGroupsExpression,
   ExpressionGroup,
   UnaryExpression,
   ExistsExpression,
@@ -94,6 +97,10 @@ export type {
   SourceRef,
   ScalarParameterRef,
   ListParameterRef,
+  GroupedListParameterRef,
+  GroupedListParameterTypes,
+  GroupValuesRef,
+  GroupScope,
   ParameterRef,
   RelationRef,
   LiteralInput,
@@ -120,9 +127,18 @@ export {
   hidden,
   source,
   requiredParameter,
+  requiredParam,
   optionalParameter,
+  optionalParam,
   requiredListParameter,
+  requiredListParam,
   optionalListParameter,
+  optionalListParam,
+  requiredGroupsParameter,
+  requiredGroupsParam,
+  optionalGroupsParameter,
+  optionalGroupsParam,
+  allGroups,
   param,
   literal,
   integer,
@@ -137,6 +153,7 @@ export {
   inList,
   and,
   inParameter,
+  inParam,
   or,
   not,
   isNull,
@@ -146,6 +163,9 @@ export {
   upper,
   coalesce,
   concat,
+  divide,
+  truncate,
+  modulo,
   count,
   countDistinct,
   sum,

package/dsl.js

@@ -9,13 +9,22 @@ exports.nullable = primitives.nullable
 exports.hidden = primitives.hidden
 exports.source = primitives.source
 exports.requiredParameter = primitives.requiredParameter
+exports.requiredParam = primitives.requiredParam
 exports.optionalParameter = primitives.optionalParameter
+exports.optionalParam = primitives.optionalParam
 exports.param = primitives.param
 exports.literal = primitives.literal
 exports.integer = primitives.integer
 exports.decimal = primitives.decimal
 exports.requiredListParameter = primitives.requiredListParameter
+exports.requiredListParam = primitives.requiredListParam
 exports.optionalListParameter = primitives.optionalListParameter
+exports.optionalListParam = primitives.optionalListParam
+exports.requiredGroupsParameter = primitives.requiredGroupsParameter
+exports.requiredGroupsParam = primitives.requiredGroupsParam
+exports.optionalGroupsParameter = primitives.optionalGroupsParameter
+exports.optionalGroupsParam = primitives.optionalGroupsParam
+exports.allGroups = primitives.allGroups
 exports.eq = primitives.eq
 exports.neq = primitives.neq
 exports.lt = primitives.lt
@@ -30,11 +39,15 @@ exports.not = primitives.not
 exports.isNull = primitives.isNull
 exports.isNotNull = primitives.isNotNull
 exports.inParameter = primitives.inParameter
+exports.inParam = primitives.inParam
 exports.exists = primitives.exists
 exports.lower = primitives.lower
 exports.upper = primitives.upper
 exports.coalesce = primitives.coalesce
 exports.concat = primitives.concat
+exports.divide = primitives.divide
+exports.truncate = primitives.truncate
+exports.modulo = primitives.modulo
 exports.count = primitives.count
 exports.countDistinct = primitives.countDistinct
 exports.sum = primitives.sum

package/lib/authoring/definition.js

@@ -11,7 +11,7 @@ const {
 const { asExpression, copySource, referenceName } = require('./primitives.js')
 const { GRAPH_MODULE_BRAND, SUMMARY_FIELD_BRAND } = require('./symbols.js')
 
-const GRAPH_DEFINITION_VERSION = 10
+const GRAPH_DEFINITION_VERSION = 12
 const RELATION_CONFIGURATION_KEYS = new Set(['name', 'from', 'to', 'on', 'required', 'cardinality', 'selection'])
 const CONSTRAINT_CONFIGURATION_KEYS = new Set(['predicate', 'when'])
 const PROJECTION_CONFIGURATION_KEYS = new Set(['path', 'expression', 'default'])

package/lib/authoring/primitives.js

@@ -1,7 +1,8 @@
 'use strict'
 
+const { randomUUID } = require('node:crypto')
 const { arrayOf, configurationOf, nonEmptyString, objectOf, optionalBoolean } = require('../configuration.js')
-const { SUMMARY_FIELD_BRAND } = require('./symbols.js')
+const { GROUP_VALUES_REF_BRAND, PARAMETER_REF_BRAND, SUMMARY_FIELD_BRAND } = require('./symbols.js')
 
 const SCALAR_TYPES = new Set([
   'boolean',
@@ -18,6 +19,7 @@ const SCALAR_TYPES = new Set([
 const FIELD_TYPE_OPTIONS_KEYS = new Set(['nullable', 'selectable'])
 const FIELD_SPECIFICATION_KEYS = new Set(['scalarType', 'nullable', 'selectable'])
 const EXISTS_CONFIGURATION_KEYS = new Set(['from'])
+const GROUPED_LIST_CONFIGURATION_KEYS = new Set(['key', 'value'])
 
 function fieldType(scalarType, options = {}) {
   assertScalarType(scalarType)
@@ -100,10 +102,32 @@ function optionalListParameter(name, scalarType) {
   return parameterDefinition(name, scalarType, false, 'list')
 }
 
+function requiredGroupsParameter(name, types) {
+  return groupedListParameterDefinition(name, types, true)
+}
+
+function optionalGroupsParameter(name, types) {
+  return groupedListParameterDefinition(name, types, false)
+}
+
+function groupedListParameterDefinition(name, types, required) {
+  const configuration = configurationOf('grouped list parameter', types, GROUPED_LIST_CONFIGURATION_KEYS)
+  assertScalarType(configuration.key)
+  const definition = parameterDefinition(name, configuration.value, required, 'groupedList')
+  definition.keyType = configuration.key
+  return definition
+}
+
 function param(parameterReference) {
   if (typeof parameterReference !== 'string' && parameterReference?.shape === 'list') {
     throw new TypeError(`List parameter ${parameterReference.name} cannot be used as a scalar expression`)
   }
+  if (parameterReference?.shape === 'groupedList') {
+    throw new TypeError(`Grouped list parameter ${parameterReference.name} cannot be used as a scalar expression`)
+  }
+  if (parameterReference?.[GROUP_VALUES_REF_BRAND] === true) {
+    throw new TypeError('Group values cannot be used as a scalar expression')
+  }
 
   return {
     kind: 'parameter',
@@ -184,6 +208,13 @@ function inList(expression, values) {
 }
 
 function inParameter(expression, parameterReference) {
+  if (parameterReference?.[GROUP_VALUES_REF_BRAND] === true) {
+    return {
+      kind: 'inGroupValues',
+      expression: asExpression(expression),
+      scope: parameterReference.scope,
+    }
+  }
   if (typeof parameterReference !== 'string' && parameterReference?.shape !== 'list') {
     throw new TypeError(`Parameter ${parameterReference?.name ?? '<unknown>'} is not a list parameter`)
   }
@@ -195,6 +226,31 @@ function inParameter(expression, parameterReference) {
   }
 }
 
+function allGroups(parameterReference, predicate) {
+  if (parameterReference?.[PARAMETER_REF_BRAND] !== true || parameterReference.shape !== 'groupedList') {
+    throw new TypeError('allGroups requires a grouped list parameter')
+  }
+  const parameter = referenceName(parameterReference, 'parameter')
+  assertScalarType(parameterReference.keyType)
+  assertScalarType(parameterReference.scalarType)
+  if (typeof predicate !== 'function') {
+    throw new TypeError('allGroups predicate must be a function')
+  }
+
+  const scope = randomUUID()
+  const key = Object.freeze({ kind: 'groupKey', scope })
+  const values = { scope }
+  Object.defineProperty(values, GROUP_VALUES_REF_BRAND, { value: true })
+  Object.freeze(values)
+
+  return {
+    kind: 'allGroups',
+    parameter,
+    scope,
+    predicate: asExpression(predicate({ key, values })),
+  }
+}
+
 function and(...expressions) {
   return {
     kind: 'and',
@@ -266,6 +322,18 @@ function concat(first, ...rest) {
   return call('concat', first, ...rest)
 }
 
+function divide(left, right) {
+  return call('divide', left, right)
+}
+
+function truncate(expression) {
+  return call('truncate', expression)
+}
+
+function modulo(left, right) {
+  return call('modulo', left, right)
+}
+
 function aggregate(functionName, expression) {
   const definition = {
     kind: 'aggregate',
@@ -322,9 +390,10 @@ function parameterDefinition(name, scalarType, required, shape = 'scalar') {
   if (required) {
     definition.required = true
   }
-  if (shape === 'list') {
-    definition.shape = 'list'
+  if (shape !== 'scalar') {
+    definition.shape = shape
   }
+  Object.defineProperty(definition, PARAMETER_REF_BRAND, { value: true })
   return definition
 }
 
@@ -351,9 +420,15 @@ function unaryExpression(kind, expression) {
 }
 
 function asExpression(value) {
+  if (value?.[GROUP_VALUES_REF_BRAND] === true) {
+    throw new TypeError('Group values cannot be used as a scalar expression')
+  }
   if (value?.[SUMMARY_FIELD_BRAND] === true) {
     return value.expression
   }
+  if (value?.[PARAMETER_REF_BRAND] === true) {
+    return param(value)
+  }
   if (value && typeof value === 'object' && typeof value.kind === 'string') {
     return value
   }
@@ -390,6 +465,7 @@ function assertScalarType(scalarType) {
 }
 
 module.exports = {
+  allGroups,
   and,
   asExpression,
   average,
@@ -399,6 +475,7 @@ module.exports = {
   count,
   countDistinct,
   decimal,
+  divide,
   eq,
   exists,
   fieldType,
@@ -406,6 +483,7 @@ module.exports = {
   gte,
   hidden,
   inList,
+  inParam: inParameter,
   inParameter,
   integer,
   isNotNull,
@@ -417,17 +495,27 @@ module.exports = {
   lte,
   maximum,
   minimum,
+  modulo,
   neq,
   not,
   nullable,
+  optionalGroupsParam: optionalGroupsParameter,
+  optionalGroupsParameter,
+  optionalListParam: optionalListParameter,
   optionalListParameter,
+  optionalParam: optionalParameter,
   optionalParameter,
   or,
   param,
   referenceName,
+  requiredGroupsParam: requiredGroupsParameter,
+  requiredGroupsParameter,
+  requiredListParam: requiredListParameter,
   requiredListParameter,
+  requiredParam: requiredParameter,
   requiredParameter,
   source,
   sum,
+  truncate,
   upper,
 }

package/lib/authoring/symbols.js

@@ -1,4 +1,6 @@
 'use strict'
 
 exports.GRAPH_MODULE_BRAND = Symbol('GraphModule')
+exports.GROUP_VALUES_REF_BRAND = Symbol('GroupValuesRef')
+exports.PARAMETER_REF_BRAND = Symbol('ParameterRef')
 exports.SUMMARY_FIELD_BRAND = Symbol('SummaryField')

package/native.d.ts

@@ -95,4 +95,5 @@ export interface SqlBinding {
   parameter: string
   scalarType: import('./dsl.js').ScalarType
   index?: number
+  path?: Array<number | string>
 }