@git.zone/cli 2.22.0 → 2.24.0

package/dist_ts/mod_services/classes.servicemanager.d.ts

@@ -1,3 +1,33 @@
+import { ServiceConfiguration } from './classes.serviceconfiguration.js';
+import { type TServiceName } from './classes.servicedatamarker.js';
+import type { ContainerStatus } from './classes.dockercontainer.js';
+export interface IServiceStatus {
+    service: TServiceName;
+    enabled: boolean;
+    container: string;
+    status: ContainerStatus;
+    port: string;
+    connectionString: string;
+    dataDirectory: string;
+    dataSizeBytes: number;
+    /** Only meaningful when the container does not exist yet. */
+    portAvailable: boolean | null;
+    /** MongoDB only: whether the instance enforces authentication. */
+    authEnabled?: boolean;
+}
+export interface IServicesStatus {
+    project: {
+        name: string;
+        path: string;
+        enabledServices: string[];
+    };
+    services: {
+        mongodb: IServiceStatus;
+        minio: IServiceStatus;
+        elasticsearch: IServiceStatus;
+    };
+    totalDataBytes: number;
+}
 export declare class ServiceManager {
     private config;
     private docker;
@@ -8,6 +38,10 @@ export declare class ServiceManager {
      * Initialize the service manager
      */
     init(): Promise<void>;
+    /**
+     * Expose the resolved service configuration to the command layer.
+     */
+    getConfiguration(): ServiceConfiguration;
     /**
      * Load service configuration from .smartconfig.json
      */
@@ -21,21 +55,72 @@ export declare class ServiceManager {
      */
     private isServiceEnabled;
     /**
-     * Register this project with the global registry
+     * Prepare a service's data directory: create it and record tool ownership.
+     *
+     * The marker written here is what later allows `gitzone services prune` to
+     * prove the directory is reclaimable instead of guessing from its path.
+     */
+    private prepareDataDirectory;
+    /**
+     * Register this project with the global registry.
+     *
+     * Public and called from the command layer after any start path: previously
+     * only `startAll` registered, so `gitzone services start mongo` created a
+     * container the registry never knew about and prune could never account for.
      */
-    private registerWithGlobalRegistry;
+    registerWithGlobalRegistry(): Promise<void>;
     /**
      * Start all enabled services
      */
     startAll(): Promise<void>;
     /**
-     * Stop all enabled services
+     * Stop every service container belonging to this project.
+     *
+     * Deliberately not filtered by the enabled-service list: disabling a service
+     * previously left its container running with no command able to stop it,
+     * which is how projects accumulated forgotten containers. Stopping a service
+     * that is not running is a no-op, so covering all three is always safe.
      */
     stopAll(): Promise<void>;
     /**
      * Start MongoDB service
+     *
+     * MongoDB runs as a single-node replica set so that multi-document
+     * transactions work. Auth + replSet requires a keyfile; mongod listens on
+     * MONGODB_PORT inside the container too, so the advertised member address
+     * (localhost:MONGODB_PORT) is reachable from host and container alike.
      */
     startMongoDB(): Promise<void>;
+    /**
+     * Create the MongoDB container as a single-node replica set
+     */
+    private createMongoContainer;
+    /**
+     * Generate the replica-set keyfile inside the data volume if missing.
+     * Created through a root one-off container so ownership (mongodb uid 999)
+     * is correct under both rootful and rootless Docker.
+     */
+    private ensureMongoKeyfile;
+    /**
+     * The mongod argv the container was created with
+     */
+    private getMongoContainerCmd;
+    /**
+     * Make sure the configured root user exists when auth is enabled.
+     *
+     * `MONGO_INITDB_ROOT_USERNAME` only takes effect on an empty dbpath, so data
+     * that was first created with auth disabled has no user at all. Enabling auth
+     * over it would leave an unusable database. MongoDB's localhost exception is
+     * the designed bootstrap path for exactly this: while zero users exist, a
+     * connection from localhost — which, inside the container, is what this is —
+     * may create the first one. If users already exist the exception does not
+     * apply and creation fails, so this can never overwrite or escalate anything.
+     */
+    private ensureMongoRootUser;
+    /**
+     * Initiate the single-node replica set once mongod is reachable
+     */
+    private ensureMongoReplicaSetInitiated;
     /**
      * Start MinIO service
      */
@@ -56,10 +141,25 @@ export declare class ServiceManager {
      * Stop Elasticsearch service
      */
     stopElasticsearch(): Promise<void>;
+    /**
+     * Collect service status as structured data.
+     *
+     * This is the machine-readable surface behind `gitzone services status
+     * --json`; consumers such as test suites can read a connection string from it
+     * without scraping human output or re-deriving it from `.nogit/env.json`.
+     */
+    collectStatus(): Promise<IServicesStatus>;
     /**
      * Show service status
      */
     showStatus(): Promise<void>;
+    /**
+     * Report on-disk size of this project's service data.
+     *
+     * Reporting comes before any deletion: knowing what a project holds is what
+     * makes reclaiming it a decision rather than a guess.
+     */
+    showDiskUsage(): Promise<void>;
     /**
      * Show configuration
      */