@miadi/ncp-story-studio 0.1.0

package/dist/schema/normalize.js

@@ -0,0 +1,88 @@
+// Real NCP files in the wild are not all shaped the same way. The canonical
+// examples ship in three layouts, and older exports omit whole collections.
+// Normalizing them is fine; doing it silently is not, so every adaptation is
+// reported as a note the caller can show.
+import { NCP_SCHEMA_VERSION } from './constants.js';
+const EMPTY_SUBTEXT = {
+    perspectives: [],
+    players: [],
+    dynamics: [],
+    storypoints: [],
+    storybeats: [],
+};
+/**
+ * Accepts:
+ * - `{ schema_version, story }` — canonical, passed through
+ * - `{ story, narratives }` — the layout `anora.json` and `the-shawshank-redemption.json` use
+ * - `{ story }` without a schema version
+ * - a bare story object
+ */
+export function normalizeNcpInput(input, options) {
+    const notes = [];
+    if (typeof input !== 'object' || input === null) {
+        throw new TypeError('an NCP document must be an object');
+    }
+    const raw = input;
+    let storyRaw;
+    if (typeof raw['story'] === 'object' && raw['story'] !== null) {
+        storyRaw = { ...raw['story'] };
+    }
+    else if (Array.isArray(raw['narratives'])) {
+        storyRaw = { ...raw };
+        notes.push({ path: '$', action: 'treated the top-level object as the story' });
+    }
+    else {
+        throw new TypeError('no `story` object and no `narratives` array: this is not an NCP document');
+    }
+    if (!Array.isArray(storyRaw['narratives']) && Array.isArray(raw['narratives'])) {
+        storyRaw['narratives'] = raw['narratives'];
+        notes.push({ path: '$.narratives', action: 'moved top-level `narratives` under `story`' });
+    }
+    if (!Array.isArray(storyRaw['narratives'])) {
+        storyRaw['narratives'] = [];
+        notes.push({ path: '$.story.narratives', action: 'added an empty `narratives` array' });
+    }
+    const narratives = storyRaw['narratives'].map((narrativeRaw, index) => normalizeNarrative(narrativeRaw, `$.story.narratives[${index}]`, notes));
+    const schemaVersion = typeof raw['schema_version'] === 'string' ? raw['schema_version'] : (options?.schemaVersion ?? NCP_SCHEMA_VERSION);
+    if (typeof raw['schema_version'] !== 'string') {
+        notes.push({ path: '$.schema_version', action: `assumed \`${schemaVersion}\`` });
+    }
+    const story = { ...storyRaw, narratives };
+    return { document: { schema_version: schemaVersion, story }, notes };
+}
+function normalizeNarrative(input, path, notes) {
+    if (typeof input !== 'object' || input === null) {
+        throw new TypeError(`${path} is not a narrative object`);
+    }
+    const raw = { ...input };
+    const subtextRaw = (typeof raw['subtext'] === 'object' && raw['subtext'] !== null ? raw['subtext'] : {});
+    if (typeof raw['subtext'] !== 'object' || raw['subtext'] === null) {
+        notes.push({ path: `${path}.subtext`, action: 'added an empty `subtext`' });
+    }
+    const subtext = {};
+    for (const key of Object.keys(EMPTY_SUBTEXT)) {
+        if (Array.isArray(subtextRaw[key])) {
+            subtext[key] = subtextRaw[key];
+        }
+        else {
+            subtext[key] = [];
+            notes.push({ path: `${path}.subtext.${key}`, action: 'added an empty array' });
+        }
+    }
+    const storytellingRaw = (typeof raw['storytelling'] === 'object' && raw['storytelling'] !== null ? raw['storytelling'] : {});
+    if (typeof raw['storytelling'] !== 'object' || raw['storytelling'] === null) {
+        notes.push({ path: `${path}.storytelling`, action: 'added an empty `storytelling`' });
+    }
+    const storytelling = {};
+    for (const key of ['overviews', 'moments']) {
+        if (Array.isArray(storytellingRaw[key])) {
+            storytelling[key] = storytellingRaw[key];
+        }
+        else {
+            storytelling[key] = [];
+            notes.push({ path: `${path}.storytelling.${key}`, action: 'added an empty array' });
+        }
+    }
+    return { ...raw, subtext, storytelling };
+}
+//# sourceMappingURL=normalize.js.map

package/dist/schema/normalize.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"normalize.js","sourceRoot":"","sources":["../../src/schema/normalize.ts"],"names":[],"mappings":"AAAA,4EAA4E;AAC5E,4EAA4E;AAC5E,6EAA6E;AAC7E,0CAA0C;AAC1C,OAAO,EAAE,kBAAkB,EAAE,MAAM,gBAAgB,CAAA;AAanD,MAAM,aAAa,GAAG;IACpB,YAAY,EAAE,EAAE;IAChB,OAAO,EAAE,EAAE;IACX,QAAQ,EAAE,EAAE;IACZ,WAAW,EAAE,EAAE;IACf,UAAU,EAAE,EAAE;CACN,CAAA;AAEV;;;;;;GAMG;AACH,MAAM,UAAU,iBAAiB,CAAC,KAAc,EAAE,OAAoC;IACpF,MAAM,KAAK,GAAoB,EAAE,CAAA;IACjC,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,IAAI,EAAE,CAAC;QAChD,MAAM,IAAI,SAAS,CAAC,mCAAmC,CAAC,CAAA;IAC1D,CAAC;IACD,MAAM,GAAG,GAAG,KAAgC,CAAA;IAE5C,IAAI,QAAiC,CAAA;IACrC,IAAI,OAAO,GAAG,CAAC,OAAO,CAAC,KAAK,QAAQ,IAAI,GAAG,CAAC,OAAO,CAAC,KAAK,IAAI,EAAE,CAAC;QAC9D,QAAQ,GAAG,EAAE,GAAI,GAAG,CAAC,OAAO,CAA6B,EAAE,CAAA;IAC7D,CAAC;SAAM,IAAI,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC,EAAE,CAAC;QAC5C,QAAQ,GAAG,EAAE,GAAG,GAAG,EAAE,CAAA;QACrB,KAAK,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,GAAG,EAAE,MAAM,EAAE,2CAA2C,EAAE,CAAC,CAAA;IAChF,CAAC;SAAM,CAAC;QACN,MAAM,IAAI,SAAS,CAAC,0EAA0E,CAAC,CAAA;IACjG,CAAC;IAED,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAC,CAAC,IAAI,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC,EAAE,CAAC;QAC/E,QAAQ,CAAC,YAAY,CAAC,GAAG,GAAG,CAAC,YAAY,CAAC,CAAA;QAC1C,KAAK,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,cAAc,EAAE,MAAM,EAAE,4CAA4C,EAAE,CAAC,CAAA;IAC5F,CAAC;IACD,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAC,CAAC,EAAE,CAAC;QAC3C,QAAQ,CAAC,YAAY,CAAC,GAAG,EAAE,CAAA;QAC3B,KAAK,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,oBAAoB,EAAE,MAAM,EAAE,mCAAmC,EAAE,CAAC,CAAA;IACzF,CAAC;IAED,MAAM,UAAU,GAAI,QAAQ,CAAC,YAAY,CAAe,CAAC,GAAG,CAAC,CAAC,YAAY,EAAE,KAAK,EAAE,EAAE,CACnF,kBAAkB,CAAC,YAAY,EAAE,sBAAsB,KAAK,GAAG,EAAE,KAAK,CAAC,CACxE,CAAA;IAED,MAAM,aAAa,GACjB,OAAO,GAAG,CAAC,gBAAgB,CAAC,KAAK,QAAQ,CAAC,CAAC,CAAC,GAAG,CAAC,gBAAgB,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,EAAE,aAAa,IAAI,kBAAkB,CAAC,CAAA;IACpH,IAAI,OAAO,GAAG,CAAC,gBAAgB,CAAC,KAAK,QAAQ,EAAE,CAAC;QAC9C,KAAK,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,kBAAkB,EAAE,MAAM,EAAE,aAAa,aAAa,IAAI,EAAE,CAAC,CAAA;IAClF,CAAC;IAED,MAAM,KAAK,GAAG,EAAE,GAAG,QAAQ,EAAE,UAAU,EAAsB,CAAA;IAC7D,OAAO,EAAE,QAAQ,EAAE,EAAE,cAAc,EAAE,aAAa,EAAE,KAAK,EAAE,EAAE,KAAK,EAAE,CAAA;AACtE,CAAC;AAED,SAAS,kBAAkB,CAAC,KAAc,EAAE,IAAY,EAAE,KAAsB;IAC9E,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,IAAI,EAAE,CAAC;QAChD,MAAM,IAAI,SAAS,CAAC,GAAG,IAAI,4BAA4B,CAAC,CAAA;IAC1D,CAAC;IACD,MAAM,GAAG,GAAG,EAAE,GAAI,KAAiC,EAAE,CAAA;IAErD,MAAM,UAAU,GAAG,CAAC,OAAO,GAAG,CAAC,SAAS,CAAC,KAAK,QAAQ,IAAI,GAAG,CAAC,SAAS,CAAC,KAAK,IAAI,CAAC,CAAC,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,EAAE,CAGtG,CAAA;IACD,IAAI,OAAO,GAAG,CAAC,SAAS,CAAC,KAAK,QAAQ,IAAI,GAAG,CAAC,SAAS,CAAC,KAAK,IAAI,EAAE,CAAC;QAClE,KAAK,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,GAAG,IAAI,UAAU,EAAE,MAAM,EAAE,0BAA0B,EAAE,CAAC,CAAA;IAC7E,CAAC;IACD,MAAM,OAAO,GAA4B,EAAE,CAAA;IAC3C,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,aAAa,CAAmC,EAAE,CAAC;QAC/E,IAAI,KAAK,CAAC,OAAO,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC;YACnC,OAAO,CAAC,GAAG,CAAC,GAAG,UAAU,CAAC,GAAG,CAAC,CAAA;QAChC,CAAC;aAAM,CAAC;YACN,OAAO,CAAC,GAAG,CAAC,GAAG,EAAE,CAAA;YACjB,KAAK,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,GAAG,IAAI,YAAY,GAAG,EAAE,EAAE,MAAM,EAAE,sBAAsB,EAAE,CAAC,CAAA;QAChF,CAAC;IACH,CAAC;IAED,MAAM,eAAe,GAAG,CACtB,OAAO,GAAG,CAAC,cAAc,CAAC,KAAK,QAAQ,IAAI,GAAG,CAAC,cAAc,CAAC,KAAK,IAAI,CAAC,CAAC,CAAC,GAAG,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,EAAE,CACxE,CAAA;IAC5B,IAAI,OAAO,GAAG,CAAC,cAAc,CAAC,KAAK,QAAQ,IAAI,GAAG,CAAC,cAAc,CAAC,KAAK,IAAI,EAAE,CAAC;QAC5E,KAAK,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,GAAG,IAAI,eAAe,EAAE,MAAM,EAAE,+BAA+B,EAAE,CAAC,CAAA;IACvF,CAAC;IACD,MAAM,YAAY,GAA4B,EAAE,CAAA;IAChD,KAAK,MAAM,GAAG,IAAI,CAAC,WAAW,EAAE,SAAS,CAAU,EAAE,CAAC;QACpD,IAAI,KAAK,CAAC,OAAO,CAAC,eAAe,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC;YACxC,YAAY,CAAC,GAAG,CAAC,GAAG,eAAe,CAAC,GAAG,CAAC,CAAA;QAC1C,CAAC;aAAM,CAAC;YACN,YAAY,CAAC,GAAG,CAAC,GAAG,EAAE,CAAA;YACtB,KAAK,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,GAAG,IAAI,iBAAiB,GAAG,EAAE,EAAE,MAAM,EAAE,sBAAsB,EAAE,CAAC,CAAA;QACrF,CAAC;IACH,CAAC;IAED,OAAO,EAAE,GAAG,GAAG,EAAE,OAAO,EAAE,YAAY,EAA0B,CAAA;AAClE,CAAC"}

package/dist/schema/read.d.ts

@@ -0,0 +1,31 @@
+import { type NormalizeNote } from './normalize.js';
+import type { NcpDocument, Story } from './types.js';
+export type NcpDialect = 'canonical' | 'subtxt-export' | 'miadi-design' | 'unknown';
+export interface ReadOptions {
+    /** Skip detection and read as this dialect. */
+    assume?: NcpDialect;
+    /** Fields the source does not carry, supplied by the caller. */
+    storyOverrides?: Partial<Pick<Story, 'title' | 'genre' | 'logline' | 'created_at'>>;
+    /** Fallback id when the source has none. */
+    fallbackId?: string;
+}
+export interface ReadResult {
+    document: NcpDocument;
+    dialect: NcpDialect;
+    notes: NormalizeNote[];
+}
+/** Which dialect an input is written in. */
+export declare function detectDialect(input: unknown): NcpDialect;
+/** Read any recognized dialect and return canonical NCP. */
+export declare function readNcp(input: unknown, options?: ReadOptions): ReadResult;
+/**
+ * A canonical-layout document can still carry Dramatica display labels where
+ * the schema declares identifiers — `example-story.json` does. This maps them
+ * and declares whatever it cannot map, so a consumer never has to guess whether
+ * `"Success"` and `"success"` are the same value.
+ */
+export declare function canonicalizeTerms(document: NcpDocument): {
+    document: NcpDocument;
+    notes: NormalizeNote[];
+};
+//# sourceMappingURL=read.d.ts.map

package/dist/schema/read.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"read.d.ts","sourceRoot":"","sources":["../../src/schema/read.ts"],"names":[],"mappings":"AAWA,OAAO,EAAqB,KAAK,aAAa,EAAE,MAAM,gBAAgB,CAAA;AAStE,OAAO,KAAK,EAIV,WAAW,EAIX,KAAK,EAGN,MAAM,YAAY,CAAA;AAEnB,MAAM,MAAM,UAAU,GAAG,WAAW,GAAG,eAAe,GAAG,cAAc,GAAG,SAAS,CAAA;AAEnF,MAAM,WAAW,WAAW;IAC1B,+CAA+C;IAC/C,MAAM,CAAC,EAAE,UAAU,CAAA;IACnB,gEAAgE;IAChE,cAAc,CAAC,EAAE,OAAO,CAAC,IAAI,CAAC,KAAK,EAAE,OAAO,GAAG,OAAO,GAAG,SAAS,GAAG,YAAY,CAAC,CAAC,CAAA;IACnF,4CAA4C;IAC5C,UAAU,CAAC,EAAE,MAAM,CAAA;CACpB;AAED,MAAM,WAAW,UAAU;IACzB,QAAQ,EAAE,WAAW,CAAA;IACrB,OAAO,EAAE,UAAU,CAAA;IACnB,KAAK,EAAE,aAAa,EAAE,CAAA;CACvB;AA+BD,4CAA4C;AAC5C,wBAAgB,aAAa,CAAC,KAAK,EAAE,OAAO,GAAG,UAAU,CAwBxD;AAED,4DAA4D;AAC5D,wBAAgB,OAAO,CAAC,KAAK,EAAE,OAAO,EAAE,OAAO,CAAC,EAAE,WAAW,GAAG,UAAU,CAmBzE;AA0eD;;;;;GAKG;AACH,wBAAgB,iBAAiB,CAAC,QAAQ,EAAE,WAAW,GAAG;IAAE,QAAQ,EAAE,WAAW,CAAC;IAAC,KAAK,EAAE,aAAa,EAAE,CAAA;CAAE,CAwF1G"}