@query-farm/vgi 0.8.0 → 0.10.0

package/dist/types.d.ts

@@ -45,6 +45,10 @@ export declare const VGI_VARARGS_TRUE = "true";
 export declare const VGI_CONST_KEY = "vgi_const";
 export declare const VGI_CONST_TRUE = "true";
 export declare const VGI_DOC_KEY = "vgi_doc";
+export declare const VGI_DEFAULT_KEY = "vgi_default";
+export declare const VGI_CHOICES_KEY = "vgi_choices";
+export declare const VGI_RANGE_KEY = "vgi_range";
+export declare const VGI_PATTERN_KEY = "vgi_pattern";
 export interface TableCardinality {
     estimate: number | null;
     max: number | null;

package/dist/worker-cf-entry.js

@@ -2850,6 +2850,10 @@ var VGI_VARARGS_TRUE = "true";
 var VGI_CONST_KEY = "vgi_const";
 var VGI_CONST_TRUE = "true";
 var VGI_DOC_KEY = "vgi_doc";
+var VGI_DEFAULT_KEY = "vgi_default";
+var VGI_CHOICES_KEY = "vgi_choices";
+var VGI_RANGE_KEY = "vgi_range";
+var VGI_PATTERN_KEY = "vgi_pattern";
 var DEFAULT_MAX_WORKERS = 99999;
 
 // src/util/arrow/index.ts
@@ -3823,6 +3827,13 @@ class CatalogReadOnlyError extends VgiError {
     this.name = "CatalogReadOnlyError";
   }
 }
+class ArgumentValidationError extends VgiError {
+  constructor(message) {
+    super(message);
+    this.name = "ArgumentValidationError";
+  }
+}
+
 class NoCatalogError extends VgiError {
   constructor() {
     super("No catalog is configured for this worker");
@@ -6985,6 +6996,187 @@ function buildVgiProtocol(config) {
 
 // src/functions/scalar.ts
 init_arrow();
+
+// src/arguments/argument-spec.ts
+init_arrow();
+function safeJson(value) {
+  try {
+    const encoded = JSON.stringify(value);
+    if (encoded === undefined) {
+      return JSON.stringify(String(value));
+    }
+    return encoded;
+  } catch {
+    return JSON.stringify(String(value));
+  }
+}
+function formatRange(ge, le, gt, lt) {
+  if (ge === undefined && le === undefined && gt === undefined && lt === undefined) {
+    return;
+  }
+  let low;
+  if (gt !== undefined) {
+    low = `(${gt}`;
+  } else if (ge !== undefined) {
+    low = `[${ge}`;
+  } else {
+    low = "(-inf";
+  }
+  let high;
+  if (lt !== undefined) {
+    high = `${lt})`;
+  } else if (le !== undefined) {
+    high = `${le}]`;
+  } else {
+    high = "+inf)";
+  }
+  return `${low}, ${high}`;
+}
+function constraintSpecFields(constraints) {
+  const fields = {};
+  if (constraints === undefined)
+    return fields;
+  if ("default" in constraints && constraints.default !== undefined) {
+    fields.defaultJson = safeJson(constraints.default);
+  }
+  if (constraints.choices !== undefined) {
+    fields.choicesJson = safeJson([...constraints.choices]);
+  }
+  const range = formatRange(constraints.ge, constraints.le, constraints.gt, constraints.lt);
+  if (range !== undefined) {
+    fields.rangeNotation = range;
+  }
+  if (constraints.pattern !== undefined) {
+    fields.pattern = constraints.pattern;
+  }
+  return fields;
+}
+function toNumber(value) {
+  if (typeof value === "number")
+    return value;
+  if (typeof value === "bigint")
+    return Number(value);
+  return;
+}
+function choiceEquals(choice, value) {
+  const cn = toNumber(choice);
+  const vn = toNumber(value);
+  if (cn !== undefined && vn !== undefined)
+    return cn === vn;
+  return choice === value;
+}
+function validateConstConstraints(name, constraints, value) {
+  if (value === null || value === undefined)
+    return;
+  const num = toNumber(value);
+  if (num !== undefined) {
+    if (constraints.ge !== undefined && num < constraints.ge) {
+      throw new ArgumentValidationError(`argument '${name}' must be >= ${constraints.ge}`);
+    }
+    if (constraints.le !== undefined && num > constraints.le) {
+      throw new ArgumentValidationError(`argument '${name}' must be <= ${constraints.le}`);
+    }
+    if (constraints.gt !== undefined && num <= constraints.gt) {
+      throw new ArgumentValidationError(`argument '${name}' must be > ${constraints.gt}`);
+    }
+    if (constraints.lt !== undefined && num >= constraints.lt) {
+      throw new ArgumentValidationError(`argument '${name}' must be < ${constraints.lt}`);
+    }
+  }
+  if (constraints.choices !== undefined && constraints.choices.length > 0) {
+    if (!constraints.choices.some((c) => choiceEquals(c, value))) {
+      throw new ArgumentValidationError(`argument '${name}' must be one of ${JSON.stringify([...constraints.choices])}`);
+    }
+  }
+  if (constraints.pattern !== undefined && typeof value === "string") {
+    let re;
+    try {
+      re = new RegExp(constraints.pattern);
+    } catch {
+      re = undefined;
+    }
+    if (re !== undefined && !re.test(value)) {
+      throw new ArgumentValidationError(`argument '${name}' must match pattern ${JSON.stringify(constraints.pattern)}`);
+    }
+  }
+}
+function argumentSpecSortKey(spec) {
+  if (typeof spec.position === "number") {
+    return [0, spec.position];
+  }
+  return [1, spec.position];
+}
+function argumentSpecsToSchema(specs) {
+  const sorted = [...specs].sort((a, b) => {
+    const ka = argumentSpecSortKey(a);
+    const kb = argumentSpecSortKey(b);
+    if (ka[0] !== kb[0])
+      return ka[0] - kb[0];
+    if (typeof ka[1] === "number" && typeof kb[1] === "number") {
+      return ka[1] - kb[1];
+    }
+    return String(ka[1]).localeCompare(String(kb[1]));
+  });
+  const fields = [];
+  for (const spec of sorted) {
+    const metadata = new Map;
+    if (typeof spec.position === "string") {
+      metadata.set(VGI_ARG_KEY, VGI_ARG_NAMED);
+    }
+    if (spec.isTableInput) {
+      metadata.set(VGI_TYPE_KEY, VGI_TYPE_TABLE);
+    } else if (spec.isAnyType) {
+      metadata.set(VGI_TYPE_KEY, VGI_TYPE_ANY);
+    }
+    if (spec.isVarargs) {
+      metadata.set(VGI_VARARGS_KEY, VGI_VARARGS_TRUE);
+    }
+    if (spec.isConst) {
+      metadata.set(VGI_CONST_KEY, VGI_CONST_TRUE);
+    }
+    if (spec.doc) {
+      metadata.set(VGI_DOC_KEY, spec.doc);
+    }
+    if (spec.defaultJson !== undefined) {
+      metadata.set(VGI_DEFAULT_KEY, spec.defaultJson);
+    }
+    if (spec.choicesJson !== undefined) {
+      metadata.set(VGI_CHOICES_KEY, spec.choicesJson);
+    }
+    if (spec.rangeNotation !== undefined) {
+      metadata.set(VGI_RANGE_KEY, spec.rangeNotation);
+    }
+    if (spec.pattern !== undefined) {
+      metadata.set(VGI_PATTERN_KEY, spec.pattern);
+    }
+    const field3 = field2(spec.name, spec.arrowType, true, metadata.size > 0 ? metadata : undefined);
+    fields.push(field3);
+  }
+  return schema2(fields);
+}
+function macroArgumentsSchema(parameters, parameterDefaultValues, parameterDocs) {
+  const docs = parameterDocs ?? {};
+  const defaultTypes = new Map;
+  if (parameterDefaultValues && parameterDefaultValues.length > 0) {
+    const batch = deserializeBatch(parameterDefaultValues);
+    for (const f of batch.schema.fields) {
+      defaultTypes.set(f.name, f.type);
+    }
+  }
+  const fields = [];
+  for (const name of parameters) {
+    const metadata = new Map;
+    const doc = docs[name];
+    if (doc) {
+      metadata.set(VGI_DOC_KEY, doc);
+    }
+    const fieldType = defaultTypes.get(name) ?? nullType2();
+    fields.push(field2(name, fieldType, true, metadata.size > 0 ? metadata : undefined));
+  }
+  return schema2(fields);
+}
+
+// src/functions/scalar.ts
 function defineScalarFunction(config) {
   const repr = config.repr ?? "rich";
   const specs = [];
@@ -6998,7 +7190,8 @@ function defineScalarFunction(config) {
         isAnyType: isAny,
         isConst: p.const,
         isVarargs: p.varargs,
-        doc: p.doc
+        doc: p.doc,
+        ...constraintSpecFields(p)
       });
     }
   } else {
@@ -7027,6 +7220,14 @@ function defineScalarFunction(config) {
       }
     }
   }
+  const constConstraints = new Map;
+  if (config.parameters) {
+    for (const p of config.parameters) {
+      if (p.const && (p.choices !== undefined || p.ge !== undefined || p.le !== undefined || p.gt !== undefined || p.lt !== undefined || p.pattern !== undefined)) {
+        constConstraints.set(p.name, p);
+      }
+    }
+  }
   const meta = {
     name: config.name,
     description: config.description,
@@ -7053,7 +7254,11 @@ function defineScalarFunction(config) {
         let constIdx = 0;
         for (const spec of specs) {
           if (spec.isConst) {
-            constArgs[spec.name] = request.arguments.get(constIdx, undefined);
+            const value = request.arguments.get(constIdx, undefined);
+            constArgs[spec.name] = value;
+            const constraints = constConstraints.get(spec.name);
+            if (constraints)
+              validateConstConstraints(spec.name, constraints, value);
             constIdx++;
           }
         }
@@ -7567,72 +7772,6 @@ function defineTableInOutFunction(config) {
 // src/catalog/read-only.ts
 init_arrow();
 
-// src/arguments/argument-spec.ts
-init_arrow();
-function argumentSpecSortKey(spec) {
-  if (typeof spec.position === "number") {
-    return [0, spec.position];
-  }
-  return [1, spec.position];
-}
-function argumentSpecsToSchema(specs) {
-  const sorted = [...specs].sort((a, b) => {
-    const ka = argumentSpecSortKey(a);
-    const kb = argumentSpecSortKey(b);
-    if (ka[0] !== kb[0])
-      return ka[0] - kb[0];
-    if (typeof ka[1] === "number" && typeof kb[1] === "number") {
-      return ka[1] - kb[1];
-    }
-    return String(ka[1]).localeCompare(String(kb[1]));
-  });
-  const fields = [];
-  for (const spec of sorted) {
-    const metadata = new Map;
-    if (typeof spec.position === "string") {
-      metadata.set(VGI_ARG_KEY, VGI_ARG_NAMED);
-    }
-    if (spec.isTableInput) {
-      metadata.set(VGI_TYPE_KEY, VGI_TYPE_TABLE);
-    } else if (spec.isAnyType) {
-      metadata.set(VGI_TYPE_KEY, VGI_TYPE_ANY);
-    }
-    if (spec.isVarargs) {
-      metadata.set(VGI_VARARGS_KEY, VGI_VARARGS_TRUE);
-    }
-    if (spec.isConst) {
-      metadata.set(VGI_CONST_KEY, VGI_CONST_TRUE);
-    }
-    if (spec.doc) {
-      metadata.set(VGI_DOC_KEY, spec.doc);
-    }
-    const field3 = field2(spec.name, spec.arrowType, true, metadata.size > 0 ? metadata : undefined);
-    fields.push(field3);
-  }
-  return schema2(fields);
-}
-function macroArgumentsSchema(parameters, parameterDefaultValues, parameterDocs) {
-  const docs = parameterDocs ?? {};
-  const defaultTypes = new Map;
-  if (parameterDefaultValues && parameterDefaultValues.length > 0) {
-    const batch = deserializeBatch(parameterDefaultValues);
-    for (const f of batch.schema.fields) {
-      defaultTypes.set(f.name, f.type);
-    }
-  }
-  const fields = [];
-  for (const name of parameters) {
-    const metadata = new Map;
-    const doc = docs[name];
-    if (doc) {
-      metadata.set(VGI_DOC_KEY, doc);
-    }
-    const fieldType = defaultTypes.get(name) ?? nullType2();
-    fields.push(field2(name, fieldType, true, metadata.size > 0 ? metadata : undefined));
-  }
-  return schema2(fields);
-}
-
 // src/metadata/resolve.ts
 init_arrow();
 function arrowTypeToName(type) {
@@ -8792,4 +8931,4 @@ export {
   Arguments
 };
 
-//# debugId=0568832FD569353D64756E2164756E21
+//# debugId=1755038A7EDE8C3064756E2164756E21