@veruna/api-contracts 17.9.0 → 17.10.0

package/build/v1/analytics/analytics.errors.d.ts

@@ -1,5 +1,6 @@
 import { ErrorMetadata } from '../../shared';
 export declare enum AnalyticsErrorCode {
-    MESSAGE_NOT_FOUND = "ANALYTICS_MESSAGE_NOT_FOUND"
+    MESSAGE_NOT_FOUND = "ANALYTICS_MESSAGE_NOT_FOUND",
+    INVALID_TIMEZONE = "ANALYTICS_INVALID_TIMEZONE"
 }
 export declare const ANALYTICS_ERRORS: Record<AnalyticsErrorCode, ErrorMetadata>;

package/build/v1/analytics/analytics.errors.js

@@ -4,11 +4,16 @@ exports.ANALYTICS_ERRORS = exports.AnalyticsErrorCode = void 0;
 var AnalyticsErrorCode;
 (function (AnalyticsErrorCode) {
     AnalyticsErrorCode["MESSAGE_NOT_FOUND"] = "ANALYTICS_MESSAGE_NOT_FOUND";
+    AnalyticsErrorCode["INVALID_TIMEZONE"] = "ANALYTICS_INVALID_TIMEZONE";
 })(AnalyticsErrorCode || (exports.AnalyticsErrorCode = AnalyticsErrorCode = {}));
 exports.ANALYTICS_ERRORS = {
     [AnalyticsErrorCode.MESSAGE_NOT_FOUND]: {
         code: AnalyticsErrorCode.MESSAGE_NOT_FOUND,
         statusCode: 404,
     },
+    [AnalyticsErrorCode.INVALID_TIMEZONE]: {
+        code: AnalyticsErrorCode.INVALID_TIMEZONE,
+        statusCode: 400,
+    },
 };
 //# sourceMappingURL=analytics.errors.js.map

package/build/v1/analytics/analytics.errors.js.map

@@ -1 +1 @@
-{"version":3,"file":"analytics.errors.js","sourceRoot":"","sources":["../../../v1/analytics/analytics.errors.ts"],"names":[],"mappings":";;;AAYA,IAAY,kBAEX;AAFD,WAAY,kBAAkB;IAC1B,uEAAiD,CAAA;AACrD,CAAC,EAFW,kBAAkB,kCAAlB,kBAAkB,QAE7B;AAEY,QAAA,gBAAgB,GAA8C;IACvE,CAAC,kBAAkB,CAAC,iBAAiB,CAAC,EAAE;QACpC,IAAI,EAAE,kBAAkB,CAAC,iBAAiB;QAC1C,UAAU,EAAE,GAAG;KAClB;CACK,CAAC"}
+{"version":3,"file":"analytics.errors.js","sourceRoot":"","sources":["../../../v1/analytics/analytics.errors.ts"],"names":[],"mappings":";;;AAYA,IAAY,kBAIX;AAJD,WAAY,kBAAkB;IAC1B,uEAAiD,CAAA;IAEjD,qEAA+C,CAAA;AACnD,CAAC,EAJW,kBAAkB,kCAAlB,kBAAkB,QAI7B;AAEY,QAAA,gBAAgB,GAA8C;IACvE,CAAC,kBAAkB,CAAC,iBAAiB,CAAC,EAAE;QACpC,IAAI,EAAE,kBAAkB,CAAC,iBAAiB;QAC1C,UAAU,EAAE,GAAG;KAClB;IACD,CAAC,kBAAkB,CAAC,gBAAgB,CAAC,EAAE;QACnC,IAAI,EAAE,kBAAkB,CAAC,gBAAgB;QACzC,UAAU,EAAE,GAAG;KAClB;CACK,CAAC"}

package/build/v1/analytics/queries/heatmap.query.d.ts

@@ -0,0 +1,21 @@
+import { z } from 'zod';
+import { HttpMethod } from '../../../shared/http-method.enum';
+export declare namespace AnalyticsHeatmapQuery {
+    const Request: z.ZodObject<{
+        days: z.ZodDefault<z.ZodCoercedNumber<unknown>>;
+        tz: z.ZodString;
+    }, z.core.$strip>;
+    const Response: z.ZodObject<{
+        tz: z.ZodString;
+        from: z.ZodISODate;
+        to: z.ZodISODate;
+        days: z.ZodArray<z.ZodObject<{
+            date: z.ZodISODate;
+            count: z.ZodNumber;
+        }, z.core.$strip>>;
+    }, z.core.$strip>;
+    const URL: "/api/v1/analytics/heatmap";
+    const METHOD = HttpMethod.GET;
+    type RequestType = z.infer<typeof Request>;
+    type ResponseType = z.infer<typeof Response>;
+}

package/build/v1/analytics/queries/heatmap.query.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AnalyticsHeatmapQuery = void 0;
+const schemas_1 = require("../schemas");
+const rest_api_1 = require("../../../rest-api");
+const http_method_enum_1 = require("../../../shared/http-method.enum");
+var AnalyticsHeatmapQuery;
+(function (AnalyticsHeatmapQuery) {
+    AnalyticsHeatmapQuery.Request = schemas_1.UsageHeatmapRequestSchema;
+    AnalyticsHeatmapQuery.Response = schemas_1.UsageHeatmapResponseSchema;
+    AnalyticsHeatmapQuery.URL = rest_api_1.REST_API.V1.ANALYTICS.REG.HEATMAP;
+    AnalyticsHeatmapQuery.METHOD = http_method_enum_1.HttpMethod.GET;
+})(AnalyticsHeatmapQuery || (exports.AnalyticsHeatmapQuery = AnalyticsHeatmapQuery = {}));
+//# sourceMappingURL=heatmap.query.js.map

package/build/v1/analytics/queries/heatmap.query.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"heatmap.query.js","sourceRoot":"","sources":["../../../../v1/analytics/queries/heatmap.query.ts"],"names":[],"mappings":";;;AACA,wCAGoB;AACpB,gDAA6C;AAC7C,uEAA8D;AAS9D,IAAiB,qBAAqB,CASrC;AATD,WAAiB,qBAAqB;IACrB,6BAAO,GAAG,mCAAyB,CAAC;IACpC,8BAAQ,GAAG,oCAA0B,CAAC;IAEtC,yBAAG,GAAG,mBAAQ,CAAC,EAAE,CAAC,SAAS,CAAC,GAAG,CAAC,OAAO,CAAC;IACxC,4BAAM,GAAG,6BAAU,CAAC,GAAG,CAAC;AAIzC,CAAC,EATgB,qBAAqB,qCAArB,qBAAqB,QASrC"}

package/build/v1/analytics/queries/index.d.ts

@@ -2,3 +2,4 @@ export * from './spend-chart.query';
 export * from './requests-chart.query';
 export * from './list-messages.query';
 export * from './message-details.query';
+export * from './heatmap.query';

package/build/v1/analytics/queries/index.js

@@ -18,4 +18,5 @@ __exportStar(require("./spend-chart.query"), exports);
 __exportStar(require("./requests-chart.query"), exports);
 __exportStar(require("./list-messages.query"), exports);
 __exportStar(require("./message-details.query"), exports);
+__exportStar(require("./heatmap.query"), exports);
 //# sourceMappingURL=index.js.map

package/build/v1/analytics/queries/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../v1/analytics/queries/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,sDAAoC;AACpC,yDAAuC;AACvC,wDAAsC;AACtC,0DAAwC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../v1/analytics/queries/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,sDAAoC;AACpC,yDAAuC;AACvC,wDAAsC;AACtC,0DAAwC;AACxC,kDAAgC"}

package/build/v1/analytics/schemas/heatmap.schema.d.ts

@@ -0,0 +1,27 @@
+import { z } from 'zod';
+export declare const USAGE_HEATMAP_DAYS: {
+    readonly MIN: 1;
+    readonly MAX: 400;
+    readonly DEFAULT: 371;
+};
+export declare const USAGE_TIMEZONE_PATTERN: RegExp;
+export declare const UsageHeatmapRequestSchema: z.ZodObject<{
+    days: z.ZodDefault<z.ZodCoercedNumber<unknown>>;
+    tz: z.ZodString;
+}, z.core.$strip>;
+export type UsageHeatmapRequest = z.infer<typeof UsageHeatmapRequestSchema>;
+export declare const UsageHeatmapDaySchema: z.ZodObject<{
+    date: z.ZodISODate;
+    count: z.ZodNumber;
+}, z.core.$strip>;
+export declare const UsageHeatmapResponseSchema: z.ZodObject<{
+    tz: z.ZodString;
+    from: z.ZodISODate;
+    to: z.ZodISODate;
+    days: z.ZodArray<z.ZodObject<{
+        date: z.ZodISODate;
+        count: z.ZodNumber;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+export type UsageHeatmapDay = z.infer<typeof UsageHeatmapDaySchema>;
+export type UsageHeatmapResponse = z.infer<typeof UsageHeatmapResponseSchema>;

package/build/v1/analytics/schemas/heatmap.schema.js

@@ -0,0 +1,34 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UsageHeatmapResponseSchema = exports.UsageHeatmapDaySchema = exports.UsageHeatmapRequestSchema = exports.USAGE_TIMEZONE_PATTERN = exports.USAGE_HEATMAP_DAYS = void 0;
+const zod_1 = require("zod");
+exports.USAGE_HEATMAP_DAYS = {
+    MIN: 1,
+    MAX: 400,
+    DEFAULT: 371,
+};
+exports.USAGE_TIMEZONE_PATTERN = /^[A-Za-z0-9_+\-]+(?:\/[A-Za-z0-9_+\-]+)*$/;
+exports.UsageHeatmapRequestSchema = zod_1.z.object({
+    days: zod_1.z.coerce
+        .number({ error: 'UsageHeatmapRequest.days.required' })
+        .int({ message: 'UsageHeatmapRequest.days.int' })
+        .min(exports.USAGE_HEATMAP_DAYS.MIN, { message: 'UsageHeatmapRequest.days.min' })
+        .max(exports.USAGE_HEATMAP_DAYS.MAX, { message: 'UsageHeatmapRequest.days.max' })
+        .default(exports.USAGE_HEATMAP_DAYS.DEFAULT),
+    tz: zod_1.z
+        .string({ error: 'UsageHeatmapRequest.tz.required' })
+        .min(1, { message: 'UsageHeatmapRequest.tz.required' })
+        .max(64, { message: 'UsageHeatmapRequest.tz.max' })
+        .regex(exports.USAGE_TIMEZONE_PATTERN, { message: 'UsageHeatmapRequest.tz.invalid' }),
+});
+exports.UsageHeatmapDaySchema = zod_1.z.object({
+    date: zod_1.z.iso.date(),
+    count: zod_1.z.number().int().positive(),
+});
+exports.UsageHeatmapResponseSchema = zod_1.z.object({
+    tz: zod_1.z.string().min(1),
+    from: zod_1.z.iso.date(),
+    to: zod_1.z.iso.date(),
+    days: zod_1.z.array(exports.UsageHeatmapDaySchema),
+});
+//# sourceMappingURL=heatmap.schema.js.map

package/build/v1/analytics/schemas/heatmap.schema.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"heatmap.schema.js","sourceRoot":"","sources":["../../../../v1/analytics/schemas/heatmap.schema.ts"],"names":[],"mappings":";;;AAAA,6BAAwB;AAOX,QAAA,kBAAkB,GAAG;IAC9B,GAAG,EAAE,CAAC;IACN,GAAG,EAAE,GAAG;IACR,OAAO,EAAE,GAAG;CACN,CAAC;AAOE,QAAA,sBAAsB,GAAG,2CAA2C,CAAC;AAErE,QAAA,yBAAyB,GAAG,OAAC,CAAC,MAAM,CAAC;IAC9C,IAAI,EAAE,OAAC,CAAC,MAAM;SACT,MAAM,CAAC,EAAE,KAAK,EAAE,mCAAmC,EAAE,CAAC;SACtD,GAAG,CAAC,EAAE,OAAO,EAAE,8BAA8B,EAAE,CAAC;SAChD,GAAG,CAAC,0BAAkB,CAAC,GAAG,EAAE,EAAE,OAAO,EAAE,8BAA8B,EAAE,CAAC;SACxE,GAAG,CAAC,0BAAkB,CAAC,GAAG,EAAE,EAAE,OAAO,EAAE,8BAA8B,EAAE,CAAC;SACxE,OAAO,CAAC,0BAAkB,CAAC,OAAO,CAAC;IACxC,EAAE,EAAE,OAAC;SACA,MAAM,CAAC,EAAE,KAAK,EAAE,iCAAiC,EAAE,CAAC;SACpD,GAAG,CAAC,CAAC,EAAE,EAAE,OAAO,EAAE,iCAAiC,EAAE,CAAC;SACtD,GAAG,CAAC,EAAE,EAAE,EAAE,OAAO,EAAE,4BAA4B,EAAE,CAAC;SAClD,KAAK,CAAC,8BAAsB,EAAE,EAAE,OAAO,EAAE,gCAAgC,EAAE,CAAC;CACpF,CAAC,CAAC;AASU,QAAA,qBAAqB,GAAG,OAAC,CAAC,MAAM,CAAC;IAC1C,IAAI,EAAE,OAAC,CAAC,GAAG,CAAC,IAAI,EAAE;IAClB,KAAK,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE;CACrC,CAAC,CAAC;AAUU,QAAA,0BAA0B,GAAG,OAAC,CAAC,MAAM,CAAC;IAC/C,EAAE,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;IACrB,IAAI,EAAE,OAAC,CAAC,GAAG,CAAC,IAAI,EAAE;IAClB,EAAE,EAAE,OAAC,CAAC,GAAG,CAAC,IAAI,EAAE;IAChB,IAAI,EAAE,OAAC,CAAC,KAAK,CAAC,6BAAqB,CAAC;CACvC,CAAC,CAAC"}

package/build/v1/analytics/schemas/index.d.ts

@@ -5,3 +5,4 @@ export * from './usage-chart-unit.enum';
 export * from './usage-finish-reason.enum';
 export * from './chart.schema';
 export * from './message.schema';
+export * from './heatmap.schema';

package/build/v1/analytics/schemas/index.js

@@ -21,4 +21,5 @@ __exportStar(require("./usage-chart-unit.enum"), exports);
 __exportStar(require("./usage-finish-reason.enum"), exports);
 __exportStar(require("./chart.schema"), exports);
 __exportStar(require("./message.schema"), exports);
+__exportStar(require("./heatmap.schema"), exports);
 //# sourceMappingURL=index.js.map

package/build/v1/analytics/schemas/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../v1/analytics/schemas/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,2DAAyC;AACzC,8DAA4C;AAC5C,2DAAyC;AACzC,0DAAwC;AACxC,6DAA2C;AAC3C,iDAA+B;AAC/B,mDAAiC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../v1/analytics/schemas/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,2DAAyC;AACzC,8DAA4C;AAC5C,2DAAyC;AACzC,0DAAwC;AACxC,6DAA2C;AAC3C,iDAA+B;AAC/B,mDAAiC;AACjC,mDAAiC"}