@kosdev-code/kos-nx-plugin 2.0.2

package/README.md

@@ -0,0 +1,11 @@
+# plugins-kos-nx-plugin
+
+This library was generated with [Nx](https://nx.dev).
+
+## Building
+
+Run `nx build plugins-kos-nx-plugin` to build the library.
+
+## Running unit tests
+
+Run `nx test plugins-kos-nx-plugin` to execute the unit tests via [Jest](https://jestjs.io).

package/generators.json

@@ -0,0 +1,70 @@
+{
+  "generators": {
+    "kos-model": {
+      "factory": "./src/generators/kos-model/generator",
+      "schema": "./src/generators/kos-model/schema.json",
+      "description": "Generate a KOS Model"
+    },
+    "kos-container-model": {
+      "factory": "./src/generators/kos-container-model/generator",
+      "schema": "./src/generators/kos-container-model/schema.json",
+      "description": "Generate a KOS Container Model for an existing model"
+    },
+    "kos-hook": {
+      "factory": "./src/generators/kos-hook/generator",
+      "schema": "./src/generators/kos-hook/schema.json",
+      "description": "Create a react hook for a kOS model"
+    },
+    "kos-component": {
+      "factory": "./src/generators/kos-component/generator",
+      "schema": "./src/generators/kos-component/schema.json",
+      "description": "Create a new React component that can be connected to a kOS model"
+    },
+    "kos-context": {
+      "factory": "./src/generators/kos-context/generator",
+      "schema": "./src/generators/kos-context/schema.json",
+      "description": "Create a React context that can be used to provide a kOS model to a component"
+    },
+    "kos-ui-project": {
+      "factory": "./src/generators/kos-ui-project/generator",
+      "schema": "./src/generators/kos-ui-project/schema.json",
+      "description": "Create a new UI Project for kOS"
+    },
+    "kos-plugin-project": {
+      "factory": "./src/generators/kos-plugin-project/generator",
+      "schema": "./src/generators/kos-plugin-project/schema.json",
+      "description": "Create a new plugin project for kOS"
+    },
+    "kos-theme-project": {
+      "factory": "./src/generators/kos-theme-project/generator",
+      "schema": "./src/generators/kos-theme-project/schema.json",
+      "description": "Create a new theme project for kos"
+    },
+    "kos-i18n-project": {
+      "factory": "./src/generators/kos-i18n-project/generator",
+      "schema": "./src/generators/kos-i18n-project/schema.json",
+      "description": "Create a new i18n project for kos"
+    },
+    "kos-init": {
+      "factory": "./src/generators/kos-init/generator",
+      "schema": "./src/generators/kos-init/schema.json",
+      "description": "kos-init generator"
+    },
+    "preset": {
+      "factory": "./src/generators/preset/generator",
+      "schema": "./src/generators/preset/schema.json",
+      "description": "preset generator",
+      "x-use-standalone-layout": true
+    },
+    "kos-companion-model": {
+      "factory": "./src/generators/kos-companion-model/generator",
+      "schema": "./src/generators/kos-companion-model/schema.json",
+      "description": "kos-companion-model generator"
+    },
+    "kos-splash-project": {
+      "factory": "./src/generators/kos-splash-project/generator",
+      "schema": "./src/generators/kos-splash-project/schema.json",
+      "description": "Generates a new project to create a kOS splash screen"
+    }
+  }
+}

package/migrations.json

@@ -0,0 +1,81 @@
+{
+  "generators": {
+    "add-overrides": {
+      "version": "0.0.9",
+      "description": "add-overrides",
+      "cli": "nx",
+      "implementation": "./src/migrations/add-overrides/add-overrides"
+    },
+    "default-projects": {
+      "version": "0.1.164",
+      "description": "Add default kOS component projects",
+      "cli": "nx",
+      "implementation": "./src/migrations/default-projects/default-projects"
+    },
+    "update-sdk": {
+      "version": "0.1.165",
+      "description": "update-sdk",
+      "cli": "nx",
+      "implementation": "./src/migrations/update-sdk/update-sdk"
+    },
+    "translations": {
+      "version": "0.1.857",
+      "description": "adds kos translation support to existing projects",
+      "cli": "nx",
+      "implementation": "./src/migrations/translations/add-descriptor"
+    },
+    "extensions": {
+      "version": "0.1.1267",
+      "description": "migrates extensions to new format",
+      "cli": "nx",
+      "implementation": "./src/migrations/migrate-extensions/migrate-extensions"
+    },
+    "translation-format": {
+      "version": "0.1.1485",
+      "description": "migrates translations to new format",
+      "cli": "nx",
+      "implementation": "./src/migrations/translation-format/translation-format"
+    },
+    "freestyle-sdk": {
+      "version": "0.1.1580",
+      "description": "migrates scripts to allow updates of freestyle sdk",
+      "cli": "nx",
+      "implementation": "./src/migrations/freestyle-sdk/freestyle-sdk"
+    },
+    "cms-sdk": {
+      "version": "0.1.1667",
+      "description": "migrates scripts to allow updates of cms sdk",
+      "cli": "nx",
+      "implementation": "./src/migrations/cms-sdk/cms-sdk"
+    },
+    "update-kabtool": {
+      "version": "0.1.1759",
+      "description": "updates kabtool to support built automation",
+      "cli": "nx",
+      "implementation": "./src/migrations/update-kabtool/update-kabtool"
+    },
+    "add-update-tool": {
+      "version": "0.1.2297",
+      "description": "adds update tool to support automated dependency updates",
+      "cli": "nx",
+      "implementation": "./src/migrations/add-update-tool/migrate"
+    },
+    "kabtool-env": {
+      "version": "0.1.2297",
+      "description": "updates the kabtool to use the .env.local file",
+      "cli": "nx",
+      "implementation": "./src/migrations/kabtool-env/migrate"
+    },
+    "consolidate-sdk": {
+      "version": "1.6.0",
+      "description": "Migration for v1.6.0",
+      "implementation": "./src/migrations/consolidate-sdk/consolidate-sdk"
+    }
+  },
+  "packageJsonUpdates": {
+    "1.5.0": {
+      "version": "1.5.0",
+      "packages": {}
+    }
+  }
+}

package/package.json

@@ -0,0 +1,25 @@
+{
+  "name": "@kosdev-code/kos-nx-plugin",
+  "version": "2.0.2",
+  "type": "commonjs",
+  "generators": "./generators.json",
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org/"
+  },
+  "scripts": {
+    "postinstall": ""
+  },
+  "nx-migrations": {
+    "migrations": "./migrations.json"
+  },
+  "dependencies": {
+    "@nx/devkit": "^17.2.8",
+    "@nx/react": "^17.2.8"
+  },
+  "main": "./src/index.js",
+  "kos": {
+    "build": {
+      "gitHash": "07201c14a1bf5d3227fe2ffe67c0049384383ccd"
+    }
+  }
+}

package/src/generators/kos-companion-model/files/types/index.d.ts.template

@@ -0,0 +1,11 @@
+import type { IKosCompanionOptions } from "@kosdev-code/kos-ui-sdk";
+import type { <%= modelNameProperCase %>Options, <%= modelNameProperCase %>Model } from "<%= importPath %>";
+
+
+export type <%= companionModelNameProperCase %>Options = IKosCompanionOptions<
+  <%= companionModelNameProperCase %>Model,
+  <%= companionModelNameProperCase %>Options
+>;
+
+
+

package/src/generators/kos-companion-model/generator.d.ts

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

package/src/generators/kos-companion-model/generator.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"generator.d.ts","sourceRoot":"","sources":["../../../../../../../packages/plugins/kos-nx-plugin/src/generators/kos-companion-model/generator.ts"],"names":[],"mappings":"AAAA,OAAO,EAKL,IAAI,EACL,MAAM,YAAY,CAAC;AAKpB,OAAO,EAAE,gCAAgC,EAAE,MAAM,UAAU,CAAC;AAE5D,wBAAsB,0BAA0B,CAC9C,IAAI,EAAE,IAAI,EACV,OAAO,EAAE,gCAAgC,iBAyD1C;AAED,eAAe,0BAA0B,CAAC"}

package/src/generators/kos-companion-model/generator.js

@@ -0,0 +1,45 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.kosCompanionModelGenerator = void 0;
+const devkit_1 = require("@nx/devkit");
+const path = require("path");
+const logger_1 = require("../../utils/logger");
+const normalize_value_1 = require("../../utils/normalize-value");
+const project_utils_1 = require("../../utils/project-utils");
+async function kosCompanionModelGenerator(tree, options) {
+    const normalized = (0, normalize_value_1.normalizeAllValues)({
+        companionModelName: options.companionModelName,
+        modelName: options.modelName,
+    });
+    const companionModelChildName = options.companionModelName;
+    logger_1.logger.info(`Companion model child name ${companionModelChildName}`);
+    const companionModelChildProjectName = options.companionModelProject;
+    logger_1.logger.info(`Companion model child project name ${companionModelChildProjectName}`);
+    const companionModelParentName = options.modelName;
+    logger_1.logger.info(`Companion model parent name ${companionModelParentName}`);
+    const companionModelParentProjectName = options.modelProject;
+    const modelProjectName = options.modelProject;
+    const companionChildKosConfig = (0, project_utils_1.getKosProjectConfiguration)(tree, companionModelChildProjectName);
+    const modelProjectConfiguration = await (0, devkit_1.readProjectConfiguration)(tree, companionModelParentProjectName);
+    const companionChildProjectConfig = await (0, devkit_1.readProjectConfiguration)(tree, companionModelChildProjectName);
+    const projectRoot = companionChildProjectConfig.sourceRoot;
+    logger_1.logger.info(`Companion child source root ${projectRoot}`);
+    if (projectRoot) {
+        const pkgJsonPath = modelProjectConfiguration
+            ? path.join(modelProjectConfiguration.root, "package.json")
+            : "";
+        const importPath = pkgJsonPath ? (0, devkit_1.readJson)(tree, pkgJsonPath).name : "";
+        const modelLocation = companionChildKosConfig?.generator?.defaults?.model?.folder || "";
+        const filePath = path.join(projectRoot, modelLocation, normalized.companionModelNameDashCase);
+        logger_1.logger.info(`Overwriting companion model in ${filePath}`);
+        (0, devkit_1.generateFiles)(tree, path.join(__dirname, "files"), filePath, {
+            ...options,
+            ...normalized,
+            importPath,
+        });
+        await (0, devkit_1.formatFiles)(tree);
+    }
+}
+exports.kosCompanionModelGenerator = kosCompanionModelGenerator;
+exports.default = kosCompanionModelGenerator;
+//# sourceMappingURL=generator.js.map

package/src/generators/kos-companion-model/generator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"generator.js","sourceRoot":"","sources":["../../../../../../../packages/plugins/kos-nx-plugin/src/generators/kos-companion-model/generator.ts"],"names":[],"mappings":";;;AAAA,uCAMoB;AACpB,6BAA6B;AAC7B,+CAA4C;AAC5C,iEAAiE;AACjE,6DAAuE;AAGhE,KAAK,UAAU,0BAA0B,CAC9C,IAAU,EACV,OAAyC;IAEzC,MAAM,UAAU,GAAG,IAAA,oCAAkB,EAAC;QACpC,kBAAkB,EAAE,OAAO,CAAC,kBAAkB;QAC9C,SAAS,EAAE,OAAO,CAAC,SAAS;KAC7B,CAAC,CAAC;IAEH,MAAM,uBAAuB,GAAG,OAAO,CAAC,kBAAkB,CAAC;IAC3D,eAAM,CAAC,IAAI,CAAC,8BAA8B,uBAAuB,EAAE,CAAC,CAAC;IACrE,MAAM,8BAA8B,GAAG,OAAO,CAAC,qBAAqB,CAAC;IACrE,eAAM,CAAC,IAAI,CACT,sCAAsC,8BAA8B,EAAE,CACvE,CAAC;IACF,MAAM,wBAAwB,GAAG,OAAO,CAAC,SAAS,CAAC;IAEnD,eAAM,CAAC,IAAI,CAAC,+BAA+B,wBAAwB,EAAE,CAAC,CAAC;IACvE,MAAM,+BAA+B,GAAG,OAAO,CAAC,YAAY,CAAC;IAE7D,MAAM,gBAAgB,GAAG,OAAO,CAAC,YAAY,CAAC;IAE9C,MAAM,uBAAuB,GAAG,IAAA,0CAA0B,EACxD,IAAI,EACJ,8BAA8B,CAC/B,CAAC;IACF,MAAM,yBAAyB,GAAG,MAAM,IAAA,iCAAwB,EAC9D,IAAI,EACJ,+BAA+B,CAChC,CAAC;IAEF,MAAM,2BAA2B,GAAG,MAAM,IAAA,iCAAwB,EAChE,IAAI,EACJ,8BAA8B,CAC/B,CAAC;IAEF,MAAM,WAAW,GAAG,2BAA2B,CAAC,UAAU,CAAC;IAC3D,eAAM,CAAC,IAAI,CAAC,+BAA+B,WAAW,EAAE,CAAC,CAAC;IAC1D,IAAI,WAAW,EAAE,CAAC;QAChB,MAAM,WAAW,GAAG,yBAAyB;YAC3C,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,yBAAyB,CAAC,IAAI,EAAE,cAAc,CAAC;YAC3D,CAAC,CAAC,EAAE,CAAC;QACP,MAAM,UAAU,GAAG,WAAW,CAAC,CAAC,CAAC,IAAA,iBAAQ,EAAC,IAAI,EAAE,WAAW,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC;QACvE,MAAM,aAAa,GACjB,uBAAuB,EAAE,SAAS,EAAE,QAAQ,EAAE,KAAK,EAAE,MAAM,IAAI,EAAE,CAAC;QACpE,MAAM,QAAQ,GAAG,IAAI,CAAC,IAAI,CACxB,WAAW,EACX,aAAa,EACb,UAAU,CAAC,0BAA0B,CACtC,CAAC;QAEF,eAAM,CAAC,IAAI,CAAC,kCAAkC,QAAQ,EAAE,CAAC,CAAC;QAC1D,IAAA,sBAAa,EAAC,IAAI,EAAE,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,OAAO,CAAC,EAAE,QAAQ,EAAE;YAC3D,GAAG,OAAO;YACV,GAAG,UAAU;YACb,UAAU;SACX,CAAC,CAAC;QACH,MAAM,IAAA,oBAAW,EAAC,IAAI,CAAC,CAAC;IAC1B,CAAC;AACH,CAAC;AA3DD,gEA2DC;AAED,kBAAe,0BAA0B,CAAC"}

package/src/generators/kos-companion-model/schema.d.ts

@@ -0,0 +1,6 @@
+export interface KosCompanionModelGeneratorSchema {
+  companionModelName: string;
+  companionModelProject: string;
+  modelName: string;
+  modelProject: string;
+}

package/src/generators/kos-companion-model/schema.json

@@ -0,0 +1,36 @@
+{
+  "$schema": "https://json-schema.org/schema",
+  "$id": "KosCompanionModel",
+  "title": "",
+  "type": "object",
+  "properties": {
+    "companionModelName": {
+      "type": "string",
+      "description": "",
+      "x-prompt": "What is the name of the companion model?"
+    },
+    "companionModelProject": {
+      "type": "string",
+      "description": "The project where the model will be located.",
+      "x-prompt": "Which project will this model be located in?",
+      "x-dropdown": "projects"
+    },
+    "modelName": {
+      "type": "string",
+      "description": "",
+      "x-prompt": "What is the name of the companion model parent?"
+    },
+    "modelProject": {
+      "type": "string",
+      "description": "The project where the model parent will be located.",
+      "x-prompt": "Which project will this model's parent be located in?",
+      "x-dropdown": "projects"
+    }
+  },
+  "required": [
+    "companionModelName",
+    "companionModelProject",
+    "modelName",
+    "modelProject"
+  ]
+}

package/src/generators/kos-component/cui/__nameDashCase__.stories.tsx__template__

@@ -0,0 +1,30 @@
+/**
+ * Note: The plugin project Storybook configuration requires that the Studio
+ * Simulator is running in order to retrieve model data...
+ */
+import { CUIStoryContainer } from "@kosdev-code/kos-ui-plugin/dev";
+import type { Meta, StoryObj } from "@storybook/react";
+import { <%= namePascalCase %> } from "./<%= nameDashCase %>";
+
+const meta: Meta<typeof <%= namePascalCase %>> = {
+  args: {},
+  component: <%= namePascalCase %>,
+  decorators: [
+    (Story, context) => (
+      <CUIStoryContainer>
+        <Story args={{ ...context.args }} />
+      </CUIStoryContainer>
+    ),
+  ],
+  tags: ["!autodocs"],
+  title: "CUI/<%= namePascalCase %>",
+};
+
+export default meta;
+
+type Story = StoryObj<typeof <%= namePascalCase %>>;
+
+export const Default: Story = {
+  render: (props) => <<%= namePascalCase %> {...props} />,
+};
+

package/src/generators/kos-component/cui/__nameDashCase__.tsx__template__

@@ -0,0 +1,35 @@
+import styled from '@emotion/styled';
+import {
+  Button,
+  Footer,
+  type Experience,
+} from '@kosdev-code/kos-ddk-components';
+import {
+  KosLog,
+  kosComponent,
+  useKosTranslation,
+} from '@kosdev-code/kos-ui-sdk';
+
+const log = KosLog.createLogger({name: "<%= nameDashCase %>"})
+log.debug("<%= nameDashCase %> component loaded");
+
+const <%= namePascalCase %>Container = styled.div`
+  align-items: center;
+  display: flex;
+  flex-direction: column;
+  width: 100%;
+`;
+
+export const <%= namePascalCase %>: Experience = kosComponent(({ onComplete }) => {
+  const { t } = useKosTranslation('<%= appProject %>');
+  return (
+    <<%= namePascalCase %>Container onClick={onComplete}>
+      Hello from <%= namePascalCase %> CUI Configuration
+      <Footer>
+        <Button onClick={onComplete}>{t('proceed')}</Button>
+      </Footer>
+    </<%= namePascalCase %>Container>
+  );
+});
+
+export default <%= namePascalCase %>

package/src/generators/kos-component/cui/index.ts__template__

@@ -0,0 +1 @@
+export * from "./<%= nameDashCase %>";

package/src/generators/kos-component/files/__nameDashCase__.css__template__

@@ -0,0 +1,2 @@
+.<%= nameDashCase %> {
+}

package/src/generators/kos-component/files/__nameDashCase__.tsx__template__

@@ -0,0 +1,20 @@
+<% if (useEmotionCss) { %>
+import styled from '@emotion/styled';
+<% } else { %>
+import "./<%= nameDashCase %>.css";
+<% } %>
+import { kosComponent, KosLog } from "@kosdev-code/kos-ui-sdk";
+
+const log = KosLog.createLogger({name: "<%= nameDashCase %>"})
+log.debug("<%= nameDashCase %> component loaded");
+
+<% if (useEmotionCss) { %>
+const <%= namePascalCase %>Container = styled.div``;
+<% } %>
+interface Props {}
+export const <%= namePascalCase %>: React.FunctionComponent<Props> = kosComponent(() => {
+ 
+ return (<% if (useEmotionCss) { %><<%= namePascalCase %>Container><%= nameDashCase %></<%= namePascalCase %>Container><% } else { %><div></div><% } %>);
+});
+
+export default <%= namePascalCase %>

package/src/generators/kos-component/files/index.ts__template__

@@ -0,0 +1 @@
+export * from "./<%= nameDashCase %>";

package/src/generators/kos-component/generator.d.ts

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

package/src/generators/kos-component/generator.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"generator.d.ts","sourceRoot":"","sources":["../../../../../../../packages/plugins/kos-nx-plugin/src/generators/kos-component/generator.ts"],"names":[],"mappings":"AAAA,OAAO,EAIL,IAAI,EAEL,MAAM,YAAY,CAAC;AAIpB,OAAO,EAAE,2BAA2B,EAAE,MAAM,UAAU,CAAC;AAiBvD,wBAAsB,qBAAqB,CACzC,IAAI,EAAE,IAAI,EACV,OAAO,EAAE,2BAA2B,iBAwSrC;AAED,eAAe,qBAAqB,CAAC"}