erudit 2.0.0-dev.7 → 2.0.0-dev.9

package/server/plugin/build/rebuild.ts

@@ -1,55 +1,55 @@
-import chokidar, { type FSWatcher } from 'chokidar';
-
-import { ERUDIT_DIR, PROJECT_DIR } from '#erudit/globalPaths';
-import { ERUDIT_SERVER } from '@server/global';
-import { logger } from '@server/logger';
-import { build } from '@server/build/process';
-import { stress } from '@erudit/utils/stress';
-
-const watchTargets: string[] = [
-    // Languages
-    ERUDIT_DIR + '/languages',
-    // Content directory
-    PROJECT_DIR + '/content',
-    // Contributors directory
-    PROJECT_DIR + '/contributors',
-];
-
-const ignoreTargets: string[] = [];
-
-const rebuildDelay = 300;
-
-//
-//
-//
-
-let watcher: FSWatcher;
-let rebuildTimeout: any;
-let rebuildRequested = false;
-
-export async function setupRebuildWatcher() {
-    if (watcher) return;
-
-    watcher = chokidar.watch(watchTargets, {
-        ignored: ignoreTargets,
-        ignoreInitial: true,
-    });
-
-    watcher.on('all', (event, path) =>
-        requestServerRebuild(`File change: ${stress(path)}`),
-    );
-}
-
-export async function requestServerRebuild(reason?: string) {
-    if (rebuildRequested) return;
-
-    clearTimeout(rebuildTimeout);
-    rebuildTimeout = setTimeout(async () => {
-        rebuildRequested = true;
-        await ERUDIT_SERVER.BUILD_PROMISE;
-        console.log('\n');
-        logger.info(`Rebuilding server data!${reason ? ` ${reason}` : ''}\n\n`);
-        await build();
-        rebuildRequested = false;
-    }, rebuildDelay);
-}
+import chokidar, { type FSWatcher } from 'chokidar';
+
+import { ERUDIT_DIR, PROJECT_DIR } from '#erudit/globalPaths';
+import { ERUDIT_SERVER } from '@server/global';
+import { logger } from '@server/logger';
+import { build } from '@server/build/process';
+import { stress } from '@erudit/utils/stress';
+
+const watchTargets: string[] = [
+    // Languages
+    ERUDIT_DIR + '/languages',
+    // Content directory
+    PROJECT_DIR + '/content',
+    // Contributors directory
+    PROJECT_DIR + '/contributors',
+];
+
+const ignoreTargets: string[] = [];
+
+const rebuildDelay = 300;
+
+//
+//
+//
+
+let watcher: FSWatcher;
+let rebuildTimeout: any;
+let rebuildRequested = false;
+
+export async function setupRebuildWatcher() {
+    if (watcher) return;
+
+    watcher = chokidar.watch(watchTargets, {
+        ignored: ignoreTargets,
+        ignoreInitial: true,
+    });
+
+    watcher.on('all', (event, path) =>
+        requestServerRebuild(`File change: ${stress(path)}`),
+    );
+}
+
+export async function requestServerRebuild(reason?: string) {
+    if (rebuildRequested) return;
+
+    clearTimeout(rebuildTimeout);
+    rebuildTimeout = setTimeout(async () => {
+        rebuildRequested = true;
+        await ERUDIT_SERVER.BUILD_PROMISE;
+        console.log('\n');
+        logger.info(`Rebuilding server data!${reason ? ` ${reason}` : ''}\n\n`);
+        await build();
+        rebuildRequested = false;
+    }, rebuildDelay);
+}

package/server/plugin/build/setup.ts

@@ -1,21 +1,21 @@
-import eruditConfig from '#erudit/config';
-
-import { registerGlobals } from '@erudit/globals/register';
-import { debug } from '@server/logger';
-import { ERUDIT_SERVER } from '@server/global';
-
-import { setupRebuildWatcher } from './rebuild';
-import { setupDatabase } from '../db/setup';
-import { setupBitranConfig } from '../bitran/setup';
-
-export async function setup() {
-    debug.start('Running initial setup procedures...');
-
-    if (import.meta.dev) await setupRebuildWatcher();
-
-    registerGlobals();
-    ERUDIT_SERVER.CONFIG = eruditConfig;
-
-    await setupBitranConfig();
-    await setupDatabase();
-}
+import eruditConfig from '#erudit/config';
+
+import { registerGlobals } from '@erudit/globals/register';
+import { debug } from '@server/logger';
+import { ERUDIT_SERVER } from '@server/global';
+
+import { setupRebuildWatcher } from './rebuild';
+import { setupDatabase } from '../db/setup';
+import { setupBitranConfig } from '../bitran/setup';
+
+export async function setup() {
+    debug.start('Running initial setup procedures...');
+
+    if (import.meta.dev) await setupRebuildWatcher();
+
+    registerGlobals();
+    ERUDIT_SERVER.CONFIG = eruditConfig;
+
+    await setupBitranConfig();
+    await setupDatabase();
+}

package/server/plugin/global.ts

@@ -1,18 +1,18 @@
-import type { DataSource } from 'typeorm';
-import type { EruditConfig } from 'erudit-cog/schema';
-
-import type { EruditPhrases } from '@shared/types/language';
-import type { NavNode, RootNavNode } from '@server/nav/node';
-import type { EruditBitranConfig } from '@erudit/globals/bitran';
-
-interface EruditServer {
-    BUILD_PROMISE: Promise<void>;
-    CONFIG: Partial<EruditConfig>;
-    LANGUAGE: { phrases: EruditPhrases; functions: Record<string, Function> };
-    DB: DataSource;
-    NAV?: RootNavNode;
-    NAV_BOOKS?: Record<string, NavNode>;
-    BITRAN_CONFIG?: Partial<EruditBitranConfig>;
-}
-
-export const ERUDIT_SERVER: EruditServer = {} as any;
+import type { DataSource } from 'typeorm';
+import type { EruditConfig } from 'erudit-cog/schema';
+
+import type { EruditPhrases } from '@shared/types/language';
+import type { NavNode, RootNavNode } from '@server/nav/node';
+import type { EruditBitranConfig } from '@erudit/globals/bitran';
+
+interface EruditServer {
+    BUILD_PROMISE: Promise<void>;
+    CONFIG: Partial<EruditConfig>;
+    LANGUAGE: { phrases: EruditPhrases; functions: Record<string, Function> };
+    DB: DataSource;
+    NAV?: RootNavNode;
+    NAV_BOOKS?: Record<string, NavNode>;
+    BITRAN_CONFIG?: Partial<EruditBitranConfig>;
+}
+
+export const ERUDIT_SERVER: EruditServer = {} as any;

package/server/plugin/importer.ts

@@ -1,12 +1,12 @@
-import { createJiti } from 'jiti';
-import { ERUDIT_DIR } from '#erudit/globalPaths';
-
-const jiti = createJiti(ERUDIT_DIR, {
-    // Enable reimporting same files during process in development mode
-    fsCache: !import.meta.dev,
-    moduleCache: !import.meta.dev,
-});
-
-export async function IMPORT(...args: Parameters<typeof jiti.import>) {
-    return jiti.import(...args) as Promise<any>;
-}
+import { createJiti } from 'jiti';
+import { ERUDIT_DIR } from '#erudit/globalPaths';
+
+const jiti = createJiti(ERUDIT_DIR, {
+    // Enable reimporting same files during process in development mode
+    fsCache: !import.meta.dev,
+    moduleCache: !import.meta.dev,
+});
+
+export async function IMPORT(...args: Parameters<typeof jiti.import>) {
+    return jiti.import(...args) as Promise<any>;
+}

package/server/plugin/index.ts

@@ -1,9 +1,9 @@
-import { ERUDIT_SERVER } from './global';
-import { build } from './build/process';
-import { close } from './build/close';
-
-export default defineNitroPlugin((_nitro) => {
-    ERUDIT_SERVER.BUILD_PROMISE = build();
-    _nitro.hooks.hook('request', async () => await ERUDIT_SERVER.BUILD_PROMISE);
-    _nitro.hooks.hook('close', close);
-});
+import { ERUDIT_SERVER } from './global';
+import { build } from './build/process';
+import { close } from './build/close';
+
+export default defineNitroPlugin((_nitro) => {
+    ERUDIT_SERVER.BUILD_PROMISE = build();
+    _nitro.hooks.hook('request', async () => await ERUDIT_SERVER.BUILD_PROMISE);
+    _nitro.hooks.hook('close', close);
+});

package/server/plugin/logger.ts

@@ -1,23 +1,23 @@
-import chalk from 'chalk';
-import { createConsola } from 'consola';
-import { brandColorTitle } from 'erudit-cog/utils/brand';
-
-import eruditConfig from '#erudit/config';
-
-// TODO: Consola has buggy behaviour when called inside Nitro
-// @see https://github.com/nitrojs/nitro/issues/3079
-
-export const logger = createConsola({
-    defaults: {
-        //tag: brandColorTitle + ' Server',
-        message: chalk.gray(`[${brandColorTitle} Server]`),
-    },
-});
-
-export const debug = createConsola({
-    defaults: {
-        //tag: brandColorTitle + ' Server Debug',
-        message: chalk.gray(`[${brandColorTitle} Server Debug]`),
-        level: eruditConfig?.debug?.log ? 3 : -999,
-    },
-});
+import chalk from 'chalk';
+import { createConsola } from 'consola';
+import { brandColorTitle } from 'erudit-cog/utils/brand';
+
+import eruditConfig from '#erudit/config';
+
+// TODO: Consola has buggy behaviour when called inside Nitro
+// @see https://github.com/nitrojs/nitro/issues/3079
+
+export const logger = createConsola({
+    defaults: {
+        //tag: brandColorTitle + ' Server',
+        message: chalk.gray(`[${brandColorTitle} Server]`),
+    },
+});
+
+export const debug = createConsola({
+    defaults: {
+        //tag: brandColorTitle + ' Server Debug',
+        message: chalk.gray(`[${brandColorTitle} Server Debug]`),
+        level: eruditConfig?.debug?.log ? 3 : -999,
+    },
+});

package/server/tsconfig.json

@@ -1,7 +1,7 @@
-{
-    "extends": "../../../playground/.erudit/nuxt/.nuxt/tsconfig.server.json",
-    "compilerOptions": {
-        "verbatimModuleSyntax": true
-    },
-    "exclude": ["../module/**/*", "../globalPath.ts"]
-}
+{
+    "extends": "../../../playground/.erudit/nuxt/.nuxt/tsconfig.server.json",
+    "compilerOptions": {
+        "verbatimModuleSyntax": true
+    },
+    "exclude": ["../module/**/*", "../globalPath.ts"]
+}

package/shared/bitran/context.ts

@@ -1,7 +1,8 @@
-import type { BitranAliases } from './alias';
+import { type Aliases } from '@erudit-js/bitran-elements/aliases/shared';
+
 import type { BitranLocation } from './location';
 
 export interface BitranContext {
     location: BitranLocation;
-    aliases: BitranAliases;
+    aliases: Aliases;
 }

package/shared/bitran/default.ts

@@ -0,0 +1,46 @@
+import {
+    defineBitranElement,
+    type BitranElements,
+} from '@erudit/globals/bitran';
+
+// Erudit Default Elements
+import {
+    aliasesName,
+    type AliasesSchema,
+} from '@erudit-js/bitran-elements/aliases/shared';
+import { aliasesTranspiler } from '@erudit-js/bitran-elements/aliases/transpiler';
+import { aliasesRenderer } from '@erudit-js/bitran-elements/aliases/renderer';
+import {
+    includeName,
+    type IncludeSchema,
+} from '@erudit-js/bitran-elements/include/shared';
+import { includeTranspiler } from '@erudit-js/bitran-elements/include/transpiler';
+import { includeRenderer } from '@erudit-js/bitran-elements/include/renderer';
+import {
+    headingName,
+    type HeadingSchema,
+} from '@erudit-js/bitran-elements/heading/shared';
+import { headingTranspiler } from '@erudit-js/bitran-elements/heading/transpiler';
+import { headingRenderer } from '@erudit-js/bitran-elements/heading/renderer';
+import { linkName, type LinkSchema } from '@erudit/shared/bitran/link/shared';
+import { linkTranspiler } from '@erudit/shared/bitran/link/transpiler';
+import { linkRenderer } from '@erudit/shared/bitran/link/renderer';
+
+export const defaultElements: BitranElements = {
+    [aliasesName]: defineBitranElement<AliasesSchema>({
+        transpiler: async () => aliasesTranspiler,
+        renderer: async () => aliasesRenderer,
+    }),
+    [includeName]: defineBitranElement<IncludeSchema>({
+        transpiler: async () => includeTranspiler,
+        renderer: async () => includeRenderer,
+    }),
+    [headingName]: defineBitranElement<HeadingSchema>({
+        transpiler: async () => headingTranspiler,
+        renderer: async () => headingRenderer,
+    }),
+    [linkName]: defineBitranElement<LinkSchema>({
+        transpiler: async () => linkTranspiler,
+        renderer: async () => linkRenderer,
+    }),
+};

package/shared/bitran/{products/link/render → link}/Link.vue

@@ -1,17 +1,17 @@
 <script lang="ts" setup>
-import { useParseData, useRenderData, type ProductProps } from 'bitran/render';
+import type { ElementProps } from '@bitran-js/renderer-vue';
 import { isContentType, isTopicPart } from 'erudit-cog/schema';
 
 import { CONTENT_TYPE_ICON, ICON, TOPIC_PART_ICON } from '@erudit/shared/icons';
-import type { LinkType } from '../shared';
+import type { LinkSchema } from './shared';
 import { MyIcon, MyRuntimeIcon } from '#components';
 import { showPreview, togglePreview } from '@erudit/app/scripts/preview/state';
 import { PreviewRequestType } from '@erudit/app/scripts/preview/request';
 import { encodeBitranLocation } from '@erudit/shared/bitran/location';
 
-const { node } = defineProps<ProductProps<LinkType>>();
-const { label } = useParseData(node);
-const linkTarget = useRenderData(node);
+const { node } = defineProps<ElementProps<LinkSchema>>();
+const { label } = node.parseData;
+const linkTarget = node.renderData;
 
 const baseUrlPath = useBaseUrlPath();
 const formatText = useFormatText();
@@ -22,7 +22,7 @@ const Icon = await (async () => {
     if (type === 'unique') {
         return h(MyRuntimeIcon, {
             name: 'link-icon',
-            svg: await useBitranProductIcon(linkTarget._productName!),
+            svg: await useBitranElementIcon(linkTarget._productName!),
         });
     } else if (type === 'absolute') {
         return h(MyIcon, { name: 'link' });
@@ -96,7 +96,7 @@ function linkClick(e: Event) {
 
     showPreview({
         type: PreviewRequestType.Link,
-        linkData: useParseData(node),
+        linkData: node.parseData,
         linkTarget,
     });
 
@@ -158,13 +158,6 @@ function linkClick(e: Event) {
 
         text-decoration: none;
         color: color-mix(in srgb, var(--linkColor), transparent 10%);
-
-        // &,
-        // & svg {
-        //     width: #{$iconSize};
-        //     height: #{$iconSize};
-        //     fill: currentColor;
-        // }
     }
 
     .label {

package/shared/bitran/link/factory.ts

@@ -0,0 +1,24 @@
+import {
+    RegexpInlinerParseFactory,
+    StringifyFactory,
+} from '@bitran-js/transpiler';
+
+import type { LinkNode, LinkSchema } from './shared';
+
+export class LinkParser extends RegexpInlinerParseFactory<LinkSchema> {
+    regexp = /\[(.+?)\]\((.+?)\)/gm;
+
+    override async parseDataFromRegexp(match: RegExpExecArray) {
+        return {
+            label: match[1]!,
+            target: match[2]!,
+        };
+    }
+}
+
+export class LinkStringifier extends StringifyFactory<LinkSchema> {
+    override async stringifyElement(elementNode: LinkNode): Promise<string> {
+        const parseData = elementNode.parseData;
+        return `[${parseData.label}](${parseData.target})`;
+    }
+}

package/shared/bitran/link/languages/en.ts

@@ -0,0 +1,7 @@
+import { defineLanguage } from '@bitran-js/renderer-vue';
+
+const english = defineLanguage({
+    _element_title: 'Link',
+});
+
+export default english;

package/shared/bitran/link/languages/ru.ts

@@ -0,0 +1,7 @@
+import { defineLanguage } from '@bitran-js/renderer-vue';
+
+const russian = defineLanguage({
+    _element_title: 'Ссылка',
+});
+
+export default russian;

package/shared/bitran/link/renderer.ts

@@ -0,0 +1,21 @@
+import {
+    defineElementVueRenderer,
+    defineComponent,
+    defineIcon,
+    defineLanguages,
+} from '@bitran-js/renderer-vue';
+
+import { LinkNode, type LinkSchema } from './shared';
+
+export const linkRenderer = defineElementVueRenderer<LinkSchema>({
+    Node: LinkNode,
+    component: defineComponent(() => import('./Link.vue')),
+    icon: defineIcon(() => import('./icon.svg?raw')),
+    languages: defineLanguages({
+        en: () => import('./languages/en'),
+        ru: () => import('./languages/ru'),
+    }),
+    createRenderData: async () => {
+        throw Error('Render data for Links must be built only on server side!');
+    },
+});

package/shared/bitran/link/shared.ts

@@ -0,0 +1,17 @@
+import { InlinerNode, type DefineElementSchema } from '@bitran-js/core';
+
+import type { LinkTarget } from './target';
+
+export const linkName = 'link';
+
+export interface LinkParseData {
+    target: string;
+    label: string;
+}
+
+export type LinkSchema = DefineElementSchema<{
+    ParseData: LinkParseData;
+    RenderData: LinkTarget;
+}>;
+
+export class LinkNode extends InlinerNode<LinkSchema> {}

package/shared/bitran/{products/link → link}/target.ts

@@ -1,7 +1,7 @@
 import { isTopicPart } from 'erudit-cog/schema';
+import { tryReplaceAlias } from '@erudit-js/bitran-elements/aliases/shared';
 
 import type { BitranContext } from '@shared/bitran/context';
-import { tryReplaceAlias } from '@shared/bitran/alias';
 import {
     bitranLocationTypes,
     parsePartialBitranLocation,

package/shared/bitran/link/transpiler.ts

@@ -0,0 +1,10 @@
+import { defineElementTranspiler } from '@bitran-js/transpiler';
+
+import { LinkNode, type LinkSchema } from './shared';
+import { LinkParser, LinkStringifier } from './factory';
+
+export const linkTranspiler = defineElementTranspiler<LinkSchema>({
+    Node: LinkNode,
+    Parsers: [LinkParser],
+    Stringifier: LinkStringifier,
+});

package/shared/content/context.ts

@@ -1,9 +1,9 @@
-export interface ContextItem {
-    type: string;
-    icon: string;
-    title: string;
-    href: string;
-    hidden: boolean;
-}
-
-export type Context = ContextItem[];
+export interface ContextItem {
+    type: string;
+    icon: string;
+    title: string;
+    href: string;
+    hidden: boolean;
+}
+
+export type Context = ContextItem[];

package/shared/content/data/base.ts

@@ -1,32 +1,32 @@
-import type {
-    ContentFlag,
-    ContentReferences,
-    ContentSeo,
-    ContentType,
-    TopicPart,
-} from 'erudit-cog/schema';
-
-import type { Context } from '@shared/content/context';
-import type { PreviousNext } from '@shared/content/previousNext';
-import type { ImageData } from '@shared/image';
-
-export interface ContentGenericData {
-    contentId: string;
-    title?: string;
-    description?: string;
-    decoration?: string;
-    type: ContentType;
-    context: Context;
-    flags: Record<ContentFlag, boolean>;
-    topicPart?: TopicPart;
-    seo?: Partial<ContentSeo>;
-    ogImage?: ImageData;
-    previousNext: PreviousNext;
-    dependencies?: Record<string, string>;
-    references?: ContentReferences;
-}
-
-export interface ContentBaseData {
-    type: ContentType;
-    generic: ContentGenericData;
-}
+import type {
+    ContentFlag,
+    ContentReferences,
+    ContentSeo,
+    ContentType,
+    TopicPart,
+} from 'erudit-cog/schema';
+
+import type { Context } from '@shared/content/context';
+import type { PreviousNext } from '@shared/content/previousNext';
+import type { ImageData } from '@shared/image';
+
+export interface ContentGenericData {
+    contentId: string;
+    title?: string;
+    description?: string;
+    decoration?: string;
+    type: ContentType;
+    context: Context;
+    flags: Record<ContentFlag, boolean>;
+    topicPart?: TopicPart;
+    seo?: Partial<ContentSeo>;
+    ogImage?: ImageData;
+    previousNext: PreviousNext;
+    dependencies?: Record<string, string>;
+    references?: ContentReferences;
+}
+
+export interface ContentBaseData {
+    type: ContentType;
+    generic: ContentGenericData;
+}

package/shared/content/data/index.ts

@@ -1,5 +1,5 @@
-import type { ContentTopicData } from './type/topic';
-import type { ContentGroupData } from './type/group';
-import type { ContentBookData } from './type/book';
-
-export type ContentData = ContentTopicData | ContentGroupData | ContentBookData;
+import type { ContentTopicData } from './type/topic';
+import type { ContentGroupData } from './type/group';
+import type { ContentBookData } from './type/book';
+
+export type ContentData = ContentTopicData | ContentGroupData | ContentBookData;

package/shared/content/data/type/book.ts

@@ -1,5 +1,5 @@
-import type { ContentBaseData } from '../base';
-
-export interface ContentBookData extends ContentBaseData {
-    type: 'book';
-}
+import type { ContentBaseData } from '../base';
+
+export interface ContentBookData extends ContentBaseData {
+    type: 'book';
+}

package/shared/content/data/type/group.ts

@@ -1,6 +1,6 @@
-import type { ContentBaseData } from '../base';
-
-export interface ContentGroupData extends ContentBaseData {
-    type: 'group';
-    bookTitle?: string;
-}
+import type { ContentBaseData } from '../base';
+
+export interface ContentGroupData extends ContentBaseData {
+    type: 'group';
+    bookTitle?: string;
+}