glost 0.1.1 → 0.3.0

package/src/nodes.ts

@@ -1,6 +1,5 @@
 import type {
   LanguageCode,
-  LinguisticLevel,
   LinguisticMetadata,
   GLOSTExtras,
   GLOSTParagraph,
@@ -15,22 +14,102 @@ import type {
   TransliterationData,
 } from "./types";
 
+// ============================================================================
+// Options Interfaces
+// ============================================================================
+
+/**
+ * Options for creating a GLOST word node
+ */
+export interface CreateWordNodeOptions {
+  /** The text value of the word */
+  value: string;
+  /** Transcription data (IPA, romanization, etc.) */
+  transcription: TransliterationData;
+  /** Linguistic metadata (part of speech, etc.) */
+  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;
+}
+
+
 // ============================================================================
 // Node Factory Functions
 // ============================================================================
 
 /**
- * Create an GLOST word node
+ * 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(
-  value: string,
-  transcription: TransliterationData,
-  metadata: LinguisticMetadata,
-  level: LinguisticLevel = "word",
-  lang?: LanguageCode,
-  script?: ScriptSystem,
-  extras?: GLOSTExtras,
-): GLOSTWord {
+export function createGLOSTWordNode(options: CreateWordNodeOptions): GLOSTWord {
+  const { value, transcription, metadata, lang, script, extras } = options;
   return {
     type: "WordNode",
     lang,
@@ -43,16 +122,29 @@ export function createGLOSTWordNode(
 }
 
 /**
- * Create an GLOST sentence node
+ * Create a GLOST sentence node
+ *
+ * @example
+ * ```typescript
+ * const sentence = createGLOSTSentenceNode({
+ *   originalText: "Hello world",
+ *   lang: "en",
+ *   script: "latin",
+ *   children: [wordNode1, wordNode2]
+ * });
+ * ```
  */
 export function createGLOSTSentenceNode(
-  originalText: string,
-  lang: LanguageCode,
-  script: ScriptSystem,
-  children: GLOSTWord[] = [],
-  transcription?: TransliterationData,
-  extras?: GLOSTExtras,
+  options: CreateSentenceNodeOptions,
 ): GLOSTSentence {
+  const {
+    originalText,
+    lang,
+    script,
+    children = [],
+    transcription,
+    extras,
+  } = options;
   return {
     type: "SentenceNode",
     originalText,
@@ -65,7 +157,7 @@ export function createGLOSTSentenceNode(
 }
 
 /**
- * Create an GLOST paragraph node
+ * Create a GLOST paragraph node
  */
 export function createGLOSTParagraphNode(
   children: GLOSTSentence[] = [],
@@ -73,7 +165,6 @@ export function createGLOSTParagraphNode(
 ): GLOSTParagraph {
   return {
     type: "ParagraphNode",
-
     children,
     position: undefined,
     extras,
@@ -81,20 +172,20 @@ export function createGLOSTParagraphNode(
 }
 
 /**
- * Create an GLOST root node
+ * Create a GLOST root node
+ *
+ * @example
+ * ```typescript
+ * const root = createGLOSTRootNode({
+ *   lang: "en",
+ *   script: "latin",
+ *   children: [paragraphNode],
+ *   metadata: { title: "My Document" }
+ * });
+ * ```
  */
-export function createGLOSTRootNode(
-  lang: LanguageCode,
-  script: ScriptSystem,
-  children: GLOSTParagraph[] = [],
-  metadata?: {
-    title?: string;
-    author?: string;
-    date?: string;
-    description?: string;
-  },
-  extras?: GLOSTExtras,
-): GLOSTRoot {
+export function createGLOSTRootNode(options: CreateRootNodeOptions): GLOSTRoot {
+  const { lang, script, children = [], metadata, extras } = options;
   return {
     type: "RootNode",
     lang,
@@ -112,14 +203,20 @@ export function createGLOSTRootNode(
 
 /**
  * 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(
-  text: string,
-  transliteration: string,
-  system: string = "ipa",
-  partOfSpeech: string = "unknown",
-  level: LinguisticLevel = "word",
-): GLOSTWord {
+export function createSimpleWord(options: CreateSimpleWordOptions): GLOSTWord {
+  const { text, transliteration, system = "ipa", partOfSpeech = "unknown" } = options;
+
   const transcription: TransliterationData = {
     [system]: {
       text: transliteration,
@@ -132,80 +229,9 @@ export function createSimpleWord(
     partOfSpeech,
   };
 
-  return createGLOSTWordNode(text, transcription, metadata, level);
-}
-
-/**
- * Create a Thai word node with RTGS transcription
- */
-export function createThaiWord(
-  text: string,
-  rtgs: string,
-  partOfSpeech: string = "unknown",
-  tone?: number,
-  syllables?: string[],
-): GLOSTWord {
-  const transcription: TransliterationData = {
-    rtgs: {
-      text: rtgs,
-      system: "rtgs",
-      tone,
-      syllables: syllables || [text],
-    },
-  };
-
-  const metadata: LinguisticMetadata = {
-    partOfSpeech,
-  };
-
-  return createGLOSTWordNode(
-    text,
-    transcription,
-    metadata,
-    "word",
-    "th",
-    "thai",
-  );
+  return createGLOSTWordNode({ value: text, transcription, metadata });
 }
 
-/**
- * Create a Japanese word node with romaji transcription
- */
-export function createJapaneseWord(
-  text: string,
-  romaji: string,
-  partOfSpeech: string = "unknown",
-  furigana?: string,
-): GLOSTWord {
-  const transcription: TransliterationData = {
-    romaji: {
-      text: romaji,
-      system: "romaji",
-      syllables: [text],
-    },
-  };
-
-  if (furigana) {
-    transcription.furigana = {
-      text: furigana,
-      system: "furigana",
-      syllables: [text],
-    };
-  }
-
-  const metadata: LinguisticMetadata = {
-    partOfSpeech,
-  };
-
-  return createGLOSTWordNode(
-    text,
-    transcription,
-    metadata,
-    "word",
-    "ja",
-    "mixed",
-  );
-}
 
 /**
  * Create a sentence from an array of words
@@ -227,7 +253,7 @@ export function createSentenceFromWords(
         return textNode ? textNode.value : "";
       })
       .join("");
-  return createGLOSTSentenceNode(text, lang, script, words);
+  return createGLOSTSentenceNode({ originalText: text, lang, script, children: words });
 }
 
 /**
@@ -253,7 +279,7 @@ export function createDocumentFromParagraphs(
     description?: string;
   },
 ): GLOSTRoot {
-  return createGLOSTRootNode(lang, script, paragraphs, metadata);
+  return createGLOSTRootNode({ lang, script, children: paragraphs, metadata });
 }
 
 // ============================================================================
@@ -261,7 +287,7 @@ export function createDocumentFromParagraphs(
 // ============================================================================
 
 /**
- * Create an GLOST punctuation node
+ * Create a GLOST punctuation node
  */
 export function createGLOSTPunctuationNode(value: string): GLOSTPunctuation {
   return {
@@ -271,7 +297,7 @@ export function createGLOSTPunctuationNode(value: string): GLOSTPunctuation {
 }
 
 /**
- * Create an GLOST whitespace node
+ * Create a GLOST whitespace node
  */
 export function createGLOSTWhiteSpaceNode(value: string): GLOSTWhiteSpace {
   return {
@@ -281,7 +307,7 @@ export function createGLOSTWhiteSpaceNode(value: string): GLOSTWhiteSpace {
 }
 
 /**
- * Create an GLOST symbol node
+ * Create a GLOST symbol node
  */
 export function createGLOSTSymbolNode(value: string): GLOSTSymbol {
   return {
@@ -291,7 +317,7 @@ export function createGLOSTSymbolNode(value: string): GLOSTSymbol {
 }
 
 /**
- * Create an GLOST text node
+ * Create a GLOST text node
  */
 export function createGLOSTTextNode(value: string): GLOSTText {
   return {

package/src/types.ts

@@ -1,4 +1,4 @@
-import type { Literal as NlcstLiteral, Node as NlcstNode, Paragraph as NlcstParagraph, Parent as NlcstParent, Punctuation as NlcstPunctuation, Root as NlcstRoot, RootContent as NlcstRootContent, Sentence as NlcstSentence, Source as NlcstSource, Symbol as NlcstSymbol, Text as NlcstText, WhiteSpace as NlcstWhiteSpace, Word as NlcstWord } from "nlcst";
+import type { Literal as NlcstLiteral, Paragraph as NlcstParagraph, Punctuation as NlcstPunctuation, Root as NlcstRoot, Sentence as NlcstSentence, Source as NlcstSource, Symbol as NlcstSymbol, Text as NlcstText, WhiteSpace as NlcstWhiteSpace, Word as NlcstWord } from "nlcst";
 
 
 

package/src/utils.ts

@@ -13,7 +13,6 @@ import type {
   GLOSTSyllable,
   GLOSTWord,
   TranscriptionSystem,
-  TransliterationData,
 } from "./types";
 
 // ============================================================================

package/tsconfig.json

@@ -5,5 +5,5 @@
     "outDir": "./dist"
   },
   "include": ["src/**/*"],
-  "exclude": ["node_modules", "dist", "**/*.test.ts", "**/*.spec.ts"]
+  "exclude": ["node_modules", "dist", "**/*.test.ts", "**/*.spec.ts", "src/__tests__"]
 }

package/dist/mock-data.d.ts

@@ -1,35 +0,0 @@
-import type { GLOSTWord } from './types';
-declare const thaiWordsWithExtras: GLOSTWord[];
-declare const japaneseWordsWithExtras: GLOSTWord[];
-declare const thaiSentenceWithExtras: import("./types").GLOSTSentence;
-declare const japaneseSentenceWithExtras: import("./types").GLOSTSentence;
-declare const thaiParagraphWithExtras: import("./types").GLOSTParagraph;
-declare const japaneseParagraphWithExtras: import("./types").GLOSTParagraph;
-export declare const thaiDocumentWithExtras: import("./types").GLOSTRoot;
-export declare const japaneseDocumentWithExtras: import("./types").GLOSTRoot;
-/**
- * Get quick translation for a word in a specific language
- */
-export declare function getQuickTranslation(word: GLOSTWord, targetLang: string): string | undefined;
-/**
- * Get all available translations for a word
- */
-export declare function getAllTranslations(word: GLOSTWord): Record<string, string>;
-/**
- * Get difficulty level for a word
- */
-export declare function getDifficulty(word: GLOSTWord): string | undefined;
-/**
- * Get cultural notes for a word
- */
-export declare function getCulturalNotes(word: GLOSTWord): string | undefined;
-/**
- * Get related words for a word
- */
-export declare function getRelatedWords(word: GLOSTWord): string[];
-/**
- * Get example sentences for a word
- */
-export declare function getExamples(word: GLOSTWord): string[];
-export { thaiWordsWithExtras, japaneseWordsWithExtras, thaiSentenceWithExtras, japaneseSentenceWithExtras, thaiParagraphWithExtras, japaneseParagraphWithExtras };
-//# sourceMappingURL=mock-data.d.ts.map

package/dist/mock-data.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"mock-data.d.ts","sourceRoot":"","sources":["../src/mock-data.ts"],"names":[],"mappings":"AAOA,OAAO,KAAK,EACV,SAAS,EAAC,MAAM,SAAS,CAAC;AAM5B,QAAA,MAAM,mBAAmB,EAAE,SAAS,EAsPnC,CAAC;AAMF,QAAA,MAAM,uBAAuB,EAAE,SAAS,EAmQvC,CAAC;AAMF,QAAA,MAAM,sBAAsB,iCAK3B,CAAC;AAEF,QAAA,MAAM,0BAA0B,iCAK/B,CAAC;AAEF,QAAA,MAAM,uBAAuB,kCAAsD,CAAC;AACpF,QAAA,MAAM,2BAA2B,kCAA0D,CAAC;AAE5F,eAAO,MAAM,sBAAsB,6BAQlC,CAAC;AAEF,eAAO,MAAM,0BAA0B,6BAQtC,CAAC;AAMF;;GAEG;AACH,wBAAgB,mBAAmB,CAAC,IAAI,EAAE,SAAS,EAAE,UAAU,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAE3F;AAED;;GAEG;AACH,wBAAgB,kBAAkB,CAAC,IAAI,EAAE,SAAS,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAW1E;AAED;;GAEG;AACH,wBAAgB,aAAa,CAAC,IAAI,EAAE,SAAS,GAAG,MAAM,GAAG,SAAS,CAEjE;AAED;;GAEG;AACH,wBAAgB,gBAAgB,CAAC,IAAI,EAAE,SAAS,GAAG,MAAM,GAAG,SAAS,CAEpE;AAED;;GAEG;AACH,wBAAgB,eAAe,CAAC,IAAI,EAAE,SAAS,GAAG,MAAM,EAAE,CAEzD;AAED;;GAEG;AACH,wBAAgB,WAAW,CAAC,IAAI,EAAE,SAAS,GAAG,MAAM,EAAE,CAErD;AAMD,OAAO,EACL,mBAAmB,EACnB,uBAAuB,EACvB,sBAAsB,EACtB,0BAA0B,EAC1B,uBAAuB,EACvB,2BAA2B,EAC5B,CAAC"}