Merge branch 'feature/PRXS-383-FrontendProtoAdd' into 'master'

Добавлена генерация файлов для frontend в Makefile и публикацию npm-пакета

See merge request !1

.gitignore

+.idea
+/node_modules/**/*
\ No newline at end of file

.gitlab-ci.yml

+stages:
+  - deploy
+
+publish_npm:
+  image: "node:19.3-alpine3.17"
+  stage: deploy
+  variables:
+    GIT_SUBMODULE_STRATEGY: recursive
+  before_script:
+    - apk add --update make bash protobuf-dev yarn
+    - npm install -g ts-proto@1.115.5
+    - npm install -g typescript@4.7.4
+    - npm i protobufjs@6.11.3
+
+  rules:
+    - if: '$CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH'
+      changes:
+        - config/package.json
+  script:
+    - make js-client
+    - cd ./config
+    - |
+      if [[ ! -f .npmrc ]]; then
+        echo 'No .npmrc found! Creating one now. Please review the following link for more information: https://docs.gitlab.com/ee/user/packages/npm_registry/index.html#project-level-npm-endpoint-1'
+        {
+          echo "@perxis-js:registry=${CI_API_V4_URL}/projects/${CI_PROJECT_ID}/packages/npm/"
+          echo "${CI_API_V4_URL#http*:}/packages/npm/:_authToken=\${CI_JOB_TOKEN}"
+          echo "${CI_API_V4_URL#http*:}/projects/${CI_PROJECT_ID}/packages/npm/:_authToken=\${CI_JOB_TOKEN}"
+        } >> .npmrc
+      fi
+    - NPM_PACKAGE_NAME=$(node -p "require('./package.json').name")
+    - NPM_PACKAGE_CURRENT_VERSION=$(npm show ${NPM_PACKAGE_NAME} version)
+    - yarn pub
+    - NPM_PACKAGE_VERSION=$(node -p "require('./package.json').version")
+    - echo "Successfully published version ${NPM_PACKAGE_VERSION} of ${NPM_PACKAGE_NAME} to GitLab's NPM registry"
\ No newline at end of file

.gitmodules

+[submodule "perxis-proto"]
+	path = perxis-proto
+	url = ../../perxis/perxis-proto.git
\ No newline at end of file

Makefile

+.PHONY: proto-js .FORCE
+SHELL = /bin/bash -o pipefail
+
+PROTODIR=perxis-proto/proto
+DSTDIR=config/dist
+
+
+ALLPROTO?=$(shell find $(PROTODIR) -name '*.proto' )
+PROTOFILES=	$(filter-out proto/status/status.proto, $(ALLPROTO))
+PROTOTSFILES=$(ALLPROTO:.proto=.ts)
+
+PROTOC_MAJOR_VERSION=$(shell protoc --version | awk '{print $$2;}' | cut -d. -f1)
+PROTOC_MINOR_VERSION=$(shell protoc --version | awk '{print $$2;}' | cut -d. -f2)
+TSC_MAJOR_VERSION=$(shell tsc --version | awk '{print $$2;}' | cut -d. -f1)
+TSC_MINOR_VERSION=$(shell tsc --version | awk '{print $$2;}' | cut -d. -f2)
+TSC_MIC_VERSION=$(shell tsc --version | awk '{print $$2;}' | cut -d. -f3)
+$(shell mkdir $(DSTDIR))
+
+# Генерация
+js-client: protoc-check js-check $(PROTOTSFILES) generate-js
+	@echo "Generated all files for npm package"
+
+%.ts: %.proto
+	@protoc -I=$(PROTODIR) \
+	--plugin=@protoc-gen-ts_proto \
+ 	--ts_proto_opt=env=browser,outputServices=generic-definitions,outputJsonMethods=false,esModuleInterop=true,useOptionals=messages,exportCommonSymbols=false,useDate=false,useExactTypes=false \
+ 	--ts_proto_out=$(DSTDIR) \
+ 	"$<"
+
+
+generate-js:
+	@./config/generate.sh
+
+proto-clean:
+	@rm -rf $(DSTDIR)
+
+.FORCE:
+# Проверка, что установлены необходимые инструменты для генерации proto-файлов
+protoc-check:
+ifeq (,$(shell which protoc))
+	$(error "Protocol Buffers not found. Run for linux: \"sudo apt install -y protobuf-compiler\", for mac: \"brew install protobuf\" \
+	or visit \"https://grpc.io/docs/protoc-installation/\" for more.\n")
+endif
+ifneq ($(shell expr $(PROTOC_MAJOR_VERSION) \>= 3),1)
+	 $(error "Current version is outdated. Please update protoc")
+endif
+ifneq ($(shell expr $(PROTOC_MINOR_VERSION) \>= 21), 1)
+	 $(error "Current version is lower than 3.21. Please update protoc")
+endif
+
+js-check:
+ifeq (,$(shell which npm))
+	$(error "NPM not found. Run for linux: \"sudo apt install npm\", for mac: \"brew install npm\" \
+	or visit \"https://docs.npmjs.com/getting-started\" for more.\n")
+endif
+ifeq (,$(shell which protoc-gen-ts_proto))
+	$(error "Ts-proto plugin for protoc not found. \
+	Run \"npm install -g ts-proto@1.115.5\" \
+	or visit \"https://github.com/stephenh/ts-proto\" for more.\n")
+endif
+ifeq (,$(shell which tsc))
+	$(error "Typescript not found. \
+	Run \"npm install -g typescript@4.7.4\" \
+	or visit \"https://github.com/microsoft/TypeScript\" for more.\n")
+endif
+ifneq ($(shell expr $(TSC_MAJOR_VERSION) \>= 4), 1)
+  	 $(error "Current version is outdated. Please update typescript \n")
+endif
+ifneq ($(shell expr $(TSC_MINOR_VERSION) \>= 7), 1)
+  	 $(error "Current version is lower than 4.7 Please update typescript \n")
+endif
+ifneq ($(shell expr $(TSC_MIC_VERSION) \>= 4), 1)
+  	 $(error "Current version is lower than 4.7.4 Please update typescript \n")
+endif

config/generate.sh

+#!/bin/bash
+
+generate_index() {
+  for path in "$@"; do
+    local base=$(basename "${path}")
+    local exac=${base%.ts}
+    local dir=$(dirname "${path}")
+
+    local segments
+    local p
+
+    IFS="/" read -a segments <<< $path
+
+    for segment in ${segments[@]}; do
+
+      if [ "$segment" == "." ] || [ "$segment" == "dist" ]; then
+        p+="$segment"
+        p+="/"
+        continue
+      fi
+
+      local exp
+
+      if [ "$segment" == "$base" ]; then
+        exp="export * from './$exac'"
+        if ! grep -Fxq "$exp" "$dir"/index.ts; then
+          echo "$exp" | tee -a "$dir"/index.ts
+        fi
+        p=""
+      elif [ "$segment" == "$exac" ]; then
+        exp="export * as $segment from './$segment'"
+        if ! grep -Fxq "$exp" "$p"/index.ts; then
+           echo "$exp" | tee -a "$p"/index.ts
+        fi
+        p+="$segment"
+        p+="/"
+      else
+        exp="export * as $segment from './$segment'"
+        if ! grep -Fxq "$exp" "$p"index.ts; then
+          echo "$exp" | tee -a "$p"index.ts
+        fi
+        p+="$segment"
+        p+="/"
+      fi
+
+    done
+  done
+}
+
+
+echo "Generate index.ts files"
+ts_files=$(find ./config/dist/**/ -name '*.ts')
+ts_files_array=($ts_files)
+generate_index "${ts_files_array[@]}"
+
+echo "Generate *.d.ts, *.d.ts.map, *.js, *.js.map files"
+tsc --project ./config --declaration --declarationMap --sourceMap --rootDir ./config/dist
+
+echo "Delete created tmp files"
+find ./config/dist -name 'index.ts' -delete
+find ./config/dist/*/** -name 'index.ts' -delete
+find ./config/ -maxdepth 1 -name 'index.ts' -delete
+find ./ -maxdepth 1 -name '*.json' -delete
+find ./ -maxdepth 1 -name '*.ts' -delete
+find ./config/dist/*/** -name '*.ts' ! -name '*.d.ts' -delete
+
+echo "---process finished"
\ No newline at end of file

config/package.json

+{
+    "name": "@perxis-js/perxis-client",
+    "version": "1.0.12",
+    "description": "",
+    "main": "dist/index.js",
+    "files": [
+        "dist/"
+    ],
+    "repository": {
+        "type": "git",
+        "url": "git+https://git.perx.ru/perxis/perxis-js.git"
+    },
+    "scripts": {
+        "pub": "npm publish"
+    },
+    "dependencies": {
+        "protobufjs": "^6.11.3"
+    },
+    "author": "",
+    "license": "ISC"
+}

config/tsconfig.json

+{
+    "compilerOptions": {
+        /* Visit https://aka.ms/tsconfig.json to read more about this file */
+
+        /* Projects */
+        // "incremental": true,                              /* Enable incremental compilation */
+        // "composite": true,                                /* Enable constraints that allow a TypeScript project to be used with project references. */
+        // "tsBuildInfoFile": "./",                          /* Specify the folder for .tsbuildinfo incremental compilation files. */
+        // "disableSourceOfProjectReferenceRedirect": true,  /* Disable preferring source files instead of declaration files when referencing composite projects */
+        // "disableSolutionSearching": true,                 /* Opt a project out of multi-project reference checking when editing. */
+        // "disableReferencedProjectLoad": true,             /* Reduce the number of projects loaded automatically by TypeScript. */
+
+        /* Language and Environment */
+        "target": "es2016" /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */,
+        // "lib": [],                                        /* Specify a set of bundled library declaration files that describe the target runtime environment. */
+        // "jsx": "preserve",                                /* Specify what JSX code is generated. */
+        // "experimentalDecorators": true,                   /* Enable experimental support for TC39 stage 2 draft decorators. */
+        // "emitDecoratorMetadata": true,                    /* Emit design-type metadata for decorated declarations in source files. */
+        // "jsxFactory": "",                                 /* Specify the JSX factory function used when targeting React JSX emit, e.g. 'React.createElement' or 'h' */
+        // "jsxFragmentFactory": "",                         /* Specify the JSX Fragment reference used for fragments when targeting React JSX emit e.g. 'React.Fragment' or 'Fragment'. */
+        // "jsxImportSource": "",                            /* Specify module specifier used to import the JSX factory functions when using `jsx: react-jsx*`.` */
+        // "reactNamespace": "",                             /* Specify the object invoked for `createElement`. This only applies when targeting `react` JSX emit. */
+        // "noLib": true,                                    /* Disable including any library files, including the default lib.d.ts. */
+        // "useDefineForClassFields": true,                  /* Emit ECMAScript-standard-compliant class fields. */
+
+        /* Modules */
+        "module": "CommonJS" /* Specify what module code is generated. */,
+        // "rootDir": "./",                                  /* Specify the root folder within your source files. */
+        // "moduleResolution": "node",                       /* Specify how TypeScript looks up a file from a given module specifier. */
+        // "baseUrl": "./",                                  /* Specify the base directory to resolve non-relative module names. */
+        // "paths": {},                                      /* Specify a set of entries that re-map imports to additional lookup locations. */
+        // "rootDirs": [],                                   /* Allow multiple folders to be treated as one when resolving modules. */
+        // "typeRoots": [],                                  /* Specify multiple folders that act like `./node_modules/@types`. */
+        // "types": [],                                      /* Specify type package names to be included without being referenced in a source file. */
+        // "allowUmdGlobalAccess": true,                     /* Allow accessing UMD globals from modules. */
+        // "resolveJsonModule": true,                        /* Enable importing .json files */
+        // "noResolve": true,                                /* Disallow `import`s, `require`s or `<reference>`s from expanding the number of files TypeScript should add to a project. */
+
+        /* JavaScript Support */
+        // "allowJs": true,                                  /* Allow JavaScript files to be a part of your program. Use the `checkJS` option to get errors from these files. */
+        // "checkJs": true,                                  /* Enable error reporting in type-checked JavaScript files. */
+        // "maxNodeModuleJsDepth": 1,                        /* Specify the maximum folder depth used for checking JavaScript files from `node_modules`. Only applicable with `allowJs`. */
+
+        /* Emit */
+        // "declaration": true,                              /* Generate .d.ts files from TypeScript and JavaScript files in your project. */
+        // "declarationMap": true,                           /* Create sourcemaps for d.ts files. */
+        // "emitDeclarationOnly": true,                      /* Only output d.ts files and not JavaScript files. */
+        // "sourceMap": true,                                /* Create source map files for emitted JavaScript files. */
+        // "outFile": "./",                                  /* Specify a file that bundles all outputs into one JavaScript file. If `declaration` is true, also designates a file that bundles all .d.ts output. */
+        // "outDir": "./",                                   /* Specify an output folder for all emitted files. */
+        // "removeComments": true,                           /* Disable emitting comments. */
+        // "noEmit": true,                                   /* Disable emitting files from a compilation. */
+        // "importHelpers": true,                            /* Allow importing helper functions from tslib once per project, instead of including them per-file. */
+        // "importsNotUsedAsValues": "remove",               /* Specify emit/checking behavior for imports that are only used for types */
+        // "downlevelIteration": true,                       /* Emit more compliant, but verbose and less performant JavaScript for iteration. */
+        // "sourceRoot": "",                                 /* Specify the root path for debuggers to find the reference source code. */
+        // "mapRoot": "",                                    /* Specify the location where debugger should locate map files instead of generated locations. */
+        // "inlineSourceMap": true,                          /* Include sourcemap files inside the emitted JavaScript. */
+        // "inlineSources": true,                            /* Include source code in the sourcemaps inside the emitted JavaScript. */
+        // "emitBOM": true,                                  /* Emit a UTF-8 Byte Order Mark (BOM) in the beginning of output files. */
+        // "newLine": "crlf",                                /* Set the newline character for emitting files. */
+        // "stripInternal": true,                            /* Disable emitting declarations that have `@internal` in their JSDoc comments. */
+        // "noEmitHelpers": true,                            /* Disable generating custom helper functions like `__extends` in compiled output. */
+        // "noEmitOnError": true,                            /* Disable emitting files if any type checking errors are reported. */
+        // "preserveConstEnums": true,                       /* Disable erasing `const enum` declarations in generated code. */
+        // "declarationDir": "./",                           /* Specify the output directory for generated declaration files. */
+        // "preserveValueImports": true,                     /* Preserve unused imported values in the JavaScript output that would otherwise be removed. */
+
+        /* Interop Constraints */
+        // "isolatedModules": true,                          /* Ensure that each file can be safely transpiled without relying on other imports. */
+        // "allowSyntheticDefaultImports": true,             /* Allow 'import x from y' when a module doesn't have a default export. */
+        "esModuleInterop": true /* Emit additional JavaScript to ease support for importing CommonJS modules. This enables `allowSyntheticDefaultImports` for type compatibility. */,
+        // "preserveSymlinks": true,                         /* Disable resolving symlinks to their realpath. This correlates to the same flag in node. */
+        "forceConsistentCasingInFileNames": true /* Ensure that casing is correct in imports. */,
+
+        /* Type Checking */
+        "strict": true /* Enable all strict type-checking options. */,
+        // "noImplicitAny": true,                            /* Enable error reporting for expressions and declarations with an implied `any` type.. */
+        // "strictNullChecks": true,                         /* When type checking, take into account `null` and `undefined`. */
+        // "strictFunctionTypes": true,                      /* When assigning functions, check to ensure parameters and the return values are subtype-compatible. */
+        // "strictBindCallApply": true,                      /* Check that the arguments for `bind`, `call`, and `apply` methods match the original function. */
+        // "strictPropertyInitialization": true,             /* Check for class properties that are declared but not set in the constructor. */
+        // "noImplicitThis": true,                           /* Enable error reporting when `this` is given the type `any`. */
+        // "useUnknownInCatchVariables": true,               /* Type catch clause variables as 'unknown' instead of 'any'. */
+        // "alwaysStrict": true,                             /* Ensure 'use strict' is always emitted. */
+        // "noUnusedLocals": true,                           /* Enable error reporting when a local variables aren't read. */
+        // "noUnusedParameters": true,                       /* Raise an error when a function parameter isn't read */
+        // "exactOptionalPropertyTypes": true,               /* Interpret optional property types as written, rather than adding 'undefined'. */
+        // "noImplicitReturns": true,                        /* Enable error reporting for codepaths that do not explicitly return in a function. */
+        // "noFallthroughCasesInSwitch": true,               /* Enable error reporting for fallthrough cases in switch statements. */
+        // "noUncheckedIndexedAccess": true,                 /* Include 'undefined' in index signature results */
+        // "noImplicitOverride": true,                       /* Ensure overriding members in derived classes are marked with an override modifier. */
+        // "noPropertyAccessFromIndexSignature": true,       /* Enforces using indexed accessors for keys declared using an indexed type */
+        // "allowUnusedLabels": true,                        /* Disable error reporting for unused labels. */
+        // "allowUnreachableCode": true,                     /* Disable error reporting for unreachable code. */
+
+        /* Completeness */
+        // "skipDefaultLibCheck": true,                      /* Skip type checking .d.ts files that are included with TypeScript. */
+        "skipLibCheck": true /* Skip type checking all .d.ts files. */
+    },
+    "include": [
+        "./dist/**/*"
+    ],
+}

perxis-proto @ 83fd620e

+Subproject commit 83fd620ee42af0a0e2e934ccadf691cabd8f468a