@kinotic-ai/kinotic-cli 2.2.0 → 2.3.0

package/README.md

@@ -1,4 +1,4 @@
-Structures CLI
+Kinotic CLI
 =================
 
 <!-- toc -->
@@ -21,57 +21,13 @@ USAGE
 <!-- usagestop -->
 # Commands
 <!-- commands -->
-* [`kinotic autocomplete [SHELL]`](#kinotic-autocomplete-shell)
 * [`kinotic create project NAME`](#kinotic-create-project-name)
 * [`kinotic gen`](#kinotic-gen)
 * [`kinotic generate`](#kinotic-generate)
-* [`kinotic help [COMMAND]`](#kinotic-help-command)
 * [`kinotic init`](#kinotic-init)
 * [`kinotic initialize`](#kinotic-initialize)
-* [`kinotic plugins`](#kinotic-plugins)
-* [`kinotic plugins add PLUGIN`](#kinotic-plugins-add-plugin)
-* [`kinotic plugins:inspect PLUGIN...`](#kinotic-pluginsinspect-plugin)
-* [`kinotic plugins install PLUGIN`](#kinotic-plugins-install-plugin)
-* [`kinotic plugins link PATH`](#kinotic-plugins-link-path)
-* [`kinotic plugins remove [PLUGIN]`](#kinotic-plugins-remove-plugin)
-* [`kinotic plugins reset`](#kinotic-plugins-reset)
-* [`kinotic plugins uninstall [PLUGIN]`](#kinotic-plugins-uninstall-plugin)
-* [`kinotic plugins unlink [PLUGIN]`](#kinotic-plugins-unlink-plugin)
-* [`kinotic plugins update`](#kinotic-plugins-update)
 * [`kinotic sync`](#kinotic-sync)
 * [`kinotic synchronize`](#kinotic-synchronize)
-* [`kinotic update [CHANNEL]`](#kinotic-update-channel)
-
-## `kinotic autocomplete [SHELL]`
-
-Display autocomplete installation instructions.
-
-```
-USAGE
-  $ kinotic autocomplete [SHELL] [-r]
-
-ARGUMENTS
-  [SHELL]  (zsh|bash|powershell) Shell type
-
-FLAGS
-  -r, --refresh-cache  Refresh cache (ignores displaying instructions)
-
-DESCRIPTION
-  Display autocomplete installation instructions.
-
-EXAMPLES
-  $ kinotic autocomplete
-
-  $ kinotic autocomplete bash
-
-  $ kinotic autocomplete zsh
-
-  $ kinotic autocomplete powershell
-
-  $ kinotic autocomplete --refresh-cache
-```
-
-_See code: [@oclif/plugin-autocomplete](https://github.com/oclif/plugin-autocomplete/blob/v3.2.41/src/commands/autocomplete/index.ts)_
 
 ## `kinotic create project NAME`
 
@@ -151,26 +107,6 @@ EXAMPLES
 
 _See code: [src/commands/generate.ts](https://github.com/kinotic-ai/kinotic/blob/v2.2.0/src/commands/generate.ts)_
 
-## `kinotic help [COMMAND]`
-
-Display help for kinotic.
-
-```
-USAGE
-  $ kinotic help [COMMAND...] [-n]
-
-ARGUMENTS
-  [COMMAND...]  Command to show help for.
-
-FLAGS
-  -n, --nested-commands  Include all nested commands in the output.
-
-DESCRIPTION
-  Display help for kinotic.
-```
-
-_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/6.2.38/src/commands/help.ts)_
-
 ## `kinotic init`
 
 This will initialize a new Kinotic Project for use with the Kinotic CLI.
@@ -233,296 +169,6 @@ EXAMPLES
 
 _See code: [src/commands/initialize.ts](https://github.com/kinotic-ai/kinotic/blob/v2.2.0/src/commands/initialize.ts)_
 
-## `kinotic plugins`
-
-List installed plugins.
-
-```
-USAGE
-  $ kinotic plugins [--json] [--core]
-
-FLAGS
-  --core  Show core plugins.
-
-GLOBAL FLAGS
-  --json  Format output as json.
-
-DESCRIPTION
-  List installed plugins.
-
-EXAMPLES
-  $ kinotic plugins
-```
-
-_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/5.4.58/src/commands/plugins/index.ts)_
-
-## `kinotic plugins add PLUGIN`
-
-Installs a plugin into kinotic.
-
-```
-USAGE
-  $ kinotic plugins add PLUGIN... [--json] [-f] [-h] [-s | -v]
-
-ARGUMENTS
-  PLUGIN...  Plugin to install.
-
-FLAGS
-  -f, --force    Force npm to fetch remote resources even if a local copy exists on disk.
-  -h, --help     Show CLI help.
-  -s, --silent   Silences npm output.
-  -v, --verbose  Show verbose npm output.
-
-GLOBAL FLAGS
-  --json  Format output as json.
-
-DESCRIPTION
-  Installs a plugin into kinotic.
-
-  Uses npm to install plugins.
-
-  Installation of a user-installed plugin will override a core plugin.
-
-  Use the KINOTIC_NPM_LOG_LEVEL environment variable to set the npm loglevel.
-  Use the KINOTIC_NPM_REGISTRY environment variable to set the npm registry.
-
-ALIASES
-  $ kinotic plugins add
-
-EXAMPLES
-  Install a plugin from npm registry.
-
-    $ kinotic plugins add myplugin
-
-  Install a plugin from a github url.
-
-    $ kinotic plugins add https://github.com/someuser/someplugin
-
-  Install a plugin from a github slug.
-
-    $ kinotic plugins add someuser/someplugin
-```
-
-## `kinotic plugins:inspect PLUGIN...`
-
-Displays installation properties of a plugin.
-
-```
-USAGE
-  $ kinotic plugins inspect PLUGIN...
-
-ARGUMENTS
-  PLUGIN...  [default: .] Plugin to inspect.
-
-FLAGS
-  -h, --help     Show CLI help.
-  -v, --verbose
-
-GLOBAL FLAGS
-  --json  Format output as json.
-
-DESCRIPTION
-  Displays installation properties of a plugin.
-
-EXAMPLES
-  $ kinotic plugins inspect myplugin
-```
-
-_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/5.4.58/src/commands/plugins/inspect.ts)_
-
-## `kinotic plugins install PLUGIN`
-
-Installs a plugin into kinotic.
-
-```
-USAGE
-  $ kinotic plugins install PLUGIN... [--json] [-f] [-h] [-s | -v]
-
-ARGUMENTS
-  PLUGIN...  Plugin to install.
-
-FLAGS
-  -f, --force    Force npm to fetch remote resources even if a local copy exists on disk.
-  -h, --help     Show CLI help.
-  -s, --silent   Silences npm output.
-  -v, --verbose  Show verbose npm output.
-
-GLOBAL FLAGS
-  --json  Format output as json.
-
-DESCRIPTION
-  Installs a plugin into kinotic.
-
-  Uses npm to install plugins.
-
-  Installation of a user-installed plugin will override a core plugin.
-
-  Use the KINOTIC_NPM_LOG_LEVEL environment variable to set the npm loglevel.
-  Use the KINOTIC_NPM_REGISTRY environment variable to set the npm registry.
-
-ALIASES
-  $ kinotic plugins add
-
-EXAMPLES
-  Install a plugin from npm registry.
-
-    $ kinotic plugins install myplugin
-
-  Install a plugin from a github url.
-
-    $ kinotic plugins install https://github.com/someuser/someplugin
-
-  Install a plugin from a github slug.
-
-    $ kinotic plugins install someuser/someplugin
-```
-
-_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/5.4.58/src/commands/plugins/install.ts)_
-
-## `kinotic plugins link PATH`
-
-Links a plugin into the CLI for development.
-
-```
-USAGE
-  $ kinotic plugins link PATH [-h] [--install] [-v]
-
-ARGUMENTS
-  PATH  [default: .] path to plugin
-
-FLAGS
-  -h, --help          Show CLI help.
-  -v, --verbose
-      --[no-]install  Install dependencies after linking the plugin.
-
-DESCRIPTION
-  Links a plugin into the CLI for development.
-
-  Installation of a linked plugin will override a user-installed or core plugin.
-
-  e.g. If you have a user-installed or core plugin that has a 'hello' command, installing a linked plugin with a 'hello'
-  command will override the user-installed or core plugin implementation. This is useful for development work.
-
-
-EXAMPLES
-  $ kinotic plugins link myplugin
-```
-
-_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/5.4.58/src/commands/plugins/link.ts)_
-
-## `kinotic plugins remove [PLUGIN]`
-
-Removes a plugin from the CLI.
-
-```
-USAGE
-  $ kinotic plugins remove [PLUGIN...] [-h] [-v]
-
-ARGUMENTS
-  [PLUGIN...]  plugin to uninstall
-
-FLAGS
-  -h, --help     Show CLI help.
-  -v, --verbose
-
-DESCRIPTION
-  Removes a plugin from the CLI.
-
-ALIASES
-  $ kinotic plugins unlink
-  $ kinotic plugins remove
-
-EXAMPLES
-  $ kinotic plugins remove myplugin
-```
-
-## `kinotic plugins reset`
-
-Remove all user-installed and linked plugins.
-
-```
-USAGE
-  $ kinotic plugins reset [--hard] [--reinstall]
-
-FLAGS
-  --hard       Delete node_modules and package manager related files in addition to uninstalling plugins.
-  --reinstall  Reinstall all plugins after uninstalling.
-```
-
-_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/5.4.58/src/commands/plugins/reset.ts)_
-
-## `kinotic plugins uninstall [PLUGIN]`
-
-Removes a plugin from the CLI.
-
-```
-USAGE
-  $ kinotic plugins uninstall [PLUGIN...] [-h] [-v]
-
-ARGUMENTS
-  [PLUGIN...]  plugin to uninstall
-
-FLAGS
-  -h, --help     Show CLI help.
-  -v, --verbose
-
-DESCRIPTION
-  Removes a plugin from the CLI.
-
-ALIASES
-  $ kinotic plugins unlink
-  $ kinotic plugins remove
-
-EXAMPLES
-  $ kinotic plugins uninstall myplugin
-```
-
-_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/5.4.58/src/commands/plugins/uninstall.ts)_
-
-## `kinotic plugins unlink [PLUGIN]`
-
-Removes a plugin from the CLI.
-
-```
-USAGE
-  $ kinotic plugins unlink [PLUGIN...] [-h] [-v]
-
-ARGUMENTS
-  [PLUGIN...]  plugin to uninstall
-
-FLAGS
-  -h, --help     Show CLI help.
-  -v, --verbose
-
-DESCRIPTION
-  Removes a plugin from the CLI.
-
-ALIASES
-  $ kinotic plugins unlink
-  $ kinotic plugins remove
-
-EXAMPLES
-  $ kinotic plugins unlink myplugin
-```
-
-## `kinotic plugins update`
-
-Update installed plugins.
-
-```
-USAGE
-  $ kinotic plugins update [-h] [-v]
-
-FLAGS
-  -h, --help     Show CLI help.
-  -v, --verbose
-
-DESCRIPTION
-  Update installed plugins.
-```
-
-_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/5.4.58/src/commands/plugins/update.ts)_
-
 ## `kinotic sync`
 
 Synchronize the local Entity definitions with the Kinotic Server
@@ -588,42 +234,4 @@ EXAMPLES
 ```
 
 _See code: [src/commands/synchronize.ts](https://github.com/kinotic-ai/kinotic/blob/v2.2.0/src/commands/synchronize.ts)_
-
-## `kinotic update [CHANNEL]`
-
-update the kinotic CLI
-
-```
-USAGE
-  $ kinotic update [CHANNEL] [--force |  | [-a | -v <value> | -i]] [-b ]
-
-FLAGS
-  -a, --available        See available versions.
-  -b, --verbose          Show more details about the available versions.
-  -i, --interactive      Interactively select version to install. This is ignored if a channel is provided.
-  -v, --version=<value>  Install a specific version.
-      --force            Force a re-download of the requested version.
-
-DESCRIPTION
-  update the kinotic CLI
-
-EXAMPLES
-  Update to the stable channel:
-
-    $ kinotic update stable
-
-  Update to a specific version:
-
-    $ kinotic update --version 1.0.0
-
-  Interactively select version:
-
-    $ kinotic update --interactive
-
-  See available versions:
-
-    $ kinotic update --available
-```
-
-_See code: [@oclif/plugin-update](https://github.com/oclif/plugin-update/blob/4.7.23/src/commands/update.ts)_
 <!-- commandsstop -->

package/dist/commands/login.d.ts

@@ -0,0 +1,9 @@
+import { Command } from '@oclif/core';
+export declare class Login extends Command {
+    static description: string;
+    static examples: string[];
+    static flags: {
+        server: import("@oclif/core/lib/interfaces").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces").CustomOptions>;
+    };
+    run(): Promise<void>;
+}

package/dist/commands/login.js

@@ -0,0 +1,21 @@
+import { Command, Flags } from '@oclif/core';
+import { resolveServer } from '../internal/state/Environment.js';
+import { CliAuthenticator } from '../internal/CliAuthenticator.js';
+export class Login extends Command {
+    static description = 'Log in to a Kinotic Server and store credentials for subsequent commands';
+    static examples = [
+        '$ kinotic login',
+        '$ kinotic login --server http://localhost:9090'
+    ];
+    static flags = {
+        server: Flags.string({ char: 's', description: 'The Kinotic server to log in to' })
+    };
+    async run() {
+        const { flags } = await this.parse(Login);
+        const serverConfig = await resolveServer(this.config.configDir, flags.server);
+        if (!(await new CliAuthenticator(serverConfig.url, this.config.configDir, this).login())) {
+            this.error('Login failed');
+        }
+        this.log(`Logged in to ${serverConfig.url}`);
+    }
+}

package/dist/commands/synchronize.d.ts

@@ -7,7 +7,6 @@ export declare class Synchronize extends Command {
         server: import("@oclif/core/lib/interfaces").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces").CustomOptions>;
         publish: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
         verbose: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
-        authHeaderFile: import("@oclif/core/lib/interfaces").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces").CustomOptions>;
         dryRun: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
         force: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
     };

package/dist/commands/synchronize.js

@@ -7,7 +7,7 @@ import { WebSocket } from 'ws';
 import { EntityCodeGenerationService } from '../internal/EntityCodeGenerationService.js';
 import { ProjectMigrationService } from '../internal/ProjectMigrationService.js';
 import { resolveServer } from '../internal/state/Environment.js';
-import { connectAndUpgradeSession } from '../internal/Utils.js';
+import { CliAuthenticator } from '../internal/CliAuthenticator.js';
 // This is required when running Kinotic from node
 Object.assign(global, { WebSocket });
 Kinotic.use(OsApiPlugin);
@@ -24,7 +24,6 @@ export class Synchronize extends Command {
         server: Flags.string({ char: 's', description: 'The Kinotic server to connect to' }),
         publish: Flags.boolean({ char: 'p', description: 'Publish each Entity after save/update' }),
         verbose: Flags.boolean({ char: 'v', description: 'Enable verbose logging' }),
-        authHeaderFile: Flags.string({ char: 'f', description: 'JSON File containing authentication headers', required: false }),
         dryRun: Flags.boolean({ description: 'Dry run enables verbose logging and does not save any changes to the server' }),
         force: Flags.boolean({ description: 'Force full regeneration, ignoring incremental change detection', default: false })
     };
@@ -40,45 +39,47 @@ export class Synchronize extends Command {
                 const serverConfig = await resolveServer(this.config.configDir, flags.server);
                 serverUrl = serverConfig.url;
             }
-            if (flags.dryRun || await connectAndUpgradeSession(serverUrl, this, flags.authHeaderFile)) {
-                try {
-                    let project = null;
-                    if (!flags.dryRun) {
-                        await Kinotic.applications.createApplicationIfNotExist(kinoticProjectConfig.application, '');
-                        project = new Project(null, kinoticProjectConfig.application, kinoticProjectConfig.name, kinoticProjectConfig.description);
-                        project.sourceOfTruth = ProjectType.TYPESCRIPT;
-                        project = await Kinotic.projects.createProjectIfNotExist(project);
+            if (!flags.dryRun && !(await new CliAuthenticator(serverUrl, this.config.configDir, this).connect())) {
+                this.error('Could not connect to the Kinotic Server');
+            }
+            try {
+                let project = null;
+                if (!flags.dryRun) {
+                    await Kinotic.applications.createApplicationIfNotExist(kinoticProjectConfig.application, '');
+                    project = new Project(null, kinoticProjectConfig.application, kinoticProjectConfig.name, kinoticProjectConfig.description);
+                    project.organizationId = kinoticProjectConfig.organization;
+                    project.sourceOfTruth = ProjectType.TYPESCRIPT;
+                    project = await Kinotic.projects.createProjectIfNotExist(project);
+                }
+                const codeGenerationService = new EntityCodeGenerationService(kinoticProjectConfig.application, kinoticProjectConfig.fileExtensionForImports, this);
+                await codeGenerationService
+                    .generateAllEntities(kinoticProjectConfig, flags.verbose || flags.dryRun, async (entityInfo, services) => {
+                    // combine named queries from generated services
+                    const namedQueries = [];
+                    for (let serviceInfo of services) {
+                        namedQueries.push(...serviceInfo.namedQueries);
+                    }
+                    // We sync named queries first since currently the backend cache eviction logic is a little dumb
+                    // i.e. The cache eviction for the EntityDefinition deletes the GraphQL schema
+                    //      This will evict the named query execution plan cache
+                    //      We want to make sure the GraphQL schema is updated after both these are updated and the EntityDefinition below
+                    if (!flags.dryRun && namedQueries.length > 0) {
+                        await this.synchronizeNamedQueries(kinoticProjectConfig.organization, project.id, entityInfo.entity, namedQueries);
                     }
-                    const codeGenerationService = new EntityCodeGenerationService(kinoticProjectConfig.application, kinoticProjectConfig.fileExtensionForImports, this);
-                    await codeGenerationService
-                        .generateAllEntities(kinoticProjectConfig, flags.verbose || flags.dryRun, async (entityInfo, services) => {
-                        // combine named queries from generated services
-                        const namedQueries = [];
-                        for (let serviceInfo of services) {
-                            namedQueries.push(...serviceInfo.namedQueries);
-                        }
-                        // We sync named queries first since currently the backend cache eviction logic is a little dumb
-                        // i.e. The cache eviction for the EntityDefinition deletes the GraphQL schema
-                        //      This will evict the named query execution plan cache
-                        //      We want to make sure the GraphQL schema is updated after both these are updated and the EntityDefinition below
-                        if (!flags.dryRun && namedQueries.length > 0) {
-                            await this.synchronizeNamedQueries(kinoticProjectConfig.organization, project.id, entityInfo.entity, namedQueries);
-                        }
-                        if (!flags.dryRun) {
-                            await this.synchronizeEntity(kinoticProjectConfig.organization, project.id, entityInfo.entity, flags.publish, flags.verbose);
-                        }
-                    }, flags.force);
-                    // Apply migrations after entity synchronization
                     if (!flags.dryRun) {
-                        const migrationService = new ProjectMigrationService(this);
-                        await migrationService.applyMigrations(project.id, './migrations', flags.verbose);
+                        await this.synchronizeEntity(kinoticProjectConfig.organization, project.id, entityInfo.entity, flags.publish, flags.verbose);
                     }
-                    this.log(`Synchronization Complete For application: ${kinoticProjectConfig.application}`);
+                }, flags.force);
+                // Apply migrations after entity synchronization
+                if (!flags.dryRun) {
+                    const migrationService = new ProjectMigrationService(this);
+                    await migrationService.applyMigrations(project.id, './migrations', flags.verbose);
                 }
-                catch (e) {
-                    if (e instanceof Error) {
-                        this.error(e.message);
-                    }
+                this.log(`Synchronization Complete For application: ${kinoticProjectConfig.application}`);
+            }
+            catch (e) {
+                if (e instanceof Error) {
+                    this.error(e.message);
                 }
             }
             await Kinotic.disconnect();

package/dist/internal/CliAuthenticator.d.ts

@@ -0,0 +1,46 @@
+import { Logger } from './Logger.js';
+/**
+ * CLI authentication against a Kinotic server using the OAuth 2.0 Device Authorization Grant
+ * (RFC 8628). {@link login} runs the interactive browser flow once and stores the refresh
+ * token; {@link connect} uses that stored token to open an authenticated {@link Kinotic}
+ * connection, refreshing the short-lived access token before every (re)connect.
+ */
+export declare class CliAuthenticator {
+    private readonly server;
+    private readonly configDir;
+    private readonly logger;
+    private refreshToken;
+    private accessToken;
+    private accessTokenExpiresAt;
+    /**
+     * @param server the server url to authenticate against
+     * @param configDir directory the rotating refresh token is persisted in
+     * @param logger sink for user-facing progress messages
+     */
+    constructor(server: string, configDir: string, logger: Pick<Logger, 'log'>);
+    /**
+     * Runs the interactive device-authorization login and persists the refresh token, so
+     * later {@link connect} calls — this run or a future one — are non-interactive.
+     *
+     * @return true if login succeeded
+     */
+    login(): Promise<boolean>;
+    /**
+     * Opens an authenticated {@link Kinotic} connection using the stored refresh token. Fails
+     * fast — with no interactive prompt — when there are no stored credentials.
+     *
+     * @return true if the connection was established
+     */
+    connect(): Promise<boolean>;
+    /**
+     * Returns a valid access token, refreshing it — and persisting the rotated refresh token —
+     * when it is absent or within 10s of expiry.
+     */
+    private freshAccessToken;
+    /** Parses the server url into the host/port the gateway serves both REST and STOMP on. */
+    private parseServer;
+    /** Runs the RFC 8628 device flow: start, browser approval, then poll for tokens. */
+    private deviceLogin;
+    private loadRefreshToken;
+    private saveRefreshToken;
+}