@tricoteuses/tisseuse 0.1.8 → 0.2.0

package/dist/lib/index.d.ts

@@ -8,17 +8,17 @@ export { compoundReferencesSeparators, divisionTypes, europeanLawNatures, french
 export { citation, citationLigne, citationSimple, } from './text_parsers/citations.js';
 export { date, duDate } from './text_parsers/dates.js';
 export { definitionDivision, designationDivision, division, divisions, natureDivisionSingulier, numeroDivision, } from './text_parsers/divisions.js';
+export type { FragmentPosition, FragmentReverseTransformation, } from './text_parsers/fragments.js';
 export { addChildLeftToLastChild, createEnumerationOrBoundedInterval, createParentChildTreeFromReferences, iterAtomicFirstParentReferences, iterAtomicReferences, iterIncludedReferences, } from './text_parsers/helpers.js';
-export { getReferences, iterCitationReferences, iterReferences, } from './text_parsers/index.js';
+export { getParsedReferences, getParsedReferencesWithOriginalTransformations, parseCitationReferences, parseReferences, parseReferencesWithOriginalTransformations, } from './text_parsers/index.js';
 export { adjectifNumeralOrdinalCourt, adverbeMultiplicatifLatin, nombreAsTextAstNumber, nombreCardinal, nombreRomainCardinal, nombreRomainOrdinal, nombreRomainOu0iAsTextAstNumber, } from './text_parsers/numbers.js';
 export { alternatives, chain, convert, optional, parseText, regExp, repeat, TextParserContext, variable, wordsTree, } from './text_parsers/parsers.js';
 export { auPortion, auxPortions, numeroPortion, portions, unePortion, } from './text_parsers/portions.js';
-export type { TextPosition } from './text_parsers/positions.js';
 export { ditPluriel, ditSingulier, introPluriel, introSingulier, liaisonPluriel, liaisonSingulier, } from './text_parsers/prepositions.js';
 export { reference, uniteBasePreciseeSingulier, uniteBaseSingulier, } from './text_parsers/references.js';
 export { adverbeRelatif, espaceAdverbeRelatif, relatifPlurielPrepose, relatifSingulierPrepose, } from './text_parsers/relative_locations.js';
 export { convertHtmlElementsToText, decodeNamedHtmlEntities, decodeNumericHtmlEntities, replacePattern, replacePatterns, simplifyHtml, simplifyText, simplifyUnicodeCharacters, } from './text_parsers/simplifiers.js';
 export { definitionTexteFrancais, identificationTexteEuropeen, natureTexteFrancais, numeroEtOuDateTexteFrancais, numeroTexteEuropeen, numeroTexteFrancais, optionalEspaceDuTerritoire, texte, texteEuropeen, texteFrancais, texteInternational, } from './text_parsers/texts.js';
-export { chainTransformers, iterOriginalMergedPositionsFromTransformed, originalMergedPositionsFromTransformed, originalSplitPositionsFromTransformed, type FragmentReverseTransformation, type SourceMapSegment, type Transformation, type TransformationLeaf, type TransformationNode, type Transformer, type TransformerLeaf, type TransformerNode, } from './text_parsers/transformers.js';
+export { chainTransformers, iterOriginalMergedPositionsFromTransformed, originalMergedPositionsFromTransformed, originalSplitPositionsFromTransformed, reverseTransformedInnerFragment, reverseTransformedReplacement, type SourceMapSegment, type Transformation, type TransformationLeaf, type TransformationNode, type Transformer, type TransformerLeaf, type TransformerNode, } from './text_parsers/transformers.js';
 export { espace, lettreAsciiMinuscule, nonLettre, numero, virguleOuEspace, } from './text_parsers/typography.js';
 export { cleanTexteTitle } from './textes.js';

package/dist/lib/server/text_links.d.ts

@@ -1,9 +1,11 @@
 import { TextParserContext } from '../text_parsers/parsers.js';
 import { DefinitionOrLink } from '../text_parsers/text_links.js';
-export declare function iterTextLinks(context: TextParserContext, { date, defaultTextId, logIgnoredReferencesTypes, logPartialReferences, logReferences, }: {
+import { Transformation } from '../text_parsers/transformers.js';
+export declare function iterTextLinks(context: TextParserContext, { date, defaultTextId, logIgnoredReferencesTypes, logPartialReferences, logReferences, transformation, }: {
     date: string;
     defaultTextId?: string;
     logIgnoredReferencesTypes?: boolean;
     logPartialReferences?: boolean;
     logReferences?: boolean;
+    transformation?: Transformation;
 }): AsyncGenerator<DefinitionOrLink, void>;

package/dist/lib/text_parsers/ast.d.ts

@@ -1,4 +1,4 @@
-import { TextPosition } from './positions.js';
+import { FragmentPosition, FragmentReverseTransformation } from './fragments.js';
 export type CompoundReferencesSeparator = (typeof compoundReferencesSeparators)[number];
 export type DivisionType = (typeof divisionTypes)[number];
 export type EuropeanLawNature = (typeof europeanLawNatures)[number];
@@ -28,6 +28,7 @@ export type TextAstBoundedInterval = {
 } & TextAstPosition;
 export type TextAstCitation = {
     content: TextAstPosition[];
+    references?: TextAstReference[];
     type: "citation";
 } & TextAstPosition;
 export type TextAstCompoundReference = TextAstBoundedInterval | TextAstCountedInterval | TextAstEnumeration | TextAstExclusion;
@@ -89,7 +90,8 @@ export type TextAstPortion = {
     type: PortionType;
 } & TextAstLocalization & TextAstPosition;
 export interface TextAstPosition {
-    position: TextPosition;
+    originalTransformation?: FragmentReverseTransformation;
+    position: FragmentPosition;
 }
 export type TextAstReference = TextAstAtomicReference | TextAstCompoundReference | TextAstParentChild | TextAstReferenceAndAction;
 export type TextAstReferenceAndAction = {

package/dist/lib/text_parsers/fragments.d.ts

@@ -0,0 +1,11 @@
+export interface FragmentPosition {
+    start: number;
+    stop: number;
+}
+export interface FragmentReverseTransformation {
+    innerPrefix?: string;
+    innerSuffix?: string;
+    outerPrefix?: string;
+    outerSuffix?: string;
+    position: FragmentPosition;
+}

package/dist/lib/text_parsers/helpers.d.ts

@@ -1,11 +1,13 @@
 import { CompoundReferencesSeparator, TextAstAtomicReference, TextAstParentChild, TextAstReference } from './ast.js';
-import { TextPosition } from './positions.js';
+import { FragmentPosition } from './fragments.js';
 export declare const addChildLeftToLastChild: (reference: TextAstReference, child: TextAstReference) => TextAstReference;
-export declare const createEnumerationOrBoundedInterval: (reference: TextAstReference, remaining: Array<[CompoundReferencesSeparator, TextAstReference]>, position: TextPosition) => TextAstReference;
-export declare const createEnumerationOrBoundedInterval1: (reference: TextAstReference, remaining: Array<[CompoundReferencesSeparator, TextAstReference]>, position: TextPosition, remainingIndex: number) => TextAstReference;
-export declare const createParentChildTreeFromReferences: (child: TextAstReference, ancestors: TextAstAtomicReference[], position: TextPosition) => TextAstReference;
+export declare const createEnumerationOrBoundedInterval: (reference: TextAstReference, remaining: Array<[CompoundReferencesSeparator, TextAstReference]>, position: FragmentPosition) => TextAstReference;
+export declare const createEnumerationOrBoundedInterval1: (reference: TextAstReference, remaining: Array<[CompoundReferencesSeparator, TextAstReference]>, position: FragmentPosition, remainingIndex: number) => TextAstReference;
+export declare const createParentChildTreeFromReferences: (child: TextAstReference, ancestors: TextAstAtomicReference[], position: FragmentPosition) => TextAstReference;
 export declare const getHighestAtomicType: (type1: TextAstAtomicReference["type"], type2: TextAstAtomicReference["type"]) => TextAstAtomicReference["type"];
 export declare const getReferenceHighestAtomicType: (reference: TextAstReference) => TextAstAtomicReference["type"];
 export declare function iterAtomicFirstParentReferences<T extends TextAstAtomicReference | TextAstParentChild>(reference: TextAstReference): Generator<T, void>;
 export declare function iterAtomicReferences(reference: TextAstReference): Generator<TextAstAtomicReference, void>;
-export declare function iterIncludedReferences(reference: TextAstReference): Generator<TextAstReference, void>;
+export declare function iterIncludedReferences(reference: TextAstReference, { citations }?: {
+    citations?: boolean;
+}): Generator<TextAstReference, void>;

package/dist/lib/text_parsers/index.d.ts

@@ -1,5 +1,8 @@
 import { TextAstCitation, TextAstReference } from './ast.js';
 import { TextParserContext } from './parsers.js';
-export declare function iterCitationReferences(context: TextParserContext, citation: TextAstCitation): Generator<TextAstReference, void>;
-export declare function iterReferences(context: TextParserContext): Generator<TextAstReference, void>;
-export declare const getReferences: (context: TextParserContext) => TextAstReference[];
+import { Transformation } from './transformers.js';
+export declare function parseCitationReferences(context: TextParserContext, citation: TextAstCitation): Generator<TextAstReference, void>;
+export declare function parseReferences(context: TextParserContext): Generator<TextAstReference, void>;
+export declare function parseReferencesWithOriginalTransformations(context: TextParserContext, transformation: Transformation): Generator<TextAstReference, void>;
+export declare const getParsedReferences: (context: TextParserContext) => TextAstReference[];
+export declare const getParsedReferencesWithOriginalTransformations: (context: TextParserContext, transformation: Transformation) => TextAstReference[];

package/dist/lib/text_parsers/parsers.d.ts

@@ -1,5 +1,5 @@
 import { TextAst, TextAstArticle, TextAstText, TextAstTextInfos, TextInfosByWordsTree } from './ast.js';
-import { TextPosition } from './positions.js';
+import { FragmentPosition } from './fragments.js';
 export type TextInfosConverter = (infos: TextAstTextInfos, context: TextParserContext) => TextAst | undefined;
 export type RegExpConverter = (match: RegExpExecArray, context: TextParserContext) => TextAst | undefined;
 export type TextAstConverter<T extends TextAst> = (ast: T, context: TextParserContext) => TextAst | undefined;
@@ -13,9 +13,9 @@ export declare class TextParserContext {
     usedInputs: TextTree | undefined;
     variables: Record<string, TextAst>;
     constructor(input: string, offset?: number);
-    position(): TextPosition;
+    position(): FragmentPosition;
     remaining(): string;
-    text(position?: TextPosition): string;
+    text(position?: FragmentPosition): string;
     textFromResults(results: TextAst[] | undefined): string;
 }
 type TextTree = string | null | Array<TextTree>;

package/dist/lib/text_parsers/text_links.d.ts

@@ -1,12 +1,19 @@
 import { TextAstArticle, TextAstDivision, TextAstPosition, TextAstReference, TextAstText } from './ast.js';
-import { TextPosition } from './positions.js';
+import { FragmentPosition, FragmentReverseTransformation } from './fragments.js';
 export type DefinitionOrLink = ArticleDefinition | ArticleLink | DivisionLink | TextLink;
 export interface ArticleDefinition {
     article: TextAstArticle;
+    /**
+     * Same value as article.originalTransformation, added for homogeneity
+     *
+     * Only defined when a transformation was used to convert input text
+     * simplified text.
+     */
+    originalTransformation?: FragmentReverseTransformation;
     /**
      * Same value as article.position, added for homogeneity
      */
-    position: TextPosition;
+    position: FragmentPosition;
     reference: TextAstReference;
     textId: string;
     type: "article_definition";
@@ -14,21 +21,36 @@ export interface ArticleDefinition {
 export interface ArticleExternalLink {
     article: TextAstArticle;
     articleId?: string;
-    position: TextPosition;
+    /**
+     * Only defined when a transformation was used to convert input text
+     * simplified text.
+     */
+    originalTransformation?: FragmentReverseTransformation;
+    position: FragmentPosition;
     reference: TextAstReference;
     type: "external_article";
 }
 export interface ArticleInternalLink {
     article: TextAstArticle;
     definition: ArticleDefinition;
-    position: TextPosition;
+    /**
+     * Only defined when a transformation was used to convert input text
+     * simplified text.
+     */
+    originalTransformation?: FragmentReverseTransformation;
+    position: FragmentPosition;
     reference: TextAstReference;
     type: "internal_article";
 }
 export type ArticleLink = ArticleExternalLink | ArticleInternalLink;
 export interface DivisionExternalLink {
     division: TextAstDivision;
-    position: TextPosition;
+    /**
+     * Only defined when a transformation was used to convert input text
+     * simplified text.
+     */
+    originalTransformation?: FragmentReverseTransformation;
+    position: FragmentPosition;
     reference: TextAstReference;
     sectionTaId?: string;
     type: "external_division";
@@ -42,7 +64,12 @@ export interface ExtractedLinkDb {
     target_id: string | null;
 }
 export interface TextExternalLink {
-    position: TextPosition;
+    /**
+     * Only defined when a transformation was used to convert input text
+     * simplified text.
+     */
+    originalTransformation?: FragmentReverseTransformation;
+    position: FragmentPosition;
     reference: TextAstReference;
     text: TextAstText & TextAstPosition;
     type: "external_text";

package/dist/lib/text_parsers/transformers.d.ts

@@ -1,11 +1,4 @@
-import { TextPosition } from './positions.js';
-export interface FragmentReverseTransformation {
-    innerPrefix?: string;
-    innerSuffix?: string;
-    outerPrefix?: string;
-    outerSuffix?: string;
-    position: TextPosition;
-}
+import { FragmentPosition, FragmentReverseTransformation } from './fragments.js';
 export interface SourceMapSegment {
     inputIndex: number;
     inputLength: number;
@@ -39,15 +32,37 @@ export type TransformerNode = (text: string) => TransformationNode;
 export declare const tagRegExp: RegExp;
 export declare function chainTransformers(title: string, transformers: Array<Transformer>): TransformerNode;
 /**
- * Caution: This iterator fails when successive original positions overlap.
+ * Generator that converts transformed (e.g. simplified) positions to original
+ * (e.g. HTML) positions
+ *
+ * When a position is included in fragments of HTML elements, the elements are
+ * either split (for spans) or the position is enlarged to include the whole
+ * elements (for blocks).
+ *
+ * Use this generator to insert HTML elements (links, spans, etc).
  */
-export declare function iterOriginalMergedPositionsFromTransformed(transformation: Transformation): Generator<FragmentReverseTransformation, void, TextPosition | undefined>;
+export declare function iterOriginalMergedPositionsFromTransformed(transformation: Transformation): Generator<FragmentReverseTransformation, void, FragmentPosition | undefined>;
 /**
- * Caution: This iterator fails when successive original positions overlap.
+ * Converts an array of transformed (e.g. simplified) positions to an array
+ *  of original (e.g. HTML) positions
+ *
+ * When a position is included in fragments of HTML elements, the elements are
+ * either split (for spans) or the position is enlarged to include the whole
+ * elements (for blocks).
+ *
+ * Use this function to insert HTML elements (links, spans, etc).
  */
-export declare function originalMergedPositionsFromTransformed(transformation: Transformation, transformedPositions: TextPosition[]): FragmentReverseTransformation[];
+export declare function originalMergedPositionsFromTransformed(transformation: Transformation, transformedPositions: FragmentPosition[]): FragmentReverseTransformation[];
 /**
- * Note: The original positions are split when they overlap.
- * So, there may be more original positions than transformed positions.
+ * Converts an array of transformed (e.g. simplified) positions to an array
+ *  of original (e.g. HTML) positions
+ *
+ * Each position is split to ensure that it doesn't contain any HTML element.
+ *
+ * The positions must be sorted in ascending order.
+ *
+ * Use this function for diffs.
  */
-export declare function originalSplitPositionsFromTransformed(transformation: Transformation, positions: TextPosition[]): TextPosition[];
+export declare function originalSplitPositionsFromTransformed(transformation: Transformation, positions: FragmentPosition[]): FragmentPosition[];
+export declare const reverseTransformedInnerFragment: <StringOrUndefined extends string | undefined>(originalText: string, originalTransformation: FragmentReverseTransformation | undefined, offset?: number) => StringOrUndefined;
+export declare const reverseTransformedReplacement: (originalTransformation: FragmentReverseTransformation, replacement: string) => string;

package/dist/scripts/test.d.ts

@@ -1 +0,0 @@
-export {};

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@tricoteuses/tisseuse",
   "description": "Find links in/to French legislative documents",
-  "version": "0.1.8",
+  "version": "0.2.0",
   "keywords": [
     "Assemblée nationale",
     "France",

package/dist/lib/text_parsers/positions.d.ts

@@ -1,4 +0,0 @@
-export interface TextPosition {
-    start: number;
-    stop: number;
-}