Changes from jan-2024 to feb-2024

Author: StanislavPetrovIcs

.env

@@ -30,7 +30,8 @@
 		"core/extensions/markdown/core/render/logic/Markdoc",
 		"*.js",
 
-		"**/dist/**/*"
+		"**/dist/**/*",
+		"target/tauri/target"
 	],
 	"plugins": ["@typescript-eslint", "react", "react-hooks", "promise"],
 	"settings": {
@@ -81,11 +82,13 @@
 		"@typescript-eslint/no-unsafe-assignment": "off",
 		"@typescript-eslint/no-unsafe-member-access": "off",
 		"@typescript-eslint/restrict-plus-operands": "off",
+		"@typescript-eslint/no-unused-vars": "warn",
 		"@typescript-eslint/restrict-template-expressions": "off",
 		"@typescript-eslint/no-unsafe-any": "off",
 		"@typescript-eslint/no-explicit-any": "off",
 		"@typescript-eslint/no-unsafe-call": "off",
 		"@typescript-eslint/explicit-function-return-type": "off",
+		"@typescript-eslint/no-base-to-string": "warn",
 		"no-case-declarations": "off",
 
 		"prefer-const": "warn",

.eslintrc

@@ -52,7 +52,8 @@ yarn-error.log*
 .Trashes
 ehthumbs.db
 Thumbs.db
-junit.xml
+.env*
+junit*.xml
 .idea/
 
 

.gitignore

@@ -9,7 +9,7 @@ Gramax — это бесплатный текстовый редактор со
 
 ### Разворачивание приложения для редактирования
 
-Чтобы начать редактировать документацию, достаточно скачать приложение или открыть его в браузере. Ссылки доступны на [gram.ax](https://gram.ax).
+Чтобы начать редактировать документацию, достаточно скачать приложение или открыть его в браузере. Ссылки доступны на нашем [сайте](https://gram.ax).
 
 ### Разворачивание портала для читателей
 
@@ -22,15 +22,15 @@ Gramax — это бесплатный текстовый редактор со
 Откройте ваш терминал и выполните команду:
 
 ```bash
-curl https://raw.githubusercontent.com/StanislavPetrovIcs/test-gramax-setup/main/setup.sh | bash; docker compose up
+curl -O https://gram.ax/docker-compose.yaml; docker compose up
 ```
 
 #### На Windows
 
 Откройте powershell и выполните команду:
 
 ```powershell
-Invoke-Expression (Invoke-WebRequest -Uri "https://raw.githubusercontent.com/StanislavPetrovIcs/test-gramax-setup/main/setup.ps1" -UseBasicParsing).Content; docker compose up
+Invoke-WebRequest -Uri "https://gram.ax/docker-compose.yaml" -OutFile "docker-compose.yaml"; docker compose up
 ```
 
 ### Запуск для разработки (Vite и Next.js)

README.md

@@ -16,9 +16,9 @@ import Logger from "@ext/loggers/Logger";
 import MarkdownParser from "@ext/markdown/core/Parser/Parser";
 import ParserContextFactory from "@ext/markdown/core/Parser/ParserContext/ParserContextFactory";
 import MarkdownFormatter from "@ext/markdown/core/edit/logic/Formatter/Formatter";
+import FuseSearcher from "@ext/search/Fuse/FuseSearcher";
 import IndexCacheProvider from "@ext/search/IndexCacheProvider";
-import LunrSearcher from "@ext/search/Lunr/Searcher";
-import Searcher from "@ext/search/Searcher";
+import { IndexDataProvider } from "@ext/search/IndexDataProvider";
 import AuthManager from "@ext/security/logic/AuthManager";
 import { TicketManager } from "@ext/security/logic/TicketManager/TicketManager";
 import { AppConfig } from "../config/AppConfig";
@@ -42,7 +42,7 @@ const _init = async (config: AppConfig): Promise<Application> => {
 	await fp.validate();
 
 	const libRules = getExecutingEnvironment() == "browser" ? [deleteAnyFolderRule] : [];
-	const lib = new Library(rp);
+	const lib = new Library(rp, config.isServerApp);
 	await lib.addFileProvider(fp, (fs) => FSLocalizationRules.bind(fs), libRules);
 
 	if (config.paths.local) {
@@ -51,8 +51,8 @@ const _init = async (config: AppConfig): Promise<Application> => {
 		await lib.addFileProvider(fp);
 	}
 
-	const cacheFileProvider = new FileProvider(config.paths.cache);
-	const cache = new IndexCacheProvider(cacheFileProvider);
+	const cacheFileProvider = new FileProvider(config.paths.userDataPath);
+	const indexCacheProvider = new IndexCacheProvider(cacheFileProvider);
 	const hashes = new Hash();
 	const tm = new ThemeManager();
 	const encoder = new Encoder();
@@ -70,15 +70,9 @@ const _init = async (config: AppConfig): Promise<Application> => {
 		config.enterpriseServerUrl,
 	);
 	const logger: Logger = new BugsnagLogger(config.bugsnagApiKey);
-	const searcher: Searcher = new LunrSearcher(lib, parser, parserContextFactory, cache);
-	const sitePresenterFactory = new SitePresenterFactory(
-		lib,
-		parser,
-		parserContextFactory,
-		searcher,
-		rp,
-		errorArticlesProvider,
-	);
+	const indexDataProvider = new IndexDataProvider(lib, parser, parserContextFactory, indexCacheProvider);
+	const searcher = new FuseSearcher(indexDataProvider);
+	const sitePresenterFactory = new SitePresenterFactory(lib, parser, parserContextFactory, rp, errorArticlesProvider);
 	const contextFactory = new ContextFactory(tm, config.cookieSecret);
 
 	return {
@@ -100,13 +94,14 @@ const _init = async (config: AppConfig): Promise<Application> => {
 		parserContextFactory,
 		errorArticlesProvider,
 		conf: {
-			corsProxy: corsProxy,
+			corsProxy,
 			branch: config.branch,
 			basePath: config.paths.base,
 			isReadOnly: config.isReadOnly,
 			isServerApp: config.isServerApp,
 			ssoServerUrl: config.ssoServerUrl,
 			ssoPublicKey: config.ssoPublicKey,
+			authServiceUrl: config.authServiceUrl,
 			isProduction: config.isProduction,
 			enterpriseServerUrl: config.enterpriseServerUrl,
 			bugsnagApiKey: config.bugsnagApiKey,

app/browser/app.ts

@@ -11,6 +11,7 @@ const configure = (): AppConfig => {
 		branch: env("BRANCH") ?? "develop",
 		ssoServerUrl: env("SSO_SERVER_URL") ?? null,
 		ssoPublicKey: env("SSO_PUBLIC_KEY") ?? null,
+		authServiceUrl: env("AUTH_SERVICE_URL") ?? "https://app.gram.ax/-server/auth",
 		enterpriseServerUrl: env("ENTERPRISE_SERVER_URL") ?? null,
 		bugsnagApiKey: env("BUGSNAG_API_KEY") ?? null,
 		cookieSecret: env("COOKIE_SECRET") ?? null,

app/browser/configure.ts

@@ -1,5 +1,6 @@
 import { AuthorizeMiddleware } from "@core/Api/middleware/AuthorizeMiddleware";
 import { DesktopModeMiddleware } from "@core/Api/middleware/DesktopModeMiddleware";
+import ReloadConfirmMiddleware from "@core/Api/middleware/ReloadConfirmMiddleware";
 import Context from "@core/Context/Context";
 import Path from "@core/FileProvider/Path/Path";
 import ResourceUpdater from "@core/Resource/ResourceUpdater";
@@ -11,7 +12,7 @@ const create: Command<{ ctx: Context; catalogName: string; parentPath?: Path },
 
 	kind: ResponseKind.plain,
 
-	middlewares: [new AuthorizeMiddleware(), new DesktopModeMiddleware()],
+	middlewares: [new AuthorizeMiddleware(), new DesktopModeMiddleware(), new ReloadConfirmMiddleware()],
 
 	async do({ ctx, catalogName, parentPath }) {
 		const { formatter, lib, parser, parserContextFactory } = this._app;
@@ -27,7 +28,7 @@ const create: Command<{ ctx: Context; catalogName: string; parentPath?: Path },
 			parentPath ? parentRef : null,
 		);
 
-		return article.logicPath;
+		return await catalog.getPathname(article);
 	},
 
 	params(ctx: Context, query: { [key: string]: string }) {

app/commands/article/create.ts

@@ -0,0 +1,27 @@
+import { Command, ResponseKind } from "@app/types/Command";
+import Path from "@core/FileProvider/Path/Path";
+import RouterPathProvider from "@core/RouterPath/RouterPathProvider";
+
+const app: Command<{ catalogName: string; articlePath: Path }, string> = Command.create({
+	path: "article/editOn/app",
+
+	kind: ResponseKind.plain,
+
+	async do({ catalogName, articlePath }) {
+		const { lib } = this._app;
+		const catalog = await lib.getCatalog(catalogName);
+		if (!catalog) return;
+		const fp = lib.getFileProviderByCatalog(catalog);
+		const itemRef = fp.getItemRef(articlePath);
+		const item = catalog.findArticleByItemRef(itemRef);
+		return RouterPathProvider.getPathname(await catalog.getPathnameData(item)).value;
+	},
+
+	params(ctx, q) {
+		const catalogName = q.catalogName;
+		const articlePath = new Path(q.articlePath);
+		return { ctx, catalogName, articlePath };
+	},
+});
+
+export default app;

app/commands/article/editOn/app.ts

@@ -1,17 +1,19 @@
-import Path from "@core/FileProvider/Path/Path";
 import { Command, ResponseKind } from "@app/types/Command";
+import Path from "@core/FileProvider/Path/Path";
 
-const fileLink: Command<{ catalogName: string; articlePath: Path }, string> = Command.create({
-	path: "article/redirect/fileLink",
+const source: Command<{ catalogName: string; articlePath: Path }, string> = Command.create({
+	path: "article/editOn/source",
 
-	kind: ResponseKind.redirect,
+	kind: ResponseKind.plain,
 
 	async do({ catalogName, articlePath }) {
 		const { lib } = this._app;
 		const catalog = await lib.getCatalog(catalogName);
+		if (!catalog) return;
+		if (!articlePath.startsWith(catalog.getBasePath())) return;
 		const fp = lib.getFileProviderByCatalog(catalog);
 		const itemRef = fp.getItemRef(articlePath);
-		const path = catalog?.getRelativeRepPath(itemRef) ?? null;
+		const path = catalog.getRelativeRepPath(itemRef);
 		const { gitVersionControl } = await catalog.repo.gvc.getGitVersionControlContainsItem(path);
 
 		return await catalog.repo.storage.getFileLink(path, await gitVersionControl.getCurrentBranch());
@@ -24,4 +26,4 @@ const fileLink: Command<{ catalogName: string; articlePath: Path }, string> = Co
 	},
 });
 
-export default fileLink;
+export default source;

app/commands/article/redirect/fileLink.ts renamed to app/commands/article/editOn/source.ts

@@ -1,29 +1,28 @@
 import { AuthorizeMiddleware } from "@core/Api/middleware/AuthorizeMiddleware";
-import { DesktopModeMiddleware } from "@core/Api/middleware/DesktopModeMiddleware";
 import Context from "@core/Context/Context";
 import Path from "@core/FileProvider/Path/Path";
 import { Article } from "@core/FileStructue/Article/Article";
-import { ArticleData } from "@core/SitePresenter/SitePresenter";
+import { ArticlePageData } from "@core/SitePresenter/SitePresenter";
 import DefaultError from "../../../../core/extensions/errorHandlers/logic/DefaultError";
 import { Command, ResponseKind } from "../../../types/Command";
 
-const checkLastModified: Command<{ ctx: Context; articlePath: Path; catalogName: string }, ArticleData> =
+const checkLastModified: Command<{ ctx: Context; articlePath: Path; catalogName: string }, ArticlePageData> =
 	Command.create({
 		path: "article/features/checkLastModified",
 
 		kind: ResponseKind.json,
 
-		middlewares: [new AuthorizeMiddleware(), new DesktopModeMiddleware()],
+		middlewares: [new AuthorizeMiddleware()],
 
 		async do({ ctx, articlePath, catalogName }) {
 			const { lib, sitePresenterFactory } = this._app;
 			const catalog = await lib.getCatalog(catalogName);
-			if (!catalog) return;
+			if (!catalog || !catalog.getRootCategory().items.length) return;
 
 			const fp = lib.getFileProviderByCatalog(catalog);
 			const itemRef = fp.getItemRef(articlePath);
-			const article = catalog.findItemByItemRef(itemRef) as Article;
-			if (!article) return;
+			const article = catalog.findItemByItemRef<Article>(itemRef);
+			if (!article || article.props.welcome) return;
 			let res = false;
 
 			try {
@@ -33,7 +32,7 @@ const checkLastModified: Command<{ ctx: Context; articlePath: Path; catalogName:
 				if (e?.code === "ENOENT") throw new DefaultError(null, e, { errorCode: e?.code });
 			}
 
-			return res ? await sitePresenterFactory.fromContext(ctx).getArticleData(article, catalog) : null;
+			return res ? await sitePresenterFactory.fromContext(ctx).getArticlePageData(article, catalog) : null;
 		},
 
 		params(ctx, q) {