@restorecommerce/resource-base-interface 1.2.5 → 1.4.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (4) hide show
  1. package/CHANGELOG.md +8 -0
  2. package/README.md +5 -3
  3. package/lib/core/interfaces.d.ts +1 -1
  4. package/package.json +17 -18
package/CHANGELOG.md CHANGED
@@ -1,3 +1,11 @@
1
+ ### 1.4.0 (September 19th, 2023)
2
+
3
+ - up node version and dependencies
4
+
5
+ ### 1.3.0 (September 19th, 2023)
6
+
7
+ - up deps (made all fields optional in proto files)
8
+
1
9
  ### 1.2.5 (July 21st, 2023)
2
10
 
3
11
  - up deps
package/README.md CHANGED
@@ -1,12 +1,14 @@
1
1
  # resource-base-interface
2
2
 
3
- [![Version][version]](https://www.npmjs.com/package/@restorecommerce/resource-base-interface)[![Build Status][build]](https://travis-ci.org/restorecommerce/resource-base-interface?branch=master)[![Dependencies][depend]](https://david-dm.org/restorecommerce/resource-base-interface)[![Coverage Status][cover]](https://coveralls.io/github/restorecommerce/resource-base-interface?branch=master)
3
+ [![Version][version]](https://www.npmjs.com/package/@restorecommerce/resource-base-interface)[![Build Status][build]](https://img.shields.io/github/actions/workflow/status/restorecommerce/resource-base-interface/build.yaml?style=flat-square)[![Dependencies][depend]](https://david-dm.org/restorecommerce/resource-base-interface)[![Coverage Status][cover]](https://coveralls.io/github/restorecommerce/resource-base-interface?branch=master)
4
4
 
5
5
  [version]: http://img.shields.io/npm/v/@restorecommerce/resource-base-interface.svg?style=flat-square
6
- [build]: http://img.shields.io/travis/restorecommerce/resource-base-interface/master.svg?style=flat-square
6
+ [build]: https://img.shields.io/github/actions/workflow/status/restorecommerce/resource-base-interface/build.yaml?style=flat-square
7
7
  [depend]: https://img.shields.io/david/restorecommerce/resource-base-interface.svg?style=flat-square
8
8
  [cover]: http://img.shields.io/coveralls/restorecommerce/resource-base-interface/master.svg?style=flat-square
9
9
 
10
+ https://github.com/restorecommerce/notification-srv/actions/workflows/build.yaml[image:https://img.shields.io/github/actions/workflow/status/restorecommerce/notification-srv/build.yaml?style=flat-square[Build Status]]
11
+
10
12
  The `resource-base-interface` describes resource CRUD operations which can be bound to a service. Such operations are described via a [gRPC](https://grpc.io/docs/) interface with the message structures therefore being defined using [Protocol Buffers](https://developers.google.com/protocol-buffers/). This interface can be bound with any protobuf definition as long as it contains the endpoints defined in the [resource-base.proto](https://github.com/restorecommerce/protos/blob/master/io/restorecommerce/resource_base.proto) file (note that any resource message structure can be defined).
11
13
 
12
14
  The exposed gRPC methods are implemented by the `ServiceBase` object which uses a `ResourceAPI` instance to perform operations with a database provider. The exposed interface is therefore agnostic to a specific database implementation.
@@ -226,4 +228,4 @@ npm install
226
228
  ```sh
227
229
  # compile the code
228
230
  npm run build
229
- ```
231
+ ```
package/lib/core/interfaces.d.ts CHANGED
@@ -40,7 +40,7 @@ export interface DocumentMetadata {
40
40
  created?: any;
41
41
  modified?: any;
42
42
  modified_by?: string;
43
- owners: {
43
+ owners?: {
44
44
  id?: string;
45
45
  value?: string;
46
46
  }[];
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@restorecommerce/resource-base-interface",
3
- "version": "1.2.5",
3
+ "version": "1.4.0",
4
4
  "description": "Restorecommerce Resource Base Interface",
5
5
  "main": "lib/index.js",
6
6
  "author": "n-fuse GmbH",
@@ -17,34 +17,33 @@
17
17
  "interface"
18
18
  ],
19
19
  "dependencies": {
20
- "@restorecommerce/chassis-srv": "^1.2.5",
21
- "@restorecommerce/grpc-client": "^2.0.2",
22
- "@restorecommerce/kafka-client": "^1.0.16",
23
- "@restorecommerce/rc-grpc-clients": "^5.0.0",
24
- "@restorecommerce/service-config": "^1.0.6",
20
+ "@restorecommerce/chassis-srv": "^1.4.0",
21
+ "@restorecommerce/grpc-client": "^2.0.4",
22
+ "@restorecommerce/kafka-client": "^1.1.3",
23
+ "@restorecommerce/rc-grpc-clients": "^5.1.3",
24
+ "@restorecommerce/service-config": "^1.0.7",
25
25
  "lodash": "^4.17.21",
26
- "redis": "^4.6.7"
26
+ "redis": "^4.6.10"
27
27
  },
28
28
  "devDependencies": {
29
- "@types/lodash": "^4.14.195",
30
- "@types/mocha": "^10.0.1",
29
+ "@types/lodash": "^4.14.199",
30
+ "@types/mocha": "^10.0.2",
31
31
  "@types/redis": "^4.0.11",
32
- "@typescript-eslint/eslint-plugin": "^6.1.0",
33
- "@typescript-eslint/eslint-plugin-tslint": "^6.1.0",
34
- "@typescript-eslint/parser": "^6.1.0",
35
- "arangojs": "^8.4.0",
32
+ "@typescript-eslint/eslint-plugin": "^6.7.4",
33
+ "@typescript-eslint/eslint-plugin-tslint": "^6.7.4",
34
+ "@typescript-eslint/parser": "^6.7.4",
35
+ "arangojs": "^8.4.1",
36
36
  "cross-env": "^7.0.3",
37
- "eslint": "^8.45.0",
37
+ "eslint": "^8.51.0",
38
38
  "eslint-plugin-prefer-arrow-functions": "^3.1.4",
39
39
  "mocha": "^10.2.0",
40
40
  "npm-run-all": "^4.1.5",
41
41
  "nyc": "^15.1.0",
42
- "rimraf": "^5.0.1",
42
+ "rimraf": "^5.0.5",
43
43
  "should": "^13.2.3",
44
- "sleep": "^6.3.0",
45
44
  "ts-node": "^10.9.1",
46
45
  "tslint": "^6.1.3",
47
- "typescript": "^5.1.6"
46
+ "typescript": "^5.2.2"
48
47
  },
49
48
  "scripts": {
50
49
  "test": "npm run lint && nyc npm run mocha",
@@ -61,6 +60,6 @@
61
60
  "build": "npm-run-all lint build:clean build:tsc"
62
61
  },
63
62
  "engines": {
64
- "node": ">= 12.0.0"
63
+ "node": ">= 18.8.0"
65
64
  }
66
65
  }