@voyant-travel/reporting-contracts 0.2.1 → 0.3.0

package/dist/contracts.d.ts

@@ -108,6 +108,7 @@ export declare const reportDatasetDefinitionSchema: z.ZodObject<{
     }, z.core.$strict>>;
     defaultLimit: z.ZodDefault<z.ZodNumber>;
     maximumLimit: z.ZodDefault<z.ZodNumber>;
+    defaultDateField: z.ZodOptional<z.ZodString>;
 }, z.core.$strict>;
 export type ReportDatasetDefinition = z.infer<typeof reportDatasetDefinitionSchema>;
 export type ReportDatasetField = z.infer<typeof reportDatasetFieldSchema>;
@@ -974,12 +975,6 @@ export declare const listReportDefinitionsQuerySchema: z.ZodObject<{
     limit: z.ZodDefault<z.ZodCoercedNumber<unknown>>;
     offset: z.ZodDefault<z.ZodCoercedNumber<unknown>>;
 }, z.core.$strip>;
-export declare const createReportVersionSchema: z.ZodObject<{
-    expectedRevision: z.ZodNumber;
-}, z.core.$strict>;
-export declare const executeReportVersionSchema: z.ZodObject<{
-    parameters: z.ZodDefault<z.ZodRecord<z.ZodString, z.ZodUnion<readonly [z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodBoolean, z.ZodNull]>, z.ZodArray<z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodBoolean, z.ZodNull]>>]>>>;
-}, z.core.$strict>;
 export declare const previewReportQuerySchema: z.ZodObject<{
     query: z.ZodObject<{
         dataset: z.ZodObject<{

package/dist/contracts.js

@@ -52,6 +52,11 @@ export const reportDatasetDefinitionSchema = z
     fields: z.array(reportDatasetFieldSchema).min(1).max(250),
     defaultLimit: z.number().int().positive().max(1_000).default(100),
     maximumLimit: z.number().int().positive().max(5_000).default(1_000),
+    // The date/datetime field a page-level date range filters on. When set, the
+    // reporting runtime injects `>= dateFrom` / `<= dateTo` on this field from the
+    // reserved `dateFrom`/`dateTo` report parameters — applying uniformly to every
+    // widget (preset and custom) without editing individual queries.
+    defaultDateField: reportingIdentifierSchema.optional(),
 })
     .strict()
     .superRefine((dataset, context) => {
@@ -272,12 +277,6 @@ export const listReportDefinitionsQuerySchema = z.object({
     limit: z.coerce.number().int().positive().max(100).default(25),
     offset: z.coerce.number().int().nonnegative().default(0),
 });
-export const createReportVersionSchema = z
-    .object({ expectedRevision: z.number().int().positive() })
-    .strict();
-export const executeReportVersionSchema = z
-    .object({ parameters: reportParametersSchema.default({}) })
-    .strict();
 export const previewReportQuerySchema = z
     .object({ query: reportQuerySchema, parameters: reportParametersSchema.default({}) })
     .strict();

package/dist/query-language.d.ts

@@ -3,6 +3,16 @@ import type { ReportQuery } from "./contracts.js";
 export declare class ReportQuerySyntaxError extends Error {
     constructor(message: string);
 }
+/**
+ * Error a dataset raises when a query is well-formed but not answerable against
+ * that dataset (e.g. summing amounts across currencies without grouping). The
+ * reporting API surfaces it as a 400 so authors see the reason instead of a 500.
+ * Dataset packages extend this so the reporting layer can recognise their
+ * domain errors without importing each dataset package.
+ */
+export declare class ReportDatasetQueryError extends Error {
+    constructor(message: string);
+}
 /**
  * Compile the intentionally small reporting language into the public query AST.
  * It is SQL-like for familiarity but has no joins, subqueries, statements, or

package/dist/query-language.js

@@ -18,6 +18,19 @@ export class ReportQuerySyntaxError extends Error {
         this.name = "ReportQuerySyntaxError";
     }
 }
+/**
+ * Error a dataset raises when a query is well-formed but not answerable against
+ * that dataset (e.g. summing amounts across currencies without grouping). The
+ * reporting API surfaces it as a 400 so authors see the reason instead of a 500.
+ * Dataset packages extend this so the reporting layer can recognise their
+ * domain errors without importing each dataset package.
+ */
+export class ReportDatasetQueryError extends Error {
+    constructor(message) {
+        super(message);
+        this.name = "ReportDatasetQueryError";
+    }
+}
 /**
  * Compile the intentionally small reporting language into the public query AST.
  * It is SQL-like for familiarity but has no joins, subqueries, statements, or
@@ -86,7 +99,7 @@ function parseFilter(source) {
             operator: nullFilter[2] ? "isNotNull" : "isNull",
         };
     }
-    const match = source.match(/^([a-z0-9][a-z0-9._/-]*)\s+(not\s+in|in|contains|>=|<=|!=|=|>|<)\s+(.+)$/i);
+    const match = source.match(/^([a-z0-9][a-z0-9._/-]*)\s+(not\s+in|in|between|contains|>=|<=|!=|=|>|<)\s+(.+)$/i);
     if (!match)
         throw syntax(`Unsupported filter ${JSON.stringify(source)}.`);
     const operator = {
@@ -98,6 +111,7 @@ function parseFilter(source) {
         "<=": "lessThanOrEqual",
         in: "in",
         "not in": "notIn",
+        between: "between",
         contains: "contains",
     };
     const operatorKey = required(match[2], "filter operator")
@@ -114,7 +128,9 @@ function parseValueReference(source) {
     if (value.startsWith("$")) {
         return { kind: "parameter", name: parseIdentifier(value.slice(1), "parameter") };
     }
-    if (value.startsWith("[") && value.endsWith("]")) {
+    // Lists accept both `[...]` and SQL-style `(...)` for `in`/`not in`/`between`.
+    if ((value.startsWith("[") && value.endsWith("]")) ||
+        (value.startsWith("(") && value.endsWith(")"))) {
         const inner = value.slice(1, -1).trim();
         const values = inner ? splitList(inner).map(parseLiteral) : [];
         return { kind: "literal", value: values };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@voyant-travel/reporting-contracts",
-  "version": "0.2.1",
+  "version": "0.3.0",
   "description": "Domain-neutral reporting datasets, widgets, templates, and query contracts for Voyant.",
   "license": "Apache-2.0",
   "type": "module",