@stacksjs/ts-analytics 0.1.6

package/src/models/Site.ts

@@ -0,0 +1,115 @@
+import type { Model } from './types'
+
+/**
+ * Site/Website being tracked
+ *
+ * DynamoDB Keys:
+ * - PK: SITE#{siteId}
+ * - SK: SITE#{siteId}
+ * - GSI1PK: OWNER#{ownerId}
+ * - GSI1SK: SITE#{siteId}
+ */
+const SiteModel: Model = {
+  name: 'Site',
+  table: 'analytics', // Single-table design
+  primaryKey: 'id',
+  autoIncrement: false, // Use UUID
+
+  traits: {
+    useUuid: true,
+    useTimestamps: true,
+  },
+
+  belongsTo: ['User'], // Owner relationship
+
+  hasMany: [
+    'PageView',
+    'Session',
+    'CustomEvent',
+    'Goal',
+  ],
+
+  attributes: {
+    id: {
+      required: true,
+      unique: true,
+      validation: {
+        rule: 'string',
+      },
+    },
+
+    name: {
+      required: true,
+      fillable: true,
+      validation: {
+        rule: 'string',
+        message: {
+          required: 'Site name is required',
+        },
+      },
+    },
+
+    domains: {
+      required: true,
+      fillable: true,
+      validation: {
+        rule: 'array',
+      },
+      cast: 'array',
+    },
+
+    timezone: {
+      required: true,
+      fillable: true,
+      default: 'UTC',
+      validation: {
+        rule: 'string',
+      },
+    },
+
+    isActive: {
+      required: true,
+      fillable: true,
+      default: true,
+      validation: {
+        rule: 'boolean',
+      },
+      cast: 'boolean',
+    },
+
+    ownerId: {
+      required: true,
+      fillable: true,
+      validation: {
+        rule: 'string',
+      },
+    },
+
+    // Embedded settings object
+    settings: {
+      required: true,
+      fillable: true,
+      cast: 'json',
+      default: {
+        collectGeolocation: false,
+        trackReferrers: true,
+        trackUtmParams: true,
+        trackDeviceType: true,
+        publicDashboard: false,
+        excludedPaths: [],
+        excludedIps: [],
+        dataRetentionDays: 0,
+      },
+    },
+  },
+
+  // DynamoDB single-table key patterns
+  dynamodb: {
+    pk: (site: { id: string }): string => `SITE#${site.id}`,
+    sk: (site: { id: string }): string => `SITE#${site.id}`,
+    gsi1pk: (site: { ownerId: string }): string => `OWNER#${site.ownerId}`,
+    gsi1sk: (site: { id: string }): string => `SITE#${site.id}`,
+  },
+}
+
+export default SiteModel

package/src/models/index.ts

@@ -0,0 +1,50 @@
+/**
+ * Analytics Models Index
+ *
+ * This module exports all Stacks-compatible model definitions
+ * for the privacy-focused web analytics system.
+ */
+
+// Aggregation stats
+export { default as AggregatedStatsModel } from './AggregatedStats'
+export { default as CampaignStatsModel } from './CampaignStats'
+export { default as ConversionModel } from './Conversion'
+export { default as CustomEventModel } from './CustomEvent'
+export { default as DeviceStatsModel } from './DeviceStats'
+export { default as EventStatsModel } from './EventStats'
+
+export { default as GeoStatsModel } from './GeoStats'
+export { default as GoalModel } from './Goal'
+export { default as GoalStatsModel } from './GoalStats'
+export { default as PageStatsModel } from './PageStats'
+export { default as PageViewModel } from './PageView'
+export { default as RealtimeStatsModel } from './RealtimeStats'
+export { default as ReferrerStatsModel } from './ReferrerStats'
+export { default as SessionModel } from './Session'
+// Core entities
+export { default as SiteModel } from './Site'
+
+/**
+ * All analytics models for batch processing
+ */
+export const analyticsModels = [
+  // Core entities
+  'Site',
+  'PageView',
+  'Session',
+  'CustomEvent',
+  'Goal',
+  'Conversion',
+  // Aggregation stats
+  'AggregatedStats',
+  'PageStats',
+  'ReferrerStats',
+  'GeoStats',
+  'DeviceStats',
+  'CampaignStats',
+  'EventStats',
+  'GoalStats',
+  'RealtimeStats',
+] as const
+
+export type AnalyticsModelName = typeof analyticsModels[number]