@rsdk/cli.common 5.7.0-next.6 → 6.0.0-next.1

package/dist/types.d.ts

@@ -1,97 +0,0 @@
-export interface RsdkJson {
-    metadata: Metadata;
-    rsdkMetadata: RsdkMetadaum[];
-}
-export interface Metadata {
-    name: string;
-    version: string;
-    description: string;
-    protocols: string[];
-    config: Config;
-}
-export interface Config {
-    prefix: string;
-    sections: Section[];
-    sources: any[];
-    properties: any[];
-}
-export interface Section {
-    tags?: string[];
-    constructorName: string;
-    properties: Property[];
-    name?: string;
-}
-export interface Property {
-    expectedInEnv: boolean;
-    key: string;
-    description: string;
-    parser: Parser;
-    defaultValue: any;
-}
-export interface Parser {
-    type: string;
-    description: string;
-}
-export interface RsdkMetadaum {
-    scope: string;
-    value: Value;
-}
-export interface Value {
-    global?: boolean;
-    imports?: Import[];
-    providers?: Provider2[];
-    exports?: string[];
-    token?: string;
-    partitionKeyField: any;
-    topicName?: string;
-    group?: string;
-    type?: number;
-    eventType?: EventType;
-    options?: Options3;
-    constructorName?: string;
-}
-export interface Import {
-    providers: Provider[];
-    exports: Export[];
-}
-export interface Provider {
-    inject: Inject | undefined[];
-}
-export interface Inject {
-    optional: boolean;
-}
-export interface Export {
-    inject: Inject2 | undefined[];
-}
-export interface Inject2 {
-    optional: boolean;
-}
-export interface Provider2 {
-    provide: string;
-    useValue: UseValue;
-}
-export interface UseValue {
-    context: string;
-}
-export interface EventType {
-    $group: string;
-    $partitionKeyField: any;
-    $type: string;
-}
-export interface Options3 {
-    key: string;
-    scope: string;
-    description: string;
-}
-export declare enum MetaKeys {
-    Core = "Core",
-    Global = "Global",
-    SubCmd = "SubCmd",
-    Option = "Option",
-    Alias = "Alias",
-    DefaultValue = "DefaultValue"
-}
-export type CoreMetadataMap = Map<string, {
-    metaKey: MetaKeys;
-    value: any;
-}[]>;

package/dist/types.js

@@ -1,13 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.MetaKeys = void 0;
-var MetaKeys;
-(function (MetaKeys) {
-    MetaKeys["Core"] = "Core";
-    MetaKeys["Global"] = "Global";
-    MetaKeys["SubCmd"] = "SubCmd";
-    MetaKeys["Option"] = "Option";
-    MetaKeys["Alias"] = "Alias";
-    MetaKeys["DefaultValue"] = "DefaultValue";
-})(MetaKeys || (exports.MetaKeys = MetaKeys = {}));
-//# sourceMappingURL=types.js.map

package/dist/types.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":";;;AAsFA,IAAY,QAOX;AAPD,WAAY,QAAQ;IAClB,yBAAa,CAAA;IACb,6BAAiB,CAAA;IACjB,6BAAiB,CAAA;IACjB,6BAAiB,CAAA;IACjB,2BAAe,CAAA;IACf,yCAA6B,CAAA;AAC/B,CAAC,EAPW,QAAQ,wBAAR,QAAQ,QAOnB"}

package/dist/utils.d.ts

@@ -1,4 +0,0 @@
-import { MetaKeys } from './types';
-export declare function assertString(v: string | symbol | undefined): asserts v is string;
-export declare const defineMetadata: (t: object, propertyKey: string, metaKey: MetaKeys, value: unknown) => void;
-export declare const defineCoreMetadata: (target: object, metaKey: MetaKeys, value: any) => void;

package/dist/utils.js

@@ -1,30 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.defineCoreMetadata = exports.defineMetadata = void 0;
-exports.assertString = assertString;
-const types_1 = require("./types");
-function assertString(v) {
-    if (typeof v !== 'string') {
-        throw new TypeError('v must be string');
-    }
-}
-const defineMetadata = (t, propertyKey, metaKey, value) => {
-    const target = t.constructor;
-    const exist = Reflect.getMetadata(types_1.MetaKeys.Core, target) ??
-        new Map();
-    const existed = exist.get(propertyKey) ?? [];
-    existed.push({
-        metaKey,
-        value,
-    });
-    exist.set(propertyKey, existed);
-    Reflect.defineMetadata(types_1.MetaKeys.Core, exist, target);
-};
-exports.defineMetadata = defineMetadata;
-const defineCoreMetadata = (target, metaKey, value) => {
-    const exist = Reflect.getMetadata(types_1.MetaKeys.Global, target) ?? new Map();
-    exist.set(metaKey, value);
-    Reflect.defineMetadata(types_1.MetaKeys.Global, exist, target);
-};
-exports.defineCoreMetadata = defineCoreMetadata;
-//# sourceMappingURL=utils.js.map

package/dist/utils.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"utils.js","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":";;;AAGA,oCAMC;AARD,mCAAmC;AAEnC,SAAgB,YAAY,CAC1B,CAA8B;IAE9B,IAAI,OAAO,CAAC,KAAK,QAAQ,EAAE,CAAC;QAC1B,MAAM,IAAI,SAAS,CAAC,kBAAkB,CAAC,CAAC;IAC1C,CAAC;AACH,CAAC;AAEM,MAAM,cAAc,GAAG,CAC5B,CAAS,EACT,WAAmB,EACnB,OAAiB,EACjB,KAAc,EACR,EAAE;IACR,MAAM,MAAM,GAAG,CAAC,CAAC,WAAW,CAAC;IAC7B,MAAM,KAAK,GACT,OAAO,CAAC,WAAW,CAAC,gBAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;QAC1C,IAAI,GAAG,EAMJ,CAAC;IAEN,MAAM,OAAO,GAAG,KAAK,CAAC,GAAG,CAAC,WAAW,CAAC,IAAI,EAAE,CAAC;IAE7C,OAAO,CAAC,IAAI,CAAC;QACX,OAAO;QACP,KAAK;KACN,CAAC,CAAC;IAEH,KAAK,CAAC,GAAG,CAAC,WAAW,EAAE,OAAO,CAAC,CAAC;IAEhC,OAAO,CAAC,cAAc,CAAC,gBAAQ,CAAC,IAAI,EAAE,KAAK,EAAE,MAAM,CAAC,CAAC;AACvD,CAAC,CAAC;AA3BW,QAAA,cAAc,kBA2BzB;AAEK,MAAM,kBAAkB,GAAG,CAChC,MAAc,EACd,OAAiB,EACjB,KAAU,EACJ,EAAE;IACR,MAAM,KAAK,GACT,OAAO,CAAC,WAAW,CAAC,gBAAQ,CAAC,MAAM,EAAE,MAAM,CAAC,IAAI,IAAI,GAAG,EAAmB,CAAC;IAE7E,KAAK,CAAC,GAAG,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;IAE1B,OAAO,CAAC,cAAc,CAAC,gBAAQ,CAAC,MAAM,EAAE,KAAK,EAAE,MAAM,CAAC,CAAC;AACzD,CAAC,CAAC;AAXW,QAAA,kBAAkB,sBAW7B"}

package/src/cmd.core.ts

@@ -1,221 +0,0 @@
-import { LoggerFactory } from '@rsdk/logging';
-import type { OptionValues } from 'commander';
-import { Command } from 'commander';
-import _ from 'lodash';
-
-import { Env } from './env.provider';
-import type { CoreMetadataMap } from './types';
-import { MetaKeys } from './types';
-
-const cliLogger = LoggerFactory.create('@rsdk/cli.common');
-
-type ParameterIndex = number;
-function getRootCommand(globalMetadata: any): Command | undefined {
-  const v = globalMetadata?.get(MetaKeys.Core);
-
-  if (!v) {
-    return;
-  }
-  return new Command(v.name).description(v.description);
-}
-
-function createEnvKey(optionMetadata: OptionMetadata): string {
-  return _.snakeCase(
-    `${optionMetadata.name}${optionMetadata.strategy === Boolean ? '_enabled' : ''}`,
-  ).toUpperCase();
-}
-
-/**
- * Приоритет значений env -> flagValue -> defaultValue
- * Сделано намеренно так как в кейсе использования локально проблем с ENV вряд ли будет.
- * А вот в кубе например удобнее редактировать ConfigMap и добавить туда ключ, чем редактировать Deployment
- * @param {OptionMetadata} optionMetadata
- * @param {OptionValues} opts
- * @returns {any}
- */
-function extractValue(optionMetadata: OptionMetadata, opts: OptionValues): any {
-  // Создаем ключ для переменной окружения на основе метаданных опции
-  const envKey = createEnvKey(optionMetadata);
-
-  // Проверяем, существует ли значение для данного ключа в переменных окружения
-  const envHasValue = Env.has(envKey);
-
-  // Преобразуем имя опции в camelCase для использования в объекте opts
-  const optsKey = _.camelCase(optionMetadata.name);
-
-  // Получаем значение флага из объекта opts
-  const flagValue = opts[optsKey];
-
-  // Проверяем, был ли предоставлен флаг в объекте opts
-  const flagProvided = Object.hasOwn(opts, optsKey);
-
-  // Если значение переменной окружения существует
-  if (envHasValue) {
-    // Получаем значение переменной окружения
-    const envValue = Env.get(envKey);
-
-    // Если флаг был предоставлен, выводим предупреждение о переопределении значения флага значением переменной окружения
-    if (flagProvided) {
-      cliLogger.warn('Env value override flag value', {
-        optionMetadata,
-        envKey,
-        envValue,
-        flagValue,
-      });
-    }
-
-    // Возвращаем значение переменной окружения
-    return envValue;
-  }
-
-  // Если значение переменной окружения не предоставлено, выводим отладочное сообщение
-  cliLogger.trace('Env value not provided', { key: optsKey, envKey });
-
-  // Если флаг был предоставлен, выводим отладочное сообщение и возвращаем значение флага
-  if (flagProvided) {
-    cliLogger.trace('Use flag value', {
-      key: optsKey,
-      flagValue,
-      opts,
-      envHasValue,
-      envKey,
-    });
-    return flagValue;
-  }
-
-  // Если ни значение переменной окружения, ни флаг не предоставлены, выводим отладочное сообщение и возвращаем значение по умолчанию
-  cliLogger.trace('Use default value', {
-    key: optsKey,
-    flagValue,
-    opts,
-    envHasValue,
-    envKey,
-    defaultValue: optionMetadata.defaultValue,
-  });
-
-  return optionMetadata.defaultValue;
-}
-
-function createCommandHandler(
-  argMap: Map<ParameterIndex, OptionMetadata>,
-  handler: (...args: any[]) => any,
-): (__: any, cmd: Command) => void {
-  return (__, cmd: Command) => {
-    const opts = cmd.opts();
-
-    const normalizedArgList: {
-      index: number;
-      optionMetadata: OptionMetadata;
-    }[] = [...argMap].map(([index, optionMetadata]) => ({
-      index,
-      optionMetadata,
-    }));
-    const sortedArgList: { index: any; optionMetadata: OptionMetadata }[] =
-      _.sortBy(normalizedArgList, ['index']);
-
-    const args: (string | undefined)[] = sortedArgList.map(
-      ({ optionMetadata }) => {
-        cliLogger.trace('handle arg', {
-          optionMetadata,
-        });
-        const result = extractValue(optionMetadata, opts);
-
-        if (optionMetadata.parser) {
-          return optionMetadata.parser(result);
-        }
-        return result;
-      },
-    );
-
-    handler(...args);
-  };
-}
-
-type OptionMetadata = {
-  name: string;
-  description: string;
-  alias?: string;
-  defaultValue?: string | boolean;
-  parser?: (v: any) => any;
-  strategy: BooleanConstructor | StringConstructor;
-};
-
-function createArgMap(
-  metadata: { metaKey: MetaKeys; value: any }[],
-): Map<ParameterIndex, OptionMetadata> {
-  return metadata.reduce((acc, item) => {
-    switch (item.metaKey) {
-      case MetaKeys.Alias:
-      case MetaKeys.DefaultValue:
-      case MetaKeys.Option:
-        acc.set(item.value.parameterIndex, {
-          ...acc.get(item.value.parameterIndex),
-          ...item.value,
-        });
-    }
-    return acc;
-  }, new Map<ParameterIndex, OptionMetadata>());
-}
-
-export const getCommanderCommand = (cmd: any): Command[] => {
-  const value = Reflect.getMetadata(MetaKeys.Core, cmd);
-  if (!(value instanceof Map)) {
-    throw new TypeError('value not a map');
-  }
-
-  const globalMetadata = Reflect.getMetadata(MetaKeys.Global, cmd);
-
-  const rootCommand = getRootCommand(globalMetadata);
-
-  const map: CoreMetadataMap = value;
-
-  // Могут быть методы/поля, на которые ссылается метод через this
-  const instance = Reflect.construct(cmd, []);
-
-  const commands: Command[] = [];
-
-  for (const [propertyKey, metadata] of map) {
-    const subCmdMetadata = metadata.filter(
-      ({ metaKey }) => metaKey === MetaKeys.SubCmd,
-    );
-    if (subCmdMetadata?.length !== 1) {
-      throw new Error('Must be one subcmd metadata', {
-        cause: {
-          subCmdMetadata,
-        },
-      });
-    }
-
-    const subCmdValue = subCmdMetadata[0].value;
-    const command = new Command(subCmdValue.name).description(
-      subCmdValue.description,
-    );
-
-    const argMap = createArgMap(metadata);
-
-    for (const option of argMap.values()) {
-      command.option(
-        `--${option.name}${option.strategy === String ? ' <value>' : ''}`,
-        `${option.description} [eq ${createEnvKey(option)} in env]`,
-        option.defaultValue,
-      );
-    }
-
-    command.action(
-      createCommandHandler(
-        argMap,
-
-        // @ts-expect-error потому что не понимает что инстанс это объект у которого есть этот метод
-        instance[propertyKey].bind(instance),
-      ),
-    );
-    commands.push(command);
-  }
-  if (rootCommand) {
-    for (const command of commands) {
-      rootCommand.addCommand(command);
-    }
-    return [rootCommand];
-  }
-  return commands;
-};

package/src/decorators.ts

@@ -1,56 +0,0 @@
-import { MetaKeys } from './types';
-import { assertString, defineCoreMetadata, defineMetadata } from './utils';
-
-export const SubCmd = (name: string, description: string): MethodDecorator => {
-  return (target, propertyKey) => {
-    assertString(propertyKey);
-    defineMetadata(target, propertyKey, MetaKeys.SubCmd, {
-      name,
-      description,
-    });
-  };
-};
-export const Cmd = (name: string, description: string): ClassDecorator => {
-  return (target) => {
-    defineCoreMetadata(target, MetaKeys.Core, {
-      name,
-      description,
-    });
-  };
-};
-
-export const Option = (
-  name: string,
-  description: string,
-  strategy: typeof Boolean | typeof String,
-  parser?: (v: any) => any,
-): ParameterDecorator => {
-  return (target, propertyKey, parameterIndex) => {
-    assertString(propertyKey);
-    defineMetadata(target, propertyKey, MetaKeys.Option, {
-      name,
-      description,
-      strategy,
-      parameterIndex,
-      parser,
-    });
-  };
-};
-export const Alias = (alias: string): ParameterDecorator => {
-  return (target, propertyKey, parameterIndex) => {
-    assertString(propertyKey);
-    defineMetadata(target, propertyKey, MetaKeys.Alias, {
-      alias,
-      parameterIndex,
-    });
-  };
-};
-export const Default = (v: any): ParameterDecorator => {
-  return (target, propertyKey, parameterIndex) => {
-    assertString(propertyKey);
-    defineMetadata(target, propertyKey, MetaKeys.DefaultValue, {
-      defaultValue: v,
-      parameterIndex,
-    });
-  };
-};

package/src/env.provider.ts

@@ -1,30 +0,0 @@
-import _ from 'lodash';
-
-export class Env {
-  static has(key: string): boolean {
-    const nk = Env.normalizeKey(key);
-
-    return nk in process.env;
-  }
-
-  static get(key: string): string | undefined;
-  static get<V = string>(key: string, parser: (v: string | undefined) => V): V;
-  static get<V = string>(
-    key: string,
-    parser?: (v: string | undefined) => V,
-  ): V | undefined | string {
-    const nk = this.normalizeKey(key);
-    if (!Env.has(nk)) {
-      return undefined;
-    }
-    const v = process.env[nk];
-    if (parser) {
-      return parser(v);
-    }
-    return v;
-  }
-
-  private static normalizeKey(key: string): string {
-    return _.snakeCase(key).toUpperCase();
-  }
-}

package/src/rsdk/metadata.aggregator.ts

@@ -1,17 +0,0 @@
-import type { RsdkJson, Value } from '../types';
-
-export function getMetadata(rsdkJson: RsdkJson, scope: string): Value[] {
-  return rsdkJson.rsdkMetadata
-    .filter((meta) => meta.scope === scope)
-    .map(({ value }) => value);
-}
-export function getMetadataByPredict(
-  rsdkJson: RsdkJson,
-  predict: (meta: { scope: string }) => boolean,
-): Value[] {
-  return rsdkJson.rsdkMetadata.filter(predict).map(({ value }) => value);
-}
-
-export function getKafkaMetadata(rsdkJson: RsdkJson): Value[] {
-  return getMetadata(rsdkJson, 'kafka-topic');
-}

package/src/rsdk-json.parser.ts

@@ -1,17 +0,0 @@
-import { readFile } from 'node:fs/promises';
-import path from 'node:path';
-
-import type { RsdkJson } from './types';
-
-export class RsdkJsonParser {
-  constructor(readonly path: string = 'autodoc/rsdk.json') {}
-
-  async parseRsdkJson(): Promise<RsdkJson> {
-    const pathToRsdkJson = path.resolve(this.path);
-    const rsdkJson: RsdkJson = JSON.parse(
-      await readFile(pathToRsdkJson, 'utf8'),
-    );
-
-    return rsdkJson;
-  }
-}

package/src/types.ts

@@ -1,102 +0,0 @@
-export interface RsdkJson {
-  metadata: Metadata;
-  rsdkMetadata: RsdkMetadaum[];
-}
-export interface Metadata {
-  name: string;
-  version: string;
-  description: string;
-  protocols: string[];
-  config: Config;
-}
-export interface Config {
-  prefix: string;
-  sections: Section[];
-  sources: any[];
-  properties: any[];
-}
-export interface Section {
-  tags?: string[];
-  constructorName: string;
-  properties: Property[];
-  name?: string;
-}
-export interface Property {
-  expectedInEnv: boolean;
-  key: string;
-  description: string;
-  parser: Parser;
-  defaultValue: any;
-}
-export interface Parser {
-  type: string;
-  description: string;
-}
-export interface RsdkMetadaum {
-  scope: string;
-  value: Value;
-}
-export interface Value {
-  global?: boolean;
-  imports?: Import[];
-  providers?: Provider2[];
-  exports?: string[];
-  token?: string;
-  partitionKeyField: any;
-  topicName?: string;
-  group?: string;
-  type?: number;
-  eventType?: EventType;
-  options?: Options3;
-  constructorName?: string;
-}
-export interface Import {
-  providers: Provider[];
-  exports: Export[];
-}
-export interface Provider {
-  inject: Inject | undefined[];
-}
-export interface Inject {
-  optional: boolean;
-}
-export interface Export {
-  inject: Inject2 | undefined[];
-}
-export interface Inject2 {
-  optional: boolean;
-}
-export interface Provider2 {
-  provide: string;
-  useValue: UseValue;
-}
-export interface UseValue {
-  context: string;
-}
-export interface EventType {
-  $group: string;
-  $partitionKeyField: any;
-  $type: string;
-}
-export interface Options3 {
-  key: string;
-  scope: string;
-  description: string;
-}
-
-export enum MetaKeys {
-  Core = 'Core',
-  Global = 'Global',
-  SubCmd = 'SubCmd',
-  Option = 'Option',
-  Alias = 'Alias',
-  DefaultValue = 'DefaultValue',
-}
-
-export type CoreMetadataMap = Map<
-  string,
-  {
-    metaKey: MetaKeys;
-    value: any;
-  }[]
->;

package/src/utils.ts

@@ -1,52 +0,0 @@
-import type { CoreMetadataMap } from './types';
-import { MetaKeys } from './types';
-
-export function assertString(
-  v: string | symbol | undefined,
-): asserts v is string {
-  if (typeof v !== 'string') {
-    throw new TypeError('v must be string');
-  }
-}
-
-export const defineMetadata = (
-  t: object,
-  propertyKey: string,
-  metaKey: MetaKeys,
-  value: unknown,
-): void => {
-  const target = t.constructor;
-  const exist: CoreMetadataMap =
-    Reflect.getMetadata(MetaKeys.Core, target) ??
-    new Map<
-      string,
-      {
-        metaKey: MetaKeys;
-        value: unknown;
-      }[]
-    >();
-
-  const existed = exist.get(propertyKey) ?? [];
-
-  existed.push({
-    metaKey,
-    value,
-  });
-
-  exist.set(propertyKey, existed);
-
-  Reflect.defineMetadata(MetaKeys.Core, exist, target);
-};
-
-export const defineCoreMetadata = (
-  target: object,
-  metaKey: MetaKeys,
-  value: any,
-): void => {
-  const exist: CoreMetadataMap =
-    Reflect.getMetadata(MetaKeys.Global, target) ?? new Map<MetaKeys, any[]>();
-
-  exist.set(metaKey, value);
-
-  Reflect.defineMetadata(MetaKeys.Global, exist, target);
-};