@cspell/cspell-types 6.1.3-alpha.1 → 6.1.3

package/dist/Parser.d.ts

@@ -2,7 +2,7 @@ export declare type ParserOptions = Record<string, unknown>;
 export declare type ParserName = string;
 export interface Parser {
     /** Name of parser */
-    name: ParserName;
+    readonly name: ParserName;
     /**
      * Parse Method
      * @param content - full content of the file
@@ -11,36 +11,40 @@ export interface Parser {
     parse(content: string, filename: string): ParseResult;
 }
 export interface ParseResult {
-    content: string;
-    filename: string;
-    parsedTexts: Iterable<ParsedText>;
+    readonly content: string;
+    readonly filename: string;
+    readonly parsedTexts: Iterable<ParsedText>;
 }
 export interface ParsedText {
     /**
      * The text extracted and possibly transformed
      */
-    text: string;
+    readonly text: string;
+    /**
+     * The raw text before it has been transformed
+     */
+    readonly rawText?: string | undefined;
     /**
      * start and end offsets of the text
      */
-    range: Range;
+    readonly range: Range;
     /**
      * The Scope annotation for a segment of text.
      * Used by the spell checker to apply spell checking options
      * based upon the value of the scope.
      */
-    scope?: Scope | undefined;
+    readonly scope?: Scope | undefined;
     /**
      * The source map is used to support text transformations.
      *
      * See: {@link SourceMap}
      */
-    map?: SourceMap | undefined;
+    readonly map?: SourceMap | undefined;
     /**
      * Used to delegate parsing the contents of `text` to another parser.
      *
      */
-    delegate?: DelegateInfo | undefined;
+    readonly delegate?: DelegateInfo | undefined;
 }
 /**
  * A SourceMap is used to map transform a piece of text back to its original text.
@@ -83,22 +87,22 @@ export interface DelegateInfo {
      * Format: `./${source_filename}/${block_number}.${ext}
      * Example: `./README.md/1.js`
      */
-    filename: string;
+    readonly filename: string;
     /**
      * The filename of the origin of the virtual file block.
      * Example: `./README.md`
      */
-    originFilename: string;
+    readonly originFilename: string;
     /**
      * Proposed file extension
      * Example: `.js`
      */
-    extension: string;
+    readonly extension: string;
     /**
      * Filetype to use
      * Example: `javascript`
      */
-    fileType: string;
+    readonly fileType?: string;
 }
 /**
  * Scope - chain of scope going from local to global

package/dist/TextMap.d.ts

@@ -0,0 +1,36 @@
+export declare type MappedText = Readonly<TransformedText>;
+export declare type Range = readonly [start: number, end: number];
+export interface Mapped {
+    /**
+     * `(i, j)` number pairs where
+     * - `i` is the offset in the source
+     * - `j` is the offset in the destination
+     *
+     * Example:
+     * - source text = `"caf\xe9"`
+     * - mapped text = `"café"`
+     * - map = `[3, 3, 7, 4]`, which is equivalent to `[0, 0, 3, 3, 7, 4]`
+     *   where the `[0, 0]` is unnecessary.
+     *
+     */
+    map: number[];
+}
+interface TransformedText extends PartialOrUndefined<Mapped> {
+    /**
+     * Transformed text with an optional map.
+     */
+    text: string;
+    /**
+     * The original text
+     */
+    rawText?: string | undefined;
+    /**
+     * The start and end offset of the text in the document.
+     */
+    range: Range;
+}
+declare type PartialOrUndefined<T> = {
+    [P in keyof T]?: T[P] | undefined;
+};
+export {};
+//# sourceMappingURL=TextMap.d.ts.map

package/dist/TextMap.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=TextMap.js.map

package/dist/TextOffset.d.ts

@@ -20,25 +20,4 @@ export interface TextDocumentOffset extends TextOffset {
     col: number;
     line: TextOffset;
 }
-export interface Mapped {
-    /**
-     * `(i, j)` number pairs where
-     * - `i` is the offset in the source
-     * - `j` is the offset in the destination
-     *
-     * Example:
-     * - source text = `"caf\xe9"`
-     * - mapped text = `"café"`
-     * - map = `[3, 3, 7, 4]`, which is equivalent to `[0, 0, 3, 3, 7, 4]`
-     *   where the `[0, 0]` is unnecessary.
-     *
-     */
-    map: number[];
-}
-export interface TransformedText extends Partial<Mapped> {
-    /**
-     * Transformed text with an optional map.
-     */
-    text: string;
-}
 //# sourceMappingURL=TextOffset.d.ts.map

package/dist/index.d.ts

@@ -4,7 +4,8 @@ export * from './CSpellReporter';
 export * from './CSpellSettingsDef';
 export type { CharacterSet, CharacterSetCosts, DictionaryInformation, EditCosts } from './DictionaryInformation';
 export type { Feature, Features } from './features';
+export type { ParsedText, Parser, ParseResult, ParserName, ParserOptions } from './Parser';
 export type { SuggestionCostMapDef, SuggestionCostsDefs } from './suggestionCostsDef';
+export type { MappedText } from './TextMap';
 export type { TextDocumentOffset, TextOffset } from './TextOffset';
-export type { ParseResult, ParsedText, Parser, ParserName, ParserOptions } from './Parser';
 //# sourceMappingURL=index.d.ts.map

package/package.json

@@ -3,7 +3,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "version": "6.1.3-alpha.1",
+  "version": "6.1.3",
   "description": "Types for cspell and cspell-lib",
   "type": "commonjs",
   "main": "dist/index.js",
@@ -67,7 +67,7 @@
     "jest": "^28.1.1",
     "rimraf": "^3.0.2",
     "ts-json-schema-generator": "^1.0.0",
-    "typescript": "^4.7.3"
+    "typescript": "^4.7.4"
   },
-  "gitHead": "3b0a99870292387ca96aba8a7da701575b56ed5b"
+  "gitHead": "e96b313542f2ec0a38ac04d1422d97e724ded3a6"
 }