npm - @rapidrest/service-core - Versions diffs - 1.0.0-rc.7 → 1.0.0 - Mend

@rapidrest/service-core 1.0.0-rc.7 → 1.0.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 (380) hide show

package/docs/reference/classes/RepoUtils.md DELETED Viewed

@@ -1,482 +0,0 @@
-[**@rapidrest/service-core**](../README.md)
-***
-[@rapidrest/service-core](../globals.md) / RepoUtils
-# Class: RepoUtils\<T\>
-Defined in: [src/models/RepoUtils.ts:83](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/models/RepoUtils.ts#L83)
-## Author
-Jean-Philippe Steinmetz
-## Type Parameters
-### T
-`T` *extends* [`BaseEntity`](BaseEntity.md) \| [`SimpleEntity`](SimpleEntity.md)
-## Constructors
-### Constructor
-> **new RepoUtils**\<`T`\>(`modelClass`, `repo?`): `RepoUtils`\<`T`\>
-Defined in: [src/models/RepoUtils.ts:117](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/models/RepoUtils.ts#L117)
-#### Parameters
-##### modelClass
-`any`
-##### repo?
-`Repository`\<`T`\> \| [`MongoRepository`](MongoRepository.md)\<`T`\>
-#### Returns
-`RepoUtils`\<`T`\>
-## Properties
-### aclUtils?
-> `protected` `optional` **aclUtils?**: [`ACLUtils`](ACLUtils.md)
-Defined in: [src/models/RepoUtils.ts:85](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/models/RepoUtils.ts#L85)
-***
-### cacheClient?
-> `protected` `optional` **cacheClient?**: `Redis`
-Defined in: [src/models/RepoUtils.ts:89](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/models/RepoUtils.ts#L89)
-The redis client that will be used as a 2nd level cache for all cacheable models.
-***
-### config
-> `protected` **config**: `any`
-Defined in: [src/models/RepoUtils.ts:92](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/models/RepoUtils.ts#L92)
-***
-### connectionManager?
-> `protected` `optional` **connectionManager?**: [`ConnectionManager`](ConnectionManager.md)
-Defined in: [src/models/RepoUtils.ts:95](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/models/RepoUtils.ts#L95)
-***
-### defaultACLUid
-> **defaultACLUid**: `string` = `""`
-Defined in: [src/models/RepoUtils.ts:98](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/models/RepoUtils.ts#L98)
-The unique identifier of the default ACL for the model type.
-***
-### logger
-> `protected` **logger**: `any`
-Defined in: [src/models/RepoUtils.ts:101](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/models/RepoUtils.ts#L101)
-***
-### modelClass
-> `protected` **modelClass**: `any`
-Defined in: [src/models/RepoUtils.ts:103](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/models/RepoUtils.ts#L103)
-***
-### notificationUtils?
-> `protected` `optional` **notificationUtils?**: [`NotificationUtils`](NotificationUtils.md)
-Defined in: [src/models/RepoUtils.ts:109](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/models/RepoUtils.ts#L109)
-***
-### objectFactory?
-> `protected` `optional` **objectFactory?**: [`ObjectFactory`](ObjectFactory.md)
-Defined in: [src/models/RepoUtils.ts:106](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/models/RepoUtils.ts#L106)
-***
-### repo?
-> `optional` **repo?**: `Repository`\<`T`\> \| [`MongoRepository`](MongoRepository.md)\<`T`\>
-Defined in: [src/models/RepoUtils.ts:112](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/models/RepoUtils.ts#L112)
-The model class associated with the controller to perform operations against.
-***
-### trustedRoles
-> `protected` **trustedRoles**: `string`[]
-Defined in: [src/models/RepoUtils.ts:115](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/models/RepoUtils.ts#L115)
-## Accessors
-### baseCacheKey
-#### Get Signature
-> **get** **baseCacheKey**(): `string`
-Defined in: [src/models/RepoUtils.ts:193](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/models/RepoUtils.ts#L193)
-The base key used to get or set data in the cache.
-##### Returns
-`string`
-## Methods
-### count()
-> **count**(`query`, `options?`): `Promise`\<`number`\>
-Defined in: [src/models/RepoUtils.ts:197](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/models/RepoUtils.ts#L197)
-#### Parameters
-##### query
-`any`
-##### options?
-[`RepoFindOptions`](../interfaces/RepoFindOptions.md)
-#### Returns
-`Promise`\<`number`\>
-***
-### create()
-> **create**(`obj`, `options?`): `Promise`\<`T`\>
-Defined in: [src/models/RepoUtils.ts:233](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/models/RepoUtils.ts#L233)
-Stores a new record of the provided object in the datastore. Performs pre-processing, permission checks against
-the class ACL, cache seeding, telemetry recording and push notifications.
-#### Parameters
-##### obj
-`Partial`\<`T`\>
-The object to store.
-##### options?
-[`RepoCreateOptions`](../interfaces/RepoCreateOptions.md)
-#### Returns
-`Promise`\<`T`\>
-***
-### delete()
-> **delete**(`uid`, `options`): `Promise`\<`void`\>
-Defined in: [src/models/RepoUtils.ts:324](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/models/RepoUtils.ts#L324)
-#### Parameters
-##### uid
-`string`
-##### options
-[`RepoDeleteOptions`](../interfaces/RepoDeleteOptions.md)
-#### Returns
-`Promise`\<`void`\>
-***
-### find()
-> **find**(`query`, `options?`): `Promise`\<`T`[]\>
-Defined in: [src/models/RepoUtils.ts:393](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/models/RepoUtils.ts#L393)
-Retrieves an array of objects from the datastore matching the given search query. This function will first
-attempt to look up the results in the cache. Also checks ACLs for READ permission.
-#### Parameters
-##### query
-`any`
-The constructed search query to run.
-##### options?
-[`RepoFindOptions`](../interfaces/RepoFindOptions.md)
-The additional options to consider during the search.
-#### Returns
-`Promise`\<`T`[]\>
-***
-### findOne()
-> **findOne**(`id`, `options?`): `Promise`\<`T` \| `undefined`\>
-Defined in: [src/models/RepoUtils.ts:519](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/models/RepoUtils.ts#L519)
-Retrieves the object with the given id from either the cache or the database. If retrieving from the database
-the cache is populated to speed up subsequent requests.
-#### Parameters
-##### id
-`string`
-The unique identifier of the object to retrieve.
-##### options?
-[`RepoFindOptions`](../interfaces/RepoFindOptions.md)
-The additional options to consider during the search.
-#### Returns
-`Promise`\<`T` \| `undefined`\>
-***
-### getClassType()
-> **getClassType**(`obj`): `any`
-Defined in: [src/models/RepoUtils.ts:599](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/models/RepoUtils.ts#L599)
-Returns the class type (constructor) for the given object. This uses the `_fqn` or `_type` property of `obj` to
-identify the class. If neither property is defined `modelClass` is assumed.
-#### Parameters
-##### obj
-`any`
-The object whose class type to look up.
-#### Returns
-`any`
-The class type (constructor) associated with the given object.
-***
-### getDefaultACL()
-> **getDefaultACL**(): [`AccessControlList`](../interfaces/AccessControlList.md) \| `undefined`
-Defined in: [src/models/RepoUtils.ts:568](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/models/RepoUtils.ts#L568)
-Returns the default access control list governing the model type. Returning a value of `undefined` will grant
-full acccess to any user (including unauthenticated anonymous users).
-#### Returns
-[`AccessControlList`](../interfaces/AccessControlList.md) \| `undefined`
-***
-### hashQuery()
-> **hashQuery**(`query`): `string`
-Defined in: [src/models/RepoUtils.ts:587](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/models/RepoUtils.ts#L587)
-Hashes the given query object to a unique string.
-#### Parameters
-##### query
-`any`
-The query object to hash.
-#### Returns
-`string`
-***
-### init()
-> `protected` **init**(): `Promise`\<`void`\>
-Defined in: [src/models/RepoUtils.ts:123](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/models/RepoUtils.ts#L123)
-#### Returns
-`Promise`\<`void`\>
-***
-### instantiateObject()
-> **instantiateObject**(`obj`, `clazz?`): `T`
-Defined in: [src/models/RepoUtils.ts:616](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/models/RepoUtils.ts#L616)
-Creates a new instance of obj scoped to the correct model class or sub-class.
-#### Parameters
-##### obj
-`any`
-##### clazz?
-`any`
-#### Returns
-`T`
-***
-### searchIdQuery()
-> **searchIdQuery**(`id`, `version?`): `any`
-Defined in: [src/models/RepoUtils.ts:629](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/models/RepoUtils.ts#L629)
-Search for existing object based on passed in id and version and product uid.
-The result of this function is compatible with all `Repository.find()` functions.
-#### Parameters
-##### id
-`string`
-##### version?
-`string` \| `number`
-#### Returns
-`any`
-***
-### truncate()
-> **truncate**(`query`, `options`): `Promise`\<`void`\>
-Defined in: [src/models/RepoUtils.ts:638](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/models/RepoUtils.ts#L638)
-#### Parameters
-##### query
-`any`
-##### options
-[`RepoFindOptions`](../interfaces/RepoFindOptions.md)
-#### Returns
-`Promise`\<`void`\>
-***
-### update()
-> **update**(`obj`, `existing`, `options?`): `Promise`\<`T`\>
-Defined in: [src/models/RepoUtils.ts:706](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/models/RepoUtils.ts#L706)
-#### Parameters
-##### obj
-`Partial`\<`T`\>
-##### existing
-`T`
-##### options?
-[`RepoUpdateOptions`](../interfaces/RepoUpdateOptions.md)\<`T`\>
-#### Returns
-`Promise`\<`T`\>
-***
-### validate()
-> **validate**(`objs`, `options?`): `Promise`\<`void`\>
-Defined in: [src/models/RepoUtils.ts:859](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/models/RepoUtils.ts#L859)
-Performs validation on the object(s) provided. This function first calls `ObjectUtils.validate()` to check
-any class level defined validation functions. Second, it scans for any properties with the `@Reference`
-decorator and attempts to verify that an existing object for the given reference ID is valid.
-#### Parameters
-##### objs
-`Partial`\<`T`\> \| `Partial`\<`T`\>[]
-The object(s) to validate.
-##### options?
-[`RepoOperationOptions`](../interfaces/RepoOperationOptions.md)
-The optional set of arguments that can be passed to perform additonal checks.
-#### Returns
-`Promise`\<`void`\>

package/docs/reference/classes/RouteUtils.md DELETED Viewed

@@ -1,191 +0,0 @@
-[**@rapidrest/service-core**](../README.md)
-***
-[@rapidrest/service-core](../globals.md) / RouteUtils
-# Class: RouteUtils
-Defined in: [src/routes/RouteUtils.ts:22](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/routes/RouteUtils.ts#L22)
-Provides a set of utilities for converting Route classes to HTTP middleware.
-## Author
-Jean-Philippe Steinmetz <rapidrests@gmail.com>
-## Constructors
-### Constructor
-> **new RouteUtils**(): `RouteUtils`
-#### Returns
-`RouteUtils`
-## Methods
-### checkRequiredPerms()
-> **checkRequiredPerms**(`aclUid`): [`RequestHandler`](../type-aliases/RequestHandler.md)
-Defined in: [src/routes/RouteUtils.ts:39](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/routes/RouteUtils.ts#L39)
-Creates a middleware function that verifies the incoming request is from a valid user with at least
-one of the specified roles.
-#### Parameters
-##### aclUid
-`string`
-#### Returns
-[`RequestHandler`](../type-aliases/RequestHandler.md)
-***
-### checkRequiredRoles()
-> **checkRequiredRoles**(`requiredRoles`): [`RequestHandler`](../type-aliases/RequestHandler.md)
-Defined in: [src/routes/RouteUtils.ts:66](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/routes/RouteUtils.ts#L66)
-Creates a middleware function that verifies the incoming request is from a valid user with at least
-one of the specified roles.
-#### Parameters
-##### requiredRoles
-`string`[]
-The list of roles that the authenticated user must have.
-#### Returns
-[`RequestHandler`](../type-aliases/RequestHandler.md)
-***
-### getFuncArray()
-> **getFuncArray**(`route`, `funcs`, `send?`): [`RequestHandler`](../type-aliases/RequestHandler.md)[]
-Defined in: [src/routes/RouteUtils.ts:91](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/routes/RouteUtils.ts#L91)
-Converts the given array of string or Function objects to functions bound to the given route object.
-#### Parameters
-##### route
-`any`
-The route object that the list of functions is bound to.
-##### funcs
-(`string` \| `Function`)[]
-The array of functions (or function names) to return.
-##### send?
-`boolean` = `false`
-Set to true to have the last wrapped function send its payload to the client.
-#### Returns
-[`RequestHandler`](../type-aliases/RequestHandler.md)[]
-An array of Function objects mapping to the route object.
-***
-### getRouteMethods()
-> **getRouteMethods**(`route`): `Map`\<`string`, `any`\>
-Defined in: [src/routes/RouteUtils.ts:114](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/routes/RouteUtils.ts#L114)
-Searches an route object for any functions that implement a `@Method` decorator.
-#### Parameters
-##### route
-`any`
-The route object to search.
-#### Returns
-`Map`\<`string`, `any`\>
-The list of `@Method` decorated functions that were found.
-***
-### registerRoute()
-> **registerRoute**(`app`, `route`): `Promise`\<`void`\>
-Defined in: [src/routes/RouteUtils.ts:143](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/routes/RouteUtils.ts#L143)
-Registers the provided route object containing a set of decorated endpoints to the server.
-#### Parameters
-##### app
-`any`
-The HTTP application/router to register the route to.
-##### route
-`any`
-The route object to register.
-#### Returns
-`Promise`\<`void`\>
-***
-### wrapMiddleware()
-> **wrapMiddleware**(`obj`, `func`, `send?`): [`RequestHandler`](../type-aliases/RequestHandler.md)
-Defined in: [src/routes/RouteUtils.ts:324](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/routes/RouteUtils.ts#L324)
-Wraps the provided function with HTTP handling based on the function's defined decorators.
-#### Parameters
-##### obj
-`any`
-The bound object whose middleware function will be wrapped.
-##### func
-`Function`
-The decorated function to wrap.
-##### send?
-`boolean` = `false`
-Set to true to have `func`'s result sent to the client.
-#### Returns
-[`RequestHandler`](../type-aliases/RequestHandler.md)