@kinotic-ai/kinotic-cli 2.2.0 → 3.0.0

package/dist/internal/spawn/InquirerPropertyResolver.js

@@ -0,0 +1,30 @@
+import { confirm, input, number, select } from '@inquirer/prompts';
+/**
+ * Prompts the user on the terminal for spawn properties missing from the
+ * render context, choosing the prompt type from the property's schema.
+ */
+export class InquirerPropertyResolver {
+    hasPrompted = false;
+    async resolve(key, schema, message, defaultValue) {
+        if (!this.hasPrompted) {
+            console.log('Please provide the following...\n');
+            this.hasPrompted = true;
+        }
+        if (schema.type === 'boolean') {
+            return confirm({ message, default: typeof defaultValue === 'boolean' ? defaultValue : undefined });
+        }
+        else if (schema.enum) {
+            return select({
+                message,
+                choices: schema.enum.map((v) => ({ value: v })),
+                default: defaultValue !== undefined ? String(defaultValue) : undefined
+            });
+        }
+        else if (schema.type === 'number' || schema.type === 'integer') {
+            return number({ message, default: typeof defaultValue === 'number' ? defaultValue : undefined });
+        }
+        else {
+            return input({ message, default: typeof defaultValue === 'string' ? defaultValue : undefined });
+        }
+    }
+}

package/dist/templates/entity/BaseRepository.liquid

@@ -19,7 +19,7 @@ export class Base{{ entityName }}Repository extends EntityRepository<{{ entityNa
     this.shouldValidate = shouldValidate
   }
 
-  protected async beforeSaveOrUpdate(entity: {{ entityName }}): Promise<{{ entityName }}> {
+  protected override async beforeSaveOrUpdate(entity: {{ entityName }}): Promise<{{ entityName }}> {
     if (this.shouldValidate) {
       return this.validate(entity)
     } else {
@@ -27,7 +27,7 @@ export class Base{{ entityName }}Repository extends EntityRepository<{{ entityNa
     }
   }
 
-  protected async beforeBulkSaveOrUpdate(entities: {{ entityName }}[]): Promise<{{ entityName }}[]> {
+  protected override async beforeBulkSaveOrUpdate(entities: {{ entityName }}[]): Promise<{{ entityName }}[]> {
     if (this.shouldValidate) {
       const validatedEntities: {{ entityName }}[] = []
       for (let entity of entities) {

package/dist/templates/spawns/project/package.json.liquid

@@ -12,8 +12,8 @@
         "typescript": "^5.9.3"
     },
     "catalog": {
-        "@kinotic-ai/core": "{{ kinoticApiVersion }}",
-        "@kinotic-ai/persistence": "{{ kinoticApiVersion }}"
+        "@kinotic-ai/core": "{{ kinoticCoreVersion }}",
+        "@kinotic-ai/persistence": "{{ kinoticPersistenceVersion }}"
     },
     "workspaces": [
         "packages/*"

package/dist/templates/spawns/project/spawn.json

@@ -1,11 +1,20 @@
 {
     "globals": {
-        "kinoticApiVersion": "^1.0.9"
+        "kinoticCoreVersion": "^1.9.1",
+        "kinoticPersistenceVersion": "^2.0.0"
     },
     "propertySchema":{
         "projectName": {
             "type": "string",
             "description": "The name of the project you want to create"
+        },
+        "organization": {
+            "type": "string",
+            "description": "The organization that owns the project"
+        },
+        "application": {
+            "type": "string",
+            "description": "The application the project belongs to"
         }
     }
 }

package/package.json

@@ -1,56 +1,50 @@
 {
   "name": "@kinotic-ai/kinotic-cli",
-  "version": "2.2.0",
+  "version": "3.0.0",
   "description": "Kinotic CLI provides the ability to build, deploy, and manage Kinotic applications that run on the Kinotic OS.",
   "author": "Kinotic Developers",
   "bin": {
     "kinotic": "./bin/run.js"
   },
   "homepage": "https://kinotic-ai",
-  "repository": "https://github.com/kinotic-ai/kinotic",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/kinotic-ai/kinotic"
+  },
   "license": "Elastic License 2.0\"",
   "main": "dist/index.js",
   "type": "module",
   "files": [
     "/bin",
     "/dist",
-    "/npm-shrinkwrap.json",
-    "/oclif.manifest.json"
+    "/npm-shrinkwrap.json"
   ],
   "dependencies": {
     "@inquirer/prompts": "^8.3.2",
-    "@kinotic-ai/core": "^1.1.1",
+    "@kinotic-ai/core": "^3.1.0",
     "@kinotic-ai/idl": "^1.0.9",
-    "@kinotic-ai/os-api": "^1.1.0",
-    "@kinotic-ai/persistence": "^1.2.0",
+    "@kinotic-ai/os-api": "^3.1.0",
+    "@kinotic-ai/persistence": "^3.1.0",
+    "@kinotic-ai/spawn": "^0.5.0",
     "@oclif/core": "^4.9.0",
-    "@oclif/plugin-autocomplete": "^3.2.41",
-    "@oclif/plugin-help": "^6",
-    "@oclif/plugin-not-found": "^3.2.75",
-    "@oclif/plugin-plugins": "^5.4.58",
-    "@oclif/plugin-update": "^4.7.23",
-    "@oclif/plugin-warn-if-update-available": "^3.1.55",
     "c12": "^3.3.3",
     "chalk": "^5.6.2",
     "execa": "^9.6.1",
     "glob": "^13.0.6",
     "graphql": "^16.13.1",
-    "liquidjs": "10.25.1",
+    "liquidjs": "10.27.0",
     "open": "^11.0.0",
     "ora": "^9.3.0",
     "p-timeout": "^7.0.1",
     "radash": "^12.1.1",
-    "reflect-metadata": "^0.2.2",
-    "simple-git": "^3.33.0",
+    "simple-git": "3.36.0",
     "terminal-link": "^5.0.0",
     "ts-morph": "^27.0.2",
     "uuid": "^13.0.0",
     "ws": "^8.19.0",
-    "yaml": "2.8.3",
-    "zod": "^4.3.6"
+    "yaml": "2.8.3"
   },
   "devDependencies": {
-    "@oclif/test": "^4.1.16",
     "@types/chai": "^5",
     "@types/inquirer": "^9.0.9",
     "@types/mocha": "^10.0.10",
@@ -59,48 +53,39 @@
     "@types/ws": "^8.18.1",
     "chai": "^6",
     "eslint": "^9",
-    "eslint-config-oclif": "^6",
     "eslint-config-prettier": "^10",
     "mocha": "^11",
-    "oclif": "^4.22.92",
     "shx": "^0.4.0",
+    "tsc-alias": "^1.8.16",
     "tslib": "^2.8.1",
     "tsx": "^4.21.0",
-    "tsc-alias": "^1.8.16",
     "typescript": "^5.9.3"
   },
   "oclif": {
     "bin": "kinotic",
     "dirname": "kinotic",
     "commands": "./dist/commands",
-    "plugins": [
-      "@oclif/plugin-help",
-      "@oclif/plugin-plugins",
-      "@oclif/plugin-update",
-      "@oclif/plugin-not-found",
-      "@oclif/plugin-warn-if-update-available",
-      "@oclif/plugin-autocomplete"
-    ],
     "topicSeparator": " ",
     "topics": {
       "create": {
         "description": "Creates Kinotic projects, libraries, and applications"
+      },
+      "spawn": {
+        "description": "Works with Kinotic spawn templates"
       }
     }
   },
   "engines": {
     "node": ">=18.0.0"
   },
-  "keywords": [
-    "oclif"
-  ],
+  "keywords": [],
   "types": "dist/index.d.ts",
   "scripts": {
     "build": "shx rm -rf dist && tsc -b && tsc-alias -f && pnpm run copy-files",
     "lint": "eslint . --ext .ts --config .eslintrc",
     "posttest": "pnpm lint",
     "test": "mocha --forbid-only \"test/**/*.test.ts\"",
-    "version": "oclif readme && git add README.md",
+    "version": "git add README.md",
     "copy-files": "cp -r ./src/templates/  ./dist/templates/"
   }
 }

package/bin/dev.cmd

@@ -1,3 +0,0 @@
-@echo off
-
-node "%~dp0\dev" %*

package/bin/dev.js

@@ -1,6 +0,0 @@
-#!/usr/bin/env tsx
-// eslint-disable-next-line node/shebang
-(async () => {
-  const oclif = await import('@oclif/core')
-  await oclif.execute({type: 'esm', development: true, dir: import.meta.url})
-})()

package/bin/run.cmd

@@ -1,3 +0,0 @@
-@echo off
-
-node "%~dp0\run" %*

package/bin/run.js

@@ -1,6 +0,0 @@
-#!/usr/bin/env node
-// eslint-disable-next-line node/shebang
-(async () => {
-  const oclif = await import('@oclif/core')
-  await oclif.execute({type: 'esm', dir: import.meta.url})
-})()

package/dist/internal/spawn/SpawnConfig.d.ts

@@ -1,31 +0,0 @@
-import { z } from 'zod';
-export declare const PropertySchemaSchema: z.ZodObject<{
-    type: z.ZodOptional<z.ZodEnum<{
-        string: "string";
-        number: "number";
-        boolean: "boolean";
-        integer: "integer";
-    }>>;
-    description: z.ZodOptional<z.ZodString>;
-    default: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodBoolean]>>;
-    enum: z.ZodOptional<z.ZodArray<z.ZodString>>;
-}, z.core.$strip>;
-export declare const SpawnConfigSchema: z.ZodObject<{
-    inherits: z.ZodOptional<z.ZodString>;
-    globals: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
-    propertySchema: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodObject<{
-        type: z.ZodOptional<z.ZodEnum<{
-            string: "string";
-            number: "number";
-            boolean: "boolean";
-            integer: "integer";
-        }>>;
-        description: z.ZodOptional<z.ZodString>;
-        default: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodBoolean]>>;
-        enum: z.ZodOptional<z.ZodArray<z.ZodString>>;
-    }, z.core.$strip>>>;
-}, z.core.$strip>;
-export type PropertySchema = z.infer<typeof PropertySchemaSchema>;
-export type SpawnConfig = z.infer<typeof SpawnConfigSchema>;
-export type GlobalsType = Record<string, unknown>;
-export type PropertySchemaType = Record<string, PropertySchema>;

package/dist/internal/spawn/SpawnConfig.js

@@ -1,12 +0,0 @@
-import { z } from 'zod';
-export const PropertySchemaSchema = z.object({
-    type: z.enum(['string', 'number', 'integer', 'boolean']).optional(),
-    description: z.string().optional(),
-    default: z.union([z.string(), z.number(), z.boolean()]).optional(),
-    enum: z.array(z.string()).optional(),
-});
-export const SpawnConfigSchema = z.object({
-    inherits: z.string().optional(),
-    globals: z.record(z.string(), z.unknown()).optional(),
-    propertySchema: z.record(z.string(), PropertySchemaSchema).optional(),
-});

package/dist/internal/spawn/SpawnEngine.d.ts

@@ -1,27 +0,0 @@
-import { SpawnResolver } from './SpawnResolver.js';
-export default class SpawnEngine {
-    private engine;
-    private spawnResolver;
-    constructor(resolver: SpawnResolver);
-    /**
-     * Renders the specified Spawn
-     * A Spawn is a directory that contains templates, an optional spawn.json file, and template parameters in folder and filenames
-     *
-     * This is done by performing the following
-     *
-     * - Will recursively walk the spawn copying any files or directories encountered
-     * -- If a template file is encountered, it will be parsed and rendered prior to copying
-     *
-     * @param spawn the name of the spawn to parse and render. This is the name of the directory containing the spawn.json
-     * @param destination the target directory where rendered data will be sent
-     * @param context the values to be provided to the templates while rendering
-     * @return a promise containing all the original values plus any added during rendering
-     */
-    renderSpawn(spawn: string, destination: string, context?: Record<string, unknown>): Promise<Record<string, unknown> | undefined>;
-    private promptForMissingProperties;
-    private _renderFile;
-    private _renderDirectory;
-    private logDebug;
-    private shouldIgnore;
-}
-export declare const spawnEngine: SpawnEngine;

package/dist/internal/spawn/SpawnEngine.js

@@ -1,187 +0,0 @@
-import fs from 'node:fs';
-import fsP from 'node:fs/promises';
-import path from 'node:path';
-import { Liquid } from 'liquidjs';
-import { confirm, input, number, select } from '@inquirer/prompts';
-import { SpawnConfigSchema } from './SpawnConfig.js';
-import { spawnResolver } from './SpawnResolver.js';
-function upperFirst(s) {
-    return s.charAt(0).toUpperCase() + s.slice(1);
-}
-function camelCase(s) {
-    return s
-        .replace(/[-_\s]+(.)/g, (_, c) => c.toUpperCase())
-        .replace(/^(.)/, (_, c) => c.toLowerCase());
-}
-export default class SpawnEngine {
-    engine;
-    spawnResolver;
-    constructor(resolver) {
-        this.spawnResolver = resolver;
-        this.engine = new Liquid({ cache: true });
-        this.engine.registerFilter('packageToPath', (v) => v.replaceAll('.', '/'));
-        this.engine.registerFilter('encodePackage', (v) => {
-            v = v.replaceAll('-', '_');
-            v = v.replace(/\.(\d+)/g, '._$1');
-            return v;
-        });
-        this.engine.registerFilter('camelCase', (v) => camelCase(v));
-        this.engine.registerFilter('upperFirst', (v) => upperFirst(v));
-    }
-    /**
-     * Renders the specified Spawn
-     * A Spawn is a directory that contains templates, an optional spawn.json file, and template parameters in folder and filenames
-     *
-     * This is done by performing the following
-     *
-     * - Will recursively walk the spawn copying any files or directories encountered
-     * -- If a template file is encountered, it will be parsed and rendered prior to copying
-     *
-     * @param spawn the name of the spawn to parse and render. This is the name of the directory containing the spawn.json
-     * @param destination the target directory where rendered data will be sent
-     * @param context the values to be provided to the templates while rendering
-     * @return a promise containing all the original values plus any added during rendering
-     */
-    async renderSpawn(spawn, destination, context) {
-        let contextInternal;
-        if (!fs.existsSync(destination)) {
-            const source = await this.spawnResolver.resolveSpawn(spawn);
-            const sources = [source];
-            const currentConfigPath = path.resolve(source, 'spawn.json');
-            if (fs.existsSync(currentConfigPath)) {
-                const spawns = [];
-                let currentConfig = currentConfigPath;
-                let currentSpawn = SpawnConfigSchema.parse(JSON.parse(fs.readFileSync(currentConfig, { encoding: 'utf8' })));
-                spawns.push(currentSpawn);
-                // follow inheritance and build stack
-                while (currentSpawn.inherits) {
-                    const inheritDir = path.resolve(path.dirname(currentConfig), currentSpawn.inherits);
-                    currentConfig = path.resolve(inheritDir, 'spawn.json');
-                    this.logDebug(`Inheriting from ${currentConfig}\n`);
-                    if (!fs.existsSync(currentConfig)) {
-                        throw new Error(`Inherited spawn ${currentConfig} does not exist`);
-                    }
-                    currentSpawn = SpawnConfigSchema.parse(JSON.parse(fs.readFileSync(currentConfig, { encoding: 'utf8' })));
-                    spawns.push(currentSpawn);
-                    sources.push(inheritDir);
-                }
-                let globals = {};
-                let propertySchemas = {};
-                for (const spawnConfig of spawns.reverse()) {
-                    if (spawnConfig.globals) {
-                        globals = { ...globals, ...spawnConfig.globals };
-                    }
-                    if (spawnConfig.propertySchema) {
-                        propertySchemas = { ...propertySchemas, ...spawnConfig.propertySchema };
-                    }
-                }
-                contextInternal = { ...globals, ...context };
-                contextInternal = await this.promptForMissingProperties(propertySchemas, contextInternal);
-            }
-            await fsP.mkdir(destination, { recursive: true });
-            for (const src of sources.reverse()) {
-                await this._renderDirectory(src, src, destination, contextInternal);
-            }
-            return contextInternal;
-        }
-        else {
-            throw new Error(`The target directory ${destination} already exists`);
-        }
-    }
-    async promptForMissingProperties(propertySchema, context) {
-        const ret = context ? { ...context } : {};
-        let hasPrompted = false;
-        for (const key in propertySchema) {
-            if (!Object.prototype.hasOwnProperty.call(ret, key)) {
-                if (!hasPrompted) {
-                    console.log('Please provide the following...\n');
-                    hasPrompted = true;
-                }
-                const schema = propertySchema[key];
-                let message;
-                if (schema.description?.includes('{{')) {
-                    message = this.engine.parseAndRenderSync(schema.description, ret);
-                }
-                else {
-                    message = schema.description ?? key;
-                }
-                let defaultValue;
-                if (typeof schema.default === 'string' && schema.default.includes('{{')) {
-                    defaultValue = this.engine.parseAndRenderSync(schema.default, ret);
-                }
-                else {
-                    defaultValue = schema.default;
-                }
-                if (schema.type === 'boolean') {
-                    ret[key] = await confirm({ message, default: typeof defaultValue === 'boolean' ? defaultValue : undefined });
-                }
-                else if (schema.enum) {
-                    ret[key] = await select({
-                        message,
-                        choices: schema.enum.map((v) => ({ value: v })),
-                        default: defaultValue !== undefined ? String(defaultValue) : undefined
-                    });
-                }
-                else if (schema.type === 'number' || schema.type === 'integer') {
-                    ret[key] = await number({ message, default: typeof defaultValue === 'number' ? defaultValue : undefined });
-                }
-                else {
-                    ret[key] = await input({ message, default: typeof defaultValue === 'string' ? defaultValue : undefined });
-                }
-            }
-        }
-        return ret;
-    }
-    async _renderFile(source, destination, errorIfExists, context) {
-        if (destination.includes('{{')) {
-            destination = await this.engine.parseAndRender(destination, context ?? {});
-        }
-        let overwritingFile = false;
-        if ((errorIfExists) && fs.existsSync(destination)) {
-            if (errorIfExists) {
-                throw new Error(`The target file ${destination} already exists`);
-            }
-            overwritingFile = true;
-        }
-        let readStream;
-        if (destination.endsWith('.liquid')) {
-            destination = destination.substring(0, destination.length - 7);
-            readStream = await this.engine.renderFileToNodeStream(source, context ?? {});
-        }
-        else {
-            readStream = fs.createReadStream(source);
-        }
-        this.logDebug(`${overwritingFile ? 'Overwriting' : 'Writing'} File\n${source}\nto\n${destination}\n`);
-        await fsP.mkdir(path.dirname(destination), { recursive: true });
-        const writeStream = fs.createWriteStream(destination);
-        readStream.pipe(writeStream);
-    }
-    async _renderDirectory(baseFrom, from, baseTo, context) {
-        const files = await fsP.readdir(from, { withFileTypes: true });
-        for (const file of files) {
-            const filePath = path.resolve(from, file.name);
-            const to = filePath.replace(baseFrom, baseTo);
-            if (file.isFile()) {
-                if (!this.shouldIgnore(file.name)) {
-                    await this._renderFile(filePath, to, false, context);
-                }
-                else {
-                    this.logDebug(`Skipping File\n${filePath}\n`);
-                }
-            }
-            else {
-                await this._renderDirectory(baseFrom, filePath, baseTo, context);
-            }
-        }
-    }
-    logDebug(message) {
-        if (process.env.DEBUG) {
-            console.debug(message);
-        }
-    }
-    shouldIgnore(fileName) {
-        const filesToSkip = ['.DS_Store', 'spawn.json'];
-        return filesToSkip.includes(fileName);
-    }
-}
-export const spawnEngine = new SpawnEngine(spawnResolver);