morten/plainidx
1
0
Fork 0
mirror of https://github.com/morten-olsen/plainidx.git synced 2026-02-08 01:06:24 +01:00
Code Issues Packages Projects Releases Wiki Activity

Compare commits

base: morten:0.1.4
Branches Tags
morten:main
morten:0.1.4 morten:0.1.3 morten:0.1.2 morten:0.1.1 morten:0.1.0
...
compare: morten:main
Branches Tags
morten:main
morten:0.1.4 morten:0.1.3 morten:0.1.2 morten:0.1.1 morten:0.1.0

1 Commits
0.1.4 ... main

Author SHA1 Message Date
Morten Olsen
99248e98b5 prepare for client/server split 2024-12-11 12:32:23 +01:00
51 changed files with 409 additions and 1500 deletions
Expand all files Collapse all files

24
app/.gitignore vendored
View File

@@ -1,24 +0,0 @@
# Logs
logs
*.log
npm-debug.log*
yarn-debug.log*
yarn-error.log*
pnpm-debug.log*
lerna-debug.log*
node_modules
dist
dist-ssr
*.local
# Editor directories and files
.vscode/*
!.vscode/extensions.json
.idea
.DS_Store
*.suo
*.ntvs*
*.njsproj
*.sln
*.sw?

13
app/index.html
View File

@@ -1,13 +0,0 @@
<!doctype html>
<html lang="en">
<head>
<meta charset="UTF-8" />
<link rel="icon" type="image/svg+xml" href="/vite.svg" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Vite + React + TS</title>
</head>
<body>
<div id="root"></div>
<script type="module" src="/src/main.tsx"></script>
</body>
</html>

28
app/package.json
View File

@@ -1,28 +0,0 @@
{
"name": "app",
"private": true,
"version": "0.0.0",
"type": "module",
"scripts": {
"dev": "vite",
"build": "tsc -b && vite build",
"lint": "eslint .",
"preview": "vite preview"
},
"dependencies": {
"@plainidx/plainidx": "workspace:*",
"@plainidx/react": "workspace:*",
"react": "^18.3.1",
"react-dom": "^18.3.1"
},
"devDependencies": {
"@eslint/js": "^9.15.0",
"@types/react": "^18.3.12",
"@types/react-dom": "^18.3.1",
"@vitejs/plugin-react-swc": "^3.5.0",
"globals": "^15.12.0",
"typescript": "~5.6.2",
"typescript-eslint": "^8.15.0",
"vite": "^6.0.1"
}
}

9
app/src/app.tsx
View File

@@ -1,9 +0,0 @@
const App = () => {
return (
<div>
<h1>Hello World</h1>
</div>
);
};
export { App };

14
app/src/main.tsx
View File

@@ -1,14 +0,0 @@
import { StrictMode } from 'react';
import { createRoot } from 'react-dom/client';
import { App } from './app.tsx';
const root = document.createElement('div');
if (!root) {
throw new Error('Root element not found');
}
createRoot(root).render(
<StrictMode>
<App />
</StrictMode>,
);

1
app/src/vite-env.d.ts vendored
View File

@@ -1 +0,0 @@
/// <reference types="vite/client" />

26
app/tsconfig.app.json
View File

@@ -1,26 +0,0 @@
{
"compilerOptions": {
"tsBuildInfoFile": "./node_modules/.tmp/tsconfig.app.tsbuildinfo",
"target": "ES2020",
"useDefineForClassFields": true,
"lib": ["ES2020", "DOM", "DOM.Iterable"],
"module": "ESNext",
"skipLibCheck": true,
/* Bundler mode */
"moduleResolution": "bundler",
"allowImportingTsExtensions": true,
"isolatedModules": true,
"moduleDetection": "force",
"noEmit": true,
"jsx": "react-jsx",
/* Linting */
"strict": true,
"noUnusedLocals": true,
"noUnusedParameters": true,
"noFallthroughCasesInSwitch": true,
"noUncheckedSideEffectImports": true
},
"include": ["src"]
}

7
app/tsconfig.json
View File

@@ -1,7 +0,0 @@
{
"files": [],
"references": [
{ "path": "./tsconfig.app.json" },
{ "path": "./tsconfig.node.json" }
]
}

24
app/tsconfig.node.json
View File

@@ -1,24 +0,0 @@
{
"compilerOptions": {
"tsBuildInfoFile": "./node_modules/.tmp/tsconfig.node.tsbuildinfo",
"target": "ES2022",
"lib": ["ES2023"],
"module": "ESNext",
"skipLibCheck": true,
/* Bundler mode */
"moduleResolution": "bundler",
"allowImportingTsExtensions": true,
"isolatedModules": true,
"moduleDetection": "force",
"noEmit": true,
/* Linting */
"strict": true,
"noUnusedLocals": true,
"noUnusedParameters": true,
"noFallthroughCasesInSwitch": true,
"noUncheckedSideEffectImports": true
},
"include": ["vite.config.ts"]
}

7
app/vite.config.ts
View File

@@ -1,7 +0,0 @@
import { defineConfig } from 'vite'
import react from '@vitejs/plugin-react-swc'
// https://vite.dev/config/
export default defineConfig({
plugins: [react()],
})

0
packages/platform-react/.gitignore → packages/base/.gitignore vendored
View File

7
packages/platform-react/package.json → packages/base/package.json
View File

@@ -1,5 +1,5 @@
{ {
"name": "@plainidx/react", "name": "@plainidx/base",
"version": "1.0.0", "version": "1.0.0",
"type": "module", "type": "module",
"main": "dist/exports.js", "main": "dist/exports.js",
@@ -11,11 +11,10 @@
}, },
"devDependencies": { "devDependencies": {
"@plainidx/configs": "workspace:*", "@plainidx/configs": "workspace:*",
"@types/node": "^22.10.1",
"@types/react": "^19.0.1",
"typescript": "^5.7.2" "typescript": "^5.7.2"
}, },
"dependencies": { "dependencies": {
"@plainidx/plainidx": "workspace:*" "nanoid": "^5.0.9",
"zod": "^3.24.0"
} }
} }

8
packages/base/src/exports.ts Normal file
View File

@@ -0,0 +1,8 @@
export { z } from 'zod';
export {
type Manifest,
type ManifestBackendAction,
type ManifestBackendActions,
type ManifestBackend,
type ManifestFrontend,
} from './manifest/manifest.js';

36
packages/base/src/manifest/manifest.ts Normal file
View File

@@ -0,0 +1,36 @@
import { ZodSchema } from 'zod';
type ManifestBackendAction = {
input: ZodSchema;
output: ZodSchema;
};
type ManifestBackendActions = Record<string, ManifestBackendAction>;
type ManifestBackend = {
main: string;
actions: ManifestBackendActions;
};
type ManifestFrontend = {
main: string;
};
type Manifest = {
id: string;
name: string;
version: string;
description?: string;
icon?: string;
config: ZodSchema;
frontend?: ManifestFrontend;
backend?: ManifestBackend;
};
export {
type Manifest,
type ManifestBackendAction,
type ManifestBackendActions,
type ManifestBackend,
type ManifestFrontend,
};

3
packages/platform-react/tsconfig.json → packages/base/tsconfig.json
View File

@@ -1,8 +1,7 @@
{ {
"extends": "@plainidx/configs/tsconfig.json", "extends": "@plainidx/configs/tsconfig.json",
"compilerOptions": { "compilerOptions": {
"outDir": "dist", "outDir": "dist"
"jsx": "react"
}, },
"include": [ "include": [
"src" "src"

2
packages/client/.gitignore vendored Normal file
View File

@@ -0,0 +1,2 @@
/node_modules/
/dist/

20
packages/client/package.json Normal file
View File

@@ -0,0 +1,20 @@
{
"name": "@plainidx/client",
"version": "1.0.0",
"type": "module",
"main": "dist/exports.js",
"files": [
"dist"
],
"scripts": {
"build": "tsc --build"
},
"devDependencies": {
"@plainidx/configs": "workspace:*",
"typescript": "^5.7.2"
},
"dependencies": {
"@plainidx/base": "workspace:*",
"nanoid": "^5.0.9"
}
}

20
packages/client/src/client/client.ts Normal file
View File

@@ -0,0 +1,20 @@
import { Manifest } from '@plainidx/base';
import { Plugin } from '../plugin/plugin.js';
type ClientOptions = {
transport: unknown;
};
class Client {
#options: ClientOptions;
constructor(options: ClientOptions) {
this.#options = options;
}
public getPlugin = <TManifest extends Manifest>(manifest: TManifest) => {
return undefined as unknown as Plugin<TManifest>;
};
}
export { Client };

0
packages/platform-react/src/exports.ts → packages/client/src/exports.ts
View File

14
packages/client/src/plugin/plugin.ts Normal file
View File

@@ -0,0 +1,14 @@
import { Manifest, ManifestBackend, z } from '@plainidx/base';
type Plugin<TManifest extends Manifest> = {
manifest: TManifest;
actions: TManifest['backend'] extends ManifestBackend
? {
[TKey in keyof TManifest['backend']['actions']]: (
input: z.infer<TManifest['backend']['actions'][TKey]['input']>,
) => Promise<z.infer<TManifest['backend']['actions'][TKey]['output']>>;
}
: Record<string, never>;
};
export { Plugin };

9
packages/client/tsconfig.json Normal file
View File

@@ -0,0 +1,9 @@
{
"extends": "@plainidx/configs/tsconfig.json",
"compilerOptions": {
"outDir": "dist"
},
"include": [
"src"
]
}

1
packages/plainidx/package.json
View File

@@ -11,6 +11,7 @@
}, },
"devDependencies": { "devDependencies": {
"@plainidx/configs": "workspace:*", "@plainidx/configs": "workspace:*",
"@plainidx/base": "workspace:*",
"@types/node": "^22.10.1", "@types/node": "^22.10.1",
"@types/react": "^19.0.1", "@types/react": "^19.0.1",
"typescript": "^5.7.2" "typescript": "^5.7.2"

39
packages/plainidx/src/editor/editor.panels.ts
View File

@@ -1,39 +0,0 @@
import { EventEmitter } from '../utils/eventemitter.js';
type EditorPanel = {
name: string;
icon: string;
component: React.ComponentType;
};
type EditorPanelsEvents = {
change: () => void;
};
class EditorPanels extends EventEmitter<EditorPanelsEvents> {
#panels: Map<string, EditorPanel>;
constructor() {
super();
this.#panels = new Map();
}
public get panels() {
return this.#panels;
}
public add(id: string, panel: EditorPanel) {
this.#panels.set(id, panel);
this.emit('change');
return () => {
this.#panels.delete(id);
this.emit('change');
};
}
public get(id: string) {
return this.#panels.get(id);
}
}
export { EditorPanels };

32
packages/plainidx/src/editor/editor.renders.ts
View File

@@ -1,32 +0,0 @@
import { Document } from '../documents/documents.document.js';
import { EventEmitter } from '../utils/eventemitter.js';
type EditorRender = {
supports: (document: Document) => boolean;
name: string;
component: React.ComponentType;
};
type EditorRendersEvents = {
change: () => void;
};
class EditorRenders extends EventEmitter<EditorRendersEvents> {
#renders: EditorRender[] = [];
public add = (render: EditorRender) => {
this.#renders.push(render);
this.emit('change');
return () => {
this.#renders = this.#renders.filter((r) => r !== render);
this.emit('change');
};
};
public getByDocument = (document: Document) => {
return this.#renders.filter((r) => r.supports(document));
};
}
export { EditorRenders };

33
packages/plainidx/src/editor/editor.ts
View File

@@ -1,33 +0,0 @@
import { EventEmitter } from '../utils/eventemitter.js';
import { EditorPanels } from './editor.panels.js';
import { EditorRenders } from './editor.renders.js';
import { EditorWorkspace } from './editor.workspace.js';
type EditorEvents = Record<string, never>;
class Editor extends EventEmitter<EditorEvents> {
#workspace: EditorWorkspace;
#renders: EditorRenders;
#panels: EditorPanels;
constructor() {
super();
this.#workspace = new EditorWorkspace();
this.#renders = new EditorRenders();
this.#panels = new EditorPanels();
}
public get workspace() {
return this.#workspace;
}
public get renders() {
return this.#renders;
}
public get panels() {
return this.#panels;
}
}
export { Editor };

26
packages/plainidx/src/editor/editor.workspace.ts
View File

@@ -1,26 +0,0 @@
import { Document } from '../documents/documents.document.js';
import { EventEmitter } from '../utils/eventemitter.js';
type WorkspaceEvents = {
change: () => void;
};
class EditorWorkspace extends EventEmitter<WorkspaceEvents> {
#documents: Set<Document> = new Set<Document>();
public get documents() {
return [...this.#documents];
}
public openDocument(document: Document) {
this.#documents.add(document);
this.emit('change');
}
public closeDocument(document: Document) {
this.#documents.delete(document);
this.emit('change');
}
}
export { EditorWorkspace };

12
packages/plainidx/src/exports.ts
View File

@@ -2,11 +2,15 @@ export { PlainDB } from './plainidx/plainidx.js';
export { FileSystem } from './filesystem/filesystem.js'; export { FileSystem } from './filesystem/filesystem.js';
export { Documents } from './documents/documents.js'; export { Documents } from './documents/documents.js';
export { Document } from './documents/documents.document.js'; export { Document } from './documents/documents.document.js';
export { createActionApiRoute } from './plugins/plugin/plugin.api.js';
export { Plugins } from './plugins/plugins.js'; export { Plugins } from './plugins/plugins.js';
export { Plugin } from './plugins/plugin/plugin.js'; export { createPlugin } from './plugins/plugin/plugin.js';
export { Databases, DatabaseMigration } from './databases/databases.js'; export { Databases, DatabaseMigration } from './databases/databases.js';
export {
type Manifest,
type ManifestBackendAction,
type ManifestBackendActions,
type ManifestBackend,
type ManifestFrontend,
} from '@plainidx/base';
export * from 'zod'; export * from 'zod';
export { type Knex as Database } from 'knex'; export { type Knex as Database } from 'knex';
export { Editor } from './editor/editor.js';
export { EditorWorkspace } from './editor/editor.workspace.js';

18
packages/plainidx/src/plugins/plugin/plugin.api.ts
View File

@@ -1,18 +0,0 @@
import { z, ZodSchema } from 'zod';
type PluginActionApi = Record<
string,
{
input?: ZodSchema;
output?: ZodSchema;
handle?: (input: any) => Promise<any>;
}
>;
const createActionApiRoute = <TInput extends ZodSchema = ZodSchema, TOutput extends ZodSchema = ZodSchema>(options: {
input?: TInput;
output?: TOutput;
handle?: (input: z.infer<TInput>) => Promise<z.infer<TOutput>>;
}) => options satisfies PluginActionApi[string];
export { type PluginActionApi, createActionApiRoute };

146
packages/plainidx/src/plugins/plugin/plugin.ts
View File

@@ -1,110 +1,50 @@
import { z } from 'zod';
import { Document, Documents } from '../../documents/documents.js'; import { Document, Documents } from '../../documents/documents.js';
import { DatabaseMigration, Databases } from '../../databases/databases.js'; import { DatabaseMigration } from '../../databases/databases.js';
import { EventEmitter } from '../../utils/eventemitter.js'; import { Knex } from 'knex';
import { Plugins } from '../plugins.js'; import { Manifest, ManifestBackend } from '@plainidx/base';
import { z, ZodSchema } from 'zod';
import { PluginActionApi } from './plugin.api.js';
import { Editor } from '../../editor/editor.js';
type PluginOptions<TLocalConfig extends ZodSchema = ZodSchema, TSharedConfig extends ZodSchema = ZodSchema> = { type Plugin<TManifest extends Manifest> = TManifest['backend'] extends ManifestBackend
plugins: Plugins; ? {
backend: true;
manifest: TManifest;
actions: {
[TKey in keyof TManifest['backend']['actions']]: (
input: z.infer<TManifest['backend']['actions'][TKey]['input']>,
) => Promise<z.infer<TManifest['backend']['actions'][TKey]['output']>>;
};
process?: (document: Document) => Promise<void>;
load?: () => Promise<void>;
unload?: () => Promise<void>;
}
: {
backend: false;
manifest: TManifest;
};
type PluginFactoryOptions<TManifest extends Manifest> = {
config: z.infer<TManifest['config']>;
documents: Documents; documents: Documents;
databases: Databases; getPlugin: <TManifest extends Manifest>(manifest: TManifest) => Promise<Plugin<TManifest>>;
configs: { getDb: (name: string, migrations: DatabaseMigration[]) => Promise<Knex>;
local?: TLocalConfig;
shared?: TSharedConfig;
};
}; };
type PluginEvents = { type BackendPluginFactory<TManifest extends Manifest> = ((
configChange: (config: unknown) => void; options: PluginFactoryOptions<TManifest>,
}; ) => Plugin<TManifest>) & { manifest: TManifest };
abstract class Plugin< const createPlugin = <TManifest extends Manifest>(
TLocalConfig extends ZodSchema = ZodSchema, manifest: TManifest,
TSharedConfig extends ZodSchema = ZodSchema, implementation: (options: PluginFactoryOptions<TManifest>) => Omit<Plugin<TManifest>, 'manifest' | 'backend'>,
TActions extends PluginActionApi = PluginActionApi, ): BackendPluginFactory<TManifest> =>
> extends EventEmitter<PluginEvents> { Object.assign(
#options: PluginOptions<TLocalConfig, TSharedConfig>; (options: PluginFactoryOptions<TManifest>): Plugin<TManifest> =>
({
...implementation(options),
manifest,
backend: !!manifest.backend,
}) as Plugin<TManifest>,
{ manifest },
);
constructor(options: PluginOptions<TLocalConfig, TSharedConfig>) { export { type Plugin, type BackendPluginFactory as PluginFactory, createPlugin };
super();
this.#options = options;
}
public get documents(): Documents {
return this.#options.documents;
}
public readonly configSchemas?: {
local?: TLocalConfig;
shared?: TSharedConfig;
};
public getDB = async (name: string, migrations: DatabaseMigration[]) => {
const { databases } = this.#options;
const scopedName = `plugins:${this.name}:${name}`;
return databases.get({ name: scopedName, migrations });
};
public get configs(): {
local?: z.infer<TLocalConfig>;
shared?: z.infer<TSharedConfig>;
} {
return this.#options.configs;
}
public setConfigs = async (configs: { local?: z.infer<TLocalConfig>; shared?: z.infer<TSharedConfig> }) => {
this.#options.configs = configs;
await this.emit('configChange', configs);
};
public abstract readonly name: string;
public actions?: TActions;
public onLoad?: () => Promise<void>;
public onUnload?: () => Promise<void>;
public onLoaded?: () => Promise<void>;
public process?: (document: Document) => Promise<void>;
public setupUI?: (editor: Editor) => Promise<void>;
/*public getPlugin = async <T extends Plugin>(plugin: new (...args: any) => T): Promise<
T['api'] extends (...args: any[]) => infer R ? R : never
> => {
const { plugins } = this.#options;
const instance = await plugins.get(plugin);
return instance.api?.() as any;
}*/
public action = async <TPlugin extends Plugin<any, any, any>, TAction extends keyof TPlugin['actions']>(
plugin: new (...args: any[]) => TPlugin,
action: TAction,
input: Exclude<Exclude<TPlugin['actions'], undefined>[TAction]['input'], undefined> extends ZodSchema
? z.infer<Exclude<Exclude<TPlugin['actions'], undefined>[TAction]['input'], undefined>>
: undefined,
): Promise<
Exclude<Exclude<TPlugin['actions'], undefined>[TAction]['output'], undefined> extends ZodSchema
? z.infer<Exclude<Exclude<TPlugin['actions'], undefined>[TAction]['output'], undefined>>
: undefined
> => {
const { plugins } = this.#options;
const instance = await plugins.get(plugin);
const { actions } = instance;
if (!actions) {
throw new Error(`Plugin ${plugin.name} does not have actions`);
}
const actionDef = actions[action];
if (!actionDef) {
throw new Error(`Plugin ${plugin.name} does not have action ${String(action)}`);
}
actionDef.input?.parse(input);
return (await actionDef.handle?.(input)) as any;
};
}
type PluginConstructor<
TLocalConfig extends ZodSchema = ZodSchema,
TSharedConfig extends ZodSchema = ZodSchema,
T extends Plugin = Plugin,
> = new (options: PluginOptions<TLocalConfig, TSharedConfig>) => T;
export { Plugin, type PluginOptions, type PluginConstructor };

108
packages/plainidx/src/plugins/plugins.ts
View File

@@ -1,9 +1,8 @@
import { Document } from '../documents/documents.document.js'; import { Document } from '../documents/documents.document.js';
import { Documents } from '../documents/documents.js'; import { Documents } from '../documents/documents.js';
import { Databases } from '../databases/databases.js'; import { Databases } from '../databases/databases.js';
import { Plugin, PluginConstructor } from './plugin/plugin.js'; import { Plugin, PluginFactory } from './plugin/plugin.js';
import { z, ZodSchema } from 'zod'; import { Manifest } from '@plainidx/base';
import { Editor } from '../editor/editor.js';
type PluginsOptions = { type PluginsOptions = {
documents: Documents; documents: Documents;
@@ -12,7 +11,7 @@ type PluginsOptions = {
class Plugins { class Plugins {
#options: PluginsOptions; #options: PluginsOptions;
#plugins: Map<PluginConstructor, Plugin>; #plugins: Map<string, Plugin<any>>;
constructor(options: PluginsOptions) { constructor(options: PluginsOptions) {
this.#options = options; this.#options = options;
@@ -22,35 +21,20 @@ class Plugins {
#onSave = async (document: Document) => { #onSave = async (document: Document) => {
for (const plugin of this.#plugins.values()) { for (const plugin of this.#plugins.values()) {
await plugin.process?.(document); if (plugin.backend) {
await plugin?.process?.(document);
}
} }
}; };
#load = async (plugins: Plugin[]) => { public get = async <TManifest extends Manifest>(manifest: TManifest): Promise<Plugin<TManifest>> => {
await Promise.all(plugins.map((plugin) => plugin.onLoad?.())); if (!this.#plugins.has(manifest.id)) {
plugins.forEach((plugin) => plugin.onLoaded?.()); throw new Error(`Plugin ${manifest.id} is not loaded`);
};
#saveConfig = async (plugin: Plugin) => {
const document = await this.#options.documents.get(`.db/plugins/${plugin.name}/config.json`);
document.data = Buffer.from(JSON.stringify(plugin.configs));
await document.save();
};
public setupUI = (editor: Editor) => {
for (const plugin of this.#plugins.values()) {
plugin.setupUI?.(editor);
} }
return this.#plugins.get(manifest.id) as Plugin<TManifest>;
}; };
public get = async <T extends Plugin>(plugin: PluginConstructor<any, any, T>): Promise<T> => { public add = async (plugins: PluginFactory<any>[]) => {
if (!this.#plugins.has(plugin)) {
await this.add([plugin]);
}
return this.#plugins.get(plugin) as T;
};
public add = async (plugins: PluginConstructor[]) => {
const { documents, databases } = this.#options; const { documents, databases } = this.#options;
const configs = await Promise.all( const configs = await Promise.all(
plugins.map(async (plugin) => { plugins.map(async (plugin) => {
@@ -58,58 +42,52 @@ class Plugins {
return JSON.parse(document.data.toString() || '{}'); return JSON.parse(document.data.toString() || '{}');
}), }),
); );
const instances = plugins.map( const instances = await Promise.all(
(Plugin, i) => plugins.map(async (plugin, i) => {
new Plugin({ const instance = plugin({
plugins: this, config: configs[i],
documents, documents,
databases, getPlugin: this.get,
configs: configs[i], getDb: async (name, migrations) => {
return databases.get({
name: `plugins/${plugin.manifest.id}/${name}`,
migrations,
});
},
});
return instance as Plugin<any>;
}), }),
); );
await this.#load(instances); for (const instance of instances) {
for (let i = 0; i < plugins.length; i++) { this.#plugins.set(instance.manifest.id, instance);
const instance = instances[i];
const plugin = plugins[i];
instance.on('configChange', this.#saveConfig.bind(null, instance));
this.#plugins.set(plugin, instance);
} }
await Promise.all(
instances.map(async (instance) => {
if ('load' in instance) {
await instance.load?.();
}
}),
);
}; };
public process = async (document: Document) => { public process = async (document: Document) => {
for (const plugin of this.#plugins.values()) { for (const plugin of this.#plugins.values()) {
await plugin.process?.(document); if (plugin.backend) {
await plugin?.process?.(document);
}
} }
}; };
public unload = async () => { public unload = async () => {
await Promise.all(this.#plugins.values().map((plugin) => plugin.onUnload?.())); await Promise.all(
this.#plugins.values().map((plugin) => {
if (plugin.backend) {
return plugin.unload?.();
}
}),
);
this.#plugins = new Map(); this.#plugins = new Map();
}; };
public action = async <TPlugin extends Plugin<any, any, any>, TAction extends keyof TPlugin['actions']>(
plugin: new (...args: any[]) => TPlugin,
action: TAction,
input: Exclude<Exclude<TPlugin['actions'], undefined>[TAction]['input'], undefined> extends ZodSchema
? z.infer<Exclude<Exclude<TPlugin['actions'], undefined>[TAction]['input'], undefined>>
: undefined,
): Promise<
Exclude<Exclude<TPlugin['actions'], undefined>[TAction]['output'], undefined> extends ZodSchema
? z.infer<Exclude<Exclude<TPlugin['actions'], undefined>[TAction]['output'], undefined>>
: undefined
> => {
const instance = await this.get(plugin);
const { actions } = instance;
if (!actions) {
throw new Error(`Plugin ${plugin.name} does not have actions`);
}
const actionDef = actions[action];
if (!actionDef) {
throw new Error(`Plugin ${plugin.name} does not have action ${String(action)}`);
}
actionDef.input?.parse(input);
return actionDef.handle?.(input) as any;
};
} }
export { Plugins }; export { Plugins };

10
packages/platform-react/src/document/document.context.ts
View File

@@ -1,10 +0,0 @@
import { Document } from '@plainidx/plainidx';
import React from 'react';
type DocumentContextType = {
document: Document;
};
const DocumentContext = React.createContext<DocumentContextType | undefined>(undefined);
export { DocumentContext };

57
packages/platform-react/src/document/document.hooks.ts
View File

@@ -1,57 +0,0 @@
import { useCallback, useContext, useEffect, useState } from 'react';
import { DocumentContext } from './document.context.js';
import { usePlainDB } from '../plaindb/plaindb.hooks.js';
const useDocument = () => {
const context = useContext(DocumentContext);
if (!context) {
throw new Error('useDocument must be used within a DocumentProvider');
}
return context.document;
};
const useDocumentRenders = () => {
const { editor } = usePlainDB();
const document = useDocument();
const [current, setCurrent] = useState(editor.renders.getByDocument(document));
useEffect(() => {
const listen = () => {
setCurrent(editor.renders.getByDocument(document));
};
editor.renders.on('change', listen);
return () => {
editor.renders.off('change', listen);
};
}, [editor.renders, document, setCurrent]);
return current;
};
const useDocumentValue = () => {
const document = useDocument();
const [current, setCurrent] = useState(document.data);
const setValue = useCallback(
(newValue: Buffer) => {
document.data = newValue;
},
[document],
);
useEffect(() => {
const listen = () => {
setCurrent(document.data);
};
document.on('change', listen);
return () => {
document.off('change', listen);
};
}, [document, setCurrent]);
return [current, setValue] as const;
};
export { useDocument, useDocumentValue, useDocumentRenders };

14
packages/platform-react/src/document/document.provider.tsx
View File

@@ -1,14 +0,0 @@
import React from 'react';
import { Document } from '@plainidx/plainidx';
import { DocumentContext } from './document.context.js';
type DocumentProviderProps = {
document: Document;
children: React.ReactNode;
};
const DocumentProvider = ({ document, children }: DocumentProviderProps) => {
return <DocumentContext.Provider value={{ document }}>{children}</DocumentContext.Provider>;
};
export { DocumentProvider };

21
packages/platform-react/src/panels/panels.hooks.ts
View File

@@ -1,21 +0,0 @@
import { useEffect, useState } from 'react';
import { usePlainDB } from '../plaindb/plaindb.hooks.js';
const usePanel = (id: string) => {
const { editor } = usePlainDB();
const [panel, setPanel] = useState(editor.panels.get(id));
useEffect(() => {
const update = () => {
setPanel(editor.panels.get(id));
};
editor.panels.on('change', update);
return () => {
editor.panels.off('change', update);
};
}, [editor, id]);
return panel;
};
export { usePanel };

19
packages/platform-react/src/panels/panels.panel.tsx
View File

@@ -1,19 +0,0 @@
import React from 'react';
import { usePanel } from './panels.hooks.js';
type PanelProps = {
id: string;
};
const Panel = ({ id }: PanelProps) => {
const panel = usePanel(id);
if (!panel) {
return null;
}
const Component = panel.component;
return <Component />;
};
export { Panel };

11
packages/platform-react/src/plaindb/plaindb.context.ts
View File

@@ -1,11 +0,0 @@
import { Editor, PlainDB } from '@plainidx/plainidx';
import React from 'react';
type PlainDBContextType = {
db: PlainDB;
editor: Editor;
};
const PlainDBContext = React.createContext<PlainDBContextType | undefined>(undefined);
export { PlainDBContext };

12
packages/platform-react/src/plaindb/plaindb.hooks.ts
View File

@@ -1,12 +0,0 @@
import { useContext } from 'react';
import { PlainDBContext } from './plaindb.context.js';
const usePlainDB = () => {
const context = useContext(PlainDBContext);
if (context === undefined) {
throw new Error('usePlainDB must be used within a PlainDBProvider');
}
return context;
};
export { usePlainDB };

19
packages/platform-react/src/plaindb/plaindb.provider.tsx
View File

@@ -1,19 +0,0 @@
import React, { useMemo } from 'react';
import { Editor, PlainDB } from '@plainidx/plainidx';
import { PlainDBContext } from './plaindb.context.js';
type PlainDBProviderProps = {
children: React.ReactNode;
db: PlainDB;
};
const PlainDBProvider = ({ children, db }: PlainDBProviderProps) => {
const editor = useMemo(() => {
const next = new Editor();
db.plugins.setupUI(editor);
return next;
}, [db]);
return <PlainDBContext.Provider value={{ db, editor }}>{children}</PlainDBContext.Provider>;
};
export { PlainDBProvider };

35
packages/platform-react/src/workspace/workspace.hooks.ts
View File

@@ -1,35 +0,0 @@
import { useCallback, useEffect, useState } from 'react';
import { usePlainDB } from '../plaindb/plaindb.hooks.js';
const useOpenDocument = () => {
const { editor, db } = usePlainDB();
const open = useCallback(
async (location: string) => {
const document = await db.documents.get(location);
editor.workspace.openDocument(document);
},
[editor, db],
);
return open;
};
const useDocuments = () => {
const { editor } = usePlainDB();
const [documents, setDocuments] = useState(editor.workspace.documents);
useEffect(() => {
const update = () => {
setDocuments(editor.workspace.documents);
};
editor.workspace.on('change', update);
return () => {
editor.workspace.off('change', update);
};
});
return documents;
};
export { useOpenDocument, useDocuments };

11
packages/plugin-core/package.json
View File

@@ -6,6 +6,17 @@
"files": [ "files": [
"dist" "dist"
], ],
"exports": {
".": {
"import": "./dist/exports.js"
},
"./manifest": {
"import": "./dist/manifest.js"
},
"./plugin": {
"import": "./dist/plugin.js"
}
},
"scripts": { "scripts": {
"build": "tsc --build" "build": "tsc --build"
}, },

89
packages/plugin-core/src/core.ts
View File

@@ -1,89 +0,0 @@
import { createActionApiRoute, type Database, Plugin, z } from '@plainidx/plainidx';
import { migrations } from './migrations/migrations.js';
class CorePlugin extends Plugin {
#db?: Promise<Database>;
public readonly name = '@builtin/core';
public actions = {
setTags: createActionApiRoute({
input: z.object({
document: z.string(),
tags: z.array(z.string()),
}),
output: z.undefined(),
handle: async ({ document, tags }) => {
await this.setTags(document, tags);
return undefined;
},
}),
getTags: createActionApiRoute({
output: z.array(
z.object({
name: z.string(),
count: z.number(),
}),
),
handle: async () => {
return this.getTags();
},
}),
setTitle: createActionApiRoute({
input: z.object({
document: z.string(),
title: z.string(),
}),
output: z.undefined(),
handle: async ({ document, title }) => {
await this.setTitle(document, title);
return undefined;
},
}),
getTitles: createActionApiRoute({
output: z.array(
z.object({
document: z.string(),
title: z.string(),
}),
),
handle: async () => {
return this.getTitles();
},
}),
};
#getDatabase = async () => {
if (!this.#db) {
this.#db = this.getDB('data', migrations);
}
return this.#db;
};
public getTags = async () => {
const db = await this.#getDatabase();
return db('tags')
.select([db.raw('tag as name'), db.raw('count(document) as count')])
.groupBy('tag');
};
public setTags = async (document: string, tags: string[]) => {
const db = await this.#getDatabase();
await db('tags').where({ document }).delete();
if (tags.length) {
await db('tags').insert(tags.map((tag) => ({ tag, document })));
}
};
public setTitle = async (document: string, title: string) => {
const db = await this.#getDatabase();
await db('titles').where({ document }).insert({ document, title }).onConflict('document').merge();
};
public getTitles = async () => {
const db = await this.#getDatabase();
return await db('titles').select('*');
};
}
export { CorePlugin };

3
packages/plugin-core/src/exports.ts
View File

@@ -1 +1,2 @@
export { CorePlugin } from './core.js'; export { core } from './plugin.js';
export { CorePlugin } from './manifest.js';

31
packages/plugin-core/src/manifest.ts Normal file
View File

@@ -0,0 +1,31 @@
import { Manifest, z } from '@plainidx/plainidx';
const CorePlugin = {
id: 'buildin-core',
name: 'Core Plugin',
version: '0.0.1',
config: z.any(),
backend: {
main: './dist/plugin.js',
actions: {
getTitles: {
input: z.object({}),
output: z.array(z.object({ location: z.string(), title: z.string() })),
},
getTags: {
input: z.object({}),
output: z.array(z.string()),
},
setData: {
input: z.object({
location: z.string(),
title: z.string(),
tags: z.array(z.string()),
}),
output: z.any(),
},
},
},
} satisfies Manifest;
export { CorePlugin };

12
packages/plugin-core/src/migrations/migrations.ts
View File

@@ -5,15 +5,15 @@ const migrations: DatabaseMigration[] = [
name: 'init', name: 'init',
up: async (db) => { up: async (db) => {
await db.schema.createTable('tags', (table) => { await db.schema.createTable('tags', (table) => {
table.string('tag').notNullable(); table.string('name').notNullable();
table.string('document').notNullable(); table.string('location').notNullable();
table.primary(['tag', 'document']); table.primary(['name', 'location']);
table.index('document'); table.index('location');
table.index('tag'); table.index('name');
}); });
await db.schema.createTable('titles', (table) => { await db.schema.createTable('titles', (table) => {
table.string('document').primary().notNullable(); table.string('location').primary().notNullable();
table.string('title').notNullable(); table.string('title').notNullable();
}); });
}, },

39
packages/plugin-core/src/plugin.ts Normal file
View File

@@ -0,0 +1,39 @@
import { createPlugin } from '@plainidx/plainidx';
import { CorePlugin } from './manifest.js';
import { migrations } from './migrations/migrations.js';
const core = createPlugin(CorePlugin, ({ getDb }) => {
const dbPromise = getDb('data', migrations);
return {
backend: true,
actions: {
getTitles: async () => {
const db = await dbPromise;
const results = await db('titles').select(['location', 'title']);
return results;
},
getTags: async () => {
const db = await dbPromise;
const results = await db('tags')
.select(['name', db.raw('count(*) as count')])
.groupBy('name');
return results;
},
setData: async ({ location, title, tags }) => {
const db = await dbPromise;
const currentTitle = await db('titles').select('title').where({ location }).first();
await db.transaction(async (trx) => {
await trx('tags').delete().where({ location });
await trx('tags').insert(tags.map((tag) => ({ name: tag, location })));
if (currentTitle) {
await trx('titles').update({ title }).where({ location });
} else {
await trx('titles').insert({ location, title });
}
});
},
},
};
});
export { core };

3
packages/plugin-markdown/src/exports.ts
View File

@@ -1 +1,2 @@
export { MarkdownPlugin } from './markdown.js'; export { markdownPlugin } from './markdown.js';
export { MarkdownPlugin } from './manifest.js';

14
packages/plugin-markdown/src/manifest.ts Normal file
View File

@@ -0,0 +1,14 @@
import { Manifest, z } from '@plainidx/plainidx';
const MarkdownPlugin = {
id: 'markdown',
name: 'Markdown Plugin',
version: '0.0.1',
config: z.any(),
backend: {
main: './dist/plugin.js',
actions: {},
},
} satisfies Manifest;
export { MarkdownPlugin };

52
packages/plugin-markdown/src/markdown.ts
View File

@@ -1,34 +1,24 @@
import { createActionApiRoute, Document, Plugin, z } from '@plainidx/plainidx';
import { MarkdownAst } from './utils/markdown-ast.js';
import { CorePlugin } from '@plainidx/plugin-core'; import { CorePlugin } from '@plainidx/plugin-core';
import { MarkdownPlugin } from './manifest.js';
import { MarkdownAst } from './utils/markdown-ast.js';
import { createPlugin } from '@plainidx/plainidx';
type MarkdownSubPlugin = { type MarkdownSubPlugin = {
process: (ast: MarkdownAst) => Promise<void>; process: (ast: MarkdownAst) => Promise<void>;
}; };
class MarkdownPlugin extends Plugin { const markdownPlugin = createPlugin(MarkdownPlugin, ({ getPlugin }) => {
#subPlugins = new Set<MarkdownSubPlugin>(); const plugins: MarkdownSubPlugin[] = [];
return {
public readonly name = '@builtin/markdown'; actions: {},
process: async (document) => {
public actions = { const core = await getPlugin(CorePlugin);
register: createActionApiRoute({
input: z.object({
plugin: z.custom<MarkdownSubPlugin>(),
}),
handle: async ({ plugin }) => {
this.#subPlugins.add(plugin);
},
}),
};
public process = async (document: Document) => {
if (!document.location.endsWith('.md')) { if (!document.location.endsWith('.md')) {
return; return;
} }
const ast = new MarkdownAst(document.data); const ast = new MarkdownAst(document.data);
for (const plugin of this.#subPlugins) { for (const plugin of plugins) {
await plugin.process(ast); await plugin.process(ast);
} }
@@ -49,11 +39,6 @@ class MarkdownPlugin extends Plugin {
} }
}); });
await this.action(CorePlugin, 'setTitle', {
title,
document: document.location,
});
ast.visit((node) => { ast.visit((node) => {
if (node.type === 'textDirective' && node.name === 'tag') { if (node.type === 'textDirective' && node.name === 'tag') {
const body = ast.nodeToString(node.children); const body = ast.nodeToString(node.children);
@@ -61,11 +46,14 @@ class MarkdownPlugin extends Plugin {
} }
}); });
document.replace(ast.toBuffer()); document.replace(ast.toBuffer());
await this.action(CorePlugin, 'setTags', {
tags,
document: document.location,
});
};
}
export { MarkdownPlugin }; await core.actions.setData({
location: document.location,
title,
tags,
});
},
};
});
export { markdownPlugin };

40
packages/tests/src/documents.test.ts
View File

@@ -1,8 +1,8 @@
import { describe, it } from 'vitest'; import { describe, it } from 'vitest';
import { CorePlugin } from '@plainidx/plugin-core'; import { core, CorePlugin } from '@plainidx/plugin-core';
import { MarkdownPlugin } from '@plainidx/plugin-markdown';
import { PlainDB } from '../../plainidx/dist/exports.js'; import { PlainDB } from '../../plainidx/dist/exports.js';
import { MemoryFileSystem } from '@plainidx/fs-memory'; import { MemoryFileSystem } from '@plainidx/fs-memory';
import { markdownPlugin } from '@plainidx/plugin-markdown';
describe('documents', () => { describe('documents', () => {
it('should be able to create a document', async () => { it('should be able to create a document', async () => {
@@ -19,34 +19,24 @@ describe('documents', () => {
}), }),
}); });
await plugins.add([MarkdownPlugin]); await plugins.add([core, markdownPlugin]);
const tags1 = await plugins.action(CorePlugin, 'getTags', undefined); const plugin = await plugins.get(CorePlugin);
console.log('Done', tags1); {
const tags = await plugin.actions.getTags({});
console.log(tags);
}
const demoDocument = await documents.get('hello/world.md'); const document = await documents.get('foo/bar.md');
demoDocument.data = Buffer.from(` document.data = Buffer.from(['# Hello World', '', ':tag[test]'].join('\n'));
# Hello World
:tag[hello] await document.save();
`); {
const tags = await plugin.actions.getTags({});
await demoDocument.save(); console.log(tags);
}
const tags2 = await plugins.action(CorePlugin, 'getTags', undefined);
console.log('Done', tags2);
demoDocument.data = Buffer.from(`
# Hello World
:tag[world]
`);
await demoDocument.save();
const tags3 = await plugins.action(CorePlugin, 'getTags', undefined);
console.log('Done', tags3);
await close(); await close();
}); });

668
pnpm-lock.yaml generated
View File

File diff suppressed because it is too large Load Diff

6
tsconfig.json
View File

@@ -1,6 +1,9 @@
{ {
"include": [], "include": [],
"references": [ "references": [
{
"path": "./packages/base"
},
{ {
"path": "./packages/plainidx" "path": "./packages/plainidx"
}, },
@@ -18,9 +21,6 @@
}, },
{ {
"path": "./packages/plugin-markdown" "path": "./packages/plugin-markdown"
},
{
"path": "./packages/platform-react"
} }
] ]
} }