@mxtommy/kip 4.5.0 → 4.5.1

package/tools/schematics/create-host2-widget/schema.json

@@ -1,89 +0,0 @@
-{
-  "$schema": "http://json-schema.org/draft-07/schema",
-  "$id": "CreateHost2WidgetSchema",
-  "title": "Create Host2 Widget",
-  "type": "object",
-  "properties": {
-    "name": {
-      "type": "string",
-      "description": "Widget machine name without widget- prefix (kebab-case). e.g. tides-chart",
-      "minLength": 3,
-      "x-prompt": "The widget base name is the Angular component machine name (kebab-case, without widget- prefix which will be added automatically). Using base name tides-chart will create a widget-tides-chart component.\nWidget base name:"
-    },
-    "title": {
-      "type": "string",
-      "description": "The widget title is the descriptive title used in the Add Widget dialog",
-      "minLength": 3,
-      "default": "Widget Label",
-      "x-prompt": "The widget title is the descriptive title used in the Add Widget dialog.\nWidget title:"
-    },
-    "registerWidget": {
-      "type": "string",
-      "description": "Register widget and make it available in the widget Add Options dialog",
-      "enum": [
-        "No",
-        "Core",
-        "Gauge",
-        "Component",
-        "Racing"
-      ],
-      "x-prompt": "Register widget and make it available in the widget Add Options dialog (choose category or 'no' to skip):"
-    },
-    "pathType": {
-      "type": "string",
-      "description": "The type of value the Signal K path provides (number|string|boolean|Date)",
-      "enum": [
-        "number",
-        "string",
-        "boolean",
-        "Date"
-      ],
-      "default": "number",
-      "x-prompt": "Path value type (number|string|boolean|Date):"
-    },
-    "pathDefault": {
-      "type": [
-        "string",
-        "null"
-      ],
-      "default": null,
-      "description": "The default Signal K path the widget should use (if any)",
-      "x-prompt": "Type the default Signal K path value for the widget (press enter for no default):"
-    },
-    "zonesSupport": {
-      "type": "boolean",
-      "default": false,
-      "description": "Enable Signal K Zones metadata support.",
-      "x-prompt": "Enable Signal K Zones metadata support?"
-    },
-    "addSpec": {
-      "type": "boolean",
-      "default": true,
-      "description": "Generate widget spec (test) file.",
-      "x-prompt": "Generate widget tests file?"
-    },
-    "todoBlock": {
-      "type": "boolean",
-      "default": true,
-      "description": "Include TODO guidance block in component.",
-      "x-prompt": "Include TODO guidance block in component?"
-    },
-    "readme": {
-      "type": "boolean",
-      "default": true,
-      "description": "Generate developer instruction README file in the widget's folder.",
-      "x-prompt": "Generate developer instruction README file in the widget's folder?"
-    },
-    "debugLogging": {
-      "type": "boolean",
-      "default": false,
-      "description": "Enable verbose debug logging for schematic execution (normalization, prompts, service update)."
-    }
-  },
-  "required": [
-    "name",
-    "title",
-    "registerWidget"
-  ],
-  "additionalProperties": false
-}

package/tools/schematics/create-host2-widget/test/create-host2-widget.spec.ts

@@ -1,70 +0,0 @@
-import { SchematicTestRunner, UnitTestTree } from '@angular-devkit/schematics/testing';
-import { Tree } from '@angular-devkit/schematics';
-import * as path from 'path';
-
-// Path to collection.json
-const collectionPath = path.join(__dirname, '..', 'collection.json').replace(/test\/[.][.]/, '..');
-
-describe('create-host2-widget schematic', () => {
-  const runner = new SchematicTestRunner('kip-schematics', collectionPath);
-  let appTree: UnitTestTree;
-
-  beforeEach(() => {
-    // Minimal host tree with widget.service.ts skeleton to exercise mutations
-  appTree = new UnitTestTree(Tree.empty());
-    appTree.create('src/app/core/services/widget.service.ts', `import { Type } from '@angular/core';\nexport interface WidgetDescription { selector: string; componentClassName: string; category: string; name: string; description: string; icon: string; minWidth: number; minHeight: number; defaultWidth: number; defaultHeight: number; requiredPlugins: string[]; }\nexport class WidgetService {\n  // eslint-disable-next-line @typescript-eslint/no-explicit-any\n  private readonly _componentTypeMap: Record<string, Type<any>> = {\n  };\n  private readonly _widgetDefinition: readonly WidgetDescription[] = [\n  ];\n}`);
-  });
-
-  // eslint-disable-next-line @typescript-eslint/no-explicit-any
-  function run(options: Record<string, any>) {
-    return runner.runSchematic('create-host2-widget', {
-      name: 'alpha', title: 'Alpha', registerWidget: 'Core',
-      pathType: 'number', pathDefault: null, ignoreZones: false,
-      addSpec: false, todoBlock: false, readme: false,
-      ...options
-    }, appTree);
-  }
-
-  it('generates widget files', async () => {
-    const tree = await run({});
-    expect(tree.exists('src/app/widgets/widget-alpha/widget-alpha.component.ts')).toBeTrue();
-  });
-
-  it('updates service: import, map, definition', async () => {
-    const tree = await run({});
-    const service = tree.read('src/app/core/services/widget.service.ts')!.toString('utf-8');
-    expect(service).toContain("import { WidgetAlphaComponent } from '../../widgets/widget-alpha/widget-alpha.component'");
-    expect(service).toMatch(/_componentTypeMap[\s\S]*WidgetAlphaComponent: WidgetAlphaComponent/);
-    expect(service).toMatch(/selector: 'widget-alpha'/);
-  });
-
-  it('inserts second widget in same category after first', async () => {
-    let tree = await run({});
-    appTree = tree; // carry over
-    tree = await run({ name: 'beta', title: 'Beta' });
-    const service = tree.read('src/app/core/services/widget.service.ts')!.toString('utf-8');
-    const alphaIdx = service.indexOf("selector: 'widget-alpha'");
-    const betaIdx = service.indexOf("selector: 'widget-beta'");
-    expect(alphaIdx).toBeGreaterThan(-1);
-    expect(betaIdx).toBeGreaterThan(-1);
-    expect(betaIdx).toBeGreaterThan(alphaIdx); // inserted after
-  });
-
-  it('is idempotent (running with same name does not duplicate)', async () => {
-    let tree = await run({});
-    appTree = tree;
-    tree = await run({});
-    const service = tree.read('src/app/core/services/widget.service.ts')!.toString('utf-8');
-    const occurrences = (service.match(/selector: 'widget-alpha'/g) || []).length;
-    expect(occurrences).toBe(1);
-  });
-
-  it('skips registration when registerWidget = no', async () => {
-    const tree = await run({ name: 'gamma', title: 'Gamma', registerWidget: 'no' });
-    const service = tree.read('src/app/core/services/widget.service.ts')!.toString('utf-8');
-    expect(service).not.toContain('WidgetGammaComponent');
-    expect(service).not.toContain("selector: 'widget-gamma'");
-    // component file still generated
-    expect(tree.exists('src/app/widgets/widget-gamma/widget-gamma.component.ts')).toBeTrue();
-  });
-});

package/tools/schematics/create-host2-widget/utils/formatting.js

@@ -1,119 +0,0 @@
-// JavaScript utility helpers for widget.service.ts mutation formatting & insertion logic
-// Converted from TypeScript version.
-
-function escapeSingle(str) {
-  return str.replace(/'/g, "\\'");
-}
-
-function buildWidgetDefinitionObject(selector, className, opts) {
-  return `{
-    name: '${opts.title}',
-    description: '${escapeSingle(opts.description)}',
-    icon: '${opts.icon}', // TODO replace placeholder icon
-    minWidth: ${opts.minWidth},
-    minHeight: ${opts.minHeight},
-    defaultWidth: ${opts.defaultWidth},
-    defaultHeight: ${opts.defaultHeight},
-    category: '${opts.category}',
-    requiredPlugins: [],
-    selector: '${selector}',
-    componentClassName: '${className}'
-  },`;
-}
-
-function appendImport(src, importStatement) {
-  if (src.includes(importStatement)) return src;
-  const importBlockRegex = /^(?:import[^;]+;\s*)+/m;
-  if (importBlockRegex.test(src)) {
-    return src.replace(importBlockRegex, (block) => {
-      const normalized = block.replace(/\n*$/, '');
-      return normalized + '\n' + importStatement + '\n\n';
-    });
-  }
-  return importStatement + '\n\n' + src;
-}
-
-function updateComponentMap(src, className) {
-  const mapPattern = /_componentTypeMap: Record<string, Type<any>> = {([\s\S]*?)};/m;
-  return src.replace(mapPattern, (m, inner) => {
-    if (inner.includes(className + ':')) return m;
-    const lines = inner.split(/\n/);
-    while (lines.length && lines[lines.length - 1].trim() === '') lines.pop();
-    for (let i = lines.length - 1; i >= 0; i--) {
-      const trimmed = lines[i].trim();
-      if (!trimmed) continue;
-      if (!trimmed.includes(':')) break;
-      if (!trimmed.endsWith(',')) lines[i] = lines[i] + ',';
-      break;
-    }
-    lines.push(`    ${className}: ${className}`);
-    // Replace inner content, then normalize closing brace indentation to two spaces
-    let replaced = m.replace(inner, lines.join('\n') + '\n');
-    replaced = replaced.replace(/\n *};/, '\n  };');
-    return replaced;
-  });
-}
-
-function normalizeDefinitionFormatting(content, baseIndent) {
-  let rebuilt = content;
-  // Remove any blank line(s) between objects: ensure pattern `},\n{` with exactly one newline
-  rebuilt = rebuilt.replace(/},\n\n+(\s*{)/g, '},\n$1');
-  // Remove blank line before closing array
-  rebuilt = rebuilt.replace(/,\n\n(\s*])/g, ',\n$1');
-  // Remove stray duplicate blank lines inside objects
-  rebuilt = rebuilt.replace(/({\n)([ \t]*\n)+/g, '$1');
-  rebuilt = rebuilt.replace(/\n\s*\n(\s+\w+:)/g, '\n$1');
-  // Normalize opening brace indentation
-  rebuilt = rebuilt.replace(/^(\s*){(?=\n)/gm, baseIndent + '{');
-  // Collapse any 2+ blank lines to single newline
-  rebuilt = rebuilt.replace(/\n{2,}/g, '\n');
-  // Remove any trailing blank lines; do NOT force an extra newline because the array pattern supplies one before the closing ];
-  return rebuilt.replace(/\n\s*$/,'');
-}
-
-function insertDefinitionObject(src, selector, className, opts) {
-  const defArrayPattern = /private readonly _widgetDefinition: readonly WidgetDescription\[] = \[(\s*[\s\S]*?)\n\s*];/m;
-  return src.replace(defArrayPattern, (m, inner) => {
-    if (inner.includes(`selector: '${selector}'`)) return m;
-    let defObj = buildWidgetDefinitionObject(selector, className, opts).trim();
-    defObj = defObj.startsWith('{') ? defObj : '{' + defObj;
-    defObj = defObj.replace(/\n{2,}/g, '\n');
-    const linesDef = defObj.split(/\n/).map(l => l.trimEnd());
-    const openIdx = 0; const closeIdx = linesDef.length - 1;
-    const indentMatch = inner.match(/^(\s*){/m);
-    const baseIndent = indentMatch ? indentMatch[1] : '    ';
-    const firstLine = baseIndent + '{';
-    const lastLine = baseIndent + linesDef[closeIdx].trim();
-    const middle = linesDef.slice(openIdx + 1, closeIdx).filter(l => l.trim().length > 0).map(l => baseIndent + '  ' + l.trim());
-    defObj = [firstLine, ...middle, lastLine].join('\n');
-    const objectRegex = /{[\s\S]*?},\n?/g;
-    const objects = inner.match(objectRegex) || [];
-    if (objects.length === 0) {
-      return m.replace(inner, defObj + '\n');
-    }
-    const metas = objects.map(o => ({ text: o, category: (o.match(/category: '([^']+)'/) || [])[1] }));
-    let insertAfter = -1;
-    for (let i = 0; i < metas.length; i++) {
-      if (metas[i].category === opts.category) insertAfter = i;
-    }
-    const formattedNew = defObj + '\n';
-    let rebuilt = '';
-    metas.forEach((meta, idx) => {
-      const normalized = meta.text.endsWith('\n') ? meta.text : meta.text + '\n';
-      rebuilt += normalized;
-      if (idx === insertAfter) rebuilt += formattedNew; // inserted immediately, no extra blank line expected
-    });
-    if (insertAfter === -1) rebuilt += formattedNew; // appended at end
-    rebuilt = normalizeDefinitionFormatting(rebuilt, baseIndent);
-    return m.replace(inner, rebuilt);
-  });
-}
-
-module.exports = {
-  escapeSingle,
-  buildWidgetDefinitionObject,
-  appendImport,
-  updateComponentMap,
-  insertDefinitionObject,
-  normalizeDefinitionFormatting
-};