@miadi/episodic-memory-schema 0.1.1 → 0.3.0

package/dist/observation.d.ts

@@ -0,0 +1,125 @@
+/**
+ * Compatibility-first observations of heterogeneous episode sources.
+ *
+ * An observation describes source material without requiring it to satisfy the
+ * authored EpisodicMemory schema. Consumers can inspect the diagnostics and
+ * decide whether a later, explicit projection is appropriate.
+ */
+export type EpisodeSourceZone = "composition-intake" | "chronicle" | "runtime-projection";
+export type EpisodeSourceFormat = "composition-json" | "episode-yaml" | "directory-inferred" | "episodic-memory";
+export interface SourceDocumentRef {
+    format: EpisodeSourceFormat;
+    relativePath: string;
+}
+export interface EpisodeIdentityCandidate {
+    kind: "episode-number" | "slug" | "title" | "path";
+    value: string;
+}
+export type ArtifactKind = "audio" | "transcript" | "image" | "text" | "midi" | "video" | "other";
+export interface ArtifactReference {
+    id: string;
+    kind: ArtifactKind;
+    relativePath: string;
+    label?: string;
+    sourceArtifact?: string;
+    metadata: Record<string, unknown>;
+}
+export type EpisodeRelationKind = "related-to" | "branch-of" | "continues-from";
+export interface EpisodeRelation {
+    id: string;
+    kind: EpisodeRelationKind;
+    target: EpisodeIdentityCandidate;
+    metadata?: Record<string, unknown>;
+}
+export interface CompatibilityDiagnostic {
+    level: "info" | "warning" | "error";
+    code: string;
+    message: string;
+    path?: string;
+}
+export interface EpisodeSourceMetadata {
+    title?: string;
+    slug?: string;
+    created?: string;
+    updated?: string;
+    notes?: string;
+    skillSeeds?: string[];
+    date?: string;
+    status?: string;
+    sessionTitle?: string;
+    primaryIssue?: string;
+}
+/**
+ * One movement of a composition — the song-form unit a musician edits.
+ *
+ * `chords` is deliberately typed as a union: the current editor writes an
+ * array, older manifests and the documented schema write a delimited string.
+ * Both are real in the corpus, so neither is normalized away here.
+ */
+export interface CompositionSection {
+    name?: string;
+    chords?: string[] | string;
+    bpm?: number;
+    lyrics?: string;
+    strum?: string;
+    /** Per-note MIDI arrays are summarized; the raw array stays in unmappedFields. */
+    midi?: {
+        source?: string;
+        noteCount?: number;
+        duration?: number;
+    };
+    unmappedFields: Record<string, unknown>;
+}
+/**
+ * The songwriting layer of a composition manifest.
+ *
+ * Present only when the source carried musical fields. Absent is meaningful —
+ * it distinguishes a hand-authored manifest that never had them from one whose
+ * musician left them at defaults.
+ */
+export interface CompositionMusicalMetadata {
+    /** Derived by the writer as the flat union of every section's chords. */
+    chords?: string[];
+    sections?: CompositionSection[];
+    rhythm?: string;
+    bpm?: number | null;
+    bpmDetected?: boolean;
+    key?: string;
+    capo?: string;
+}
+export interface EpisodeObservation {
+    id: string;
+    zone: EpisodeSourceZone;
+    sourceDocuments: SourceDocumentRef[];
+    identityCandidates: EpisodeIdentityCandidate[];
+    sourceMetadata: EpisodeSourceMetadata;
+    artifacts: ArtifactReference[];
+    relations: EpisodeRelation[];
+    diagnostics: CompatibilityDiagnostic[];
+    /** Present only for sources carrying musical metadata. */
+    musical?: CompositionMusicalMetadata;
+    /** Source fields that were preserved but not structurally projected. */
+    unmappedFields: Record<string, unknown>;
+}
+export interface ObserveCompositionManifestOptions {
+    relativePath: string;
+    zone?: "composition-intake";
+}
+export interface ObserveEpisodeYamlManifestOptions {
+    relativePath: string;
+    zone?: "chronicle";
+}
+export interface EpisodeDirectoryEntry {
+    relativePath: string;
+    type?: "file" | "directory";
+    size?: number;
+    modifiedAt?: string;
+}
+export interface EpisodeDirectorySnapshot {
+    entries: readonly (string | EpisodeDirectoryEntry)[];
+}
+export interface ObserveEpisodeDirectoryOptions {
+    relativePath: string;
+    zone?: "chronicle";
+}
+//# sourceMappingURL=observation.d.ts.map

package/dist/observation.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"observation.d.ts","sourceRoot":"","sources":["../src/observation.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH,MAAM,MAAM,iBAAiB,GACzB,oBAAoB,GACpB,WAAW,GACX,oBAAoB,CAAA;AAExB,MAAM,MAAM,mBAAmB,GAC3B,kBAAkB,GAClB,cAAc,GACd,oBAAoB,GACpB,iBAAiB,CAAA;AAErB,MAAM,WAAW,iBAAiB;IAChC,MAAM,EAAE,mBAAmB,CAAA;IAC3B,YAAY,EAAE,MAAM,CAAA;CACrB;AAED,MAAM,WAAW,wBAAwB;IACvC,IAAI,EAAE,gBAAgB,GAAG,MAAM,GAAG,OAAO,GAAG,MAAM,CAAA;IAClD,KAAK,EAAE,MAAM,CAAA;CACd;AAED,MAAM,MAAM,YAAY,GACpB,OAAO,GACP,YAAY,GACZ,OAAO,GACP,MAAM,GACN,MAAM,GACN,OAAO,GACP,OAAO,CAAA;AAEX,MAAM,WAAW,iBAAiB;IAChC,EAAE,EAAE,MAAM,CAAA;IACV,IAAI,EAAE,YAAY,CAAA;IAClB,YAAY,EAAE,MAAM,CAAA;IACpB,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,cAAc,CAAC,EAAE,MAAM,CAAA;IACvB,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CAClC;AAED,MAAM,MAAM,mBAAmB,GAAG,YAAY,GAAG,WAAW,GAAG,gBAAgB,CAAA;AAE/E,MAAM,WAAW,eAAe;IAC9B,EAAE,EAAE,MAAM,CAAA;IACV,IAAI,EAAE,mBAAmB,CAAA;IACzB,MAAM,EAAE,wBAAwB,CAAA;IAChC,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CACnC;AAED,MAAM,WAAW,uBAAuB;IACtC,KAAK,EAAE,MAAM,GAAG,SAAS,GAAG,OAAO,CAAA;IACnC,IAAI,EAAE,MAAM,CAAA;IACZ,OAAO,EAAE,MAAM,CAAA;IACf,IAAI,CAAC,EAAE,MAAM,CAAA;CACd;AAED,MAAM,WAAW,qBAAqB;IACpC,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,UAAU,CAAC,EAAE,MAAM,EAAE,CAAA;IACrB,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,YAAY,CAAC,EAAE,MAAM,CAAA;CACtB;AAED;;;;;;GAMG;AACH,MAAM,WAAW,kBAAkB;IACjC,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,MAAM,CAAC,EAAE,MAAM,EAAE,GAAG,MAAM,CAAA;IAC1B,GAAG,CAAC,EAAE,MAAM,CAAA;IACZ,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,kFAAkF;IAClF,IAAI,CAAC,EAAE;QAAE,MAAM,CAAC,EAAE,MAAM,CAAC;QAAC,SAAS,CAAC,EAAE,MAAM,CAAC;QAAC,QAAQ,CAAC,EAAE,MAAM,CAAA;KAAE,CAAA;IACjE,cAAc,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CACxC;AAED;;;;;;GAMG;AACH,MAAM,WAAW,0BAA0B;IACzC,yEAAyE;IACzE,MAAM,CAAC,EAAE,MAAM,EAAE,CAAA;IACjB,QAAQ,CAAC,EAAE,kBAAkB,EAAE,CAAA;IAC/B,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,GAAG,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACnB,WAAW,CAAC,EAAE,OAAO,CAAA;IACrB,GAAG,CAAC,EAAE,MAAM,CAAA;IACZ,IAAI,CAAC,EAAE,MAAM,CAAA;CACd;AAED,MAAM,WAAW,kBAAkB;IACjC,EAAE,EAAE,MAAM,CAAA;IACV,IAAI,EAAE,iBAAiB,CAAA;IACvB,eAAe,EAAE,iBAAiB,EAAE,CAAA;IACpC,kBAAkB,EAAE,wBAAwB,EAAE,CAAA;IAC9C,cAAc,EAAE,qBAAqB,CAAA;IACrC,SAAS,EAAE,iBAAiB,EAAE,CAAA;IAC9B,SAAS,EAAE,eAAe,EAAE,CAAA;IAC5B,WAAW,EAAE,uBAAuB,EAAE,CAAA;IACtC,0DAA0D;IAC1D,OAAO,CAAC,EAAE,0BAA0B,CAAA;IACpC,wEAAwE;IACxE,cAAc,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CACxC;AAED,MAAM,WAAW,iCAAiC;IAChD,YAAY,EAAE,MAAM,CAAA;IACpB,IAAI,CAAC,EAAE,oBAAoB,CAAA;CAC5B;AAED,MAAM,WAAW,iCAAiC;IAChD,YAAY,EAAE,MAAM,CAAA;IACpB,IAAI,CAAC,EAAE,WAAW,CAAA;CACnB;AAED,MAAM,WAAW,qBAAqB;IACpC,YAAY,EAAE,MAAM,CAAA;IACpB,IAAI,CAAC,EAAE,MAAM,GAAG,WAAW,CAAA;IAC3B,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,UAAU,CAAC,EAAE,MAAM,CAAA;CACpB;AAED,MAAM,WAAW,wBAAwB;IACvC,OAAO,EAAE,SAAS,CAAC,MAAM,GAAG,qBAAqB,CAAC,EAAE,CAAA;CACrD;AAED,MAAM,WAAW,8BAA8B;IAC7C,YAAY,EAAE,MAAM,CAAA;IACpB,IAAI,CAAC,EAAE,WAAW,CAAA;CACnB"}

package/dist/observation.js

@@ -0,0 +1,9 @@
+/**
+ * Compatibility-first observations of heterogeneous episode sources.
+ *
+ * An observation describes source material without requiring it to satisfy the
+ * authored EpisodicMemory schema. Consumers can inspect the diagnostics and
+ * decide whether a later, explicit projection is appropriate.
+ */
+export {};
+//# sourceMappingURL=observation.js.map

package/dist/observation.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"observation.js","sourceRoot":"","sources":["../src/observation.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@miadi/episodic-memory-schema",
-  "version": "0.1.1",
+  "version": "0.3.0",
   "description": "TypeScript types and JSON Schema for episodic memory — the durable session-to-session memory layer in the Miadi orchestration kit. Narrative layer is NCP-aligned; provenance layer is W3C PROV-DM and OAIS-informed.",
   "keywords": [
     "miadi",
@@ -18,7 +18,7 @@
   "homepage": "https://github.com/jgwill/Miadi/tree/main/packages/episodic-memory-schema",
   "repository": {
     "type": "git",
-    "url": "https://github.com/jgwill/Miadi.git",
+    "url": "git+https://github.com/jgwill/Miadi.git",
     "directory": "packages/episodic-memory-schema"
   },
   "type": "module",
@@ -39,15 +39,15 @@
     "README.md",
     "LICENSE"
   ],
-  "scripts": {
-    "build": "tsc",
-    "type-check": "tsc --noEmit",
-    "prepublishOnly": "pnpm build"
-  },
   "devDependencies": {
     "typescript": "^5.4.0"
   },
   "publishConfig": {
     "access": "public"
+  },
+  "scripts": {
+    "build": "tsc",
+    "type-check": "tsc --noEmit",
+    "test": "npm run build && node --test test/*.test.mjs"
   }
-}
+}