feat(MNHC-131): setup monorepo

.github/ISSUE_TEMPLATE/feature-request.yml

@@ -25,6 +25,6 @@ body:
       multiple: true
       description: What libraries should be affected by your feature proposal?
       options:
-        - console-microfronent-sdk
+        - console-console-sdk-microfrontend
     validations:
       required: true

.github/workflows/test.yml

@@ -30,7 +30,7 @@ jobs:
         version: 8
         run_install: false
     - name: Install Packages
-      run: pnpm i; rm -f .npmrc
+      run: pnpm i
       env:
         NODE_AUTH_TOKEN: ${{secrets.MIA_NPM_REGISTRY_TOKEN}}
     - run: pnpm build

README.md

@@ -20,11 +20,11 @@ See the specific monorepo readme to using this library
 
 ### Console SDK. 
 An abstract interface used within helper repositories. 
-[Read more](./packages/microfronent-sdk)                     
+[Read more](./packages/console-sdk-microfrontend)                     
 
 ### Vite helpers.
 Used to configure the microfrontend with vite. 
-[Read more](./packages/vite-helpers-console-microfrontend)    
+[Read more](./packages/console-sdk-vite-helpers)    
 
 ### Webpack helpers. 
 Used to configure the microfrontend with webpack. 
@@ -35,9 +35,9 @@ Used to configure the microfrontend with webpack.
 To use this repository 
 
 ```bash
-npm install @mia-platform-internal/microfronent-sdk
-npm install @mia-platform-internal/vite-helpers-console-microfrontend
-npm install @mia-platform-internal/webapack-helpers-console-microfrontend
+npm install @mia-platform-internal/console-sdk-microfrontend
+npm install @mia-platform-internal/console-sdk-vite-helpers
+npm install @mia-platform-internal/console-sdk-webapack-helpers
 ```
 
 ## Local Development
@@ -49,9 +49,9 @@ npm install && npm test
 ```
 
 
-[action-status-svg]: https://github.com/mia-platform/microfronent-sdk/actions/workflows/test.yml/badge.svg
-[github-action]: https://github.com/mia-platform/microfronent-sdk/actions/workflows/test.yml
+[action-status-svg]: https://github.com/mia-platform/console-sdk-microfrontend/actions/workflows/test.yml/badge.svg
+[github-action]: https://github.com/mia-platform/console-sdk-microfrontend/actions/workflows/test.yml
 [standard-mia-svg]: https://img.shields.io/badge/code_style-standard--mia-orange.svg
 [standard-mia]: https://github.com/mia-platform/eslint-config-mia
-[coverall-svg]: https://coveralls.io/repos/github/mia-platform/microfronent-sdk/badge.svg
-[coverall-io]: https://coveralls.io/github/mia-platform/microfronent-sdk
+[coverall-svg]: https://coveralls.io/repos/github/mia-platform/console-sdk-microfrontend/badge.svg
+[coverall-io]: https://coveralls.io/github/mia-platform/console-sdk-microfrontend

package.json

@@ -1,12 +1,12 @@
 {
-  "name": "console-monorepo",
+  "name": "console-sdk-monorepo",
   "license": "Apache-2.0",
   "version": "1.0.0",
   "private": true,
   "sideEffects": false,
   "workspaces": [
-    "packages/microfronent-sdk",
-    "packages/vite-helpers-console-microfrontend",
+    "packages/console-sdk-microfrontend",
+    "packages/console-sdk-vite-helpers",
     "packages/webpack-helpers-console-microfrontend"
   ],
   "devDependencies": {
@@ -23,8 +23,8 @@
   },
   "dependencies": {},
   "scripts": {
-    "sdk": "pnpm --filter @mia-platform/microfronent-sdk",
-    "vh": "pnpm --filter @mia-platform/vite-helpers-console-microfrontend",
+    "sdk": "pnpm --filter @mia-platform/console-sdk-microfrontend",
+    "vh": "pnpm --filter @mia-platform/console-sdk-vite-helpers",
     "wh": "pnpm --filter @mia-platform/webpack-helpers-console-microfrontend",
 
     "postinstall": "pnpm sdk build",

packages/console-sdk-microfrontend/CHANGELOG.md

@@ -0,0 +1,3 @@
+# @mia-platform/console-sdk-microfrontend
+
+## Unreleased

packages/console-sdk-microfrontend/README.md

@@ -0,0 +1,2 @@
+# Microfrontend SDK
+

packages/microfrontend-sdk/package.json → packages/console-sdk-microfrontend/package.json

@@ -1,9 +1,9 @@
 {
-  "name": "@mia-platform/microfronent-sdk",
+  "name": "@mia-platform/console-sdk-microfrontend",
   "license": "Apache-2.0",
   "version": "0.0.0",
   "private": true,
-  "main": "./build/src/index.js",
+  "main": "./src/index.ts",
   "module": "./src/index.ts",
   "scripts": {
     "preinstall": "npx only-allow pnpm",
@@ -25,20 +25,19 @@
     "vite-plugin-qiankun": "1.0.15",
     "@types/jest": "^29.5.11",
     "@types/jsdom": "21.1.6",
-    "jsdom": "^23.0.1",
     "jest": "^29.7.0",
     "ts-jest": "^29.1.1"
   },
   "engines": {
     "node": ">=v18.18.2"
   },
-  "homepage": "https://github.com/mia-platform/microfronent-sdk#readme",
+  "homepage": "https://github.com/mia-platform/console-sdk-microfrontend#readme",
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/mia-platform/microfronent-sdk.git"
+    "url": "git+https://github.com/mia-platform/console-sdk-microfrontend.git"
   },
   "bugs": {
-    "url": "https://github.com/mia-platform/microfronent-sdk/issues"
+    "url": "https://github.com/mia-platform/console-sdk-microfrontend/issues"
   },
   "jest": {
     "preset": "ts-jest",

packages/microfrontend-sdk/src/MicrofrontendIntegrator.test.ts → packages/console-sdk-microfrontend/src/MicrofrontendIntegrator.test.ts

@@ -16,67 +16,56 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-import { JSDOM } from 'jsdom'
-
-import ConsoleSDK, { ContextsType, ISDKProps } from './MicrofrontendIntegrator'
-import { Events, EventsTypes } from './types'
-
-const dom = new JSDOM()
-const { document } = dom.window
-
-const container = document.createElement('div')
-container.id = '__quiankun_container__'
+import { ContextsType, Events, EventsTypes, IConsoleProps } from './types'
+import ConsoleSDK from './MicrofrontendIntegrator'
 
 const eventBus = jest.fn()
-const quiankunProps = { name: 'testMicrofrontend', container }
-const SDKPropsMock: ISDKProps = {
+const quiankunProps = { name: 'testMicrofrontend' }
+const consoleProps: IConsoleProps = {
   ...quiankunProps,
-  console: {
-    writeConfig: jest.fn(),
-    _signals: { mount: jest.fn() },
-    eventBus,
-    configObservables: {
-      endpoints: {},
-      collections: {},
-      configMaps: {},
-      services: {},
-      unsecretedVariables: [],
-
-      forceConfigUpdateChecksum: '',
-      microfrontendPluginConfig: {},
+  eventListener: eventBus,
+  featureTogglesProxyContext: {},
+  hotkeysContext: {},
+  resourceAPI: {
+    endpoints: {},
+    collections: {},
+    configMaps: {},
+    services: {},
+    unsecretedVariables: [],
+
+    forceConfigUpdateChecksum: '',
+    microfrontendPluginConfig: {},
+
+    selectedEnvironment: {},
+    selectedProject: {},
 
-      selectedEnvironment: {},
-      selectedProject: {},
+    writeConfig: jest.fn(),
 
-      _version: '0.0.0',
-    },
-    contexts: {
-      featureTogglesProxyContext: {},
-      hotkeysContext: {},
-    },
+    _version: '0.0.0',
+    _signals: { mount: jest.fn() },
   },
 }
 
 describe('ConsoleSDK', () => {
   it('should get the container id', () => {
-    const microfrontendIntegrator = new ConsoleSDK(SDKPropsMock)
+    const microfrontendIntegrator = new ConsoleSDK(consoleProps)
     expect(microfrontendIntegrator.getContainerId()).toBe('testMicrofrontend')
   })
 
   it('should send an event through the event bus', () => {
-    const microfrontendIntegrator = new ConsoleSDK(SDKPropsMock)
+    const microfrontendIntegrator = new ConsoleSDK(consoleProps)
     const event: Events = {
       payload: { test: 'case' },
       publisherId: 'microfrontend-test',
       action: EventsTypes.SET_DYNAMIC_ROUTES,
     }
 
     microfrontendIntegrator.sendEvent(event)
-    expect(SDKPropsMock.console.eventBus).toHaveBeenCalledWith(event)
+    expect(consoleProps.eventListener).toHaveBeenCalledWith(event)
   })
 
   it('should get a context', () => {
-    const microfrontendIntegrator = new ConsoleSDK(SDKPropsMock)
+    const microfrontendIntegrator = new ConsoleSDK(consoleProps)
 
     const featureToggleContext = microfrontendIntegrator.getContext(ContextsType.FEATURE_TOGGLE_CONTEXT)
     const hotkeysContext = microfrontendIntegrator.getContext(ContextsType.HOTKEYS_CONTEXT)
@@ -88,7 +77,7 @@ describe('ConsoleSDK', () => {
   })
 
   it('should get the console config observable', () => {
-    const microfrontendIntegrator = new ConsoleSDK(SDKPropsMock)
+    const microfrontendIntegrator = new ConsoleSDK(consoleProps)
     const configObservable = microfrontendIntegrator.getConsoleConfigObservable()
 
     expect(configObservable).toHaveProperty('endpoints')

packages/console-sdk-microfrontend/src/MicrofrontendIntegrator.ts

@@ -0,0 +1,75 @@
+/**
+ * Copyright 2024 Mia srl
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+import { Subject } from 'rxjs'
+
+import { ContextsType, Events, IConsoleProps, IContexts, ISDKConsoleObservable } from './types'
+import { getConsoleProps } from './adaptConsoleProps'
+
+export type IMicrofronendIntegrator = {
+  getContext(contextType: ContextsType): IContexts[keyof IContexts] | undefined
+  getContainerId(): string
+  getConsoleConfigObservable(): ISDKConsoleObservable
+  sendEvent(event: Events): void
+}
+export default class MicrofronendIntegrator implements IMicrofronendIntegrator {
+  private events: Subject<Events>
+
+  name: string
+  contexts: IContexts
+  configObservable: ISDKConsoleObservable
+
+  constructor(mountingProps: IConsoleProps) {
+    const { name, console } = getConsoleProps(mountingProps)
+    const { eventBus, contexts } = console
+
+    this.name = name
+    this.contexts = contexts
+    this.configObservable = console.configObservables
+
+    this.events = new Subject()
+    this.events.subscribe(eventBus)
+  }
+
+  getContext(contextType: ContextsType): IContexts[keyof IContexts] | undefined {
+    switch (contextType) {
+    case ContextsType.FEATURE_TOGGLE_CONTEXT: {
+      const ctx: IContexts['featureTogglesProxyContext'] = {}
+      return ctx
+    }
+    case ContextsType.HOTKEYS_CONTEXT: {
+      const ctx: IContexts['hotkeysContext'] = {}
+      return ctx
+    }
+    default:
+      return undefined
+    }
+  }
+
+  getContainerId(): string {
+    return this.name
+  }
+
+  getConsoleConfigObservable(): ISDKConsoleObservable {
+    return this.configObservable
+  }
+
+  sendEvent(event: Events): void {
+    this.events.next(event)
+  }
+}

packages/microfrontend-sdk/src/adaptConsoleProps.ts → packages/console-sdk-microfrontend/src/adaptConsoleProps.ts

@@ -16,13 +16,12 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-import { QiankunProps } from 'vite-plugin-qiankun/dist/helper'
 import { omit } from 'ramda'
 
-import { ISDKProps } from './MicrofrontendIntegrator'
+import { IConsoleProps, ISDKProps } from './types'
 import pkg from '../package.json'
 
-export function getConsoleProps(props: QiankunProps): ISDKProps {
+export function getConsoleProps(props: IConsoleProps): ISDKProps {
   const {
     eventListener,
     resourceAPI,

packages/microfrontend-sdk/src/index.ts → packages/console-sdk-microfrontend/src/index.ts

@@ -16,12 +16,13 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-import ConsoleSDK, { IConsoleSDK, ISDKProps } from './MicrofrontendIntegrator'
-import { Events, EventsTypes } from './types'
+import ConsoleSDK, { IMicrofronendIntegrator } from './MicrofrontendIntegrator'
+import { Events, EventsTypes, IConsoleProps, ISDKProps } from './types'
 
 export type {
   ISDKProps,
-  IConsoleSDK,
+  IConsoleProps,
+  IMicrofronendIntegrator,
   Events,
   EventsTypes,
 }