glost-presets 0.5.0

package/dist/reading-app.d.ts

@@ -0,0 +1,43 @@
+/**
+ * Reading App Preset
+ *
+ * Interactive reading features including transcription, translation,
+ * and clause segmentation.
+ *
+ * @packageDocumentation
+ */
+import type { Preset } from "glost-processor";
+/**
+ * Reading App Preset
+ *
+ * Optimized for interactive reading applications.
+ *
+ * Includes:
+ * - Transcription
+ * - Translation
+ * - Clause segmentation
+ *
+ * @example
+ * ```typescript
+ * import { glost } from "glost-processor";
+ * import { readingAppPreset } from "glost-presets";
+ *
+ * const processor = glost()
+ *   .use(readingAppPreset);
+ *
+ * const result = await processor.process(document);
+ * ```
+ */
+export declare const readingAppPreset: Preset;
+/**
+ * Create a customized reading app preset
+ *
+ * @param options - Customization options
+ * @returns Customized preset
+ */
+export declare function createReadingAppPreset(options?: {
+    transcriptionScheme?: string;
+    translationTarget?: string;
+    includeClauseSegmenter?: boolean;
+}): Preset;
+//# sourceMappingURL=reading-app.d.ts.map

package/dist/reading-app.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"reading-app.d.ts","sourceRoot":"","sources":["../src/reading-app.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,iBAAiB,CAAC;AAE9C;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,eAAO,MAAM,gBAAgB,EAAE,MAS9B,CAAC;AAEF;;;;;GAKG;AACH,wBAAgB,sBAAsB,CAAC,OAAO,CAAC,EAAE;IAC/C,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAC7B,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,sBAAsB,CAAC,EAAE,OAAO,CAAC;CAClC,GAAG,MAAM,CAsBT"}

package/dist/reading-app.js

@@ -0,0 +1,62 @@
+/**
+ * Reading App Preset
+ *
+ * Interactive reading features including transcription, translation,
+ * and clause segmentation.
+ *
+ * @packageDocumentation
+ */
+/**
+ * Reading App Preset
+ *
+ * Optimized for interactive reading applications.
+ *
+ * Includes:
+ * - Transcription
+ * - Translation
+ * - Clause segmentation
+ *
+ * @example
+ * ```typescript
+ * import { glost } from "glost-processor";
+ * import { readingAppPreset } from "glost-presets";
+ *
+ * const processor = glost()
+ *   .use(readingAppPreset);
+ *
+ * const result = await processor.process(document);
+ * ```
+ */
+export const readingAppPreset = {
+    id: "reading-app",
+    name: "Reading App",
+    description: "Interactive reading features with transcription, translation, and clause segmentation",
+    plugins: [
+        ["transcription", { scheme: "auto" }],
+        ["translation", { target: "en" }],
+        "clause-segmenter",
+    ],
+};
+/**
+ * Create a customized reading app preset
+ *
+ * @param options - Customization options
+ * @returns Customized preset
+ */
+export function createReadingAppPreset(options) {
+    const { transcriptionScheme = "auto", translationTarget = "en", includeClauseSegmenter = true, } = options || {};
+    const plugins = [
+        ["transcription", { scheme: transcriptionScheme }],
+        ["translation", { target: translationTarget }],
+    ];
+    if (includeClauseSegmenter) {
+        plugins.push("clause-segmenter");
+    }
+    return {
+        id: "reading-app-custom",
+        name: "Reading App (Custom)",
+        description: "Customized reading app preset",
+        plugins,
+    };
+}
+//# sourceMappingURL=reading-app.js.map

package/dist/reading-app.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"reading-app.js","sourceRoot":"","sources":["../src/reading-app.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAIH;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAW;IACtC,EAAE,EAAE,aAAa;IACjB,IAAI,EAAE,aAAa;IACnB,WAAW,EAAE,uFAAuF;IACpG,OAAO,EAAE;QACP,CAAC,eAAe,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,CAAC;QACrC,CAAC,aAAa,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC;QACjC,kBAAkB;KACnB;CACF,CAAC;AAEF;;;;;GAKG;AACH,MAAM,UAAU,sBAAsB,CAAC,OAItC;IACC,MAAM,EACJ,mBAAmB,GAAG,MAAM,EAC5B,iBAAiB,GAAG,IAAI,EACxB,sBAAsB,GAAG,IAAI,GAC9B,GAAG,OAAO,IAAI,EAAE,CAAC;IAElB,MAAM,OAAO,GAAsB;QACjC,CAAC,eAAe,EAAE,EAAE,MAAM,EAAE,mBAAmB,EAAE,CAAC;QAClD,CAAC,aAAa,EAAE,EAAE,MAAM,EAAE,iBAAiB,EAAE,CAAC;KAC/C,CAAC;IAEF,IAAI,sBAAsB,EAAE,CAAC;QAC3B,OAAO,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC;IACnC,CAAC;IAED,OAAO;QACL,EAAE,EAAE,oBAAoB;QACxB,IAAI,EAAE,sBAAsB;QAC5B,WAAW,EAAE,+BAA+B;QAC5C,OAAO;KACR,CAAC;AACJ,CAAC"}

package/dist/vocabulary-builder.d.ts

@@ -0,0 +1,41 @@
+/**
+ * Vocabulary Builder Preset
+ *
+ * Focus on word frequency and difficulty for vocabulary learning.
+ *
+ * @packageDocumentation
+ */
+import type { Preset } from "glost-processor";
+/**
+ * Vocabulary Builder Preset
+ *
+ * Optimized for vocabulary learning and word prioritization.
+ *
+ * Includes:
+ * - Frequency data
+ * - Difficulty levels
+ * - Translation
+ *
+ * @example
+ * ```typescript
+ * import { glost } from "glost-processor";
+ * import { vocabularyBuilderPreset } from "glost-presets";
+ *
+ * const processor = glost()
+ *   .use(vocabularyBuilderPreset);
+ *
+ * const result = await processor.process(document);
+ * ```
+ */
+export declare const vocabularyBuilderPreset: Preset;
+/**
+ * Create a customized vocabulary builder preset
+ *
+ * @param options - Customization options
+ * @returns Customized preset
+ */
+export declare function createVocabularyBuilderPreset(options?: {
+    translationTarget?: string;
+    includeTranslation?: boolean;
+}): Preset;
+//# sourceMappingURL=vocabulary-builder.d.ts.map

package/dist/vocabulary-builder.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"vocabulary-builder.d.ts","sourceRoot":"","sources":["../src/vocabulary-builder.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,iBAAiB,CAAC;AAE9C;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,eAAO,MAAM,uBAAuB,EAAE,MASrC,CAAC;AAEF;;;;;GAKG;AACH,wBAAgB,6BAA6B,CAAC,OAAO,CAAC,EAAE;IACtD,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,kBAAkB,CAAC,EAAE,OAAO,CAAC;CAC9B,GAAG,MAAM,CAqBT"}

package/dist/vocabulary-builder.js

@@ -0,0 +1,61 @@
+/**
+ * Vocabulary Builder Preset
+ *
+ * Focus on word frequency and difficulty for vocabulary learning.
+ *
+ * @packageDocumentation
+ */
+/**
+ * Vocabulary Builder Preset
+ *
+ * Optimized for vocabulary learning and word prioritization.
+ *
+ * Includes:
+ * - Frequency data
+ * - Difficulty levels
+ * - Translation
+ *
+ * @example
+ * ```typescript
+ * import { glost } from "glost-processor";
+ * import { vocabularyBuilderPreset } from "glost-presets";
+ *
+ * const processor = glost()
+ *   .use(vocabularyBuilderPreset);
+ *
+ * const result = await processor.process(document);
+ * ```
+ */
+export const vocabularyBuilderPreset = {
+    id: "vocabulary-builder",
+    name: "Vocabulary Builder",
+    description: "Word frequency and difficulty for vocabulary prioritization",
+    plugins: [
+        "frequency",
+        "difficulty",
+        ["translation", { target: "en" }],
+    ],
+};
+/**
+ * Create a customized vocabulary builder preset
+ *
+ * @param options - Customization options
+ * @returns Customized preset
+ */
+export function createVocabularyBuilderPreset(options) {
+    const { translationTarget = "en", includeTranslation = true, } = options || {};
+    const plugins = [
+        "frequency",
+        "difficulty",
+    ];
+    if (includeTranslation) {
+        plugins.push(["translation", { target: translationTarget }]);
+    }
+    return {
+        id: "vocabulary-builder-custom",
+        name: "Vocabulary Builder (Custom)",
+        description: "Customized vocabulary builder preset",
+        plugins,
+    };
+}
+//# sourceMappingURL=vocabulary-builder.js.map

package/dist/vocabulary-builder.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"vocabulary-builder.js","sourceRoot":"","sources":["../src/vocabulary-builder.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAIH;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,MAAM,CAAC,MAAM,uBAAuB,GAAW;IAC7C,EAAE,EAAE,oBAAoB;IACxB,IAAI,EAAE,oBAAoB;IAC1B,WAAW,EAAE,6DAA6D;IAC1E,OAAO,EAAE;QACP,WAAW;QACX,YAAY;QACZ,CAAC,aAAa,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC;KAClC;CACF,CAAC;AAEF;;;;;GAKG;AACH,MAAM,UAAU,6BAA6B,CAAC,OAG7C;IACC,MAAM,EACJ,iBAAiB,GAAG,IAAI,EACxB,kBAAkB,GAAG,IAAI,GAC1B,GAAG,OAAO,IAAI,EAAE,CAAC;IAElB,MAAM,OAAO,GAAsB;QACjC,WAAW;QACX,YAAY;KACb,CAAC;IAEF,IAAI,kBAAkB,EAAE,CAAC;QACvB,OAAO,CAAC,IAAI,CAAC,CAAC,aAAa,EAAE,EAAE,MAAM,EAAE,iBAAiB,EAAE,CAAC,CAAC,CAAC;IAC/D,CAAC;IAED,OAAO;QACL,EAAE,EAAE,2BAA2B;QAC/B,IAAI,EAAE,6BAA6B;QACnC,WAAW,EAAE,sCAAsC;QACnD,OAAO;KACR,CAAC;AACJ,CAAC"}

package/package.json

@@ -0,0 +1,40 @@
+{
+  "name": "glost-presets",
+  "version": "0.5.0",
+  "description": "Preset configurations for common GLOST use cases",
+  "type": "module",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist",
+    "src",
+    "README.md"
+  ],
+  "keywords": [
+    "glost",
+    "presets",
+    "configuration"
+  ],
+  "author": "",
+  "license": "MIT",
+  "dependencies": {
+    "glost-core": "0.5.0",
+    "glost-processor": "0.5.0"
+  },
+  "devDependencies": {
+    "@types/node": "^20.0.0",
+    "typescript": "^5.3.3",
+    "vitest": "^1.6.0"
+  },
+  "scripts": {
+    "build": "tsc",
+    "test": "vitest run --passWithNoTests",
+    "test:watch": "vitest"
+  }
+}

package/src/grammar-analyzer.ts

@@ -0,0 +1,71 @@
+/**
+ * Grammar Analyzer Preset
+ * 
+ * Focus on grammatical analysis with POS tagging and clause segmentation.
+ * 
+ * @packageDocumentation
+ */
+
+import type { Preset } from "glost-processor";
+
+/**
+ * Grammar Analyzer Preset
+ * 
+ * Optimized for grammatical analysis and teaching.
+ * 
+ * Includes:
+ * - Part-of-speech tagging
+ * - Clause segmentation
+ * - Gender (for applicable languages)
+ * 
+ * @example
+ * ```typescript
+ * import { glost } from "glost-processor";
+ * import { grammarAnalyzerPreset } from "glost-presets";
+ * 
+ * const processor = glost()
+ *   .use(grammarAnalyzerPreset);
+ * 
+ * const result = await processor.process(document);
+ * ```
+ */
+export const grammarAnalyzerPreset: Preset = {
+  id: "grammar-analyzer",
+  name: "Grammar Analyzer",
+  description: "POS tagging and clause segmentation for grammar analysis",
+  plugins: [
+    "pos",
+    "clause-segmenter",
+    "gender",
+  ],
+};
+
+/**
+ * Create a customized grammar analyzer preset
+ * 
+ * @param options - Customization options
+ * @returns Customized preset
+ */
+export function createGrammarAnalyzerPreset(options?: {
+  includeGender?: boolean;
+}): Preset {
+  const {
+    includeGender = true,
+  } = options || {};
+
+  const plugins: Preset["plugins"] = [
+    "pos",
+    "clause-segmenter",
+  ];
+
+  if (includeGender) {
+    plugins.push("gender");
+  }
+
+  return {
+    id: "grammar-analyzer-custom",
+    name: "Grammar Analyzer (Custom)",
+    description: "Customized grammar analyzer preset",
+    plugins,
+  };
+}

package/src/index.ts

@@ -0,0 +1,43 @@
+/**
+ * GLOST Presets
+ * 
+ * Preset configurations for common GLOST use cases.
+ * 
+ * @packageDocumentation
+ * 
+ * @example
+ * ```typescript
+ * import { glost } from "glost-processor";
+ * import { languageLearningPreset } from "glost-presets";
+ * 
+ * const processor = glost()
+ *   .use(languageLearningPreset);
+ * 
+ * const result = await processor.process(document);
+ * ```
+ */
+
+export {
+  languageLearningPreset,
+  createLanguageLearningPreset,
+} from "./language-learning.js";
+
+export {
+  readingAppPreset,
+  createReadingAppPreset,
+} from "./reading-app.js";
+
+export {
+  vocabularyBuilderPreset,
+  createVocabularyBuilderPreset,
+} from "./vocabulary-builder.js";
+
+export {
+  grammarAnalyzerPreset,
+  createGrammarAnalyzerPreset,
+} from "./grammar-analyzer.js";
+
+export {
+  minimalPreset,
+  createMinimalPreset,
+} from "./minimal.js";

package/src/language-learning.ts

@@ -0,0 +1,103 @@
+/**
+ * Language Learning Preset
+ * 
+ * Complete language learning stack with transcription, translation,
+ * frequency, difficulty, and POS tagging.
+ * 
+ * @packageDocumentation
+ */
+
+import type { Preset } from "glost-processor";
+
+/**
+ * Language Learning Preset
+ * 
+ * Full-featured preset for language learning applications.
+ * 
+ * Includes:
+ * - Transcription (with configurable scheme)
+ * - Translation (with configurable target)
+ * - Frequency data
+ * - Difficulty levels
+ * - Part-of-speech tagging
+ * 
+ * @example
+ * ```typescript
+ * import { glost } from "glost-processor";
+ * import { languageLearningPreset } from "glost-presets";
+ * 
+ * const processor = glost()
+ *   .use(languageLearningPreset);
+ * 
+ * const result = await processor.process(document);
+ * ```
+ */
+export const languageLearningPreset: Preset = {
+  id: "language-learning",
+  name: "Language Learning",
+  description: "Complete language learning stack with transcription, translation, frequency, difficulty, and POS",
+  plugins: [
+    ["transcription", { scheme: "auto" }],
+    ["translation", { target: "en" }],
+    "frequency",
+    "difficulty",
+    "pos",
+  ],
+};
+
+/**
+ * Create a customized language learning preset
+ * 
+ * @param options - Customization options
+ * @returns Customized preset
+ * 
+ * @example
+ * ```typescript
+ * import { createLanguageLearningPreset } from "glost-presets";
+ * 
+ * const preset = createLanguageLearningPreset({
+ *   transcriptionScheme: "ipa",
+ *   translationTarget: "es",
+ *   includePos: false
+ * });
+ * ```
+ */
+export function createLanguageLearningPreset(options?: {
+  transcriptionScheme?: string;
+  translationTarget?: string;
+  includeFrequency?: boolean;
+  includeDifficulty?: boolean;
+  includePos?: boolean;
+}): Preset {
+  const {
+    transcriptionScheme = "auto",
+    translationTarget = "en",
+    includeFrequency = true,
+    includeDifficulty = true,
+    includePos = true,
+  } = options || {};
+
+  const plugins: Preset["plugins"] = [
+    ["transcription", { scheme: transcriptionScheme }],
+    ["translation", { target: translationTarget }],
+  ];
+
+  if (includeFrequency) {
+    plugins.push("frequency");
+  }
+
+  if (includeDifficulty) {
+    plugins.push("difficulty");
+  }
+
+  if (includePos) {
+    plugins.push("pos");
+  }
+
+  return {
+    id: "language-learning-custom",
+    name: "Language Learning (Custom)",
+    description: "Customized language learning preset",
+    plugins,
+  };
+}

package/src/minimal.ts

@@ -0,0 +1,65 @@
+/**
+ * Minimal Preset
+ * 
+ * Just the essentials: transcription and translation.
+ * 
+ * @packageDocumentation
+ */
+
+import type { Preset } from "glost-processor";
+
+/**
+ * Minimal Preset
+ * 
+ * Lightweight preset with just transcription and translation.
+ * 
+ * Includes:
+ * - Transcription
+ * - Translation
+ * 
+ * @example
+ * ```typescript
+ * import { glost } from "glost-processor";
+ * import { minimalPreset } from "glost-presets";
+ * 
+ * const processor = glost()
+ *   .use(minimalPreset);
+ * 
+ * const result = await processor.process(document);
+ * ```
+ */
+export const minimalPreset: Preset = {
+  id: "minimal",
+  name: "Minimal",
+  description: "Just transcription and translation - the essentials",
+  plugins: [
+    ["transcription", { scheme: "auto" }],
+    ["translation", { target: "en" }],
+  ],
+};
+
+/**
+ * Create a customized minimal preset
+ * 
+ * @param options - Customization options
+ * @returns Customized preset
+ */
+export function createMinimalPreset(options?: {
+  transcriptionScheme?: string;
+  translationTarget?: string;
+}): Preset {
+  const {
+    transcriptionScheme = "auto",
+    translationTarget = "en",
+  } = options || {};
+
+  return {
+    id: "minimal-custom",
+    name: "Minimal (Custom)",
+    description: "Customized minimal preset",
+    plugins: [
+      ["transcription", { scheme: transcriptionScheme }],
+      ["translation", { target: translationTarget }],
+    ],
+  };
+}

package/src/reading-app.ts

@@ -0,0 +1,76 @@
+/**
+ * Reading App Preset
+ * 
+ * Interactive reading features including transcription, translation,
+ * and clause segmentation.
+ * 
+ * @packageDocumentation
+ */
+
+import type { Preset } from "glost-processor";
+
+/**
+ * Reading App Preset
+ * 
+ * Optimized for interactive reading applications.
+ * 
+ * Includes:
+ * - Transcription
+ * - Translation
+ * - Clause segmentation
+ * 
+ * @example
+ * ```typescript
+ * import { glost } from "glost-processor";
+ * import { readingAppPreset } from "glost-presets";
+ * 
+ * const processor = glost()
+ *   .use(readingAppPreset);
+ * 
+ * const result = await processor.process(document);
+ * ```
+ */
+export const readingAppPreset: Preset = {
+  id: "reading-app",
+  name: "Reading App",
+  description: "Interactive reading features with transcription, translation, and clause segmentation",
+  plugins: [
+    ["transcription", { scheme: "auto" }],
+    ["translation", { target: "en" }],
+    "clause-segmenter",
+  ],
+};
+
+/**
+ * Create a customized reading app preset
+ * 
+ * @param options - Customization options
+ * @returns Customized preset
+ */
+export function createReadingAppPreset(options?: {
+  transcriptionScheme?: string;
+  translationTarget?: string;
+  includeClauseSegmenter?: boolean;
+}): Preset {
+  const {
+    transcriptionScheme = "auto",
+    translationTarget = "en",
+    includeClauseSegmenter = true,
+  } = options || {};
+
+  const plugins: Preset["plugins"] = [
+    ["transcription", { scheme: transcriptionScheme }],
+    ["translation", { target: translationTarget }],
+  ];
+
+  if (includeClauseSegmenter) {
+    plugins.push("clause-segmenter");
+  }
+
+  return {
+    id: "reading-app-custom",
+    name: "Reading App (Custom)",
+    description: "Customized reading app preset",
+    plugins,
+  };
+}

package/src/vocabulary-builder.ts

@@ -0,0 +1,73 @@
+/**
+ * Vocabulary Builder Preset
+ * 
+ * Focus on word frequency and difficulty for vocabulary learning.
+ * 
+ * @packageDocumentation
+ */
+
+import type { Preset } from "glost-processor";
+
+/**
+ * Vocabulary Builder Preset
+ * 
+ * Optimized for vocabulary learning and word prioritization.
+ * 
+ * Includes:
+ * - Frequency data
+ * - Difficulty levels
+ * - Translation
+ * 
+ * @example
+ * ```typescript
+ * import { glost } from "glost-processor";
+ * import { vocabularyBuilderPreset } from "glost-presets";
+ * 
+ * const processor = glost()
+ *   .use(vocabularyBuilderPreset);
+ * 
+ * const result = await processor.process(document);
+ * ```
+ */
+export const vocabularyBuilderPreset: Preset = {
+  id: "vocabulary-builder",
+  name: "Vocabulary Builder",
+  description: "Word frequency and difficulty for vocabulary prioritization",
+  plugins: [
+    "frequency",
+    "difficulty",
+    ["translation", { target: "en" }],
+  ],
+};
+
+/**
+ * Create a customized vocabulary builder preset
+ * 
+ * @param options - Customization options
+ * @returns Customized preset
+ */
+export function createVocabularyBuilderPreset(options?: {
+  translationTarget?: string;
+  includeTranslation?: boolean;
+}): Preset {
+  const {
+    translationTarget = "en",
+    includeTranslation = true,
+  } = options || {};
+
+  const plugins: Preset["plugins"] = [
+    "frequency",
+    "difficulty",
+  ];
+
+  if (includeTranslation) {
+    plugins.push(["translation", { target: translationTarget }]);
+  }
+
+  return {
+    id: "vocabulary-builder-custom",
+    name: "Vocabulary Builder (Custom)",
+    description: "Customized vocabulary builder preset",
+    plugins,
+  };
+}