@apollo-deploy/schemas 0.4.4

package/dist/definitions/analytics/response.schema.d.ts

@@ -0,0 +1,190 @@
+/**
+ * Analytics Domain - Response Schemas
+ *
+ * Zod schemas for analytics API response formatting.
+ * Includes metric registry and analytics platform API responses.
+ *
+ * Requirements: 6.5-6.7, 13.1-13.8, 23.1-23.2, 24.2
+ */
+import { z } from 'zod';
+/**
+ * Overview response schema
+ *
+ * Response schema for the /api/v1/analytics/overview endpoint.
+ *
+ * Requirements: 6.5
+ */
+export declare const OverviewResponseSchema: z.ZodObject<{
+    platform: z.ZodEnum<{
+        google: "google";
+        apple: "apple";
+        microsoft: "microsoft";
+    }>;
+    appId: z.ZodString;
+    timeRange: z.ZodObject<{
+        from: z.ZodString;
+        to: z.ZodString;
+    }, z.core.$strip>;
+    metrics: z.ZodRecord<z.ZodString, z.ZodObject<{
+        current: z.ZodNumber;
+        currentRaw: z.ZodString;
+        previous: z.ZodOptional<z.ZodNumber>;
+        change: z.ZodOptional<z.ZodNumber>;
+        changePercent: z.ZodOptional<z.ZodNumber>;
+        trend: z.ZodOptional<z.ZodEnum<{
+            up: "up";
+            down: "down";
+            stable: "stable";
+        }>>;
+        unit: z.ZodString;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+/**
+ * Metric detail response schema
+ *
+ * Response schema for the /api/v1/analytics/metrics/:metricKey endpoint.
+ *
+ * Requirements: 6.7
+ */
+export declare const MetricDetailResponseSchema: z.ZodObject<{
+    metricKey: z.ZodString;
+    displayName: z.ZodString;
+    unit: z.ZodString;
+    rollupStrategy: z.ZodEnum<{
+        sum: "sum";
+        latest: "latest";
+        hll: "hll";
+        complex: "complex";
+    }>;
+    dataPoints: z.ZodArray<z.ZodObject<{
+        timestamp: z.ZodString;
+        value: z.ZodNumber;
+        valueRaw: z.ZodString;
+    }, z.core.$strip>>;
+    granularity: z.ZodEnum<{
+        "1m": "1m";
+        "1h": "1h";
+        "1d": "1d";
+    }>;
+    isDeprecated: z.ZodBoolean;
+}, z.core.$strip>;
+/**
+ * Metric definition response schema
+ *
+ * Response schema for a single metric definition.
+ */
+export declare const MetricDefinitionResponseSchema: z.ZodObject<{
+    metricKey: z.ZodString;
+    displayName: z.ZodString;
+    description: z.ZodNullable<z.ZodString>;
+    unitLabel: z.ZodEnum<{
+        ms: "ms";
+        bytes: "bytes";
+        count: "count";
+        percent: "percent";
+        basis_points: "basis_points";
+    }>;
+    rollupStrategy: z.ZodEnum<{
+        sum: "sum";
+        latest: "latest";
+        hll: "hll";
+        complex: "complex";
+    }>;
+    derivedNumeratorKey: z.ZodNullable<z.ZodString>;
+    derivedDenominatorKey: z.ZodNullable<z.ZodString>;
+    validationMin: z.ZodNumber;
+    validationMax: z.ZodNumber;
+    isDeprecated: z.ZodBoolean;
+    deprecatedAt: z.ZodNullable<z.ZodString>;
+    createdAt: z.ZodString;
+    updatedAt: z.ZodString;
+}, z.core.$strip>;
+/**
+ * Metric registry response schema
+ *
+ * Response schema for the registry endpoint.
+ */
+export declare const MetricRegistryResponseSchema: z.ZodObject<{
+    metrics: z.ZodArray<z.ZodObject<{
+        metricKey: z.ZodString;
+        displayName: z.ZodString;
+        description: z.ZodNullable<z.ZodString>;
+        unitLabel: z.ZodEnum<{
+            ms: "ms";
+            bytes: "bytes";
+            count: "count";
+            percent: "percent";
+            basis_points: "basis_points";
+        }>;
+        rollupStrategy: z.ZodEnum<{
+            sum: "sum";
+            latest: "latest";
+            hll: "hll";
+            complex: "complex";
+        }>;
+        derivedNumeratorKey: z.ZodNullable<z.ZodString>;
+        derivedDenominatorKey: z.ZodNullable<z.ZodString>;
+        validationMin: z.ZodNumber;
+        validationMax: z.ZodNumber;
+        isDeprecated: z.ZodBoolean;
+        deprecatedAt: z.ZodNullable<z.ZodString>;
+        createdAt: z.ZodString;
+        updatedAt: z.ZodString;
+    }, z.core.$strip>>;
+    total: z.ZodNumber;
+}, z.core.$strip>;
+/**
+ * Analytics error response schema
+ *
+ * Error response format for analytics API.
+ *
+ * Requirements: 23.1, 23.2
+ */
+export declare const AnalyticsErrorResponseSchema: z.ZodObject<{
+    error: z.ZodObject<{
+        code: z.ZodString;
+        message: z.ZodString;
+        details: z.ZodOptional<z.ZodObject<{
+            field: z.ZodOptional<z.ZodString>;
+            expected: z.ZodOptional<z.ZodString>;
+            actual: z.ZodOptional<z.ZodString>;
+            suggestion: z.ZodOptional<z.ZodString>;
+        }, z.core.$strip>>;
+    }, z.core.$strip>;
+    requestId: z.ZodString;
+    timestamp: z.ZodString;
+}, z.core.$strip>;
+/**
+ * Rate limit headers schema
+ *
+ * Rate limit information returned in response headers.
+ *
+ * Requirements: 24.2
+ */
+export declare const RateLimitHeadersSchema: z.ZodObject<{
+    limit: z.ZodNumber;
+    remaining: z.ZodNumber;
+    resetAt: z.ZodNumber;
+}, z.core.$strip>;
+/**
+ * Trigger analytics job response schema
+ *
+ * Response for the admin job trigger endpoint.
+ */
+export declare const TriggerAnalyticsJobResponseSchema: z.ZodObject<{
+    jobType: z.ZodString;
+    triggered: z.ZodBoolean;
+    message: z.ZodString;
+    jobs: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        jobType: z.ZodString;
+        triggered: z.ZodBoolean;
+    }, z.core.$strip>>>;
+}, z.core.$strip>;
+export type OverviewResponse = z.infer<typeof OverviewResponseSchema>;
+export type MetricDetailResponse = z.infer<typeof MetricDetailResponseSchema>;
+export type MetricDefinitionResponse = z.infer<typeof MetricDefinitionResponseSchema>;
+export type MetricRegistryResponse = z.infer<typeof MetricRegistryResponseSchema>;
+export type AnalyticsErrorResponse = z.infer<typeof AnalyticsErrorResponseSchema>;
+export type RateLimitHeaders = z.infer<typeof RateLimitHeadersSchema>;
+export type TriggerAnalyticsJobResponse = z.infer<typeof TriggerAnalyticsJobResponseSchema>;
+//# sourceMappingURL=response.schema.d.ts.map

package/dist/definitions/analytics/response.schema.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"response.schema.d.ts","sourceRoot":"","sources":["../../../src/definitions/analytics/response.schema.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAcxB;;;;;;GAMG;AACH,eAAO,MAAM,sBAAsB;;;;;;;;;;;;;;;;;;;;;;;;iBAejC,CAAC;AAEH;;;;;;GAMG;AACH,eAAO,MAAM,0BAA0B;;;;;;;;;;;;;;;;;;;;;iBAqBrC,CAAC;AAMH;;;;GAIG;AACH,eAAO,MAAM,8BAA8B;;;;;;;;;;;;;;;;;;;;;;;;;iBAczC,CAAC;AAEH;;;;GAIG;AACH,eAAO,MAAM,4BAA4B;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAGvC,CAAC;AAMH;;;;;;GAMG;AACH,eAAO,MAAM,4BAA4B;;;;;;;;;;;;;iBAwBvC,CAAC;AAEH;;;;;;GAMG;AACH,eAAO,MAAM,sBAAsB;;;;iBASjC,CAAC;AAMH;;;;GAIG;AACH,eAAO,MAAM,iCAAiC;;;;;;;;iBAmB5C,CAAC;AAGH,MAAM,MAAM,gBAAgB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,sBAAsB,CAAC,CAAC;AACtE,MAAM,MAAM,oBAAoB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,0BAA0B,CAAC,CAAC;AAC9E,MAAM,MAAM,wBAAwB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,8BAA8B,CAAC,CAAC;AACtF,MAAM,MAAM,sBAAsB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,4BAA4B,CAAC,CAAC;AAClF,MAAM,MAAM,sBAAsB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,4BAA4B,CAAC,CAAC;AAClF,MAAM,MAAM,gBAAgB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,sBAAsB,CAAC,CAAC;AACtE,MAAM,MAAM,2BAA2B,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,iCAAiC,CAAC,CAAC"}

package/dist/definitions/analytics/response.schema.js

@@ -0,0 +1,158 @@
+/**
+ * Analytics Domain - Response Schemas
+ *
+ * Zod schemas for analytics API response formatting.
+ * Includes metric registry and analytics platform API responses.
+ *
+ * Requirements: 6.5-6.7, 13.1-13.8, 23.1-23.2, 24.2
+ */
+import { z } from 'zod';
+import { AnalyticsPlatformSchema, GranularitySchema, RollupStrategySchema, TimeSeriesDataPointSchema, UnitLabelSchema, OverviewMetricValueSchema, } from './domain.schema.js';
+// ============================================================================
+// Analytics Platform API Response Schemas (Requirements 6.5-6.7)
+// ============================================================================
+/**
+ * Overview response schema
+ *
+ * Response schema for the /api/v1/analytics/overview endpoint.
+ *
+ * Requirements: 6.5
+ */
+export const OverviewResponseSchema = z.object({
+    /** Store platform */
+    platform: AnalyticsPlatformSchema,
+    /** Application ID */
+    appId: z.string(),
+    /** Time range */
+    timeRange: z.object({
+        from: z.string(),
+        to: z.string(),
+    }),
+    /** Metrics dictionary keyed by metric_key */
+    metrics: z.record(z.string(), OverviewMetricValueSchema),
+});
+/**
+ * Metric detail response schema
+ *
+ * Response schema for the /api/v1/analytics/metrics/:metricKey endpoint.
+ *
+ * Requirements: 6.7
+ */
+export const MetricDetailResponseSchema = z.object({
+    /** Metric key */
+    metricKey: z.string(),
+    /** Human-readable display name */
+    displayName: z.string(),
+    /** Unit of measurement */
+    unit: z.string(),
+    /** Rollup strategy */
+    rollupStrategy: RollupStrategySchema,
+    /** Time series data points */
+    dataPoints: z.array(TimeSeriesDataPointSchema).max(1000),
+    /** Data granularity */
+    granularity: GranularitySchema,
+    /** Whether the metric is deprecated */
+    isDeprecated: z.boolean(),
+});
+// ============================================================================
+// Metric Registry Response Schemas (Requirements 13.1-13.8)
+// ============================================================================
+/**
+ * Metric definition response schema
+ *
+ * Response schema for a single metric definition.
+ */
+export const MetricDefinitionResponseSchema = z.object({
+    metricKey: z.string(),
+    displayName: z.string(),
+    description: z.string().nullable(),
+    unitLabel: UnitLabelSchema,
+    rollupStrategy: RollupStrategySchema,
+    derivedNumeratorKey: z.string().nullable(),
+    derivedDenominatorKey: z.string().nullable(),
+    validationMin: z.number(),
+    validationMax: z.number(),
+    isDeprecated: z.boolean(),
+    deprecatedAt: z.string().nullable(),
+    createdAt: z.string(),
+    updatedAt: z.string(),
+});
+/**
+ * Metric registry response schema
+ *
+ * Response schema for the registry endpoint.
+ */
+export const MetricRegistryResponseSchema = z.object({
+    metrics: z.array(MetricDefinitionResponseSchema),
+    total: z.number().int().min(0),
+});
+// ============================================================================
+// Error and Rate Limit Response Schemas (Requirements 23.1-23.2, 24.2)
+// ============================================================================
+/**
+ * Analytics error response schema
+ *
+ * Error response format for analytics API.
+ *
+ * Requirements: 23.1, 23.2
+ */
+export const AnalyticsErrorResponseSchema = z.object({
+    error: z.object({
+        /** Machine-readable error code */
+        code: z.string(),
+        /** Human-readable message */
+        message: z.string(),
+        /** Additional error details */
+        details: z
+            .object({
+            field: z.string().optional(),
+            expected: z.string().optional(),
+            actual: z.string().optional(),
+            suggestion: z.string().optional(),
+        })
+            .optional(),
+    }),
+    /** Request ID for tracing */
+    requestId: z.string(),
+    /** ISO 8601 timestamp */
+    timestamp: z.string(),
+});
+/**
+ * Rate limit headers schema
+ *
+ * Rate limit information returned in response headers.
+ *
+ * Requirements: 24.2
+ */
+export const RateLimitHeadersSchema = z.object({
+    /** Maximum requests allowed in window */
+    limit: z.number().int().min(1),
+    /** Remaining requests in current window */
+    remaining: z.number().int().min(0),
+    /** Unix timestamp when window resets */
+    resetAt: z.number().int(),
+});
+// ============================================================================
+// Admin Response Schemas
+// ============================================================================
+/**
+ * Trigger analytics job response schema
+ *
+ * Response for the admin job trigger endpoint.
+ */
+export const TriggerAnalyticsJobResponseSchema = z.object({
+    /** Type of job(s) that were triggered */
+    jobType: z.string(),
+    /** Whether the job(s) were successfully queued */
+    triggered: z.boolean(),
+    /** Human-readable message */
+    message: z.string(),
+    /** Individual job results when triggering all jobs */
+    jobs: z
+        .array(z.object({
+        jobType: z.string(),
+        triggered: z.boolean(),
+    }))
+        .optional(),
+});
+//# sourceMappingURL=response.schema.js.map

package/dist/definitions/analytics/response.schema.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"response.schema.js","sourceRoot":"","sources":["../../../src/definitions/analytics/response.schema.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,EACL,uBAAuB,EACvB,iBAAiB,EACjB,oBAAoB,EACpB,yBAAyB,EACzB,eAAe,EACf,yBAAyB,GAC1B,MAAM,oBAAoB,CAAC;AAE5B,+EAA+E;AAC/E,iEAAiE;AACjE,+EAA+E;AAE/E;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,sBAAsB,GAAG,CAAC,CAAC,MAAM,CAAC;IAC7C,qBAAqB;IACrB,QAAQ,EAAE,uBAAuB;IAEjC,qBAAqB;IACrB,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE;IAEjB,iBAAiB;IACjB,SAAS,EAAE,CAAC,CAAC,MAAM,CAAC;QAClB,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE;QAChB,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE;KACf,CAAC;IAEF,6CAA6C;IAC7C,OAAO,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,EAAE,EAAE,yBAAyB,CAAC;CACzD,CAAC,CAAC;AAEH;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,0BAA0B,GAAG,CAAC,CAAC,MAAM,CAAC;IACjD,iBAAiB;IACjB,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE;IAErB,kCAAkC;IAClC,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE;IAEvB,0BAA0B;IAC1B,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE;IAEhB,sBAAsB;IACtB,cAAc,EAAE,oBAAoB;IAEpC,8BAA8B;IAC9B,UAAU,EAAE,CAAC,CAAC,KAAK,CAAC,yBAAyB,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC;IAExD,uBAAuB;IACvB,WAAW,EAAE,iBAAiB;IAE9B,uCAAuC;IACvC,YAAY,EAAE,CAAC,CAAC,OAAO,EAAE;CAC1B,CAAC,CAAC;AAEH,+EAA+E;AAC/E,4DAA4D;AAC5D,+EAA+E;AAE/E;;;;GAIG;AACH,MAAM,CAAC,MAAM,8BAA8B,GAAG,CAAC,CAAC,MAAM,CAAC;IACrD,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE;IACrB,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE;IACvB,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAClC,SAAS,EAAE,eAAe;IAC1B,cAAc,EAAE,oBAAoB;IACpC,mBAAmB,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC1C,qBAAqB,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC5C,aAAa,EAAE,CAAC,CAAC,MAAM,EAAE;IACzB,aAAa,EAAE,CAAC,CAAC,MAAM,EAAE;IACzB,YAAY,EAAE,CAAC,CAAC,OAAO,EAAE;IACzB,YAAY,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACnC,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE;IACrB,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE;CACtB,CAAC,CAAC;AAEH;;;;GAIG;AACH,MAAM,CAAC,MAAM,4BAA4B,GAAG,CAAC,CAAC,MAAM,CAAC;IACnD,OAAO,EAAE,CAAC,CAAC,KAAK,CAAC,8BAA8B,CAAC;IAChD,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;CAC/B,CAAC,CAAC;AAEH,+EAA+E;AAC/E,uEAAuE;AACvE,+EAA+E;AAE/E;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,4BAA4B,GAAG,CAAC,CAAC,MAAM,CAAC;IACnD,KAAK,EAAE,CAAC,CAAC,MAAM,CAAC;QACd,kCAAkC;QAClC,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE;QAEhB,6BAA6B;QAC7B,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE;QAEnB,+BAA+B;QAC/B,OAAO,EAAE,CAAC;aACP,MAAM,CAAC;YACN,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;YAC5B,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;YAC/B,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;YAC7B,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;SAClC,CAAC;aACD,QAAQ,EAAE;KACd,CAAC;IAEF,6BAA6B;IAC7B,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE;IAErB,yBAAyB;IACzB,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE;CACtB,CAAC,CAAC;AAEH;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,sBAAsB,GAAG,CAAC,CAAC,MAAM,CAAC;IAC7C,yCAAyC;IACzC,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;IAE9B,2CAA2C;IAC3C,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;IAElC,wCAAwC;IACxC,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE;CAC1B,CAAC,CAAC;AAEH,+EAA+E;AAC/E,yBAAyB;AACzB,+EAA+E;AAE/E;;;;GAIG;AACH,MAAM,CAAC,MAAM,iCAAiC,GAAG,CAAC,CAAC,MAAM,CAAC;IACxD,yCAAyC;IACzC,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE;IAEnB,kDAAkD;IAClD,SAAS,EAAE,CAAC,CAAC,OAAO,EAAE;IAEtB,6BAA6B;IAC7B,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE;IAEnB,sDAAsD;IACtD,IAAI,EAAE,CAAC;SACJ,KAAK,CACJ,CAAC,CAAC,MAAM,CAAC;QACP,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE;QACnB,SAAS,EAAE,CAAC,CAAC,OAAO,EAAE;KACvB,CAAC,CACH;SACA,QAAQ,EAAE;CACd,CAAC,CAAC"}