@automate.ax/integration-contracts 0.130.3 → 0.130.5

package/dist/axiom/api.d.ts

@@ -9,6 +9,7 @@ export interface AxiomRequestOptions<TSchema extends z.ZodType> {
     body?: Encodable;
     headers?: Record<string, string>;
     method?: "DELETE" | "GET" | "PATCH" | "POST" | "PUT";
+    numericStringFields?: readonly string[];
     query?: Record<string, boolean | number | string | undefined>;
     responseSchema: TSchema;
     version?: "v1" | "v2";

package/dist/axiom/api.js

@@ -1,4 +1,5 @@
 import { encodableSchema } from "@automate.ax/codec";
+import { JSONParse, JSONStringify } from "json-with-bigint";
 import * as z from "zod";
 const AXIOM_API_ORIGIN = "https://api.axiom.co";
 const AXIOM_SECRET_SCHEMA = z.object({ apiKey: z.string().trim().min(1) });
@@ -68,7 +69,7 @@ export function getAxiomApi(account, edgeUrl = AXIOM_API_ORIGIN) {
         const response = await fetch(url, {
             body: options.body === undefined
                 ? undefined
-                : JSON.stringify(encodableSchema.parse(options.body)),
+                : serializeRequestBody(options.body, options.numericStringFields),
             headers: {
                 Accept: "application/json",
                 Authorization: `Bearer ${apiKey}`,
@@ -146,12 +147,60 @@ function parseResponse(text) {
     if (!text)
         return null;
     try {
-        return encodableSchema.parse(JSON.parse(text));
+        return encodableSchema.parse(normalizeBigInts(JSONParse(text)));
     }
     catch {
         return { response: text };
     }
 }
+/**
+ * Serializes selected decimal strings as lossless JSON integers.
+ *
+ * @param body - Encodable request body.
+ * @param numericStringFields - Field names to emit as JSON integers.
+ */
+function serializeRequestBody(body, numericStringFields) {
+    const parsed = encodableSchema.parse(body);
+    if (!numericStringFields?.length)
+        return JSON.stringify(parsed);
+    return JSONStringify(mapTopLevelNumericStringFields(parsed, new Set(numericStringFields)));
+}
+/**
+ * Converts selected top-level fields from decimal strings to bigint wire
+ * values.
+ *
+ * @param value - Encodable value to convert.
+ * @param numericStringFields - Field names to convert.
+ */
+function mapTopLevelNumericStringFields(value, numericStringFields) {
+    if (!isPlainObject(value))
+        return value;
+    return Object.fromEntries(Object.entries(value).map(([key, item]) => [
+        key,
+        numericStringFields.has(key) &&
+            typeof item === "string" &&
+            /^-?\d+$/.test(item)
+            ? BigInt(item)
+            : item,
+    ]));
+}
+/**
+ * Converts losslessly parsed bigint values to encodable decimal strings.
+ *
+ * @param value - Parsed JSON value.
+ */
+function normalizeBigInts(value) {
+    if (typeof value === "bigint")
+        return value.toString();
+    if (Array.isArray(value))
+        return value.map(normalizeBigInts);
+    if (typeof value !== "object" ||
+        value === null ||
+        Object.getPrototypeOf(value) !== Object.prototype) {
+        return value;
+    }
+    return Object.fromEntries(Object.entries(value).map(([key, item]) => [key, normalizeBigInts(item)]));
+}
 /**
  * Parses a finite numeric response header.
  *

package/dist/axiom/schemas.d.ts

@@ -286,7 +286,7 @@ export declare const AXIOM_MONITOR_SCHEMA: z.ZodObject<{
         Threshold: "Threshold";
     }>;
 }, z.core.$strip>;
-export declare const AXIOM_MONITOR_WITH_ID_SCHEMA: z.ZodIntersection<z.ZodObject<{
+export declare const AXIOM_MONITOR_WITH_ID_SCHEMA: z.ZodPreprocess<z.ZodIntersection<z.ZodObject<{
     alertOnNoData: z.ZodOptional<z.ZodBoolean>;
     aplQuery: z.ZodOptional<z.ZodString>;
     columnName: z.ZodOptional<z.ZodString>;
@@ -325,7 +325,7 @@ export declare const AXIOM_MONITOR_WITH_ID_SCHEMA: z.ZodIntersection<z.ZodObject
     createdBy: z.ZodOptional<z.ZodString>;
     id: z.ZodString;
     updatedAt: z.ZodOptional<z.ZodString>;
-}, z.core.$catchall<z.ZodOptional<z.ZodCustom<import("@automate.ax/codec").Encodable, import("@automate.ax/codec").Encodable>>>>>;
+}, z.core.$catchall<z.ZodOptional<z.ZodCustom<import("@automate.ax/codec").Encodable, import("@automate.ax/codec").Encodable>>>>>>;
 export declare const AXIOM_ALERT_HISTORY_SCHEMA: z.ZodObject<{
     checkId: z.ZodString;
     name: z.ZodString;
@@ -540,7 +540,7 @@ export declare const AXIOM_SAVED_QUERY_SCHEMA: z.ZodObject<{
     }, z.core.$strip>;
     who: z.ZodString;
 }, z.core.$strip>;
-export declare const AXIOM_SAVED_QUERY_WITH_ID_SCHEMA: z.ZodObject<{
+export declare const AXIOM_SAVED_QUERY_WITH_ID_SCHEMA: z.ZodPreprocess<z.ZodObject<{
     dataset: z.ZodOptional<z.ZodString>;
     kind: z.ZodLiteral<"apl">;
     metadata: z.ZodRecord<z.ZodString, z.ZodString>;
@@ -599,7 +599,7 @@ export declare const AXIOM_SAVED_QUERY_WITH_ID_SCHEMA: z.ZodObject<{
     }, z.core.$strip>;
     who: z.ZodString;
     id: z.ZodString;
-}, z.core.$strip>;
+}, z.core.$strip>>;
 export declare const AXIOM_DASHBOARD_CHART_SCHEMA: z.ZodDiscriminatedUnion<[z.ZodObject<{
     type: z.ZodLiteral<"TimeSeries">;
     query: z.ZodObject<{
@@ -765,6 +765,7 @@ export declare const AXIOM_DASHBOARD_CHART_SCHEMA: z.ZodDiscriminatedUnion<[z.Zo
         options: z.ZodOptional<z.ZodJSONSchema>;
         query: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodOptional<z.ZodCustom<import("@automate.ax/codec").Encodable, import("@automate.ax/codec").Encodable>>>>;
         selectType: z.ZodEnum<{
+            apl: "apl";
             query: "query";
             list: "list";
         }>;
@@ -785,6 +786,7 @@ export declare const AXIOM_DASHBOARD_CHART_SCHEMA: z.ZodDiscriminatedUnion<[z.Zo
     name: z.ZodOptional<z.ZodString>;
     sectionId: z.ZodOptional<z.ZodUUID>;
 }, z.core.$catchall<z.ZodOptional<z.ZodCustom<import("@automate.ax/codec").Encodable, import("@automate.ax/codec").Encodable>>>>], "type">;
+export declare const AXIOM_DASHBOARD_VERSION_SCHEMA: z.ZodString;
 export declare const AXIOM_DASHBOARD_DOCUMENT_SCHEMA: z.ZodObject<{
     against: z.ZodOptional<z.ZodEnum<{
         "": "";
@@ -968,6 +970,7 @@ export declare const AXIOM_DASHBOARD_DOCUMENT_SCHEMA: z.ZodObject<{
             options: z.ZodOptional<z.ZodJSONSchema>;
             query: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodOptional<z.ZodCustom<import("@automate.ax/codec").Encodable, import("@automate.ax/codec").Encodable>>>>;
             selectType: z.ZodEnum<{
+                apl: "apl";
                 query: "query";
                 list: "list";
             }>;
@@ -1200,6 +1203,7 @@ export declare const AXIOM_DASHBOARD_RESOURCE_SCHEMA: z.ZodObject<{
                 options: z.ZodOptional<z.ZodJSONSchema>;
                 query: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodOptional<z.ZodCustom<import("@automate.ax/codec").Encodable, import("@automate.ax/codec").Encodable>>>>;
                 selectType: z.ZodEnum<{
+                    apl: "apl";
                     query: "query";
                     list: "list";
                 }>;
@@ -1250,7 +1254,7 @@ export declare const AXIOM_DASHBOARD_RESOURCE_SCHEMA: z.ZodObject<{
     uid: z.ZodString;
     updatedAt: z.ZodString;
     updatedBy: z.ZodString;
-    version: z.ZodNumber;
+    version: z.ZodString;
 }, z.core.$catchall<z.ZodOptional<z.ZodCustom<import("@automate.ax/codec").Encodable, import("@automate.ax/codec").Encodable>>>>;
 export declare const AXIOM_DASHBOARD_WRITE_SCHEMA: z.ZodObject<{
     dashboard: z.ZodObject<{
@@ -1439,6 +1443,7 @@ export declare const AXIOM_DASHBOARD_WRITE_SCHEMA: z.ZodObject<{
                     options: z.ZodOptional<z.ZodJSONSchema>;
                     query: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodOptional<z.ZodCustom<import("@automate.ax/codec").Encodable, import("@automate.ax/codec").Encodable>>>>;
                     selectType: z.ZodEnum<{
+                        apl: "apl";
                         query: "query";
                         list: "list";
                     }>;
@@ -1489,7 +1494,7 @@ export declare const AXIOM_DASHBOARD_WRITE_SCHEMA: z.ZodObject<{
         uid: z.ZodString;
         updatedAt: z.ZodString;
         updatedBy: z.ZodString;
-        version: z.ZodNumber;
+        version: z.ZodString;
     }, z.core.$catchall<z.ZodOptional<z.ZodCustom<import("@automate.ax/codec").Encodable, import("@automate.ax/codec").Encodable>>>>;
     overwritten: z.ZodOptional<z.ZodBoolean>;
     status: z.ZodEnum<{

package/dist/axiom/schemas.js

@@ -246,14 +246,19 @@ export const AXIOM_MONITOR_SCHEMA = z
     .refine(({ aplQuery, mplQuery }) => Boolean(aplQuery) !== Boolean(mplQuery), {
     message: "Provide exactly one of aplQuery or mplQuery.",
 });
-export const AXIOM_MONITOR_WITH_ID_SCHEMA = AXIOM_MONITOR_SCHEMA.and(z
+export const AXIOM_MONITOR_WITH_ID_SCHEMA = z.preprocess((value) => typeof value === "object" &&
+    value !== null &&
+    "notifierIds" in value &&
+    value.notifierIds === null
+    ? { ...value, notifierIds: [] }
+    : value, AXIOM_MONITOR_SCHEMA.and(z
     .object({
     createdAt: z.string().optional(),
     createdBy: z.string().optional(),
     id: AXIOM_ID_SCHEMA,
     updatedAt: z.string().optional(),
 })
-    .catchall(encodableSchema));
+    .catchall(encodableSchema)));
 export const AXIOM_ALERT_HISTORY_SCHEMA = z.object({
     checkId: AXIOM_ID_SCHEMA,
     name: z.string(),
@@ -317,9 +322,27 @@ export const AXIOM_SAVED_QUERY_SCHEMA = z.object({
     query: AXIOM_APL_REQUEST_SCHEMA,
     who: z.string(),
 });
-export const AXIOM_SAVED_QUERY_WITH_ID_SCHEMA = AXIOM_SAVED_QUERY_SCHEMA.extend({
-    id: AXIOM_ID_SCHEMA,
-});
+export const AXIOM_SAVED_QUERY_WITH_ID_SCHEMA = z.preprocess((value) => {
+    if (typeof value !== "object" ||
+        value === null ||
+        !("query" in value) ||
+        typeof value.query !== "object" ||
+        value.query === null) {
+        return value;
+    }
+    return {
+        ...value,
+        query: {
+            ...value.query,
+            ...("defaultOrder" in value.query && value.query.defaultOrder === null
+                ? { defaultOrder: [] }
+                : {}),
+            ...("libraries" in value.query && value.query.libraries === null
+                ? { libraries: [] }
+                : {}),
+        },
+    };
+}, AXIOM_SAVED_QUERY_SCHEMA.extend({ id: AXIOM_ID_SCHEMA }));
 const AXIOM_CHART_QUERY_SCHEMA = z
     .object({
     apl: z.string().trim().min(1).optional(),
@@ -368,7 +391,7 @@ const AXIOM_SMART_FILTER_SCHEMA = z.discriminatedUnion("type", [
         ...AXIOM_SMART_FILTER_BASE_FIELDS,
         options: z.json().optional(),
         query: z.record(z.string(), encodableSchema).optional(),
-        selectType: z.enum(["list", "query"]),
+        selectType: z.enum(["apl", "list", "query"]),
         type: z.literal("select"),
     })
         .catchall(encodableSchema),
@@ -490,6 +513,15 @@ export const AXIOM_DASHBOARD_CHART_SCHEMA = z.discriminatedUnion("type", [
     })
         .catchall(encodableSchema),
 ]);
+const AXIOM_DASHBOARD_TIME_SCHEMA = z
+    .string()
+    .min(1)
+    .max(100)
+    .refine((value) => value === "qr-now" ||
+    /^qr-now-[1-9]\d*[a-z]+$/i.test(value) ||
+    /^\d+$/.test(value) ||
+    Number.isFinite(Date.parse(value)), { message: "Use qr-now, qr-now-{duration}, a timestamp, or a date." });
+export const AXIOM_DASHBOARD_VERSION_SCHEMA = z.string().regex(/^[1-9]\d*$/);
 export const AXIOM_DASHBOARD_DOCUMENT_SCHEMA = z.object({
     against: z
         .enum([
@@ -539,8 +571,8 @@ export const AXIOM_DASHBOARD_DOCUMENT_SCHEMA = z.object({
     })
         .array()
         .optional(),
-    timeWindowEnd: z.string().min(1).max(100),
-    timeWindowStart: z.string().min(1).max(100),
+    timeWindowEnd: AXIOM_DASHBOARD_TIME_SCHEMA,
+    timeWindowStart: AXIOM_DASHBOARD_TIME_SCHEMA,
     uid: AXIOM_ID_SCHEMA.optional(),
 });
 export const AXIOM_DASHBOARD_RESOURCE_SCHEMA = z
@@ -552,7 +584,7 @@ export const AXIOM_DASHBOARD_RESOURCE_SCHEMA = z
     uid: AXIOM_ID_SCHEMA,
     updatedAt: z.string(),
     updatedBy: z.string(),
-    version: z.number().int().positive(),
+    version: AXIOM_DASHBOARD_VERSION_SCHEMA,
 })
     .catchall(encodableSchema);
 export const AXIOM_DASHBOARD_WRITE_SCHEMA = z.object({

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@automate.ax/integration-contracts",
-  "version": "0.130.3",
+  "version": "0.130.5",
   "description": "Shared integration payload contracts and provider primitives for Automate.ax.",
   "license": "MIT",
   "repository": {
@@ -59,7 +59,7 @@
     }
   },
   "dependencies": {
-    "@automate.ax/codec": "0.130.3",
+    "@automate.ax/codec": "0.130.5",
     "@cfworker/json-schema": "^4.1.1",
     "@googleapis/calendar": "^15.0.0",
     "@googleapis/forms": "^6.0.1",
@@ -70,6 +70,7 @@
     "@octokit/rest": "^22.0.1",
     "convex": "^1.45.0",
     "html-to-text": "^10.0.0",
+    "json-with-bigint": "^3.5.10",
     "nodemailer": "^9.0.3",
     "postal-mime": "^2.7.5",
     "stripe": "^22.1.0",

package/src/axiom/api.ts

@@ -1,4 +1,5 @@
 import { encodableSchema, type Encodable } from "@automate.ax/codec"
+import { JSONParse, JSONStringify } from "json-with-bigint"
 import * as z from "zod"
 
 const AXIOM_API_ORIGIN = "https://api.axiom.co"
@@ -14,6 +15,7 @@ export interface AxiomRequestOptions<TSchema extends z.ZodType> {
   body?: Encodable
   headers?: Record<string, string>
   method?: "DELETE" | "GET" | "PATCH" | "POST" | "PUT"
+  numericStringFields?: readonly string[]
   query?: Record<string, boolean | number | string | undefined>
   responseSchema: TSchema
   version?: "v1" | "v2"
@@ -111,7 +113,7 @@ export function getAxiomApi(
       body:
         options.body === undefined
           ? undefined
-          : JSON.stringify(encodableSchema.parse(options.body)),
+          : serializeRequestBody(options.body, options.numericStringFields),
       headers: {
         Accept: "application/json",
         Authorization: `Bearer ${apiKey}`,
@@ -205,12 +207,73 @@ function confinedUrl(origin: string, version: "v1" | "v2", path: string) {
 function parseResponse(text: string): Encodable {
   if (!text) return null
   try {
-    return encodableSchema.parse(JSON.parse(text))
+    return encodableSchema.parse(normalizeBigInts(JSONParse(text) as unknown))
   } catch {
     return { response: text }
   }
 }
 
+/**
+ * Serializes selected decimal strings as lossless JSON integers.
+ *
+ * @param body - Encodable request body.
+ * @param numericStringFields - Field names to emit as JSON integers.
+ */
+function serializeRequestBody(
+  body: Encodable,
+  numericStringFields: readonly string[] | undefined,
+) {
+  const parsed = encodableSchema.parse(body)
+  if (!numericStringFields?.length) return JSON.stringify(parsed)
+  return JSONStringify(
+    mapTopLevelNumericStringFields(parsed, new Set(numericStringFields)),
+  )
+}
+
+/**
+ * Converts selected top-level fields from decimal strings to bigint wire
+ * values.
+ *
+ * @param value - Encodable value to convert.
+ * @param numericStringFields - Field names to convert.
+ */
+function mapTopLevelNumericStringFields(
+  value: Encodable,
+  numericStringFields: ReadonlySet<string>,
+): unknown {
+  if (!isPlainObject(value)) return value
+  return Object.fromEntries(
+    Object.entries(value).map(([key, item]) => [
+      key,
+      numericStringFields.has(key) &&
+      typeof item === "string" &&
+      /^-?\d+$/.test(item)
+        ? BigInt(item)
+        : item,
+    ]),
+  )
+}
+
+/**
+ * Converts losslessly parsed bigint values to encodable decimal strings.
+ *
+ * @param value - Parsed JSON value.
+ */
+function normalizeBigInts(value: unknown): unknown {
+  if (typeof value === "bigint") return value.toString()
+  if (Array.isArray(value)) return value.map(normalizeBigInts)
+  if (
+    typeof value !== "object" ||
+    value === null ||
+    Object.getPrototypeOf(value) !== Object.prototype
+  ) {
+    return value
+  }
+  return Object.fromEntries(
+    Object.entries(value).map(([key, item]) => [key, normalizeBigInts(item)]),
+  )
+}
+
 /**
  * Parses a finite numeric response header.
  *

package/src/axiom/schemas.ts

@@ -267,15 +267,24 @@ export const AXIOM_MONITOR_SCHEMA = z
   .refine(({ aplQuery, mplQuery }) => Boolean(aplQuery) !== Boolean(mplQuery), {
     message: "Provide exactly one of aplQuery or mplQuery.",
   })
-export const AXIOM_MONITOR_WITH_ID_SCHEMA = AXIOM_MONITOR_SCHEMA.and(
-  z
-    .object({
-      createdAt: z.string().optional(),
-      createdBy: z.string().optional(),
-      id: AXIOM_ID_SCHEMA,
-      updatedAt: z.string().optional(),
-    })
-    .catchall(encodableSchema),
+export const AXIOM_MONITOR_WITH_ID_SCHEMA = z.preprocess(
+  (value) =>
+    typeof value === "object" &&
+    value !== null &&
+    "notifierIds" in value &&
+    value.notifierIds === null
+      ? { ...value, notifierIds: [] }
+      : value,
+  AXIOM_MONITOR_SCHEMA.and(
+    z
+      .object({
+        createdAt: z.string().optional(),
+        createdBy: z.string().optional(),
+        id: AXIOM_ID_SCHEMA,
+        updatedAt: z.string().optional(),
+      })
+      .catchall(encodableSchema),
+  ),
 )
 
 export const AXIOM_ALERT_HISTORY_SCHEMA = z.object({
@@ -344,10 +353,31 @@ export const AXIOM_SAVED_QUERY_SCHEMA = z.object({
   query: AXIOM_APL_REQUEST_SCHEMA,
   who: z.string(),
 })
-export const AXIOM_SAVED_QUERY_WITH_ID_SCHEMA = AXIOM_SAVED_QUERY_SCHEMA.extend(
-  {
-    id: AXIOM_ID_SCHEMA,
+export const AXIOM_SAVED_QUERY_WITH_ID_SCHEMA = z.preprocess(
+  (value) => {
+    if (
+      typeof value !== "object" ||
+      value === null ||
+      !("query" in value) ||
+      typeof value.query !== "object" ||
+      value.query === null
+    ) {
+      return value
+    }
+    return {
+      ...value,
+      query: {
+        ...value.query,
+        ...("defaultOrder" in value.query && value.query.defaultOrder === null
+          ? { defaultOrder: [] }
+          : {}),
+        ...("libraries" in value.query && value.query.libraries === null
+          ? { libraries: [] }
+          : {}),
+      },
+    }
   },
+  AXIOM_SAVED_QUERY_SCHEMA.extend({ id: AXIOM_ID_SCHEMA }),
 )
 
 const AXIOM_CHART_QUERY_SCHEMA = z
@@ -398,7 +428,7 @@ const AXIOM_SMART_FILTER_SCHEMA = z.discriminatedUnion("type", [
       ...AXIOM_SMART_FILTER_BASE_FIELDS,
       options: z.json().optional(),
       query: z.record(z.string(), encodableSchema).optional(),
-      selectType: z.enum(["list", "query"]),
+      selectType: z.enum(["apl", "list", "query"]),
       type: z.literal("select"),
     })
     .catchall(encodableSchema),
@@ -521,6 +551,19 @@ export const AXIOM_DASHBOARD_CHART_SCHEMA = z.discriminatedUnion("type", [
     })
     .catchall(encodableSchema),
 ])
+const AXIOM_DASHBOARD_TIME_SCHEMA = z
+  .string()
+  .min(1)
+  .max(100)
+  .refine(
+    (value) =>
+      value === "qr-now" ||
+      /^qr-now-[1-9]\d*[a-z]+$/i.test(value) ||
+      /^\d+$/.test(value) ||
+      Number.isFinite(Date.parse(value)),
+    { message: "Use qr-now, qr-now-{duration}, a timestamp, or a date." },
+  )
+export const AXIOM_DASHBOARD_VERSION_SCHEMA = z.string().regex(/^[1-9]\d*$/)
 export const AXIOM_DASHBOARD_DOCUMENT_SCHEMA = z.object({
   against: z
     .enum([
@@ -570,8 +613,8 @@ export const AXIOM_DASHBOARD_DOCUMENT_SCHEMA = z.object({
     })
     .array()
     .optional(),
-  timeWindowEnd: z.string().min(1).max(100),
-  timeWindowStart: z.string().min(1).max(100),
+  timeWindowEnd: AXIOM_DASHBOARD_TIME_SCHEMA,
+  timeWindowStart: AXIOM_DASHBOARD_TIME_SCHEMA,
   uid: AXIOM_ID_SCHEMA.optional(),
 })
 
@@ -584,7 +627,7 @@ export const AXIOM_DASHBOARD_RESOURCE_SCHEMA = z
     uid: AXIOM_ID_SCHEMA,
     updatedAt: z.string(),
     updatedBy: z.string(),
-    version: z.number().int().positive(),
+    version: AXIOM_DASHBOARD_VERSION_SCHEMA,
   })
   .catchall(encodableSchema)
 export const AXIOM_DASHBOARD_WRITE_SCHEMA = z.object({