glost-core 0.5.0

package/dist/guards.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"guards.js","sourceRoot":"","sources":["../src/guards.ts"],"names":[],"mappings":"AAAA,+EAA+E;AAC/E,oDAAoD;AACpD,+EAA+E;AAe/E,+EAA+E;AAC/E,wBAAwB;AACxB,+EAA+E;AAE/E;;GAEG;AACH,MAAM,UAAU,WAAW,CAAC,IAAa;IACvC,OAAO,CACL,OAAO,IAAI,KAAK,QAAQ;QACxB,IAAI,KAAK,IAAI;QACb,MAAM,IAAI,IAAI;QACd,IAAI,CAAC,IAAI,KAAK,UAAU;QACxB,UAAU,IAAI,IAAI;QAClB,MAAM,IAAI,IAAI;QACd,QAAQ,IAAI,IAAI;QAChB,OAAO,IAAI,IAAI;QACf,UAAU,IAAI,IAAI;QAClB,eAAe,IAAI,IAAI;QACvB,QAAQ,IAAI,IAAI,CACjB,CAAC;AACJ,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,eAAe,CAAC,IAAa;IAC3C,OAAO,CACL,OAAO,IAAI,KAAK,QAAQ;QACxB,IAAI,KAAK,IAAI;QACb,MAAM,IAAI,IAAI;QACd,IAAI,CAAC,IAAI,KAAK,cAAc;QAC5B,UAAU,IAAI,IAAI;QAClB,MAAM,IAAI,IAAI;QACd,QAAQ,IAAI,IAAI;QAChB,OAAO,IAAI,IAAI;QACf,UAAU,IAAI,IAAI,CACnB,CAAC;AACJ,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,gBAAgB,CAAC,IAAa;IAC5C,OAAO,CACL,OAAO,IAAI,KAAK,QAAQ;QACxB,IAAI,KAAK,IAAI;QACb,MAAM,IAAI,IAAI;QACd,IAAI,CAAC,IAAI,KAAK,eAAe;QAC7B,UAAU,IAAI,IAAI;QAClB,MAAM,IAAI,IAAI;QACd,QAAQ,IAAI,IAAI;QAChB,OAAO,IAAI,IAAI;QACf,UAAU,IAAI,IAAI,CACnB,CAAC;AACJ,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,WAAW,CAAC,IAAa;IACvC,OAAO,CACL,OAAO,IAAI,KAAK,QAAQ;QACxB,IAAI,KAAK,IAAI;QACb,MAAM,IAAI,IAAI;QACd,IAAI,CAAC,IAAI,KAAK,UAAU;QACxB,UAAU,IAAI,IAAI;QAClB,MAAM,IAAI,IAAI;QACd,QAAQ,IAAI,IAAI;QAChB,OAAO,IAAI,IAAI;QACf,UAAU,IAAI,IAAI,CACnB,CAAC;AACJ,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,WAAW,CAAC,IAAa;IACvC,OAAO,CACL,OAAO,IAAI,KAAK,QAAQ;QACxB,IAAI,KAAK,IAAI;QACb,MAAM,IAAI,IAAI;QACd,IAAI,CAAC,IAAI,KAAK,UAAU;QACxB,OAAO,IAAI,IAAI;QACf,OAAO,IAAI,CAAC,KAAK,KAAK,QAAQ,CAC/B,CAAC;AACJ,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,kBAAkB,CAAC,IAAa;IAC9C,OAAO,CACL,OAAO,IAAI,KAAK,QAAQ;QACxB,IAAI,KAAK,IAAI;QACb,MAAM,IAAI,IAAI;QACd,IAAI,CAAC,IAAI,KAAK,iBAAiB;QAC/B,OAAO,IAAI,IAAI;QACf,OAAO,IAAI,CAAC,KAAK,KAAK,QAAQ,CAC/B,CAAC;AACJ,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,aAAa,CAAC,IAAa;IACzC,OAAO,CACL,OAAO,IAAI,KAAK,QAAQ;QACxB,IAAI,KAAK,IAAI;QACb,MAAM,IAAI,IAAI;QACd,IAAI,CAAC,IAAI,KAAK,YAAY;QAC1B,OAAO,IAAI,IAAI;QACf,OAAO,IAAI,CAAC,KAAK,KAAK,QAAQ,CAC/B,CAAC;AACJ,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,iBAAiB,CAAC,IAAa;IAC7C,OAAO,CACL,OAAO,IAAI,KAAK,QAAQ;QACxB,IAAI,KAAK,IAAI;QACb,MAAM,IAAI,IAAI;QACd,IAAI,CAAC,IAAI,KAAK,gBAAgB;QAC9B,OAAO,IAAI,IAAI;QACf,OAAO,IAAI,CAAC,KAAK,KAAK,QAAQ,CAC/B,CAAC;AACJ,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,aAAa,CAAC,IAAa;IACzC,OAAO,CACL,OAAO,IAAI,KAAK,QAAQ;QACxB,IAAI,KAAK,IAAI;QACb,MAAM,IAAI,IAAI;QACd,IAAI,CAAC,IAAI,KAAK,YAAY;QAC1B,OAAO,IAAI,IAAI;QACf,OAAO,IAAI,CAAC,KAAK,KAAK,QAAQ,CAC/B,CAAC;AACJ,CAAC;AAED,+EAA+E;AAC/E,sBAAsB;AACtB,+EAA+E;AAE/E;;GAEG;AACH,MAAM,UAAU,WAAW,CAAC,IAAa;IACvC,OAAO,CACL,WAAW,CAAC,IAAI,CAAC;QACjB,eAAe,CAAC,IAAI,CAAC;QACrB,gBAAgB,CAAC,IAAI,CAAC;QACtB,WAAW,CAAC,IAAI,CAAC;QACjB,kBAAkB,CAAC,IAAI,CAAC;QACxB,aAAa,CAAC,IAAI,CAAC;QACnB,iBAAiB,CAAC,IAAI,CAAC;QACvB,aAAa,CAAC,IAAI,CAAC;QACnB,WAAW,CAAC,IAAI,CAAC,CAClB,CAAC;AACJ,CAAC;AAED,+EAA+E;AAC/E,uBAAuB;AACvB,+EAA+E;AAE/E;;GAEG;AACH,MAAM,UAAU,eAAe,CAAC,IAAa;IAC3C,OAAO,WAAW,CAAC,IAAI,CAAC,CAAC;AAC3B,CAAC;AAED,+EAA+E;AAC/E,oBAAoB;AACpB,+EAA+E;AAE/E;;GAEG;AACH,MAAM,UAAU,gBAAgB,CAAC,KAAgB;IAC/C,OAAO,KAAK,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC;AAClC,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,oBAAoB,CAAC,KAAgB;IACnD,OAAO,KAAK,CAAC,KAAK,CAAC,eAAe,CAAC,CAAC;AACtC,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,qBAAqB,CAAC,KAAgB;IACpD,OAAO,KAAK,CAAC,KAAK,CAAC,gBAAgB,CAAC,CAAC;AACvC,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,mBAAmB,CAAC,KAAgB;IAClD,OAAO,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,CACxB,WAAW,CAAC,IAAI,CAAC;QACjB,eAAe,CAAC,IAAI,CAAC;QACrB,gBAAgB,CAAC,IAAI,CAAC;QACtB,WAAW,CAAC,IAAI,CAAC;QACjB,kBAAkB,CAAC,IAAI,CAAC;QACxB,aAAa,CAAC,IAAI,CAAC;QACnB,iBAAiB,CAAC,IAAI,CAAC;QACvB,aAAa,CAAC,IAAI,CAAC,CACpB,CAAC;AACJ,CAAC;AAED,+EAA+E;AAC/E,sBAAsB;AACtB,+EAA+E;AAE/E;;GAEG;AACH,MAAM,UAAU,WAAW,CAAC,IAAa;IACvC,OAAO,CACL,OAAO,IAAI,KAAK,QAAQ;QACxB,IAAI,KAAK,IAAI;QACb,UAAU,IAAI,IAAI;QAClB,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,CAC7B,CAAC;AACJ,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,WAAW,CAAC,IAAa;IACvC,OAAO,CACL,OAAO,IAAI,KAAK,QAAQ;QACxB,IAAI,KAAK,IAAI;QACb,UAAU,IAAI,IAAI;QAClB,OAAO,IAAI,CAAC,QAAQ,KAAK,QAAQ;QACjC,IAAI,CAAC,QAAQ,KAAK,IAAI,CACvB,CAAC;AACJ,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,gBAAgB,CAAC,IAAa;IAC5C,OAAO,CACL,OAAO,IAAI,KAAK,QAAQ;QACxB,IAAI,KAAK,IAAI;QACb,eAAe,IAAI,IAAI;QACvB,OAAO,IAAI,CAAC,aAAa,KAAK,QAAQ;QACtC,IAAI,CAAC,aAAa,KAAK,IAAI,CAC5B,CAAC;AACJ,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,SAAS,CAAC,IAAa;IACrC,OAAO,CACL,OAAO,IAAI,KAAK,QAAQ;QACxB,IAAI,KAAK,IAAI;QACb,QAAQ,IAAI,IAAI;QAChB,OAAO,IAAI,CAAC,MAAM,KAAK,QAAQ;QAC/B,IAAI,CAAC,MAAM,KAAK,IAAI,CACrB,CAAC;AACJ,CAAC;AAED,+EAA+E;AAC/E,qBAAqB;AACrB,+EAA+E;AAE/E;;;GAGG;AACH,MAAM,UAAU,4BAA4B,CAAC,IAAa;IACxD,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,EAAE,CAAC;QACvB,OAAO,KAAK,CAAC;IACf,CAAC;IAED,gDAAgD;IAChD,IAAI,WAAW,CAAC,IAAI,CAAC,EAAE,CAAC;QACtB,OAAQ,IAAI,CAAC,QAAsB,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC;IACzD,CAAC;IAED,OAAO,IAAI,CAAC;AACd,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,qBAAqB,CAAC,KAAgB;IACpD,OAAO,KAAK,CAAC,KAAK,CAAC,4BAA4B,CAAC,CAAC;AACnD,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,UAAU,CAAC,IAAe;IACxC,OAAO,CACL,WAAW,CAAC,IAAI,CAAC;QACjB,kBAAkB,CAAC,IAAI,CAAC;QACxB,aAAa,CAAC,IAAI,CAAC;QACnB,iBAAiB,CAAC,IAAI,CAAC;QACvB,aAAa,CAAC,IAAI,CAAC,CACpB,CAAC;AACJ,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,eAAe,CAAC,IAAe;IAC7C,OAAO,CACL,WAAW,CAAC,IAAI,CAAC;QACjB,eAAe,CAAC,IAAI,CAAC;QACrB,gBAAgB,CAAC,IAAI,CAAC;QACtB,WAAW,CAAC,IAAI,CAAC,CAClB,CAAC;AACJ,CAAC"}

package/dist/index.d.ts

@@ -0,0 +1,9 @@
+export * from "./types.js";
+export * from "./nodes.js";
+export * from "./utils.js";
+export * from "./validators.js";
+export * from "./guards.js";
+export * from "./errors.js";
+export type { ParagraphLike } from "./utils.js";
+export { getAllWords, getAllSentences, getAllParagraphs, getAllClauses, getAllPhrases, getAllSyllables, getAllCharacters, getWordsFromDocument, getFirstSentence, getWordsFromSentence, getWordsFromParagraph, findNodesByType, findWordsByLanguage, findWordsByTranscriptionSystem, isGLOSTWord, isGLOSTSentence, isGLOSTParagraph, isGLOSTRoot, isGLOSTClause, isGLOSTPhrase, isGLOSTSyllable, isGLOSTCharacter, getWordText, getWordTranscription, hasWordTranscription, getWordTranslation, getWordMeaning, getWordPartOfSpeech, getWordDifficulty, getSentenceTranslation, getGLOSTWordCount, adaptParagraphLikeToGLOST, parseLanguageTag, getBaseLanguage, areLanguagesCompatible, findBestLanguageMatch, getLanguageFallback, normalizeLanguageTag, isValidLanguageTag, } from "./utils.js";
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAGA,cAAc,YAAY,CAAC;AAC3B,cAAc,YAAY,CAAC;AAC3B,cAAc,YAAY,CAAC;AAC3B,cAAc,iBAAiB,CAAC;AAChC,cAAc,aAAa,CAAC;AAC5B,cAAc,aAAa,CAAC;AAI5B,YAAY,EAAE,aAAa,EAAE,MAAM,YAAY,CAAC;AAGhD,OAAO,EAEL,WAAW,EACX,eAAe,EACf,gBAAgB,EAChB,aAAa,EACb,aAAa,EACb,eAAe,EACf,gBAAgB,EAChB,oBAAoB,EACpB,gBAAgB,EAChB,oBAAoB,EACpB,qBAAqB,EAGrB,eAAe,EACf,mBAAmB,EACnB,8BAA8B,EAG9B,WAAW,EACX,eAAe,EACf,gBAAgB,EAChB,WAAW,EACX,aAAa,EACb,aAAa,EACb,eAAe,EACf,gBAAgB,EAGhB,WAAW,EACX,oBAAoB,EACpB,oBAAoB,EACpB,kBAAkB,EAClB,cAAc,EACd,mBAAmB,EACnB,iBAAiB,EAGjB,sBAAsB,EAGtB,iBAAiB,EACjB,yBAAyB,EAGzB,gBAAgB,EAChB,eAAe,EACf,sBAAsB,EACtB,qBAAqB,EACrB,mBAAmB,EACnB,oBAAoB,EACpB,kBAAkB,GACnB,MAAM,YAAY,CAAC"}

package/dist/index.js

@@ -0,0 +1,25 @@
+// GLOST - Glossed Syntax Tree
+// Extends nlcst for language learning with annotations
+export * from "./types.js";
+export * from "./nodes.js";
+export * from "./utils.js";
+export * from "./validators.js";
+export * from "./guards.js";
+export * from "./errors.js";
+// Re-export key utilities for transcription components
+export { 
+// Tree traversal
+getAllWords, getAllSentences, getAllParagraphs, getAllClauses, getAllPhrases, getAllSyllables, getAllCharacters, getWordsFromDocument, getFirstSentence, getWordsFromSentence, getWordsFromParagraph, 
+// Node finding
+findNodesByType, findWordsByLanguage, findWordsByTranscriptionSystem, 
+// Type guards (most are now exported via guards.ts)
+isGLOSTWord, isGLOSTSentence, isGLOSTParagraph, isGLOSTRoot, isGLOSTClause, isGLOSTPhrase, isGLOSTSyllable, isGLOSTCharacter, 
+// Word utilities
+getWordText, getWordTranscription, hasWordTranscription, getWordTranslation, getWordMeaning, getWordPartOfSpeech, getWordDifficulty, 
+// Sentence utilities
+getSentenceTranslation, 
+// Content statistics utilities
+getGLOSTWordCount, adaptParagraphLikeToGLOST, 
+// BCP-47 Language utilities
+parseLanguageTag, getBaseLanguage, areLanguagesCompatible, findBestLanguageMatch, getLanguageFallback, normalizeLanguageTag, isValidLanguageTag, } from "./utils.js";
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,8BAA8B;AAC9B,uDAAuD;AAEvD,cAAc,YAAY,CAAC;AAC3B,cAAc,YAAY,CAAC;AAC3B,cAAc,YAAY,CAAC;AAC3B,cAAc,iBAAiB,CAAC;AAChC,cAAc,aAAa,CAAC;AAC5B,cAAc,aAAa,CAAC;AAM5B,uDAAuD;AACvD,OAAO;AACL,iBAAiB;AACjB,WAAW,EACX,eAAe,EACf,gBAAgB,EAChB,aAAa,EACb,aAAa,EACb,eAAe,EACf,gBAAgB,EAChB,oBAAoB,EACpB,gBAAgB,EAChB,oBAAoB,EACpB,qBAAqB;AAErB,eAAe;AACf,eAAe,EACf,mBAAmB,EACnB,8BAA8B;AAE9B,oDAAoD;AACpD,WAAW,EACX,eAAe,EACf,gBAAgB,EAChB,WAAW,EACX,aAAa,EACb,aAAa,EACb,eAAe,EACf,gBAAgB;AAEhB,iBAAiB;AACjB,WAAW,EACX,oBAAoB,EACpB,oBAAoB,EACpB,kBAAkB,EAClB,cAAc,EACd,mBAAmB,EACnB,iBAAiB;AAEjB,qBAAqB;AACrB,sBAAsB;AAEtB,+BAA+B;AAC/B,iBAAiB,EACjB,yBAAyB;AAEzB,4BAA4B;AAC5B,gBAAgB,EAChB,eAAe,EACf,sBAAsB,EACtB,qBAAqB,EACrB,mBAAmB,EACnB,oBAAoB,EACpB,kBAAkB,GACnB,MAAM,YAAY,CAAC"}

package/dist/nodes.d.ts

@@ -0,0 +1,227 @@
+import type { LanguageCode, LinguisticMetadata, GLOSTExtras, GLOSTParagraph, GLOSTPunctuation, GLOSTRoot, GLOSTSentence, GLOSTSymbol, GLOSTText, GLOSTWhiteSpace, GLOSTWord, ScriptSystem, TransliterationData } from "./types.js";
+/**
+ * Options for creating a GLOST word node
+ */
+export interface CreateWordNodeOptions {
+    /** The text value of the word */
+    value: string;
+    /** Transcription data (IPA, romanization, etc.) - optional */
+    transcription?: TransliterationData;
+    /** Linguistic metadata (part of speech, etc.) - optional */
+    metadata?: LinguisticMetadata;
+    /** Language code (ISO-639-1, ISO-639-3, or BCP-47) */
+    lang?: LanguageCode;
+    /** Script system used */
+    script?: ScriptSystem;
+    /** Additional extension data */
+    extras?: GLOSTExtras;
+}
+/**
+ * Options for creating a GLOST sentence node
+ */
+export interface CreateSentenceNodeOptions {
+    /** The original text of the sentence */
+    originalText: string;
+    /** Language code */
+    lang: LanguageCode;
+    /** Script system used */
+    script: ScriptSystem;
+    /** Word nodes in the sentence */
+    children?: GLOSTWord[];
+    /** Optional transcription data */
+    transcription?: TransliterationData;
+    /** Additional extension data */
+    extras?: GLOSTExtras;
+}
+/**
+ * Options for creating a GLOST root node
+ */
+export interface CreateRootNodeOptions {
+    /** Language code */
+    lang: LanguageCode;
+    /** Script system used */
+    script: ScriptSystem;
+    /** Paragraph nodes */
+    children?: GLOSTParagraph[];
+    /** Document metadata */
+    metadata?: {
+        title?: string;
+        author?: string;
+        date?: string;
+        description?: string;
+    };
+    /** Additional extension data */
+    extras?: GLOSTExtras;
+}
+/**
+ * Options for creating a simple word node
+ */
+export interface CreateSimpleWordOptions {
+    /** The text value of the word */
+    text: string;
+    /** Transliteration text */
+    transliteration: string;
+    /** Transcription system (default: "ipa") */
+    system?: string;
+    /** Part of speech (default: "unknown") */
+    partOfSpeech?: string;
+}
+/**
+ * Create a GLOST word node
+ *
+ * @example
+ * ```typescript
+ * const word = createGLOSTWordNode({
+ *   value: "hello",
+ *   transcription: { ipa: { text: "həˈloʊ", system: "ipa" } },
+ *   metadata: { partOfSpeech: "interjection" },
+ *   lang: "en",
+ *   script: "latin"
+ * });
+ * ```
+ */
+export declare function createGLOSTWordNode(options: CreateWordNodeOptions): GLOSTWord;
+/**
+ * Create a GLOST sentence node
+ *
+ * @example
+ * ```typescript
+ * const sentence = createGLOSTSentenceNode({
+ *   originalText: "Hello world",
+ *   lang: "en",
+ *   script: "latin",
+ *   children: [wordNode1, wordNode2]
+ * });
+ * ```
+ */
+export declare function createGLOSTSentenceNode(options: CreateSentenceNodeOptions): GLOSTSentence;
+/**
+ * Create a GLOST paragraph node
+ */
+export declare function createGLOSTParagraphNode(children?: GLOSTSentence[], extras?: GLOSTExtras): GLOSTParagraph;
+/**
+ * Create a GLOST root node
+ *
+ * @example
+ * ```typescript
+ * const root = createGLOSTRootNode({
+ *   lang: "en",
+ *   script: "latin",
+ *   children: [paragraphNode],
+ *   metadata: { title: "My Document" }
+ * });
+ * ```
+ */
+export declare function createGLOSTRootNode(options: CreateRootNodeOptions): GLOSTRoot;
+/**
+ * Create a simple word node with basic transcription
+ *
+ * @example
+ * ```typescript
+ * const word = createSimpleWord({
+ *   text: "hello",
+ *   transliteration: "həˈloʊ",
+ *   system: "ipa",
+ *   partOfSpeech: "interjection"
+ * });
+ * ```
+ */
+export declare function createSimpleWord(options: CreateSimpleWordOptions): GLOSTWord;
+/**
+ * Create a sentence from an array of words
+ */
+export declare function createSentenceFromWords(words: GLOSTWord[], lang: LanguageCode, script: ScriptSystem, originalText?: string): GLOSTSentence;
+/**
+ * Create a paragraph from an array of sentences
+ */
+export declare function createParagraphFromSentences(sentences: GLOSTSentence[]): GLOSTParagraph;
+/**
+ * Create a document from an array of paragraphs
+ */
+export declare function createDocumentFromParagraphs(paragraphs: GLOSTParagraph[], lang: LanguageCode, script: ScriptSystem, metadata?: {
+    title?: string;
+    author?: string;
+    date?: string;
+    description?: string;
+}): GLOSTRoot;
+/**
+ * Create a document from an array of sentences (simplified helper)
+ *
+ * Automatically wraps sentences in a paragraph for convenience.
+ * Useful when you don't need explicit paragraph structure.
+ *
+ * @param sentences - Array of sentences
+ * @param lang - Language code
+ * @param script - Script system (optional, will be inferred from lang if not provided)
+ * @param metadata - Optional document metadata
+ * @returns GLOST root document
+ *
+ * @example
+ * ```typescript
+ * const sentences = [
+ *   createSentenceFromWords([word1, word2], "th", "thai", "สวัสดี"),
+ *   createSentenceFromWords([word3, word4], "th", "thai", "ขอบคุณ")
+ * ];
+ * const doc = createDocumentFromSentences(sentences, "th", "thai");
+ * ```
+ */
+export declare function createDocumentFromSentences(sentences: GLOSTSentence[], lang: LanguageCode, script: ScriptSystem, metadata?: {
+    title?: string;
+    author?: string;
+    date?: string;
+    description?: string;
+}): GLOSTRoot;
+/**
+ * Create a simple document from an array of words (simplified helper)
+ *
+ * Automatically creates sentence and paragraph wrappers for maximum convenience.
+ * Perfect for testing, quick prototypes, and simple use cases.
+ *
+ * @param words - Array of word nodes
+ * @param lang - Language code
+ * @param script - Script system (optional, will be inferred from lang if not provided)
+ * @param options - Optional configuration
+ * @param options.sentenceText - Original text of the sentence (will be auto-generated if not provided)
+ * @param options.metadata - Optional document metadata
+ * @returns GLOST root document
+ *
+ * @example
+ * ```typescript
+ * import { createSimpleDocument } from "glost";
+ * import { createThaiWord } from "glost-th";
+ *
+ * const words = [
+ *   createThaiWord({ text: "สวัสดี" }),
+ *   createThaiWord({ text: "ครับ" })
+ * ];
+ * const doc = createSimpleDocument(words, "th", "thai", {
+ *   sentenceText: "สวัสดีครับ"
+ * });
+ * ```
+ */
+export declare function createSimpleDocument(words: GLOSTWord[], lang: LanguageCode, script: ScriptSystem, options?: {
+    sentenceText?: string;
+    metadata?: {
+        title?: string;
+        author?: string;
+        date?: string;
+        description?: string;
+    };
+}): GLOSTRoot;
+/**
+ * Create a GLOST punctuation node
+ */
+export declare function createGLOSTPunctuationNode(value: string): GLOSTPunctuation;
+/**
+ * Create a GLOST whitespace node
+ */
+export declare function createGLOSTWhiteSpaceNode(value: string): GLOSTWhiteSpace;
+/**
+ * Create a GLOST symbol node
+ */
+export declare function createGLOSTSymbolNode(value: string): GLOSTSymbol;
+/**
+ * Create a GLOST text node
+ */
+export declare function createGLOSTTextNode(value: string): GLOSTText;
+//# sourceMappingURL=nodes.d.ts.map

package/dist/nodes.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"nodes.d.ts","sourceRoot":"","sources":["../src/nodes.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,YAAY,EACZ,kBAAkB,EAClB,WAAW,EACX,cAAc,EACd,gBAAgB,EAChB,SAAS,EACT,aAAa,EACb,WAAW,EACX,SAAS,EACT,eAAe,EACf,SAAS,EACT,YAAY,EACZ,mBAAmB,EACpB,MAAM,YAAY,CAAC;AAMpB;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC,iCAAiC;IACjC,KAAK,EAAE,MAAM,CAAC;IACd,8DAA8D;IAC9D,aAAa,CAAC,EAAE,mBAAmB,CAAC;IACpC,4DAA4D;IAC5D,QAAQ,CAAC,EAAE,kBAAkB,CAAC;IAC9B,sDAAsD;IACtD,IAAI,CAAC,EAAE,YAAY,CAAC;IACpB,yBAAyB;IACzB,MAAM,CAAC,EAAE,YAAY,CAAC;IACtB,gCAAgC;IAChC,MAAM,CAAC,EAAE,WAAW,CAAC;CACtB;AAED;;GAEG;AACH,MAAM,WAAW,yBAAyB;IACxC,wCAAwC;IACxC,YAAY,EAAE,MAAM,CAAC;IACrB,oBAAoB;IACpB,IAAI,EAAE,YAAY,CAAC;IACnB,yBAAyB;IACzB,MAAM,EAAE,YAAY,CAAC;IACrB,iCAAiC;IACjC,QAAQ,CAAC,EAAE,SAAS,EAAE,CAAC;IACvB,kCAAkC;IAClC,aAAa,CAAC,EAAE,mBAAmB,CAAC;IACpC,gCAAgC;IAChC,MAAM,CAAC,EAAE,WAAW,CAAC;CACtB;AAED;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC,oBAAoB;IACpB,IAAI,EAAE,YAAY,CAAC;IACnB,yBAAyB;IACzB,MAAM,EAAE,YAAY,CAAC;IACrB,sBAAsB;IACtB,QAAQ,CAAC,EAAE,cAAc,EAAE,CAAC;IAC5B,wBAAwB;IACxB,QAAQ,CAAC,EAAE;QACT,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,WAAW,CAAC,EAAE,MAAM,CAAC;KACtB,CAAC;IACF,gCAAgC;IAChC,MAAM,CAAC,EAAE,WAAW,CAAC;CACtB;AAED;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACtC,iCAAiC;IACjC,IAAI,EAAE,MAAM,CAAC;IACb,2BAA2B;IAC3B,eAAe,EAAE,MAAM,CAAC;IACxB,4CAA4C;IAC5C,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,0CAA0C;IAC1C,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAOD;;;;;;;;;;;;;GAaG;AACH,wBAAgB,mBAAmB,CAAC,OAAO,EAAE,qBAAqB,GAAG,SAAS,CAW7E;AAED;;;;;;;;;;;;GAYG;AACH,wBAAgB,uBAAuB,CACrC,OAAO,EAAE,yBAAyB,GACjC,aAAa,CAkBf;AAED;;GAEG;AACH,wBAAgB,wBAAwB,CACtC,QAAQ,GAAE,aAAa,EAAO,EAC9B,MAAM,CAAC,EAAE,WAAW,GACnB,cAAc,CAOhB;AAED;;;;;;;;;;;;GAYG;AACH,wBAAgB,mBAAmB,CAAC,OAAO,EAAE,qBAAqB,GAAG,SAAS,CAW7E;AAMD;;;;;;;;;;;;GAYG;AACH,wBAAgB,gBAAgB,CAAC,OAAO,EAAE,uBAAuB,GAAG,SAAS,CAe5E;AAGD;;GAEG;AACH,wBAAgB,uBAAuB,CACrC,KAAK,EAAE,SAAS,EAAE,EAClB,IAAI,EAAE,YAAY,EAClB,MAAM,EAAE,YAAY,EACpB,YAAY,CAAC,EAAE,MAAM,GACpB,aAAa,CAaf;AAED;;GAEG;AACH,wBAAgB,4BAA4B,CAC1C,SAAS,EAAE,aAAa,EAAE,GACzB,cAAc,CAEhB;AAED;;GAEG;AACH,wBAAgB,4BAA4B,CAC1C,UAAU,EAAE,cAAc,EAAE,EAC5B,IAAI,EAAE,YAAY,EAClB,MAAM,EAAE,YAAY,EACpB,QAAQ,CAAC,EAAE;IACT,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB,GACA,SAAS,CAEX;AAED;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,wBAAgB,2BAA2B,CACzC,SAAS,EAAE,aAAa,EAAE,EAC1B,IAAI,EAAE,YAAY,EAClB,MAAM,EAAE,YAAY,EACpB,QAAQ,CAAC,EAAE;IACT,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB,GACA,SAAS,CAGX;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,wBAAgB,oBAAoB,CAClC,KAAK,EAAE,SAAS,EAAE,EAClB,IAAI,EAAE,YAAY,EAClB,MAAM,EAAE,YAAY,EACpB,OAAO,CAAC,EAAE;IACR,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,EAAE;QACT,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,WAAW,CAAC,EAAE,MAAM,CAAC;KACtB,CAAC;CACH,GACA,SAAS,CAIX;AAMD;;GAEG;AACH,wBAAgB,0BAA0B,CAAC,KAAK,EAAE,MAAM,GAAG,gBAAgB,CAK1E;AAED;;GAEG;AACH,wBAAgB,yBAAyB,CAAC,KAAK,EAAE,MAAM,GAAG,eAAe,CAKxE;AAED;;GAEG;AACH,wBAAgB,qBAAqB,CAAC,KAAK,EAAE,MAAM,GAAG,WAAW,CAKhE;AAED;;GAEG;AACH,wBAAgB,mBAAmB,CAAC,KAAK,EAAE,MAAM,GAAG,SAAS,CAK5D"}

package/dist/nodes.js

@@ -0,0 +1,243 @@
+// ============================================================================
+// Node Factory Functions
+// ============================================================================
+/**
+ * Create a GLOST word node
+ *
+ * @example
+ * ```typescript
+ * const word = createGLOSTWordNode({
+ *   value: "hello",
+ *   transcription: { ipa: { text: "həˈloʊ", system: "ipa" } },
+ *   metadata: { partOfSpeech: "interjection" },
+ *   lang: "en",
+ *   script: "latin"
+ * });
+ * ```
+ */
+export function createGLOSTWordNode(options) {
+    const { value, transcription, metadata, lang, script, extras } = options;
+    return {
+        type: "WordNode",
+        lang,
+        script,
+        transcription,
+        metadata,
+        extras,
+        children: [createGLOSTTextNode(value)],
+    };
+}
+/**
+ * Create a GLOST sentence node
+ *
+ * @example
+ * ```typescript
+ * const sentence = createGLOSTSentenceNode({
+ *   originalText: "Hello world",
+ *   lang: "en",
+ *   script: "latin",
+ *   children: [wordNode1, wordNode2]
+ * });
+ * ```
+ */
+export function createGLOSTSentenceNode(options) {
+    const { originalText, lang, script, children = [], transcription, extras, } = options;
+    return {
+        type: "SentenceNode",
+        originalText,
+        lang,
+        script,
+        transcription,
+        children,
+        extras,
+    };
+}
+/**
+ * Create a GLOST paragraph node
+ */
+export function createGLOSTParagraphNode(children = [], extras) {
+    return {
+        type: "ParagraphNode",
+        children,
+        position: undefined,
+        extras,
+    };
+}
+/**
+ * Create a GLOST root node
+ *
+ * @example
+ * ```typescript
+ * const root = createGLOSTRootNode({
+ *   lang: "en",
+ *   script: "latin",
+ *   children: [paragraphNode],
+ *   metadata: { title: "My Document" }
+ * });
+ * ```
+ */
+export function createGLOSTRootNode(options) {
+    const { lang, script, children = [], metadata, extras } = options;
+    return {
+        type: "RootNode",
+        lang,
+        script,
+        metadata,
+        children,
+        position: undefined,
+        extras,
+    };
+}
+// ============================================================================
+// Helper Functions for Common Patterns
+// ============================================================================
+/**
+ * Create a simple word node with basic transcription
+ *
+ * @example
+ * ```typescript
+ * const word = createSimpleWord({
+ *   text: "hello",
+ *   transliteration: "həˈloʊ",
+ *   system: "ipa",
+ *   partOfSpeech: "interjection"
+ * });
+ * ```
+ */
+export function createSimpleWord(options) {
+    const { text, transliteration, system = "ipa", partOfSpeech = "unknown" } = options;
+    const transcription = {
+        [system]: {
+            text: transliteration,
+            syllables: [text],
+        },
+    };
+    const metadata = {
+        partOfSpeech,
+    };
+    return createGLOSTWordNode({ value: text, transcription, metadata });
+}
+/**
+ * Create a sentence from an array of words
+ */
+export function createSentenceFromWords(words, lang, script, originalText) {
+    const text = originalText ||
+        words
+            .map((w) => {
+            // Extract text from word's Text node children
+            const textNode = w.children.find((child) => child.type === "TextNode");
+            return textNode ? textNode.value : "";
+        })
+            .join("");
+    return createGLOSTSentenceNode({ originalText: text, lang, script, children: words });
+}
+/**
+ * Create a paragraph from an array of sentences
+ */
+export function createParagraphFromSentences(sentences) {
+    return createGLOSTParagraphNode(sentences);
+}
+/**
+ * Create a document from an array of paragraphs
+ */
+export function createDocumentFromParagraphs(paragraphs, lang, script, metadata) {
+    return createGLOSTRootNode({ lang, script, children: paragraphs, metadata });
+}
+/**
+ * Create a document from an array of sentences (simplified helper)
+ *
+ * Automatically wraps sentences in a paragraph for convenience.
+ * Useful when you don't need explicit paragraph structure.
+ *
+ * @param sentences - Array of sentences
+ * @param lang - Language code
+ * @param script - Script system (optional, will be inferred from lang if not provided)
+ * @param metadata - Optional document metadata
+ * @returns GLOST root document
+ *
+ * @example
+ * ```typescript
+ * const sentences = [
+ *   createSentenceFromWords([word1, word2], "th", "thai", "สวัสดี"),
+ *   createSentenceFromWords([word3, word4], "th", "thai", "ขอบคุณ")
+ * ];
+ * const doc = createDocumentFromSentences(sentences, "th", "thai");
+ * ```
+ */
+export function createDocumentFromSentences(sentences, lang, script, metadata) {
+    const paragraph = createParagraphFromSentences(sentences);
+    return createDocumentFromParagraphs([paragraph], lang, script, metadata);
+}
+/**
+ * Create a simple document from an array of words (simplified helper)
+ *
+ * Automatically creates sentence and paragraph wrappers for maximum convenience.
+ * Perfect for testing, quick prototypes, and simple use cases.
+ *
+ * @param words - Array of word nodes
+ * @param lang - Language code
+ * @param script - Script system (optional, will be inferred from lang if not provided)
+ * @param options - Optional configuration
+ * @param options.sentenceText - Original text of the sentence (will be auto-generated if not provided)
+ * @param options.metadata - Optional document metadata
+ * @returns GLOST root document
+ *
+ * @example
+ * ```typescript
+ * import { createSimpleDocument } from "glost";
+ * import { createThaiWord } from "glost-th";
+ *
+ * const words = [
+ *   createThaiWord({ text: "สวัสดี" }),
+ *   createThaiWord({ text: "ครับ" })
+ * ];
+ * const doc = createSimpleDocument(words, "th", "thai", {
+ *   sentenceText: "สวัสดีครับ"
+ * });
+ * ```
+ */
+export function createSimpleDocument(words, lang, script, options) {
+    const sentence = createSentenceFromWords(words, lang, script, options?.sentenceText);
+    const paragraph = createParagraphFromSentences([sentence]);
+    return createDocumentFromParagraphs([paragraph], lang, script, options?.metadata);
+}
+// ============================================================================
+// NLCST Node Factory Functions
+// ============================================================================
+/**
+ * Create a GLOST punctuation node
+ */
+export function createGLOSTPunctuationNode(value) {
+    return {
+        type: "PunctuationNode",
+        value,
+    };
+}
+/**
+ * Create a GLOST whitespace node
+ */
+export function createGLOSTWhiteSpaceNode(value) {
+    return {
+        type: "WhiteSpaceNode",
+        value,
+    };
+}
+/**
+ * Create a GLOST symbol node
+ */
+export function createGLOSTSymbolNode(value) {
+    return {
+        type: "SymbolNode",
+        value,
+    };
+}
+/**
+ * Create a GLOST text node
+ */
+export function createGLOSTTextNode(value) {
+    return {
+        type: "TextNode",
+        value,
+    };
+}
+//# sourceMappingURL=nodes.js.map

package/dist/nodes.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"nodes.js","sourceRoot":"","sources":["../src/nodes.ts"],"names":[],"mappings":"AA4FA,+EAA+E;AAC/E,yBAAyB;AACzB,+EAA+E;AAE/E;;;;;;;;;;;;;GAaG;AACH,MAAM,UAAU,mBAAmB,CAAC,OAA8B;IAChE,MAAM,EAAE,KAAK,EAAE,aAAa,EAAE,QAAQ,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC;IACzE,OAAO;QACL,IAAI,EAAE,UAAU;QAChB,IAAI;QACJ,MAAM;QACN,aAAa;QACb,QAAQ;QACR,MAAM;QACN,QAAQ,EAAE,CAAC,mBAAmB,CAAC,KAAK,CAAC,CAAC;KACvC,CAAC;AACJ,CAAC;AAED;;;;;;;;;;;;GAYG;AACH,MAAM,UAAU,uBAAuB,CACrC,OAAkC;IAElC,MAAM,EACJ,YAAY,EACZ,IAAI,EACJ,MAAM,EACN,QAAQ,GAAG,EAAE,EACb,aAAa,EACb,MAAM,GACP,GAAG,OAAO,CAAC;IACZ,OAAO;QACL,IAAI,EAAE,cAAc;QACpB,YAAY;QACZ,IAAI;QACJ,MAAM;QACN,aAAa;QACb,QAAQ;QACR,MAAM;KACP,CAAC;AACJ,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,wBAAwB,CACtC,WAA4B,EAAE,EAC9B,MAAoB;IAEpB,OAAO;QACL,IAAI,EAAE,eAAe;QACrB,QAAQ;QACR,QAAQ,EAAE,SAAS;QACnB,MAAM;KACP,CAAC;AACJ,CAAC;AAED;;;;;;;;;;;;GAYG;AACH,MAAM,UAAU,mBAAmB,CAAC,OAA8B;IAChE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,QAAQ,GAAG,EAAE,EAAE,QAAQ,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC;IAClE,OAAO;QACL,IAAI,EAAE,UAAU;QAChB,IAAI;QACJ,MAAM;QACN,QAAQ;QACR,QAAQ;QACR,QAAQ,EAAE,SAAS;QACnB,MAAM;KACP,CAAC;AACJ,CAAC;AAED,+EAA+E;AAC/E,uCAAuC;AACvC,+EAA+E;AAE/E;;;;;;;;;;;;GAYG;AACH,MAAM,UAAU,gBAAgB,CAAC,OAAgC;IAC/D,MAAM,EAAE,IAAI,EAAE,eAAe,EAAE,MAAM,GAAG,KAAK,EAAE,YAAY,GAAG,SAAS,EAAE,GAAG,OAAO,CAAC;IAEpF,MAAM,aAAa,GAAwB;QACzC,CAAC,MAAM,CAAC,EAAE;YACR,IAAI,EAAE,eAAe;YACrB,SAAS,EAAE,CAAC,IAAI,CAAC;SAClB;KACF,CAAC;IAEF,MAAM,QAAQ,GAAuB;QACnC,YAAY;KACb,CAAC;IAEF,OAAO,mBAAmB,CAAC,EAAE,KAAK,EAAE,IAAI,EAAE,aAAa,EAAE,QAAQ,EAAE,CAAC,CAAC;AACvE,CAAC;AAGD;;GAEG;AACH,MAAM,UAAU,uBAAuB,CACrC,KAAkB,EAClB,IAAkB,EAClB,MAAoB,EACpB,YAAqB;IAErB,MAAM,IAAI,GACR,YAAY;QACZ,KAAK;aACF,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE;YACT,8CAA8C;YAC9C,MAAM,QAAQ,GAAG,CAAC,CAAC,QAAQ,CAAC,IAAI,CAC9B,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,IAAI,KAAK,UAAU,CACxB,CAAC;YACf,OAAO,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC;QACxC,CAAC,CAAC;aACD,IAAI,CAAC,EAAE,CAAC,CAAC;IACd,OAAO,uBAAuB,CAAC,EAAE,YAAY,EAAE,IAAI,EAAE,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,KAAK,EAAE,CAAC,CAAC;AACxF,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,4BAA4B,CAC1C,SAA0B;IAE1B,OAAO,wBAAwB,CAAC,SAAS,CAAC,CAAC;AAC7C,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,4BAA4B,CAC1C,UAA4B,EAC5B,IAAkB,EAClB,MAAoB,EACpB,QAKC;IAED,OAAO,mBAAmB,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,UAAU,EAAE,QAAQ,EAAE,CAAC,CAAC;AAC/E,CAAC;AAED;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,MAAM,UAAU,2BAA2B,CACzC,SAA0B,EAC1B,IAAkB,EAClB,MAAoB,EACpB,QAKC;IAED,MAAM,SAAS,GAAG,4BAA4B,CAAC,SAAS,CAAC,CAAC;IAC1D,OAAO,4BAA4B,CAAC,CAAC,SAAS,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,QAAQ,CAAC,CAAC;AAC3E,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,MAAM,UAAU,oBAAoB,CAClC,KAAkB,EAClB,IAAkB,EAClB,MAAoB,EACpB,OAQC;IAED,MAAM,QAAQ,GAAG,uBAAuB,CAAC,KAAK,EAAE,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,YAAY,CAAC,CAAC;IACrF,MAAM,SAAS,GAAG,4BAA4B,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC;IAC3D,OAAO,4BAA4B,CAAC,CAAC,SAAS,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,QAAQ,CAAC,CAAC;AACpF,CAAC;AAED,+EAA+E;AAC/E,+BAA+B;AAC/B,+EAA+E;AAE/E;;GAEG;AACH,MAAM,UAAU,0BAA0B,CAAC,KAAa;IACtD,OAAO;QACL,IAAI,EAAE,iBAAiB;QACvB,KAAK;KACN,CAAC;AACJ,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,yBAAyB,CAAC,KAAa;IACrD,OAAO;QACL,IAAI,EAAE,gBAAgB;QACtB,KAAK;KACN,CAAC;AACJ,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,qBAAqB,CAAC,KAAa;IACjD,OAAO;QACL,IAAI,EAAE,YAAY;QAClB,KAAK;KACN,CAAC;AACJ,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,mBAAmB,CAAC,KAAa;IAC/C,OAAO;QACL,IAAI,EAAE,UAAU;QAChB,KAAK;KACN,CAAC;AACJ,CAAC"}