Stable release

.github/workflows/release.yml

@@ -6,8 +6,6 @@ on:
 jobs:
   release:
     runs-on: ubuntu-latest
-    env:
-      GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
     steps:
       - name: Checkout
         uses: actions/checkout@v3
@@ -17,12 +15,12 @@ jobs:
       - name: Setup Node.js
         uses: actions/setup-node@v3
         with:
-          node-version: 22.14.0
+          node-version: 24.14.0
       - name: Install pnpm
         uses: pnpm/action-setup@v2
         id: pnpm-install
         with:
-          version: 9
+          version: 10
           run_install: false
       - name: Get pnpm store directory
         id: pnpm-cache
@@ -48,6 +46,8 @@ jobs:
         run: pnpm config set //registry.npmjs.org/:_authToken ${{ secrets.CI_NPM_TOKEN }}
       - name: Release
         run: pnpm release
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
       - name: Update develop
         run: |
           git checkout develop

.nvmrc

@@ -1 +1 @@
-22.14.0
+24.14.0

.release-it.json

@@ -7,6 +7,7 @@
     "release": true
   },
   "npm": {
+    "publish": false,
     "skipChecks": true
   },
   "plugins": {

Dockerfile

@@ -1,4 +1,4 @@
-FROM node:22.14.0-alpine AS base
+FROM node:24.14.0-alpine AS base
 
 ENV PNPM_HOME="/pnpm"
 ENV PATH="$PNPM_HOME:$PATH"

README.md

@@ -110,7 +110,7 @@ export AWS_SECRET_ACCESS_KEY=
 After cloning the repository:
 
 - `cd os-cli`
-- `cp ./env/.env.development ./env`
+- `cp ./env/.env.development .env`
 - `docker compose up -d`
 - `pnpm install`
 
@@ -128,4 +128,3 @@ I personally prefer build in a terminal window and run the compiled version in a
 ## License
 
 os-cli [MIT licensed](LICENSE).
-

package.json

@@ -24,7 +24,7 @@
   "engines": {
     "node": ">=18.16.1"
   },
-  "packageManager": "pnpm@9.15.9",
+  "packageManager": "pnpm@10.30.3",
   "bin": {
     "os-cli": "dist/os-cli.js"
   },
@@ -65,7 +65,7 @@
     "@nestjs/testing": "^11.0.11",
     "@release-it/conventional-changelog": "8.0.2",
     "@types/jest": "^29.5.14",
-    "@types/node": "^22.13.10",
+    "@types/node": "^24.11.0",
     "@types/supertest": "^6.0.2",
     "eslint": "^9.22.0",
     "eslint-config-prettier": "^10.1.1",

renovate.json

@@ -1,14 +1,12 @@
 {
   "$schema": "https://docs.renovatebot.com/renovate-schema.json",
   "semanticCommits": "enabled",
+  "automerge": true,
   "packageRules": [
     {
       "matchUpdateTypes": ["major"],
-      "dependencyDashboardApproval": true
-    },
-    {
-      "matchDepTypes": ["devDependencies"],
-      "automerge": true
+      "dependencyDashboardApproval": true,
+      "automerge": false
     }
   ],
   "extends": [

src/aliases/commands/create.command.ts

@@ -41,7 +41,7 @@ export class CreateAliasCommand extends CommandRunner {
   }
 
   @Option({
-    flags: '-wr, --write-index, <boolean>',
+    flags: '-wr, --write-index, [boolean]',
     description: 'is write index',
     required: false,
     defaultValue: false,

src/analyzer/analyze.command.ts

@@ -29,7 +29,6 @@ export class AnalyzeCommand extends CommandRunner {
   @Option({
     flags: '-a, --analyzer, [string]',
     description: 'analyzer name',
-    defaultValue: 'default',
   })
   parseAnalyzer(val: string): string {
     return val;
@@ -71,7 +70,7 @@ export class AnalyzeCommand extends CommandRunner {
     passedParam: string[],
     options: {
       index?: string;
-      analyzer: string;
+      analyzer?: string;
       text?: string;
       payload?: Record<string, unknown>;
       file?: Record<string, unknown>;
@@ -99,7 +98,7 @@ export class AnalyzeCommand extends CommandRunner {
     try {
       const res = await this.analyzeService.analyze(payload);
 
-      this.logger.log('Index successfully created', {
+      this.logger.log('Text successfully analyzed', {
         fn: this.run.name,
         res,
       });

src/documents/commands/documents.command.ts

@@ -1,4 +1,6 @@
 import { Command, CommandRunner } from 'nest-commander';
+import { ExistsDocumentCommand } from './exists.command';
+import { GetDocumentCommand } from './get.command';
 import { DeleteDocumentsCommand } from './delete.command';
 import { CreateDocumentsCommand } from './create.command';
 import { QueryDocumentsCommand } from './query.command';
@@ -7,7 +9,13 @@ import { QueryDocumentsCommand } from './query.command';
   name: 'documents',
   description: 'opensearch documents related commands',
   aliases: ['d'],
-  subCommands: [DeleteDocumentsCommand, CreateDocumentsCommand, QueryDocumentsCommand],
+  subCommands: [
+    ExistsDocumentCommand,
+    GetDocumentCommand,
+    DeleteDocumentsCommand,
+    CreateDocumentsCommand,
+    QueryDocumentsCommand,
+  ],
 })
 export class DocumentsCommand extends CommandRunner {
   constructor() {

src/documents/commands/exists.command.ts

@@ -0,0 +1,67 @@
+import { SubCommand, CommandRunner, Option } from 'nest-commander';
+import { LoggerService } from '@andreafspeziale/nestjs-log';
+import { DocumentsService } from '../documents.service';
+
+@SubCommand({
+  name: 'exists',
+  description: 'check if document exists',
+  aliases: ['e'],
+})
+export class ExistsDocumentCommand extends CommandRunner {
+  constructor(
+    private readonly logger: LoggerService,
+    private readonly documentsService: DocumentsService,
+  ) {
+    super();
+    this.logger.setContext(ExistsDocumentCommand.name);
+  }
+
+  @Option({
+    flags: '-i, --index, <string>',
+    description: 'index name',
+    required: true,
+  })
+  parseIndex(val: string): string {
+    return val;
+  }
+
+  @Option({
+    flags: '-d, --document, <string>',
+    description: 'document id',
+    required: true,
+  })
+  parseDocument(val: string): string {
+    return val;
+  }
+
+  async run(
+    passedParam: string[],
+    options: {
+      index: string;
+      document: string;
+    },
+  ): Promise<void> {
+    this.logger.debug('Running command...', {
+      fn: this.run.name,
+      passedParam,
+      options,
+    });
+
+    try {
+      const res = await this.documentsService.exists(options.index, options.document);
+
+      this.logger.log('Document exists check completed', {
+        fn: this.run.name,
+        res,
+      });
+    } catch (error) {
+      this.logger.error('Error while checking document existence', {
+        fn: this.run.name,
+        index: options.index,
+        name: error.name,
+        ...(error.meta.body ? { body: error.meta.body } : {}),
+        ...(error.meta.statusCode ? { statusCode: error.meta.statusCode } : {}),
+      });
+    }
+  }
+}

src/documents/commands/get.command.ts

@@ -0,0 +1,67 @@
+import { SubCommand, CommandRunner, Option } from 'nest-commander';
+import { LoggerService } from '@andreafspeziale/nestjs-log';
+import { DocumentsService } from '../documents.service';
+
+@SubCommand({
+  name: 'get',
+  description: 'get document',
+  aliases: ['g'],
+})
+export class GetDocumentCommand extends CommandRunner {
+  constructor(
+    private readonly logger: LoggerService,
+    private readonly documentsService: DocumentsService,
+  ) {
+    super();
+    this.logger.setContext(GetDocumentCommand.name);
+  }
+
+  @Option({
+    flags: '-i, --index, <string>',
+    description: 'index name',
+    required: true,
+  })
+  parseIndex(val: string): string {
+    return val;
+  }
+
+  @Option({
+    flags: '-d, --document, <string>',
+    description: 'document id',
+    required: true,
+  })
+  parseDocument(val: string): string {
+    return val;
+  }
+
+  async run(
+    passedParam: string[],
+    options: {
+      index: string;
+      document: string;
+    },
+  ): Promise<void> {
+    this.logger.debug('Running command...', {
+      fn: this.run.name,
+      passedParam,
+      options,
+    });
+
+    try {
+      const res = await this.documentsService.get(options.index, options.document);
+
+      this.logger.log('Document successfully retrieved', {
+        fn: this.run.name,
+        res,
+      });
+    } catch (error) {
+      this.logger.error('Error while getting document', {
+        fn: this.run.name,
+        index: options.index,
+        name: error.name,
+        ...(error.meta.body ? { body: error.meta.body } : {}),
+        ...(error.meta.statusCode ? { statusCode: error.meta.statusCode } : {}),
+      });
+    }
+  }
+}

src/documents/commands/index.ts

@@ -1,3 +1,5 @@
+export * from './exists.command';
+export * from './get.command';
 export * from './delete.command';
 export * from './create.command';
 export * from './query.command';

src/documents/documents.module.ts

@@ -1,6 +1,8 @@
 import { Module } from '@nestjs/common';
 import { DeleteQuestions } from '../common';
 import {
+  ExistsDocumentCommand,
+  GetDocumentCommand,
   DeleteDocumentsCommand,
   DocumentsCommand,
   CreateDocumentsCommand,
@@ -13,6 +15,8 @@ import { DocumentsService } from './documents.service';
   providers: [
     DocumentsService,
     DocumentsCommand,
+    ExistsDocumentCommand,
+    GetDocumentCommand,
     DeleteDocumentsCommand,
     DeleteQuestions,
     BulkQuestions,

src/documents/documents.service.ts

@@ -11,6 +11,24 @@ export class DocumentsService {
     this.logger.setContext(DocumentsService.name);
   }
 
+  async exists(index: string, id: string) {
+    return (
+      await this.osClient.exists({
+        index,
+        id,
+      })
+    ).body;
+  }
+
+  async get(index: string, id: string) {
+    return (
+      await this.osClient.get({
+        index,
+        id,
+      })
+    ).body;
+  }
+
   async delete(index: string, id: string) {
     return (
       await this.osClient.delete({