erudit 2.0.0-dev.8 → 3.0.0-dev.1

package/test/bitran/location.test.ts

@@ -1,143 +1,143 @@
-import {
-    decodeBitranLocation,
-    encodeBitranLocation,
-    parseBitranLocation,
-    parsePartialBitranLocation,
-    stringifyBitranLocation,
-    type BitranLocation,
-} from '@erudit/shared/bitran/location';
-
-const locations: [BitranLocation, string][] = [
-    // Full locations
-    [{ type: 'article', path: 'foo', unique: 'bar' }, 'article|foo|bar'],
-    [{ type: 'group', path: 'foo', unique: 'bar' }, 'group|foo|bar'],
-    // Type + path
-    [{ type: 'article', path: 'foo' }, 'article|foo'],
-    [{ type: 'group', path: 'foo' }, 'group|foo'],
-];
-
-const partialLocations: [string, BitranLocation, BitranLocation][] = [
-    // Full string location
-    [
-        'article|foo/bar|baz',
-        { type: 'group', path: 'qux' },
-        { type: 'article', path: 'foo/bar', unique: 'baz' },
-    ],
-    // Only unique
-    [
-        'baz',
-        { type: 'summary', path: 'foo/bar' },
-        { type: 'summary', path: 'foo/bar', unique: 'baz' },
-    ],
-    [
-        'baz',
-        { type: 'contributor', path: 'John' },
-        { type: 'contributor', path: 'John', unique: 'baz' },
-    ],
-    // Topic context
-    [
-        'article|baz',
-        { type: 'practice', path: 'foo/bar' },
-        { type: 'article', path: 'foo/bar', unique: 'baz' },
-    ],
-];
-
-const invalidPartialLocations: [string, BitranLocation][] = [
-    // Referencing topic part in non-topic context
-    ['article|bar', { type: 'contributor', path: 'foo' }],
-];
-
-const invalidLocations = [
-    // Too few parts
-    { type: 'article' },
-    { path: 'foo' },
-    { unique: 'foo' },
-    // Unknown type
-    { type: 'foo' },
-    { type: 'foo', path: 'bar', unique: 'baz' },
-    // Locations that require path
-    { type: 'article', unique: 'foo' },
-    { type: 'summary', unique: 'foo' },
-    { type: 'practice', unique: 'foo' },
-    { type: 'group', unique: 'foo' },
-    { type: 'contributor', unique: 'foo' },
-];
-
-const invalidStrLocations = [
-    // Too few parts
-    'article',
-    'group',
-    // Unknown type
-    'foo',
-    'foo|bar',
-    'foo|bar|baz',
-    // Empty string unique
-    'article|foo/bar|',
-];
-
-//
-//
-//
-
-describe('stringifyBitranLocation', () => {
-    for (const [location, expected] of locations) {
-        it(`should produce "${expected}"`, () => {
-            expect(stringifyBitranLocation(location)).toBe(expected);
-        });
-    }
-
-    for (const invalidLocation of invalidLocations) {
-        it(`should throw on location ${JSON.stringify(invalidLocation)}`, () => {
-            expect(() =>
-                stringifyBitranLocation(invalidLocation as BitranLocation),
-            ).toThrow();
-        });
-    }
-});
-
-describe('parseBitranLocation', () => {
-    for (const [location, expected] of locations) {
-        it(`should produce ${JSON.stringify(expected)}`, () => {
-            expect(parseBitranLocation(expected)).toEqual(location);
-        });
-    }
-
-    for (const invalidStrLocation of invalidStrLocations) {
-        it(`should throw on location "${invalidStrLocation}"`, () => {
-            expect(() => parseBitranLocation(invalidStrLocation)).toThrow();
-        });
-    }
-});
-
-describe('parsePartialBitranLocation', () => {
-    for (const [locationStr, context, expected] of partialLocations) {
-        it(`should produce ${JSON.stringify(expected)}`, () => {
-            expect(parsePartialBitranLocation(locationStr, context)).toEqual(
-                expected,
-            );
-        });
-    }
-
-    for (const [locationStr, context] of invalidPartialLocations) {
-        it(`should throw on location "${locationStr}"`, () => {
-            expect(() =>
-                parsePartialBitranLocation(locationStr, context),
-            ).toThrow();
-        });
-    }
-});
-
-describe('decode/encodeBitranLocation', () => {
-    it.each([
-        '',
-        'foo',
-        'foo|bar',
-        'foo|bar|baz',
-        'foo|bar/baz|qux',
-        'foo|bar/baz/qux|corge:grault:waldo',
-    ])('should not change string location %p', (testCase) =>
-        expect(decodeBitranLocation(encodeBitranLocation(testCase))).toBe(
-            testCase,
-        ),
-    );
-});
+import {
+    decodeBitranLocation,
+    encodeBitranLocation,
+    parseBitranLocation,
+    parsePartialBitranLocation,
+    stringifyBitranLocation,
+    type BitranLocation,
+} from '@erudit/shared/bitran/location';
+
+const locations: [BitranLocation, string][] = [
+    // Full locations
+    [{ type: 'article', path: 'foo', unique: 'bar' }, 'article|foo|bar'],
+    [{ type: 'group', path: 'foo', unique: 'bar' }, 'group|foo|bar'],
+    // Type + path
+    [{ type: 'article', path: 'foo' }, 'article|foo'],
+    [{ type: 'group', path: 'foo' }, 'group|foo'],
+];
+
+const partialLocations: [string, BitranLocation, BitranLocation][] = [
+    // Full string location
+    [
+        'article|foo/bar|baz',
+        { type: 'group', path: 'qux' },
+        { type: 'article', path: 'foo/bar', unique: 'baz' },
+    ],
+    // Only unique
+    [
+        'baz',
+        { type: 'summary', path: 'foo/bar' },
+        { type: 'summary', path: 'foo/bar', unique: 'baz' },
+    ],
+    [
+        'baz',
+        { type: 'contributor', path: 'John' },
+        { type: 'contributor', path: 'John', unique: 'baz' },
+    ],
+    // Topic context
+    [
+        'article|baz',
+        { type: 'practice', path: 'foo/bar' },
+        { type: 'article', path: 'foo/bar', unique: 'baz' },
+    ],
+];
+
+const invalidPartialLocations: [string, BitranLocation][] = [
+    // Referencing topic part in non-topic context
+    ['article|bar', { type: 'contributor', path: 'foo' }],
+];
+
+const invalidLocations = [
+    // Too few parts
+    { type: 'article' },
+    { path: 'foo' },
+    { unique: 'foo' },
+    // Unknown type
+    { type: 'foo' },
+    { type: 'foo', path: 'bar', unique: 'baz' },
+    // Locations that require path
+    { type: 'article', unique: 'foo' },
+    { type: 'summary', unique: 'foo' },
+    { type: 'practice', unique: 'foo' },
+    { type: 'group', unique: 'foo' },
+    { type: 'contributor', unique: 'foo' },
+];
+
+const invalidStrLocations = [
+    // Too few parts
+    'article',
+    'group',
+    // Unknown type
+    'foo',
+    'foo|bar',
+    'foo|bar|baz',
+    // Empty string unique
+    'article|foo/bar|',
+];
+
+//
+//
+//
+
+describe('stringifyBitranLocation', () => {
+    for (const [location, expected] of locations) {
+        it(`should produce "${expected}"`, () => {
+            expect(stringifyBitranLocation(location)).toBe(expected);
+        });
+    }
+
+    for (const invalidLocation of invalidLocations) {
+        it(`should throw on location ${JSON.stringify(invalidLocation)}`, () => {
+            expect(() =>
+                stringifyBitranLocation(invalidLocation as BitranLocation),
+            ).toThrow();
+        });
+    }
+});
+
+describe('parseBitranLocation', () => {
+    for (const [location, expected] of locations) {
+        it(`should produce ${JSON.stringify(expected)}`, () => {
+            expect(parseBitranLocation(expected)).toEqual(location);
+        });
+    }
+
+    for (const invalidStrLocation of invalidStrLocations) {
+        it(`should throw on location "${invalidStrLocation}"`, () => {
+            expect(() => parseBitranLocation(invalidStrLocation)).toThrow();
+        });
+    }
+});
+
+describe('parsePartialBitranLocation', () => {
+    for (const [locationStr, context, expected] of partialLocations) {
+        it(`should produce ${JSON.stringify(expected)}`, () => {
+            expect(parsePartialBitranLocation(locationStr, context)).toEqual(
+                expected,
+            );
+        });
+    }
+
+    for (const [locationStr, context] of invalidPartialLocations) {
+        it(`should throw on location "${locationStr}"`, () => {
+            expect(() =>
+                parsePartialBitranLocation(locationStr, context),
+            ).toThrow();
+        });
+    }
+});
+
+describe('decode/encodeBitranLocation', () => {
+    it.each([
+        '',
+        'foo',
+        'foo|bar',
+        'foo|bar|baz',
+        'foo|bar/baz|qux',
+        'foo|bar/baz/qux|corge:grault:waldo',
+    ])('should not change string location %p', (testCase) =>
+        expect(decodeBitranLocation(encodeBitranLocation(testCase))).toBe(
+            testCase,
+        ),
+    );
+});

package/server/plugin/bitran/core.ts

@@ -1,51 +0,0 @@
-import {
-    createBitranCore as _createBitranCore,
-    type GenericProductCore,
-} from 'bitran/core';
-
-import { ERUDIT_SERVER } from '@server/global';
-import type { BitranContext } from '@erudit/shared/bitran/context';
-
-// Erudit Products
-import { headingName } from '@erudit/shared/bitran/products/heading/shared';
-import { heading } from '@erudit/shared/bitran/products/heading/core';
-import { aliasName } from '@erudit/shared/bitran/products/alias/shared';
-import { defineAlias } from '@erudit/shared/bitran/products/alias/core';
-import { includeName } from '@erudit/shared/bitran/products/include/shared';
-import { include } from '@erudit/shared/bitran/products/include/core';
-import { linkName } from '@erudit/shared/bitran/products/link/shared';
-import { link } from '@erudit/shared/bitran/products/link/core';
-
-type Products = Record<string, GenericProductCore>;
-
-export async function createBitranCore(context: BitranContext) {
-    const projectProducts = await getProjectProducts();
-
-    const eruditProducts: Products = {
-        [aliasName]: defineAlias(context), // Exec aliases logic on server and pass resolved aliases as RenderData -> no actions on client at all
-        [includeName]: include,
-        [headingName]: heading,
-        [linkName]: link,
-    };
-
-    const bitranCore = _createBitranCore({
-        products: {
-            ...projectProducts,
-            ...eruditProducts,
-        },
-    });
-
-    return bitranCore;
-}
-
-async function getProjectProducts(): Promise<Products> {
-    const productDefinitions = ERUDIT_SERVER?.BITRAN_CONFIG?.products;
-
-    if (!productDefinitions) return {};
-
-    const projectProducts: Products = {};
-    for (const [name, definition] of Object.entries(productDefinitions))
-        projectProducts[name] = await definition.core();
-
-    return projectProducts;
-}

package/shared/bitran/alias.ts

@@ -1,17 +0,0 @@
-export type BitranAliases = Record<string, string>;
-
-export const NO_ALIASES: () => BitranAliases = () => ({});
-
-export function tryReplaceAlias(
-    target: string,
-    aliases: BitranAliases,
-): string {
-    if (!target.match(/^~\w+$/)) return target;
-
-    const alias = target.substring(1);
-    const replacement = aliases[alias];
-
-    if (!replacement) throw new Error(`Unknown alias "~${alias}"!`);
-
-    return replacement;
-}

package/shared/bitran/products/alias/core/factory.ts

@@ -1,46 +0,0 @@
-import { BlockParseFactory, ProductStrFactory } from 'bitran/process';
-
-import type { BitranAliases } from '@erudit/shared/bitran/alias';
-import type { AliasType } from '../shared';
-
-export class AliasParser extends BlockParseFactory<AliasType> {
-    regexp = /^~ (?<alias>\S+) (?<target>\S+)$/;
-    aliases: BitranAliases = {};
-
-    canParse(strBlock: string) {
-        const lines = strBlock.split('\n');
-
-        for (const line of lines) {
-            const match = line.match(this.regexp);
-            if (!match) return false;
-            this.aliases[match[1]!.trim()] = match[2]!.trim();
-        }
-
-        return true;
-    }
-
-    async createParseData(): Promise<Record<string, string>> {
-        const { provide: context } = this.getPayload();
-
-        for (const [alias, target] of Object.entries(this.aliases)) {
-            if (alias in context.aliases)
-                throw new Error(
-                    `Duplicate alias "${alias}" within Bitran context!\n` +
-                        `Current alias target: "${target}".\n` +
-                        `Context alias target: "${context.aliases[alias]}".`,
-                );
-
-            context.aliases[alias] = target;
-        }
-
-        return this.aliases;
-    }
-}
-
-export class AliasStr extends ProductStrFactory<AliasType> {
-    stringifyData(data: Record<string, string>): string {
-        return Object.entries(data)
-            .map(([alias, location]) => `~ ${alias} ${location}`)
-            .join('\n');
-    }
-}

package/shared/bitran/products/alias/core/index.ts

@@ -1,13 +0,0 @@
-import { BlockNode } from 'bitran/dom';
-import { defineProductCoreFn } from 'bitran/core';
-
-import type { AliasType } from '../shared';
-import { AliasParser, AliasStr } from './factory';
-
-export class AliasNode extends BlockNode<AliasType> {}
-
-export const defineAlias = defineProductCoreFn<AliasType>({
-    Node: AliasNode,
-    Parser: AliasParser,
-    Stringifier: AliasStr,
-});

package/shared/bitran/products/alias/render/Alias.vue

@@ -1,10 +0,0 @@
-<script lang="ts" setup>
-import type { ProductProps } from 'bitran/render';
-import type { AliasType } from '../shared';
-
-defineProps<ProductProps<AliasType>>();
-</script>
-
-<template>
-    <div>Alias</div>
-</template>

package/shared/bitran/products/alias/render/icon.svg

@@ -1,3 +0,0 @@
-<svg xmlns="http://www.w3.org/2000/svg" version="1.1" viewBox="0 0 24 24">
-    <path d="M4.5,23.8c-.9,0-1.7-.3-2.3-.9-.6-.6-.9-1.4-.9-2.3s.3-1.7.9-2.3c.6-.6,1.4-.9,2.3-.9s1,.1,1.4.3c.4.2.8.5,1.1.9,1.1-.6,1.9-1.3,2.6-2.3s1.1-2,1.2-3.2h-3.3c-.2.6-.6,1.2-1.2,1.6-.6.4-1.2.6-1.9.6s-1.7-.3-2.3-.9c-.6-.6-.9-1.4-.9-2.3s.3-1.7.9-2.3c.6-.6,1.4-.9,2.3-.9s1.3.2,1.9.6c.6.4.9.9,1.2,1.6h3.3c-.2-1.2-.6-2.3-1.2-3.2s-1.5-1.7-2.6-2.3c-.3.4-.7.7-1.1.9-.4.2-.9.3-1.4.3-.9,0-1.7-.3-2.3-.9-.6-.6-.9-1.4-.9-2.3s.3-1.7.9-2.3C2.8.5,3.6.2,4.5.2s1.7.3,2.3.9.9,1.4,1,2.3c1.5.8,2.7,1.8,3.6,3.1s1.5,2.8,1.7,4.5h5.7l-1.7-1.7,1.5-1.5,4.3,4.3-4.3,4.3-1.5-1.5,1.7-1.7h-5.7c-.2,1.7-.8,3.1-1.7,4.5-.9,1.3-2.1,2.4-3.6,3.1,0,.9-.4,1.7-1,2.3-.6.6-1.4.9-2.3.9Z"/>
-</svg>

package/shared/bitran/products/alias/render/index.ts

@@ -1,17 +0,0 @@
-import {
-    defineIcon,
-    defineLanguages,
-    defineProductComponent,
-    defineProductRender,
-    RenderMode,
-} from 'bitran/render';
-
-export const alias = defineProductRender({
-    mode: RenderMode.Server,
-    component: defineProductComponent(() => import('./Alias.vue')),
-    icon: defineIcon(() => import('./icon.svg?raw')),
-    languages: defineLanguages({
-        en: () => import('./languages/en'),
-        ru: () => import('./languages/ru'),
-    }),
-});

package/shared/bitran/products/alias/render/languages/en.ts

@@ -1,5 +0,0 @@
-import { defineLanguage } from 'bitran/render';
-
-export default defineLanguage({
-    _name: 'Aliases',
-});

package/shared/bitran/products/alias/render/languages/ru.ts

@@ -1,5 +0,0 @@
-import { defineLanguage } from 'bitran/render';
-
-export default defineLanguage({
-    _name: 'Перенаправления',
-});

package/shared/bitran/products/alias/shared.ts

@@ -1,11 +0,0 @@
-import type { DefineProductType } from 'bitran';
-
-import type { BitranAliases } from '@shared/bitran/alias';
-import type { BitranContext } from '@shared/bitran/context';
-
-export type AliasType = DefineProductType<{
-    ParseData: BitranAliases;
-    Provide: BitranContext;
-}>;
-
-export const aliasName = '__alias';

package/shared/bitran/products/heading/core/factory.ts

@@ -1,53 +0,0 @@
-import slugify from 'slugify';
-import { BlockParseFactory, ProductStrFactory } from 'bitran/process';
-
-import eruditConfig from '#erudit/config';
-import type { HeadingParseData, HeadingType } from '../shared';
-
-const validLevels = [1, 2, 3];
-
-export class HeadingParser extends BlockParseFactory<HeadingType> {
-    regexp = /^(?<level>#+) (?<title>.+)$/;
-    match?: RegExpMatchArray | null;
-
-    canParse(strBlock: string) {
-        this.match = strBlock.match(this.regexp);
-        return !!this.match;
-    }
-
-    async createParseData() {
-        const [, matchLevel, matchTitle] = this.match!;
-        const level = matchLevel!.length;
-        const title = matchTitle!.trim();
-
-        if (!validLevels.includes(level))
-            throw new Error(
-                `Invalid heading level: ${level}. Available levels: ${validLevels.join(', ')}.`,
-            );
-
-        if (!title) throw new Error(`Empty heading!`);
-
-        return {
-            level: level - 1,
-            title,
-        };
-    }
-
-    override alterAutoId(autoId: string) {
-        const { parseData, provide } = this.getPayload();
-
-        // TODO: If Chinese-like locale is set just return auto-id or original title?
-        let titleSlug = slugify(parseData.title, {
-            lower: true,
-            strict: true,
-            locale: provide?.languageCode || eruditConfig.language,
-        });
-        return titleSlug || autoId;
-    }
-}
-
-export class HeadingStr extends ProductStrFactory<HeadingType> {
-    stringifyData({ title, level }: HeadingParseData) {
-        return `${'#'.repeat(level + 1)} ${title}`;
-    }
-}

package/shared/bitran/products/heading/core/index.ts

@@ -1,19 +0,0 @@
-import { defineProductCore, defineProductCoreFn } from 'bitran/core';
-import { BlockNode } from 'bitran/dom';
-
-import type { HeadingType } from '../shared';
-import { HeadingParser, HeadingStr } from './factory';
-
-export class HeadingNode extends BlockNode<HeadingType> {}
-
-export const heading = defineProductCore<HeadingType>({
-    Node: HeadingNode,
-    Parser: HeadingParser,
-    Stringifier: HeadingStr,
-});
-
-export const defineLocaleHeading = defineProductCoreFn<HeadingType>({
-    Node: HeadingNode,
-    Parser: HeadingParser,
-    Stringifier: HeadingStr,
-});

package/shared/bitran/products/heading/render/Heading.vue

@@ -1,47 +0,0 @@
-<script lang="ts" setup>
-import { useParseData, usePrettyText, type ProductProps } from 'bitran/render';
-import { type HeadingType } from '../shared';
-
-const { node } = defineProps<ProductProps<HeadingType>>();
-const { level, title } = useParseData(node);
-const pretty = usePrettyText();
-</script>
-
-<template>
-    <component :is="`h${level + 2}`" :class="$style.h">
-        {{ pretty(title) }}
-    </component>
-</template>
-
-<style lang="scss" module>
-h2, h3, h4
-{
-    &.h
-    {
-        font-weight: 700;
-    }
-}
-
-h2.h
-{
-    font-size: 1.55em;
-    border-bottom: 1px solid light-dark(#dedede, #323232);
-    padding-bottom: 10px;
-}
-
-h3.h
-{
-    font-size: 1.2em;
-}
-
-h4.h
-{
-    font-size: 1.05em;
-}
-
-// Dirty hack to add extra space before the heading
-:global(.bitran-blockContainer:not(:first-of-type)):has(:global(> .bitran-block > .bitran-blockMain) > .h)
-{
-    margin-top: calc(var(--bitran_blocksGap) * 1.25);
-}
-</style>

package/shared/bitran/products/heading/render/icon.svg

@@ -1,3 +0,0 @@
-<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512">
-    <path d="M181.3 32.4c17.4 2.9 29.2 19.4 26.3 36.8L197.8 128l95.1 0 11.5-69.3c2.9-17.4 19.4-29.2 36.8-26.3s29.2 19.4 26.3 36.8L357.8 128l58.2 0c17.7 0 32 14.3 32 32s-14.3 32-32 32l-68.9 0L325.8 320l58.2 0c17.7 0 32 14.3 32 32s-14.3 32-32 32l-68.9 0-11.5 69.3c-2.9 17.4-19.4 29.2-36.8 26.3s-29.2-19.4-26.3-36.8l9.8-58.7-95.1 0-11.5 69.3c-2.9 17.4-19.4 29.2-36.8 26.3s-29.2-19.4-26.3-36.8L90.2 384 32 384c-17.7 0-32-14.3-32-32s14.3-32 32-32l68.9 0 21.3-128L64 192c-17.7 0-32-14.3-32-32s14.3-32 32-32l68.9 0 11.5-69.3c2.9-17.4 19.4-29.2 36.8-26.3zM187.1 192L165.8 320l95.1 0 21.3-128-95.1 0z" />
-</svg>

package/shared/bitran/products/heading/render/index.ts

@@ -1,17 +0,0 @@
-import {
-    defineIcon,
-    defineLanguages,
-    defineProductComponent,
-    defineProductRender,
-    RenderMode,
-} from 'bitran/render';
-
-export const heading = defineProductRender({
-    mode: RenderMode.Server,
-    component: defineProductComponent(() => import('./Heading.vue')),
-    icon: defineIcon(() => import('./icon.svg?raw')),
-    languages: defineLanguages({
-        en: () => import('./languages/en'),
-        ru: () => import('./languages/ru'),
-    }),
-});

package/shared/bitran/products/heading/render/languages/en.ts

@@ -1,5 +0,0 @@
-import { defineLanguage } from 'bitran/render';
-
-export default defineLanguage({
-    _name: 'Section',
-});

package/shared/bitran/products/heading/render/languages/ru.ts

@@ -1,5 +0,0 @@
-import { defineLanguage } from 'bitran/render';
-
-export default defineLanguage({
-    _name: 'Раздел',
-});

package/shared/bitran/products/heading/shared.ts

@@ -1,13 +0,0 @@
-import type { DefineProductType } from 'bitran';
-
-export interface HeadingParseData {
-    level: number;
-    title: string;
-}
-
-export type HeadingType = DefineProductType<{
-    ParseData: HeadingParseData;
-    Provide?: { languageCode: string };
-}>;
-
-export const headingName = '__heading';