@rapidrest/service-core 1.0.0-beta.1

package/docs/reference/interfaces/TruncateRequestOptions.md

@@ -0,0 +1,175 @@
+[**@rapidrest/service-core**](../README.md)
+
+***
+
+[@rapidrest/service-core](../globals.md) / TruncateRequestOptions
+
+# Interface: TruncateRequestOptions
+
+Defined in: [src/routes/ModelRoute.ts:72](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/routes/ModelRoute.ts#L72)
+
+The set of options required by truncate request handlers.
+
+## Extends
+
+- [`DeleteRequestOptions`](DeleteRequestOptions.md)
+
+## Properties
+
+### ignoreACL?
+
+> `optional` **ignoreACL?**: `boolean`
+
+Defined in: [src/models/RepoUtils.ts:32](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/models/RepoUtils.ts#L32)
+
+Set to `true` to ignore the ACL permissions check.
+
+#### Inherited from
+
+[`DeleteRequestOptions`](DeleteRequestOptions.md).[`ignoreACL`](DeleteRequestOptions.md#ignoreacl)
+
+***
+
+### params
+
+> **params**: `any`
+
+Defined in: [src/routes/ModelRoute.ts:74](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/routes/ModelRoute.ts#L74)
+
+The list of URL parameters to use in the search.
+
+***
+
+### productUid?
+
+> `optional` **productUid?**: `string`
+
+Defined in: [src/routes/ModelRoute.ts:48](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/routes/ModelRoute.ts#L48)
+
+The desired product uid of the resource to delete.
+
+#### Inherited from
+
+[`DeleteRequestOptions`](DeleteRequestOptions.md).[`productUid`](DeleteRequestOptions.md#productuid)
+
+***
+
+### purge?
+
+> `optional` **purge?**: `boolean`
+
+Defined in: [src/routes/ModelRoute.ts:50](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/routes/ModelRoute.ts#L50)
+
+Set to true to permanently remove the object from the database (if applicable).
+
+#### Inherited from
+
+[`DeleteRequestOptions`](DeleteRequestOptions.md).[`purge`](DeleteRequestOptions.md#purge)
+
+***
+
+### pushChannels?
+
+> `optional` **pushChannels?**: `string`[]
+
+Defined in: [src/routes/ModelRoute.ts:76](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/routes/ModelRoute.ts#L76)
+
+An additional list of channel names to send push notifications to.
+
+#### Overrides
+
+[`DeleteRequestOptions`](DeleteRequestOptions.md).[`pushChannels`](DeleteRequestOptions.md#pushchannels)
+
+***
+
+### query
+
+> **query**: `any`
+
+Defined in: [src/routes/ModelRoute.ts:78](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/routes/ModelRoute.ts#L78)
+
+The list of query parameters to use in the search.
+
+***
+
+### recordEvent?
+
+> `optional` **recordEvent?**: `boolean`
+
+Defined in: [src/models/RepoUtils.ts:36](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/models/RepoUtils.ts#L36)
+
+Indicates if a telemetry event should be broadcast for the request.
+
+#### Inherited from
+
+[`DeleteRequestOptions`](DeleteRequestOptions.md).[`recordEvent`](DeleteRequestOptions.md#recordevent)
+
+***
+
+### req?
+
+> `optional` **req?**: `HttpRequest`
+
+Defined in: [src/routes/ModelRoute.ts:27](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/routes/ModelRoute.ts#L27)
+
+The originating client request.
+
+#### Inherited from
+
+[`DeleteRequestOptions`](DeleteRequestOptions.md).[`req`](DeleteRequestOptions.md#req)
+
+***
+
+### res?
+
+> `optional` **res?**: `HttpResponse`
+
+Defined in: [src/routes/ModelRoute.ts:29](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/routes/ModelRoute.ts#L29)
+
+The outgoing client response.
+
+#### Inherited from
+
+[`DeleteRequestOptions`](DeleteRequestOptions.md).[`res`](DeleteRequestOptions.md#res)
+
+***
+
+### skipPush?
+
+> `optional` **skipPush?**: `boolean`
+
+Defined in: [src/routes/ModelRoute.ts:80](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/routes/ModelRoute.ts#L80)
+
+Set to `true` to not send a push notification.
+
+#### Overrides
+
+[`DeleteRequestOptions`](DeleteRequestOptions.md).[`skipPush`](DeleteRequestOptions.md#skippush)
+
+***
+
+### user?
+
+> `optional` **user?**: `JWTUser`
+
+Defined in: [src/models/RepoUtils.ts:40](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/models/RepoUtils.ts#L40)
+
+The authenticated user making the request.
+
+#### Inherited from
+
+[`DeleteRequestOptions`](DeleteRequestOptions.md).[`user`](DeleteRequestOptions.md#user)
+
+***
+
+### version?
+
+> `optional` **version?**: `string` \| `number`
+
+Defined in: [src/routes/ModelRoute.ts:56](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/routes/ModelRoute.ts#L56)
+
+The desired version number of the resource to delete.
+
+#### Inherited from
+
+[`DeleteRequestOptions`](DeleteRequestOptions.md).[`version`](DeleteRequestOptions.md#version)

package/docs/reference/interfaces/UpdateRequestOptions.md

@@ -0,0 +1,149 @@
+[**@rapidrest/service-core**](../README.md)
+
+***
+
+[@rapidrest/service-core](../globals.md) / UpdateRequestOptions
+
+# Interface: UpdateRequestOptions\<T\>
+
+Defined in: [src/routes/ModelRoute.ts:89](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/routes/ModelRoute.ts#L89)
+
+The set of options required by update request handlers.
+
+## Extends
+
+- [`RequestOptions`](RequestOptions.md)
+
+## Type Parameters
+
+### T
+
+`T` *extends* [`BaseEntity`](../classes/BaseEntity.md) \| [`SimpleEntity`](../classes/SimpleEntity.md)
+
+## Properties
+
+### existing?
+
+> `optional` **existing?**: `T` \| `null`
+
+Defined in: [src/routes/ModelRoute.ts:91](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/routes/ModelRoute.ts#L91)
+
+The existing object that has already been recently pulled from the datastore.
+
+***
+
+### ignoreACL?
+
+> `optional` **ignoreACL?**: `boolean`
+
+Defined in: [src/models/RepoUtils.ts:32](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/models/RepoUtils.ts#L32)
+
+Set to `true` to ignore the ACL permissions check.
+
+#### Inherited from
+
+[`RequestOptions`](RequestOptions.md).[`ignoreACL`](RequestOptions.md#ignoreacl)
+
+***
+
+### productUid?
+
+> `optional` **productUid?**: `string`
+
+Defined in: [src/routes/ModelRoute.ts:93](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/routes/ModelRoute.ts#L93)
+
+The desired product uid of the resource to update.
+
+***
+
+### pushChannels?
+
+> `optional` **pushChannels?**: `string`[]
+
+Defined in: [src/routes/ModelRoute.ts:95](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/routes/ModelRoute.ts#L95)
+
+An additional list of channel names to send push notifications to.
+
+#### Overrides
+
+[`RequestOptions`](RequestOptions.md).[`pushChannels`](RequestOptions.md#pushchannels)
+
+***
+
+### recordEvent?
+
+> `optional` **recordEvent?**: `boolean`
+
+Defined in: [src/models/RepoUtils.ts:36](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/models/RepoUtils.ts#L36)
+
+Indicates if a telemetry event should be broadcast for the request.
+
+#### Inherited from
+
+[`RequestOptions`](RequestOptions.md).[`recordEvent`](RequestOptions.md#recordevent)
+
+***
+
+### req?
+
+> `optional` **req?**: `HttpRequest`
+
+Defined in: [src/routes/ModelRoute.ts:27](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/routes/ModelRoute.ts#L27)
+
+The originating client request.
+
+#### Inherited from
+
+[`RequestOptions`](RequestOptions.md).[`req`](RequestOptions.md#req)
+
+***
+
+### res?
+
+> `optional` **res?**: `HttpResponse`
+
+Defined in: [src/routes/ModelRoute.ts:29](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/routes/ModelRoute.ts#L29)
+
+The outgoing client response.
+
+#### Inherited from
+
+[`RequestOptions`](RequestOptions.md).[`res`](RequestOptions.md#res)
+
+***
+
+### skipPush?
+
+> `optional` **skipPush?**: `boolean`
+
+Defined in: [src/routes/ModelRoute.ts:97](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/routes/ModelRoute.ts#L97)
+
+Set to `true` to not send a push notification.
+
+#### Overrides
+
+[`RequestOptions`](RequestOptions.md).[`skipPush`](RequestOptions.md#skippush)
+
+***
+
+### user?
+
+> `optional` **user?**: `JWTUser`
+
+Defined in: [src/models/RepoUtils.ts:40](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/models/RepoUtils.ts#L40)
+
+The authenticated user making the request.
+
+#### Inherited from
+
+[`RequestOptions`](RequestOptions.md).[`user`](RequestOptions.md#user)
+
+***
+
+### version?
+
+> `optional` **version?**: `string` \| `number`
+
+Defined in: [src/routes/ModelRoute.ts:99](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/routes/ModelRoute.ts#L99)
+
+The desired version number of the resource to update.

package/docs/reference/type-aliases/OneOrMany.md

@@ -0,0 +1,19 @@
+[**@rapidrest/service-core**](../README.md)
+
+***
+
+[@rapidrest/service-core](../globals.md) / OneOrMany
+
+# Type Alias: OneOrMany\<T\>
+
+> **OneOrMany**\<`T`\> = `T` \| `T`[]
+
+Defined in: [src/Types.ts:4](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/Types.ts#L4)
+
+Provides an explicit type declaration for `T | T[]`.
+
+## Type Parameters
+
+### T
+
+`T`

package/docs/reference/type-aliases/OneOrNull.md

@@ -0,0 +1,19 @@
+[**@rapidrest/service-core**](../README.md)
+
+***
+
+[@rapidrest/service-core](../globals.md) / OneOrNull
+
+# Type Alias: OneOrNull\<T\>
+
+> **OneOrNull**\<`T`\> = `T` \| `null`
+
+Defined in: [src/Types.ts:9](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/Types.ts#L9)
+
+Provides an explicit type declaration for `T | null`.
+
+## Type Parameters
+
+### T
+
+`T`

package/docs/reference/type-aliases/PartialBaseEntity.md

@@ -0,0 +1,17 @@
+[**@rapidrest/service-core**](../README.md)
+
+***
+
+[@rapidrest/service-core](../globals.md) / PartialBaseEntity
+
+# Type Alias: PartialBaseEntity\<T\>
+
+> **PartialBaseEntity**\<`T`\> = `Partial`\<`T`\> & `Pick`\<`T`, `"uid"`\> & `Pick`\<`T`, `"version"`\>
+
+Defined in: [src/models/BaseEntity.ts:68](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/models/BaseEntity.ts#L68)
+
+## Type Parameters
+
+### T
+
+`T` *extends* [`BaseEntity`](../classes/BaseEntity.md)

package/docs/reference/type-aliases/PartialSimpleEntity.md

@@ -0,0 +1,17 @@
+[**@rapidrest/service-core**](../README.md)
+
+***
+
+[@rapidrest/service-core](../globals.md) / PartialSimpleEntity
+
+# Type Alias: PartialSimpleEntity\<T\>
+
+> **PartialSimpleEntity**\<`T`\> = `Partial`\<`T`\> & `Pick`\<`T`, `"uid"`\>
+
+Defined in: [src/models/SimpleEntity.ts:33](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/models/SimpleEntity.ts#L33)
+
+## Type Parameters
+
+### T
+
+`T` *extends* [`SimpleEntity`](../classes/SimpleEntity.md)

package/docs/reference/type-aliases/UpdateObject.md

@@ -0,0 +1,19 @@
+[**@rapidrest/service-core**](../README.md)
+
+***
+
+[@rapidrest/service-core](../globals.md) / UpdateObject
+
+# Type Alias: UpdateObject\<T\>
+
+> **UpdateObject**\<`T`\> = `Partial`\<`T`\> & `Pick`\<`T`, `"uid"`\>
+
+Defined in: [src/routes/ModelRoute.ts:84](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/routes/ModelRoute.ts#L84)
+
+A Partial type for a BaseEntity or SimpleEntity.
+
+## Type Parameters
+
+### T
+
+`T` *extends* [`BaseEntity`](../classes/BaseEntity.md) \| [`SimpleEntity`](../classes/SimpleEntity.md)

package/package.json

@@ -0,0 +1,125 @@
+{
+    "name": "@rapidrest/service-core",
+    "version": "1.0.0-beta.1",
+    "description": "Provides all core functionality for RapidREST based backend services.",
+    "repository": "https://github.com/rapidrest/service-core.git",
+    "author": "RapidREST <rapidrests@gmail.com>",
+    "license": "MIT",
+    "contributors": [
+        "Jean-Philippe Steinmetz",
+        "Arthur Thompson",
+        "Thomas Buscaglia"
+    ],
+    "scripts": {
+        "build": "yarn lint && rimraf dist && tsc",
+        "deploy-docs": "ts-node tools/gh-pages-publish",
+        "docs": "typedoc --plugin typedoc-plugin-markdown --out docs/reference src",
+        "lint": "eslint ./src ./test",
+        "local-audit": "yarn install && yarn npm audit -A -R \"$@\"",
+        "checkup": "yarn dlx @yarnpkg/doctor \"$@\"",
+        "dependency-check": "yarn dlx depcheck \"$@\"",
+        "report-coverage": "cat ./coverage/lcov.info | coveralls",
+        "test": "vitest run",
+        "test:prod": "npm run lint && vitest run --coverage",
+        "test:watch": "vitest",
+        "postversion": "git push && git push --tags"
+    },
+    "dependencies": {
+        "axios": "^1.17.0",
+        "bson": "^7.2.0",
+        "dayjs": "^1.11.21",
+        "deepmerge": "^4.3.1",
+        "node-schedule": "^2.1.1",
+        "uWebSockets.js": "uNetworking/uWebSockets.js#v20.68.0",
+        "winston-transport": "^4.9.0",
+        "ws": "^8.21.0"
+    },
+    "peerDependencies": {
+        "@rapidrest/core": "1.x",
+        "ioredis": "5.x",
+        "lodash": "4.x",
+        "mongodb": "^7.0.0",
+        "openapi3-ts": "4.x",
+        "prom-client": "15.x",
+        "reflect-metadata": "0.2.x",
+        "typeorm": "0.3.x",
+        "uWebSockets.js": "*",
+        "winston": "3.x"
+    },
+    "peerDependenciesMeta": {
+        "ioredis": {
+            "optional": true
+        },
+        "mongodb": {
+            "optional": true
+        },
+        "typeorm": {
+            "optional": true
+        }
+    },
+    "devDependencies": {
+        "@rapidrest/core": "^1.2.0",
+        "@swc/core": "^1.15.41",
+        "@types/ioredis-mock": "^8.2.7",
+        "@types/node": "^25.9.2",
+        "@types/node-schedule": "^2.1.8",
+        "@types/rimraf": "^4.0.5",
+        "@types/sqlite3": "^5.1.0",
+        "@types/uuid": "^11.0.0",
+        "@types/ws": "^8.18.1",
+        "@typescript-eslint/eslint-plugin": "^8.61.0",
+        "@typescript-eslint/parser": "^8.61.0",
+        "@vitest/coverage-v8": "^4.1.8",
+        "coveralls": "^3.1.1",
+        "eslint": "^10.4.1",
+        "eslint-config-prettier": "^10.1.8",
+        "eslint-plugin-import": "^2.32.0",
+        "eslint-plugin-jsdoc": "^63.0.2",
+        "globals": "^17.6.0",
+        "ioredis": "^5.11.1",
+        "ioredis-mock": "^8.13.1",
+        "lodash": "^4.18.1",
+        "mongodb": "^7.3.0",
+        "mongodb-memory-server": "^11.2.0",
+        "nconf": "^0.13.0",
+        "openapi3-ts": "^4.6.0",
+        "pg": "^8.21.0",
+        "prom-client": "^15.1.3",
+        "reflect-metadata": "^0.2.2",
+        "rimraf": "^6.1.3",
+        "sqlite3": "^6.0.1",
+        "ts-node": "^10.9.2",
+        "typedoc": "^0.28.19",
+        "typedoc-plugin-markdown": "^4.12.0",
+        "typeorm": "^0.3.20",
+        "typescript": "^6.0.3",
+        "unplugin-swc": "^1.5.9",
+        "uuid": "^14.0.0",
+        "vitest": "^4.1.8",
+        "winston": "^3.19.0",
+        "ws": "^8.21.0"
+    },
+    "resolutions": {
+        "cross-spawn": "^7.0.5"
+    },
+    "packageManager": "yarn@4.5.3",
+    "engines": {
+        "node": ">=24.0.0"
+    },
+    "publishConfig": {
+        "registry": "https://registry.npmjs.org/"
+    },
+    "type": "module",
+    "main": "dist/lib/index.js",
+    "exports": {
+        ".": {
+            "import": "./dist/lib/index.js",
+            "types": "./dist/types/index.d.ts"
+        }
+    },
+    "typings": "dist/types/index.d.ts",
+    "files": [
+        "dist",
+        "docs"
+    ]
+}