@kosdev-code/kos-nx-plugin 2.0.2

package/src/generators/kos-plugin-project/files/src/app/app.tsx.template

@@ -0,0 +1,54 @@
+import { Global } from '@emotion/react';
+import {
+  ApplicationComponentConfigurationProvider,
+  ApplicationProvider,
+} from '@kosdev-code/kos-ddk-model-components';
+import { getStyles } from '@kosdev-code/kos-ddk-styles';
+import {
+  ErrorBoundaryWithFallback,
+  KosTranslationProvider,
+  LoadingMessage,
+  getLogLevel,
+} from '@kosdev-code/kos-ui-sdk';
+import log from 'loglevel';
+import { Suspense } from 'react';
+import { Route, HashRouter as Router, Routes } from 'react-router-dom';
+import { KosCoreContextProvider } from '../registration';
+import "@kosdev-code/kos-ddk-components/style.css";
+import './app.css';
+import { MainView } from './components/main-view';
+
+const level = getLogLevel();
+
+log.setLevel(level);
+
+const App = () => (
+  <>
+    <Global styles={getStyles()}></Global>
+    <ErrorBoundaryWithFallback>
+      <Suspense fallback={<LoadingMessage></LoadingMessage>}>
+        <KosCoreContextProvider>
+          <KosTranslationProvider
+            appContext={['app/system', 'app/kosdev.ddk']}
+            locale="en"
+          >
+            <ApplicationProvider>
+              <ApplicationComponentConfigurationProvider>
+                <div className="App">
+                  <Router window={window}>
+                    <Routes>
+                      <Route index element={<MainView />} />
+                      <Route path=":id" element={<MainView />} />
+                    </Routes>
+                  </Router>
+                </div>
+              </ApplicationComponentConfigurationProvider>
+            </ApplicationProvider>
+          </KosTranslationProvider>
+        </KosCoreContextProvider>
+      </Suspense>
+    </ErrorBoundaryWithFallback>
+  </>
+);
+
+export default App;

package/src/generators/kos-plugin-project/files/src/app/components/main-view/index.ts.template

@@ -0,0 +1 @@
+export * from "./main-view";

package/src/generators/kos-plugin-project/files/src/app/components/main-view/main-view.tsx.template

@@ -0,0 +1,14 @@
+import { kosComponent, KosLog } from '@kosdev-code/kos-ui-sdk';
+import { resolver, kOSJSON } from '../../tools';
+import { DynamicContainer, Shell } from '@kosdev-code/kos-ui-plugin/dev';
+
+const log = KosLog.createLogger({ name: 'main-view' });
+log.debug('main-view component loaded');
+
+export const MainView: React.FunctionComponent = kosComponent(() => {
+  return (
+    <Shell>
+      <DynamicContainer kOSJSON={kOSJSON} resolver={resolver} />
+    </Shell>
+  );
+});

package/src/generators/kos-plugin-project/files/src/app/tools/experience-resolver.ts.template

@@ -0,0 +1,10 @@
+export const resolver = async (location: string) => {
+  const regexp = /\.\/src\/app\/(.+)\/.+/;
+  const match = location.match(regexp);
+
+  if (!match) throw new Error("Invalid location");
+
+  const target = match[1];
+
+  return await import(`../${target}`);
+};

package/src/generators/kos-plugin-project/files/src/app/tools/index.ts.template

@@ -0,0 +1,2 @@
+export * from './experience-resolver';
+export * from './kOSJSON';

package/src/generators/kos-plugin-project/files/src/app/tools/kOSJSON.ts.template

@@ -0,0 +1 @@
+export { default as kOSJSON } from '../../../.kos.json';

package/src/generators/kos-plugin-project/files/src/assets/kos-logo.svg.template

@@ -0,0 +1,4 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<svg id="kos_logo_full" data-name="kos_logo_full" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 41.58 16.95">
+    <path d="m21.49,12.39c-.7-.38-1.25-.91-1.64-1.59-.4-.68-.59-1.45-.59-2.32s.2-1.64.59-2.32c.4-.68.94-1.21,1.64-1.59.7-.38,1.49-.57,2.38-.57s1.68.19,2.38.57c.7.38,1.25.91,1.64,1.59.4.68.59,1.45.59,2.32s-.2,1.64-.59,2.32c-.4.68-.94,1.21-1.64,1.59-.7.38-1.49.57-2.38.57s-1.68-.19-2.38-.57Zm3.76-1.49c.4-.24.72-.56.95-.98.23-.42.34-.9.34-1.43s-.11-1.01-.34-1.43c-.23-.42-.54-.75-.95-.98-.4-.24-.86-.35-1.37-.35s-.97.12-1.37.35c-.4.24-.72.56-.95.98-.23.42-.34.9-.34,1.43s.11,1.01.34,1.43c.23.42.54.75.95.98.4.24.86.35,1.37.35s.97-.12,1.37-.35Zm6.34,1.67c-.73-.24-1.32-.56-1.76-.98l1.16-1.42c.81.72,1.77,1.08,2.89,1.08.51,0,.92-.1,1.24-.29.31-.19.47-.43.47-.71,0-.21-.09-.38-.28-.53-.18-.14-.5-.26-.94-.35l-1.84-.35c-.8-.15-1.4-.43-1.79-.83-.4-.4-.59-.91-.59-1.51,0-.54.16-1.02.47-1.42.32-.4.76-.71,1.32-.93s1.2-.32,1.91-.32c.67,0,1.32.1,1.93.29s1.15.49,1.6.9l-1.08,1.38c-.76-.62-1.6-.92-2.51-.92-.49,0-.89.08-1.22.25-.32.17-.49.38-.49.64,0,.17.08.32.25.44.16.13.48.24.94.32l1.7.31c.85.16,1.49.46,1.91.91.43.44.64.97.64,1.59,0,.55-.15,1.04-.44,1.46s-.71.75-1.25.98-1.17.35-1.88.35c-.86,0-1.65-.12-2.38-.35ZM41.5,1c0-.55-.46-1-1.01-1H1C.45,0,0,.45,0,1v14.95c0,.55.45,1,1,1h15.2v-.02s.06.02.1.02h24.29c.55,0,1-.45.99-1l-.08-14.95Zm-25.21,14.95l-.09-14.95h24.3s.09,14.95.09,14.95h-24.3Zm-8.34-7.1l-1.66,1.64v2.32h-1.88V4.16h1.88v4.09l4.1-4.09h2.27l-3.42,3.4,3.62,5.24h-2.23l-2.69-3.96Z"/>
+</svg>

package/src/generators/kos-plugin-project/files/src/assets/locales/en/__nameDashCase__.json.template

@@ -0,0 +1,3 @@
+{
+    "ddk.ncui.config.title": "Placeholder Config",
+}

package/src/generators/kos-plugin-project/files/src/registration.ts.template

@@ -0,0 +1,13 @@
+import { Application, DDKModels } from '@kosdev-code/kos-ddk-models';
+import { KosModelRegistry } from '@kosdev-code/kos-dispense-sdk';
+
+import { initKosProvider, registerLegacyModel } from '@kosdev-code/kos-ui-sdk';
+
+KosModelRegistry.dispense.models().model(Application);
+Object.keys(DDKModels).forEach((key) => {
+  const model = DDKModels[key];
+  registerLegacyModel(KosModelRegistry)(key, model);
+});
+const { KosCoreContextProvider } = initKosProvider();
+
+export { KosCoreContextProvider };

package/src/generators/kos-plugin-project/files/webpack.config.prod.ts.template

@@ -0,0 +1,24 @@
+import { generatePluginConfiguration } from '@kosdev-code/kos-ui-plugin/utilities';
+import { withKosConfig } from '@kosdev-code/kos-ui-plugin/webpack';
+import { withReact } from '@nx/react';
+import { withModuleFederation } from '@nx/react/module-federation';
+import { composePlugins, withNx } from '@nx/webpack';
+import { readFileSync } from 'fs';
+import { join } from 'path';
+import * as webpack from 'webpack';
+
+const kosConfig = JSON.parse(
+  readFileSync(join(__dirname, './.kos.json'), 'utf-8')
+);
+const baseConfig = generatePluginConfiguration(kosConfig);
+const config = {
+  ...baseConfig,
+};
+
+// Nx plugins for webpack to build config object from Nx options and context.
+export default composePlugins(
+  withNx(),
+  withReact({}),
+  withModuleFederation(config),
+  withKosConfig(webpack)
+);

package/src/generators/kos-plugin-project/files/webpack.config.ts.template

@@ -0,0 +1,7 @@
+import { withKosConfig } from '@kosdev-code/kos-ui-plugin/webpack';
+import { withReact } from '@nx/react';
+import { composePlugins, withNx } from '@nx/webpack';
+import * as webpack from 'webpack';
+
+// Nx plugins for webpack to build config object from Nx options and context.
+export default composePlugins(withNx(), withReact({}), withKosConfig(webpack));

package/src/generators/kos-plugin-project/generator.d.ts

@@ -0,0 +1,5 @@
+import { Tree } from "@nx/devkit";
+import { KosPluginProjectGeneratorSchema } from "./schema";
+export declare function kosPluginProjectGenerator(tree: Tree, options: KosPluginProjectGeneratorSchema): Promise<void>;
+export default kosPluginProjectGenerator;
+//# sourceMappingURL=generator.d.ts.map

package/src/generators/kos-plugin-project/generator.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"generator.d.ts","sourceRoot":"","sources":["../../../../../../../packages/plugins/kos-nx-plugin/src/generators/kos-plugin-project/generator.ts"],"names":[],"mappings":"AAAA,OAAO,EAKL,IAAI,EAEL,MAAM,YAAY,CAAC;AAKpB,OAAO,EAAE,+BAA+B,EAAE,MAAM,UAAU,CAAC;AAC3D,wBAAsB,yBAAyB,CAC7C,IAAI,EAAE,IAAI,EACV,OAAO,EAAE,+BAA+B,iBA6HzC;AAED,eAAe,yBAAyB,CAAC"}

package/src/generators/kos-plugin-project/generator.js

@@ -0,0 +1,108 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.kosPluginProjectGenerator = void 0;
+const devkit_1 = require("@nx/devkit");
+const eslint_1 = require("@nx/eslint");
+const react_1 = require("@nx/react");
+const path = require("path");
+const normalize_value_1 = require("../kos-model/lib/normalize-value");
+async function kosPluginProjectGenerator(tree, options) {
+    const normalizedOptions = (0, normalize_value_1.normalizeAllValues)({
+        name: options.name,
+    });
+    const normalized = {
+        ...normalizedOptions,
+        template: "",
+        directory: options.directory,
+        projectName: options.name,
+        uiType: options.uiType ?? "ddk.ncui.plugin",
+    };
+    console.log(normalized);
+    const projectRoot = path.join(options.directory ?? "plugins", normalized.name);
+    await (0, react_1.remoteGenerator)(tree, {
+        e2eTestRunner: "none",
+        projectNameAndRootFormat: "as-provided",
+        dynamic: true,
+        linter: eslint_1.Linter.EsLint,
+        name: normalized.name,
+        directory: projectRoot,
+        tags: "type:plugin",
+        unitTestRunner: "none",
+        style: "@emotion/styled",
+        skipFormat: false,
+        typescriptConfiguration: true,
+    });
+    await (0, react_1.storybookConfigurationGenerator)(tree, {
+        project: normalized.name,
+        generateStories: false,
+        interactionTests: false,
+    });
+    const projectConfiguration = (0, devkit_1.readProjectConfiguration)(tree, normalized.projectName);
+    const externalJson = {
+        kab: {
+            command: `node tools/scripts/kabtool.mjs build ${normalized.nameDashCase} && node tools/scripts/kabtool.mjs list ${normalized.nameDashCase} `,
+            options: {
+                outputPath: `dist/archives/packages/${normalized.nameDashCase}/`,
+                zipName: "ui.zip",
+                kabName: `${normalized.nameDashCase}.kab`,
+            },
+            dependsOn: ["zip"],
+        },
+        zip: {
+            command: `node tools/scripts/archiver.js ${normalized.nameDashCase}`,
+            options: {
+                outputPath: `dist/archives/packages/${normalized.nameDashCase}/`,
+                zipName: "ui.zip",
+            },
+            dependsOn: ["build:production", "descriptor"],
+        },
+        descriptor: {
+            command: `node tools/scripts/descriptor.mjs ${normalized.nameDashCase}`,
+            options: {
+                outputPath: `dist/plugins/${normalized.nameDashCase}`,
+                fileName: "descriptor.json",
+            },
+            dependsOn: ["build"],
+        },
+    };
+    (0, devkit_1.updateJson)(tree, `${projectConfiguration.root}/project.json`, (json) => {
+        json.targets = {
+            ...json.targets,
+            ...externalJson,
+        };
+        if (json.targets?.build?.configurations?.production) {
+            json.targets.build.configurations.production.webpackConfig = `plugins/${normalized.nameDashCase}/webpack.config.prod.ts`;
+        }
+        return json;
+    });
+    (0, devkit_1.updateJson)(tree, `${projectConfiguration.root}/tsconfig.json`, (json) => {
+        json.compilerOptions = {
+            ...json.compilerOptions,
+            moduleResolution: "Bundler",
+            resolveJsonModule: true,
+        };
+        return json;
+    });
+    (0, devkit_1.updateJson)(tree, `${projectConfiguration.root}/tsconfig.storybook.json`, (json) => {
+        json.include.push(".storybook/*.jsx");
+        json.include.push(".storybook/*.tsx");
+        return json;
+    });
+    (0, devkit_1.generateFiles)(tree, path.join(__dirname, "files"), projectConfiguration.root, normalized);
+    tree.delete(`${projectConfiguration.root}/src/app/nx-welcome.tsx`);
+    tree.delete(`${projectConfiguration.root}/src/index.ts`);
+    tree.delete(`${projectConfiguration.root}/src/app/app.spec.tsx`);
+    tree.delete(`${projectConfiguration.root}/.storybook/preview.ts`);
+    (0, devkit_1.addDependenciesToPackageJson)(tree, {
+        "@kosdev-code/kos-ddk": "^0.2.0",
+        "@kosdev-code/kos-ddk-components": "^0.2.0",
+        "@kosdev-code/kos-ddk-model-components": "^0.2.0",
+        "@kosdev-code/kos-ddk-models": "^0.2.0",
+        "@kosdev-code/kos-ddk-styles": "^0.2.0",
+        "@kosdev-code/kos-ui-plugin": "^0.2.0",
+    }, {});
+    await (0, devkit_1.formatFiles)(tree);
+}
+exports.kosPluginProjectGenerator = kosPluginProjectGenerator;
+exports.default = kosPluginProjectGenerator;
+//# sourceMappingURL=generator.js.map

package/src/generators/kos-plugin-project/generator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"generator.js","sourceRoot":"","sources":["../../../../../../../packages/plugins/kos-nx-plugin/src/generators/kos-plugin-project/generator.ts"],"names":[],"mappings":";;;AAAA,uCAOoB;AACpB,uCAAoC;AACpC,qCAA6E;AAC7E,6BAA6B;AAC7B,sEAAsE;AAE/D,KAAK,UAAU,yBAAyB,CAC7C,IAAU,EACV,OAAwC;IAExC,MAAM,iBAAiB,GAAG,IAAA,oCAAkB,EAAC;QAC3C,IAAI,EAAE,OAAO,CAAC,IAAI;KACnB,CAAC,CAAC;IACH,MAAM,UAAU,GAAG;QACjB,GAAG,iBAAiB;QACpB,QAAQ,EAAE,EAAE;QACZ,SAAS,EAAE,OAAO,CAAC,SAAS;QAC5B,WAAW,EAAE,OAAO,CAAC,IAAI;QACzB,MAAM,EAAE,OAAO,CAAC,MAAM,IAAI,iBAAiB;KAC5C,CAAC;IACF,OAAO,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;IACxB,MAAM,WAAW,GAAG,IAAI,CAAC,IAAI,CAC3B,OAAO,CAAC,SAAS,IAAI,SAAS,EAC9B,UAAU,CAAC,IAAI,CAChB,CAAC;IACF,MAAM,IAAA,uBAAe,EAAC,IAAI,EAAE;QAC1B,aAAa,EAAE,MAAM;QACrB,wBAAwB,EAAE,aAAa;QACvC,OAAO,EAAE,IAAI;QACb,MAAM,EAAE,eAAM,CAAC,MAAM;QACrB,IAAI,EAAE,UAAU,CAAC,IAAI;QACrB,SAAS,EAAE,WAAW;QACtB,IAAI,EAAE,aAAa;QACnB,cAAc,EAAE,MAAM;QACtB,KAAK,EAAE,iBAAiB;QACxB,UAAU,EAAE,KAAK;QACjB,uBAAuB,EAAE,IAAI;KAC9B,CAAC,CAAC;IAEH,MAAM,IAAA,uCAA+B,EAAC,IAAI,EAAE;QAC1C,OAAO,EAAE,UAAU,CAAC,IAAI;QACxB,eAAe,EAAE,KAAK;QACtB,gBAAgB,EAAE,KAAK;KACxB,CAAC,CAAC;IAEH,MAAM,oBAAoB,GAAG,IAAA,iCAAwB,EACnD,IAAI,EACJ,UAAU,CAAC,WAAW,CACvB,CAAC;IAEF,MAAM,YAAY,GAAG;QACnB,GAAG,EAAE;YACH,OAAO,EAAE,wCAAwC,UAAU,CAAC,YAAY,2CAA2C,UAAU,CAAC,YAAY,GAAG;YAC7I,OAAO,EAAE;gBACP,UAAU,EAAE,0BAA0B,UAAU,CAAC,YAAY,GAAG;gBAChE,OAAO,EAAE,QAAQ;gBACjB,OAAO,EAAE,GAAG,UAAU,CAAC,YAAY,MAAM;aAC1C;YACD,SAAS,EAAE,CAAC,KAAK,CAAC;SACnB;QACD,GAAG,EAAE;YACH,OAAO,EAAE,kCAAkC,UAAU,CAAC,YAAY,EAAE;YACpE,OAAO,EAAE;gBACP,UAAU,EAAE,0BAA0B,UAAU,CAAC,YAAY,GAAG;gBAChE,OAAO,EAAE,QAAQ;aAClB;YACD,SAAS,EAAE,CAAC,kBAAkB,EAAE,YAAY,CAAC;SAC9C;QACD,UAAU,EAAE;YACV,OAAO,EAAE,qCAAqC,UAAU,CAAC,YAAY,EAAE;YACvE,OAAO,EAAE;gBACP,UAAU,EAAE,gBAAgB,UAAU,CAAC,YAAY,EAAE;gBACrD,QAAQ,EAAE,iBAAiB;aAC5B;YACD,SAAS,EAAE,CAAC,OAAO,CAAC;SACrB;KACF,CAAC;IACF,IAAA,mBAAU,EAAC,IAAI,EAAE,GAAG,oBAAoB,CAAC,IAAI,eAAe,EAAE,CAAC,IAAI,EAAE,EAAE;QACrE,IAAI,CAAC,OAAO,GAAG;YACb,GAAG,IAAI,CAAC,OAAO;YACf,GAAG,YAAY;SAChB,CAAC;QAEF,IAAI,IAAI,CAAC,OAAO,EAAE,KAAK,EAAE,cAAc,EAAE,UAAU,EAAE,CAAC;YACpD,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,cAAc,CAAC,UAAU,CAAC,aAAa,GAAG,WAAW,UAAU,CAAC,YAAY,yBAAyB,CAAC;QAC3H,CAAC;QAED,OAAO,IAAI,CAAC;IACd,CAAC,CAAC,CAAC;IACH,IAAA,mBAAU,EAAC,IAAI,EAAE,GAAG,oBAAoB,CAAC,IAAI,gBAAgB,EAAE,CAAC,IAAI,EAAE,EAAE;QACtE,IAAI,CAAC,eAAe,GAAG;YACrB,GAAG,IAAI,CAAC,eAAe;YACvB,gBAAgB,EAAE,SAAS;YAC3B,iBAAiB,EAAE,IAAI;SACxB,CAAC;QAEF,OAAO,IAAI,CAAC;IACd,CAAC,CAAC,CAAC;IACH,IAAA,mBAAU,EACR,IAAI,EACJ,GAAG,oBAAoB,CAAC,IAAI,0BAA0B,EACtD,CAAC,IAAI,EAAE,EAAE;QACP,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC;QACtC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC;QAEtC,OAAO,IAAI,CAAC;IACd,CAAC,CACF,CAAC;IACF,IAAA,sBAAa,EACX,IAAI,EACJ,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,OAAO,CAAC,EAC7B,oBAAoB,CAAC,IAAI,EACzB,UAAU,CACX,CAAC;IAEF,IAAI,CAAC,MAAM,CAAC,GAAG,oBAAoB,CAAC,IAAI,yBAAyB,CAAC,CAAC;IACnE,IAAI,CAAC,MAAM,CAAC,GAAG,oBAAoB,CAAC,IAAI,eAAe,CAAC,CAAC;IACzD,IAAI,CAAC,MAAM,CAAC,GAAG,oBAAoB,CAAC,IAAI,uBAAuB,CAAC,CAAC;IACjE,IAAI,CAAC,MAAM,CAAC,GAAG,oBAAoB,CAAC,IAAI,wBAAwB,CAAC,CAAC;IAElE,IAAA,qCAA4B,EAC1B,IAAI,EACJ;QACE,sBAAsB,EAAE,QAAQ;QAChC,iCAAiC,EAAE,QAAQ;QAC3C,uCAAuC,EAAE,QAAQ;QACjD,6BAA6B,EAAE,QAAQ;QACvC,6BAA6B,EAAE,QAAQ;QACvC,4BAA4B,EAAE,QAAQ;KACvC,EACD,EAAE,CACH,CAAC;IACF,MAAM,IAAA,oBAAW,EAAC,IAAI,CAAC,CAAC;AAC1B,CAAC;AA/HD,8DA+HC;AAED,kBAAe,yBAAyB,CAAC"}

package/src/generators/kos-plugin-project/schema.d.ts

@@ -0,0 +1,5 @@
+export interface KosPluginProjectGeneratorSchema {
+  name: string;
+  directory?: string;
+  uiType?: string;
+}

package/src/generators/kos-plugin-project/schema.json

@@ -0,0 +1,33 @@
+{
+  "$schema": "http://json-schema.org/schema",
+  "$id": "KosPluginProject",
+  "title": "",
+  "type": "object",
+  "properties": {
+    "name": {
+      "type": "string",
+      "description": "",
+      "$default": {
+        "$source": "argv",
+        "index": 0
+      },
+      "x-prompt": "What name would you like to use?"
+    },
+    "directory": {
+      "type": "string",
+      "description": "",
+      "required": false,
+      "$default": {
+        "$source": "argv",
+        "index": 1
+      },
+      "x-prompt": "What directory would you like to use?"
+    },
+    "uiType": {
+      "type": "string",
+      "description": "KAB type of UI",
+      "default": "ddk.ncui.plugin"
+    }
+  },
+  "required": ["name"]
+}

package/src/generators/kos-splash-project/files/project/project.json.template

@@ -0,0 +1,17 @@
+{
+  "name": "<%= nameDashCase %>",
+  "$schema": "../../node_modules/nx/schemas/project-schema.json",
+  "sourceRoot": "splash/<%= nameDashCase %>/src",
+  "projectType": "application",
+  "targets": {
+    "splash": {
+      "command": "node tools/scripts/splashtool.mjs <%= nameDashCase %>",
+      "options": {
+        "outputPath": "dist/archives/packages/<%= nameDashCase %>/",
+        "layerName": "<%= nameDashCase %>",
+        "startPath": "start.html"
+      }
+    }
+  },
+  "tags": []
+}

package/src/generators/kos-splash-project/files/project/src/start.html.template

@@ -0,0 +1,13 @@
+<!DOCTYPE html>
+<html lang="en">
+  <head>
+    <meta charset="utf-8" />
+    <title><%= nameDashCase %></title>
+    <base href="./" />
+
+    <meta name="viewport" content="width=device-width, initial-scale=1" />
+  </head>
+  <body>
+    <div id="root">Hello World</div>
+  </body>
+</html>

package/src/generators/kos-splash-project/files/tools/splashtool.mjs.template

@@ -0,0 +1,247 @@
+#!/usr/bin/env node
+import devkit from '@nx/devkit';
+import archiver from 'archiver';
+import chalk from 'chalk';
+import { spawn } from 'child_process';
+import dotenv from 'dotenv';
+import dotenvExpand from 'dotenv-expand';
+import fs from 'fs';
+import path from 'path';
+const { readCachedProjectGraph } = devkit;
+
+const [, , projectName] = process.argv;
+
+const graph = readCachedProjectGraph();
+const project = graph.nodes[projectName];
+const config = dotenv.config({
+  path: path.resolve(process.cwd(), '.env'),
+});
+
+dotenvExpand.expand(config);
+const splashOptions = project.data?.targets?.splash?.options;
+
+const { outputPath, layerName, startPath } = splashOptions;
+const installPath = process.env.KOS_INSTALL_PATH;
+if (!fs.existsSync(outputPath)) {
+  fs.mkdirSync(outputPath, { recursive: true });
+}
+
+const htmlPath = path.resolve(project.data.sourceRoot, startPath);
+fs.copyFileSync(htmlPath, path.resolve(outputPath, 'start.html'));
+
+const packPath = path.resolve(outputPath, 'layer.pack');
+if (!fs.existsSync(packPath)) {
+  fs.writeFileSync(
+    packPath,
+    `# gensquashfs pack file
+
+dir  /usr/share/www 0755 0 0
+file /usr/share/www/start.html 0644 0 0 ./start.html`,
+    { encoding: 'utf-8' }
+  );
+}
+createDiskImage({
+  outputPath,
+  layerName: `${layerName}.img`,
+  packPath,
+  installPath,
+})
+  .then((imgPath) => {
+    console.log('imgPath: ', imgPath);
+    const zipPath = path.resolve(outputPath, `${layerName}.zip`);
+    console.log('zipPath: ', zipPath);
+    return archiveDiskImage({ zipPath, imgPath });
+  })
+  .then((zipPath) => {
+    console.log('zipPath from archive: ', zipPath);
+    const kabName = `${layerName}.kab`;
+    return createKabFile({
+      zipPath,
+      kabName,
+      outputPath,
+      installPath,
+      layerName,
+    }).then(() => {
+      console.log(chalk.green('done'));
+    });
+  });
+async function createDiskImage({
+  outputPath,
+  layerName,
+  packPath,
+  installPath,
+}) {
+  return new Promise((resolve, reject) => {
+    console.log(`packPath: ${packPath}`);
+
+    if (!fs.existsSync(outputPath)) {
+      fs.mkdirSync(outputPath, { recursive: true });
+    }
+    const layerPath = path.resolve(outputPath, layerName);
+    console.log(`layerName: ${layerPath}`);
+
+    const genSquashFsLocation =
+      process.platform === 'darwin'
+        ? path.join(
+            'Contents',
+            'MacOS',
+            'lib',
+            'squashfs-tools-ng',
+            'bin',
+            'gensquashfs'
+          )
+        : path.join(
+            'release',
+            'lib',
+            'squashfs-tools-ng',
+            'bin',
+            'gensquashfs'
+          );
+
+    console.log(installPath, genSquashFsLocation);
+    const gensquashfsPath = path.resolve(installPath, genSquashFsLocation);
+
+    const command = gensquashfsPath;
+
+    const baseBuildArgs = [
+      '-F',
+      packPath,
+      '--compressor=gzip',
+      '--force',
+      layerPath,
+    ];
+
+    const args = [...baseBuildArgs];
+
+    const ps = spawn(command, args);
+
+    ps.stdout.on('data', (data) => {
+      console.log(chalk.blue(`studio: ${data}`));
+    });
+
+    ps.stderr.on('data', (data) => {
+      console.error(chalk.red(`studio: ${data}`));
+    });
+
+    ps.on('close', (code) => {
+      console.log(`child process exited with code ${code}`);
+      if (code === 0) {
+        resolve(layerPath);
+      } else {
+        reject();
+      }
+    });
+  });
+}
+async function archiveDiskImage({ zipPath, imgPath }) {
+  console.log(`archiveDiskImage: zipPath: ${zipPath}, imgPath: ${imgPath}`);
+  return new Promise((resolve, reject) => {
+    const output = fs.createWriteStream(zipPath);
+    const archive = archiver('zip', {
+      zlib: { level: 9 }, // Sets the compression level.
+    });
+
+    // listen for all archive data to be written
+    // 'close' event is fired only when a file descriptor is involved
+    output.on('close', function () {
+      console.log(archive.pointer() + ' total bytes');
+      console.log(
+        'archiver has been finalized and the output file descriptor has closed.'
+      );
+      resolve(zipPath);
+    });
+
+    // This event is fired when the data source is drained no matter what was the data source.
+    // It is not part of this library but rather from the NodeJS Stream API.
+    // @see: https://nodejs.org/api/stream.html#stream_event_end
+    output.on('end', function () {
+      console.log('Data has been drained');
+    });
+
+    // good practice to catch warnings (ie stat failures and other non-blocking errors)
+    archive.on('warning', function (err) {
+      if (err.code === 'ENOENT') {
+        // log warning
+      } else {
+        // throw error
+        reject();
+      }
+    });
+
+    // good practice to catch this error explicitly
+    archive.on('error', function (err) {
+      reject();
+    });
+
+    // pipe archive data to the file
+    archive.pipe(output);
+
+    // append a file from stream
+
+    // append files from a sub-directory, putting its contents at the root of archive
+    archive.file(imgPath, { name: 'layer.img' });
+
+    // finalize the archive (ie we are done appending files but streams have to finish yet)
+    // 'close', 'end' or 'finish' may be fired right after calling this method so register to them beforehand
+    archive.finalize();
+  });
+}
+
+async function createKabFile({
+  zipPath,
+  kabName,
+  outputPath,
+  installPath,
+  layerName,
+}) {
+  return new Promise((resolve, reject) => {
+    if (!fs.existsSync(outputPath)) {
+      fs.mkdirSync(outputPath, { recursive: true });
+    }
+    const kabPath = path.resolve(outputPath, kabName);
+    console.log(`kabPath: ${kabPath}`);
+
+    const kabtoolLocation =
+      process.platform === 'darwin'
+        ? path.join('Contents', 'MacOS', 'bin', 'kabtool')
+        : path.join('release', 'bin', 'kabtool');
+
+    const kabtoolPath = path.resolve(installPath, kabtoolLocation);
+    console.log(kabtoolPath);
+    const command = kabtoolPath;
+
+    const baseBuildArgs = [
+      '-b',
+      '-t',
+      'kos.layer',
+      '-n',
+      layerName,
+      '-v',
+      '0.0.1',
+      '-z',
+      zipPath,
+    ];
+
+    const args = [...baseBuildArgs, kabPath];
+
+    console.log(command, args);
+    const ps = spawn(command, args);
+
+    ps.stdout.on('data', (data) => {
+      console.log(chalk.blue(`studio: ${data}`));
+    });
+
+    ps.stderr.on('data', (data) => {
+      console.error(chalk.red(`studio: ${data}`));
+    });
+
+    ps.on('close', (code) => {
+      console.log(`child process exited with code ${code}`);
+      if (code === 0) {
+        resolve();
+      } else {
+        reject();
+      }
+    });
+  });
+}

package/src/generators/kos-splash-project/generator.d.ts

@@ -0,0 +1,5 @@
+import { Tree } from "@nx/devkit";
+import { KosSplashProjectGeneratorSchema } from "./schema";
+export declare function kosSplashProjectGenerator(tree: Tree, options: KosSplashProjectGeneratorSchema): Promise<void>;
+export default kosSplashProjectGenerator;
+//# sourceMappingURL=generator.d.ts.map

package/src/generators/kos-splash-project/generator.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"generator.d.ts","sourceRoot":"","sources":["../../../../../../../packages/plugins/kos-nx-plugin/src/generators/kos-splash-project/generator.ts"],"names":[],"mappings":"AAAA,OAAO,EAA8B,IAAI,EAAE,MAAM,YAAY,CAAC;AAG9D,OAAO,EAAE,+BAA+B,EAAE,MAAM,UAAU,CAAC;AAC3D,wBAAsB,yBAAyB,CAC7C,IAAI,EAAE,IAAI,EACV,OAAO,EAAE,+BAA+B,iBAoBzC;AAED,eAAe,yBAAyB,CAAC"}

package/src/generators/kos-splash-project/generator.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.kosSplashProjectGenerator = void 0;
+const devkit_1 = require("@nx/devkit");
+const path = require("path");
+const normalize_value_1 = require("../../utils/normalize-value");
+async function kosSplashProjectGenerator(tree, options) {
+    const normalized = (0, normalize_value_1.normalizeAllValues)(options);
+    const projectRoot = `splash/${normalized.nameDashCase}`;
+    const toolsRoot = path.join("tools", "scripts");
+    (0, devkit_1.generateFiles)(tree, path.join(__dirname, "files", "project"), projectRoot, normalized);
+    (0, devkit_1.generateFiles)(tree, path.join(__dirname, "files", "tools"), toolsRoot, normalized);
+    await (0, devkit_1.formatFiles)(tree);
+}
+exports.kosSplashProjectGenerator = kosSplashProjectGenerator;
+exports.default = kosSplashProjectGenerator;
+//# sourceMappingURL=generator.js.map

package/src/generators/kos-splash-project/generator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"generator.js","sourceRoot":"","sources":["../../../../../../../packages/plugins/kos-nx-plugin/src/generators/kos-splash-project/generator.ts"],"names":[],"mappings":";;;AAAA,uCAA8D;AAC9D,6BAA6B;AAC7B,iEAAiE;AAE1D,KAAK,UAAU,yBAAyB,CAC7C,IAAU,EACV,OAAwC;IAExC,MAAM,UAAU,GAAG,IAAA,oCAAkB,EAAC,OAAO,CAAC,CAAC;IAE/C,MAAM,WAAW,GAAG,UAAU,UAAU,CAAC,YAAY,EAAE,CAAC;IACxD,MAAM,SAAS,GAAG,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,SAAS,CAAC,CAAC;IAChD,IAAA,sBAAa,EACX,IAAI,EACJ,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,OAAO,EAAE,SAAS,CAAC,EACxC,WAAW,EACX,UAAU,CACX,CAAC;IAEF,IAAA,sBAAa,EACX,IAAI,EACJ,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,OAAO,EAAE,OAAO,CAAC,EACtC,SAAS,EACT,UAAU,CACX,CAAC;IACF,MAAM,IAAA,oBAAW,EAAC,IAAI,CAAC,CAAC;AAC1B,CAAC;AAtBD,8DAsBC;AAED,kBAAe,yBAAyB,CAAC"}

package/src/generators/kos-splash-project/schema.d.ts

@@ -0,0 +1,3 @@
+export interface KosSplashProjectGeneratorSchema {
+  name: string;
+}

package/src/generators/kos-splash-project/schema.json

@@ -0,0 +1,18 @@
+{
+  "$schema": "https://json-schema.org/schema",
+  "$id": "KosSplashProject",
+  "title": "",
+  "type": "object",
+  "properties": {
+    "name": {
+      "type": "string",
+      "description": "",
+      "$default": {
+        "$source": "argv",
+        "index": 0
+      },
+      "x-prompt": "What name would you like to use?"
+    }
+  },
+  "required": ["name"]
+}