hcloud-sdk 15.0.0 → 17.0.0

package/changelog.md

@@ -1,45 +1,90 @@
-## [15.0.0](https://github.com/moovit-sp-gmbh/hcloud-sdk-js/compare/v14.13.2...v15.0.0) (2024-11-20)
+## [17.0.0](https://github.com/moovit-sp-gmbh/hcloud-sdk-js/compare/v16.0.0...v17.0.0) (2025-06-04)
 
 ### ⚠ BREAKING CHANGES
 
-* **bouncer:** rework bouncer to use s3 over backend
-* consent check no longer sends OAuthApp
+* rename rush to cosmo
+* add executionId to High5ExecutionPackage
+* fix outdated getStreamExecutionStatus() method
+* fix replace node debug command schema
+* update pool implementation to match teams
 
 ### Features
 
-* add boolean flag to execute stream design ([9d80542](https://github.com/moovit-sp-gmbh/hcloud-sdk-js/commit/9d80542f21349504e1f011fe332d056ecaa9a1d4))
-* add callback-fn support to bouncer ([f6084da](https://github.com/moovit-sp-gmbh/hcloud-sdk-js/commit/f6084da2a7baeaade44b4400343f2e87880c9520))
-* add dedicated endpoint for separate lastURL, lastView update ([bc56e43](https://github.com/moovit-sp-gmbh/hcloud-sdk-js/commit/bc56e43230d196f8d1566a3a9e7fa4fd8e1e59d0))
-* add designPublish method ([41ee277](https://github.com/moovit-sp-gmbh/hcloud-sdk-js/commit/41ee27770ce33ee1bbd463f09b780b0d6568cf98))
-* add featureflags (s3) ([e73f207](https://github.com/moovit-sp-gmbh/hcloud-sdk-js/commit/e73f20766b991aca34d3526c304173ce99e56317))
-* add installerVersion to agents ([bc3bd80](https://github.com/moovit-sp-gmbh/hcloud-sdk-js/commit/bc3bd8009e4f46f6eb73ad5bba11efdf24ae4ff1))
-* add method to obtain OAuthApp by clientID ([e96a0ca](https://github.com/moovit-sp-gmbh/hcloud-sdk-js/commit/e96a0ca2e0372f028357636a827904a9bb58ae6b))
-* add minimumEngineVersion to PatchCatalogDTO ([e248f16](https://github.com/moovit-sp-gmbh/hcloud-sdk-js/commit/e248f1656b3e8275ba1d111743441094e483fba0))
-* add node input error properties ([ae51b64](https://github.com/moovit-sp-gmbh/hcloud-sdk-js/commit/ae51b64e623ae32a778b72bc42a370f5551670c3))
-* add optional IP to mothership hello ([e608585](https://github.com/moovit-sp-gmbh/hcloud-sdk-js/commit/e608585dc0fafa9bc76ec7ec6fbdac828a5d94ca))
-* add optional latest field to wave engine ([24164ac](https://github.com/moovit-sp-gmbh/hcloud-sdk-js/commit/24164ac630ea864142a871a15ed4c9d4690aa145))
-* add optional minimumEngineVersion to WaveCatalog ([70759d2](https://github.com/moovit-sp-gmbh/hcloud-sdk-js/commit/70759d2443c0813db5a6eef60620ca2eb40e8f1d))
-* add start/end date fields to execution patch status interface ([c902e05](https://github.com/moovit-sp-gmbh/hcloud-sdk-js/commit/c902e054e1a6a1f141d8bc529212d95893f4929a))
-* add StreamNodeSpecificationV2 ([6a09846](https://github.com/moovit-sp-gmbh/hcloud-sdk-js/commit/6a098460cce24a9f61c1273d2298dbe50ac473cc))
-* add support for lastCorrelationId ([76401d4](https://github.com/moovit-sp-gmbh/hcloud-sdk-js/commit/76401d44cc49d84c65da57a33d41b9a801f57114))
-* add wave changelog interfaces ([e70ee01](https://github.com/moovit-sp-gmbh/hcloud-sdk-js/commit/e70ee0156554bdeae9eca18d35fa7595ba80ad48))
-* add WAVE_ENGINE_LATEST nats subject ([d6c93f6](https://github.com/moovit-sp-gmbh/hcloud-sdk-js/commit/d6c93f64d79471f37ad28fa05cfe0fcd6fcb9893))
-* add webhook callback method ([d022f2e](https://github.com/moovit-sp-gmbh/hcloud-sdk-js/commit/d022f2ee4c06ac5d7b8a7ef4029501823e22f5e3))
-* **bouncer:** rework bouncer to use s3 over backend ([9b1757e](https://github.com/moovit-sp-gmbh/hcloud-sdk-js/commit/9b1757e440342e03475abe023de959e24fb97eb4))
-* consider undefined specVersion same as 1 ([3385d27](https://github.com/moovit-sp-gmbh/hcloud-sdk-js/commit/3385d274380c3b2b9c1de5e33e2167473b3d7572))
-* extend High5ExecutionPackage ([10d71b2](https://github.com/moovit-sp-gmbh/hcloud-sdk-js/commit/10d71b293d83e93ed232a394cb37f7ee23aeafbd))
-* ignore regionId param on resetPassword ([cec82b7](https://github.com/moovit-sp-gmbh/hcloud-sdk-js/commit/cec82b77d2644f131b7f5f45d78cfaa8bbbb93ed))
-* update StreamNodeSpecifications type ([e1ef726](https://github.com/moovit-sp-gmbh/hcloud-sdk-js/commit/e1ef7262298659bd12e2452455a19c58bc834927))
+* add 'Cosmo' to lastView and entrypoint in GeneralSettings ([7cd2778](https://github.com/moovit-sp-gmbh/hcloud-sdk-js/commit/7cd2778fa6b955a8eff48caeadb85d914eadf8c9))
+* add agentInfo to High5ExecutionStatus interface ([cf066d0](https://github.com/moovit-sp-gmbh/hcloud-sdk-js/commit/cf066d039f5ac71877e17566af997a6088a5a139))
+* add boolean to trigger an overriding of the user agent ([575e192](https://github.com/moovit-sp-gmbh/hcloud-sdk-js/commit/575e1922cc9e3b10918c4fdf0d62a4a9e6bcf0de))
+* add cosmo NATS subjects ([96e04df](https://github.com/moovit-sp-gmbh/hcloud-sdk-js/commit/96e04dfdd8935102c4db6cbbc1a4e1a95508dd82))
+* add debug info to execution status ([0bb3765](https://github.com/moovit-sp-gmbh/hcloud-sdk-js/commit/0bb376538a2062d82ef9a8e8abca249b44526f75))
+* add endpoint to retrieve execution trees ([e690283](https://github.com/moovit-sp-gmbh/hcloud-sdk-js/commit/e69028361a8c37f69d5d9af6938a0320c8b110c1))
+* add executionId to High5ExecutionPackage ([e4d337b](https://github.com/moovit-sp-gmbh/hcloud-sdk-js/commit/e4d337b6ecddde61612f01385389e9f3096c2825))
+* add Friday spaces and db management methods ([7c37979](https://github.com/moovit-sp-gmbh/hcloud-sdk-js/commit/7c37979d23d3a4a45fe50417c09dd77b34a6bd8c))
+* add isPoolExecution to High5ExecutionStatus interface ([ead79ea](https://github.com/moovit-sp-gmbh/hcloud-sdk-js/commit/ead79ea9e4fd72e6dede47581128148b4f07c06f))
+* add IssuedDebugCommand type ([607f058](https://github.com/moovit-sp-gmbh/hcloud-sdk-js/commit/607f0582026d532049cb9db4c76ccfbb1f357762))
+* add new field 'additionConnectorRoot' to StreamSingleNodeResult ([5d74ba2](https://github.com/moovit-sp-gmbh/hcloud-sdk-js/commit/5d74ba229d94f1b3caa71c3df2dd35483b33044a))
+* add new property triggerDetails to streams info type ([b2fdbd0](https://github.com/moovit-sp-gmbh/hcloud-sdk-js/commit/b2fdbd0c88650353fa5c40d381afe4c4187beeba))
+* add optional parameter 'poolName' to ExtendedHigh5ExecutionPackage ([8b0f621](https://github.com/moovit-sp-gmbh/hcloud-sdk-js/commit/8b0f621cb1737daebec7dcfb8c322a17715a34d5))
+* add optional property 'parents' to High5ExecutionRequest and High5ExecutionStatus ([5287b85](https://github.com/moovit-sp-gmbh/hcloud-sdk-js/commit/5287b8544940aa74cf6f2a8d29ecc821f9c1fe13))
+* add parentExecutionSecret to High5ExecutionRequest ([efeae87](https://github.com/moovit-sp-gmbh/hcloud-sdk-js/commit/efeae87f652407d22a4447d8d76504b12450f189))
+* add product FridayDB ([14d17f5](https://github.com/moovit-sp-gmbh/hcloud-sdk-js/commit/14d17f51bdca16b6d475b4aed8d35bde2e3c9689))
+* add product rush ([db8432c](https://github.com/moovit-sp-gmbh/hcloud-sdk-js/commit/db8432cdbdc0044750da79d723e822d4d06e3ea1))
+* add REPLACE_NODE debug command ([432e9d1](https://github.com/moovit-sp-gmbh/hcloud-sdk-js/commit/432e9d1d01a7aa21d46596dfb550546a86c6bfa9))
+* add RestartDebugCommand ([df89bac](https://github.com/moovit-sp-gmbh/hcloud-sdk-js/commit/df89bac47c36f2956b43be0b4bf5fe7de43eb9ae))
+* add scopes for friday and cosmo ([5619a47](https://github.com/moovit-sp-gmbh/hcloud-sdk-js/commit/5619a477e81ed50a04bfad50ce397b9d67ab6733))
+* add service account avatars ([cdbf199](https://github.com/moovit-sp-gmbh/hcloud-sdk-js/commit/cdbf1992fda116e16dbf0b739cae5893b281fe84))
+* add support for adding service accounts pats as agent context ([c965167](https://github.com/moovit-sp-gmbh/hcloud-sdk-js/commit/c965167044a46c760e567d15f2ae9dfbbd532cb9))
+* add support for extendings the frontend configuration ([d5155e4](https://github.com/moovit-sp-gmbh/hcloud-sdk-js/commit/d5155e45f9e8e79593635e7d4983f93911332ddb))
+* add support for service accounts ([edc6b76](https://github.com/moovit-sp-gmbh/hcloud-sdk-js/commit/edc6b765b3eae783d4048aae4aea1c1c6ca41f0c))
+* add targetEmail to ExtendedHigh5ExecutionPackage ([8b8ce66](https://github.com/moovit-sp-gmbh/hcloud-sdk-js/commit/8b8ce66e9a67435be79c9753b4817a0a0e6dfdb7))
+* add triggerSource to High5ExecutionStatus interface ([5458c28](https://github.com/moovit-sp-gmbh/hcloud-sdk-js/commit/5458c280ba2cb829345c8aca50e00e29842453bf))
+* add validator for entity names ([193f4ed](https://github.com/moovit-sp-gmbh/hcloud-sdk-js/commit/193f4ed2277e1f87459721d7787feb8b18bda74b))
+* add waveEngineVersion to High5ExecutionStatus interface ([9aea7a5](https://github.com/moovit-sp-gmbh/hcloud-sdk-js/commit/9aea7a5339383c0ce02e3c347093985041eb0fab))
+* bump version ([7f3a4ea](https://github.com/moovit-sp-gmbh/hcloud-sdk-js/commit/7f3a4eae037f3e410e1f102d790e13a120f1b245))
+* change extends to prefer to load external configuration ([e9891e7](https://github.com/moovit-sp-gmbh/hcloud-sdk-js/commit/e9891e796a1e948a37786e9ebb168450cda1e873))
+* clonse and clear operationsQueue on send to avoid loosing entries ([fc504a4](https://github.com/moovit-sp-gmbh/hcloud-sdk-js/commit/fc504a4216f229da8c26e43b33bf7ebde0e2eab7))
+* export service-accounts from idp index ([e3777df](https://github.com/moovit-sp-gmbh/hcloud-sdk-js/commit/e3777df5d8b50a02002ab70683ae5f87793736d4))
+* **helper:** add namespace entitiy to validation helper ([3254e16](https://github.com/moovit-sp-gmbh/hcloud-sdk-js/commit/3254e1628bca226e2eea2790539e74a875350068))
+* introduce callbackEnabled propery to webhook crud instances ([00b592d](https://github.com/moovit-sp-gmbh/hcloud-sdk-js/commit/00b592d18af3649e3896ba6ebdff2509ddb5bb91))
+* introduce color and nodeType in nodeInfo, streamNode and node interface ([95a6a24](https://github.com/moovit-sp-gmbh/hcloud-sdk-js/commit/95a6a24308975113090e1eddec168cae1765c9a8))
+* make nodeResult.info.catalog optional ([ff27ce8](https://github.com/moovit-sp-gmbh/hcloud-sdk-js/commit/ff27ce8e099b6f59bab5e3e0e569f79db8de8d76))
+* **nats:** rework cosmo nats subjects to follow old style ([4666ba0](https://github.com/moovit-sp-gmbh/hcloud-sdk-js/commit/4666ba04e9320211eda49266b6b249c3480bce62))
+* rename rush to cosmo ([0517e98](https://github.com/moovit-sp-gmbh/hcloud-sdk-js/commit/0517e98718a47364c4f063e8b4a36a16263d6b83))
+* rework service-account search method to be aligned with all searches ([feefb80](https://github.com/moovit-sp-gmbh/hcloud-sdk-js/commit/feefb807f87b1759e100cc6cc6d1b358857c53e2))
+* update pool implementation to match teams ([37af970](https://github.com/moovit-sp-gmbh/hcloud-sdk-js/commit/37af970251a68fabfd2059c250da9c33966c8c08))
 
-### Performance Improvements
+### Bug Fixes
 
-* define methods in proto instead of instance ([ea6e551](https://github.com/moovit-sp-gmbh/hcloud-sdk-js/commit/ea6e551235fa1d18d59793f157993f363ef14860))
-* lazily initialize services ([495da13](https://github.com/moovit-sp-gmbh/hcloud-sdk-js/commit/495da13edf611a1d9125d2a75a1de9c65ab6d902))
+* append missing /debug to issueDebugCommand target url ([6a5a632](https://github.com/moovit-sp-gmbh/hcloud-sdk-js/commit/6a5a632f0ede6012471df0a340607ce0680204e6))
+* change variable in nats subjects to base64 encdoded versions ([d4315f7](https://github.com/moovit-sp-gmbh/hcloud-sdk-js/commit/d4315f7389cb426824e2567b204b94269838e67d))
+* cosmo NATS subjects ([d9b1b9c](https://github.com/moovit-sp-gmbh/hcloud-sdk-js/commit/d9b1b9c0428ac5b2b7759b152ece97bf28a0606d))
+* don't send the default headers for S3 fetches ([0560c90](https://github.com/moovit-sp-gmbh/hcloud-sdk-js/commit/0560c90641e5c5fbdce9dea10b95764d93a6ad5f))
+* fix outdated getStreamExecutionStatus() method ([793d4b9](https://github.com/moovit-sp-gmbh/hcloud-sdk-js/commit/793d4b9937a1c71e33df475b0a5689a6fee63904))
+* fix replace node debug command schema ([d040931](https://github.com/moovit-sp-gmbh/hcloud-sdk-js/commit/d040931b37f06b121fa4e0a11e34ef2803c11115))
+* implement review changes ([81f403f](https://github.com/moovit-sp-gmbh/hcloud-sdk-js/commit/81f403f3285220cf5bc6d1947db3233a1daedd7d))
+* **nats:** re-add logging subject ([f20f463](https://github.com/moovit-sp-gmbh/hcloud-sdk-js/commit/f20f463acd6ee4264c31a3ca309ababb538cdf90))
+* remove catalog._id field in NodeInfo ([9f237d9](https://github.com/moovit-sp-gmbh/hcloud-sdk-js/commit/9f237d9ef12bdf81417b833c9abd81455e3b43a8))
+* rename Comments to Namespace ([235a7c3](https://github.com/moovit-sp-gmbh/hcloud-sdk-js/commit/235a7c3181d58dc18e17d1c0c80c66f9703e4f3e))
+* return ServiceAccount after regenerating the token ([b5790ea](https://github.com/moovit-sp-gmbh/hcloud-sdk-js/commit/b5790ea4d88376d8664cfc3eabcf4f59e25ecab0))
+* revert introduction of 'parents' field in High5ExecutionStauts and High5ExecutionRequest ([ed6ba17](https://github.com/moovit-sp-gmbh/hcloud-sdk-js/commit/ed6ba17839db12095c3ddcf43b62fd59b5e0825e))
+* update dependencies remove test scripts and workflows ([498c0b0](https://github.com/moovit-sp-gmbh/hcloud-sdk-js/commit/498c0b024ec7b59b9c201d779e957d691deb6296))
+* use names for pools over ids ([71165d2](https://github.com/moovit-sp-gmbh/hcloud-sdk-js/commit/71165d2bb6a5ef7258277f410b53c5198f9d76c8))
 
-### Reverts
+### Performance Improvements
 
-* Revert "feat: add support for lastCorrelationId" ([a23b7f8](https://github.com/moovit-sp-gmbh/hcloud-sdk-js/commit/a23b7f835079c714f220c51cdff4faec6767ba31))
+* add Friday service ([d9ebc62](https://github.com/moovit-sp-gmbh/hcloud-sdk-js/commit/d9ebc625d2a09e615b2a34846c0b93161bcbda71))
+* add Friday service to Auditor ([9ed9221](https://github.com/moovit-sp-gmbh/hcloud-sdk-js/commit/9ed9221f13454891fd617667574c4158ea5c0de2))
+* add license quota for friday backend ([50cd1d8](https://github.com/moovit-sp-gmbh/hcloud-sdk-js/commit/50cd1d8c4fa897d50a9e0e26147fe58607317e9b))
+* add methods for Friday documents management ([9183e0b](https://github.com/moovit-sp-gmbh/hcloud-sdk-js/commit/9183e0bede3bd54f32848e173b1f705ec42ea44b))
+* add Nats subjects for Friday service ([237b226](https://github.com/moovit-sp-gmbh/hcloud-sdk-js/commit/237b2263c62652e063eada5d929152e7d7c74853))
+* add new property to the High5 Space object ([0962b0d](https://github.com/moovit-sp-gmbh/hcloud-sdk-js/commit/0962b0d66d5eeafbe649db59a7ea736a0858248b))
+* add sanitazation function to entity names validator ([5c16153](https://github.com/moovit-sp-gmbh/hcloud-sdk-js/commit/5c161533a7876d470d7e755fe972742d3806e226))
+* add support for cosmo spaces in Dali ([30e3462](https://github.com/moovit-sp-gmbh/hcloud-sdk-js/commit/30e346227d1b83c7d66b3bcdc16881d0cdeb57e0))
+* add validation rule for friday database name ([ff4d853](https://github.com/moovit-sp-gmbh/hcloud-sdk-js/commit/ff4d853bf59648ab204fe50df200d4f01ca1328b))
+* add validation rule for Friday document key ([8780dba](https://github.com/moovit-sp-gmbh/hcloud-sdk-js/commit/8780dbafe7fd267b3575b9a7f5cad0398c4114cd))
+* extend space permission interface in High5 and Fuse ([27b4a12](https://github.com/moovit-sp-gmbh/hcloud-sdk-js/commit/27b4a12902e678a2c041359b487716ef13c750d5))
+* implement NATS updates for SDS ([2a43e35](https://github.com/moovit-sp-gmbh/hcloud-sdk-js/commit/2a43e350a02a2435afedf01e2dee8bed495e3859))
+* migrate eslint to version 9 ([f59b2d2](https://github.com/moovit-sp-gmbh/hcloud-sdk-js/commit/f59b2d2f67f1652fb878202b49ed1b106dbef4f5))
+* update collection of path parameters in validation helper ([b3059f4](https://github.com/moovit-sp-gmbh/hcloud-sdk-js/commit/b3059f4f45a62cbefe6f5a1ab693eba385c6f3a4))
 
-### Code Refactoring
+### Reverts
 
-* consent check no longer sends OAuthApp ([361f3c1](https://github.com/moovit-sp-gmbh/hcloud-sdk-js/commit/361f3c13ac330d20c04b26c3b08b5a46c7bcdd17))
+* restore endpoint to rename the Space ([ddb3407](https://github.com/moovit-sp-gmbh/hcloud-sdk-js/commit/ddb34070ccc5593130c54f699edfcb875a25413c))

package/lib/Hcloud.d.ts

@@ -4,6 +4,7 @@ import AgentService from "./service/agent";
 import AuditorService from "./service/auditor";
 import BouncerService from "./service/bouncer";
 import DaliService from "./service/dali";
+import FridayService from "./service/friday";
 import FuseService from "./service/fuse";
 import High5Service from "./service/high5";
 import IdpService from "./service/idp";
@@ -29,6 +30,8 @@ export declare class HCloud {
     private _Mailer?;
     get Mothership(): MothershipService;
     private _Mothership?;
+    get Friday(): FridayService;
+    private _Friday?;
     get Nats(): NatsService;
     private _Nats?;
     private options;

package/lib/Hcloud.js

@@ -9,6 +9,7 @@ const agent_1 = require("./service/agent");
 const auditor_1 = require("./service/auditor");
 const bouncer_1 = require("./service/bouncer");
 const dali_1 = require("./service/dali");
+const friday_1 = require("./service/friday");
 const fuse_1 = require("./service/fuse");
 const high5_1 = require("./service/high5");
 const idp_1 = require("./service/idp");
@@ -71,6 +72,12 @@ class HCloud {
         }
         return this._Mothership;
     }
+    get Friday() {
+        if (this._Friday === undefined) {
+            this._Friday = new friday_1.default(this.options, this.axios);
+        }
+        return this._Friday;
+    }
     get Nats() {
         if (this._Nats === undefined) {
             this._Nats = new nats_1.default(this.options, this.axios);

package/lib/helper/ValidationHelper.d.ts

@@ -0,0 +1,66 @@
+declare enum Entity {
+    USER_NAME = "USER_NAME",
+    ORGANIZATION_NAME = "ORGANIZATION_NAME",
+    USER_ORGANIZATION_NAME = "USER_ORGANIZATION_NAME",
+    TEAM_NAME = "TEAM_NAME",
+    COMPANY_NAME = "COMPANY_NAME",
+    PAT_NAME = "PAT_NAME",
+    JOIN_TOKEN_NAME = "JOIN_TOKEN_NAME",
+    SPACE_NAME = "SPACE_NAME",
+    EVENT_NAME = "EVENT_NAME",
+    STREAM_NAME = "STREAM_NAME",
+    DESIGN_NAME = "DESIGN_NAME",
+    SNAPSHOT_NAME = "SNAPSHOT_NAME",
+    WEBHOOK_NAME = "WEBHOOK_NAME",
+    SECRET_KEY = "SECRET_KEY",
+    SECRET_VALUE = "SECRET_VALUE",
+    POOL_NAME = "POOL_NAME",
+    FUSE_JOB = "FUSE_JOB",
+    WAVE_ENGINE_RELEASE = "WAVE_ENGINE_RELEASE",
+    CHALLENGE_STRING = "CHALLENGE_STRING",
+    DATABASE_NAME = "DATABASE_NAME",
+    DOCUMENT_KEY = "DOCUMENT_KEY",
+    DOMAIN_NAME = "DOMAIN_NAME",
+    USER_ID = "USER_ID",
+    INVITATION_ID = "INVITATION_ID",
+    OAUTH_APP_ID = "OAUTH_APP_ID",
+    PAT_ID = "PAT_ID",
+    STREAM_ID = "STREAM_ID",
+    EXECUTION_SECRET = "EXECUTION_SECRET",
+    HIGH5_EXECUTION_ID = "HIGH5_EXECUTION_ID",
+    STREAM_LOG_ID = "STREAM_LOG_ID",
+    STREAM_STATUS_ID = "STREAM_STATUS_ID",
+    JOIN_TOKEN_ID = "JOIN_TOKEN_ID",
+    NODE_ID = "NODE_ID",
+    SNAPSHOT_ID = "SNAPSHOT_ID",
+    CATALOG_ID = "CATALOG_ID",
+    WEBHOOK_ID = "WEBHOOK_ID",
+    WEBHOOK_TOKEN = "WEBHOOK_TOKEN",
+    CRONJOB_ID = "CRONJOB_ID",
+    CRONJOB_LOG_ID = "CRONJOB_LOG_ID",
+    NAMESPACE_NAME = "NAMESPACE_NAME"
+}
+declare class EntityDetails {
+    private entity;
+    constructor(name: Entity);
+    get pattern(): RegExp;
+    get minLength(): number;
+    get maxLength(): number;
+    /**
+     * Checks whether the specified value can be used as name of the Current Entity,
+     * the length of the string is additionally checking because these details may not be specified in the regular expression.
+     * @param value - Some string to validate
+     * @returns Validation result
+     */
+    validate(value: string): boolean;
+    /**
+     * This function cleans the given string from disallowed characters, removes extra dashes, dots, and spaces at the beginning and end of the string.
+     * The list of allowed characters is determined automatically based on the given regular expression for name validation (property "pattern"),
+     * but for special cases, it can be set manually in the property "symbols" in the entity name definition.
+     * @param value - Incoming string to sanitize
+     * @returns Sanitized string
+     */
+    sanitize(value: string): string;
+}
+declare function ValidationHelper(name: Entity): EntityDetails;
+export { Entity, EntityDetails, ValidationHelper };

package/lib/helper/ValidationHelper.js

@@ -0,0 +1,312 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EntityDetails = exports.Entity = void 0;
+exports.ValidationHelper = ValidationHelper;
+var Entity;
+(function (Entity) {
+    Entity["USER_NAME"] = "USER_NAME";
+    Entity["ORGANIZATION_NAME"] = "ORGANIZATION_NAME";
+    Entity["USER_ORGANIZATION_NAME"] = "USER_ORGANIZATION_NAME";
+    Entity["TEAM_NAME"] = "TEAM_NAME";
+    Entity["COMPANY_NAME"] = "COMPANY_NAME";
+    Entity["PAT_NAME"] = "PAT_NAME";
+    Entity["JOIN_TOKEN_NAME"] = "JOIN_TOKEN_NAME";
+    Entity["SPACE_NAME"] = "SPACE_NAME";
+    Entity["EVENT_NAME"] = "EVENT_NAME";
+    Entity["STREAM_NAME"] = "STREAM_NAME";
+    Entity["DESIGN_NAME"] = "DESIGN_NAME";
+    Entity["SNAPSHOT_NAME"] = "SNAPSHOT_NAME";
+    Entity["WEBHOOK_NAME"] = "WEBHOOK_NAME";
+    Entity["SECRET_KEY"] = "SECRET_KEY";
+    Entity["SECRET_VALUE"] = "SECRET_VALUE";
+    Entity["POOL_NAME"] = "POOL_NAME";
+    Entity["FUSE_JOB"] = "FUSE_JOB";
+    Entity["WAVE_ENGINE_RELEASE"] = "WAVE_ENGINE_RELEASE";
+    Entity["CHALLENGE_STRING"] = "CHALLENGE_STRING";
+    Entity["DATABASE_NAME"] = "DATABASE_NAME";
+    Entity["DOCUMENT_KEY"] = "DOCUMENT_KEY";
+    Entity["DOMAIN_NAME"] = "DOMAIN_NAME";
+    Entity["USER_ID"] = "USER_ID";
+    Entity["INVITATION_ID"] = "INVITATION_ID";
+    Entity["OAUTH_APP_ID"] = "OAUTH_APP_ID";
+    Entity["PAT_ID"] = "PAT_ID";
+    Entity["STREAM_ID"] = "STREAM_ID";
+    Entity["EXECUTION_SECRET"] = "EXECUTION_SECRET";
+    Entity["HIGH5_EXECUTION_ID"] = "HIGH5_EXECUTION_ID";
+    Entity["STREAM_LOG_ID"] = "STREAM_LOG_ID";
+    Entity["STREAM_STATUS_ID"] = "STREAM_STATUS_ID";
+    Entity["JOIN_TOKEN_ID"] = "JOIN_TOKEN_ID";
+    Entity["NODE_ID"] = "NODE_ID";
+    Entity["SNAPSHOT_ID"] = "SNAPSHOT_ID";
+    Entity["CATALOG_ID"] = "CATALOG_ID";
+    Entity["WEBHOOK_ID"] = "WEBHOOK_ID";
+    Entity["WEBHOOK_TOKEN"] = "WEBHOOK_TOKEN";
+    Entity["CRONJOB_ID"] = "CRONJOB_ID";
+    Entity["CRONJOB_LOG_ID"] = "CRONJOB_LOG_ID";
+    Entity["NAMESPACE_NAME"] = "NAMESPACE_NAME";
+})(Entity || (exports.Entity = Entity = {}));
+class EntityDetails {
+    constructor(name) {
+        this.entity = entityCollection[name];
+    }
+    get pattern() {
+        return this.entity.pattern;
+    }
+    get minLength() {
+        return this.entity.minLength;
+    }
+    get maxLength() {
+        return this.entity.maxLength;
+    }
+    /**
+     * Checks whether the specified value can be used as name of the Current Entity,
+     * the length of the string is additionally checking because these details may not be specified in the regular expression.
+     * @param value - Some string to validate
+     * @returns Validation result
+     */
+    validate(value) {
+        return (typeof value === "string" &&
+            value.length >= this.entity.minLength &&
+            value.length <= this.entity.maxLength &&
+            this.entity.pattern.test(value));
+    }
+    /**
+     * This function cleans the given string from disallowed characters, removes extra dashes, dots, and spaces at the beginning and end of the string.
+     * The list of allowed characters is determined automatically based on the given regular expression for name validation (property "pattern"),
+     * but for special cases, it can be set manually in the property "symbols" in the entity name definition.
+     * @param value - Incoming string to sanitize
+     * @returns Sanitized string
+     */
+    sanitize(value) {
+        if (typeof value !== "string")
+            return "";
+        if (!this.validate(value)) {
+            if (!this.entity.symbols) {
+                const matches = this.entity.pattern.toString().match(/\[([^\]]+)\]/);
+                this.entity.symbols = new RegExp(matches ? `[${matches[1]}]` : /./i);
+            }
+            value = value
+                .split("")
+                .filter(char => this.entity.symbols.test(char))
+                .join("")
+                .replace(/^[\s-.]+|[\s-.]+$/g, "")
+                .replace(/-{2,}/g, "-");
+            if (value.length < this.entity.minLength)
+                value = value.concat("x".repeat(this.entity.minLength - value.length));
+            return value.slice(0, this.entity.maxLength);
+        }
+        return value;
+    }
+}
+exports.EntityDetails = EntityDetails;
+function ValidationHelper(name) {
+    return new EntityDetails(name);
+}
+const entityCollection = {
+    [Entity.USER_NAME]: {
+        // Case-insensitive. Must contain at least 3 character. Allows letters, numbers, underscores, hyphens, dots, and spaces. Cannot start with a dash, end with a dash, or contain double dashes
+        pattern: /^(?!-)(?!.*--)[\w-. ]{3,255}(?<!-)$/i,
+        minLength: 3,
+        maxLength: 255,
+    },
+    [Entity.ORGANIZATION_NAME]: {
+        // Case-insensitive. No spaces or other special characters allowed. Cannot start with a dash, end with a dash, or contain double dashes
+        pattern: /^(?!-)(?!.*--)[a-zA-Z0-9-.]{3,64}(?<!-)$/i,
+        minLength: 3,
+        maxLength: 64,
+    },
+    [Entity.USER_ORGANIZATION_NAME]: {
+        pattern: /^[\w-+@.]{3,255}$/i,
+        minLength: 3,
+        maxLength: 255,
+    },
+    [Entity.TEAM_NAME]: {
+        // Case-insensitive. No spaces or additional special characters allowed. Cannot start with a dash, end with a dash, or contain double dashes
+        pattern: /^(?!-)(?!.*--)[a-zA-Z0-9-.]{3,64}(?<!-)$/i,
+        minLength: 3,
+        maxLength: 64,
+    },
+    [Entity.COMPANY_NAME]: {
+        pattern: /^[\w-. ]{1,255}$/i,
+        minLength: 1,
+        maxLength: 255,
+    },
+    [Entity.PAT_NAME]: {
+        pattern: /^[\w-. ]{1,64}$/i,
+        minLength: 1,
+        maxLength: 64,
+    },
+    [Entity.JOIN_TOKEN_NAME]: {
+        pattern: /^[\w-.]{1,64}$/i,
+        minLength: 1,
+        maxLength: 64,
+    },
+    [Entity.SPACE_NAME]: {
+        pattern: /^[a-zA-Z0-9-.]{1,32}$/i,
+        minLength: 1,
+        maxLength: 32,
+    },
+    [Entity.EVENT_NAME]: {
+        pattern: /^[\w-.]{1,128}$/i,
+        minLength: 1,
+        maxLength: 128,
+    },
+    [Entity.STREAM_NAME]: {
+        pattern: /^(?![.\s]+)[\w-. ]{1,128}(?<![.\s]+)$/i,
+        symbols: /[\w-. ]/i,
+        minLength: 1,
+        maxLength: 128,
+    },
+    [Entity.DESIGN_NAME]: {
+        pattern: /^[a-zA-Z-_]{1,64}$/i,
+        minLength: 1,
+        maxLength: 64,
+    },
+    [Entity.SNAPSHOT_NAME]: {
+        pattern: /^[\w-. ]{1,64}$/i,
+        minLength: 1,
+        maxLength: 64,
+    },
+    [Entity.WEBHOOK_NAME]: {
+        pattern: /^[\w-. ]{1,128}$/i,
+        minLength: 1,
+        maxLength: 128,
+    },
+    [Entity.SECRET_KEY]: {
+        pattern: /^[\w-.]{1,32}$/i,
+        minLength: 1,
+        maxLength: 32,
+    },
+    [Entity.SECRET_VALUE]: {
+        pattern: /^.{1,1024}$/i,
+        minLength: 1,
+        maxLength: 1024,
+    },
+    [Entity.POOL_NAME]: {
+        pattern: /^[\w-.]{1,128}$/i,
+        minLength: 1,
+        maxLength: 128,
+    },
+    [Entity.FUSE_JOB]: {
+        pattern: /^.{1,64}$/i,
+        minLength: 1,
+        maxLength: 64,
+    },
+    [Entity.WAVE_ENGINE_RELEASE]: {
+        pattern: /^\d+\.\d+\.\d+(-dev-\d+)?$/i,
+        symbols: /[dev0-9-.]/i,
+        minLength: 1,
+        maxLength: 128,
+    },
+    [Entity.CHALLENGE_STRING]: {
+        pattern: /^[\w-]{1,128}$/i,
+        minLength: 1,
+        maxLength: 128,
+    },
+    [Entity.DATABASE_NAME]: {
+        pattern: /^[\w-.]{1,128}$/i,
+        minLength: 1,
+        maxLength: 128,
+    },
+    [Entity.DOCUMENT_KEY]: {
+        pattern: /^[\w-.]{1,64}$/i,
+        minLength: 1,
+        maxLength: 64,
+    },
+    [Entity.DOMAIN_NAME]: {
+        pattern: /^(?=.{1,254}$)(?=(^.{1,63}\.|^.{1,63}\.)*)(^([a-zA-Z0-9-]{1,63}\.)+[a-zA-Z]{2,63}$)$/i,
+        minLength: 4,
+        maxLength: 254,
+    },
+    [Entity.USER_ID]: {
+        pattern: /^[a-fA-F0-9]{24}$/i,
+        minLength: 24,
+        maxLength: 24,
+    },
+    [Entity.INVITATION_ID]: {
+        pattern: /^[a-fA-F0-9]{24}$/i,
+        minLength: 24,
+        maxLength: 24,
+    },
+    [Entity.OAUTH_APP_ID]: {
+        pattern: /^[a-fA-F0-9]{24}$/i,
+        minLength: 24,
+        maxLength: 24,
+    },
+    [Entity.PAT_ID]: {
+        pattern: /^[a-fA-F0-9]{24}$/i,
+        minLength: 24,
+        maxLength: 24,
+    },
+    [Entity.STREAM_ID]: {
+        pattern: /^[a-fA-F0-9]{24}$/i,
+        minLength: 24,
+        maxLength: 24,
+    },
+    [Entity.EXECUTION_SECRET]: {
+        pattern: /^[\w-]{3,1024}$/i,
+        minLength: 3,
+        maxLength: 1024,
+    },
+    [Entity.HIGH5_EXECUTION_ID]: {
+        pattern: /^[a-fA-F0-9]{24}$/i,
+        minLength: 24,
+        maxLength: 24,
+    },
+    [Entity.STREAM_LOG_ID]: {
+        pattern: /^[a-fA-F0-9]{24}$/i,
+        minLength: 24,
+        maxLength: 24,
+    },
+    [Entity.STREAM_STATUS_ID]: {
+        pattern: /^[a-fA-F0-9]{24}$/i,
+        minLength: 24,
+        maxLength: 24,
+    },
+    [Entity.JOIN_TOKEN_ID]: {
+        pattern: /^[a-fA-F0-9]{24}$/i,
+        minLength: 24,
+        maxLength: 24,
+    },
+    [Entity.NODE_ID]: {
+        pattern: /^[a-fA-F0-9]{24}$/i,
+        minLength: 24,
+        maxLength: 24,
+    },
+    [Entity.SNAPSHOT_ID]: {
+        pattern: /^[a-fA-F0-9]{24}$/i,
+        minLength: 24,
+        maxLength: 24,
+    },
+    [Entity.CATALOG_ID]: {
+        pattern: /^[a-fA-F0-9]{24}$/i,
+        minLength: 24,
+        maxLength: 24,
+    },
+    [Entity.WEBHOOK_ID]: {
+        pattern: /^[a-fA-F0-9]{24}$/i,
+        minLength: 24,
+        maxLength: 24,
+    },
+    [Entity.WEBHOOK_TOKEN]: {
+        pattern: /^[a-fA-F0-9]{128}$/i,
+        minLength: 128,
+        maxLength: 128,
+    },
+    [Entity.CRONJOB_ID]: {
+        pattern: /^[a-fA-F0-9]{24}$/i,
+        minLength: 24,
+        maxLength: 24,
+    },
+    [Entity.CRONJOB_LOG_ID]: {
+        pattern: /^[a-fA-F0-9]{24}$/i,
+        minLength: 24,
+        maxLength: 24,
+    },
+    [Entity.NAMESPACE_NAME]: {
+        // Case-insensitive. No spaces or other special characters allowed. Cannot start with a dash, end with a dash, or contain double dashes
+        pattern: /^(?!-)(?!.*--)[a-zA-Z0-9-.]{3,64}(?<!-)$/i,
+        minLength: 3,
+        maxLength: 64,
+    },
+};

package/lib/interfaces/auditor/index.d.ts

@@ -1,4 +1,4 @@
-import { Organization } from "../idp";
+import { LicenseTier, Organization } from "../idp";
 export declare enum Level {
     INFO = "info",
     WARN = "warn",
@@ -12,7 +12,8 @@ export declare enum Origin {
     Mailer = "mailer",
     Fuse = "fuse",
     Mothership = "mothership",
-    Dali = "dali"
+    Dali = "dali",
+    Friday = "friday"
 }
 export declare enum Event {
     Login = "login",
@@ -29,7 +30,10 @@ export declare enum Event {
     Cronjob = "cronjob",
     Secret = "secret",
     Agent = "agent",
-    Avatar = "avatar"
+    Avatar = "avatar",
+    ServiceAccount = "serviceAccount",
+    Database = "database",
+    Document = "document"
 }
 export declare enum Type {
     Read = "read",
@@ -63,7 +67,9 @@ export interface AuditLog {
 export interface AuditLogCreate {
     level: Level;
     origin: Origin;
-    organization: Pick<Organization, "_id" | "name">;
+    organization: Pick<Organization, "_id" | "name"> & {
+        license?: LicenseTier;
+    };
     event: Event;
     space?: string;
     type?: Type;

package/lib/interfaces/auditor/index.js

@@ -17,6 +17,7 @@ var Origin;
     Origin["Fuse"] = "fuse";
     Origin["Mothership"] = "mothership";
     Origin["Dali"] = "dali";
+    Origin["Friday"] = "friday";
 })(Origin || (exports.Origin = Origin = {}));
 var Event;
 (function (Event) {
@@ -35,6 +36,9 @@ var Event;
     Event["Secret"] = "secret";
     Event["Agent"] = "agent";
     Event["Avatar"] = "avatar";
+    Event["ServiceAccount"] = "serviceAccount";
+    Event["Database"] = "database";
+    Event["Document"] = "document";
 })(Event || (exports.Event = Event = {}));
 var Type;
 (function (Type) {

package/lib/interfaces/friday/index.d.ts

@@ -0,0 +1,3 @@
+export * from "./space";
+export * from "./space/database";
+export * from "./space/database/document";

package/lib/interfaces/friday/index.js

@@ -0,0 +1,19 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./space"), exports);
+__exportStar(require("./space/database"), exports);
+__exportStar(require("./space/database/document"), exports);