feat(type-designer): migrate plugin to independant plugin packages

biome.json

@@ -7,7 +7,11 @@
 	},
 	"files": {
 		"ignoreUnknown": false,
-		"ignore": []
+		"ignore": [
+			"packages/core/src/scd-events-v1/edit.scd-events-v1.ts",
+			"packages/core/src/scd-events-v1/open.scd-events-v1.ts",
+			"packages/core/src/scd-xml/foundation.ts"
+		]
 	},
 	"formatter": {
 		"enabled": true,
@@ -49,7 +53,15 @@
 	},
 	"overrides": [
 		{
-			"include": ["*.svelte"]
+			"include": ["*.svelte"],
+			"linter": {
+				"rules": {
+					"style": {
+						"useConst": "off",
+						"useImportType": "off"
+					}
+				}
+			}
 		}
 	]
 }

package.json

@@ -1,30 +1,29 @@
 {
-	"name": "@oscd-plugins/network",
+	"name": "@oscd-plugins/monorepo",
 	"private": true,
 	"version": "0.0.0",
 	"type": "module",
 	"scripts": {
-		"dev": "vite --mode=DEV",
-		"build": "vite build",
-		"preview": "vite preview",
-		"check": "svelte-check --tsconfig ./tsconfig.json",
 		"//====== FORMAT & LINT ======//": "",
 		"biome:check": "biome check .",
 		"biome:fix": "biome check . --write",
 		"//====== PREPARE ======//": "",
-		"prepare": "husky install"
+		"prepare": "husky install",
+		"//====== LAUNCHING SCRIPTS ======//": "",
+		"storybook": "pnpm --filter @oscd-plugins/ui storybook",
+		"//====== LOCAL DEPENDENCIES INSTALL ======//": "",
+		"install:core": "pnpm --filter @oscd-plugins/core i",
+		"install:ui": "pnpm --filter @oscd-plugins/ui i",
+		"//====== PLUGIN INSTALL ======//": "",
+		"install:type-designer": "pnpm install:core && pnpm install:ui && pnpm --filter @oscd-plugins/type-designer i",
+		"//====== PLUGIN STAND ALONE MODE ======//": "",
+		"dev:type-designer": "pnpm install:type-designer && pnpm --filter @oscd-plugins/type-designer dev",
+		"//====== PLUGIN INTEGRATED MODE ======//": "",
+		"dev:integrated:type-designer": "pnpm install:type-designer && pnpm --filter @oscd-plugins/type-designer build:watch"
 	},
 	"devDependencies": {
 		"@biomejs/biome": "1.9.2",
-		"@sveltejs/vite-plugin-svelte": "^2.0.2",
-		"@tsconfig/svelte": "^3.0.0",
-		"husky": "^8.0.3",
-		"svelte": "^3.55.1",
-		"svelte-check": "^2.10.3",
-		"tslib": "^2.5.0",
-		"turbo": "^1.8.3",
-		"typescript": "^4.9.3",
-		"vite": "^4.1.0"
+		"husky": "^8.0.3"
 	},
 	"packageManager": "[email protected]+sha512.73a29afa36a0d092ece5271de5177ecbf8318d454ecd701343131b8ebc0c1a91c487da46ab77c8e596d6acf1461e3594ced4becedf8921b074fbd8653ed7051c"
 }

packages/core/package.json

@@ -33,6 +33,7 @@
 		"eslint-plugin-promise": "^6.0.0",
 		"happy-dom": "^8.9.0",
 		"safaridriver": "^0.0.4",
+		"svelte": "^4.2.19",
 		"typescript": "4.9.4",
 		"vitest": "^0.29.7",
 		"webdriverio": "^8.6.7"

packages/core/src/index.ts

@@ -10,3 +10,6 @@ export * from './constants/element.constant'
 
 // UTILS
 export type * from './utils'
+
+// PLUGIN
+export * from './scd-plugin'

packages/core/src/scd-events-v1/scd-edit-events.ts → packages/core/src/scd-events-v1/edit.scd-events-v1.ts

@@ -1,9 +1,10 @@
-//////////////////////////////////////////////////////////////////////////////////////////////////////////////
-// DO NOT MODIFY THIS FILE DIRECTLY !	MAKE A PR TO MODIFY THE CORE LIBRARY.																	//
-// AS FOR NOW THE OPENSCD EVENTS PACKAGE IS NOT PUBLISHED																										//
-// WE USE A COPY OF ITS CORE EDITOR FUNCTIONALITIES	- THIS IS THE V1 MARK AS DEPRECATED BUT STILL IN USE		//
-// SEE SOURCE  https://github.com/openscd/open-scd/blob/main/packages/core/foundation/deprecated/editor.ts	//
-//////////////////////////////////////////////////////////////////////////////////////////////////////////////
+//////////////////////////////////////////////////////////////////////////////////////////////////////////
+// DO NOT MODIFY THIS FILE DIRECTLY !	MAKE A PR TO MODIFY THE CORE LIBRARY.
+// AS FOR NOW THE OPENSCD EVENTS PACKAGE IS NOT PUBLISHED
+// WE USE A COPY OF ITS CORE EDITOR FUNCTIONALITIES	- THIS IS THE V1 MARK AS DEPRECATED BUT STILL IN USE
+// SEE SOURCE  https://github.com/openscd/open-scd/blob/main/packages/core/foundation/deprecated/editor.ts
+// THIS FILE IS IGNORED BY BIOME
+//////////////////////////////////////////////////////////////////////////////////////////////////////////
 
 export type Initiator = 'user' | 'system' | 'undo' | 'redo' | string
 

packages/core/src/scd-events-v1/index.ts

@@ -1 +1,2 @@
-export * from './scd-edit-events'
+export * from './edit.scd-events-v1'
+export * from './open.scd-events-v1'

packages/core/src/scd-events-v1/open.scd-events-v1.ts

@@ -0,0 +1,33 @@
+//////////////////////////////////////////////////////////////////////////////////////////////////////////////
+// DO NOT MODIFY THIS FILE DIRECTLY !	MAKE A PR TO MODIFY THE CORE LIBRARY.
+// AS FOR NOW THE OPENSCD EVENTS PACKAGE IS NOT PUBLISHED
+// WE USE A COPY OF ITS CORE EDITOR FUNCTIONALITIES	- THIS IS THE V1 MARK AS DEPRECATED BUT STILL IN USE
+// SEE SOURCE  https://github.com/openscd/open-scd/blob/main/packages/core/foundation/deprecated/open-event.js
+// THIS FILE IS IGNORED BY BIOME
+//////////////////////////////////////////////////////////////////////////////////////////////////////////////
+
+/** Represents a document to be opened. */
+export interface OpenDocDetail {
+	doc: XMLDocument
+	docName: string
+	docId?: string
+}
+export type OpenDocEvent = CustomEvent<OpenDocDetail>
+export function newOpenDocEvent(
+	doc: XMLDocument,
+	docName: string,
+	eventInitDict?: CustomEventInit<Partial<OpenDocDetail>>
+): OpenDocEvent {
+	return new CustomEvent<OpenDocDetail>('open-doc', {
+		bubbles: true,
+		composed: true,
+		...eventInitDict,
+		detail: { doc, docName, ...eventInitDict?.detail }
+	})
+}
+
+declare global {
+	interface ElementEventMap {
+		['open-doc']: OpenDocEvent
+	}
+}

packages/core/src/scd-plugin/editor-instance.scd-plugin.ts

@@ -0,0 +1,60 @@
+// TYPES
+import type { SvelteComponent, ComponentType } from 'svelte'
+import type { PluginConstructor } from './types.scd-plugin'
+
+export default function editorPluginInstance(
+	pluginComponent: ComponentType<SvelteComponent>
+) {
+	//====== INITIALIZATION ======//
+
+	// this emulate the class declaration we need for custom components
+	function EditorPlugin() {
+		return Reflect.construct(HTMLElement, [], new.target)
+	}
+	EditorPlugin.prototype = Object.create(HTMLElement.prototype)
+
+	//====== PROPERTIES ======//
+
+	EditorPlugin.prototype.pluginInstance = undefined
+	EditorPlugin.prototype.localDoc = undefined
+	EditorPlugin.prototype.localDocName = undefined
+
+	//====== METHODS ======//
+
+	Object.defineProperty(EditorPlugin.prototype, 'doc', {
+		get: function doc() {
+			return this.localDoc
+		},
+		set: function doc(newDoc: XMLDocument) {
+			this.localDoc = newDoc
+			if (!this.pluginInstance) return
+
+			this.pluginInstance.$set({ xmlDocument: newDoc })
+		}
+	})
+
+	Object.defineProperty(EditorPlugin.prototype, 'docName', {
+		get: function docName() {
+			return this.localDocName
+		},
+		set: function docName(newDocName: string) {
+			this.localDocName = newDocName
+		}
+	})
+
+	//====== LIFECYCLE METHODS ======//
+
+	EditorPlugin.prototype.connectedCallback = function () {
+		this.pluginInstance = new pluginComponent({
+			target: this.attachShadow({ mode: 'open' }),
+			props: {
+				xmlDocument: this.localDoc,
+				pluginHostElement: this
+			}
+		})
+	}
+
+	//====== RETURN PLUGIN INSTANCE ======//
+
+	return EditorPlugin as unknown as PluginConstructor
+}

packages/core/src/scd-plugin/index.ts

@@ -0,0 +1,3 @@
+export * from './wrapper.scd-plugin'
+// TYPES
+export type { PluginType } from './types.scd-plugin'