@plasius/schema 1.2.18 → 1.3.0

package/README.md

@@ -30,6 +30,25 @@ uses `dist-cjs/*.js` with `type: module`, it must generate
 
 ---
 
+## Player-system event contracts
+
+The package exports versioned contracts for a blob-backed, privacy-safe player
+event pipeline:
+
+```ts
+import {
+  PlayerSystemCuratedSnapshotSchema,
+  PlayerSystemNormalizedEventBatchSchema,
+  PlayerSystemObservedEventBatchSchema,
+} from "@plasius/schema";
+```
+
+The contracts cover raw observed-event ingress, normalized batches with
+deterministic keys, and curated per-player Event Log/Achievement snapshots.
+Only the stable `playerId` is treated as a personal identifier. It is retained
+for storage partitioning and pseudonymized by `sanitizeForLog`; unknown fields
+and hidden server truth are excluded by schema serialization.
+
 ## Demo
 
 ```bash

package/dist/index.cjs

@@ -22,6 +22,12 @@ var index_exports = {};
 __export(index_exports, {
   FieldBuilder: () => FieldBuilder,
   IsoLanguageCode: () => IsoLanguageCode,
+  PLAYER_SYSTEM_ACHIEVEMENT_TIERS: () => PLAYER_SYSTEM_ACHIEVEMENT_TIERS,
+  PLAYER_SYSTEM_ACHIEVEMENT_TRACK_STATUSES: () => PLAYER_SYSTEM_ACHIEVEMENT_TRACK_STATUSES,
+  PLAYER_SYSTEM_EVENT_KINDS: () => PLAYER_SYSTEM_EVENT_KINDS,
+  PlayerSystemCuratedSnapshotSchema: () => PlayerSystemCuratedSnapshotSchema,
+  PlayerSystemNormalizedEventBatchSchema: () => PlayerSystemNormalizedEventBatchSchema,
+  PlayerSystemObservedEventBatchSchema: () => PlayerSystemObservedEventBatchSchema,
   createComponentSchema: () => createComponentSchema,
   createSchema: () => createSchema,
   field: () => field,
@@ -2559,10 +2565,129 @@ function getComponentSchema(type) {
 function getAllComponentSchemas() {
   return Array.from(componentSchemaRegistry.entries());
 }
+
+// src/player-system-events.ts
+var PLAYER_SYSTEM_EVENT_KINDS = [
+  "combat",
+  "social",
+  "mission",
+  "crafting",
+  "world"
+];
+var PLAYER_SYSTEM_ACHIEVEMENT_TIERS = [
+  "bronze",
+  "silver",
+  "gold"
+];
+var PLAYER_SYSTEM_ACHIEVEMENT_TRACK_STATUSES = [
+  "tracking",
+  "earned"
+];
+var playerIdField = () => field.string().min(1).max(128).PID({
+  classification: "low",
+  action: "none",
+  logHandling: "pseudonym",
+  purpose: "a stable player-scoped storage identifier"
+}).description(
+  "Stable player identifier; the only personal identifier retained in event projections"
+);
+var eventIdField = () => field.string().min(1).max(128);
+var eventKindField = () => field.string().enum(PLAYER_SYSTEM_EVENT_KINDS);
+var eventTitleField = () => field.generalText().min(1).max(120).description("Player-visible event title");
+var eventSummaryField = () => field.generalText().min(1).max(320).description("Player-visible event summary");
+var observedEventFields = (defaultHighlighted = true) => ({
+  id: eventIdField(),
+  playerId: playerIdField(),
+  occurredAt: field.dateTimeISO(),
+  kind: eventKindField(),
+  title: eventTitleField(),
+  summary: eventSummaryField(),
+  highlighted: defaultHighlighted ? field.boolean().default(false) : field.boolean()
+});
+var eventHighlightFields = () => ({
+  id: eventIdField(),
+  title: eventTitleField(),
+  summary: eventSummaryField(),
+  occurredAt: field.dateTimeISO(),
+  kind: eventKindField()
+});
+var eventEntryFields = () => ({
+  id: eventIdField(),
+  title: eventTitleField(),
+  summary: eventSummaryField(),
+  occurredAt: field.dateTimeISO(),
+  kind: eventKindField(),
+  highlighted: field.boolean()
+});
+var achievementFields = () => ({
+  id: eventIdField(),
+  title: eventTitleField(),
+  tier: field.string().enum(PLAYER_SYSTEM_ACHIEVEMENT_TIERS),
+  progressLabel: eventSummaryField(),
+  earnedAt: field.dateTimeISO().optional()
+});
+var achievementTrackFields = () => ({
+  id: eventIdField(),
+  title: eventTitleField(),
+  current: field.number().min(0).max(1e3),
+  target: field.number().min(1).max(1e3),
+  status: field.string().enum(PLAYER_SYSTEM_ACHIEVEMENT_TRACK_STATUSES)
+});
+var PlayerSystemObservedEventBatchSchema = createSchema(
+  {
+    source: field.string().min(1).max(120),
+    emittedAt: field.dateTimeISO(),
+    events: field.array(field.object(observedEventFields()))
+  },
+  "player-system-observed-event-batch",
+  {
+    version: "1.0.0",
+    piiEnforcement: "strict"
+  }
+);
+var PlayerSystemNormalizedEventBatchSchema = createSchema(
+  {
+    sourceBlobName: field.string().min(1).max(512),
+    processedAt: field.dateTimeISO(),
+    events: field.array(
+      field.object({
+        ...observedEventFields(false),
+        deterministicKey: field.string().min(1).max(256)
+      })
+    )
+  },
+  "player-system-normalized-event-batch",
+  {
+    version: "1.0.0",
+    piiEnforcement: "strict"
+  }
+);
+var PlayerSystemCuratedSnapshotSchema = createSchema(
+  {
+    playerId: playerIdField(),
+    projectedAt: field.dateTimeISO(),
+    lastObservedAt: field.dateTimeISO(),
+    highlights: field.array(field.object(eventHighlightFields())),
+    events: field.array(field.object(eventEntryFields())),
+    achievements: field.array(field.object(achievementFields())),
+    tracks: field.array(field.object(achievementTrackFields()))
+  },
+  "player-system-curated-snapshot",
+  {
+    version: "1.0.0",
+    piiEnforcement: "strict"
+  }
+);
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   FieldBuilder,
   IsoLanguageCode,
+  PLAYER_SYSTEM_ACHIEVEMENT_TIERS,
+  PLAYER_SYSTEM_ACHIEVEMENT_TRACK_STATUSES,
+  PLAYER_SYSTEM_EVENT_KINDS,
+  PlayerSystemCuratedSnapshotSchema,
+  PlayerSystemNormalizedEventBatchSchema,
+  PlayerSystemObservedEventBatchSchema,
   createComponentSchema,
   createSchema,
   field,